RubyGems - friendly_id - Versions diffs - 5.0.0.beta1 → 5.0.0.beta2 - Mend

friendly_id 5.0.0.beta1 → 5.0.0.beta2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (17) hide show

checksums.yaml +4 -4
data/CONTRIBUTING.md +5 -0
data/Guide.md +63 -5
data/README.md +15 -8
data/Rakefile +1 -0
data/bench.rb +14 -1
data/lib/friendly_id.rb +2 -1
data/lib/friendly_id/base.rb +3 -3
data/lib/friendly_id/configuration.rb +2 -2
data/lib/friendly_id/finder_methods.rb +50 -0
data/lib/friendly_id/finders.rb +48 -37
data/lib/friendly_id/history.rb +11 -5
data/lib/friendly_id/slugged.rb +13 -5
data/lib/friendly_id/version.rb +2 -2
data/test/finders_test.rb +29 -0
data/test/history_test.rb +31 -0
metadata +4 -2

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3a7d80631aa03de549650e0cc84c04108204af5c
-  data.tar.gz: c868670182414c4846e8c4a94aa34d680f78c1a7
+  metadata.gz: dec251b305da7b006b6d849ae54f04fab7ef7b7a
+  data.tar.gz: c7211733816c992c5ce91d5fea8ca8de2d12552d
 SHA512:
-  metadata.gz: 203a56c05ef6d18ab3ba8b9de406749a55689d25fb3776b744986c753bcd0a174ffe8f364521f5cca9255b7f196feea76f5fd94bde48c63d8bc4fb2e9a3f8ce9
-  data.tar.gz: 195f31cb8264650bb0b9922dc436575fa3ba33c4c0ecb8f4f2efb2c62033131f11e93d9ba9fff3c710b67bcd0dd96c5601e06a6b5cb9678e72b8abab6b985d2a
+  metadata.gz: 3ae8a30684b5081c38453dd908a10347071da7456338cb6c1f65fa040918ab970ffe88900e54cecadddb58c56e5f4133221421aa1e48b6b12c8ee2c43a095f2f
+  data.tar.gz: 786a072ec3e57cc9ba785b5d175adb2934d70157e0f93367bbd1a3664211f2150853622b51123dcac66893ae79b98565f9367c69a599e9d5d67db8aa13159502

data/CONTRIBUTING.md CHANGED Viewed

@@ -16,6 +16,11 @@ Here are the answers to some common questions.
 Then you **must** use FriendlyId 5, which is currently available in the master
 branch of the repository, and will be released to Rubygems soon.
+### I'm seeing a bunch of odd characters at the end of the id
+For example: `2bc08962-b3dd-4f29-b2e6-244710c86106`. FriendlyId 5 uses a UUID
+rather than a sequence to simplify slug generation and avoid concurrency problems.
 ### How do I set up my routes for FriendlyId?
 Exactly like in any other Rails app. FriendlyId doesn't change any routing

data/Guide.md CHANGED Viewed

@@ -83,6 +83,56 @@ 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
@@ -241,12 +291,8 @@ whether for a single slug or for slug candidates.
 #### Deciding When to Generate New Slugs
-Previous versions of FriendlyId provided a method named
-`should_generate_new_friendly_id?` which you could override to control when new
-slugs were generated.
 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:
+you want a slug to be regenerated,set the slug field to nil:
     restaurant.friendly_id # joes-diner
     restaurant.name = "The Plaza Diner"
@@ -256,6 +302,18 @@ you want a slug to be regenerated, you must explicity set the field to 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

data/README.md CHANGED Viewed

@@ -1,4 +1,4 @@
-# FriendlyId
+[![Build Status](https://travis-ci.org/norman/friendly_id.png)](https://travis-ci.org/norman/friendly_id)
 **VERSION NOTE**
@@ -11,7 +11,9 @@ If you wish to use this gem with Rails 3.1 or 3.2 you need to use FriendlyId ver
 Please see [4.0-stable
 branch](https://github.com/norman/friendly_id/tree/4.0-stable).
-[![Build Status](https://travis-ci.org/norman/friendly_id.png)](https://travis-ci.org/norman/friendly_id)
+# 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>
 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
@@ -43,8 +45,15 @@ with 4.x.
 Here's a summary of the most important changes:
-* FriendlyId no longer overrides `find`. If you want to do friendly finds, you
-  must do `Model.friendly.find` rather than `Model.find`.
+* FriendlyId no longer overrides `find` by default. If you want to do friendly finds,
+  you must do `Model.friendly.find` rather than `Model.find`. You can however easily
+  restore FriendlyId 4-style finders by using the `:finders` addon:
+```ruby
+friendly_id :foo, use: :slugged # you must do MyClass.friendly.find('bar')
+# or...
+friendly_id :foo, use: [:slugged, :finders] # you can now do MyClass.find('bar')
+```
 * 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
@@ -69,13 +78,11 @@ end
 ```
 * Now that candidates have been added, FriendlyId no longer uses a numeric
-  sequence to differentiate conflicting slug, but rather a GUID. This makes the
+  sequence to differentiate conflicting slug, but rather a UUID (e.g. something
+  like `2bc08962-b3dd-4f29-b2e6-244710c86106`). This makes the
   codebase simpler and more reliable when running concurrently, at the expense
   of uglier ids being generated when there are conflicts.
-* The Globalize module has been removed and will be released as its own gem.
-  Note that it has not yet been developed.
 * The default sequence separator is now `-` rather than `--`.
 * Slugs are no longer regenerated when a record is saved. If you want to regenerate

data/Rakefile CHANGED Viewed

@@ -48,6 +48,7 @@ task :guide do
   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")

data/bench.rb CHANGED Viewed

@@ -25,15 +25,24 @@ class Manual < ActiveRecord::Base
   friendly_id :name, :use => :history
 end
+class Restaurant < ActiveRecord::Base
+  extend FriendlyId
+  relation.class.send(:include, FriendlyId::FinderMethods)
+  friendly_id :name
+end
 BOOKS       = []
 JOURNALISTS = []
 MANUALS     = []
+RESTAURANTS = []
 100.times do
   name = Faker::Name.name
   BOOKS       << (Book.create! :name => name).id
   JOURNALISTS << (Journalist.create! :name => name).friendly_id
   MANUALS     << (Manual.create! :name => name).friendly_id
+  RESTAURANTS << (Restaurant.create! :name => name).friendly_id
 end
 ActiveRecord::Base.connection.execute "UPDATE manuals SET slug = NULL"
@@ -47,6 +56,10 @@ Benchmark.bmbm do |x|
     N.times {Journalist.friendly.find JOURNALISTS.rand}
   end
+  x.report 'find (in-table slug; included FinderMethods)' do
+    N.times {Restaurant.find RESTAURANTS.rand}
+  end
   x.report 'find (external slug)' do
     N.times {Manual.friendly.find MANUALS.rand}
   end
@@ -62,4 +75,4 @@ Benchmark.bmbm do |x|
   x.report 'insert (external slug)' do
     N.times {transaction {Manual.create :name => Faker::Name.name}}
   end
-end
+end

data/lib/friendly_id.rb CHANGED Viewed

@@ -3,7 +3,7 @@ require "thread"
 require "friendly_id/base"
 require "friendly_id/object_utils"
 require "friendly_id/configuration"
-require "friendly_id/finders"
+require "friendly_id/finder_methods"
 =begin
@@ -51,6 +51,7 @@ module FriendlyId
   autoload :Reserved,   "friendly_id/reserved"
   autoload :Scoped,     "friendly_id/scoped"
   autoload :Slugged,    "friendly_id/slugged"
+  autoload :Finders,    "friendly_id/finders"
   # FriendlyId takes advantage of `extended` to do basic model setup, primarily
   # extending {FriendlyId::Base} to add {FriendlyId::Base#friendly_id

data/lib/friendly_id/base.rb CHANGED Viewed

@@ -191,8 +191,8 @@ often better and easier to use {FriendlyId::Slugged slugs}.
       include Model
     end
-    # Return a scope that includes the friendly finders.
-    # @see FriendlyId::Finders
+    # Returns a scope that includes the friendly finders.
+    # @see FriendlyId::FinderMethods
     def friendly
       # Guess what? This causes Rails to invoke `extend` on the scope, which has
       # the well-known effect of blowing away Ruby's method cache. It would be
@@ -203,7 +203,7 @@ often better and easier to use {FriendlyId::Slugged slugs}.
       # and maintainability. If you'd like to improve the performance, your
       # efforts would be best directed at improving it at the root cause
       # of the problem - in Rails - because it would benefit more people.
-      all.extending(Finders)
+      all.extending(FinderMethods)
     end
     # Returns the model class's {FriendlyId::Configuration friendly_id_config}.

data/lib/friendly_id/configuration.rb CHANGED Viewed

@@ -67,7 +67,7 @@ module FriendlyId
       end
     end
-    # Returns whether the given module is in use
+    # Returns whether the given module is in use.
     def uses?(mod)
       @model_class < get_module(mod)
     end
@@ -84,7 +84,7 @@ module FriendlyId
     private
     def get_module(object)
-      Module === object ? object : FriendlyId.const_get(object.to_s.classify)
+      Module === object ? object : FriendlyId.const_get(object.to_s.titleize.camelize.gsub(/\s+/, ''))
     end
     def set(values)

data/lib/friendly_id/finder_methods.rb ADDED Viewed

@@ -0,0 +1,50 @@
+module FriendlyId
+  module FinderMethods
+    # Finds a record using the given id.
+    #
+    # If the id is "unfriendly", it will call the original find method.
+    # If the id is a numeric string like '123' it will first look for a friendly
+    # id matching '123' and then fall back to looking for a record with the
+    # numeric id '123'.
+    #
+    # Since FriendlyId 5.0, if the id is a numeric string like '123-foo' it
+    # will *only* search by friendly id and not fall back to the regular find
+    # method.
+    #
+    # If you want to search only by the friendly id, use {#find_by_friendly_id}.
+    # @raise ActiveRecord::RecordNotFound
+    def find(*args)
+      id = args.first
+      return super if args.count != 1 || id.unfriendly_id?
+      first_by_friendly_id(id).tap {|result| return result unless result.nil?}
+      return super if Integer(id, 10) rescue nil
+      raise ActiveRecord::RecordNotFound
+    end
+    # Returns true if a record with the given id exists.
+    def exists?(conditions = :none)
+      return super unless conditions.friendly_id?
+      exists_by_friendly_id?(conditions)
+    end
+    # Finds exclusively by the friendly id, completely bypassing original
+    # `find`.
+    # @raise ActiveRecord::RecordNotFound
+    def find_by_friendly_id(id)
+      first_by_friendly_id(id) or raise ActiveRecord::RecordNotFound
+    end
+    private
+    def first_by_friendly_id(id)
+      where(friendly_id_config.query_field => id).first
+    end
+    def exists_by_friendly_id?(id)
+      where(friendly_id_config.query_field => id).exists?
+    end
+  end
+end

data/lib/friendly_id/finders.rb CHANGED Viewed

@@ -1,51 +1,62 @@
 module FriendlyId
+=begin
+## Performing Finds with FriendlyId
-  # These are the finder methods that are added to the +friendly+ scope.
-  module Finders
+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.
-    # Finds a record using the given id.
-    #
-    # If the id is "unfriendly", it will call the original find method.
-    # If the id is a numeric string like '123' it will first look for a friendly
-    # id matching '123' and then fall back to looking for a record with the
-    # numeric id '123'.
-    #
-    # Since FriendlyId 5.0, if the id is a numeric string like '123-foo' it
-    # will *only* search by friendly id and not fall back to the regular find
-    # method.
-    #
-    # If you want to search only by the friendly id, use {#find_by_friendly_id}.
-    # @raise ActiveRecord::RecordNotFound
-    def find(*args)
-      id = args.first
-      return super if args.count != 1 || id.unfriendly_id?
-      first_by_friendly_id(id).tap {|result| return result unless result.nil?}
-      return super if Integer(id, 10) rescue nil
-      raise ActiveRecord::RecordNotFound
-    end
+By default, these methods are available only on the `friendly` scope:
-    # Returns true if a record with the given id exists.
-    def exists?(conditions = :none)
-      return super unless conditions.friendly_id?
-      exists_by_friendly_id?(conditions)
-    end
+    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
-    # Finds exclusively by the friendly id, completely bypassing original
-    # +find+.
-    # @raise ActiveRecord::RecordNotFound
-    def find_by_friendly_id(id)
-      first_by_friendly_id(id) or raise ActiveRecord::RecordNotFound
+      scope :active, -> {where(:active => true)}
+      friendly_id :name, :use => [:slugged, :finders]
     end
-    private
+    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:
-    def first_by_friendly_id(id)
-      where(friendly_id_config.query_field => id).first
+    # before
+    def set_restaurant
+      @restaurant = Restaurant.find(params[:id])
     end
-    def exists_by_friendly_id?(id)
-      where(friendly_id_config.query_field => id).exists?
+    # after
+    def set_restaurant
+      @restaurant = Restaurant.friendly.find(params[:id])
     end
+=end
+  module Finders
+    def self.included(model_class)
+      model_class.send(:relation).class.send(:include, FriendlyId::FinderMethods)
+      if model_class.friendly_id_config.uses? :history
+        model_class.send(:relation).class.send(:include, FriendlyId::History::HistoryFinderMethods)
+      end
+    end
   end
 end

data/lib/friendly_id/history.rb CHANGED Viewed

@@ -54,27 +54,33 @@ method.
 =end
   module History
+    def self.setup(model_class)
+      model_class.friendly_id_config.use :slugged
+    end
     # Configures the model instance to use the History add-on.
     def self.included(model_class)
       model_class.class_eval do
-        @friendly_id_config.use :slugged
         has_many :slugs, -> {order("#{Slug.quoted_table_name}.id DESC")}, {
           :as         => :sluggable,
           :dependent  => :destroy,
           :class_name => Slug.to_s
         }
+        if model_class.friendly_id_config.uses? :finders
+          model_class.send(:relation).class.send(:include, HistoryFinderMethods)
+        end
         after_save :create_slug
         def self.friendly
-          all.extending(HistoryFinders)
+          all.extending(HistoryFinderMethods)
         end
       end
     end
-    module HistoryFinders
-      include Finders
+    module HistoryFinderMethods
+      include FinderMethods
       private

data/lib/friendly_id/slugged.rb CHANGED Viewed

@@ -162,12 +162,8 @@ whether for a single slug or for slug candidates.
 #### Deciding When to Generate New Slugs
-Previous versions of FriendlyId provided a method named
-`should_generate_new_friendly_id?` which you could override to control when new
-slugs were generated.
 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:
+you want a slug to be regenerated,set the slug field to nil:
     restaurant.friendly_id # joes-diner
     restaurant.name = "The Plaza Diner"
@@ -177,6 +173,18 @@ you want a slug to be regenerated, you must explicity set the field to 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

data/lib/friendly_id/version.rb CHANGED Viewed

@@ -1,3 +1,3 @@
 module FriendlyId
-  VERSION = "5.0.0.beta1"
-end
+  VERSION = "5.0.0.beta2"
+end

data/test/finders_test.rb ADDED Viewed

@@ -0,0 +1,29 @@
+require "helper"
+class JournalistWithFriendlyFinders < ActiveRecord::Base
+  self.table_name = 'journalists'
+  extend FriendlyId
+  scope :existing, -> {where('1 = 1')}
+  friendly_id :name, use: [:slugged, :finders]
+end
+class Finders < MiniTest::Unit::TestCase
+  include FriendlyId::Test
+  def model_class
+    JournalistWithFriendlyFinders
+  end
+  test 'should find records with finders as class methods' do
+    with_instance_of(model_class) do |record|
+      assert model_class.find(record.friendly_id)
+    end
+  end
+  test 'should find records with finders on relations' do
+    with_instance_of(model_class) do |record|
+      assert model_class.existing.find(record.friendly_id)
+    end
+  end
+end

data/test/history_test.rb CHANGED Viewed

@@ -136,6 +136,37 @@ class HistoryTestWithSti < HistoryTest
   end
 end
+class HistoryTestWithFriendlyFinders < HistoryTest
+  class Journalist < ActiveRecord::Base
+    extend FriendlyId
+    friendly_id :name, :use => [:slugged, :finders, :history]
+  end
+  class Restaurant < ActiveRecord::Base
+    extend FriendlyId
+    belongs_to :city
+    friendly_id :name, :use => [:slugged, :history, :finders]
+  end
+  test "should be findable by old slugs" do
+    [Journalist, Restaurant].each do |model_class|
+      with_instance_of(model_class) do |record|
+        old_friendly_id = record.friendly_id
+        record.name = record.name + "b"
+        record.slug = nil
+        record.save!
+        begin
+          assert model_class.find(old_friendly_id)
+          assert model_class.exists?(old_friendly_id), "should exist? by old id"
+        rescue ActiveRecord::RecordNotFound
+          flunk "Could not find record by old id"
+        end
+      end
+    end
+  end
+end
 class City < ActiveRecord::Base
   has_many :restaurants
 end

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: friendly_id
 version: !ruby/object:Gem::Version
-  version: 5.0.0.beta1
+  version: 5.0.0.beta2
 platform: ruby
 authors:
 - Norman Clarke
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2013-08-11 00:00:00.000000000 Z
+date: 2013-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -167,6 +167,7 @@ files:
 - lib/friendly_id/base.rb
 - lib/friendly_id/candidates.rb
 - lib/friendly_id/configuration.rb
+- lib/friendly_id/finder_methods.rb
 - lib/friendly_id/finders.rb
 - lib/friendly_id/history.rb
 - lib/friendly_id/migration.rb
@@ -188,6 +189,7 @@ files:
 - test/configuration_test.rb
 - test/core_test.rb
 - test/databases.yml
+- test/finders_test.rb
 - test/generator_test.rb
 - test/helper.rb
 - test/history_test.rb