url_keyed_object 0.1.0 → 0.1.1

data/.gitignore

@@ -19,3 +19,4 @@ rdoc
 pkg
 
 ## PROJECT::SPECIFIC
+url_keyed_object.gemspec

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/features/for_url_key-like_uses.feature

@@ -0,0 +1,44 @@
+Feature: Using for things which are URL key-like
+  In order to generate and validate URL key-like data in a plain Ruby object
+  A Ruby developer
+  Wants to use UrlKeyedObject
+  
+  # If you want to generate URL key values without validating them it's really easy
+  Scenario: Generating a URL key value
+    When I make a call to generate a URL key:
+      """
+      @value = UrlKeyedObject.generate_unchecked_url_key
+      """
+    Then @value should match /^[a-z0-9]{5}$/
+    
+  Scenario: Generating and validating a URL key value
+    Given this class:
+      """
+        class HasOpaqueId
+          class << self
+            def instances
+              @instances ||= []
+            end
+          end
+          
+          attr_reader :id
+          
+          def initialize
+            @id = UrlKeyedObject.generate_checked_url_key do |id_value|
+              is_this_a_valid_id?(id_value)
+            end
+            self.class.instances << self
+          end
+          
+          private
+          
+          def is_this_a_valid_id?(id_value)
+            self.class.instances.select { |obj| obj.id == id_value }.empty?
+          end
+        end
+      """
+    When I make a new instance:
+      """
+        @object_with_id = HasOpaqueId.new
+      """
+    Then @object_with_id.id should match /^[a-z0-9]{5}$/

data/features/step_definitions/eval_steps.rb

@@ -10,6 +10,10 @@ Then /^(@[a-zA-Z_0-9]+)\.([a-zA-Z_0-9?!]+) should match \/(.+)\/$/ do |ivar, met
   instance_variable_get(ivar).send(method).should match(regex)
 end
 
+Then /^(@[a-zA-Z_0-9]+) should match \/(.+)\/$/ do |ivar, regex|
+  instance_variable_get(ivar).should match(regex)
+end
+
 Then /^(@[a-zA-Z_0-9]+)\.([a-zA-Z_0-9?!]+) should be (.+)$/ do |ivar, method, value|
   instance_variable_get(ivar).send(method).should send("be_#{value}")
 end

data/features/support/env.rb

@@ -1,4 +1,4 @@
 $LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../lib')
-require 'url_keyed_object'
+require 'url_keyed_object/active_record'
 
 require 'spec/expectations'

data/features/with_active_record-basic.feature

@@ -37,7 +37,7 @@ Feature: Using with ActiveRecord
         @instance = Thing.new
         @instance.save!
       """
-    Then @instance.url_key should match /[a-z0-9]{5}/
+    Then @instance.url_key should match /^[a-z0-9]{5}$/
   
   Scenario: Attempting to mass-assign url_key ought to fail
     When I make an instance using mass-assignment:

data/lib/url_keyed_object/active_record.rb

@@ -1,3 +1,5 @@
+require 'url_keyed_object'
+
 module UrlKeyedObject
   module ActiveRecord
     # --
@@ -27,10 +29,7 @@ module UrlKeyedObject
     protected
     
     def generate_valid_url_key
-      new_url_key = UrlKeyedObject.generate_unchecked_url_key
-      while !self.valid_url_key?(new_url_key) do
-        new_url_key = UrlKeyedObject.generate_unchecked_url_key
-      end
+      new_url_key = UrlKeyedObject.generate_checked_url_key { |value| self.valid_url_key?(value) }
       write_attribute(:url_key, new_url_key)
     end
     

data/lib/url_keyed_object.rb

@@ -6,9 +6,10 @@ module UrlKeyedObject
     # holds an array so a base-31 column (units / tens / hundreds) equiv can be 
     # encoded as an ASCII character
     def key_encoding
-      @key_encoding ||= ["0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "0", 
-                         "a", "b", "c", "d", "e", "f", "g", "h", "j", "k", "m",
-                         "n", "p", "q", "r", "s", "v", "w", "x", "y", "z"]
+      @key_encoding ||= ["0", "1", "2", "3", "4", "5", "6", "7", "8", "9", 
+                         "a", "b", "c", "d", "e", "f", "g", "h", "j", "k", 
+                         "m", "n", "p", "q", "r", "s", "v", "w", "x", "y", 
+                         "z"]
     end
     
     # generates a url key from a random 5-digit base 31 number, without checking its uniqueness
@@ -18,6 +19,15 @@ module UrlKeyedObject
       end.join('')
     end
     
+    # Keeps generating new URL keys until the passed-in block returns true
+    def generate_checked_url_key
+      key = generate_unchecked_url_key
+      while !yield(key)
+        key = generate_unchecked_url_key
+      end
+      key
+    end
+    
     # Validate the well-formedness of a URL key
     def well_formed_url_key?(url_key)
       !url_key.match(/^[0-9abcdefghjkmnpqrsvwxyz]{5}$/).nil?
@@ -29,5 +39,3 @@ module UrlKeyedObject
     end
   end
 end
-
-require 'url_keyed_object/active_record'

data/spec/spec_helper.rb

@@ -1,6 +1,7 @@
 $:.unshift(File.dirname(__FILE__))
 $:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'url_keyed_object'
+require 'url_keyed_object/active_record'
 require 'spec'
 require 'spec/autorun'
 require 'rubygems'

data/spec/url_keyed_object/active_record_spec.rb

@@ -83,12 +83,9 @@ describe UrlKeyedObject::ActiveRecord do
     
     it "should be able to keep attempting to create a URL key until one is valid" do
       url_keyed_object = @url_keyed_class.new
-      valid_url_sequence = sequence('valid url sequence')
       
-      UrlKeyedObject.expects(:generate_unchecked_url_key).in_sequence(valid_url_sequence).returns('a1url')
-      url_keyed_object.expects(:valid_url_key?).in_sequence(valid_url_sequence).returns(false)
-      UrlKeyedObject.expects(:generate_unchecked_url_key).in_sequence(valid_url_sequence).returns('a2url')
-      url_keyed_object.expects(:valid_url_key?).in_sequence(valid_url_sequence).returns(true)
+      UrlKeyedObject.expects(:generate_checked_url_key).yields('a2url').returns('a2url')
+      url_keyed_object.expects(:valid_url_key?).with('a2url').returns(true)
       
       @url_keyed_class.publicize_methods do
         url_keyed_object.generate_valid_url_key

data/spec/url_keyed_object_spec.rb

@@ -38,4 +38,16 @@ describe UrlKeyedObject do
       end
     end
   end
+  
+  describe "validity of URL keys" do
+    it "should be able to evaluate a block to check key validity, repeating until it generates one" do
+      valid_key_sequence = sequence('valid key sequence')
+      UrlKeyedObject.expects(:generate_unchecked_url_key).in_sequence(valid_key_sequence).returns('a1url')
+      UrlKeyedObject.expects(:generate_unchecked_url_key).in_sequence(valid_key_sequence).returns('a2url')
+      
+      key = UrlKeyedObject.generate_checked_url_key { |value| value != 'a1url' }
+      
+      key.should == 'a2url'
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: url_keyed_object
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Matt Patterson
@@ -60,6 +60,7 @@ files:
 - VERSION
 - cucumber.yml
 - features/fixtures/.gitignore
+- features/for_url_key-like_uses.feature
 - features/step_definitions/database_steps.rb
 - features/step_definitions/eval_steps.rb
 - features/step_definitions/feedback_steps.rb