advent_of_code_cli 0.1.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 874bcb2472449a2b367b4276efabaf1c7b15a19857c0e331d16bf3cd6da7e700
-  data.tar.gz: 36f956b45bb8849b1b17880132842f16194209d3cfaff592be643b98da4d7ca2
+  metadata.gz: 975ed7c8275bc2111366961b426b01ba4805835876aa47ada28cb45a8296a56d
+  data.tar.gz: e3ecbe525361d68da73e13906adda1594354d9bfc1727a85a752f57114673685
 SHA512:
-  metadata.gz: 3387033c1bf3c5f5edd4cd335647c64d3722ba0ffd5a6f716e7ec895d6e789a537d67b181cc44d29d1c99eec79590b3fe69a3627fe4d19e3eeedf180d1b091b1
-  data.tar.gz: e952fb854364b9bfbcfdd6a84e194476c038ed176fde60903818dce824899c570b84cb256819e46f6afe5438402551adef59bc0825520d85adfce1819c9e8d2a
+  metadata.gz: 2bcc6d477acc45cb34b0bbea2c7f2f0cb904b3e76b80847267de80db2d2f5dfcaf96ec0078c080e6de44a4cd45cbe008708199090d4cd0a59fda6147bf2d556e
+  data.tar.gz: 7b912eaa46ee7e047aed2bc94ed7997e097317fef923ad4fdbd36d69885ff6be07002cf43ba0409d3b0e0ee916711301a85d1e7775f24c91c349f628dff9f48c

data/.rubocop.yml

@@ -1,5 +1,6 @@
 AllCops:
   TargetRubyVersion: 2.6
+  NewCops: enable
 
 Style/Documentation:
   Enabled: false
@@ -14,3 +15,9 @@ Style/StringLiteralsInInterpolation:
 
 Layout/LineLength:
   Max: 120
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false

data/Gemfile.lock

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

data/README.md

@@ -2,7 +2,7 @@
 
 > ⚠️ **Note:** This tool is under active development. I built in in a couple hours with no automated tests. Things may change between versions!
 
-A little CLI tool that scaffolds and runs [Advent of Code](https://advent-of-code.com) solutions in Ruby.
+A little CLI tool that scaffolds and runs [Advent of Code](https://adventofcode.com) solutions in Ruby.
 
 This project is heavily based on [advent-of-code-rust](https://github.com/arturopala/advent-of-code-rust). Go check it out!
 
@@ -52,6 +52,8 @@ module Day01
 end
 ```
 
+...where `input` is an `Array[String]` of all the lines without newlines.
+
 I would love to make this structure configurable in the future.
 
 ### Download
@@ -111,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/download.rb

@@ -31,7 +31,7 @@ module AdventOfCode
       private
 
       def cookie
-        @cookie ||= ENV["AOC_COOKIE"]
+        @cookie ||= ENV.fetch("AOC_COOKIE", nil)
       end
 
       def cookie_present?
@@ -46,6 +46,9 @@ module AdventOfCode
 
         request = Net::HTTP::Get.new(url)
         request["Cookie"] = "session=#{cookie}"
+        # The creator of Advent of Code has requested that automated tools send identifying information
+        # when making requests: https://www.reddit.com/r/adventofcode/comments/z9dhtd
+        request["User-Agent"] = "github.com/egiurleo/advent_of_code_cli by emily.samp@icloud.com"
 
         response = https.request(request)
         response.read_body

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/scaffold.rb

@@ -32,17 +32,17 @@ module AdventOfCode
 
       def solution_file_contents
         <<~RUBY
-        module Day#{day_string}
-          class << self
-            def part_one(input)
-              raise NotImplementedError
-            end
-
-            def part_two(input)
-              raise NotImplementedError
+          module Day#{day_string}
+            class << self
+              def part_one(input)
+                raise NotImplementedError
+              end
+
+              def part_two(input)
+                raise NotImplementedError
+              end
             end
           end
-        end
         RUBY
       end
     end

data/lib/advent_of_code_cli/commands/solve.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'benchmark'
-
 module AdventOfCode
   module Commands
     class Solve < Command
@@ -34,7 +32,7 @@ module AdventOfCode
         end_time = Time.now
 
         say "Part #{part} result: #{result}"
-        say "Took #{end_time-start_time} seconds to solve"
+        say "Took #{end_time - start_time} seconds to solve"
       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.3"
+  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.3
+  version: 0.1.5
 platform: ruby
 authors:
 - Emily Samp
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-12-01 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
@@ -54,6 +57,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/egiurleo/advent_of_code_cli
   source_code_uri: https://github.com/egiurleo/advent_of_code_cli
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -69,7 +73,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: A CLI tool to scaffold and run Advent of Code solutions.