apipie-rails 1.1.0 → 1.2.1

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config --exclude-limit 180`
-# on 2023-04-14 04:21:53 UTC using RuboCop version 1.44.1.
+# on 2023-06-09 05:29:05 UTC using RuboCop version 1.52.0.
 # 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
@@ -14,10 +14,9 @@ Gemspec/DeprecatedAttributeAssignment:
   Exclude:
     - 'apipie-rails.gemspec'
 
-# Offense count: 9
+# Offense count: 11
 # Configuration parameters: EnforcedStyle, AllowedGems, Include.
 # SupportedStyles: Gemfile, gems.rb, gemspec
-# AllowedGems: bundler
 # Include: **/*.gemspec, **/Gemfile, **/gems.rb
 Gemspec/DevelopmentDependencies:
   Exclude:
@@ -108,7 +107,7 @@ Layout/DotPosition:
     - 'spec/lib/apipie/generator/swagger/operation_id_spec.rb'
     - 'spec/lib/apipie/generator/swagger/param_description/type_spec.rb'
 
-# Offense count: 7
+# Offense count: 8
 # This cop supports safe autocorrection (--autocorrect).
 Layout/ElseAlignment:
   Exclude:
@@ -119,7 +118,7 @@ Layout/ElseAlignment:
     - 'lib/apipie/param_description.rb'
     - 'lib/apipie/resource_description.rb'
 
-# Offense count: 60
+# Offense count: 58
 # This cop supports safe autocorrection (--autocorrect).
 Layout/EmptyLineAfterGuardClause:
   Exclude:
@@ -155,7 +154,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: 57
+# Offense count: 56
 # This cop supports safe autocorrection (--autocorrect).
 Layout/EmptyLines:
   Exclude:
@@ -193,7 +192,7 @@ Layout/EmptyLinesAroundAttributeAccessor:
   Exclude:
     - 'lib/apipie/configuration.rb'
 
-# Offense count: 93
+# Offense count: 92
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: EnforcedStyle.
 # SupportedStyles: empty_lines, no_empty_lines
@@ -202,7 +201,6 @@ Layout/EmptyLinesAroundBlockBody:
     - 'app/controllers/apipie/apipies_controller.rb'
     - 'lib/tasks/apipie.rake'
     - 'spec/controllers/api/v1/architectures_controller_spec.rb'
-    - 'spec/controllers/api/v2/architectures_controller_spec.rb'
     - 'spec/controllers/concerns_controller_spec.rb'
     - 'spec/controllers/extended_controller_spec.rb'
     - 'spec/controllers/included_param_group_controller_spec.rb'
@@ -288,7 +286,7 @@ Layout/EmptyLinesAroundModuleBody:
     - 'lib/apipie/tag_list_description.rb'
     - 'lib/apipie/validator.rb'
 
-# Offense count: 7
+# Offense count: 8
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: EnforcedStyleAlignWith, Severity.
 # SupportedStylesAlignWith: keyword, variable, start_of_line
@@ -374,9 +372,9 @@ Layout/IndentationConsistency:
     - 'lib/apipie/generator/swagger/param_description/name.rb'
     - 'spec/lib/apipie/param_group_spec.rb'
 
-# Offense count: 10
+# Offense count: 14
 # This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: Width, AllowedPatterns, IgnoredPatterns.
+# Configuration parameters: Width, AllowedPatterns.
 Layout/IndentationWidth:
   Exclude:
     - 'app/controllers/apipie/apipies_controller.rb'
@@ -440,13 +438,12 @@ Layout/MultilineMethodCallIndentation:
     - 'lib/apipie/generator/swagger/param_description/composite.rb'
     - 'lib/apipie/generator/swagger/param_description/type.rb'
 
-# Offense count: 5
+# Offense count: 4
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: EnforcedStyle, IndentationWidth.
 # SupportedStyles: aligned, indented
 Layout/MultilineOperationIndentation:
   Exclude:
-    - 'lib/apipie/application.rb'
     - 'lib/apipie/generator/swagger/param_description/composite.rb'
     - 'lib/apipie/param_description.rb'
     - 'lib/tasks/apipie.rake'
@@ -622,18 +619,17 @@ Layout/TrailingEmptyLines:
     - 'spec/lib/apipie/generator/swagger/param_description_spec.rb'
     - 'spec/lib/apipie/param_group_spec.rb'
 
-# Offense count: 16
+# Offense count: 15
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: AllowInHeredoc.
 Layout/TrailingWhitespace:
   Exclude:
     - 'lib/apipie/error_description.rb'
-    - 'spec/dummy/app/controllers/api/v2/nested/resources_controller.rb'
     - 'spec/dummy/app/controllers/application_controller.rb'
     - 'spec/dummy/app/controllers/twitter_example_controller.rb'
 
 # Offense count: 10
-# This cop supports safe autocorrection (--autocorrect).
+# This cop supports unsafe autocorrection (--autocorrect-all).
 # Configuration parameters: AllowSafeAssignment.
 Lint/AssignmentInCondition:
   Exclude:
@@ -749,12 +745,11 @@ Lint/UnusedBlockArgument:
     - 'spec/lib/swagger/swagger_dsl_spec.rb'
     - 'spec/spec_helper.rb'
 
-# Offense count: 26
+# Offense count: 24
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: AllowUnusedKeywordArguments, IgnoreEmptyMethods, IgnoreNotImplementedMethods.
 Lint/UnusedMethodArgument:
   Exclude:
-    - 'lib/apipie/application.rb'
     - 'lib/apipie/dsl_definition.rb'
     - 'lib/apipie/response_description_adapter.rb'
     - 'lib/apipie/validator.rb'
@@ -762,6 +757,7 @@ Lint/UnusedMethodArgument:
     - 'spec/support/custom_bool_validator.rb'
 
 # Offense count: 5
+# This cop supports unsafe autocorrection (--autocorrect-all).
 Lint/UselessAssignment:
   Exclude:
     - 'lib/apipie/application.rb'
@@ -776,35 +772,42 @@ Lint/UselessMethodDefinition:
     - 'spec/dummy/app/controllers/overridden_concerns_controller.rb'
 
 # Offense count: 3
+# This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: CheckForMethodsWithNoSideEffects.
 Lint/Void:
   Exclude:
     - 'spec/controllers/users_controller_spec.rb'
 
 # Offense count: 58
-# Configuration parameters: AllowedMethods, AllowedPatterns, IgnoredMethods, CountRepeatedAttributes.
+# Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes.
 Metrics/AbcSize:
   Max: 96
 
+# Offense count: 1
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns, inherit_mode.
+# AllowedMethods: refine
+Metrics/BlockLength:
+  Max: 26
+
 # Offense count: 4
 # Configuration parameters: CountBlocks.
 Metrics/BlockNesting:
   Max: 4
 
-# Offense count: 25
-# Configuration parameters: AllowedMethods, AllowedPatterns, IgnoredMethods.
+# Offense count: 24
+# Configuration parameters: AllowedMethods, AllowedPatterns.
 Metrics/CyclomaticComplexity:
   Max: 24
 
-# Offense count: 77
-# Configuration parameters: CountComments, CountAsOne, ExcludedMethods, AllowedMethods, AllowedPatterns, IgnoredMethods.
+# Offense count: 79
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
 Metrics/MethodLength:
   Max: 58
 
 # Offense count: 1
 # Configuration parameters: CountComments, CountAsOne.
 Metrics/ModuleLength:
-  Max: 119
+  Max: 101
 
 # Offense count: 4
 # Configuration parameters: CountKeywordArgs.
@@ -812,8 +815,8 @@ Metrics/ParameterLists:
   MaxOptionalParameters: 5
   Max: 6
 
-# Offense count: 21
-# Configuration parameters: AllowedMethods, AllowedPatterns, IgnoredMethods.
+# Offense count: 20
+# Configuration parameters: AllowedMethods, AllowedPatterns.
 Metrics/PerceivedComplexity:
   Max: 25
 
@@ -840,15 +843,16 @@ Naming/HeredocDelimiterCase:
   Exclude:
     - 'spec/dummy/app/controllers/users_controller.rb'
 
-# Offense count: 6
+# Offense count: 7
 # Configuration parameters: ForbiddenDelimiters.
-# ForbiddenDelimiters: (?-mix:(^|\s)(EO[A-Z]{1}|END)(\s|$))
+# ForbiddenDelimiters: (?i-mx:(^|\s)(EO[A-Z]{1}|END)(\s|$))
 Naming/HeredocDelimiterNaming:
   Exclude:
     - 'spec/dummy/app/controllers/twitter_example_controller.rb'
     - 'spec/dummy/app/controllers/users_controller.rb'
 
 # Offense count: 3
+# This cop supports unsafe autocorrection (--autocorrect-all).
 # Configuration parameters: EnforcedStyleForLeadingUnderscores.
 # SupportedStylesForLeadingUnderscores: disallowed, required, optional
 Naming/MemoizedInstanceVariableName:
@@ -880,7 +884,7 @@ Naming/PredicateName:
 # Offense count: 1
 # Configuration parameters: EnforcedStyle, CheckMethodNames, CheckSymbols, AllowedIdentifiers, AllowedPatterns.
 # SupportedStyles: snake_case, normalcase, non_integer
-# AllowedIdentifiers: capture3, iso8601, rfc1123_date, rfc822, rfc2822, rfc3339
+# AllowedIdentifiers: capture3, iso8601, rfc1123_date, rfc822, rfc2822, rfc3339, x86_64
 Naming/VariableNumber:
   Exclude:
     - 'spec/dummy/app/controllers/users_controller.rb'
@@ -906,12 +910,6 @@ Performance/Detect:
   Exclude:
     - 'spec/lib/swagger/rake_swagger_spec.rb'
 
-# Offense count: 1
-# This cop supports unsafe autocorrection (--autocorrect-all).
-Performance/InefficientHashSearch:
-  Exclude:
-    - 'lib/apipie/generator/swagger/warning.rb'
-
 # Offense count: 1
 # This cop supports safe autocorrection (--autocorrect).
 Performance/RedundantBlockCall:
@@ -940,11 +938,10 @@ Performance/StringIdentifierArgument:
     - 'lib/apipie/extractor/writer.rb'
     - 'spec/controllers/users_controller_spec.rb'
 
-# Offense count: 6
+# Offense count: 5
 # This cop supports safe autocorrection (--autocorrect).
 Performance/StringReplacement:
   Exclude:
-    - 'app/controllers/apipie/apipies_controller.rb'
     - 'lib/apipie/application.rb'
     - 'lib/apipie/extractor/writer.rb'
     - 'lib/apipie/generator/swagger/operation_id.rb'
@@ -984,7 +981,7 @@ RSpec/BeforeAfterAll:
   Exclude:
     - 'spec/controllers/users_controller_spec.rb'
 
-# Offense count: 52
+# Offense count: 53
 # Configuration parameters: Prefixes, AllowedPatterns.
 # Prefixes: when, with, without
 RSpec/ContextWording:
@@ -1012,14 +1009,13 @@ RSpec/DescribeClass:
     - 'spec/lib/swagger/rake_swagger_spec.rb'
     - 'spec/lib/swagger/swagger_dsl_spec.rb'
 
-# Offense count: 76
+# Offense count: 75
 # This cop supports unsafe autocorrection (--autocorrect-all).
 # Configuration parameters: SkipBlocks, EnforcedStyle.
 # SupportedStyles: described_class, explicit
 RSpec/DescribedClass:
   Exclude:
     - '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'
     - 'spec/controllers/included_param_group_controller_spec.rb'
     - 'spec/controllers/users_controller_spec.rb'
@@ -1070,7 +1066,6 @@ RSpec/ExampleLength:
 RSpec/ExampleWording:
   Exclude:
     - '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'
     - 'spec/controllers/concerns_controller_spec.rb'
     - 'spec/controllers/extended_controller_spec.rb'
@@ -1153,18 +1148,17 @@ RSpec/MessageSpies:
 RSpec/MultipleExpectations:
   Max: 19
 
-# Offense count: 154
+# Offense count: 156
 # Configuration parameters: AllowSubject.
 RSpec/MultipleMemoizedHelpers:
   Max: 15
 
-# Offense count: 83
+# Offense count: 82
 # Configuration parameters: EnforcedStyle, IgnoreSharedExamples.
 # SupportedStyles: always, named_only
 RSpec/NamedSubject:
   Exclude:
     - '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'
     - 'spec/controllers/users_controller_spec.rb'
     - 'spec/lib/apipie/generator/swagger/param_description/builder_spec.rb'
@@ -1179,18 +1173,17 @@ RSpec/NamedSubject:
     - 'spec/lib/swagger/rake_swagger_spec.rb'
     - 'spec/lib/swagger/swagger_dsl_spec.rb'
 
-# Offense count: 89
+# Offense count: 94
 # Configuration parameters: AllowedGroups.
 RSpec/NestedGroups:
   Max: 6
 
-# Offense count: 2
+# Offense count: 1
 # Configuration parameters: AllowedPatterns.
 # AllowedPatterns: ^expect_, ^assert_
 RSpec/NoExpectationExample:
   Exclude:
     - 'spec/controllers/users_controller_spec.rb'
-    - 'spec/test_engine/memes_controller_spec.rb'
 
 # Offense count: 2
 # This cop supports safe autocorrection (--autocorrect).
@@ -1297,13 +1290,12 @@ Rails/HttpStatus:
     - 'spec/dummy/app/controllers/pets_controller.rb'
     - 'spec/dummy/app/controllers/users_controller.rb'
 
-# Offense count: 4
+# Offense count: 3
 # This cop supports unsafe autocorrection (--autocorrect-all).
 Rails/NegateInclude:
   Exclude:
     - 'lib/apipie/extractor/collector.rb'
     - 'lib/apipie/extractor/writer.rb'
-    - 'lib/apipie/generator/swagger/warning.rb'
     - 'spec/spec_helper.rb'
 
 # Offense count: 7
@@ -1322,7 +1314,7 @@ Rails/OutputSafety:
     - 'lib/apipie/helpers.rb'
 
 # Offense count: 3
-# This cop supports safe autocorrection (--autocorrect).
+# This cop supports unsafe autocorrection (--autocorrect-all).
 Rails/Pluck:
   Exclude:
     - 'lib/apipie/extractor/writer.rb'
@@ -1384,9 +1376,9 @@ Style/AndOr:
   Exclude:
     - 'lib/apipie/param_description.rb'
 
-# Offense count: 17
+# Offense count: 18
 # This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyle, ProceduralMethods, FunctionalMethods, AllowedMethods, AllowedPatterns, IgnoredMethods, AllowBracesOnProceduralOneLiners, BracesRequiredMethods.
+# Configuration parameters: EnforcedStyle, ProceduralMethods, FunctionalMethods, AllowedMethods, AllowedPatterns, AllowBracesOnProceduralOneLiners, BracesRequiredMethods.
 # SupportedStyles: line_count_based, semantic, braces_for_chaining, always_braces
 # ProceduralMethods: benchmark, bm, bmbm, create, each_with_object, measure, new, realtime, tap, with_object
 # FunctionalMethods: let, let!, subject, watch
@@ -1463,7 +1455,7 @@ Style/ClassCheck:
 
 # Offense count: 2
 # This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: AllowedMethods, AllowedPatterns, IgnoredMethods.
+# Configuration parameters: AllowedMethods, AllowedPatterns.
 # AllowedMethods: ==, equal?, eql?
 Style/ClassEqualityComparison:
   Exclude:
@@ -1497,13 +1489,12 @@ Style/CommentedKeyword:
     - 'lib/apipie/dsl_definition.rb'
     - 'lib/apipie/extractor/recorder.rb'
 
-# Offense count: 9
+# Offense count: 8
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: EnforcedStyle, SingleLineConditionsOnly, IncludeTernaryExpressions.
 # SupportedStyles: assign_to_condition, assign_inside_condition
 Style/ConditionalAssignment:
   Exclude:
-    - 'app/controllers/apipie/apipies_controller.rb'
     - 'lib/apipie/extractor/writer.rb'
     - 'lib/apipie/param_description.rb'
     - 'lib/apipie/response_description.rb'
@@ -1541,7 +1532,7 @@ Style/EmptyElse:
     - 'lib/apipie/extractor/recorder.rb'
     - 'lib/apipie/extractor/writer.rb'
 
-# Offense count: 26
+# Offense count: 27
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: EnforcedStyle.
 # SupportedStyles: compact, expanded
@@ -1594,12 +1585,13 @@ Style/For:
 
 # Offense count: 7
 # This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: MaxUnannotatedPlaceholdersAllowed, AllowedMethods, AllowedPatterns, IgnoredMethods.
+# Configuration parameters: MaxUnannotatedPlaceholdersAllowed, AllowedMethods, AllowedPatterns.
 # SupportedStyles: annotated, template, unannotated
+# AllowedMethods: redirect
 Style/FormatStringToken:
   EnforcedStyle: template
 
-# Offense count: 33
+# Offense count: 31
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: MinBodyLength, AllowConsecutiveConditionals.
 Style/GuardClause:
@@ -1664,7 +1656,7 @@ Style/Lambda:
 
 # Offense count: 2
 # This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: AllowedMethods, AllowedPatterns, IgnoredMethods.
+# Configuration parameters: AllowedMethods, AllowedPatterns.
 Style/MethodCallWithoutArgsParentheses:
   Exclude:
     - 'lib/apipie/extractor/recorder.rb'
@@ -1783,7 +1775,6 @@ Style/Proc:
 Style/RaiseArgs:
   Exclude:
     - 'lib/apipie/application.rb'
-    - 'lib/apipie/dsl_definition.rb'
     - 'lib/apipie/extractor/writer.rb'
     - 'lib/apipie/param_description.rb'
     - 'lib/apipie/see_description.rb'
@@ -1834,7 +1825,7 @@ Style/RedundantPercentQ:
   Exclude:
     - 'apipie-rails.gemspec'
 
-# Offense count: 29
+# Offense count: 27
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: AllowMultipleReturnValues.
 Style/RedundantReturn:
@@ -1895,12 +1886,11 @@ Style/Semicolon:
   Exclude:
     - 'lib/apipie/method_description.rb'
 
-# Offense count: 2
+# Offense count: 1
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: AllowIfMethodIsEmpty.
 Style/SingleLineMethods:
   Exclude:
-    - 'lib/apipie/resource_description.rb'
     - 'lib/apipie/tag_list_description.rb'
 
 # Offense count: 6
@@ -1936,7 +1926,7 @@ Style/StringConcatenation:
     - 'lib/apipie/application.rb'
     - 'lib/apipie/extractor/writer.rb'
 
-# Offense count: 1196
+# Offense count: 1212
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: EnforcedStyle, ConsistentQuotesInMultiline.
 # SupportedStyles: single_quotes, double_quotes
@@ -2020,7 +2010,7 @@ Style/StringLiterals:
     - 'spec/support/rake.rb'
     - 'spec/test_engine/memes_controller_spec.rb'
 
-# Offense count: 35
+# Offense count: 34
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: MinSize.
 # SupportedStyles: percent, brackets

data/.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+  "rubyLsp.bundleGemfile": "gemfiles/Gemfile.tools"
+}

data/CHANGELOG.md

@@ -1,8 +1,25 @@
  Changelog
 ===========
 
-Also deleted the `Gemfile` that was now a broken symlink.
-please use `export BUNDLE_GEMFILE='gemfiles/Gemfile.rails61'; bundle exec rspec` to run the test suite
+## [v1.2.1](https://github.com/Apipie/apipie-rails/tree/v1.2.1) (2023-06-09)
+[Full Changelog](https://github.com/Apipie/apipie-rails/compare/v1.2.0...v1.2.1)
+* rspec: Fixes deprecated matcher ([#882](https://github.com/Apipie/apipie-rails/pull/882)) (David Wessman)
+* Fix streaming bug ([#677](https://github.com/Apipie/apipie-rails/pull/677)) (Hunter Braun)
+* Update README URLs based on HTTP redirects ([#448](https://github.com/Apipie/apipie-rails/pull/448)) (ReadmeCritic)
+* Swagger: Adds option to skip default tags ([#881](https://github.com/Apipie/apipie-rails/pull/881)) (David Wessman)
+* Parameter validation: Raises error for all missing ([#886](https://github.com/Apipie/apipie-rails/pull/886)) (David Wessman)
+
+## [v1.2.0](https://github.com/Apipie/apipie-rails/tree/v1.2.0) (2023-06-03)
+[Full Changelog](https://github.com/Apipie/apipie-rails/compare/v1.1.0...v1.2.0)
+* Allow resource_name to be inherited ([#872](https://github.com/Apipie/apipie-rails/pull/872)) (Eric Hankins)
+* Fix cache rendering with namespaced resources ([#874](https://github.com/Apipie/apipie-rails/pull/874)) (Eric Hankins)
+* Fix deprecated content_type on Rails >= 6 ([#879](https://github.com/Apipie/apipie-rails/pull/879)) (Eric Hankins)
+* Fix typo in Collector ([#877](https://github.com/Apipie/apipie-rails/pull/877)) (Eric Hankins)
+* Fix error climbing controller hierarchy ([#875](https://github.com/Apipie/apipie-rails/pull/875)) (Eric Hankins)
+* Add Gemfile.tools for IDE usage ([#876](https://github.com/Apipie/apipie-rails/pull/876)) (Eric Hankins)
+* Fix rubocop ([#883](https://github.com/Apipie/apipie-rails/pull/883)) (Mathieu Jobin)
+* Performance/InefficientHashSearch-20230602233137 ([#884](https://github.com/Apipie/apipie-rails/pull/884)) (RuboCop challenger)
+* Redo Github action script to not need individual gemfiles ([#885](https://github.com/Apipie/apipie-rails/pull/885)) (Mathieu Jobin)
 
 ## [v1.1.0](https://github.com/Apipie/apipie-rails/tree/v1.1.0) (2023-05-16)
 [Full Changelog](https://github.com/Apipie/apipie-rails/compare/v1.0.0...v1.1.0)

data/Gemfile

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec path: '.'
+
+# use ENV vars, with default value as fallback for local setup
+ruby(ENV['RUBY_VERSION'] || '3.2.2')
+gem 'actionpack', "~> #{ENV['RAILS_VERSION'] || '7.0'}.0"
+gem 'activesupport', "~> #{ENV['RAILS_VERSION'] || '7.0'}.0"
+
+gem 'mime-types' # , '~> 3.0'
+gem 'rails-controller-testing'
+gem 'rspec-rails' # , '~> 5.0'
+
+# net-smtp not included by default in Ruby 3.1
+# Will be fixed by https://github.com/mikel/mail/pull/1439
+gem 'net-smtp', require: false if Gem.ruby_version >= Gem::Version.new('3.1.0')
+
+gem 'test_engine', path: './spec/dummy/components/test_engine', group: :test

data/README.rst

@@ -56,7 +56,7 @@ Run your application and see the result at
 use ``http://localhost:3000/apipie.json``.
 
 For a more comprehensive getting started guide, see
-`this demo <https://github.com/iNecas/apipie-demo>`_, which includes
+`this demo <https://github.com/Apipie/apipie-demo>`_, which includes
 features such as generating documentation from tests, recording examples etc.
 
 Screenshots
@@ -78,7 +78,7 @@ See `Contributors page  <https://github.com/Apipie/apipie-rails/graphs/contribut
 License
 -------
 
-Apipie-rails is released under the `MIT License <http://opensource.org/licenses/MIT>`_
+Apipie-rails is released under the `MIT License <https://opensource.org/licenses/MIT>`_
 
 ===============
  Documentation
@@ -108,6 +108,10 @@ resource_id
 name
   Human readable name of resource. By default ``class.name.humanize`` is used.
 
+  - Can be specified as a proc, which will receive the controller class as an argument.
+  - Can be a symbol, which will be sent to the controller class to get the name.
+  - Can be a string, which will be used as is.
+
 short (also short_description)
   Short description of the resource (it's shown on both the list of resources, and resource details)
 
@@ -1180,7 +1184,7 @@ Here is an example of how to rescue and process a +ParamMissing+ or
 +ParamInvalid+ error from within the ApplicationController.
 
 .. code:: ruby
-  
+
   class ApplicationController < ActionController::Base
 
     # ParamError is superclass of ParamMissing, ParamInvalid
@@ -1726,6 +1730,9 @@ There are several configuration parameters that determine the structure of the g
     See [https://swagger.io/docs/specification/2-0/authentication/] for details of what values can be specified
     By default, no security is defined.
 
+``config.generator.swagger.skip_default_tags``
+    By setting ``false`` (default): The resource name for e.g. ``/pets/{petId}`` will automatically be added as a tag ``pets``.
+    By setting ``true``: The tags needs to be explicitly added to the resource using the DSL.
 
 Known limitations of the current implementation
 -------------------------------------------------
@@ -1925,14 +1932,10 @@ And if you write one on your own, don't hesitate to share it with us!
  Contributing
 ====================
 
-Since this gem does not have a Gemfile, you need to specify it in your shell with:
-
-.. code:: shell
-   BUNDLE_GEMFILE='gemfiles/Gemfile.rails61'
-
 Then, you can install dependencies and run the test suite:
 
 .. code:: shell
+
    > bundle install
    > bundle exec rspec
 
@@ -1940,7 +1943,7 @@ Then, you can install dependencies and run the test suite:
  Disqus Integration
 ====================
 
-You can setup `Disqus <http://www.disqus.com>`_ discussion within
+You can setup `Disqus <https://disqus.com/>`_ discussion within
 your documentation. Just set the credentials in the Apipie
 configuration:
 

data/app/controllers/apipie/apipies_controller.rb

@@ -154,26 +154,12 @@ module Apipie
 
     def render_from_cache
       path = Apipie.configuration.doc_base_url.dup
-      # some params can contain dot, but only one in row
-      if [:resource, :method, :format, :version].any? { |p| params[p].to_s.gsub(".", "") =~ /\W/ || params[p].to_s.include?('..') }
-        head :bad_request and return
-      end
-
       path << "/" << params[:version] if params[:version].present?
       path << "/" << params[:resource] if params[:resource].present?
       path << "/" << params[:method] if params[:method].present?
-      if params[:format].present?
-        path << ".#{params[:format]}"
-      else
-        path << ".html"
-      end
-
-      # we sanitize the params before so in ideal case, this condition
-      # will be never satisfied. It's here for cases somebody adds new
-      # param into the path later and forgets about sanitation.
-      if path.include?('..')
-        head :bad_request and return
-      end
+      # Sanitize path against directory traversal attacks (e.g. ../../foo)
+      # by turning path into an absolute path before appending it to the cache dir
+      path = File.expand_path("#{path}.#{request.format.symbol}", '/')
 
       cache_file = File.join(Apipie.configuration.cache_dir, path)
       if File.exist?(cache_file)

data/gemfiles/Gemfile.tools

@@ -0,0 +1,9 @@
+# This Gemfile is used for IDEs like VS Code that need specific gems installed
+# for their tools to work properly. It is not used for the application itself.
+
+source 'https://rubygems.org'
+
+gem 'rubocop-rails'
+gem 'rubocop-rspec'
+gem 'rubocop-performance'
+gem 'ruby-lsp', '~> 0.5.1'

data/lib/apipie/application.rb

@@ -122,15 +122,26 @@ module Apipie
     # resource_description? It's used to derivate the default value of
     # versions for methods.
     def controller_versions(controller)
-      ret = @controller_versions[controller.to_s]
-      return ret unless ret.empty?
-      if controller == ActionController::Base || controller.nil?
-        return [Apipie.configuration.default_version]
-      else
-        return controller_versions(controller.to_s.constantize.superclass)
+      value_from_parents(controller, default: [Apipie.configuration.default_version]) do |c|
+        ret = @controller_versions[c.to_s]
+        ret unless ret.empty?
       end
     end
 
+    # Recursively walks up the controller hierarchy looking for a value
+    # from the block.
+    # Stops at ActionController::Base.
+    # @param [Class] controller controller to start from
+    # @param [Array] args arguments passed to the block
+    # @param [Object] default default value to return if no value is found
+    # @param [Proc] block block to call with controller and args
+    def value_from_parents(controller, *args, default: nil, &block)
+      return default if controller == ActionController::Base || controller == AbstractController::Base || controller.nil?
+
+      thing = yield(controller, *args)
+      thing || value_from_parents(controller.superclass, *args, default: default, &block)
+    end
+
     def set_controller_versions(controller, versions)
       @controller_versions[controller.to_s] = versions
     end
@@ -443,7 +454,7 @@ module Apipie
     end
 
     def version_prefix(klass)
-      version = controller_versions(klass.to_s).first
+      version = controller_versions(klass).first
       base_url = get_base_url(version)
       return "/" if base_url.blank?
       base_url[1..-1] + "/"