sangi 0.1.0

data/lib/sangi/engines/addition_engine.rb

@@ -0,0 +1,184 @@
+module Sangi
+  class AdditionEngine
+    def initialize(config)
+      @config = config
+    end
+
+    def build(abs_a:, abs_b:, result_sign:, display_a:, display_b:, expression:)
+      @rod_factory = RodFactory.new
+      @result_value = result_sign * (abs_a + abs_b)
+      place_count = [
+        digit_count(abs_a),
+        digit_count(abs_b),
+        digit_count(@result_value.abs),
+        1
+      ].max
+      @board = Board.from_numbers(
+        a: display_a,
+        b: display_b,
+        work: 0,
+        place_count: place_count,
+        rod_factory: @rod_factory
+      )
+      @board.row(:work).sign = result_sign
+      @builder = StepBuilder.new(
+        config: @config,
+        expression: expression,
+        board: @board,
+        result_value: @result_value,
+        rod_factory: @rod_factory
+      )
+
+      push_setup_step
+      max_operand_places(abs_a, abs_b).times do |place|
+        add_digit_to_work(source: :a, place: place, digit: digit_of(abs_a, place))
+        add_digit_to_work(source: :b, place: place, digit: digit_of(abs_b, place))
+      end
+      normalize_all_places
+      push_finish_step
+      @builder.steps
+    end
+
+    private
+
+    def push_setup_step
+      @builder.push(
+        title: "準備",
+        brief_message: "A行とB行を表示し、Work行を空にします。",
+        learn_message: "A行とB行は参照用に残し、棒をWork行へ1本ずつ置いて合計を作ります。",
+        event: Event.new(type: :setup)
+      )
+    end
+
+    def push_finish_step
+      @board.row(:work).normalize_zero_sign!
+      @builder.push(
+        title: "完了",
+        brief_message: "計算結果は#{@result_value}です。",
+        learn_message: "Work行の棒を正規化したので、各位が読みやすい算木風表示になりました。結果は#{@result_value}です。",
+        event: Event.new(type: :finish)
+      )
+    end
+
+    def add_digit_to_work(source:, place:, digit:)
+      return if digit.zero?
+
+      source_label = source == :a ? "A" : "B"
+      (digit / 5).times do
+        @builder.place_rod(
+          row: :work,
+          place: place,
+          kind: :five,
+          title: "#{source_label}を加える",
+          brief_message: "#{source_label}行を参照し、Workの#{@builder.place_name(place)}にfive棒を1本置きます。",
+          learn_message: "#{source_label}行の#{@builder.place_name(place)}にある5を表す棒を、Work行へ1本追加します。"
+        )
+        normalize_from_place(place)
+      end
+
+      (digit % 5).times do
+        @builder.place_rod(
+          row: :work,
+          place: place,
+          kind: :unit,
+          title: "#{source_label}を加える",
+          brief_message: "#{source_label}行を参照し、Workの#{@builder.place_name(place)}にunit棒を1本置きます。",
+          learn_message: "#{source_label}行の#{@builder.place_name(place)}にある1を表す棒を、Work行へ1本追加します。"
+        )
+        normalize_from_place(place)
+      end
+    end
+
+    def normalize_all_places
+      @board.place_count.times { |place| normalize_from_place(place) }
+    end
+
+    def normalize_from_place(start_place)
+      current = start_place
+      while current < @board.place_count
+        changed = false
+        cell = work_cell(current)
+
+        while cell.unit_rods.size >= 5
+          normalize_units_to_five(current)
+          changed = true
+        end
+
+        while cell.five_rods.size >= 2
+          carry_five_pair(current)
+          changed = true
+        end
+
+        break unless changed
+
+        current += 1
+      end
+    end
+
+    def normalize_units_to_five(place)
+      5.times do
+        @builder.remove_rod(
+          row: :work,
+          place: place,
+          kind: :unit,
+          title: "5本をまとめる",
+          brief_message: "Workの#{@builder.place_name(place)}でunit棒5本をfive棒1本にまとめるため、unit棒を1本取り除きます。",
+          learn_message: "同じ位の1の棒が5本になったので、5を表す棒へ変換します。",
+          event_type: :convert_unit_to_five
+        )
+      end
+      @builder.place_rod(
+        row: :work,
+        place: place,
+        kind: :five,
+        title: "5本をまとめる",
+        brief_message: "Workの#{@builder.place_name(place)}にfive棒を1本置きます。",
+        learn_message: "unit棒5本を取り除いた代わりに、同じ位へ5を表す棒を1本置きます。",
+        event_type: :convert_unit_to_five
+      )
+    end
+
+    def carry_five_pair(place)
+      2.times do
+        @builder.remove_rod(
+          row: :work,
+          place: place,
+          kind: :five,
+          title: "繰り上げ",
+          brief_message: "Workの#{@builder.place_name(place)}でfive棒2本を次の位へ繰り上げるため、five棒を1本取り除きます。",
+          learn_message: "同じ位の5の棒が2本で10になるため、次の位の1本へ置き換えます。",
+          event_type: :carry_to_next_place
+        )
+      end
+      @builder.place_rod(
+        row: :work,
+        place: place + 1,
+        kind: :unit,
+        title: "繰り上げ",
+        brief_message: "Workの#{@builder.place_name(place + 1)}にunit棒を1本置きます。",
+        learn_message: "下の位の10は、1つ上の位では1として表します。",
+        event_type: :carry_to_next_place
+      )
+    end
+
+    def work_cell(place)
+      @board.row(:work).cells.fetch(place)
+    end
+
+    def digit_of(value, place)
+      digits_of(value).fetch(place, 0)
+    end
+
+    def digits_of(value)
+      SignedNumber.from_integer(value).digits
+    end
+
+    def digit_count(value)
+      value.to_s.length
+    end
+
+    def max_operand_places(abs_a, abs_b)
+      [digit_count(abs_a), digit_count(abs_b)].max
+    end
+  end
+end

data/lib/sangi/engines/copy_engine.rb

@@ -0,0 +1,85 @@
+module Sangi
+  class CopyEngine
+    def initialize(config)
+      @config = config
+    end
+
+    def build(display_a:, display_b:, result:, expression:)
+      rod_factory = RodFactory.new
+      place_count = [
+        digit_count(display_a.abs),
+        digit_count(display_b.abs),
+        digit_count(result.abs),
+        1
+      ].max
+      board = Board.from_numbers(
+        a: display_a,
+        b: display_b,
+        work: 0,
+        place_count: place_count,
+        rod_factory: rod_factory
+      )
+      board.row(:work).sign = result <=> 0
+      builder = StepBuilder.new(
+        config: @config,
+        expression: expression,
+        board: board,
+        result_value: result,
+        rod_factory: rod_factory
+      )
+
+      builder.push(
+        title: "準備",
+        brief_message: "A行とB行を表示し、Work行を空にします。",
+        learn_message: "0を含む計算なので、必要な棒だけをWork行へ写して結果を確認します。",
+        event: Event.new(type: :setup)
+      )
+      copy_result_to_work(builder, result.abs)
+      board.row(:work).normalize_zero_sign!
+      builder.push(
+        title: "完了",
+        brief_message: "計算結果は#{result}です。",
+        learn_message: "Work行の棒が表す値が計算結果です。結果は#{result}です。",
+        event: Event.new(type: :finish)
+      )
+      builder.steps
+    end
+
+    private
+
+    def copy_result_to_work(builder, value)
+      digits_of(value).each_with_index do |digit, place|
+        add_digit_rods(builder, place, digit)
+      end
+    end
+
+    def add_digit_rods(builder, place, digit)
+      (digit / 5).times do
+        builder.place_rod(
+          row: :work,
+          place: place,
+          kind: :five,
+          title: "結果を写す",
+          brief_message: "結果を表すため、Workの#{builder.place_name(place)}にfive棒を1本置きます。"
+        )
+      end
+      (digit % 5).times do
+        builder.place_rod(
+          row: :work,
+          place: place,
+          kind: :unit,
+          title: "結果を写す",
+          brief_message: "結果を表すため、Workの#{builder.place_name(place)}にunit棒を1本置きます。"
+        )
+      end
+    end
+
+    def digits_of(value)
+      SignedNumber.from_integer(value).digits
+    end
+
+    def digit_count(value)
+      value.to_s.length
+    end
+  end
+end

data/lib/sangi/engines/subtraction_borrowing.rb

@@ -0,0 +1,124 @@
+module Sangi
+  module SubtractionBorrowing
+    private
+
+    def ensure_unit_available(place)
+      cell = work_cell(place)
+      return if cell.unit_rods.any?
+
+      if cell.five_rods.any?
+        split_five_to_units(place)
+      else
+        borrow_to_place(place)
+        ensure_unit_available(place)
+      end
+    end
+
+    def ensure_five_available(place)
+      cell = work_cell(place)
+      return if cell.five_rods.any?
+
+      if cell.unit_rods.size >= 5
+        normalize_units_to_five(place)
+        return
+      end
+
+      borrow_to_place(place)
+      normalize_units_to_five(place) if work_cell(place).unit_rods.size >= 5
+      return if work_cell(place).five_rods.any?
+
+      raise InternalError, "#{@builder.place_name(place)}でfive棒を用意できません。"
+    end
+
+    def split_five_to_units(place)
+      @builder.remove_rod(
+        row: :work,
+        place: place,
+        kind: :five,
+        title: "fiveを分解",
+        brief_message: "Workの#{@builder.place_name(place)}でfive棒をunit棒5本へ分解するため、five棒を1本取り除きます。",
+        learn_message: "5を表す棒を、1を表す棒5本へ戻します。",
+        event_type: :convert_five_to_units
+      )
+      5.times do
+        @builder.place_rod(
+          row: :work,
+          place: place,
+          kind: :unit,
+          title: "fiveを分解",
+          brief_message: "Workの#{@builder.place_name(place)}にunit棒を1本置きます。",
+          learn_message: "5を表す棒の代わりに、1を表す棒を1本ずつ置きます。",
+          event_type: :convert_five_to_units
+        )
+      end
+    end
+
+    def normalize_units_to_five(place)
+      5.times do
+        @builder.remove_rod(
+          row: :work,
+          place: place,
+          kind: :unit,
+          title: "5本をまとめる",
+          brief_message: "Workの#{@builder.place_name(place)}でunit棒5本をfive棒1本にまとめるため、unit棒を1本取り除きます。",
+          event_type: :convert_unit_to_five
+        )
+      end
+      @builder.place_rod(
+        row: :work,
+        place: place,
+        kind: :five,
+        title: "5本をまとめる",
+        brief_message: "Workの#{@builder.place_name(place)}にfive棒を1本置きます。",
+        event_type: :convert_unit_to_five
+      )
+    end
+
+    def borrow_to_place(target_place)
+      source_place = find_upper_nonzero_place(target_place)
+      raise InternalError, "繰り下げ元の位が見つかりません。" if source_place.nil?
+
+      source_place.downto(target_place + 1) do |place|
+        decrement_one_at_place(place)
+        add_ten_to_lower_place(place - 1)
+      end
+    end
+
+    def find_upper_nonzero_place(target_place)
+      (target_place + 1...@board.place_count).find do |place|
+        work_cell(place).value.positive?
+      end
+    end
+
+    def decrement_one_at_place(place)
+      ensure_unit_available(place)
+      @builder.remove_rod(
+        row: :work,
+        place: place,
+        kind: :unit,
+        title: "繰り下げ",
+        brief_message: "Workの#{@builder.place_name(place)}から1を借りるため、unit棒を1本取り除きます。",
+        learn_message: "上の位から1を借りると、1つ下の位では10として扱えます。",
+        event_type: :borrow_from_upper_place
+      )
+    end
+
+    def add_ten_to_lower_place(lower_place)
+      2.times do
+        @builder.place_rod(
+          row: :work,
+          place: lower_place,
+          kind: :five,
+          title: "繰り下げ",
+          brief_message: "Workの#{@builder.place_name(lower_place)}に10を作るため、five棒を1本置きます。",
+          learn_message: "上の位から借りた1は、下の位では10です。five棒2本で10を表します。",
+          event_type: :borrow_from_upper_place
+        )
+      end
+    end
+
+    def work_cell(place)
+      @board.row(:work).cells.fetch(place)
+    end
+  end
+end

data/lib/sangi/engines/subtraction_engine.rb

@@ -0,0 +1,134 @@
+module Sangi
+  class SubtractionEngine
+    include SubtractionBorrowing
+
+    def initialize(config)
+      @config = config
+    end
+
+    def build(minuend_abs:, subtrahend_abs:, result_sign:, expression:)
+      @rod_factory = RodFactory.new
+      @result_value = result_sign * (minuend_abs - subtrahend_abs)
+      place_count = [
+        digit_count(minuend_abs),
+        digit_count(subtrahend_abs),
+        digit_count(@result_value.abs),
+        1
+      ].max
+      @board = Board.from_numbers(
+        a: minuend_abs,
+        b: subtrahend_abs,
+        work: 0,
+        place_count: place_count,
+        rod_factory: @rod_factory
+      )
+      @board.row(:work).sign = result_sign
+      @builder = StepBuilder.new(
+        config: @config,
+        expression: expression,
+        board: @board,
+        result_value: @result_value,
+        rod_factory: @rod_factory
+      )
+
+      push_setup_step
+      copy_minuend_to_work(minuend_abs)
+      digit_count(subtrahend_abs).times do |place|
+        subtract_digit_from_work(place, digit_of(subtrahend_abs, place))
+      end
+      push_finish_step
+      @builder.steps
+    end
+
+    private
+
+    def push_setup_step
+      @builder.push(
+        title: "準備",
+        brief_message: "絶対値の大きい数をA行、小さい数をB行に置き、Work行で減算します。",
+        learn_message: "異符号の加算や結果が負になる減算は、絶対値の大きい方から小さい方を引き、最後に符号を付けます。",
+        event: Event.new(type: :setup)
+      )
+    end
+
+    def push_finish_step
+      @board.row(:work).normalize_zero_sign!
+      @builder.push(
+        title: "完了",
+        brief_message: "計算結果は#{@result_value}です。",
+        learn_message: "Work行に残った棒が差を表します。結果の符号を反映すると#{@result_value}です。",
+        event: Event.new(type: :finish)
+      )
+    end
+
+    def copy_minuend_to_work(value)
+      digits_of(value).each_with_index do |digit, place|
+        add_digit_rods_to_work(place, digit)
+      end
+    end
+
+    def add_digit_rods_to_work(place, digit)
+      (digit / 5).times do
+        @builder.place_rod(
+          row: :work,
+          place: place,
+          kind: :five,
+          title: "被減数を写す",
+          brief_message: "被減数を表すため、Workの#{@builder.place_name(place)}にfive棒を1本置きます。"
+        )
+      end
+      (digit % 5).times do
+        @builder.place_rod(
+          row: :work,
+          place: place,
+          kind: :unit,
+          title: "被減数を写す",
+          brief_message: "被減数を表すため、Workの#{@builder.place_name(place)}にunit棒を1本置きます。"
+        )
+      end
+    end
+
+    def subtract_digit_from_work(place, digit)
+      return if digit.zero?
+
+      unit_count = digit % 5
+      five_count = digit / 5
+
+      unit_count.times do
+        ensure_unit_available(place)
+        @builder.remove_rod(
+          row: :work,
+          place: place,
+          kind: :unit,
+          title: "減算",
+          brief_message: "Workの#{@builder.place_name(place)}からunit棒を1本取り除きます。",
+          learn_message: "減数の1に対応する棒を、Work行から1本取り除きます。"
+        )
+      end
+
+      five_count.times do
+        ensure_five_available(place)
+        @builder.remove_rod(
+          row: :work,
+          place: place,
+          kind: :five,
+          title: "減算",
+          brief_message: "Workの#{@builder.place_name(place)}からfive棒を1本取り除きます。",
+          learn_message: "減数の5に対応する棒を、Work行から1本取り除きます。"
+        )
+      end
+    end
+
+    def digit_of(value, place)
+      digits_of(value).fetch(place, 0)
+    end
+
+    def digits_of(value)
+      SignedNumber.from_integer(value).digits
+    end
+
+    def digit_count(value)
+      value.to_s.length
+    end
+  end
+end

data/lib/sangi/errors.rb

@@ -0,0 +1,8 @@
+module Sangi
+  class Error < StandardError; end
+  class ParseError < Error; end
+  class ValidationError < Error; end
+  class StepLimitError < Error; end
+  class ExportError < Error; end
+  class InternalError < Error; end
+end

data/lib/sangi/event.rb

@@ -0,0 +1,14 @@
+module Sangi
+  class Event
+    attr_reader :type, :row, :place_index, :kind, :from, :to
+
+    def initialize(type:, row: nil, place_index: nil, kind: nil, from: nil, to: nil)
+      @type = type
+      @row = row
+      @place_index = place_index
+      @kind = kind
+      @from = from
+      @to = to
+    end
+  end
+end

data/lib/sangi/exporter/text_exporter.rb

@@ -0,0 +1,41 @@
+module Sangi
+  module Exporter
+    class TextExporter
+      SEPARATOR = "=" * 60
+
+      def initialize(config, renderer)
+        @config = config
+        @renderer = renderer
+      end
+
+      def export(path, steps)
+        File.write(path, build_text(steps), mode: "w:UTF-8")
+      rescue SystemCallError
+        raise ExportError, "ログファイルを書き込めません: #{path}"
+      end
+
+      def build_text(steps)
+        first = steps.first
+        state = first&.numeric_state || {}
+        lines = [
+          "sangi calculation log",
+          "version: #{VERSION}",
+          "expr: #{state[:source]}",
+          "normalized: #{state[:normalized]}",
+          "mode: #{@config.mode}",
+          "zero: #{@config.zero_mode}",
+          "sign: #{@config.sign_mode}",
+          "explain: #{@config.explain_mode}",
+          ""
+        ]
+        steps.each do |step|
+          lines << SEPARATOR
+          lines << "step #{step.index}/#{steps.size}"
+          lines << @renderer.render(step, total_steps: steps.size).chomp
+        end
+        lines << SEPARATOR unless steps.empty?
+        lines.join("\n") + "\n"
+      end
+    end
+  end
+end

data/lib/sangi/expression.rb

@@ -0,0 +1,20 @@
+module Sangi
+  class Expression
+    attr_reader :left, :operator, :right, :source
+
+    def initialize(left:, operator:, right:, source:)
+      @left = left
+      @operator = operator
+      @right = right
+      @source = source
+    end
+
+    def effective_right
+      operator == :- ? -right : right
+    end
+
+    def normalized_source
+      "#{left} + #{effective_right}"
+    end
+  end
+end

data/lib/sangi/parser.rb

@@ -0,0 +1,49 @@
+module Sangi
+  class Parser
+    PATTERN = /\A\s*([+-]?\d+)\s*([+-])\s*([+-]?\d+)\s*\z/
+
+    def initialize(config)
+      @config = config
+    end
+
+    def parse(source)
+      match = PATTERN.match(source.to_s)
+      raise ParseError, parse_error_message unless match
+
+      operator_text = match[2]
+      right_text = match[3]
+      raise ParseError, parse_error_message if operator_text == "+" && right_text.start_with?("+")
+
+      left = normalize_zero(match[1].to_i)
+      operator = operator_text.to_sym
+      right = normalize_zero(right_text.to_i)
+
+      validate_digits!(left)
+      validate_digits!(right)
+
+      Expression.new(
+        left: left,
+        operator: operator,
+        right: right,
+        source: source.to_s
+      )
+    end
+
+    private
+
+    def normalize_zero(value)
+      value.zero? ? 0 : value
+    end
+
+    def validate_digits!(value)
+      return if value.abs.to_s.length <= @config.max_digits
+
+      raise ValidationError,
+            "桁数が上限を超えています。現在の上限: #{@config.max_digits}桁。上限を変更するには --max-digits N を指定してください。"
+    end
+
+    def parse_error_message
+      "入力式を解釈できません。例: 123+45, 100-7, -12+7, 3--5"
+    end
+  end
+end