slugger 0.2.0 → 0.3.0

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/lib/slugger.rb

@@ -8,7 +8,7 @@ module Slugger
   end
   module ClassMethods
     def has_slug(title_column=nil,options={})
-      class_inheritable_accessor :slugger_options
+      class_attribute :slugger_options
       default_options = {
         :title_column      => 'title',
         :slug_column       => 'slug',
@@ -16,35 +16,44 @@ module Slugger
         :downcase          => true,
         :on_conflict       => :error
       }
-      # :on_conflict can be :error or :concat_random_chars
+
       self.slugger_options = default_options.merge(options)
       self.slugger_options[:title_column] = title_column unless title_column.nil?
-      
-      # if columns_hash[slugger_options[:title_column].to_s].nil?
-      #   raise ArgumentError, "#{self.name} is missing source column"
-      # end
-      raise ArgumentError, "#{self.name} is missing required #{slugger_options[:slug_column]} column" if columns_hash[slugger_options[:slug_column].to_s].nil?
 
-      before_validation :permalize, :on => :create
+      if columns_hash[slugger_options[:slug_column].to_s].nil?
+        raise ArgumentError, "#{self.name} is missing required " +
+                             "#{slugger_options[:slug_column]} column"
+      end
+
+      before_validation :permalize,          :on => :create
+      before_validation :permalize_on_blank, :on => :update
+
+      # Used by +slug_conflict_resolution_append_id+
+      after_create      :append_id_to_slug
 
       validates slugger_options[:slug_column].to_sym, :presence => true
+
       if slugger_options[:scope]
-        validates slugger_options[:slug_column].to_sym, :uniqueness => {:scope => slugger_options[:scope]}
+        validates slugger_options[:slug_column].to_sym,
+                  :uniqueness => { :scope => slugger_options[:scope] }
       else
-        validates slugger_options[:slug_column].to_sym, :uniqueness => true
+        validates slugger_options[:slug_column].to_sym,
+                  :uniqueness => true
       end
 
-      send :define_method, :column_to_slug, lambda { self.send(slugger_options[:title_column]) }
-    
+      send :define_method, :column_to_slug,
+        lambda { self.send(slugger_options[:title_column]) }
+
       include InstanceMethods
     end
   end
   module InstanceMethods
 
-    protected
+    private
 
     def permalize
       return unless self.send("#{self.slugger_options[:slug_column]}").blank?
+
       if slugger_options[:title_column].is_a?(Array)
         s = ""
         self.slugger_options[:title_column].each do |m|
@@ -52,34 +61,63 @@ module Slugger
         end
         s = Iconv.iconv('ascii//ignore//translit', 'utf-8', s).to_s
       else
-        s = Iconv.iconv('ascii//ignore//translit', 'utf-8', self.send("#{self.slugger_options[:title_column]}")).to_s
+        s = Iconv.iconv('ascii//ignore//translit', 'utf-8',
+              self.send("#{self.slugger_options[:title_column]}")).to_s
       end
-      s.gsub!(/\'/, '')   # remove '
-      s.gsub!(/\W+/, ' ') # all non-word chars to spaces
-      s.strip!            # ohh la la
-      s.downcase!         if slugger_options[:downcase]
-      s.gsub!(/\ +/, slugger_options[:substitution_char].to_s) # spaces to dashes, preferred separator char everywhere
+
+      # Remove apostrophes
+      s.gsub!(/\'/, '')
+      # Replace all non-word chars to spaces
+      s.gsub!(/\W+/, ' ')
+      s.strip!
+      # Replace spaces with dashes or custom substitution character
+      s.gsub!(/\ +/, slugger_options[:substitution_char].to_s)
+      s.downcase! if slugger_options[:downcase]
+      s = s[0..(slugger_options[:max_length] - 1)] if slugger_options[:max_length]
+
       self.send("#{self.slugger_options[:slug_column]}=", s)
+
       slug_conflict_resolution
     end
+
+    def permalize_on_blank
+      permalize if self[slugger_options[:slug_column]].blank?
+    end
+
     def slug_conflict_resolution(append=nil)
-      existing = self.class.send(:where, "#{slugger_options[:slug_column]}".to_sym => self.send("#{self.slugger_options[:slug_column]}")).first
-      if existing
+      slug_column = slugger_options[:slug_column]
+
+      # Check if there are any records which the generated slug will conflict with
+      if self.class.where(slug_column => read_attribute(slug_column)).any?
         self.send("slug_conflict_resolution_#{self.slugger_options[:on_conflict]}", append)
       end
     end
+
     def slug_conflict_resolution_concat_random_chars(append)
       chars = ("a".."z").to_a + ("1".."9").to_a
       random_chars = Array.new(3, '').collect{chars[rand(chars.size)]}.join
       self.send("#{self.slugger_options[:slug_column]}=", "#{self.slugger_options[:slug_column]}#{self.slugger_options[:substitution_char]}#{random_chars}")
       slug_conflict_resolution
     end
+
+    def slug_conflict_resolution_append_id(append)
+      slug_column       = slugger_options[:slug_column]
+      substitution_char = slugger_options[:substitution_char]
+
+      # Temporarily write the slug with '+ID+' appended, then update the slug
+      # after the record is saved to the database +appended_id_to_slug+
+      self[slug_column] = [self[slug_column], '+ID+'].join(substitution_char)
+    end
+
     def slug_conflict_resolution_error(append)
-      # no op, validatino sets error
+      # no op, validation sets error
     end
 
-    def strip_title
-      self.send("#{self.slugger_options[:title_column]}").strip!
+    def append_id_to_slug
+      slug_column = slugger_options[:slug_column]
+      id_regex    = /\+ID\+\z/
+      return unless self[slug_column][id_regex]
+      update_attribute(slug_column, self[slug_column].gsub(id_regex, id.to_s))
     end
   end
 end

data/slugger.gemspec

@@ -27,5 +27,4 @@ Gem::Specification.new do |s|
   s.add_dependency "activerecord", ">= 3.0.0"
   s.add_development_dependency "rspec", ">= 2.0.0"
   s.add_development_dependency "sqlite3", "~> 1.3.0"
-  # s.add_runtime_dependency "rest-client"
 end

data/spec/lib/post_spec.rb

@@ -13,6 +13,11 @@ describe Post do
     p = Post.create(:title => "apostrop'hes", :slug => "apostrophes")
     p.slug.should == "apostrophes"
   end
+  it "should be limited to 20 characters" do
+    p = Post.create(
+      :title => "when you write really long titles slugs should be shortened")
+    p.slug.should == "when-you-write-reall"
+  end
   it "should not be valid on duplicate" do
     p = Post.create(:title => "hello")
     p.slug.should == "hello"

data/spec/lib/user_spec.rb

@@ -9,4 +9,11 @@ describe User do
     u = User.create(:first_name => "Tyler", :last_name => "Durden")
     u.slug.should == "tyler-durden"
   end
+  it "should append the database id if duplicates exist" do
+    first_user = User.create(:first_name => "Jordan", :last_name => "Byron")
+    first_user.slug.should == "jordan-byron"
+
+    second_user = User.create(:first_name => "Jordan", :last_name => "Byron")
+    second_user.slug.should == "jordan-byron-#{second_user.id}"
+  end
 end

data/spec/schema.rb

@@ -13,14 +13,14 @@ class CreateSchema < ActiveRecord::Migration
       t.string :slug
       t.timestamps
     end
-    
+
     create_table :users, :force => true do |t|
       t.string :first_name
       t.string :last_name
       t.string :slug
       t.timestamps
     end
-    
+
     create_table :edges, :force => true do |t|
       t.string :name
       t.string :slug_name
@@ -33,11 +33,11 @@ CreateSchema.suppress_messages do
 end
 
 class Post < ActiveRecord::Base
-  has_slug
+  has_slug 'title', :max_length => 20
 end
 
 class User < ActiveRecord::Base
-  has_slug [:first_name, :last_name]
+  has_slug [:first_name, :last_name], :on_conflict => :append_id
 end
 
 class Edge < ActiveRecord::Base

metadata

@@ -1,81 +1,58 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: slugger
-version: !ruby/object:Gem::Version 
-  hash: 23
+version: !ruby/object:Gem::Version
+  version: 0.3.0
   prerelease: 
-  segments: 
-  - 0
-  - 2
-  - 0
-  version: 0.2.0
 platform: ruby
-authors: 
+authors:
 - Seth Faxon
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-08-28 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-01-11 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: activerecord
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &70106294659920 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 3
-        - 0
-        - 0
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 3.0.0
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *70106294659920
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70106294659420 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 15
-        segments: 
-        - 2
-        - 0
-        - 0
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 2.0.0
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: sqlite3
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *70106294659420
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &70106294658960 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 27
-        segments: 
-        - 1
-        - 3
-        - 0
+      - !ruby/object:Gem::Version
         version: 1.3.0
   type: :development
-  version_requirements: *id003
+  prerelease: false
+  version_requirements: *70106294658960
 description: Slugger is yet another slug generator.
-email: 
+email:
 - seth.faxon@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - MIT-LICENSE
 - README.rdoc
-files: 
+files:
 - .gitignore
 - Gemfile
 - MIT-LICENSE
@@ -93,38 +70,29 @@ files:
 - tasks/spec.rake
 homepage: https://github.com/sfaxon/slugger
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: slugger
 rubygems_version: 1.8.8
 signing_key: 
 specification_version: 3
 summary: Slugger is yet another slug generator.
-test_files: 
+test_files:
 - spec/lib/edge_spec.rb
 - spec/lib/post_spec.rb
 - spec/lib/user_spec.rb