resources_id_replace 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+gemspec
+
+gem 'rails', '>= 3.0.0'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Toru KAWAMURA
+
+MIT License
+
+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.md

@@ -0,0 +1,63 @@
+# resources_id_replace
+
+Replace param name of resources' id.
+Useful for making user friendly URL.
+
+## Example
+
+You can use `:replace_id_with` option for `resources`.
+
+```ruby
+resources :users, :replace_id_with => 'name'
+```
+
+```
+    users GET    /users(.:format)            users#index
+          POST   /users(.:format)            users#create
+ new_user GET    /users/new(.:format)        users#new
+edit_user GET    /users/:name/edit(.:format) users#edit
+     user GET    /users/:name(.:format)      users#show
+          PUT    /users/:name(.:format)      users#update
+          DELETE /users/:name(.:format)      users#destroy
+```
+
+Good with the following codes.
+
+```ruby
+class User < ActiveRecord::Base
+  def to_param
+    name
+  end
+end
+```
+
+```ruby
+class UsersController < ApplicationController
+  def show
+    @user = User.find_by_name!(params[:name])
+  end
+end
+```
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'resources_id_replace'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install resources_id_replace
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,15 @@
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test
+

data/lib/resources_id_replace.rb

@@ -0,0 +1,17 @@
+require "resources_id_replace/version"
+require 'action_dispatch'
+
+ActionDispatch::Routing::Mapper::Resources::Resource.class_eval do
+  def id_replacer
+    (@options[:replace_id_with] || 'id').to_s
+  end
+
+  def member_scope
+    "#{path}/:#{id_replacer}"
+  end
+
+  def nested_scope
+    "#{path}/:#{singular}_#{id_replacer}"
+  end
+end
+ActionDispatch::Routing::Mapper::Resources::RESOURCE_OPTIONS << :replace_id_with

data/lib/resources_id_replace/version.rb

@@ -0,0 +1,3 @@
+module ResourcesIdReplace
+  VERSION = "0.0.1"
+end

data/resources_id_replace.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'resources_id_replace/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "resources_id_replace"
+  gem.version       = ResourcesIdReplace::VERSION
+  gem.authors       = ["Toru KAWAMURA"]
+  gem.email         = ["tkawa@4bit.net"]
+  gem.description   = %q{Replace param name of resources' id}
+  gem.summary       = %q{Replace param name of resources' id}
+  gem.homepage      = "https://github.com/tkawa/resources_id_replace"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'actionpack', '>= 3.0.0'
+  gem.add_development_dependency 'rake'
+end

data/test/resources_id_replace_test.rb

@@ -0,0 +1,52 @@
+# Configure Rails Environment
+ENV["RAILS_ENV"] = "test"
+
+require 'test/unit'
+
+require 'abstract_controller'
+require 'action_controller'
+require 'action_dispatch'
+
+require 'resources_id_replace'
+
+class UsersController < ActionController::Base
+  def show
+    head params[:name] ? :ok : :not_found
+  end
+end
+class CommentsController < ActionController::Base
+  def index
+    head params[:user_name] ? :ok : :not_found
+  end
+  def show
+    head params[:user_name] && params[:id] ? :ok : :not_found
+  end
+end
+
+class ResourcesIdReplaceTest < ActionDispatch::IntegrationTest
+  Routes = ActionDispatch::Routing::RouteSet.new.tap do |app|
+    app.draw do
+      resources :users, :replace_id_with => 'name' do
+        resources :comments
+      end
+    end
+  end
+
+  include Routes.url_helpers
+  def app; Routes end
+
+  test "accessing user by name instead of id" do
+    get "/users/tkawa"
+    assert_equal "200", @response.code
+  end
+
+  test "accessing subresource by name instead of id" do
+    get "/users/tkawa/comments"
+    assert_equal "200", @response.code
+  end
+
+  test "accessing member of subresource by id" do
+    get "/users/tkawa/comments/1"
+    assert_equal "200", @response.code
+  end
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: resources_id_replace
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Toru KAWAMURA
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Replace param name of resources' id
+email:
+- tkawa@4bit.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/resources_id_replace.rb
+- lib/resources_id_replace/version.rb
+- resources_id_replace.gemspec
+- test/resources_id_replace_test.rb
+homepage: https://github.com/tkawa/resources_id_replace
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2010132676723267050
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2010132676723267050
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Replace param name of resources' id
+test_files:
+- test/resources_id_replace_test.rb