has_unique_slug 0.1.3 → 0.1.4

data/Gemfile

@@ -2,4 +2,3 @@ source "http://rubygems.org"
 
 # Specify your gem's dependencies in has_unique_slug.gemspec
 gemspec
-gem 'rspec'

data/README.md

@@ -9,42 +9,30 @@ Tested and working on Rails 3.1.x
 
 ## Usage
 
-Assume you have a Post model that has a title and slug column, you can use the following to uniquely parameterize title:
-
 	class Post < ActiveRecord::Base
 		has_unique_slug
 	end
-	
 
-A unique slug will be generated automatically on creation by calling parameterize on title.
-If the generated slug is not unique, a number is added onto the end to ensure uniqueness. The series starts at 2 and increments up by one until a unique slug is found.
-If a slug is already specified, this slug will be used however the above rules still apply for incrementing the slug until a unique one is found.
-Ex. Post 1 has title "Sample Post" which would then generate slug "sample-post"
-    Post 2 has also has title "Sample Post" which then would generate slug "sample-post-2"
+- by default, the column `title` is assumed as the identifier, and `slug` is used to store the unique slug
+- `title.paramterize` is called to generate the slug unless a slug has already been assigned, in which case parameterize is called on the provided slug
+- if a slug is not unique in the database, a suffix is appended on the end in the format "-n" where n starts at 2 and progresses ad infinitum until a unique slug is found.
 
-You can specify which column to use to generate the slug and which column to use to store the slug. Below is the default:
+You can specify which column to use to generate the slug and which column to use to store the slug. For example:
 
 	class Post < ActiveRecord::Base
-	    # the column slug will store the slug, title.parameterize will be called to build the slug
-		has_unique_slug :slug, :title
+		has_unique_slug :column => :permalink, :subject => :name
+		# will store the unique slug in the column `permalink` created from `name`
 	end	
 
-The entire argument list is `has_unique_slug(slug_column, title_column, options, &block)` however there are no options you can pass in at this time.
-
-If only 1 argument is given, use that column to store the slug:
-
-	class Post < ActiveRecord::Base
-		has_unique_slug :permalink		# Uses the permalink column to store the slug
-	end
-
-Optionally, a block can be provided to generate the slug:
+Optionally, a Proc can be used instead of a column name to create the slug:
 
     class Car < ActiveRecord::Base
-        has_unique_slug {|car| "#{car.year} #{car.name}"}
+        has_unique_slug :subject => Proc.new {|car| "#{car.year}-#{car.name}"}
     end
-Note the space: parameterize will be called on the result of the block to ensure the slug is url friendly.
+You do not have to call parameterize on name, this will be done automatically.  (You don't even need to add dash, a space will work fine)
+
 
-You do not have to modify your controller to get this to work:
+You do not have to modify your controller to find records:
 
     class PostsController < ApplicationController
         
@@ -56,11 +44,14 @@ You do not have to modify your controller to get this to work:
         end
     end     
 
-Then you may use all your standard url helpers as normal.
-Ex. If a `post` has a title "Sample Post" and a slug "sample-post", the helper `post_path(post)` will create /posts/sample-post
+All the standard url helper methods will still work since `to_param`  is overridden to output the slug
+    
+    # Ex.
+    post = Post.create! :title => "Sample Post"
+    post_path(post)     # /posts/sample-post
 
 ## TODO:
 
-- Would like to write some tests.
-- Would like to be able to specify scope for uniqueness
-- Possibly consider optimizing the method to ensure uniqueness
+- Add support for scopes
+- Add support for database versioning
+- Consider optimizing the method to ensure a unique slug

data/has_unique_slug.gemspec

@@ -19,6 +19,8 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   # specify any dependencies here; for example:
-  # s.add_development_dependency "rspec"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "activerecord"
+  s.add_development_dependency "sqlite3"
   # s.add_runtime_dependency "rest-client"
 end

data/lib/has_unique_slug.rb

@@ -7,25 +7,26 @@ module HasUniqueSlug
   
   # Builds a slug from the subject_column unless a block is specified.
   # If a block is specified, the result of the block is returned.
-  def build_slug(record, subject_column, &block)
-    ( block_given? ? yield(record) : record[subject_column] ).parameterize
+  def build_slug(record, subject_column)
+    ( subject_column.is_a?(Proc) ? subject_column.call(record) : record[subject_column] ).parameterize
   end
   
   module ClassMethods
     
-    def has_unique_slug(*args, &block)
+    def has_unique_slug args = {}
       
-      options = { :scope => nil }
-      options.merge! args.pop if args.last.is_a? Hash
-      slug_column, subject_column = args
-      slug_column ||= :slug
-      subject_column ||= :title
+      # Setup default options
+      options = { :column => :slug, :subject => :title }
+      options.merge! args
+      slug_column, subject_column = options[:column], options[:subject]
       
-      # Add ActiveRecord Callback
-      before_save do |record|
+      # Use before_validates otherwise ActiveRecord uniqueness validations on the model will fail.  Uniqueness is already guarneteed.
+      # It is not recommend to use a 'validates :slug, :uniqueness => true' validation because that will add unndeeded stress on the
+      # database.
+      before_validation do |record|
         
-        # Add a slug if slug doesn't exist
-        slug_prefix = record[slug_column].blank? ? build_slug(record, subject_column, &block) : record[slug_column].parameterize
+        # Create base slug 
+        slug_prefix = record[slug_column].blank? ? build_slug(record, subject_column) : record[slug_column].parameterize
         
         # Ensure the current slug is unique in the database, if not, make it unqiue
         test_slug, i = slug_prefix, 1
@@ -34,7 +35,7 @@ module HasUniqueSlug
           test_slug = "#{slug_prefix}-#{(i += 1)}"
         end
         
-        # Set the slug
+        # Set the slug in the record
         record[slug_column] = test_slug
       end
       
@@ -50,14 +51,11 @@ module HasUniqueSlug
         end
       EOV
       
-      # Add find method to override ActiveRecord::Base.find
+      # Add find method to override ActiveRecord::Base.find.  
+      # Note: find_by_id will still work to search for record by their database id.
       instance_eval do
         def find(*args)
-          if args.length == 1
-            where("#{slug_column} = ?", args.first).first
-          else
-            where("#{slug_column} IN (?)", args)
-          end
+          args.length == 1 ? where(slug_column => args.first).first : where(slug_column => args)
         end
       end
     end
@@ -65,7 +63,8 @@ module HasUniqueSlug
   end
   
   module InstanceMethods
-
+    
+    # Override to param method.  Outputs the specified column (or slug by default) instead of the id
     def to_param
       self.send(self.class.slug_column)
     end

data/lib/has_unique_slug/version.rb

@@ -1,3 +1,3 @@
 module HasUniqueSlug
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

data/spec/has_unique_slug_spec.rb

@@ -1,5 +1,104 @@
 require 'spec_helper'
 
-describe HasUniqueSlug
-  pending "Write test simulating active record"
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+
+def setup_db
+  ActiveRecord::Schema.define(:version => 1) do
+    create_table :standards do |t|
+      t.column :title, :string
+      t.column :slug, :string
+    end
+    
+    create_table :customs do |t|
+      t.column :name, :string
+      t.column :permalink, :string
+    end
+  end
+end
+
+def teardown_db
+  ActiveRecord::Base.connection.tables.each do |t|
+    ActiveRecord::Base.connection.drop_table t
+  end
+end
+
+class Standard < ActiveRecord::Base
+  has_unique_slug
+  
+  def self.table_name 
+    "standards" 
+  end
+end
+
+class Custom < ActiveRecord::Base
+  has_unique_slug :column => :permalink, :subject => :name
+  
+  def self.table_name
+    "customs" 
+  end
+end
+
+class Custom2 < ActiveRecord::Base
+  has_unique_slug :column => :permalink, :subject => Proc.new {|record| "zcvf #{record.name} zxvf"}
+  
+  def self.table_name
+    "customs" 
+  end
+end
+
+describe HasUniqueSlug do
+  
+  before(:all) do
+    setup_db
+  end
+  
+  after(:all) do
+    teardown_db
+  end
+  
+  it "creates a unique slug" do
+    r = Standard.create! :title => "Sample Record"
+    r.slug.should == "sample-record"
+  end
+  
+  it "should add incremental column if not unique" do
+    2.upto 5 do |i|
+      r = Standard.create! :title => "Sample Record"
+      r.slug.should == "sample-record-#{i}"
+    end
+  end
+  
+  it "should not increment the slug if the duplicate is itself" do
+    r = Standard.last
+    slug = r.slug
+    r.save.should be_true
+    r.slug.should == slug
+  end
+  
+  it "should update slugs for non-standard implementation" do
+    r = Custom.create! :name => "Sample Record"
+    r.permalink.should == "sample-record"
+    2.upto 5 do |i|
+      r = Custom.create! :name => "Sample Record"
+      r.permalink.should == "sample-record-#{i}"
+    end
+    r = Custom.last
+    slug = r.permalink
+    r.save.should be_true
+    r.permalink.should == slug
+  end
+  
+  it "should update slugs based on the block if a block is provided" do
+    r = Custom2.create! :name => "Sample Record"
+    r.permalink.should == "zcvf-sample-record-zxvf"
+    2.upto 5 do |i|
+      r = Custom2.create! :name => "Sample Record"
+      r.permalink.should == "zcvf-sample-record-zxvf-#{i}"
+    end
+    r = Custom2.last
+    slug = r.permalink
+    r.save.should be_true
+    r.permalink.should == slug
+  end
+  
 end

data/spec/spec_helper.rb

@@ -1,8 +1,33 @@
 require 'rubygems'
 require 'bundler/setup'
+gem 'activerecord'
+require 'active_record'
+gem 'sqlite3'
+require 'sqlite3'
 
 require 'has_unique_slug' # and any other gems you need
 
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+
+def setup_db
+  ActiveRecord::Schema.define(:version => 1) do
+    create_table :standard_setup do |t|
+      t.column :title, :string
+      t.column :slug, :string
+    end
+    create_table :customized_setup do |t|
+      t.column :name, :string
+      t.column :permalink, :string
+    end
+  end
+end
+
+def teardown_db
+  ActiveRecord::Base.connection.tables.each do |t|
+    ActiveRecord::Base.connection.drop_table t
+  end
+end
+
 RSpec.configure do |config|
-  # some (optional) config here
+  
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: has_unique_slug
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 19
   prerelease: 
   segments: 
   - 0
   - 1
-  - 3
-  version: 0.1.3
+  - 4
+  version: 0.1.4
 platform: ruby
 authors: 
 - Brendan Stennett
@@ -15,9 +15,50 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-13 00:00:00 Z
-dependencies: []
-
+date: 2011-10-14 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: sqlite3
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
 description: Generates a unique slug for use as a drop-in replacement for ids.
 email: 
 - brendan@unknowncollective.com