dterror-resource_identifier 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Diogo Terror
+ 
+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/Manifest

@@ -0,0 +1,8 @@
+init.rb
+lib/resource_identifier.rb
+LICENSE
+Rakefile
+README.md
+spec/resource_id_spec.rb
+spec/spec_helper.rb
+Manifest

data/README.md

@@ -0,0 +1,25 @@
+#resource_identifier
+
+This plugin allows you to specify a different table identifier (AR's default is the :id field) so that it affects
+how find classmethod works and also the to_param instance method so that your model behaves like having a different identifier (a slug field, for instance).
+
+This is great if you want to have really beautiful urls :)
+
+take a look at some code:
+
+	class Article < ActiveRecord::Base
+		resource_identifier :slug
+	end
+	
+	# then...
+	@article = Article.find('hello-world')
+	
+	# and if you have routes like...
+	map.resouces :articles
+	
+	# then article_path(@article) will be...
+	'/articles/hello-world/'
+
+## Install
+
+	sudo gem install dterror-resource_identifier

data/Rakefile

@@ -0,0 +1,21 @@
+require 'rake'
+require "spec/rake/spectask"
+require 'echoe'
+
+desc 'Default: run the spec'
+task :default => :spec
+
+Echoe.new('resource_identifier', '0.1.0') do |p|
+  p.summary = "Have trully beautiful URLS in your Rails RESTful routes"
+  p.description = "An ActiveRecord plugin that allows you to specify a different table identifier (AR's default is the :id field)."
+  p.url = 'http://github.com/dterror/resource_identifier/'
+  p.author = 'Diogo Terror'
+  p.email = 'ranccis@gmail.com'
+  p.development_dependencies = []
+end
+
+desc "Run all specs"
+Spec::Rake::SpecTask.new('spec') do |t|
+  t.spec_files = FileList['spec/**/*.rb']
+  t.spec_opts = ["-c", "-fs"]
+end

data/init.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + '/lib/resource_identifier'

data/lib/resource_identifier.rb

@@ -0,0 +1,58 @@
+
+module ResourceIdentifier
+  
+  def self.included(base)
+    base.class_eval do
+      extend ClassMethods
+      include InstanceMethods
+      
+      alias_method_chain :to_param, :identifier
+      class << self
+        alias_method_chain :find, :identifier
+      end
+    end
+  end
+  
+  module ClassMethods
+    def resource_identifier(symbol, opts_hash={})
+      self.instance_eval do
+        @resource_id = symbol
+        @allow_default_id = (opts_hash[:allow_default_id] || false)
+      end
+    end
+    
+    def get_resource_id
+      self.instance_variable_get("@resource_id")
+    end
+    
+    def allow_default?
+      self.instance_variable_get("@allow_default_id")
+    end
+    
+    def find_with_identifier(*args)
+      case args.first
+      when String
+        res = find_without_identifier(:first, :conditions => { (self.get_resource_id || :id) => args.first })
+        raise ActiveRecord::RecordNotFound, "Couldn't find #{self.class} with Identifier=#{args.first}" if res.nil?
+        return res
+      when Fixnum
+        if  self.get_resource_id.nil? || (self.get_resource_id and self.allow_default?)
+          find_without_identifier(*args)
+        else
+          raise ActiveRecord::RecordNotFound, "The given identifier is not a valid format of resource identifier"
+        end
+      else
+        find_without_identifier(*args)
+      end
+    end
+  end
+  
+  module InstanceMethods
+    def to_param_with_identifier
+      send self.class.get_resource_id
+    end
+  end
+  
+end
+
+ActiveRecord::Base.send :include, ResourceIdentifier

data/resource_identifier.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{resource_identifier}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Diogo Terror"]
+  s.date = %q{2009-08-14}
+  s.description = %q{An ActiveRecord plugin that allows you to specify a different table identifier (AR's default is the :id field).}
+  s.email = %q{ranccis@gmail.com}
+  s.extra_rdoc_files = ["lib/resource_identifier.rb", "LICENSE", "README.md"]
+  s.files = ["init.rb", "lib/resource_identifier.rb", "LICENSE", "Rakefile", "README.md", "spec/resource_id_spec.rb", "spec/spec_helper.rb", "Manifest", "resource_identifier.gemspec"]
+  s.has_rdoc = true
+  s.homepage = %q{http://www.github.com/dterror/resource_identifier}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Resource_identifier", "--main", "README.md"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{resource_identifier}
+  s.rubygems_version = %q{1.3.2}
+  s.summary = %q{Have trully beautiful URLS in your Rails RESTful routes}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/spec/resource_id_spec.rb

@@ -0,0 +1,75 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe "A model Resource Ided" do
+  
+  before(:all) do
+    setup_db
+    class Person < ActiveRecord::Base;resource_identifier(:slug);end
+    class Comment < ActiveRecord::Base;end
+    class Article < ActiveRecord::Base;resource_identifier(:slug, :allow_default_id => true);end
+  end
+  
+  before(:each) do
+    Person.create(:name => "John Locke", :slug => "john-locke")
+    Comment.create(:name => "John Locke", :comment => "Come on...")
+    Article.create(:title => "My Article", :slug => 'my-article')
+  end
+  
+  it "should only start working when the resource_identifier method is called" do
+    Comment.get_resource_id.should be_nil
+    comm = Comment.find(1)
+    comm.name.should == 'John Locke'
+  end
+  
+  it "should populate resource_id field" do
+    Person.get_resource_id.should == :slug
+  end
+  
+  it "should find with the specified resource_identifier" do
+    john = Person.find('john-locke')
+    john.name.should == 'John Locke'
+  end
+  
+  it "should respond with ActiveRecord::RecordNotFound instea of a plain nil when not found" do
+    a = lambda { Person.find('jack-shephard') }
+    a.should raise_error(ActiveRecord::RecordNotFound)
+  end
+  
+  it "should not find with id by default" do
+    a = lambda { Person.find(1) }
+    a.should raise_error(ActiveRecord::RecordNotFound)
+  end
+  
+  it "should not find with id by default even when its stringified" do
+    a = lambda { Person.find('1') }
+    a.should raise_error(ActiveRecord::RecordNotFound)
+  end
+  
+  it "should return to_param with the identifier field" do
+    john = Person.find('john-locke')
+    john.to_param.should == 'john-locke'
+  end
+  
+  it "should work with option allow_default_id" do
+    art = Article.find('my-article')
+    same_art = Article.find(1)
+    art.title.should == "My Article"
+    same_art.title.should == 'My Article'
+  end
+    
+end
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib/'
+require 'rubygems'
+require 'spec'
+require 'active_record'
+require 'resource_identifier'
+
+ActiveRecord::Base.establish_connection(
+    :adapter => 'sqlite3',
+    :database => ':memory:'
+)
+
+def setup_db
+  ActiveRecord::Schema.define do
+    create_table :people, :force => true do |t|
+      t.string :name, :slug
+    end
+    create_table :comments, :force => true do |t|
+      t.string :name, :comment
+    end
+    create_table :articles, :force => true do |t|
+      t.string :title, :slug
+    end
+  end
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification 
+name: dterror-resource_identifier
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Diogo Terror
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-14 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: An ActiveRecord plugin that allows you to specify a different table identifier (AR's default is the :id field).
+email: ranccis@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- lib/resource_identifier.rb
+- LICENSE
+- README.md
+files: 
+- init.rb
+- lib/resource_identifier.rb
+- LICENSE
+- Rakefile
+- README.md
+- spec/resource_id_spec.rb
+- spec/spec_helper.rb
+- Manifest
+- resource_identifier.gemspec
+has_rdoc: true
+homepage: http://www.github.com/dterror/resource_identifier
+licenses: 
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Resource_identifier
+- --main
+- README.md
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: resource_identifier
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Have trully beautiful URLS in your Rails RESTful routes
+test_files: []
+