foca-kaleidoscope 0.1.0 → 0.1.1

data/README.markdown

@@ -26,6 +26,24 @@ Example plz?
     # Don't save values automatically
     User.factory.new #=> #<User id: nil, ...>
 
+Generating unique values
+------------------------
+
+Most of the time, our models require certain fields to have unique content. In 
+order to generate that with Kaleidoscope, just call `Kaleidoscope.unique`:
+
+    Kaleidoscope.unique #=> 0
+    Kaleidoscope.unique #=> 1
+    # and so on, and so forth
+    
+If you need repeatable values, call `Kaleidoscope.reset_uniques!` and the next
+call to `Kaleidoscope.unique` will return 0 again.
+
+You can pass a block to `unique`, in which case we will pass the unique value
+to the block and return whatever the block outputs:
+
+    Kaleidoscope.unique {|i| "user_#{i}" } #=> "user_0"
+
 How does it work?
 -----------------
 

data/lib/kaleidoscope.rb

@@ -36,4 +36,25 @@ module Kaleidoscope
   def self.define(&block)
     module_eval(&block)
   end
+  
+  # Generate a unique value each time it's called (starting from zero)
+  # if passed a block it passes the value to the block and returns the output
+  #
+  #   Kaleidoscope.factory(User) {{ :login => "user_#{Kaleidoscope.unique}" }}
+  #
+  #   User.factory.create #=> #<User login: "user_0">
+  #   User.factory.create #=> #<User login: "user_1">
+  #   ...etc...
+  def self.unique(&block)
+    @unique_value ||= -1
+    @unique_value += 1
+    block ||= lambda {|i| i }
+    block.call(@unique_value)
+  end
+  
+  # Reset the unique generator so the next unique value generated is zero again
+  # Useful to run between tests to get predictable values.
+  def self.reset_uniques!
+    @unique_value = -1
+  end
 end

data/test/test_kaleidoscope.rb

@@ -36,6 +36,7 @@ class TestKaleidoscope < Test::Unit::TestCase
   include TestHelpers
   
   def setup
+    Kaleidoscope.reset_uniques!
     User.create_table
   end
   
@@ -79,4 +80,23 @@ class TestKaleidoscope < Test::Unit::TestCase
     assert_equal "Foo Bar", user.name
     assert_equal "foo@bar.com", user.email
   end
+  
+  def test_it_generates_unique_values
+    assert_equal 0, Kaleidoscope.unique
+    assert_equal 1, Kaleidoscope.unique
+    assert_equal 2, Kaleidoscope.unique
+  end
+  
+  def test_passes_unique_values_to_block_if_given
+    assert_equal "user_0", Kaleidoscope.unique {|i| "user_#{i}" }
+  end
+  
+  def test_it_can_reset_the_unique_generator
+    assert_equal 0, Kaleidoscope.unique
+    assert_equal 1, Kaleidoscope.unique
+    
+    Kaleidoscope.reset_uniques!
+    
+    assert_equal 0, Kaleidoscope.unique
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: foca-kaleidoscope
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - "Nicol\xC3\xA1s Sanguinetti"