friendly_id 4.1.0.beta.1 → 5.0.0.alpha.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 44f9c1a8ef2afb5bda90485d0df78b67da83e73d
+  data.tar.gz: 722909dc863dd55275aa403ee4321c99af1ea118
+SHA512:
+  metadata.gz: d0949ad9c3d10238bbc4f6f350bd4d8b7101485679f3d55ef78c902b1a0f280d738b89f5753bd467d593ab8ec91ca7bc412323083114140f1fea5a061c27755f
+  data.tar.gz: d561df0002650904d1b087185f9d5a94ad6e191ab88925fe9e0974894affaafa55e92db2774cc3fe364ead7fef85dd6cade495f7f47feeeda54efe5b04b2681e

data/.travis.yml

@@ -1,20 +1,15 @@
+language: ruby
 rvm:
+  - 2.0.0
   - 1.9.3
-  - 1.8.7
-#  - jruby
-#  - rbx
-
-branches:
-  only:
-    - master
+#  - jruby-19mode
+#  - rbx-19mode
 env:
   - DB=postgres
   - DB=mysql
   - DB=sqlite3
-
 gemfile:
-  - gemfiles/Gemfile.rails-3.0.rb
-  - gemfiles/Gemfile.rails-3.1.rb
-  - gemfiles/Gemfile.rails-3.2.rb
-before_script: 'bundle exec rake db:create db:up > /dev/null'
+  - gemfiles/Gemfile.rails-4.0.rb
+
+before_script: 'bundle exec rake db:create db:up'
 script: 'bundle exec rake test'

data/Changelog.md

@@ -10,6 +10,10 @@ suggestions, ideas and improvements to FriendlyId.
 
 Made the :scoped and :history modules compatible with each other (Andre Duffeck)
 
+## 4.0.10 (NOT RELEASED YET)
+
+* Fixed table prefixes/suffixes being ignored (Jesse Farless)
+
 ## 4.0.9 (2012-10-31)
 
 * Fixed support for Rails 3.2.9.rc1

data/Gemfile

@@ -1,11 +1,11 @@
-source :rubygems
+source 'https://rubygems.org'
 
 gemspec
 
 # Database Configuration
 group :development, :test do
   platforms :jruby do
-    gem 'activerecord-jdbcsqlite3-adapter'
+    gem 'activerecord-jdbcsqlite3-adapter', '>= 1.3.0.beta2'
     gem 'jruby-openssl'
   end
 

data/Guide.rdoc

@@ -114,9 +114,8 @@ 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. Do not make the column unique in case you wish to scope the slug
-(more on this later). You may also wish to constrain it to NOT NULL, but this
-depends on your app's behavior and requirements.
+unique. You may also wish to constrain it to NOT NULL, but this depends on your
+app's behavior and requirements.
 
 === Example Setup
 
@@ -165,11 +164,11 @@ FriendlyId will append a sequence to the generated slug to ensure uniqueness:
   car2 = Car.create :title => "Peugot 206"
 
   car.friendly_id #=> "peugot-206"
-  car2.friendly_id #=> "peugot-206--2"
+  car2.friendly_id #=> "peugot-206-f9f3789a-daec-4156-af1d-fab81aa16ee5"
 
 ==== Sequence Separator - The Two Dashes
 
-By default, FriendlyId uses two dashes to separate the slug from a sequence.
+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.
@@ -268,11 +267,11 @@ 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.
+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/norman/friendly_id/issues/180] for discussion.
+issue}[https://github.com/FriendlyId/friendly_id/issues/180] for discussion.
 
 
 == History: Avoiding 404's When Slugs Change
@@ -296,6 +295,8 @@ model.
 
 === Considerations
 
+This module is incompatible with the +:scoped+ module.
+
 Because recording slug history requires creating additional database records,
 this module has an impact on the performance of the associated model's +create+
 method.
@@ -350,13 +351,32 @@ This allows, for example, two restaurants in different cities to have the slug
     City.find("chicago").restaurants.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--2+.
++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.
 
-Please do note that you must drop the uniqueness constraint on the slug's
-column in the database when you're scoping the slug.
+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
 
@@ -417,7 +437,7 @@ 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
-{FriendlyId::Globalize Globalize} module instead.
+friendly_id_globalize gem instead.
 
 === Example migration
 
@@ -465,56 +485,7 @@ 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
-
-
-== Translating Slugs Using Globalize
-
-The {FriendlyId::Globalize Globalize} module lets you use
-Globalize[https://github.com/svenfuchs/globalize3] to translate slugs. This
-module is most suitable for applications that need to be localized to many
-languages. If your application only needs to be localized to one or two
-languages, you may wish to consider the {FriendlyId::SimpleI18n SimpleI18n}
-module.
-
-In order to use this module, your model's table and translation table must both
-have a slug column, and your model must set the +slug+ field as translatable
-with Globalize:
-
-    class Post < ActiveRecord::Base
-      translates :title, :slug
-      extend FriendlyId
-      friendly_id :title, :use => :globalize
-    end
-
-=== Finds
-
-Finds will take the current locale into consideration:
-
-  I18n.locale = :it
-  Post.find("guerre-stellari")
-  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(:it) do
-    Post.find("guerre-stellari")
-  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, simply change the locale and
-assign a value to the +slug+ field:
-
-  I18n.with_locale(:it) do
-    post.slug = "guerre-stellari"
+    post.set_friendly_id("La guerra de las galaxas")
   end
 
 
@@ -546,6 +517,6 @@ For example:
     after_validation :move_friendly_id_error_to_name
 
     def move_friendly_id_error_to_name
-      errors.messages[:name] = errors.messages.delete(:friendly_id)
+      errors.add :name, *errors.delete(:friendly_id) if errors[:friendly_id].present?
     end
-  end
+  end

data/README.md

@@ -1,6 +1,17 @@
 # FriendlyId
 
-[![Build Status](https://travis-ci.org/norman/friendly_id.png)](https://travis-ci.org/norman/friendly_id)
+**VERSION NOTE**
+
+**Rails 4**:
+Master branch of this repository contains FriendlyId 5 which is compatible with Rails 4.
+This version is under active development and not yet fully stable.
+
+**Rails 3**:
+If you wish to use this gem with Rails 3.1 or 3.2 you need to use FriendlyId version 4, which is the current stable release.
+Please see [4.0-stable
+branch](https://github.com/FriendlyId/friendly_id/tree/4.0-stable).
+
+[![Build Status](https://travis-ci.org/FriendlyId/friendly_id.png)](https://travis-ci.org/FriendlyId/friendly_id)
 
 FriendlyId is the "Swiss Army bulldozer" of slugging and permalink plugins for
 Ruby on Rails. It allows you to create pretty URLs and work with human-friendly
@@ -18,63 +29,125 @@ instead of:
 ## FriendlyId Features
 
 FriendlyId offers many advanced features, including: slug history and
-versioning, i18n, Globalize support, scoped slugs, reserved words, and custom
-slug generators.
+versioning, i18n, scoped slugs, reserved words, and custom slug generators.
 
-FriendlyId is compatible with Active Record **3.0** and higher.
+Note: FriendlyId 5.0 is compatible with Active Record **4.0** and higher only.
+For Rails 3.x, please use FriendlyId 4.x.
 
-## Version 4.x
 
-FriendlyId 4.x introduces many changes incompatible with 3.x. If you're
-upgrading, please [read the
-docs](http://rubydoc.info/github/norman/friendly_id/master/file/WhatsNew.md) to see what's
-new.
+## Version 5.x
 
-## Docs
+As of version 5.0, FriendlyId uses semantic versioning. Therefore, as you might
+infer from the version number, FriendlyId 5.0 introduces changes incompatible
+with 4.x.
 
-The current docs can always be found
-[here](http://rubydoc.info/github/norman/friendly_id/master/frames).
+Here's a summary of the most important changes:
 
-The best place to start is with the
-[Guide](http://rubydoc.info/github/norman/friendly_id/master/file/Guide.rdoc),
-which compiles the top-level RDocs into one outlined document.
+* FriendlyId no longer overrides `find`. If you want to do friendly finds, you
+  must do `Model.friendly.find` rather than `Model.find`.
 
-You might also want to watch Ryan Bates's [Railscast on FriendlyId](http://railscasts.com/episodes/314-pretty-urls-with-friendlyid).
+* Version 5.0 offers a new "candidates" functionality which makes it easy to
+  set up a list of alternate slugs that can be used to uniquely distinguish
+  records, rather than appending a sequence. For example:
 
-## Rails Quickstart
+```ruby
+class Restaurant < ActiveRecord::Base
+  extend FriendlyId
+  friendly_id :slug_candidates, use: :slugged
 
-    gem install friendly_id
+  # 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
+```
 
-    rails new my_app
+* Now that candidates have been added, FriendlyId no longer uses a numeric
+  sequence to differentiate conflicting slug, but rather a GUID. This makes the
+  codebase simpler and more reliable when running concurrently, at the expense
+  of uglier ids being generated when there are conflicts.
 
-    cd my_app
+* The Globalize module has been removed and will be released as its own gem.
+  Note that it has not yet been developed.
 
-    gem "friendly_id", "~> 4.0.1"
+* The default sequence separator is now `-` rather than `--`.
 
-    rails generate scaffold user name:string slug:string
+* Slugs are no longer regenerated when a record is saved. If you want to regenerate
+  a slug, you must explicitly set the slug column to nil:
 
-    # edit db/migrate/*_create_users.rb
-    add_index :users, :slug, unique: true
+```ruby
+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
+```
 
-    rake db:migrate
+* Like Rails 4, FriendlyId now requires Ruby 1.9.3 or higher.
 
-    # edit app/models/user.rb
-    class User < ActiveRecord::Base
-      extend FriendlyId
-      friendly_id :name, use: :slugged
-    end
+## Docs
 
-    User.create! name: "Joe Schmoe"
+The current docs can always be found
+[here](http://rubydoc.info/github/FriendlyId/friendly_id/master/frames).
 
-    rails server
+The best place to start is with the
+[Guide](http://rubydoc.info/github/FriendlyId/friendly_id/master/file/Guide.rdoc),
+which compiles the top-level RDocs into one outlined document.
 
-    GET http://localhost:3000/users/joe-schmoe
+You might also want to watch Ryan Bates's [Railscast on FriendlyId](http://railscasts.com/episodes/314-pretty-urls-with-friendlyid),
+which is now somewhat outdated but still mostly relevant.
 
-    # If you're adding FriendlyId to an existing app and need
-    # to generate slugs for existing users, do this from the
-    # console, runner, or add a Rake task:
-    User.find_each(&:save)
+## Rails Quickstart
 
+```shell
+rails new my_app
+cd my_app
+```
+```ruby
+# Gemfile
+gem 'friendly_id', github: 'FriendlyId/friendly_id', branch: 'master' # Note: You MUST use 5.0.0 or greater for Rails 4.0+
+```
+```shell
+rails generate scaffold user name:string slug:string
+```
+```ruby
+# edit db/migrate/*_create_users.rb
+add_index :users, :slug, unique: true
+```
+```shell
+rake db:migrate
+```
+```ruby
+# edit app/models/user.rb
+class User < ActiveRecord::Base
+  extend FriendlyId
+  friendly_id :name, use: :slugged
+end
+
+User.create! name: "Joe Schmoe"
+
+# Change User.find to User.friendly.find in your controller
+User.friendly.find(params[:id])
+```
+```shell
+rails server
+
+GET http://localhost:3000/users/joe-schmoe
+```
+```ruby
+# If you're adding FriendlyId to an existing app and need
+# to generate slugs for existing users, do this from the
+# console, runner, or add a Rake task:
+User.find_each(&:save)
+```
 
 ## Benchmarks
 
@@ -85,7 +158,7 @@ The latest benchmarks for FriendlyId are maintained
 ## Bugs
 
 Please report them on the [Github issue
-tracker](http://github.com/norman/friendly_id/issues) for this project.
+tracker](http://github.com/FriendlyId/friendly_id/issues) for this project.
 
 If you have a bug to report, please include the following information:
 
@@ -103,32 +176,15 @@ article](http://yourbugreportneedsmore.info/).
 ## Thanks and Credits
 
 FriendlyId was originally created by Norman Clarke and Adrian Mugnolo, with
-significant help early in its life by Emilio Tagua. I'm deeply grateful for the
-generous contributions over the years from [many
-volunteers](https://github.com/norman/friendly_id/contributors).
-
-Part of the inspiration to rework FriendlyId came from Darcy Laycock's library
-[Slugged](https://github.com/Sutto/slugged), which he was inspired to create
-because of frustrations he experienced while using FriendlyId 3.x. Seeing a
-smart programmer become frustrated with my code was enough of a kick in the
-butt to make me want to significantly improve this library.
-
-Many thanks to him for providing valid, real criticism while still being a cool
-about it. I definitely recommend you check out his library if for some reason
-FriendlyId doesn't do it for you.
-
-Thanks also to Loren Segal and Nick Plante for YARD and the
-[rubydoc.info](http://rubydoc.info/) website which FriendlyId uses for
-documentation.
+significant help early in its life by Emilio Tagua. It is now maintained by
+Norman Clarke and Philip Arndt.
 
-Lastly, FriendlyId uses [Travis](http://travis-ci.org/) for continuous
-integration. It's an excellent, free service created by a whole bunch of [good
-people](https://github.com/travis-ci) - if you're not already using it, you
-should be!
+We're deeply grateful for the generous contributions over the years from [many
+volunteers](https://github.com/FriendlyId/friendly_id/contributors).
 
 ## License
 
-Copyright (c) 2008-2012 Norman Clarke and contributors, released under the MIT
+Copyright (c) 2008-2013 Norman Clarke and contributors, released under the MIT
 license.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of

data/Rakefile

@@ -15,23 +15,28 @@ Rake::TestTask.new do |t|
   t.verbose = true
 end
 
+desc "Remove temporary files"
 task :clean do
   %x{rm -rf *.gem doc pkg coverage}
   %x{rm -f `find . -name '*.rbc'`}
 end
 
+desc "Build the gem"
 task :gem do
   %x{gem build friendly_id.gemspec}
 end
 
+desc "Build YARD documentation"
 task :yard => :guide do
   puts %x{bundle exec yard}
 end
 
+desc "Run benchmarks"
 task :bench => :load_path do
   require File.expand_path("../bench", __FILE__)
 end
 
+desc "Generate Guide.rdoc"
 task :guide do
   def read_comments(path)
     path  = File.expand_path("../#{path}", __FILE__)
@@ -47,7 +52,6 @@ task :guide do
   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/globalize.rb")
   buffer << read_comments("lib/friendly_id/reserved.rb")
 
   File.open("Guide.rdoc", "w") do |file|