mongoid_slug 0.3.0 → 0.4.0

data/README.rdoc

@@ -7,13 +7,31 @@ This gem generates a URL slug/permalink based on fields in a Mongoid model.
       include Mongoid::Slug
       field :title
       slug  :title
+      embeds_many :authors
     end
-    
+
+    class Author
+      include Mongoid::Document
+      include Mongoid::Slug
+      field :first_name
+      field :last_name
+      slug  :first_name, :last_name
+      embedded_in :book, :inverse_of => :authors
+    end
+
     >> book = Book.create(:title => "A Thousand Plateaus")
     >> book.to_param
     "a-thousand-plateaus"
     >> book.update_attributes(:title => "Anti Oedipus")
     >> book.to_param
     "anti-oedipus"
-    >> Book.find_by_slug("anti-oedipus").first
+    >> Book.where(:slug => 'anti-oedipus').first
     #<Book _id: 4c23b1f7faa4a7479a000009, slug: "anti-oedipus", title: "Anti Oedipus">
+    >> 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.to_param
+    => "félix-guattari"
+    >> book.authors.where(:slug => 'felix-guattari).first
+    => #<Author _id: 4c31e362faa4a7050e000003, slug: "félix-guattari", last_name: "Guattari", first_name: "Félix">

data/lib/mongoid_slug.rb

@@ -3,22 +3,14 @@ module Mongoid::Slug
   extend ActiveSupport::Concern
 
   included do
-    cattr_accessor :slugged
+    cattr_accessor :slugged_fields
   end
 
   module ClassMethods #:nodoc:
     # Set a field or a number of fields as source of slug
     def slug(*fields)
-      self.slugged = fields
-      field :slug; index :slug, :unique => true; before_save :slugify
-    end
-
-    # This returns an array containing the match rather than
-    # the match itself.
-    #
-    # http://groups.google.com/group/mongoid/browse_thread/thread/5905589e108d7cc0
-    def find_by_slug(slug)
-      where(:slug => slug).limit(1)
+      self.slugged_fields = fields
+      field :slug; before_save :generate_slug
     end
   end
 
@@ -28,33 +20,40 @@ module Mongoid::Slug
 
   private
 
-  def slugify
-    if new_record? || slugged_changed?
-      self.slug = find_unique_slug
-    end
-  end
-
-  def slugged_changed?
-    self.class.slugged.any? do |field|
-      self.send(field.to_s + '_changed?')
+  def duplicates_of(slug, association_chain=[])
+    if embedded?
+      association_chain << association_name
+      _parent.send :duplicates_of, slug, association_chain
+    else
+      association_chain.reverse! << "slug"
+      collection.find(association_chain.join(".") => slug)
     end
   end
 
   def find_unique_slug(suffix='')
     slug = ("#{slug_base} #{suffix}").parameterize
 
-    if (embedded? ?
-        _parent.collection.find("#{association_name}.slug" => slug) :
-        collection.find(:slug => slug)
-      ).reject{ |doc| doc.id == self.id }.empty?
+    if duplicates_of(slug).reject{ |doc| doc.id == self.id }.empty?
       slug
     else
-      new_suffix = suffix.blank? ? '1' : "#{suffix.to_i + 1}"
-      find_unique_slug(new_suffix)
+      suffix = suffix.blank? ? '1' : "#{suffix.to_i + 1}"
+      find_unique_slug(suffix)
+    end
+  end
+
+  def generate_slug
+    if new_record? || slugged_fields_changed?
+      self.slug = find_unique_slug
     end
   end
 
   def slug_base
-    self.class.slugged.collect{ |field| self.send(field) }.join(" ")
+    self.class.slugged_fields.collect{ |field| self.send(field) }.join(" ")
+  end
+
+  def slugged_fields_changed?
+    self.class.slugged_fields.any? do |field|
+      self.send(field.to_s + '_changed?')
+    end
   end
 end

data/spec/models/author.rb

@@ -4,4 +4,5 @@ class Author
   field :first_name
   field :last_name
   slug  :first_name, :last_name
+  referenced_in :book
 end

data/spec/models/bar.rb

@@ -0,0 +1,8 @@
+class Bar
+  include Mongoid::Document
+  include Mongoid::Slug
+  field :name
+  slug  :name
+  embeds_many :bazes, :class_name => "Baz"
+  embedded_in :foo, :inverse_of => :bars
+end

data/spec/models/baz.rb

@@ -0,0 +1,8 @@
+class Baz
+  include Mongoid::Document
+  include Mongoid::Slug
+  field :name
+  field :other
+  slug  :name
+  embedded_in :bar, :inverse_of => :bazes
+end

data/spec/models/book.rb

@@ -6,4 +6,5 @@ class Book
   slug  :title
   embeds_one :publisher
   embeds_many :subjects
+  references_many :authors
 end

data/spec/models/foo.rb

@@ -0,0 +1,7 @@
+class Foo
+  include Mongoid::Document
+  include Mongoid::Slug
+  field :name
+  slug  :name
+  embeds_many :bars
+end

data/spec/mongoid_slug_spec.rb

@@ -43,10 +43,8 @@ describe Mongoid::Slug do
       @book.slug.should eql former_slug
     end
 
-    context ".find_by_slug" do
-      it "finds by slug" do
-        Book.find_by_slug(@book.slug).first.should eql @book
-      end
+    it "finds by slug" do
+      Book.where(:slug => @book.slug).first.should eql @book
     end
 
   end
@@ -86,10 +84,8 @@ describe Mongoid::Slug do
       @subject.slug.should eql former_slug
     end
 
-    context ".find_by_slug" do
-      it "finds by slug" do
-        @book.subjects.find_by_slug(@subject.slug).first.should eql @subject
-      end
+    it "finds by slug" do
+      @book.subjects.where(:slug => @subject.slug).first.should eql @subject
     end
 
   end
@@ -147,10 +143,76 @@ describe Mongoid::Slug do
       @author.slug.should_not match /\d$/
     end
 
-    context ".find_by_slug" do
-      it "finds by slug" do
-        Author.find_by_slug("gilles-deleuze").first.should eql @author
-      end
+    it "finds by slug" do
+      Author.where(:slug => "gilles-deleuze").first.should eql @author
     end
+
+  end
+
+  context "deeply embedded relationships" do
+
+    before(:each) do
+      @foo = Foo.create(:name => "foo")
+      @bar = @foo.bars.create(:name => "bar")
+      @baz = @bar.bazes.create(:name => "baz")
+      @baz = Foo.first.bars.first.bazes.first # Better to be paranoid and reload from db
+    end
+
+    it "generates slug" do
+      @baz.to_param.should eql(@baz.name.parameterize)
+    end
+
+    it "updates slug" do
+      @baz.update_attributes(:name => "lorem")
+      @baz.to_param.should eql "lorem".parameterize
+    end
+
+    it "generates a unique slug" do
+      similar_baz = @bar.bazes.create(:name => @baz.name)
+      similar_baz.to_param.should_not eql @baz.to_param
+    end
+
+    it "appends a counter when slug is not unique" do
+      similar_baz = @bar.bazes.create(:name => @baz.name)
+      similar_baz.slug.should match /\d$/
+    end
+
+    it "does not append a counter when slug is unique" do
+      @baz.slug.should_not match /\d$/
+    end
+
+    it "does not update slug if slugged field has not changed" do
+      former_slug = @baz.slug
+      @baz.update_attributes(:other => "Lorem ipsum dolor sit amet")
+      @baz.slug.should eql former_slug
+    end
+
+    it "finds by slug" do
+      @bar.bazes.where(:slug => @baz.slug).first.should eql @baz
+    end
+
+  end
+
+  describe "#duplicates_of" do
+
+    before(:each) do
+      @foo = Foo.create(:name => "foo")
+      @bar = @foo.bars.create(:name => "bar")
+      @baz = @bar.bazes.create(:name => "baz")
+    end
+
+    it "should find duplicate slug of a root document" do
+      @foo.send(:duplicates_of, @foo.slug).count.should eql 1
+    end
+
+    it "should find duplicate slug of an embedded document" do
+      @bar.send(:duplicates_of, @bar.slug).count.should eql 1
+    end
+
+    it "should find duplicate slug of a deeply-embedded document" do
+      @baz.send(:duplicates_of, @baz.slug).count.should eql 1
+    end
+
   end
+
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: mongoid_slug
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 15
   prerelease: false
   segments: 
   - 0
-  - 3
+  - 4
   - 0
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Hakan Ensari
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-30 00:00:00 +01:00
+date: 2010-07-05 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -50,7 +50,10 @@ files:
 - README.rdoc
 - lib/mongoid_slug.rb
 - spec/models/author.rb
+- spec/models/bar.rb
+- spec/models/baz.rb
 - spec/models/book.rb
+- spec/models/foo.rb
 - spec/models/publisher.rb
 - spec/models/subject.rb
 - spec/mongoid_slug_spec.rb
@@ -91,7 +94,10 @@ specification_version: 3
 summary: Generates a URL slug in a Mongoid model
 test_files: 
 - spec/models/author.rb
+- spec/models/bar.rb
+- spec/models/baz.rb
 - spec/models/book.rb
+- spec/models/foo.rb
 - spec/models/publisher.rb
 - spec/models/subject.rb
 - spec/mongoid_slug_spec.rb