mongoid_slug 0.8.3 → 0.9.0

data/README.md

@@ -81,5 +81,17 @@ specify the `:inverse_of` option on the other side of the assocation.
 
 Embedded objects are automatically scoped by their parent.
 
+If the value of `:scope` is not an association, it should be the name of a field within the model itself:
+
+```ruby
+class Employee
+ include Mongoid::Document
+ include Mongoid::Slug
+ field :name
+ field :company_id
+ slug  :name, :scope => :company_id
+end
+```
+
 [1]: https://github.com/rsl/stringex/
-[2]: https://github.com/papercavalier/mongoid-slug/blob/master/lib/mongoid/slug.rb
+[2]: https://github.com/hakanensari/mongoid-slug/blob/master/lib/mongoid/slug.rb

data/lib/mongoid/slug.rb

@@ -3,8 +3,8 @@ require 'stringex'
 
 module Mongoid #:nodoc:
 
-  # The slug module helps you generate a URL slug or permalink based on one or
-  # more fields in a Mongoid model.
+  # The slug module helps you generate a URL slug or permalink based on
+  # one or more fields in a Mongoid model.
   #
   #    class Person
   #      include Mongoid::Document
@@ -18,7 +18,10 @@ module Mongoid #:nodoc:
     extend ActiveSupport::Concern
 
     included do
-      cattr_accessor :slug_builder, :slugged_fields, :slug_name, :slug_scope
+      cattr_accessor :slug_builder,
+                     :slugged_fields,
+                     :slug_name,
+                     :slug_scope
     end
 
     module ClassMethods
@@ -29,26 +32,28 @@ module Mongoid #:nodoc:
       #
       # The options hash respects the following members:
       #
-      # * `:as`, which specifies name of the field that stores the slug.
-      # Defaults to `slug`.
+      # * `:as`, which specifies name of the field that stores the
+      # slug. Defaults to `slug`.
       #
-      # * `:scope`, which specifies a reference association to scope the slug
-      # by. Embedded documents are by default scoped by their parent.
+      # * `:scope`, which specifies a reference association to scope
+      # the slug by. Embedded documents are by default scoped by their
+      # parent.
       #
-      # * `:permanent`, which specifies whether the slug should be immutable
-      # once created. Defaults to `false`.
+      # * `:permanent`, which specifies whether the slug should be
+      # immutable once created. Defaults to `false`.
       #
-      # * `:index`, which specifies whether an index should be defined for the
-      # slug. Defaults to `false` and has no effect if the document is em-
-      # bedded. Make sure you have a unique index on the slug of root
-      # documents to avoid the (very unlikely) race condition that would ensue
-      # if two documents with identical slugs were to be saved simultaneously.
+      # * `:index`, which specifies whether an index should be defined
+      # for the slug. Defaults to `false` and has no effect if the
+      # document is embedded. Make sure you have a unique index on the
+      # slug of root documents to avoid the (very unlikely) race
+      # condition that would ensue if two documents with identical
+      # slugs were to be saved simultaneously.
       #
-      # Alternatively, this method can be given a block to build a custom slug
-      # out of the specified fields.
+      # Alternatively, this method can be given a block to build a
+      # custom slug out of the specified fields.
       #
-      # The block takes a single argument, the document itself, and should
-      # return a string that will serve as the base of the slug.
+      # The block takes a single argument, the document itself, and
+      # should return a string that will serve as the base of the slug.
       #
       # Here, for instance, we slug an array field.
       #
@@ -72,7 +77,8 @@ module Mongoid #:nodoc:
             block
           else
             lambda do |doc|
-              slugged_fields.map { |f| doc.read_attribute(f) }.join(' ')
+              slugged_fields.map { |f| doc.read_attribute(f) }.
+                             join(' ')
             end
           end
 
@@ -119,35 +125,54 @@ module Mongoid #:nodoc:
       # TODO: An epic method which calls for refactoring.
       slug = slug_builder.call(self).to_url
 
-      # Regular expression that matches slug, slug-1, slug-2, ... slug-n
-      # If slug_name field was indexed, MongoDB will utilize that index to
-      # match /^.../ pattern
+      # Regular expression that matches slug, slug-1, ... slug-n
+      # If slug_name field was indexed, MongoDB will utilize that
+      # index to match /^.../ pattern.
       pattern = /^#{Regexp.escape(slug)}(?:-(\d+))?$/
 
-      existing_slugs =
-        uniqueness_scope.
-        only(slug_name).
-        where(slug_name => pattern, :_id.ne => _id).
-        map { |obj| obj.try(:read_attribute, slug_name) }
+      if slug_scope &&
+         self.class.reflect_on_association(slug_scope).nil?
+        # scope is not an association, so it's scoped to a local field
+        # (e.g. an association id in a denormalized db design)
+        existing_slugs =
+          self.class.
+          only(slug_name).
+          where(slug_name  => pattern,
+                :_id.ne    => _id,
+                slug_scope => self[slug_scope])
+      else
+        existing_slugs =
+          uniqueness_scope.
+          only(slug_name).
+          where(slug_name => pattern, :_id.ne => _id)
+      end
+
+      existing_slugs = existing_slugs.map do |obj|
+        obj.try(:read_attribute, slug_name)
+      end
 
-      if existing_slugs.count > 0      
-        # sort the existing_slugs in increasing order by comparing the suffix
-        # numbers:
+      if existing_slugs.count > 0
+        # Sort the existing_slugs in increasing order by comparing the
+        # suffix numbers:
         # slug, slug-1, slug-2, ..., slug-n
         existing_slugs.sort! do |a, b|
-          (pattern.match(a)[1] || -1).to_i <=> (pattern.match(b)[1] || -1).to_i
+          (pattern.match(a)[1] || -1).to_i <=>
+          (pattern.match(b)[1] || -1).to_i
         end
-        max_counter = existing_slugs.last.match(/-(\d+)$/).try(:[], 1).to_i
+        max = existing_slugs.last.match(/-(\d+)$/).try(:[], 1).to_i
 
-        # Use max_counter + 1 as unique counter
-        slug += "-#{max_counter + 1}"
+        slug += "-#{max + 1}"
       end
 
       slug
     end
 
     def generate_slug
-      if new_record? || slugged_fields_changed?
+      # Generate a slug for new records only if the slug was not set.
+      # If we're not a new record generate a slug if our slugged fields
+      # changed on us.
+      if (new_record? && !read_attribute(slug_name)) ||
+         (!new_record? && slugged_fields_changed?)
         generate_slug!
       end
     end
@@ -165,20 +190,20 @@ module Mongoid #:nodoc:
         metadata = self.class.reflect_on_association(slug_scope)
         parent = self.send(metadata.name)
 
-        # Make sure doc is actually associated with something, and that some
-        # referenced docs have been persisted to the parent
+        # Make sure doc is actually associated with something, and that
+        # some referenced docs have been persisted to the parent
         #
-        # TODO: we need better reflection for reference associations, like
-        # association_name instead of forcing collection_name here -- maybe
-        # in the forthcoming Mongoid refactorings?
+        # TODO: we need better reflection for reference associations,
+        # like association_name instead of forcing collection_name here
+        # -- maybe in the forthcoming Mongoid refactorings?
         inverse = metadata.inverse_of || collection_name
         parent.respond_to?(inverse) ? parent.send(inverse) : self.class
       elsif embedded?
-        parent_metadata = reflect_on_all_associations(:embedded_in).first
+        parent_metadata = reflect_on_all_associations(:embedded_in)[0]
         _parent.send(parent_metadata.inverse_of || self.metadata.name)
       else
         appropriate_class = self.class
-        while (appropriate_class.superclass.include?(Mongoid::Document))
+        while appropriate_class.superclass.include?(Mongoid::Document)
           appropriate_class = appropriate_class.superclass
         end
         appropriate_class

data/lib/mongoid/slug/version.rb

@@ -1,5 +1,5 @@
 module Mongoid #:nodoc:
   module Slug
-    VERSION = '0.8.3'
+    VERSION = '0.9.0'
   end
 end

data/spec/models/magazine.rb

@@ -0,0 +1,7 @@
+class Magazine
+  include Mongoid::Document
+  include Mongoid::Slug
+  field :title
+  field :publisher_id
+  slug  :title, :scope => :publisher_id
+end

data/spec/mongoid/slug_spec.rb

@@ -236,6 +236,23 @@ module Mongoid
         end
       end
     end
+    
+    context "when slug is scoped by one of the class's own fields" do
+      let!(:magazine) do
+        Magazine.create(:title  => "Big Weekly", :publisher_id => "abc123")
+      end
+
+      it "should scope by local field" do
+        magazine.to_param.should eql 'big-weekly'
+        magazine2 = Magazine.create(:title => "Big Weekly", :publisher_id => "def456")
+        magazine2.to_param.should eql magazine.to_param
+      end
+
+      it "should generate a unique slug by appending a counter to duplicate text" do
+        dup = Magazine.create(:title  => "Big Weekly", :publisher_id => "abc123")
+        dup.to_param.should eql 'big-weekly-1'
+      end
+    end
 
     context "when :slug is given a block" do
       let(:caption) do
@@ -369,5 +386,12 @@ module Mongoid
         book.reload.slug.should eql "proust-and-signs"
       end
     end
+    
+    context "when the slugged field is set upon creation" do
+      it "respects the provided slug and does not generate a new one" do
+        book = Book.create(:title => "A Thousand Plateaus", :slug => 'not-what-you-expected')
+        book.to_param.should eql "not-what-you-expected"
+      end
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongoid_slug
 version: !ruby/object:Gem::Version
-  version: 0.8.3
+  version: 0.9.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-20 00:00:00.000000000Z
+date: 2012-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid
-  requirement: &70160200453060 !ruby/object:Gem::Requirement
+  requirement: &70354887937940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '2.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70160200453060
+  version_requirements: *70354887937940
 - !ruby/object:Gem::Dependency
   name: stringex
-  requirement: &70160200452160 !ruby/object:Gem::Requirement
+  requirement: &70354887953780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '1.3'
   type: :runtime
   prerelease: false
-  version_requirements: *70160200452160
+  version_requirements: *70354887953780
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70160200451400 !ruby/object:Gem::Requirement
+  requirement: &70354887953320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '0.9'
   type: :development
   prerelease: false
-  version_requirements: *70160200451400
+  version_requirements: *70354887953320
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70160200450620 !ruby/object:Gem::Requirement
+  requirement: &70354887952860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,7 +54,7 @@ dependencies:
         version: '2.6'
   type: :development
   prerelease: false
-  version_requirements: *70160200450620
+  version_requirements: *70354887952860
 description: Mongoid Slug generates a URL slug or permalink based on one or more fields
   in a Mongoid model.
 email:
@@ -72,6 +72,7 @@ files:
 - spec/models/author.rb
 - spec/models/book.rb
 - spec/models/caption.rb
+- spec/models/magazine.rb
 - spec/models/page.rb
 - spec/models/partner.rb
 - spec/models/person.rb
@@ -91,21 +92,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -3230490500102343809
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -3230490500102343809
 requirements: []
 rubyforge_project: mongoid_slug
-rubygems_version: 1.8.6
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: Generates a URL slug
@@ -114,6 +109,7 @@ test_files:
 - spec/models/author.rb
 - spec/models/book.rb
 - spec/models/caption.rb
+- spec/models/magazine.rb
 - spec/models/page.rb
 - spec/models/partner.rb
 - spec/models/person.rb