aocli 1.4.4 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b1b051f8ff01af0cd8c73b87ce71f60e2d168083d6d5c560b5c96cb2631d734b
-  data.tar.gz: 56a8fc53f52ebb65993baf8e97444fad7154bc68cec266ecd04b4cbe5c9d7320
+  metadata.gz: 401260b3c2e7cdde374a92e0fb04dd8e22339d42b1c7b17b1fa493ff632fff47
+  data.tar.gz: 3ce43f2fa01ceb2d096f3463f3d74fb1dacbb109c395004bfd80de11e2f6b94d
 SHA512:
-  metadata.gz: 938f801d1c451d28279075209c0d3a2d88e235c652fb8f5eb81919cf2589df1eab92e7ea8d6016d93a38147525a20d49a3f72bcc1ab70a38ea05c7191586d6ee
-  data.tar.gz: e42e540e22ab43c83733f65aef1e725ff06aba142f576bbe3399256942282bc00ed4ed3f2164f537defa69694349543a07d4a777eba4a186716ead2148e7364f
+  metadata.gz: 74937e8ee1f6cbbd9739202196bbb6f310ab6215ece6054122fdabf4dbcfb3884f25ade07a515635fb70f59e8301f045f42a4a52bcfb71d36262a9224e955b0c
+  data.tar.gz: 050203b32f0b03893bfd4ca79d78f3c710e5367a41ae94312d000313de025636f011823d85cc31d0b3a16a9098b23e758b165a4cc6df821461d5ad12050a4f15

data/.rubocop.yml

@@ -11,3 +11,15 @@ Style/StringLiteralsInInterpolation:
 
 Layout/LineLength:
   Max: 120
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false

data/CHANGELOG.md

@@ -17,3 +17,7 @@
 ## [1.4.4] - 2023-11-21
 
 - Support year 2023
+
+## [1.4.5] - 2023-11-21
+
+- Bump active support version to remove depractor error

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    aocli (1.4.4)
-      activesupport (~> 7.0)
+    aocli (1.5.0)
+      activesupport (~> 7.0.8)
       faraday (~> 2.7)
       nokogiri (~> 1.13)
       tty-prompt (~> 0.23.1)
@@ -10,7 +10,7 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.4)
+    activesupport (7.0.8)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)

data/README.md

@@ -38,6 +38,23 @@ For the example shown, I viewed 2018 day 11 and can see the cookie inside the co
 
 ![cookie-example](/public/aocli-cookie-helper.png)
 
+## Using your own template file
+
+Don't like the default template you got for each challenge? It's just about as basic as it gets so I've made it easy for users
+to create their own and have it be used. Simply create your own template, structured however your prefer
+and optionally insert the two directives `__aocli_load_input__` and `__aocli_problem_description__`. You can leave either off if you
+prefer to either not have the problem description shown or would like to load your input in another way.
+
+`__aocli_problem_description__` Will be replaced with the given problems description as a comment
+
+`__aocli_load_input__` Will be replaced by the line that loads your input as a string into the `input` variable.
+
+Then run the `aocli` command and choose the "Set Template File" option, paste in the full path to your file and it'll be used
+when generating the files for a given day.
+
+Partial file path could be used if you expect to run aocli from the same location
+all the time but I'd recommend using the full path just in case.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/aocli/advent_of_code/client.rb

@@ -16,7 +16,7 @@ module Aocli
     class Client
       attr_reader :conn
       def initialize
-        @cookie = Aocli::CookieRetriever.call
+        @cookie = Aocli::Config.value_for(:cookie)
         @conn = initialise_conn_object
         raise(StandardError, "No cookie is set") unless @cookie
       end

data/lib/aocli/cli.rb

@@ -1,21 +1,25 @@
+require "byebug"
 
-require"byebug"
 module Aocli
   class Cli
     def initialize
-      @options = {cookie: Aocli::CookieRetriever.call}
+      @options = Aocli::Config.load_config
       @prompt = TTY::Prompt.new
     end
 
     def run
       prompt_for_command
-      get_all_command_options
+      prompt_command_options
       # Aocli::Commands::StartDay
       # Aocli::Commands::SaveCookie
+      # Aocli::Commands::RemoveCookie
+      # Aocli::Commands::SetTemplatePath
+      # Aocli::Commands::RemoveTemplatePath
       options[:command].constantize.run!(options)
     end
 
     private
+
     attr_accessor :options, :prompt
     attr_reader :cookie
 
@@ -23,12 +27,16 @@ module Aocli
       options[:command] = prompt.select("What would you like to do?", command_options)
     end
 
-    def get_all_command_options
+    def prompt_command_options
       case options[:command]
       when "Aocli::Commands::StartDay"
         set_start_day_options
       when "Aocli::Commands::SaveCookie"
         set_save_cookie_options
+      when "Aocli::Commands::SetTemplatePath"
+        set_template_path_options
+      when "Aocli::Commands::RemoveCookie", "Aocli::Commands::RemoveTemplatePath"
+        nil
       when "Exit"
         exit
       else
@@ -38,16 +46,17 @@ module Aocli
 
     def command_options
       @command_options ||= [
+        requires_config(:cookie, {name: "Start day", value: "Aocli::Commands::StartDay"}),
         {name: "Save Cookie", value: "Aocli::Commands::SaveCookie"},
-        requires_cookie({name: "Start day", value: "Aocli::Commands::StartDay"}),
+        requires_config(:cookie, {name: "Unset cookie", value: "Aocli::Commands::RemoveCookie"}),
+        {name: set_template_prompt, value: "Aocli::Commands::SetTemplatePath"},
+        requires_config(:template_path, {name: "Unset template file", value: "Aocli::Commands::RemoveTemplatePath"}),
         {name: "Exit", value: "Exit"},
       ]
-      # TODO:
-      # requires_cookie({name: "Remove cookie file", value: "Aocli::Commands::RemoveCookieFile"}),
     end
 
-    def requires_cookie(hash)
-      hash.merge(options[:cookie] ? {} : {disabled: "(No cookie has been set yet)"})
+    def requires_config(required_config, hash)
+      hash.merge(options[required_config] ? {} : {disabled: "(No #{required_config} has been set yet)"})
     end
 
     def set_start_day_options
@@ -60,5 +69,17 @@ module Aocli
     def set_save_cookie_options
       options[:cookie] = prompt.ask("Paste your cookie and it will be saved:")
     end
+
+    def set_template_path_options
+      options[:template_path] = prompt.ask("Paste the full file path to your template file:")
+    end
+
+    def set_template_prompt
+      base_prompt = "Set Template File"
+      if options[:template_path]
+        base_prompt += " -> Currently set to '#{options[:template_path]}'"
+      end
+      base_prompt
+    end
   end
 end

data/lib/aocli/commands/remove_cookie.rb

@@ -0,0 +1,13 @@
+module Aocli
+  module Commands
+    module RemoveCookie
+      def self.run!(_options = nil)
+        Aocli::Config.remove_config(:cookie)
+
+        puts <<~MSG
+          ### Cookie has been removed ###
+        MSG
+      end
+    end
+  end
+end

data/lib/aocli/commands/remove_template_path.rb

@@ -0,0 +1,14 @@
+module Aocli
+  module Commands
+    module RemoveTemplatePath
+      def self.run!(_options = nil)
+        current_path = Aocli::Config.value_for(:template_path)
+        Aocli::Config.remove_config(:template_path)
+
+        puts <<~MSG
+          ### '#{current_path} is no longer set as your template file ###
+        MSG
+      end
+    end
+  end
+end

data/lib/aocli/commands/save_cookie.rb

@@ -2,8 +2,7 @@ module Aocli
   module Commands
     module SaveCookie
       def self.run!(options)
-        Aocli::FileUtils.touch_file(Aocli::Values::CONFIG_FILE_PATH)
-        File.write(Aocli::Values::CONFIG_FILE_PATH, {cookie: options[:cookie]}.to_yaml)
+        Aocli::Config.add_config(key: :cookie, value: options[:cookie])
 
         puts <<~MSG
           ### Cookie saved to #{Aocli::Values::CONFIG_FILE_PATH} ###

data/lib/aocli/commands/set_template_path.rb

@@ -0,0 +1,13 @@
+module Aocli
+  module Commands
+    module SetTemplatePath
+      def self.run!(options)
+        Aocli::Config.add_config(key: :template_path, value: options[:template_path])
+
+        puts <<~MSG
+          ### The template at '#{options[:template_path]}' will now be used ###
+        MSG
+      end
+    end
+  end
+end

data/lib/aocli/commands/start_day.rb

@@ -23,6 +23,7 @@ module Aocli
       end
 
       private
+
       attr_reader :date, :output_destination, :main_file_path, :input_file_path
 
       def main_content
@@ -31,15 +32,22 @@ module Aocli
           day: date.day,
         )
 
-        content = Aocli::FileUtils.insert_lines(
+        problem_description = "Part One Description\n" + problem_description
+
+        template_file = Aocli::Config.value_for(:template_path) || File.join(__dir__, "../content/main.txt")
+        unless File.exist?(template_file)
+          template_file = File.join(__dir__, "../content/main.txt")
+        end
+
+        content = Aocli::FileUtils.replace_line(
+          File.read(template_file),
+          "__aocli_problem_description__",
           Aocli::FileUtils.wrap_lines(problem_description).split("\n").map { _1 == "" ? "#" : "# #{_1}" },
-          into: File.read(File.join(__dir__, "../content/main.txt")),
-          after: "##### Part One Description #####",
         )
 
         Aocli::FileUtils.replace_line(
           content,
-          "# __load_input__",
+          "__aocli_load_input__",
           'input = File.read(__FILE__.gsub("main.rb", "input.txt"))'
         )
       end

data/lib/aocli/config.rb

@@ -0,0 +1,28 @@
+module Aocli
+  module Config
+    module_function
+
+    def add_config(key:, value:)
+      config = load_config.merge({key => value})
+      File.write(Aocli::Values::CONFIG_FILE_PATH, config.to_yaml)
+    end
+
+    def value_for(key)
+      load_config[key]
+    end
+
+    def load_config
+      unless File.exist?(Aocli::Values::CONFIG_FILE_PATH)
+        Aocli::FileUtils.touch_file(Aocli::Values::CONFIG_FILE_PATH)
+      end
+
+      YAML.load_file(Aocli::Values::CONFIG_FILE_PATH, fallback: {})
+    end
+
+    def remove_config(key)
+      config = load_config
+
+      File.write(Aocli::Values::CONFIG_FILE_PATH, config.except(key).to_yaml)
+    end
+  end
+end

data/lib/aocli/content/main.txt

@@ -1,4 +1,4 @@
-##### Part One Description #####
+__aocli_problem_description__
 
 def self.parse_input(input)
   # Parse input
@@ -13,6 +13,7 @@ def part_two(input)
   # Solve part two
 end
 
-# __load_input__
+__aocli_load_input__
+
 puts "Part One: #{part_one(parse_input(input))}"
 puts "Part Two: #{part_two(parse_input(input))}"

data/lib/aocli/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Aocli
-  VERSION = "1.4.4"
+  VERSION = "1.5.0"
 end

data/lib/aocli.rb

@@ -2,11 +2,14 @@
 
 require("aocli/advent_of_code")
 require("aocli/cli")
+require("aocli/config")
+require("aocli/commands/set_template_path")
 require("aocli/commands/save_cookie")
+require("aocli/commands/remove_cookie")
+require("aocli/commands/remove_template_path")
 require("aocli/commands/start_day")
 require("aocli/file_utils")
 require("aocli/version")
-require("aocli/cookie_retriever")
 require("aocli/values")
 
 require("fileutils")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aocli
 version: !ruby/object:Gem::Version
-  version: 1.4.4
+  version: 1.5.0
 platform: ruby
 authors:
 - Blake Astley
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-11-21 00:00:00.000000000 Z
+date: 2023-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,56 +16,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: 7.0.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: 7.0.8
 - !ruby/object:Gem::Dependency
-  name: nokogiri
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '2.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '2.7'
 - !ruby/object:Gem::Dependency
-  name: tty-prompt
+  name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.23.1
+        version: '1.13'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.23.1
+        version: '1.13'
 - !ruby/object:Gem::Dependency
-  name: faraday
+  name: tty-prompt
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: 0.23.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: 0.23.1
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -173,10 +173,13 @@ files:
 - lib/aocli/advent_of_code.rb
 - lib/aocli/advent_of_code/client.rb
 - lib/aocli/cli.rb
+- lib/aocli/commands/remove_cookie.rb
+- lib/aocli/commands/remove_template_path.rb
 - lib/aocli/commands/save_cookie.rb
+- lib/aocli/commands/set_template_path.rb
 - lib/aocli/commands/start_day.rb
+- lib/aocli/config.rb
 - lib/aocli/content/main.txt
-- lib/aocli/cookie_retriever.rb
 - lib/aocli/file_utils.rb
 - lib/aocli/values.rb
 - lib/aocli/version.rb
@@ -205,7 +208,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.3.25
 signing_key:
 specification_version: 4
 summary: Command line application to retrieve advent of code challenges

data/lib/aocli/cookie_retriever.rb

@@ -1,18 +0,0 @@
-require("yaml")
-
-module Aocli
-  module CookieRetriever
-    module_function
-
-    def call
-      return unless file_exists?
-
-      config = YAML.load_file(Aocli::Values::CONFIG_FILE_PATH)
-      config[:cookie]
-    end
-
-    def file_exists?
-      File.file?(Aocli::Values::CONFIG_FILE_PATH)
-    end
-  end
-end