aoc_cli 0.2.3 → 1.0.0

data/db/migrate/6_create_puzzle_dir_sync_logs.rb

@@ -0,0 +1,18 @@
+Sequel.migration do
+  change do
+    create_table :puzzle_dir_sync_logs do
+      primary_key :id
+
+      foreign_key :puzzle_id, :puzzles, null: false
+      foreign_key :location_id, :locations, null: false
+
+      integer :puzzle_status, null: false
+      integer :input_status, null: false
+
+      datetime :created_at
+      datetime :updated_at
+
+      index %i[puzzle_id location_id]
+    end
+  end
+end

data/exe/aoc

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "aoc_cli"
+
+AocCli.run!(*ARGV)

data/lib/aoc_cli/components/attempts_table.erb

@@ -0,0 +1,5 @@
+<% if puzzle.attempts.empty? -%>
+No attempts have been made for this puzzle.
+<% else -%>
+<%= Terminal::Table.new(title:, headings:, rows:) %>
+<% end -%>

data/lib/aoc_cli/components/attempts_table.rb

@@ -0,0 +1,58 @@
+module AocCli
+  module Components
+    class AttemptsTable < Kangaru::Component
+      attr_reader :puzzle
+
+      def initialize(puzzle:)
+        @puzzle = puzzle
+      end
+
+      def title
+        "Advent of Code: #{puzzle.presenter.date}"
+      end
+
+      def headings
+        %w[Answer Status Time Hint]
+      end
+
+      def rows
+        [*level_one_rows, separator, *level_two_rows].compact
+      end
+
+      private
+
+      def level_one_rows
+        @level_one_rows ||= rows_for(level_one_attempts)
+      end
+
+      def separator
+        return if level_one_rows.empty? || level_two_rows.empty?
+
+        :separator
+      end
+
+      def level_two_rows
+        @level_two_rows ||= rows_for(level_two_attempts)
+      end
+
+      def level_one_attempts
+        puzzle.attempts_dataset.where(level: 1).order(:created_at).to_a
+      end
+
+      def level_two_attempts
+        puzzle.attempts_dataset.where(level: 2).order(:created_at).to_a
+      end
+
+      def rows_for(attempts)
+        attempts.map do |attempt|
+          [
+            attempt.answer,
+            attempt.presenter.status,
+            attempt.created_at,
+            attempt.presenter.hint
+          ]
+        end
+      end
+    end
+  end
+end

data/lib/aoc_cli/components/docs_component.erb

@@ -0,0 +1,19 @@
+
+<%= heading(title) %> <<%= AocCli::VERSION.blue %>>
+
+A command-line interface for the Advent of Code puzzles.
+
+Features include downloading puzzles and inputs, solving puzzles and
+tracking year progress from within the terminal.
+
+This is an unofficial project with no affiliation to Advent of Code.
+
+<% endpoints.each do |controller, data| %>
+  <%= heading(controller) %>
+
+  <%= data[:description] %>
+
+  Usage: <%= "aoc #{controller}".blue %> <%= "<command>".cyan %>
+
+<%= commands_table(data[:commands], indent: 4) %>
+<% end -%>

data/lib/aoc_cli/components/docs_component.rb

@@ -0,0 +1,41 @@
+module AocCli
+  module Components
+    class DocsComponent < Kangaru::Component
+      include Helpers::ViewHelper
+
+      ENDPOINTS = {
+        event: {
+          description: "Handle event directories",
+          commands: {
+            init: "Create and initialise an event directory",
+            progress: "Check your progress for the current event"
+          }
+        },
+
+        puzzle: {
+          description: "Handle puzzle directories",
+          commands: {
+            init: "Fetch and initialise puzzles for the current event",
+            solve: "Submit and evaluate a puzzle solution",
+            sync: "Ensure puzzle files are up to date",
+            attempts: "Review previous attempts for the current puzzle"
+          }
+        }
+      }.freeze
+
+      def endpoints
+        ENDPOINTS
+      end
+
+      def title
+        "Advent of Code CLI"
+      end
+
+      def commands_table(commands, indent: 0)
+        rows = commands.transform_keys(&:to_s).to_a
+
+        table_for(*rows, gap: 4, indent:)
+      end
+    end
+  end
+end

data/lib/aoc_cli/components/errors_component.erb

@@ -0,0 +1,8 @@
+<% if messages.count == 1 -%>
+<%= title.red %>: <%= messages.first %>
+<% else -%>
+<%= title.red %>:
+<% messages.each do |message| -%>
+  <%= "\u2022 #{message}" %>
+<% end -%>
+<% end -%>

data/lib/aoc_cli/components/errors_component.rb

@@ -0,0 +1,36 @@
+module AocCli
+  module Components
+    class ErrorsComponent < Kangaru::Component
+      attr_reader :messages
+
+      def initialize(*messages)
+        @messages = messages
+      end
+
+      # TODO: remove once Kangaru has native conditional rendering
+      def render
+        return unless render?
+
+        super
+      end
+
+      def self.from_model(model)
+        errors = model.errors.map(&:full_message)
+
+        new(*errors)
+      end
+
+      private
+
+      def render?
+        !messages.empty?
+      end
+
+      # TODO: move this to a const when Kangaru allows binding-agnostic
+      # component constants (like controllers).
+      def title
+        "Error"
+      end
+    end
+  end
+end

data/lib/aoc_cli/components/progress_table.erb

@@ -0,0 +1 @@
+<%= Terminal::Table.new(headings:, rows:, title:)  %>

data/lib/aoc_cli/components/progress_table.rb

@@ -0,0 +1,43 @@
+module AocCli
+  module Components
+    class ProgressTable < Kangaru::Component
+      attr_reader :event
+
+      def initialize(event:)
+        @event = event
+      end
+
+      private
+
+      TITLE    = "Advent of Code: %{year}".freeze
+      HEADINGS = %w[Day Progress].freeze
+      PROGRESS = "Day %{day}".freeze
+      TOTAL    = "Total".freeze
+
+      def title
+        format(TITLE, year: event.year)
+      end
+
+      def headings
+        HEADINGS
+      end
+
+      def rows
+        [*progress_rows, :separator, total_row]
+      end
+
+      def progress_rows
+        1.upto(25).map do |day|
+          [
+            format(PROGRESS, day:),
+            event.stats.presenter.progress_icons(day)
+          ]
+        end
+      end
+
+      def total_row
+        [TOTAL, event.stats.presenter.total_progress]
+      end
+    end
+  end
+end

data/lib/aoc_cli/components/puzzle_sync_component.erb

@@ -0,0 +1,2 @@
+Puzzle <%= puzzle.presenter.date %> dir synchronised
+<%= table_for(*status_rows, indent: 2) -%>

data/lib/aoc_cli/components/puzzle_sync_component.rb

@@ -0,0 +1,26 @@
+module AocCli
+  module Components
+    class PuzzleSyncComponent < Kangaru::Component
+      extend Forwardable
+
+      include Helpers::ViewHelper
+
+      attr_reader :log
+
+      def_delegators :log, :puzzle
+
+      def initialize(log:)
+        @log = log
+      end
+
+      private
+
+      def status_rows
+        [
+          [puzzle.presenter.puzzle_filename, log.puzzle_status],
+          [puzzle.presenter.input_filename, log.input_status]
+        ]
+      end
+    end
+  end
+end

data/lib/aoc_cli/configurators/session_configurator.rb

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

data/lib/aoc_cli/controllers/application_controller.rb

@@ -0,0 +1,27 @@
+module AocCli
+  class ApplicationController < Kangaru::Controller
+    include Concerns::ErrorConcern
+    include Concerns::LocationConcern
+
+    include Helpers::ViewHelper
+
+    def execute
+      return handle_help_param! if params[:help]
+
+      super
+    rescue Core::Processor::Error => e
+      render_model_errors!(e.processor)
+    end
+
+    private
+
+    def handle_help_param!
+      params.delete(:help)
+
+      path = File.join("/help", request.path)
+      request = Kangaru::Request.new(path:, params:)
+
+      Kangaru.application!.router.resolve(request)
+    end
+  end
+end

data/lib/aoc_cli/controllers/concerns/error_concern.rb

@@ -0,0 +1,17 @@
+module AocCli
+  module Concerns
+    module ErrorConcern
+      def render_error!(error)
+        Components::ErrorsComponent.new(error).render
+
+        false
+      end
+
+      def render_model_errors!(model)
+        Components::ErrorsComponent.from_model(model).render
+
+        false
+      end
+    end
+  end
+end

data/lib/aoc_cli/controllers/concerns/location_concern.rb

@@ -0,0 +1,79 @@
+module AocCli
+  module Concerns
+    module LocationConcern
+      def current_path
+        File.expand_path(".")
+      end
+
+      def current_location
+        Location.first(path: current_path)
+      end
+
+      def current_event
+        case current_resource
+        when Event then current_resource
+        when Puzzle then current_resource.event
+        end
+      end
+
+      def current_puzzle
+        case current_resource
+        when Puzzle then current_resource
+        end
+      end
+
+      def ensure_in_event_dir!
+        return true if in_event_dir?
+
+        render_error!(ERRORS[:not_in_event])
+      end
+
+      def ensure_in_puzzle_dir!
+        return true if in_puzzle_dir?
+
+        render_error!(ERRORS[:not_in_puzzle])
+      end
+
+      def ensure_in_aoc_dir!
+        return true if in_aoc_dir?
+
+        render_error!(ERRORS[:not_in_aoc])
+      end
+
+      def ensure_not_in_aoc_dir!
+        return true unless in_aoc_dir?
+
+        render_error!(ERRORS[:in_aoc])
+      end
+
+      private
+
+      ERRORS = {
+        not_in_event:
+          "Action can't be performed outside event directory",
+        not_in_puzzle:
+          "Action can't be performed outside puzzle directory",
+        not_in_aoc:
+          "Action can't be performed outside Advent of Code directory",
+        in_aoc:
+          "Action can't be performed from Advent of Code directory"
+      }.freeze
+
+      def current_resource
+        current_location&.resource
+      end
+
+      def in_event_dir?
+        current_location&.event_dir? || false
+      end
+
+      def in_puzzle_dir?
+        current_location&.puzzle_dir? || false
+      end
+
+      def in_aoc_dir?
+        in_event_dir? || in_puzzle_dir?
+      end
+    end
+  end
+end

data/lib/aoc_cli/controllers/default_controller.rb

@@ -0,0 +1,9 @@
+module AocCli
+  class DefaultController < ApplicationController
+    def default
+      Components::DocsComponent.new.render
+    end
+
+    alias help default
+  end
+end

data/lib/aoc_cli/controllers/event_controller.rb

@@ -0,0 +1,35 @@
+module AocCli
+  class EventController < ApplicationController
+    def init
+      return unless ensure_not_in_aoc_dir!
+
+      @event = Processors::EventInitialiser.run!(
+        year: target_id,
+        dir: params[:dir] || current_path
+      )
+    end
+
+    def attach
+      return render_error!("Event does not exist") if queried_event.nil?
+
+      @source = queried_event.location.path
+
+      @target = Processors::ResourceAttacher.run!(
+        resource: queried_event,
+        path: params[:dir] || current_path
+      ).path
+    end
+
+    def progress
+      return unless ensure_in_aoc_dir!
+
+      Components::ProgressTable.new(event: current_event || raise).render
+    end
+
+    private
+
+    def queried_event
+      @queried_event ||= Event.first(year: target_id)
+    end
+  end
+end

data/lib/aoc_cli/controllers/help/event_controller.rb

@@ -0,0 +1,11 @@
+module AocCli
+  module Help
+    class EventController < ApplicationController
+      def init = true
+
+      def attach = true
+
+      def progress = true
+    end
+  end
+end

data/lib/aoc_cli/controllers/help/puzzle_controller.rb

@@ -0,0 +1,13 @@
+module AocCli
+  module Help
+    class PuzzleController < ApplicationController
+      def init = true
+
+      def solve = true
+
+      def sync = true
+
+      def attempts = true
+    end
+  end
+end

data/lib/aoc_cli/controllers/puzzle_controller.rb

@@ -0,0 +1,39 @@
+module AocCli
+  class PuzzleController < ApplicationController
+    def init
+      return unless ensure_in_event_dir!
+
+      @puzzle = Processors::PuzzleInitialiser.run!(
+        event: current_event,
+        day: target_id
+      )
+    end
+
+    def solve
+      return unless ensure_in_puzzle_dir!
+
+      @attempt = Processors::SolutionPoster.run!(
+        puzzle: current_puzzle,
+        answer: params[:answer]
+      )
+    end
+
+    def sync
+      return unless ensure_in_puzzle_dir!
+
+      @sync_log = Processors::PuzzleDirSynchroniser.run!(
+        puzzle: current_puzzle,
+        location: current_location,
+        skip_cache: params[:skip_cache] || false
+      )
+
+      Components::PuzzleSyncComponent.new(log: @sync_log).render
+    end
+
+    def attempts
+      return unless ensure_in_puzzle_dir!
+
+      Components::AttemptsTable.new(puzzle: current_puzzle || raise).render
+    end
+  end
+end

data/lib/aoc_cli/core/attempt_parser.rb

@@ -0,0 +1,69 @@
+module AocCli
+  module Core
+    class AttemptParser
+      attr_reader :response
+
+      def initialize(response)
+        @response = response
+      end
+
+      def to_h
+        { status:, hint:, wait_time: }.compact
+      end
+
+      private
+
+      module Prefixes
+        CORRECT      = /^That's the right answer/
+        INCORRECT    = /^That's not the right answer/
+        RATE_LIMITED = /^You gave an answer too recently/
+        WRONG_LEVEL  = /^You don't seem to be solving the right level/
+      end
+
+      module Hints
+        TOO_LOW  = /your answer is too low/
+        TOO_HIGH = /your answer is too high/
+      end
+
+      module WaitTimes
+        ONE_MINUTE          = /one minute/
+        INCORRECT_FORMAT    = /(\d+) minutes/
+        RATE_LIMITED_FORMAT = /(?:(\d+)m)/
+      end
+
+      def status
+        case response
+        when Prefixes::CORRECT      then :correct
+        when Prefixes::INCORRECT    then :incorrect
+        when Prefixes::RATE_LIMITED then :rate_limited
+        when Prefixes::WRONG_LEVEL  then :wrong_level
+        else raise "unexpected response"
+        end
+      end
+
+      def hint
+        case response
+        when Hints::TOO_LOW  then :too_low
+        when Hints::TOO_HIGH then :too_high
+        end
+      end
+
+      def wait_time
+        case status
+        when :incorrect    then scan_incorrect_wait_time!
+        when :rate_limited then scan_rated_limited_wait_time!
+        end
+      end
+
+      def scan_incorrect_wait_time!
+        return 1 if response.match?(WaitTimes::ONE_MINUTE)
+
+        response.scan(WaitTimes::INCORRECT_FORMAT).flatten.first.to_i
+      end
+
+      def scan_rated_limited_wait_time!
+        response.scan(WaitTimes::RATE_LIMITED_FORMAT).flatten.first.to_i
+      end
+    end
+  end
+end

data/lib/aoc_cli/core/processor.rb

@@ -0,0 +1,32 @@
+module AocCli
+  module Core
+    class Processor
+      extend Forwardable
+
+      include Kangaru::Attributable
+      include Kangaru::Validatable
+
+      class Error < StandardError
+        attr_reader :processor
+
+        def initialize(processor)
+          @processor = processor
+        end
+      end
+
+      def run
+        raise NotImplementedError
+      end
+
+      def run!
+        raise(Error, self) unless valid?
+
+        run
+      end
+
+      def self.run!(...)
+        new(...).run!
+      end
+    end
+  end
+end