mongoid-slug 6.0.1 → 7.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 54274387f9a202810aefa5b3b19c90990636d6076cbc6591cf46129986b4b5e4
-  data.tar.gz: 557ba29c3dfaa615f7e926ba223bb3390e930a52ed559baf33b0517cf224aaa8
+  metadata.gz: 316ca3607617c4e0c9f74a98fcac1d1629e5d777b79d6b4dab5a3ed3d07b3989
+  data.tar.gz: c55bbfa991bdc760e461b8ab73de8deb972bcbf784bc2db37640a1d03a5e51aa
 SHA512:
-  metadata.gz: 11a15aec160529e61f5e6fe9636d9fded847d12ec08fe50e6c67997aca86fed844f42264962c65999e862b7a73ba3d41c337c7fae492e8c91999efbd889ea502
-  data.tar.gz: ff604c15c46fa831bb648906b802cc8e93d13363207fc3a121b7b1c3e4ef3ccb46305f630507ded0e24ad07d70069e4e70ae3185d022267e5ba4c42b53381b44
+  metadata.gz: f4cbe88440e9ef769c7fb91f1a2fed9e294b2cb213e0779425314b4bfc20307d0003688f3ee7ce00bc2c34560f99fda420b038179b5f919a22ddfcd3559ebab5
+  data.tar.gz: d89e83169fe6e282a664b0ffa2db13d7235e413d39a25948142c85aa21ef830c298663d77364b3590c48e4b6a736e1b3b279681030a6de9c920ede6f8411aadb

data/README.md

@@ -8,6 +8,12 @@ It sits idly on top of [stringex](https://github.com/rsl/stringex), supporting n
 [![Gem Version](https://badge.fury.io/rb/mongoid-slug.svg)](http://badge.fury.io/rb/mongoid-slug)
 [![Code Climate](https://codeclimate.com/github/mongoid/mongoid-slug.svg)](https://codeclimate.com/github/mongoid/mongoid-slug)
 
+### Version Support
+
+Mongoid Slug 7.x requires at least Mongoid 7.0.0 and Ruby 2.7.0. For earlier Mongoid and Ruby version support, please use an earlier version of Mongoid Slug.
+
+Mongoid Slug is compatible with all MongoDB versions which Mongoid supports, however, please see "Slug Max Length" section below for MongoDB 4.0 and earlier.
+
 ### Installation
 
 Add to your Gemfile:
@@ -70,6 +76,7 @@ post = Post.find 'a-thousand-plateaus' # Finds by slugs
 post = Post.find '50b1386a0482939864000001' # Finds by bson ids
 => ...
 ```
+
 [Examine slug.rb](lib/mongoid/slug.rb) for all available options.
 
 ### Updating Existing Records
@@ -127,6 +134,23 @@ The `to_url` method comes from [stringex](https://github.com/rsl/stringex).
 
 You can define a slug builder globally and/or override it per model.
 
+### Indexing
+
+By default, Mongoid Slug will automatically generate an index for the slug, which will be created when you run `rake db:create_indexes`. This index will take into account scoping and other options described below.
+
+To skip this index generation, you may set `index: false` as follows:
+
+```ruby
+class Employee
+  include Mongoid::Document
+  include Mongoid::Slug
+
+  field :name
+
+  slug :name, index: :false
+end
+```
+
 ### Scoping
 
 To scope a slug by a reference association, pass `:scope`:
@@ -169,9 +193,16 @@ class Employee
 end
 ```
 
-### Limit Slug Length
+### Slug Max 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`.
+MongoDB [featureCompatibilityVersion](https://docs.mongodb.com/manual/reference/command/setFeatureCompatibilityVersion/#std-label-view-fcv)
+"4.0" and earlier applies an [Index Key Limit](https://docs.mongodb.com/manual/reference/limits/#mongodb-limit-Index-Key-Limit)
+which limits the total size of an index entry to around 1KB 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
@@ -295,7 +326,7 @@ For example, if `I18n.default_locale` is `:en`, the index will be generated as f
 ```ruby
 slug :title, localize: true
 
-# The following indexes is auto-generated:
+# The following index is auto-generated:
 index({ '_slugs.en' => 1 }, { unique: true, sparse: true })
 ```
 

data/lib/mongoid/slug/criteria.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mongoid
   module Slug
     class Criteria < Mongoid::Criteria
@@ -50,6 +52,7 @@ module Mongoid
 
       def look_like_slugs?(args)
         return false unless args.all? { |id| id.is_a?(String) }
+
         id_field = @klass.fields['_id']
         @slug_strategy ||= id_field.options[:slug_id_strategy] || build_slug_strategy(id_field.type)
         args.none? { |id| @slug_strategy.call(id) }
@@ -61,13 +64,13 @@ module Mongoid
       # use object_id or string strategy depending on the id_type
       # otherwise default for all other id_types
       def build_slug_strategy(id_type)
-        type_method = id_type.to_s.downcase.split('::').last + '_slug_strategy'
+        type_method = "#{id_type.to_s.downcase.split('::').last}_slug_strategy"
         respond_to?(type_method, true) ? method(type_method) : ->(_id) { false }
       end
 
       # a string will not look like a slug if it looks like a legal BSON::ObjectId
       def objectid_slug_strategy(id)
-        Mongoid::Compatibility::ObjectId.legal?(id)
+        BSON::ObjectId.legal?(id)
       end
 
       # a string will always look like a slug
@@ -78,10 +81,10 @@ module Mongoid
       def for_slugs(slugs)
         # _translations
         localized = (begin
-                       @klass.fields['_slugs'].options[:localize]
-                     rescue StandardError
-                       false
-                     end)
+          @klass.fields['_slugs'].options[:localize]
+        rescue StandardError
+          false
+        end)
         if localized
           def_loc = I18n.default_locale
           query = { '$in' => slugs }
@@ -100,6 +103,7 @@ module Mongoid
       def check_for_missing_documents_for_slugs!(result, slugs)
         missing_slugs = slugs - result.map(&:slugs).flatten
         return unless !missing_slugs.blank? && Mongoid.raise_not_found_error
+
         raise Errors::DocumentNotFound.new(klass, slugs, missing_slugs)
       end
     end

data/lib/mongoid/slug/index_builder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mongoid
   module Slug
     module IndexBuilder

data/lib/mongoid/slug/railtie.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mongoid
   module Slug
     class Railtie < Rails::Railtie

data/lib/mongoid/slug/slug_id_strategy.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 Mongoid::Fields.option(:slug_id_strategy) do |_model, field, value|
   field.options[:slug_id_strategy] = value
 end

data/lib/mongoid/slug/unique_slug.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'forwardable'
 
 # Can use e.g. Mongoid::Slug::UniqueSlug.new(ModelClass.new).find_unique "slug-1" for auto-suggest ui
@@ -20,9 +22,10 @@ module Mongoid
           @documents.each do |doc|
             history_slugs = doc._slugs
             next if history_slugs.nil?
-            existing_slugs.push(*history_slugs.find_all { |cur_slug| cur_slug =~ regexp_pattern })
+
+            existing_slugs.push(*history_slugs.grep(regexp_pattern))
             last_entered_slug.push(*history_slugs.last) if history_slugs.last =~ regexp_pattern
-            existing_history_slugs.push(*history_slugs.first(history_slugs.length - 1).find_all { |cur_slug| cur_slug =~ regexp_pattern })
+            existing_history_slugs.push(*history_slugs.first(history_slugs.length - 1).grep(regexp_pattern))
           end
         end
 
@@ -111,7 +114,7 @@ module Mongoid
           @state.include_slug unless model.class.look_like_slugs?([@_slug])
 
           # make sure that the slug is not equal to a reserved word
-          @state.include_slug if slug_reserved_words.any? { |word| word === @_slug }
+          @state.include_slug if slug_reserved_words.any? { |word| word === @_slug } # rubocop:disable Style/CaseEquality
 
           # only look for a new unique slug if the existing slugs contains the current slug
           # - e.g if the slug 'foo-2' is taken, but 'foo' is available, the user can use 'foo'.
@@ -132,7 +135,7 @@ module Mongoid
       # index to match /^.../ pattern.
       # Use Regexp::Raw to avoid the multiline option when querying the server.
       def regex_for_slug
-        if embedded? || Mongoid::Compatibility::Version.mongoid3? || Mongoid::Compatibility::Version.mongoid4?
+        if embedded?
           Regexp.new(escaped_pattern)
         else
           BSON::Regexp::Raw.new(escaped_pattern)
@@ -155,11 +158,7 @@ module Mongoid
         end
 
         if embedded?
-          parent_metadata = if Mongoid::Compatibility::Version.mongoid7_or_newer?
-                              reflect_on_all_association(:embedded_in)[0]
-                            else
-                              reflect_on_all_associations(:embedded_in)[0]
-                            end
+          parent_metadata = reflect_on_all_association(:embedded_in)[0]
           return model._parent.send(parent_metadata.inverse_of || self.metadata.name)
         end
 

data/lib/mongoid/slug/version.rb

@@ -1,5 +1,7 @@
-module Mongoid #:nodoc:
+# frozen_string_literal: true
+
+module Mongoid # :nodoc:
   module Slug
-    VERSION = '6.0.1'.freeze
+    VERSION = '7.0.0'
   end
 end

data/lib/mongoid/slug.rb

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
+
 require 'mongoid'
 require 'stringex'
 require 'mongoid/slug/criteria'
 require 'mongoid/slug/index_builder'
 require 'mongoid/slug/unique_slug'
 require 'mongoid/slug/slug_id_strategy'
-require 'mongoid-compatibility'
 require 'mongoid/slug/railtie' if defined?(Rails)
 
 module Mongoid
@@ -17,6 +18,7 @@ module Mongoid
     included do
       cattr_accessor :slug_reserved_words,
                      :slug_scope,
+                     :slug_index,
                      :slugged_attributes,
                      :slug_url_builder,
                      :slug_history,
@@ -29,6 +31,7 @@ module Mongoid
 
     class << self
       attr_accessor :default_slug
+
       def configure(&block)
         instance_eval(&block)
       end
@@ -75,6 +78,7 @@ module Mongoid
         options = fields.extract_options!
 
         self.slug_scope            = options[:scope]
+        self.slug_index            = options[:index].nil? ? true : options[:index]
         self.slug_reserved_words   = options[:reserve] || Set.new(%w[new edit])
         self.slugged_attributes    = fields.map(&:to_s)
         self.slug_history          = options[:history]
@@ -85,7 +89,10 @@ module Mongoid
         alias_attribute :slugs, :_slugs
 
         # Set indexes
-        Mongoid::Slug::IndexBuilder.build_indexes(self, slug_scope_key, slug_by_model_type, options[:localize]) unless embedded?
+        if slug_index && !embedded?
+          Mongoid::Slug::IndexBuilder.build_indexes(self, slug_scope_key, slug_by_model_type,
+                                                    options[:localize])
+        end
 
         self.slug_url_builder = block_given? ? block : default_slug_url_builder
 
@@ -111,6 +118,7 @@ module Mongoid
       # @return [ Array<Document>, Document ]
       def slug_scope_key
         return nil unless slug_scope
+
         reflect_on_association(slug_scope).try(:key) || slug_scope
       end
 
@@ -141,17 +149,13 @@ module Mongoid
 
       private
 
-      if Mongoid::Compatibility::Version.mongoid5_or_newer? && Threaded.method(:current_scope).arity == -1
+      if Threaded.method(:current_scope).arity == -1
         def current_scope
           Threaded.current_scope(self)
         end
-      elsif Mongoid::Compatibility::Version.mongoid5_or_newer?
-        def current_scope
-          Threaded.current_scope
-        end
       else
         def current_scope
-          scope_stack.last
+          Threaded.current_scope
         end
       end
     end
@@ -181,10 +185,10 @@ module Mongoid
 
       # skip slug generation and use Mongoid id
       # to find document instead
-      return true if new_slug.size.zero?
+      return true if new_slug.empty?
 
       # avoid duplicate slugs
-      _slugs.delete(new_slug) if _slugs
+      _slugs&.delete(new_slug)
 
       if !!slug_history && _slugs.is_a?(Array)
         append_slug(new_slug)
@@ -249,6 +253,7 @@ module Mongoid
     # @return [String] the slug, or nil if the document does not have a slug.
     def slug
       return _slugs.last if _slugs
+
       _id.to_s
     end
 

data/lib/mongoid_slug.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 # To be removed
 require 'mongoid/slug'

data/lib/tasks/mongoid_slug.rake

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 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)
+    Rails.application.eager_load! if defined?(Rails)
     klasses = Mongoid::Config.models.find_all { |c| c.ancestors.include?(Mongoid::Slug) }
     unless klasses.blank?
       models  = args.extras

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mongoid-slug
 version: !ruby/object:Gem::Version
-  version: 6.0.1
+  version: 7.0.0
 platform: ruby
 authors:
 - Andreas Saebjoernsen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-11 00:00:00.000000000 Z
+date: 2023-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid
@@ -16,28 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: mongoid-compatibility
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: stringex
   requirement: !ruby/object:Gem::Requirement
@@ -52,90 +38,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: awesome_print
-  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
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: guard-rspec
-  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
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  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
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  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
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec-its
-  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
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: uuid
-  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
-        version: '0'
 description: Mongoid URL slug or permalink generator
 email:
 - andy@cosemble.com
@@ -154,41 +56,11 @@ files:
 - 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
-- spec/models/artwork.rb
-- spec/models/author.rb
-- spec/models/author_polymorphic.rb
-- spec/models/book.rb
-- spec/models/book_polymorphic.rb
-- spec/models/caption.rb
-- spec/models/entity.rb
-- spec/models/friend.rb
-- spec/models/incorrect_slug_persistence.rb
-- 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_custom.rb
-- spec/models/page_slug_localized_history.rb
-- spec/models/partner.rb
-- spec/models/person.rb
-- spec/models/relationship.rb
-- spec/models/string_id.rb
-- spec/models/subject.rb
-- spec/models/without_slug.rb
-- spec/mongoid/criteria_spec.rb
-- spec/mongoid/index_builder_spec.rb
-- spec/mongoid/slug_spec.rb
-- spec/shared/indexes.rb
-- spec/spec_helper.rb
-- spec/tasks/mongoid_slug_rake_spec.rb
 homepage: https://github.com/mongoid/mongoid-slug
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -197,46 +69,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.4.4
 signing_key:
 specification_version: 4
 summary: Mongoid URL slugs
-test_files:
-- spec/models/alias.rb
-- spec/models/article.rb
-- spec/models/artist.rb
-- spec/models/artwork.rb
-- spec/models/author.rb
-- spec/models/author_polymorphic.rb
-- spec/models/book.rb
-- spec/models/book_polymorphic.rb
-- spec/models/caption.rb
-- spec/models/entity.rb
-- spec/models/friend.rb
-- spec/models/incorrect_slug_persistence.rb
-- 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_custom.rb
-- spec/models/page_slug_localized_history.rb
-- spec/models/partner.rb
-- spec/models/person.rb
-- spec/models/relationship.rb
-- spec/models/string_id.rb
-- spec/models/subject.rb
-- spec/models/without_slug.rb
-- spec/mongoid/criteria_spec.rb
-- spec/mongoid/index_builder_spec.rb
-- spec/mongoid/slug_spec.rb
-- spec/shared/indexes.rb
-- spec/spec_helper.rb
-- spec/tasks/mongoid_slug_rake_spec.rb
+test_files: []

data/spec/models/alias.rb

@@ -1,6 +0,0 @@
-class Alias
-  include Mongoid::Document
-  include Mongoid::Slug
-  field :name, as: :author_name
-  slug :author_name
-end

data/spec/models/article.rb

@@ -1,9 +0,0 @@
-class Article
-  include Mongoid::Document
-  include Mongoid::Slug
-  field :brief
-  field :title
-  slug :title, :brief do |doc|
-    [doc.title, doc.brief].reject(&:blank?).first
-  end
-end

data/spec/models/artist.rb

@@ -1,8 +0,0 @@
-class Artist
-  include Mongoid::Document
-  include Mongoid::Slug
-
-  slug :name
-  field :name
-  has_and_belongs_to_many :artworks
-end

data/spec/models/artwork.rb

@@ -1,10 +0,0 @@
-class Artwork
-  include Mongoid::Document
-  include Mongoid::Slug
-
-  slug :title
-  field :title
-  field :published, type: Boolean, default: true
-  scope :published, -> { where(published: true) }
-  has_and_belongs_to_many :artists
-end

data/spec/models/author.rb

@@ -1,15 +0,0 @@
-class Author
-  include Mongoid::Document
-  include Mongoid::Slug
-  field :first_name
-  field :last_name
-  if Mongoid::Compatibility::Version.mongoid6_or_newer?
-    belongs_to :book, required: false
-  else
-    belongs_to :book
-  end
-  has_many :characters,
-           class_name: 'Person',
-           foreign_key: :author_id
-  slug :first_name, :last_name, scope: :book, history: false, max_length: 256
-end

data/spec/models/author_polymorphic.rb

@@ -1,15 +0,0 @@
-class AuthorPolymorphic
-  include Mongoid::Document
-  include Mongoid::Slug
-  field :first_name
-  field :last_name
-  slug :first_name, :last_name, scope: :book_polymorphic
-  if Mongoid::Compatibility::Version.mongoid6_or_newer?
-    belongs_to :book_polymorphic, required: false
-  else
-    belongs_to :book_polymorphic
-  end
-  has_many :characters,
-           class_name: 'Person',
-           foreign_key: :author_id
-end

data/spec/models/book.rb

@@ -1,12 +0,0 @@
-class Book
-  include Mongoid::Document
-  include Mongoid::Slug
-  field :title
-
-  slug :title, history: true, max_length: nil
-  embeds_many :subjects
-  has_many :authors
-end
-
-class ComicBook < Book
-end

data/spec/models/book_polymorphic.rb

@@ -1,12 +0,0 @@
-class BookPolymorphic
-  include Mongoid::Document
-  include Mongoid::Slug
-  field :title
-
-  slug :title, history: true, by_model_type: true
-  embeds_many :subjects
-  has_many :author_polymorphics
-end
-
-class ComicBookPolymorphic < BookPolymorphic
-end

data/spec/models/caption.rb

@@ -1,17 +0,0 @@
-class Caption
-  include Mongoid::Document
-  include Mongoid::Slug
-  field :my_identity, type: String
-  field :title
-  field :medium
-
-  # A fairly complex scenario, where we want to create a slug out of an
-  # my_identity field, which comprises name of artist and some more bibliographic
-  # info in parantheses, and the title of the work.
-  #
-  # We are only interested in the name of the artist so we remove the
-  # paranthesized details.
-  slug :my_identity, :title do |cur_object|
-    cur_object.slug_builder.gsub(/\s*\([^)]+\)/, '').to_url
-  end
-end