mongoid_slug 0.7.2 → 0.8.0

data/lib/mongoid/slug.rb

@@ -39,7 +39,9 @@ module Mongoid #:nodoc:
       #
       # * `: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.
+      # 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.
       #
       # Alternatively, this method can be given a block to build a custom slug
       # out of the specified fields.
@@ -59,9 +61,9 @@ module Mongoid #:nodoc:
       #      end
       #
       def slug(*fields, &block)
-        options = fields.extract_options!
-        self.slug_scope = options[:scope]
-        self.slug_name = options[:as] || :slug
+        options             = fields.extract_options!
+        self.slug_scope     = options[:scope]
+        self.slug_name      = options[:as] || :slug
         self.slugged_fields = fields.map(&:to_s)
 
         self.slug_builder =
@@ -69,7 +71,7 @@ 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
 
@@ -94,20 +96,13 @@ module Mongoid #:nodoc:
           end
 
           def self.find_by_#{slug_name}!(slug)
-            where(slug_name => slug).first || raise(Mongoid::Errors::DocumentNotFound.new(self.class, slug))
+            where(slug_name => slug).first ||
+              raise(Mongoid::Errors::DocumentNotFound.new(self.class, slug))
           end
         CODE
       end
     end
 
-    # Regenerates slug.
-    #
-    # Should come in handy when generating slugs for an existing collection.
-    def slug!
-      generate_slug!
-      save
-    end
-
     # Returns the slug.
     def to_param
       read_attribute(slug_name)
@@ -116,20 +111,29 @@ module Mongoid #:nodoc:
     private
 
     def find_unique_slug
+      # 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
-      pattern = /^#{Regexp.escape(slug)}(?:-\d+)?$/
+      pattern = /^#{Regexp.escape(slug)}(?:-(\d+))?$/
       
-      # Get the maximum counter slug
-      max_counter_slug = uniqueness_scope.only(slug_name).
+      existing_slugs =
+        uniqueness_scope.
+        only(slug_name).
         where(slug_name => pattern, :_id.ne => _id).
-        order_by([slug_name, :desc]).first.try(:read_attribute, slug_name)
+        map {|obj| obj.try(:read_attribute, slug_name)}
       
-      if max_counter_slug
-        max_counter = max_counter_slug.match(/-(\d+)$/).try(:[], 1).to_i
+      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
+        end
+        max_counter = existing_slugs.last.match(/-(\d+)$/).try(:[], 1).to_i
+
         # Use max_counter + 1 as unique counter
         slug += "-#{max_counter + 1}"
       end

data/lib/mongoid/slug/version.rb

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

data/spec/models/page.rb

@@ -0,0 +1,9 @@
+class Page
+  include Mongoid::Document
+  include Mongoid::Slug
+  field :title
+  field :content
+  field :order, :type => Integer
+  slug  :title
+  default_scope asc(:order)
+end

data/spec/mongoid/slug_spec.rb

@@ -19,8 +19,10 @@ module Mongoid
       end
 
       it "generates a unique slug by appending a counter to duplicate text" do
-        dup = Book.create(:title => book.title)
-        dup.to_param.should eql "a-thousand-plateaus-1"
+        15.times{ |x|
+          dup = Book.create(:title => book.title)
+          dup.to_param.should eql "a-thousand-plateaus-#{x+1}"
+        }
       end
 
       it "does not update slug if slugged fields have not changed" do
@@ -39,6 +41,12 @@ module Mongoid
       end
     end
 
+    context "when using default_scope on a model" do
+      it "find_unique_slug should work correctly" do
+        Page.create!(:title => "Title", :content => "Content", :order => 1)
+      end
+    end
+
     context "when the object is embedded" do
       let(:subject) do
         book.subjects.create(:name => "Psychoanalysis")
@@ -322,32 +330,6 @@ module Mongoid
       end
     end
 
-    describe "#slug!" do
-      before do
-        class Foo
-          include Mongoid::Document
-          field :name
-        end
-      end
-
-      let!(:foo) do
-        Foo.create(:name => "John")
-      end
-
-      it "regenerates slug" do
-        class Foo
-          include Mongoid::Slug
-          slug :name
-        end
-
-        foo.reload.slug.should be_nil
-
-        foo.slug!
-
-        foo.reload.slug.should eql 'john'
-      end
-    end
-
     describe ".find_by_slug" do
       let!(:book) { Book.create(:title => "A Thousand Plateaus") }
 

data/spec/spec_helper.rb

@@ -15,7 +15,7 @@ require File.expand_path("../../lib/mongoid/slug", __FILE__)
 
 Dir["#{File.dirname(__FILE__)}/models/*.rb"].each { |f| require f }
 
-Rspec.configure do |c|
+RSpec.configure do |c|
   c.before(:all)  { DatabaseCleaner.strategy = :truncation }
   c.before(:each) { DatabaseCleaner.clean }
 end

metadata

@@ -1,8 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: mongoid_slug
 version: !ruby/object:Gem::Version 
-  prerelease: 
-  version: 0.7.2
+  prerelease: false
+  segments: 
+  - 0
+  - 8
+  - 0
+  version: 0.8.0
 platform: ruby
 authors: 
 - Paper Cavalier
@@ -10,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-14 00:00:00 +01:00
+date: 2011-06-10 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -21,7 +25,10 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: 2.0.0
+        segments: 
+        - 2
+        - 0
+        version: "2.0"
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -32,9 +39,40 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: 1.2.0
+        segments: 
+        - 1
+        - 2
+        version: "1.2"
   type: :runtime
   version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: database_cleaner
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 6
+        version: "0.6"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 6
+        version: "2.6"
+  type: :development
+  version_requirements: *id004
 description: Mongoid Slug generates a URL slug or permalink based on one or more fields in a Mongoid model.
 email: 
 - code@papercavalier.com
@@ -54,6 +92,7 @@ files:
 - spec/models/book.rb
 - spec/models/caption.rb
 - spec/models/comic_book.rb
+- spec/models/page.rb
 - spec/models/partner.rb
 - spec/models/person.rb
 - spec/models/relationship.rb
@@ -74,17 +113,21 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: mongoid_slug
-rubygems_version: 1.5.2
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Generates a URL slug
@@ -94,6 +137,7 @@ test_files:
 - spec/models/book.rb
 - spec/models/caption.rb
 - spec/models/comic_book.rb
+- spec/models/page.rb
 - spec/models/partner.rb
 - spec/models/person.rb
 - spec/models/relationship.rb