apipie-rails 1.4.0 → 1.4.1

data/spec/lib/swagger/swagger_dsl_spec.rb

@@ -5,10 +5,10 @@ require 'rspec/expectations'
 describe "Swagger Responses" do
   let(:desc) { Apipie.get_resource_description(controller_class, Apipie.configuration.default_version) }
 
-  let(:swagger) {
+  let(:swagger) do
     Apipie.configuration.generator.swagger.suppress_warnings = true
     Apipie.to_swagger_json(Apipie.configuration.default_version, controller_class.to_s.underscore.sub("_controller", ""))
-  }
+  end
 
   let(:controller_class ) { described_class }
 
@@ -122,7 +122,7 @@ describe "Swagger Responses" do
         desc._methods[:index]
       end
 
-      it "should return code 200 with array of entries of the format {'pet_name', 'animal_type'}" do
+      it "returns code 200 with array of entries of the format {'pet_name', 'animal_type'}" do
         returns_obj = subject.returns.detect{|e| e.code == 200 }
 
         puts returns_obj.to_json
@@ -132,7 +132,7 @@ describe "Swagger Responses" do
         expect(returns_obj).to match_field_structure([:pet_name, :animal_type])
       end
 
-      it 'should have the response described in the swagger' do
+      it 'has the response described in the swagger' do
         response = swagger_response_for('/pets')
         expect(response[:description]).to eq("list of pets")
 
@@ -145,7 +145,7 @@ describe "Swagger Responses" do
       end
 
 
-      it "should return code 401 with a String description field" do
+      it "returns code 401 with a String description field" do
         returns_obj = subject.returns.detect{|e| e.code == 404 }
 
         expect(returns_obj.code).to eq(404)
@@ -155,7 +155,7 @@ describe "Swagger Responses" do
       end
 
 
-      it "should return code 401 with a :reason field (defined in the superclass)" do
+      it "returns code 401 with a :reason field (defined in the superclass)" do
         returns_obj = subject.returns.detect{|e| e.code == 401 }
 
         expect(returns_obj.code).to eq(401)
@@ -164,7 +164,7 @@ describe "Swagger Responses" do
         expect(returns_obj).to match_field_structure([:reason])
       end
 
-      it 'should have the 404 response described in the swagger' do
+      it 'has the 404 response described in the swagger' do
         response = swagger_response_for('/pets', 404)
         expect(response[:description]).to eq("Not Found")
 
@@ -181,7 +181,7 @@ describe "Swagger Responses" do
         desc._methods[:show_plain_response_with_tags]
       end
 
-      it "should return tags with 'Dogs', 'Cats', and 'LivingBeings'" do
+      it "returns tags with 'Dogs', 'Cats', and 'LivingBeings'" do
         returns_obj = subject.tag_list
         puts returns_obj.inspect
 
@@ -194,7 +194,7 @@ describe "Swagger Responses" do
         desc._methods[:show_as_properties]
       end
 
-      it "should return code 200 with 'pet_name' and 'animal_type'" do
+      it "returns code 200 with 'pet_name' and 'animal_type'" do
         returns_obj = subject.returns.detect{|e| e.code == 200 }
 
         puts returns_obj.to_json
@@ -204,7 +204,7 @@ describe "Swagger Responses" do
         expect(returns_obj).to match_field_structure([:pet_name, :animal_type])
       end
 
-      it 'should have the response described in the swagger' do
+      it 'has the response described in the swagger' do
         response = swagger_response_for('/pets/{id}/as_properties')
         expect(response[:description]).to eq("OK")
 
@@ -213,7 +213,7 @@ describe "Swagger Responses" do
         expect(schema).to have_field(:animal_type, 'string', {:description => 'Type of pet', :enum => %w[dog cat iguana kangaroo]})
       end
 
-      it 'should have the 404 response description overridden' do
+      it 'has the 404 response description overridden' do
         returns_obj = subject.returns.detect{|e| e.code == 404 }
 
         # puts returns_obj.to_json
@@ -229,7 +229,7 @@ describe "Swagger Responses" do
         desc._methods[:show_as_param_group_of_properties]
       end
 
-      it "should return code 200 with 'pet_name' and 'animal_type'" do
+      it "returns code 200 with 'pet_name' and 'animal_type'" do
         returns_obj = subject.returns.detect{|e| e.code == 200 }
 
         puts returns_obj.to_json
@@ -241,7 +241,7 @@ describe "Swagger Responses" do
         expect(returns_obj.params_ordered[1].is_required?).to be_truthy
       end
 
-      it 'should have the response described in the swagger' do
+      it 'has the response described in the swagger' do
         response = swagger_response_for('/pets/{id}/as_param_group_of_properties')
         expect(response[:description]).to eq("The pet")
 
@@ -256,7 +256,7 @@ describe "Swagger Responses" do
         desc._methods[:show_pet_by_id]
       end
 
-      it "should have only oauth (from ApplicationController), common_param (from resource) and pet_id as an input parameters" do
+      it "has only oauth (from ApplicationController), common_param (from resource) and pet_id as an input parameters" do
         params_obj = subject.params_ordered
 
         expect(params_obj[0].name).to eq(:oauth)
@@ -264,7 +264,7 @@ describe "Swagger Responses" do
         expect(params_obj[2].name).to eq(:pet_id)
       end
 
-      it "should return code 200 with 'pet_id', pet_name' and 'animal_type'" do
+      it "returns code 200 with 'pet_id', pet_name' and 'animal_type'" do
         returns_obj = subject.returns.detect{|e| e.code == 200 }
 
         puts returns_obj.to_json
@@ -275,7 +275,7 @@ describe "Swagger Responses" do
         expect(returns_obj).to match_field_structure([:pet_id, :pet_name, :animal_type])
       end
 
-      it 'should have the response described in the swagger' do
+      it 'has the response described in the swagger' do
         response = swagger_response_for('/pets/pet_by_id')
         expect(response[:description]).to eq("OK")
 
@@ -283,7 +283,7 @@ describe "Swagger Responses" do
         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
@@ -304,7 +304,7 @@ describe "Swagger Responses" do
         desc._methods[:get_vote_by_owner_name]
       end
 
-      it "should return code 200 with 'owner_name' and 'vote'" do
+      it "returns code 200 with 'owner_name' and 'vote'" do
         returns_obj = subject.returns.detect{|e| e.code == 200 }
 
         puts returns_obj.to_json
@@ -314,7 +314,7 @@ describe "Swagger Responses" do
         expect(returns_obj).to match_field_structure([:owner_name, :vote])
       end
 
-      it 'should have the response described in the swagger' do
+      it 'has the response described in the swagger' do
         response = swagger_response_for('/pets/by_owner_name/did_vote')
         expect(response[:description]).to eq("OK")
 
@@ -329,7 +329,7 @@ describe "Swagger Responses" do
         desc._methods[:show_extra_info]
       end
 
-      it "should return code 201 with 'pet_name' and 'animal_type'" do
+      it "returns code 201 with 'pet_name' and 'animal_type'" do
         returns_obj = subject.returns.detect{|e| e.code == 201 }
 
         puts returns_obj.to_json
@@ -339,7 +339,7 @@ describe "Swagger Responses" do
         expect(returns_obj).to match_field_structure([:pet_name, :animal_type])
       end
 
-      it 'should have the 201 response described in the swagger' do
+      it 'has the 201 response described in the swagger' do
         response = swagger_response_for('/pets/{id}/extra_info', 201)
         expect(response[:description]).to eq("Found a pet")
 
@@ -348,7 +348,7 @@ describe "Swagger Responses" do
         expect(schema).to have_field(:animal_type, 'string')
       end
 
-      it "should return code 202 with spread out 'pet' and encapsulated 'pet_measurements'" do
+      it "returns code 202 with spread out 'pet' and encapsulated 'pet_measurements'" do
         returns_obj = subject.returns.detect{|e| e.code == 202 }
 
         puts returns_obj.to_json
@@ -361,7 +361,7 @@ describe "Swagger Responses" do
                                                      ])
       end
 
-      it 'should have the 202 response described in the swagger' do
+      it 'has the 202 response described in the swagger' do
         response = swagger_response_for('/pets/{id}/extra_info', 202)
         expect(response[:description]).to eq('Accepted')
 
@@ -376,7 +376,7 @@ describe "Swagger Responses" do
         expect(pm_schema).to have_field(:num_legs, 'number', {:description => "Number of legs", :required => false})
       end
 
-      it "should return code 203 with spread out 'pet', encapsulated 'pet_measurements' and encapsulated 'pet_history'" do
+      it "returns code 203 with spread out 'pet', encapsulated 'pet_measurements' and encapsulated 'pet_history'" do
         returns_obj = subject.returns.detect{|e| e.code == 203 }
 
         puts returns_obj.to_json
@@ -391,7 +391,7 @@ describe "Swagger Responses" do
                                                      ])
       end
 
-      it 'should have the 203 response described in the swagger' do
+      it 'has the 203 response described in the swagger' do
         response = swagger_response_for('/pets/{id}/extra_info', 203)
         expect(response[:description]).to eq('Non-Authoritative Information')
 
@@ -418,7 +418,7 @@ describe "Swagger Responses" do
         expect(pai_schema).to have_field(:avg_meals_per_day, 'number')
       end
 
-      it "should return code 204 with array of integer" do
+      it "returns code 204 with array of integer" do
         returns_obj = subject.returns.detect{|e| e.code == 204 }
 
         puts returns_obj.to_json
@@ -428,7 +428,7 @@ describe "Swagger Responses" do
         expect(returns_obj).to match_field_structure([:int_array, :enum_array])
       end
 
-      it 'should have the 204 response described in the swagger' do
+      it 'has the 204 response described in the swagger' do
         response = swagger_response_for('/pets/{id}/extra_info', 204)
 
         schema = response[:schema]
@@ -437,7 +437,7 @@ describe "Swagger Responses" do
       end
 
 
-      it "should return code matching :unprocessable_entity (422) with spread out 'pet' and 'num_fleas'" do
+      it "returns code matching :unprocessable_entity (422) with spread out 'pet' and 'num_fleas'" do
         returns_obj = subject.returns.detect{|e| e.code == 422 }
 
         puts returns_obj.to_json
@@ -449,7 +449,7 @@ describe "Swagger Responses" do
                                                      ])
       end
 
-      it 'should have the 422 response described in the swagger' do
+      it 'has the 422 response described in the swagger' do
         response = swagger_response_for('/pets/{id}/extra_info', 422)
         expect(response[:description]).to eq('Fleas were discovered on the pet')
 
@@ -475,7 +475,7 @@ describe "Swagger Responses" do
         desc._methods[:show_as_properties]
       end
 
-      it "should return tags with 'Dogs', and 'Wolves'" do
+      it "returns tags with 'Dogs', and 'Wolves'" do
         returns_obj = subject.tag_list
         puts returns_obj.inspect
 
@@ -496,7 +496,7 @@ describe "Swagger Responses" do
         desc._methods[:show_as_properties]
       end
 
-      it "should return tags with 'Dogs', 'Pets', and 'Animals'" do
+      it "returns tags with 'Dogs', 'Pets', and 'Animals'" do
         returns_obj = subject.tag_list
         puts returns_obj.inspect
 
@@ -509,7 +509,7 @@ describe "Swagger Responses" do
         desc._methods[:show_as_same_properties]
       end
 
-      it "should return tags with 'Dogs', 'Pets', 'Puma', and 'Animals'" do
+      it "returns tags with 'Dogs', 'Pets', 'Puma', and 'Animals'" do
         returns_obj = subject.tag_list
         puts returns_obj.inspect
 
@@ -532,7 +532,7 @@ describe "Swagger Responses" do
         desc._methods[:pets_described_as_class]
       end
 
-      it "should return code 200 with array of entries of the format {'pet_name', 'animal_type'}" do
+      it "returns code 200 with array of entries of the format {'pet_name', 'animal_type'}" do
         returns_obj = subject.returns.detect{|e| e.code == 200 }
 
         puts returns_obj.to_json
@@ -542,7 +542,7 @@ describe "Swagger Responses" do
         expect(returns_obj).to match_field_structure([:pet_name, :animal_type])
       end
 
-      it 'should have the response described in the swagger' do
+      it 'has the response described in the swagger' do
         response = swagger_response_for('/pets_described_as_class')
         expect(response[:description]).to eq("list of pets")
 
@@ -561,7 +561,7 @@ describe "Swagger Responses" do
         desc._methods[:pets_with_measurements_described_as_class]
       end
 
-      it "should return code 200 with spread out 'pet' and encapsulated 'pet_measurements'" do
+      it "returns code 200 with spread out 'pet' and encapsulated 'pet_measurements'" do
         returns_obj = subject.returns.detect{|e| e.code == 200 }
 
         puts returns_obj.to_json
@@ -574,7 +574,7 @@ describe "Swagger Responses" do
                                                      ])
       end
 
-      it 'should have the 200 response described in the swagger' do
+      it 'has the 200 response described in the swagger' do
         response = swagger_response_for('/pets_with_measurements_described_as_class/{id}', 200)
         expect(response[:description]).to eq('measurements of the pet')
 
@@ -595,7 +595,7 @@ describe "Swagger Responses" do
         desc._methods[:pets_with_many_measurements_as_class]
       end
 
-      it "should return code 200 with pet_name (string) and many_pet_measurements (array of objects)" do
+      it "returns code 200 with pet_name (string) and many_pet_measurements (array of objects)" do
         returns_obj = subject.returns.detect{|e| e.code == 200 }
 
         puts returns_obj.to_json
@@ -608,7 +608,7 @@ describe "Swagger Responses" do
       end
 
 
-      it 'should have the 200 response described in the swagger' do
+      it 'has the 200 response described in the swagger' do
         response = swagger_response_for('/pets_with_many_measurements_as_class/{id}', 200)
         expect(response[:description]).to eq('measurements of the pet')
 
@@ -637,7 +637,7 @@ describe "Swagger Responses" do
         desc._methods[:pet_described_using_automated_view]
       end
 
-      it "should return code 200 with array of entries of the format {'pet_name', 'animal_type'}" do
+      it "returns code 200 with array of entries of the format {'pet_name', 'animal_type'}" do
         returns_obj = subject.returns.detect{|e| e.code == 200 }
 
         expect(returns_obj.code).to eq(200)
@@ -646,7 +646,7 @@ describe "Swagger Responses" do
         expect(returns_obj).to match_field_structure([:pet_name, :animal_type, :age])
       end
 
-      it 'should have the response described in the swagger' do
+      it 'has the response described in the swagger' do
         response = swagger_response_for('/pet_described_using_automated_view/{id}')
         expect(response[:description]).to eq("like Pet, but different")
 

data/spec/test_engine/memes_controller_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe TestEngine::MemesController do
 
   describe "#index" do
-    it "should have the full mounted path of engine" do
+    it "has the full mounted path of engine" do
       expect(Apipie.routes_for_action(TestEngine::MemesController, :index, {}).first[:path]).to eq("/test/memes")
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apipie-rails
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.4.1
 platform: ruby
 authors:
 - Pavel Pokorny
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-29 00:00:00.000000000 Z
+date: 2024-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -165,6 +165,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -478,8 +492,128 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: Rails REST API documentation tool
-test_files: []
+test_files:
+- spec/controllers/api/v1/architectures_controller_spec.rb
+- spec/controllers/api/v2/architectures_controller_spec.rb
+- spec/controllers/api/v2/empty_middle_controller_spec.rb
+- spec/controllers/api/v2/nested/resources_controller_spec.rb
+- spec/controllers/api/v2/sub/footguns_controller_spec.rb
+- spec/controllers/concerns_controller_spec.rb
+- spec/controllers/extended_controller_spec.rb
+- spec/controllers/included_param_group_controller_spec.rb
+- spec/controllers/pets_controller_spec.rb
+- spec/controllers/users_controller_spec.rb
+- spec/dummy/Rakefile
+- spec/dummy/app/controllers/api/base_controller.rb
+- spec/dummy/app/controllers/api/v1/architectures_controller.rb
+- spec/dummy/app/controllers/api/v1/base_controller.rb
+- spec/dummy/app/controllers/api/v2/architectures_controller.rb
+- spec/dummy/app/controllers/api/v2/base_controller.rb
+- spec/dummy/app/controllers/api/v2/empty_middle_controller.rb
+- spec/dummy/app/controllers/api/v2/nested/architectures_controller.rb
+- spec/dummy/app/controllers/api/v2/nested/resources_controller.rb
+- spec/dummy/app/controllers/api/v2/sub/footguns_controller.rb
+- spec/dummy/app/controllers/application_controller.rb
+- spec/dummy/app/controllers/concerns_controller.rb
+- spec/dummy/app/controllers/extended_controller.rb
+- spec/dummy/app/controllers/extending_concern.rb
+- spec/dummy/app/controllers/files_controller.rb
+- spec/dummy/app/controllers/included_param_group_controller.rb
+- spec/dummy/app/controllers/overridden_concerns_controller.rb
+- spec/dummy/app/controllers/pets_controller.rb
+- spec/dummy/app/controllers/pets_using_auto_views_controller.rb
+- spec/dummy/app/controllers/pets_using_self_describing_classes_controller.rb
+- spec/dummy/app/controllers/sample_controller.rb
+- spec/dummy/app/controllers/tagged_cats_controller.rb
+- spec/dummy/app/controllers/tagged_dogs_controller.rb
+- spec/dummy/app/controllers/twitter_example_controller.rb
+- spec/dummy/app/controllers/users_controller.rb
+- spec/dummy/app/helpers/random_param_group.rb
+- spec/dummy/app/views/layouts/application.html.erb
+- spec/dummy/components/test_engine/Gemfile
+- spec/dummy/components/test_engine/app/controllers/test_engine/application_controller.rb
+- spec/dummy/components/test_engine/app/controllers/test_engine/memes_controller.rb
+- spec/dummy/components/test_engine/config/routes.rb
+- spec/dummy/components/test_engine/db/.gitkeep
+- spec/dummy/components/test_engine/lib/test_engine.rb
+- spec/dummy/components/test_engine/test_engine.gemspec
+- spec/dummy/config.ru
+- spec/dummy/config/application.rb
+- spec/dummy/config/boot.rb
+- spec/dummy/config/database.yml
+- spec/dummy/config/environment.rb
+- spec/dummy/config/environments/development.rb
+- spec/dummy/config/environments/production.rb
+- spec/dummy/config/environments/test.rb
+- spec/dummy/config/initializers/apipie.rb
+- spec/dummy/config/initializers/backtrace_silencers.rb
+- spec/dummy/config/initializers/inflections.rb
+- spec/dummy/config/initializers/mime_types.rb
+- spec/dummy/config/initializers/secret_token.rb
+- spec/dummy/config/initializers/session_store.rb
+- spec/dummy/config/locales/en.yml
+- spec/dummy/config/routes.rb
+- spec/dummy/db/.gitkeep
+- spec/dummy/doc/apipie_examples.json
+- spec/dummy/doc/users/desc_from_file.md
+- spec/dummy/public/404.html
+- spec/dummy/public/422.html
+- spec/dummy/public/500.html
+- spec/dummy/public/favicon.ico
+- spec/dummy/public/stylesheets/.gitkeep
+- spec/dummy/script/rails
+- spec/lib/apipie/apipies_controller_spec.rb
+- spec/lib/apipie/application_spec.rb
+- spec/lib/apipie/configuration_spec.rb
+- spec/lib/apipie/extractor/collector_spec.rb
+- spec/lib/apipie/extractor/recorder/middleware_spec.rb
+- spec/lib/apipie/extractor/recorder_spec.rb
+- spec/lib/apipie/extractor/writer_spec.rb
+- spec/lib/apipie/extractor_spec.rb
+- spec/lib/apipie/file_handler_spec.rb
+- spec/lib/apipie/generator/swagger/config_spec.rb
+- spec/lib/apipie/generator/swagger/context_spec.rb
+- spec/lib/apipie/generator/swagger/method_description/api_schema_service_spec.rb
+- spec/lib/apipie/generator/swagger/method_description/response_schema_service_spec.rb
+- spec/lib/apipie/generator/swagger/method_description/response_service_spec.rb
+- spec/lib/apipie/generator/swagger/operation_id_spec.rb
+- spec/lib/apipie/generator/swagger/param_description/builder_spec.rb
+- spec/lib/apipie/generator/swagger/param_description/composite_spec.rb
+- spec/lib/apipie/generator/swagger/param_description/description_spec.rb
+- spec/lib/apipie/generator/swagger/param_description/in_spec.rb
+- 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/path_decorator_spec.rb
+- spec/lib/apipie/generator/swagger/referenced_definitions_spec.rb
+- spec/lib/apipie/generator/swagger/resource_description_composite_spec.rb
+- spec/lib/apipie/generator/swagger/resource_descriptions_collection_spec.rb
+- spec/lib/apipie/generator/swagger/schema_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
+- spec/lib/apipie/method_description_spec.rb
+- spec/lib/apipie/no_documented_method_spec.rb
+- spec/lib/apipie/param_description/deprecation_spec.rb
+- spec/lib/apipie/param_description_spec.rb
+- spec/lib/apipie/param_group_spec.rb
+- spec/lib/apipie/resource_description_spec.rb
+- spec/lib/apipie/response_description/response_object_spec.rb
+- spec/lib/apipie/response_description_spec.rb
+- spec/lib/apipie/response_does_not_match_swagger_schema_spec.rb
+- spec/lib/apipie/swagger_generator_spec.rb
+- spec/lib/apipie/validator_spec.rb
+- spec/lib/rake_spec.rb
+- spec/lib/swagger/openapi_2_0_schema.json
+- spec/lib/swagger/rake_swagger_spec.rb
+- spec/lib/swagger/swagger_dsl_spec.rb
+- spec/lib/validators/array_validator_spec.rb
+- spec/spec_helper.rb
+- spec/support/custom_bool_validator.rb
+- spec/support/rake.rb
+- spec/test_engine/memes_controller_spec.rb