mongoid_slug 0.5.0 → 0.5.1

data/README.md

@@ -51,6 +51,44 @@ To demo some more functionality in the console:
     >> author = book.authors.create(:first_name => "Gilles", :last_name => "Deleuze")
     >> author.to_param
     => "gilles-deleuze"
-    >> author.update_attributes(:first => "Félix", :last_name => "Guattari")
+    >> author.update_attributes(:first_name => "Félix", :last_name => "Guattari")
     >> author.to_param
     => "felix-guattari"
+
+Scoping by Associations
+-----------------------
+
+Objects that are embedded in a parent document automatically have their slug uniqueness scoped to the parent. If you wish to scope by a reference association, you can pass a `:scope` option to the `slug` class method:
+
+    class Company
+      include Mongoid::Document
+      field :name
+      references_many :employees
+    end
+
+    class Employee
+      include Mongoid::Document
+      include Mongoid::Slug
+      field :first_name
+      field :last_name
+      slug  :first_name, :last_name, :scope => :company
+      referenced_in :company
+    end
+
+In this example, if you create an employee without associating it with any company, the slug scope will fall back to the root employees collection. Currently if you have an irregular association name, for instance:
+
+    references_many :employees, :class_name => 'Person', :foreign_key => :company_id
+
+you **must** specify the `:inverse_of` option on the other side of the assocation.
+
+Indexing
+--------
+
+You may optionally pass an `:index` option to generate an index on the slug in top-level objects.
+
+    class Book
+      field :title
+      slug  :title, :index => true
+    end
+
+Indexes on non-scoped slugs will be unique.

data/lib/mongoid/slug.rb

@@ -9,7 +9,7 @@ module Mongoid #:nodoc:
     extend ActiveSupport::Concern
 
     included do
-      cattr_accessor :slug_name, :slugged_fields
+      cattr_accessor :slug_name, :slugged_fields, :slug_scope
     end
 
     module ClassMethods
@@ -20,14 +20,30 @@ module Mongoid #:nodoc:
       # alternative name with the :as option.
       #
       # If you wish the slug to be permanent once created, set :permanent to true.
+      #
+      # To index slug in a top-level object, set :index to true.
       def slug(*fields)
         options = fields.extract_options!
 
         self.slug_name      = options[:as] || :slug
+        self.slug_scope     = options[:scope] || nil
         self.slugged_fields = fields
 
+        if options[:scoped]
+          ActiveSupport::Deprecation.warn <<-EOM
+
+            The :scoped => true option is deprecated and now default for embedded
+            child documents. Please use :scope => :association_name if you wish
+            to scope by a reference association.
+          EOM
+        end
+
         field slug_name
 
+        if options[:index]
+          index slug_name, :unique => (slug_scope ? false : true)
+        end
+
         if options[:permanent]
           before_create :generate_slug
         else
@@ -86,14 +102,29 @@ module Mongoid #:nodoc:
     end
 
     def unique_slug?(slug)
-      if embedded?
+      uniqueness_scope.where(slug_name => slug).
+        reject { |doc| doc.id == self.id }.
+        empty?
+    end
+
+    def uniqueness_scope
+      if slug_scope
+        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
+        #
+        # 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.send(association_name)
       else
         self.class
-      end.
-        where(slug_name => slug).
-        reject { |doc| doc.id == self.id }.
-        empty?
+      end
     end
   end
 end

data/lib/mongoid/slug/version.rb

@@ -1,5 +1,5 @@
 module Mongoid #:nodoc:
   module Slug
-    VERSION = "0.5.0"
+    VERSION = "0.5.1"
   end
 end

data/spec/models/author.rb

@@ -3,6 +3,9 @@ class Author
   include Mongoid::Slug
   field :first_name
   field :last_name
-  slug  :first_name, :last_name
+  slug  :first_name, :last_name, :scope => :book, :index => true
   referenced_in :book
+  references_many :characters,
+                  :class_name => 'Person',
+                  :foreign_key => :author_id
 end

data/spec/models/book.rb

@@ -2,7 +2,7 @@ class Book
   include Mongoid::Document
   include Mongoid::Slug
   field :title
-  slug  :title
+  slug  :title, :index => true
   embeds_many :subjects
   references_many :authors
 end

data/spec/models/person.rb

@@ -2,6 +2,7 @@ class Person
   include Mongoid::Document
   include Mongoid::Slug
   field :name
-  slug  :name, :as => :permalink, :permanent => true
+  slug  :name, :as => :permalink, :permanent => true, :scope => :author
   embeds_many :relationships
+  referenced_in :author, :inverse_of => :characters
 end

data/spec/mongoid/slug_spec.rb

@@ -182,6 +182,47 @@ module Mongoid
       end
     end
 
+    context "when slug is scoped by a reference association" do
+      let(:author) do
+        book.authors.create(:first_name => "Gilles", :last_name  => "Deleuze")
+      end
+
+      it "scopes by parent object" do
+        book2 = Book.create(:title => "Anti Oedipus")
+        dup = book2.authors.create(
+          :first_name => author.first_name,
+          :last_name => author.last_name
+        )
+        dup.to_param.should eql author.to_param
+      end
+
+      it "generates a unique slug by appending a counter to duplicate text" do
+        dup = book.authors.create(
+          :first_name => author.first_name,
+          :last_name  => author.last_name)
+        dup.to_param.should eql 'gilles-deleuze-1'
+      end
+
+      context "with an irregular association name" do
+        let(:character) do
+          # well we've got to make up something... :-)
+          author.characters.create(:name => "Oedipus")
+        end
+
+        let!(:author2) do
+          Author.create(
+            :first_name => "Sophocles",
+            :last_name => "son of Sophilos"
+          )
+        end
+
+        it "scopes by parent object provided that inverse_of is specified" do
+          dup = author2.characters.create(:name => character.name)
+          dup.to_param.should eql character.to_param
+        end
+      end
+    end
+
     it "works with non-Latin characters" do
       book.title = "Капитал"
       book.save
@@ -195,5 +236,52 @@ module Mongoid
       book.save
       book.to_param.should eql 'zhong-wen'
     end
+
+    it "deprecates the :scoped option" do
+      ActiveSupport::Deprecation.should_receive(:warn)
+      class Oldie
+        include Mongoid::Document
+        include Mongoid::Slug
+        field :name
+        slug  :name, :scoped => true
+      end
+    end
+
+    context "when :index is set to true" do
+      before do
+        Book.collection.drop_indexes
+        Author.collection.drop_indexes
+      end
+
+      it "indexes slug in top-level objects" do
+        Book.create_indexes
+        Book.collection.index_information.should have_key "slug_1"
+      end
+
+      context "when slug is scoped by a reference association" do
+        it "creates a non-unique index" do
+          Author.create_indexes
+          Author.index_information["slug_1"]["unique"].should be_false
+        end
+      end
+
+      context "when slug is not scoped by a reference association" do
+        it "creates a unique index" do
+          Book.create_indexes
+          Book.index_information["slug_1"]["unique"].should be_true
+        end
+      end
+
+      it "does not index slug in embedded objects" do
+        pending "Would such an option even make sense?"
+      end
+    end
+
+    context "when :index is not set" do
+      it "does not index slug" do
+        Person.create_indexes
+        Person.collection.index_information.should_not have_key "permalink_1"
+      end
+    end
   end
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 5
-  - 0
-  version: 0.5.0
+  - 1
+  version: 0.5.1
 platform: ruby
 authors: 
 - Paper Cavalier
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-28 00:00:00 -03:00
+date: 2010-12-30 00:00:00 -03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -94,6 +94,21 @@ dependencies:
         version: 2.3.0
   type: :development
   version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: ruby-debug19
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 11
+        - 0
+        version: 0.11.0
+  type: :development
+  version_requirements: *id006
 description: Mongoid Slug generates a URL slug or permalink based on one or more fields in a Mongoid model.
 email: 
 - code@papercavalier.com