apipie-rails 1.5.0 → 1.5.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: ac4c24841aa8ff06fd2d1b86ee4ab64ff873a531adb5bdd0e1d7e9f39cfd0072
4
- data.tar.gz: 81896d38d3352ae7f9f77a24cbe193f9568c9b470302ecc69a2dfc2a3838a628
3
+ metadata.gz: baf45fb6178ea4ae804300d54415680c2b7d86c465f5147f5b4091202d585c53
4
+ data.tar.gz: 9af8578adfde5145b007bc648b0d7c997d04da6de8a709ce28e3bfeaa605fd5f
5
5
  SHA512:
6
- metadata.gz: 273e9bf75332d36f83ce0bf37a05ddb70d710557e995ef09f7789d45d251193304b204a861e3eb76421d0a66396966ec8c09ae6e32152ecaaddf001b7ab9cf74
7
- data.tar.gz: 4da0ec44eb77de5d88f96cf20a43a38770d86c7f28d9bd53ce8ade4177e2f29592baaa9a8e5ce5d834d3b5fa48f4280b3188c9786f2d5a827b93961d309058e9
6
+ metadata.gz: febcfbe9d521c0b45fd4895acf1b649b2b6e5f1bb4dc1e8624cd950f4ed05b665b5e60daa79b70749601ba5d0e1573dcffa601c35ece37814ce55ec36f3d7514
7
+ data.tar.gz: 23c8d22754237c3ed79a3b92cbc9d9a7e3a8d11715985cdd9bfbe1fa39f98d82001a7e0b28b63d19c37558b3f78d75f0987b2f3f4459fca8be9bd53f56b7c0cb
data/.rubocop.yml CHANGED
@@ -1,4 +1,4 @@
1
- require:
1
+ plugins:
2
2
  - rubocop-rails
3
3
  - rubocop-rspec
4
4
  - rubocop-rspec_rails
@@ -58,7 +58,7 @@ Metrics/BlockLength:
58
58
  - lib/tasks/apipie.rake
59
59
  - lib/apipie/swagger_generator.rb
60
60
 
61
- Naming/PredicateName:
61
+ Naming/PredicatePrefix:
62
62
  AllowedMethods:
63
63
  - have_field?
64
64
 
data/.rubocop_todo.yml CHANGED
@@ -1,6 +1,6 @@
1
1
  # This configuration was generated by
2
2
  # `rubocop --auto-gen-config --exclude-limit 180`
3
- # on 2024-07-10 23:53:15 UTC using RuboCop version 1.65.0.
3
+ # on 2026-04-14 07:12:28 UTC using RuboCop version 1.86.1.
4
4
  # The point is for the user to remove these configuration records
5
5
  # one by one as the offenses are removed from the code base.
6
6
  # Note that changes in the inspected code, or installation of new
@@ -8,47 +8,37 @@
8
8
 
9
9
  # Offense count: 1
10
10
  # This cop supports safe autocorrection (--autocorrect).
11
- # Configuration parameters: Severity, Include.
12
- # Include: **/*.gemspec
13
11
  Gemspec/DeprecatedAttributeAssignment:
14
12
  Exclude:
15
13
  - 'apipie-rails.gemspec'
16
14
 
17
15
  # Offense count: 12
18
- # Configuration parameters: EnforcedStyle, AllowedGems, Include.
16
+ # Configuration parameters: EnforcedStyle, AllowedGems.
19
17
  # SupportedStyles: Gemfile, gems.rb, gemspec
20
- # Include: **/*.gemspec, **/Gemfile, **/gems.rb
21
18
  Gemspec/DevelopmentDependencies:
22
19
  Exclude:
23
20
  - 'apipie-rails.gemspec'
24
21
 
25
22
  # Offense count: 2
26
23
  # This cop supports safe autocorrection (--autocorrect).
27
- # Configuration parameters: TreatCommentsAsGroupSeparators, ConsiderPunctuation, Include.
28
- # Include: **/*.gemspec
24
+ # Configuration parameters: TreatCommentsAsGroupSeparators, ConsiderPunctuation.
29
25
  Gemspec/OrderedDependencies:
30
26
  Exclude:
31
27
  - 'apipie-rails.gemspec'
32
28
 
33
29
  # Offense count: 2
34
30
  # This cop supports safe autocorrection (--autocorrect).
35
- # Configuration parameters: Severity, Include.
36
- # Include: **/*.gemspec
37
31
  Gemspec/RequireMFA:
38
32
  Exclude:
39
33
  - 'apipie-rails.gemspec'
40
34
  - 'spec/dummy/components/test_engine/test_engine.gemspec'
41
35
 
42
36
  # Offense count: 1
43
- # Configuration parameters: Severity, Include.
44
- # Include: **/*.gemspec
45
37
  Gemspec/RequiredRubyVersion:
46
38
  Exclude:
47
39
  - 'spec/dummy/components/test_engine/test_engine.gemspec'
48
40
 
49
41
  # Offense count: 1
50
- # Configuration parameters: Severity, Include.
51
- # Include: **/*.gemspec
52
42
  Gemspec/RubyVersionGlobalsUsage:
53
43
  Exclude:
54
44
  - 'apipie-rails.gemspec'
@@ -94,7 +84,7 @@ Layout/CommentIndentation:
94
84
 
95
85
  # Offense count: 1
96
86
  # This cop supports safe autocorrection (--autocorrect).
97
- # Configuration parameters: EnforcedStyleAlignWith, Severity.
87
+ # Configuration parameters: EnforcedStyleAlignWith.
98
88
  # SupportedStylesAlignWith: start_of_line, def
99
89
  Layout/DefEndAlignment:
100
90
  Exclude:
@@ -125,7 +115,7 @@ Layout/ElseAlignment:
125
115
  - 'lib/apipie/param_description.rb'
126
116
  - 'lib/apipie/resource_description.rb'
127
117
 
128
- # Offense count: 59
118
+ # Offense count: 60
129
119
  # This cop supports safe autocorrection (--autocorrect).
130
120
  Layout/EmptyLineAfterGuardClause:
131
121
  Exclude:
@@ -161,7 +151,7 @@ Layout/EmptyLineBetweenDefs:
161
151
  - 'spec/dummy/app/controllers/pets_using_auto_views_controller.rb'
162
152
  - 'spec/dummy/app/controllers/pets_using_self_describing_classes_controller.rb'
163
153
 
164
- # Offense count: 54
154
+ # Offense count: 55
165
155
  # This cop supports safe autocorrection (--autocorrect).
166
156
  Layout/EmptyLines:
167
157
  Exclude:
@@ -258,7 +248,7 @@ Layout/EmptyLinesAroundClassBody:
258
248
  - 'spec/dummy/app/controllers/users_controller.rb'
259
249
  - 'spec/dummy/config/initializers/apipie.rb'
260
250
 
261
- # Offense count: 6
251
+ # Offense count: 7
262
252
  # This cop supports safe autocorrection (--autocorrect).
263
253
  Layout/EmptyLinesAroundMethodBody:
264
254
  Exclude:
@@ -293,7 +283,7 @@ Layout/EmptyLinesAroundModuleBody:
293
283
 
294
284
  # Offense count: 8
295
285
  # This cop supports safe autocorrection (--autocorrect).
296
- # Configuration parameters: EnforcedStyleAlignWith, Severity.
286
+ # Configuration parameters: EnforcedStyleAlignWith.
297
287
  # SupportedStylesAlignWith: keyword, variable, start_of_line
298
288
  Layout/EndAlignment:
299
289
  Exclude:
@@ -370,7 +360,8 @@ Layout/IndentationConsistency:
370
360
 
371
361
  # Offense count: 14
372
362
  # This cop supports safe autocorrection (--autocorrect).
373
- # Configuration parameters: Width, AllowedPatterns.
363
+ # Configuration parameters: Width, EnforcedStyleAlignWith, AllowedPatterns.
364
+ # SupportedStylesAlignWith: start_of_line, relative_to_receiver
374
365
  Layout/IndentationWidth:
375
366
  Exclude:
376
367
  - 'app/controllers/apipie/apipies_controller.rb'
@@ -385,7 +376,7 @@ Layout/IndentationWidth:
385
376
 
386
377
  # Offense count: 15
387
378
  # This cop supports safe autocorrection (--autocorrect).
388
- # Configuration parameters: AllowDoxygenCommentStyle, AllowGemfileRubyComment.
379
+ # Configuration parameters: AllowDoxygenCommentStyle, AllowGemfileRubyComment, AllowRBSInlineAnnotation, AllowSteepAnnotation.
389
380
  Layout/LeadingCommentSpace:
390
381
  Exclude:
391
382
  - 'lib/apipie/dsl_definition.rb'
@@ -572,7 +563,7 @@ Layout/SpaceInsideParens:
572
563
  - 'spec/lib/apipie/method_description/apis_service_spec.rb'
573
564
  - 'spec/lib/swagger/swagger_dsl_spec.rb'
574
565
 
575
- # Offense count: 14
566
+ # Offense count: 13
576
567
  # This cop supports safe autocorrection (--autocorrect).
577
568
  # Configuration parameters: EnforcedStyle.
578
569
  # SupportedStyles: final_newline, final_blank_line
@@ -586,7 +577,6 @@ Layout/TrailingEmptyLines:
586
577
  - 'spec/dummy/app/controllers/pets_controller.rb'
587
578
  - 'spec/dummy/app/controllers/pets_using_self_describing_classes_controller.rb'
588
579
  - 'spec/dummy/app/controllers/tagged_dogs_controller.rb'
589
- - 'spec/dummy/config/boot.rb'
590
580
  - 'spec/dummy/config/environments/development.rb'
591
581
  - 'spec/dummy/config/initializers/secret_token.rb'
592
582
  - 'spec/lib/apipie/generator/swagger/operation_id_spec.rb'
@@ -678,12 +668,6 @@ Lint/SendWithMixinArgument:
678
668
  - 'lib/apipie/routing.rb'
679
669
  - 'spec/dummy/config/application.rb'
680
670
 
681
- # Offense count: 2
682
- Lint/ShadowingOuterLocalVariable:
683
- Exclude:
684
- - 'lib/apipie/extractor/writer.rb'
685
- - 'lib/apipie/swagger_generator.rb'
686
-
687
671
  # Offense count: 4
688
672
  # This cop supports safe autocorrection (--autocorrect).
689
673
  Lint/ToJSON:
@@ -702,7 +686,7 @@ Lint/UnderscorePrefixedVariableName:
702
686
 
703
687
  # Offense count: 22
704
688
  # This cop supports safe autocorrection (--autocorrect).
705
- # Configuration parameters: AutoCorrect, IgnoreEmptyBlocks, AllowUnusedKeywordArguments.
689
+ # Configuration parameters: IgnoreEmptyBlocks, AllowUnusedKeywordArguments.
706
690
  Lint/UnusedBlockArgument:
707
691
  Exclude:
708
692
  - 'lib/apipie/configuration.rb'
@@ -717,7 +701,8 @@ Lint/UnusedBlockArgument:
717
701
 
718
702
  # Offense count: 24
719
703
  # This cop supports safe autocorrection (--autocorrect).
720
- # Configuration parameters: AutoCorrect, AllowUnusedKeywordArguments, IgnoreEmptyMethods, IgnoreNotImplementedMethods.
704
+ # Configuration parameters: AllowUnusedKeywordArguments, IgnoreEmptyMethods, IgnoreNotImplementedMethods, NotImplementedExceptions.
705
+ # NotImplementedExceptions: NotImplementedError
721
706
  Lint/UnusedMethodArgument:
722
707
  Exclude:
723
708
  - 'lib/apipie/dsl_definition.rb'
@@ -727,8 +712,7 @@ Lint/UnusedMethodArgument:
727
712
  - 'spec/support/custom_bool_validator.rb'
728
713
 
729
714
  # Offense count: 5
730
- # This cop supports unsafe autocorrection (--autocorrect-all).
731
- # Configuration parameters: AutoCorrect.
715
+ # This cop supports safe autocorrection (--autocorrect).
732
716
  Lint/UselessAssignment:
733
717
  Exclude:
734
718
  - 'lib/apipie/application.rb'
@@ -736,35 +720,22 @@ Lint/UselessAssignment:
736
720
  - 'lib/apipie/method_description.rb'
737
721
  - 'spec/controllers/api/v1/architectures_controller_spec.rb'
738
722
 
739
- # Offense count: 2
740
- # This cop supports unsafe autocorrection (--autocorrect-all).
741
- # Configuration parameters: AutoCorrect.
742
- Lint/UselessMethodDefinition:
743
- Exclude:
744
- - 'spec/dummy/app/controllers/overridden_concerns_controller.rb'
745
-
746
- # Offense count: 4
723
+ # Offense count: 3
747
724
  # This cop supports safe autocorrection (--autocorrect).
748
- # Configuration parameters: AutoCorrect, CheckForMethodsWithNoSideEffects.
725
+ # Configuration parameters: CheckForMethodsWithNoSideEffects.
749
726
  Lint/Void:
750
727
  Exclude:
751
728
  - 'spec/controllers/users_controller_spec.rb'
752
- - 'spec/lib/swagger/swagger_dsl_spec.rb'
753
729
 
754
730
  # Offense count: 60
755
731
  # Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes.
756
732
  Metrics/AbcSize:
757
733
  Max: 96
758
734
 
759
- # Offense count: 1
760
- # Configuration parameters: CountBlocks, CountModifierForms.
761
- Metrics/BlockNesting:
762
- Max: 4
763
-
764
735
  # Offense count: 25
765
736
  # Configuration parameters: AllowedMethods, AllowedPatterns.
766
737
  Metrics/CyclomaticComplexity:
767
- Max: 24
738
+ Max: 22
768
739
 
769
740
  # Offense count: 79
770
741
  # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
@@ -774,7 +745,7 @@ Metrics/MethodLength:
774
745
  # Offense count: 1
775
746
  # Configuration parameters: CountComments, CountAsOne.
776
747
  Metrics/ModuleLength:
777
- Max: 119
748
+ Max: 117
778
749
 
779
750
  # Offense count: 5
780
751
  # Configuration parameters: CountKeywordArgs.
@@ -835,13 +806,27 @@ Naming/MethodParameterName:
835
806
  - 'lib/apipie/method_description.rb'
836
807
  - 'spec/controllers/users_controller_spec.rb'
837
808
 
809
+ # Offense count: 15
810
+ # Configuration parameters: Mode, AllowedMethods, AllowedPatterns, AllowBangMethods, WaywardPredicates.
811
+ # AllowedMethods: call
812
+ # WaywardPredicates: infinite?, nonzero?
813
+ Naming/PredicateMethod:
814
+ Exclude:
815
+ - 'app/controllers/apipie/apipies_controller.rb'
816
+ - 'lib/apipie/response_description.rb'
817
+ - 'lib/apipie/static_dispatcher.rb'
818
+ - 'lib/apipie/validator.rb'
819
+ - 'spec/dummy/config/initializers/apipie.rb'
820
+ - 'spec/spec_helper.rb'
821
+ - 'spec/support/custom_bool_validator.rb'
822
+
838
823
  # Offense count: 7
839
- # Configuration parameters: NamePrefix, ForbiddenPrefixes, AllowedMethods, MethodDefinitionMacros.
840
- # NamePrefix: is_, has_, have_
841
- # ForbiddenPrefixes: is_, has_, have_
824
+ # Configuration parameters: NamePrefix, ForbiddenPrefixes, AllowedMethods, MethodDefinitionMacros, UseSorbetSigs.
825
+ # NamePrefix: is_, has_, have_, does_
826
+ # ForbiddenPrefixes: is_, has_, have_, does_
842
827
  # AllowedMethods: is_a?
843
828
  # MethodDefinitionMacros: define_method, define_singleton_method
844
- Naming/PredicateName:
829
+ Naming/PredicatePrefix:
845
830
  Exclude:
846
831
  - 'lib/apipie/param_description.rb'
847
832
  - 'lib/apipie/response_description.rb'
@@ -851,7 +836,7 @@ Naming/PredicateName:
851
836
  # Offense count: 1
852
837
  # Configuration parameters: EnforcedStyle, CheckMethodNames, CheckSymbols, AllowedIdentifiers, AllowedPatterns.
853
838
  # SupportedStyles: snake_case, normalcase, non_integer
854
- # AllowedIdentifiers: capture3, iso8601, rfc1123_date, rfc822, rfc2822, rfc3339, x86_64
839
+ # AllowedIdentifiers: TLS1_1, TLS1_2, capture3, iso8601, rfc1123_date, rfc822, rfc2822, rfc3339, x86_64
855
840
  Naming/VariableNumber:
856
841
  Exclude:
857
842
  - 'spec/dummy/app/controllers/users_controller.rb'
@@ -941,7 +926,7 @@ RSpec/BeforeAfterAll:
941
926
  Exclude:
942
927
  - 'spec/controllers/users_controller_spec.rb'
943
928
 
944
- # Offense count: 54
929
+ # Offense count: 57
945
930
  # Configuration parameters: Prefixes, AllowedPatterns.
946
931
  # Prefixes: when, with, without
947
932
  RSpec/ContextWording:
@@ -991,7 +976,6 @@ RSpec/DescribedClass:
991
976
 
992
977
  # Offense count: 1
993
978
  # This cop supports unsafe autocorrection (--autocorrect-all).
994
- # Configuration parameters: AutoCorrect.
995
979
  RSpec/EmptyExampleGroup:
996
980
  Exclude:
997
981
  - 'spec/lib/apipie/generator/swagger/param_description/composite_spec.rb'
@@ -1015,7 +999,7 @@ RSpec/EmptyLineAfterHook:
1015
999
  Exclude:
1016
1000
  - 'spec/lib/apipie/apipies_controller_spec.rb'
1017
1001
 
1018
- # Offense count: 55
1002
+ # Offense count: 56
1019
1003
  # Configuration parameters: CountAsOne.
1020
1004
  RSpec/ExampleLength:
1021
1005
  Max: 85
@@ -1041,7 +1025,6 @@ RSpec/HookArgument:
1041
1025
 
1042
1026
  # Offense count: 3
1043
1027
  # This cop supports safe autocorrection (--autocorrect).
1044
- # Configuration parameters: AutoCorrect.
1045
1028
  RSpec/HooksBeforeExamples:
1046
1029
  Exclude:
1047
1030
  - 'spec/controllers/users_controller_spec.rb'
@@ -1088,12 +1071,12 @@ RSpec/MessageSpies:
1088
1071
  RSpec/MultipleExpectations:
1089
1072
  Max: 19
1090
1073
 
1091
- # Offense count: 170
1074
+ # Offense count: 176
1092
1075
  # Configuration parameters: AllowSubject.
1093
1076
  RSpec/MultipleMemoizedHelpers:
1094
1077
  Max: 15
1095
1078
 
1096
- # Offense count: 85
1079
+ # Offense count: 89
1097
1080
  # Configuration parameters: EnforcedStyle, IgnoreSharedExamples.
1098
1081
  # SupportedStyles: always, named_only
1099
1082
  RSpec/NamedSubject:
@@ -1113,7 +1096,7 @@ RSpec/NamedSubject:
1113
1096
  - 'spec/lib/swagger/rake_swagger_spec.rb'
1114
1097
  - 'spec/lib/swagger/swagger_dsl_spec.rb'
1115
1098
 
1116
- # Offense count: 99
1099
+ # Offense count: 105
1117
1100
  # Configuration parameters: AllowedGroups.
1118
1101
  RSpec/NestedGroups:
1119
1102
  Max: 6
@@ -1133,6 +1116,12 @@ RSpec/NotToNot:
1133
1116
  Exclude:
1134
1117
  - 'spec/lib/apipie/file_handler_spec.rb'
1135
1118
 
1119
+ # Offense count: 17
1120
+ # This cop supports unsafe autocorrection (--autocorrect-all).
1121
+ RSpec/Output:
1122
+ Exclude:
1123
+ - 'spec/lib/swagger/swagger_dsl_spec.rb'
1124
+
1136
1125
  # Offense count: 1
1137
1126
  RSpec/OverwritingSetup:
1138
1127
  Exclude:
@@ -1168,12 +1157,10 @@ RSpec/StubbedMock:
1168
1157
  - 'spec/lib/apipie/extractor/writer_spec.rb'
1169
1158
  - 'spec/lib/apipie/param_description_spec.rb'
1170
1159
 
1171
- # Offense count: 6
1160
+ # Offense count: 2
1172
1161
  # Configuration parameters: IgnoreNameless, IgnoreSymbolicNames.
1173
1162
  RSpec/VerifiedDoubles:
1174
1163
  Exclude:
1175
- - 'spec/lib/apipie/apipies_controller_spec.rb'
1176
- - 'spec/lib/apipie/extractor/recorder_spec.rb'
1177
1164
  - 'spec/lib/apipie/extractor/writer_spec.rb'
1178
1165
  - 'spec/lib/validators/array_validator_spec.rb'
1179
1166
 
@@ -1182,6 +1169,24 @@ RSpec/VoidExpect:
1182
1169
  Exclude:
1183
1170
  - 'spec/lib/apipie/extractor/writer_spec.rb'
1184
1171
 
1172
+ # Offense count: 32
1173
+ # This cop supports safe autocorrection (--autocorrect).
1174
+ RSpecRails/MinitestAssertions:
1175
+ Exclude:
1176
+ - 'spec/controllers/concerns_controller_spec.rb'
1177
+ - 'spec/controllers/users_controller_spec.rb'
1178
+ - 'spec/lib/apipie/apipies_controller_spec.rb'
1179
+
1180
+ # Offense count: 3
1181
+ # This cop supports safe autocorrection (--autocorrect).
1182
+ # Configuration parameters: ExpectedOrder.
1183
+ # ExpectedOrder: index, show, new, edit, create, update, destroy
1184
+ Rails/ActionOrder:
1185
+ Exclude:
1186
+ - 'spec/dummy/app/controllers/overridden_concerns_controller.rb'
1187
+ - 'spec/dummy/app/controllers/twitter_example_controller.rb'
1188
+ - 'spec/dummy/app/controllers/users_controller.rb'
1189
+
1185
1190
  # Offense count: 4
1186
1191
  # This cop supports unsafe autocorrection (--autocorrect-all).
1187
1192
  Rails/ApplicationController:
@@ -1198,14 +1203,13 @@ Rails/Delegate:
1198
1203
  Exclude:
1199
1204
  - 'lib/apipie/response_description_adapter.rb'
1200
1205
 
1201
- # Offense count: 25
1206
+ # Offense count: 24
1202
1207
  # This cop supports safe autocorrection (--autocorrect).
1203
1208
  # Configuration parameters: EnforcedStyle.
1204
1209
  # SupportedStyles: slashes, arguments
1205
1210
  Rails/FilePath:
1206
1211
  Exclude:
1207
1212
  - 'lib/apipie/configuration.rb'
1208
- - 'lib/apipie/dsl_definition.rb'
1209
1213
  - 'lib/tasks/apipie.rake'
1210
1214
  - 'spec/dummy/config/initializers/apipie.rb'
1211
1215
  - 'spec/lib/apipie/apipies_controller_spec.rb'
@@ -1233,15 +1237,14 @@ Rails/NegateInclude:
1233
1237
  - 'lib/apipie/extractor/writer.rb'
1234
1238
  - 'spec/spec_helper.rb'
1235
1239
 
1236
- # Offense count: 6
1240
+ # Offense count: 24
1237
1241
  # This cop supports unsafe autocorrection (--autocorrect-all).
1238
- # Configuration parameters: Include.
1239
- # Include: app/**/*.rb, config/**/*.rb, db/**/*.rb, lib/**/*.rb
1240
1242
  Rails/Output:
1241
1243
  Exclude:
1242
1244
  - 'lib/apipie/apipie_module.rb'
1243
1245
  - 'lib/apipie/extractor.rb'
1244
1246
  - 'lib/apipie/rspec/response_validation_helper.rb'
1247
+ - 'spec/lib/swagger/swagger_dsl_spec.rb'
1245
1248
 
1246
1249
  # Offense count: 2
1247
1250
  Rails/OutputSafety:
@@ -1268,8 +1271,6 @@ Rails/Present:
1268
1271
 
1269
1272
  # Offense count: 1
1270
1273
  # This cop supports unsafe autocorrection (--autocorrect-all).
1271
- # Configuration parameters: Include.
1272
- # Include: **/Rakefile, **/*.rake
1273
1274
  Rails/RakeEnvironment:
1274
1275
  Exclude:
1275
1276
  - 'lib/tasks/apipie.rake'
@@ -1318,10 +1319,12 @@ Style/CaseEquality:
1318
1319
  Exclude:
1319
1320
  - 'lib/apipie/validator.rb'
1320
1321
 
1321
- # Offense count: 43
1322
+ # Offense count: 41
1322
1323
  # This cop supports unsafe autocorrection (--autocorrect-all).
1323
- # Configuration parameters: EnforcedStyle.
1324
+ # Configuration parameters: EnforcedStyle, EnforcedStyleForClasses, EnforcedStyleForModules.
1324
1325
  # SupportedStyles: nested, compact
1326
+ # SupportedStylesForClasses: ~, nested, compact
1327
+ # SupportedStylesForModules: ~, nested, compact
1325
1328
  Style/ClassAndModuleChildren:
1326
1329
  Exclude:
1327
1330
  - 'lib/apipie/core_ext/route.rb'
@@ -1359,7 +1362,6 @@ Style/ClassAndModuleChildren:
1359
1362
  - 'lib/apipie/method_description/api.rb'
1360
1363
  - 'lib/apipie/method_description/apis_service.rb'
1361
1364
  - 'lib/apipie/rspec/response_validation_helper.rb'
1362
- - 'spec/dummy/app/controllers/api/v2/nested/resources_controller.rb'
1363
1365
  - 'spec/dummy/config/initializers/apipie.rb'
1364
1366
  - 'spec/lib/validators/array_validator_spec.rb'
1365
1367
 
@@ -1382,6 +1384,13 @@ Style/ClassEqualityComparison:
1382
1384
  - 'lib/apipie/application.rb'
1383
1385
  - 'lib/apipie/validator.rb'
1384
1386
 
1387
+ # Offense count: 2
1388
+ # This cop supports unsafe autocorrection (--autocorrect-all).
1389
+ Style/CollectionQuerying:
1390
+ Exclude:
1391
+ - 'lib/apipie/generator/swagger/warning_writer.rb'
1392
+ - 'lib/apipie/see_description.rb'
1393
+
1385
1394
  # Offense count: 19
1386
1395
  # This cop supports safe autocorrection (--autocorrect).
1387
1396
  Style/ColonMethodCall:
@@ -1402,7 +1411,7 @@ Style/CommentAnnotation:
1402
1411
  - 'spec/lib/swagger/rake_swagger_spec.rb'
1403
1412
  - 'spec/lib/swagger/swagger_dsl_spec.rb'
1404
1413
 
1405
- # Offense count: 17
1414
+ # Offense count: 3
1406
1415
  # This cop supports unsafe autocorrection (--autocorrect-all).
1407
1416
  Style/CommentedKeyword:
1408
1417
  Exclude:
@@ -1444,7 +1453,7 @@ Style/EmptyCaseCondition:
1444
1453
 
1445
1454
  # Offense count: 3
1446
1455
  # This cop supports safe autocorrection (--autocorrect).
1447
- # Configuration parameters: AutoCorrect, EnforcedStyle, AllowComments.
1456
+ # Configuration parameters: EnforcedStyle, AllowComments.
1448
1457
  # SupportedStyles: empty, nil, both
1449
1458
  Style/EmptyElse:
1450
1459
  Exclude:
@@ -1454,7 +1463,7 @@ Style/EmptyElse:
1454
1463
 
1455
1464
  # Offense count: 27
1456
1465
  # This cop supports safe autocorrection (--autocorrect).
1457
- # Configuration parameters: AutoCorrect, EnforcedStyle.
1466
+ # Configuration parameters: EnforcedStyle.
1458
1467
  # SupportedStyles: compact, expanded
1459
1468
  Style/EmptyMethod:
1460
1469
  Exclude:
@@ -1478,11 +1487,16 @@ Style/Encoding:
1478
1487
 
1479
1488
  # Offense count: 1
1480
1489
  # This cop supports safe autocorrection (--autocorrect).
1481
- # Configuration parameters: AllowedVars.
1490
+ # Configuration parameters: AllowedVars, DefaultToNil.
1482
1491
  Style/FetchEnvVar:
1483
1492
  Exclude:
1484
1493
  - 'lib/tasks/apipie.rake'
1485
1494
 
1495
+ # Offense count: 1
1496
+ Style/FileOpen:
1497
+ Exclude:
1498
+ - 'lib/apipie/dsl_definition.rb'
1499
+
1486
1500
  # Offense count: 1
1487
1501
  # This cop supports safe autocorrection (--autocorrect).
1488
1502
  Style/FileRead:
@@ -1505,7 +1519,7 @@ Style/For:
1505
1519
 
1506
1520
  # Offense count: 7
1507
1521
  # This cop supports safe autocorrection (--autocorrect).
1508
- # Configuration parameters: MaxUnannotatedPlaceholdersAllowed, AllowedMethods, AllowedPatterns.
1522
+ # Configuration parameters: MaxUnannotatedPlaceholdersAllowed, Mode, AllowedMethods, AllowedPatterns.
1509
1523
  # SupportedStyles: annotated, template, unannotated
1510
1524
  # AllowedMethods: redirect
1511
1525
  Style/FormatStringToken:
@@ -1556,7 +1570,7 @@ Style/IfInsideElse:
1556
1570
  # Offense count: 4
1557
1571
  # This cop supports unsafe autocorrection (--autocorrect-all).
1558
1572
  # Configuration parameters: AllowedMethods.
1559
- # AllowedMethods: nonzero?
1573
+ # AllowedMethods: infinite?, nonzero?
1560
1574
  Style/IfWithBooleanLiteralBranches:
1561
1575
  Exclude:
1562
1576
  - 'lib/apipie/param_description.rb'
@@ -1597,6 +1611,12 @@ Style/MissingRespondToMissing:
1597
1611
  Exclude:
1598
1612
  - 'lib/apipie/apipie_module.rb'
1599
1613
 
1614
+ # Offense count: 1
1615
+ # This cop supports safe autocorrection (--autocorrect).
1616
+ Style/ModuleMemberExistenceCheck:
1617
+ Exclude:
1618
+ - 'lib/apipie/dsl_definition.rb'
1619
+
1600
1620
  # Offense count: 1
1601
1621
  Style/MultilineBlockChain:
1602
1622
  Exclude:
@@ -1637,6 +1657,16 @@ Style/NestedParenthesizedCalls:
1637
1657
  Style/NumericLiterals:
1638
1658
  MinDigits: 6
1639
1659
 
1660
+ # Offense count: 5
1661
+ # Configuration parameters: AllowedClasses.
1662
+ Style/OneClassPerFile:
1663
+ Exclude:
1664
+ - 'lib/apipie/core_ext/route.rb'
1665
+ - 'lib/apipie/extractor.rb'
1666
+ - 'lib/apipie/rspec/response_validation_helper.rb'
1667
+ - 'spec/dummy/app/controllers/pets_using_auto_views_controller.rb'
1668
+ - 'spec/dummy/app/controllers/pets_using_self_describing_classes_controller.rb'
1669
+
1640
1670
  # Offense count: 7
1641
1671
  # Configuration parameters: AllowedMethods.
1642
1672
  # AllowedMethods: respond_to_missing?
@@ -1687,6 +1717,12 @@ Style/RaiseArgs:
1687
1717
  - 'lib/apipie/see_description.rb'
1688
1718
  - 'lib/apipie/validator.rb'
1689
1719
 
1720
+ # Offense count: 3
1721
+ # This cop supports unsafe autocorrection (--autocorrect-all).
1722
+ Style/ReduceToHash:
1723
+ Exclude:
1724
+ - 'lib/apipie/generator/swagger/method_description/response_service.rb'
1725
+
1690
1726
  # Offense count: 1
1691
1727
  # This cop supports unsafe autocorrection (--autocorrect-all).
1692
1728
  # Configuration parameters: Methods.
@@ -1702,6 +1738,8 @@ Style/RedundantAssignment:
1702
1738
 
1703
1739
  # Offense count: 1
1704
1740
  # This cop supports safe autocorrection (--autocorrect).
1741
+ # Configuration parameters: AllowedMethods.
1742
+ # AllowedMethods: infinite?, nonzero?
1705
1743
  Style/RedundantCondition:
1706
1744
  Exclude:
1707
1745
  - 'lib/apipie/response_description.rb'
@@ -1720,11 +1758,14 @@ Style/RedundantInterpolation:
1720
1758
  - 'lib/tasks/apipie.rake'
1721
1759
  - 'spec/lib/swagger/rake_swagger_spec.rb'
1722
1760
 
1723
- # Offense count: 1
1761
+ # Offense count: 4
1724
1762
  # This cop supports safe autocorrection (--autocorrect).
1725
1763
  Style/RedundantParentheses:
1726
1764
  Exclude:
1727
1765
  - 'lib/apipie/extractor/collector.rb'
1766
+ - 'lib/apipie/param_description.rb'
1767
+ - 'lib/tasks/apipie.rake'
1768
+ - 'spec/lib/swagger/rake_swagger_spec.rb'
1728
1769
 
1729
1770
  # Offense count: 2
1730
1771
  # This cop supports safe autocorrection (--autocorrect).
@@ -1927,7 +1968,7 @@ Style/SymbolArray:
1927
1968
  # Offense count: 2
1928
1969
  # This cop supports safe autocorrection (--autocorrect).
1929
1970
  # Configuration parameters: EnforcedStyleForMultiline.
1930
- # SupportedStylesForMultiline: comma, consistent_comma, no_comma
1971
+ # SupportedStylesForMultiline: comma, consistent_comma, diff_comma, no_comma
1931
1972
  Style/TrailingCommaInArrayLiteral:
1932
1973
  Exclude:
1933
1974
  - 'spec/controllers/users_controller_spec.rb'
@@ -1936,7 +1977,7 @@ Style/TrailingCommaInArrayLiteral:
1936
1977
  # Offense count: 4
1937
1978
  # This cop supports safe autocorrection (--autocorrect).
1938
1979
  # Configuration parameters: EnforcedStyleForMultiline.
1939
- # SupportedStylesForMultiline: comma, consistent_comma, no_comma
1980
+ # SupportedStylesForMultiline: comma, consistent_comma, diff_comma, no_comma
1940
1981
  Style/TrailingCommaInHashLiteral:
1941
1982
  Exclude:
1942
1983
  - 'lib/apipie/generator/swagger/param_description.rb'
data/CHANGELOG.md CHANGED
@@ -1,5 +1,11 @@
1
1
  Changelog
2
2
  ===========
3
+ ## [v1.5.1](https://github.com/Apipie/apipie-rails/tree/v1.5.1) (2026-06-26)
4
+ [Full Changelog](https://github.com/Apipie/apipie-rails/compare/v1.5.0...v1.5.1)
5
+ * Make rdoc.to_html compatible with rdoc-8.0 [#971](https://github.com/Apipie/apipie-rails/pull/971) (Oleh Fedorenko)
6
+ * Remove rails 8.2 deprecation warnings in `config/routes.rb`. (Panos Dalitsouris)
7
+ * Update `.rubocop_todo.yml` (Panos Dalitsouris)
8
+
3
9
  ## [v1.5.0](https://github.com/Apipie/apipie-rails/tree/v1.5.0) (2025-08-19)
4
10
  [Full Changelog](https://github.com/Apipie/apipie-rails/compare/v1.4.2...v1.5.0)
5
11
  * Don't collect records without an action (Evgeni Golov)
data/lib/apipie/markup.rb CHANGED
@@ -16,10 +16,11 @@ module Apipie
16
16
  private
17
17
 
18
18
  def rdoc
19
- if Gem::Version.new(::RDoc::VERSION) < Gem::Version.new('4.0.0')
20
- ::RDoc::Markup::ToHtml.new()
21
- else
19
+ rdoc_version = Gem::Version.new(::RDoc::VERSION)
20
+ if rdoc_version >= Gem::Version.new('4.0.0') && rdoc_version < Gem::Version.new('8.0.0')
22
21
  ::RDoc::Markup::ToHtml.new(::RDoc::Options.new)
22
+ else
23
+ ::RDoc::Markup::ToHtml.new()
23
24
  end
24
25
  end
25
26
  end
@@ -5,7 +5,7 @@ module Apipie
5
5
  namespace "apipie", :path => Apipie.configuration.doc_base_url do
6
6
  get 'apipie_checksum', :to => "apipies#apipie_checksum", :format => "json"
7
7
  constraints(:version => %r{[^/]+}, :resource => %r{[^/]+}, :method => %r{[^/]+}) do
8
- get(options.reverse_merge("(:version)/(:resource)/(:method)" => "apipies#index", :as => :apipie))
8
+ get "(:version)/(:resource)/(:method)", **options.reverse_merge(to: "apipies#index", as: :apipie)
9
9
  end
10
10
  end
11
11
  end
@@ -1,3 +1,3 @@
1
1
  module Apipie
2
- VERSION = "1.5.0".freeze
2
+ VERSION = "1.5.1".freeze
3
3
  end
@@ -31,25 +31,9 @@
31
31
  },
32
32
  {
33
33
  "cell_type": "code",
34
- "execution_count": 5,
35
- "metadata": {},
36
- "outputs": [
37
- {
38
- "name": "stdout",
39
- "output_type": "stream",
40
- "text": [
41
- "/home/evgeni/Devel/apipie/apipie-rails\n"
42
- ]
43
- },
44
- {
45
- "name": "stderr",
46
- "output_type": "stream",
47
- "text": [
48
- "/usr/lib/python3.13/site-packages/IPython/core/magics/osm.py:417: UserWarning: This is now an optional IPython functionality, setting dhist requires you to install the `pickleshare` library.\n",
49
- " self.shell.db['dhist'] = compress_dhist(dhist)[-100:]\n"
50
- ]
51
- }
52
- ],
34
+ "execution_count": null,
35
+ "metadata": {},
36
+ "outputs": [],
53
37
  "source": [
54
38
  "%cd .."
55
39
  ]
@@ -63,12 +47,12 @@
63
47
  },
64
48
  {
65
49
  "cell_type": "code",
66
- "execution_count": 2,
50
+ "execution_count": null,
67
51
  "metadata": {},
68
52
  "outputs": [],
69
53
  "source": [
70
- "NEW_VERSION = '1.5.0'\n",
71
- "LAST_VERSION = '1.4.2'\n",
54
+ "NEW_VERSION = '0.5.20'\n",
55
+ "LAST_VERSION = '0.5.19'\n",
72
56
  "GIT_REMOTE_UPSTREAM = 'origin'\n",
73
57
  "STABLE_RELEASE = False\n",
74
58
  "WORK_BRANCH = 'stable' if STABLE_RELEASE else 'master'\n",
@@ -165,7 +149,7 @@
165
149
  },
166
150
  {
167
151
  "cell_type": "code",
168
- "execution_count": 7,
152
+ "execution_count": null,
169
153
  "metadata": {},
170
154
  "outputs": [],
171
155
  "source": [
@@ -174,32 +158,9 @@
174
158
  },
175
159
  {
176
160
  "cell_type": "code",
177
- "execution_count": 3,
178
- "metadata": {},
179
- "outputs": [
180
- {
181
- "data": {
182
- "text/markdown": [
183
- "* Don't collect records without an action (Evgeni Golov)\n",
184
- "* Update test matrix: rails 7.2, 8.0, ruby 3.4 [#960](https://github.com/Apipie/apipie-rails/pull/960) (Evgeni Golov)\n",
185
- "* Fix activesupport::deprecation.warn deprecation (Jonathan Biolaz)\n",
186
- "* Rubocop autofix (Evgeni Golov)\n",
187
- "* Update ci workflow to run on ubuntu 24.04 (Evgeni Golov)\n",
188
- "* Fix issue with loading rails logger in tests (Eric Helms)\n",
189
- "* Update link for rdoc in readme (Panos Dalitsouris)\n",
190
- "* Fix the decimalvalidator header in readme.md [#945](https://github.com/Apipie/apipie-rails/pull/945) (Ewoud Kohl van Wijngaarden)\n",
191
- "* Rename render_page in apipie.rake to render_apipie_page [#943](https://github.com/Apipie/apipie-rails/pull/943) (Nathan Palmer)\n",
192
- "* Update it.yml following latest en.yml [#942](https://github.com/Apipie/apipie-rails/pull/942) (Claudio Maradonna)"
193
- ],
194
- "text/plain": [
195
- "<IPython.core.display.Markdown object>"
196
- ]
197
- },
198
- "execution_count": 3,
199
- "metadata": {},
200
- "output_type": "execute_result"
201
- }
202
- ],
161
+ "execution_count": null,
162
+ "metadata": {},
163
+ "outputs": [],
203
164
  "source": [
204
165
  "# Parse git changelog\n",
205
166
  "from IPython.display import Markdown as md\n",
@@ -231,7 +192,7 @@
231
192
  },
232
193
  {
233
194
  "cell_type": "code",
234
- "execution_count": 6,
195
+ "execution_count": null,
235
196
  "metadata": {},
236
197
  "outputs": [],
237
198
  "source": [
@@ -269,7 +230,9 @@
269
230
  {
270
231
  "cell_type": "code",
271
232
  "execution_count": null,
272
- "metadata": {},
233
+ "metadata": {
234
+ "scrolled": false
235
+ },
273
236
  "outputs": [],
274
237
  "source": [
275
238
  "! git add -u\n",
@@ -392,31 +355,9 @@
392
355
  },
393
356
  {
394
357
  "cell_type": "code",
395
- "execution_count": 8,
396
- "metadata": {},
397
- "outputs": [
398
- {
399
- "name": "stdout",
400
- "output_type": "stream",
401
- "text": [
402
- "\n",
403
- "\n",
404
- "* Don't collect records without an action (Evgeni Golov)\n",
405
- "* Update test matrix: rails 7.2, 8.0, ruby 3.4 [#960](https://github.com/Apipie/apipie-rails/pull/960) (Evgeni Golov)\n",
406
- "* Fix activesupport::deprecation.warn deprecation (Jonathan Biolaz)\n",
407
- "* Rubocop autofix (Evgeni Golov)\n",
408
- "* Update ci workflow to run on ubuntu 24.04 (Evgeni Golov)\n",
409
- "* Fix issue with loading rails logger in tests (Eric Helms)\n",
410
- "* Update link for rdoc in readme (Panos Dalitsouris)\n",
411
- "* Fix the decimalvalidator header in readme.md [#945](https://github.com/Apipie/apipie-rails/pull/945) (Ewoud Kohl van Wijngaarden)\n",
412
- "* Rename render_page in apipie.rake to render_apipie_page [#943](https://github.com/Apipie/apipie-rails/pull/943) (Nathan Palmer)\n",
413
- "* Update it.yml following latest en.yml [#942](https://github.com/Apipie/apipie-rails/pull/942) (Claudio Maradonna)\n",
414
- "\n",
415
- "\n",
416
- "https://github.com/Apipie/apipie-rails/releases/new?tag=1.5.0\n"
417
- ]
418
- }
419
- ],
358
+ "execution_count": null,
359
+ "metadata": {},
360
+ "outputs": [],
420
361
  "source": [
421
362
  "print('\\n')\n",
422
363
  "print('\\n'.join(change_log))\n",
@@ -435,7 +376,7 @@
435
376
  ],
436
377
  "metadata": {
437
378
  "kernelspec": {
438
- "display_name": "Python 3 (ipykernel)",
379
+ "display_name": "Python 3",
439
380
  "language": "python",
440
381
  "name": "python3"
441
382
  },
@@ -449,9 +390,9 @@
449
390
  "name": "python",
450
391
  "nbconvert_exporter": "python",
451
392
  "pygments_lexer": "ipython3",
452
- "version": "3.13.6"
393
+ "version": "3.6.8"
453
394
  }
454
395
  },
455
396
  "nbformat": 4,
456
- "nbformat_minor": 4
397
+ "nbformat_minor": 2
457
398
  }
@@ -0,0 +1,25 @@
1
+ require 'spec_helper'
2
+
3
+ RSpec.describe Apipie::Routing::MapperExtensions do
4
+ let(:routes) { ActionDispatch::Routing::RouteSet.new }
5
+ let(:version) { 'v1' }
6
+ let(:resource) { 'users' }
7
+ let(:api_method) { 'show' }
8
+ let(:path) { "/apidoc/#{version}/#{resource}/#{api_method}" }
9
+
10
+ describe '#apipie' do
11
+ before { routes.draw { apipie } }
12
+
13
+ it 'preserves the default route helper and mapping', :aggregate_failures do
14
+ expect(routes.url_helpers.apipie_apipie_path(version: version, resource: resource, method: api_method)).to eq(path)
15
+
16
+ expect(routes.recognize_path(path, method: :get)).to include(
17
+ controller: 'apipie/apipies',
18
+ action: 'index',
19
+ version: version,
20
+ resource: resource,
21
+ method: api_method
22
+ )
23
+ end
24
+ end
25
+ end
data/spec/support/rake.rb CHANGED
@@ -6,6 +6,7 @@ shared_context "rake" do
6
6
  let(:task_name) { rake.parse_task_string(self.class.description).first }
7
7
  let(:task_args) { rake.parse_task_string(self.class.description).last }
8
8
  let(:task_path) { "lib/tasks/apipie" }
9
+
9
10
  subject { rake[task_name] }
10
11
 
11
12
  def loaded_files_excluding_current_rake_file
metadata CHANGED
@@ -1,14 +1,15 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: apipie-rails
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.5.0
4
+ version: 1.5.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Pavel Pokorny
8
8
  - Ivan Necas
9
+ autorequire:
9
10
  bindir: bin
10
11
  cert_chain: []
11
- date: 1980-01-02 00:00:00.000000000 Z
12
+ date: 2026-06-26 00:00:00.000000000 Z
12
13
  dependencies:
13
14
  - !ruby/object:Gem::Dependency
14
15
  name: actionpack
@@ -459,6 +460,7 @@ files:
459
460
  - spec/lib/apipie/response_description/response_object_spec.rb
460
461
  - spec/lib/apipie/response_description_spec.rb
461
462
  - spec/lib/apipie/response_does_not_match_swagger_schema_spec.rb
463
+ - spec/lib/apipie/routing/mapper_extensions_spec.rb
462
464
  - spec/lib/apipie/swagger_generator_spec.rb
463
465
  - spec/lib/apipie/validator_spec.rb
464
466
  - spec/lib/rake_spec.rb
@@ -476,6 +478,7 @@ metadata:
476
478
  bug_tracker_uri: https://github.com/Apipie/apipie-rails/issues
477
479
  changelog_uri: https://github.com/Apipie/apipie-rails/blob/master/CHANGELOG.md
478
480
  source_code_uri: https://github.com/Apipie/apipie-rails
481
+ post_install_message:
479
482
  rdoc_options: []
480
483
  require_paths:
481
484
  - lib
@@ -490,7 +493,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
490
493
  - !ruby/object:Gem::Version
491
494
  version: '0'
492
495
  requirements: []
493
- rubygems_version: 3.6.7
496
+ rubygems_version: 3.2.33
497
+ signing_key:
494
498
  specification_version: 4
495
499
  summary: Rails REST API documentation tool
496
500
  test_files:
@@ -603,6 +607,7 @@ test_files:
603
607
  - spec/lib/apipie/response_description/response_object_spec.rb
604
608
  - spec/lib/apipie/response_description_spec.rb
605
609
  - spec/lib/apipie/response_does_not_match_swagger_schema_spec.rb
610
+ - spec/lib/apipie/routing/mapper_extensions_spec.rb
606
611
  - spec/lib/apipie/swagger_generator_spec.rb
607
612
  - spec/lib/apipie/validator_spec.rb
608
613
  - spec/lib/rake_spec.rb