has_slug 0.2.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2007 Bill Eisenhauer & Andre Lewis
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,131 @@
+= has_slug
+
+== Description
+
+has_slug is a plugin that add's slugging capabilities to ActiveRecord models. 
+It allows you to create SEO friendly URL's that will work the same as the 
+numeric defaults Rails provides you.
+
+Using has_slug, you can make this:
+
+  http://example.com/articles/1
+
+Look like this:
+
+  http://example.com/articles/1-first-post
+
+Or even better:
+
+  http://example.com/articles/first-post
+
+has_slug is inspired by friendly_id (http://github.com/norman/friendly_id/tree/master),
+but instead of adding a new table for the slugs it uses a single column per model.
+
+=== Why?
+
+* Text-based id's look better
+* They make URL's easier to remember.
+* They give no hint about the number of records in your database.
+* They are better for search engine optimization.
+
+=== But ...
+
+* It can be tricky to ensure they're always unique.
+* They can change, breaking your URL's and your SEO.
+* They can conflict with your application's namespace.
+
+has_slug takes care of creating unique slugs by using a counter. The first time
+a slug is generated for "Some Title", it will become "some-title". The second 
+time this is done, it will use the slug "some-title_2".
+
+has_slug DOES NOT take care of changing slugs! If you need to care of this, 
+either use the friendly_id plugin, which DOES take care of this, or use a 
+custom solution.
+
+has_slug also doesn't  take care of the namespace conflicts (a slug named 
+'new' for instance), you could use the following technique if this is 
+required: http://henrik.nyh.se/2008/10/validating-slugs-against-existing-routes-in-rails
+
+== Usage
+
+=== Typical usage (with slug column)
+
+Blog posts have a distinct, but not necessarily unique title stored in a column
+in the database. If we add a slug column to the posts table, we can use has_slug
+to generate slugs automatically.
+
+  class Post < ActiveRecord::Base
+    has_slug :title
+  end
+
+We can then use the standard url helpers to generate a SEO friendly URL:
+
+  @post_1 = Post.create(:title       => 'First Post',
+                        :description => 'Description ...')
+
+  @post_2 = Post.create(:title       => 'First Post',
+                        :description => 'Description ...')
+
+  url_for(@post_1)
+  # => http://example.com/posts/first-post
+
+  url_for(@post_2)
+  # => http://example.com/posts/first-post_2
+  
+And use the standard finder to find the corresponding post:
+
+  @post = Post.find('first-post')
+
+You can also use the <code>found_by_slug?</code> method to find out if the 
+record was found by the slug. You could use this to redirect to the URL with 
+the slug for SEO purposes.
+
+  redirect_to(@post, :status => 301) unless @post.found_by_slug?
+
+== Typical usage (without slug column)
+
+We can also use has_slug without adding the slug column. If we do this, the id
+of the record is prepended to the slug.
+
+  @post = Post.find(1)
+  
+  url_for(@post)
+  # => http://example.com/posts/1-first-post
+
+== Preserving characters
+
+Sometimes you'd like to preserve characters. For instance, if you'd like to have
+slugs that look like filenames, you would want to preserve the ".". This is made
+possible by the preserve option:
+
+  has_slug :filename, :preserve => "."
+
+== Scoped usage
+
+Restaurants belong to a city. They have a unique name, but only in the city they
+are in. If we add a slug column to the restaurants table, we can use has_slug
+to generate scoped slugs automatically.
+
+  class Restaurant < ActiveRecord::Base
+    belongs_to :city
+    
+    has_slug :name, :scope => :city
+  end
+
+We can then use the standard url helpers to generate a SEO friendly URL:
+
+  @restaurant_1 = Restaurant.create(:name => 'Da Marco',
+                                    :city => City.find('new-york'))
+  
+  @restaurant_2 = Restaurant.create(:name => 'Da Marco',
+                                    :city => City.find('san-fransisco'))
+
+  url_for(@restaurant_1.city, @restaurant)
+  # => http://example.com/cities/new-york/restaurants/da-marco
+  
+  url_for(@restaurant_2.city, @restaurant)
+  # => http://example.com/cities/san-fransisco/restaurants/da-marco
+
+== Authors
+
+* Tom-Eric Gerritsen (tomeric@i76.nl)

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the has_slug plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the has_slug plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'has_slug'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/init.rb

@@ -0,0 +1 @@
+require 'has_slug'

data/lib/has_slug.rb

@@ -0,0 +1,71 @@
+require 'rubygems'
+
+begin
+  require 'unicode'
+rescue MissingSourceFile
+  require 'unicode_utils'
+end
+
+require 'has_slug/slug'
+
+# has_slug is a slugging library for Ruby on Rails
+module HasSlug
+
+  # Load has_slug if the gem is included
+  def self.enable
+    return if ActiveRecord::Base.methods.include? 'has_slug'
+    
+    ActiveRecord::Base.class_eval { extend HasSlug::ClassMethods }
+  end
+  
+  module ClassMethods 
+
+    # Valid options for the has_slug method
+    VALID_HAS_SLUG_OPTIONS = [:scope, :slug_column, :preserve].freeze
+    
+    # Default options for the has_slug method
+    DEFAULT_HAS_SLUG_OPTIONS = { :scope => nil, :slug_column => 'slug', :preserve => '' }.freeze
+
+    # Set up an ActiveRecord model to use a slug.
+    #
+    # The attribute argument can be one of your model's columns, or a method
+    # you use to generate the slug.
+    #
+    # Options:
+    # * <tt>:scope</tt> - The scope of the slug
+    # * <tt>:slug_column</tt> - The column that will be used to store the slug in (defaults to slug)
+    def has_slug(attribute, options = {})
+      options.assert_valid_keys(VALID_HAS_SLUG_OPTIONS)
+      
+      options = DEFAULT_HAS_SLUG_OPTIONS.merge(options).merge(:attribute => attribute)
+      
+      if defined?(has_slug_options)
+        raise Exception, "has_slug_options is already defined, you can only call has_slug once"
+      end
+      
+      write_inheritable_attribute(:has_slug_options, options)
+      class_inheritable_reader(:has_slug_options)
+      
+      if columns.any? { |column| column.name.to_s == options[:slug_column].to_s }
+        require 'has_slug/sluggable_class_methods'
+        require 'has_slug/sluggable_instance_methods'
+        
+        extend SluggableClassMethods
+        include SluggableInstanceMethods
+        
+        before_save :set_slug,
+                    :if => :new_slug_needed?
+      else
+        require 'has_slug/not_sluggable_class_methods'
+        require 'has_slug/not_sluggable_instance_methods'
+        
+        extend NotSluggableClassMethods
+        include NotSluggableInstanceMethods
+      end
+    end
+  end
+end
+
+if defined?(ActiveRecord)
+  HasSlug::enable
+end

data/lib/has_slug/not_sluggable_class_methods.rb

@@ -0,0 +1,56 @@
+module HasSlug::NotSluggableClassMethods
+  
+  def self.extended(base)
+    class << base
+      alias_method_chain :find_one, :slug
+      alias_method_chain :find_some, :slug
+    end
+  end
+  
+  def find_one_with_slug(id_or_slug, options = {})
+    return find_one_without_slug(id_or_slug, options) if id_or_slug.is_a?(Fixnum)
+    
+    if match = id_or_slug.match(/^([0-9]+)/)
+      result = find_one_without_slug(match[1].to_i, options)
+      result.found_by_slug! if id_or_slug == result.slug
+    else
+      result = find_one_without_slug(id_or_slug, options)
+    end
+    
+    return result
+  end
+  
+  def find_some_with_slug(ids_or_slugs, options = {})
+    return find_some_without_slug(ids_or_slugs, options) if ids_or_slugs.all? { |x| x.is_a?(Fixnum) }
+    
+    ids = ids_or_slugs.map do |id_or_slug|
+            if match = id_or_slug.to_s.match(/^([0-9]+)/)
+              match[1].to_i
+            else
+              id_or_slug
+            end
+          end
+  
+    find_options = options.dup
+
+    find_options[:conditions] ||= [""]
+    find_options[:conditions]   = [find_options[:conditions] + " AND "] if find_options[:conditions].is_a?(String)
+    
+    find_options[:conditions][0] << "#{quoted_table_name}.#{primary_key} IN (?)" 
+    find_options[:conditions]    << ids
+    
+    found    = find_every(find_options)
+    expected = ids_or_slugs.map(&:to_s).uniq
+    
+    unless found.size == expected.size
+      raise ActiveRecord::RecordNotFound, "Couldn't find all #{ name.pluralize } with IDs (#{ ids_or_slugs * ', ' }) AND #{ sanitize_sql options[:conditions] } (found #{ found.size } results, but was looking for #{ expected.size })"
+    end
+    
+    ids_or_slugs.each do |slug|
+      slug_record = found.detect { |record| record.slug == slug }
+      slug_record.found_by_slug! if slug_record
+    end
+    
+    found
+  end
+end

data/lib/has_slug/not_sluggable_instance_methods.rb

@@ -0,0 +1,26 @@
+module HasSlug::NotSluggableInstanceMethods
+  attr :found_by_slug
+  
+  def found_by_slug!
+    @found_by_slug = true
+  end
+  
+  def found_by_slug?
+    @found_by_slug
+  end
+  
+  def sluggable
+    read_attribute(self.class.has_slug_options[:attribute])
+  end
+  
+  def slug
+    id   = self.send(self.class.primary_key)
+    slug = self.sluggable.to_slug(:preserve => has_slug_options[:preserve])
+    
+    "#{id}-#{slug}"
+  end
+
+  def to_param
+    self.slug
+  end
+end

data/lib/has_slug/slug.rb

@@ -0,0 +1,41 @@
+class String
+  # convert strings to slugs that are lowercase an only contain alphanumeric
+  # characters, dashes and sometimes dots
+  def to_slug(options = {})
+    slug = self
+    
+    preserve    = options.delete(:preserve).to_s.split
+    acceptable  = preserve + ["-", "_"]
+    
+    # Transliterate
+    if defined?(Unicode) && Unicode.respond_to?(:normalize_KD)
+      slug = Unicode.normalize_KD(slug).gsub(/[^\x00-\x7F]/n,'')
+    elsif defined?(UnicodeUtils) && UnicodeUtils.respond_to?(:compatibility_decomposition)
+      slug = UnicodeUtils.compatibility_decomposition(slug).gsub(/[^\x00-\x7F]/n,'')
+    end
+
+    # Convert to lowercase
+    slug.downcase!
+    
+    # Change all characters that are not to be preserved to dashes
+    slug.gsub!(Regexp.new("[^a-z0-9#{Regexp.escape(preserve.join)}]"), '-')
+  
+    # Preservable chars should be saved only when they have letter or number on 
+    # both sides (this preserves file extensions in case of :preserve => '.')
+    preserve.each do |char|      
+      slug.gsub!(Regexp.new("([^a-z0-9])#{Regexp.escape(char)}+"), '\\1-')
+      slug.gsub!(Regexp.new("#{Regexp.escape(char)}+([^a-z0-9])"), '-\\1')
+      slug.gsub!(Regexp.new("^#{Regexp.escape(char)}+"), '')
+      slug.gsub!(Regexp.new("#{Regexp.escape(char)}+$"), '')
+    end
+    
+    # Strip dashes from begining and end
+    slug.gsub!(/^-(.+)+/, '\1')
+    slug.gsub!(/(.+)-+$/, '\1')
+
+    # Change multiple succesive dashes to single dash.
+    slug.gsub!(/-+/, '-')
+    
+    slug
+  end
+end

data/lib/has_slug/sluggable_class_methods.rb

@@ -0,0 +1,89 @@
+module HasSlug::SluggableClassMethods
+
+  def self.extended(base) #:nodoc:#
+    class << base
+      alias_method_chain :find_one, :slug
+      alias_method_chain :find_some, :slug
+    end
+  end
+  
+  def slug_scope_attribute
+    return @@slug_scope_attribute if defined?(@@slug_scope_attribute)
+
+    if scope = has_slug_options[:scope]
+      if columns.any? { |c| c.name == scope }
+        @@slug_scope_attribute = scope.to_sym
+      elsif columns.any? { |c| c.name == "#{scope}_id" }
+        @@slug_scope_attribute = "#{scope}_id".to_sym
+      else
+        raise Exception, "has_slug's scope '#{scope}' does not exist in the model '#{self.class.to_s}'"
+      end
+    end
+    
+    @@slug_scope_attribute
+  end
+  
+  # Find a single record that has the same slug as the given record's slug
+  def find_one_with_same_slug(object)
+    slug_column = has_slug_options[:slug_column]
+    
+    options  = if object.new_record? then {}
+                                     else { :conditions => ["#{quoted_table_name}.#{primary_key} != ?", object] }
+                                     end
+
+    if scope = has_slug_options[:scope]
+      result = send("find_by_#{slug_column}_and_#{slug_scope_attribute}",
+                    object.slug, object.send(scope), options)
+    else
+      result = send("find_by_#{slug_column}", object.slug, options)
+    end
+      
+    result.found_by_slug! if result
+
+    result
+  end
+  
+  # Find a single record using the record's slug or the record's id
+  def find_one_with_slug(id_or_slug, options = {})
+    return find_one_without_slug(id_or_slug, options) if id_or_slug.is_a?(Fixnum)
+
+    slug_column = has_slug_options[:slug_column]
+
+    if result = send("find_by_#{slug_column}", id_or_slug, options)
+      result.found_by_slug!
+    else
+      result = find_one_without_slug(id_or_slug, options)
+    end
+    
+    result
+  end
+  
+  # Find multiple records using the records slugs or the records id's
+  def find_some_with_slug(ids_or_slugs, options = {})
+    return find_some_without_slug(ids_or_slugs, options) if ids_or_slugs.all? { |x| x.is_a?(Fixnum) }
+    
+    find_options = options.dup
+    
+    find_options[:conditions] ||= [""]
+    find_options[:conditions]   = [find_options[:conditions] + " AND "] if find_options[:conditions].is_a?(String)
+    find_options[:conditions][0] << "(#{quoted_table_name}.#{primary_key} IN (?)" <<
+                                    " OR #{quoted_table_name}.#{has_slug_options[:slug_column]} IN (?))"
+    
+    find_options[:conditions] << ids_or_slugs
+    find_options[:conditions] << ids_or_slugs.map(&:to_s)
+    
+    found    = find_every(find_options)
+    expected = ids_or_slugs.map(&:to_s).uniq
+    
+    unless found.size == expected.size
+      raise ActiveRecord::RecordNotFound, "Couldn't find all #{name.pluralize} with IDs (#{ids_or_slugs * ', '}) AND #{sanitize_sql(options[:conditions])} (found #{found.size} results, but was looking for #{expected.size})"
+    end
+    
+    ids_or_slugs.each do |slug|
+      slug_record = found.detect { |record| record.send(has_slug_options[:slug_column]) == slug }
+      slug_record.found_by_slug! if slug_record
+    end
+    
+    found
+  end
+end

data/lib/has_slug/sluggable_instance_methods.rb

@@ -0,0 +1,53 @@
+module HasSlug::SluggableInstanceMethods
+  attr :found_by_slug
+  
+  def found_by_slug!
+    @found_by_slug = true
+  end
+  
+  def found_by_slug?
+    @found_by_slug
+  end
+  
+  def sluggable
+    read_attribute(self.class.has_slug_options[:attribute])
+  end
+  
+  def slug
+    read_attribute(self.class.has_slug_options[:slug_column])
+  end
+  
+  def slug=(slug)
+    write_attribute(self.class.has_slug_options[:slug_column], slug)
+  end
+  
+  def new_slug_needed?
+    slug_changed      = self.send("#{self.class.has_slug_options[:slug_column]}_changed?")
+    sluggable_changed = self.send("#{self.class.has_slug_options[:attribute]}_changed?")
+
+    scope_changed     = if self.class.has_slug_options[:scope] then self.send("#{self.class.slug_scope_attribute}_changed?")
+                                                               else false
+                                                               end
+    
+    (!slug_changed && (self.new_record? || sluggable_changed)) || scope_changed
+    
+  end
+  
+  def to_param
+    self.slug || self.id
+  end
+  
+  private
+  
+  def set_slug
+    self.slug = self.sluggable.to_slug(:preserve => has_slug_options[:preserve])
+    
+    while existing = self.class.find_one_with_same_slug(self)
+      index ||= 2
+      
+      self.slug = "#{self.sluggable.to_slug(:preserve => has_slug_options[:preserve])}_#{index}"
+      
+      index += 1
+    end
+  end
+end

data/tasks/has_slug_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :has_slug do
+#   # Task goes here
+# end

data/test/factories/city_factory.rb

@@ -0,0 +1,3 @@
+Factory.define :city do |city|
+  city.name 'New York'
+end

data/test/factories/kitchen_factory.rb

@@ -0,0 +1,3 @@
+Factory.define :kitchen do |kitchen|
+  kitchen.name 'Italian'
+end

data/test/factories/restaurant_factory.rb

@@ -0,0 +1,5 @@
+Factory.define :restaurant do |restaurant|
+  restaurant.name 'Da Marco'
+  restaurant.city { |city| city.association(:city) }
+  restaurant.kitchen { |kitchen| kitchen.association(:kitchen) }
+end

data/test/models/city.rb

@@ -0,0 +1,8 @@
+class City < ActiveRecord::Base
+  has_slug :name
+  
+  has_many :restaurants
+  
+  has_many :kitchens,
+           :through => :restaurants
+end

data/test/models/kitchen.rb

@@ -0,0 +1,5 @@
+class Kitchen < ActiveRecord::Base
+  has_slug :name
+  
+  belongs_to :restaurant
+end

data/test/models/restaurant.rb

@@ -0,0 +1,9 @@
+class Restaurant < ActiveRecord::Base
+  has_slug :name,
+           :scope => :city,
+           :preserve => '.'
+  
+  belongs_to :city
+  
+  belongs_to :kitchen
+end

data/test/schema.rb

@@ -0,0 +1,17 @@
+ActiveRecord::Schema.define(:version => 1) do
+  create_table 'cities', :force => true do |t|
+    t.column 'name', :string
+    t.column 'slug', :string
+  end
+  
+  create_table 'restaurants', :force => true do |t|
+    t.column 'name', :string
+    t.column 'slug', :string
+    t.column 'city_id', :integer
+    t.column 'kitchen_id', :integer
+  end
+  
+  create_table 'kitchens', :force => true do |t|
+    t.column 'name', :string
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,27 @@
+require 'rubygems'
+require 'test/unit'
+require 'sqlite3'
+require 'activerecord'
+require 'shoulda'
+require 'factory_girl'
+
+HAS_SLUG_ROOT = File.dirname(__FILE__) + "/.."
+$:.unshift("#{HAS_SLUG_ROOT}/lib")
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3",
+                                        :dbfile  => "#{HAS_SLUG_ROOT}/test/test.db")
+require 'has_slug'
+require "#{HAS_SLUG_ROOT}/test/schema.rb"
+
+Dir["#{HAS_SLUG_ROOT}/test/models/*"].each { |f| require f }
+Dir["#{HAS_SLUG_ROOT}/test/factories/*"].each { |f| require f }
+
+[City, Restaurant, Kitchen].each { |c| c.reset_column_information }
+
+class Test::Unit::TestCase
+  def reset_database!
+    City.destroy_all
+    Restaurant.destroy_all
+    Kitchen.destroy_all
+  end
+end

data/test/unit/has_slug_test.rb

@@ -0,0 +1,171 @@
+# encoding: utf-8
+require "#{File.dirname(__FILE__)}/../test_helper"
+
+class HasSlugTest < Test::Unit::TestCase
+  context 'A model' do
+    setup do
+      reset_database!
+    end
+    
+    context 'without a slug column' do
+      setup do
+        @italian = Factory(:kitchen, :name => 'Italian')
+        @french  = Factory(:kitchen, :name => 'French')
+      end
+      
+      should 'set the slug' do
+        assert_not_nil @italian.slug
+      end
+      
+      should 'return the slug on call to #to_param' do
+        assert_equal @italian.slug, @italian.to_param
+      end
+      
+      should 'still find by id' do
+        kitchen = Kitchen.find(@italian.id)
+
+        assert_equal @italian, kitchen
+        assert !kitchen.found_by_slug?
+      end
+
+      should 'find one by slug' do
+        kitchen = Kitchen.find(@italian.slug)
+
+        assert_equal @italian, kitchen
+        assert kitchen.found_by_slug?        
+      end
+
+      should 'still find some by id' do
+        kitchens = Kitchen.find([@italian.id, @french.id])
+
+        assert_equal 2, kitchens.length
+        assert !kitchens.any?(&:found_by_slug?)
+      end
+
+      should 'find some by slug' do
+        kitchens = Kitchen.find([@italian.slug, @french.slug])
+
+        assert_equal 2, kitchens.length
+        assert kitchens.all?(&:found_by_slug?)
+      end
+
+      should 'find some by id or slug' do
+        kitchens = Kitchen.find([@italian.id, @french.slug])
+
+        assert_equal 2, kitchens.length
+        assert !kitchens[0].found_by_slug?
+        assert  kitchens[1].found_by_slug?
+      end
+    end
+    
+    context 'with a slug column' do
+      setup do
+        @new_york      = Factory(:city, :name => 'New York')
+        @san_francisco = Factory(:city, :name => 'San Francisco')
+      end
+      
+      context 'and a custom slug' do
+        setup do
+          @custom = Factory(:city, :name => 'Las Vegas', :slug => 'lv')
+        end
+        
+        should 'not update the slug unless sluggable_column changed' do
+          @custom.save
+          assert_equal 'lv', @custom.slug
+        end
+        
+        should 'update the slug if sluggable_column changed' do
+          @custom.update_attributes(:name => 'Los Angeles')
+
+          assert_equal 'los-angeles', @custom.slug
+        end
+      end
+      
+      context 'and characters to preserve' do
+        setup do
+          @restaurant_2_0 = Factory(:restaurant, :name => 'Restaurant 2.0')
+        end
+        
+        should 'preserve the .' do
+          assert_equal 'restaurant-2.0', @restaurant_2_0.slug
+        end
+      end
+      
+      context 'and a scope' do
+        setup do
+          @da_marco = Factory(:restaurant, :name => 'Da Marco',
+                                           :city => @new_york)
+        end
+        
+        should 'create the same slug in a different scope' do
+          @da_marco_2 = Factory(:restaurant, :name => 'Da Marco',
+                                             :city => @san_francisco)
+          
+          assert_equal @da_marco_2.slug, @da_marco.slug
+        end
+        
+        should 'not create duplicate slugs' do
+          @da_marco_2 = Factory(:restaurant, :name => 'Da Marco',
+                                             :city => @new_york)
+         
+          assert_not_equal @da_marco_2.slug, @da_marco.slug
+          
+          @da_marco_2.update_attributes(:city => @san_fransisco)          
+          assert_equal @da_marco_2.slug, @da_marco.slug    
+        end
+      end
+      
+      should 'set the slug' do
+        assert_equal 'new-york',      @new_york.slug
+        assert_equal 'san-francisco', @san_francisco.slug
+      end
+      
+      should 'return the slug on call to #to_param' do
+        assert_equal @new_york.slug,      @new_york.to_param
+        assert_equal @san_francisco.slug, @san_francisco.to_param
+      end
+      
+      should 'not create duplicate slugs' do
+        @new_york_2 = Factory(:city, :name => 'New-York')
+        
+        assert_not_equal @new_york_2.slug, @new_york.slug
+      end
+      
+      should 'still find by id' do
+        city = City.find(@new_york.id)
+        
+        assert_equal @new_york, city
+        assert !city.found_by_slug?
+      end
+      
+      should 'find one by slug' do
+        city = City.find(@new_york.slug)
+        
+        assert_equal @new_york, city
+        assert city.found_by_slug?        
+      end
+      
+      should 'still find some by id' do
+        cities = City.find([@new_york.id, @san_francisco.id])
+        
+        assert_equal 2, cities.length
+        assert !cities.any?(&:found_by_slug?)
+      end
+      
+      should 'find some by slug' do
+        cities = City.find([@new_york.slug, @san_francisco.slug])
+        
+        assert_equal 2, cities.length
+        assert cities.all?(&:found_by_slug?)
+      end
+      
+      should 'find some by id or slug' do
+        cities = City.find([@new_york.id, @san_francisco.slug])
+        
+        assert_equal 2, cities.length
+        assert !cities[0].found_by_slug?
+        assert  cities[1].found_by_slug?
+      end
+    end
+  end
+end

data/test/unit/slug_test.rb

@@ -0,0 +1,52 @@
+# encoding: utf-8
+require "#{File.dirname(__FILE__)}/../test_helper"
+
+class SlugTest < Test::Unit::TestCase
+  context 'A Slug' do
+    should 'be lowercase' do
+      assert_equal 'abc', "ABC".to_slug
+    end
+    
+    should 'have replaced spaces with dashes' do
+      assert_equal 'abc-def', "abc def".to_slug
+    end
+    
+    should 'have replaced special characters with dashes' do
+      assert_equal 'l-atelier',  "l'Atelier".to_slug
+      assert_equal 'five-stars', "Five*Stars".to_slug
+      assert_equal '-',          "***".to_slug
+    end
+    
+    should 'have stripped utf-8 characters' do
+      assert_equal 'internationalization', "Iñtërnâtiônàlizâtiôn".to_slug 
+    end
+    
+    should 'preserve specified characters if they have numbers or letters on both sides' do
+      assert_equal 'filename-1',   "filename.1".to_slug
+      assert_equal 'filename.1',   "filename.1".to_slug(:preserve => '.')
+
+      assert_equal 'filename-txt', "filename.txt".to_slug
+      assert_equal 'filename.txt', "filename.txt".to_slug(:preserve => '.')
+      
+      assert_equal 'a-sentence', "A sentence.".to_slug
+      assert_equal 'a-sentence', "A sentence.".to_slug(:preserve => '.')
+      
+      assert_equal 'a-sentence-a-new-sentence', "A sentence. A new sentence.".to_slug
+      assert_equal 'a-sentence-a-new-sentence', "A sentence. A new sentence.".to_slug(:preserve => '.')
+    end
+    
+    should 'not have trailing dashes' do
+      assert_equal 'abc-def', "abc def ".to_slug
+      assert_equal 'abc-def', "abc def-".to_slug
+    end
+    
+    should 'not have leading dashes' do
+      assert_equal 'abc-def', " abc def".to_slug
+      assert_equal 'abc-def', "-abc def".to_slug
+    end 
+    
+    should 'not have succesive dashes' do
+      assert_equal 'abc-def', "abc  def".to_slug
+    end
+  end
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification 
+name: has_slug
+version: !ruby/object:Gem::Version 
+  version: 0.2.1
+platform: ruby
+authors: 
+- Tom-Eric Gerritsen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-12-29 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: unicode
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: has_slug is a plugin that provides slugging capabilities to Ruby on Rails models. Inspired by the friendly_id plugin.
+email: tomeric@i76.nl
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- init.rb
+- MIT-LICENSE
+- Rakefile
+- README.rdoc
+- lib/has_slug.rb
+- lib/has_slug/slug.rb
+- lib/has_slug/not_sluggable_class_methods.rb
+- lib/has_slug/not_sluggable_instance_methods.rb
+- lib/has_slug/sluggable_class_methods.rb
+- lib/has_slug/sluggable_instance_methods.rb
+- tasks/has_slug_tasks.rake
+has_rdoc: true
+homepage: http://www.i76.nl/
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 2
+summary: A slugging plugin for Ruby on Rails
+test_files: 
+- test/schema.rb
+- test/test_helper.rb
+- test/factories/city_factory.rb
+- test/factories/kitchen_factory.rb
+- test/factories/restaurant_factory.rb
+- test/models/city.rb
+- test/models/kitchen.rb
+- test/models/restaurant.rb
+- test/unit/has_slug_test.rb
+- test/unit/slug_test.rb