mongoid_slug 0.6.0 → 0.6.1

data/README.md

@@ -1,53 +1,56 @@
 Mongoid Slug
 ============
 
-Mongoid Slug generates a URL slug or permalink based on one or more fields in a Mongoid model. It sits on top of [stringex](https://github.com/rsl/stringex) and works with non-Latin characters.
+Mongoid Slug generates a URL slug or permalink based on one or more
+fields in a Mongoid model.
+
+It sits idly on top of [stringex](https://github.com/rsl/stringex) and
+works with non-Latin characters.
 
 Quick Start
----------------
+-----------
 
-First, add mongoid_slug to your Gemfile:
+Add mongoid_slug to your Gemfile:
 
     gem 'mongoid_slug', :require => 'mongoid/slug'
 
-Say you have a book that embeds many authors. You can set up slugs for both resources like this:
+Set up slugs in models like this:
 
     class Book
       include Mongoid::Document
       include Mongoid::Slug
+
       field :title
-      slug  :title
       embeds_many :authors
+
+      slug :title
     end
 
     class Author
       include Mongoid::Document
       include Mongoid::Slug
-      field :first_name
-      field :last_name
-      slug  :first_name, :last_name
+
+      field :first
+      field :last
       embedded_in :book, :inverse_of => :authors
+
+      slug :first, :last, :as => :name
     end
 
-In your controller, use the `find_by_slug` helper:
+Finder
+------
 
-    Book.find_by_slug(params[:book_id])
-    book.authors.find_by_slug(params[:id])
+In your controller, throw in some minimal magic:
 
-You can customize the name of the field that stores the slug:
+    # GET /books/a-thousand-plateaus/authors/authors/gilles-deleuze
+    author = Book.find_by_slug(params[:book_id]).
+                  authors.
+                  find_by_name(params[:id])
 
-    class Person
-      include Mongoid::Document
-      include Mongoid::Slug
-      field :name
-      slug  :name, :as => :permalink
-    end
+Permanence
+----------
 
-The finder now becomes:
-
-    Person.find_by_permalink(params[:id])
-
-To demo some more functionality in the console:
+By default, slugs are not permanent:
 
     >> book = Book.create(:title => "A Thousand Plateaus")
     >> book.to_param
@@ -56,47 +59,47 @@ To demo some more functionality in the console:
     >> book.save
     >> book.to_param
     "anti-oedipus"
-    >> author = book.authors.create(:first_name => "Gilles", :last_name => "Deleuze")
-    >> author.to_param
-    => "gilles-deleuze"
-    >> author.update_attributes(:first_name => "Félix", :last_name => "Guattari")
-    >> author.to_param
-    => "felix-guattari"
 
-Scoping by Associations
------------------------
+If you require permanent slugs, pass the `:permanent` option when
+defining the slug.
+
+Scope
+-----
+
+Embedded objects that are automatically scoped by their parent.
 
-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:
+To scope an object by a reference association, pass `:scope`:
 
     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
+      field :name
+      slug  :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:
+In this example, if you create an employee without associating it with
+any company, the scope will fall back to the root employees collection.
 
-    references_many :employees, :class_name => 'Person', :foreign_key => :company_id
+Currently, if you have an irregular association name, you **must**
+specify the `:inverse_of` option on the other side of the assocation.
 
-you **must** specify the `:inverse_of` option on the other side of the assocation.
+Indexes
+-------
 
-Indexing
---------
-
-You may optionally pass an `:index` option to generate an index on the slug in top-level objects.
+You may optionally pass an `:index` option to define an index on top-level
+slugs.
 
     class Book
       field :title
       slug  :title, :index => true
     end
 
-Indexes on non-scoped slugs will be unique.
+Indexes on unscoped slugs will be unique.
+
+This option has no effect if the object is embedded.

data/lib/mongoid/slug.rb

@@ -1,4 +1,3 @@
-#encoding: utf-8
 require 'stringex'
 
 module Mongoid #:nodoc:
@@ -125,7 +124,11 @@ module Mongoid #:nodoc:
         metadata = reflect_on_all_associations(:embedded_in).first
         _parent.send(metadata.inverse_of)
       else
-        self.class
+        appropriate_class = self.class
+        while (appropriate_class.superclass.include?(Mongoid::Document))
+          appropriate_class = appropriate_class.superclass
+        end
+        appropriate_class
       end
     end
   end

data/lib/mongoid/slug/version.rb

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

data/spec/models/comic_book.rb

@@ -0,0 +1,3 @@
+class ComicBook < Book
+  
+end

data/spec/mongoid/slug_spec.rb

@@ -159,12 +159,12 @@ module Mongoid
       end
     end
 
-    context "when the field name for the slug is set with the :as option" do
+    context "when :as is passed as an argument" do
       let!(:person) do
         Person.create(:name => "John Doe")
       end
 
-      it "sets the slug field name" do
+      it "sets an alternative slug field name" do
         person.should respond_to(:permalink)
         person.permalink.should eql "john-doe"
       end
@@ -174,12 +174,12 @@ module Mongoid
       end
     end
 
-    context "when slug is set to be permanent with the :permanent option" do
+    context "when :permanent is passed as an argument" do
       let(:person) do
         Person.create(:name => "John Doe")
       end
 
-      it "does not change the slug when the slugged fields are updated" do
+      it "does not update the slug when the slugged fields change" do
         person.name = "Jane Doe"
         person.save
         person.to_param.should eql "john-doe"
@@ -251,41 +251,47 @@ module Mongoid
       end
     end
 
-    context "when :index is set to true" do
+    context "when :index is passed as an argument" do
       before do
         Book.collection.drop_indexes
         Author.collection.drop_indexes
       end
 
-      it "indexes slug in top-level objects" do
+      it "defines an index on the 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
+        it "defines 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
+        it "defines 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
+      it "has no effect in embedded objects"
     end
 
-    context "when :index is not set" do
-      it "does not index slug" do
+    context "when :index is not passed as an argument" do
+      it "does not define an index on the slug" do
         Person.create_indexes
         Person.collection.index_information.should_not have_key "permalink_1"
       end
     end
+
+    context "when the object has STI" do
+      it "scopes by the superclass" do
+        book = Book.create(:title => "Anti Oedipus")
+        comic_book = ComicBook.create(:title => "Anti Oedipus")
+        comic_book.slug.should_not eql(book.title)
+      end
+    end
   end
 end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: mongoid_slug
 version: !ruby/object:Gem::Version 
+  hash: 5
   prerelease: false
   segments: 
   - 0
   - 6
-  - 0
-  version: 0.6.0
+  - 1
+  version: 0.6.1
 platform: ruby
 authors: 
 - Paper Cavalier
@@ -14,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-17 00:00:00 +00:00
+date: 2011-01-28 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -25,13 +26,14 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 15424089
         segments: 
         - 2
         - 0
         - 0
         - rc
-        - 5
-        version: 2.0.0.rc.5
+        - 6
+        version: 2.0.0.rc.6
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -42,6 +44,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 31
         segments: 
         - 1
         - 2
@@ -57,11 +60,12 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 31
         segments: 
         - 1
-        - 1
-        - 5
-        version: 1.1.5
+        - 2
+        - 0
+        version: 1.2.0
   type: :development
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
@@ -72,6 +76,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 7
         segments: 
         - 0
         - 6
@@ -87,6 +92,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 31
         segments: 
         - 2
         - 4
@@ -94,21 +100,6 @@ dependencies:
         version: 2.4.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
@@ -125,6 +116,7 @@ files:
 - README.md
 - spec/models/author.rb
 - spec/models/book.rb
+- spec/models/comic_book.rb
 - spec/models/partner.rb
 - spec/models/person.rb
 - spec/models/relationship.rb
@@ -145,6 +137,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
@@ -153,6 +146,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
@@ -166,6 +160,7 @@ summary: Generates a URL slug
 test_files: 
 - spec/models/author.rb
 - spec/models/book.rb
+- spec/models/comic_book.rb
 - spec/models/partner.rb
 - spec/models/person.rb
 - spec/models/relationship.rb