acts_as_sluggable 0.0.2 → 0.0.3

data/.gitignore

@@ -2,3 +2,4 @@ pkg/*
 *.gem
 .bundle
 .rvmrc
+.DS_Store

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    acts_as_sluggable (0.0.1)
+    acts_as_sluggable (0.0.3)
       mongoid (>= 2.0.0.beta.17)
 
 GEM

data/README.markdown

@@ -67,6 +67,25 @@ on the Document it will be automatically declared, so adding:
 
 is optional.
 
+## find
+
+To make things transparent and easy, by default, the find method of the acts_as_sluggable Documents will look for the object by the slug, not the id.
+
+So, if you had the Project class configured as the example above:
+
+    @project = Project.create(:name => "Name")
+
+    Project.find(@project.to_param)                               #=> @project
+
+If, for any reason, you have to look for the object using its id, you have to be explicit:
+
+    @project = Project.create(:name => "Name")
+
+    Project.find(:first, :conditions => {:_id => @project.id})    #=> @project
+    Project.where(:_id => @project.id)                            #=> @project
+
+The *find* behavior for the other Mongoid::Documents remains the same.
+
 # About the Author
 
 [Crowd Interactive](http://www.crowdint.com) is an American web design and development company that happens to work in Colima, Mexico. 

data/acts_as_sluggable.gemspec

@@ -6,8 +6,8 @@ Gem::Specification.new do |s|
   s.name        = "acts_as_sluggable"
   s.version     = Acts::Sluggable::VERSION
   s.platform    = Gem::Platform::RUBY
-  s.authors     = ["David Padilla"]
-  s.email       = ["david@crowdint.com"]
+  s.authors     = ["David Padilla", "Emmanuel Delgado"]
+  s.email       = ["david@crowdint.com", "emmanuel@crowdint.com"]
   s.homepage    = "http://rubygems.org/gems/acts_as_sluggable"
   s.summary     = %q{Create a slug for mongoid documents}
   s.description = %q{Create a slug for mongoid documents}

data/lib/acts_as_sluggable.rb

@@ -1,6 +1,4 @@
 require 'acts_as_sluggable/acts/sluggable'
+require 'acts_as_sluggable/mongoid/criterion/optional'
 
-#
-# Include it in Mongoid::Document
-#
-Mongoid::Document.send(:include, Acts::Sluggable)
+Mongoid::Document.send(:include, Acts::Sluggable)

data/lib/acts_as_sluggable/acts/sluggable.rb

@@ -16,44 +16,45 @@ module Acts
         @acts_as_sluggable_options = {
           :generate_from => :name,
           :store_as => :slug
-        }.merge(options)
+          }.merge(options)
 
-        generate_from = @acts_as_sluggable_options[:generate_from]
-        store_as = @acts_as_sluggable_options[:store_as]
+          generate_from = @acts_as_sluggable_options[:generate_from]
+          store_as = @acts_as_sluggable_options[:store_as]
 
-        class_eval do
-          before_save do
-            generate_slug(generate_from, store_as)
-          end
+          class_eval do
+            before_save do
+              generate_slug(generate_from, store_as)
+            end
 
-          field(store_as, :type => String) unless self.respond_to?(store_as)
-          index(store_as)
-          alias_method :to_param!, :to_param
-        end
+            field(store_as, :type => String) unless self.respond_to?(store_as)
+            index(store_as)
+            alias_method :to_param!, :to_param
 
-        define_method("to_param") do
-          self.send(store_as)
-        end
-      end
+            include InstanceMethods
 
-      def acts_as_sluggable_options
-        @acts_as_sluggable_options
-      end
+            def self.acts_as_sluggable_options
+              @acts_as_sluggable_options
+            end
+
+            def self.find_by_slug(slug)
+              where(@acts_as_sluggable_options[:store_as] => slug).first
+            end
+          end
 
-      def find_by_slug(slug)
-        where(@acts_as_sluggable_options[:store_as] => slug).first
+          define_method("to_param") do
+            self.send(store_as)
+          end
+        end
       end
-    end
 
-    module InstanceMethods
-      def generate_slug(method, slug_field_name)
-        self.send("#{slug_field_name.to_s}=", self.send(method).parameterize)
+      module InstanceMethods
+        def generate_slug(method, slug_field_name)
+          self.send("#{slug_field_name.to_s}=", self.send(method).parameterize)
+        end
       end
-    end
 
-    def self.included(receiver)
-      receiver::ClassMethods.send :include, ClassMethods
-      receiver.send :include, InstanceMethods
+      def self.included(receiver)
+        receiver::ClassMethods.send :include, ClassMethods
+      end
     end
   end
-end

data/lib/acts_as_sluggable/mongoid/criterion/optional.rb

@@ -0,0 +1,26 @@
+module Mongoid::Criterion::Optional
+  #
+  # Overwrite the id method to find objects
+  # by the specified slug rather than the id.
+  # If you want to find via id you'll have to use
+  # An explicit finder like:
+  #
+  #   where(:_id => some_id)
+  #
+  alias :id! :id
+  def id(*ids)
+    if @klass.respond_to?(:acts_as_sluggable_options)
+      ids.flatten!
+      if ids.size > 1
+        self.in(
+        @klass.acts_as_sluggable_options[:store_as] => ::BSON::ObjectId.cast!(@klass, ids, @klass.primary_key.nil?)
+        )
+      else
+        @selector[@klass.acts_as_sluggable_options[:store_as]] = ids.first
+      end
+      self
+    else
+      id!(*ids)
+    end
+  end
+end

data/lib/acts_as_sluggable/version.rb

@@ -1,5 +1,5 @@
 module Acts
   module Sluggable
-    VERSION = "0.0.2"
+    VERSION = "0.0.3"
   end
 end

data/test/test_helper.rb

@@ -3,8 +3,44 @@ require 'test/unit'
 require 'bundler/setup'
 require 'shoulda'
 require 'mongoid'
-
 require 'acts_as_sluggable'
 
-# $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
+
+module Acts::Sluggable::Test
+  module Config
+    def setup
+      ::Mongoid.configure do |config|
+        name = "acts_as_sluggable_test"
+        host = "localhost"
+        config.master = Mongo::Connection.new.db(name)
+        config.logger = nil
+      end
+    end
+
+    def teardown
+      ::Mongoid.master.collections.select {|c| c.name !~ /system/ }.each(&:drop)
+    end
+  end
+end
+
+class Project
+  include Mongoid::Document
+  field :name, :type => String
+end
+
+class SluggableProject
+  include Mongoid::Document
+  field :name, :type => String
+  acts_as_sluggable
+end
+
+class Organization
+  include Mongoid::Document
+
+  acts_as_sluggable :generate_from => :alternative_name, :store_as => :alternative_slug
+
+  field :alternative_name, :type => String
+  field :alternative_slug, :type => String
+end
+

data/test/unit/test_as_sluggable.rb

@@ -1,88 +1,71 @@
 require 'test_helper'
 
-class Project
-  include Mongoid::Document
+module Acts::Sluggable::Test
 
-  acts_as_sluggable
+  class TestActsAsSluggable < Test::Unit::TestCase
 
-  field :name, :type => String
-end
-
-class Organization
-  include Mongoid::Document
-
-  acts_as_sluggable :generate_from => :alternative_name, :store_as => :alternative_slug
+    include Config 
 
-  field :alternative_name, :type => String
-  field :alternative_slug, :type => String
-end
-
-class TestActsAsSluggable < Test::Unit::TestCase
-  def setup
-    ::Mongoid.configure do |config|
-      name = "acts_as_sluggable_test"
-      host = "localhost"
-      config.master = Mongo::Connection.new.db(name)
-      config.logger = nil
+    def methods_per_model_assert(expected, model)
+      [:find_by_slug, :find].each do |method|
+        assert_equal(expected, model.send(method, expected.to_param))
+      end
     end
-  end
 
-  context "default parameters" do
-    setup do
-      @project = Project.create(:name => 'Some name')
-    end
+    context "default parameters" do
+      setup do
+        @sluggable_project = SluggableProject.create(:name => 'Some name')
+      end
 
-    should "create a slug" do
-      assert_equal('some-name', @project.slug)
-    end
+      should "create a slug" do
+        assert_equal('some-name', @sluggable_project.slug)
+      end
 
-    context :to_param do
-      should "return the slug too" do
-        assert_equal('some-name', @project.to_param)        
+      context :to_param do
+        should "return the slug too" do
+          assert_equal('some-name', @sluggable_project.to_param)        
+        end
       end
-    end
 
-    context :find_by_slug do
-      should "find the object" do
-        assert_equal(@project, Project.find_by_slug(@project.to_param))
+      context :using_finders do
+        should "find the object" do
+          methods_per_model_assert @sluggable_project, SluggableProject
+        end
       end
     end
-  end
 
-  context "custom parameters" do
-    setup do
-      @organization = Organization.create(:alternative_name => 'Some Other Name')
-    end
+    context "custom parameters" do
+      setup do
+        @organization = Organization.create(:alternative_name => 'Some Other Name')
+      end
 
-    should "create a slug using the custom field and store it on the custom slug field" do
-      assert_equal('some-other-name', @organization.alternative_slug)
-    end
+      should "create a slug using the custom field and store it on the custom slug field" do
+        assert_equal('some-other-name', @organization.alternative_slug)
+      end
 
-    context :to_param do
-      should "return the slug too" do
-        assert_equal('some-other-name', @organization.to_param)        
+      context :to_param do
+        should "return the slug too" do
+          assert_equal('some-other-name', @organization.to_param)        
+        end
       end
-    end
 
-    context :find_by_slug do
-      should "find the object" do
-        assert_equal(@organization, Organization.find_by_slug(@organization.to_param))
+      context :using_finders do
+        should "find the object" do
+          methods_per_model_assert @organization, Organization
+        end
       end
     end
-  end
 
-  context :acts_as_sluggable_options do
-    should "respond to acts_as_sluggable_options" do
-      assert_equal(true, Project.respond_to?(:acts_as_sluggable_options))
-    end
+    context :acts_as_sluggable_options do
+      should "respond to acts_as_sluggable_options" do
+        assert_equal(true, SluggableProject.respond_to?(:acts_as_sluggable_options))
+      end
 
-    should "return the options for acts_as_sluggable" do
-      assert_equal(:name, Project.acts_as_sluggable_options[:generate_from])
-      assert_equal(:slug, Project.acts_as_sluggable_options[:store_as])
+      should "return the options for acts_as_sluggable" do
+        assert_equal(:name, SluggableProject.acts_as_sluggable_options[:generate_from])
+        assert_equal(:slug, SluggableProject.acts_as_sluggable_options[:store_as])
+      end
     end
-  end
 
-  def teardown
-    ::Mongoid.master.collections.select {|c| c.name !~ /system/ }.each(&:drop)
   end
-end
+end

data/test/unit/test_mongoid_finder.rb

@@ -0,0 +1,31 @@
+require 'test_helper'
+
+module Acts::Sluggable::Test
+
+  class TestMongoidFinder < Test::Unit::TestCase
+
+    include Config
+    alias :setup! :setup
+
+    def setup
+      setup!
+      @sluggable_project = SluggableProject.create!(:name => 'Scott')
+      @project = Project.create!
+    end
+
+    context "find" do
+      should "return the objects when you pass the id" do
+        assert_equal(@sluggable_project, SluggableProject.find(@sluggable_project.to_param))
+        assert_equal(@project, Project.find(@project.id))
+      end
+    end
+
+    context "explicit find by id" do
+      should "return the object" do
+        assert_equal(@sluggable_project, SluggableProject.where(:_id => @sluggable_project.id).first)
+        assert_equal(@sluggable_project, SluggableProject.find(:first, :conditions => {:_id => @sluggable_project.id}))
+      end
+    end
+
+  end
+end

metadata

@@ -1,21 +1,22 @@
 --- !ruby/object:Gem::Specification 
 name: acts_as_sluggable
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - David Padilla
+- Emmanuel Delgado
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2010-10-28 00:00:00 -05:00
+date: 2010-10-30 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -71,6 +72,7 @@ dependencies:
 description: Create a slug for mongoid documents
 email: 
 - david@crowdint.com
+- emmanuel@crowdint.com
 executables: []
 
 extensions: []
@@ -86,9 +88,11 @@ files:
 - acts_as_sluggable.gemspec
 - lib/acts_as_sluggable.rb
 - lib/acts_as_sluggable/acts/sluggable.rb
+- lib/acts_as_sluggable/mongoid/criterion/optional.rb
 - lib/acts_as_sluggable/version.rb
 - test/test_helper.rb
 - test/unit/test_as_sluggable.rb
+- test/unit/test_mongoid_finder.rb
 has_rdoc: true
 homepage: http://rubygems.org/gems/acts_as_sluggable
 licenses: []
@@ -126,3 +130,4 @@ summary: Create a slug for mongoid documents
 test_files: 
 - test/test_helper.rb
 - test/unit/test_as_sluggable.rb
+- test/unit/test_mongoid_finder.rb