aoc_cli 0.2.3 → 1.0.1

data/lib/aoc_cli/views/help/event/attach.erb

@@ -0,0 +1,32 @@
+aoc event attach
+
+Description:
+
+  Attaches an existing event to the specified directory (defaults to current
+  directory). This may be useful if the original directories have been moved
+  or deleted.
+
+  This command cannot be executed from, or target, a directory that is already
+  managed by aoc (i.e., existing event and puzzle directories).
+
+  The command will fail if the event has not already been initialized. To
+  create a new event, see the event init command.
+
+Usage:
+
+  aoc event attach <year> [--dir=<dir>]
+
+  * <year>: Year of the event to relocate.
+  * <dir>: The new event directory (default ".").
+
+Examples:
+
+  aoc event attach 2023 (in a non-AoC directory)
+
+  Relocates the 2023 event directory to the current directory
+
+
+  aoc event attach 2023 --dir /foo/bar/aoc
+
+  Relocates the 2023 event directory to the specified directory.
+

data/lib/aoc_cli/views/help/event/init.erb

@@ -0,0 +1,38 @@
+aoc event init
+
+Description:
+
+  Initializes the event for the specified year by fetching event stats and
+  creating an event directory in the target directory. The target directory
+  defaults to the current directory but can be explicitly specified with the
+  optional --dir String argument.
+
+  The event directory serves as the location of event puzzle directories. For
+  more information, refer to puzzle init. The name of the created event
+  directory defaults to the event year.
+
+  This command cannot be executed from, or target, a directory that is already
+  managed by aoc (i.e., existing event and puzzle directories).
+
+  The command will fail if the event has already been initialized elsewhere. To
+  move an existing event's location, see the event attach command.
+
+Usage:
+
+  aoc event init <year> [--dir=<dir>]
+
+  * <year>: Year of the event to initialize.
+  * <dir>: Base directory to initialize the event within (default ".").
+
+Examples:
+
+  aoc event init 2023 (in a non-AoC directory)
+
+  Initializes the 2023 event and creates the 2023 event directory inside the
+  current directory.
+
+  aoc event init 2023 --dir /foo/bar/aoc
+
+  Initializes the 2023 event and creates the 2023 event directory in the
+  specified directory.
+

data/lib/aoc_cli/views/help/event/progress.erb

@@ -0,0 +1,12 @@
+aoc event progress
+
+Description:
+
+  Prints a table displaying progress (stars) for the current event.
+
+  This command can be run from both event and puzzle directories.
+
+Usage:
+
+  aoc event progress
+

data/lib/aoc_cli/views/help/puzzle/attempts.erb

@@ -0,0 +1,12 @@
+aoc puzzle attempts
+
+Description:
+
+  This command can only be run from a puzzle directory (see puzzle init).
+
+  Shows posted solution attempts for the current puzzle.
+
+Usage:
+
+  aoc puzzle attempts
+

data/lib/aoc_cli/views/help/puzzle/init.erb

@@ -0,0 +1,31 @@
+aoc puzzle init
+
+Description:
+
+  This command can only be run from an event directory (see event init).
+
+  Initialises the given day's puzzle for the current event. This fetches
+  the puzzle prompt and input from Advent of Code, creates a puzzle directory,
+  and writes the puzzle files to it.
+
+  Once initialised, the new puzzle directory contains two files:
+  * Markdown puzzle prompt (format "day_<day>.md")
+  * Plain text puzzle input (format "input")
+
+  These files can be restored at any time using puzzle sync.
+
+  The puzzle directory is a good place to write puzzle solution code and review
+  previous solution attempts. See puzzle solve and puzzle attempts respectively
+
+Usage:
+
+  aoc puzzle init <day>
+
+  * <day>: Day of puzzle to initialise (1-25).
+
+Examples:
+
+  aoc puzzle init 20 (in an event directory)
+
+  Initializes the day 20 puzzle and creates puzzle directory
+

data/lib/aoc_cli/views/help/puzzle/solve.erb

@@ -0,0 +1,33 @@
+aoc puzzle solve
+
+Description:
+
+  This command can only be run from a puzzle directory (see puzzle init).
+
+  Posts the given answer to Advent of Code for the current puzzle. The response
+  will have one of three possible states:
+
+    1. Correct
+    2. Incorrect
+    3. Rate-limited
+
+  If the attempt was correct, relevant stats are updated and the puzzle files
+  are refreshed to include any new puzzle information.
+
+  If the attempt was incorrect or rate-limited, the required wait time will be
+  indicated to the nearest minute.
+
+  Previous attempt data can be reviewed with the puzzle attempts command.
+
+Usage:
+
+  aoc puzzle solve --answer=<answer>
+
+  * <answer>: The puzzle solution to attempt
+
+Examples:
+
+  aoc puzzle solve --answer abcdef (in a puzzle directory)
+
+  Initializes the day 20 puzzle and creates puzzle directory
+

data/lib/aoc_cli/views/help/puzzle/sync.erb

@@ -0,0 +1,32 @@
+aoc puzzle sync
+
+Description:
+
+  This command can only be run from a puzzle directory (see puzzle init).
+
+  Restores puzzle dir files (puzzle and input) to their cached state.
+
+  Puzzle data is cached when puzzles are initialised and correctly solved in
+  order to decrease load on Advent of Code and increase performance. However
+  there may be situations where the cache is outdated: for example if puzzles
+  have been solved from the browser.
+
+  To fetch and write the latest puzzle data, pass the --skip-cache flag.
+
+Usage:
+
+  aoc puzzle sync [--skip-cache]
+
+  * <skip-cache>: Whether to ignore puzzle file cache (default false)
+
+Examples:
+
+  aoc puzzle sync (in a puzzle directory)
+
+  Restores (writes or updates) puzzle files to cached state.
+
+
+  aoc puzzle sync --skip-cache (in a puzzle directory)
+
+  Puzzle data is refreshed before writing the puzzle files.
+

data/lib/aoc_cli/views/puzzle/init.erb

@@ -0,0 +1,3 @@
+<%= success_tag %>: puzzle initialised
+  event  <%= @puzzle.year %>
+  day    <%= @puzzle.day %>

data/lib/aoc_cli/views/puzzle/solve.erb

@@ -0,0 +1,10 @@
+<% if @attempt.rate_limited? -%>
+<%= "Rate limited".yellow.bold %>: please wait <%= @attempt.wait_time %> minutes.
+<% elsif @attempt.incorrect? -%>
+<%= "Incorrect".red.bold %>: please wait <%= @attempt.wait_time %> minutes.
+<% unless @attempt.hint.nil? -%>
+Hint: your answer is <%= @attempt.presenter.hint.downcase %>
+<% end -%>
+<% elsif @attempt.correct? -%>
+<%= "Correct".green.bold %>: part <%= @attempt.level %> complete.
+<% end -%>

data/lib/aoc_cli.rb

@@ -1,19 +1,39 @@
-require 'colorize'
-
-require_relative 'aoc_cli/errors'
-require_relative 'aoc_cli/interface'
-require_relative "aoc_cli/version"
-require_relative 'aoc_cli/files'
-require_relative 'aoc_cli/commands'
-require_relative 'aoc_cli/tools'
-require_relative 'aoc_cli/year'
-require_relative 'aoc_cli/day'
-require_relative 'aoc_cli/solve'
-require_relative 'aoc_cli/database'
-require_relative 'aoc_cli/paths'
-require_relative 'aoc_cli/tables'
+require "fileutils"
+require "forwardable"
+require "http"
+require "kangaru"
+require "nokogiri"
+require "reverse_markdown"
+require "terminal-table"
 
 module AocCli
-	Metafile = AocCli::Files::Metafile
-	Prefs    = AocCli::Files::Config::Prefs
+  extend Kangaru::Initialiser
+
+  config_path File.expand_path("~/.config/aoc_cli/config.yml")
+
+  config_path "spec/aoc.yml", env: :test
+
+  configure do |config|
+    migration_path = File.join(
+      File.expand_path(__dir__ || raise), "../db/migrate"
+    )
+
+    config.database.adaptor = :sqlite
+    config.database.path = File.expand_path("~/.local/share/aoc/aoc.sqlite3")
+    config.database.migration_path = migration_path
+  end
+
+  configure env: :test do |config|
+    config.database.path = "db/test.sqlite3"
+  end
+
+  apply_config!
+
+  Sequel::Model.plugin(:polymorphic)
+  Sequel::Model.plugin(:enum)
+
+  Terminal::Table::Style.defaults = {
+    border: :unicode,
+    alignment: :center
+  }
 end

data/rbs_collection.lock.yaml

@@ -0,0 +1,168 @@
+---
+path: ".gems"
+gems:
+- name: activesupport
+  version: '7.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: ec140aff951e3af39846eed4525ba5d040d294fa
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: addressable
+  version: '2.8'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: ec140aff951e3af39846eed4525ba5d040d294fa
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: base64
+  version: '0'
+  source:
+    type: stdlib
+- name: bigdecimal
+  version: '0'
+  source:
+    type: stdlib
+- name: cgi
+  version: '0'
+  source:
+    type: stdlib
+- name: colorize
+  version: '1.1'
+  source:
+    type: git
+    name: apexatoll/gem_signatures
+    revision: aad38d45071ab6a1389c58052d06604f0ef71591
+    remote: https://github.com/apexatoll/gem_signatures
+    repo_dir: sig
+- name: concurrent-ruby
+  version: '1.1'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: ec140aff951e3af39846eed4525ba5d040d294fa
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: connection_pool
+  version: '2.4'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: ec140aff951e3af39846eed4525ba5d040d294fa
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: date
+  version: '0'
+  source:
+    type: stdlib
+- name: erb
+  version: '0'
+  source:
+    type: stdlib
+- name: fileutils
+  version: '0'
+  source:
+    type: stdlib
+- name: forwardable
+  version: '0'
+  source:
+    type: stdlib
+- name: http
+  version: '5.1'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: ec140aff951e3af39846eed4525ba5d040d294fa
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: i18n
+  version: '1.10'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: ec140aff951e3af39846eed4525ba5d040d294fa
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: kangaru
+  version: '0.2'
+  source:
+    type: git
+    name: apexatoll/gem_signatures
+    revision: aad38d45071ab6a1389c58052d06604f0ef71591
+    remote: https://github.com/apexatoll/gem_signatures
+    repo_dir: sig
+- name: logger
+  version: '0'
+  source:
+    type: stdlib
+- name: minitest
+  version: '0'
+  source:
+    type: stdlib
+- name: monitor
+  version: '0'
+  source:
+    type: stdlib
+- name: mutex_m
+  version: '0'
+  source:
+    type: stdlib
+- name: nokogiri
+  version: '1.11'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: ec140aff951e3af39846eed4525ba5d040d294fa
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: pathname
+  version: '0'
+  source:
+    type: stdlib
+- name: securerandom
+  version: '0'
+  source:
+    type: stdlib
+- name: sequel
+  version: '5.72'
+  source:
+    type: git
+    name: apexatoll/gem_signatures
+    revision: aad38d45071ab6a1389c58052d06604f0ef71591
+    remote: https://github.com/apexatoll/gem_signatures
+    repo_dir: sig
+- name: singleton
+  version: '0'
+  source:
+    type: stdlib
+- name: tempfile
+  version: '0'
+  source:
+    type: stdlib
+- name: terminal-table
+  version: '3.0'
+  source:
+    type: git
+    name: apexatoll/gem_signatures
+    revision: aad38d45071ab6a1389c58052d06604f0ef71591
+    remote: https://github.com/apexatoll/gem_signatures
+    repo_dir: sig
+- name: time
+  version: '0'
+  source:
+    type: stdlib
+- name: timeout
+  version: '0'
+  source:
+    type: stdlib
+- name: zeitwerk
+  version: '2.6'
+  source:
+    type: git
+    name: apexatoll/gem_signatures
+    revision: aad38d45071ab6a1389c58052d06604f0ef71591
+    remote: https://github.com/apexatoll/gem_signatures
+    repo_dir: sig
+gemfile_lock_path: Gemfile.lock

data/rbs_collection.yaml

@@ -0,0 +1,28 @@
+sources:
+  - type: git
+    name: ruby/gem_rbs_collection
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    revision: main
+    repo_dir: gems
+
+  - type: git
+    name: apexatoll/gem_signatures
+    remote: https://github.com/apexatoll/gem_signatures
+    revision: main
+    repo_dir: sig
+
+path: .gems
+
+gems:
+  - name: date
+  - name: fileutils
+  - name: forwardable
+  - name: pathname
+  - name: rake
+    ignore: true
+  - name: rspec
+    ignore: true
+  - name: rubocop
+    ignore: true
+  - name: steep
+    ignore: true

data/sig/aoc_cli/components/attempts_table.rbs

@@ -0,0 +1,29 @@
+module AocCli
+  module Components
+    class AttemptsTable < Kangaru::Component
+      attr_reader puzzle: Puzzle
+
+      def initialize: (puzzle: Puzzle) -> void
+
+      def title: -> String
+
+      def headings: -> Array[String]
+
+      def rows: -> Array[Array[untyped] | Symbol]
+
+      private
+
+      attr_reader level_one_rows: Array[Array[untyped]]
+
+      attr_reader level_two_rows: Array[Array[untyped]]
+
+      def separator: -> Symbol?
+
+      def level_one_attempts: -> Array[Attempt]
+
+      def level_two_attempts: -> Array[Attempt]
+
+      def rows_for: (Array[Attempt]) -> Array[Array[untyped]]
+    end
+  end
+end

data/sig/aoc_cli/components/docs_component.rbs

@@ -0,0 +1,15 @@
+module AocCli
+  module Components
+    class DocsComponent < Kangaru::Component
+      include Helpers::ViewHelper
+
+      ENDPOINTS: Hash[Symbol, untyped]
+
+      def endpoints: -> Hash[Symbol, untyped]
+
+      def title: -> String
+
+      def commands_table: (Hash[Symbol, String], ?indent: Integer) -> String
+    end
+  end
+end

data/sig/aoc_cli/components/errors_component.rbs

@@ -0,0 +1,19 @@
+module AocCli
+  module Components
+    class ErrorsComponent < Kangaru::Component
+      attr_reader messages: Array[String]
+
+      def initialize: (*String) -> void
+
+      def render: -> void
+      
+      def self.from_model: (untyped) -> ErrorsComponent
+
+      private
+
+      def render?: -> bool
+
+      def title: -> String
+    end
+  end
+end

data/sig/aoc_cli/components/progress_table.rbs

@@ -0,0 +1,28 @@
+module AocCli
+  module Components
+    class ProgressTable < Kangaru::Component
+      attr_reader event: Event
+
+      def initialize: (event: Event) -> void
+
+      private
+
+      type row = [String, String]
+
+      TITLE: String
+      HEADINGS: Array[String]
+      PROGRESS: String
+      TOTAL: String
+
+      def title: -> String
+
+      def headings: -> Array[String]
+
+      def rows: -> Array[row | Symbol]
+
+      def progress_rows: -> Array[row]
+
+      def total_row: -> row
+    end
+  end
+end

data/sig/aoc_cli/components/puzzle_sync_component.rbs

@@ -0,0 +1,19 @@
+module AocCli
+  module Components
+    class PuzzleSyncComponent < Kangaru::Component
+      extend Forwardable
+
+      include Helpers::ViewHelper
+
+      attr_reader log: PuzzleDirSyncLog
+
+      def puzzle: -> Puzzle
+
+      def initialize: (log: PuzzleDirSyncLog) -> void
+
+      private
+
+      def status_rows: -> Array[[untyped, untyped]]
+    end
+  end
+end

data/sig/aoc_cli/configurators/session_configurator.rbs

@@ -0,0 +1,7 @@
+module AocCli
+  module Configurators
+    class SessionConfigurator < Kangaru::Configurator
+      attr_accessor token: String
+    end
+  end
+end

data/sig/aoc_cli/controllers/application_controller.rbs

@@ -0,0 +1,12 @@
+module AocCli
+  class ApplicationController < Kangaru::Controller
+    include Concerns::ErrorConcern
+    include Concerns::LocationConcern
+
+    include Helpers::ViewHelper
+
+    private
+
+    def handle_help_param!: -> void
+  end
+end

data/sig/aoc_cli/controllers/concerns/error_concern.rbs

@@ -0,0 +1,9 @@
+module AocCli
+  module Concerns
+    module ErrorConcern
+      def render_error!: (String) -> false
+
+      def render_model_errors!: (untyped) -> false
+    end
+  end
+end

data/sig/aoc_cli/controllers/concerns/location_concern.rbs

@@ -0,0 +1,35 @@
+module AocCli
+  module Concerns
+    module LocationConcern
+      include ErrorConcern
+
+      def current_path: -> String
+
+      def current_location: -> Location?
+
+      def current_event: -> Event?
+
+      def current_puzzle: -> Puzzle?
+
+      def ensure_in_event_dir!: -> bool
+
+      def ensure_in_puzzle_dir!: -> bool
+
+      def ensure_in_aoc_dir!: -> bool
+
+      def ensure_not_in_aoc_dir!: -> bool
+      
+      private
+
+      ERRORS: Hash[Symbol, String]
+
+      def current_resource: -> untyped
+
+      def in_event_dir?: -> bool
+
+      def in_puzzle_dir?: -> bool
+
+      def in_aoc_dir?: -> bool
+    end
+  end
+end

data/sig/aoc_cli/controllers/default_controller.rbs

@@ -0,0 +1,7 @@
+module AocCli
+  class DefaultController < ApplicationController
+    def default: -> void
+
+    alias help default
+  end
+end

data/sig/aoc_cli/controllers/event_controller.rbs

@@ -0,0 +1,18 @@
+module AocCli
+  class EventController < ApplicationController
+    @event: Event
+
+    def init: -> void
+
+    @source: String
+    @target: String
+
+    def attach: -> void
+
+    def progress: -> void
+
+    private
+
+    attr_reader queried_event: Event?
+  end
+end

data/sig/aoc_cli/controllers/help/event_controller.rbs

@@ -0,0 +1,11 @@
+module AocCli
+  module Help
+    class EventController < ApplicationController
+      def init: -> void
+
+      def attach: -> void
+
+      def progress: -> void
+    end
+  end
+end