mongoid-slugify 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.rvmrc

data/Gemfile

@@ -0,0 +1,8 @@
+source 'http://rubygems.org'
+
+# Specify your gem's dependencies in mongoid-slugify.gemspec
+gemspec
+
+gem 'rspec'
+gem 'database_cleaner'
+gem 'bson_ext'

data/README.rdoc

@@ -0,0 +1,40 @@
+== Installation 
+
+Add mongoid-slugify to your Gemfile:
+
+  gem 'mongoid-slugify'
+
+== Usage
+
+  class Product
+    include Mongoid::Document
+    include Mongoid::Slugify
+
+    field :title
+
+    private
+      def generate_slug
+        title.parameterize
+      end
+  end
+
+As you can see, you should make 2 things:
+
+- include Mongoid::Slugify module to your model
+- provide a way to generate initial slug for your model (based on any fields, that you want)
+
+If do those - Mongooid::Slugify will save the generated slug to `slug` field of your model and will care about slug uniqueness
+(it will append "-1", "-2", etc to your slugs until it finds free one).
+
+Mongooid::Slugify gives you these additional functions:
+
+- redefines to_param method, so that it returns slug, if it's present, and model id otherwise
+- Model.(find_by_slug/find_by_slug!/find_by_slug_or_id/find_by_slug_or_id!) methods.
+  If you don't want to generate slugs for all your existing objects (so that to_param will return model ids) - you should prefer the latter two in your controllers.
+
+== Warning
+
+This library will NEVER (at least not in the nearest future) provide a way to generate initial slugs. I just don't need it.
+Don't try to add this functionality to my library.
+
+If you need all-out-of-the-box solution - look at Mongoid Slug [https://github.com/hakanensari/mongoid-slug], it's far more full featured and actively developed.

data/Rakefile

@@ -0,0 +1,8 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+end
+
+task :default => :spec

data/lib/mongoid/slugify/version.rb

@@ -0,0 +1,5 @@
+module Mongoid
+  module Slugify
+    VERSION = "0.0.1"
+  end
+end

data/lib/mongoid/slugify.rb

@@ -0,0 +1,65 @@
+require 'mongoid'
+require 'mongoid/slugify/version'
+require 'active_support/concern'
+
+module Mongoid
+  module Slugify
+    extend ActiveSupport::Concern
+    
+    included do
+      field :slug
+      index :slug, :unique => true
+      before_save :assign_slug
+    end
+
+    module ClassMethods
+      def find_by_slug(slug)
+        where(:slug => slug).first
+      end
+
+      def find_by_slug!(slug)
+        find_by_slug(slug) || raise(Mongoid::Errors::DocumentNotFound.new(self, slug))
+      end
+      
+      def find_by_slug_or_id(slug_or_id)
+        find_by_slug(slug_or_id) || where(:id => id).first
+      end
+
+      def find_by_slug_or_id!(slug_or_id)
+        find_by_slug(slug_or_id) || find(slug_or_id)
+      end
+    end
+
+    module InstanceMethods
+      def to_param
+        slug || super
+      end
+
+      private
+        def generate_slug
+          raise NotImplementedError
+        end
+
+        def generate_unique_slug
+          current_slug = generate_slug
+          pattern = /^#{Regexp.escape(current_slug)}(?:-(\d+))?$/
+          
+          appropriate_class = self.class
+          while (appropriate_class.superclass.include?(Mongoid::Document))
+            appropriate_class = appropriate_class.superclass
+          end
+
+          existing_slugs = appropriate_class.where(:slug => pattern, :_id.ne => _id).only(:slug).map { |record| record.slug }
+          if existing_slugs.count > 0
+            max_counter = existing_slugs.map { |slug| (pattern.match(slug)[1] || 0).to_i }.max
+            current_slug += "-#{max_counter + 1}"
+          end
+          current_slug
+        end
+
+        def assign_slug
+          self.slug = generate_unique_slug
+        end
+    end
+  end
+end

data/lib/mongoid-slugify.rb

@@ -0,0 +1 @@
+require "mongoid/slugify"

data/mongoid-slugify.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/mongoid/slugify/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Pavel Forkert"]
+  gem.email         = ["fxposter@gmail.com"]
+  gem.description   = "Provides a simple way to add slug generation to a Mongoid model"
+  gem.summary       = "Managing slugs in Mongoid models"
+  gem.homepage      = ""
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "mongoid-slugify"
+  gem.require_paths = ["lib"]
+  gem.version       = Mongoid::Slugify::VERSION
+  
+  gem.add_runtime_dependency 'activesupport', '>= 3.0', '< 3.2'
+  gem.add_runtime_dependency 'mongoid', '~> 2.0'
+end

data/spec/mongoid/slugify_spec.rb

@@ -0,0 +1,233 @@
+#encoding: utf-8
+require "spec_helper"
+
+class Author
+  include Mongoid::Document
+  include Mongoid::Slugify
+  field :first_name
+  field :last_name
+  referenced_in :book
+  references_many :characters,
+                  :class_name => 'Person',
+                  :foreign_key => :author_id
+
+  private
+    def generate_slug
+      [first_name, last_name].reject(&:blank?).join('-').parameterize
+    end
+end
+
+class Book
+  include Mongoid::Document
+  include Mongoid::Slugify
+  field :title
+  embeds_many :subjects
+  references_many :authors
+  
+  private
+    def generate_slug
+      title.parameterize
+    end
+end
+
+class ComicBook < Book
+end
+
+class Person
+  include Mongoid::Document
+  include Mongoid::Slugify
+  field :name
+  embeds_many :relationships
+  referenced_in :author, :inverse_of => :characters
+  
+  private
+    def generate_slug
+      name.parameterize
+    end
+end
+
+class Caption
+  include Mongoid::Document
+  include Mongoid::Slugify
+  field :identity
+  field :title
+  field :medium
+
+  private
+    def generate_slug
+      [identity.gsub(/\s*\([^)]+\)/, ''), title].join(' ').parameterize
+    end
+end
+
+module Mongoid
+  describe Slugify do
+    let(:book) do
+      Book.create(:title => "A Thousand Plateaus")
+    end
+
+    context "when the object is top-level" do
+      it "generates a slug" do
+        book.to_param.should eql "a-thousand-plateaus"
+      end
+
+      it "updates the slug" do
+        book.title = "Anti Oedipus"
+        book.save
+        book.to_param.should eql "anti-oedipus"
+      end
+
+      it "generates a unique slug by appending a counter to duplicate text" do
+        15.times{ |x|
+          dup = Book.create(:title => book.title)
+          dup.to_param.should eql "a-thousand-plateaus-#{x+1}"
+        }
+      end
+
+      it "does not update slug if slugged fields have not changed" do
+        book.save
+        book.to_param.should eql "a-thousand-plateaus"
+      end
+
+      it "does not change slug if slugged fields have changed but generated slug is identical" do
+        book.title = "a thousand plateaus"
+        book.save
+        book.to_param.should eql "a-thousand-plateaus"
+      end
+
+      it "finds by slug" do
+        Book.find_by_slug(book.to_param).should eql book
+      end
+    end
+
+    context "when the slug is composed of multiple fields" do
+      let!(:author) do
+        Author.create(
+          :first_name => "Gilles",
+          :last_name => "Deleuze")
+      end
+
+      it "generates a slug" do
+        author.to_param.should eql "gilles-deleuze"
+      end
+
+      it "updates the slug" do
+        author.first_name = "Félix"
+        author.last_name = "Guattari"
+        author.save
+        author.to_param.should eql "felix-guattari"
+      end
+
+      it "generates a unique slug by appending a counter to duplicate text" do
+        dup = Author.create(
+          :first_name => author.first_name,
+          :last_name => author.last_name)
+        dup.to_param.should eql 'gilles-deleuze-1'
+
+        dup2 = Author.create(
+          :first_name => author.first_name,
+          :last_name => author.last_name)
+
+        dup.save
+        dup2.to_param.should eql 'gilles-deleuze-2'
+      end
+
+      it "does not update slug if slugged fields have changed but generated slug is identical" do
+        author.last_name = "DELEUZE"
+        author.save
+        author.to_param.should eql 'gilles-deleuze'
+      end
+
+      it "finds by slug" do
+        Author.find_by_slug("gilles-deleuze").should eql author
+      end
+    end
+
+    context "when :slug is given a block" do
+      let(:caption) do
+        Caption.create(:identity => 'Edward Hopper (American, 1882-1967)',
+                       :title => 'Soir Bleu, 1914',
+                       :medium => 'Oil on Canvas')
+      end
+
+      it "generates a slug" do
+        caption.to_param.should eql 'edward-hopper-soir-bleu-1914'
+      end
+
+      it "updates the slug" do
+        caption.title = 'Road in Maine, 1914'
+        caption.save
+        caption.to_param.should eql "edward-hopper-road-in-maine-1914"
+      end
+
+      it "does not change slug if slugged fields have changed but generated slug is identical" do
+        caption.identity = 'Edward Hopper'
+        caption.save
+        caption.to_param.should eql 'edward-hopper-soir-bleu-1914'
+      end
+
+      it "finds by slug" do
+        Caption.find_by_slug(caption.to_param).should eql caption
+      end
+    end
+
+    context "when :index is passed as an argument" do
+      before do
+        Book.collection.drop_indexes
+        Author.collection.drop_indexes
+      end
+
+      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 not scoped by a reference association" do
+        it "defines a unique index" do
+          Book.create_indexes
+          Book.index_information["slug_1"]["unique"].should be_true
+        end
+      end
+    end
+
+    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.slug)
+      end
+    end
+
+    describe ".find_by_slug" do
+      let!(:book) { Book.create(:title => "A Thousand Plateaus") }
+
+      it "returns nil if no document is found" do
+        Book.find_by_slug(:title => "Anti Oedipus").should be_nil
+      end
+
+      it "returns the document if it is found" do
+        Book.find_by_slug(book.slug).should == book
+      end
+    end
+
+    describe ".find_by_slug!" do
+      let!(:book) { Book.create(:title => "A Thousand Plateaus") }
+
+      it "raises a Mongoid::Errors::DocumentNotFound error if no document is found" do
+        lambda {
+          Book.find_by_slug!(:title => "Anti Oedipus")
+        }.should raise_error(Mongoid::Errors::DocumentNotFound)
+      end
+
+      it "returns the document when it is found" do
+        Book.find_by_slug!(book.slug).should == book
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+require "bundler/setup"
+Bundler.require(:default, :development)
+
+Mongoid.configure do |config|
+  name = "mongoid_slugify_test"
+  config.master = Mongo::Connection.new.db(name)
+end
+
+DatabaseCleaner.strategy = :truncation
+DatabaseCleaner.orm = :mongoid
+
+RSpec.configure do |config|
+  config.before :each do
+    DatabaseCleaner.start
+  end
+  
+  config.after :each do
+    DatabaseCleaner.clean
+  end
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: mongoid-slugify
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Pavel Forkert
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-10-17 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70314068885540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70314068885540
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: &70314068884600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70314068884600
+description: Provides a simple way to add slug generation to a Mongoid model
+email:
+- fxposter@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.rdoc
+- Rakefile
+- lib/mongoid-slugify.rb
+- lib/mongoid/slugify.rb
+- lib/mongoid/slugify/version.rb
+- mongoid-slugify.gemspec
+- spec/mongoid/slugify_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+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'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Managing slugs in Mongoid models
+test_files:
+- spec/mongoid/slugify_spec.rb
+- spec/spec_helper.rb