advent 0.1.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d20f95e7e3d0a52a78b93287b93c1864643d94abb70155af037434e254ef18b4
-  data.tar.gz: 1c4452e0c6b36b2cda5687398c18f819038b06e7cb71056293b8f427246542d9
+  metadata.gz: ffa503d42078237632f9e87e404a67ba1e1a09b4a9e4cf2fee9ce9b647e89cb7
+  data.tar.gz: d147b5bbc31d6759fdf9441c69b2921d43037cff3258f7ef42d0c01d77ecce0d
 SHA512:
-  metadata.gz: 9e39e7bc77607f5cb2d056377b45a763f6564f3205314e9000a128a53faa6cd758e5c427f9e6255d57a495cf971793703ba45a5eb2dfbb85bf6e15d5e21b1143
-  data.tar.gz: 626cb6bb873ac8c5927a302b155c1f2239207e054b8eb186764a0e91929a8afe009af3cf5fb1abd5dd282de36043b9878d7d0d9266dcb4bb6be29b05fa0d8fee
+  metadata.gz: cc70be78e2d488a49fd0bdce22ac3b53016757516fc6aa6fc307e26aacd1899f2026d0b6c7f78d81dc1269f0dc568f571b645deb819dd23f7f25f78b0df7313e
+  data.tar.gz: 23900afcbe9288005d5ec925106c9a0ae20e3ffcc99fb3b04f17b4434af2d6b2437bc492287d28fd5d51d3c7560b73ab4eea94261c8521040be4d47b6be4afd7

data/README.md

@@ -16,10 +16,67 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ## Usage
 
+Initialise a new project somewhere:
+
+```bash
+mkdir advent_of_code && cd advent_of_code
+
+# create a blank advent.yml config file
+advent init
+```
+
+Configuration values and format are explained in the [Config](#config) section.
+
+Advent expects you to have a working directory resembling something like:
+
+    $ tree
+    .
+    ├── 2015
+    ├── 2016
+    └── advent.yml
+
+You can run commands from anywhere under this directory.
+
+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
 
+## Config
+
+The config file should be at the root of your working directory called
+`advent.yml`. The default values if you don't provide an override are:
+
+```yaml
+download_when_generating: true
+remember_session: true
+```
+
+### Config explained
+
+<dl>
+<dt>download_when_generating</dt>
+<dd>
+When you run `advent generate` it will automatically download the input file to
+go with it
+</dd>
+
+<dt>remember_session</dt>
+<dd>
+Save your session cookie in `.advent_session` when prompted so you don't need to
+find it again
+</dd>
+</dl>
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/advent/cli/downloader.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+class Advent::CLI::Downloader
+  def initialize(command, year, day)
+    @command = command
+    @year = year
+    @day = day
+  end
+
+  def download
+    ask_for_session_cookie_if_needed
+    input = Advent::Input.new(Advent.root.join(@year), day: @day.to_i)
+
+    if input.download(Advent.session.value, @command.options.http_module)
+      @command.say "Input downloaded to #{input.file_path}.", :green
+      @command.say "\nUsing #load_input in your daily solution will load the input file for you."
+    else
+      @command.say_error "Something went wrong, maybe an old session cookie?", :red
+    end
+  end
+
+  private
+
+  def ask_for_session_cookie_if_needed
+    return if Advent.session.exist?
+
+    session = @command.ask "What is your Advent of Code session cookie value?", echo: false
+    Advent.session.value = session
+
+    @command.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
+end

data/lib/advent/cli/solver.rb

@@ -18,7 +18,7 @@ class Advent::CLI::Solver
       load @path, Solutions
       solution = Solutions.const_get(solution_class_name).new
     else
-      require @path
+      require @path.expand_path
       solution = Object.const_get(solution_class_name).new
     end
 
@@ -37,15 +37,11 @@ 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"
-  end
-
   def solution_class_name
     "Day#{day}"
   end
+
+  def day
+    @_day ||= @path.basename.to_s.match(/day([0-9]+)\.rb/)[1]
+  end
 end

data/lib/advent/cli.rb

@@ -9,13 +9,17 @@ module Advent
   class CLI < Thor
     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
 
-      self.destination_root = root_path
       source_paths << File.expand_path("templates", __dir__)
+
+      # Don't try to load Advent.root if we're running init
+      unless args.last[:current_command]&.name == "init"
+        self.destination_root = Advent.root
+      end
     end
 
     # @return [Boolean] defines whether an exit status is set if a command fails
@@ -23,20 +27,12 @@ module Advent
       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
+    desc "download YEAR DAY", "Download the input for YEAR and DAY"
+    def download(year, day)
+      require "advent/cli/downloader"
 
-      def root_path
-        @_root_path ||= if options.root_path.is_a?(Pathname)
-          options.root_path
-        else
-          Pathname.new(options.root_path)
-        end
+      Dir.chdir Advent.root do
+        Downloader.new(self, year, day).download
       end
     end
 
@@ -44,33 +40,37 @@ module Advent
     # 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)
-      year, day = if in_year_directory?
-        [root_path.basename.to_s, parse_number(year_or_day)]
-      else
-        [year_or_day, parse_number(day)]
-      end
+    def generate(year, day)
+      year = parse_number year
+      day = parse_number day
 
-      if (error_message = validate(year, day))
-        say_error error_message, :red
+      if (message = validate(year, day))
+        say_error message, :red
         return
       end
 
-      subpath = if in_year_directory?
+      template "solution.rb.tt", "#{year}/day#{day}.rb", context: binding
+      template "solution_test.rb.tt", "#{year}/test/day#{day}_test.rb", context: binding
+
+      download year, day if Advent.config.download_when_generating
+    end
+
+    desc "init DIR", "Initialise a new advent project in DIR"
+    def init(dir = ".")
+      create_file Pathname.getwd.join(dir).join(Advent::Configuration::FILE_NAME) do
         ""
-      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 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, root_path.join(path)).solve
+      file_path = Pathname.getwd.join(path)
+
+      Dir.chdir Advent.root do
+        Solver.new(self, file_path.relative_path_from(Advent.root)).solve
+      end
     end
 
     desc "version", "Prints the current version of the gem"

data/lib/advent/configuration.rb

@@ -0,0 +1,30 @@
+require "psych"
+
+module Advent
+  class Configuration
+    DEFAULTS = {
+      "download_when_generating" => true,
+      "remember_session" => true
+    }
+    FILE_NAME = "advent.yml"
+
+    attr_reader :download_when_generating, :remember_session
+
+    class << self
+      def from_file(file = FILE_NAME)
+        if RUBY_VERSION >= "3.1"
+          new Psych.safe_load_file(file)
+        else
+          new Psych.safe_load(File.read(file))
+        end
+      end
+    end
+
+    def initialize(conf)
+      config = DEFAULTS.merge(conf || {})
+
+      @download_when_generating = config.dig("download_when_generating")
+      @remember_session = config.dig("remember_session")
+    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,39 @@
+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)
+      if save_to_disk?
+        File.write file_name, val
+      else
+        @_value = val
+      end
+    end
+
+    def value
+      return @_value unless save_to_disk?
+      return File.read(file_name) if exist?
+    end
+
+    private
+
+    def save_to_disk?
+      Advent.config.remember_session
+    end
+  end
+end

data/lib/advent/solution.rb

@@ -16,11 +16,12 @@ module Advent
 
       @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/version.rb

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

data/lib/advent.rb

@@ -1,9 +1,39 @@
 # frozen_string_literal: true
 
+require_relative "advent/configuration"
+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 config
+      @_config ||= Configuration.from_file(root.join(Configuration::FILE_NAME))
+    end
+
+    def root
+      if (location = find_config_location)
+        location
+      else
+        raise Error, "Cannot find advent.yml config file in current or parent directories."
+      end
+    end
+
+    def session
+      @_session ||= Session.new
+    end
+
+    private
+
+    def find_config_location
+      Pathname.new(Dir.pwd).ascend do |path|
+        return path if File.exist? path.join(Configuration::FILE_NAME)
+        return nil if path.to_s == "/"
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: advent
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.5
 platform: ruby
 authors:
 - Daniel Grieve
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-11-22 00:00:00.000000000 Z
+date: 2022-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -34,11 +34,14 @@ extra_rdoc_files: []
 files:
 - LICENSE.txt
 - README.md
-- Rakefile
 - exe/advent
 - lib/advent.rb
 - lib/advent/cli.rb
+- lib/advent/cli/downloader.rb
 - lib/advent/cli/solver.rb
+- lib/advent/configuration.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
@@ -48,7 +51,13 @@ homepage: https://github.com/dnlgrv/advent-rb
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: |2+
+
+  advent v0.1.5 requires a config file in your working directory.
+
+  See https://github.com/dnlgrv/advent-rb/blob/main/README.md#usage or if you're
+  brave run `advent init` in your current directory.
+
 rdoc_options: []
 require_paths:
 - lib
@@ -68,3 +77,4 @@ signing_key:
 specification_version: 4
 summary: Have fun with the Advent of Code using Ruby.
 test_files: []
+...

data/Rakefile

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-require "rake/testtask"
-require "standard/rake"
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.options = "-p"
-  t.test_files = FileList["test/**/*_test.rb"]
-end
-
-task default: %i[test]