apipie-rails 1.4.0 → 1.4.2

data/lib/apipie/extractor/writer.rb

@@ -324,7 +324,7 @@ module Apipie
           desc ||= case @action.to_s
                    when "show", "create", "update", "destroy"
                      name = name.singularize
-                     "#{@action.capitalize} #{name =~ /^[aeiou]/ ? 'an' : 'a'} #{name}"
+                     "#{@action.capitalize} #{/^[aeiou]/.match?(name) ? 'an' : 'a'} #{name}"
                    when "index"
                      "List #{name}"
                    end
@@ -341,7 +341,7 @@ module Apipie
         params.sort_by {|n,_| n }.each do |(name, desc)|
           desc[:type] = (desc[:type] && desc[:type].first) || Object
           code << "#{indent}param"
-          if name =~ /\W/
+          if /\W/.match?(name)
             code << " :'#{name}'"
           else
             code << " :#{name}"
@@ -397,7 +397,7 @@ module Apipie
         lines_to_add = []
         block_level = 0
         ensure_line_breaks(controller_content.lines).first(action_line).reverse_each do |line|
-          if line =~ /\s*\bend\b\s*/
+          if /\s*\bend\b\s*/.match?(line)
             block_level += 1
           end
           if block_level > 0
@@ -405,10 +405,10 @@ module Apipie
           else
             added_lines << line
           end
-          if line =~ /\s*\b(module|class|def)\b /
+          if /\s*\b(module|class|def)\b /.match?(line)
             break
           end
-          next unless line =~ /do\s*(\|.*?\|)?\s*$/
+          next unless /do\s*(\|.*?\|)?\s*$/.match?(line)
           block_level -= 1
           if block_level == 0
             added_lines.concat(lines_to_add)
@@ -426,7 +426,7 @@ module Apipie
       #   https://github.com/puppetlabs/puppet/blob/0dc44695/lib/puppet/util/monkey_patches.rb
       def ensure_line_breaks(lines)
         if lines.to_a.size > 1 && lines.first !~ /\n\Z/
-          lines.map { |l| l !~ /\n\Z/ ? (l << "\n") : l }.to_enum
+          lines.map { |l| !/\n\Z/.match?(l) ? (l << "\n") : l }.to_enum
         else
           lines
         end

data/lib/apipie/generator/swagger/method_description/api_schema_service.rb

@@ -17,8 +17,8 @@ class Apipie::Generator::Swagger::MethodDescription::ApiSchemaService
       end
 
       parameters = Apipie::Generator::Swagger::MethodDescription::ParametersService
-                   .new(@method_description, path: path, http_method: api.normalized_http_method)
-                   .call
+        .new(@method_description, path: path, http_method: api.normalized_http_method)
+        .call
 
       paths[path.swagger_path(@method_description)] ||= {}
       paths[path.swagger_path(@method_description)][api.normalized_http_method] = {

data/lib/apipie/generator/swagger/method_description/parameters_service.rb

@@ -40,7 +40,7 @@ class Apipie::Generator::Swagger::MethodDescription::ParametersService
 
       if Apipie.configuration.generator.swagger.json_input_uses_refs?
         composite = composite
-                    .referenced("#{@method_description.operation_id}_input")
+          .referenced("#{@method_description.operation_id}_input")
       end
 
       swagger_schema_for_body = composite.to_swagger
@@ -80,7 +80,7 @@ class Apipie::Generator::Swagger::MethodDescription::ParametersService
           warn_path_parameter_not_described(name, @path)
 
           result[name.to_sym] = Apipie::Generator::Swagger::ParamDescription
-                                .create_for_missing_param(@method_description, name)
+            .create_for_missing_param(@method_description, name)
         end
 
         result
@@ -89,15 +89,15 @@ class Apipie::Generator::Swagger::MethodDescription::ParametersService
 
   def body_param_descriptions
     @body_param_descriptions ||= all_params
-                                 .reject { |k, _| @path.param?(k) }
-                                 .values
+      .reject { |k, _| @path.param?(k) }
+      .values
   end
 
   def path_param_descriptions
     @path_param_descriptions ||= all_params
-                                 .select { |k, _| @path.param?(k) }
-                                 .each_value { |desc| desc.required = true }
-                                 .values
+      .select { |k, _| @path.param?(k) }
+      .each_value { |desc| desc.required = true }
+      .values
   end
 
   # @return [Array]

data/lib/apipie/generator/swagger/param_description/builder.rb

@@ -1,7 +1,7 @@
 class Apipie::Generator::Swagger::ParamDescription::Builder
   # @param [Apipie::ParamDescription] param_description
   # @param [TrueClass, FalseClass] in_schema
-  # @param [Apipie::MethodDescription] controller_method
+  # @param [Apipie::MethodDescription, nil] controller_method
   def initialize(param_description, in_schema:, controller_method:)
     @param_description = param_description
     @in_schema = in_schema
@@ -98,8 +98,8 @@ class Apipie::Generator::Swagger::ParamDescription::Builder
   def warn_optional_without_default_value(definition)
     if !required? && !definition.key?(:default)
       method_id =
-        if @param_description.is_a?(Apipie::ResponseDescriptionAdapter::PropDesc)
-          @controller_method
+        if @controller_method.present? && @param_description.is_a?(Apipie::ResponseDescriptionAdapter::PropDesc)
+          @controller_method.method_name
         else
           Apipie::Generator::Swagger::MethodDescription::Decorator.new(@controller_method).ruby_name
         end

data/lib/apipie/generator/swagger/param_description/in.rb

@@ -2,7 +2,7 @@ class Apipie::Generator::Swagger::ParamDescription::In
   IN_KEYWORD_DEFAULT_VALUES = {
     form_data: 'formData',
     query: 'query'
-  }
+  }.freeze
 
   def initialize(param_description, in_schema:, default_in_value:, http_method:)
     @param_description = param_description

data/lib/apipie/generator/swagger/param_description/path_params_composite.rb

@@ -26,21 +26,21 @@ class Apipie::Generator::Swagger::ParamDescription::PathParamsComposite
         context.add_to_prefix!(desc.name)
 
         out = Apipie::Generator::Swagger::ParamDescription::PathParamsComposite
-              .new(desc.validator.params_ordered, context)
-              .to_swagger
+          .new(desc.validator.params_ordered, context)
+          .to_swagger
 
         @result.concat(out)
       else
         param_entry =
           Apipie::Generator::Swagger::ParamDescription::Builder
-          .new(desc, in_schema: false, controller_method: context.controller_method)
-          .with_description(language: context.language)
-          .with_name(prefix: context.prefix)
-          .with_type(with_null: context.allow_null?)
-          .with_in(
-            http_method: context.http_method,
-            default_in_value: context.default_in_value
-          ).to_swagger
+            .new(desc, in_schema: false, controller_method: context.controller_method)
+            .with_description(language: context.language)
+            .with_name(prefix: context.prefix)
+            .with_type(with_null: context.allow_null?)
+            .with_in(
+              http_method: context.http_method,
+              default_in_value: context.default_in_value
+            ).to_swagger
 
         @result << param_entry
       end

data/lib/apipie/generator/swagger/param_description/type.rb

@@ -114,7 +114,11 @@ class Apipie::Generator::Swagger::ParamDescription::Type
   def warn_hash_without_internal_typespec
     method_id =
       if @param_description.is_a?(Apipie::ResponseDescriptionAdapter::PropDesc)
-        @controller_method.method
+        if @controller_method.present?
+          @controller_method.method_name
+        else
+          Apipie::Generator::Swagger::MethodDescription::Decorator.new(nil).ruby_name
+        end
       else
         Apipie::Generator::Swagger::MethodDescription::Decorator.new(@param_description.method_description).ruby_name
       end

data/lib/apipie/generator/swagger/resource_description_composite.rb

@@ -41,11 +41,11 @@ class Apipie::Generator::Swagger::ResourceDescriptionComposite
         next unless method_description.show
 
         result = Apipie::Generator::Swagger::MethodDescription::ApiSchemaService
-                 .new(
-                   Apipie::Generator::Swagger::MethodDescription::Decorator.new(method_description),
-                   language: @language
-                 )
-                 .call
+          .new(
+            Apipie::Generator::Swagger::MethodDescription::Decorator.new(method_description),
+            language: @language
+          )
+          .call
 
         results.deep_merge!(result)
       end

data/lib/apipie/generator/swagger/type_extractor.rb

@@ -18,7 +18,7 @@ class Apipie::Generator::Swagger::TypeExtractor
     date: Apipie::Generator::Swagger::Type.new('string', 'date'),
     dateTime: Apipie::Generator::Swagger::Type.new('string', 'date-time'),
     password: Apipie::Generator::Swagger::Type.new('string', 'password')
-  }
+  }.freeze
 
   # @param [Apipie::Validator::BaseValidator, ResponseDescriptionAdapter::PropDesc::Validator, nil] validator
   def initialize(validator)

data/lib/apipie/generator/swagger/warning.rb

@@ -17,7 +17,7 @@ class Apipie::Generator::Swagger::Warning
     optional_without_default_value: OPTIONAL_WITHOUT_DEFAULT_VALUE_CODE,
     param_ignored_in_form_data: PARAM_IGNORED_IN_FORM_DATA_CODE,
     path_param_not_described_code: PATH_PARAM_NOT_DESCRIBED_CODE
-  }
+  }.freeze
 
   MESSAGES = {
     MISSING_METHOD_SUMMARY_CODE => "Missing short description for method",
@@ -28,7 +28,7 @@ class Apipie::Generator::Swagger::Warning
     OPTIONAL_WITHOUT_DEFAULT_VALUE_CODE => "The parameter :%{parameter} is optional but default value is not specified (use :default_value => ...)",
     PARAM_IGNORED_IN_FORM_DATA_CODE => "Ignoring param :%{parameter} -- cannot include Hash without fields in a formData specification",
     PATH_PARAM_NOT_DESCRIBED_CODE => "The parameter :%{name} appears in the path %{path} but is not described"
-  }
+  }.freeze
 
   attr_reader :code
 

data/lib/apipie/helpers.rb

@@ -27,7 +27,7 @@ module Apipie
       end
       path = path.sub(%r{^/},"")
       ret = "#{@url_prefix}/#{path}"
-      ret.insert(0,"/") unless ret =~ %r{\A[./]}
+      ret.insert(0,"/") unless %r{\A[./]}.match?(ret)
       ret.sub!(%r{/*\Z},"")
       ret
     end

data/lib/apipie/response_description.rb

@@ -88,11 +88,16 @@ module Apipie
 
       @method_description = method_description
 
-      if code.is_a? Symbol
-        @code = Rack::Utils::SYMBOL_TO_STATUS_CODE[code]
-      else
-        @code = code
-      end
+      @code =
+        if code.is_a? Symbol
+          begin
+            Rack::Utils.status_code(code)
+          rescue ArgumentError
+            nil
+          end
+        else
+          code
+        end
 
       @description = options[:desc]
       if @description.nil?

data/lib/apipie/routes_formatter.rb

@@ -1,6 +1,6 @@
 module Apipie
   class RoutesFormatter
-    API_METHODS = %w{GET POST PUT PATCH OPTIONS DELETE}
+    API_METHODS = %w{GET POST PUT PATCH OPTIONS DELETE}.freeze
 
     # The entry method called by Apipie to extract the array
     # representing the api dsl from the routes definition.

data/lib/apipie/static_dispatcher.rb

@@ -16,8 +16,8 @@ module Apipie
     def match?(path)
       # Replace all null bytes
       path = ::Rack::Utils.unescape(path || '')
-                          .encode(Encoding::UTF_8, invalid: :replace, replace: '')
-                          .gsub("\x0", '')
+        .encode(Encoding::UTF_8, invalid: :replace, replace: '')
+        .gsub("\x0", '')
 
       full_path = path.empty? ? @root : File.join(@root, path)
       paths = "#{full_path}#{ext}"

data/lib/apipie/version.rb

@@ -1,3 +1,3 @@
 module Apipie
-  VERSION = "1.4.0"
+  VERSION = "1.4.2".freeze
 end

data/lib/tasks/apipie.rake

@@ -70,17 +70,17 @@ namespace :apipie do
     with_loaded_documentation do
       out = ENV["OUT_REF"] || File.join(Rails.root, Apipie.configuration.doc_path, 'apidoc_ref')
       paths = generate_swagger_using_args(args, out)
-      paths.each {|path|
+      paths.each do |path|
         existing_files_in_dir = Pathname(out).children(true)
 
         make_reference = false
 
         # reference filenames have the format <basename>.<counter>.swagger_ref
-        reference_files = existing_files_in_dir.select{|f|
+        reference_files = existing_files_in_dir.select do |f|
               f.extname == '.swagger_ref' &&
               f.basename.sub_ext("").extname.delete('.').to_i > 0 &&
               f.basename.sub_ext("").sub_ext("") == path.basename.sub_ext("")
-        }
+        end
         if reference_files.empty?
           print "Reference file does not exist for [#{path}]\n"
           counter = 1
@@ -111,7 +111,7 @@ namespace :apipie do
         if reference_files.length > num_refs_to_keep
           (reference_files - reference_files[-num_refs_to_keep..-1]).each(&:delete)
         end
-      }
+      end
     end
   end
 

data/spec/controllers/api/v1/architectures_controller_spec.rb

@@ -4,7 +4,7 @@ describe Api::V1::ArchitecturesController do
   describe "resource description" do
     subject { Apipie.get_resource_description(Api::V1::ArchitecturesController, "1.0") }
 
-    it "should be version 1.0" do
+    it "is version 1.0" do
       expect(subject._version).to eq('1.0')
 
       expect(Apipie.resource_descriptions['1.0'].size).to eq(2)
@@ -14,11 +14,11 @@ describe Api::V1::ArchitecturesController do
     context "there is another version" do
       let(:v2) { archv2 = Apipie.get_resource_description(Api::V2::ArchitecturesController, "2.0") }
 
-      it "should have unique doc url" do
+      it "has unique doc url" do
         expect(subject.doc_url).not_to eq(v2.doc_url)
       end
 
-      it "should have unique methods" do
+      it "has unique methods" do
         expect(subject._methods.keys).to include(:index)
         expect(v2._methods.keys).to include(:index)
         expect(subject._methods[:index]).not_to eq(v2._methods[:index])

data/spec/controllers/api/v2/nested/resources_controller_spec.rb

@@ -20,7 +20,7 @@ describe Api::V2::Nested::ResourcesController do
   describe '.get_resource_id' do
     subject { Apipie.get_resource_id(Api::V2::Nested::ResourcesController) }
 
-    it "should have resource_id set" do
+    it "has resource_id set" do
       expect(subject).to eq("resource")
     end
   end

data/spec/controllers/concerns_controller_spec.rb

@@ -7,12 +7,12 @@ describe ConcernsController do
     expect(Apipie["concern_resources#show"]).to be
   end
 
-  it "should reply to valid request" do
+  it "replies to valid request" do
     get :show, :params => { :id => '5' }, :session => { :user_id => "secret_hash" }
     assert_response :success
   end
 
-  it "should pass if required parameter is missing" do
+  it "passes if required parameter is missing" do
     expect { get :show, :params => { :id => '5' } }.not_to raise_error
   end
 

data/spec/controllers/extended_controller_spec.rb

@@ -2,13 +2,13 @@ require "spec_helper"
 
 describe ExtendedController do
 
-  it 'should include params from both original controller and extending concern' do
+  it 'includes params from both original controller and extending concern' do
     expect(Apipie["extended#create"].params.keys).to eq [:oauth, :user, :admin]
     user_param = Apipie["extended#create"].params[:user]
     expect(user_param.validator.params_ordered.map(&:name)).to eq [:name, :password, :from_concern]
   end
 
-  it 'should include updated metadata' do
+  it 'includes updated metadata' do
     expect(Apipie['extended#create'].metadata).to eq metadata: 'data'
   end
 end

data/spec/controllers/included_param_group_controller_spec.rb

@@ -5,7 +5,7 @@ describe IncludedParamGroupController do
 
   let(:dsl_data) { ActionController::Base.send(:_apipie_dsl_data_init) }
 
-  it "should not error when there is a param_group that is deeply nested in response description" do
+  it "does not error when there is a param_group that is deeply nested in response description" do
     subject = Apipie.get_resource_description(IncludedParamGroupController, Apipie.configuration.default_version)
     expect(subject._methods.keys).to include(:show)
   end

data/spec/controllers/pets_controller_spec.rb

@@ -4,7 +4,7 @@ require 'rspec/expectations'
 require 'apipie/rspec/response_validation_helper'
 require "json-schema"
 
-RSpec.describe PetsController, :type => :controller do
+RSpec.describe PetsController do
   it "does not raise error when rendered output matches the described response" do
     response = get :return_and_validate_expected_response, format: :json
     expect(response).to match_declared_responses