twisty_puzzles 0.0.1

data/lib/twisty_puzzles/state_helper.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'twisty_puzzles/abstract_direction'
+
+module TwistyPuzzles
+  
+    # Common utilities for different puzzle states.
+    # TODO: Remove
+    module StateHelper
+      def apply_sticker_cycle(cycle)
+        last_sticker = self[cycle[-1]]
+        (cycle.length - 1).downto(1) do |i|
+          self[cycle[i]] = self[cycle[i - 1]]
+        end
+        self[cycle[0]] = last_sticker
+      end
+
+      def apply_4sticker_cycle(cycle, direction)
+        raise ArgumentError unless cycle.length == 4
+        raise TypeError unless direction.is_a?(AbstractDirection)
+
+        if direction.double_move?
+          apply_sticker_cycle([cycle[0], cycle[2]])
+          apply_sticker_cycle([cycle[1], cycle[3]])
+        else
+          # Note that we cannot do reverse! because the values are cached.
+          actual_cycle = direction.value == 3 ? cycle.reverse : cycle
+          apply_sticker_cycle(actual_cycle)
+        end
+      end
+    end
+end

data/lib/twisty_puzzles/sticker_cycle.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require 'set'
+require 'twisty_puzzles/coordinate'
+require 'twisty_puzzles/cube_state'
+require 'twisty_puzzles/reversible_applyable'
+
+module TwistyPuzzles
+  
+    # A sticker cycle that can be applied to a cube state.
+    class StickerCycle
+      include ReversibleApplyable
+
+      def initialize(cube_size, sticker_cycle)
+        @cube_size = cube_size
+        @sticker_cycle = sticker_cycle
+      end
+
+      attr_reader :cube_size, :sticker_cycle
+
+      def apply_to(cube_state)
+        raise TypeError unless cube_state.is_a?(CubeState)
+        raise ArgumentError unless cube_state.n == @cube_size
+
+        cube_state.apply_sticker_cycle(@sticker_cycle) if @sticker_cycle.length >= 2
+      end
+
+      def inverse
+        StickerCycle.new(@cube_size, @sticker_cycle.reverse)
+      end
+    end
+
+    # A set of disjoint sticker cycles that can be applied to a cube state together
+    class StickerCycles
+      include ReversibleApplyable
+
+      def initialize(cube_size, sticker_cycles)
+        affected_set = Set[]
+        sticker_cycles.each do |c|
+          raise TypeError unless c.is_a?(StickerCycle)
+
+          c.sticker_cycle.each do |s|
+            raise ArgumentError unless affected_set.add?(s)
+          end
+        end
+        @cube_size = cube_size
+        @sticker_cycles = sticker_cycles
+      end
+
+      attr_reader :cube_size, :sticker_cycles
+
+      def apply_to(cube_state)
+        raise TypeError unless cube_state.is_a?(CubeState)
+        raise ArgumentError unless cube_state.n == @cube_size
+
+        @sticker_cycles.each { |c| c.apply_to(cube_state) }
+      end
+
+      def +(other)
+        raise TypeError unless other.is_a?(StickerCycles)
+        raise ArgumentError unless @cube_size == other.cube_size
+
+        StickerCycles.new(@cube_size, @sticker_cycles + other.sticker_cycles)
+      end
+
+      def inverse
+        StickerCycles.new(@cube_size, @sticker_cycles.map(&:inverse))
+      end
+    end
+end

data/lib/twisty_puzzles/twisty_puzzles_error.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module TwistyPuzzles
+  class TwistyPuzzlesError < StandardError
+  end
+end

data/lib/twisty_puzzles/utils/array_helper.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+module TwistyPuzzles
+  module Utils
+    # A few array related helper methods.
+    module ArrayHelper
+      def apply_permutation(array, permutation)
+        raise ArgumentError unless array.length == permutation.length
+        raise ArgumentError unless permutation.uniq.length == permutation.length
+
+        permutation.map do |i|
+          raise ArgumentError unless i.is_a?(Integer) && i >= 0 && i < array.length
+
+          array[i]
+        end
+      end
+
+      def turned_equals?(left, right)
+        return false if left.length != right.length
+
+        (0...left.length).any? do |r|
+          return true if left.rotate(r) == right
+        end
+        false
+      end
+
+      private
+
+      def next_state_after_nil(array, state)
+        case state
+        when :start then :first_nil_part
+        when :first_part then :nil_middle
+        when :middle then :second_nil_part
+        when :first_nil_part, :second_nil_part, :nil_middle then state
+        when :second_part
+          raise ArgumentError,
+                "Cannot rotate out nils for #{array.inspect} since the nils are not contiguous."
+        else raise "Unknown state #{state} reached."
+        end
+      end
+
+      def next_state_after_non_nil(array, state)
+        case state
+        when :start then :first_part
+        when :first_nil_part then :middle
+        when :nil_middle then :second_part
+        when :first_part, :second_part, :middle then state
+        when :second_nil_part
+          raise ArgumentError,
+                "Cannot rotate out nils for #{array.inspect} since the nils are not contiguous."
+        else raise "Unknown state #{state} reached."
+        end
+      end
+
+      def next_state(state, array, element, first_part, second_part)
+        if element.nil?
+          next_state_after_nil(array, state)
+        else
+          state = next_state_after_non_nil(array, state)
+          current_part = state == :second_part ? second_part : first_part
+          current_part.push(element)
+          state
+        end
+      end
+
+      public
+
+      def rotate_out_nils(array)
+        first_part = []
+        second_part = []
+        # Valid input goes either start -> first_part -> nil_middle -> second_part
+        # or start -> first_nil_part -> middle -> second_nil_part
+        state = :start
+        array.each do |element|
+          state = next_state(state, array, element, first_part, second_part)
+        end
+        second_part + first_part
+      end
+
+      def check_types(array, type)
+        array.each { |e| raise TypeError unless e.is_a?(type) }
+      end
+
+      # Returns the only element of an array and raises if the array has not exactly one element.
+      def only(array)
+        raise ArgumentError, "Can't take the only element of an empty array." if array.empty?
+
+        unless array.length == 1
+          raise ArgumentError,
+                "Can't take the only element of an array with #{array.length} elements."
+        end
+
+        array[0]
+      end
+
+      def find_only(array, &block)
+        only(array.select(&block))
+      end
+
+      def replace_once(array, old_element, new_element)
+        raise ArgumentError unless array.count { |e| e == old_element } == 1
+
+        new_array = array.dup
+        new_array[new_array.index(old_element)] = new_element
+        new_array
+      end
+    end
+  end
+end

data/lib/twisty_puzzles/utils/string_helper.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module TwistyPuzzles
+  module Utils
+    # A few string related helper methods.
+    module StringHelper
+      def camel_case_to_snake_case(camel_case)
+        camel_case.gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+                  .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+                  .downcase
+      end
+
+      def simple_class_name(clazz)
+        clazz.name.split('::').last
+      end
+
+      def snake_case_class_name(clazz)
+        camel_case_to_snake_case(simple_class_name(clazz))
+      end
+
+      def format_time(time_s)
+        format('%<time_s>.2f', time_s: time_s)
+      end
+    end
+  end
+end

data/lib/twisty_puzzles/utils.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module CubeTrainer
+  # Module that contains various utils that aren't very specific to twisty puzzles.
+  module Utils
+  end
+end

data/lib/twisty_puzzles/version.rb

@@ -0,0 +1,3 @@
+module TwistyPuzzles
+  VERSION = '0.0.1'
+end

data/lib/twisty_puzzles.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+# Libraries for the twisty puzzles.
+module TwistyPuzzles
+end

metadata

@@ -0,0 +1,249 @@
+--- !ruby/object:Gem::Specification
+name: twisty_puzzles
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Bernhard F. Brodowsky
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-04-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rantly
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: rspec-prof
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email: bernhard.brodowsky@gmail.com
+executables: []
+extensions:
+- ext/twisty_puzzles/native/extconf.rb
+extra_rdoc_files:
+- README.md
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE
+- README.md
+- ext/twisty_puzzles/native/extconf.rb
+- lib/twisty_puzzles.rb
+- lib/twisty_puzzles/abstract_direction.rb
+- lib/twisty_puzzles/abstract_move.rb
+- lib/twisty_puzzles/abstract_move_parser.rb
+- lib/twisty_puzzles/algorithm.rb
+- lib/twisty_puzzles/algorithm_transformation.rb
+- lib/twisty_puzzles/axis_face_and_direction_move.rb
+- lib/twisty_puzzles/cancellation_helper.rb
+- lib/twisty_puzzles/color_scheme.rb
+- lib/twisty_puzzles/commutator.rb
+- lib/twisty_puzzles/compiled_algorithm.rb
+- lib/twisty_puzzles/compiled_cube_algorithm.rb
+- lib/twisty_puzzles/compiled_skewb_algorithm.rb
+- lib/twisty_puzzles/coordinate.rb
+- lib/twisty_puzzles/cube.rb
+- lib/twisty_puzzles/cube_constants.rb
+- lib/twisty_puzzles/cube_direction.rb
+- lib/twisty_puzzles/cube_move.rb
+- lib/twisty_puzzles/cube_move_parser.rb
+- lib/twisty_puzzles/cube_print_helper.rb
+- lib/twisty_puzzles/cube_state.rb
+- lib/twisty_puzzles/letter_scheme.rb
+- lib/twisty_puzzles/move_type_creator.rb
+- lib/twisty_puzzles/parser.rb
+- lib/twisty_puzzles/part_cycle_factory.rb
+- lib/twisty_puzzles/puzzle.rb
+- lib/twisty_puzzles/reversible_applyable.rb
+- lib/twisty_puzzles/rotation.rb
+- lib/twisty_puzzles/skewb_direction.rb
+- lib/twisty_puzzles/skewb_move.rb
+- lib/twisty_puzzles/skewb_move_parser.rb
+- lib/twisty_puzzles/skewb_notation.rb
+- lib/twisty_puzzles/skewb_state.rb
+- lib/twisty_puzzles/state_helper.rb
+- lib/twisty_puzzles/sticker_cycle.rb
+- lib/twisty_puzzles/twisty_puzzles_error.rb
+- lib/twisty_puzzles/utils.rb
+- lib/twisty_puzzles/utils/array_helper.rb
+- lib/twisty_puzzles/utils/string_helper.rb
+- lib/twisty_puzzles/version.rb
+homepage: https://github.com/Lykos/twisty_puzzles
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Lykos/twisty_puzzles
+  source_code_uri: https://github.com/Lykos/twisty_puzzles
+  changelog_uri: https://github.com/Lykos/twisty_puzzles/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6.2
+signing_key: 
+specification_version: 4
+summary: 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.
+test_files: []