twisty_puzzles 0.0.9 → 0.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3dfb23949825572c531ac7bfcea491151629f8673160605069b1793a827d961a
-  data.tar.gz: f343cc589e99ac129717f47a7b3dbe4dcb3d4a0cbcae2e0f8c42b12b22ad842c
+  metadata.gz: 20cf60d5066716b3eaa148e33f1e8c598387573170e1005d034f3128e6b971cb
+  data.tar.gz: 2770afd2a3a625f281089401c2a2ef47a6c61843d09026e9d999ee79139fe54e
 SHA512:
-  metadata.gz: 2fc20aef94e333318c53ee292b5418424ad8880cc2f8ff18c2102d0799d96728ccc9a98869269bf9c6a046174dcf5f71182cf6498021838d8772c18a7008cfe2
-  data.tar.gz: b79344d44bf6fd32cd9443c79405dcab052867a746e23fecc0b1496bd96b36fc6c4dd09d2a8c3d33389d7e5b5daaf0ca4a0552cce8948c59ac590da458c6150d
+  metadata.gz: 2bdf4691d6efea522b259510bcdb405820784870566948d47b653c91e2d8ca495d9946e17f0d9f703ee234bf0758b3a59969dc52e4f91eafa94659c624ac3930
+  data.tar.gz: b28d42481604cbec6b748b025a3293eed64e2c7a90b0e6186c6eadeed63352f81b562e835f54bf6b4fbc9905bf047c917b269896c5504628c7d9c7352c1b70ec

data/lib/twisty_puzzles/abstract_move.rb

@@ -143,6 +143,10 @@ module TwistyPuzzles
       prepend_slice_move(other, cube_size)
     end
 
+    def prepend_slice_move(_other, _cube_size)
+      raise NotImplementedError, "#{self.class}#prepend_slice_move is not implemented"
+    end
+
     private
 
     def move_count_internal(metric, slice_factor, direction_factor)

data/lib/twisty_puzzles/abstract_move_parser.rb

@@ -31,14 +31,14 @@ module TwistyPuzzles
     def parse_move(move_string)
       match = move_string.match(regexp)
       if !match || !match.pre_match.empty? || !match.post_match.empty?
-        raise ArgumentError("Invalid move #{move_string}.")
+        raise ArgumentError, "Invalid move #{move_string}."
       end
 
       parsed_parts = parse_named_captures(match)
       move_type_creators.each do |parser|
         return parser.create(parsed_parts) if parser.applies_to?(parsed_parts)
       end
-      raise "No move type creator applies to #{parsed_parts}"
+      raise ArgumentError, "No move type creator applies to #{parsed_parts}"
     end
   end
 end

data/lib/twisty_puzzles/algorithm_transformation.rb

@@ -4,28 +4,36 @@ require 'twisty_puzzles/cube_direction'
 require 'twisty_puzzles/rotation'
 
 module TwistyPuzzles
-  AlgorithmTransformation =
-    Struct.new(:rotation, :mirror, :mirror_normal_face) do
-      def transformed(algorithm)
-        algorithm = algorithm.mirror(mirror_normal_face) if mirror
-        algorithm.rotate_by(rotation)
-      end
+  # A transformation consisting of mirroring and rotating that can be applied to an algorithm.
+  class AlgorithmTransformation
+    def initialize(rotation, mirror, mirror_normal_face)
+      @rotation = rotation
+      @mirror = mirror
+      @mirror_normal_face = mirror_normal_face
+    end
 
-      def identity?
-        rotation.identity? && !mirror
-      end
+    attr_reader :rotation, :mirror, :mirror_normal_face
 
-      # Returns algorithm transformations that mirror an algorithm and rotate it around a face.
-      def self.around_face(face)
-        around_face_rotations = CubeDirection::ALL_DIRECTIONS.map { |d| Rotation.new(face, d) }
-        mirror_normal_face = face.neighbors.first
-        around_face_rotations.product([true, false]).map do |r, m|
-          AlgorithmTransformation.new(r, m, mirror_normal_face)
-        end
-      end
+    def transformed(algorithm)
+      algorithm = algorithm.mirror(mirror_normal_face) if mirror
+      algorithm.rotate_by(rotation)
+    end
 
-      def self.around_face_without_identity(face)
-        around_face(face).reject(&:identity?)
+    def identity?
+      rotation.identity? && !mirror
+    end
+
+    # Returns algorithm transformations that mirror an algorithm and rotate it around a face.
+    def self.around_face(face)
+      around_face_rotations = CubeDirection::ALL_DIRECTIONS.map { |d| Rotation.new(face, d) }
+      mirror_normal_face = face.neighbors.first
+      around_face_rotations.product([true, false]).map do |r, m|
+        AlgorithmTransformation.new(r, m, mirror_normal_face)
       end
     end
+
+    def self.around_face_without_identity(face)
+      around_face(face).reject(&:identity?)
+    end
+  end
 end

data/lib/twisty_puzzles/axis_face_and_direction_move.rb

@@ -55,7 +55,9 @@ module TwistyPuzzles
         self
       else
         rotation_neighbors = rotation.axis_face.neighbors
-        face_index = rotation_neighbors.index(@axis_face) || raise
+        face_index = rotation_neighbors.index(@axis_face)
+        raise unless face_index
+
         new_axis_face =
           rotation_neighbors[(face_index + rotation.direction.value) % rotation_neighbors.length]
         fields = replace_once(identifying_fields, @axis_face, new_axis_face)

data/lib/twisty_puzzles/color_scheme.rb

@@ -37,7 +37,7 @@ module TwistyPuzzles
     end
 
     def part_for_colors(part_type, colors)
-      raise ArgumentError unless part_type.is_a?(Class)
+      raise ArgumentError unless part_type.is_a?(Class) && (part_type < Part)
 
       part_type.for_face_symbols(colors.map { |c| face_symbol(c) })
     end
@@ -95,10 +95,12 @@ module TwistyPuzzles
 
     def chirality_corner_source_and_unknown_index(obvious_turned_face_symbols_to_colors)
       corner_matcher =
-        CornerMatcher.new(CHIRALITY_FACE_SYMBOLS.map do |s|
-                            # This will return nil for exactly one face that we don't know yet.
-                            @colors_to_face_symbols[obvious_turned_face_symbols_to_colors[s]]
-                          end)
+        CornerMatcher.new(
+          CHIRALITY_FACE_SYMBOLS.map do |s|
+            # This will return nil for exactly one face that we don't know yet.
+            @colors_to_face_symbols[obvious_turned_face_symbols_to_colors[s]]
+          end
+        )
 
       # There should be exactly one corner that gets mapped to the chirality corner.
       chirality_corner_source =
@@ -141,7 +143,7 @@ module TwistyPuzzles
                 "Color #{c} cannot be part of the color scheme because it is a reserved color."
         end
       end
-      raise ArgumentError unless face_symbols_to_colors.values.all? { |c| c.is_a?(Symbol) }
+      raise ArgumentError unless face_symbols_to_colors.values.all?(Symbol)
     end
 
     def add_missing_mappings(turned_face_symbols_to_colors, chirality_corner_source, unknown_index)

data/lib/twisty_puzzles/commutator.rb

@@ -10,6 +10,10 @@ module TwistyPuzzles
     def cancellations(other, cube_size, metric = :htm)
       algorithm.cancellations(other.algorithm, cube_size, metric)
     end
+
+    def algorithm
+      raise NotImplementedError
+    end
   end
 
   # Algorithm that is used like a commutator but actually isn't one.

data/lib/twisty_puzzles/coordinate.rb

@@ -28,7 +28,7 @@ module TwistyPuzzles
 
     # Middle coordinate for uneven numbers, the one before for even numbers
     def self.middle_or_before(cube_size)
-      cube_size - cube_size / 2 - 1
+      cube_size - (cube_size / 2) - 1
     end
 
     # Middle coordinate for uneven numbers, the one after for even numbers
@@ -38,7 +38,7 @@ module TwistyPuzzles
 
     # The last coordinate that is strictly before the middle
     def self.last_before_middle(cube_size)
-      cube_size / 2 - 1
+      (cube_size / 2) - 1
     end
 
     def self.canonicalize(index, cube_size)
@@ -310,7 +310,7 @@ module TwistyPuzzles
 
     def self.for_corner(corner)
       native = Native::SkewbCoordinate.for_corner(corner.face_symbols)
-      new(Face.for_face_symbol(corner.face_symbols.first), 1 + corner.piece_index % 4, native)
+      new(Face.for_face_symbol(corner.face_symbols.first), 1 + (corner.piece_index % 4), native)
     end
 
     def hash

data/lib/twisty_puzzles/cube.rb

@@ -34,6 +34,14 @@ module TwistyPuzzles
 
     attr_reader :piece_index, :face_symbols
 
+    def self.min_parseable_face_symbols
+      self::FACES
+    end
+
+    def self.max_parseable_face_symbols
+      self::FACES
+    end
+
     def self.generate_parts
       valid_face_symbol_combinations =
         FACE_SYMBOLS.permutation(self::FACES).select do |p|
@@ -64,10 +72,18 @@ module TwistyPuzzles
       true
     end
 
+    def num_incarnations(_cube_size)
+      1
+    end
+
     def base_index_on_face(cube_size, incarnation_index)
       base_index_on_other_face(solved_face, cube_size, incarnation_index)
     end
 
+    def base_index_on_other_face(face, cube_size, incarnation_index)
+      raise NotImplementedError
+    end
+
     def self.for_face_symbols_internal(face_symbols)
       raise unless face_symbols.length == self::FACES
 
@@ -82,6 +98,10 @@ module TwistyPuzzles
       self::ELEMENTS[index]
     end
 
+    def self.valid?(_face_symbols)
+      false
+    end
+
     def <=>(other)
       @piece_index <=> other.piece_index
     end
@@ -110,7 +130,7 @@ module TwistyPuzzles
     # Rotate a piece such that the given face symbol is the first face symbol.
     def rotate_face_symbol_up(face_symbol)
       index = @face_symbols.index(face_symbol)
-      raise "Part #{self} doesn't have face symbol #{c}." unless index
+      raise "Part #{self} doesn't have face symbol #{face_symbol}." unless index
 
       rotate_by(index)
     end
@@ -133,13 +153,9 @@ module TwistyPuzzles
       (0...@face_symbols.length).map { |i| rotate_by(i) }
     end
 
-    def self.create_for_face_symbols(face_symbols)
-      new(face_symbols)
-    end
-
     def self.parse(piece_description)
       face_symbols =
-        piece_description.upcase.strip.split('').map do |e|
+        piece_description.upcase.strip.chars.map do |e|
           FACE_SYMBOLS[FACE_NAMES.index(e)]
         end
       for_face_symbols(face_symbols)
@@ -319,6 +335,14 @@ module TwistyPuzzles
   class MoveableCenter < Part
     FACES = 1
 
+    def self.min_parseable_face_symbols
+      self::CORRESPONDING_PART_CLASS::FACES
+    end
+
+    def self.max_parseable_face_symbols
+      self::CORRESPONDING_PART_CLASS::FACES
+    end
+
     def self.min_cube_size
       4
     end
@@ -338,10 +362,6 @@ module TwistyPuzzles
       find_only(self::ELEMENTS) { |e| e.corresponding_part == corresponding_part }
     end
 
-    def self.create_for_face_symbols(face_symbols)
-      new(self::CORRESPONDING_PART_CLASS.create_for_face_symbols(face_symbols))
-    end
-
     def face_symbol
       @face_symbols[0]
     end
@@ -463,11 +483,15 @@ module TwistyPuzzles
       false
     end
 
+    def self.max_parseable_face_symbols
+      FACES + 1
+    end
+
     def self.for_face_symbols(face_symbols)
       # One additional face symbol is usually mentioned for wings.
       raise unless face_symbols.length == FACES || face_symbols.length == FACES + 1
 
-      if face_symbols.length == 3
+      if face_symbols.length == FACES + 1
         for_corner_face_symbols(face_symbols)
       else
         for_face_symbols_internal(face_symbols)
@@ -514,7 +538,7 @@ module TwistyPuzzles
     end
 
     def num_incarnations(cube_size)
-      [cube_size / 2 - 1, 0].max
+      cube_size > 3 ? (cube_size / 2) - 1 : 0
     end
 
     # One index of such a piece on a on a NxN face.
@@ -530,14 +554,6 @@ module TwistyPuzzles
   class Corner < Part
     FACES = 3
 
-    def self.create_for_face_symbols(face_symbols)
-      piece_candidates =
-        face_symbols[1..].permutation.map do |cs|
-          new([face_symbols[0]] + cs)
-        end
-      find_only(piece_candidates, &:valid?)
-    end
-
     def self.for_face_symbols(face_symbols)
       unless face_symbols.length == FACES
         raise "Invalid number of face_symbols to create a corner: #{face_symbols.inspect}"
@@ -621,7 +637,7 @@ module TwistyPuzzles
     ELEMENTS = generate_parts
 
     def num_incarnations(cube_size)
-      [cube_size / 2 - 1, 0].max
+      cube_size > 3 ? (cube_size / 2) - 1 : 0
     end
 
     # One index of such a piece on a on a NxN face.
@@ -644,10 +660,10 @@ module TwistyPuzzles
     end
 
     def num_incarnations(cube_size)
-      if cube_size.even?
+      if cube_size.even? || cube_size <= 3
         0
       else
-        [cube_size / 2 - 1, 0].max
+        (cube_size / 2) - 1
       end
     end
 

data/lib/twisty_puzzles/cube_move.rb

@@ -68,8 +68,8 @@ module TwistyPuzzles
 
     def equivalent_slice_move?(other, cube_size)
       cube_size == 3 && other.slice_index == 1 &&
-        (@axis_face == other.axis_face && @direction == other.direction ||
-         @axis_face == other.axis_face.opposite && @direction == other.direction.inverse)
+        ((@axis_face == other.axis_face && @direction == other.direction) ||
+         (@axis_face == other.axis_face.opposite && @direction == other.direction.inverse))
     end
   end
 

data/lib/twisty_puzzles/cube_print_helper.rb

@@ -72,9 +72,9 @@ module TwistyPuzzles
     def skewb_ascii_art_line(first_color, middle_color, last_color, num_first_color)
       raise if num_first_color > SKEWB_FACE_SIZE / 2
 
-      first_color * num_first_color +
-        middle_color * (SKEWB_FACE_SIZE - 2 * num_first_color) +
-        last_color * num_first_color
+      (first_color * num_first_color) +
+        (middle_color * (SKEWB_FACE_SIZE - (2 * num_first_color))) +
+        (last_color * num_first_color)
     end
 
     def skewb_ascii_art(center_color, corner_colors)
@@ -116,7 +116,7 @@ module TwistyPuzzles
       front_face = face_lines(cube_state, :F, 1, 3) { |c| color_character(c, color_mode) }
       right_face = face_lines(cube_state, :R, 1, 3) { |c| color_character(c, color_mode) }
       pll_line = front_face.first + right_face.first
-      (top_face + [pll_line] * 3).join("\n")
+      (top_face + ([pll_line] * 3)).join("\n")
     end
 
     def cube_string(cube_state, color_mode)
@@ -150,7 +150,7 @@ module TwistyPuzzles
     end
 
     def pad_lines(lines, padding)
-      lines.map { |line| empty_name * padding + line }
+      lines.map { |line| (empty_name * padding) + line }
     end
 
     def zip_concat_lines(*args)

data/lib/twisty_puzzles/cube_state.rb

@@ -75,6 +75,16 @@ module TwistyPuzzles
 
     alias == eql?
 
+    def rotation_algorithms
+      Rotation::ALL_ROTATIONS.combination(2).reject do |r0, r1|
+        r0.inverse == r1
+      end.map { |rs| Algorithm.new(rs) } # rubocop:disable Style/MultilineBlockChain
+    end
+
+    def equal_modulo_rotations?(other)
+      rotation_algorithms.any? { |r| r.apply_temporarily_to(self) { |state| state == other } }
+    end
+
     def hash
       @hash ||= [self.class, @native].hash
     end

data/lib/twisty_puzzles/move_type_creator.rb

@@ -6,7 +6,7 @@ module TwistyPuzzles
   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) }
+      raise TypeError unless capture_keys.all?(Symbol)
 
       @capture_keys = capture_keys.freeze
       @move_class = move_class

data/lib/twisty_puzzles/parser.rb

@@ -77,8 +77,8 @@ module TwistyPuzzles # rubocop:disable Style/Documentation
     end
 
     # Parses at least one move.
-    def parse_nonempty_moves
-      moves = parse_moves
+    def parse_nonempty_moves_with_triggers
+      moves = parse_moves_with_triggers
       complain('move') if moves.empty?
       moves
     end
@@ -117,10 +117,26 @@ module TwistyPuzzles # rubocop:disable Style/Documentation
       if @scanner.peek(1) == OPENING_BRACKET
         parse_commutator_internal
       else
-        FakeCommutator.new(parse_moves_with_triggers)
+        parse_commutator_no_brackets
       end
     end
 
+    def parse_commutator_no_brackets
+      setup_or_first_part_or_algorithm = parse_moves_with_triggers
+      skip_spaces
+      if @scanner.eos? || !SEPARATORS.include?(@scanner.peek(1))
+        return FakeCommutator.new(setup_or_first_part_or_algorithm)
+      end
+
+      setup_or_first_part = setup_or_first_part_or_algorithm
+      complain('move') if setup_or_first_part.empty?
+      separator = parse_separator
+      comm = parse_commutator_internal_after_separator(setup_or_first_part, separator)
+      skip_spaces
+      complain('end of commutator') unless @scanner.eos?
+      comm
+    end
+
     def parse_algorithm
       skip_spaces
       parse_moves_with_triggers
@@ -131,40 +147,67 @@ module TwistyPuzzles # rubocop:disable Style/Documentation
       if @scanner.peek(1) == OPENING_BRACKET
         parse_pure_commutator
       else
-        FakeCommutator.new(parse_moves_with_triggers)
+        parse_pure_commutator_no_brackets
       end
     end
 
     def parse_pure_commutator
       skip_spaces
       parse_open_bracket
-      first_part = parse_nonempty_moves
+      first_part = parse_nonempty_moves_with_triggers
       skip_spaces
-      complain('middle of pure commutator') unless @scanner.getch == ','
-      second_part = parse_nonempty_moves
+      parse_comma
+      second_part = parse_nonempty_moves_with_triggers
       skip_spaces
       parse_close_bracket
       PureCommutator.new(first_part, second_part)
     end
 
+    def parse_pure_commutator_no_brackets
+      first_part_or_algorithm = parse_moves_with_triggers
+      skip_spaces
+      if @scanner.eos? || !@scanner.peek(1) == ','
+        return FakeCommutator.new(first_part_or_algorithm)
+      end
+
+      first_part = first_part_or_algorithm
+      complain('move') if first_part.empty?
+      parse_comma
+      second_part = parse_nonempty_moves_with_triggers
+      skip_spaces
+      PureCommutator.new(first_part, second_part)
+    end
+
+    def parse_comma
+      complain('middle of pure commutator') unless @scanner.getch == ','
+    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
+        second_part = parse_nonempty_moves_with_triggers
         PureCommutator.new(setup_or_first_part, second_part)
       else
         complain('end of setup or middle of pure commutator') unless @scanner.eos?
       end
     end
 
+    SEPARATORS = %w[; : ,].freeze
+
+    def parse_separator
+      separator = @scanner.getch
+      complain('separator between commutator parts') unless SEPARATORS.include?(separator)
+      separator
+    end
+
     def parse_commutator_internal
       skip_spaces
       parse_open_bracket
-      setup_or_first_part = parse_nonempty_moves
+      setup_or_first_part = parse_nonempty_moves_with_triggers
       skip_spaces
-      separator = @scanner.getch
+      separator = parse_separator
       comm = parse_commutator_internal_after_separator(setup_or_first_part, separator)
       skip_spaces
       parse_close_bracket

data/lib/twisty_puzzles/rotation.rb

@@ -35,10 +35,12 @@ module TwistyPuzzles
 
       direction = translated_direction(skewb_direction)
 
-      Algorithm.new([
-                      Rotation.new(corner.faces[skewb_direction.value], direction),
-                      Rotation.new(corner.faces[0], direction)
-                    ])
+      Algorithm.new(
+        [
+          Rotation.new(corner.faces[skewb_direction.value], direction),
+          Rotation.new(corner.faces[0], direction)
+        ]
+      )
     end
 
     def to_s

data/lib/twisty_puzzles/skewb_state.rb

@@ -26,10 +26,12 @@ module TwistyPuzzles
               next unless c2.face_symbols.include?(c1_rot.face_symbols.first)
 
               c2_rot = c2.rotate_face_symbol_up(c1_rot.face_symbols.first)
-              check_parts.push([
-                                 SkewbCoordinate.for_corner(c1_rot),
-                                 SkewbCoordinate.for_corner(c2_rot)
-                               ])
+              check_parts.push(
+                [
+                  SkewbCoordinate.for_corner(c1_rot),
+                  SkewbCoordinate.for_corner(c2_rot)
+                ]
+              )
             end
             matching_corners.push(check_parts)
           end

data/lib/twisty_puzzles/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TwistyPuzzles
-  VERSION = '0.0.9'
+  VERSION = '0.0.13'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twisty_puzzles
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.13
 platform: ruby
 authors:
 - Bernhard F. Brodowsky
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-04-21 00:00:00.000000000 Z
+date: 2021-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize