twisty_puzzles 0.0.1

data/lib/twisty_puzzles/move_type_creator.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module TwistyPuzzles
+  
+    # Class for creating one move type from its parts.
+    # Helper class for parsing logic.
+    class MoveTypeCreator
+      def initialize(capture_keys, move_class)
+        raise TypeError unless move_class.is_a?(Class)
+        raise TypeError unless capture_keys.all? { |k| k.is_a?(Symbol) }
+
+        @capture_keys = capture_keys.freeze
+        @move_class = move_class
+      end
+
+      def applies_to?(parsed_parts)
+        parsed_parts.keys.sort == @capture_keys.sort
+      end
+
+      def create(parsed_parts)
+        raise ArgumentError unless applies_to?(parsed_parts)
+
+        fields = @capture_keys.map { |name| parsed_parts[name] }
+        @move_class.new(*fields)
+      end
+    end
+end

data/lib/twisty_puzzles/parser.rb

@@ -0,0 +1,222 @@
+# frozen_string_literal: true
+
+require 'twisty_puzzles/algorithm'
+require 'twisty_puzzles/commutator'
+require 'twisty_puzzles/cube_move_parser'
+require 'twisty_puzzles/skewb_move_parser'
+require 'twisty_puzzles/twisty_puzzles_error'
+
+module TwistyPuzzles
+  # rubocop:disable Style/Documentation
+  
+    # rubocop:enable Style/Documentation
+    class CommutatorParseError < TwistyPuzzlesError
+    end
+
+    # Parser for commutators and algorithms.
+    class Parser
+      OPENING_BRACKET = '['
+      OPENING_PAREN = '('
+      CLOSING_BRACKET = ']'
+      CLOSING_PAREN = ')'
+      TIMES = '*'
+
+      def initialize(alg_string, move_parser)
+        @alg_string = alg_string
+        @scanner = StringScanner.new(alg_string)
+        @move_parser = move_parser
+      end
+
+      def parse_open_paren
+        complain('beginning of trigger') unless @scanner.getch == OPENING_PAREN
+      end
+
+      def parse_close_paren
+        complain('end of trigger') unless @scanner.getch == CLOSING_PAREN
+      end
+
+      def parse_times
+        complain('times symbol of multiplier') unless @scanner.getch == TIMES
+      end
+
+      def parse_factor
+        number = @scanner.scan(/\d+/)
+        complain('factor of multiplier') unless number
+        Integer(number, 10)
+      end
+
+      def parse_multiplier
+        skip_spaces
+        parse_times
+        skip_spaces
+        parse_factor
+      end
+
+      def parse_trigger
+        parse_open_paren
+        skip_spaces
+        moves = parse_moves_with_triggers
+        skip_spaces
+        parse_close_paren
+        skip_spaces
+        case @scanner.peek(1)
+        when TIMES
+          moves * parse_multiplier
+        when ('0'..'9')
+          moves * parse_factor
+        else
+          moves
+        end
+      end
+
+      # Parses at least one move and allows for triggers in parentheses.
+      def parse_moves_with_triggers
+        skip_spaces
+        if @scanner.peek(1) == OPENING_PAREN
+          parse_trigger + parse_moves_with_triggers
+        else
+          parse_moves
+        end
+      end
+
+      # Parses at least one move.
+      def parse_nonempty_moves
+        moves = parse_moves
+        complain('move') if moves.empty?
+        moves
+      end
+
+      # Parses a series of moves.
+      def parse_moves
+        moves = []
+        while (m = begin skip_spaces; parse_move_internal end)
+          moves.push(m)
+        end
+        Algorithm.new(moves)
+      end
+
+      def complain(parsed_object)
+        raise CommutatorParseError, <<~ERROR.chomp
+          Couldn't parse #{parsed_object} here:
+            #{@alg_string}
+            #{' ' * @scanner.pos}^"
+        ERROR
+      end
+
+      def check_eos(parsed_object)
+        complain("end of #{parsed_object}") unless @scanner.eos?
+      end
+
+      def parse_open_bracket
+        complain('beginning of commutator') unless @scanner.getch == OPENING_BRACKET
+      end
+
+      def parse_close_bracket
+        complain('end of commutator') unless @scanner.getch == CLOSING_BRACKET
+      end
+
+      def parse_commutator
+        skip_spaces
+        if @scanner.peek(1) == OPENING_BRACKET
+          parse_commutator_internal
+        else
+          FakeCommutator.new(parse_moves_with_triggers)
+        end
+      end
+
+      def parse_algorithm
+        skip_spaces
+        parse_moves_with_triggers
+      end
+
+      def parse_setup_commutator_inner
+        skip_spaces
+        if @scanner.peek(1) == OPENING_BRACKET
+          parse_pure_commutator
+        else
+          FakeCommutator.new(parse_moves_with_triggers)
+        end
+      end
+
+      def parse_pure_commutator
+        skip_spaces
+        parse_open_bracket
+        first_part = parse_nonempty_moves
+        skip_spaces
+        complain('middle of pure commutator') unless @scanner.getch == ','
+        second_part = parse_nonempty_moves
+        skip_spaces
+        parse_close_bracket
+        PureCommutator.new(first_part, second_part)
+      end
+
+      def parse_commutator_internal_after_separator(setup_or_first_part, separator)
+        if [':', ';'].include?(separator)
+          inner_commutator = parse_setup_commutator_inner
+          SetupCommutator.new(setup_or_first_part, inner_commutator)
+        elsif separator == ','
+          second_part = parse_nonempty_moves
+          PureCommutator.new(setup_or_first_part, second_part)
+        else
+          complain('end of setup or middle of pure commutator') unless @scanner.eos?
+        end
+      end
+
+      def parse_commutator_internal
+        skip_spaces
+        parse_open_bracket
+        setup_or_first_part = parse_nonempty_moves
+        skip_spaces
+        separator = @scanner.getch
+        comm = parse_commutator_internal_after_separator(setup_or_first_part, separator)
+        skip_spaces
+        parse_close_bracket
+        skip_spaces
+        complain('end of commutator') unless @scanner.eos?
+        comm
+      end
+
+      def parse_move_internal
+        move = @scanner.scan(@move_parser.regexp)
+        return unless move
+
+        @move_parser.parse_move(move)
+      end
+
+      def skip_spaces
+        @scanner.skip(/\s+/)
+      end
+    end
+
+    def parse_commutator(alg_string, complete_parse = true)
+      parser = Parser.new(alg_string, CubeMoveParser::INSTANCE)
+      commutator = parser.parse_commutator
+      parser.check_eos('commutator') if complete_parse
+      commutator
+    end
+
+    def parse_cube_algorithm(alg_string, complete_parse = true)
+      parser = Parser.new(alg_string, CubeMoveParser::INSTANCE)
+      algorithm = parser.parse_algorithm
+      parser.check_eos('algorithm') if complete_parse
+      algorithm
+    end
+
+    def parse_cube_move(move_string)
+      CubeMoveParser::INSTANCE.parse_move(move_string)
+    end
+
+    alias parse_algorithm parse_cube_algorithm
+    alias parse_move parse_cube_move
+
+    def parse_skewb_algorithm(alg_string, notation, complete_parse = true)
+      parser = Parser.new(alg_string, SkewbMoveParser.new(notation))
+      algorithm = parser.parse_algorithm
+      parser.check_eos('algorithm') if complete_parse
+      algorithm
+    end
+
+    def parse_skewb_move(move_string, notation)
+      SkewbMoveParser.new(notation).parse_move(move_string)
+    end
+end

data/lib/twisty_puzzles/part_cycle_factory.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require 'twisty_puzzles/sticker_cycle'
+require 'twisty_puzzles/utils/array_helper'
+
+module TwistyPuzzles
+  
+    # Factory for sticker cycles given part cycles.
+    class PartCycleFactory
+      include Utils::ArrayHelper
+
+      def initialize(cube_size, incarnation_index)
+        CubeState.check_cube_size(cube_size)
+        unless incarnation_index.is_a?(Integer) && incarnation_index >= 0
+          raise ArgumentError, "Invalid incarnation index #{incarnation_index}."
+        end
+
+        @cube_size = cube_size
+        @incarnation_index = incarnation_index
+        @cache = {}
+      end
+
+      def coordinates(part)
+        @cache[part] ||= Coordinate.solved_positions(part, @cube_size, @incarnation_index)
+      end
+
+      def multi_twist(parts)
+        unless parts.all? { |p| p.is_a?(Corner) || p.is_a?(Edge) }
+          raise TypeError, 'Twists are only supported for edges and corners.'
+        end
+
+        cycles = parts.map { |p| StickerCycle.new(@cube_size, coordinates(p)) }
+        StickerCycles.new(@cube_size, cycles)
+      end
+
+      def check_type_consistency(parts)
+        return unless parts.any? { |p| p.class != parts.first.class }
+
+        raise TypeError, "Cycles of heterogenous piece types #{parts.inspect} are not supported."
+      end
+
+      def construct(parts)
+        if parts.length < 2
+          raise ArgumentError, 'Cycles of length smaller than 2 are not supported.'
+        end
+
+        unless @incarnation_index < parts.first.num_incarnations(@cube_size)
+          raise ArgumentError, "Incarnation index #{@incarnation_index} for cube size " \
+                               "#{@cube_size} is not supported for #{parts.first.inspect}."
+        end
+
+        check_types(parts, Part)
+        check_type_consistency(parts)
+        part_coordinates = parts.map { |p| coordinates(p) }
+        cycles = part_coordinates.transpose.map { |c| StickerCycle.new(@cube_size, c) }
+        StickerCycles.new(@cube_size, cycles)
+      end
+    end
+end

data/lib/twisty_puzzles/puzzle.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module TwistyPuzzles
+  
+    # Represents one type of puzzle.
+    class Puzzle
+      def initialize(name)
+        @name = name
+      end
+
+      NXN_CUBE = Puzzle.new('nxn cube')
+      SKEWB = Puzzle.new('skewb')
+
+      attr_reader :name
+
+      def eql?(other)
+        self.class == other.class && name == other.name
+      end
+
+      def hash
+        @hash ||= [self.class, @name].hash
+      end
+
+      alias == eql?
+    end
+end

data/lib/twisty_puzzles/reversible_applyable.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'twisty_puzzles/skewb_state'
+
+module TwistyPuzzles
+  
+    # Module that makes a class that has an `apply_to` and `reverse` be able to apply temporarily.
+    module ReversibleApplyable
+      def apply_to_dupped(puzzle_state)
+        dupped = puzzle_state.dup
+        apply_to(dupped)
+        dupped
+      end
+
+      # Applies the current algorithm/cycle/whatever to the given puzzle state and yields the
+      # modified version. The puzzle state will be the same as the original after this function
+      # returns.
+      # Whether the yielded puzzle state is actually the same as the passed one or a copy is an
+      # implementation detail.
+      def apply_temporarily_to(puzzle_state)
+        return yield(apply_to_dupped(puzzle_state)) if with_dup_is_faster?(puzzle_state)
+
+        apply_to(puzzle_state)
+        begin
+          yield(puzzle_state)
+        ensure
+          inverse.apply_to(puzzle_state)
+        end
+      end
+
+      private
+
+      def with_dup_is_faster?(state)
+        !state.is_a?(CubeState) || state.n <= 4
+      end
+    end
+end

data/lib/twisty_puzzles/rotation.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+require 'twisty_puzzles/algorithm'
+require 'twisty_puzzles/axis_face_and_direction_move'
+require 'twisty_puzzles/cube'
+require 'twisty_puzzles/cube_direction'
+require 'twisty_puzzles/cube_move'
+require 'twisty_puzzles/puzzle'
+
+module TwistyPuzzles
+  
+    # A rotation of a Skewb or cube.
+    class Rotation < AxisFaceAndDirectionMove
+      ALL_ROTATIONS = Face::ELEMENTS.product(CubeDirection::ALL_DIRECTIONS).map { |f, d| new(f, d) }
+      NON_ZERO_ROTATIONS =
+        Face::ELEMENTS.product(CubeDirection::NON_ZERO_DIRECTIONS).map { |f, d| new(f, d) }
+      LEFT = new(Face::U, CubeDirection::BACKWARD)
+      RIGHT = new(Face::U, CubeDirection::FORWARD)
+
+      # Translates a Skewb direction into a cube direction.
+      def self.translated_direction(direction)
+        case direction
+        when SkewbDirection::ZERO then CubeDirection::ZERO
+        when SkewbDirection::FORWARD then CubeDirection::FORWARD
+        when SkewbDirection::BACKWARD then CubeDirection::BACKWARD
+        end
+      end
+
+      # Returns an algorithm consisting of two rotations that are equivalent to rotating
+      # the puzzle around a corner.
+      # Takes a Skewb direction as an argument (even for cubes) because rotating around
+      # is like a Skewb move given that it's modulo 3.
+      def self.around_corner(corner, skewb_direction)
+        raise TypeError unless corner.is_a?(Corner)
+        raise TypeError unless skewb_direction.is_a?(SkewbDirection)
+
+        direction = translated_direction(skewb_direction)
+
+        Algorithm.new([
+                        Rotation.new(corner.faces[skewb_direction.value], direction),
+                        Rotation.new(corner.faces[0], direction)
+                      ])
+      end
+
+      def to_s
+        "#{AXES[@axis_face.axis_priority]}#{canonical_direction.name}"
+      end
+
+      def puzzles
+        [Puzzle::SKEWB, Puzzle::NXN_CUBE]
+      end
+
+      def slice_move?
+        false
+      end
+
+      # Returns an alternative representation of the same rotation
+      def alternative
+        Rotation.new(@axis_face.opposite, @direction.inverse)
+      end
+
+      def equivalent_internal?(other, _cube_size)
+        [self, alternative].include?(other)
+      end
+
+      def prepend_rotation(other, _cube_size)
+        if same_axis?(other)
+          direction = translated_direction(other.axis_face)
+          Algorithm.move(Rotation.new(other.axis_face, direction + other.direction))
+        elsif @direction.double_move? && other.direction.double_move?
+          used_axis_priorities = [@axis_face, other.axis_face].map(&:axis_priority)
+          # Note that there are two solutions, but any works.
+          remaining_face =
+            Face::ELEMENTS.find { |f| !used_axis_priorities.include?(f.axis_priority) }
+          Algorithm.move(Rotation.new(remaining_face, CubeDirection::DOUBLE))
+        end
+      end
+
+      def prepend_fat_m_slice_move(_other, _cube_size)
+        nil
+      end
+
+      def prepend_fat_move(other, cube_size)
+        return unless compatible_fat_move?(other)
+
+        Algorithm.move(
+          FatMove.new(other.axis_face.opposite, other.direction, other.inverted_width(cube_size))
+        )
+      end
+
+      def prepend_slice_move(_other, _cube_size)
+        nil
+      end
+
+      def move_count(_cube_size, _metric = :htm)
+        0
+      end
+
+      private
+
+      def compatible_fat_move?(other)
+        same_axis?(other) && translated_direction(other.axis_face) == other.direction.inverse
+      end
+    end
+end