@@ -10,6 +10,8 @@ module Pancake # formats it supports. The second is hash of options. Typically this # hash is generated by the publish declaration in a controller. # + # TODO: Allow params to be grouped together + # # :api: private def initialize(default_formats, opts) # Extract the params — excluding configuration — and turn the keys into @@ -36,6 +38,7 @@ module Pancake # # :api: private def validate_and_coerce(incoming_params) + missing = [] params.each do |name, config| type, default, opts = config value = incoming_params[name] @@ -44,13 +47,13 @@ module Pancake incoming_params[name] = send("validate_and_coerce_#{type}", value, opts) else if default == :req - raise "Required parameter #{name} is missing" + missing << [name, type] elsif default != :opt incoming_params[name] = default end end end - incoming_params + [incoming_params, missing] end private @@ -70,6 +73,14 @@ module Pancake def validate_and_coerce_date(value, opts) Date.parse(value) end + + # Turns the incoming value into a string. The opts argument is + # only there to satisfy the interface. it is not used. + # + # :api: private + def validate_and_coerce_string(value, opts) + value.to_s + end # Extracts the format options from a hash. It is used to compile the # list of formats that an action can provide. It accepts an array of lib/pancake/more/controller/action_options.rb @@ -79,6 +79,13 @@ module Pancake as_declaration(:date, *args) end + # Coerces the specified parameter into a string. + # + # :api: public + def self.as_string(*args) + as_declaration(:string, *args) + end + # Takes a parameters hash, and validates each entry against the options # defined for this action. It will flag required params when missing, # insert defaults or coerce values into the desired type. It mutates lib/pancake/more/controller/publish.rb @@ -3,6 +3,7 @@ require File.dirname(__FILE__) + '/../../spec_helper' describe "Pancake::Controller publish declaration" do before(:all) do class Test < Pancake::Controller + provides :html publish def simple_publish; end @@ -21,6 +22,17 @@ describe "Pancake::Controller publish declaration" do publish :only_provides => :xml def only_provides_test; end + + publish :name => as_string(:opt) + def optional_test; end + + publish :provides => [:json, :txt], + :id => as_integer(:req), + :name => as_string("Campion"), + :melon => as_integer(50), + :jam => as_string(:opt), + :squeeze => as_string(:req) + def complex_test; end end end @@ -29,20 +41,28 @@ describe "Pancake::Controller publish declaration" do end it "should coerce a parameter into an integer" do - params = Test.validate_and_coerce_params('integer_test', 'id' => "30") + params, missing = Test.validate_and_coerce_params('integer_test', 'id' => "30") params['id'].should == 30 end it "should coerce a parameter into a date" do date = Date.parse("2009/07/05") - params = Test.validate_and_coerce_params('date_test', 'start' => "2009/07/05") + params, missing = Test.validate_and_coerce_params('date_test', 'start' => "2009/07/05") params['start'].should == date end - it "should allow parameters to be optional" + it "should flag required params that are missing" do + params, missing = Test.validate_and_coerce_params('integer_test', {}) + missing.include?(['id', :integer]).should == true + end + + it "should allow parameters to be optional" do + params, missing = Test.validate_and_coerce_params('optional_test', {}) + missing.empty?.should == true + end it "should return a default value for a parameter" do - params = Test.validate_and_coerce_params('default_test', {}) + params, missing = Test.validate_and_coerce_params('default_test', {}) params['page'].should == 12 end @@ -53,4 +73,16 @@ describe "Pancake::Controller publish declaration" do it "should replace the list of formats allowed for an action" do Test.actions['only_provides_test'].formats.should == [:xml] end + + it "should allow complex declarations" do + input = {'id' => "30", 'name' => "Purslane"} + params, missing = Test.validate_and_coerce_params('complex_test', input) + params['id'].should == 30 + params['name'].should == "Purslane" + params['melon'].should == 50 + params['jame'].should be_nil + missing.include?(['squeeze', :string]).should == true + + Test.actions['complex_test'].formats.should == [:html, :json, :txt] + end end spec/more/controller/publish_spec.rb 85bc664908755223a00e32d6011646af7cc5f21a Luke Sutton luke.sutton@gmail.com http://github.com/hassox/pancake/commit/2dcb0fc431f93b04d5e6c1653c2497e7357cfb86 2dcb0fc431f93b04d5e6c1653c2497e7357cfb86 2009-07-05T04:17:53-07:00 2009-07-05T04:17:53-07:00 When coercing controller params, append missing params to list rather than raising an error — it will be left to the controller to examing the list and raise whatever error it wants. Additionally add some more specs to test more complex publish declarations. 84d4ba2a06eb85c200b37eb305a23950b1a0e3d7 Luke Sutton luke.sutton@gmail.com