friendly_id4 4.0.0.beta6 → 4.0.0.pre

data/friendly_id.gemspec

@@ -1,31 +0,0 @@
-# encoding: utf-8
-$:.push File.expand_path("../lib", __FILE__)
-
-require "friendly_id"
-
-Gem::Specification.new do |s|
-  s.name              = "friendly_id4"
-  s.version           = FriendlyId::VERSION
-  s.authors           = ["Norman Clarke"]
-  s.email             = ["norman@njclarke.com"]
-  s.homepage          = "http://norman.github.com/friendly_id"
-  s.summary           = "A comprehensive slugging and pretty-URL plugin."
-  s.rubyforge_project = "friendly_id"
-  s.files             = `git ls-files`.split("\n")
-  s.test_files        = `git ls-files -- {test}/*`.split("\n")
-  s.require_paths     = ["lib"]
-
-  s.add_development_dependency "activerecord", "~> 3.0"
-  s.add_development_dependency "sqlite3", "~> 1.3"
-  s.add_development_dependency "cutest", "~> 1.1.2"
-  s.add_development_dependency "ffaker"
-  s.add_development_dependency "maruku"
-  s.add_development_dependency "yard"
-  s.add_development_dependency "mocha"
-
-  s.description       = <<-EOM
-    FriendlyId is the "Swiss Army bulldozer" of slugging and permalink plugins
-    for Ruby on Rails. It allows you to create pretty URL's and work with
-    human-friendly strings as if they were numeric ids for ActiveRecord models.
-  EOM
-end

data/lib/friendly_id/base.rb

@@ -1,134 +0,0 @@
-module FriendlyId
-  # Class methods that will be added to model classes that extend {FriendlyId}.
-  module Base
-
-    # Configure FriendlyId's behavior in a model.
-    #
-    #   class Post < ActiveRecord::Base
-    #     extend FriendlyId
-    #     friendly_id :title, :use => :slugged
-    #   end
-    #
-    # When given the optional block, this method will yield the class's instance
-    # of {FriendlyId::Configuration} to the block before evaluating other
-    # arguments, so configuration values set in the block may be overwritten by
-    # the arguments. This order was chosen to allow passing the same proc to
-    # multiple models, while being able to override the values it sets. Here is
-    # a contrived example:
-    #
-    #   $friendly_id_config_proc = Proc.new do |config|
-    #     config.base = :name
-    #     config.use :slugged
-    #   end
-    #
-    #   class Foo < ActiveRecord::Base
-    #     extend FriendlyId
-    #     friendly_id &$friendly_id_config_proc
-    #   end
-    #
-    #   class Bar < ActiveRecord::Base
-    #     extend FriendlyId
-    #     friendly_id :title, &$friendly_id_config_proc
-    #   end
-    #
-    # However, it's usually better to use {FriendlyId.defaults} for this:
-    #
-    #   FriendlyId.defaults do |config|
-    #     config.base = :name
-    #     config.use :slugged
-    #   end
-    #
-    #   class Foo < ActiveRecord::Base
-    #     extend FriendlyId
-    #   end
-    #
-    #   class Bar < ActiveRecord::Base
-    #     extend FriendlyId
-    #     friendly_id :title
-    #   end
-    #
-    # In general you should use the block syntax either because of your personal
-    # aesthetic preference, or because you need to share some functionality
-    # between multiple models that can't be well encapsulated by
-    # {FriendlyId.defaults}.
-    #
-    # === Order Method Calls in a Block vs Ordering Options
-    #
-    # When calling this method without a block, you may set the hash options in
-    # any order.
-    #
-    # However, when using block-style invocation, be sure to call
-    # FriendlyId::Configuration's {FriendlyId::Configuration#use use} method
-    # *prior* to the associated configuration options, because it will include
-    # modules into your class, and these modules in turn may add required
-    # configuration options to the +@friendly_id_configuraton+'s class:
-    #
-    #   class Person < ActiveRecord::Base
-    #     friendly_id do |config|
-    #       # This will work
-    #       config.use :slugged
-    #       config.sequence_separator = ":"
-    #     end
-    #   end
-    #
-    #   class Person < ActiveRecord::Base
-    #     friendly_id do |config|
-    #       # This will fail
-    #       config.sequence_separator = ":"
-    #       config.use :slugged
-    #     end
-    #   end
-    #
-    # @option options [Symbol] :use The name of an addon to use. By default,
-    #   FriendlyId provides {FriendlyId::Slugged :slugged},
-    #   {FriendlyId::History :history}, {FriendlyId::Reserved :reserved}, and
-    #   {FriendlyId::Scoped :scoped}.
-    #
-    # @option options [Array] :reserved_words Available when using +:reserved+,
-    #   which is loaded by default. Sets an array of words banned for use as
-    #   the basis of a friendly_id. By default this includes "edit" and "new".
-    #
-    # @option options [Symbol] :scope Available when using +:scoped+.
-    #   Sets the relation or column used to scope generated friendly ids. This
-    #   option has no default value.
-    #
-    # @option options [Symbol] :sequence_separator Available when using +:slugged+.
-    #   Configures the sequence of characters used to separate a slug from a
-    #   sequence. Defaults to +--+.
-    #
-    # @option options [Symbol] :slug_column Available when using +:slugged+.
-    #   Configures the name of the column where FriendlyId will store the slug.
-    #   Defaults to +:slug+.
-    #
-    # @option options [Symbol] :slug_sequencer_class Available when using +:slugged+.
-    #   Sets the class used to generate unique slugs. You should not specify this
-    #   unless you're doing some extensive hacking on FriendlyId. Defaults to
-    #   {FriendlyId::SlugSequencer}.
-    #
-    # @yield Provides access to the model class's friendly_id_config, which
-    #   allows an alternate configuration syntax, and conditional configuration
-    #   logic.
-    #
-    # @yieldparam config The model class's {FriendlyId::Configuration friendly_id_config}.
-    def friendly_id(base = nil, options = {}, &block)
-      yield @friendly_id_config if block_given?
-      @friendly_id_config.use options.delete :use
-      @friendly_id_config.send :set, base ? options.merge(:base => base) : options
-      before_save do |record|
-        record.instance_eval {@current_friendly_id = friendly_id}
-      end
-      include Model
-    end
-
-    # Returns the model class's {FriendlyId::Configuration friendly_id_config}.
-    # @note In the case of Single Table Inheritance (STI), this method will
-    #   duplicate the parent class's FriendlyId::Configuration instance on first
-    #   access. If you're concerned about thread safety, then be sure to invoke
-    #   {#friendly_id} in your class for each model.
-    def friendly_id_config
-      @friendly_id_config or begin
-       @friendly_id_config = base_class.friendly_id_config.dup
-      end
-    end
-  end
-end

data/lib/friendly_id/configuration.rb

@@ -1,78 +0,0 @@
-module FriendlyId
-  # The configuration paramters passed to +friendly_id+ will be stored in
-  # this object.
-  class Configuration
-
-    # The base column or method used by FriendlyId as the basis of a friendly id
-    # or slug.
-    #
-    # For models that don't use FriendlyId::Slugged, the base is the column that
-    # is used as the FriendlyId directly. For models using FriendlyId::Slugged,
-    # the base is a column or method whose value is used as the basis of the
-    # slug.
-    #
-    # For example, if you have a model representing blog posts and that uses
-    # slugs, you likely will want to use the "title" attribute as the base, and
-    # FriendlyId will take care of transforming the human-readable title into
-    # something suitable for use in a URL.
-    #
-    # @param [Symbol] A symbol referencing a column or method in the model. This
-    #   value is usually set by passing it as the first argument to
-    #   {FriendlyId::Base#friendly_id friendly_id}:
-    #
-    # @example
-    #   class Book < ActiveRecord::Base
-    #     extend FriendlyId
-    #     friendly_id :name
-    #   end
-    attr_accessor :base
-
-    # The default configuration options.
-    attr_reader :defaults
-
-    # The model class that this configuration belongs to.
-    # @return ActiveRecord::Base
-    attr_reader :model_class
-
-    def initialize(model_class, values = nil)
-      @model_class = model_class
-      @defaults    = {}
-      set values
-    end
-
-    # Lets you specify the modules to use with FriendlyId.
-    #
-    # This method is invoked by {FriendlyId::Base#friendly_id friendly_id} when
-    # passing the +:use+ option, or when using {FriendlyId::Base#friendly_id
-    # friendly_id} with a block.
-    #
-    # @example
-    #   class Book < ActiveRecord::Base
-    #     extend FriendlyId
-    #     friendly_id :name, :use => :slugged
-    #   end
-    # @param [#to_s] *modules Arguments should be a symbols or strings that
-    #   correspond with the name of a module inside the FriendlyId namespace. By
-    #   default FriendlyId provides +:slugged+, +:history+ and +:scoped+.
-    def use(*modules)
-      modules.to_a.flatten.compact.map do |name|
-        model_class.send :include, FriendlyId.const_get(name.to_s.classify)
-      end
-    end
-
-    # The column that FriendlyId will use to find the record when querying by
-    # friendly id.
-    #
-    # This method is generally only used internally by FriendlyId.
-    # @return String
-    def query_field
-      base.to_s
-    end
-
-    private
-
-    def set(values)
-      values and values.each {|name, value| self.send "#{name}=", value}
-    end
-  end
-end

data/lib/friendly_id/finder_methods.rb

@@ -1,20 +0,0 @@
-module FriendlyId
-  # These methods will override the finder methods in ActiveRecord::Relation.
-  module FinderMethods
-
-    protected
-
-    # FriendlyId overrides this method to make it possible to use friendly id's
-    # identically to numeric ids in finders.
-    #
-    # @example
-    #  person = Person.find(123)
-    #  person = Person.find("joe")
-    #
-    # @see FriendlyId::ObjectUtils
-    def find_one(id)
-      return super if !@klass.respond_to?(:friendly_id) || id.unfriendly_id?
-      where(@klass.friendly_id_config.query_field => id).first or super
-    end
-  end
-end

data/lib/friendly_id/history.rb

@@ -1,64 +0,0 @@
-require "friendly_id/slug"
-
-module FriendlyId
-
-=begin
-FriendlyId can maintain a history of your record's older slugs, so if your
-record's friendly_id changes, your URL's won't break.
-
-    class Post < ActiveRecord::Base
-      extend FriendlyId
-      friendly_id :title, :use => :history
-    end
-
-    class PostsController < ApplicationController
-
-      before_filter :find_post
-
-      ...
-      def find_post
-        return unless params[:id]
-        @post = begin
-          Post.find params[:id]
-        rescue ActiveRecord::RecordNotFound
-          Post.find_by_friendly_id params[:id]
-        end
-        # If an old id or a numeric id was used to find the record, then
-        # the request path will not match the post_path, and we should do
-        # a 301 redirect that uses the current friendly_id
-        if request.path != post_path(@post)
-          return redirect_to @post, :status => :moved_permanently
-        end
-      end
-    end
-=end
-  module History
-
-    # Configures the model instance to use the History add-on.
-    def self.included(klass)
-      klass.instance_eval do
-        raise "FriendlyId::History is incompatibe with FriendlyId::Scoped" if self < Scoped
-        include Slugged unless self < Slugged
-        has_many :friendly_id_slugs, :as => :sluggable, :dependent => :destroy
-        before_save :build_friendly_id_slug, :if => lambda {|r| r.slug_sequencer.slug_changed?}
-        scope :with_friendly_id, lambda {|id| includes(:friendly_id_slugs).where("friendly_id_slugs.slug = ?", id)}
-        extend Finder
-      end
-    end
-
-    private
-
-    def build_friendly_id_slug
-      self.friendly_id_slugs.build :slug => friendly_id
-    end
-  end
-
-  # Adds a finder that explictly uses slugs from the slug table.
-  module Finder
-
-    # Search for a record in the slugs table using the specified slug.
-    def find_by_friendly_id(*args)
-      with_friendly_id(args.shift).first(*args)
-    end
-  end
-end

data/lib/friendly_id/migration.rb

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

data/lib/friendly_id/model.rb

@@ -1,22 +0,0 @@
-module FriendlyId
-  # Instance methods that will be added to all classes using FriendlyId.
-  module Model
-
-    attr_reader :current_friendly_id
-
-    # Convenience method for accessing the class method of the same name.
-    def friendly_id_config
-      self.class.friendly_id_config
-    end
-
-    # Get the instance's friendly_id.
-    def friendly_id
-      send friendly_id_config.query_field
-    end
-
-    # Either the friendly_id, or the numeric id cast to a string.
-    def to_param
-      (friendly_id.present? ? friendly_id : id).to_s
-    end
-  end
-end

data/lib/friendly_id/object_utils.rb

@@ -1,40 +0,0 @@
-module FriendlyId
-  # Utility methods for determining whether any object is a friendly id.
-  #
-  # Monkey-patching Object is a somewhat extreme measure not to be taken lightly
-  # by libraries, but in this case I decided to do it because to me, it feels
-  # cleaner than adding a module method to {FriendlyId}. I've given the methods
-  # names that unambigously refer to the library of their origin, which should
-  # be sufficient to avoid conflicts with other libraries.
-  module ObjectUtils
-
-    # True is the id is definitely friendly, false if definitely unfriendly,
-    # else nil.
-    #
-    # An object is considired "definitely unfriendly" if its class is or
-    # inherits from Numeric, Symbol or ActiveRecord::Base.
-    #
-    # An object is considered "definitely friendly" if it responds to +to_i+,
-    # and its value when cast to an integer and then back to a string is
-    # different from its value when merely cast to a string:
-    #
-    #   123.friendly_id?       #=> false
-    #   "123".friendly_id?     #=> nil
-    #   "abc123".friendly_id?  #=> true
-    def friendly_id?
-      if [Numeric, Symbol, ActiveRecord::Base].detect {|klass| self.class < klass}
-        false
-      elsif respond_to?(:to_i) && to_i.to_s != to_s
-        true
-      end
-    end
-
-    # True if the id is definitely unfriendly, false if definitely friendly,
-    # else nil.
-    def unfriendly_id?
-      val = friendly_id? ; !val unless val.nil?
-    end
-  end
-end
-
-Object.send :include, FriendlyId::ObjectUtils

data/lib/friendly_id/reserved.rb

@@ -1,46 +0,0 @@
-module FriendlyId
-
-=begin
-This module adds the ability to exlude a list of words from use as
-FriendlyId slugs.
-
-By default, FriendlyId reserves the words "new" and "edit" when this module
-is included. You can configure this globally by using {FriendlyId.defaults FriendlyId.defaults}:
-
-  FriendlyId.defaults do |config|
-    config.use :reserved
-    # Reserve words for English and Spanish URLs
-    config.reserved_words = %w(new edit nueva nuevo editar)
-  end
-=end
-  module Reserved
-
-    # When included, this module adds configuration options to the model class's
-    # friendly_id_config.
-    def self.included(model_class)
-      model_class.class_eval do
-        friendly_id_config.class.send :include, Reserved::Configuration
-        friendly_id_config.defaults[:reserved_words] ||= ["new", "edit"]
-      end
-    end
-
-    # This module adds the +:reserved_words+ configuration option to
-    # {FriendlyId::Configuration FriendlyId::Configuration}.
-    module Configuration
-      attr_writer :reserved_words
-
-      # Overrides {FriendlyId::Configuration#base} to add a validation to the
-      # model class.
-      def base=(base)
-        super
-        reserved_words = model_class.friendly_id_config.reserved_words
-        model_class.validates_exclusion_of base, :in => reserved_words
-      end
-
-      # An array of words forbidden as slugs.
-      def reserved_words
-        @reserved_words ||= @defaults[:reserved_words]
-      end
-    end
-  end
-end