alancse-friendly_id 2.0.1

data/Rakefile

@@ -0,0 +1,45 @@
+require 'newgem'
+require 'lib/friendly_id/version'
+
+Hoe.new("friendly_id", FriendlyId::Version::STRING) do |p|
+  p.rubyforge_name = "friendly-id"
+  p.author = ['Norman Clarke', 'Adrian Mugnolo', 'Emilio Tagua']
+  p.email = ['norman@randomba.org', 'adrian@randomba.org', 'miloops@gmail.com']
+  p.summary = "A comprehensive slugging and pretty-URL plugin for Ruby on Rails."
+  p.description = 'A comprehensive slugging and pretty-URL plugin for Ruby on Rails.'
+  p.url = 'http://randomba.org'
+  p.need_tar = true
+  p.need_zip = true
+  p.test_globs = ['test/**/*_test.rb']
+  p.extra_deps << ['unicode', '>= 0.1']
+  p.extra_dev_deps = [
+    ['newgem', ">= #{::Newgem::VERSION}"]
+  ]
+  p.rdoc_pattern = /^(lib|bin|ext)|txt|rdoc$/
+  changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
+  p.remote_rdoc_dir = ""
+end
+
+desc "Run RCov"
+task :rcov do
+  run_coverage Dir["test/**/*_test.rb"]
+end
+
+def run_coverage(files)
+  rm_f "coverage"
+  rm_f "coverage.data"
+  if files.length == 0
+    puts "No files were specified for testing"
+    return
+  end
+  files = files.join(" ")
+  if PLATFORM =~ /darwin/
+    exclude = '--exclude "gems/"'
+  else
+    exclude = '--exclude "rubygems"'
+  end
+  rcov = "rcov -Ilib:test --sort coverage --text-report #{exclude} --no-validator-links"
+  cmd = "#{rcov} #{files}"
+  puts cmd
+  sh cmd
+end

data/friendly_id.gemspec

@@ -0,0 +1,38 @@
+Gem::Specification.new do |s|
+  s.name = %q{alancse-friendly_id}
+  s.version = "2.0.1"
+
+  #s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Norman Clarke", "Adrian Mugnolo", "Emilio Tagua"]
+  #s.cert_chain = ["/Users/norman/.gem/gem-public_cert.pem"]
+  s.date = %q{2009-01-10}
+  s.description = %q{A comprehensive slugging and pretty-URL plugin for Ruby on Rails.}
+  s.email = ["norman@randomba.org", "adrian@randomba.org", "miloops@gmail.com"]
+  s.extra_rdoc_files = ["History.txt", "Manifest.txt"]
+  s.files = ["History.txt", "MIT-LICENSE", "Manifest.txt", "README.rdoc", "Rakefile", "friendly_id.gemspec", "generators/friendly_id/friendly_id_generator.rb", "generators/friendly_id/templates/create_slugs.rb", "generators/friendly_id_20_upgrade/friendly_id_20_upgrade_generator.rb", "generators/friendly_id_20_upgrade/templates/upgrade_friendly_id_to_20.rb", "init.rb", "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/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/test_helper.rb"]
+  s.has_rdoc = true
+  s.homepage = %q{http://randomba.org}
+  s.rdoc_options = ["--main", "README.txt"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{friendly-id}
+  s.rubygems_version = %q{1.3.1}
+  #s.signing_key = %q{/Users/norman/.gem/gem-private_key.pem}
+  s.summary = %q{A comprehensive slugging and pretty-URL plugin for Ruby on Rails.}
+  s.test_files = ["test/non_slugged_test.rb", "test/scoped_model_test.rb", "test/slug_test.rb", "test/sluggable_test.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<unicode>, [">= 0.1"])
+      s.add_development_dependency(%q<hoe>, [">= 1.8.2"])
+    else
+      s.add_dependency(%q<unicode>, [">= 0.1"])
+      s.add_dependency(%q<hoe>, [">= 1.8.2"])
+    end
+  else
+    s.add_dependency(%q<unicode>, [">= 0.1"])
+    s.add_dependency(%q<hoe>, [">= 1.8.2"])
+  end
+end

data/generators/friendly_id/friendly_id_generator.rb

@@ -0,0 +1,12 @@
+class FriendlyIdGenerator < Rails::Generator::Base
+  def manifest
+    record do |m|
+      unless options[:skip_migration]
+        m.migration_template(
+          'create_slugs.rb', 'db/migrate', :migration_file_name => 'create_slugs'
+        )
+        m.file "/../../../lib/tasks/friendly_id.rake", "lib/tasks/friendly_id.rake"
+      end
+    end
+  end
+end

data/generators/friendly_id/templates/create_slugs.rb

@@ -0,0 +1,18 @@
+class CreateSlugs < ActiveRecord::Migration
+  def self.up
+    create_table :slugs do |t|
+      t.string :name
+      t.integer :sluggable_id
+      t.integer :sequence, :null => false, :default => 1
+      t.string :sluggable_type, :limit => 40
+      t.string :scope, :limit => 40
+      t.datetime :created_at
+    end
+    add_index :slugs, [:name, :sluggable_type, :scope, :sequence], :unique => true
+    add_index :slugs, :sluggable_id
+  end
+
+  def self.down
+    drop_table :slugs
+  end
+end

data/generators/friendly_id_20_upgrade/friendly_id_20_upgrade_generator.rb

@@ -0,0 +1,11 @@
+class FriendlyId20UpgradeGenerator < Rails::Generator::Base
+  def manifest
+    record do |m|
+      unless options[:skip_migration]
+        m.migration_template(
+          'upgrade_friendly_id_to_20.rb', 'db/migrate', :migration_file_name => 'upgrade_friendly_id_to_20'
+        )
+      end
+    end
+  end
+end

data/generators/friendly_id_20_upgrade/templates/upgrade_friendly_id_to_20.rb

@@ -0,0 +1,19 @@
+class UpgradeFriendlyIdTo20 < ActiveRecord::Migration
+
+  def self.up
+    remove_column :slugs, :updated_at
+    remove_index :slugs, :column => [:name, :sluggable_type]
+    add_column :slugs, :sequence, :integer, :null => false, :default => 1
+    add_column :slugs, :scope, :string, :limit => 40
+    add_index :slugs, [:name, :sluggable_type, :scope, :sequence], :unique => true, :name => "index_slugs_on_n_s_s_and_s"
+  end
+
+  def self.down
+    remove_index :slugs, :name => "index_slugs_on_n_s_s_and_s"
+    remove_column :slugs, :scope
+    remove_column :slugs, :sequence
+    add_column :slugs, :updated_at, :datetime
+    add_index :slugs, [:name, :sluggable_type], :unique => true
+  end
+
+end

data/init.rb

@@ -0,0 +1 @@
+require 'friendly_id'

data/lib/friendly_id.rb

@@ -0,0 +1,68 @@
+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
+
+  # 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
+    # you use to generate the slug.
+    #
+    # Options:
+    # * <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 = {})
+      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
+
+      if options[:use_slug]
+        has_many :slugs, :order => 'id DESC', :as => :sluggable, :dependent => :destroy, :readonly => true
+        require 'friendly_id/sluggable_class_methods'
+        require 'friendly_id/sluggable_instance_methods'
+        extend SluggableClassMethods
+        include SluggableInstanceMethods
+        before_save :set_slug
+      else
+        require 'friendly_id/non_sluggable_class_methods'
+        require 'friendly_id/non_sluggable_instance_methods'
+        extend NonSluggableClassMethods
+        include NonSluggableInstanceMethods
+      end
+    end
+
+  end
+
+  class << self
+
+    # Load FriendlyId if the gem is included in a Rails app.
+    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
+
+
+end
+
+if defined?(ActiveRecord)
+  FriendlyId::enable
+end

data/lib/friendly_id/helpers.rb

@@ -0,0 +1,13 @@
+module FriendlyId
+  
+  module Helpers
+    # Calculate expected result size for find_some_with_friendly (taken from
+    # active_record/base.rb)
+    def expected_size(ids_and_names, options) #:nodoc:#
+      size = options[:offset] ? ids_and_names.size - options[:offset] : ids_and_names.size
+      size = options[:limit] if options[:limit] && size > options[:limit]
+      size
+    end
+  end
+  
+end

data/lib/friendly_id/non_sluggable_class_methods.rb

@@ -0,0 +1,40 @@
+module FriendlyId::NonSluggableClassMethods
+
+  include FriendlyId::Helpers
+
+  def self.extended(base) #:nodoc:#
+    class << base
+      alias_method_chain :find_one, :friendly
+      alias_method_chain :find_some, :friendly
+    end
+  end
+
+  protected
+
+  def find_one_with_friendly(id, options) #:nodoc:#
+    if id.is_a?(String) && result = send("find_by_#{ friendly_id_options[:column] }", id, options)
+      result.send(:found_using_friendly_id=, true)
+    else
+      result = find_one_without_friendly id, options
+    end
+    result
+  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, ids_and_names]
+    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
+
+  end
+end

data/lib/friendly_id/non_sluggable_instance_methods.rb

@@ -0,0 +1,33 @@
+module FriendlyId::NonSluggableInstanceMethods
+
+  attr :found_using_friendly_id
+
+  # Was the record found using one of its friendly ids?
+  def found_using_friendly_id?
+    @found_using_friendly_id
+  end
+
+  # Was the record found using its numeric id?
+  def found_using_numeric_id?
+    !@found_using_friendly_id
+  end
+  alias has_better_id? found_using_numeric_id?
+
+  # Returns the friendly_id.
+  def friendly_id
+    send friendly_id_options[:column]
+  end
+  alias best_id friendly_id
+
+  # Returns the friendly id, or if none is available, the numeric id.
+  def to_param
+    friendly_id.to_s || id.to_s
+  end
+
+  private
+
+  def found_using_friendly_id=(value) #:nodoc#
+    @found_using_friendly_id = value
+  end
+
+end

data/lib/friendly_id/shoulda_macros.rb

@@ -0,0 +1,36 @@
+module FriendlyId
+
+  # A Shoulda[http://www.thoughtbot.com/projects/shoulda/] macros for testing
+  # models using FriendlyId.
+  module ShouldaMacros
+
+    # Ensure that a model is using FriendlyId.
+    def self.should_have_friendly_id(column, options = {})
+
+      options.assert_valid_keys(:use_slug)
+      klass = self.model_class
+
+      should "have friendly id for #{method}" do
+        assert_respond_to klass, :friendly_id_options,
+          "#{klass} does not respond to friendly_id_options"
+        assert_equal column, klass.friendly_id_options[:method]
+      end
+
+      if options[:use_slug]
+        should "include/extend friendly_id's sluggable modules" do
+          assert klass.extended_by.include?(FriendlyId::SluggableClassMethods),
+            "#{klass} does not extend FriendlyId::SluggableClassMethods"
+          assert klass.include?(FriendlyId::SluggableInstanceMethods),
+            "#{klass} not include FriendlyId::SluggableInstanceMethods"
+        end
+      else
+        should "include/extend friendly_id's non-sluggable modules" do
+          assert klass.extended_by.include?(FriendlyId::NonSluggableClassMethods),
+            "#{klass} does not extend FriendlyId::NonSluggableClassMethods"
+          assert klass.include?(FriendlyId::NonSluggableInstanceMethods),
+            "#{klass} not include FriendlyId::NonSluggableInstanceMethods"
+        end
+      end
+    end
+  end
+end

data/lib/friendly_id/slug.rb

@@ -0,0 +1,89 @@
+# A Slug is a unique, human-friendly identifier for an ActiveRecord.
+class Slug < ActiveRecord::Base
+
+  belongs_to :sluggable, :polymorphic => true
+  before_save :check_for_blank_name, :set_sequence
+
+  class << self
+
+    # Sanitizes and dasherizes string to make it safe for URL's.
+    #
+    # Example:
+    #
+    #   slug.normalize('This... is an example!') # => "this-is-an-example"
+    #
+    # Note that Rails 2.2.x offers a parameterize method for this. It's not
+    # used here because it assumes you want to strip away accented characters,
+    # and this may not always be your desire.
+    #
+    # At the time of writing, it also handles several characters incorrectly,
+    # for instance replacing Icelandic's "thorn" character with "y" rather
+    # than "d." This might be pedantic, but I don't want to piss off the
+    # Vikings. The last time anyone pissed them off, they uleashed a wave of
+    # 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.
+        send(chars_func).
+        # For some reason Spanish ¡ and ¿ are not detected as non-word
+        # characters. Bug in Ruby?
+        normalize.gsub(/[\W|¡|¿]/u, ' ').
+        strip.
+        gsub(/\s+/u, '-').
+        gsub(/-\z/u, '').
+        downcase.
+        to_s
+    end
+
+    def parse(friendly_id)
+      name, sequence = friendly_id.split('--')
+      sequence ||= "1"
+      return name, sequence
+    end
+
+    # Remove diacritics (accents, umlauts, etc.) from the string.
+    def strip_diacritics(string)
+      require 'unicode'
+      Unicode::normalize_KD(string).unpack('U*').select { |cp|
+        cp < 0x300 || cp > 0x036F
+      }.pack('U*')
+    end
+
+    private
+
+    def chars_func
+      Rails.version =~ /2.2.[\d]*/ ? :mb_chars : :chars
+    rescue NoMethodError
+      :chars
+    end
+
+  end
+
+  # Whether or not this slug is the most recent of its owner's slugs.
+  def is_most_recent?
+    sluggable.slug == self
+  end
+
+  def to_friendly_id
+    sequence > 1 ? "#{name}--#{sequence}" : name
+  end
+
+  protected
+
+  # Raise a FriendlyId::SlugGenerationError if the slug name is blank.
+  def check_for_blank_name #:nodoc:#
+    if name.blank?
+      raise FriendlyId::SlugGenerationError.new("The slug text is blank.")
+    end
+  end
+
+  def set_sequence
+    return unless new_record?
+    last = Slug.find(:first, :conditions => { :name => name, :scope => scope,
+      :sluggable_type => sluggable_type}, :order => "sequence DESC",
+      :select => 'sequence')
+    self.sequence = last.sequence + 1 if last
+  end
+
+end