rubiks_cube 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ba95ab7306e2711c27d79e0048fcf8d2e85b5431
-  data.tar.gz: e8ea3a5407c148f56c66f1ba5461dd1bbfe8720d
+  metadata.gz: ea7804b38177c1c4c7075d2e4cd1db3c4de4d511
+  data.tar.gz: eb603bea15bfc45f9eee766563170d3c867838bb
 SHA512:
-  metadata.gz: 224109e67b1da66903e9a2aed557a82f583732995674e23b1ddd5a75ea35d44c65fcdc7e74fee9dd26fb295c60fbeb97f519b19ad6f721f1d2218450a5c87c17
-  data.tar.gz: 3552b5164b043e02ac70715c6a0ba98f459d51ef401c65ebe4182e8d0a750c41ef5c4759312c6dd2f4d9a2602b47f86135555a11ef263d9dd7f694cf632d1226
+  metadata.gz: 7c12b08b5ffb2bf6394799ed19a5092e596ec985c59f8a14530f021bc8fd505a16d25cb8c20443538f7b69c201d203231e08e4030a27acedb05fbc8c727d3fbc
+  data.tar.gz: c0e10419fe026a25b542ae3bfde7be090882114bbd20e19dd974ebebfabe0c5147dcc1a7ea234eeef09bfb76fc835abf600858d753bbcef180e6a84c0c8d5b6e

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rubiks_cube (1.1.0)
+    rubiks_cube (1.2.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -81,19 +81,20 @@ If you have a scrambled Rubik's Cube sitting in front of you right now, you
 may not know how to get it back to the solved position. That's OK! We can set
 the Rubik's Cube state manually and learn how to solve it.
 
-Describing a cube state may seem complicated at first, but it quickly becomes
-easy after you've done it a few times.
+Starting with the **F** face, enter the color of each sticker from top-left to
+bottom-right. You may use any characters you like to describe the color of your
+cube, but make sure all six colors are unique. Whitespace is not important.
 
-Hold your Rubik's Cube in your hand. Notice that the center of each face does
-not move when you rotate a side. The is the basis for entering cube state
-manually. If the center of a face is red, then that face will be red when the
-cube is solved.
+The cube state must be entered in the following order:
 
-Starting with top edges and working down (counter-clockwise), enter the state
-of each cubie. After edges are entered, proceed to corners. See the
-[examples](#examples) below for more help.
+1. **F**: Front Face
+1. **R**: Right Face
+1. **B**: Back Face
+1. **L**: Left Face
+1. **U**: Up Face (top)
+1. **D**: Down Face (bottom)
 
-![](https://raw.github.com/chrishunt/rubiks-cube/master/img/cube_instructions.jpg)
+See the [examples](#examples) below for more help.
 
 ### Examples
 
@@ -111,8 +112,14 @@ require 'rubiks_cube'
 
 cube = RubiksCube::Cube.new
 
-cube.state
-  #=> "UF UR UB UL FL FR BR BL DF DR DB DL UFL URF UBR ULB DLF DFR DRB DBL"
+cube.state = <<-STATE
+  G G G G G G G G G
+  Y Y Y Y Y Y Y Y Y
+  B B B B B B B B B
+  W W W W W W W W W
+  R R R R R R R R R
+  O O O O O O O O O
+STATE
 
 cube.solved? #=> true
 ```
@@ -121,15 +128,21 @@ cube.solved? #=> true
 
 ![](https://raw.github.com/chrishunt/rubiks-cube/master/img/cube_scramble_1.jpg)
 
-Notice our cube is now slightly scrambled. We can start our Rubik's Cube in
-this state if we like:
+Our cube is now slightly scrambled.
 
 ```ruby
 require 'rubiks_cube'
 
-cube = RubiksCube::Cube.new(
-  "RF FU UB UL FL UR BR BL DF DR DB DL UFL FUR UBR ULB DLF DFR DRB BLD"
-)
+cube = RubiksCube::Cube.new
+
+cube.state = <<-STATE
+  G G Y G G R G G G
+  R R Y Y Y Y Y Y Y
+  B B B B B B B B W
+  W W W W W W O W W
+  R R R R R G R Y G
+  O O O O O O B O O
+STATE
 
 cube.solved? #=> false
 ```
@@ -138,8 +151,8 @@ cube.solved? #=> false
 
 ![](https://raw.github.com/chrishunt/rubiks-cube/master/img/cube_scramble_2.jpg)
 
-And here's a fully scrambled cube. This looks hard to solve. We can start our
-cube in this state if we like and have the solver tell us a solution.
+Here's a fully scrambled cube. This looks hard to solve. We can start our cube
+in this state if we like and have the solver tell us a solution.
 
 Here's the scramble we used to mix the cube if you'd like to try it yourself:
 
@@ -150,9 +163,16 @@ U D B2 U B D2 B2 F' R' U2 F U' L2 F L2 B2 L2 R' U R' U' D R2 F2 B2
 ```ruby
 require 'rubiks_cube'
 
-cube = RubiksCube::Cube.new(
-  "RF DL UB DF UF DB FL LB UL DR BR UR FUR LFD UFL DRB BLD DFR BRU LBU"
-)
+cube = RubiksCube::Cube.new
+
+cube.state = <<-STATE
+  R G O R G O O W G
+  G W W B Y W Y Y Y
+  G B B G B W R Y B
+  Y G Y B W G R Y W
+  O R R O R O G Y W
+  B R O R O O W B B
+STATE
 
 cube.solved? #=> false
 ```
@@ -273,7 +293,7 @@ at first. Each face is represented by a letter:
 - **F**: Front Face
 - **B**: Back Face
 - **U**: Up Face (top)
-- **D**: Up Face (bottom)
+- **D**: Down Face (bottom)
 
 When we see a letter in an algorithm, then we turn that face 90 degrees
 clockwise. To determine which direction is clockwise, rotate the cube so that

data/lib/rubiks_cube.rb

@@ -1,4 +1,5 @@
 require 'rubiks_cube/version'
+require 'rubiks_cube/sticker_state_transform'
 require 'rubiks_cube/cube'
 require 'rubiks_cube/cubie'
 require 'rubiks_cube/algorithms'

data/lib/rubiks_cube/cube.rb

@@ -11,6 +11,12 @@ module RubiksCube
       )
     end
 
+    def state=(stickers)
+      @state = build_state_from_string(
+        StickerStateTransform.new(stickers).to_cube
+      )
+    end
+
     def ==(other)
       state == other.state
     end

data/lib/rubiks_cube/sticker_state_transform.rb

@@ -0,0 +1,41 @@
+module RubiksCube
+  # Transform manual sticker state entry to cube state
+  class StickerStateTransform
+    attr_reader :state
+
+    CENTER_LOCATIONS = [ 4, 13, 22, 31, 40, 49 ]
+
+    CORNER_LOCATIONS = [
+      42, 0 , 29, 44, 9, 2 , 38, 18, 11, 36, 27, 20,
+      45, 35, 6 , 47, 8, 15, 53, 17, 24, 51, 26, 33
+    ]
+
+    EDGE_LOCATIONS = [
+      43, 1 , 41, 10, 37, 19, 39, 28,
+      3 , 32, 5 , 12, 21, 14, 23, 30,
+      46, 7 , 50, 16, 52, 25, 48, 34
+    ]
+
+    def initialize(state)
+      @state = state.gsub(/\s/, '').split('')
+    end
+
+    def to_cube
+      (edges + corners).join(' ').gsub(/./) { |c| color_mapping.fetch(c, c) }
+    end
+
+    private
+
+    def color_mapping
+      Hash[state.values_at(*CENTER_LOCATIONS).zip %w(F R B L U D)]
+    end
+
+    def edges
+      state.values_at(*EDGE_LOCATIONS).each_slice(2).map(&:join)
+    end
+
+    def corners
+      state.values_at(*CORNER_LOCATIONS).each_slice(3).map(&:join)
+    end
+  end
+end

data/lib/rubiks_cube/version.rb

@@ -1,3 +1,3 @@
 module RubiksCube
-  VERSION = '1.1.0'
+  VERSION = '1.2.0'
 end

data/spec/rubiks_cube/cube_spec.rb

@@ -23,6 +23,12 @@ describe RubiksCube::Cube do
     end
   end
 
+  describe '#state=' do
+    it 'changes the state of the cube' do
+      expect { subject.state = 'a b c' }.to change { subject.state }
+    end
+  end
+
   describe '==' do
     it 'returns true when two cubes have the same state' do
       expect(subject).to eq described_class.new(state)

data/spec/rubiks_cube/sticker_state_transform_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe RubiksCube::StickerStateTransform do
+  subject { described_class.new state }
+
+  let(:state) { nil }
+
+  describe '#to_cube' do
+    context 'when initialized with sticker state' do
+      let(:state) {[
+        "g b b b w b o g b \
+
+         o w b o o g r r w r y y o y r r g o r w o y r w",
+        "gw  bg      o yggowywyywrbbyrg  "
+      ].join(' ')}
+
+      it 'transforms to cube state' do
+        expect(subject.to_cube).to eq(
+          "BD RF RB UF DF DR RU LB BU DL LU LF FUR FRD BLD ULB BDR FDL UFL BRU"
+        )
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubiks_cube
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Chris Hunt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-09 00:00:00.000000000 Z
+date: 2013-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -97,7 +97,6 @@ files:
 - Rakefile
 - img/cube_algorithm.jpg
 - img/cube_blank.jpg
-- img/cube_instructions.jpg
 - img/cube_m_slice.jpg
 - img/cube_orientation.jpg
 - img/cube_permutation.jpg
@@ -110,6 +109,7 @@ files:
 - lib/rubiks_cube/cube.rb
 - lib/rubiks_cube/cubie.rb
 - lib/rubiks_cube/solution.rb
+- lib/rubiks_cube/sticker_state_transform.rb
 - lib/rubiks_cube/two_cycle_solution.rb
 - lib/rubiks_cube/version.rb
 - rubiks_cube.gemspec
@@ -117,6 +117,7 @@ files:
 - spec/rubiks_cube/cube_spec.rb
 - spec/rubiks_cube/cubie_spec.rb
 - spec/rubiks_cube/solution_spec.rb
+- spec/rubiks_cube/sticker_state_transform_spec.rb
 - spec/rubiks_cube/two_cycle_solution_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/chrishunt/rubiks-cube
@@ -148,5 +149,6 @@ test_files:
 - spec/rubiks_cube/cube_spec.rb
 - spec/rubiks_cube/cubie_spec.rb
 - spec/rubiks_cube/solution_spec.rb
+- spec/rubiks_cube/sticker_state_transform_spec.rb
 - spec/rubiks_cube/two_cycle_solution_spec.rb
 - spec/spec_helper.rb