mongoid_slug 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Hakan Ensari
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,17 @@
+= Mongoid Slug
+
+This gem generates a URL slug/permalink based on a field in a Mongoid model.
+
+    class Book
+      include Mongoid::Document
+      include Mongoid::Slug
+      field :title
+      slug  :title
+    end
+    
+    >> book = Book.create(:title => "A Thousand Plateaus")
+    >> book.to_param
+    "a-thousand-plateaus"
+    >> book.update_attributes(:title => "Anti Oedipus")
+    >> book.to_param
+    "anti-oedipus"

data/lib/mongoid_slug.rb

@@ -0,0 +1,44 @@
+# Generates a URL slug/permalink based on a field in a Mongoid model.
+module Mongoid::Slug
+  
+  def self.included(base)
+    base.extend ClassMethods
+    base.class_eval { field :slug; before_save :slugify }
+  end
+
+  module ClassMethods #:nodoc:
+    
+    # Set a field as source of slug
+    def slug(field)
+      class_variable_set(:@@slugged_field, field.to_sym)
+    end
+
+    def find_by_slug(slug)
+      where(:slug => slug).first
+    end
+  end
+
+  def to_param
+    slug
+  end
+
+  private
+
+  def slugify
+    self.slug = find_unique_slug if new_record? || self.send((self.class.class_eval('@@slugged_field').to_s + '_changed?').to_sym)
+  end
+
+  def find_unique_slug(suffix='')
+    slug = ("#{slugged_field} #{suffix}").parameterize
+    if collection.find(:slug => slug).count == 0
+      slug
+    else
+      new_suffix = suffix.blank? ? '1' : "#{suffix.to_i + 1}"
+      find_unique_slug(new_suffix)
+    end
+  end
+
+  def slugged_field
+    self.send(self.class.class_eval('@@slugged_field'))
+  end
+end

data/spec/models/book.rb

@@ -0,0 +1,7 @@
+class Book
+  include Mongoid::Document
+  include Mongoid::Slug
+  field :title
+  field :authors
+  slug :title
+end

data/spec/spec_helper.rb

@@ -0,0 +1,27 @@
+require "rubygems"
+require "bundler"
+Bundler.require(:default)
+
+require File.expand_path("../../lib/mongoid_slug", __FILE__)
+Dir["#{File.dirname(__FILE__)}/models/*.rb"].each { |f| require f }
+
+Mongoid.configure do |config|
+  name = "mongoid_slug_test"
+  host = "localhost"
+  config.master = Mongo::Connection.new.db(name)
+end
+
+DatabaseCleaner.orm = "mongoid"
+Rspec.configure do |config|
+  config.before(:all) do
+    DatabaseCleaner.strategy = :truncation
+  end
+
+  config.before(:each) do
+    DatabaseCleaner.start
+  end
+
+  config.after(:each) do
+    DatabaseCleaner.clean
+  end
+end

data/spec/unit/mongoid_slug_spec.rb

@@ -0,0 +1,40 @@
+require "spec_helper"
+
+describe Mongoid::Slug do
+  before(:each) do
+    @book = ::Book.create(:title => "A Thousand Plateaus", :authors => "Gilles Deleuze, Félix Guattari")
+  end
+
+  it "generates slug" do
+    @book.to_param.should eql @book.title.parameterize
+  end
+
+  it "updates slug" do
+    @book.update_attributes(:title => "Anti Oedipus")
+    @book.reload.to_param.should eql "Anti Oedipus".parameterize
+  end
+
+  it "generates a unique slug" do
+    similar_book = Book.create(:title => @book.title)
+    similar_book.to_param.should_not eql @book.to_param
+  end
+
+  it "appends a counter when slug is not unique" do
+    similar_book = Book.create(:title => @book.title)
+    similar_book.slug.should match /\d$/
+  end
+
+  it "does not append a counter when slug is unique" do
+    @book.slug.should_not match /\d$/
+  end
+
+  it "does not update slug if slugged field has not changed" do
+    existing_slug = @book.slug
+    @book.update_attributes('authors' => "Gilles Deleuze")
+    @book.slug.should eql existing_slug
+  end
+
+  it "finds by slug" do
+    Book.find_by_slug(@book.slug).should eql @book
+  end
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification 
+name: mongoid_slug
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Hakan Ensari
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-22 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mongoid
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: -1848230041
+        segments: 
+        - 2
+        - 0
+        - 0
+        - beta7
+        version: 2.0.0.beta7
+  type: :runtime
+  version_requirements: *id001
+description: Mongoid Slug generates a URL slug/permalink based on a field in a Mongoid model.
+email: code@papercavalier.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- LICENSE
+- README.rdoc
+- lib/mongoid_slug.rb
+- spec/models/book.rb
+- spec/spec_helper.rb
+- spec/unit/mongoid_slug_spec.rb
+has_rdoc: true
+homepage: http://github.com/papercavalier/mongoid-slug
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Generates a URL slug in a Mongoid model
+test_files: 
+- spec/models/book.rb
+- spec/spec_helper.rb
+- spec/unit/mongoid_slug_spec.rb