Merge pull request #4 from codeunion/rubocop-support

Add Rubocop support

Author: jfarmer

.rubocop.yml

@@ -0,0 +1,44 @@
+# Increase permitted ABC size
+Metrics/AbcSize:
+  Max: 20
+
+# Allow methods of up to 20 lines of code
+Metrics/MethodLength:
+  Max: 20
+
+# Don't enforce top-level class and module documentation
+Style/Documentation:
+  Enabled: false
+
+# Don't enforce "loop do" for infinite loops
+Style/InfiniteLoop:
+  Enabled: false
+
+# Don't enforce underscores for large numeric values
+Style/NumericLiterals:
+  Enabled: false
+
+# Don't enforce prefix-free predicate methods
+Style/PredicateName:
+  Enabled: false
+
+# Don't enforce implicit return
+Style/RedundantReturn:
+  Enabled: false
+
+# Don't enforce implicit self
+Style/RedundantSelf:
+  Enabled: false
+
+# Prefer double quoted string literals
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+# Don't enforce attr_* for trivial readers/writers
+Style/TrivialAccessors:
+  Enabled: false
+
+# Don't enforce %w and %W for word arrays
+Style/WordArray:
+  Enabled: false

bonus/is_fibonacci.rb

@@ -10,8 +10,8 @@
 #   http://cl.ly/image/1z3b3y41130b
 # This can calculate is_fibonacci?(fib(2**18)) in ~0.9 seconds.
 
-require 'benchmark'
-require_relative 'fast_fib'
+require "benchmark"
+require_relative "fast_fib"
 
 BIG_FIB_INPUT = 2**18
 
@@ -28,7 +28,7 @@ def is_fibonacci?(n)
 # Print out some friendly usage information
 def show_usage!
   puts "Usage:"
-  puts "  #{$0} <number-to-test>"
+  puts "  #{$PROGRAM_NAME} <number-to-test>"
   puts ""
   puts "Options:"
   puts "  -t, --test        Run PASS/FAIL tests"
@@ -62,13 +62,13 @@ def run_benchmarks!(iterations = 3)
 # Run our test suite
 def run_tests!
   puts "Testing with Fibonacci inputs"
-  [0,1,2,3,5,39088169].each do |n|
+  [0, 1, 2, 3, 5, 39088169].each do |n|
     assert_equal(true, is_fibonacci?(n), "is_fibonacci?(#{n}) is true")
   end
 
   puts ""
   puts "Testing with non-Fibonacci inputs"
-  [4,6,7,10,39088169 - 1].each do |n|
+  [4, 6, 7, 10, 39088169 - 1].each do |n|
     assert_equal(false, is_fibonacci?(n), "is_fibonacci?(#{n}) is false")
   end
 
@@ -80,8 +80,11 @@ def run_tests!
 
   puts "done"
 
-  assert_equal(true, is_fibonacci?(big_fib), "is_fibonacci?(fib(#{BIG_FIB_INPUT})) is true")
-  assert_equal(false, is_fibonacci?(big_not_fib), "is_fibonacci?(fib(#{BIG_FIB_INPUT}) + 100) is false")
+  assert_equal(true, is_fibonacci?(big_fib),
+               "is_fibonacci?(fib(#{BIG_FIB_INPUT})) is true")
+
+  assert_equal(false, is_fibonacci?(big_not_fib),
+               "is_fibonacci?(fib(#{BIG_FIB_INPUT}) + 100) is false")
 end
 
 # Helper method for testing purposes
@@ -98,13 +101,13 @@ def assert_equal(expected, actual, msg)
   assert(expected == actual, msg)
 end
 
-if __FILE__ == $0
+if __FILE__ == $PROGRAM_NAME
   case ARGV[0]
-  when '-h', '--help', '', nil
+  when "-h", "--help", "", nil
     show_usage!
-  when '-b', '--bench'
+  when "-b", "--bench"
     run_benchmarks!
-  when '-t', '--test'
+  when "-t", "--test"
     run_tests!
   else
     puts is_fibonacci?(ARGV[0].to_i)

exercises/board.rb

@@ -19,8 +19,8 @@
 
 # In short, you should imagine an empty chess-like board absent the idea
 # that you're playing chess or any other game.  You can place and remove
-# whatever you want from each square — chess pieces, paper scraps, coins, etc. —
-# but you can only place one thing on each square.
+# whatever you want from each square -- chess pieces, paper scraps,
+# coins, etc. -- but you can only place one thing on each square.
 
 # In code, we'll be representing a "piece" by a single-character string like
 # "X", "O", "K", "Q", "N", etc.
@@ -49,15 +49,17 @@ def columns
   # Place a "piece" on the board at (row, column)
   def place(row, column, piece)
     if row >= self.rows
-      raise "Board has #{self.rows} rows and index #{row} is out of bounds."
+      fail "Board has #{self.rows} rows and index #{row} is out of bounds."
     end
 
     if row >= self.rows
-      raise "Board has #{self.columns} columns and index #{column} is out of bounds."
+      fail "Board has #{self.columns} columns and " \
+            "index #{column} is out of bounds."
     end
 
-    if @board[row][column] != nil
-      raise "Cannot place #{piece.inspect} at row #{row}, column #{column}: #{@board[row][column].inspect} is already there."
+    unless @board[row][column].nil?
+      fail "Cannot place #{piece.inspect} at row #{row}, column #{column}: " \
+            "#{@board[row][column].inspect} is already there."
     end
 
     @board[row][column] = piece
@@ -99,7 +101,7 @@ def print_board(board)
     board.columns.times do |column|
       piece = board.at(row, column)
 
-      if piece == nil
+      if piece.nil?
         piece = " " # Display empty cells as spaces
       end
 
@@ -108,17 +110,16 @@ def print_board(board)
 
     print "\n"
   end
-
 end
 
 # Don't change this code, either!
 # See http://cl.ly/image/3t450Y271d25 for expected output
-if __FILE__ == $0
-  board = Board.new(4,4)
-  board.place(0,0,"X")
-  board.place(1,1,"O")
-  board.place(2,2,"X")
-  board.place(3,3,"#")
+if __FILE__ == $PROGRAM_NAME
+  board = Board.new(4, 4)
+  board.place(0, 0, "X")
+  board.place(1, 1, "O")
+  board.place(2, 2, "X")
+  board.place(3, 3, "#")
 
   print_board(board)
 end

exercises/bottles.rb

@@ -29,7 +29,7 @@
 def bottles(start_number)
 end
 
-if __FILE__ == $0
+if __FILE__ == $PROGRAM_NAME
   # What *should* this print?
   bottles(5)
 end

exercises/commas.rb

@@ -22,7 +22,7 @@
 def commas(num)
 end
 
-if __FILE__ == $0
+if __FILE__ == $PROGRAM_NAME
   # What are the common cases?  What are the corner cases?
   # Your sanity checks should look like
   #   p commas(input) == ...expected return value...

exercises/count_in_list.rb

@@ -21,7 +21,7 @@ def count_in_list(list, item_to_count)
   #  3. A way to add to the running total as you see the item
 end
 
-if __FILE__ == $0
+if __FILE__ == $PROGRAM_NAME
   # I'd advise putting some sanity checks here.
   # How else will you be sure your code does what you think it does?
 end

exercises/count_max.rb

@@ -8,22 +8,23 @@
 #   count_max([10, 1,2,10,10]) == 3
 # because "10" is the largest number in the list and it occurs 3 times
 
-# This is how we require the max.rb and count_in_list.rb files in the current folder.
-# We can now use the "max" and "count_in_list" methods we defined there — justs
-# as if we had defined them here!
+# This is how we require the max.rb and count_in_list.rb files in the current
+# folder. We can now use the "max" and "count_in_list" methods we defined there
+# -- as if we had defined them right here!
 
-require_relative './max'
-require_relative './count_in_list'
+require_relative "./max"
+require_relative "./count_in_list"
 
 def count_max(list)
   # You can write this using nothing more than the max and count_in_list
   # methods that you've already written.  You do not HAVE to, but it's worth
-  # trying. The "requite_relative" statements above make them available to us, here.
+  # trying. The "requite_relative" statements above make them available to us.
   #
-  # But remember: inelegant, working code is better than elegant, unfinished code.
+  # But remember: inelegant, working code is better than elegant,
+  # unfinished code.
 end
 
-if __FILE__ == $0
+if __FILE__ == $PROGRAM_NAME
   # I'd advise putting some sanity checks here.
   # How else will you be sure your code does what you think it does?
 end

exercises/die.rb

@@ -1,7 +1,7 @@
 # Classes: Die
 
 # Your job is to implement the Die#roll instance method.  We've hard-coded
-# the number of sides and assigned it to the @sides instance variable —
+# the number of sides and assigned it to the @sides instance variable --
 # don't change that!
 
 # Die#roll should return a random number between 1 and the value of
@@ -19,12 +19,11 @@ def roll
   end
 end
 
-
 # Don't change any of this code.  It's here to tell you when your method isn't
 # working.  Since we're dealing with random behavior, there's a (small) chance
 # that this code will run even if your Die#roll method isn't working.
 
-if __FILE__ == $0
+if __FILE__ == $PROGRAM_NAME
   roll_count = 20
   die = Die.new
 
@@ -34,7 +33,8 @@ def roll
   1.upto(roll_count) do |i|
     result = die.roll
     unless (1..6).include?(result)
-      raise "die.roll returned #{result.inspect}, but it must return a number between 1 and 6 (inclusive)"
+      fail "die.roll returned #{result.inspect}, " \
+            "but it must return a number between 1 and 6 (inclusive)"
     else
       puts "Roll #{i}: #{result}"
     end

exercises/die_labels.rb

@@ -20,15 +20,15 @@ def prompt(msg)
   gets.chomp
 end
 
-if __FILE__ == $0
+if __FILE__ == $PROGRAM_NAME
   # Examples of what we mean by "returning a random label":
   # normal_die = Die.new([1,2,3,4,5,6])
   # letter_die = Die.new(['A', 'B', 'C', 'D'])
   # dot_die    = Die.new(['.', '..', '...', '....'])
   #
   # letter_die.roll would return one of 'A', 'B', 'C', or 'D' at random
 
-  eight_ball = Die.new(['Yes', 'No', 'Unclear', 'Absolutely', 'Never', 'Maybe'])
+  eight_ball = Die.new(["Yes", "No", "Unclear", "Absolutely", "Never", "Maybe"])
 
   loop do
     input = prompt("Ask the Magic 8-Ball a question (or type 'quit' to quit)")

exercises/die_sides.rb

@@ -20,8 +20,7 @@ def roll
   end
 end
 
-
-if __FILE__ == $0
+if __FILE__ == $PROGRAM_NAME
   die_10 = Die.new(10)
   die_20 = Die.new(20)
   die_6  = Die.new(6)