slugger 0.1.0 → 0.1.1

data/README.rdoc

@@ -1,6 +1,6 @@
 = Slugger
 
-Slugger is yet another slug generator.  It makes pretty urls for Active Record models.  It jumps through some hoops to make sure every slug is unique.  
+Slugger is yet another slug generator.  It makes pretty urls for Active Record models.  Why would the ruby (on rails) community need another slug generating plugin you ask?  It doesn't, but I needed one that would jump through some hoops to make sure slugs are unique without setting errors.
 
 == Installation
 
@@ -8,33 +8,42 @@ It's a gem. Either run `gem install slugger` at the command line, or add `gem 's
 
 == Usage
 
-  has_slug :source_column, [options]
+  has_slug :source_column, [options_hash]
 
-The default source column is title.
+The default source column is title and slug column is, well slug.  The following two settings are the same:
+
+  has_slug
+  has_slug :title, :slug_column => 'slug'
 
 :source_column can also be an array, for example, if you wanted to create slugs for an Author model on first and last name:
 
-  has_slug [:first_name, :last_name]
+  class Author << ActiveRecord::Base
+    has_slug [:first_name, :last_name]
+  end
+
+To be sure that the slug will never have a validation error:
 
-== Options
+  class Post << ActiveRecord::Base
+    has_slug :title, :on_conflict => :concat_random_chars
+  end
 
-Say you have an Episode model that belongs to TVSeries.  Every episode will have a pilot, but you don't want the unique validation to build silly looking urls:
+Say you have an Episode model that belongs to TVSeries.  Every episode will have a pilot, but you don't want the unique validation to build silly looking urls: (this doesn't actually work), patches welcome
 
   class Episode << ActiveRecord::Base
     belongs_to :series
     
     has_slug :title, :scope => :series_id
   end
-  
 
 == Example
 
-  create_table "collection" do |t|
+  create_table "collections" do |t|
     t.string   "title"
     t.string   "slug"
   end
+  add_index(:collections, :slug)
 
-  class Project < ActiveRecord::Base
+  class Collection < ActiveRecord::Base
     has_slug
   end
 

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/lib/slugger.rb

@@ -7,35 +7,39 @@ module Slugger
     base.extend(ClassMethods)
   end
   module ClassMethods
-    def has_slug(title_column=nil,sluger_options={})
-      class_inheritable_accessor :sluger_options
-      sluger_options[:title_column]      ||= title_column || 'title'
-      # sluger_options[:title_column]      ||= 'title'
-      sluger_options[:slug_column]       ||= 'slug'
-      sluger_options[:as_param]          ||= true
-      sluger_options[:substitution_char] ||= '-'
-      self.sluger_options = sluger_options
+    def has_slug(title_column=nil,options={})
+      class_inheritable_accessor :slugger_options
+      default_options = {
+        :title_column      => 'title',
+        :slug_column       => 'slug',
+        :as_param          => true,
+        :substitution_char => '-',
+        :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[sluger_options[:title_column].to_s].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 slug column" if columns_hash[sluger_options[:slug_column]].nil?
+      raise ArgumentError, "#{self.name} is missing required #{slugger_options[:slug_column]} column" if columns_hash[slugger_options[:slug_column].to_s].nil?
 
-      before_validation :create_slug, :on => :create
+      before_validation :permalize, :on => :create
 
-      validates sluger_options[:slug_column].to_sym, :presence => true
-      if sluger_options[:scope]
-        validates sluger_options[:slug_column].to_sym, :uniqueness => {:scope => sluger_options[:scope]}
+      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]}
       else
-        validates sluger_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(sluger_options[:title_column]) }
+      send :define_method, :column_to_slug, lambda { self.send(slugger_options[:title_column]) }
 
       class << self
         def find(*args)
-          if self.sluger_options[:as_param] && args.first.is_a?(String)
+          if self.slugger_options[:as_param] && args.first.is_a?(String)
             find_by_slug(args)
           else
             super(*args)
@@ -49,31 +53,48 @@ module Slugger
   module InstanceMethods
 
     def to_param
-      sluger_options[:as_param] ? self.slug : self.id
+      slugger_options[:as_param] ? self.slug : self.id
     end
 
     protected
 
     def permalize
-      return if !self.send("#{self.sluggable_conf[:slug_column]}").blank?
-      s = Iconv.iconv('ascii//ignore//translit', 'utf-8', self.send("#{self.sluggable_conf[:title_column]}")).to_s
+      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|
+          s = "#{s} #{self.send(m)}"
+        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
+      end
       s.gsub!(/\'/, '')   # remove '
       s.gsub!(/\W+/, ' ') # all non-word chars to spaces
       s.strip!            # ohh la la
-      s.downcase!         #
-      s.gsub!(/\ +/, '-') # spaces to dashes, preferred separator char everywhere
-      self.send("#{self.sluggable_conf[:slug_column]}=", s) 
+      s.downcase!         if slugger_options[:downcase]
+      s.gsub!(/\ +/, slugger_options[:substitution_char].to_s) # spaces to dashes, preferred separator char everywhere
+      self.send("#{self.slugger_options[:slug_column]}=", s)
+      slug_conflict_resolution
     end
-    def strip_title
-      self.send("#{self.sluggable_conf[:title_column]}").strip!
+    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
+        self.send("slug_conflict_resolution_#{self.slugger_options[:on_conflict]}", append)
+      end
     end
-    
-    def create_slug
-      self.slug ||= clean("#{column_to_slug}")
+    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_error(append)
+      # no op, validatino sets error
     end
-  
-    def clean(string)
-      string.downcase.gsub(/[^\w\s\d\_\-]/,'').gsub(/\s\s+/,' ').gsub(/[^\w\d]/, sluger_options[:substitution_char])
+
+    def strip_title
+      self.send("#{self.slugger_options[:title_column]}").strip!
     end
   end
 end

data/spec/lib/edge_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+# class Edge < ActiveRecord::Base
+#   has_slug 'name', :slug_column => :slug_name,
+#                    :as_param => false,
+#                    :substitution_char => "_",
+#                    :downcase => false,
+#                    :on_conflict => :concat_random_chars
+# end
+
+describe Edge do
+  it "should set slug on create" do
+    e = Edge.create(:name => "hello")
+    e.slug_name.should == "hello"
+  end
+  it "should honor downcase false" do
+    e = Edge.create(:name => "YELLING")
+    e.slug_name.should == "YELLING"
+  end
+  it "should honor changing substitution_char" do
+    e = Edge.create(:name => "with spaces")
+    e.slug_name.should == "with_spaces"
+  end
+  it "should concat random chars when conflict" do
+    e = Edge.create(:name => "dupable")
+    e.slug_name.should == "dupable"
+    f = Edge.create(:name => e.slug_name)
+    f.should be_valid
+    f.slug_name.should_not == e.slug_name
+  end
+end

data/spec/lib/post_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe Post do
+  it "should set slug on create" do
+    p = Post.create(:title => "hello world")
+    p.slug.should == "hello-world"
+  end
+  it "should not override given slug" do
+    p = Post.create(:title => "hello world", :slug => "custom-slug")
+    p.slug.should == "custom-slug"
+  end
+  it "should remove apostrophes" do
+    p = Post.create(:title => "apostrop'hes", :slug => "apostrophes")
+    p.slug.should == "apostrophes"
+  end
+  it "should not be valid on duplicate" do
+    p = Post.create(:title => "hello")
+    p.slug.should == "hello"
+    q = Post.create(:title => "hello")
+    q.should_not be_valid
+  end
+end

data/spec/lib/user_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+# class User < ActiveRecord::Base
+#   has_slug [:first_name, :last_name]
+# end
+
+describe User do
+  it "should set slug on create when given an array" do
+    u = User.create(:first_name => "Tyler", :last_name => "Durden")
+    u.slug.should == "tyler-durden"
+  end
+end

data/spec/schema.rb

@@ -20,6 +20,11 @@ class CreateSchema < ActiveRecord::Migration
       t.string :slug
       t.timestamps
     end
+    
+    create_table :edges, :force => true do |t|
+      t.string :name
+      t.string :slug_name
+    end
   end
 end
 
@@ -33,12 +38,12 @@ end
 
 class User < ActiveRecord::Base
   has_slug [:first_name, :last_name]
+end
 
-  def name
-    [first_name, last_name].compact.join(' ')
-  end
-
-  def name=(names)
-    self[:first_name], self[:last_name] = names.split(' ', 2)
-  end
+class Edge < ActiveRecord::Base
+  has_slug 'name', :slug_column => :slug_name,
+                   :as_param => false,
+                   :substitution_char => "_",
+                   :downcase => false,
+                   :on_conflict => :concat_random_chars
 end

data/spec/spec_helper.rb

@@ -5,7 +5,6 @@ require 'schema'
 
 Dir[File.dirname(__FILE__) + "/support/**/*.rb"].each {|f| require f}
 
-
 RSpec.configure do |config|
   # == Mock Framework
   #

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: slugger
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Seth Faxon
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-23 00:00:00 Z
+date: 2011-08-24 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: activerecord
@@ -85,7 +85,9 @@ files:
 - lib/slugger.rb
 - lib/slugger/version.rb
 - slugger.gemspec
-- spec/lib/slugger_spec.rb
+- spec/lib/edge_spec.rb
+- spec/lib/post_spec.rb
+- spec/lib/user_spec.rb
 - spec/schema.rb
 - spec/spec_helper.rb
 - tasks/spec.rake
@@ -123,6 +125,8 @@ signing_key:
 specification_version: 3
 summary: Slugger is yet another slug generator.
 test_files: 
-- spec/lib/slugger_spec.rb
+- spec/lib/edge_spec.rb
+- spec/lib/post_spec.rb
+- spec/lib/user_spec.rb
 - spec/schema.rb
 - spec/spec_helper.rb

data/spec/lib/slugger_spec.rb

@@ -1,8 +0,0 @@
-require 'spec_helper'
-
-describe Post do
-  it "should set slug on create" do
-    p = Post.create(:title => "hello world")
-    p.slug.should == "hello-world"
-  end
-end