advent 0.1.4 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 360b1871cc09fd664dd8562fd1a29afd9b2e8bbc7a83d9d711c7933a6c62b5ec
-  data.tar.gz: 2f9cde07fa43650354a3f11c7cb869efa7c969d4254083ca807bd7a855fcf9d0
+  metadata.gz: a49571ac28572d7a91bcc6a26ecb7253b4f10690dfe2c529a86eca8d310b059b
+  data.tar.gz: 470af342600d4fac184e63837dd0f0cdfbd27d34268d34d4a191ef65ce59b960
 SHA512:
-  metadata.gz: e27b9323e1ad7a07484fe9302dfd49b430bd4fc5433ef0e412e1af14f734bdd1c0a8c719803e108e4b7b3aec144ec942119bc6a07bc93381f4aae9ef634324b1
-  data.tar.gz: b8e99258c57406a1cf945e868a1642d8ed8636c983fd960fd3f889bc6760c170bb346e3cdb0cc82e547f880dbd8c6f71898e941defdfd41b97a73974bc4cdec0
+  metadata.gz: e94342f2d83c40b0bd360478d7535583da1076517b218c045b44ead0d455e389c174e58c92321da978f63cecbd41abfff0904927552b1acaeb08853b74874a34
+  data.tar.gz: 5d2af6a890fc835148f7e1bc054ef49a3e69e641d7a93528ae184b8b39d48a8c69ce4cdf166c29750525750167278c8c84350d8c2d766df77c8d2a2b30f4e502

data/README.md

@@ -16,15 +16,26 @@ 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
+    ├── 2016
+    └── advent.yml
 
-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.
+You can run commands from anywhere under this directory.
 
 The typical flow for tackling a daily challenge would be:
 
@@ -40,6 +51,32 @@ 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

@@ -8,15 +8,19 @@ require "thor"
 module Advent
   class CLI < Thor
     include Thor::Actions
+    EXCLUDED_ROOT_COMMANDS = %w[help init version]
 
-    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 a command that doesn't need it
+      unless EXCLUDED_ROOT_COMMANDS.include? args.last[:current_command]&.name
+        self.destination_root = Advent.root
+      end
     end
 
     # @return [Boolean] defines whether an exit status is set if a command fails
@@ -24,44 +28,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
-    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
+    def download(year, day)
+      require "advent/cli/downloader"
 
-      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
-
-        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
+      Dir.chdir Advent.root do
+        Downloader.new(self, year, day).download
       end
     end
 
@@ -69,29 +41,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 = determine_year_and_day(year_or_day, day)
+    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"
@@ -102,22 +82,6 @@ module Advent
 
     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]

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

@@ -18,11 +18,22 @@ module Advent
     end
 
     def value=(val)
-      File.write file_name, val
+      if save_to_disk?
+        File.write file_name, val
+      else
+        @_value = val
+      end
     end
 
     def value
-      File.read file_name if exist?
+      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/version.rb

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

data/lib/advent.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative "advent/configuration"
 require_relative "advent/input"
 require_relative "advent/session"
 require_relative "advent/solution"
@@ -10,8 +11,29 @@ 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
+      @_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.4
+  version: 0.1.6
 platform: ruby
 authors:
 - Daniel Grieve
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-11-23 00:00:00.000000000 Z
+date: 2022-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -34,11 +34,12 @@ 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
@@ -50,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
@@ -70,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]