apipie-rails 0.2.4 → 0.2.5

data/.travis.yml

@@ -1,6 +1,5 @@
 language: ruby
 rvm:
-  - 1.8.7
   - 1.9.3
   - 2.0.0
   - 2.1.1
@@ -8,9 +7,3 @@ gemfile:
   - Gemfile.rails32
   - Gemfile.rails40
   - Gemfile.rails41
-matrix:
-  exclude:
-    - rvm: 1.8.7
-      gemfile: Gemfile.rails40
-    - rvm: 1.8.7
-      gemfile: Gemfile.rails41

data/CHANGELOG.md

@@ -2,6 +2,13 @@
  Changelog
 ===========
 
+v0.2.5
+------
+
+* Name substitution for referenced param_group defined in a concern
+  [#280](https://github.com/Apipie/apipie-rails/pull/280) [@tstrachota][]
+* expected_type 'array' for ArrayValidator
+  [#276](https://github.com/Apipie/apipie-rails/pull/276) [@dustint-rh][]
 
 THE FURTHER SUPPORT FOR RUBY 1.8.7 WILL NOT BE ENSURED IN THE MASTER
 AND THE `>= 0.3.0` RELAEASES. We discourage anyone to keep using ruby
@@ -202,3 +209,4 @@ v0.0.15
 [@exAspArk]: https://github.com/exAspArk
 [@mourad-ifeelgoods]: https://github.com/mourad-ifeelgoods
 [@domcleal]: https://github.com/domcleal
+[@dustint-rh]: https://github.com/dustint-rh

data/lib/apipie/dsl_definition.rb

@@ -264,7 +264,13 @@ module Apipie
           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 @@ module Apipie
         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 @@ module Apipie
         @_apipie_concern_data ||= []
       end
 
+      def apipie_concern?
+        true
+      end
+
       # create method api and redefine newly added method
       def method_added(method_name) #:doc:
         super

data/lib/apipie/param_description.rb

@@ -35,6 +35,9 @@ module Apipie
 
       # 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 @@ module Apipie
       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 @@ module Apipie
     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

data/lib/apipie/validator.rb

@@ -175,6 +175,10 @@ module Apipie
         "Must be an array of #{items}"
       end
 
+      def expected_type
+        "array"
+      end
+
       def self.build(param_description, argument, options, block)
         if argument == Array && !block.is_a?(Proc)
           self.new(param_description, argument, options)

data/lib/apipie/version.rb

@@ -1,3 +1,3 @@
 module Apipie
-  VERSION = '0.2.4'
+  VERSION = '0.2.5'
 end

data/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

data/spec/lib/param_group_spec.rb

@@ -41,5 +41,20 @@ describe "param groups" do
 
     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
 

metadata

@@ -1,169 +1,165 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: apipie-rails
-version: !ruby/object:Gem::Version
-  version: 0.2.4
+version: !ruby/object:Gem::Version 
+  hash: 29
   prerelease: 
+  segments: 
+  - 0
+  - 2
+  - 5
+  version: 0.2.5
 platform: ruby
-authors:
+authors: 
 - Pavel Pokorny
 - Ivan Necas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-11 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2014-08-22 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: rails
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 3.0.10
-  type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 3
+        - 0
+        - 10
         version: 3.0.10
-- !ruby/object:Gem::Dependency
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
   name: json
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
   name: rspec-rails
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 2.14.2
-  type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        hash: 51
+        segments: 
+        - 2
+        - 14
+        - 2
         version: 2.14.2
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
   type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: sqlite3
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: minitest
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: maruku
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: maruku
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: RedCloth
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: RedCloth
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: rake
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rdoc
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
+  name: rdoc
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id009 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id009
 description: Rails REST API documentation tool
-email:
+email: 
 - pajkycz@gmail.com
 - inecas@redhat.com
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - .gitignore
 - .rspec
 - .travis.yml
@@ -254,6 +250,7 @@ files:
 - spec/dummy/app/controllers/application_controller.rb
 - spec/dummy/app/controllers/concerns/sample_controller.rb
 - spec/dummy/app/controllers/concerns_controller.rb
+- spec/dummy/app/controllers/overridden_concerns_controller.rb
 - spec/dummy/app/controllers/twitter_example_controller.rb
 - spec/dummy/app/controllers/users_controller.rb
 - spec/dummy/app/views/layouts/application.html.erb
@@ -300,31 +297,41 @@ files:
 - spec/lib/validators/array_validator_spec.rb
 - spec/spec_helper.rb
 - spec/support/rake.rb
+has_rdoc: true
 homepage: http://github.com/Pajk/apipie-rails
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Rails REST API documentation tool
-test_files:
+test_files: 
 - spec/controllers/api/v1/architectures_controller_spec.rb
 - spec/controllers/api/v2/architectures_controller_spec.rb
 - spec/controllers/api/v2/nested/resources_controller_spec.rb
@@ -342,6 +349,7 @@ test_files:
 - spec/dummy/app/controllers/application_controller.rb
 - spec/dummy/app/controllers/concerns/sample_controller.rb
 - spec/dummy/app/controllers/concerns_controller.rb
+- spec/dummy/app/controllers/overridden_concerns_controller.rb
 - spec/dummy/app/controllers/twitter_example_controller.rb
 - spec/dummy/app/controllers/users_controller.rb
 - spec/dummy/app/views/layouts/application.html.erb
@@ -388,4 +396,3 @@ test_files:
 - spec/lib/validators/array_validator_spec.rb
 - spec/spec_helper.rb
 - spec/support/rake.rb
-has_rdoc: