aoc_cli 0.2.3 → 1.0.0

data/sig/aoc_cli/core/processor.rbs

@@ -0,0 +1,25 @@
+module AocCli
+  module Core
+    class Processor
+      extend Forwardable
+
+      include Kangaru::Attributable
+      extend Kangaru::Attributable::ClassMethods
+
+      include Kangaru::Validatable
+      extend Kangaru::Validatable::ClassMethods
+
+      class Error < StandardError
+        attr_reader processor: Processor
+
+        def initialize: (Processor) -> void
+      end
+
+      def run: -> untyped
+
+      def run!: -> untyped
+
+      def self.run!: (**untyped) -> untyped
+    end
+  end
+end

data/sig/aoc_cli/core/repository.rbs

@@ -0,0 +1,25 @@
+module AocCli
+  module Core
+    class Repository
+      HOST: String
+
+      RESOURCES: Hash[Symbol, Hash[Symbol, untyped]]
+
+      def self.get_stats: (year: Integer) -> Hash[Symbol, Integer]
+
+      def self.get_puzzle: (year: Integer, day: Integer) -> String
+
+      def self.get_input: (year: Integer, day: Integer) -> String
+
+      def self.post_solution: (
+        year: Integer, day: Integer, level: Integer, answer: untyped
+      ) -> Hash[Symbol, untyped]
+
+      private
+
+      def self.build_resource: (Symbol, **untyped) -> Resource
+
+      def self.format_url: (String, **untyped) -> String
+    end
+  end
+end

data/sig/aoc_cli/core/request.rbs

@@ -0,0 +1,29 @@
+module AocCli
+  module Core
+    class Request
+      extend Forwardable
+
+      attr_reader client: HTTP::Client
+
+      def initialize: (token: String) -> void
+
+      def get: (String) -> HTTP::Response
+
+      def post: (String, **untyped) -> HTTP::Response
+
+      def self.build: -> Request
+
+      def self.get: (String) -> HTTP::Response
+
+      def self.post: (String, **untyped) -> HTTP::Response
+
+      class ::Class
+        def def_delegators: (Symbol, *Symbol) -> void
+      end
+
+      private
+
+      def setup_client!: (String) -> HTTP::Client
+    end
+  end
+end

data/sig/aoc_cli/core/resource.rbs

@@ -0,0 +1,25 @@
+module AocCli
+  module Core
+    class Resource
+      attr_reader url: String
+      attr_reader scope: String?
+      attr_reader method: Symbol
+      attr_reader params: Hash[Symbol, untyped]
+
+      def initialize: (
+        url: String,
+        ?scope: String?,
+        ?method: Symbol,
+        ?params: Hash[Symbol, untyped]
+      ) -> void
+
+      def fetch: -> String
+
+      def fetch_markdown: -> String
+
+      private
+
+      def response: -> String
+    end
+  end
+end

data/sig/aoc_cli/core/stats_parser.rbs

@@ -0,0 +1,23 @@
+module AocCli
+  module Core
+    class StatsParser
+      DAY_CLASS_PREFIX: String
+      ONE_STAR_CLASS: String
+      TWO_STARS_CLASS: String
+
+      attr_reader calendar_html: String
+
+      def initialize: (String) -> void
+
+      def to_h: -> Hash[Symbol, Integer]
+
+      private
+
+      def calendar_link_classes: -> Array[Array[String]]
+
+      def calendar_links: -> Nokogiri::XML::NodeSet
+
+      def count_stars: (Array[String]) -> Integer
+    end
+  end
+end

data/sig/aoc_cli/helpers/table_generator.rbs

@@ -0,0 +1,36 @@
+module AocCli
+  module Helpers
+    class TableGenerator
+      type matrix[T] = Array[Array[T]]
+
+      include Kangaru::Validatable
+      extend Kangaru::Validatable::ClassMethods
+
+      attr_reader rows: matrix[String]
+      attr_reader gap: Integer
+      attr_reader indent: Integer
+
+      def initialize: (
+        rows: matrix[String],
+        ?gap: Integer,
+        ?indent: Integer
+      ) -> void
+
+      def validate!: -> void
+
+      def generate!: -> String
+
+      private
+
+      CELL_GAP: Integer
+
+      attr_reader column_widths: Array[Integer]
+
+      def space: (Integer) -> String
+
+      def format_row!: (Array[String]) -> String
+
+      def validate_rows_are_same_length!: -> void
+    end
+  end
+end

data/sig/aoc_cli/helpers/view_helper.rbs

@@ -0,0 +1,15 @@
+module AocCli
+  module Helpers
+    module ViewHelper
+      def main_header: -> String
+
+      def heading: (String) -> String
+
+      def success_tag: -> String
+
+      def table_for: (*Array[String], ?gap: Integer, ?indent: Integer) -> String
+
+      def wrap_text: (String, ?width: Integer, ?indent: Integer) -> String
+    end
+  end
+end

data/sig/aoc_cli/models/attempt.rbs

@@ -0,0 +1,35 @@
+module AocCli
+  class Attempt < Kangaru::Model
+    attr_accessor id: Integer
+    attr_accessor level: Integer
+    attr_accessor answer: String
+    attr_accessor status: Symbol
+    attr_accessor hint: Symbol?
+    attr_accessor wait_time: Integer?
+    attr_accessor created_at: Time
+    attr_accessor updated_at: Time
+
+    attr_accessor puzzle: Puzzle
+    attr_accessor puzzle_dataset: Sequel::Dataset
+
+    attr_reader presenter: Presenters::AttemptPresenter
+
+    def incorrect?: -> bool
+    def correct?: -> bool
+    def rate_limited?: -> bool
+    def wrong_level?: -> bool
+
+    def too_low?: -> bool
+    def too_high?: -> bool
+
+    private
+
+    def validate_hint_not_set!: -> void
+
+    def validate_hint!: -> void
+
+    def validate_wait_time_not_set!: -> void
+
+    def validate_wait_time_integer!: -> void
+  end
+end

data/sig/aoc_cli/models/event.rbs

@@ -0,0 +1,17 @@
+module AocCli
+  class Event < Kangaru::Model
+    attr_accessor id: Integer
+    attr_accessor year: Integer
+    attr_accessor created_at: Time
+    attr_accessor updated_at: Time
+
+    attr_accessor puzzles: Array[Puzzle]
+    attr_accessor puzzles_dataset: Sequel::Dataset
+
+    attr_accessor stats: Stats
+    attr_accessor stats_dataset: Sequel::Dataset
+
+    attr_accessor location: Location
+    attr_accessor location_dataset: Sequel::Dataset
+  end
+end

data/sig/aoc_cli/models/location.rbs

@@ -0,0 +1,19 @@
+module AocCli
+  class Location < Kangaru::Model
+    type resource = (Event | Puzzle)
+
+    attr_accessor id: Integer
+    attr_accessor path: String
+    attr_accessor resource: resource
+    attr_accessor created_at: Time
+    attr_accessor updated_at: Time
+
+    def exists?: -> bool
+
+    def event_dir?: -> bool
+
+    def puzzle_dir?: -> bool
+
+    def to_pathname: -> Pathname
+  end
+end

data/sig/aoc_cli/models/puzzle.rbs

@@ -0,0 +1,28 @@
+module AocCli
+  class Puzzle < Kangaru::Model
+    extend Forwardable
+
+    attr_accessor id: Integer
+    attr_accessor event: Event
+    attr_accessor day: Integer
+    attr_accessor content: String
+    attr_accessor input: String
+    attr_accessor created_at: Time
+    attr_accessor updated_at: Time
+    attr_accessor part_one_completed_at: Time
+    attr_accessor part_two_completed_at: Time
+
+    attr_accessor location: Location
+    attr_accessor location_dataset: Sequel::Dataset
+
+    attr_accessor attempts: Array[Attempt]
+    attr_accessor attempts_dataset: Sequel::Dataset
+
+    # Delegated to event
+    def year: -> Integer
+
+    attr_reader presenter: Presenters::PuzzlePresenter
+
+    def mark_complete!: (Integer) -> void
+  end
+end

data/sig/aoc_cli/models/puzzle_dir_sync_log.rbs

@@ -0,0 +1,11 @@
+module AocCli
+  class PuzzleDirSyncLog < Kangaru::Model
+    attr_accessor id: Integer
+    attr_accessor puzzle: Puzzle
+    attr_accessor location: Location
+    attr_accessor puzzle_status: Symbol
+    attr_accessor input_status: Symbol
+
+    STATUS_ENUM: Hash[Symbol, Integer]
+  end
+end

data/sig/aoc_cli/models/stats.rbs

@@ -0,0 +1,53 @@
+module AocCli
+  class Stats < Kangaru::Model
+    extend Forwardable
+
+    attr_accessor id: Integer
+    attr_accessor day_1: Integer
+    attr_accessor day_2: Integer
+    attr_accessor day_3: Integer
+    attr_accessor day_4: Integer
+    attr_accessor day_5: Integer
+    attr_accessor day_6: Integer
+    attr_accessor day_7: Integer
+    attr_accessor day_8: Integer
+    attr_accessor day_9: Integer
+    attr_accessor day_10: Integer
+    attr_accessor day_11: Integer
+    attr_accessor day_12: Integer
+    attr_accessor day_13: Integer
+    attr_accessor day_14: Integer
+    attr_accessor day_15: Integer
+    attr_accessor day_16: Integer
+    attr_accessor day_17: Integer
+    attr_accessor day_18: Integer
+    attr_accessor day_19: Integer
+    attr_accessor day_20: Integer
+    attr_accessor day_21: Integer
+    attr_accessor day_22: Integer
+    attr_accessor day_23: Integer
+    attr_accessor day_24: Integer
+    attr_accessor day_25: Integer
+    attr_accessor created_at: Time
+    attr_accessor updated_at: Time
+    attr_accessor completed_at: Time
+
+    attr_accessor event: Event
+    attr_accessor event_dataset: Sequel::Dataset
+
+    # Delegated to event
+    def year: -> Integer
+
+    attr_reader presenter: Presenters::StatsPresenter
+
+    def total: -> Integer
+
+    def progress: (Integer) -> Integer
+
+    def current_level: (Integer) -> Integer?
+
+    def complete?: (Integer) -> bool
+
+    def advance_progress!: (Integer) -> void
+  end
+end

data/sig/aoc_cli/presenters/attempt_presenter.rbs

@@ -0,0 +1,13 @@
+module AocCli
+  module Presenters
+    class AttemptPresenter
+      attr_reader attempt: Attempt
+
+      def initialize: (Attempt) -> void
+
+      def status: -> String
+
+      def hint: -> String
+    end
+  end
+end

data/sig/aoc_cli/presenters/puzzle_presenter.rbs

@@ -0,0 +1,19 @@
+module AocCli
+  module Presenters
+    class PuzzlePresenter
+      attr_reader puzzle: Puzzle
+
+      def initialize: (Puzzle) -> void
+
+      def date: -> String
+
+      def puzzle_filename: -> String
+
+      def input_filename: -> String
+
+      private
+
+      def formatted_day: -> String
+    end
+  end
+end

data/sig/aoc_cli/presenters/stats_presenter.rbs

@@ -0,0 +1,19 @@
+module AocCli
+  module Presenters
+    class StatsPresenter
+      attr_reader stats: Stats
+
+      def initialize: (Stats) -> void
+
+      def total_progress: -> String
+
+      def progress_icons: (Integer) -> String
+
+      module Icons
+        INCOMPLETE: String
+        HALF_COMPLETE: String
+        COMPLETE: String
+      end
+    end
+  end
+end

data/sig/aoc_cli/processors/event_initialiser.rbs

@@ -0,0 +1,26 @@
+module AocCli
+  module Processors
+    class EventInitialiser < Core::Processor
+      attr_accessor year: Integer
+      attr_accessor dir: String
+
+      def self.run!: (year: untyped, dir: untyped) -> Event
+
+      private
+
+      attr_reader event_dir: Pathname
+
+      def create_event!: -> Event
+
+      def initialise_stats!: (Event) -> void
+
+      def make_event_directory!: -> void
+
+      def attach_event!: (Event) -> void
+
+      def validate_event_dir_does_not_exist!: -> void
+
+      def validate_event_not_already_initialised!: -> void
+    end
+  end
+end

data/sig/aoc_cli/processors/puzzle_dir_synchroniser.rbs

@@ -0,0 +1,40 @@
+module AocCli
+  module Processors
+    class PuzzleDirSynchroniser < Core::Processor
+      attr_accessor puzzle: Puzzle
+      attr_accessor location: Location
+      attr_accessor skip_cache: bool
+
+      def self.run!: (
+        puzzle: untyped,
+        location: untyped,
+        ?skip_cache: untyped
+      )-> PuzzleDirSyncLog
+
+      private
+
+      # Delegated to Puzzle
+      def year: -> Integer
+      def day: -> Integer
+      def presenter: -> Presenters::PuzzlePresenter
+
+      # Delegated to Presenter
+      def puzzle_filename: -> String
+      def input_filename: -> String
+
+      attr_reader puzzle_dir: Pathname
+      attr_reader puzzle_file: Pathname
+      attr_reader input_file: Pathname
+
+      def refresh_puzzle!: -> void
+
+      def create_puzzle_dir_sync_log!: -> PuzzleDirSyncLog
+
+      def puzzle_status: -> Symbol
+
+      def input_status: -> Symbol
+
+      def validate_puzzle_dir_exists!: -> void
+    end
+  end
+end

data/sig/aoc_cli/processors/puzzle_initialiser.rbs

@@ -0,0 +1,37 @@
+module AocCli
+  module Processors
+    class PuzzleInitialiser < Core::Processor
+      attr_accessor event: Event
+      attr_accessor day: Integer
+
+      def run: -> Puzzle
+
+      def self.run!: (event: untyped, day: untyped) -> Puzzle
+
+      private
+
+      # Delegated to Event
+      def year: -> Integer
+
+      attr_reader event_dir: Pathname
+      attr_reader puzzle_dir: Pathname
+      attr_reader existing_puzzle: Puzzle?
+
+      def fetch_content!: -> String
+
+      def fetch_input!: -> String
+
+      def create_or_update_puzzle!: (String, String) -> Puzzle
+
+      def attach_puzzle_dir!: (Puzzle) -> Location
+
+      def write_puzzle_files!: (Puzzle, Location) -> PuzzleDirSyncLog
+
+      def validate_event_location_set!: -> void
+
+      def validate_event_dir_exists!: -> void
+
+      def validate_puzzle_dir_does_not_exist!: -> void
+    end
+  end
+end

data/sig/aoc_cli/processors/puzzle_refresher.rbs

@@ -0,0 +1,21 @@
+module AocCli
+  module Processors
+    class PuzzleRefresher < Core::Processor
+      attr_accessor puzzle: Puzzle
+
+      def self.run!: (puzzle: Puzzle) -> Puzzle
+
+      private
+
+      extend Forwardable
+
+      def year: -> Integer
+
+      def day: -> Integer
+
+      def content: -> String
+
+      def input: -> String
+    end
+  end
+end

data/sig/aoc_cli/processors/resource_attacher.rbs

@@ -0,0 +1,16 @@
+module AocCli
+  module Processors
+    class ResourceAttacher < Core::Processor
+      type resource = Event | Puzzle
+
+      attr_accessor resource: resource
+      attr_accessor path: String
+
+      def run: -> Location
+
+      def self.run!: (resource: resource, path: String) -> Location
+
+      def location: -> Location?
+    end
+  end
+end

data/sig/aoc_cli/processors/solution_poster.rbs

@@ -0,0 +1,34 @@
+module AocCli
+  module Processors
+    class SolutionPoster < Core::Processor
+      attr_accessor puzzle: Puzzle
+      attr_accessor answer: Integer
+
+      def run: -> Attempt
+
+      def self.run!: (puzzle: untyped, answer: untyped) -> Attempt
+
+      private
+
+      # Delegated to @puzzle
+      def event: -> Event
+      def location: -> Location
+      def year: -> Integer
+      def day: -> Integer
+
+      attr_reader level: Integer
+
+      def post_solution!: -> Hash[Symbol, untyped]
+
+      def create_attempt!: (Hash[Symbol, untyped]) -> Attempt
+
+      def advance_puzzle!: -> void
+
+      def validate_puzzle_location_set!: -> void
+
+      def validate_stats_associated!: -> void
+
+      def validate_puzzle_not_complete!: -> void
+    end
+  end
+end

data/sig/aoc_cli/processors/stats_initialiser.rbs

@@ -0,0 +1,15 @@
+module AocCli
+  module Processors
+    class StatsInitialiser < Core::Processor
+      attr_accessor event: Event
+
+      private
+
+      BLANK_STATS: Hash[Symbol, Integer]
+
+      def fetch_stats!: -> Hash[Symbol, Integer]
+
+      def validate_stats_do_not_exist!: -> void
+    end
+  end
+end

data/sig/aoc_cli/processors/stats_refresher.rbs

@@ -0,0 +1,19 @@
+module AocCli
+  module Processors
+    class StatsRefresher < Core::Processor
+      extend Forwardable
+
+      attr_accessor stats: Stats
+
+      def run: -> Stats
+
+      def self.run!: (stats: Stats) -> Stats
+
+      private
+
+      def year: -> Integer
+
+      def updated_stats: -> Hash[Symbol, Integer]
+    end
+  end
+end

data/sig/aoc_cli/validators/collection_type_validator.rbs

@@ -0,0 +1,24 @@
+module AocCli
+  module Validators
+    class CollectionTypeValidator < Kangaru::Validator
+
+      private
+
+      VALIDATION_RULES: Array[Symbol]
+
+      ERROR: String
+
+      attr_reader validation_rule: Symbol
+
+      attr_reader target_type: Class
+
+      def validate_preconditions!: -> void
+
+      def validate_all_elements!: -> void
+
+      def validate_any_elements!: -> void
+
+      def validate_none_elements!: -> void
+    end
+  end
+end

data/sig/aoc_cli/validators/event_year_validator.rbs

@@ -0,0 +1,19 @@
+module AocCli
+  module Validators
+    class EventYearValidator < Kangaru::Validator
+      def validate: -> untyped
+
+      private
+
+      ERRORS: Hash[Symbol, String]
+
+      MIN_YEAR: Integer
+
+      def max_year: -> untyped
+
+      def in_december?: -> bool
+
+      def validate_year!: -> void
+    end
+  end
+end

data/sig/aoc_cli/validators/included_validator.rbs

@@ -0,0 +1,11 @@
+module AocCli
+  module Validators
+    class IncludedValidator < Kangaru::Validator
+      private
+
+      ERRORS: Hash[Symbol, String]
+
+      def allowed_values: -> Array[untyped]
+    end
+  end
+end