sluggable 0.1.0 → 0.1.1

data/README.rdoc

@@ -18,26 +18,48 @@ Then, in your ActiveRecord model you just need to include the module
 and provide the column to use when generating the slug.  For example, 
 if we had a Post model with:
 
-    class Post < ActiveRecord::Base
+    class Blog < ActiveRecord::Base
       # Columns:
-      #  title: string
-      #  body:  text
-      #  slug:  string
+      #  name: string
+      #  slug: string
   
       include Sluggable
-      slug_column :title
+      slug_from :name
   
       before_validation :generate_slug
   
     end
 
-This sets it up so that the value of the `title` column is used as the
+This sets it up so that the value of the `name` column is used as the
 source when generating the slug.  The module also provides a private
 method (`generate_slug`) to generate and store the slug for this record.  
 It requires that the table have a column called `slug` and is typically
 called in a lifecycle hook, though it can be called from anywhere you 
 need it.
 
+If you have a model that allows the same slug when scoped to another
+associated model, you can provide a parameter as part of the `slug_from`
+method:
+
+    class Post < ActiveRecord::Base
+      # Columns:
+      #  blog_id: integer
+      #  title:   string
+      #  body:    text
+      #  slug:    string
+
+      belongs_to :blog
+      
+      include Sluggable
+      slug_from :title, :scope => :blog_id
+      
+      before_validation :generate_slug
+      
+    end
+
+This will allow the same slug to be generated for 2 posts each scoped to
+a different blog.
+
 == License
 
 Copyright (c) 2009 Patrick Reagan (mailto:reaganpr@gmail.com)

data/Rakefile

@@ -24,7 +24,28 @@ Rake::GemPackageTask.new(spec) do |pkg|
   pkg.gem_spec = spec
 end
 
-Rake::TestTask.new do |t|
+namespace :db do
+  desc 'Create the test database'
+  task :create do
+    require 'activerecord'
+    require 'test/support/configuration'
+
+    path = File.dirname(__FILE__) + '/test/support'
+
+    ActiveRecord::Base.establish_connection(Configuration.database(path))
+    ActiveRecord::Base.connection
+
+    load(File.dirname(__FILE__) + '/test/support/database.rb')
+  end
+
+  task :drop do
+    Dir[File.dirname(__FILE__) + '/test/support/*.sqlite3'].each {|f| FileUtils.rm(f) }
+  end
+  
+  task :reset => [:drop, :create]
+end
+
+Rake::TestTask.new(:test => 'db:reset') do |t|
   t.libs << 'test'
   t.test_files = FileList["test/**/*_test.rb"]
   t.verbose = true
@@ -33,7 +54,7 @@ end
 begin
   require 'rcov/rcovtask'
 
-  Rcov::RcovTask.new(:coverage) do |t|
+  Rcov::RcovTask.new(:coverage => 'db:reset') do |t|
     t.libs       = ['test']
     t.test_files = FileList["test/**/*_test.rb"]
     t.verbose    = true

data/lib/sluggable.rb

@@ -6,18 +6,10 @@ require 'core_ext/string'
 module Sluggable
   module ClassMethods
     
-    # Find all the other slugs in the database that don't belong to the 
-    # record specified by the +:id+ parameter.
-    def others_by_slug(id, slug)
-      conditions = id.nil? ? {} : {:conditions => ['id != ?', id]}
-      find_by_slug(slug, conditions)
-    end
-    
     # Determine the database column to use when generating the slug
-    def slug_column(column)
-      define_method(:slug_column) do
-        column
-      end
+    def slug_from(column, options = {})
+      define_method(:slug_source) { column }
+      define_method(:slug_scope)  { Array(options[:scope]) }
     end
     
   end
@@ -28,7 +20,7 @@ module Sluggable
       valid_slug = base_slug
 
       index = 2
-      while self.class.others_by_slug(self.id, valid_slug)
+      while self.class.find_by_slug(valid_slug, slug_conditions)
         valid_slug = base_slug + "-#{index}"
         index+= 1
       end
@@ -36,7 +28,23 @@ module Sluggable
     end
     
     def generate_slug # :nodoc:
-      self.slug = next_available_slug(self.send(slug_column).sluggify)
+      self.slug = next_available_slug(self.send(slug_source).sluggify)
+    end
+    
+    def conditions_for(column, include = true)
+      operator = include ? '=' : '!='
+      ["#{column} #{operator} ?", self[column]] unless self[column].blank?
+    end
+    
+    def slug_conditions
+      condition_parts = [conditions_for(:id, false)]
+      condition_parts += slug_scope.map {|c| conditions_for(c) }
+      condition_parts.compact!
+      
+      condition_string     = condition_parts.map {|p| p[0] }.join(' AND ')
+      condition_parameters = condition_parts.map {|p| p[1] }
+
+      condition_parts.empty? ? {} : {:conditions => [condition_string, *condition_parameters]}
     end
     
     private :next_available_slug, :generate_slug

data/lib/sluggable/version.rb

@@ -3,7 +3,7 @@ module Sluggable
     
     MAJOR = 0
     MINOR = 1
-    TINY  = 0
+    TINY  = 1
     
     def self.to_s # :nodoc:
       [MAJOR, MINOR, TINY].join('.')

data/test/support/configuration.rb

@@ -0,0 +1,7 @@
+class Configuration
+  
+  def self.database(path)
+    {:adapter => 'sqlite3', :database => "#{path}/test.sqlite3", :timeout => 5000}
+  end
+  
+end

data/test/support/database.rb

@@ -0,0 +1,15 @@
+ActiveRecord::Schema.define do
+
+  create_table "blogs", :force => true do |t|
+    t.string "name", :null => false
+    t.string "slug"
+  end
+
+  create_table "posts", :force => true do |t|
+    t.string   "title",      :null => false
+    t.string   "slug"
+    t.text     "body",       :null => false
+    t.integer  "blog_id",    :null => false
+  end
+  
+end

data/test/test_helper.rb

@@ -4,4 +4,12 @@ $:.reject! { |e| e.include? 'TextMate' }
 require 'rubygems'
 require 'throat_punch'
 
-require File.dirname(__FILE__) + '/../lib/sluggable'
+require 'activerecord'
+
+require File.dirname(__FILE__) + '/../lib/sluggable'
+
+path = File.dirname(__FILE__) + '/support'
+require "#{path}/configuration"
+
+ActiveRecord::Base.establish_connection(Configuration.database(path))
+

data/test/unit/sluggable_test.rb

@@ -1,80 +1,129 @@
 require File.dirname(__FILE__) + '/../test_helper'
 
-class SluggableImplementation
+class Blog < ActiveRecord::Base
+
+  include Sluggable
+  slug_from :name
+
+end
+
+class Post < ActiveRecord::Base
+
   include Sluggable
+  slug_from :title, :scope => :blog_id
+
 end
 
 class SluggableImplementationTest < Test::Unit::TestCase
-  
-  def stub_others_by_slug(id, *slugs)
-    slugs.each do |slug|
-      return_val = (slug == slugs.last) ? nil : stub()
-      SluggableImplementation.stubs(:others_by_slug).with(@id, slug).returns(return_val)
+
+  context "An instance of the Blog class" do
+    teardown { Blog.destroy_all }
+
+    should "know the column to use when generating the slug" do
+      Blog.new.slug_source.should == :name
     end
-  end
-  
-  context "The SluggableImplmentation class" do
-    setup do
-      @object = stub()
-      @slug   = 'sample-slug'
+
+    should "know the scope for finding the uniqueness of the slug" do
+      Blog.new.slug_scope.should == []
     end
-    
-    should "be able to find others by slug when provided an ID" do
-      id = 1
-      SluggableImplementation.expects(:find_by_slug).with(@slug, {:conditions => ['id != ?', id]}).returns(@object)
-      assert_equal @object, SluggableImplementation.others_by_slug(id, @slug)
+
+    should "know how to generate the conditions for a column when it exists" do
+      blog = Blog.create!(:name => 'Mine')
+      blog.conditions_for(:id).should == ['id = ?', blog.id]
     end
     
-    should "be able to find others by slug when not provided an ID" do
-      SluggableImplementation.expects(:find_by_slug).with(@slug, {}).returns(@object)
-      assert_equal @object, SluggableImplementation.others_by_slug(nil, @slug)
+    should "know how to generate the conditions for a column when it should not be included" do
+      blog = Blog.create!(:name => 'Mine')
+      blog.conditions_for(:id, false).should == ['id != ?', blog.id]
     end
-    
-    should "be able to record the column for use when generating the slug" do
-      SluggableImplementation.slug_column :title
-      @sluggable = SluggableImplementation.new
+
+    should "know how to generate the conditions for a column when it doesn't exist" do
+      blog = Blog.new
+      blog.conditions_for(:id).should be_nil
+    end
+
+    should "generate an empty set of conditions when there is no id" do
+      blog = Blog.new
+      blog.slug_conditions.should == {}
+    end
+
+    should "generate a set of conditions when there is an ID" do
+      blog = Blog.create!(:name => 'Me')
+      blog.slug_conditions.should == {:conditions => ['id != ?', blog.id]}
+    end
+
+    should "know the next available slug when the original is taken" do
+      Blog.create!(:name => 'One', :slug => 'one')
+
+      blog = Blog.new
+      blog.send(:next_available_slug, 'one').should == 'one-2'
+    end
+
+    should "incrementally suggest slugs until it finds an available one" do
+      Blog.create!(:name => 'One', :slug => 'one')
+      Blog.create!(:name => 'One', :slug => 'one-2')
+
+      blog = Blog.new
+
+      blog.send(:next_available_slug, 'one').should == 'one-3'
+    end
+
+    should "know not to suggest an incremental slug when the existing slug belongs to the current record" do
+      blog = Blog.create!(:name => 'One', :slug => 'one')
+      blog.send(:next_available_slug, 'one').should == 'one'
+    end
+
+    should "be able to assign a valid slug to the slug property" do
+      blog = Blog.new(:name => 'One')
+      blog.send(:generate_slug)
       
-      assert_equal :title, @sluggable.slug_column
+      blog.slug.should == 'one'
     end
-    
+
   end
+
+  context "An instance of the Post class" do
+    teardown do
+      Post.destroy_all
+      Blog.destroy_all
+    end
   
-  context "An instance of SluggableImplementation" do
-    
-    setup do
-      @id   = 1
-      @slug = 'title'
-      
-      @sluggable = SluggableImplementation.new
-      @sluggable.stubs(:id).returns(@id)
+    should "know the scope for finding the uniqueness of the slug" do
+      Post.new.slug_scope.should == [:blog_id]
     end
-    
-    should "know the next available slug when the original is taken" do
-      stub_others_by_slug(@id, 'title', 'title-2')
-      assert_equal "title-2", @sluggable.send(:next_available_slug, 'title')
+  
+    should "be able to generate a set of conditions when there is no ID" do
+      p = Post.new(:blog_id => 1)
+      p.slug_conditions.should == {:conditions => ['blog_id = ?', 1]}
     end
-    
-    should "incrementally suggest slugs until it finds an available one" do
-      stub_others_by_slug(@id, 'title', 'title-2', 'title-3')
-      assert_equal 'title-3', @sluggable.send(:next_available_slug, 'title')
+  
+    should "be able to generate a set of conditions when there is an ID" do
+      p = Post.create!(:title => 'Title', :body => 'Text', :blog_id => 1)
+      p.slug_conditions.should == {:conditions => ['id != ? AND blog_id = ?', p.id, 1]}
     end
     
-    should "know not to suggest an incremental slug when the existing slug belongs to the current record" do
-      SluggableImplementation.stubs(:id).with().returns(@id)
-      SluggableImplementation.stubs(:others_by_slug).with(@id, @slug).returns(nil)
+    should "maintain the current slug when one exists scoped to another blog_id" do
+      Post.create!(:title => 'Title', :body => 'Text', :blog_id => 1, :slug => 'title')
+      p = Post.new(:title => 'Title', :body => 'Text', :blog_id => 2)
       
-      assert_equal @slug, @sluggable.send(:next_available_slug, @slug)
+      p.send(:generate_slug)
+      
+      p.slug.should == 'title'
     end
     
-    should "be able to assign a valid slug to the slug property" do
-      @sluggable.stubs(:slug_column).with().returns(:title)
-      @sluggable.stubs(:title).with().returns(stub(:sluggify => @slug))
-      @sluggable.stubs(:next_available_slug).with(@slug).returns(@slug)
-      @sluggable.expects(:slug=).with(@slug)
+    should "increment the slug when one exists scoped to the same blog" do
+      Post.create!(:title => 'Title', :body => 'Text', :blog_id => 1, :slug => 'title')
+      p = Post.new(:title => 'Title', :body => 'Text', :blog_id => 1)
+
+      p.send(:generate_slug)
       
-      @sluggable.send(:generate_slug)
+      p.slug.should == 'title-2'
     end
     
   end
-  
-end
+
+
+end
+
+
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: sluggable
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Patrick Reagan
@@ -47,6 +47,9 @@ files:
 - lib/core_ext/string.rb
 - lib/sluggable/version.rb
 - lib/sluggable.rb
+- test/support/configuration.rb
+- test/support/database.rb
+- test/support/test.sqlite3
 - test/test_helper.rb
 - test/unit/core_ext/nil_class_test.rb
 - test/unit/core_ext/string_test.rb