advent 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 44488f23b0a385b7060d3a2d64d6538dc1e738bbd8600bcc405e1735ace44ff2
-  data.tar.gz: aa26c72769ec2cc0eeb05bf4ed67e3619470e7e1e7e77465c0b19c69b65abe2b
+  metadata.gz: d20f95e7e3d0a52a78b93287b93c1864643d94abb70155af037434e254ef18b4
+  data.tar.gz: 1c4452e0c6b36b2cda5687398c18f819038b06e7cb71056293b8f427246542d9
 SHA512:
-  metadata.gz: 8be6f552d4fd5930143da51281cf204b7e93f680358578927094f97dde8443d1d5c4307641286edf14fa2454fde7058abd2a2422afe107d4a857b1bdfdd5129b
-  data.tar.gz: 51575d6fd1d772627c00e199c69f07c4069429787345fa239312effbeac090604c35bf9ab3c1dada8a13de0e75c8a41c83afccfe91723507eb06c36ee6692f8d
+  metadata.gz: 9e39e7bc77607f5cb2d056377b45a763f6564f3205314e9000a128a53faa6cd758e5c427f9e6255d57a495cf971793703ba45a5eb2dfbb85bf6e15d5e21b1143
+  data.tar.gz: 626cb6bb873ac8c5927a302b155c1f2239207e054b8eb186764a0e91929a8afe009af3cf5fb1abd5dd282de36043b9878d7d0d9266dcb4bb6be29b05fa0d8fee

data/lib/advent/cli/solver.rb

@@ -3,21 +3,25 @@
 class Advent::CLI::Solver
   PARTS = [1, 2]
 
-  def initialize(command, year:, day:)
+  if RUBY_VERSION >= "3.1"
+    module Solutions
+    end
+  end
+
+  def initialize(command, path)
     @command = command
-    @year = year
-    @day = day
+    @path = path
   end
 
   def solve
-    if @command.in_year_directory?
-      require @command.root_path.join(solution_file_name).to_s
+    if RUBY_VERSION >= "3.1"
+      load @path, Solutions
+      solution = Solutions.const_get(solution_class_name).new
     else
-      require @command.root_path.join(@year.to_s, solution_file_name)
+      require @path
+      solution = Object.const_get(solution_class_name).new
     end
 
-    solution = Object.const_get(solution_class_name).new
-
     PARTS.each do |n|
       method_name = "part#{n}".to_sym
 
@@ -33,11 +37,15 @@ class Advent::CLI::Solver
 
   private
 
+  def day
+    @_day ||= @path.basename.to_s.match(/day([0-9]+)\.rb/)[1]
+  end
+
   def solution_file_name
-    "day#{@day}.rb"
+    "day#{day}.rb"
   end
 
   def solution_class_name
-    "Day#{@day}"
+    "Day#{day}"
   end
 end

data/lib/advent/cli.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "advent"
+require "date"
 require "pathname"
 require "thor"
 
@@ -17,11 +18,14 @@ module Advent
       source_paths << File.expand_path("templates", __dir__)
     end
 
+    # @return [Boolean] defines whether an exit status is set if a command fails
     def self.exit_on_failure?
       true
     end
 
     no_commands do
+      # @return [Boolean] whether the current root_path option is in a
+      # directory that looks like a year (eg. 2015)
       def in_year_directory?
         dir = root_path.basename.to_s
         dir =~ /^20[0-9]{2}/
@@ -36,26 +40,61 @@ module Advent
       end
     end
 
-    desc "generate YEAR DAY or generate DAY in a year directory", "Generate a new solution for YEAR and DAY"
+    desc "generate YEAR DAY", "Generate a new solution for YEAR and DAY"
+    # Generates a new solution file. If within a year directory, only the day
+    # is used, otherwise both the year and day will be required to generate the
+    # output.
     def generate(year_or_day, day = nil)
-      destination = if in_year_directory?
-        "day#{year_or_day}.rb"
+      year, day = if in_year_directory?
+        [root_path.basename.to_s, parse_number(year_or_day)]
       else
-        "#{year_or_day}/day#{day}.rb"
+        [year_or_day, parse_number(day)]
       end
 
-      template "solution.rb.tt", destination, context: binding
+      if (error_message = validate(year, day))
+        say_error error_message, :red
+        return
+      end
+
+      subpath = if in_year_directory?
+        ""
+      else
+        "#{year}/"
+      end
+
+      template "solution.rb.tt", "#{subpath}day#{day}.rb", context: binding
+      template "solution_test.rb.tt", "#{subpath}test/day#{day}_test.rb", context: binding
     end
 
-    desc "solve YEAR DAY", "Solve your solution for YEAR and DAY"
-    def solve(year, day)
+    desc "solve FILE", "Solve your solution"
+    # Runs a solution file, outputting both :part1 and :part2 method return values.
+    def solve(path)
       require "advent/cli/solver"
-      Solver.new(self, year: year, day: day).solve
+      Solver.new(self, root_path.join(path)).solve
     end
 
-    desc "version", "Prints the current version of Advent"
+    desc "version", "Prints the current version of the gem"
+    # Prints the current version of the gem
     def version
       say Advent::VERSION
     end
+
+    private
+
+    def parse_number(str)
+      if (m = str.match(/[0-9]+/))
+        m[0]
+      end
+    end
+
+    def validate(year, day)
+      if year.to_i < 2014
+        "Advent of Code only started in 2014!"
+      elsif year.to_i > Date.today.year
+        "Future years are not supported."
+      elsif !(1..25).cover? day.to_i
+        "Day must be between 1 and 25 (inclusive)."
+      end
+    end
   end
 end

data/lib/advent/solution.rb

@@ -3,8 +3,13 @@
 require "pathname"
 
 module Advent
+  # Baes class for an Advent of Code solution attempt. If subclass is in a
+  # directory matching a year (eg. 2015) and the filename is for a particular
+  # day (eg. day1.rb) then the @year and @day instance variables are
+  # automatically inferred.
   class Solution
-    attr_reader :year, :day
+    attr_reader :year # @return [Numeric] the year this solution is from
+    attr_reader :day # @return [Numeric] the day this solution is for
 
     def initialize
       year, day = infer_year_and_day_from_file_system

data/lib/advent/templates/solution_test.rb.tt

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "advent"
+require "minitest/autorun"
+
+require_relative "../day<%= day %>"
+
+class Day<%= day %>Test < Advent::TestCase
+  def setup
+    @solution = Day<%= day %>.new
+  end
+
+  # def test_part1
+  #   assert_equal 123, @solution.part1
+  # end
+
+  # def test_part2
+  #   assert_equal 123, @solution.part2
+  # end
+end

data/lib/advent/test_case.rb

@@ -0,0 +1,6 @@
+require "minitest"
+
+module Advent
+  class TestCase < Minitest::Test
+  end
+end

data/lib/advent/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Advent
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/lib/advent.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "advent/solution"
+require_relative "advent/test_case"
 require_relative "advent/version"
 
 module Advent

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: advent
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Daniel Grieve
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-11-21 00:00:00.000000000 Z
+date: 2022-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -41,6 +41,8 @@ files:
 - lib/advent/cli/solver.rb
 - lib/advent/solution.rb
 - lib/advent/templates/solution.rb.tt
+- lib/advent/templates/solution_test.rb.tt
+- lib/advent/test_case.rb
 - lib/advent/version.rb
 homepage: https://github.com/dnlgrv/advent-rb
 licenses: