friendly_id 5.0.0.beta4 → 5.0.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 04766b0ed96f1b271571b983cf3b73cf9385406c
-  data.tar.gz: 5881c90dc07cf35780402d04211cc93ebd597d01
+  metadata.gz: eb59a1c03451e5b3848ab8fa00da5aa476276d79
+  data.tar.gz: f6057d3fad4267d1cea422b0eb72b78f433afc78
 SHA512:
-  metadata.gz: 06b4a78391d3a6f9ca7a42e4769087e4dbf70a559e29313147b48b655dbc59ffddfbaf3f91e78854d64c8b1cedf1bf2e088280c9747fcb9fc45318ec7243d925
-  data.tar.gz: 2e66f50e25d14cf807e2f2719c49e13e2936656ac50a6842f1225357089e0561b2ec39effad76571558999d04d905715f365649cd1119b7a2a8765dd81084c79
+  metadata.gz: 9bbd5d21be8df888836e6e98b14c43d45eb89da31816830c5287038dce5f1a60c9920adf3b69a498e96b5d0cb6addfe952c5983d307228f5c57726095d9160c7
+  data.tar.gz: cae59c6cbc8406c0cedf700ad1201a23b01d74ec6b7d871333d8c156e273332485f581b59d2df9e59da689e4c4219dffe6a8f770f7a48e9f8af1b8b0a18b8de3

data/.gitignore

@@ -10,3 +10,5 @@ coverage
 *.rbc
 *.lock
 .rbx
+Guide.md
+.friendly_id

data/.yardopts

@@ -1,3 +1,4 @@
+-e guide.rb
 --files=Changelog.md,Guide.md
 --private
 --protected

data/Changelog.md

@@ -3,6 +3,13 @@
 We would like to think our many {file:Contributors contributors} for
 suggestions, ideas and improvements to FriendlyId.
 
+## 5.0.0.rc1 (2013-08-28)
+
+* Removed some outdated tests.
+* Improved documentation.
+* Removed Guide from repository and added tasks to maintain docs up to date
+  on Github pages at http://norman.github.io/friendly_id.
+
 ## 5.0.0.beta4 (2013-08-21)
 
 * Add an initializer to the generator; move the default reserved words there.

data/README.md

@@ -15,7 +15,7 @@ branch](https://github.com/norman/friendly_id/tree/4.0-stable).
 
 # FriendlyId
 
-<em>For the most complete, user-friendly documentation, see the [FriendlyId Guide](http://rubydoc.info/github/norman/friendly_id/master/file/Guide.md).</em>
+<em>For the most complete, user-friendly documentation, see the [FriendlyId Guide](http://norman.github.io/friendly_id/file.Guide.html).</em>
 
 FriendlyId is the "Swiss Army bulldozer" of slugging and permalink plugins for
 Active Record. It lets you create pretty URLs and work with human-friendly
@@ -91,11 +91,13 @@ The most important changes are:
           restaurant.friendly_id # the-plaza-diner
 
   You can restore some of the old behavior by overriding the
-  `should_generate_new_friendly_id` method.
+  `should_generate_new_friendly_id?` method.
 
 * The `friendly_id` Rails generator now generates an initializer showing you
   how to do some commmon global configuration.
 
+* The Globalize plugin has moved to a separate gem (currently in alpha).
+
 * The `:reserved` module no longer includes any default reserved words.
   Previously it blocked "edit" and "new" everywhere. The default word list has
   been moved to `config/initializers/friendly_id.rb` and now includes many more
@@ -127,10 +129,15 @@ A migration like this should be sufficient:
 ## Docs
 
 The most current docs from the master branch can always be found
-[here](http://rubydoc.info/github/norman/friendly_id/master/frames).
+[here](http://norman.github.io/friendly_id).
+
+Docs for older versions are also available:
+
+* [4.0](http://norman.github.io/friendly_id/4.0/)
+* [3.3](http://norman.github.io/friendly_id/3.3/)
 
 The best place to start is with the
-[Guide](http://rubydoc.info/github/norman/friendly_id/master/file/Guide.md),
+[Guide](http://norman.github.io/friendly_id/file.Guide.html),
 which compiles the top-level RDocs into one outlined document.
 
 You might also want to watch Ryan Bates's [Railscast on FriendlyId](http://railscasts.com/episodes/314-pretty-urls-with-friendlyid),

data/Rakefile

@@ -27,7 +27,7 @@ task :gem do
 end
 
 desc "Build YARD documentation"
-task :yard => :guide do
+task :yard do
   puts %x{bundle exec yard}
 end
 
@@ -38,26 +38,7 @@ end
 
 desc "Generate Guide.md"
 task :guide do
-  def read_comments(path)
-    path  = File.expand_path("../#{path}", __FILE__)
-    match = File.read(path).match(/\n=begin(.*)\n=end/m)[1].to_s
-    match.split("\n").reject {|x| x =~ /^@/}.join("\n")
-  end
-
-  buffer = []
-
-  buffer << read_comments("lib/friendly_id.rb")
-  buffer << read_comments("lib/friendly_id/base.rb")
-  buffer << read_comments("lib/friendly_id/finders.rb")
-  buffer << read_comments("lib/friendly_id/slugged.rb")
-  buffer << read_comments("lib/friendly_id/history.rb")
-  buffer << read_comments("lib/friendly_id/scoped.rb")
-  buffer << read_comments("lib/friendly_id/simple_i18n.rb")
-  buffer << read_comments("lib/friendly_id/reserved.rb")
-
-  File.open("Guide.md", "w") do |file|
-    file.write(buffer.join("\n"))
-  end
+  load File.expand_path('../guide.rb', __FILE__)
 end
 
 namespace :test do
@@ -110,3 +91,7 @@ namespace :db do
 end
 
 task :doc => :yard
+
+task :docs do
+  sh %{git checkout gh-pages && rake doc && git checkout @{-1}}
+end

data/guide.rb

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+# This script generates the Guide.md file included in the Yard docs.
+
+def comments_from path
+  path  = File.expand_path("../lib/friendly_id/#{path}", __FILE__)
+  match = File.read(path).match(/\n=begin(.*)\n=end/m)[1].to_s
+  match.split("\n").reject {|x| x =~ /^@/}.join("\n").strip
+end
+
+File.open(File.expand_path('../Guide.md', __FILE__), 'w:utf-8') do |guide|
+  ['../friendly_id.rb', 'base.rb', 'finders.rb', 'slugged.rb', 'history.rb',
+  'scoped.rb', 'simple_i18n.rb', 'reserved.rb'].each do |file|
+    guide.write comments_from file
+    guide.write "\n"
+  end
+end

data/lib/friendly_id.rb

@@ -50,6 +50,19 @@ module FriendlyId
   autoload :Slugged,    "friendly_id/slugged"
   autoload :Finders,    "friendly_id/finders"
 
+  # Instances of these classes will never be considered a friendly id.
+  # @see FriendlyId::ObjectUtils#friendly_id
+  UNFRIENDLY_CLASSES = [
+    ActiveRecord::Base,
+    Array,
+    FalseClass,
+    Hash,
+    NilClass,
+    Numeric,
+    Symbol,
+    TrueClass
+  ]
+
   # FriendlyId takes advantage of `extended` to do basic model setup, primarily
   # extending {FriendlyId::Base} to add {FriendlyId::Base#friendly_id
   # friendly_id} as a class method.

data/lib/friendly_id/initializer.rb

@@ -7,7 +7,7 @@
 #
 # To learn more, check out the guide:
 #
-# http://rubydoc.info/github/norman/friendly_id/master/file/Guide.md
+# http://norman.github.io/friendly_id/file.Guide.html
 
 FriendlyId.defaults do |config|
   # ## Reserved Words

data/lib/friendly_id/object_utils.rb

@@ -29,10 +29,7 @@ module FriendlyId
     def friendly_id?
       # Considered unfriendly if this is an instance of an unfriendly class or
       # one of its descendants.
-      unfriendly_classes = [ActiveRecord::Base, Array, Hash, NilClass, Numeric,
-                            Symbol, TrueClass, FalseClass]
-
-      if unfriendly_classes.detect {|klass| self.class <= klass}
+      if FriendlyId::UNFRIENDLY_CLASSES.detect {|klass| self.class <= klass}
         false
       elsif respond_to?(:to_i) && to_i.to_s != to_s
         true

data/lib/friendly_id/reserved.rb

@@ -4,7 +4,7 @@ module FriendlyId
 
 ## Reserved Words
 
-The {FriendlyId::Reserved Reserved} module adds the ability to exlude a list of
+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
@@ -17,16 +17,16 @@ 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
+    class Person < ActiveRecord::Base
+      extend FriendlyId
+      friendly_id :name, use: :slugged
 
-    after_validation :move_friendly_id_error_to_name
+      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?
+      def move_friendly_id_error_to_name
+        errors.add :name, *errors.delete(:friendly_id) if errors[:friendly_id].present?
+      end
     end
-  end
 
 =end
   module Reserved

data/lib/friendly_id/simple_i18n.rb

@@ -37,7 +37,7 @@ friendly_id_globalize gem instead.
 Finds will take into consideration the current locale:
 
     I18n.locale = :es
-    Post.find("la-guerra-de-las-galaxas")
+    Post.find("la-guerra-de-las-galaxias")
     I18n.locale = :en
     Post.find("star-wars")
 
@@ -45,7 +45,7 @@ To find a slug by an explicit locale, perform the find inside a block
 passed to I18n's `with_locale` method:
 
     I18n.with_locale(:es) do
-      Post.find("la-guerra-de-las-galaxas")
+      Post.find("la-guerra-de-las-galaxias")
     end
 
 ### Creating Records
@@ -59,13 +59,13 @@ To translate an existing record's friendly_id, use
 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.set_friendly_id("La guerra de las galaxias", :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")
+      post.set_friendly_id("La guerra de las galaxias")
     end
 =end
   module SimpleI18n

data/lib/friendly_id/version.rb

@@ -1,3 +1,3 @@
 module FriendlyId
-  VERSION = "5.0.0.beta4"
+  VERSION = "5.0.0.rc1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: friendly_id
 version: !ruby/object:Gem::Version
-  version: 5.0.0.beta4
+  version: 5.0.0.rc1
 platform: ruby
 authors:
 - Norman Clarke
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-21 00:00:00.000000000 Z
+date: 2013-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -155,13 +155,13 @@ files:
 - CONTRIBUTING.md
 - Changelog.md
 - Gemfile
-- Guide.md
 - MIT-LICENSE
 - README.md
 - Rakefile
 - bench.rb
 - friendly_id.gemspec
 - gemfiles/Gemfile.rails-4.0.rb
+- guide.rb
 - lib/friendly_id.rb
 - lib/friendly_id/.gitattributes
 - lib/friendly_id/base.rb
@@ -182,11 +182,6 @@ files:
 - lib/friendly_id/version.rb
 - lib/generators/friendly_id_generator.rb
 - test/base_test.rb
-- test/compatibility/ancestry/Gemfile
-- test/compatibility/ancestry/ancestry_test.rb
-- test/compatibility/threading/Gemfile
-- test/compatibility/threading/Gemfile.lock
-- test/compatibility/threading/threading.rb
 - test/configuration_test.rb
 - test/core_test.rb
 - test/databases.yml

data/Guide.md

@@ -1,597 +0,0 @@
-
-
-## About FriendlyId
-
-FriendlyId is an add-on to Ruby's Active Record that allows you to replace ids
-in your URLs with strings:
-
-    # without FriendlyId
-    http://example.com/states/4323454
-
-    # with FriendlyId
-    http://example.com/states/washington
-
-It requires few changes to your application code and offers flexibility,
-performance and a well-documented codebase.
-
-### Core Concepts
-
-#### Slugs
-
-The concept of *slugs* is at the heart of FriendlyId.
-
-A slug is the part of a URL which identifies a page using human-readable
-keywords, rather than an opaque identifier such as a numeric id. This can make
-your application more friendly both for users and search engine.
-
-#### Finders: Slugs Act Like Numeric IDs
-
-To the extent possible, FriendlyId lets you treat text-based identifiers like
-normal IDs. This means that you can perform finds with slugs just like you do
-with numeric ids:
-
-    Person.find(82542335)
-    Person.friendly.find("joe")
-
-
-## Setting Up FriendlyId in Your Model
-
-To use FriendlyId in your ActiveRecord models, you must first either extend or
-include the FriendlyId module (it makes no difference), then invoke the
-{FriendlyId::Base#friendly_id friendly_id} method to configure your desired
-options:
-
-    class Foo < ActiveRecord::Base
-      include FriendlyId
-      friendly_id :bar, :use => [:slugged, :simple_i18n]
-    end
-
-The most important option is `:use`, which you use to tell FriendlyId which
-addons it should use. See the documentation for this method for a list of all
-available addons, or skim through the rest of the docs to get a high-level
-overview.
-
-### The Default Setup: Simple Models
-
-The simplest way to use FriendlyId is with a model that has a uniquely indexed
-column with no spaces or special characters, and that is seldom or never
-updated. The most common example of this is a user name:
-
-    class User < ActiveRecord::Base
-      extend FriendlyId
-      friendly_id :login
-      validates_format_of :login, :with => /\A[a-z0-9]+\z/i
-    end
-
-    @user = User.friendly.find "joe"   # the old User.find(1) still works, too
-    @user.to_param                     # returns "joe"
-    redirect_to @user                  # the URL will be /users/joe
-
-In this case, FriendlyId assumes you want to use the column as-is; it will never
-modify the value of the column, and your application should ensure that the
-value is unique and admissible in a URL:
-
-    class City < ActiveRecord::Base
-      extend FriendlyId
-      friendly_id :name
-    end
-
-    @city.friendly.find "Viña del Mar"
-    redirect_to @city # the URL will be /cities/Viña%20del%20Mar
-
-Writing the code to process an arbitrary string into a good identifier for use
-in a URL can be repetitive and surprisingly tricky, so for this reason it's
-often better and easier to use {FriendlyId::Slugged slugs}.
-
-## 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 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
-
-
-## Slugged Models
-
-FriendlyId can use a separate column to store slugs for models which require
-some text processing.
-
-For example, blog applications typically use a post title to provide the basis
-of a search engine friendly URL. Such identifiers typically lack uppercase
-characters, use ASCII to approximate UTF-8 character, and strip out other
-characters which may make them aesthetically unappealing or error-prone when
-used in a URL.
-
-    class Post < ActiveRecord::Base
-      extend FriendlyId
-      friendly_id :title, :use => :slugged
-    end
-
-    @post = Post.create(:title => "This is the first post!")
-    @post.friendly_id   # returns "this-is-the-first-post"
-    redirect_to @post   # the URL will be /posts/this-is-the-first-post
-
-In general, use slugs by default unless you know for sure you don't need them.
-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
-{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
-
-    # your model
-    class Post < ActiveRecord::Base
-      extend FriendlyId
-      friendly_id :title, :use => :slugged
-      validates_presence_of :title, :slug, :body
-    end
-
-    # a migration
-    class CreatePosts < ActiveRecord::Migration
-      def self.up
-        create_table :posts do |t|
-          t.string :title, :null => false
-          t.string :slug, :null => false
-          t.text :body
-        end
-
-        add_index :posts, :slug, :unique => true
-      end
-
-      def self.down
-        drop_table :posts
-      end
-    end
-
-### Working With Slugs
-
-#### Formatting
-
-By default, FriendlyId uses Active Support's
-[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"
-
-#### Column or Method?
-
-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.
-
-Here's an example of a class that uses a custom method to generate the slug:
-
-    class Person < ActiveRecord::Base
-      friendly_id :name_and_location
-      def name_and_location
-        "#{name} from #{location}"
-      end
-    end
-
-    bob = Person.create! :name => "Bob Smith", :location => "New York City"
-    bob.friendly_id #=> "bob-smith-from-new-york-city"
-
-FriendlyId refers to this internally as the "base" method.
-
-#### Uniqueness
-
-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:
-
-    car = Car.create :title => "Peugot 206"
-    car2 = Car.create :title => "Peugot 206"
-
-    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 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
-
-    r1 = Restaurant.create! name: 'Plaza Diner', city: 'New Paltz'
-    r2 = Restaurant.create! name: 'Plaza Diner', city: 'Kingston'
-
-    r1.friendly_id  #=> 'plaza-diner'
-    r2.friendly_id  #=> 'plaza-diner-kingston'
-
-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.
-
-#### Sequence Separator
-
-By default, FriendlyId uses a dash to separate the slug from a sequence.
-
-You can change this with the {FriendlyId::Slugged::Configuration#sequence_separator
-sequence_separator} configuration option.
-
-#### Providing Your Own Slug Processing Method
-
-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.
-
-#### Deciding When to Generate New Slugs
-
-As of FriendlyId 5.0, slugs are only generated when the `slug` field is nil. If
-you want a slug to be regenerated,set the slug field to nil:
-
-    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
-
-You can also override the
-{FriendlyId::Slugged#should_generate_new_friendly_id?} method, which lets you
-control exactly when new friendly ids are set:
-
-    class Post < ActiveRecord::Base
-      extend FriendlyId
-      friendly_id :title, :use => :slugged
-
-      def should_generate_new_friendly_id?
-        title_changed?
-      end
-    end
-
-#### Locale-specific Transliterations
-
-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:
-
-    # config/locales/de.yml
-    de:
-      i18n:
-        transliterate:
-          rule:
-            ü: "ue"
-            ö: "oe"
-            etc...
-
-    movie = Movie.create! :title => "Der Preis fürs Überleben"
-    movie.slug #=> "der-preis-fuers-ueberleben"
-
-This functionality was in fact taken from earlier versions of FriendlyId.
-
-#### 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
-they will generate the same slug, and the second save will fail.
-
-This can happen in two fairly normal cases: the first, when a model using nested
-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/norman/friendly_id/issues/185) for discussion.
-
-
-## 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.find params[:id]
-
-        # 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
-
-
-## 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.friendly.find("joes-diner").where(:city_id => @city.id)
-
-
-### 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
-
-
-## Translating Slugs Using Simple I18n
-
-The {FriendlyId::SimpleI18n SimpleI18n} module adds very basic i18n support to
-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
-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
-
-    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
-
-### 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")
-
-To find a slug by an explicit locale, perform the find inside a block
-passed to I18n's `with_locale` method:
-
-    I18n.with_locale(:es) do
-      Post.find("la-guerra-de-las-galaxas")
-    end
-
-### Creating Records
-
-When new records are created, the slug is generated for the current locale only.
-
-### 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)
-
-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
-
-
-## Reserved Words
-
-The {FriendlyId::Reserved Reserved} 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
-
-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.
-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

data/test/compatibility/ancestry/Gemfile

@@ -1,8 +0,0 @@
-source :rubygems
-
-gem "sqlite3", "~> 1.3.4"
-gem "activerecord", "3.0.10"
-gem "minitest", "~> 2.4.0"
-gem "mocha", "~> 0.9.12"
-gem "ancestry"
-gem "rake"

data/test/compatibility/ancestry/ancestry_test.rb

@@ -1,34 +0,0 @@
-require File.expand_path("../../../helper", __FILE__)
-
-require "ancestry"
-
-ActiveRecord::Migration.create_table("things") do |t|
-  t.string  :name
-  t.string  :slug
-  t.string :ancestry
-end
-ActiveRecord::Migration.add_index :things, :ancestry
-
-class Thing < ActiveRecord::Base
-  extend FriendlyId
-  friendly_id do |config|
-    config.use :slugged
-    config.use :scoped
-    config.base  = :name
-    config.scope = :ancestry
-  end
-  has_ancestry
-end
-
-class AncestryTest < MiniTest::Unit::TestCase
-  include FriendlyId::Test
-
-  test "should sequence slugs when scoped by ancestry" do
-    3.times.inject([]) do |memo, _|
-      memo << Thing.create!(:name => "a", :parent => memo.last)
-    end.each do |thing|
-      assert_equal "a", thing.friendly_id
-    end
-  end
-end
-

data/test/compatibility/threading/Gemfile

@@ -1,8 +0,0 @@
-source :rubygems
-
-gem "pg"
-gem "mysql2"
-gem "mocha"
-gem "activerecord", "3.1.1"
-gem "sqlite3"
-gem "fatalistic"

data/test/compatibility/threading/threading.rb

@@ -1,45 +0,0 @@
-ENV["DB"] = "postgres"
-
-require "thread"
-require File.expand_path("../../../helper", __FILE__)
-require "active_record/locking/fatalistic"
-
-ActiveRecord::Migration.tap do |m|
-  m.drop_table "things"
-  m.create_table("things") do |t|
-    t.string  :name
-    t.string  :slug
-  end
-  m.add_index :things, :slug, :unique => true
-end
-
-class Thing < ActiveRecord::Base
-  extend FriendlyId
-  friendly_id :name, :use => :slugged
-end
-
-$things = 10.times.map do
-  Thing.new :name => "a b c"
-end
-
-$mutex = Mutex.new
-
-def save_thing
-  thing = $mutex.synchronize do
-    $things.pop
-  end
-  if thing.nil? then return end
-  Thing.lock do
-    thing.save!
-    print "#{thing.friendly_id}\n"
-  end
-  true
-end
-
-2.times.map do
-  Thread.new do
-    while true do
-      break unless save_thing
-    end
-  end
-end.map(&:value)