rails-action-args 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/Gemfile

@@ -0,0 +1,10 @@
+source :gemcutter
+
+gem "rspec"
+gem "rack"
+gem "actionpack", "3.0.0.beta2", :require => "action_controller"
+gem "railties", "3.0.0.beta2", :require => "rails"
+gem "ParseTree"
+gem "ruby2ruby"
+gem "rake"
+gem "rack-test", :require => "rack/test"

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Andy Delcambre
+
+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.markdown

@@ -0,0 +1,64 @@
+# rails-action-args
+
+Rails Action Args allows you to accept the parameters to you action as
+arguments to the action method.
+
+The best way to demonstrate this is with a quick example.
+
+First you need to include ActionArgs in your ApplicationController
+
+    class ApplicationController < ActionController::Base
+      include ActionArgs
+    end
+
+Then you simply accept arguments to your methods.
+
+    class PostsController < ApplicationController
+      respond_to :json
+
+      def show(id)
+        @post = Post.find(id)
+        respond_with @post
+      end
+    end
+
+    class MyApp < Rails::Application
+      root :to => "posts#show"
+    end
+
+Now if this is called with {:id => 1} in the params, the id will be set to 1.
+
+    > curl http://localhost:3000?id=1
+    {"id": 1, "title":"Lorem ipsum dolor"}
+
+If you call the action without the correct parameter, you get a 400 Bad Request
+
+    > curl http://localhost:3000
+    HTTP/1.1 400 Bad Request
+
+
+You can also supply default arguments as normal.
+
+    class PostsController < ApplicationController
+      respond_to :json
+
+      def show(id=4)
+        @post = Post.find(id)
+        respond_with @post
+      end
+    end
+
+    > curl http://localhost:3000?id=1
+    {"id": 4, "title":"Consectur sit amet"}
+
+## Authors
+
+This plugin is very heavily influenced by the merb-action-args plugin.
+All authors of that plugin helped make this one happen.
+
+Special thanks to Yehuda Katz for writing much of the original merb plugin
+and helping convert this to Rails 3.
+
+## Copyright
+
+Copyright (c) 2010 Andy Delcambre. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+require 'yaml'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "rails-action-args"
+    gem.summary = %Q{A port of merb-action-args to Rails 3}
+    gem.description = "Rails Action Args allows you to accept the parameters to you action as arguments to the action method."
+    gem.email = "adelcambre@engineyard.com"
+    gem.homepage = "http://github.com/adelcambre/rails-action-args"
+    gem.authors = ["Andy Delcambre"]
+
+    gem.add_dependency "actionpack"
+    gem.add_dependency "activesupport"
+
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rails-action-args #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION.yml

@@ -0,0 +1,4 @@
+---
+:major: 0
+:minor: 1
+:patch: 0

data/lib/rails_action_args.rb

@@ -0,0 +1,2 @@
+require 'rails_action_args/get_args'
+require 'rails_action_args/abstract_controller'

data/lib/rails_action_args/abstract_controller.rb

@@ -0,0 +1,47 @@
+require 'abstract_controller'
+require 'active_support/concern'
+
+# Hook up the BadRequest exception to return 400 Bad Request
+class AbstractController::BadRequest < StandardError; end
+ActionDispatch::ShowExceptions.rescue_responses["AbstractController::BadRequest"] = :bad_request
+
+module ActionArgs
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+    def action_arguments(action)
+      @action_arguments ||= {}
+      return @action_arguments[action] if @action_arguments[action]
+
+      arguments = instance_method(action).get_args.first || []
+
+      defaults = arguments.map do |arg|
+        if arg.size == 2
+          arg.first
+        end
+      end.compact
+      @action_arguments[action] = [arguments, defaults]
+    end
+  end
+
+  # Calls an action and maps the params hash to the action parameters.
+  #
+  # ==== Parameters
+  # action<Symbol>:: The action to call
+  #
+  # ==== Raises
+  # BadRequest:: The params hash doesn't have a required parameter.
+  def send_action(action)
+    arguments, defaults = self.class.action_arguments(action.to_s)
+
+    args = arguments.map do |arg, default|
+      p = params.key?(arg.to_sym)
+      unless p || (defaults && defaults.include?(arg))
+        missing = arguments.reject {|arg| params.key?(arg[0].to_sym || arg[1])}
+        raise AbstractController::BadRequest, "Your parameters (#{params.inspect}) were missing #{missing.join(", ")}"
+      end
+      p ? params[arg.to_sym] : default
+    end
+    super(action, *args)
+  end
+end

data/lib/rails_action_args/get_args.rb

@@ -0,0 +1,15 @@
+if RUBY_PLATFORM == "java"
+  require File.join(File.dirname(__FILE__), "jruby_args")
+elsif RUBY_VERSION < "1.9"
+  require File.join(File.dirname(__FILE__), "mri_args")
+else
+  require File.join(File.dirname(__FILE__), "vm_args")
+end
+
+class UnboundMethod
+  include GetArgs
+end
+
+class Method
+  include GetArgs
+end

data/lib/rails_action_args/jruby_args.rb

@@ -0,0 +1,67 @@
+require 'java'
+require 'jruby'
+
+module GetArgs
+  Methods = org.jruby.internal.runtime.methods
+
+  def get_args
+    real_method = JRuby.reference(self)
+
+    # hack to expose a protected field; could be improved in 1.1.5
+    method_field = org.jruby.RubyMethod.java_class.declared_field(:method)
+
+    method_field.accessible = true
+  
+    dyn_method = method_field.value(real_method)
+
+    case dyn_method
+    when Methods.MethodArgs
+      return build_args(dyn_method.args_node)
+    else
+      raise "Can't get args from method: #{self}"
+    end
+  end
+
+  def build_args(args_node)
+    args = []
+    required = []
+    optional = []
+
+    # required args
+    if (args_node.args && args_node.args.size > 0)
+      required << args_node.args.child_nodes.map { |arg| [arg.name.to_s.intern] }
+    end
+  
+    # optional args
+    if (args_node.opt_args && args_node.opt_args.size > 0)
+      optional << args_node.opt_args.child_nodes.map do |arg|
+        name = arg.name.to_s.intern
+        value_node = arg.value_node
+        case value_node
+        when org.jruby.ast::FixnumNode
+          value = value_node.value
+        when org.jruby.ast::SymbolNode
+          value = value_node.get_symbol(JRuby.runtime)
+        when org.jruby.ast::StrNode
+          value = value_node.value
+        else
+          value = nil
+        end
+        [name, value]
+      end
+    end
+
+    first_args = required.first
+    optional.first.each {|arg| first_args << arg} if optional.first
+        
+    args = [first_args]
+    
+    rest = args_node.rest_arg_node
+    args << (rest ? rest.name.to_s.intern : nil)
+  
+    block = args_node.block_arg_node
+    args << (block ? block.name.to_s.intern : nil)
+
+    args
+  end
+end

data/lib/rails_action_args/mri_args.rb

@@ -0,0 +1,102 @@
+require 'parse_tree'
+require 'ruby2ruby'
+
+class Object
+  def full_const_get(name)
+    list = name.split("::")
+    list.shift if list.first.blank?
+    obj = self
+    list.each do |x|
+      # This is required because const_get tries to look for constants in the
+      # ancestor chain, but we only want constants that are HERE
+      obj = obj.const_defined?(x) ? obj.const_get(x) : obj.const_missing(x)
+    end
+    obj
+  end
+end
+
+class ParseTreeArray < Array
+  R2R = Object.const_defined?(:Ruby2Ruby) ? Ruby2Ruby : RubyToRuby
+  
+  def self.translate(*args)
+    sexp = ParseTree.translate(*args)
+    # ParseTree.translate returns [nil] if called on an inherited method, so walk
+    # up the inheritance chain to find the class that the method was defined in
+    unless sexp.first
+      klass = args.first.ancestors.detect do |klass| 
+        klass.public_instance_methods(false).include?(args.last.to_s)
+      end
+      sexp = ParseTree.translate(klass, args.last) if klass
+    end
+    sexp = Unifier.new.process(sexp)
+    self.new(sexp)
+  end
+  
+  def deep_array_node(type = nil)
+    each do |node|
+      return ParseTreeArray.new(node) if node.is_a?(Array) && (!type || node[0] == type)
+      next unless node.is_a?(Array)
+      return ParseTreeArray.new(node).deep_array_node(type)
+    end
+    nil
+  end
+
+  def arg_nodes
+    self[1..-1].inject([]) do |sum,item|
+      sum << [item] unless item.is_a?(Array)
+      sum
+    end
+  end
+  
+  def get_args
+    if arg_node = deep_array_node(:args)
+      # method defined with def keyword
+      args = arg_node.arg_nodes
+      default_node = arg_node.deep_array_node(:block)
+      return [args, []] unless default_node
+    else
+      # assuming method defined with Module#define_method
+      return [[],[]]
+    end
+    
+    # if it was defined with def, and we found the default_node,
+    # that should bring us back to regularly scheduled programming..
+    lasgns = default_node[1..-1]
+    lasgns.each do |asgn|
+      args.assoc(asgn[1]) << eval(R2R.new.process(asgn[2]))
+    end
+    [args, (default_node[1..-1].map { |asgn| asgn[1] })]
+  end
+
+end
+
+# Used in mapping controller arguments to the params hash.
+# NOTE: You must have the 'ruby2ruby' gem installed for this to work.
+#
+# ==== Examples
+#   # In PostsController
+#   def show(id)  #=> id is the same as params[:id]
+module GetArgs
+  
+  # ==== Returns
+  # Array:: Method arguments and their default values.
+  #
+  # ==== Examples
+  #   class Example
+  #     def hello(one,two="two",three)
+  #     end
+  #
+  #     def goodbye
+  #     end
+  #   end
+  #
+  #   Example.instance_method(:hello).get_args
+  #     #=> [[:one], [:two, "two"], [:three, "three"]]
+  #   Example.instance_method(:goodbye).get_args  #=> nil
+  def get_args
+    klass, meth = self.to_s.split(/ /).to_a[1][0..-2].split("#")
+    # Remove stupidity for #<Method: Class(Object)#foo>
+    klass = $` if klass =~ /\(/
+    ParseTreeArray.translate(Object.full_const_get(klass), meth).get_args
+  end
+end

data/lib/rails_action_args/vm_args.rb

@@ -0,0 +1,27 @@
+begin
+  require "methopara"
+rescue
+  puts "make sure you have methora http://github.com/genki/methopara installed if you want to use action args on Ruby 1.9"
+end
+
+module GetArgs
+  def get_args
+    unless respond_to?(:parameters)
+      raise NotImplementedError, "Ruby #{RUBY_VERSION} doesn't support #{self.class}#parameters"
+    end
+
+    required = []
+    optional = []
+
+    parameters.each do |(type, name)|
+      if type == :opt
+        required << [name, nil]
+        optional << name
+      else
+        required << [name]
+      end
+    end
+
+    return [required, optional]
+  end
+end

data/rails-action-args.gemspec

@@ -0,0 +1,65 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{rails-action-args}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Andy Delcambre"]
+  s.date = %q{2010-04-03}
+  s.description = %q{Rails Action Args allows you to accept the parameters to you action as arguments to the action method.}
+  s.email = %q{adelcambre@engineyard.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.markdown"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "Gemfile",
+     "LICENSE",
+     "README.markdown",
+     "Rakefile",
+     "VERSION.yml",
+     "lib/rails_action_args.rb",
+     "lib/rails_action_args/abstract_controller.rb",
+     "lib/rails_action_args/get_args.rb",
+     "lib/rails_action_args/jruby_args.rb",
+     "lib/rails_action_args/mri_args.rb",
+     "lib/rails_action_args/vm_args.rb",
+     "rails-action-args.gemspec",
+     "spec/controllers/action_args_controller.rb",
+     "spec/rails_action_args_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/adelcambre/rails-action-args}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{A port of merb-action-args to Rails 3}
+  s.test_files = [
+    "spec/controllers/action_args_controller.rb",
+     "spec/rails_action_args_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  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
+      s.add_runtime_dependency(%q<actionpack>, [">= 0"])
+      s.add_runtime_dependency(%q<activesupport>, [">= 0"])
+    else
+      s.add_dependency(%q<actionpack>, [">= 0"])
+      s.add_dependency(%q<activesupport>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<actionpack>, [">= 0"])
+    s.add_dependency(%q<activesupport>, [">= 0"])
+  end
+end
+

data/spec/controllers/action_args_controller.rb

@@ -0,0 +1,66 @@
+class ApplicationController < ActionController::Base
+  include ActionArgs
+end
+
+module ExtraActions
+  def funky_inherited_method(foo, bar)
+    render :text => "#{foo} #{bar}"
+  end
+end
+
+module Awesome
+  class ActionArgsController < ApplicationController
+    def index(foo)
+      render :text => foo.to_s
+    end
+  end
+end
+
+class ActionArgsController < ApplicationController
+  include ExtraActions
+
+  def nada
+    render :text => "NADA"
+  end
+
+  def index(foo)
+    render :text => foo
+  end
+
+  def multi(foo, bar)
+    render :text => "#{foo} #{bar}"
+  end
+
+  def defaults(foo, bar = "bar")
+    render :text => "#{foo} #{bar}"
+  end
+
+  def defaults_mixed(foo, bar ="bar", baz = "baz")
+    render :text => "#{foo} #{bar} #{baz}"
+  end
+
+  define_method :dynamic_define_method do
+    render :text => "mos def"
+  end
+
+  def with_default_nil(foo, bar = nil)
+    render :text => "#{foo} #{bar}"
+  end
+
+  def with_default_array(foo, bar = [])
+    render :text => "#{foo} #{bar.inspect}"
+  end
+
+end
+
+class MyApp < Rails::Application
+   config.session_store :disabled
+
+   routes.draw do
+     match "/awesome/index" => "Awesome::ActionArgs#index"
+
+     controller :action_args do
+       match "/action_args/:action"
+     end
+  end
+end

data/spec/rails_action_args_spec.rb

@@ -0,0 +1,63 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "spec_helper"))
+
+describe "RailsActionArgs" do
+  def app
+    MyApp
+  end
+
+  it "should be able to handle a nested class" do
+    request("/awesome/index?foo=bar").body.should == "bar"
+  end
+
+  it "should be able to handle no arguments" do
+    request("/action_args/nada").body.should == "NADA"
+  end
+
+  it "should be able to accept Action Arguments" do
+    request("/action_args/index?foo=bar").body.should == "bar"
+  end
+
+  it "should be able to accept multiple Action Arguments" do
+    request("/action_args/multi?foo=bar&bar=baz").body.should == "bar baz"
+  end
+
+  it "should be able to handle defaults in Action Arguments" do
+    request("/action_args/defaults?foo=bar").body.should == "bar bar"
+  end
+
+  it "should be able to handle out of order defaults" do
+    request("/action_args/defaults_mixed?foo=bar&baz=bar").body.should == "bar bar bar"
+  end
+
+  it "should throw a 400 Bad Request if the arguments are not provided" do
+    request("/action_args/index").status.should == 400
+  end
+
+  it "should treat define_method actions as equal" do
+    request("/action_args/dynamic_define_method").body.should == "mos def"
+  end
+
+  it "should be able to inherit actions for use with Action Arguments" do
+    request("/action_args/funky_inherited_method?foo=bar&bar=baz").body.should == "bar baz"
+  end
+
+  it "should be able to handle nil defaults" do
+    request("/action_args/with_default_nil?foo=bar").body.should == "bar "
+  end
+
+  it "should be able to handle [] defaults" do
+    request("/action_args/with_default_array?foo=bar").body.should == "bar []"
+  end
+
+  it "should print out the missing parameters if all are required" do
+    response = request("/action_args/multi")
+    response.status.should == 400
+    response.body.should include("were missing foo, bar")
+  end
+
+  it "should only print out missing parameters" do
+    response = request("/action_args/multi?foo=Hello")
+    response.status.should == 400
+    response.body.should include("were missing bar")
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'bundler'
+Bundler.setup
+Bundler.require
+
+require 'rails_action_args'
+require File.expand_path(File.join(File.dirname(__FILE__), "controllers", "action_args_controller"))
+
+Spec::Runner.configure do |config|
+  config.include(Rack::Test::Methods)
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification 
+name: rails-action-args
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Andy Delcambre
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-03 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: actionpack
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+description: Rails Action Args allows you to accept the parameters to you action as arguments to the action method.
+email: adelcambre@engineyard.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- .document
+- .gitignore
+- Gemfile
+- LICENSE
+- README.markdown
+- Rakefile
+- VERSION.yml
+- lib/rails_action_args.rb
+- lib/rails_action_args/abstract_controller.rb
+- lib/rails_action_args/get_args.rb
+- lib/rails_action_args/jruby_args.rb
+- lib/rails_action_args/mri_args.rb
+- lib/rails_action_args/vm_args.rb
+- rails-action-args.gemspec
+- spec/controllers/action_args_controller.rb
+- spec/rails_action_args_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/adelcambre/rails-action-args
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A port of merb-action-args to Rails 3
+test_files: 
+- spec/controllers/action_args_controller.rb
+- spec/rails_action_args_spec.rb
+- spec/spec_helper.rb