Fix swagger warnings

.rubocop.yml

@@ -38,6 +38,7 @@ Metrics/ClassLength:
     - lib/apipie/extractor/writer.rb
     - lib/apipie/application.rb
     - lib/apipie/param_description.rb
+    - lib/apipie/method_description.rb
     - lib/apipie/swagger_generator.rb
     - spec/dummy/app/controllers/pets_controller.rb
     - spec/dummy/app/controllers/twitter_example_controller.rb

.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config --exclude-limit 180`
-# on 2023-04-11 04:14:54 UTC using RuboCop version 1.44.1.
+# on 2023-04-14 04:21:53 UTC using RuboCop version 1.44.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -155,7 +155,7 @@ Layout/EmptyLineBetweenDefs:
     - 'spec/dummy/app/controllers/pets_using_auto_views_controller.rb'
     - 'spec/dummy/app/controllers/pets_using_self_describing_classes_controller.rb'
 
-# Offense count: 61
+# Offense count: 57
 # This cop supports safe autocorrection (--autocorrect).
 Layout/EmptyLines:
   Exclude:
@@ -174,8 +174,6 @@ Layout/EmptyLines:
     - 'spec/dummy/app/controllers/pets_using_self_describing_classes_controller.rb'
     - 'spec/lib/apipie/apipies_controller_spec.rb'
     - 'spec/lib/apipie/application_spec.rb'
-    - 'spec/lib/apipie/method_description_spec.rb'
-    - 'spec/lib/apipie/param_description_spec.rb'
     - 'spec/lib/swagger/rake_swagger_spec.rb'
     - 'spec/lib/swagger/swagger_dsl_spec.rb'
 
@@ -195,7 +193,7 @@ Layout/EmptyLinesAroundAttributeAccessor:
   Exclude:
     - 'lib/apipie/configuration.rb'
 
-# Offense count: 101
+# Offense count: 93
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: EnforcedStyle.
 # SupportedStyles: empty_lines, no_empty_lines
@@ -218,7 +216,6 @@ Layout/EmptyLinesAroundBlockBody:
     - 'spec/lib/apipie/file_handler_spec.rb'
     - 'spec/lib/apipie/generator/swagger/param_description/composite_spec.rb'
     - 'spec/lib/apipie/generator/swagger/param_description/type_spec.rb'
-    - 'spec/lib/apipie/method_description_spec.rb'
     - 'spec/lib/apipie/param_description_spec.rb'
     - 'spec/lib/apipie/param_group_spec.rb'
     - 'spec/lib/apipie/validator_spec.rb'
@@ -269,7 +266,7 @@ Layout/EmptyLinesAroundMethodBody:
     - 'lib/apipie/rspec/response_validation_helper.rb'
     - 'lib/apipie/static_dispatcher.rb'
 
-# Offense count: 31
+# Offense count: 29
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: EnforcedStyle.
 # SupportedStyles: empty_lines, empty_lines_except_namespace, empty_lines_special, no_empty_lines
@@ -282,7 +279,6 @@ Layout/EmptyLinesAroundModuleBody:
     - 'lib/apipie/errors.rb'
     - 'lib/apipie/extractor.rb'
     - 'lib/apipie/markup.rb'
-    - 'lib/apipie/method_description.rb'
     - 'lib/apipie/param_description.rb'
     - 'lib/apipie/resource_description.rb'
     - 'lib/apipie/response_description.rb'
@@ -571,14 +567,13 @@ Layout/SpaceInsideBlockBraces:
     - 'spec/spec_helper.rb'
     - 'spec/support/rake.rb'
 
-# Offense count: 216
+# Offense count: 206
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: EnforcedStyle, EnforcedStyleForEmptyBraces.
 # SupportedStyles: space, no_space, compact
 # SupportedStylesForEmptyBraces: space, no_space
 Layout/SpaceInsideHashLiteralBraces:
   Exclude:
-    - 'lib/apipie/dsl_definition.rb'
     - 'lib/apipie/extractor.rb'
     - 'lib/apipie/extractor/collector.rb'
     - 'lib/apipie/extractor/recorder.rb'
@@ -592,7 +587,6 @@ Layout/SpaceInsideHashLiteralBraces:
     - 'spec/dummy/components/test_engine/app/controllers/test_engine/memes_controller.rb'
     - 'spec/lib/apipie/apipies_controller_spec.rb'
     - 'spec/lib/apipie/extractor/recorder/middleware_spec.rb'
-    - 'spec/lib/apipie/method_description_spec.rb'
     - 'spec/lib/swagger/swagger_dsl_spec.rb'
 
 # Offense count: 5
@@ -854,14 +848,13 @@ Naming/HeredocDelimiterNaming:
     - 'spec/dummy/app/controllers/twitter_example_controller.rb'
     - 'spec/dummy/app/controllers/users_controller.rb'
 
-# Offense count: 4
+# Offense count: 3
 # Configuration parameters: EnforcedStyleForLeadingUnderscores.
 # SupportedStylesForLeadingUnderscores: disallowed, required, optional
 Naming/MemoizedInstanceVariableName:
   Exclude:
     - 'lib/apipie/apipie_module.rb'
     - 'lib/apipie/generator/swagger/param_description/type.rb'
-    - 'lib/apipie/generator/swagger/type_extractor.rb'
 
 # Offense count: 3
 # Configuration parameters: MinNameLength, AllowNamesEndingInNumbers, AllowedNames, ForbiddenNames.
@@ -940,13 +933,12 @@ Performance/RegexpMatch:
     - 'lib/apipie/extractor/writer.rb'
     - 'lib/apipie/helpers.rb'
 
-# Offense count: 8
+# Offense count: 7
 # This cop supports safe autocorrection (--autocorrect).
 Performance/StringIdentifierArgument:
   Exclude:
     - 'lib/apipie/extractor/writer.rb'
     - 'spec/controllers/users_controller_spec.rb'
-    - 'spec/lib/apipie/method_description_spec.rb'
 
 # Offense count: 6
 # This cop supports safe autocorrection (--autocorrect).
@@ -972,7 +964,7 @@ RSpec/Be:
     - 'spec/controllers/concerns_controller_spec.rb'
     - 'spec/controllers/users_controller_spec.rb'
 
-# Offense count: 55
+# Offense count: 59
 # This cop supports unsafe autocorrection (--autocorrect-all).
 RSpec/BeEq:
   Exclude:
@@ -992,7 +984,7 @@ RSpec/BeforeAfterAll:
   Exclude:
     - 'spec/controllers/users_controller_spec.rb'
 
-# Offense count: 55
+# Offense count: 52
 # Configuration parameters: Prefixes, AllowedPatterns.
 # Prefixes: when, with, without
 RSpec/ContextWording:
@@ -1020,7 +1012,7 @@ RSpec/DescribeClass:
     - 'spec/lib/swagger/rake_swagger_spec.rb'
     - 'spec/lib/swagger/swagger_dsl_spec.rb'
 
-# Offense count: 94
+# Offense count: 76
 # This cop supports unsafe autocorrection (--autocorrect-all).
 # Configuration parameters: SkipBlocks, EnforcedStyle.
 # SupportedStyles: described_class, explicit
@@ -1047,12 +1039,11 @@ RSpec/EmptyExampleGroup:
   Exclude:
     - 'spec/lib/apipie/generator/swagger/param_description/composite_spec.rb'
 
-# Offense count: 6
+# Offense count: 2
 # This cop supports safe autocorrection (--autocorrect).
 RSpec/EmptyLineAfterExampleGroup:
   Exclude:
     - 'spec/controllers/users_controller_spec.rb'
-    - 'spec/lib/apipie/param_description_spec.rb'
 
 # Offense count: 1
 # This cop supports safe autocorrection (--autocorrect).
@@ -1067,12 +1058,12 @@ RSpec/EmptyLineAfterHook:
   Exclude:
     - 'spec/lib/apipie/apipies_controller_spec.rb'
 
-# Offense count: 52
+# Offense count: 51
 # Configuration parameters: CountAsOne.
 RSpec/ExampleLength:
   Max: 85
 
-# Offense count: 161
+# Offense count: 159
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: CustomTransform, IgnoredWords, DisallowedExamples.
 # DisallowedExamples: works
@@ -1106,22 +1097,20 @@ RSpec/ExpectInHook:
   Exclude:
     - 'spec/lib/apipie/extractor/writer_spec.rb'
 
-# Offense count: 6
+# Offense count: 2
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: EnforcedStyle.
 # SupportedStyles: implicit, each, example
 RSpec/HookArgument:
   Exclude:
     - 'spec/lib/apipie/extractor/writer_spec.rb'
-    - 'spec/lib/apipie/method_description_spec.rb'
 
-# Offense count: 4
+# Offense count: 3
 # This cop supports safe autocorrection (--autocorrect).
 RSpec/HooksBeforeExamples:
   Exclude:
     - 'spec/controllers/users_controller_spec.rb'
     - 'spec/lib/apipie/extractor/writer_spec.rb'
-    - 'spec/lib/apipie/param_description_spec.rb'
 
 # Offense count: 2
 # This cop supports safe autocorrection (--autocorrect).
@@ -1131,14 +1120,13 @@ RSpec/ImplicitSubject:
   Exclude:
     - 'spec/lib/apipie/application_spec.rb'
 
-# Offense count: 20
+# Offense count: 2
 # Configuration parameters: AssignmentOnly.
 RSpec/InstanceVariable:
   Exclude:
     - 'spec/lib/apipie/apipies_controller_spec.rb'
-    - 'spec/lib/apipie/method_description_spec.rb'
 
-# Offense count: 9
+# Offense count: 8
 # This cop supports safe autocorrection (--autocorrect).
 RSpec/LeadingSubject:
   Exclude:
@@ -1148,7 +1136,6 @@ RSpec/LeadingSubject:
     - 'spec/lib/apipie/generator/swagger/param_description/name_spec.rb'
     - 'spec/lib/apipie/generator/swagger/param_description/type_spec.rb'
     - 'spec/lib/apipie/generator/swagger/param_description_spec.rb'
-    - 'spec/lib/apipie/generator/swagger/type_extractor_spec.rb'
     - 'spec/support/rake.rb'
 
 # Offense count: 1
@@ -1162,16 +1149,16 @@ RSpec/LeakyConstantDeclaration:
 RSpec/MessageSpies:
   EnforcedStyle: receive
 
-# Offense count: 97
+# Offense count: 94
 RSpec/MultipleExpectations:
   Max: 19
 
-# Offense count: 100
+# Offense count: 154
 # Configuration parameters: AllowSubject.
 RSpec/MultipleMemoizedHelpers:
   Max: 15
 
-# Offense count: 65
+# Offense count: 83
 # Configuration parameters: EnforcedStyle, IgnoreSharedExamples.
 # SupportedStyles: always, named_only
 RSpec/NamedSubject:
@@ -1183,7 +1170,6 @@ RSpec/NamedSubject:
     - 'spec/lib/apipie/generator/swagger/param_description/builder_spec.rb'
     - 'spec/lib/apipie/generator/swagger/param_description/type_spec.rb'
     - 'spec/lib/apipie/generator/swagger/param_description_spec.rb'
-    - 'spec/lib/apipie/generator/swagger/type_extractor_spec.rb'
     - 'spec/lib/apipie/generator/swagger/warning_spec.rb'
     - 'spec/lib/apipie/generator/swagger/warning_writer_spec.rb'
     - 'spec/lib/apipie/method_description/apis_service_spec.rb'
@@ -1193,7 +1179,7 @@ RSpec/NamedSubject:
     - 'spec/lib/swagger/rake_swagger_spec.rb'
     - 'spec/lib/swagger/swagger_dsl_spec.rb'
 
-# Offense count: 65
+# Offense count: 89
 # Configuration parameters: AllowedGroups.
 RSpec/NestedGroups:
   Max: 6
@@ -1206,14 +1192,13 @@ RSpec/NoExpectationExample:
     - 'spec/controllers/users_controller_spec.rb'
     - 'spec/test_engine/memes_controller_spec.rb'
 
-# Offense count: 11
+# Offense count: 2
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: EnforcedStyle.
 # SupportedStyles: not_to, to_not
 RSpec/NotToNot:
   Exclude:
     - 'spec/lib/apipie/file_handler_spec.rb'
-    - 'spec/lib/apipie/param_description_spec.rb'
 
 # Offense count: 1
 RSpec/OverwritingSetup:
@@ -1241,11 +1226,6 @@ RSpec/Rails/InferredSpecType:
   Exclude:
     - 'spec/controllers/pets_controller_spec.rb'
 
-# Offense count: 2
-RSpec/RepeatedExample:
-  Exclude:
-    - 'spec/lib/apipie/method_description_spec.rb'
-
 # Offense count: 2
 RSpec/RepeatedExampleGroupBody:
   Exclude:
@@ -1341,7 +1321,7 @@ Rails/OutputSafety:
   Exclude:
     - 'lib/apipie/helpers.rb'
 
-# Offense count: 5
+# Offense count: 3
 # This cop supports safe autocorrection (--autocorrect).
 Rails/Pluck:
   Exclude:
@@ -1530,12 +1510,6 @@ Style/ConditionalAssignment:
     - 'lib/apipie/see_description.rb'
     - 'lib/tasks/apipie.rake'
 
-# Offense count: 1
-# Configuration parameters: AllowedConstants.
-Style/Documentation:
-  Exclude:
-    - 'lib/apipie/generator/config.rb'
-
 # Offense count: 1
 # This cop supports unsafe autocorrection (--autocorrect-all).
 # Configuration parameters: EnforcedStyle.
@@ -1618,7 +1592,7 @@ Style/For:
   Exclude:
     - 'lib/apipie/response_description_adapter.rb'
 
-# Offense count: 8
+# Offense count: 7
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: MaxUnannotatedPlaceholdersAllowed, AllowedMethods, AllowedPatterns, IgnoredMethods.
 # SupportedStyles: annotated, template, unannotated
@@ -1716,13 +1690,6 @@ Style/MultilineBlockChain:
   Exclude:
     - 'lib/apipie/param_description.rb'
 
-# Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: AllowMethodComparison.
-Style/MultipleComparison:
-  Exclude:
-    - 'lib/apipie/validator.rb'
-
 # Offense count: 7
 # This cop supports unsafe autocorrection (--autocorrect-all).
 # Configuration parameters: EnforcedStyle.
@@ -1867,7 +1834,7 @@ Style/RedundantPercentQ:
   Exclude:
     - 'apipie-rails.gemspec'
 
-# Offense count: 30
+# Offense count: 29
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: AllowMultipleReturnValues.
 Style/RedundantReturn:
@@ -1969,7 +1936,7 @@ Style/StringConcatenation:
     - 'lib/apipie/application.rb'
     - 'lib/apipie/extractor/writer.rb'
 
-# Offense count: 1235
+# Offense count: 1196
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: EnforcedStyle, ConsistentQuotesInMultiline.
 # SupportedStyles: single_quotes, double_quotes
@@ -2053,7 +2020,7 @@ Style/StringLiterals:
     - 'spec/support/rake.rb'
     - 'spec/test_engine/memes_controller_spec.rb'
 
-# Offense count: 38
+# Offense count: 35
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: MinSize.
 # SupportedStyles: percent, brackets

lib/apipie/generator/swagger/method_description/decorator.rb

@@ -1,15 +1,15 @@
 class Apipie::Generator::Swagger::MethodDescription::Decorator < SimpleDelegator
   # @return [String]
   def operation_id
-    "#{object.resource.controller.name}__#{object.method}"
+    "#{object.resource.controller.name}__#{object.method_name}"
   end
 
   # @return [String]
   def ruby_name
     if object.blank?
       '<no method>'
     else
-      "#{object.resource.controller.name}##{object.method}"
+      "#{object.resource.controller.name}##{object.method_name}"
     end
   end