twisty_puzzles 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a6328e75fef53854e6be5c5f5cbe3eb27e775b2b97397731ee6547291126fa94
-  data.tar.gz: fc78c670139d170a18aa1f89854520ba00596ba4078b65dc4572a3c6d4ee4b9e
+  metadata.gz: 59a43662a260f2e013e0b59b6597dbfc4f6b5a04bc9d49b9f350b9c3a050babe
+  data.tar.gz: 98e23ce0bbcb677b9deb490ca02bb2e6c3fbd376c0c5a35dcb79d6e06afbd905
 SHA512:
-  metadata.gz: 31ac0e826d8011114db4edcd88a87c52d47dc7ca925c51533c4262869e361608ed935f907342cb8d41145086086798bd837aaf1ae4e7bc509282f070f4c03d86
-  data.tar.gz: 1cb3ed5deb0a2bcdfd5e3ae469c4ad8e701504da2ab222eff4fa24c8f2b10413a8f96ee356b91c514846f8c416744e4f7ae90a8d6135ff9cf8fd4e1b6cdbcff5
+  metadata.gz: fb187fa6e58c48444b5629e4ab195f2063d2ad9b0c8f07aa8d3a4e19486c177fb29b38a404e2a80f0690d6491466f94cd638d04fc6d76389ffb915671c2107a4
+  data.tar.gz: 9b89321ce8b01b446b992a318aaf43f2cdc54bc9745d16538f14e2bc93f038a413923a11c0e856e13712e20a29c6d0416344ed577ea5aac642ef295571d489a3

data/README.md

@@ -1,3 +1,8 @@
+![Ruby](https://github.com/Lykos/twisty_puzzles/workflows/Ruby/badge.svg)
+![Rubocop](https://github.com/Lykos/twisty_puzzles/workflows/Rubocop/badge.svg)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Gem Version](https://badge.fury.io/rb/twisty_puzzles.svg)](https://badge.fury.io/rb/twisty_puzzles)
+
 # Twisty Puzzles
 Gem for my cube_trainer rails app. Some things are better left in a separate gem with no rails, e.g. native extensions. The main purpose is to support my Rails app, but if it's useful for someone else, feel free to use it at your own risk.
 
@@ -25,7 +30,7 @@ TODO: Write usage instructions here
 
 After checking out the repo, run `bundle install` to install dependencies. Then, run `bundle exec rake spec` to run the tests. You can also run `bundle exec bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `lib/twisty_puzzles/version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 

data/lib/twisty_puzzles/abstract_move.rb

@@ -150,8 +150,7 @@ module TwistyPuzzles
       when :qtm then slice_factor * direction_factor
       when :htm then slice_factor
       when :stm then 1
-      when :qstm then direction_factor
-      when :sqtm then direction_factor
+      when :qstm, :sqtm then direction_factor
       else raise ArgumentError, "Invalid move metric #{metric.inspect}."
       end
     end

data/lib/twisty_puzzles/abstract_move_parser.rb

@@ -20,7 +20,7 @@ module TwistyPuzzles
     end
 
     def parse_named_captures(match)
-      present_named_captures = match.named_captures.reject { |_n, v| v.nil? }
+      present_named_captures = match.named_captures.compact
       present_named_captures.map do |name, string|
         key = parse_part_key(name).to_sym
         value = parse_move_part(name, string)

data/lib/twisty_puzzles/algorithm.rb

@@ -128,7 +128,7 @@ module TwistyPuzzles
       AbstractMove.check_move_metric(metric)
       return 0 if empty?
 
-      @moves.map { |m| m.move_count(cube_size, metric) }.reduce(:+)
+      @moves.sum { |m| m.move_count(cube_size, metric) }
     end
 
     def *(other)

data/lib/twisty_puzzles/axis_face_and_direction_move.rb

@@ -11,6 +11,7 @@ module TwistyPuzzles
       raise TypeError, "Unsuitable axis face #{axis_face}." unless axis_face.is_a?(Face)
       raise TypeError unless direction.is_a?(CubeDirection)
 
+      super()
       @axis_face = axis_face
       @direction = direction
     end

data/lib/twisty_puzzles/cancellation_helper.rb

@@ -135,7 +135,7 @@ module TwistyPuzzles
     def self.alg_plus_cancelled_move(algorithm, move, cube_size)
       if move.is_a?(Rotation) && (tail_rotations = num_tail_rotations(algorithm)) >= 2
         Algorithm.new(algorithm.moves[0...-tail_rotations]) +
-          cancelled_rotations(algorithm.moves[-tail_rotations..-1] + [move])
+          cancelled_rotations(algorithm.moves[-tail_rotations..] + [move])
       else
         Algorithm.new(algorithm.moves[0...-1]) +
           algorithm.moves[-1].join_with_cancellation(move, cube_size)

data/lib/twisty_puzzles/color_scheme.rb

@@ -56,7 +56,7 @@ module TwistyPuzzles
       raise ArgumentError unless colors.include?(top_color)
       raise ArgumentError unless colors.include?(front_color)
 
-      # Note: The reason that this is so complicated is that we want it to still work if the
+      # NOTE: The reason that this is so complicated is that we want it to still work if the
       # chirality corner gets exchanged.
 
       # Do the obvious and handle opposites of the top and front color so we have no

data/lib/twisty_puzzles/commutator.rb

@@ -17,6 +17,7 @@ module TwistyPuzzles
     def initialize(algorithm)
       raise ArgumentError unless algorithm.is_a?(Algorithm)
 
+      super()
       @algorithm = algorithm
     end
 
@@ -47,6 +48,7 @@ module TwistyPuzzles
       raise ArgumentError unless first_part.is_a?(Algorithm)
       raise ArgumentError unless second_part.is_a?(Algorithm)
 
+      super()
       @first_part = first_part
       @second_part = second_part
     end
@@ -85,6 +87,7 @@ module TwistyPuzzles
         raise ArgumentError, 'Inner commutator has to be a commutator.'
       end
 
+      super()
       @setup = setup
       @inner_commutator = inner_commutator
     end

data/lib/twisty_puzzles/compiled_algorithm.rb

@@ -26,10 +26,10 @@ module TwistyPuzzles
     def inverse
       @inverse ||=
         begin
-                              alg = self.class.new(@native.inverse)
-                              alg.inverse = self
-                              alg
-                            end
+          alg = self.class.new(@native.inverse)
+          alg.inverse = self
+          alg
+        end
     end
 
     def +(other)

data/lib/twisty_puzzles/coordinate.rb

@@ -90,7 +90,7 @@ module TwistyPuzzles
       base_coordinate = Coordinate.from_indices(
         part.solved_face, cube_size, *part.base_index_on_face(cube_size, incarnation_index)
       )
-      other_face_symbols = part.corresponding_part.face_symbols[1..-1]
+      other_face_symbols = part.corresponding_part.face_symbols[1..]
       match_coordinate_internal(base_coordinate, other_face_symbols)
     end
 
@@ -99,7 +99,7 @@ module TwistyPuzzles
     def self.solved_positions(part, cube_size, incarnation_index)
       solved_coordinate = solved_position(part, cube_size, incarnation_index)
       other_coordinates =
-        part.face_symbols[1..-1].map.with_index do |f, i|
+        part.face_symbols[1..].map.with_index do |f, i|
           face = Face.for_face_symbol(f)
           # The reverse is important for edge like parts. We are not in the same position as usual
           # solved pieces would be.
@@ -109,7 +109,7 @@ module TwistyPuzzles
           base_coordinate = Coordinate.from_indices(face, cube_size, *base_indices)
           other_face_symbols = [part.face_symbols[0]] +
                                part.corresponding_part.face_symbols[1...i + 1] +
-                               part.corresponding_part.face_symbols[i + 2..-1]
+                               part.corresponding_part.face_symbols[i + 2..]
           match_coordinate_internal(base_coordinate, other_face_symbols)
         end
       [solved_coordinate] + other_coordinates
@@ -276,7 +276,7 @@ module TwistyPuzzles
       @native = native
     end
 
-    attr_reader :native
+    attr_reader :native, :coordinate
 
     private_class_method :new
 
@@ -311,7 +311,5 @@ module TwistyPuzzles
     def face
       @face ||= Face.for_face_symbol(@native.face)
     end
-
-    attr_reader :coordinate
   end
 end

data/lib/twisty_puzzles/cube.rb

@@ -97,7 +97,7 @@ module TwistyPuzzles
     end
 
     def inspect
-      self.class.to_s + '(' + @face_symbols.map(&:to_s).join(', ') + ')'
+      "#{self.class}(#{@face_symbols.map(&:to_s).join(', ')})"
     end
 
     def to_s
@@ -365,7 +365,7 @@ module TwistyPuzzles
     attr_reader :corresponding_part
 
     def inspect
-      self.class.to_s + '(' + face_symbol.to_s + ', ' + @corresponding_part.inspect + ')'
+      "#{self.class}(#{face_symbol}, #{@corresponding_part.inspect})"
     end
 
     def rotate_by(_number)
@@ -532,7 +532,7 @@ module TwistyPuzzles
 
     def self.create_for_face_symbols(face_symbols)
       piece_candidates =
-        face_symbols[1..-1].permutation.map do |cs|
+        face_symbols[1..].permutation.map do |cs|
           new([face_symbols[0]] + cs)
         end
       find_only(piece_candidates, &:valid?)

data/lib/twisty_puzzles/cube_move.rb

@@ -139,8 +139,6 @@ module TwistyPuzzles
       end
     end
 
-    # rubocop:disable Metrics/PerceivedComplexity
-    # rubocop:disable Metrics/CyclomaticComplexity
     def prepend_fat_move(other, cube_size)
       if same_fat_block?(other)
         merge_with_same_fat_block(other)
@@ -156,8 +154,6 @@ module TwistyPuzzles
         Algorithm.move(other.inner_fat_mslice_move(cube_size))
       end
     end
-    # rubocop:enable Metrics/CyclomaticComplexity
-    # rubocop:enable Metrics/PerceivedComplexity
 
     def prepend_slice_move(other, cube_size)
       return unless same_axis?(other)

data/lib/twisty_puzzles/cube_move_parser.rb

@@ -14,29 +14,29 @@ module TwistyPuzzles
   class CubeMoveParser < AbstractMoveParser
     REGEXP =
       begin
-                      axes_part = "(?<axis_name>[#{AbstractMove::AXES.join}])"
-                      face_names = CubeConstants::FACE_NAMES.join
-                      fat_move_part =
-                        "(?<width>\\d*)(?<fat_face_name>[#{face_names}])w"
-                      normal_move_part = "(?<face_name>[#{face_names}])"
-                      downcased_face_names = face_names.downcase
-                      maybe_fat_maybe_slice_move_part =
-                        "(?<maybe_fat_face_maybe_slice_name>[#{downcased_face_names}])"
-                      slice_move_part =
-                        "(?<slice_index>\\d+)(?<slice_name>[#{downcased_face_names}])"
-                      mslice_move_part =
-                        "(?<mslice_name>[#{AbstractMove::SLICE_FACES.keys.join}])"
-                      move_part = "(?:#{axes_part}|" \
-                                  "#{fat_move_part}|" \
-                                  "#{normal_move_part}|" \
-                                  "#{maybe_fat_maybe_slice_move_part}|" \
-                                  "#{slice_move_part}|#{mslice_move_part})"
-                      direction_names =
-                        AbstractDirection::POSSIBLE_DIRECTION_NAMES.flatten
-                      direction_names.sort_by! { |e| -e.length }
-                      direction_part = "(?<direction>#{direction_names.join('|')})"
-                      Regexp.new("#{move_part}#{direction_part}")
-                    end
+        axes_part = "(?<axis_name>[#{AbstractMove::AXES.join}])"
+        face_names = CubeConstants::FACE_NAMES.join
+        fat_move_part =
+          "(?<width>\\d*)(?<fat_face_name>[#{face_names}])w"
+        normal_move_part = "(?<face_name>[#{face_names}])"
+        downcased_face_names = face_names.downcase
+        maybe_fat_maybe_slice_move_part =
+          "(?<maybe_fat_face_maybe_slice_name>[#{downcased_face_names}])"
+        slice_move_part =
+          "(?<slice_index>\\d+)(?<slice_name>[#{downcased_face_names}])"
+        mslice_move_part =
+          "(?<mslice_name>[#{AbstractMove::SLICE_FACES.keys.join}])"
+        move_part = "(?:#{axes_part}|" \
+                    "#{fat_move_part}|" \
+                    "#{normal_move_part}|" \
+                    "#{maybe_fat_maybe_slice_move_part}|" \
+                    "#{slice_move_part}|#{mslice_move_part})"
+        direction_names =
+          AbstractDirection::POSSIBLE_DIRECTION_NAMES.flatten
+        direction_names.sort_by! { |e| -e.length }
+        direction_part = "(?<direction>#{direction_names.join('|')})"
+        Regexp.new("#{move_part}#{direction_part}")
+      end
 
     MOVE_TYPE_CREATORS = [
       MoveTypeCreator.new(%i[axis_face direction], Rotation),

data/lib/twisty_puzzles/cube_print_helper.rb

@@ -41,9 +41,10 @@ module TwistyPuzzles
     end
 
     def maybe_reverse(reverse_mode, stuff)
-      if reverse_mode == :reverse
+      case reverse_mode
+      when :reverse
         stuff.reverse
-      elsif reverse_mode == :keep
+      when :keep
         stuff
       else
         raise
@@ -102,7 +103,7 @@ module TwistyPuzzles
       face_symbol_info = FACE_SYMBOL_INFOS[face_symbol]
       stickers = cube_state.sticker_array(face)
       center_color = color_character(stickers[0], color_mode)
-      corner_colors = stickers[1..-1].map { |c| color_character(c, color_mode) }
+      corner_colors = stickers[1..].map { |c| color_character(c, color_mode) }
       permuted_corner_colors =
         apply_permutation(corner_colors, face_symbol_info.skewb_corner_permutation)
       raise unless corner_colors.length == 4

data/lib/twisty_puzzles/parser.rb

@@ -185,14 +185,14 @@ module TwistyPuzzles # rubocop:disable Style/Documentation
     end
   end
 
-  def parse_commutator(alg_string, complete_parse = true)
+  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)
+  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
@@ -206,7 +206,7 @@ module TwistyPuzzles # rubocop:disable Style/Documentation
   alias parse_algorithm parse_cube_algorithm
   alias parse_move parse_cube_move
 
-  def parse_skewb_algorithm(alg_string, notation, complete_parse = true)
+  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

data/lib/twisty_puzzles/rotation.rb

@@ -62,6 +62,7 @@ module TwistyPuzzles
       [self, alternative].include?(other)
     end
 
+    # rubocop:disable Metrics/AbcSize
     def prepend_rotation(other, _cube_size)
       if same_axis?(other)
         direction = translated_direction(other.axis_face)
@@ -74,6 +75,7 @@ module TwistyPuzzles
         Algorithm.move(Rotation.new(remaining_face, CubeDirection::DOUBLE))
       end
     end
+    # rubocop:enable Metrics/AbcSize
 
     def prepend_fat_m_slice_move(_other, _cube_size)
       nil

data/lib/twisty_puzzles/skewb_move.rb

@@ -12,6 +12,7 @@ module TwistyPuzzles
       raise TypeError unless axis_corner.is_a?(Corner)
       raise TypeError unless direction.is_a?(SkewbDirection)
 
+      super()
       @axis_corner = axis_corner.rotate_face_up(axis_corner.faces.min_by(&:piece_index))
       @direction = direction
     end

data/lib/twisty_puzzles/skewb_move_parser.rb

@@ -18,6 +18,7 @@ module TwistyPuzzles
     def initialize(notation)
       raise TypeError unless notation.is_a?(SkewbNotation)
 
+      super()
       @notation = notation
     end
 

data/lib/twisty_puzzles/skewb_notation.rb

@@ -10,9 +10,11 @@ module TwistyPuzzles
   # Class that represents one notation for Skewb moves, e.g. Sarahs notation or fixed
   # corner notation.
   class SkewbNotation
+    # rubocop:disable Metrics/AbcSize
     def initialize(name, move_corner_pairs)
       raise TypeError unless name.is_a?(String)
 
+      super()
       check_move_corner_pairs(move_corner_pairs)
       @name = name
       @move_to_corner = move_corner_pairs.to_h.freeze
@@ -26,7 +28,9 @@ module TwistyPuzzles
         end.freeze
       freeze
     end
+    # rubocop:enable Metrics/AbcSize
 
+    # rubocop:disable Metrics/CyclomaticComplexity
     def check_move_corner_pairs(move_corner_pairs)
       move_corner_pairs.each do |m|
         raise ArgumentError unless m.length == 2
@@ -37,6 +41,7 @@ module TwistyPuzzles
 
       check_corner_coverage(move_corner_pairs.map(&:last))
     end
+    # rubocop:enable Metrics/CyclomaticComplexity
 
     def check_corner_coverage(corners)
       corner_closure = corners + corners.map(&:diagonal_opposite)
@@ -49,6 +54,7 @@ module TwistyPuzzles
     end
 
     attr_reader :name, :move_strings, :non_zero_moves
+
     private_class_method :new
 
     def self.fixed_corner
@@ -103,7 +109,7 @@ module TwistyPuzzles
         move_to_string(m, reversed_rotations)
       end.join(' ')
       new_tail_rotations = reversed_rotations.reverse! +
-                           algorithm.moves[algorithm.length - num_tail_rotations..-1]
+                           algorithm.moves[algorithm.length - num_tail_rotations..]
       cancelled_rotations = Algorithm.new(new_tail_rotations).cancelled(3)
       cancelled_rotations.empty? ? alg_string : "#{alg_string} #{cancelled_rotations}"
     end

data/lib/twisty_puzzles/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: twisty_puzzles
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Bernhard F. Brodowsky
@@ -112,16 +112,16 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
@@ -253,15 +253,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Gem for my cube_trainer rails app. Some things are better left in a separate