Merge pull request #280 from tstrachota/concerns

Name substitution for referenced param_groups defined in concerns

lib/apipie/dsl_definition.rb

@@ -264,7 +264,13 @@ def param_group(name, scope_or_options = nil, options = {})
           scope = scope_or_options
         end
         scope ||= _default_param_group_scope
-        @_current_param_group = {:scope => scope, :name => name, :options => options}
+
+        @_current_param_group = {
+          :scope => scope,
+          :name => name,
+          :options => options,
+          :from_concern => scope.apipie_concern?
+        }
         self.instance_exec(&Apipie.get_param_group(scope, name))
       ensure
         @_current_param_group = nil
@@ -322,6 +328,10 @@ def _apipie_perform_concern_subst(string)
         end
       end
 
+      def apipie_concern?
+        false
+      end
+
       # create method api and redefine newly added method
       def method_added(method_name) #:doc:
         super
@@ -363,6 +373,10 @@ def _apipie_concern_data
         @_apipie_concern_data ||= []
       end
 
+      def apipie_concern?
+        true
+      end
+
       # create method api and redefine newly added method
       def method_added(method_name) #:doc:
         super

lib/apipie/param_description.rb

@@ -35,6 +35,9 @@ def initialize(method_description, name, validator, desc_or_options = nil, optio
 
       # we save options to know what was passed in DSL
       @options = options
+      if @options[:param_group]
+        @from_concern = @options[:param_group][:from_concern]
+      end
 
       @method_description = method_description
       @name = concern_subst(name)
@@ -66,6 +69,10 @@ def initialize(method_description, name, validator, desc_or_options = nil, optio
       end
     end
 
+    def from_concern?
+      method_description.from_concern? || @from_concern
+    end
+
     def validate(value)
       return true if @allow_nil && value.nil?
       if (!@allow_nil && value.nil?) || !@validator.valid?(value)
@@ -187,7 +194,7 @@ def action_awareness
     end
 
     def concern_subst(string)
-      return string if string.nil? or !method_description.from_concern?
+      return string if string.nil? or !from_concern?
 
       original = string
       string = ":#{original}" if original.is_a? Symbol

spec/dummy/app/controllers/overridden_concerns_controller.rb

@@ -0,0 +1,31 @@
+class OverriddenConcernsController < ApplicationController
+
+  resource_description { resource_id 'overridden_concern_resources' }
+
+  apipie_concern_subst(:concern => 'user')
+  include ::Concerns::SampleController
+
+  def_param_group :concern do
+    param :concern, String
+  end
+
+  api :PUT, '/:resource_id/:id'
+  param :custom_parameter, String, "New parameter added by the overriding method"
+  param_group :concern, ::Concerns::SampleController
+  def update
+    super
+  end
+
+  api :POST, '/:resource_id', "Create a :concern"
+  param_group :concern
+  def create
+    super
+  end
+
+  api :GET, '/:resource_id/custom'
+  param :concern, String
+  def custom
+    render :text => "OK #{params.inspect}"
+  end
+
+end

spec/lib/param_group_spec.rb

@@ -41,5 +41,20 @@
 
     arch_v1_params.sort_by(&:to_s).should == arch_v2_params.sort_by(&:to_s)
   end
+
+  it "should replace parameter name in a group when it comes from concern" do
+    Apipie["overridden_concern_resources#update"].params.has_key?(:user).should == true
+  end
+
+  it "shouldn't replace parameter name in a group redefined in the controller" do
+    Apipie["overridden_concern_resources#create"].params.has_key?(:concern).should == true
+    Apipie["overridden_concern_resources#create"].params.has_key?(:user).should == false
+  end
+
+it "shouldn't replace name of a parameter defined in the controller" do
+    Apipie["overridden_concern_resources#custom"].params.has_key?(:concern).should == true
+    Apipie["overridden_concern_resources#custom"].params.has_key?(:user).should == false
+  end
+
 end