rdavila_friendly_id 2.2.6

data/Rakefile

@@ -0,0 +1,35 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'rake/clean'
+
+CLEAN	<< "pkg" << "docs" << "coverage"
+
+task :default => :test
+
+Rake::TestTask.new(:test) { |t| t.pattern = 'test/**/*_test.rb' }
+Rake::GemPackageTask.new(eval(File.read("friendly_id.gemspec"))) { |pkg| }
+Rake::RDocTask.new do |r|
+	r.rdoc_dir = "docs"
+	r.main = "README.rdoc"
+	r.rdoc_files.include "README.rdoc", "History.txt", "lib/**/*.rb"
+end
+
+begin
+  require "yard"
+  YARD::Rake::YardocTask.new do |t|
+    t.options = ["--output-dir=docs"]
+  end
+rescue LoadError
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |r|
+    r.test_files = FileList['test/*_test.rb']
+    r.verbose = true
+    r.rcov_opts << "--exclude gems/*"
+  end
+rescue LoadError
+end

data/extras/README.txt

@@ -0,0 +1,3 @@
+These templates are here to generate FriendlyId-enabled Rails apps for
+testing. They are for developers, they are not intended for generating
+"real" applications.

data/extras/template-gem.rb

@@ -0,0 +1,26 @@
+run "rm public/index.html"
+gem "friendly_id"
+gem "haml"
+gem "will_paginate"
+run "haml --rails ."
+generate "friendly_id"
+generate :haml_scaffold, "post title:string"
+route "map.root :controller => 'posts', :action => 'index'"
+rake "db:migrate"
+rake "db:fixtures:load"
+file 'app/models/post.rb',
+%q{class Post < ActiveRecord::Base
+  has_friendly_id :title, :use_slug => true
+end}
+file 'test/fixtures/slugs.yml',
+%q{
+one:
+  name: mystring
+  sequence: 1
+  sluggable: one (Post)
+
+two:
+  name: mystring
+  sequence: 2
+  sluggable: two (Post)
+}

data/extras/template-plugin.rb

@@ -0,0 +1,28 @@
+run "rm public/index.html"
+inside 'vendor/plugins' do
+  run "git clone ../../../../ friendly_id"
+end
+gem "haml"
+gem "will_paginate"
+run "haml --rails ."
+generate "friendly_id"
+generate :haml_scaffold, "post title:string"
+route "map.root :controller => 'posts', :action => 'index'"
+rake "db:migrate"
+rake "db:fixtures:load"
+file 'app/models/post.rb',
+%q{class Post < ActiveRecord::Base
+  has_friendly_id :title, :use_slug => true
+end}
+file 'test/fixtures/slugs.yml',
+%q{
+one:
+  name: mystring
+  sequence: 1
+  sluggable: one (Post)
+
+two:
+  name: mystring
+  sequence: 2
+  sluggable: two (Post)
+}

data/generators/friendly_id/friendly_id_generator.rb

@@ -0,0 +1,28 @@
+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')
+      end
+      unless options[:skip_tasks]
+        m.directory "lib/tasks"
+        m.file "/../../../lib/tasks/friendly_id.rake", "lib/tasks/friendly_id.rake"
+      end
+    end
+  end
+
+  protected
+
+  def add_options!(opt)
+    opt.separator ''
+    opt.separator 'Options:'
+    opt.on("--skip-migration", "Don't generate a migration for the slugs table") do |value|
+      options[:skip_migration] = value
+    end
+    opt.on("--skip-tasks", "Don't add friendly_id Rake tasks to lib/tasks") do |value|
+      options[:skip_tasks] = value
+    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], :name => "index_slugs_on_n_s_s_and_s", :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,12 @@
+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'
+        )
+        m.file "/../../../lib/tasks/friendly_id.rake", "lib/tasks/friendly_id.rake"
+      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,83 @@
+require "friendly_id/helpers"
+require "friendly_id/slug"
+require "friendly_id/sluggable_class_methods"
+require "friendly_id/sluggable_instance_methods"
+require "friendly_id/non_sluggable_class_methods"
+require "friendly_id/non_sluggable_instance_methods"
+
+begin
+  require 'ar-extensions'
+  require 'ar-extensions/adapters/mysql'
+  require 'ar-extensions/import/mysql'
+rescue LoadError
+  puts "Please install ar-extensions if you want to use friendly_id:make_slugs_faster or friendly_id:redo_slugs_faster tasks."
+end
+
+# FriendlyId is a comprehensive Ruby library for slugging and permalinks with
+# ActiveRecord.
+module FriendlyId
+
+  # Default options for has_friendly_id.
+  DEFAULT_OPTIONS = {
+    :max_length       => 255,
+    :reserved         => ["new", "index"],
+    :reserved_message => 'can not be "%s"'
+  }.freeze
+
+  # The names of all valid configuration options.
+  VALID_OPTIONS = (DEFAULT_OPTIONS.keys + [
+    :cache_column,
+    :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
+
+  # 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 nil. 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>:cache_column</tt> - Defaults to nil. Use this column as a cache for generating to_param (experimental) Note that if you use this option, any calls to +attr_accessible+ must be made BEFORE any calls to has_friendly_id in your class.
+  # * <tt>:strip_diacritics</tt> - Defaults to nil. If true, it will remove accents, umlauts, etc. from western characters.
+  # * <tt>:strip_non_ascii</tt> - Defaults to nil. If true, it will remove all non-ASCII 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 raise a FriendlyId::SlugGenerationError. 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'.
+  #
+  # You can also optionally pass a block if you want to use your own custom
+  # slug normalization routines rather than the default ones that come with
+  # friendly_id:
+  #
+  #   require "stringex"
+  #   class Post < ActiveRecord::Base
+  #     has_friendly_id :title, :use_slug => true do |text|
+  #       # Use stringex to generate the friendly_id rather than the baked-in methods
+  #       text.to_url
+  #     end
+  #   end
+  def has_friendly_id(method, options = {}, &block)
+    options.assert_valid_keys VALID_OPTIONS
+    options = DEFAULT_OPTIONS.merge(options).merge(:method => method)
+    write_inheritable_attribute :friendly_id_options, options
+    class_inheritable_accessor :friendly_id_options
+    class_inheritable_reader :slug_normalizer_block
+    write_inheritable_attribute(:slug_normalizer_block, block) if block_given?
+    if friendly_id_options[:use_slug]
+      extend SluggableClassMethods
+      include SluggableInstanceMethods
+    else
+      extend NonSluggableClassMethods
+      include NonSluggableInstanceMethods
+    end
+  end
+end
+
+class ActiveRecord::Base #:nodoc:#
+  extend FriendlyId #:nodoc:#
+end

data/lib/friendly_id/helpers.rb

@@ -0,0 +1,12 @@
+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,34 @@
+module FriendlyId::NonSluggableClassMethods
+
+  include FriendlyId::Helpers
+
+  protected
+
+  def find_one(id, options) #:nodoc:#
+    if id.respond_to?(:to_str) && result = send("find_by_#{ friendly_id_options[:method] }", id.to_str, options)
+      result.send(:found_using_friendly_id=, true)
+    else
+      result = super id, options
+    end
+    result
+  end
+
+  def find_some(ids_and_names, options) #:nodoc:#
+
+    names, ids = ids_and_names.partition {|id_or_name| id_or_name.respond_to?(:to_str) && id_or_name.to_str }
+    results = with_scope :find => options do
+      find :all, :conditions => ["#{quoted_table_name}.#{primary_key} IN (?) OR #{friendly_id_options[:method]} IN (?)",
+        ids, 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 names.include?(r.friendly_id)}
+
+    results
+
+  end
+end

data/lib/friendly_id/non_sluggable_instance_methods.rb

@@ -0,0 +1,45 @@
+module FriendlyId::NonSluggableInstanceMethods
+
+  def self.included(base)
+    base.validate :validate_friendly_id
+  end
+
+  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[:method]
+  end
+  alias best_id friendly_id
+
+  # Returns the friendly id, or if none is available, the numeric id.
+  def to_param
+    (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[:method],
+        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
+  end
+
+end

data/lib/friendly_id/slug.rb

@@ -0,0 +1,98 @@
+# 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
+
+
+  ASCII_APPROXIMATIONS = {
+    198 => "AE",
+    208 => "D",
+    216 => "O",
+    222 => "Th",
+    223 => "ss",
+    230 => "ae",
+    240 => "d",
+    248 => "o",
+    254 => "th"
+  }.freeze
+
+  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 the Unicode handling in ActiveSupport may fail to process some
+    # characters from Polish, Icelandic and other languages.
+    def normalize(slug_text)
+      return "" if slug_text.nil? || slug_text == ""
+      ActiveSupport::Multibyte.proxy_class.new(slug_text.to_s).normalize(:kc).
+        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. Borrowed
+    # from "The Ruby Way."
+    def strip_diacritics(string)
+      a = ActiveSupport::Multibyte.proxy_class.new(string || "").normalize(:kd)
+      a.unpack('U*').inject([]) { |a, u|
+        if ASCII_APPROXIMATIONS[u]
+          a += ASCII_APPROXIMATIONS[u].unpack('U*')
+        elsif (u < 0x300 || u > 0x036F)
+          a << u
+        end
+        a
+      }.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
+
+  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