slug 0.5.0

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:minor: 5
+:patch: 0
+:major: 0

data/lib/slug/ascii_approximations.rb

@@ -0,0 +1,14 @@
+module Slug
+  # ASCII approximations for accented characters.
+  ASCII_APPROXIMATIONS = {
+    198 => "AE",
+    208 => "D",
+    216 => "O",
+    222 => "Th",
+    223 => "ss",
+    230 => "ae",
+    240 => "d",
+    248 => "o",
+    254 => "th"
+  }.freeze
+end

data/lib/slug/slug.rb

@@ -0,0 +1,104 @@
+module Slug
+  module ClassMethods
+    
+    # Call this to set up slug handling on an ActiveRecord model.
+    #
+    # Params:
+    # * <tt>:source</tt> - the column the slug will be based on (e.g. :<tt>headline</tt>)
+    #
+    # Options:
+    # * <tt>:column</tt> - the column the slug will be saved to (defaults to <tt>:slug</tt>)
+    #
+    # Slug will take care of validating presence and uniqueness of slug. It will generate the slug before create;
+    # subsequent changes to the source column will have no effect on the slug.  If you'd like to update the slug
+    # later on, call <tt>@model.set_slug</tt>
+    def slug source, opts={}
+      class_inheritable_accessor :slug_source, :slug_column
+      
+      self.slug_source = source
+      raise ArgumentError, "Source column '#{self.slug_source}' does not exist!" if !self.column_names.include?(self.slug_source.to_s)
+      
+      self.slug_column = opts.has_key?(:column) ? opts[:column] : :slug
+      raise ArgumentError, "Slug column '#{self.slug_column}' does not exist! #{self.column_names.join(',')}" if !self.column_names.include?(self.slug_column.to_s)
+      
+      validates_presence_of self.slug_column
+      validates_uniqueness_of self.slug_column
+      before_validation_on_create :set_slug 
+    end
+  end
+  
+  # Sets the slug. Called before create.
+  def set_slug
+    self[self.slug_column] = self[self.slug_source]
+
+    strip_diacritics_from_slug
+    normalize_slug
+    assign_slug_sequence
+    
+    self.errors.add(self.slug_column, "#{self.slug_column} cannot be blank. Is #{self.slug_source} sluggable?") if self[self.slug_column].blank?
+  end
+  
+  # Overrides to_param to return the model's slug.
+  def to_param
+    self[self.slug_column]
+  end
+  
+  def self.included(klass)
+    klass.extend(ClassMethods)
+  end
+  
+  private
+  # Takes the slug, downcases it and replaces non-word characters with a -.
+  # Feel free to override this method if you'd like different slug formatting.
+  def normalize_slug
+    return if self[self.slug_column].blank?
+    s = ActiveSupport::Multibyte.proxy_class.new(self[self.slug_column]).normalize(:kc)
+    s.downcase!
+    s.strip!
+    s.gsub!(/[\W]/u, ' ') # Remove non-word characters
+    s.gsub!(/\s+/u, '-') # Convert whitespaces to dashes
+    s.gsub!(/-\z/u, '') # Remove trailing dashes
+    self[self.slug_column] = s.to_s
+  end
+  
+  # Converts accented characters to their ASCII equivalents and removes them if they have no equivalent.
+  # Override this with a void function if you don't want accented characters to be stripped.
+  def strip_diacritics_from_slug
+    return if self[self.slug_column].blank?
+    s = ActiveSupport::Multibyte.proxy_class.new(self[self.slug_column])
+    s = s.normalize(:kd).unpack('U*')
+    s = s.inject([]) do |a,u|
+      if Slug::ASCII_APPROXIMATIONS[u]
+        a += Slug::ASCII_APPROXIMATIONS[u].unpack('U*')
+      elsif (u < 0x300 || u > 0x036F)
+        a << u
+      end
+      a
+    end
+    s = s.pack('U*')
+    s.gsub!(/[^a-z0-9]+/i, ' ')
+    self[self.slug_column] = s.to_s
+  end
+  
+  # If a slug of the same name already exists, this will append '-n' to the end of the slug to
+  # make it unique. The second instance gets a '-1' suffix.
+  def assign_slug_sequence
+    return if self[self.slug_column].blank?
+    idx = next_slug_sequence
+    self[self.slug_column] = "#{self[self.slug_column]}-#{idx}" if idx > 0
+  end
+  
+  # Returns the next unique index for a slug.
+  def next_slug_sequence
+    last_in_sequence = self.class.find(:first, :conditions => ["#{self.slug_column} LIKE ?", self[self.slug_column] + '%'],
+                                         :order => "CAST(REPLACE(#{self.slug_column},'#{self[self.slug_column]}','') AS UNSIGNED)")
+    if last_in_sequence.nil?
+      return 0
+    else
+      sequence_match = last_in_sequence[self.slug_column].match(/^#{self[self.slug_column]}(-(\d+))?/)
+      current = sequence_match.nil? ? 0 : sequence_match[2].to_i
+      return current + 1
+    end
+  end
+  
+end

data/lib/slug.rb

@@ -0,0 +1,6 @@
+require File.join(File.dirname(__FILE__), 'slug', 'slug')
+require File.join(File.dirname(__FILE__), 'slug', 'ascii_approximations')
+
+if defined?(ActiveRecord)
+  ActiveRecord::Base.class_eval { include Slug }
+end

data/test/schema.rb

@@ -0,0 +1,13 @@
+ActiveRecord::Schema.define(:version => 1) do
+
+  create_table "articles", :force => true do |t|
+    t.column "headline", "string"
+    t.column "slug", "string"
+  end
+  
+  create_table "people", :force => true do |t|
+    t.column "name", "string"
+    t.column "web_slug", "string"
+  end
+  
+end

data/test/test_helper.rb

@@ -0,0 +1,32 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'mocha'
+
+class Test::Unit::TestCase
+end
+
+# You can use "rake test AR_VERSION=2.0.5" to test against 2.0.5, for example.
+# The default is to use the latest installed ActiveRecord.
+if ENV["AR_VERSION"]
+  gem 'activerecord', "#{ENV["AR_VERSION"]}"
+  gem 'activesupport', "#{ENV["AR_VERSION"]}"
+end
+require 'active_record'
+require 'active_support'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'slug'
+
+ActiveRecord::Base.establish_connection :adapter => "sqlite3", :database => ":memory:"
+silence_stream(STDOUT) do
+  load(File.dirname(__FILE__) + "/schema.rb")
+end
+
+class Article < ActiveRecord::Base
+  slug :headline
+end
+
+class Person < ActiveRecord::Base
+  slug :name, :column => :web_slug
+end

data/test/test_slug.rb

@@ -0,0 +1,160 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class TestSlug < Test::Unit::TestCase
+
+  def setup
+    Article.delete_all
+    Person.delete_all
+  end
+
+  should "base slug on specified source column" do
+    article = Article.create!(:headline => 'Test Headline')
+    assert_equal 'test-headline', article.slug
+  end
+
+  context "slug column" do
+    should "save slug to 'slug' column by default" do
+      article = Article.create!(:headline => 'Test Headline')
+      assert_equal 'test-headline', article.slug
+    end
+    
+    should "save slug to :column specified in options" do
+      person = Person.create!(:name => 'Test Person')
+      assert_equal 'test-person', person.web_slug
+    end
+  end
+
+  context "setup validations" do
+    teardown do
+      Person.slug(:name, :column => :web_slug) # Reset Person slug column to valid config.
+    end
+
+    should "raise ArgumentError if an invalid source column is passed" do
+      assert_raises(ArgumentError) { Person.slug(:invalid_source_column) }
+    end
+
+    should "raise an ArgumentError if an invalid slug column is passed" do
+      assert_raises(ArgumentError) { Person.slug(:name, :column => :bad_slug_column)}
+    end
+  end
+  
+  should "set validation error if source column is empty" do
+    article = Article.create
+    assert !article.valid?
+    assert article.errors.on(:slug)
+  end
+  
+  should "set validation error if normalization makes source value empty" do
+    article = Article.create(:headline => '---')
+    assert !article.valid?
+    assert article.errors.on(:slug)
+  end
+  
+  should "not update the slug even if the source column changes" do
+    article = Article.create!(:headline => 'Test Headline')
+    article.update_attributes!(:headline =>  'New Headline')
+    assert_equal 'test-headline', article.slug
+  end
+
+  context "slug normalization" do
+    setup do
+      @article = Article.new
+    end
+
+    should "should lowercase strings" do
+      @article.headline = 'AbC'
+      @article.save!
+      assert_equal "abc", @article.slug
+    end
+  
+    should "should replace whitespace with dashes" do
+      @article.headline = 'a b'
+      @article.save!
+      assert_equal 'a-b', @article.slug
+    end
+
+    should "should replace 2spaces with 1dash" do
+      @article.headline = 'a  b'
+      @article.save!
+      assert_equal 'a-b', @article.slug
+    end
+
+    should "should remove punctuation" do
+      @article.headline = 'abc!@#$%^&*•¶§∞¢££¡¿()><?"":;][]\.,/'
+      @article.save!
+      assert_match 'abc', @article.slug
+    end
+  
+    should "should strip trailing space" do
+      @article.headline = 'ab '
+      @article.save!
+      assert_equal 'ab', @article.slug
+    end
+
+    should "should strip leading space" do
+      @article.headline = ' ab'
+      @article.save!
+      assert_equal 'ab', @article.slug
+    end
+      
+    should "should strip trailing dashes" do
+      @article.headline = 'ab-'
+      @article.save!
+      assert_match 'ab', @article.slug
+    end
+
+    should "should strip leading dashes" do
+      @article.headline = '-ab'
+      @article.save!
+      assert_match 'ab', @article.slug
+    end
+
+    should "should not modify valid slug strings" do
+      @article.headline = 'a-b-c-d'
+      @article.save!
+      assert_match 'a-b-c-d', @article.slug
+    end
+  end
+  
+  context "diacritics handling" do
+    setup do
+      @article = Article.new
+    end
+  
+    should "should strip diacritics" do
+      @article.headline = "açaí"
+      @article.save!
+      assert_equal "acai", @article.slug
+    end
+  
+    should "strip diacritics correctly " do
+      @article.headline  = "ÀÁÂÃÄÅÆÇÈÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝÞßàáâãäåæçèéêëìíîïðñòóôõöøùúûüýþÿ"
+      @article.save!
+      expected = "aaaaaaaeceeeiiiidnoooooouuuuythssaaaaaaaeceeeeiiiidnoooooouuuuythy".split(//)
+      output = @article.slug.split(//)
+      output.each_index do |i|
+        assert_equal expected[i], output[i]
+      end
+    end
+  end
+
+  context "sequence handling" do
+    should "not add a sequence if saving first instance of slug" do
+      article = Article.create!(:headline => 'Test Headline')
+      assert_equal 'test-headline', article.slug
+    end
+    
+    should "assign a -1 suffix to the second instance of the slug" do
+      article_1 = Article.create!(:headline => 'Test Headline')
+      article_2 = Article.create!(:headline => 'Test Headline')
+      assert_equal 'test-headline-1', article_2.slug
+    end
+    
+    should "assign a -12 suffix to the thirteenth instance of the slug" do
+      12.times { |i| Article.create!(:headline => 'Test Headline') }
+      article_13 = Article.create!(:headline => 'Test Headline')
+      assert_equal 'test-headline-12', article_13.slug
+    end
+  end
+
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification 
+name: slug
+version: !ruby/object:Gem::Version 
+  version: 0.5.0
+platform: ruby
+authors: 
+- Ben Koski
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-31 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Simple, straightforward slugs for your ActiveRecord models.
+email: ben.koski@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- VERSION.yml
+- lib/slug/ascii_approximations.rb
+- lib/slug/slug.rb
+- lib/slug.rb
+- test/schema.rb
+- test/test_helper.rb
+- test/test_slug.rb
+has_rdoc: true
+homepage: http://github.com/bkoski/slug
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+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: Simple, straightforward slugs for your ActiveRecord models.
+test_files: []
+