slugoid4 0.0.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9c0b633f3004ec696b74052700f8d1ad282e4512
+  data.tar.gz: aabef7318ab0948457e3bcc249635e5d90a3a3cc
+SHA512:
+  metadata.gz: b98ff05ceccf59f071570ba8b85a2a7f46258cbeab86326651a5f145922bc3b034df335862364e0659c199848291c5784affa412693e961c08349290498fda30
+  data.tar.gz: bfa470593641690523b6d364a8cb4bfd0d2b4649202ede5fd4e7659144b84dc827b8926eae03efcfff395afae1f4c97012067810801e23e3fd63a055110bbaaf

data/.gitignore

@@ -0,0 +1,7 @@
+pkg/*
+*.gem
+.bundle
+.rvmrc
+.DS_Store
+Gemfile.lock
+.idea

data/.idea/scopes/scope_settings.xml

@@ -0,0 +1,5 @@
+<component name="DependencyValidationManager">
+  <state>
+    <option name="SKIP_IMPORT_STATEMENTS" value="false" />
+  </state>
+</component>

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in slugoid.gemspec
+gemspec

data/README.markdown

@@ -0,0 +1,101 @@
+# slugoid
+
+Whenever you use MongoDB and Mongoid, there's a high chance you will end up preparing your urls
+with a slug instead of the traditional ids because MongoDB ids are ugly.
+
+This gem will help you generate slugs in an easy way
+
+## Compatibility
+
+So far it works with the Rails 3 version of Mongoid.
+
+### Attention
+
+If you're using mongoid 2.0.0.rc.7 or less, you need to use version
+*0.0.5*
+
+When mongoid 2.0.0.rc.8 was released there was a change that prevented
+backwards compatibility.
+
+# Installation
+
+## Rails 3
+
+Include it in your Gemfile:
+
+    gem 'slugoid'
+
+And run bundler
+
+    bundle install
+
+# Usage
+
+To use it, all you have to do is call *acts_as_slugoid* in your Mongoid::Document
+
+    class Project
+      include Mongoid::Document
+
+      acts_as_slugoid
+    end
+
+By default, this will declare a field on the Document called :slug and will try to generate the slug from
+a field called :name.
+
+## Options
+
+### :generate_from
+
+If you want to change the field to generate the slug you can use the :generate_from option:
+
+    class Organization
+      include Mongoid::Document
+
+      field :alternative_name
+      acts_as_slugoid :generate_from => :alternative_name
+    end
+
+This will generate the slug form a field called :alternative_name.
+
+### :store_as
+
+If you want to change the field where the slug is stored you can use the :store_as option:
+
+    class Organization
+      include Mongoid::Document
+
+      field :name
+      acts_as_slugoid :store_as => :alternative_slug
+    end
+
+Now it will store the slug in a field called :alternative_slug. If the specified field is not defined
+on the Document it will be automatically declared, so adding:
+
+    field :alternative_slug
+
+is optional.
+
+## find
+
+To make things transparent and easy, by default, the find method of the acts_as_slugoid 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. 
+We specialize in building and growing online retail stores. We don’t work with everyone – just companies we believe in. Call us today to see if there’s a fit.
+Find more info [here](http://www.crowdint.com)!

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test

data/lib/slugoid/acts/slugoid.rb

@@ -0,0 +1,63 @@
+module Acts
+  module Slugoid
+    module ClassMethods
+
+      extend ActiveSupport::Concern
+
+      #
+      # Adds the logic to generate the slug
+      #
+      # Options:
+      #
+      #   :generate_from
+      #       The name of the field used to generate the slug
+      #
+      #   :store_as
+      #       The name of the field where the slug will be stored
+      #
+      def acts_as_slugoid(options = {})
+        @acts_as_slugoid_options = {
+          :generate_from => :name,
+          :store_as => :slug
+          }.merge(options)
+
+          generate_from = @acts_as_slugoid_options[:generate_from]
+          store_as = @acts_as_slugoid_options[:store_as]
+
+          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
+
+            include InstanceMethods
+
+            def self.acts_as_slugoid_options
+              @acts_as_slugoid_options
+            end
+
+            def self.find_by_slug(slug)
+              where(@acts_as_slugoid_options[:store_as] => slug).first
+            end
+          end
+
+          define_method("to_param") do
+            self.send(store_as)
+          end
+        end
+      end
+
+      module InstanceMethods
+        def generate_slug(method, slug_field_name)
+          self.send("#{slug_field_name.to_s}=", self.send(method).parameterize)
+        end
+      end
+
+      def self.included(receiver)
+        receiver::ClassMethods.send :include, ClassMethods
+      end
+    end
+  end

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

@@ -0,0 +1,31 @@
+module Mongoid::Criterion
+  module Optional
+
+    extend ActiveSupport::Concern
+
+    # 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 :for_ids! :for_ids
+
+    def for_ids(*ids)
+      ids.flatten!
+      if @klass.respond_to?(:acts_as_slugoid_options) && !ids.first.is_a?(BSON::ObjectId)
+        if ids.size > 1
+          self.in(
+              @klass.acts_as_slugoid_options[:store_as] => ::BSON::ObjectId.cast!(@klass, ids, @klass.primary_key.nil?)
+          )
+        else
+          @selector[@klass.acts_as_slugoid_options[:store_as]] = ids.first
+        end
+        self
+      else
+        for_ids!(*ids)
+      end
+    end
+  end
+end

data/lib/slugoid/version.rb

@@ -0,0 +1,5 @@
+module Acts
+  module Slugoid
+    VERSION = "0.0.6"
+  end
+end

data/lib/slugoid.rb

@@ -0,0 +1,6 @@
+require 'slugoid/acts/slugoid'
+
+include  Acts::Slugoid
+include  Mongoid::Criterion::Optional
+
+Mongoid::Document.send(:include, Acts::Slugoid)

data/slugoid.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "slugoid/version"
+
+Gem::Specification.new do |s|
+  s.name        = "slugoid4"
+  s.version     = Acts::Slugoid::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Irfan Ahmed","David Padilla", "Emmanuel Delgado"]
+  s.email       = ["irfan@e-solutionpark.com","david@crowdint.com", "emmanuel@crowdint.com"]
+  s.homepage    = "http://rubygems.org/gems/slugoid4"
+  s.summary     = %q{Drop-in solution to pretty urls when using Mongoid for rails4}
+  s.description = %q{Drop-in solution to pretty urls when using Mongoid}
+
+  s.add_dependency('mongoid', '~>4.0.0')
+  s.add_development_dependency('bson_ext')
+  s.add_development_dependency('shoulda')
+
+  s.files         = ['lib/slugoid/acts/slugoid.rb', 'lib/slugoid/mongoid/criterion/optional.rb' ]+ `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib", "lib/slugoid", "lib/slugoid/acts", "lib/slugoid/mongoid"]
+  s.license       = 'MIT'
+end

data/test/test_helper.rb

@@ -0,0 +1,46 @@
+require 'rubygems'
+require 'test/unit'
+require 'bundler/setup'
+require 'shoulda'
+require 'mongoid'
+require 'slugoid'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+module Acts::Slugoid::Test
+  module Config
+    def setup
+      ::Mongoid.configure do |config|
+        name = "slugoid_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 SlugoidProject
+  include Mongoid::Document
+  field :name, :type => String
+  acts_as_slugoid
+end
+
+class Organization
+  include Mongoid::Document
+
+  acts_as_slugoid :generate_from => :alternative_name, :store_as => :alternative_slug
+
+  field :alternative_name, :type => String
+  field :alternative_slug, :type => String
+end
+

data/test/unit/test_as_slugoid.rb

@@ -0,0 +1,71 @@
+require 'test_helper'
+
+module Acts::Slugoid::Test
+
+  class TestSlugoid < Test::Unit::TestCase
+
+    include Config 
+
+    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
+
+    context "default parameters" do
+      setup do
+        @slugoid_project = SlugoidProject.create(:name => 'Some name')
+      end
+
+      should "create a slug" do
+        assert_equal('some-name', @slugoid_project.slug)
+      end
+
+      context :to_param do
+        should "return the slug too" do
+          assert_equal('some-name', @slugoid_project.to_param)        
+        end
+      end
+
+      context :using_finders do
+        should "find the object" do
+          methods_per_model_assert @slugoid_project, SlugoidProject
+        end
+      end
+    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
+
+      context :to_param do
+        should "return the slug too" do
+          assert_equal('some-other-name', @organization.to_param)
+        end
+      end
+
+      context :using_finders do
+        should "find the object" do
+          methods_per_model_assert @organization, Organization
+        end
+      end
+    end
+
+    context :acts_as_slugoid_options do
+      should "respond to acts_as_slugoid_options" do
+        assert_equal(true, SlugoidProject.respond_to?(:acts_as_slugoid_options))
+      end
+
+      should "return the options for acts_as_slugoid" do
+        assert_equal(:name, SlugoidProject.acts_as_slugoid_options[:generate_from])
+        assert_equal(:slug, SlugoidProject.acts_as_slugoid_options[:store_as])
+      end
+    end
+
+  end
+end

data/test/unit/test_mongoid_finder.rb

@@ -0,0 +1,37 @@
+require 'test_helper'
+
+module Acts::Slugoid::Test
+
+  class TestMongoidFinder < Test::Unit::TestCase
+
+    include Config
+    alias :setup! :setup
+
+    def setup
+      setup!
+      @slugoid_project = SlugoidProject.create!(:name => 'Scott')
+      @project         = Project.create!(:name => 'Bauer')
+    end
+
+    context "find" do
+      should "return the objects when you pass the id" do
+        assert_equal(@slugoid_project, SlugoidProject.find(@slugoid_project.to_param))
+        assert_equal(@slugoid_project, SlugoidProject.find(@slugoid_project.id))
+      end
+
+      should "work as usual for other models" do
+        assert_equal @project, Project.find(@project.id)
+        assert_equal @project, Project.find(:first, :conditions => {:name => @project.name})
+        assert_equal @project, Project.first(:conditions => {:name => @project.name})
+      end
+    end
+
+    context "explicit find by id" do
+      should "return the object" do
+        assert_equal(@slugoid_project, SlugoidProject.where(:_id => @slugoid_project.id).first)
+        assert_equal(@slugoid_project, SlugoidProject.find(:first, :conditions => {:_id => @slugoid_project.id}))
+      end
+    end
+
+  end
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: slugoid4
+version: !ruby/object:Gem::Version
+  version: 0.0.6
+platform: ruby
+authors:
+- Irfan Ahmed
+- David Padilla
+- Emmanuel Delgado
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: bson_ext
+  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: shoulda
+  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: Drop-in solution to pretty urls when using Mongoid
+email:
+- irfan@e-solutionpark.com
+- david@crowdint.com
+- emmanuel@crowdint.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/slugoid/acts/slugoid.rb
+- lib/slugoid/mongoid/criterion/optional.rb
+- .gitignore
+- .idea/scopes/scope_settings.xml
+- Gemfile
+- README.markdown
+- Rakefile
+- lib/slugoid.rb
+- lib/slugoid/version.rb
+- slugoid.gemspec
+- test/test_helper.rb
+- test/unit/test_as_slugoid.rb
+- test/unit/test_mongoid_finder.rb
+homepage: http://rubygems.org/gems/slugoid4
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- lib/slugoid
+- lib/slugoid/acts
+- lib/slugoid/mongoid
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Drop-in solution to pretty urls when using Mongoid for rails4
+test_files: []