friendly_id 3.1.8 → 3.2.0.beta1

data/Changelog.md

@@ -6,6 +6,11 @@ suggestions, ideas and improvements to FriendlyId.
 * Table of Contents
 {:toc}
 
+## 3.2.0 (NOT RELEASED YET)
+
+* Removes `:scope` as a find parameter, allowing more flexible finds with
+  scoped records.
+
 ## 3.1.8 (2010-11-22)
 
 * Fix compatibility with Active Record 3.0.3.

data/Guide.md

@@ -445,8 +445,8 @@ the slug "joes-diner" if it's located in a different city:
     http://example.org/cities/seattle/restaurants/joes-diner
     http://example.org/cities/chicago/restaurants/joes-diner
 
-    Restaurant.find("joes-diner", :scope => "seattle")  # returns 1 record
-    Restaurant.find("joes-diner", :scope => "chicago")  # returns 1 record
+    City.find("seattle").restaurants.find("joes-diner")  # returns 1 record
+    City.find("chicago").restaurants.find("joes-diner")  # returns 1 record
 
 The value for the `:scope` key in your model can be a custom method you
 define, or the name of a relation. If it's the name of a relation, then the
@@ -454,15 +454,45 @@ scope's text value will be the result of calling `to_param` on the related
 model record. In the example above, the city model also uses FriendlyId and so
 its `to_param` method returns its friendly_id: "chicago" or "seattle".
 
+### Complications with Scoped Slugs
+
+#### 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")
+
+may return the wrong record. In these cases when you want to use the friendly\_id for queries,
+either query as a relation, or specify the scope in your query conditions:
+
+    # will only return restaurants named "Joe's Diner" in the given city
+    @city.restaurants.find("joes-diner")
+
+    # or
+
+    Restaurants.find("joes-diner", :include => :slugs, :conditions => {:slugs => {:scope => @city.to_param}})
+
+
+#### Finding All Records That Match a Scoped ID
+
 If you want to find all records with a partular friendly\_id regardless of scope,
-this is a slightly more complicated, but doable:
+the easiest way is to use cached slugs and query this column directly:
+
+    Restaurant.find_all_by_cached_slug("joes-diner")
+    # Another option, with Active Record 3.x
+    Restaurant.where(:cached_slug => "joes-diner")
+
+
+If you're not using cached slugs, then this is slightly more complicated, but
+still doable:
 
     name, sequence = params[:id].parse_friendly_id
-    Restaurant.find(:all, :joins => :slugs, :conditions => {
+    Restaurant.all(:include => :slugs, :conditions => {
       :slugs => {:name => name, :sequence => sequence}
     })
 
-### Updating a Relation's Scoped Slugs
+
+#### Updating a Relation's Scoped Slugs
 
 When using a relation as the scope, updating the relation will update the
 slugs, but only if both models have specified the relationship. In the above
@@ -477,23 +507,26 @@ this up:
 
     # in routes.rb
     map.resources :restaurants
-    map.restaurant "/restaurants/:scope/:id", :controller => "restaurants"
+    map.restaurant "/restaurants/:city_id/:id", :controller => "restaurants"
 
     # in views
     link_to 'Show', restaurant_path(restaurant.city, restaurant)
 
     # in controllers
-    @restaurant = Restaurant.find(params[:id], :scope => params[:scope])
+    @city = City.find(params[:city_id])
+    @restaurant = @city.resaturants.find(params[:id])
 
 ### Scoped Models and Cached Slugs
 
-Be aware that you can't use cached slugs with scoped models. This is because in
-order to uniquely identify a scoped model, you need to consult two fields rather
-than one. I've considered adding a "cached scope" column as well as one for the
-cached slug, but I'm not convinced this is a good idea. FriendlyId 3.1.6 and
-above included significant performance optimizations for models that don't use
-cached slugs, so in practice this ends up being [less of a performance problem
-than you may imagine](#some_benchmarks).
+If you want to use cached slugs with scoped models, be sure not to create a unique index on the
+`cached_slug` column.
+
+### Scoped Models in FriendyId Before 3.2.0
+
+In older versions of FriendlyId, you could specify a non-standard `:scope`
+argument to finds. This feature has been removed in 3.2.0 in favor of the query
+stategies described above.
+
 
 ## FriendlyId Rake Tasks
 

data/Rakefile

@@ -1,4 +1,5 @@
 require "rubygems"
+require "bundler/setup"
 require "rake"
 require "rake/testtask"
 require "rake/gempackagetask"

data/lib/friendly_id/active_record_adapter/finders.rb

@@ -12,7 +12,6 @@ module FriendlyId
         attr :klass
         attr :id
         attr :options
-        attr :scope_val
         attr :result
         attr :friendly_ids
         attr :unfriendly_ids
@@ -21,8 +20,6 @@ module FriendlyId
           @klass     = klass
           @id        = id
           @options   = options
-          @scope_val = options.delete(:scope)
-          @scope_val = @scope_val.to_param if @scope_val && @scope_val.respond_to?(:to_param)
         end
 
         def find_one
@@ -37,9 +34,6 @@ module FriendlyId
           scope = some_friendly_scope
           if use_slugs? && @friendly_ids.present?
             scope = scope.scoped(:joins => :slugs)
-            if fc.scope?
-              scope = scope.scoped(:conditions => {:slugs => {:scope => scope_val}})
-            end
           end
           options[:readonly] = false unless options[:readonly]
           @result = scope.all(options).uniq
@@ -47,13 +41,6 @@ module FriendlyId
           @result.each { |record| record.friendly_id_status.name = id }
         end
 
-        def raise_error(error)
-          raise(error) unless fc.scope?
-          scope_message = scope_val || "expected, but none given"
-          message = "%s, scope: %s" % [error.message, scope_message]
-          raise ActiveRecord::RecordNotFound, message
-        end
-
         private
 
         def find_one_with_cached_slug
@@ -64,7 +51,6 @@ module FriendlyId
         def find_one_with_slug
           name, seq = id.to_s.parse_friendly_id
           scope = scoped(:joins => :slugs, :conditions => {:slugs => {:name => name, :sequence => seq}})
-          scope = scope.scoped(:conditions => {:slugs => {:scope => scope_val}}) if fc.scope?
           options[:readonly] = false unless options[:readonly]
           @result = scope.first(options)
           assign_status
@@ -146,16 +132,12 @@ module FriendlyId
         return super if id.blank? || id.unfriendly_id?
         finder = Find.new(self, id, options)
         finder.find_one or super
-      rescue ActiveRecord::RecordNotFound => error
-        finder ? finder.raise_error(error) : raise(error)
       end
 
       def find_some(ids, options)
         return super if ids.empty?
         finder = Find.new(self, ids, options)
         finder.find_some
-      rescue ActiveRecord::RecordNotFound => error
-        finder ? finder.raise_error(error) : raise(error)
       end
     end
   end

data/lib/friendly_id/active_record_adapter/relation.rb

@@ -9,8 +9,7 @@ module FriendlyId
         attr :ids
         alias id ids
 
-        def_delegators :relation, :arel, :arel_table, :friendly_id_scope,
-                       :klass, :limit_value, :offset_value, :where
+        def_delegators :relation, :arel, :arel_table, :klass, :limit_value, :offset_value, :where
         def_delegators :klass, :connection, :friendly_id_config
         alias fc friendly_id_config
 
@@ -20,7 +19,7 @@ module FriendlyId
         end
 
         def find_one
-          if fc.cache_column? && !fc.scope?
+          if fc.cache_column?
             find_one_with_cached_slug
           elsif fc.use_slugs?
             find_one_with_slug
@@ -39,13 +38,6 @@ module FriendlyId
           validate_expected_size!(ids, records)
         end
 
-        def raise_error(error)
-          raise(error) unless fc.scope
-          scope_message = friendly_id_scope || "expected, but none given"
-          message = "%s, scope: %s" % [error.message, scope_message]
-          raise ActiveRecord::RecordNotFound, message
-        end
-
         private
 
         def assign_status
@@ -67,7 +59,14 @@ module FriendlyId
         end
 
         def find_one_with_slug
-          sluggable_id = sluggable_ids_for([id]).first
+          sluggable_ids = sluggable_ids_for([id])
+
+          if sluggable_ids.size > 1 && fc.scope?
+            return relation.where(relation.primary_key.in(sluggable_ids)).first
+          end
+
+          sluggable_id = sluggable_ids.first
+
           if sluggable_id
             name, seq = id.to_s.parse_friendly_id
             record = relation.send(:find_one_without_friendly, sluggable_id)
@@ -80,7 +79,7 @@ module FriendlyId
         end
 
         def friendly_records(friendly_ids, unfriendly_ids)
-          use_slugs_table =  fc.use_slugs? && (fc.scope? || !fc.cache_column?)
+          use_slugs_table =  fc.use_slugs? && (!fc.cache_column?)
           return find_some_using_slug(friendly_ids, unfriendly_ids) if use_slugs_table
           column     = fc.cache_column || fc.column
           friendly   = arel_table[column].in(friendly_ids)
@@ -105,14 +104,6 @@ module FriendlyId
             string = fragment % [connection.quote(klass.base_class), connection.quote(name), seq]
             clause ? clause + " OR #{string}" : string
           end
-          if fc.scope?
-            conditions = if friendly_id_scope
-              scope = connection.quote(friendly_id_scope)
-              "slugs.scope = %s AND (%s)" % [scope, conditions]
-            else
-              "slugs.scope IS NULL AND (%s)" % [conditions]
-            end
-          end
           sql = "SELECT sluggable_id FROM slugs WHERE (%s)" % conditions
           connection.select_values sql
         end
@@ -142,16 +133,6 @@ module FriendlyId
         end
       end
 
-      attr :friendly_id_scope
-
-      # This method overrides Active Record's default in order to allow the :scope option to
-      # be passed to finds.
-      def apply_finder_options(options)
-        @friendly_id_scope = options.delete(:scope)
-        @friendly_id_scope = @friendly_id_scope.to_param if @friendly_id_scope.respond_to?(:to_param)
-        super
-      end
-
       protected
 
       def find_one(id)
@@ -159,8 +140,6 @@ module FriendlyId
           return super if !klass.uses_friendly_id? or id.unfriendly_id?
           find = Find.new(self, id)
           find.find_one or super
-        rescue ActiveRecord::RecordNotFound => error
-          find ? find.raise_error(error) : raise(error)
         end
       end
 
@@ -172,10 +151,7 @@ module FriendlyId
           ids = ids.map {|id| (id.respond_to?(:friendly_id_config) ? id.id : id).to_i}
           super
         end
-      rescue ActiveRecord::RecordNotFound => error
-        find ? find.raise_error(error) : raise(error)
       end
-
     end
   end
-end
+end

data/lib/friendly_id/version.rb

@@ -1,9 +1,9 @@
 module FriendlyId
   module Version
     MAJOR = 3
-    MINOR = 1
-    TINY = 8
-    BUILD = nil
+    MINOR = 2
+    TINY = 0
+    BUILD = "beta1"
     STRING = [MAJOR, MINOR, TINY, BUILD].compact.join('.')
   end
 end

data/test/active_record_adapter/scoped_model_test.rb

@@ -29,7 +29,7 @@ module FriendlyId
       test "should not use cached slug column with scopes" do
         @tourist  = Tourist.create!(:name => "John Smith", :country => @usa)
         @tourist2 = Tourist.create!(:name => "John Smith", :country => @canada)
-        assert_equal @canada, Tourist.find(@tourist2.friendly_id, :scope => @canada).country
+        assert_equal @canada, @canada.residents.find(@tourist2.friendly_id).country
       end
 
       test "a slugged model should auto-detect that it is being used as a parent scope" do
@@ -81,49 +81,18 @@ module FriendlyId
             :slugs => {:name => name, :sequence => sequence}}).size
       end
 
-      test "should find a single scoped record with a scope as a string" do
-        assert Resident.find(@resident.friendly_id, :scope => @resident.country.to_param)
+      test "should find a scoped record by friendly_id" do
+        assert Resident.find(@resident.friendly_id)
       end
 
-      test "should find a single scoped record with a scope" do
-        assert Resident.find(@resident.friendly_id, :scope => @resident.country)
+      test "should find a scope record as a relation member" do
+        assert_equal @resident, @usa.residents.find("john-smith")
+        assert_equal @resident2, @canada.residents.find("john-smith")
       end
 
-      test "should find a single scoped record with a nil scope" do
-        nomad  = Resident.create!(:name => "Homer", :country => nil)
-        assert Resident.find(nomad.friendly_id, :scope => nil)
-      end
-
-      test "should find a multiple scoped records with a scope" do
-        r1 = Resident.create!(:name => "John Smith", :country => @usa)
-        r2 = Resident.create!(:name => "Jane Smith", :country => @usa)
-        result = Resident.find([r1, r2].map(&:friendly_id), :scope => @resident.country)
-        assert_equal 2, result.size
-      end
-
-
-      test "should raise an error when finding a single scoped record with no scope" do
-        assert_raises ActiveRecord::RecordNotFound do
-          Resident.find(@resident.friendly_id)
-        end
-      end
-
-      test "should append scope error info when missing scope causes a find to fail" do
-        begin
-          Resident.find(@resident.friendly_id)
-          fail "The find should not have succeeded"
-        rescue ActiveRecord::RecordNotFound => e
-          assert_match(/scope: expected/, e.message)
-        end
-      end
-
-      test "should append scope error info when the scope value causes a find to fail" do
-        begin
-          Resident.find(@resident.friendly_id, :scope => "badscope")
-          fail "The find should not have succeeded"
-        rescue ActiveRecord::RecordNotFound => e
-          assert_match(/scope: badscope/, e.message)
-        end
+      test "should find a single scoped record using slug conditions" do
+        assert_equal @resident, Resident.find(@resident.friendly_id, :include => :slugs,
+          :conditions => {:slugs => {:scope => @resident.country.to_param}})
       end
 
       test "should update the sluggable field when a polymorphic relationship exists" do
@@ -141,4 +110,4 @@ module FriendlyId
       end
     end
   end
-end
+end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: friendly_id
 version: !ruby/object:Gem::Version 
-  prerelease: false
+  prerelease: true
   segments: 
   - 3
-  - 1
-  - 8
-  version: 3.1.8
+  - 2
+  - 0
+  - beta1
+  version: 3.2.0.beta1
 platform: ruby
 authors: 
 - Norman Clarke
@@ -16,12 +17,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-22 00:00:00 -03:00
+date: 2010-11-23 00:00:00 -03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: babosa
-  prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -33,10 +33,10 @@ dependencies:
         - 0
         version: 0.2.0
   type: :runtime
+  prerelease: false
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: activerecord
-  prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -48,10 +48,10 @@ dependencies:
         - 0
         version: 3.0.0
   type: :development
+  prerelease: false
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: mocha
-  prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -62,10 +62,10 @@ dependencies:
         - 9
         version: "0.9"
   type: :development
+  prerelease: false
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: sqlite3-ruby
-  prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -75,6 +75,7 @@ dependencies:
         - 1
         version: "1"
   type: :development
+  prerelease: false
   version_requirements: *id004
 description: "    FriendlyId is the \"Swiss Army bulldozer\" of slugging and permalink plugins\n    for Ruby on Rails. It allows you to create pretty URL's and work with\n    human-friendly strings as if they were numeric ids for ActiveRecord models.\n"
 email: 
@@ -159,17 +160,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: -2292774950521045189
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version 
       segments: 
-      - 0
-      version: "0"
+      - 1
+      - 3
+      - 1
+      version: 1.3.1
 requirements: []
 
 rubyforge_project: friendly-id