friendly_id 5.4.0 → 5.5.1

data/lib/friendly_id/finders.rb

@@ -1,73 +1,73 @@
 module FriendlyId
-=begin
-## Performing Finds with FriendlyId
-
-FriendlyId offers enhanced finders which will search for your record by
-friendly id, and fall back to the numeric id if necessary. This makes it easy
-to add FriendlyId to an existing application with minimal code modification.
-
-By default, these methods are available only on the `friendly` scope:
-
-    Restaurant.friendly.find('plaza-diner') #=> works
-    Restaurant.friendly.find(23)            #=> also works
-    Restaurant.find(23)                     #=> still works
-    Restaurant.find('plaza-diner')          #=> will not work
-
-### Restoring FriendlyId 4.0-style finders
-
-Prior to version 5.0, FriendlyId overrode the default finder methods to perform
-friendly finds all the time. This required modifying parts of Rails that did
-not have a public API, which was harder to maintain and at times caused
-compatiblity problems. In 5.0 we decided to change the library's defaults and add
-the friendly finder methods only to the `friendly` scope in order to boost
-compatiblity. However, you can still opt-in to original functionality very
-easily by using the `:finders` addon:
-
-    class Restaurant < ActiveRecord::Base
-      extend FriendlyId
-
-      scope :active, -> {where(:active => true)}
-
-      friendly_id :name, :use => [:slugged, :finders]
-    end
-
-    Restaurant.friendly.find('plaza-diner') #=> works
-    Restaurant.find('plaza-diner')          #=> now also works
-    Restaurant.active.find('plaza-diner')   #=> now also works
-
-### Updating your application to use FriendlyId's finders
-
-Unless you've chosen to use the `:finders` addon, be sure to modify the finders
-in your controllers to use the `friendly` scope. For example:
-
-    # before
-    def set_restaurant
-      @restaurant = Restaurant.find(params[:id])
-    end
-
-    # after
-    def set_restaurant
-      @restaurant = Restaurant.friendly.find(params[:id])
-    end
-
-#### Active Admin
-
-Unless you use the `:finders` addon, you should modify your admin controllers
-for models that use FriendlyId with something similar to the following:
-
-    controller do
-      def find_resource
-        scoped_collection.friendly.find(params[:id])
-      end
-    end
-
-=end
+  # @guide begin
+  #
+  # ## Performing Finds with FriendlyId
+  #
+  # FriendlyId offers enhanced finders which will search for your record by
+  # friendly id, and fall back to the numeric id if necessary. This makes it easy
+  # to add FriendlyId to an existing application with minimal code modification.
+  #
+  # By default, these methods are available only on the `friendly` scope:
+  #
+  #     Restaurant.friendly.find('plaza-diner') #=> works
+  #     Restaurant.friendly.find(23)            #=> also works
+  #     Restaurant.find(23)                     #=> still works
+  #     Restaurant.find('plaza-diner')          #=> will not work
+  #
+  # ### Restoring FriendlyId 4.0-style finders
+  #
+  # Prior to version 5.0, FriendlyId overrode the default finder methods to perform
+  # friendly finds all the time. This required modifying parts of Rails that did
+  # not have a public API, which was harder to maintain and at times caused
+  # compatiblity problems. In 5.0 we decided to change the library's defaults and add
+  # the friendly finder methods only to the `friendly` scope in order to boost
+  # compatiblity. However, you can still opt-in to original functionality very
+  # easily by using the `:finders` addon:
+  #
+  #     class Restaurant < ActiveRecord::Base
+  #       extend FriendlyId
+  #
+  #       scope :active, -> {where(:active => true)}
+  #
+  #       friendly_id :name, :use => [:slugged, :finders]
+  #     end
+  #
+  #     Restaurant.friendly.find('plaza-diner') #=> works
+  #     Restaurant.find('plaza-diner')          #=> now also works
+  #     Restaurant.active.find('plaza-diner')   #=> now also works
+  #
+  # ### Updating your application to use FriendlyId's finders
+  #
+  # Unless you've chosen to use the `:finders` addon, be sure to modify the finders
+  # in your controllers to use the `friendly` scope. For example:
+  #
+  #     # before
+  #     def set_restaurant
+  #       @restaurant = Restaurant.find(params[:id])
+  #     end
+  #
+  #     # after
+  #     def set_restaurant
+  #       @restaurant = Restaurant.friendly.find(params[:id])
+  #     end
+  #
+  # #### Active Admin
+  #
+  # Unless you use the `:finders` addon, you should modify your admin controllers
+  # for models that use FriendlyId with something similar to the following:
+  #
+  #     controller do
+  #       def find_resource
+  #         scoped_collection.friendly.find(params[:id])
+  #       end
+  #     end
+  #
+  # @guide end
   module Finders
-
     module ClassMethods
       if (ActiveRecord::VERSION::MAJOR == 4) && (ActiveRecord::VERSION::MINOR == 0)
         def relation_delegate_class(klass)
-          relation_class_name = :"#{klass.to_s.gsub('::', '_')}_#{self.to_s.gsub('::', '_')}"
+          relation_class_name = :"#{klass.to_s.gsub("::", "_")}_#{to_s.gsub("::", "_")}"
           klass.const_get(relation_class_name)
         end
       end
@@ -82,7 +82,7 @@ for models that use FriendlyId with something similar to the following:
       end
 
       # Support for friendly finds on associations for Rails 4.0.1 and above.
-      if ::ActiveRecord.const_defined?('AssociationRelation')
+      if ::ActiveRecord.const_defined?("AssociationRelation")
         model_class.extend(ClassMethods)
         association_relation_delegate_class = model_class.relation_delegate_class(::ActiveRecord::AssociationRelation)
         association_relation_delegate_class.send(:include, model_class.friendly_id_config.finder_methods)

data/lib/friendly_id/history.rb

@@ -1,59 +1,58 @@
 module FriendlyId
-
-=begin
-
-## History: Avoiding 404's When Slugs Change
-
-FriendlyId's {FriendlyId::History History} module adds the ability to store a
-log of a model's slugs, so that when its friendly id changes, it's still
-possible to perform finds by the old id.
-
-The primary use case for this is avoiding broken URLs.
-
-### Setup
-
-In order to use this module, you must add a table to your database schema to
-store the slug records. FriendlyId provides a generator for this purpose:
-
-    rails generate friendly_id
-    rake db:migrate
-
-This will add a table named `friendly_id_slugs`, used by the {FriendlyId::Slug}
-model.
-
-### Considerations
-
-Because recording slug history requires creating additional database records,
-this module has an impact on the performance of the associated model's `create`
-method.
-
-### Example
-
-    class Post < ActiveRecord::Base
-      extend FriendlyId
-      friendly_id :title, :use => :history
-    end
-
-    class PostsController < ApplicationController
-
-      before_filter :find_post
-
-      ...
-
-      def find_post
-        @post = Post.friendly.find params[:id]
-
-        # If an old id or a numeric id was used to find the record, then
-        # the request slug will not match the current slug, and we should do
-        # a 301 redirect to the new path
-        if params[:id] != @post.slug
-          return redirect_to @post, :status => :moved_permanently
-        end
-      end
-    end
-=end
+  # @guide begin
+  #
+  # ## History: Avoiding 404's When Slugs Change
+  #
+  # FriendlyId's {FriendlyId::History History} module adds the ability to store a
+  # log of a model's slugs, so that when its friendly id changes, it's still
+  # possible to perform finds by the old id.
+  #
+  # The primary use case for this is avoiding broken URLs.
+  #
+  # ### Setup
+  #
+  # In order to use this module, you must add a table to your database schema to
+  # store the slug records. FriendlyId provides a generator for this purpose:
+  #
+  #     rails generate friendly_id
+  #     rake db:migrate
+  #
+  # This will add a table named `friendly_id_slugs`, used by the {FriendlyId::Slug}
+  # model.
+  #
+  # ### Considerations
+  #
+  # Because recording slug history requires creating additional database records,
+  # this module has an impact on the performance of the associated model's `create`
+  # method.
+  #
+  # ### Example
+  #
+  #     class Post < ActiveRecord::Base
+  #       extend FriendlyId
+  #       friendly_id :title, :use => :history
+  #     end
+  #
+  #     class PostsController < ApplicationController
+  #
+  #       before_filter :find_post
+  #
+  #       ...
+  #
+  #       def find_post
+  #         @post = Post.friendly.find params[:id]
+  #
+  #         # If an old id or a numeric id was used to find the record, then
+  #         # the request slug will not match the current slug, and we should do
+  #         # a 301 redirect to the new path
+  #         if params[:id] != @post.slug
+  #           return redirect_to @post, :status => :moved_permanently
+  #         end
+  #       end
+  #     end
+  #
+  # @guide end
   module History
-
     module Configuration
       def dependent_value
         dependent.nil? ? :destroy : dependent
@@ -72,10 +71,10 @@ method.
     # Configures the model instance to use the History add-on.
     def self.included(model_class)
       model_class.class_eval do
-        has_many :slugs, -> {order(id: :desc)}, **{
-          :as         => :sluggable,
-          :dependent  => @friendly_id_config.dependent_value,
-          :class_name => Slug.to_s
+        has_many :slugs, -> { order(id: :desc) }, **{
+          as: :sluggable,
+          dependent: @friendly_id_config.dependent_value,
+          class_name: Slug.to_s
         }
 
         after_save :create_slug
@@ -96,7 +95,7 @@ method.
       end
 
       def slug_table_record(id)
-        select(quoted_table_name + '.*').joins(:slugs).where(slug_history_clause(id)).order(Slug.arel_table[:id].desc).first
+        select(quoted_table_name + ".*").joins(:slugs).where(slug_history_clause(id)).order(Slug.arel_table[:id].desc).first
       end
 
       def slug_history_clause(id)
@@ -112,7 +111,7 @@ method.
     def scope_for_slug_generator
       relation = super.joins(:slugs)
       unless new_record?
-        relation = relation.merge(Slug.where('sluggable_id <> ?', id))
+        relation = relation.merge(Slug.where("sluggable_id <> ?", id))
       end
       if friendly_id_config.uses?(:scoped)
         relation = relation.where(Slug.arel_table[:scope].eq(serialized_scope))
@@ -124,9 +123,9 @@ method.
       return unless friendly_id
       return if history_is_up_to_date?
       # Allow reversion back to a previously used slug
-      relation = slugs.where(:slug => friendly_id)
+      relation = slugs.where(slug: friendly_id)
       if friendly_id_config.uses?(:scoped)
-        relation = relation.where(:scope => serialized_scope)
+        relation = relation.where(scope: serialized_scope)
       end
       relation.destroy_all unless relation.empty?
       slugs.create! do |record|
@@ -139,7 +138,7 @@ method.
       latest_history = slugs.first
       check = latest_history.try(:slug) == friendly_id
       if friendly_id_config.uses?(:scoped)
-        check = check && latest_history.scope == serialized_scope
+        check &&= latest_history.scope == serialized_scope
       end
       check
     end

data/lib/friendly_id/initializer.rb

@@ -16,9 +16,9 @@ FriendlyId.defaults do |config|
   # undesirable to allow as slugs. Edit this list as needed for your app.
   config.use :reserved
 
-  config.reserved_words = %w(new edit index session login logout users admin
-    stylesheets assets javascripts images)
-    
+  config.reserved_words = %w[new edit index session login logout users admin
+    stylesheets assets javascripts images]
+
   # This adds an option to treat reserved words as conflicts rather than exceptions.
   # When there is no good candidate, a UUID will be appended, matching the existing
   # conflict behavior.
@@ -37,7 +37,7 @@ FriendlyId.defaults do |config|
   #    MyModel.find('foo')
   #
   # This is significantly more convenient but may not be appropriate for
-  # all applications, so you must explicity opt-in to this behavior. You can
+  # all applications, so you must explicitly opt-in to this behavior. You can
   # always also configure it on a per-model basis if you prefer.
   #
   # Something else to consider is that using the :finders addon boosts

data/lib/friendly_id/migration.rb

@@ -8,14 +8,14 @@ MIGRATION_CLASS =
 class CreateFriendlyIdSlugs < MIGRATION_CLASS
   def change
     create_table :friendly_id_slugs do |t|
-      t.string   :slug,           :null => false
-      t.integer  :sluggable_id,   :null => false
-      t.string   :sluggable_type, :limit => 50
-      t.string   :scope
+      t.string :slug, null: false
+      t.integer :sluggable_id, null: false
+      t.string :sluggable_type, limit: 50
+      t.string :scope
       t.datetime :created_at
     end
     add_index :friendly_id_slugs, [:sluggable_type, :sluggable_id]
-    add_index :friendly_id_slugs, [:slug, :sluggable_type], length: { slug: 140, sluggable_type: 50 }
-    add_index :friendly_id_slugs, [:slug, :sluggable_type, :scope], length: { slug: 70, sluggable_type: 50, scope: 70 }, unique: true
+    add_index :friendly_id_slugs, [:slug, :sluggable_type], length: {slug: 140, sluggable_type: 50}
+    add_index :friendly_id_slugs, [:slug, :sluggable_type, :scope], length: {slug: 70, sluggable_type: 50, scope: 70}, unique: true
   end
 end

data/lib/friendly_id/object_utils.rb

@@ -19,7 +19,6 @@ module FriendlyId
   # names that unambigously refer to the library of their origin, which should
   # be sufficient to avoid conflicts with other libraries.
   module ObjectUtils
-
     # True if the id is definitely friendly, false if definitely unfriendly,
     # else nil.
     #
@@ -45,7 +44,8 @@ module FriendlyId
     # True if the id is definitely unfriendly, false if definitely friendly,
     # else nil.
     def unfriendly_id?
-      val = friendly_id? ; !val unless val.nil?
+      val = friendly_id?
+      !val unless val.nil?
     end
   end
 

data/lib/friendly_id/reserved.rb

@@ -1,42 +1,40 @@
 module FriendlyId
-
-=begin
-
-## Reserved Words
-
-The {FriendlyId::Reserved Reserved} module adds the ability to exclude a list of
-words from use as FriendlyId slugs.
-
-With Ruby on Rails, FriendlyId's generator generates an initializer that
-reserves some words such as "new" and "edit" using {FriendlyId.defaults
-FriendlyId.defaults}.
-
-Note that the error messages for fields will appear on the field
-`:friendly_id`. If you are using Rails's scaffolded form errors display, then
-it will have no field to highlight. If you'd like to change this so that
-scaffolding works as expected, one way to accomplish this is to move the error
-message to a different field. For example:
-
-    class Person < ActiveRecord::Base
-      extend FriendlyId
-      friendly_id :name, use: :slugged
-
-      after_validation :move_friendly_id_error_to_name
-
-      def move_friendly_id_error_to_name
-        errors.add :name, *errors.delete(:friendly_id) if errors[:friendly_id].present?
-      end
-    end
-
-=end
+  # @guide begin
+  #
+  # ## Reserved Words
+  #
+  # The {FriendlyId::Reserved Reserved} module adds the ability to exclude a list of
+  # words from use as FriendlyId slugs.
+  #
+  # With Ruby on Rails, FriendlyId's generator generates an initializer that
+  # reserves some words such as "new" and "edit" using {FriendlyId.defaults
+  # FriendlyId.defaults}.
+  #
+  # Note that the error messages for fields will appear on the field
+  # `:friendly_id`. If you are using Rails's scaffolded form errors display, then
+  # it will have no field to highlight. If you'd like to change this so that
+  # scaffolding works as expected, one way to accomplish this is to move the error
+  # message to a different field. For example:
+  #
+  #     class Person < ActiveRecord::Base
+  #       extend FriendlyId
+  #       friendly_id :name, use: :slugged
+  #
+  #       after_validation :move_friendly_id_error_to_name
+  #
+  #       def move_friendly_id_error_to_name
+  #         errors.add :name, *errors.delete(:friendly_id) if errors[:friendly_id].present?
+  #       end
+  #     end
+  #
+  # @guide 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
-        validates_exclusion_of :friendly_id, :in => ->(_) {
+        validates_exclusion_of :friendly_id, in: ->(_) {
           friendly_id_config.reserved_words || []
         }
       end