dougcole-friendly_id 2.0.5 → 2.0.6

data/History.txt

@@ -1,3 +1,23 @@
+== 2.0.4 2009-02-12
+
+* 1 major enhancment:
+  * You can now pass in your own custom slug generation blocks while setting up friendly_id.
+
+== 2.0.3 2009-02-11
+
+* 1 minor enhancment:
+  * Fixed to_param returning an empty string for non-slugged models with a null friendly_id.
+
+== 2.0.2 2009-02-09
+
+* 2 major enhancements:
+  * Made FriendlyId depend only on ActiveRecord. It should now be possible to
+    use FriendlyId with Camping or any other codebase that uses AR.
+  * Overhauled creaky testing setup and switched to Shoulda.
+
+* 1 minor enhancment:
+  * Made reserved words work for non-slugged models.
+
 == 2.0.1 2009-01-19
 
 * 1 minor enhancements:

data/Manifest.txt

@@ -14,32 +14,24 @@ lib/friendly_id.rb
 lib/friendly_id/helpers.rb
 lib/friendly_id/non_sluggable_class_methods.rb
 lib/friendly_id/non_sluggable_instance_methods.rb
-lib/friendly_id/shoulda_macros.rb
 lib/friendly_id/slug.rb
 lib/friendly_id/sluggable_class_methods.rb
 lib/friendly_id/sluggable_instance_methods.rb
 lib/friendly_id/version.rb
 lib/tasks/friendly_id.rake
 lib/tasks/friendly_id.rb
-test/database.yml
-test/fixtures/countries.yml
-test/fixtures/country.rb
-test/fixtures/people.yml
-test/fixtures/person.rb
-test/fixtures/post.rb
-test/fixtures/posts.yml
-test/fixtures/slugs.yml
-test/fixtures/user.rb
-test/fixtures/users.yml
+test/custom_slug_normalizer_test.rb
+test/models/book.rb
+test/models/country.rb
+test/models/novel.rb
+test/models/person.rb
+test/models/post.rb
+test/models/thing.rb
+test/models/user.rb
 test/non_slugged_test.rb
-test/rails/2.x/app/controllers/application.rb
-test/rails/2.x/config/boot.rb
-test/rails/2.x/config/database.yml
-test/rails/2.x/config/environment.rb
-test/rails/2.x/config/environments/test.rb
-test/rails/2.x/config/routes.rb
 test/schema.rb
 test/scoped_model_test.rb
 test/slug_test.rb
-test/sluggable_test.rb
+test/slugged_model_test.rb
+test/sti_test.rb
 test/test_helper.rb

data/README.rdoc

@@ -136,9 +136,13 @@ Here's how to do it:
 
   class Restaurant < ActiveRecord::Base
     belongs_to :city
-    has_friendly_id :name, :use_slug => true, :reserved => ["new", "index"]
+    has_friendly_id :name, :use_slug => true, :reserved => ["my", "values"]
   end
 
+As of FriendlyId version 2.0.2, "new" and "index" are reseved by default. When
+you attempt to store a reserved value, FriendlyId raises a
+FriendlyId::SlugGenerationError.
+
 
 === Scoped Slugs
 
@@ -208,6 +212,33 @@ that uses a non-Roman writing system, your feedback would be most welcome.
   @post.friendly_id # "友好编号在中国"
   @post2 = Post.create(:title => "友好编号在中国")
   @post2.friendly_id # "友好编号在中国--2"
+  
+=== Custom Slug Generation
+
+While FriendlyId's slug generation options work for most people, you may need
+something else. As of version 2.0.4 you can pass in your own custom slug
+generation block:
+
+  require 'stringex'
+  class Post < ActiveRecord::Base
+    has_friendly_id :title, :use_slug => true do |text|
+      # User stringex to generate the friendly_id rather than the baked-in methods
+      text.to_url
+    end
+  end
+  
+  ...
+  
+  @post = Post.create(:title => "tell your readers 你好")
+  @post.friendly_id # "tell-your-readers-ni-hao"
+
+FriendlyId will still respect your settings for max length and reserved words,
+but will use your block rather than the baked-in methods to normalize the
+friendly_id text.
+
+(As an aside, the stringex[http://github.com/rsl/stringex/tree/master] library
+provides some very cool slugging functionality and is a great option for
+apps using FriendlyId in either English or Chinese. Definitely check it out.)
 
 == Getting it
 
@@ -228,7 +259,7 @@ which FriendlyId depends on:
 
 == Setting it up
 
-FriendlyId currently works with Rails 2.0.0 and higher. Here's how to set it up.
+FriendlyId currently works with Rails 2.0.0 - 2.3.0. Here's how to set it up.
 
 1) Install the Gem:
 
@@ -267,7 +298,7 @@ rake:friendly_id:remove_old_slugs MODEL=MyModelName DAYS=60
 
 == Upgrading from an older version
 
-If you installed an older version of FriendlyId and want to upgrade to 2.0,
+If you installed an older version of FriendlyId and want to upgrade to 2.0.x,
 follow these steps:
 
 ==== Install the friendly_id Gem:
@@ -297,8 +328,6 @@ Add this to the bottom of environment.rb:
   ./script generate friendly_id_20_upgrade
   rake db:migrate
 
-That's it!
-
 == Hacking FriendlyId:
 
 FriendlyId is {hosted on Github}[git://github.com/norman/friendly_id.git], and

data/Rakefile

@@ -59,3 +59,11 @@ def run_coverage(files)
   puts cmd
   sh cmd
 end
+
+desc 'Publish RDoc to RubyForge.'
+task :publish_docs => [:clean, :docs] do
+  host = "compay@rubyforge.org"
+  remote_dir = "/var/www/gforge-projects/friendly-id"
+  local_dir = 'doc'
+  sh %{rsync -av --delete #{local_dir}/ #{host}:#{remote_dir}}
+end

data/VERSION.yml

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

data/lib/friendly_id.rb

@@ -1,21 +1,35 @@
-require 'unicode'
 require 'friendly_id/helpers'
 require 'friendly_id/slug'
-require 'friendly_id/shoulda_macros'
-
 
 # FriendlyId is a comprehensize Rails plugin/gem for slugging and permalinks.
 module FriendlyId
 
+  # Default options for has_friendly_id.
+  DEFAULT_FRIENDLY_ID_OPTIONS = {
+    :max_length => 255,
+    :method => nil,
+    :reserved => ["new", "index"],
+    :reserved_message => 'can not be "%s"',
+    :scope => nil,
+    :strip_diacritics => false,
+    :strip_non_ascii => false,
+    :use_slug => false }.freeze
+
+  # Valid keys for has_friendly_id options.
+  VALID_FRIENDLY_ID_KEYS = [
+    :max_length,
+    :reserved,
+    :reserved_message,
+    :scope,
+    :strip_diacritics,
+    :strip_non_ascii,
+    :use_slug ].freeze
+
   # This error is raised when it's not possible to generate a unique slug.
   class SlugGenerationError < StandardError ; end
 
   module ClassMethods
 
-    # Default options for friendly_id.
-    DEFAULT_FRIENDLY_ID_OPTIONS = {:method => nil, :use_slug => false, :max_length => 255, :reserved => [], :strip_diacritics => false, :scope => nil}.freeze
-    VALID_FRIENDLY_ID_KEYS = [:use_slug, :max_length, :reserved, :strip_diacritics, :scope].freeze
-
     # Set up an ActiveRecord model to use a friendly_id.
     #
     # The column argument can be one of your model's columns, or a method
@@ -25,25 +39,32 @@ module FriendlyId
     # * <tt>:use_slug</tt> - Defaults to false. Use slugs when you want to use a non-unique text field for friendly ids.
     # * <tt>:max_length</tt> - Defaults to 255. The maximum allowed length for a slug.
     # * <tt>:strip_diacritics</tt> - Defaults to false. If true, it will remove accents, umlauts, etc. from western characters.
-    # * <tt>:reseved</tt> - Array of words that are reserved and can't be used as slugs. If such a word is used, it will be treated the same as if that slug was already taken (numeric extension will be appended). Defaults to [].
-    def has_friendly_id(column, options = {})
+    # * <tt>:strip_non_ascii</tt> - Defaults to false. If true, it will all non-ascii ([^a-z0-9]) characters.
+    # * <tt>:reserved</tt> - Array of words that are reserved and can't be used as friendly_id's. For sluggable models, if such a word is used, it will be treated the same as if that slug was already taken (numeric extension will be appended). Defaults to ["new", "index"].
+    # * <tt>:reserved_message</tt> - The validation message that will be shown when a reserved word is used as a frindly_id. Defaults to '"%s" is reserved'.
+    def has_friendly_id(column, options = {}, &block)
       options.assert_valid_keys VALID_FRIENDLY_ID_KEYS
       options = DEFAULT_FRIENDLY_ID_OPTIONS.merge(options).merge(:column => column)
       write_inheritable_attribute :friendly_id_options, options
-      class_inheritable_reader :friendly_id_options
+      class_inheritable_accessor :friendly_id_options
+      class_inheritable_reader :slug_normalizer_block
 
       if options[:use_slug]
-        has_many :slugs, :order => 'id DESC', :as => :sluggable, :dependent => :destroy, :readonly => true
+        has_many :slugs, :order => 'id DESC', :as => :sluggable, :dependent => :destroy
         require 'friendly_id/sluggable_class_methods'
         require 'friendly_id/sluggable_instance_methods'
         extend SluggableClassMethods
         include SluggableInstanceMethods
         before_save :set_slug
+        if block_given?
+          write_inheritable_attribute :slug_normalizer_block, block
+        end
       else
         require 'friendly_id/non_sluggable_class_methods'
         require 'friendly_id/non_sluggable_instance_methods'
         extend NonSluggableClassMethods
         include NonSluggableInstanceMethods
+        validate_on_create :validate_friendly_id
       end
     end
 
@@ -55,7 +76,6 @@ module FriendlyId
     def enable
       return if ActiveRecord::Base.methods.include? 'has_friendly_id'
       ActiveRecord::Base.class_eval { extend FriendlyId::ClassMethods }
-      Test::Unit::TestCase.class_eval { include FriendlyId::ShouldaMacros }
     end
 
   end
@@ -64,4 +84,4 @@ end
 
 if defined?(ActiveRecord)
   FriendlyId::enable
-end
+end

data/lib/friendly_id/non_sluggable_class_methods.rb

@@ -21,17 +21,17 @@ module FriendlyId::NonSluggableClassMethods
   end
 
   def find_some_with_friendly(ids_and_names, options) #:nodoc:#
-    
+
     results = with_scope :find => options do
       find :all, :conditions => ["#{ quoted_table_name }.#{ primary_key } IN (?) OR #{friendly_id_options[:column].to_s} IN (?)",
         ids_and_names.map {|id| id.to_i}, ids_and_names.map {|id| id.to_s}]
     end
-    
+
     expected = expected_size(ids_and_names, options)
     if results.size != expected
       raise ActiveRecord::RecordNotFound, "Couldn't find all #{ name.pluralize } with IDs (#{ ids_and_names * ', ' }) AND #{ sanitize_sql options[:conditions] } (found #{ results.size } results, but was looking for #{ expected })"
     end
-    
+
     results.each {|r| r.send(:found_using_friendly_id=, true) if ids_and_names.include?(r.friendly_id)}
 
     results

data/lib/friendly_id/non_sluggable_instance_methods.rb

@@ -24,10 +24,18 @@ module FriendlyId::NonSluggableInstanceMethods
 
   # Returns the friendly id, or if none is available, the numeric id.
   def to_param
-    friendly_id.to_s || id.to_s
+    (friendly_id || id).to_s
   end
 
   private
+  
+  def validate_friendly_id
+    if self.class.friendly_id_options[:reserved].include? friendly_id
+      self.errors.add(self.class.friendly_id_options[:column],
+        self.class.friendly_id_options[:reserved_message] % friendly_id)
+      return false
+    end
+  end
 
   def found_using_friendly_id=(value) #:nodoc#
     @found_using_friendly_id = value

data/lib/friendly_id/slug.rb

@@ -1,3 +1,4 @@
+require 'unicode'
 # A Slug is a unique, human-friendly identifier for an ActiveRecord.
 class Slug < ActiveRecord::Base
 
@@ -23,12 +24,12 @@ class Slug < ActiveRecord::Base
     # terror in Europe unlike anything ever seen before or after. I'm not
     # taking any chances.
     def normalize(slug_text)
-      return "" if slug_text.blank?
-      slug_text.
+      return "" if slug_text.nil? || slug_text == ""
+      Unicode::normalize_KC(slug_text).
         send(chars_func).
         # For some reason Spanish ¡ and ¿ are not detected as non-word
         # characters. Bug in Ruby?
-        normalize.gsub(/[\W|¡|¿]/u, ' ').
+        gsub(/[\W|¡|¿]/u, ' ').
         strip.
         gsub(/\s+/u, '-').
         gsub(/-\z/u, '').
@@ -42,20 +43,21 @@ class Slug < ActiveRecord::Base
       return name, sequence
     end
 
-    # Remove diacritics (accents, umlauts, etc.) from the string.
+    # Remove diacritics (accents, umlauts, etc.) from the string. Borrowed
+    # from "The Ruby Way."
     def strip_diacritics(string)
-      require 'unicode'
-      Unicode::normalize_KD(string).unpack('U*').select { |cp|
-        cp < 0x300 || cp > 0x036F
-      }.pack('U*')
+      Unicode::normalize_KD(string).unpack('U*').select { |u| u < 0x300 || u > 0x036F }.pack('U*')
+    end
+    
+    # Remove non-ascii characters from the string.
+    def strip_non_ascii(string)
+      strip_diacritics(string).gsub(/[^a-z0-9]+/i, ' ')
     end
 
     private
 
     def chars_func
-      Rails.version =~ /2.2.[\d]*/ ? :mb_chars : :chars
-    rescue NoMethodError
-      :chars
+      "".respond_to?(:mb_chars) ? :mb_chars : :chars
     end
 
   end
@@ -73,7 +75,7 @@ class Slug < ActiveRecord::Base
 
   # Raise a FriendlyId::SlugGenerationError if the slug name is blank.
   def check_for_blank_name #:nodoc:#
-    if name.blank?
+    if name == "" || name.nil?
       raise FriendlyId::SlugGenerationError.new("The slug text is blank.")
     end
   end

data/lib/friendly_id/sluggable_class_methods.rb

@@ -1,7 +1,7 @@
 module FriendlyId::SluggableClassMethods
-  
-  include FriendlyId::Helpers
 
+  include FriendlyId::Helpers
+  
   def self.extended(base) #:nodoc:#
 
     class << base
@@ -38,6 +38,17 @@ module FriendlyId::SluggableClassMethods
     end
 
     result
+  rescue ActiveRecord::RecordNotFound => e
+
+    if friendly_id_options[:scope]
+      if !scope
+        e.message << "; expected scope but got none"
+      else
+        e.message << " and scope=#{scope}"
+      end
+    end
+
+    raise e
 
   end
 
@@ -87,7 +98,7 @@ module FriendlyId::SluggableClassMethods
     ids = []
     ids_and_names.each do |id_or_name|
       name, sequence = Slug.parse id_or_name
-      slug = Slug.find(:first, :readonly => true, :conditions => {
+      slug = Slug.find(:first, :conditions => {
         :name           => name,
         :scope          => scope,
         :sequence       => sequence,

data/lib/friendly_id/sluggable_instance_methods.rb

@@ -6,7 +6,7 @@ module FriendlyId::SluggableInstanceMethods
   attr_accessor :finder_slug_name
 
   def finder_slug
-    @finder_slug ||= init_finder_slug
+    @finder_slug ||= init_finder_slug or nil
   end
 
   # Was the record found using one of its friendly ids?
@@ -56,11 +56,18 @@ module FriendlyId::SluggableInstanceMethods
   # Get the processed string used as the basis of the friendly id.
   def slug_text
     base = send friendly_id_options[:column]
-    if self.friendly_id_options[:strip_diacritics]
-      base = Slug::normalize(Slug::strip_diacritics(base))
+    if self.slug_normalizer_block
+      base = self.slug_normalizer_block.call(base)
     else
+      if self.friendly_id_options[:strip_diacritics]
+        base = Slug::strip_diacritics(base)
+      end
+      if self.friendly_id_options[:strip_non_ascii]
+        base = Slug::strip_non_ascii(base)
+      end
       base = Slug::normalize(base)
     end
+    
     if base.length > friendly_id_options[:max_length]
       base = base[0...friendly_id_options[:max_length]]
     end
@@ -82,7 +89,7 @@ module FriendlyId::SluggableInstanceMethods
   def init_finder_slug
     return false if !@finder_slug_name
     name, sequence = Slug.parse(@finder_slug_name)
-    slug = Slug.find(:first, :conditions => {:sluggable_id => id, :name => name, :sequence => sequence, :sluggable_type => self.class.name })
+    slug = Slug.find(:first, :conditions => {:sluggable_id => id, :name => name, :sequence => sequence, :sluggable_type => self.class.base_class.name })
     finder_slug = slug
   end
 

data/lib/friendly_id/version.rb

@@ -2,7 +2,7 @@ module FriendlyId #:nodoc:
   module Version #:nodoc:
     MAJOR = 2
     MINOR = 0
-    TINY = 1
+    TINY = 4
     STRING = [MAJOR, MINOR, TINY].join('.')
   end
 end

data/test/custom_slug_normalizer_test.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8
+
+require File.dirname(__FILE__) + '/test_helper'
+
+class CustomSlugNormalizerTest < Test::Unit::TestCase
+
+  context "A slugged model using a custom slug generator" do
+
+    setup do
+      Thing.friendly_id_options = FriendlyId::DEFAULT_FRIENDLY_ID_OPTIONS.merge(:column => :name, :use_slug => true)
+      Thing.delete_all
+      Slug.delete_all
+    end
+
+    should "invoke the block code" do
+      @thing = Thing.create!(:name => "test")
+      assert_equal "a94a8fe5ccb19ba61c4c0873d391e987982fbbd3", @thing.friendly_id
+    end
+
+    should "respect the max_length option" do
+      Thing.friendly_id_options = Thing.friendly_id_options.merge(:max_length => 10)
+      @thing = Thing.create!(:name => "test")
+      assert_equal "a94a8fe5cc", @thing.friendly_id
+    end
+
+    should "respect the reserved option" do
+      Thing.friendly_id_options = Thing.friendly_id_options.merge(:reserved => ["a94a8fe5ccb19ba61c4c0873d391e987982fbbd3"])
+      assert_raises FriendlyId::SlugGenerationError do
+        Thing.create!(:name => "test")
+      end
+    end
+  
+  end
+
+end