friendly_id 5.0.0.alpha.1 → 5.0.0.beta1

data/lib/friendly_id/object_utils.rb

@@ -19,13 +19,13 @@ module FriendlyId
     # 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
-    #   :id.friendly_id?                  #=> false
-    #   {:name => 'joe'}.friendly_id?     #=> false
-    #   ['name = ?', 'joe'].friendly_id?  #=> false
-    #   nil.friendly_id?                  #=> false
-    #   "123".friendly_id?                #=> nil
-    #   "abc123".friendly_id?             #=> true
+    #     123.friendly_id?                  #=> false
+    #     :id.friendly_id?                  #=> false
+    #     {:name => 'joe'}.friendly_id?     #=> false
+    #     ['name = ?', 'joe'].friendly_id?  #=> false
+    #     nil.friendly_id?                  #=> false
+    #     "123".friendly_id?                #=> nil
+    #     "abc123".friendly_id?             #=> true
     def friendly_id?
       # Considered unfriendly if this is an instance of an unfriendly class or
       # one of its descendants.

data/lib/friendly_id/reserved.rb

@@ -2,7 +2,7 @@ module FriendlyId
 
 =begin
 
-== Reserved Words
+## Reserved Words
 
 The {FriendlyId::Reserved Reserved} module adds the ability to exlude a list of
 words from use as FriendlyId slugs.
@@ -17,7 +17,7 @@ FriendlyId.defaults}:
     config.reserved_words = %w(new edit nueva nuevo editar)
   end
 
-Note that the error message will appear on the field +:friendly_id+. If you are
+Note that the error message 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.
@@ -46,7 +46,7 @@ For example:
       end
     end
 
-    # This module adds the +:reserved_words+ configuration option to
+    # This module adds the `:reserved_words` configuration option to
     # {FriendlyId::Configuration FriendlyId::Configuration}.
     module Configuration
       attr_writer :reserved_words

data/lib/friendly_id/scoped.rb

@@ -4,13 +4,13 @@ module FriendlyId
 
 =begin
 
-== Unique Slugs by Scope
+## 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+:
+`joes-diner`:
 
     class Restaurant < ActiveRecord::Base
       extend FriendlyId
@@ -24,16 +24,16 @@ This allows, for example, two restaurants in different cities to have the slug
       friendly_id :name, :use => :slugged
     end
 
-    City.find("seattle").restaurants.find("joes-diner")
-    City.find("chicago").restaurants.find("joes-diner")
+    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+.
+`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
+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:
+Additionally, the `:scope` option can receive an array of scope values:
 
     class Cuisine < ActiveRecord::Base
       extend FriendlyId
@@ -55,30 +55,30 @@ Additionally, the +:scope+ option can receive an array of scope values:
 
 All supplied values will be used to determine scope.
 
-=== Finding Records by Friendly ID
+### Finding Records by Friendly ID
 
 If you are using scopes your friendly ids may not be unique, so a simple find
 like
 
-    Restaurant.find("joes-diner")
+    Restaurant.friendly.find("joes-diner")
 
 may return the wrong record. In these cases it's best to query through the
 relation:
 
-    @city.restaurants.find("joes-diner")
+    @city.restaurants.friendly.find("joes-diner")
 
 Alternatively, you could pass the scope value as a query parameter:
 
-    Restaurant.find("joes-diner").where(:city_id => @city.id)
+    Restaurant.friendly.find("joes-diner").where(:city_id => @city.id)
 
 
-=== Finding All Records That Match a Scoped ID
+### Finding All Records That Match a Scoped ID
 
 Query the slug column directly:
 
-    Restaurant.find_all_by_slug("joes-diner")
+    Restaurant.where(:slug => "joes-diner")
 
-=== Routes for Scoped Models
+### 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
@@ -93,8 +93,8 @@ an example of one way to set this up:
     <%= link_to 'Show', [@city, @restaurant] %>
 
     # in controllers
-    @city = City.find(params[:city_id])
-    @restaurant = @city.restaurants.find(params[:id])
+    @city = City.friendly.find(params[:city_id])
+    @restaurant = @city.restaurants.friendly.find(params[:id])
 
     # URLs:
     http://example.org/cities/seattle/restaurants/joes-diner
@@ -130,21 +130,21 @@ an example of one way to set this up:
     end
     private :slug_generator
 
-    # This module adds the +:scope+ configuration option to
+    # 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
-      # +belongs_to+ relation, or a column.
+      # `belongs_to` relation, or a column.
       #
       # @return Symbol The scope value
       attr_accessor :scope
 
       # Gets the scope columns.
       #
-      # Checks to see if the +:scope+ option passed to
+      # Checks to see if the `:scope` option passed to
       # {FriendlyId::Base#friendly_id} refers to a relation, and if so, returns
       # the realtion's foreign key. Otherwise it assumes the option value was
       # the name of column and returns it cast to a String.

data/lib/friendly_id/simple_i18n.rb

@@ -4,7 +4,7 @@ module FriendlyId
 
 =begin
 
-== Translating Slugs Using Simple I18n
+## Translating Slugs Using Simple I18n
 
 The {FriendlyId::SimpleI18n SimpleI18n} module adds very basic i18n support to
 FriendlyId.
@@ -12,61 +12,61 @@ FriendlyId.
 In order to use this module, your model must have a slug column for each locale.
 By default FriendlyId looks for columns named, for example, "slug_en",
 "slug_es", etc. The first part of the name can be configured by passing the
-+:slug_column+ option if you choose. Note that the column for the default locale
+`:slug_column` option if you choose. Note that the column for the default locale
 must also include the locale in its name.
 
 This module is most suitable to applications that need to support few locales.
 If you need to support two or more locales, you may wish to use the
 friendly_id_globalize gem instead.
 
-=== Example migration
+### Example migration
 
-  def self.up
-    create_table :posts do |t|
-      t.string :title
-      t.string :slug_en
-      t.string :slug_es
-      t.text   :body
+    def self.up
+      create_table :posts do |t|
+        t.string :title
+        t.string :slug_en
+        t.string :slug_es
+        t.text   :body
+      end
+      add_index :posts, :slug_en
+      add_index :posts, :slug_es
     end
-    add_index :posts, :slug_en
-    add_index :posts, :slug_es
-  end
 
-=== Finds
+### Finds
 
 Finds will take into consideration the current locale:
 
-  I18n.locale = :es
-  Post.find("la-guerra-de-las-galaxas")
-  I18n.locale = :en
-  Post.find("star-wars")
+    I18n.locale = :es
+    Post.find("la-guerra-de-las-galaxas")
+    I18n.locale = :en
+    Post.find("star-wars")
 
 To find a slug by an explicit locale, perform the find inside a block
-passed to I18n's +with_locale+ method:
+passed to I18n's `with_locale` method:
 
-  I18n.with_locale(:es) do
-    Post.find("la-guerra-de-las-galaxas")
-  end
+    I18n.with_locale(:es) do
+      Post.find("la-guerra-de-las-galaxas")
+    end
 
-=== Creating Records
+### Creating Records
 
 When new records are created, the slug is generated for the current locale only.
 
-=== Translating Slugs
+### Translating Slugs
 
 To translate an existing record's friendly_id, use
 {FriendlyId::SimpleI18n::Model#set_friendly_id}. This will ensure that the slug
 you add is properly escaped, transliterated and sequenced:
 
-  post = Post.create :name => "Star Wars"
-  post.set_friendly_id("La guerra de las galaxas", :es)
+    post = Post.create :name => "Star Wars"
+    post.set_friendly_id("La guerra de las galaxas", :es)
 
 If you don't pass in a locale argument, FriendlyId::SimpleI18n will just use the
 current locale:
 
-  I18n.with_locale(:es) do
-    post.set_friendly_id("La guerra de las galaxas")
-  end
+    I18n.with_locale(:es) do
+      post.set_friendly_id("La guerra de las galaxas")
+    end
 =end
   module SimpleI18n
 

data/lib/friendly_id/slugged.rb

@@ -5,7 +5,7 @@ require "friendly_id/candidates"
 module FriendlyId
 =begin
 
-== Slugged Models
+## Slugged Models
 
 FriendlyId can use a separate column to store slugs for models which require
 some text processing.
@@ -30,13 +30,13 @@ To activate the slugging functionality, use the {FriendlyId::Slugged} module.
 
 FriendlyId will generate slugs from a method or column that you specify, and
 store them in a field in your model. By default, this field must be named
-+:slug+, though you may change this using the
+`:slug`, though you may change this using the
 {FriendlyId::Slugged::Configuration#slug_column slug_column} configuration
 option. You should add an index to this column, and in most cases, make it
 unique. You may also wish to constrain it to NOT NULL, but this depends on your
 app's behavior and requirements.
 
-=== Example Setup
+### Example Setup
 
     # your model
     class Post < ActiveRecord::Base
@@ -62,119 +62,144 @@ app's behavior and requirements.
       end
     end
 
-=== Working With Slugs
+### Working With Slugs
 
-==== Formatting
+#### Formatting
 
 By default, FriendlyId uses Active Support's
-paramaterize[http://api.rubyonrails.org/classes/ActiveSupport/Inflector.html#method-i-parameterize]
+[paramaterize](http://api.rubyonrails.org/classes/ActiveSupport/Inflector.html#method-i-parameterize)
 method to create slugs. This method will intelligently replace spaces with
 dashes, and Unicode Latin characters with ASCII approximations:
 
-  movie = Movie.create! :title => "Der Preis fürs Überleben"
-  movie.slug #=> "der-preis-furs-uberleben"
+    movie = Movie.create! :title => "Der Preis fürs Überleben"
+    movie.slug #=> "der-preis-furs-uberleben"
 
-==== Uniqueness
+#### Column or Method?
 
-When you try to insert a record that would generate a duplicate friendly id,
-FriendlyId will append a sequence to the generated slug to ensure uniqueness:
+FriendlyId always uses a method as the basis of the slug text - not a column. It
+first glance, this may sound confusing, but remember that Active Record provides
+methods for each column in a model's associated table, and that's what
+FriendlyId uses.
 
-  car = Car.create :title => "Peugot 206"
-  car2 = Car.create :title => "Peugot 206"
+Here's an example of a class that uses a custom method to generate the slug:
 
-  car.friendly_id #=> "peugot-206"
-  car2.friendly_id #=> "peugot-206-f9f3789a-daec-4156-af1d-fab81aa16ee5"
+    class Person < ActiveRecord::Base
+      friendly_id :name_and_location
+      def name_and_location
+        "#{name} from #{location}"
+      end
+    end
 
-==== Sequence Separator - The Two Dashes
+    bob = Person.create! :name => "Bob Smith", :location => "New York City"
+    bob.friendly_id #=> "bob-smith-from-new-york-city"
 
-By default, FriendlyId uses a dash to separate the slug from a sequence.
+FriendlyId refers to this internally as the "base" method.
 
-You can change this with the {FriendlyId::Slugged::Configuration#sequence_separator
-sequence_separator} configuration option.
+#### Uniqueness
 
-==== Column or Method?
+When you try to insert a record that would generate a duplicate friendly id,
+FriendlyId will append a UUID to the generated slug to ensure uniqueness:
 
-FriendlyId always uses a method as the basis of the slug text - not a column. It
-first glance, this may sound confusing, but remember that Active Record provides
-methods for each column in a model's associated table, and that's what
-FriendlyId uses.
+    car = Car.create :title => "Peugot 206"
+    car2 = Car.create :title => "Peugot 206"
 
-Here's an example of a class that uses a custom method to generate the slug:
+    car.friendly_id #=> "peugot-206"
+    car2.friendly_id #=> "peugot-206-f9f3789a-daec-4156-af1d-fab81aa16ee5"
+
+Previous versions of FriendlyId appended a numeric sequence a to make slugs
+unique, but this was removed to simplify using FriendlyId in concurrent code.
+
+#### Candidates
+
+Since UUIDs are ugly, FriendlyId provides a "slug candidates" functionality to
+let you specify alternate slugs to use in the event the one you want to use is
+already taken. For example:
 
-  class Person < ActiveRecord::Base
-    friendly_id :name_and_location
-    def name_and_location
-      "#{name} from #{location}"
+    class Restaurant < ActiveRecord::Base
+      extend FriendlyId
+      friendly_id :slug_candidates, use: :slugged
+
+      # Try building a slug based on the following fields in
+      # increasing order of specificity.
+      def slug_candidates
+        [
+          :name,
+          [:name, :city],
+          [:name, :street, :city],
+          [:name, :street_number, :street, :city]
+        ]
+      end
     end
-  end
 
-  bob = Person.create! :name => "Bob Smith", :location => "New York City"
-  bob.friendly_id #=> "bob-smith-from-new-york-city"
+    r1 = Restaurant.create! name: 'Plaza Diner', city: 'New Paltz'
+    r2 = Restaurant.create! name: 'Plaza Diner', city: 'Kingston'
 
-==== Providing Your Own Slug Processing Method
+    r1.friendly_id  #=> 'plaza-diner'
+    r2.friendly_id  #=> 'plaza-diner-kingston'
 
-You can override {FriendlyId::Slugged#normalize_friendly_id} in your model for
-total control over the slug format.
+To use candidates, make your FriendlyId base method return an array. The
+method need not be named `slug_candidates`; it can be anything you want. The
+array may contain any combination of symbols, strings, procs or lambdas and
+will be evaluated lazily and in order. If you include symbols, FriendlyId will
+invoke a method on your model class with the same name. Strings will be
+interpreted literally. Procs and lambdas will be called and their return values
+used as the basis of the friendly id. If none of the candidates can generate a
+unique slug, then FriendlyId will append a UUID to the first candidate as a
+last resort.
 
-==== Deciding When to Generate New Slugs
+#### Sequence Separator
 
-Overriding {FriendlyId::Slugged#should_generate_new_friendly_id?} lets you
-control whether new friendly ids are created when a model is updated. For
-example, if you only want to generate slugs once and then treat them as
-read-only:
+By default, FriendlyId uses a dash to separate the slug from a sequence.
 
-  class Post < ActiveRecord::Base
-    extend FriendlyId
-    friendly_id :title, :use => :slugged
+You can change this with the {FriendlyId::Slugged::Configuration#sequence_separator
+sequence_separator} configuration option.
 
-    def should_generate_new_friendly_id?
-      new_record?
-    end
-  end
+#### Providing Your Own Slug Processing Method
 
-  post = Post.create!(:title => "Hello world!")
-  post.slug #=> "hello-world"
-  post.title = "Hello there, world!"
-  post.save!
-  post.slug #=> "hello-world"
+You can override {FriendlyId::Slugged#normalize_friendly_id} in your model for
+total control over the slug format. It will be invoked for any generated slug,
+whether for a single slug or for slug candidates.
 
-==== Locale-specific Transliterations
+#### Deciding When to Generate New Slugs
 
-Active Support's +parameterize+ uses
-transliterate[http://api.rubyonrails.org/classes/ActiveSupport/Inflector.html#method-i-transliterate],
-which in turn can use I18n's transliteration rules to consider the current
-locale when replacing Latin characters:
+Previous versions of FriendlyId provided a method named
+`should_generate_new_friendly_id?` which you could override to control when new
+slugs were generated.
 
-  # config/locales/de.yml
-  de:
-    i18n:
-      transliterate:
-        rule:
-          ü: "ue"
-          ö: "oe"
-          etc...
+As of FriendlyId 5.0, slugs are only generated when the `slug` field is nil. If
+you want a slug to be regenerated, you must explicity set the field to nil:
 
-  movie = Movie.create! :title => "Der Preis fürs Überleben"
-  movie.slug #=> "der-preis-fuers-ueberleben"
+    restaurant.friendly_id # joes-diner
+    restaurant.name = "The Plaza Diner"
+    restaurant.save!
+    restaurant.friendly_id # joes-diner
+    restaurant.slug = nil
+    restaurant.save!
+    restaurant.friendly_id # the-plaza-diner
 
-This functionality was in fact taken from earlier versions of FriendlyId.
 
-==== Gotchas: Common Problems
+#### Locale-specific Transliterations
 
-===== Slugs That Begin With Numbers
+Active Support's `parameterize` uses
+[transliterate](http://api.rubyonrails.org/classes/ActiveSupport/Inflector.html#method-i-transliterate),
+which in turn can use I18n's transliteration rules to consider the current
+locale when replacing Latin characters:
 
-Ruby's `to_i` function casts strings to integers in such a way that +23abc.to_i+
-returns 23. Because FriendlyId falls back to finding by numeric id, this means
-that if you attempt to find a record with a non-existant slug, and that slug
-begins with a number, your find will probably return the wrong record.
+    # config/locales/de.yml
+    de:
+      i18n:
+        transliterate:
+          rule:
+            ü: "ue"
+            ö: "oe"
+            etc...
 
-There are two fairly simple ways to avoid this:
+    movie = Movie.create! :title => "Der Preis fürs Überleben"
+    movie.slug #=> "der-preis-fuers-ueberleben"
 
-* Use validations to ensure that slugs don't begin with numbers.
-* Use explicit finders like +find_by_id+ to always find by the numeric id, or
-  +find_by_slug+ to always find using the friendly id.
+This functionality was in fact taken from earlier versions of FriendlyId.
 
-===== Concurrency Issues
+#### Gotchas: Common Problems
 
 FriendlyId uses a before_validation callback to generate and set the slug. This
 means that if you create two model instances before saving them, it's possible
@@ -185,12 +210,8 @@ attributes creates more than one record for a model that uses friendly_id. The
 second, in concurrent code, either in threads or multiple processes.
 
 To solve the nested attributes issue, I recommend simply avoiding them when
-creating more than one nested record for a model that uses FriendlyId. See {this
-Github issue}[https://github.com/FriendlyId/friendly_id/issues/185] for discussion.
-
-To solve the concurrency issue, I recommend locking the model's table against
-inserts while when saving the record. See {this Github
-issue}[https://github.com/FriendlyId/friendly_id/issues/180] for discussion.
+creating more than one nested record for a model that uses FriendlyId. See [this
+Github issue](https://github.com/norman/friendly_id/issues/185) for discussion.
 
 =end
   module Slugged
@@ -216,25 +237,25 @@ issue}[https://github.com/FriendlyId/friendly_id/issues/180] for discussion.
     # you can override this method in your model class to control exactly how
     # slugs are generated.
     #
-    # === Example
+    # ### Example
     #
-    #   class Person < ActiveRecord::Base
-    #     friendly_id :name_and_location
+    #     class Person < ActiveRecord::Base
+    #       friendly_id :name_and_location
     #
-    #     def name_and_location
-    #       "#{name} from #{location}"
-    #     end
+    #       def name_and_location
+    #         "#{name} from #{location}"
+    #       end
     #
-    #     # Use default slug, but upper case and with underscores
-    #     def normalize_friendly_id(string)
-    #       super.upcase.gsub("-", "_")
+    #       # Use default slug, but upper case and with underscores
+    #       def normalize_friendly_id(string)
+    #         super.upcase.gsub("-", "_")
+    #       end
     #     end
-    #   end
     #
-    #   bob = Person.create! :name => "Bob Smith", :location => "New York City"
-    #   bob.friendly_id #=> "BOB_SMITH_FROM_NEW_YORK_CITY"
+    #     bob = Person.create! :name => "Bob Smith", :location => "New York City"
+    #     bob.friendly_id #=> "BOB_SMITH_FROM_NEW_YORK_CITY"
     #
-    # === More Resources
+    # ### More Resources
     #
     # You might want to look into Babosa[https://github.com/norman/babosa],
     # which is the slugging library used by FriendlyId prior to version 4, which
@@ -273,8 +294,8 @@ issue}[https://github.com/FriendlyId/friendly_id/issues/180] for discussion.
     end
     private :slug_generator
 
-    # This module adds the +:slug_column+, and +:sequence_separator+, and
-    # +:slug_generator_class+ configuration options to
+    # This module adds the `:slug_column`, and `:sequence_separator`, and
+    # `:slug_generator_class` configuration options to
     # {FriendlyId::Configuration FriendlyId::Configuration}.
     module Configuration
       attr_writer :slug_column, :sequence_separator
@@ -291,7 +312,7 @@ issue}[https://github.com/FriendlyId/friendly_id/issues/180] for discussion.
       # You can change the default separator by setting the
       # {FriendlyId::Slugged::Configuration#sequence_separator
       # sequence_separator} configuration option.
-      # @return String The sequence separator string. Defaults to "+-+".
+      # @return String The sequence separator string. Defaults to "`-`".
       def sequence_separator
         @sequence_separator or defaults[:sequence_separator]
       end