mongoid_slug 2.0.1 → 3.0.0.rc1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ODMzODllM2NkMGQ3ZjJiYjFjNDdjMzUwYWU4ZWJkYjg2NTI0NTkyZg==
+  data.tar.gz: !binary |-
+    YmQ3MTlmYjZlMmRmZWNkZWEyY2I5NGU1OGM0ZmE4NDlhYjRjMmYxMg==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NTVhOGRjYzBlOTc2MTYwMTgzNzdhNjQ4NjRhNGQyZWFhOWU5ZTlhZTJmMzgz
+    Y2QwYjM3ZDhhZGI2MWQ2OTZiZDQ0OTBkNmU3YmM5ODE2NmJlM2Q2Y2ZjN2Qy
+    NWE5M2I1YTk0YzFkYWE4ZGE0MDgxZjNhOTBjZmQwZTBkYWJlODc=
+  data.tar.gz: !binary |-
+    MjE2ZjA5MGIyYjkzYmNjM2MzMzZmYmMwNDU4MjlhZjU1NDRlZWU2YWUwNTRi
+    ZWNmMzU2ZjM3ZTMyOGI3MzUwMjg3YWRmOWUxNzY1NmY0ZTY4OTY2OTQwMjVj
+    NjcwZjQ4NmViNjgzODA0MzZiNDBkOTAyZTA2Y2Y5MjQ5MGE4MDg=

data/README.md

@@ -1,4 +1,4 @@
-*IMPORTANT:*  If you are upgrading to Mongoid Slug 1.0.0 please migrate in accordance with the instructions in https://github.com/digitalplaywright/mongoid-slug/wiki/How-to-upgrade-to-1.0.0.
+*IMPORTANT:*  If you are upgrading to Mongoid Slug 1.0.0 please migrate in accordance with the instructions in https://github.com/digitalplaywright/mongoid-slug/wiki/How-to-upgrade-to-1.0.0-or-newer.
 Mongoid Slug 1.0.0  stores the slugs in a single field _slugs of array type, and all previous slugs must be migrated.
 
 Mongoid Slug
@@ -69,7 +69,7 @@ Post.fields['_id'].type
 => String
 post = Post.find 'a-thousand-plateaus' # Finds by slugs
 => ...
-post = Post.find '....1000/Plateus' # Finds by ids
+post = Post.find '50b1386a0482939864000001' # Finds by bson ids
 => ...
 ```
 [Read here] [4] for all available options.
@@ -80,7 +80,7 @@ Custom Slug Generation
 By default Mongoid Slug generates slugs with stringex. If this is not desired you can
 define your own slug generator like this:
 
-```
+```ruby
 class Caption
   include Mongoid::Document
   include Mongoid::Slug
@@ -91,8 +91,8 @@ class Caption
     cur_object.slug_builder.to_url
   end
 end
-
 ```
+You can call stringex `to_url` method.
 
 Scoping
 -------
@@ -102,17 +102,17 @@ To scope a slug by a reference association, pass `:scope`:
 ```ruby
 class Company
   include Mongoid::Document
-  
+
   references_many :employees
 end
 
 class Employee
   include Mongoid::Document
   include Mongoid::Slug
-  
+
   field :name
   referenced_in :company
-  
+
   slug  :name, :scope => :company
 end
 ```
@@ -131,10 +131,10 @@ The value of `:scope` can alternatively be a field within the model itself:
 class Employee
   include Mongoid::Document
   include Mongoid::Slug
-  
+
   field :name
   field :company_id
-  
+
   slug  :name, :scope => :company_id
 end
 ```
@@ -149,9 +149,9 @@ To specify that the history of a document should be kept track of, pass
 class Page
   include Mongoid::Document
   include Mongoid::Slug
-  
+
   field :title
-  
+
   slug :title, history: true
 end
 ```
@@ -184,6 +184,39 @@ Friend.find('admin') # => nil
 friend.slug # => 'admin-1'
 ```
 
+When reserved words are not specified, the words 'new' and 'edit' are considered reserved by default.
+Specifying an array of custom reserved words will overwrite these defaults.
+
+Custom Find Strategies
+--------------
+
+By default find will search for the document by the id field if the provided id
+looks like a BSON ObjectId, and it will otherwise find by the _slugs field. However,
+custom strategies can ovveride the default behavior, like e.g:
+
+```ruby
+module Mongoid::Slug::UuidIdStrategy
+  def self.call id
+    id =~ /\A([0-9a-fA-F]){8}-(([0-9a-fA-F]){4}-){3}([0-9a-fA-F]){12}\z/
+  end
+end
+```
+
+Use a custom strategy by adding the slug_id_strategy annotation to the _id field:
+
+```ruby
+class Entity
+  include Mongoid::Document
+  include Mongoid::Slug
+
+  field :_id, type: String, slug_id_strategy: UuidIdStrategy
+
+  field :user_edited_variation
+  slug  :user_edited_variation, :history => true
+end
+```
+
+
 Adhoc checking whether a string is unique on a per Model basis
 --------------------------------------------------------------
 
@@ -201,4 +234,4 @@ unique = Mongoid::Slug::UniqueSlug.new(Book.new).find_unique(title)
 [1]: https://github.com/rsl/stringex/
 [2]: https://secure.travis-ci.org/hakanensari/mongoid-slug.png
 [3]: http://travis-ci.org/hakanensari/mongoid-slug
-[4]: https://github.com/hakanensari/mongoid-slug/blob/master/lib/mongoid/slug.rb
+[4]: https://github.com/digitalplaywright/mongoid-slug/blob/master/lib/mongoid/slug.rb

data/lib/mongoid/slug/criteria.rb

@@ -79,7 +79,15 @@ module Mongoid
 
 
       def for_slugs(slugs)
-        where({ _slugs: { '$in' => slugs } }).limit(slugs.length)
+        #_translations
+        localized = (@klass.fields['_slugs'].options[:localize] rescue false)
+        if localized
+          def_loc = I18n.default_locale
+          query = { '$in' => slugs }
+          where({'$or' => [{ _slugs: query }, { "_slugs.#{def_loc}" => query }]}).limit(slugs.length)
+        else
+          where({ _slugs: { '$in' => slugs } }).limit(slugs.length)
+        end
       end
 
       def execute_or_raise_for_slugs(slugs, multi)

data/lib/mongoid/slug/version.rb

@@ -1,5 +1,5 @@
 module Mongoid #:nodoc:
   module Slug
-    VERSION = '2.0.1'
+    VERSION = '3.0.0.rc1'
   end
 end

data/lib/mongoid/slug.rb

@@ -10,8 +10,8 @@ module Mongoid
                      :url_builder,
                      :history
 
-      field :_slugs, type: Array, default: []
-      alias_attribute :slugs, :_slugs
+      # field :_slugs, type: Array, default: [], localize: false
+      # alias_attribute :slugs, :_slugs
     end
 
     module ClassMethods
@@ -50,10 +50,13 @@ module Mongoid
         options = fields.extract_options!
 
         self.slug_scope            = options[:scope]
-        self.reserved_words        = options[:reserve] || Set.new([:new, :edit])
+        self.reserved_words        = options[:reserve] || Set.new(["new", "edit"])
         self.slugged_attributes    = fields.map &:to_s
         self.history               = options[:history]
 
+        field :_slugs, type: Array, default: [], localize: options[:localize]
+        alias_attribute :slugs, :_slugs
+
         unless embedded?
           if slug_scope
             scope_key = (metadata = self.reflect_on_association(slug_scope)) ? metadata.key : slug_scope
@@ -115,8 +118,8 @@ module Mongoid
     # @return [true]
     def build_slug
       _new_slug = find_unique_slug
-      self._slugs.delete(_new_slug)
-      if !!self.history
+      self._slugs.delete(_new_slug) if self._slugs
+      if !!self.history && self._slugs.is_a?(Array)
         self._slugs << _new_slug
       else
         self._slugs = [_new_slug]
@@ -151,7 +154,8 @@ module Mongoid
 
     # @return [String] the slug, or nil if the document does not have a slug.
     def slug
-      _slugs.last
+      return _slugs.last if _slugs
+      return _id.to_s
     end
 
     def slug_builder

data/spec/models/page_localize.rb

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

data/spec/models/page_slug_localized.rb

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

data/spec/models/page_slug_localized_history.rb

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

data/spec/models/paranoid_document.rb

@@ -0,0 +1,8 @@
+class ParanoidDocument
+  include Mongoid::Document
+  include Mongoid::Paranoia
+  include Mongoid::Slug
+
+  field :title
+  slug  :title
+end

data/spec/mongoid/slug_spec.rb

@@ -507,26 +507,44 @@ module Mongoid
       end
     end
 
-    context "when :reserve is passed" do
-      it "does not use the the reserved slugs" do
-        friend1 = Friend.create(:name => "foo")
-        friend1.slugs.should_not eql("foo")
-        friend1.slugs.should include("foo-1")
+    context "for reserved words" do
+      context "when the :reserve option is used on the model" do
+        it "does not use the reserved slugs" do
+          friend1 = Friend.create(:name => "foo")
+          friend1.slugs.should_not include("foo")
+          friend1.slugs.should include("foo-1")
+
+          friend2 = Friend.create(:name => "bar")
+          friend2.slugs.should_not include("bar")
+          friend2.slugs.should include("bar-1")
+
+          friend3 = Friend.create(:name => "en")
+          friend3.slugs.should_not include("en")
+          friend3.slugs.should include("en-1")
+        end
 
-        friend2 = Friend.create(:name => "bar")
-        friend2.slugs.should_not eql("bar")
-        friend2.slugs.should include("bar-1")
+        it "should start with concatenation -1" do
+          friend1 = Friend.create(:name => "foo")
+          friend1.slugs.should include("foo-1")
+          friend2 = Friend.create(:name => "foo")
+          friend2.slugs.should include("foo-2")
+        end
 
-        friend3 = Friend.create(:name => "en")
-        friend3.slugs.should_not eql("en")
-        friend3.slugs.should include("en-1")
+        ["new", "edit"].each do |word|
+          it "should overwrite the default reserved words allowing the word '#{word}'" do
+            friend = Friend.create(:name => word)
+            friend.slugs.should include word
+          end
+        end
       end
-
-      it "should start with concatenation -1" do
-        friend1 = Friend.create(:name => "foo")
-        friend1.slugs.should include("foo-1")
-        friend2 = Friend.create(:name => "foo")
-        friend2.slugs.should include("foo-2")
+      context "when the model does not have any reserved words set" do
+        ["new", "edit"].each do |word|
+          it "does not use the default reserved word '#{word}'" do
+            book = Book.create(:title => word)
+            book.slugs.should_not include word
+            book.slugs.should include("#{word}-1")
+          end
+        end
       end
     end
 
@@ -832,5 +850,178 @@ module Mongoid
         end
       end
     end
+
+    context "slug can be localized" do
+      it "generate a new slug for each localization" do
+        old_locale = I18n.locale
+
+        # Using a default locale of en.
+        page = PageSlugLocalize.new
+        page.title = "Title on English"
+        page.save
+        page.slug.should eql "title-on-english"
+        I18n.locale = :nl
+        page.title = "Title on Netherlands"
+        page.save
+        page.slug.should eql "title-on-netherlands"
+
+        # Set locale back to english
+        I18n.locale = old_locale
+      end
+
+      it "returns _id if no slug" do
+        old_locale = I18n.locale
+
+        # Using a default locale of en.
+        page = PageSlugLocalize.new
+        page.title = "Title on English"
+        page.save
+        page.slug.should eql "title-on-english"
+        I18n.locale = :nl
+        page.slug.should eql page._id.to_s
+
+        # Set locale back to english
+        I18n.locale = old_locale
+      end
+
+      it "fallbacks if slug not localized yet" do
+        old_locale = I18n.locale
+
+        # Using a default locale of en.
+        page = PageSlugLocalize.new
+        page.title = "Title on English"
+        page.save
+        page.slug.should eql "title-on-english"
+        I18n.locale = :nl
+        page.slug.should eql page._id.to_s
+
+        # Turn on i18n fallback
+        require "i18n/backend/fallbacks"
+        I18n::Backend::Simple.send(:include, I18n::Backend::Fallbacks)
+        ::I18n.fallbacks[:nl] = [ :nl, :en ]
+        page.slug.should eql "title-on-english"
+        fallback_slug = page.slug
+
+        fallback_page = PageSlugLocalize.find(fallback_slug) rescue nil
+        fallback_page.should eq(page)
+
+        # Set locale back to english
+        I18n.locale = old_locale
+
+        # Restore fallback for next tests
+        ::I18n.fallbacks[:nl] = [ :nl ]
+      end
+
+      it "returns default slug if not localized" do
+        old_locale = I18n.locale
+
+        # Using a default locale of en.
+        page = PageLocalize.new
+        page.title = "Title on English"
+        page.save
+        page.slug.should eql "title-on-english"
+        I18n.locale = :nl
+        page.title = "Title on Netherlands"
+        page.slug.should eql "title-on-english"
+        page.save
+        page.slug.should eql "title-on-netherlands"
+
+
+        # Set locale back to english
+        I18n.locale = old_locale
+      end
+    end
+
+    context "slug can be localized when using history" do
+      it "generate a new slug for each localization and keep history" do
+        old_locale = I18n.locale
+
+        # Using a default locale of en.
+        page = PageSlugLocalizeHistory.new
+        page.title = "Title on English"
+        page.save
+        page.slug.should eql "title-on-english"
+        I18n.locale = :nl
+        page.title = "Title on Netherlands"
+        page.save
+        page.slug.should eql "title-on-netherlands"
+        I18n.locale = old_locale
+        page.title = "Modified title on English"
+        page.save
+        page.slug.should eql "modified-title-on-english"
+        page.slug.should include("title-on-english")
+        I18n.locale = :nl
+        page.title = "Modified title on Netherlands"
+        page.save
+        page.slug.should eql "modified-title-on-netherlands"
+        page.slug.should include("title-on-netherlands")
+
+        # Set locale back to english
+        I18n.locale = old_locale
+      end
+
+      it "returns _id if no slug" do
+        old_locale = I18n.locale
+
+        # Using a default locale of en.
+        page = PageSlugLocalizeHistory.new
+        page.title = "Title on English"
+        page.save
+        page.slug.should eql "title-on-english"
+        I18n.locale = :nl
+        page.slug.should eql page._id.to_s
+
+        # Set locale back to english
+        I18n.locale = old_locale
+      end
+
+      it "fallbacks if slug not localized yet" do
+        old_locale = I18n.locale
+
+        # Using a default locale of en.
+        page = PageSlugLocalizeHistory.new
+        page.title = "Title on English"
+        page.save
+        page.slug.should eql "title-on-english"
+        I18n.locale = :nl
+        page.slug.should eql page._id.to_s
+
+        # Turn on i18n fallback
+        require "i18n/backend/fallbacks"
+        I18n::Backend::Simple.send(:include, I18n::Backend::Fallbacks)
+        ::I18n.fallbacks[:nl] = [ :nl, :en ]
+        page.slug.should eql "title-on-english"
+        fallback_slug = page.slug
+
+        fallback_page = PageSlugLocalizeHistory.find(fallback_slug) rescue nil
+        fallback_page.should eq(page)
+
+        # Set locale back to english
+        I18n.locale = old_locale
+      end
+    end
+
+    context "Mongoid paranoia with mongoid slug model" do
+
+      let(:paranoid_doc) {ParanoidDocument.create!(:title => "slug")}
+
+      it "returns paranoid_doc for correct slug" do
+        expect(ParanoidDocument.find(paranoid_doc.slug)).to eq(paranoid_doc)
+      end
+
+      it "raises for deleted slug" do
+        paranoid_doc.delete
+        expect{ParanoidDocument.find(paranoid_doc.slug)}.to raise_error(Mongoid::Errors::DocumentNotFound)
+      end
+
+      it "returns paranoid_doc for correct restored slug" do
+        paranoid_doc.delete
+        ParanoidDocument.deleted.first.restore
+        expect(ParanoidDocument.find(paranoid_doc.slug)).to eq(paranoid_doc)
+      end
+
+
+
+    end
   end
 end

data/spec/spec_helper.rb

@@ -7,6 +7,7 @@ require 'uuid'
 require "awesome_print"
 
 require File.expand_path '../../lib/mongoid_slug', __FILE__
+require 'mongoid/paranoia'
 
 module Mongoid::Slug::UuidIdStrategy
   def self.call id

metadata

@@ -1,36 +1,32 @@
 --- !ruby/object:Gem::Specification
 name: mongoid_slug
 version: !ruby/object:Gem::Version
-  version: 2.0.1
-  prerelease: 
+  version: 3.0.0.rc1
 platform: ruby
 authors:
 - Andreas Saebjoernsen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-10 00:00:00.000000000 Z
+date: 2013-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ! '>'
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ! '>'
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: stringex
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -46,7 +41,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -54,7 +48,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -62,7 +55,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -70,7 +62,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -78,7 +69,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -86,7 +76,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -94,7 +83,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -102,7 +90,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -110,7 +97,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: uuid
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -118,7 +104,20 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -148,6 +147,10 @@ files:
 - spec/models/integer_id.rb
 - spec/models/magazine.rb
 - spec/models/page.rb
+- spec/models/page_localize.rb
+- spec/models/page_slug_localized.rb
+- spec/models/page_slug_localized_history.rb
+- spec/models/paranoid_document.rb
 - spec/models/partner.rb
 - spec/models/person.rb
 - spec/models/relationship.rb
@@ -158,27 +161,26 @@ files:
 - spec/spec_helper.rb
 homepage: https://github.com/digitalplaywright/mongoid-slug
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ! '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: mongoid_slug
-rubygems_version: 1.8.24
+rubygems_version: 2.0.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Mongoid URL slugs
 test_files:
 - spec/models/alias.rb
@@ -191,6 +193,10 @@ test_files:
 - spec/models/integer_id.rb
 - spec/models/magazine.rb
 - spec/models/page.rb
+- spec/models/page_localize.rb
+- spec/models/page_slug_localized.rb
+- spec/models/page_slug_localized_history.rb
+- spec/models/paranoid_document.rb
 - spec/models/partner.rb
 - spec/models/person.rb
 - spec/models/relationship.rb