From 6db90f85ad8aaa348437a50107b9fb027337ee64 Mon Sep 17 00:00:00 2001 From: Mathieu Jobin <99191+mathieujobin@users.noreply.github.com> Date: Thu, 30 May 2024 16:10:25 +0900 Subject: [PATCH] configure Layout/MultilineMethodCallIndentation to ensure short indent --- .rubocop.yml | 3 +++ .rubocop_todo.yml | 10 ---------- lib/apipie/application.rb | 12 +++++------ .../method_description/api_schema_service.rb | 4 ++-- .../method_description/parameters_service.rb | 14 ++++++------- .../path_params_composite.rb | 20 +++++++++---------- .../swagger/resource_description_composite.rb | 10 +++++----- lib/apipie/static_dispatcher.rb | 4 ++-- spec/lib/swagger/swagger_dsl_spec.rb | 2 +- 9 files changed, 36 insertions(+), 43 deletions(-) diff --git a/.rubocop.yml b/.rubocop.yml index 400c57f1..5b8da261 100644 --- a/.rubocop.yml +++ b/.rubocop.yml @@ -12,6 +12,9 @@ AllCops: NewCops: enable TargetRubyVersion: 2.6 +Layout/MultilineMethodCallIndentation: + EnforcedStyle: indented + Layout/LineLength: Max: 140 Exclude: diff --git a/.rubocop_todo.yml b/.rubocop_todo.yml index 11eef51c..1dc4e50c 100644 --- a/.rubocop_todo.yml +++ b/.rubocop_todo.yml @@ -411,16 +411,6 @@ Layout/MultilineMethodCallBraceLayout: Exclude: - 'lib/tasks/apipie.rake' -# Offense count: 14 -# This cop supports safe autocorrection (--autocorrect). -# Configuration parameters: EnforcedStyle, IndentationWidth. -# SupportedStyles: aligned, indented, indented_relative_to_receiver -Layout/MultilineMethodCallIndentation: - Exclude: - - 'lib/apipie/generator/swagger/param_description/builder.rb' - - 'lib/apipie/generator/swagger/param_description/composite.rb' - - 'lib/apipie/generator/swagger/param_description/type.rb' - # Offense count: 4 # This cop supports safe autocorrection (--autocorrect). # Configuration parameters: EnforcedStyle, IndentationWidth. diff --git a/lib/apipie/application.rb b/lib/apipie/application.rb index 898f534f..5399b0bb 100644 --- a/lib/apipie/application.rb +++ b/lib/apipie/application.rb @@ -281,12 +281,12 @@ def to_swagger_json(version, resource_id, method_name, language, clear_warnings resources = Apipie::Generator::Swagger::ResourceDescriptionsCollection - .new(resource_descriptions) - .filter( - resource_id: resource_id, - method_name: method_name, - version: version - ) + .new(resource_descriptions) + .filter( + resource_id: resource_id, + method_name: method_name, + version: version + ) Apipie::SwaggerGenerator.generate_from_resources( resources, diff --git a/lib/apipie/generator/swagger/method_description/api_schema_service.rb b/lib/apipie/generator/swagger/method_description/api_schema_service.rb index 596b3488..9b8df904 100644 --- a/lib/apipie/generator/swagger/method_description/api_schema_service.rb +++ b/lib/apipie/generator/swagger/method_description/api_schema_service.rb @@ -17,8 +17,8 @@ def call 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] = { diff --git a/lib/apipie/generator/swagger/method_description/parameters_service.rb b/lib/apipie/generator/swagger/method_description/parameters_service.rb index 0b7a35dd..aa4a7c09 100644 --- a/lib/apipie/generator/swagger/method_description/parameters_service.rb +++ b/lib/apipie/generator/swagger/method_description/parameters_service.rb @@ -40,7 +40,7 @@ def body_params_schema 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 @@ def all_params 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 @@ def all_params 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] diff --git a/lib/apipie/generator/swagger/param_description/path_params_composite.rb b/lib/apipie/generator/swagger/param_description/path_params_composite.rb index 8e1783fe..c7505c9c 100644 --- a/lib/apipie/generator/swagger/param_description/path_params_composite.rb +++ b/lib/apipie/generator/swagger/param_description/path_params_composite.rb @@ -26,21 +26,21 @@ def to_swagger 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 diff --git a/lib/apipie/generator/swagger/resource_description_composite.rb b/lib/apipie/generator/swagger/resource_description_composite.rb index 6f42e93e..a7c7c11c 100644 --- a/lib/apipie/generator/swagger/resource_description_composite.rb +++ b/lib/apipie/generator/swagger/resource_description_composite.rb @@ -41,11 +41,11 @@ def paths 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 diff --git a/lib/apipie/static_dispatcher.rb b/lib/apipie/static_dispatcher.rb index 357c168d..984d5ae7 100644 --- a/lib/apipie/static_dispatcher.rb +++ b/lib/apipie/static_dispatcher.rb @@ -16,8 +16,8 @@ def initialize(root) 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}" diff --git a/spec/lib/swagger/swagger_dsl_spec.rb b/spec/lib/swagger/swagger_dsl_spec.rb index 4a5a9da2..64f64d41 100644 --- a/spec/lib/swagger/swagger_dsl_spec.rb +++ b/spec/lib/swagger/swagger_dsl_spec.rb @@ -283,7 +283,7 @@ def have_field?(field, expected_name, breadcrumb) expect(schema).to have_field(:pet_id, 'number', {:description => 'id of pet'}) expect(schema).to have_field(:pet_name, 'string', {:description => 'Name of pet', :required => false}) expect(schema).to have_field(:animal_type, 'string', {:description => 'Type of pet', :enum => %w[dog cat iguana kangaroo]}) - expect(schema).not_to have_field(:partial_match_allowed, 'boolean', {:required => false}) # rubocop:disable Capybara/NegationMatcher + expect(schema).not_to have_field(:partial_match_allowed, 'boolean', {:required => false}) end it "creates a swagger definition with all input parameters" do