mongoid_slug 0.1.0 → 0.2.0

data/README.rdoc

@@ -1,6 +1,6 @@
 = Mongoid Slug
 
-This gem generates a URL slug/permalink based on a field in a Mongoid model.
+This gem generates a URL slug/permalink based on a field or set of fields in a Mongoid model.
 
     class Book
       include Mongoid::Document
@@ -15,3 +15,5 @@ This gem generates a URL slug/permalink based on a field in a Mongoid model.
     >> book.update_attributes(:title => "Anti Oedipus")
     >> book.to_param
     "anti-oedipus"
+    >> Book.find_by_slug("anti-oedipus")
+    #<Book _id: 4c23b1f7faa4a7479a000009, slug: "anti-oedipus", title: "Anti Oedipus">

data/lib/mongoid_slug.rb

@@ -7,14 +7,18 @@ module Mongoid::Slug
   end
 
   module ClassMethods #:nodoc:
-    
+
     # Set a field as source of slug
-    def slug(field)
-      class_variable_set(:@@slugged_field, field.to_sym)
+    def slug(*field)
+      class_variable_set(:@@slugged_fields, field)
     end
 
     def find_by_slug(slug)
-      where(:slug => slug).first
+      if embedded?
+        raise 'I have not implemented this method yet for embedded docs. Try: parent.children.where(:slug => "foo") instead'
+      else
+        where(:slug => slug).first
+      end
     end
   end
 
@@ -25,12 +29,18 @@ module Mongoid::Slug
   private
 
   def slugify
-    self.slug = find_unique_slug if new_record? || self.send((self.class.class_eval('@@slugged_field').to_s + '_changed?').to_sym)
+    self.slug = find_unique_slug if new_record? || slugged_fields_changed?
+  end
+
+  def slugged_fields_changed?
+    self.class.class_eval('@@slugged_fields').any? do |field|
+      self.send(field.to_s + '_changed?')
+    end
   end
 
   def find_unique_slug(suffix='')
-    slug = ("#{slugged_field} #{suffix}").parameterize
-    if collection.find(:slug => slug).count == 0
+    slug = ("#{slug_base} #{suffix}").parameterize
+    if (embedded? ? self._parent.collection.find("#{self.class.to_s.downcase.pluralize}.slug" => slug) : collection.find(:slug => slug)).count == 0
       slug
     else
       new_suffix = suffix.blank? ? '1' : "#{suffix.to_i + 1}"
@@ -38,7 +48,7 @@ module Mongoid::Slug
     end
   end
 
-  def slugged_field
-    self.send(self.class.class_eval('@@slugged_field'))
+  def slug_base
+    self.class.class_eval('@@slugged_fields').collect{ |field| self.send(field) }.join(" ")
   end
 end

data/spec/models/author.rb

@@ -0,0 +1,7 @@
+class Author
+  include Mongoid::Document
+  include Mongoid::Slug
+  field :first_name
+  field :last_name
+  slug  :first_name, :last_name
+end

data/spec/models/book.rb

@@ -2,6 +2,8 @@ class Book
   include Mongoid::Document
   include Mongoid::Slug
   field :title
-  field :authors
-  slug :title
+  field :isbn
+  slug  :title
+  embeds_one :publisher
+  embeds_many :subjects
 end

data/spec/models/publisher.rb

@@ -0,0 +1,9 @@
+class Publisher
+  include Mongoid::Document
+  include Mongoid::Slug
+  field :name
+  field :year, :type => Integer
+  field :place
+  slug  :name
+  embedded_in :book, :inverse_of => :publisher
+end

data/spec/models/subject.rb

@@ -0,0 +1,7 @@
+class Subject
+  include Mongoid::Document
+  include Mongoid::Slug
+  field :name
+  slug  :name
+  embedded_in :book, :inverse_of => :subjects
+end

data/spec/unit/mongoid_slug_spec.rb

@@ -1,40 +1,154 @@
 require "spec_helper"
 
 describe Mongoid::Slug do
+
   before(:each) do
-    @book = ::Book.create(:title => "A Thousand Plateaus", :authors => "Gilles Deleuze, Félix Guattari")
+    @book = Book.create(:title => "A Thousand Plateaus", :isbn => "9789245242475")
   end
 
-  it "generates slug" do
-    @book.to_param.should eql @book.title.parameterize
-  end
+  context "root" do
 
-  it "updates slug" do
-    @book.update_attributes(:title => "Anti Oedipus")
-    @book.reload.to_param.should eql "Anti Oedipus".parameterize
-  end
+    it "generates slug" do
+      @book.to_param.should eql @book.title.parameterize
+    end
 
-  it "generates a unique slug" do
-    similar_book = Book.create(:title => @book.title)
-    similar_book.to_param.should_not eql @book.to_param
-  end
+    it "updates slug" do
+      @book.update_attributes(:title => "Anti Oedipus")
+      @book.to_param.should eql "Anti Oedipus".parameterize
+    end
+
+    it "generates a unique slug" do
+      similar_book = Book.create(:title => @book.title)
+      similar_book.to_param.should_not eql @book.to_param
+    end
+
+    it "appends a counter when slug is not unique" do
+      similar_book = Book.create(:title => @book.title)
+      similar_book.slug.should match /\d$/
+    end
+
+    it "does not append a counter when slug is unique" do
+      @book.slug.should_not match /\d$/
+    end
+
+    it "does not update slug if slugged field has not changed" do
+      existing_slug = @book.slug
+      @book.update_attributes('isbn' => "9785545858118")
+      @book.slug.should eql existing_slug
+    end
+
+    context ".find_by_slug" do
+      it "finds by slug" do
+        Book.find_by_slug(@book.slug).should eql @book
+      end
+    end
 
-  it "appends a counter when slug is not unique" do
-    similar_book = Book.create(:title => @book.title)
-    similar_book.slug.should match /\d$/
   end
 
-  it "does not append a counter when slug is unique" do
-    @book.slug.should_not match /\d$/
+  context "embedded has many" do
+
+    before(:each) do
+      @subject = @book.subjects.create(:name => "Psychoanalysis")
+    end
+
+    it "generates slug" do
+      @subject.to_param.should eql(@subject.name.parameterize)
+    end
+
+    it "updates slug" do
+      @subject.update_attributes(:name => "Schizoanalysis")
+      @subject.to_param.should eql "Schizoanalysis".parameterize
+    end
+
+    it "generates a unique slug" do
+      similar_subject = @book.subjects.create(:model => @subject.name)
+      similar_subject.to_param.should_not eql @subject.to_param
+    end
+
+    it "appends a counter when slug is not unique" do
+      similar_subject = @book.subjects.create(:name => @subject.name)
+      similar_subject.slug.should match /\d$/
+    end
+
+    it "does not append a counter when slug is unique" do
+      @subject.slug.should_not match /\d$/
+    end
+
+    it "does not update slug if slugged field has not changed" do
+      existing_slug = @subject.slug
+      @subject.update_attributes(:description => "Lorem ipsum dolor sit amet")
+      @subject.slug.should eql existing_slug
+    end
+
+    context ".find_by_slug" do
+      it "raises error" do
+        lambda { @book.subjects.find_by_slug(@subject.slug) }.should raise_error
+      end
+
+      it "does find by a regular where" do
+        @book.subjects.where(:slug => @subject.slug).first.should eql @subject
+      end
+    end
+
   end
 
-  it "does not update slug if slugged field has not changed" do
-    existing_slug = @book.slug
-    @book.update_attributes('authors' => "Gilles Deleuze")
-    @book.slug.should eql existing_slug
+  context "embedded has one" do
+
+    before(:each) do
+      @publisher = @book.create_publisher(:name => "OUP")
+    end
+
+    it "generates slug" do
+      @publisher.to_param.should eql(@publisher.name.parameterize)
+    end
+
+    it "updates slug" do
+      @publisher.update_attributes(:name => "Harvard UP")
+      @publisher.to_param.should eql "Harvard UP".parameterize
+    end
+
+    it "does not update slug if slugged field has not changed" do
+      existing_slug = @publisher.slug
+      @publisher.update_attributes(:year => 2001)
+      @publisher.slug.should eql existing_slug
+    end
+
   end
 
-  it "finds by slug" do
-    Book.find_by_slug(@book.slug).should eql @book
+  context "slugging composite fields" do
+    before(:each) do
+      @author = Author.create(:first_name => "Gilles", :last_name => "Deleuze")
+    end
+
+    it "generates slug" do
+      @author.to_param.should eql("Gilles Deleuze".parameterize)
+    end
+
+    it "updates slug" do
+      @author.update_attributes(:first_name => "Félix", :last_name => "Guattari")
+      @author.to_param.should eql "Félix Guattari".parameterize
+    end
+
+    it "generates a unique slug" do
+      similar_author = Author.create(:first_name => @author.first_name,
+                                     :last_name => @author.last_name)
+      similar_author.to_param.should_not eql @author.to_param
+    end
+
+    it "appends a counter when slug is not unique" do
+      similar_author = Author.create(:first_name => @author.first_name,
+                                     :last_name => @author.last_name)
+      similar_author.slug.should match /\d$/
+    end
+
+    it "does not append a counter when slug is unique" do
+      @author.slug.should_not match /\d$/
+    end
+
+    context ".find_by_slug" do
+      it "finds by slug" do
+        Author.find_by_slug("gilles-deleuze").should eql @author
+      end
+    end
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: mongoid_slug
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 23
   prerelease: false
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Hakan Ensari
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-22 00:00:00 +01:00
+date: 2010-06-24 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -48,7 +48,10 @@ files:
 - LICENSE
 - README.rdoc
 - lib/mongoid_slug.rb
+- spec/models/author.rb
 - spec/models/book.rb
+- spec/models/publisher.rb
+- spec/models/subject.rb
 - spec/spec_helper.rb
 - spec/unit/mongoid_slug_spec.rb
 has_rdoc: true
@@ -86,6 +89,9 @@ signing_key:
 specification_version: 3
 summary: Generates a URL slug in a Mongoid model
 test_files: 
+- spec/models/author.rb
 - spec/models/book.rb
+- spec/models/publisher.rb
+- spec/models/subject.rb
 - spec/spec_helper.rb
 - spec/unit/mongoid_slug_spec.rb