url_keyed_object 0.1.1 → 0.2.0

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.2.0

data/features/for_url_key-like_uses.feature

@@ -11,7 +11,7 @@ Feature: Using for things which are URL key-like
       """
     Then @value should match /^[a-z0-9]{5}$/
     
-  Scenario: Generating and validating a URL key value
+  Scenario: Generating and validating a URL key value as part of object initialisation
     Given this class:
       """
         class HasOpaqueId
@@ -42,3 +42,17 @@ Feature: Using for things which are URL key-like
         @object_with_id = HasOpaqueId.new
       """
     Then @object_with_id.id should match /^[a-z0-9]{5}$/
+    
+  Scenario: Generating a URL key value of arbitrary length
+    When I make a call to generate a URL key:
+      """
+      @value = UrlKeyedObject.generate_unchecked_url_key(18)
+      """
+    Then @value should match /^[a-z0-9]{18}$/
+  
+  Scenario: Generating and validating a URL key value of arbitrary length
+  When I make a call to generate a valid URL key (with an admittedly nonsensical validation block):
+    """
+    @value = UrlKeyedObject.generate_checked_url_key(18) { |value| value.length == 18 }
+    """
+  Then @value should match /^[a-z0-9]{18}$/

data/features/with_active_record-basic.feature

@@ -20,7 +20,7 @@ Feature: Using with ActiveRecord
     And this class:
       """
       class Thing < ActiveRecord::Base
-        include UrlKeyedObject::ActiveRecord
+        acts_as_url_keyed
       end
       """
   
@@ -48,7 +48,7 @@ Feature: Using with ActiveRecord
     And a warning should have been logged
   
   Scenario: Attempting to set url_key ought to fail
-    When I make an instance using mass-assignment:
+    When I make an instance and set the value of url_key manually:
       """
         @instance = Thing.new
         @instance.url_key = 'abcde'

data/features/with_active_record-more-advanced.feature

@@ -0,0 +1,58 @@
+@db
+Feature: More advanced usage with ActiveRecord
+  In order to generate and validate non-standard URL keys in an ActiveRecord::Base object
+  A Rails developer
+  Wants to include and use UrlKeyedObject
+  
+  # The default case is for a 5-character ID, stored in the url_key column.
+  # Here we have an existing column we want to re-use, and we want a longer URL key
+  # 
+  # calling acts_as_url_keyed and setting a couple of options is all that's needed. 
+  Background:
+    Given a database, with this table defined:
+      """
+      create_table :advanced_things do |t|
+        t.string    :opaque_id, :null => false
+        
+        t.timestamps
+      end
+      """
+    And this class:
+      """
+      class AdvancedThing < ActiveRecord::Base
+        acts_as_url_keyed :url_key_column => :opaque_id, :url_key_length => 8
+      end
+      """
+  
+  Scenario: An unsaved model object with UrlKeyedObject included
+    When I make a bare instance:
+      """
+        @instance = AdvancedThing.new
+      """
+    Then @instance.opaque_id should be nil
+  
+  Scenario: A saved model object with an 8-character URL key on #opaque_id
+    When I make and save an instance:
+      """
+        @instance = AdvancedThing.new
+        @instance.save!
+      """
+    Then @instance.opaque_id should match /^[a-z0-9]{8}$/
+  
+  Scenario: Attempting to mass-assign opaque_id ought to fail
+    When I make an instance using mass-assignment:
+      """
+        @instance = AdvancedThing.new(:opaque_id => 'abcde')
+      """
+    Then @instance.opaque_id should be nil
+    And a warning should have been logged
+  
+  Scenario: Attempting to set opaque_id ought to fail
+    When I make an instance and set the value of opaque_id manually:
+      """
+        @instance = AdvancedThing.new
+        @instance.opaque_id = 'abcde'
+      """
+    Then @instance.opaque_id should be nil
+    And a warning should have been logged
+

data/lib/url_keyed_object/active_record.rb

@@ -1,40 +1,67 @@
 require 'url_keyed_object'
+require 'active_record'
 
 module UrlKeyedObject
   module ActiveRecord
-    # --
-    # the stuff that actually gets included.
-    # comment included for my benefit, in case I forget (quite likely)
-    # ++
+    # def url_key=(value)
+    #   logger.warn('Attempt to set #url_key!')
+    #   nil
+    # end
     
-    def to_param
-      url_key
-    end
-    
-    def url_key=(value)
-      logger.warn('Attempt to set #url_key!')
-      nil
-    end
-    
-    # --
-    # Validations
-    # ++
     
-    def self.included(model)
-      model.class_eval do
+    module ClassMethods
+      def url_key_column
+        @url_key_column ||= :url_key
+      end
+      
+      def url_key_length
+        @url_key_length ||= 5
+      end
+      
+      def acts_as_url_keyed(opts = {})
+        attr_writer :url_key_length
+        
+        @url_key_column = opts[:url_key_column] if opts.has_key?(:url_key_column)
+        @url_key_length = opts[:url_key_length] if opts.has_key?(:url_key_length)
+        
         before_create :generate_valid_url_key
+        
+        include InstanceMethods
+        
+        define_method("#{url_key_column}=") { |value| logger.warn("Attempt to set ##{url_key_column}!"); nil }
       end
     end
     
-    protected
-    
-    def generate_valid_url_key
-      new_url_key = UrlKeyedObject.generate_checked_url_key { |value| self.valid_url_key?(value) }
-      write_attribute(:url_key, new_url_key)
+    module InstanceMethods
+      protected
+      
+      def generate_valid_url_key
+        new_url_key = UrlKeyedObject.generate_checked_url_key(url_key_length) { |value| self.valid_url_key?(value) }
+        write_attribute(url_key_column, new_url_key)
+      end
+      
+      def valid_url_key?(url_key)
+        self.class.send("find_by_#{url_key_column}", url_key).nil?
+      end
+      
+      def url_key_column
+        self.class.url_key_column
+      end
+      
+      def url_key_length
+        self.class.url_key_length
+      end
+      
+      
+      def to_param
+        send url_key_column
+      end
     end
     
-    def valid_url_key?(url_key)
-      self.class.find_by_url_key(url_key).nil?
+    def self.included(model_class)
+      model_class.extend ClassMethods
     end
   end
-end
+end
+
+ActiveRecord::Base.send :include, UrlKeyedObject::ActiveRecord

data/lib/url_keyed_object.rb

@@ -13,24 +13,24 @@ module UrlKeyedObject
     end
     
     # generates a url key from a random 5-digit base 31 number, without checking its uniqueness
-    def generate_unchecked_url_key
-      (1..5).collect do
+    def generate_unchecked_url_key(length = 5)
+      (1..length).collect do
         key_encoding[rand(31)]
       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
+    def generate_checked_url_key(length = 5)
+      key = generate_unchecked_url_key(length)
       while !yield(key)
-        key = generate_unchecked_url_key
+        key = generate_unchecked_url_key(length)
       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?
+    def well_formed_url_key?(url_key, length = 5)
+      !url_key.match(Regexp.new("^[0-9abcdefghjkmnpqrsvwxyz]{#{length.to_i}}$")).nil?
     end
     
     # decode a moderately dirty URL key

data/spec/spec_helper.rb

@@ -1,11 +1,11 @@
 $:.unshift(File.dirname(__FILE__))
 $:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rubygems'
+gem 'activerecord'
 require 'url_keyed_object'
 require 'url_keyed_object/active_record'
 require 'spec'
 require 'spec/autorun'
-require 'rubygems'
-gem 'activerecord'
 
 Spec::Runner.configure do |config|
   config.mock_with :mocha

data/spec/url_keyed_object/active_record_spec.rb

@@ -37,7 +37,7 @@ describe UrlKeyedObject::ActiveRecord do
         'UrlKeyedObjectMock'
       end
       
-      include UrlKeyedObject::ActiveRecord
+      acts_as_url_keyed
     end
     
     ActiveRecord::Base.logger = Logger.new(STDERR)

data/spec/url_keyed_object_spec.rb

@@ -5,6 +5,10 @@ describe UrlKeyedObject do
     UrlKeyedObject.generate_unchecked_url_key.should match(/[0-9abcdefghjkmnpqrsvwxyz]{5}/)
   end
   
+  it "should be able to generate an arbitrary-length URL key" do
+    UrlKeyedObject.generate_unchecked_url_key(7).should match(/[0-9abcdefghjkmnpqrsvwxyz]{7}/)
+  end
+  
   describe "decoding a moderately dirty URL key (case insensitivity, ambiguous character replacement)" do
     it "should be able to cope with O o 0 ambiguity" do
       UrlKeyedObject.decode_url_key('Oo0ab').should == '000ab'
@@ -37,17 +41,27 @@ describe UrlKeyedObject do
         UrlKeyedObject.well_formed_url_key?(malformed_url_key).should be_false
       end
     end
+    
+    it "should be able to cope with a different specified length" do
+      UrlKeyedObject.well_formed_url_key?('abcdef', 6).should be_true
+    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')
+      UrlKeyedObject.expects(:generate_unchecked_url_key).with(5).returns('a1url').
+                     in_sequence(valid_key_sequence)
+      UrlKeyedObject.expects(:generate_unchecked_url_key).with(5).returns('a2url').
+                     in_sequence(valid_key_sequence)
       
       key = UrlKeyedObject.generate_checked_url_key { |value| value != 'a1url' }
       
       key.should == 'a2url'
     end
+    
+    it "should description" do
+      
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: url_keyed_object
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors: 
 - Matt Patterson
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-19 00:00:00 +00:00
+date: 2010-01-20 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -68,6 +68,7 @@ files:
 - features/support/hooks.rb
 - features/support/recording_logger.rb
 - features/with_active_record-basic.feature
+- features/with_active_record-more-advanced.feature
 - lib/url_keyed_object.rb
 - lib/url_keyed_object/active_record.rb
 - spec/spec.opts