advent 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 44488f23b0a385b7060d3a2d64d6538dc1e738bbd8600bcc405e1735ace44ff2
-  data.tar.gz: aa26c72769ec2cc0eeb05bf4ed67e3619470e7e1e7e77465c0b19c69b65abe2b
+  metadata.gz: 360b1871cc09fd664dd8562fd1a29afd9b2e8bbc7a83d9d711c7933a6c62b5ec
+  data.tar.gz: 2f9cde07fa43650354a3f11c7cb869efa7c969d4254083ca807bd7a855fcf9d0
 SHA512:
-  metadata.gz: 8be6f552d4fd5930143da51281cf204b7e93f680358578927094f97dde8443d1d5c4307641286edf14fa2454fde7058abd2a2422afe107d4a857b1bdfdd5129b
-  data.tar.gz: 51575d6fd1d772627c00e199c69f07c4069429787345fa239312effbeac090604c35bf9ab3c1dada8a13de0e75c8a41c83afccfe91723507eb06c36ee6692f8d
+  metadata.gz: e27b9323e1ad7a07484fe9302dfd49b430bd4fc5433ef0e412e1af14f734bdd1c0a8c719803e108e4b7b3aec144ec942119bc6a07bc93381f4aae9ef634324b1
+  data.tar.gz: b8e99258c57406a1cf945e868a1642d8ed8636c983fd960fd3f889bc6760c170bb346e3cdb0cc82e547f880dbd8c6f71898e941defdfd41b97a73974bc4cdec0

data/README.md

@@ -16,6 +16,26 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ## Usage
 
+Advent expects you to have a working directory resembling something like:
+
+    $ tree
+    .
+    ├── 2015
+    └── 2016
+
+Some commands can be run from within a directory for a specific year, but it's
+better to run from the parent directory where possible.
+
+The typical flow for tackling a daily challenge would be:
+
+    $ advent generate 2015 1 # generate files to work in
+    $ advent download 2015 1 # download the input file
+
+    $ vim 2015/day1.rb 2015/day1_test.rb # do your work
+
+    $ ruby 2015/day1_test.rb # run any tests you may have
+    $ advent solve 2015/day1.rb # get your answers to submit
+
 A list of commands and help is available using `advent`:
 
     $ advent help

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"
 
@@ -9,6 +10,7 @@ module Advent
     include Thor::Actions
 
     class_option :root_path, default: Dir.pwd, hide: true, check_default_type: false
+    class_option :http_module, default: Net::HTTP, check_default_type: false
 
     def initialize(*args)
       super
@@ -17,45 +19,119 @@ 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}/
       end
+    end
+
+    desc "download YEAR DAY", "Download the input for YEAR and DAY"
+    def download(year_or_day, day = nil)
+      year, day = determine_year_and_day(year_or_day, day)
+
+      if (error_message = validate(year, day))
+        say_error error_message, :red
+        return
+      end
+
+      subpath = if in_year_directory?
+        ""
+      else
+        "#{year}/"
+      end
+
+      unless Advent.session.exist?
+        session = ask "What is your Advent of Code session cookie value?", echo: false
+        Advent.session.value = session
 
-      def root_path
-        @_root_path ||= if options.root_path.is_a?(Pathname)
-          options.root_path
-        else
-          Pathname.new(options.root_path)
-        end
+        say "\n\nThanks. Psst, we're going to save this for next time. It's in .advent_session if you need to update or delete it.\n\n"
+      end
+
+      input = Advent::Input.new(root_path.join(subpath), day: day.to_i)
+
+      if input.download(Advent.session.value, options.http_module)
+        say "Input downloaded to #{input.file_path}.", :green
+        say "\nUsing #load_input in your daily solution will load the input file for you."
+      else
+        say_error "Something went wrong, maybe an old session cookie?", :red
       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 = determine_year_and_day(year_or_day, day)
+
+      if (error_message = validate(year, day))
+        say_error error_message, :red
+        return
+      end
+
+      subpath = if in_year_directory?
+        ""
       else
-        "#{year_or_day}/day#{day}.rb"
+        "#{year}/"
       end
 
-      template "solution.rb.tt", destination, context: binding
+      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 determine_year_and_day(year_or_day, day)
+      if in_year_directory?
+        [root_path.basename.to_s, parse_number(year_or_day)]
+      else
+        [year_or_day, parse_number(day)]
+      end
+    end
+
+    def root_path
+      @_root_path ||= if options.root_path.is_a?(Pathname)
+        options.root_path
+      else
+        Pathname.new(options.root_path)
+      end
+    end
+
+    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/input.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require "cgi/cookie"
+require "fileutils"
+require "net/http"
+require "uri"
+
+module Advent
+  class Input
+    def initialize(dir, day:)
+      @dir = dir
+      @day = day
+    end
+
+    def file_path
+      @dir.join(".day#{@day}.input.txt")
+    end
+
+    def exist?
+      File.exist? file_path
+    end
+
+    def download(session, http = Net::HTTP)
+      session_cookie = CGI::Cookie.new("session", session)
+      response = http.get_response(input_url, {"Cookie" => session_cookie.to_s})
+
+      if success?(response)
+        FileUtils.mkdir_p file_path.dirname
+        File.write file_path, response.body
+        true
+      else
+        false
+      end
+    end
+
+    private
+
+    def input_url
+      URI("https://adventofcode.com/#{year}/day/#{@day}/input")
+    end
+
+    def year
+      @_year ||= @dir.basename
+    end
+
+    def success?(response)
+      response.code >= "200" && response.code < "300"
+    end
+  end
+end

data/lib/advent/session.rb

@@ -0,0 +1,28 @@
+module Advent
+  # Simple class for handling the session cookie file
+  class Session
+    FILE_NAME = ".advent_session"
+
+    attr_reader :file_name
+
+    def initialize(file_name = FILE_NAME)
+      @file_name = file_name
+    end
+
+    def clear
+      File.delete file_name if exist?
+    end
+
+    def exist?
+      File.exist? file_name
+    end
+
+    def value=(val)
+      File.write file_name, val
+    end
+
+    def value
+      File.read file_name if exist?
+    end
+  end
+end

data/lib/advent/solution.rb

@@ -3,19 +3,25 @@
 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
 
       @year = year
       @day = day
+
+      @input = Input.new(source_location.dirname, day: day)
     end
 
     def load_input
-      dir = source_location.dirname
-      File.read(dir.join(".day#{@day}.input.txt"))
+      File.read(@input.file_path)
     end
 
     private

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.4"
 end

data/lib/advent.rb

@@ -1,8 +1,17 @@
 # frozen_string_literal: true
 
+require_relative "advent/input"
+require_relative "advent/session"
 require_relative "advent/solution"
+require_relative "advent/test_case"
 require_relative "advent/version"
 
 module Advent
   class Error < StandardError; end
+
+  class << self
+    def session
+      @_session = Session.new
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: advent
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Daniel Grieve
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-11-21 00:00:00.000000000 Z
+date: 2022-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -39,8 +39,12 @@ files:
 - lib/advent.rb
 - lib/advent/cli.rb
 - lib/advent/cli/solver.rb
+- lib/advent/input.rb
+- lib/advent/session.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: