rkoans 0.0.1 → 0.1.0

data/sig/exercises/closure_capture.rbs

@@ -0,0 +1,10 @@
+module Exercises
+  class ClosureCapture
+    def self.multipliers: (Array[Integer] numbers) -> Array[^(Integer value) -> Integer]
+  end
+end
+
+class ClosureCaptureTest
+  def test_separate_captures: -> void
+  def test_lambda_contract: -> void
+end

data/sig/exercises/collection_basics.rbs

@@ -0,0 +1,6 @@
+module Exercises
+  class CollectionBasics
+    def self.koans: -> { mapped: Array[Integer]?, selected: Array[Integer]? }
+    def self.double_odds: (Array[Integer]) -> Array[Integer]
+  end
+end

data/sig/exercises/collection_basics_test.rbs

@@ -0,0 +1,4 @@
+class CollectionBasicsTest
+  def test_collection_koans: -> void
+  def test_double_odds: -> void
+end

data/sig/exercises/constant_scope.rbs

@@ -0,0 +1,11 @@
+module Exercises
+  class ConstantScope
+    def self.predictions: -> { lexical_label: String, shared_class_count: Integer, new_block_local_visible: bool }
+    def self.counter: -> ^() -> Integer
+  end
+end
+
+class ConstantScopeTest
+  def test_scope_predictions: -> void
+  def test_local_closure_state: -> void
+end

data/sig/exercises/core_protocols.rbs

@@ -0,0 +1,20 @@
+module Exercises
+  class CoreProtocols
+    class Packet
+      include Enumerable[Integer]
+      include Comparable
+      def initialize: (Array[Integer] values) -> void
+      def each: -> Enumerator[Integer, untyped]
+              | { (Integer) -> void } -> untyped
+      def total: -> Integer
+      def <=>: (Packet other) -> Integer
+      def to_s: -> String
+    end
+    def self.protocol: (Packet packet) -> [bool, bool]
+  end
+end
+
+class CoreProtocolsTest
+  def test_enumerable_protocol: -> void
+  def test_comparable_and_conversion: -> void
+end

data/sig/exercises/delegation.rbs

@@ -0,0 +1,14 @@
+module Exercises
+  class Delegation
+    class Mailbox[A]
+      def initialize: (Array[A] items) -> void
+      def push: (*A items) -> Array[A]
+      def size: -> Integer
+    end
+  end
+end
+
+class DelegationTest
+  def test_delegation_receiver: -> void
+  def test_live_receiver: -> void
+end

data/sig/exercises/dynamic_methods.rbs

@@ -0,0 +1,13 @@
+module Exercises
+  class DynamicMethods
+    def self.readers: (Array[Symbol] names) -> Class
+    def self.evaluate: (Integer factor) -> Integer
+    def self.instance_value: (Object object, Symbol name) -> untyped
+    def self.class_value: (Class klass) -> Class
+  end
+end
+
+class DynamicMethodsTest
+  def test_defined_reader_closures: -> void
+  def test_eval_binding_and_reflection: -> void
+end

data/sig/exercises/exception_flow.rbs

@@ -0,0 +1,11 @@
+module Exercises
+  class ExceptionFlow
+    def self.trace: (fail: bool) -> Array[String]
+    def self.reraises: -> bot
+  end
+end
+
+class ExceptionFlowTest
+  def test_ensure_and_else: -> void
+  def test_reraise: -> void
+end

data/sig/exercises/heredoc_layout.rbs

@@ -0,0 +1,11 @@
+module Exercises
+  class HeredocLayout
+    def self.render: (String name) -> String
+    def self.literal: -> String
+  end
+end
+
+class HeredocLayoutTest
+  def test_squiggly_indentation: -> void
+  def test_quoted_heredoc: -> void
+end

data/sig/exercises/keyword_forwarding.rbs

@@ -0,0 +1,12 @@
+module Exercises
+  class KeywordForwarding
+    type payload = String | Hash[Symbol, String]
+    def self.target: (payload, ?suffix: String) ?{ (payload) -> String } -> String
+    def self.forward: (*payload args, **String keywords) ?{ (payload) -> String } -> String
+  end
+end
+
+class KeywordForwardingTest
+  def test_keyword_and_block: -> void
+  def test_positional_hash: -> void
+end

data/sig/exercises/lazy_enumeration.rbs

@@ -0,0 +1,10 @@
+module Exercises
+  class LazyEnumeration
+    def self.first_multiples: (Integer limit) -> Array[Integer]
+  end
+end
+
+class LazyEnumerationTest
+  def test_lazy_limit: -> void
+  def test_empty_limit: -> void
+end

data/sig/exercises/literals_and_operators.rbs

@@ -0,0 +1,12 @@
+module Exercises
+  class LiteralsAndOperators
+    type predictions = { zero_truthy: bool, integer_division: Integer, float_division: Float, precedence: Integer, not_nil: bool, words: Array[String], range: Array[Integer] }
+    def self.predictions: -> predictions
+    def self.default_for_nil: [A] (A? value) -> (A | String)
+  end
+end
+
+class LiteralsAndOperatorsTest
+  def test_literals_and_precedence: -> void
+  def test_short_circuit_default: -> void
+end

data/sig/exercises/method_contracts.rbs

@@ -0,0 +1,11 @@
+module Exercises
+  class MethodContracts
+    def self.format_order: (String name, ?Integer quantity, *Symbol extras, unit: String, **String options) ?{ (String) -> String } -> String
+    def self.parameters: -> Array[[Symbol, Symbol]]
+  end
+end
+
+class MethodContractsTest
+  def test_method_defaults_and_block: -> void
+  def test_parameter_metadata: -> void
+end

data/sig/exercises/method_lookup.rbs

@@ -0,0 +1,16 @@
+module Exercises
+  class MethodLookup
+    module Wrapper
+      def call: -> String
+    end
+    class Presenter
+      def call: -> String
+    end
+    def self.lookup: -> Array[String]
+  end
+end
+
+class MethodLookupTest
+  def test_prepend_wrapper: -> void
+  def test_ancestor_order: -> void
+end

data/sig/exercises/nonlocal_exit.rbs

@@ -0,0 +1,14 @@
+module Exercises
+  class NonlocalExit
+    def self.lambda_trace: -> Array[String]
+    def self.escaped_proc: -> ^() -> bot
+    def self.find_even: (Array[Array[Integer]] groups) -> Integer?
+    def self.skip_odds: (Array[Integer] values) -> Array[Integer]
+  end
+end
+
+class NonlocalExitTest
+  def test_lambda_return_scope: -> void
+  def test_proc_nonlocal_return: -> void
+  def test_catch_throw_and_next: -> void
+end

data/sig/exercises/numbered_parameters.rbs

@@ -0,0 +1,11 @@
+module Exercises
+  class NumberedParameters
+    def self.pair_sums: (Array[[Integer, Integer]] pairs) -> Array[Integer]
+    def self.predictions: -> { explicit_and_numbered: bool, numbered_pair: bool }
+  end
+end
+
+class NumberedParametersTest
+  def test_numbered_pair_input: -> void
+  def test_numbered_syntax: -> void
+end

data/sig/exercises/numeric_precision.rbs

@@ -0,0 +1,11 @@
+module Exercises
+  class NumericPrecision
+    def self.ratios: (Integer a, Integer b) -> { integer: Integer, floating: Float, rational: Rational }
+    def self.imaginary_product: (Integer a, Integer b) -> Complex
+  end
+end
+
+class NumericPrecisionTest
+  def test_numeric_division: -> void
+  def test_complex_product: -> void
+end

data/sig/exercises/pattern_matching.rbs

@@ -0,0 +1,10 @@
+module Exercises
+  class PatternMatching
+    def self.amount: (Hash[Symbol, untyped] payload, String kind) -> Integer?
+  end
+end
+
+class PatternMatchingTest
+  def test_pinned_kind: -> void
+  def test_pattern_guard: -> void
+end

data/sig/exercises/refinement_scope.rbs

@@ -0,0 +1,18 @@
+module Exercises
+  class RefinementScope
+    class Speaker
+      def say: -> String
+    end
+    module Voice
+    end
+    module Local
+      def self.call: -> String
+    end
+    def self.outside: -> String
+  end
+end
+
+class RefinementScopeTest
+  def test_lexical_refinement: -> void
+  def test_outside_unchanged: -> void
+end

data/sig/exercises/regexp_captures.rbs

@@ -0,0 +1,11 @@
+module Exercises
+  class RegexpCaptures
+    def self.parse: (String text) -> { name: String, id: Integer }?
+    def self.probe: (String text) -> [String?, bool]
+  end
+end
+
+class RegexpCapturesTest
+  def test_whole_string_and_captures: -> void
+  def test_match_without_global_capture_change: -> void
+end

data/sig/exercises/runtime_context.rbs

@@ -0,0 +1,23 @@
+module Exercises
+  class RuntimeContext
+    type context = {
+      arguments: Array[String],
+      greeting: String?,
+      program: String,
+      file: String,
+      encoding: String,
+      ruby: String
+    }
+    def self.context: -> context
+  end
+end
+
+class RuntimeContextTest
+  @arguments: Array[String]
+  @greeting: String?
+  def setup: -> void
+  def teardown: -> void
+  def test_runtime_globals: -> void
+  def test_runtime_constants: -> void
+  def test_empty_arguments_and_missing_or_empty_greeting: -> void
+end

data/sig/exercises/shared_rows.rbs

@@ -0,0 +1,11 @@
+module Exercises
+  class SharedRows
+    def self.rows: (Integer count) -> Array[Array[untyped]]
+  end
+end
+
+class SharedRowsTest
+  def test_independent_rows: -> void
+  def test_empty_rows: -> void
+  def test_fresh_rows_on_each_call: -> void
+end

data/sig/exercises/singleton_pattern.rbs

@@ -0,0 +1,14 @@
+module Exercises
+  class SingletonPattern
+    class Configuration
+      attr_accessor mode: String
+      def initialize: -> void
+      def self.instance: -> Configuration
+    end
+  end
+end
+
+class SingletonPatternTest
+  def test_singleton_identity: -> void
+  def test_private_constructor: -> void
+end

data/sig/exercises/time_and_date.rbs

@@ -0,0 +1,11 @@
+module Exercises
+  class TimeAndDate
+    def self.utc: (String text) -> String
+    def self.days_between: (String first, String last) -> Integer
+  end
+end
+
+class TimeAndDateTest
+  def test_time_offset: -> void
+  def test_calendar_days: -> void
+end

data/sig/exercises/visibility.rbs

@@ -0,0 +1,18 @@
+module Exercises
+  class Visibility
+    class Wallet
+      def initialize: (Integer balance) -> void
+      def balance: -> Integer
+      private
+      def normalize: (Integer value) -> Integer
+      public
+      def deposit: (Integer value) -> Integer
+      def compare: (Wallet other) -> Integer
+    end
+  end
+end
+
+class VisibilityTest
+  def test_protected_peer_calls: -> void
+  def test_private_normalization: -> void
+end

data/sig/fixture_support.rbs

@@ -0,0 +1,11 @@
+module FixtureSupport
+  include CommandSupport
+  FIXTURE_ROOT: String
+  FIXTURE_COMMAND: Array[String]
+
+  private
+
+  def command: -> Array[String]
+  def reference_source: (?String id) -> String
+  def solution: (String directory) -> String
+end

data/sig/help_hint_command_test.rbs

@@ -0,0 +1,8 @@
+class HelpHintCommandTest
+  include FixtureSupport
+  def test_help_is_always_available_and_hints_are_limited_to_unfinished_current_exercises: -> void
+
+  private
+
+  def with_session: (String directory) { (IO input, IO output) -> untyped } -> untyped
+end

data/sig/heredoc_layout_acceptance_test.rbs

@@ -0,0 +1,3 @@
+class HeredocLayoutAcceptanceTest
+  def test_incorrect_delimiters_are_rejected: -> void
+end

data/sig/keyboard_session_test.rbs

@@ -0,0 +1,9 @@
+class KeyboardSessionTest
+  include FixtureSupport
+  def test_list_and_show_are_immediate_but_next_and_quit_require_enter: -> void
+
+  private
+
+  def confirm_next_and_quit: (IO input, IO output, Integer pid, String directory) -> void
+  def stop_child: (Integer pid) -> void
+end

data/sig/keyword_forwarding_acceptance_test.rbs

@@ -0,0 +1,3 @@
+class KeywordForwardingAcceptanceTest
+  def test_incorrect_fix_is_rejected: -> void
+end

data/sig/lazy_enumeration_acceptance_test.rbs

@@ -0,0 +1,3 @@
+class LazyEnumerationAcceptanceTest
+  def test_incorrect_fix_is_rejected: -> void
+end

data/sig/literals_and_operators_acceptance_test.rbs

@@ -0,0 +1,3 @@
+class LiteralsAndOperatorsAcceptanceTest
+  def test_incorrect_fix_is_rejected: -> void
+end

data/sig/method_contracts_acceptance_test.rbs

@@ -0,0 +1,3 @@
+class MethodContractsAcceptanceTest
+  def test_incorrect_fix_is_rejected: -> void
+end

data/sig/method_lookup_acceptance_test.rbs

@@ -0,0 +1,3 @@
+class MethodLookupAcceptanceTest
+  def test_incorrect_fix_is_rejected: -> void
+end

data/sig/nonlocal_exit_acceptance_test.rbs

@@ -0,0 +1,3 @@
+class NonlocalExitAcceptanceTest
+  def test_incorrect_fix_is_rejected: -> void
+end

data/sig/numbered_parameters_acceptance_test.rbs

@@ -0,0 +1,3 @@
+class NumberedParametersAcceptanceTest
+  def test_incorrect_fix_is_rejected: -> void
+end

data/sig/numeric_precision_acceptance_test.rbs

@@ -0,0 +1,4 @@
+class NumericPrecisionAcceptanceTest
+  def test_incorrect_fix_is_rejected: -> void
+  def test_integer_complex_product_is_rejected: -> void
+end

data/sig/packaging_test.rbs

@@ -0,0 +1,3 @@
+class PackagingTest
+  def test_package_includes_signatures_and_checks_but_not_learner_edits: -> void
+end

data/sig/pattern_matching_acceptance_test.rbs

@@ -0,0 +1,3 @@
+class PatternMatchingAcceptanceTest
+  def test_incorrect_fix_is_rejected: -> void
+end

data/sig/reference_solutions_test.rbs

@@ -0,0 +1,3 @@
+class ReferenceSolutionsTest
+  def test_each_reference_passes_its_exercise_checks: -> void
+end

data/sig/refinement_scope_acceptance_test.rbs

@@ -0,0 +1,3 @@
+class RefinementScopeAcceptanceTest
+  def test_incorrect_fix_is_rejected: -> void
+end

data/sig/regexp_captures_acceptance_test.rbs

@@ -0,0 +1,4 @@
+class RegexpCapturesAcceptanceTest
+  def test_incorrect_fix_is_rejected: -> void
+  def test_float_identifier_is_rejected: -> void
+end

data/sig/rkoans/catalog.rbs

@@ -0,0 +1,11 @@
+module Rkoans
+  class Catalog
+    @root: String
+    @ids: Array[String]
+    attr_reader root: String
+    attr_reader ids: Array[String]
+    def initialize: (?root: String) -> void
+    private
+    def valid_ids?: -> bool
+  end
+end

data/sig/rkoans/checker.rbs

@@ -0,0 +1,22 @@
+module Rkoans
+  class Checker
+    class Result < Data
+      attr_reader output: String
+      attr_reader exit_code: Integer
+
+      def self.new: (String output, Integer exit_code) -> Result
+                  | (output: String, exit_code: Integer) -> Result
+    end
+
+    MAX_KB: Integer
+    @timeout: Integer | Float
+
+    def initialize: (?timeout: Integer | Float) -> void
+    def run: (Exercise exercise) -> Result
+
+    private
+
+    def stop_group: (pid: Integer) -> Integer?
+    def reap_exited_child: (Integer pid) -> Integer?
+  end
+end

data/sig/rkoans/cli.rbs

@@ -0,0 +1,21 @@
+module Rkoans
+  class CLI
+    @err: IO
+    @out: IO
+    @session: Session?
+    @directory: String
+    @input: IO
+
+    @catalog: Catalog?
+    def initialize: (?out: IO, ?err: IO, ?input: IO, ?directory: String, ?catalog: Catalog?) -> void
+    def run: (Array[String] arguments) -> Integer
+
+    private
+
+    def catalog: -> Catalog
+    def session: -> Session
+    def dispatch: (String command, String? id) -> Integer
+    def help: -> Integer
+    def usage_error: -> Integer
+  end
+end

data/sig/rkoans/exercise.rbs

@@ -0,0 +1,18 @@
+module Rkoans
+  class Exercise
+    @id: String
+    @solution: String
+    @source: String
+    @root: String
+
+    attr_reader solution: String
+    attr_reader id: String
+
+    def initialize: (?directory: String, ?id: String, ?catalog: Catalog) -> void
+    def prepare: -> Integer?
+    def instructions: -> String
+    def checks: -> String
+    def reference: -> String
+    def hint: -> String
+  end
+end

data/sig/rkoans/keyboard.rbs

@@ -0,0 +1,13 @@
+module Rkoans
+  class Keyboard
+    @input: IO?
+    @pending: String?
+    def initialize: (input: IO?) -> void
+    def with_terminal: [T] () { () -> T } -> T
+    def read: (Float interval) -> String?
+
+    private
+
+    def decode: (String key) -> String?
+  end
+end

data/sig/rkoans/progress.rbs

@@ -0,0 +1,9 @@
+module Rkoans
+  class Progress
+    @path: String
+    @catalog: Catalog
+    def initialize: (directory: String, ?catalog: Catalog) -> void
+    def completed: -> Array[String]
+    def mark_done: (String id) -> Integer?
+  end
+end

data/sig/rkoans/selection.rbs

@@ -0,0 +1,9 @@
+module Rkoans
+  class Selection
+    @path: String
+    @catalog: Catalog
+    def initialize: (directory: String, ?catalog: Catalog) -> void
+    def read: -> String
+    def write: (String id) -> Integer
+  end
+end

data/sig/rkoans/session.rbs

@@ -0,0 +1,30 @@
+module Rkoans
+  class Session
+    @directory: String
+    @input: IO
+    @selection: Selection
+    @checker: Checker
+    @progress: Progress
+    @view: TerminalView
+    @exercise: Exercise
+    @passed: bool
+    @listing: bool
+
+    @catalog: Catalog
+    def initialize: (directory: String, out: IO, input: IO, ?catalog: Catalog) -> void
+    def start: (String? id) -> Integer
+    def check: -> Integer
+
+    private
+
+    def activate: (String id) -> void
+    def watch: -> (String | :quit)
+    def handle_command: (String command) -> void
+    def advance: -> void
+    def show_checks: (watching: bool) -> Integer
+    def check_result: -> Checker::Result
+    def render: (Checker::Result result, watching: bool, ?message: String?) -> Integer
+    def show_message: (String message, ?watching: bool) -> void
+    def show_hint: -> void
+  end
+end

data/sig/rkoans/terminal_view.rbs

@@ -0,0 +1,24 @@
+module Rkoans
+  class TerminalView
+    HELP: String
+    @out: IO
+    @catalog: Catalog
+    def initialize: (out: IO, ?catalog: Catalog) -> void
+    def render: (exercise: Exercise, result: Checker::Result, completed: Array[String], watching: bool,
+                 ?message: String?) -> void
+    def show_message: (String message, exercise: Exercise, completed: Array[String], passed: bool,
+                       ?mode: (:current | :list | :quit)) -> void
+    def show_list: (exercise: Exercise, completed: Array[String], passed: bool) -> void
+    def footer: (Exercise exercise, Array[String] completed, bool passed, ?listing: bool) -> void
+
+    private
+
+    def clear: -> void
+
+    def show_completed: (Exercise exercise) -> void
+    def show_checks: (Exercise exercise, Checker::Result result) -> void
+    def colorize: (String text, Integer code) -> String
+    def progress_line: (Integer count) -> String
+    def commands: (bool passed, listing: bool) -> String
+  end
+end

data/sig/rkoans/watcher.rbs

@@ -0,0 +1,18 @@
+module Rkoans
+  class Watcher
+    @path: String
+    @interval: Float
+    @debounce: Float
+    @previous: String?
+    @changed_at: Float?
+
+    def initialize: (String path, ?interval: Float, ?debounce: Float) -> void
+    def run: (?input: IO?) { (String?) -> untyped } -> bot
+
+    private
+
+    def fingerprint: -> String?
+    def changed?: -> bool
+    def monotonic_time: -> Float
+  end
+end

data/sig/rkoans.rbs

@@ -1,4 +1,6 @@
 module Rkoans
+  class Error < StandardError
+  end
   VERSION: String
   # See the writing guide of rbs: https://github.com/ruby/rbs#guides
 end