advent_of_code_cli 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b2cac14f5226dc5a7c96642991455c2f33c794d2897669393c095ca350cdae2
-  data.tar.gz: e3d32b4654fc79cfb0fb86e2a33004019142ba6fb523215e2da7692b071879c5
+  metadata.gz: 975ed7c8275bc2111366961b426b01ba4805835876aa47ada28cb45a8296a56d
+  data.tar.gz: e3ecbe525361d68da73e13906adda1594354d9bfc1727a85a752f57114673685
 SHA512:
-  metadata.gz: 2e1723a650da1f128a8f3cae5af52ae0f2e7b04845a883a82181f076d47b14b984a26b3ad6cc79ea4c1ce2272b6232531d2892e8790cd202dbcd053d1ccab98f
-  data.tar.gz: 71fc3eed81a924700eddb86a9c1f06c2a3ce0c43cbaf09e64f34c6078e3876f6d5409bbfbb4e37952165db444c866e3ebbbd5daaf63a79b7a725402570705f92
+  metadata.gz: 2bcc6d477acc45cb34b0bbea2c7f2f0cb904b3e76b80847267de80db2d2f5dfcaf96ec0078c080e6de44a4cd45cbe008708199090d4cd0a59fda6147bf2d556e
+  data.tar.gz: 7b912eaa46ee7e047aed2bc94ed7997e097317fef923ad4fdbd36d69885ff6be07002cf43ba0409d3b0e0ee916711301a85d1e7775f24c91c349f628dff9f48c

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    advent_of_code_cli (0.1.4)
+    advent_of_code_cli (0.1.5)
       thor (>= 1.2.0)
 
 GEM

data/README.md

@@ -113,6 +113,61 @@ Done!
 
 This command expects files to be in the format provided by the `scaffold` command. Once again, I would love to make this configurable but haven't gotten around to it yet.
 
+### Examples
+
+It is often helpful to run our solutions against example input. The `example` command can help you create and run examples of your own invention.
+
+#### Create a new example
+
+You can create a new file for example input by running the following command:
+
+```
+bundle exec aoc_cli example new 1 A
+```
+
+The first argument specifies the day, and the second argument is the name of the example. You may choose whatever name you'd like.
+
+This will generate the following output:
+
+```
+Creating examples/01/A.txt...
+Creating examples/01/A_expected.yml...
+Done!
+```
+
+- `examples/01/A.txt` is a blank text file where you can enter your own input for the problem.
+- `examples/01/A_expected.yml` is a YAML file with the following content:
+
+```
+part_one: ~
+part_two: ~
+```
+
+Replace the two tildes (`~`) with the expected result of running your solution against the example input provided.
+
+#### Running examples
+
+You can check your solution against an example with the following command:
+
+```
+bundle exec aoc_cli example solve 1 A
+```
+
+This will output the following:
+
+```
+Reading input...
+Loading solution...
+
+Running part one with example A...
+Part one result: 1034 ✅
+Took 0.000259 seconds to solve
+
+Running part two with example A...
+Part two result: 7934 ✅
+Took 0.000253 seconds to solve
+```
+
 ## Contributing
 
 Issues and code contributions are welcome! Happy Advent of Code to all who celebrate! 🎁

data/lib/advent_of_code_cli/commands/command.rb

@@ -25,6 +25,14 @@ module AdventOfCode
         "inputs/#{day_string}.txt"
       end
 
+      def example_file_name
+        "examples/#{day_string}/#{@name}.txt"
+      end
+
+      def example_expected_file_name
+        "examples/#{day_string}/#{@name}_expected.yml"
+      end
+
       def create_file(file_name, contents = nil)
         File.open(file_name, "w") do |file|
           file.puts contents if contents

data/lib/advent_of_code_cli/commands/example/new.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module AdventOfCode
+  module Commands
+    module Example
+      class New < Command
+        def initialize(day:, name:)
+          @name = name
+          super(day: day)
+        end
+
+        def execute
+          unless Dir.exist?("examples")
+            say("Creating examples directory...")
+            Dir.mkdir("examples")
+          end
+
+          unless Dir.exist?("examples/#{day_string}")
+            say("Creating examples/#{day_string} directory...")
+            Dir.mkdir("examples/#{day_string}")
+          end
+
+          if File.exist?(example_file_name)
+            raise ExampleAlreadyExistsError,
+                  "could not create example file because file #{example_file_name} already exists"
+          end
+
+          say("Creating #{example_file_name}...")
+          create_file(example_file_name)
+
+          say("Creating #{example_expected_file_name}...")
+          create_file(example_expected_file_name, expected_file_contents)
+
+          say "Done!", :green
+        end
+
+        private
+
+        def expected_file_contents
+          <<~RUBY
+            part_one: ~
+            part_two: ~
+          RUBY
+        end
+      end
+    end
+  end
+end

data/lib/advent_of_code_cli/commands/example/solve.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require "yaml"
+
+module AdventOfCode
+  module Commands
+    module Example
+      class Solve < Command
+        def initialize(day:, name:)
+          @name = name
+          super(day: day)
+        end
+
+        def execute
+          raise MissingExampleError unless File.exist?(example_file_name)
+          raise MissingExampleError unless File.exist?(example_expected_file_name)
+          raise MissingSolutionError unless File.exist?(solution_file_name)
+
+          say "Reading input..."
+          input = File.readlines(example_file_name, chomp: true)
+
+          say "Loading solution..."
+          load(solution_file_name)
+
+          module_name = "Day#{day_string}"
+
+          say "\nRunning part one with example #{@name}..."
+          solution(module_name, "one", input)
+
+          say "\nRunning part two with example #{@name}..."
+          solution(module_name, "two", input)
+
+          say "\nDone!", :green
+        end
+
+        private
+
+        def solution(module_name, part, input)
+          start_time = Time.now
+          result = Object.const_get(module_name).send("part_#{part}", input)
+          end_time = Time.now
+
+          expected_result = expected_answers["part_#{part}"]
+
+          if expected_result.nil?
+            say "Part #{part} result: #{result} ⚠️  (no expectation provided)"
+          elsif result == expected_result
+            say "Part #{part} result: #{result} ✅"
+          else
+            say "Part #{part} result: #{result} ❌ (expected #{expected_result})"
+          end
+
+          say "Took #{end_time - start_time} seconds to solve"
+        end
+
+        def expected_answers
+          @expected_answers ||= YAML.safe_load(File.read(example_expected_file_name))
+        end
+      end
+    end
+  end
+end

data/lib/advent_of_code_cli/commands/example.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative "example/new"
+require_relative "example/solve"
+
+module AdventOfCode
+  module Commands
+    module Example
+      class CLI < Thor
+        desc "new DAY NAME", "creates an example file with name NAME for day DAY"
+        def new(day, name)
+          New.new(day: day.to_i, name: name).execute
+        rescue ExampleAlreadyExistsError => e
+          say(e.message, :red)
+        rescue InvalidDayError
+          rescue_invalid_day_error
+        end
+
+        desc "solve DAY NAME", "runs the example with name NAME for day DAY"
+        def solve(day, name)
+          Solve.new(day: day.to_i, name: name).execute
+        rescue InvalidDayError
+          rescue_invalid_day_error
+        rescue MissingExampleError
+          say "Error: Cannot find example file.", :red
+        rescue AdventOfCode::MissingSolutionError
+          say "Error: Cannot find solution file.", :red
+        end
+
+        private
+
+        def rescue_invalid_day_error
+          say "Error: The day argument must be an integer between 1 and 25.", :red
+        end
+      end
+    end
+  end
+end

data/lib/advent_of_code_cli/commands.rb

@@ -2,5 +2,6 @@
 
 require_relative "commands/command"
 require_relative "commands/download"
+require_relative "commands/example"
 require_relative "commands/scaffold"
 require_relative "commands/solve"

data/lib/advent_of_code_cli/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AdventOfCode
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

data/lib/advent_of_code_cli.rb

@@ -7,8 +7,10 @@ require_relative "advent_of_code_cli/commands"
 
 module AdventOfCode
   class Error < StandardError; end
+  class ExampleAlreadyExistsError < Error; end
   class InvalidDayError < Error; end
   class MissingCookieError < Error; end
+  class MissingExampleError < Error; end
   class MissingInputError < Error; end
   class MissingSolutionError < Error; end
 
@@ -41,6 +43,9 @@ module AdventOfCode
       say "Error: Cannot find solution file.", :red
     end
 
+    desc "example", "create and run example files"
+    subcommand "example", Commands::Example::CLI
+
     private
 
     def rescue_invalid_day_error

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: advent_of_code_cli
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Emily Samp
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-12-02 00:00:00.000000000 Z
+date: 2022-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -45,6 +45,9 @@ files:
 - lib/advent_of_code_cli/commands.rb
 - lib/advent_of_code_cli/commands/command.rb
 - lib/advent_of_code_cli/commands/download.rb
+- lib/advent_of_code_cli/commands/example.rb
+- lib/advent_of_code_cli/commands/example/new.rb
+- lib/advent_of_code_cli/commands/example/solve.rb
 - lib/advent_of_code_cli/commands/scaffold.rb
 - lib/advent_of_code_cli/commands/solve.rb
 - lib/advent_of_code_cli/version.rb