slug 0.5.0 → 0.5.1

data/.gitignore

@@ -0,0 +1,3 @@
+*.sw?
+.DS_Store
+coverage

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Ben Koski
+
+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,74 @@
+= slug
+
+Slug provides simple, straightforward slugging for your ActiveRecord models.
+
+Slug is based on code from Norman Clarke's fantastic {friendly_id}[http://friendly-id.rubyforge.org] project and Nick Zadrozny's {friendly_identifier}[http://code.google.com/p/friendly-identifier/].
+
+Here's what's different:
+
+* Unlike friendly_id, slugs are stored directly in your model's table.  friendly_id stores its data in a separate sluggable table, which enables cool things like slug versioning--but forces yet another join when trying to do complex find_by_slugs.
+* Like friendly_id, diacritics (accented characters) are stripped from slug strings.
+* Most importantly, there are just two options: source column (for example, headline) and an optional slug column (if for some reason you don't want your slugs stored in a column called slug)
+
+== INSTALLATION
+
+  sudo gem install slug --source http://gemcutter.org
+
+then add
+
+  config.gem 'slug', :source => 'http://gemcutter.org'
+
+to your rails project.
+
+== USAGE
+
+It's up to you to set up the appropriate column in your model.  By default, Slug saves the slug to a column called 'slug', so in most cases you'll just want to add
+
+  t.string :slug
+
+to your create migration.
+
+I'd also suggest adding a unique index on the slug field in your migration
+
+  add_index :model_name, :slug, :unique => true
+
+Though Slug uses validates_uniqueness_of to ensue the uniqueness of your slug, two concurrent INSERTs could conceivably try to set the same slug.  Unlikely, but it's worth adding a unique index as a backstop.
+
+Once your table is migrated, just add
+
+  slug :source_field
+
+to your ActiveRecord model.  <tt>:source_field</tt> is the column you'd like to base the slug on--for example, it might be <tt>:headline</tt>.
+
+If you want to save the slug in a database column that isn't called <tt>slug</tt>, just pass the <tt>:column</tt> option. For example
+
+  slug :headline, :column => :web_slug
+
+would generate a slug based on <tt>headline</tt> and save it to <tt>web_slug</tt>.
+
+The source column isn't limited to just database attributes--you can specify any instance method.  This is handy if you need special formatting on your source column before it's slugged, or if you want to base the slug on several attributes.
+
+For example:
+
+  class Article < ActiveRecord::Base
+    slug :title_for_slug
+
+    def title_for_slug
+      "#{headline}-#{publication_date.year}-#{publication_date.month}"
+    end
+  end
+end
+
+would use headline-pub year-pub month as the slug source.
+
+From here, you can work with your slug as if it were a normal column--<tt>find_by_slug</tt> and named scopes will work as they do for any other column.
+
+A few notes:
+* Slug validates presence and uniqueness of the slug column.  If you pass something that isn't sluggable as the source (for example, say you set the headline to '---'), a validation error will be set.
+* Slug doesn't update the slug if the source column changes.  If you really need to regenerate the slug, call <tt>@model.set_slug</tt> before save.
+* If a slug already exists, Slug will automatically append a '-n' suffix to your slug to make it unique.  The second instance of a slug is '-1'.
+* If you don't like the slug formatting or the accented character stripping doesn't work for you, it's easy to override Slug's formatting functions. Check the source for details.
+
+== AUTHOR
+
+Ben Koski, ben.koski@gmail.com

data/Rakefile

@@ -0,0 +1,47 @@
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "slug"
+    s.summary = %Q{Simple, straightforward slugs for your ActiveRecord models.}
+    s.email = "ben.koski@gmail.com"
+    s.homepage = "http://github.com/bkoski/slug"
+    s.description = "Simple, straightforward slugs for your ActiveRecord models."
+    s.add_dependency 'activerecord'
+    s.add_dependency 'activesupport'
+    s.authors = ["Ben Koski"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = 'slug'
+  rdoc.options << '--line-numbers' << '--inline-source' << '--all'
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib' << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |t|
+    t.libs << 'test'
+    t.test_files = FileList['test/**/*_test.rb']
+    t.verbose = true
+  end
+rescue LoadError
+  puts "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+end
+
+task :default => :test

data/VERSION.yml

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

data/lib/slug.rb

@@ -2,5 +2,5 @@ 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 }
+  ActiveRecord::Base.instance_eval { extend Slug::ClassMethods }
 end

data/lib/slug/slug.rb

@@ -14,91 +14,98 @@ module Slug
     # later on, call <tt>@model.set_slug</tt>
     def slug source, opts={}
       class_inheritable_accessor :slug_source, :slug_column
+      include InstanceMethods
       
       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_presence_of self.slug_column, :message => "#{self.slug_column} cannot be blank. Is #{self.slug_source} sluggable?"
       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]
+  module InstanceMethods
+  
+    # Sets the slug. Called before create.
+    def set_slug
+      validate_slug_columns
+      self[self.slug_column] = self.send(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
+      strip_diacritics_from_slug
+      normalize_slug
+      assign_slug_sequence
+    end
   
-  # Overrides to_param to return the model's slug.
-  def to_param
-    self[self.slug_column]
-  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
+    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
+    private
+    # Validates that source and destination methods exist. Invoked at runtime to allow definition
+    # of source/slug methods after <tt>slug</tt> setup in class.
+    def validate_slug_columns
+      raise ArgumentError, "Source column '#{self.slug_source}' does not exist!" if !self.respond_to?(self.slug_source)
+      raise ArgumentError, "Slug column '#{self.slug_column}' does not exist!"   if !self.respond_to?("#{self.slug_column}=")
+    end
+  
+    # 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
+    # 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
-      a
+      s = s.pack('U*')
+      s.gsub!(/[^a-z0-9]+/i, ' ')
+      self[self.slug_column] = s.to_s
     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
+    # 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
+    # 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
-  
 end

data/slug.gemspec

@@ -0,0 +1,62 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{slug}
+  s.version = "0.5.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ben Koski"]
+  s.date = %q{2009-12-07}
+  s.description = %q{Simple, straightforward slugs for your ActiveRecord models.}
+  s.email = %q{ben.koski@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION.yml",
+     "lib/slug.rb",
+     "lib/slug/ascii_approximations.rb",
+     "lib/slug/slug.rb",
+     "slug.gemspec",
+     "test/models.rb",
+     "test/schema.rb",
+     "test/test_helper.rb",
+     "test/test_slug.rb"
+  ]
+  s.homepage = %q{http://github.com/bkoski/slug}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Simple, straightforward slugs for your ActiveRecord models.}
+  s.test_files = [
+    "test/models.rb",
+     "test/schema.rb",
+     "test/test_helper.rb",
+     "test/test_slug.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activerecord>, [">= 0"])
+      s.add_runtime_dependency(%q<activesupport>, [">= 0"])
+    else
+      s.add_dependency(%q<activerecord>, [">= 0"])
+      s.add_dependency(%q<activesupport>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<activerecord>, [">= 0"])
+    s.add_dependency(%q<activesupport>, [">= 0"])
+  end
+end
+

data/test/models.rb

@@ -0,0 +1,23 @@
+# Used to test slug behavior in general
+class Article < ActiveRecord::Base
+  slug :headline  
+end
+
+# Used to test alternate slug column
+class Person < ActiveRecord::Base
+  slug :name, :column => :web_slug
+end
+
+# Used to test invalid method names
+class Company < ActiveRecord::Base
+  slug :name
+end
+
+# Used to test slugs based on methods rather than database attributes
+class Event < ActiveRecord::Base
+  slug :title_for_slug
+  
+  def title_for_slug
+    "#{title}-#{location}"
+  end
+end

data/test/schema.rb

@@ -2,6 +2,7 @@ ActiveRecord::Schema.define(:version => 1) do
 
   create_table "articles", :force => true do |t|
     t.column "headline", "string"
+    t.column "section", "string"
     t.column "slug", "string"
   end
   
@@ -10,4 +11,15 @@ ActiveRecord::Schema.define(:version => 1) do
     t.column "web_slug", "string"
   end
   
+  create_table "companies", :force => true do |t|
+    t.column "name", "string"
+    t.column "slug", "string"
+  end
+  
+  create_table "events", :force => true do |t|
+    t.column "title", "string"
+    t.column "location", "string"
+    t.column "slug", "string"
+  end
+  
 end

data/test/test_helper.rb

@@ -23,10 +23,4 @@ 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
+require 'models'

data/test/test_slug.rb

@@ -12,6 +12,11 @@ class TestSlug < Test::Unit::TestCase
     assert_equal 'test-headline', article.slug
   end
 
+  should "base slug on specified source column, even if it is defined as a method rather than database attribute" do
+    article = Event.create!(:title => 'Test Event', :location => 'Portland')
+    assert_equal 'test-event-portland', article.slug
+  end
+
   context "slug column" do
     should "save slug to 'slug' column by default" do
       article = Article.create!(:headline => 'Test Headline')
@@ -24,29 +29,31 @@ class TestSlug < Test::Unit::TestCase
     end
   end
 
-  context "setup validations" do
-    teardown do
-      Person.slug(:name, :column => :web_slug) # Reset Person slug column to valid config.
-    end
-
+  context "column validations" do
     should "raise ArgumentError if an invalid source column is passed" do
-      assert_raises(ArgumentError) { Person.slug(:invalid_source_column) }
+      Company.slug(:invalid_source_column) 
+      assert_raises(ArgumentError) { Company.create! }
     end
 
     should "raise an ArgumentError if an invalid slug column is passed" do
-      assert_raises(ArgumentError) { Person.slug(:name, :column => :bad_slug_column)}
+      Company.slug(:name, :column => :bad_slug_column)
+      assert_raises(ArgumentError) { Company.create! }
     end
   end
   
   should "set validation error if source column is empty" do
     article = Article.create
     assert !article.valid?
+    require 'ruby-debug'
+    debugger if article.errors.count > 1
+    assert_equal 1, article.errors.count
     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_equal 1, article.errors.count
     assert article.errors.on(:slug)
   end
   
@@ -109,6 +116,12 @@ class TestSlug < Test::Unit::TestCase
       assert_match 'ab', @article.slug
     end
 
+    should "remove double-dashes" do
+      @article.headline = 'a--b--c'
+      @article.save!
+      assert_match 'a-b-c', @article.slug
+    end
+
     should "should not modify valid slug strings" do
       @article.headline = 'a-b-c-d'
       @article.save!

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: slug
 version: !ruby/object:Gem::Version 
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors: 
 - Ben Koski
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-31 00:00:00 -04:00
+date: 2009-12-07 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -38,13 +38,20 @@ executables: []
 
 extensions: []
 
-extra_rdoc_files: []
-
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
 files: 
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
 - VERSION.yml
+- lib/slug.rb
 - lib/slug/ascii_approximations.rb
 - lib/slug/slug.rb
-- lib/slug.rb
+- slug.gemspec
+- test/models.rb
 - test/schema.rb
 - test/test_helper.rb
 - test/test_slug.rb
@@ -54,7 +61,6 @@ licenses: []
 
 post_install_message: 
 rdoc_options: 
-- --inline-source
 - --charset=UTF-8
 require_paths: 
 - lib
@@ -75,7 +81,10 @@ requirements: []
 rubyforge_project: 
 rubygems_version: 1.3.5
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: Simple, straightforward slugs for your ActiveRecord models.
-test_files: []
-
+test_files: 
+- test/models.rb
+- test/schema.rb
+- test/test_helper.rb
+- test/test_slug.rb