routing_concerns 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 David Heinemeier Hansson
+
+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,103 @@
+Routing Concerns
+================
+
+Abstract common routing resource concerns to cut down on duplication.
+
+Code before:
+
+```ruby
+BCX::Application.routes.draw do
+  resources :calendar_events do
+    get :past, on: :collection
+    resources :comments
+  end
+
+  resources :messages  { resources :comments }
+  resources :forwards  { resources :comments }
+  resources :uploads   { resources :comments }
+  resources :documents { resources :comments }
+  resources :todos     { resources :comments }
+  
+  resources :projects, defaults: { bucket_type: 'project' } do
+    post :trash, :restore, on: :member
+  
+    resources :messages, except: [ :new ] do
+      post :trash, :restore, on: :member
+      resources :image_attachments, only: :index
+    end
+  
+    resources :forwards do
+      member do
+        get  :content
+        post :trash, :restore
+      end
+  
+      resources :image_attachments, only: :index
+    end
+  
+    resources :uploads do
+      post :trash, :restore, on: :member
+      resources :image_attachments, only: :index
+    end
+  
+    resources :todolists do
+      get :more, :completed, on: :collection
+      post :trash, :restore, on: :member
+    end
+  
+    resources :todos do
+      post :toggle, :trash, :restore, on: :member
+    end
+  
+    resources :comments do
+      post :trash, on: :member
+      resources :image_attachments, only: :index
+    end
+  end
+end
+```
+
+Code after:
+
+```ruby
+BCX::Application.routes.draw do
+  concern :commentable do
+    resources :comments
+  end
+  
+  concern :trashable do
+    post :trash, :restore, on: :member
+  end
+
+  concern :image_attachable do
+    resources :image_attachments, only: :index
+  end
+
+  resources :calendar_events, concerns: :commentable do
+    get :past, on: :collection
+  end
+
+  resources :messages, :forwards, :uploads, :documents, :todos, concerns: :commentable
+
+  resources :projects, concerns: :trashable, defaults: { bucket_type: 'project' } do
+    resources :messages, :uploads, :comments, concerns: [:trashable, :image_attachable]
+  
+    resources :forwards, concerns: [:trashable, :image_attachable] do
+      get :content, on: :member
+    end
+  
+    resources :todolists, concerns: :trashable do
+      get :more, :completed, on: :collection
+    end
+  
+    resources :todos, concerns: :trashable do
+      post :toggle, on: :member
+    end
+  end
+end
+```
+
+Compatibility
+-------------
+
+This plugin was designed as a proof-of-concept for a feature that's destined for Rails 4. It has only been tested on Rails 3.2+, but may work on earlier versions as well.

data/Rakefile

@@ -0,0 +1,38 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'RoutingConcerns'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_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/action_dispatch/routing/concerns.rb

@@ -0,0 +1,56 @@
+require 'action_dispatch'
+
+module ActionDispatch::Routing::Mapper::Concerns
+  def concern(name, &block)
+    @concerns ||= {}
+    @concerns[name] = block
+  end
+  
+  def concerns(*names)
+    Array(names).flatten.compact.each do |name|
+      if @concerns && concern = @concerns[name]
+        instance_eval(&concern)
+      else
+        raise "No concern named #{name} was found!"
+      end
+    end
+  end
+end
+
+module ActionDispatch::Routing::Mapper::ResourcesWithConcerns
+  extend ActiveSupport::Concern
+  
+  included do
+    alias_method_chain :resource,  :concerns
+    alias_method_chain :resources, :concerns
+  end
+  
+  def resource_with_concerns(*resources, &block)
+    if (options_with_concerns = resources.last).is_a?(Hash)
+      named_concerns = options_with_concerns[:concerns]
+
+      resource_without_concerns(*resources) do
+        concerns(named_concerns)
+        block.call if block_given?
+      end
+    else
+      resource_without_concerns(*resources, &block)
+    end
+  end
+
+  def resources_with_concerns(*resources, &block)
+    if (options_with_concerns = resources.last).is_a?(Hash)
+      named_concerns = options_with_concerns[:concerns]
+
+      resources_without_concerns(*resources) do
+        concerns(named_concerns)
+        block.call if block_given?
+      end
+    else
+      resources_without_concerns(*resources, &block)
+    end
+  end
+end
+
+ActionDispatch::Routing::Mapper.send :include, ActionDispatch::Routing::Mapper::Concerns
+ActionDispatch::Routing::Mapper.send :include, ActionDispatch::Routing::Mapper::ResourcesWithConcerns

data/lib/active_model/forbidden_attributes_protection.rb

@@ -0,0 +1,16 @@
+module ActiveModel
+  class ForbiddenAttributes < StandardError
+  end
+
+  module ForbiddenAttributesProtection
+    def sanitize_for_mass_assignment(new_attributes, options = {})
+      if !new_attributes.respond_to?(:permitted?) || (new_attributes.respond_to?(:permitted?) && new_attributes.permitted?)
+        super
+      else
+        raise ActiveModel::ForbiddenAttributes
+      end
+    end
+  end
+end
+
+ActiveModel.autoload :ForbiddenAttributesProtection

data/lib/routing_concerns.rb

@@ -0,0 +1,2 @@
+require 'action_dispatch/routing/concerns'
+require 'routing_concerns/railtie'

data/lib/routing_concerns/railtie.rb

@@ -0,0 +1 @@
+require 'rails/railtie'

data/lib/routing_concerns/version.rb

@@ -0,0 +1,3 @@
+module RoutingConcerns
+  VERSION = "0.1.0"
+end

data/test/routing_concerns_test.rb

@@ -0,0 +1,43 @@
+# Configure Rails Environment
+ENV["RAILS_ENV"] = "test"
+
+require 'test/unit'
+
+require 'abstract_controller'
+require 'action_controller'
+require 'action_dispatch'
+
+require 'routing_concerns'
+
+class CommentsController < ActionController::Base
+  def index
+    head :ok
+  end
+end
+
+class RoutingConcernsTest < ActionDispatch::IntegrationTest
+  Routes = ActionDispatch::Routing::RouteSet.new.tap do |app|
+    app.draw do
+      concern :commentable do
+        resources :comments
+      end
+      
+      resources :posts, concerns: :commentable
+      resource  :post,  concerns: :commentable
+      resources :comments
+    end
+  end
+
+  include Routes.url_helpers
+  def app; Routes end
+
+  test "accessing concern from resources" do
+    get "/posts/1/comments"
+    assert_equal "200", @response.code
+  end
+
+  test "accessing concern from resource" do
+    get "/post/comments"
+    assert_equal "200", @response.code
+  end
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: routing_concerns
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- David Heinemeier Hansson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: &2152297360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *2152297360
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: &2152296340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *2152296340
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: &2152295060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *2152295060
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2152294660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2152294660
+description: 
+email:
+- david@heinemeierhansson.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/action_dispatch/routing/concerns.rb
+- lib/active_model/forbidden_attributes_protection.rb
+- lib/routing_concerns/railtie.rb
+- lib/routing_concerns/version.rb
+- lib/routing_concerns.rb
+- MIT-LICENSE
+- Rakefile
+- README.md
+- test/routing_concerns_test.rb
+homepage: 
+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: 
+rubygems_version: 1.8.7
+signing_key: 
+specification_version: 3
+summary: Routing concerns for Action Pack
+test_files:
+- test/routing_concerns_test.rb