moar doc tests

And with a single doctest present in the code, it will also run any
standard minitest tests present, too. They don't all have to switch to
doctests.

Author: Robb Kidd

2021/ruby/Rakefile

@@ -25,7 +25,7 @@ task :test, [:day] do |t, args|
     file.write "require 'day#{day}'\n"
   end
 
-  abort unless system("yard doctest ./day#{day}.rb")
+  abort unless system("yard doctest -v ./day#{day}.rb")
 end
 
 task :new do

2021/ruby/day01.rb

@@ -9,10 +9,18 @@ def initialize(input=nil)
     @sonar_sweep = input || sonar_sweep_report
   end
 
+  # @example part 1
+  #   d = Day01.new(PART1_EXAMPLE_INPUT)
+  #   d.part1 #=> 7
+  #
   def part1
     num_increases(@sonar_sweep)
   end
 
+  # @example part 2
+  #   d = Day01.new(PART1_EXAMPLE_INPUT)
+  #   d.part2 #=> 5
+  #
   def part2
     sliding_window_increases(@sonar_sweep)
   end
@@ -35,10 +43,7 @@ def sliding_window_increases(depths)
   def sonar_sweep_report
     File.read('../inputs/day01-input.txt').split("\n").map(&:to_i)
   end
-end
 
-require 'minitest'
-class TestDay01 < Minitest::Test
   PART1_EXAMPLE_INPUT=[
     199,
     200,
@@ -51,22 +56,4 @@ class TestDay01 < Minitest::Test
     260,
     263,
   ]
-
-  def setup
-    @day01_example = Day01.new(PART1_EXAMPLE_INPUT)
-  end
-
-  def test_part1_example
-    assert_equal 7, @day01_example.part1
-  end
-
-  def test_part2_example
-    assert_equal 5, @day01_example.part2
-  end
-end
-
-if ENV.key? 'TEST'
-  require 'minitest/autorun'
-else
-  Day01.go
 end

2021/ruby/day02.rb

@@ -5,15 +5,25 @@ def self.go
     puts "Part 2: #{day.part2}"
   end
 
+  def initialize(input=nil)
+    @input = input || real_input
+  end
+
+  # @example answer
+  #   new(EXAMPLE_INPUT).part1 #=> 150
+  #
   def part1
     submarine = Sub.new
-    submarine.follow_instructions(planned_course)
+    submarine.follow_instructions(@input)
     submarine.where_you_at
   end
 
+  # @example answer
+  #   new(EXAMPLE_INPUT).part2 #=> 900
+  #
   def part2
     submarine = SlightlyMoreComplicatedSub.new
-    submarine.follow_instructions(planned_course)
+    submarine.follow_instructions(@input)
     submarine.where_you_at
   end
 
@@ -169,9 +179,3 @@ def test_sub_can_do_the_aim_thing
     assert_equal 40, @test_sub.depth
   end
 end
-
-if ENV.key? 'TEST'
-  require 'minitest/autorun'
-else
-  Day02.go
-end

2021/ruby/day03.rb

@@ -5,17 +5,27 @@ def self.go
     puts "Part 2: #{day.part2}"
   end
 
+  def initialize(input=nil)
+    @input = input || real_input
+  end
+
+  # @example
+  #   new(EXAMPLE_INPUT).part1 #=> 198
+  #
   def part1
-    diag = SubDiagnostics.new(report)
+    diag = SubDiagnostics.new(@input)
     diag.power_consumption
   end
 
+  # @example
+  #   new(EXAMPLE_INPUT).part2 #=> 230
+  #
   def part2
-    diag = SubDiagnostics.new(report)
+    diag = SubDiagnostics.new(@input)
     diag.life_support_rating
   end
 
-  def report
+  def real_input
     File.read('../inputs/day03-input.txt')
   end
 
@@ -48,15 +58,27 @@ def initialize(report='')
     end
   end
 
+  # @example
+  #   SubDiagnostics
+  #     .new(Day03::EXAMPLE_INPUT)
+  #     .power_consumption #=> 198
   def power_consumption
     gamma_rate * epsilon_rate
   end
 
+  # @example
+  #   SubDiagnostics
+  #     .new(Day03::EXAMPLE_INPUT)
+  #     .gamma_rate #=> 22
   def gamma_rate
     popular_bits
       .to_i(2)
   end
 
+  # @example
+  #   SubDiagnostics
+  #     .new(Day03::EXAMPLE_INPUT)
+  #     .epsilon_rate #=> 9
   def epsilon_rate
     popular_bits
       .tr('01', '10')
@@ -74,14 +96,26 @@ def popular_bits
         .join("")
   end
 
+  # @example
+  #   SubDiagnostics
+  #     .new(Day03::EXAMPLE_INPUT)
+  #     .life_support_rating #=> 230
   def life_support_rating
     oxygen_generator_rating * co2_scrubber_rating
   end
 
+  # @example
+  #   SubDiagnostics
+  #     .new(Day03::EXAMPLE_INPUT)
+  #     .oxygen_generator_rating #=> 23
   def oxygen_generator_rating
     rating_filter(method(:most_common_bit_at))
   end
 
+  # @example
+  #   SubDiagnostics
+  #     .new(Day03::EXAMPLE_INPUT)
+  #     .co2_scrubber_rating #=> 10
   def co2_scrubber_rating
     rating_filter(method(:least_common_bit_at))
   end
@@ -121,42 +155,3 @@ def bit_tally(input)
       .map{ |position| position.tally }
   end
 end
-
-require 'minitest'
-
-class TestDay03 < Minitest::Test
-
-  def setup
-    @diag = SubDiagnostics.new(Day03::EXAMPLE_INPUT)
-  end
-
-  def test_part1_gamma_rate
-    assert_equal 22, @diag.gamma_rate
-  end
-
-  def test_part1_epsilon_rate
-    assert_equal 9, @diag.epsilon_rate
-  end
-
-  def test_part1_power_consumption
-    assert_equal 198, @diag.power_consumption
-  end
-
-  def test_part2_oxygen_generator_rating
-    assert_equal 23, @diag.oxygen_generator_rating
-  end
-
-  def test_part2_co2_scrubber_rating
-    assert_equal 10, @diag.co2_scrubber_rating
-  end
-
-  def test_part2_life_support_rating
-    assert_equal 230, @diag.life_support_rating
-  end
-end
-
-if ENV.key? 'TEST'
-  require 'minitest/autorun'
-else
-  Day03.go
-end

2021/ruby/day04.rb

@@ -5,19 +5,29 @@ def self.go
     puts "Part 2: #{day.part2}"
   end
 
+  def initialize(input=nil)
+    @input = input || real_input
+  end
+
+  # @example
+  #   new(EXAMPLE_INPUT).part1 #=> 4512
+  #
   def part1
-    bingo = BingoSubSystem.new(input)
+    bingo = BingoSubSystem.new(@input)
     chicken_dinner = bingo.first_winning_board
     chicken_dinner.score
   end
 
+  # @example
+  #   new(EXAMPLE_INPUT).part2 #=> 1924
+  #
   def part2
-    bingo = BingoSubSystem.new(input)
+    bingo = BingoSubSystem.new(@input)
     tofurky_dinner = bingo.last_winning_board
     tofurky_dinner.score
   end
 
-  def input
+  def real_input
     File.read('../inputs/day04-input.txt')
   end
 
@@ -240,9 +250,3 @@ def test_tile_marking
     assert tile.marked?
   end
 end
-
-if ENV.key? 'TEST'
-  require 'minitest/autorun'
-else
-  Day04.go
-end

2021/ruby/template.rb.erb

@@ -5,13 +5,17 @@ class <%= day.capitalize %>
     puts "Part 2: #{day.part2}"
   end
 
+  def initialize(input=nil)
+    @input = input || real_input
+  end
+
   def part1
   end
 
   def part2
   end
 
-  def input
+  def real_input
     File.read('../inputs/<%= day.downcase %>-input.txt')
   end