mongoid_param 0.1.0

data/README.rdoc

@@ -0,0 +1,106 @@
+= Mongoid::Param
+
+Addon to Mongoid that allows you to easily generate and query against human readable (parameterized) id's!
+
+== Installation
+
+Add to Gemfile:
+  
+    gem 'mongoid_param'
+
+== Getting Started
+
+To parameterize a model, you only need to include the module in your model and then call param with the field(s) you want to parameterize on.  Here's an example:
+
+    class User
+      include Mongoid::Document
+      include Mongoid::Param
+
+      field :username
+      field :dob, :type => Date
+
+      param :username
+    end
+
+== Parameterizing on Multiple Fields
+
+You can pass multiple symbols to the *param* method to parameterize on multiple fields:
+
+    class Post
+      include Mongoid::Document
+      include Mongoid::Param
+  
+      field :year
+      field :month
+      field :day
+      field :title
+  
+      param :year, :month, :day, :title
+    end
+    
+== Customizing your Param values
+
+You can easily customize your param value by passing a method to param:
+
+    class Message
+      include Mongoid::Document
+      include Mongoid::Timestamps
+      include Mongoid::Param
+      
+      field :title
+      param :generate_param
+      
+      private
+      
+      def generate_param
+        created_at ||= Time.now  # necessary because we're called before validation
+        "#{created_at.year} #{created_at.month} #{created_at.day} #{title}"
+      end
+    end
+
+== Behind the Scenes
+
+    >> u = User.new :username => 'Bob', :dob => Date.today
+    
+    >> u.to_param
+    => "bob"
+    
+    >> u.update_attributes :username => 'Johnny Walker'
+    
+    >> u.to_param
+    => "johnny_walker"
+    
+    >> p = Post.new :title => 'Big Announcement', :year => 2010, :month => 2, :day => 13
+    
+    >> p.to_param
+    => "2010_2_13_big_announcement"
+    
+    >> p.update_attributes :month => 10
+    
+    >> p.to_param
+    => "2010_10_13_big_announcement"
+
+== Usage in Rails
+
+Mongoid::Param was designed to easily work with Rails.
+
+In your controller:
+
+    class UserController < ApplicationController
+      ...
+      def show
+        @user = User.find_by_param(params[:id])
+      end
+      ...
+    end
+    
+In your view:
+
+    link_to @user.username, @user   # => /users/bob
+
+== Finding by Parameters
+
+Included is a simple helper method that allows you to easily fetch a record by its _param field:
+
+    @user = User.find_by_param('bob')
+

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/mongoid_param.rb

@@ -0,0 +1,43 @@
+# Generates and allows you to query against a human-friendly name for your records.
+module Mongoid
+  
+  module Param
+  
+    def self.included(base)
+      base.send :extend, ClassMethods
+    end
+  
+    module ClassMethods
+    
+      def param(*on_fields)
+        cattr_accessor :param_fields
+        self.param_fields = on_fields
+        field :_param, :type => String
+        index :_param, :unique => true
+        validates :_param, :presence => true, :uniqueness => true,
+          :format => { :with => /[-a-z0-9_]+/ },
+          :exclusion => { :in => %w[index show new create edit update destroy delete] }
+        before_validation :make_param
+        
+        send :include, InstanceMethods
+      end
+      
+      def find_by_param(value)
+        where(:_param => value).first
+      end
+      
+    end
+  
+    module InstanceMethods
+      def make_param
+        p = (self.param_fields.collect { |f| self.send(f) }.join(" ") || self._id).gsub(/('|")/, '')
+        self._param = p.parameterize('_')
+      end
+      
+      def to_param
+        _param
+      end
+    end
+    
+  end
+end

data/spec/models/post.rb

@@ -0,0 +1,11 @@
+class Post
+  include Mongoid::Document
+  include Mongoid::Param
+  
+  field :year
+  field :month
+  field :day
+  field :title
+  
+  param :year, :month, :day, :title
+end

data/spec/models/user.rb

@@ -0,0 +1,9 @@
+class User
+  include Mongoid::Document
+  include Mongoid::Param
+  
+  field :username
+  field :dob, :type => Date
+  
+  param :username
+end

data/spec/mongoid_param_spec.rb

@@ -0,0 +1,80 @@
+require "spec_helper"
+
+describe Mongoid::Param do
+  
+  context "user" do
+    
+    before(:each) do
+      @bob = User.create(:username => 'Bob', :dob => Date.today)
+      @nancy = User.create(:username => 'Nancy', :dob => Date.today)
+    end
+    
+    it "generates param" do
+      @bob.to_param.should eql 'bob'
+    end
+    
+    it "updates the param" do
+      @bob.update_attributes :username => 'Bobby'
+      @bob.to_param.should eql 'bobby'
+    end
+    
+    it "requires a unique param" do
+      @bob.update_attributes :username => 'Nancy'
+      @bob.errors['_param'].include?('is already taken').should eql true
+    end
+    
+    it "finds by param" do
+      u = User.find_by_param('bob')
+      u.blank?.should eql false
+    end
+    
+    it "does not find nonexistent things" do
+      u = User.find_by_param('someone')
+      u.blank?.should eql true
+    end
+    
+    it "junks bad characters" do
+      u = User.create(:username => '(Alien) Cyborg Warfare #3')
+      u.to_param.should eql 'alien_cyborg_warfare_3'
+    end
+    
+  end
+  
+  context "post" do
+    
+    before(:each) do
+      @big = Post.create(:year => 2010, :month => 06, :day => 21, :title => 'Big Announcement')
+      @big_two = Post.create(:year => 2011, :month => 06, :day => 21, :title => 'Big Announcement')
+      @little = Post.create(:year => 2009, :month => 02, :day => 04, :title => 'Little Announcement')
+    end
+    
+    it "has the proper entires" do
+      Post.count.should eql 3
+    end
+    
+    it "has globbed params" do
+      @big.to_param.should eql "2010_6_21_big_announcement"
+      @big_two.to_param.should eql "2011_6_21_big_announcement"
+      @little.to_param.should eql "2009_2_4_little_announcement"
+    end
+    
+    it "requires a unique param" do
+      @big_two.update_attributes :year => 2010
+      @big_two.errors['_param'].include?('is already taken').should eql true
+    end
+    
+    it "finds by param" do
+      p = Post.find_by_param('2010_6_21_big_announcement')
+      p.blank?.should eql false
+    end
+    
+    it "does not find nonexistent things" do
+      p = Post.find_by_param('2010_5_3_some_post')
+      p.blank?.should eql true
+    end
+    
+  end
+  
+end
+
+      

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+require "rubygems"
+require "bundler"
+
+Bundler.require(:default)
+
+Mongoid.config.master = Mongo::Connection.new.db("mongoid_param_test")
+
+require File.expand_path("../../lib/mongoid_param", __FILE__)
+Dir["#{File.dirname(__FILE__)}/models/*.rb"].each { |f| require f }
+
+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

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification 
+name: mongoid_param
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Jason Coene
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-09 00:00:00 -04: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: -1848230040
+        segments: 
+        - 2
+        - 0
+        - 0
+        - beta4
+        version: 2.0.0.beta4
+  type: :runtime
+  version_requirements: *id001
+description: Addon to Mongoid that allows you to easily generate and query against human readable (parameterized) id's!
+email: jcoene@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- README.rdoc
+- VERSION
+- lib/mongoid_param.rb
+- spec/models/post.rb
+- spec/models/user.rb
+- spec/mongoid_param_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/jcoene/mongoid_param
+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: Parameterize your models in one line
+test_files: 
+- spec/models/post.rb
+- spec/models/user.rb
+- spec/mongoid_param_spec.rb
+- spec/spec_helper.rb