mongoid-slug 5.1.1 → 5.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f62313ab069384e3dea183cd680aae50318beb85
-  data.tar.gz: 8881c0bef60727f9c57d8210b74f04bd48f545d6
+  metadata.gz: 2d38815d369307746d6c796167d08b99aae02f8d
+  data.tar.gz: e0f6c6ba7dc2431fe84de87a6b32dcc90ba1f2ba
 SHA512:
-  metadata.gz: 0bbf0cc529c6c8da1955ab3f9d40dfddb5e081c740bee1f012b3c115ad1698ed00bd5c8b81e158ce3626678e99dc9337a565ea3a8c67107583e940d20eed78f7
-  data.tar.gz: d9b4553651b7c2f588a8fe188974c1074283846dae8e5962d05471b216d50e7dc0db1ae10bad7ed46c932debf502ea28ebe7e1726fa1360866cbb9da802add49
+  metadata.gz: c4a7f3f5d7fdf36cb4d64b0ae5bb9f1e35bc6c2dbad3a7d1bbd586ff46b0a0da957bd3762bbe88182595b1aeb9b4e59c6a88bd143bbcdc3f17498c1a60ff82be
+  data.tar.gz: c91cb32733b81ec8b1ace9528bfced0c019aa1fc96d88cc4b6e11d803af0509cee3a0098260de8abcfd7702207deda9cd1c813b3f73f3a12f14930880d08c94c

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010-2015 Hakan Ensari & Contributors
+Copyright (c) 2010-2016 Hakan Ensari & Contributors
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -60,7 +60,7 @@ class Post
   field :_id, type: String, slug_id_strategy: lambda {|id| id.start_with?('....')}
 
   field :name
-  slug  :name, :history => true
+  slug  :name, history: true
 end
 
 Post.fields['_id'].type
@@ -72,6 +72,16 @@ post = Post.find '50b1386a0482939864000001' # Finds by bson ids
 ```
 [Examine slug.rb](lib/mongoid/slug.rb) for all available options.
 
+To set slugs for existing records run following rake task:
+
+```ruby
+rake mongoid_slug:set
+```
+You can pass model names as an option for which you want to set slugs:
+
+```ruby
+rake mongoid_slug:set[Model1,Model2]
+```
 Custom Slug Generation
 -------
 
@@ -111,7 +121,7 @@ class Employee
   field :name
   referenced_in :company
 
-  slug  :name, :scope => :company
+  slug  :name, scope: :company
 end
 ```
 
@@ -133,12 +143,28 @@ class Employee
   field :name
   field :company_id
 
-  slug  :name, :scope => :company_id
+  slug  :name, scope: :company_id
 end
 ```
 
-Optionally find and create slugs per model type
--------
+Limit Slug Length
+-----------------
+
+MongoDB has a default limit around 1KB to the size of the index keys and will raise error 17280, `key too large to index` when trying to create a record that causes an index key to exceed that limit. By default slugs are of the form `text[-number]` and the text portion is limited in size to `Mongoid::Slug::MONGO_INDEX_KEY_LIMIT_BYTES - 32` bytes. You can change this limit with `max_length` or set it to `nil` if you're running MongoDB with [failIndexKeyTooLong](https://docs.mongodb.org/manual/reference/parameters/#param.failIndexKeyTooLong) set to `false`.
+
+```ruby
+class Company
+  include Mongoid::Document
+  include Mongoid::Slug
+
+  field :name
+
+  slug  :name, max_length: 24
+end
+```
+
+Optionally Find and Create Slugs per Model Type
+-----------------------------------------------
 
 By default when using STI, the scope will be around the super-class.
 
@@ -148,7 +174,7 @@ class Book
   include Mongoid::Slug
   field :title
 
-  slug  :title, :history => true
+  slug  :title, history: true
   embeds_many :subjects
   has_many :authors
 end
@@ -156,12 +182,12 @@ end
 class ComicBook < Book
 end
 
-book = Book.create(:title => "Anti Oedipus")
-comic_book = ComicBook.create(:title => "Anti Oedipus")
+book = Book.create(title: 'Anti Oedipus')
+comic_book = ComicBook.create(title: 'Anti Oedipus')
 comic_book.slugs.should_not eql(book.slugs)
 ```
 
-If you want the scope to be around the subclass, then set the option :by_model_type => true.
+If you want the scope to be around the subclass, then set the option `by_model_type: true`.
 
 ```ruby
 class Book
@@ -169,7 +195,7 @@ class Book
   include Mongoid::Slug
   field :title
 
-  slug  :title, :history => true, :by_model_type => true
+  slug  :title, history: true, by_model_type: true
   embeds_many :subjects
   has_many :authors
 end
@@ -177,8 +203,8 @@ end
 class ComicBook < Book
 end
 
-book = Book.create(:title => "Anti Oedipus")
-comic_book = ComicBook.create(:title => "Anti Oedipus")
+book = Book.create(title: 'Anti Oedipus')
+comic_book = ComicBook.create(title: 'Anti Oedipus')
 comic_book.slugs.should eql(book.slugs)
 ```
 
@@ -206,7 +232,7 @@ page = Page.new title: "Home"
 page.save
 page.update_attributes title: "Welcome"
 
-Page.find("welcome") == Page.find("home") #=> true
+Page.find("welcome") == Page.find("home") # => true
 ```
 
 Reserved Slugs
@@ -276,7 +302,7 @@ class Entity
   field :_id, type: String, slug_id_strategy: UuidIdStrategy
 
   field :user_edited_variation
-  slug  :user_edited_variation, :history => true
+  slug  :user_edited_variation, history: true
 end
 ```
 
@@ -329,5 +355,5 @@ Mongoid-slug is work of [many of contributors](https://github.com/digitalplaywri
 Copyright & License
 -------------------
 
-Copyright (c) 2010-2015 Hakan Ensari & Contributors, see [LICENSE](LICENSE) for details.
+Copyright (c) 2010-2016 Hakan Ensari & Contributors, see [LICENSE](LICENSE) for details.
 

data/lib/mongoid/slug.rb

@@ -6,19 +6,23 @@ require 'mongoid/slug/paranoia'
 require 'mongoid/slug/unique_slug'
 require 'mongoid/slug/slug_id_strategy'
 require 'mongoid-compatibility'
+require 'mongoid/slug/railtie' if defined?(Rails)
 
 module Mongoid
   # Slugs your Mongoid model.
   module Slug
     extend ActiveSupport::Concern
 
+    MONGO_INDEX_KEY_LIMIT_BYTES = 1024
+
     included do
       cattr_accessor :reserved_words,
                      :slug_scope,
                      :slugged_attributes,
                      :url_builder,
                      :history,
-                     :by_model_type
+                     :by_model_type,
+                     :slug_max_length
 
       # field :_slugs, type: Array, default: [], localize: false
       # alias_attribute :slugs, :_slugs
@@ -43,6 +47,7 @@ module Mongoid
       #   @param options :scope [Symbol] a reference association or field to
       #   scope the slug by. Embedded documents are, by default, scoped by
       #   their parent.
+      #   @param options :max_length [Integer] the maximum length of the text portion of the slug
       #   @yield If given, a block is used to build a slug.
       #
       # @example A custom builder
@@ -64,6 +69,7 @@ module Mongoid
         self.slugged_attributes    = fields.map(&:to_s)
         self.history               = options[:history]
         self.by_model_type         = options[:by_model_type]
+        self.slug_max_length       = options.key?(:max_length) ? options[:max_length] : MONGO_INDEX_KEY_LIMIT_BYTES - 32
 
         field :_slugs, type: Array, default: [], localize: options[:localize]
         alias_attribute :slugs, :_slugs

data/lib/mongoid/slug/railtie.rb

@@ -0,0 +1,9 @@
+module Mongoid
+  module Slug
+    class Railtie < Rails::Railtie
+      rake_tasks do
+        Dir[File.join(File.dirname(__FILE__), '../../tasks/*.rake')].each { |f| load f }
+      end
+    end
+  end
+end

data/lib/mongoid/slug/unique_slug.rb

@@ -63,7 +63,7 @@ module Mongoid
 
       def_delegators :@model, :slug_scope, :reflect_on_association, :read_attribute,
                      :check_against_id, :reserved_words, :url_builder, :collection_name,
-                     :embedded?, :reflect_on_all_associations, :by_model_type
+                     :embedded?, :reflect_on_all_associations, :by_model_type, :slug_max_length
 
       def initialize(model)
         @model = model
@@ -82,6 +82,9 @@ module Mongoid
                    else
                      url_builder.call(model)
                    end
+
+          @_slug = @_slug[0...slug_max_length] if slug_max_length
+
           # Regular expression that matches slug, slug-1, ... slug-n
           # If slug_name field was indexed, MongoDB will utilize that
           # index to match /^.../ pattern.

data/lib/mongoid/slug/version.rb

@@ -1,5 +1,5 @@
 module Mongoid #:nodoc:
   module Slug
-    VERSION = '5.1.1'
+    VERSION = '5.2.0'
   end
 end

data/lib/tasks/mongoid_slug.rake

@@ -0,0 +1,18 @@
+namespace :mongoid_slug do
+  desc 'Goes though all documents and sets slug if not already set'
+  task set: :environment do |_, args|
+    ::Rails.application.eager_load! if defined?(Rails)
+    klasses = Module.constants.find_all do |const|
+      const != const.upcase ? Mongoid::Slug > (Object.const_get const) : nil
+    end
+    klasses.map! { |klass| klass.to_s.constantize }
+    unless klasses.blank?
+      models  = args.extras
+      klasses = (klasses.map(&:to_s) & models.map(&:classify)).map(&:constantize) if models.any?
+      klasses.each do |klass|
+        # set slug for objects having blank slug
+        klass.each { |object| object.set_slug! unless object.slugs? }
+      end
+    end
+  end
+end

data/spec/models/author.rb

@@ -3,7 +3,7 @@ class Author
   include Mongoid::Slug
   field :first_name
   field :last_name
-  slug :first_name, :last_name, scope: :book
+  slug :first_name, :last_name, scope: :book, history: false, max_length: 256
   belongs_to :book
   has_many :characters,
            class_name: 'Person',

data/spec/models/book.rb

@@ -3,7 +3,7 @@ class Book
   include Mongoid::Slug
   field :title
 
-  slug :title, history: true
+  slug :title, history: true, max_length: nil
   embeds_many :subjects
   has_many :authors
 end

data/spec/mongoid/slug_spec.rb

@@ -348,33 +348,50 @@ module Mongoid
     end
 
     context 'when :history is passed as an argument' do
-      let(:book) do
-        Book.create(title: 'Book Title')
-      end
+      context 'true' do
+        let(:book) do
+          Book.create(title: 'Book Title')
+        end
 
-      before(:each) do
-        book.title = 'Other Book Title'
-        book.save
-      end
+        before(:each) do
+          book.title = 'Other Book Title'
+          book.save
+        end
 
-      it "saves the old slug in the owner's history" do
-        expect(book.slugs).to include('book-title')
-      end
+        it "saves the old slug in the owner's history" do
+          expect(book.slugs).to include('book-title')
+        end
 
-      it 'generates a unique slug by appending a counter to duplicate text' do
-        dup = Book.create(title: 'Book Title')
-        expect(dup.to_param).to eql 'book-title-1'
-      end
+        it 'generates a unique slug by appending a counter to duplicate text' do
+          dup = Book.create(title: 'Book Title')
+          expect(dup.to_param).to eql 'book-title-1'
+        end
 
-      it 'does not allow a BSON::ObjectId as use for a slug' do
-        bad = Book.create(title: '4ea0389f0364313d79104fb3')
-        expect(bad.to_param).not_to eql '4ea0389f0364313d79104fb3'
+        it 'does not allow a BSON::ObjectId as use for a slug' do
+          bad = Book.create(title: '4ea0389f0364313d79104fb3')
+          expect(bad.to_param).not_to eql '4ea0389f0364313d79104fb3'
+        end
+
+        it 'ensures no duplicate values are stored in history' do
+          book.update_attributes title: 'Book Title'
+          book.update_attributes title: 'Foo'
+          expect(book.slugs.find_all { |slug| slug == 'book-title' }.size).to eql 1
+        end
       end
+      context 'false' do
+        let(:author) do
+          Author.create(first_name: 'Gilles', last_name: 'Deleuze')
+        end
 
-      it 'ensures no duplicate values are stored in history' do
-        book.update_attributes title: 'Book Title'
-        book.update_attributes title: 'Foo'
-        expect(book.slugs.find_all { |slug| slug == 'book-title' }.size).to eql 1
+        before(:each) do
+          author.first_name = 'John'
+          author.save
+        end
+
+        it "does not save the old slug in the owner's history" do
+          expect(author.slugs.count).to eq 1
+          expect(author.slugs).to_not include('gilles-deleuze')
+        end
       end
     end
 
@@ -519,6 +536,28 @@ module Mongoid
         it_should_behave_like 'has an index', { _slugs: 1 }, unique: true, sparse: true
       end
 
+      context 'with a value exceeding mongodb max index key' do
+        if Mongoid::Compatibility::Version.mongoid5?
+          it 'errors with a model without a max length' do
+            expect do
+              Book.create!(title: 't' * 1025)
+            end.to raise_error Mongo::Error::OperationFailure, /key too large to index/
+          end
+        elsif Mongoid::Compatibility::Version.mongoid4?
+          it 'errors with a model without a max length' do
+            expect do
+              Book.create!(title: 't' * 1025)
+            end.to raise_error Moped::Errors::OperationFailure, /key too large to index/
+          end
+        end
+        it 'succeeds with a model with a max length' do
+          expect do
+            author = Author.create!(last_name: 't' * 1025)
+            expect(author.slug.length).to eq 256
+          end.to_not raise_error
+        end
+      end
+
       context 'when slug is scoped by a reference association' do
         subject { Author }
         it_should_behave_like 'does not have an index', _slugs: 1
@@ -1019,5 +1058,34 @@ module Mongoid
                                      'nl' => ['title-on-netherlands'])
       end
     end
+
+    describe 'slug_max_length' do
+      before do
+        Author.create_indexes
+      end
+      after do
+        Author.remove_indexes
+      end
+      it 'can be assigned to nil' do
+        expect(Book.slug_max_length).to be nil
+      end
+      it 'defaults to MONGO_INDEX_KEY_LIMIT_BYTES - 32' do
+        expect(Article.slug_max_length).to eq Mongoid::Slug::MONGO_INDEX_KEY_LIMIT_BYTES - 32
+      end
+      it 'is assigned via max_length' do
+        expect(Author.slug_max_length).to eq 256
+      end
+      it 'enforces max length of slug' do
+        author1 = Author.create!(last_name: 't' * 1024)
+        expect(author1.slug.length).to eq 256
+        expect(author1.slug.ends_with?('ttt')).to be true
+        author2 = Author.create!(last_name: 't' * 1024)
+        expect(author2.slug.length).to eq 258
+        expect(author2.slug.ends_with?('tt-1')).to be true
+        author3 = Author.create!(last_name: 't' * 1024)
+        expect(author3.slug.length).to eq 258
+        expect(author3.slug.ends_with?('tt-2')).to be true
+      end
+    end
   end
 end

data/spec/tasks/mongoid_slug_rake_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+require 'rake'
+
+describe 'mongoid_slug:set' do
+  before :all do
+    load File.expand_path('../../../lib/tasks/mongoid_slug.rake', __FILE__)
+    Rake::Task.define_task(:environment)
+  end
+
+  context 'when models parameter is passed' do
+    before :all do
+      UninitalizedSlugFirst = Class.new do
+        include Mongoid::Document
+        field :name, type: String
+        store_in collection: 'uninitalized_slug_first'
+      end
+      UninitalizedSlugSecond = Class.new do
+        include Mongoid::Document
+        field :name, type: String
+        store_in collection: 'uninitalized_slug_second'
+      end
+    end
+
+    it 'goes though all documents of passed models and sets slug if not already set' do
+      uninitalized_slug1 = UninitalizedSlugFirst.create(name: 'uninitalized-slug1')
+      uninitalized_slug2 = UninitalizedSlugSecond.create(name: 'uninitalized-slug2')
+
+      UninitalizedSlugFirst.class_eval do
+        include Mongoid::Slug
+        slug :name
+      end
+      UninitalizedSlugSecond.class_eval do
+        include Mongoid::Slug
+        slug :name
+      end
+
+      expect(uninitalized_slug1.slugs).to be_nil
+      expect(uninitalized_slug2.slugs).to be_nil
+
+      Rake::Task['mongoid_slug:set'].reenable
+      Rake::Task['mongoid_slug:set'].invoke('UninitalizedSlugFirst')
+
+      expect(uninitalized_slug1.reload.slugs).to eq(['uninitalized-slug1'])
+      expect(uninitalized_slug2.reload.slugs).to eq []
+    end
+  end
+
+  context 'when models parameter is not passed' do
+    before :all do
+      UninitalizedSlugThird = Class.new do
+        include Mongoid::Document
+        field :name, type: String
+        store_in collection: 'uninitalized_slug_third'
+      end
+    end
+
+    it 'goes though all documents and sets slug if not already set' do
+      uninitalized_slug3 = UninitalizedSlugThird.create(name: 'uninitalized-slug3')
+
+      UninitalizedSlugThird.class_eval do
+        include Mongoid::Slug
+        slug :name
+      end
+
+      expect(uninitalized_slug3.slugs).to be_nil
+
+      Rake::Task['mongoid_slug:set'].reenable
+      Rake::Task['mongoid_slug:set'].invoke
+
+      expect(uninitalized_slug3.reload.slugs).to eq(['uninitalized-slug3'])
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mongoid-slug
 version: !ruby/object:Gem::Version
-  version: 5.1.1
+  version: 5.2.0
 platform: ruby
 authors:
 - Andreas Saebjoernsen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-03 00:00:00.000000000 Z
+date: 2016-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid
@@ -177,10 +177,12 @@ files:
 - lib/mongoid/slug/criteria.rb
 - lib/mongoid/slug/index.rb
 - lib/mongoid/slug/paranoia.rb
+- lib/mongoid/slug/railtie.rb
 - lib/mongoid/slug/slug_id_strategy.rb
 - lib/mongoid/slug/unique_slug.rb
 - lib/mongoid/slug/version.rb
 - lib/mongoid_slug.rb
+- lib/tasks/mongoid_slug.rake
 - spec/models/alias.rb
 - spec/models/article.rb
 - spec/models/artist.rb
@@ -215,6 +217,7 @@ files:
 - spec/mongoid/slug_spec.rb
 - spec/shared/indexes.rb
 - spec/spec_helper.rb
+- spec/tasks/mongoid_slug_rake_spec.rb
 homepage: https://github.com/digitalplaywright/mongoid-slug
 licenses:
 - MIT
@@ -274,3 +277,4 @@ test_files:
 - spec/mongoid/slug_spec.rb
 - spec/shared/indexes.rb
 - spec/spec_helper.rb
+- spec/tasks/mongoid_slug_rake_spec.rb