rkoans 0.0.1 → 0.1.0

data/lib/rkoans/terminal_view.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+module Rkoans
+  # Renders check output, the completed screen, and the session footer.
+  class TerminalView
+    HELP = <<~TEXT
+      Keyboard help
+
+      l          List exercises immediately.
+      s          Show the current exercise immediately.
+      h          Show an exercise hint immediately (unfinished current exercise only).
+      ?          Show this help immediately.
+      n + Enter  Move to the next exercise after the current checks pass.
+      q + Enter  Quit and preserve your edits.
+      Ctrl-C     Quit and preserve your edits.
+
+      Saving your exercise file reruns its checks automatically.
+    TEXT
+
+    # @param catalog [Catalog] ordered exercises used by this component
+    def initialize(out:, catalog: Catalog.new)
+      @catalog = catalog
+      @out = out
+    end
+
+    def render(exercise:, result:, completed:, watching:, message: nil)
+      clear if watching
+      @out.puts "Output\n\n"
+      if watching && result.exit_code.zero?
+        show_completed(exercise)
+      else
+        show_checks(exercise, result)
+      end
+      @out.puts "\n#{message}" if message
+      footer(exercise, completed, result.exit_code.zero?) if watching
+    end
+
+    def show_message(message, exercise:, completed:, passed:, mode: :current)
+      clear
+      @out.puts "Output\n\n#{message}"
+      footer(exercise, completed, passed, listing: mode == :list) unless mode == :quit
+    end
+
+    def show_list(exercise:, completed:, passed:)
+      clear
+      @out.puts "Exercises\n\n"
+      @catalog.ids.each do |id|
+        marker = id == exercise.id ? '>' : ' '
+        state = completed.include?(id) ? 'done' : 'open'
+        @out.puts "#{marker} [#{state}] #{id}"
+      end
+      footer(exercise, completed, passed, listing: true)
+    end
+
+    def footer(exercise, completed, passed, listing: false)
+      @out.puts progress_line(completed.size)
+      @out.puts "Current exercise: #{colorize(exercise.solution, 36)}"
+      @out.puts colorize('Watching for saves · Ctrl-C to exit', 36)
+      @out.puts "\n#{commands(passed, listing: listing)}"
+    end
+
+    private
+
+    def clear
+      @out.print "\e[3J\e[2J\e[H" if @out.tty?
+    end
+
+    def progress_line(count)
+      filled = count * 20 / @catalog.ids.size
+      bar = colorize('#' * filled, 32) + colorize('-' * (20 - filled), 31)
+      "\nProgress: [#{bar}] #{count}/#{@catalog.ids.size}"
+    end
+
+    def commands(passed, listing:)
+      return 's:show current / n:next (Enter) / q:quit (Enter) / ?:help' if listing
+
+      passed ? 'n:next (Enter) / l:list / q:quit (Enter) / ?:help' : 'h:hint / l:list / q:quit (Enter) / ?:help'
+    end
+
+    def show_completed(exercise)
+      @out.puts colorize('Exercise done ✓', 32)
+      @out.puts "Solution for comparison: #{colorize(exercise.reference, 36)}"
+      @out.puts 'When done experimenting, enter n to move on to the next exercise.'
+    end
+
+    def show_checks(exercise, result)
+      @out.puts exercise.instructions
+      @out.puts "\nEdit: #{exercise.solution}\n\n"
+      @out.puts result.output
+      @out.puts(result.exit_code.zero? ? colorize('PASS', 32) : colorize('FAIL', 31))
+    end
+
+    def colorize(text, code)
+      return text unless @out.tty? && !ENV.key?('NO_COLOR')
+
+      "\e[#{code}m#{text}\e[0m"
+    end
+  end
+end

data/lib/rkoans/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Rkoans
-  VERSION = '0.0.1'
+  VERSION = '0.1.0'
 end

data/lib/rkoans/watcher.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require 'digest'
+
+module Rkoans
+  # Reruns a block after file contents change and saves settle.
+  class Watcher
+    # @param [String] path
+    # @param [Float] interval
+    # @param [Float] debounce
+    def initialize(path, interval: 0.1, debounce: 0.2)
+      @path = path
+      @interval = interval
+      @debounce = debounce
+    end
+
+    # Calls the block initially and after saves, until interrupted.
+    def run(input: nil)
+      keyboard = Keyboard.new(input: input)
+      @previous = fingerprint
+      @changed_at = nil
+      keyboard.with_terminal do
+        yield nil
+        loop do
+          command = keyboard.read(@interval)
+          yield command if command
+          yield nil if changed?
+        end
+      end
+    end
+
+    private
+
+    def changed?
+      current = fingerprint
+      if current != @previous
+        @previous = current
+        @changed_at = monotonic_time
+      elsif @changed_at && monotonic_time - @changed_at >= @debounce
+        @changed_at = nil
+        return true
+      end
+      false
+    end
+
+    # @return [String, nil]
+    def fingerprint
+      Digest::SHA256.file(@path).hexdigest
+    rescue Errno::ENOENT
+      nil
+    end
+
+    # @return [Float]
+    def monotonic_time
+      Process.clock_gettime(Process::CLOCK_MONOTONIC)
+    end
+  end
+end

data/lib/rkoans.rb

@@ -1,5 +1,15 @@
 # frozen_string_literal: true
 
-module Rkoans
-  class Error < StandardError; end
-end
+require_relative 'rkoans/error'
+
+require_relative 'rkoans/version'
+require_relative 'rkoans/catalog'
+require_relative 'rkoans/exercise'
+require_relative 'rkoans/selection'
+require_relative 'rkoans/progress'
+require_relative 'rkoans/checker'
+require_relative 'rkoans/keyboard'
+require_relative 'rkoans/watcher'
+require_relative 'rkoans/terminal_view'
+require_relative 'rkoans/session'
+require_relative 'rkoans/cli'

data/sig/about_array_assignment_acceptance_test.rbs

@@ -0,0 +1,3 @@
+class AboutArrayAssignmentAcceptanceTest
+  def test_incorrect_splat_and_missing_value_predictions_are_rejected: -> void
+end

data/sig/about_arrays_acceptance_test.rbs

@@ -0,0 +1,3 @@
+class AboutArraysAcceptanceTest
+  def test_incorrect_slice_and_pop_predictions_are_rejected: -> void
+end

data/sig/about_asserts_command_test.rbs

@@ -0,0 +1,4 @@
+class AboutAssertsCommandTest
+  include CommandSupport
+  def test_default_start_introduces_assertions_and_checks_each_answer: -> void
+end

data/sig/about_blocks_acceptance_test.rbs

@@ -0,0 +1,3 @@
+class AboutBlocksAcceptanceTest
+  def test_incorrect_predictions_are_rejected: -> void
+end

data/sig/about_class_methods_acceptance_test.rbs

@@ -0,0 +1,3 @@
+class AboutClassMethodsAcceptanceTest
+  def test_incorrect_predictions_are_rejected: -> void
+end

data/sig/about_classes_acceptance_test.rbs

@@ -0,0 +1,3 @@
+class AboutClassesAcceptanceTest
+  def test_incorrect_predictions_are_rejected: -> void
+end

data/sig/about_constants_acceptance_test.rbs

@@ -0,0 +1,3 @@
+class AboutConstantsAcceptanceTest
+  def test_incorrect_predictions_are_rejected: -> void
+end

data/sig/about_control_statements_acceptance_test.rbs

@@ -0,0 +1,3 @@
+class AboutControlStatementsAcceptanceTest
+  def test_incorrect_predictions_are_rejected: -> void
+end

data/sig/about_dice_project_acceptance_test.rbs

@@ -0,0 +1,3 @@
+class AboutDiceProjectAcceptanceTest
+  def test_incomplete_implementation_is_rejected: -> void
+end

data/sig/about_exceptions_acceptance_test.rbs

@@ -0,0 +1,3 @@
+class AboutExceptionsAcceptanceTest
+  def test_incorrect_predictions_are_rejected: -> void
+end

data/sig/about_extra_credit_acceptance_test.rbs

@@ -0,0 +1,5 @@
+class AboutExtraCreditAcceptanceTest
+  def test_incomplete_implementation_is_rejected: -> void
+  private
+  def incomplete_repairs: -> Array[[String, String]]
+end

data/sig/about_hashes_acceptance_test.rbs

@@ -0,0 +1,3 @@
+class AboutHashesAcceptanceTest
+  def test_incorrect_predictions_are_rejected: -> void
+end

data/sig/about_inheritance_acceptance_test.rbs

@@ -0,0 +1,3 @@
+class AboutInheritanceAcceptanceTest
+  def test_incorrect_predictions_are_rejected: -> void
+end

data/sig/about_iteration_acceptance_test.rbs

@@ -0,0 +1,3 @@
+class AboutIterationAcceptanceTest
+  def test_incorrect_predictions_are_rejected: -> void
+end

data/sig/about_keyword_arguments_acceptance_test.rbs

@@ -0,0 +1,3 @@
+class AboutKeywordArgumentsAcceptanceTest
+  def test_incorrect_predictions_are_rejected: -> void
+end

data/sig/about_message_passing_acceptance_test.rbs

@@ -0,0 +1,3 @@
+class AboutMessagePassingAcceptanceTest
+  def test_incorrect_predictions_are_rejected: -> void
+end

data/sig/about_methods_acceptance_test.rbs

@@ -0,0 +1,3 @@
+class AboutMethodsAcceptanceTest
+  def test_incorrect_predictions_are_rejected: -> void
+end

data/sig/about_modules_acceptance_test.rbs

@@ -0,0 +1,3 @@
+class AboutModulesAcceptanceTest
+  def test_incorrect_predictions_are_rejected: -> void
+end

data/sig/about_nil_acceptance_test.rbs

@@ -0,0 +1,3 @@
+class AboutNilAcceptanceTest
+  def test_incorrect_error_and_empty_message_predictions_are_rejected: -> void
+end

data/sig/about_objects_acceptance_test.rbs

@@ -0,0 +1,3 @@
+class AboutObjectsAcceptanceTest
+  def test_incorrect_nil_conversion_and_clone_predictions_are_rejected: -> void
+end

data/sig/about_open_classes_acceptance_test.rbs

@@ -0,0 +1,3 @@
+class AboutOpenClassesAcceptanceTest
+  def test_incorrect_predictions_are_rejected: -> void
+end

data/sig/about_pattern_matching_acceptance_test.rbs

@@ -0,0 +1,3 @@
+class AboutPatternMatchingAcceptanceTest
+  def test_incorrect_predictions_are_rejected: -> void
+end

data/sig/about_proxy_object_project_acceptance_test.rbs

@@ -0,0 +1,3 @@
+class AboutProxyObjectProjectAcceptanceTest
+  def test_incomplete_implementation_is_rejected: -> void
+end

data/sig/about_regular_expressions_acceptance_test.rbs

@@ -0,0 +1,3 @@
+class AboutRegularExpressionsAcceptanceTest
+  def test_incorrect_predictions_are_rejected: -> void
+end

data/sig/about_sandwich_code_acceptance_test.rbs

@@ -0,0 +1,3 @@
+class AboutSandwichCodeAcceptanceTest
+  def test_incomplete_implementation_is_rejected: -> void
+end

data/sig/about_scope_acceptance_test.rbs

@@ -0,0 +1,3 @@
+class AboutScopeAcceptanceTest
+  def test_incorrect_predictions_are_rejected: -> void
+end

data/sig/about_scoring_project_acceptance_test.rbs

@@ -0,0 +1,3 @@
+class AboutScoringProjectAcceptanceTest
+  def test_incomplete_implementation_is_rejected: -> void
+end

data/sig/about_strings_acceptance_test.rbs

@@ -0,0 +1,3 @@
+class AboutStringsAcceptanceTest
+  def test_incorrect_mutation_and_identity_predictions_are_rejected: -> void
+end

data/sig/about_symbols_acceptance_test.rbs

@@ -0,0 +1,3 @@
+class AboutSymbolsAcceptanceTest
+  def test_incorrect_identity_and_exception_predictions_are_rejected: -> void
+end

data/sig/about_to_str_acceptance_test.rbs

@@ -0,0 +1,3 @@
+class AboutToStrAcceptanceTest
+  def test_incorrect_predictions_are_rejected: -> void
+end

data/sig/about_triangle_project_acceptance_test.rbs

@@ -0,0 +1,3 @@
+class AboutTriangleProjectAcceptanceTest
+  def test_incomplete_implementation_is_rejected: -> void
+end

data/sig/about_triangle_project_two_acceptance_test.rbs

@@ -0,0 +1,3 @@
+class AboutTriangleProjectTwoAcceptanceTest
+  def test_incomplete_implementation_is_rejected: -> void
+end

data/sig/about_true_and_false_command_test.rbs

@@ -0,0 +1,4 @@
+class AboutTrueAndFalseCommandTest
+  include CommandSupport
+  def test_truth_values_reject_partial_answers_and_accept_reference: -> void
+end

data/sig/catalog_error_command_test.rbs

@@ -0,0 +1,4 @@
+class CatalogErrorCommandTest
+  include CommandSupport
+  def test_invalid_and_missing_catalogs_exit_cleanly: -> void
+end

data/sig/checker_test.rbs

@@ -0,0 +1,9 @@
+class CheckerTest
+  class TimeoutExercise < Rkoans::Exercise
+    @checks: String
+    attr_reader checks: String
+    def initialize: (directory: String, checks: String) -> void
+  end
+
+  def test_timeout_stops_the_check_and_its_child_process: -> void
+end

data/sig/class_state_acceptance_test.rbs

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

data/sig/closure_capture_acceptance_test.rbs

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

data/sig/command_support.rbs

@@ -0,0 +1,18 @@
+module CommandSupport
+  interface _Stream
+    def readline: -> String
+  end
+
+  ROOT: String
+  COMMAND: Array[String]
+
+  private
+
+  def command: -> Array[String]
+  def reference_source: (?String id) -> String
+
+  def solution: (String directory) -> String
+  def run_command: (*String command_name, directory: String) -> [String, Process::Status]
+  def with_watcher: (*String message, directory: String) { (_Stream) -> untyped } -> untyped
+  def wait_for: (_Stream stream, String text) -> String
+end

data/sig/command_test.rbs

@@ -0,0 +1,5 @@
+class CommandTest
+  include FixtureSupport
+  def test_check_reports_failure_then_success_from_another_directory: -> void
+  def test_default_start_watches_atomic_saves_and_preserves_edits_on_restart: -> void
+end

data/sig/constant_scope_acceptance_test.rbs

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

data/sig/core_protocols_acceptance_test.rbs

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

data/sig/curriculum_cop_test.rbs

@@ -0,0 +1,9 @@
+class CurriculumCopTest
+  def test_complete_curriculum_and_missing_asset_diagnostics: -> void
+  def test_reports_multiple_curriculum_defects_together: -> void
+  def test_invalid_catalog_is_reported_as_an_offense: -> void
+  private
+  def with_curriculum: { (String directory) -> void } -> void
+  def copy_cop: (String root, String directory) -> void
+  def offenses: (String directory) -> Array[String]
+end

data/sig/delegation_acceptance_test.rbs

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

data/sig/dynamic_methods_acceptance_test.rbs

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

data/sig/exception_flow_acceptance_test.rbs

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

data/sig/exercise_test.rbs

@@ -0,0 +1,3 @@
+class ExerciseTest
+  def test_start_preserves_existing_class_named_files: -> void
+end

data/sig/exercises/about_array_assignment.rbs

@@ -0,0 +1,36 @@
+# SPDX-License-Identifier: CC-BY-NC-SA-3.0
+# Adapted from Ruby Koans by Jim Weirich and Joe O'Brien.
+# See THIRD_PARTY_NOTICES.md for attribution and license terms.
+
+module Exercises
+  class AboutArrayAssignment
+    type answers = {
+      names: (Array[String] | :fill_me_in),
+      first_name: (String | :fill_me_in),
+      last_name: (String | :fill_me_in),
+      extra_first: (String | :fill_me_in),
+      extra_last: (String | :fill_me_in),
+      splat_first: (String | :fill_me_in),
+      splat_last: (Array[String] | :fill_me_in),
+      short_first: (String | :fill_me_in),
+      short_last: (nil | :fill_me_in),
+      nested_first: (Array[String] | :fill_me_in),
+      nested_last: (String | :fill_me_in),
+      single_first: (String | :fill_me_in),
+      swapped_first: (String | :fill_me_in),
+      swapped_last: (String | :fill_me_in)
+    }
+    def self.koans: -> answers
+  end
+end
+
+class AboutArrayAssignmentTest
+  def test_non_parallel_assignment: -> void
+  def test_parallel_assignments: -> void
+  def test_parallel_assignments_with_extra_values: -> void
+  def test_parallel_assignments_with_splat_operator: -> void
+  def test_parallel_assignments_with_too_few_values: -> void
+  def test_parallel_assignments_with_subarrays: -> void
+  def test_parallel_assignment_with_one_variable: -> void
+  def test_swapping_with_parallel_assignment: -> void
+end

data/sig/exercises/about_arrays.rbs

@@ -0,0 +1,51 @@
+# SPDX-License-Identifier: CC-BY-NC-SA-3.0
+# Adapted from Ruby Koans by Jim Weirich and Joe O'Brien.
+# See THIRD_PARTY_NOTICES.md for attribution and license terms.
+
+module Exercises
+  class AboutArrays
+    type answers = {
+      empty_type: (singleton(Array) | :fill_me_in),
+      empty_size: (Integer | :fill_me_in),
+      second_literal: (Integer | :fill_me_in),
+      after_append: (Array[Integer] | :fill_me_in),
+      first_index: Symbol,
+      first_method: Symbol,
+      last_index: Symbol,
+      last_method: Symbol,
+      negative_last: Symbol,
+      negative_third: Symbol,
+      slice_one: (Array[Symbol] | :fill_me_in),
+      slice_two: (Array[Symbol] | :fill_me_in),
+      slice_tail: (Array[Symbol] | :fill_me_in),
+      slice_long_tail: (Array[Symbol] | :fill_me_in),
+      slice_at_end_zero: (Array[Symbol] | :fill_me_in),
+      slice_at_end_long: (Array[Symbol] | :fill_me_in),
+      slice_beyond_end: (nil | :fill_me_in),
+      range_type: (singleton(Range) | :fill_me_in),
+      inclusive_range: (Array[Integer] | :fill_me_in),
+      exclusive_range: (Array[Integer] | :fill_me_in),
+      inclusive_slice: (Array[Symbol] | :fill_me_in),
+      exclusive_slice: (Array[Symbol] | :fill_me_in),
+      negative_range_slice: (Array[Symbol] | :fill_me_in),
+      after_push: (Array[Integer | Symbol] | :fill_me_in),
+      popped_value: Symbol,
+      after_pop: (Array[Integer] | :fill_me_in),
+      after_unshift: (Array[Integer | Symbol] | :fill_me_in),
+      shifted_value: Symbol,
+      after_shift: (Array[Integer] | :fill_me_in)
+    }
+    def self.koans: -> answers
+  end
+end
+
+class AboutArraysTest
+  def test_creating_arrays: -> void
+  def test_array_literals: -> void
+  def test_accessing_array_elements: -> void
+  def test_slicing_arrays: -> void
+  def test_arrays_and_ranges: -> void
+  def test_slicing_with_ranges: -> void
+  def test_pushing_and_popping_arrays: -> void
+  def test_shifting_arrays: -> void
+end

data/sig/exercises/about_asserts.rbs

@@ -0,0 +1,23 @@
+# SPDX-License-Identifier: CC-BY-NC-SA-3.0
+# Adapted from Ruby Koans by Jim Weirich and Joe O'Brien.
+# See THIRD_PARTY_NOTICES.md for attribution and license terms.
+module Exercises
+  class AboutAsserts
+    type answers = {
+      truth: bool,
+      with_message: bool,
+      expected_value: Integer?,
+      better_expected_value: Integer?,
+      filled_value: Integer?
+    }
+    def self.koans: -> answers
+  end
+end
+
+class AboutAssertsTest
+  def test_assert_truth: -> void
+  def test_assert_with_message: -> void
+  def test_assert_equality: -> void
+  def test_a_better_way_of_asserting_equality: -> void
+  def test_fill_in_values: -> void
+end

data/sig/exercises/about_blocks.rbs

@@ -0,0 +1,40 @@
+# SPDX-License-Identifier: CC-BY-NC-SA-3.0
+# Adapted from Ruby Koans by Jim Weirich and Joe O'Brien.
+# See THIRD_PARTY_NOTICES.md for attribution and license terms.
+
+module Exercises
+  class AboutBlocks
+    type answers = {
+      methods_can_take_blocks_one: (::Integer | :fill_me_in),
+      blocks_can_be_defined_with_do_end_too_one: (::Integer | :fill_me_in),
+      blocks_can_take_arguments_one: (::String | :fill_me_in),
+      methods_can_call_yield_many_times_one: (::Array[::Symbol] | :fill_me_in),
+      methods_can_see_if_they_have_been_called_with_a_block_one: (::Symbol | :fill_me_in),
+      methods_can_see_if_they_have_been_called_with_a_block_two: (::Symbol | :fill_me_in),
+      block_can_affect_variables_in_the_code_where_they_are_created_one: (::Symbol | :fill_me_in),
+      blocks_can_be_assigned_to_variables_and_called_explicitly_one: (::Integer | :fill_me_in),
+      blocks_can_be_assigned_to_variables_and_called_explicitly_two: (::Integer | :fill_me_in),
+      stand_alone_blocks_can_be_passed_to_methods_expecting_blocks_one: (::String | :fill_me_in),
+      methods_can_take_an_explicit_block_argument_one: (::Integer | :fill_me_in),
+      methods_can_take_an_explicit_block_argument_two: (::Integer | :fill_me_in)
+    }
+    def self.koans: -> answers
+  end
+end
+
+class AboutBlocksTest
+  def method_with_block: [A] () { () -> A } -> A
+  def test_methods_can_take_blocks: -> void
+  def test_blocks_can_be_defined_with_do_end_too: -> void
+  def method_with_block_arguments: [A] () { (String) -> A } -> A
+  def test_blocks_can_take_arguments: -> void
+  def many_yields: [A] () { (Symbol) -> A } -> A
+  def test_methods_can_call_yield_many_times: -> void
+  def yield_tester: [A] () ?{ () -> A } -> (A | Symbol)
+  def test_methods_can_see_if_they_have_been_called_with_a_block: -> void
+  def test_block_can_affect_variables_in_the_code_where_they_are_created: -> void
+  def test_blocks_can_be_assigned_to_variables_and_called_explicitly: -> void
+  def test_stand_alone_blocks_can_be_passed_to_methods_expecting_blocks: -> void
+  def method_with_explicit_block: [A] () { (Integer) -> A } -> A
+  def test_methods_can_take_an_explicit_block_argument: -> void
+end