tasteful_routes 0.1.2

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/README.rdoc

@@ -0,0 +1,74 @@
+= Tasteful Routes
+
+An opinionated variation of the standard Rails RESTful routes that has singular member action URLs.
+
+== Usage
+
+Simply define your routes with tasteful_resources as you normally would with the {resources method}[http://api.rubyonrails.org/classes/ActionDispatch/Routing/Mapper/Resources.html#method-i-resources]:
+
+  YourApp::Application.routes.draw do
+    tasteful_resources :jobs
+  end
+
+This results in the following routes:
+
+      jobs GET    /jobs(.:format)         {:controller=>"jobs", :action=>"index"}
+           POST   /jobs(.:format)         {:controller=>"jobs", :action=>"create"}
+   new_job GET    /job/new(.:format)      {:controller=>"jobs", :action=>"new"}
+  edit_job GET    /job/:id/edit(.:format) {:controller=>"jobs", :action=>"edit"}
+       job GET    /job/:id(.:format)      {:controller=>"jobs", :action=>"show"}
+           PUT    /job/:id(.:format)      {:controller=>"jobs", :action=>"update"}
+           DELETE /job/:id(.:format)      {:controller=>"jobs", :action=>"destroy"}
+
+It should work with all the same options as resources, including nesting:
+
+  YourApp::Application.routes.draw do
+    tasteful_resources :jobs do
+      tasteful_resources :items
+    end
+  end
+
+This time resulting in:
+
+      job_items GET    /job/:job_id/items(.:format)         {:controller=>"items", :action=>"index"}
+                POST   /job/:job_id/items(.:format)         {:controller=>"items", :action=>"create"}
+   new_job_item GET    /job/:job_id/item/new(.:format)      {:controller=>"items", :action=>"new"}
+  edit_job_item GET    /job/:job_id/item/:id/edit(.:format) {:controller=>"items", :action=>"edit"}
+       job_item GET    /job/:job_id/item/:id(.:format)      {:controller=>"items", :action=>"show"}
+                PUT    /job/:job_id/item/:id(.:format)      {:controller=>"items", :action=>"update"}
+                DELETE /job/:job_id/item/:id(.:format)      {:controller=>"items", :action=>"destroy"}
+           jobs GET    /jobs(.:format)                      {:controller=>"jobs", :action=>"index"}
+                POST   /jobs(.:format)                      {:controller=>"jobs", :action=>"create"}
+        new_job GET    /job/new(.:format)                   {:controller=>"jobs", :action=>"new"}
+       edit_job GET    /job/:id/edit(.:format)              {:controller=>"jobs", :action=>"edit"}
+            job GET    /job/:id(.:format)                   {:controller=>"jobs", :action=>"show"}
+                PUT    /job/:id(.:format)                   {:controller=>"jobs", :action=>"update"}
+                DELETE /job/:id(.:format)                   {:controller=>"jobs", :action=>"destroy"}
+
+
+== Maintainers
+
+* {Hugh Evans}[http://github.com/hughevans]
+
+== License
+
+Copyright 2011 Icelab http://icelab.com.au
+
+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/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+task :default => :spec
+
+desc "Run specs."
+RSpec::Core::RakeTask.new do |t|
+end

data/lib/tasteful_routes/mapper.rb

@@ -0,0 +1,51 @@
+module ActionDispatch::Routing
+  class Mapper
+    module TastefulResources
+      class TastefulResource < ActionDispatch::Routing::Mapper::Resource
+        def member_scope
+          "#{path.singularize}/:id"
+        end
+
+        def new_scope(new_path)
+          "#{path.singularize}/#{new_path}"
+        end
+
+        def nested_scope
+          "#{path.singularize}/:#{singular}_id"
+        end
+      end
+
+      def tasteful_resources(*resources, &block)
+        options = resources.extract_options!
+
+        if apply_common_behavior_for(:tasteful_resources, resources, options, &block)
+          return self
+        end
+
+        resource_scope(TastefulResource.new(resources.pop, options)) do
+          yield if block_given?
+
+          collection do
+            get  :index if parent_resource.actions.include?(:index)
+            post :create if parent_resource.actions.include?(:create)
+          end
+
+          new do
+            get :new
+          end if parent_resource.actions.include?(:new)
+
+          member do
+            get    :edit if parent_resource.actions.include?(:edit)
+            get    :show if parent_resource.actions.include?(:show)
+            put    :update if parent_resource.actions.include?(:update)
+            delete :destroy if parent_resource.actions.include?(:destroy)
+          end
+        end
+
+        self
+      end
+
+    end
+    include TastefulResources
+  end
+end

data/lib/tasteful_routes/version.rb

@@ -0,0 +1,3 @@
+module TastefulRoutes
+  VERSION = "0.1.2"
+end

data/lib/tasteful_routes.rb

@@ -0,0 +1,3 @@
+require "rails"
+require "tasteful_routes/version"
+require "tasteful_routes/mapper"

data/spec/routing_spec.rb

@@ -0,0 +1,85 @@
+require 'spec_helper'
+
+describe :tasteful_routes do
+  before(:all) do
+    @set = ActionDispatch::Routing::RouteSet.new
+    @set.draw do
+      resources :clients
+
+      resources :posts do
+        resources :comments
+      end
+
+      tasteful_resources :projects
+
+      tasteful_resources :jobs do
+        tasteful_resources :items
+      end
+    end
+
+    class RouteTesting; end
+    RouteTesting.send :include, @set.url_helpers
+
+    @routes = RouteTesting.new
+  end
+
+  context "Not breaking existing behavior" do
+    context "of resources" do
+      specify "collection paths" do
+        @routes.send(:clients_path).should == "/clients"
+      end
+
+      specify "member paths" do
+        @routes.send(:client_path, 1).should == "/clients/1"
+      end
+    end
+
+    context "of nested resources" do
+      specify "collection paths" do
+        @routes.send(:post_comments_path, 1).should == "/posts/1/comments"
+      end
+
+      specify "member paths" do
+        @routes.send(:post_comment_path, 1, 12).should == "/posts/1/comments/12"
+      end
+    end
+  end
+
+  context "#tasteful_resources" do
+    context "for non-nested resources" do
+      it "should pluralize the collection paths" do
+        @routes.send(:projects_path).should == "/projects"
+      end
+
+      it "should singularize the member paths" do
+        @routes.send(:new_project_path).should == "/project/new"
+        @routes.send(:project_path, 1).should == "/project/1"
+        @routes.send(:edit_project_path, 1).should == "/project/1/edit"
+      end
+    end
+
+    context "for the parent of nested resources" do
+      it "should pluralize the collection paths" do
+        @routes.send(:jobs_path).should == "/jobs"
+      end
+
+      it "should singularize the member paths" do
+        @routes.send(:new_job_path).should == "/job/new"
+        @routes.send(:job_path, 1).should == "/job/1"
+        @routes.send(:edit_job_path, 1).should == "/job/1/edit"
+      end
+    end
+
+    context "for the child of nested resources" do
+      it "should pluralize the collection paths" do
+        @routes.send(:job_items_path, 1).should == "/job/1/items"
+      end
+
+      it "should singularize the member paths" do
+        @routes.send(:new_job_item_path, 1).should == "/job/1/item/new"
+        @routes.send(:job_item_path, 1, 12).should == "/job/1/item/12"
+        @routes.send(:edit_job_item_path, 1, 12).should == "/job/1/item/12/edit"
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'rspec'
+
+require 'rails'
+require 'action_controller'
+require 'action_dispatch'
+require 'rack/mount'
+require 'active_support/core_ext/hash/slice.rb'
+
+require 'tasteful_routes'

data/tastful_routes.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "tasteful_routes/version"
+
+Gem::Specification.new do |s|
+  s.name              = "tasteful_routes"
+  s.version           = TastefulRoutes::VERSION
+  s.authors           = ["Icelab", "Hugh Evans"]
+  s.email             = "hugh@artpop.com.au"
+  s.homepage          = "http://github.com/icelab/tasteful_routes"
+  s.summary           = %q{An opinionated variation of the standard Rails
+                        RESTful routes that has singular member action URLs.}
+  s.description       = %q{An opinionated variation of the standard Rails
+                        RESTful routes that has singular member action URLs. For
+                        example, /job/1 instead of /jobs/1. The collection
+                        methods continue to operate on the plural /jobs (index
+                        and create).}
+
+  s.rubyforge_project = "tasteful_routes"
+
+  s.files             = `git ls-files`.split("\n")
+  s.require_path      = "lib"
+
+  s.add_dependency "rails", "~> 3.0.0"
+
+  s.add_development_dependency "rspec", "~> 2.6.0"
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification 
+name: tasteful_routes
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.2
+platform: ruby
+authors: 
+- Icelab
+- Hugh Evans
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-05 00:00:00 +10:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 3.0.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.6.0
+  type: :development
+  version_requirements: *id002
+description: |-
+  An opinionated variation of the standard Rails
+                          RESTful routes that has singular member action URLs. For
+                          example, /job/1 instead of /jobs/1. The collection
+                          methods continue to operate on the plural /jobs (index
+                          and create).
+email: hugh@artpop.com.au
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Gemfile
+- README.rdoc
+- Rakefile
+- lib/tasteful_routes.rb
+- lib/tasteful_routes/mapper.rb
+- lib/tasteful_routes/version.rb
+- spec/routing_spec.rb
+- spec/spec_helper.rb
+- tastful_routes.gemspec
+has_rdoc: true
+homepage: http://github.com/icelab/tasteful_routes
+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"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: tasteful_routes
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: An opinionated variation of the standard Rails RESTful routes that has singular member action URLs.
+test_files: []
+