friendly_id 5.4.2 → 5.5.0

data/lib/friendly_id/history.rb

@@ -1,59 +1,55 @@
 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
+  #
+  ## 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
   module History
-
     module Configuration
       def dependent_value
         dependent.nil? ? :destroy : dependent
@@ -72,10 +68,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 +92,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 +108,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 +120,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 +135,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,38 @@
 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
+  #
+  ## 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
+  #
   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

data/lib/friendly_id/scoped.rb

@@ -1,108 +1,104 @@
 require "friendly_id/slugged"
 
 module FriendlyId
-
-=begin
-
-## Unique Slugs by Scope
-
-The {FriendlyId::Scoped} module allows FriendlyId to generate unique slugs
-within a scope.
-
-This allows, for example, two restaurants in different cities to have the slug
-`joes-diner`:
-
-    class Restaurant < ActiveRecord::Base
-      extend FriendlyId
-      belongs_to :city
-      friendly_id :name, :use => :scoped, :scope => :city
-    end
-
-    class City < ActiveRecord::Base
-      extend FriendlyId
-      has_many :restaurants
-      friendly_id :name, :use => :slugged
-    end
-
-    City.friendly.find("seattle").restaurants.friendly.find("joes-diner")
-    City.friendly.find("chicago").restaurants.friendly.find("joes-diner")
-
-Without :scoped in this case, one of the restaurants would have the slug
-`joes-diner` and the other would have `joes-diner-f9f3789a-daec-4156-af1d-fab81aa16ee5`.
-
-The value for the `:scope` option can be the name of a `belongs_to` relation, or
-a column.
-
-Additionally, the `:scope` option can receive an array of scope values:
-
-    class Cuisine < ActiveRecord::Base
-      extend FriendlyId
-      has_many :restaurants
-      friendly_id :name, :use => :slugged
-    end
-
-    class City < ActiveRecord::Base
-      extend FriendlyId
-      has_many :restaurants
-      friendly_id :name, :use => :slugged
-    end
-
-    class Restaurant < ActiveRecord::Base
-      extend FriendlyId
-      belongs_to :city
-      friendly_id :name, :use => :scoped, :scope => [:city, :cuisine]
-    end
-
-All supplied values will be used to determine scope.
-
-### Finding Records by Friendly ID
-
-If you are using scopes your friendly ids may not be unique, so a simple find
-like:
-
-    Restaurant.friendly.find("joes-diner")
-
-may return the wrong record. In these cases it's best to query through the
-relation:
-
-    @city.restaurants.friendly.find("joes-diner")
-
-Alternatively, you could pass the scope value as a query parameter:
-
-    Restaurant.where(:city_id => @city.id).friendly.find("joes-diner")
-
-
-### Finding All Records That Match a Scoped ID
-
-Query the slug column directly:
-
-    Restaurant.where(:slug => "joes-diner")
-
-### Routes for Scoped Models
-
-Recall that FriendlyId is a database-centric library, and does not set up any
-routes for scoped models. You must do this yourself in your application. Here's
-an example of one way to set this up:
-
-    # in routes.rb
-    resources :cities do
-      resources :restaurants
-    end
-
-    # in views
-    <%= link_to 'Show', [@city, @restaurant] %>
-
-    # in controllers
-    @city = City.friendly.find(params[:city_id])
-    @restaurant = @city.restaurants.friendly.find(params[:id])
-
-    # URLs:
-    http://example.org/cities/seattle/restaurants/joes-diner
-    http://example.org/cities/chicago/restaurants/joes-diner
-
-=end
+  #
+  ## Unique Slugs by Scope
+  #
+  # The {FriendlyId::Scoped} module allows FriendlyId to generate unique slugs
+  # within a scope.
+  #
+  # This allows, for example, two restaurants in different cities to have the slug
+  # `joes-diner`:
+  #
+  #     class Restaurant < ActiveRecord::Base
+  #       extend FriendlyId
+  #       belongs_to :city
+  #       friendly_id :name, :use => :scoped, :scope => :city
+  #     end
+  #
+  #     class City < ActiveRecord::Base
+  #       extend FriendlyId
+  #       has_many :restaurants
+  #       friendly_id :name, :use => :slugged
+  #     end
+  #
+  #     City.friendly.find("seattle").restaurants.friendly.find("joes-diner")
+  #     City.friendly.find("chicago").restaurants.friendly.find("joes-diner")
+  #
+  # Without :scoped in this case, one of the restaurants would have the slug
+  # `joes-diner` and the other would have `joes-diner-f9f3789a-daec-4156-af1d-fab81aa16ee5`.
+  #
+  # The value for the `:scope` option can be the name of a `belongs_to` relation, or
+  # a column.
+  #
+  # Additionally, the `:scope` option can receive an array of scope values:
+  #
+  #     class Cuisine < ActiveRecord::Base
+  #       extend FriendlyId
+  #       has_many :restaurants
+  #       friendly_id :name, :use => :slugged
+  #     end
+  #
+  #     class City < ActiveRecord::Base
+  #       extend FriendlyId
+  #       has_many :restaurants
+  #       friendly_id :name, :use => :slugged
+  #     end
+  #
+  #     class Restaurant < ActiveRecord::Base
+  #       extend FriendlyId
+  #       belongs_to :city
+  #       friendly_id :name, :use => :scoped, :scope => [:city, :cuisine]
+  #     end
+  #
+  # All supplied values will be used to determine scope.
+  #
+  ### Finding Records by Friendly ID
+  #
+  # If you are using scopes your friendly ids may not be unique, so a simple find
+  # like:
+  #
+  #     Restaurant.friendly.find("joes-diner")
+  #
+  # may return the wrong record. In these cases it's best to query through the
+  # relation:
+  #
+  #     @city.restaurants.friendly.find("joes-diner")
+  #
+  # Alternatively, you could pass the scope value as a query parameter:
+  #
+  #     Restaurant.where(:city_id => @city.id).friendly.find("joes-diner")
+  #
+  #
+  ### Finding All Records That Match a Scoped ID
+  #
+  # Query the slug column directly:
+  #
+  #     Restaurant.where(:slug => "joes-diner")
+  #
+  ### Routes for Scoped Models
+  #
+  # Recall that FriendlyId is a database-centric library, and does not set up any
+  # routes for scoped models. You must do this yourself in your application. Here's
+  # an example of one way to set this up:
+  #
+  #     # in routes.rb
+  #     resources :cities do
+  #       resources :restaurants
+  #     end
+  #
+  #     # in views
+  #     <%= link_to 'Show', [@city, @restaurant] %>
+  #
+  #     # in controllers
+  #     @city = City.friendly.find(params[:city_id])
+  #     @restaurant = @city.restaurants.friendly.find(params[:id])
+  #
+  #     # URLs:
+  #     http://example.org/cities/seattle/restaurants/joes-diner
+  #     http://example.org/cities/chicago/restaurants/joes-diner
+  #
   module Scoped
-
     # FriendlyId::Config.use will invoke this method when present, to allow
     # loading dependent modules prior to overriding them when necessary.
     def self.setup(model_class)
@@ -146,7 +142,6 @@ an example of one way to set this up:
     # This module adds the `:scope` configuration option to
     # {FriendlyId::Configuration FriendlyId::Configuration}.
     module Configuration
-
       # Gets the scope value.
       #
       # When setting this value, the argument should be a symbol referencing a

data/lib/friendly_id/sequentially_slugged/calculator.rb

@@ -0,0 +1,69 @@
+module FriendlyId
+  module SequentiallySlugged
+    class Calculator
+      attr_accessor :scope, :slug, :slug_column, :sequence_separator
+
+      def initialize(scope, slug, slug_column, sequence_separator, base_class)
+        @scope = scope
+        @slug = slug
+        table_name = scope.connection.quote_table_name(base_class.arel_table.name)
+        @slug_column = "#{table_name}.#{scope.connection.quote_column_name(slug_column)}"
+        @sequence_separator = sequence_separator
+      end
+
+      def next_slug
+        slug + sequence_separator + next_sequence_number.to_s
+      end
+
+      private
+
+      def conflict_query
+        base = "#{slug_column} = ? OR #{slug_column} LIKE ?"
+        # Awful hack for SQLite3, which does not pick up '\' as the escape character
+        # without this.
+        base << " ESCAPE '\\'" if /sqlite/i.match?(scope.connection.adapter_name)
+        base
+      end
+
+      def next_sequence_number
+        last_sequence_number ? last_sequence_number + 1 : 2
+      end
+
+      def last_sequence_number
+        # Reject slug_conflicts that doesn't come from the first_candidate
+        # Map all sequence numbers and take the maximum
+        slug_conflicts
+          .reject { |slug_conflict| !regexp.match(slug_conflict) }
+          .map { |slug_conflict| regexp.match(slug_conflict)[1].to_i }
+          .max
+      end
+
+      # Return the unnumbered (shortest) slug first, followed by the numbered ones
+      # in ascending order.
+      def ordering_query
+        "#{sql_length}(#{slug_column}) ASC, #{slug_column} ASC"
+      end
+
+      def regexp
+        /#{slug}#{sequence_separator}(\d+)\z/
+      end
+
+      def sequential_slug_matcher
+        # Underscores (matching a single character) and percent signs (matching
+        # any number of characters) need to be escaped. While this looks like
+        # an excessive number of backslashes, it is correct.
+        "#{slug}#{sequence_separator}".gsub(/[_%]/, '\\\\\&') + "%"
+      end
+
+      def slug_conflicts
+        scope
+          .where(conflict_query, slug, sequential_slug_matcher)
+          .order(Arel.sql(ordering_query)).pluck(Arel.sql(slug_column))
+      end
+
+      def sql_length
+        /sqlserver/i.match?(scope.connection.adapter_name) ? "LEN" : "LENGTH"
+      end
+    end
+  end
+end