commit_param_routing 0.0.1

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in commit_param_routing.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Senthil V S
+
+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,73 @@
+# CommitParamRouting
+
+Many times we might end up using html forms with multiple submit buttons with different behaviours. In those cases, it would be ideal to route
+to different controller actions. 
+This gem uses rails [advanced constraints](http://guides.rubyonrails.org/routing.html#advanced-constraints) to get this done.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'commit_param_routing'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install commit_param_routing
+
+## Usage
+
+Consider you have a resource and you wanna route to three different actions from the same form with three different submit buttons. Then the route would be
+
+```ruby
+resources :plan do
+  post :save, constraints: CommitParamRouting.new(PlansController::SAVE, ProjectsController::REVISE), action: :save
+  post :save, constraints: CommitParamRouting.new(PlansController::PROPOSE), action: :propose
+  post :save, constraints: CommitParamRouting.new(PlansController::FINALIZE), action: :finalize
+end 
+```
+
+And the `plans_controller.rb` would be,
+
+```ruby
+class PlansController < ApplicationController
+  SAVE = "Save"
+  REVISE = "Revise the plan"
+  PROPOSE = "Propose now"
+  FINALIZE = "Finalize"
+
+  def save
+    #some code here
+  end
+
+  def propose
+    #some code here
+  end
+
+  def finalize
+    #some code here
+  end
+end
+```
+
+```haml
+  = form_for @plan, url: plan_save_path(@plan), method: :post do |f|
+    =# some form elements here
+    - if @plan.can_be_revised?
+      = f.submit PlansController::REVISE
+    - if @plan.can_be_finalized?
+      = f.submit PlansController::FINALIZE
+    = # other submit buttons
+```
+
+## 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,12 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+ 
+require 'rake/testtask'
+ 
+Rake::TestTask.new do |t|
+  t.libs << 'lib/commit_param_routing'
+  t.test_files = FileList['test/lib/*_test.rb']
+  t.verbose = true
+end
+ 
+task :default => :test

data/commit_param_routing.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'commit_param_routing'
+
+Gem::Specification.new do |spec|
+  spec.name          = "commit_param_routing"
+  spec.version       = CommitParamRouting::VERSION
+  spec.authors       = ["Senthil V S"]
+  spec.email         = ["vss123@gmail.com"]
+  spec.description   = %q{Gem that helps rails project to route to different controller actions based on commit param of the form}
+  spec.summary       = %q{Gem that helps rails project to route to different controller actions based on commit param of the form}
+  spec.homepage      = "https://github.com/siliconsenthil/commit_param_routing"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'activesupport', '>= 3.2'
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/commit_param_routing.rb

@@ -0,0 +1,11 @@
+class CommitParamRouting
+  VERSION = "0.0.1"
+
+  def initialize(*param_values)
+    @param_values = param_values
+  end
+
+  def matches?(request)
+    @param_values.any?{|prm| request.params[:commit] == prm.to_s}
+  end
+end

data/test/lib/commit_param_routing_test.rb

@@ -0,0 +1,26 @@
+require "ostruct"
+require_relative '../test_helper'
+
+describe CommitParamRouting do
+  it "must be defined" do
+    CommitParamRouting::VERSION.wont_be_nil
+  end
+
+  describe "matches?" do
+    it "should return true when param matches" do
+      CommitParamRouting.new(:save).matches?(stub_request("save")).must_equal true
+      CommitParamRouting.new(:save).matches?(stub_request("something_else")).must_equal false
+      CommitParamRouting.new("save").matches?(stub_request("SaVe")).must_equal false
+    end
+
+    it "should return true when one of the param matches" do
+      CommitParamRouting.new(:save, :revise).matches?(stub_request("revise")).must_equal true
+      CommitParamRouting.new(:save, :revise).matches?(stub_request("no_revise")).must_equal false
+    end
+  end
+
+  private
+  def stub_request(commit_param)
+    OpenStruct.new(params: {commit: commit_param}.with_indifferent_access)
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+require 'minitest/autorun'
+require 'minitest/pride'
+require 'active_support/core_ext'
+require File.expand_path('../../lib/commit_param_routing.rb', __FILE__)

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: commit_param_routing
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Senthil V S
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: Gem that helps rails project to route to different controller actions
+  based on commit param of the form
+email:
+- vss123@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- commit_param_routing.gemspec
+- lib/commit_param_routing.rb
+- test/lib/commit_param_routing_test.rb
+- test/test_helper.rb
+homepage: https://github.com/siliconsenthil/commit_param_routing
+licenses:
+- MIT
+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: 1611573789543045986
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1611573789543045986
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Gem that helps rails project to route to different controller actions based
+  on commit param of the form
+test_files:
+- test/lib/commit_param_routing_test.rb
+- test/test_helper.rb