puzzled 0.0.1 → 0.2

data/README.md

@@ -1,18 +1,27 @@
 Puzzled?
 ========
-Generates scrambles for, and solves, the Rubik's Cube.
-
-Current Status
---------------
-`Puzzled::RubiksCube.scramble` generates Rubik's Cube scrambles
+Generates scrambles for the Rubik's Cube.
 
 Usage
 -----
+Install:
+
+    $ gem install puzzled
 
-    $ irb
+Play:
 
     > require 'puzzled'
-    > cube = Puzzled::RubiksCube.new
-    > cube.scramble     # generates typical 25-move scramble
-    > cube.scramble 5   # generates 5-move scramble
-       #=> ["F2","R","F2","U2","L2"]
+    > Puzzled::RubiksCube.new.scramble 10
+
+      #=> ["F", "D'", "U", "F", "U'", "D2", "F2", "B", "U", "B'"]
+
+    > Puzzled::RevengeCube.new.scramble 10
+
+      #=> ["L", "R'", "u", "d2", "f2", "D", "B", "b", "r'", "L'"]
+
+Test:
+
+    $ git clone git://github.com/huntca/puzzled.git
+    $ cd puzzled
+    $ bundle
+    $ rspec spec

data/lib/puzzled/cube.rb

@@ -0,0 +1,50 @@
+module Puzzled
+  class Cube
+    # Set the move groups and dirs for this cube
+    def initialize(groups = nil)
+      @groups = groups ? groups : [["F","B"],["L","R"],["D","U"]]
+      @dirs   = ["","'","2"]
+    end
+
+    # Retun Cube scramble of length n
+    def scramble(n=10)
+      scramble = []
+      prev_group = nil
+      prev_prev_group = nil
+      n.times do
+        # Find a move group for the next move
+        # We cannot have 3 moves in a row that are in the same group
+        group = rand(@groups.size)
+        if prev_group == nil
+          prev_group = group
+        elsif prev_prev_group == nil
+          prev_prev_group = prev_group
+          prev_group = group
+        else
+          # While we have 3 moves in the same group, pick a new group
+          while group == prev_group && group == prev_prev_group
+            group = rand(@groups.size)
+          end
+          prev_prev_group = prev_group
+          prev_group = group
+        end
+
+        # Find the next move from move group
+        # We cannot have two turns in a row on the same face
+        move = @groups[group][rand(@groups[group].size)]
+        if scramble.size > 0
+          while move == scramble.last[0] do
+            move = @groups[group][rand(@groups[group].size)]
+          end
+        end
+
+        # Find a direction for this move
+        dir = @dirs[rand(@dirs.size)]
+
+        # Add move to scramble
+        scramble << move + dir
+      end
+      return scramble
+    end
+  end
+end

data/lib/puzzled/revenge_cube.rb

@@ -0,0 +1,15 @@
+module Puzzled
+  class RevengeCube < Cube
+    # Set the move groups for that of a Revenge Cube
+    def initialize
+      super([["F","B","f","b"],
+             ["L","R","l","r"],
+             ["D","U","d","u"]])
+    end
+
+    # Retun Revenge Cube scramble of length n
+    def scramble(n=40)
+      super(n)
+    end
+  end
+end

data/lib/puzzled/rubiks_cube.rb

@@ -1,47 +1,8 @@
 module Puzzled
-  class RubiksCube
-    GROUPS = [["F","B"],["L","R"],["D","U"]]
-    DIRS   = ["","'","2"]
-
-    # Retun Rubik's Cube scramble of size = size
-    def scramble(size=25)
-      scramble = []
-      prev_group = nil
-      prev_prev_group = nil
-      size.times do
-        # Find a move group for the next move
-        # We cannot have 3 moves in a row that are in the same group
-        group = rand(GROUPS.size)
-        if prev_group == nil
-          prev_group = group
-        elsif prev_prev_group == nil
-          prev_prev_group = prev_group
-          prev_group = group
-        else
-          # While we have 3 moves in the same group, pick a new group
-          while group == prev_group && group == prev_prev_group
-            group = rand(GROUPS.size)
-          end
-          prev_prev_group = prev_group
-          prev_group = group
-        end
-
-        # Find the next move from move group
-        # We cannot have two turns in a row on the same face
-        move = GROUPS[group][rand(2)]
-        if scramble.size > 0
-          while move == scramble.last[0] do
-            move = GROUPS[group][rand(2)]
-          end
-        end
-
-        # Find a direction for this move
-        dir = DIRS[rand(DIRS.size)]
-
-        # Add move to scramble
-        scramble << move + dir
-      end
-      return scramble
+  class RubiksCube < Cube
+    # Return Rubik's Cube scramble of length n
+    def scramble(n=25)
+      super(n)
     end
   end
 end

data/lib/puzzled/version.rb

@@ -1,3 +1,3 @@
 module Puzzled
-  VERSION = "0.0.1"
+  VERSION = "0.2"
 end

data/lib/puzzled.rb

@@ -1,6 +1,4 @@
 require "puzzled/version"
+require "puzzled/cube"
 require "puzzled/rubiks_cube"
-
-module Puzzled
-  # Your code goes here...
-end
+require "puzzled/revenge_cube"

data/spec/cube_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+describe Puzzled::Cube do
+  describe "#scramble" do
+    before(:each) do
+      @cube = Puzzled::Cube.new
+    end
+
+    it "returns correct number of moves" do
+      scramble_size = 30
+      @cube.scramble(scramble_size).size.should == scramble_size
+    end
+
+    it "returns default set of moves when no size is given" do
+      @cube.scramble.size.should > 0
+    end
+
+    it "contains only valid moves" do
+      moves = ["F","B","L","R","D","U",
+               "f","b","l","r","d","u"]
+      contains_valid_moves(@cube.scramble, moves)
+    end
+
+    it "does not rotate the same face 2 times in a row" do
+      prev = nil
+      @cube.scramble(500).each do |move|
+        if prev != nil
+          move[0].should_not == prev
+        end
+        prev = move[0]
+      end
+    end
+
+    it "does not rotate parallel faces 3 times in a row" do
+      group = { "F" => 1, "B" => 1, "f" => 1, "b" => 1,
+                "L" => 2, "R" => 2, "l" => 2, "r" => 2,
+                "D" => 3, "U" => 3, "d" => 3, "u" => 3 }
+      prev = nil
+      prev_prev = nil
+      @cube.scramble(500).each do |move|
+        if prev == nil
+          prev = move
+        elsif prev_prev == nil
+          prev_prev = prev
+          prev = move
+        else
+          if group[prev[0]] == group[move[0]]
+            group[prev_prev[0]].should_not == group[move[0]]
+          end
+          prev_prev = prev
+          prev = move
+        end
+      end
+    end
+  end
+end

data/spec/revenge_cube_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe Puzzled::RevengeCube do
+  describe "#scramble" do
+    before(:each) do
+      @revenge_cube = Puzzled::RevengeCube.new
+    end
+
+    it "returns correct number of moves by default" do
+      @revenge_cube.scramble.size == 40
+    end
+
+    it "contains only valid moves" do
+      moves = ["F","B","L","R","D","U",
+               "f","b","l","r","d","u"]
+      contains_valid_moves(@revenge_cube.scramble, moves)
+    end
+
+    it "contains some slice moves" do
+      contains_slice_moves(@revenge_cube.scramble)
+    end
+  end
+end

data/spec/rubiks_cube_spec.rb

@@ -1,4 +1,4 @@
-require 'puzzled'
+require 'spec_helper'
 
 describe Puzzled::RubiksCube do
   describe "#scramble" do
@@ -6,57 +6,13 @@ describe Puzzled::RubiksCube do
       @rubiks_cube = Puzzled::RubiksCube.new
     end
 
-    it "returns correct number of moves" do
-      scramble_size = 30
-      @rubiks_cube.scramble(scramble_size).size.should == scramble_size
-    end
-
-    it "returns correct number of moves when no size is given" do
-      @rubiks_cube.scramble.size.should > 0
+    it "returns correct number of moves by default" do
+      @rubiks_cube.scramble.size.should == 25
     end
 
     it "contains only valid moves" do
       moves = ["F","B","L","R","D","U"]
-      dirs  = ["'","2"]
-      @rubiks_cube.scramble.each do |move|
-        move.size.should > 0
-        move.size.should <= 2
-        moves.include?(move[0]).should == true
-        dirs.include?(move[1]).should == true if move.size > 1
-      end
-    end
-
-    it "does not rotate the same face 2 times in a row" do
-      prev = nil
-      @rubiks_cube.scramble(500).each do |move|
-        if prev != nil
-          move[0].should_not == prev
-        end
-        prev = move[0]
-      end
+      contains_valid_moves(@rubiks_cube.scramble, moves)
     end
-
-    it "does not rotate parallel faces 3 times in a row" do
-      group = { "F" => 1, "B" => 1,
-                "L" => 2, "R" => 2,
-                "D" => 3, "U" => 3 }
-      prev = nil
-      prev_prev = nil
-      @rubiks_cube.scramble(500).each do |move|
-        if prev == nil
-          prev = move
-        elsif prev_prev == nil
-          prev_prev = prev
-          prev = move
-        else
-          if group[prev[0]] == group[move[0]]
-            group[prev_prev[0]].should_not == group[move[0]]
-          end
-          prev_prev = prev
-          prev = move
-        end
-      end
-    end
-
   end
 end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+require 'puzzled'
+
+def contains_valid_moves(scramble, moves)
+  dirs  = ["'","2"]
+  scramble.each do |move|
+    move.size.should > 0
+    move.size.should <= 2
+    moves.include?(move[0]).should == true
+    dirs.include?(move[1]).should == true if move.size > 1
+  end
+end
+
+def contains_slice_moves(scramble)
+  contains_slice = false
+  slices = ["f","b","l","r","d","u"]
+  scramble.each do |move|
+    contains_slice = true if slices.include?(move)
+  end
+  contains_slice.should == true
+end

metadata

@@ -2,7 +2,7 @@
 name: puzzled
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.1
+  version: "0.2"
 platform: ruby
 authors: 
 - Chris Hunt
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-15 00:00:00 Z
+date: 2011-08-17 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec
@@ -38,10 +38,15 @@ files:
 - README.md
 - Rakefile
 - lib/puzzled.rb
+- lib/puzzled/cube.rb
+- lib/puzzled/revenge_cube.rb
 - lib/puzzled/rubiks_cube.rb
 - lib/puzzled/version.rb
 - puzzled.gemspec
+- spec/cube_spec.rb
+- spec/revenge_cube_spec.rb
 - spec/rubiks_cube_spec.rb
+- spec/spec_helper.rb
 homepage: ""
 licenses: []
 
@@ -70,4 +75,7 @@ signing_key:
 specification_version: 3
 summary: Rubik's Cube scramble generator.
 test_files: 
+- spec/cube_spec.rb
+- spec/revenge_cube_spec.rb
 - spec/rubiks_cube_spec.rb
+- spec/spec_helper.rb