apipie-rails 0.9.2 → 0.9.3

data/spec/lib/{param_description_spec.rb → apipie/param_description_spec.rb}

@@ -188,7 +188,9 @@ describe Apipie::ParamDescription do
       end
       context 'when allow_blank is specified as false' do
         it "should throw an exception when passed an empty value" do
-          expect { Apipie::ParamDescription.new(method_desc, :param, String, allow_blank: false).validate('') }.to raise_error(Apipie::ParamInvalid)
+          expect do
+            Apipie::ParamDescription.new(method_desc, :param, String, allow_blank: false).validate('')
+          end.to raise_error(Apipie::ParamInvalid)
         end
       end
       context 'when allow_blank is not specified' do
@@ -428,4 +430,82 @@ describe Apipie::ParamDescription do
     end
   end
 
+  describe '#deprecated?' do
+    subject do
+      Apipie::ParamDescription.new(method_desc, :param, Integer, options)
+    end
+
+    let(:options) { {} }
+
+    it { is_expected.not_to be_deprecated }
+
+    context 'when deprecated option is passed' do
+      context 'and is true' do
+        let(:options) { { deprecated: true } }
+
+        it { is_expected.to be_deprecated }
+      end
+
+      context 'and is false' do
+        let(:options) { { deprecated: false } }
+
+        it { is_expected.not_to be_deprecated }
+      end
+
+      context 'and is a string' do
+        let(:options) { { deprecated: 'Some description' } }
+
+        it { is_expected.to be_deprecated }
+      end
+
+      context 'and deprecation options are given' do
+        let(:options) do
+          { deprecated: { in: '2.3', info: 'Something', sunset: '3.0' } }
+        end
+
+        it { is_expected.to be_deprecated }
+      end
+    end
+  end
+
+  describe '#deprecation' do
+    subject { param_description.deprecation }
+
+    let(:options) { {} }
+
+    let(:param_description) do
+      Apipie::ParamDescription.new(method_desc, :param, Integer, options)
+    end
+
+    it { is_expected.to be_blank }
+
+    context 'when deprecated option is passed' do
+      context 'and is true' do
+        let(:options) { { deprecated: true } }
+
+        it { is_expected.to be_blank }
+      end
+
+      context 'and is false' do
+        let(:options) { { deprecated: false } }
+
+        it { is_expected.to be_blank }
+      end
+
+      context 'and is a string' do
+        let(:options) { { deprecated: 'Some description' } }
+
+        it { is_expected.to be_an_instance_of(Apipie::ParamDescription::Deprecation) }
+      end
+
+      context 'and deprecation options are given' do
+        let(:options) do
+          { deprecated: { in: '2.3', info: 'Something', sunset: '3.0' } }
+        end
+
+        it { is_expected.to be_an_instance_of(Apipie::ParamDescription::Deprecation) }
+      end
+    end
+  end
+
 end

data/spec/lib/{resource_description_spec.rb → apipie/resource_description_spec.rb}

@@ -36,12 +36,12 @@ describe Apipie::ResourceDescription do
 
     it "should be ordered" do
       expect(@resource._methods.keys).to eq([:a, :b, :c])
-      expect(@resource.to_json[:methods].map{|h| h[:name]}).to eq(['a', 'b', 'c'])
+      expect(@resource.to_json[:methods].map { |h| h[:name] }).to eq(['a', 'b', 'c'])
     end
 
     it "should be still ordered" do
       expect(@resource._methods.keys).to eq([:a, :b, :c])
-      expect(@resource.to_json[:methods].map{|h| h[:name]}).to eq(['a', 'b', 'c'])
+      expect(@resource.to_json[:methods].map { |h| h[:name] }).to eq(['a', 'b', 'c'])
     end
 
   end

data/spec/lib/swagger/swagger_dsl_spec.rb

@@ -37,7 +37,7 @@ describe "Swagger Responses" do
   def swagger_param_by_name(param_name, path, method='get')
     params = swagger_params_for(path, method)
     matching = params.select{|p| p[:name] == param_name }
-    raise "multiple params named [#{param_name}] in swagger definition for [#{method } #{path}]" if matching.length > 1
+    raise "multiple params named [#{param_name}] in swagger definition for [#{method} #{path}]" if matching.length > 1
 
     nil if matching.length == 0
 

data/spec/spec_helper.rb

@@ -55,7 +55,7 @@ end
 
 # Requires supporting ruby files with custom matchers and macros, etc,
 # in spec/support/ and its subdirectories.
-Dir[File.expand_path('support/**/*.rb', __dir__)].each {|f| require f}
+Dir[File.expand_path('support/**/*.rb', __dir__)].sort.each {|f| require f}
 
 RSpec.configure do |config|
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apipie-rails
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 0.9.3
 platform: ruby
 authors:
 - Pavel Pokorny
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-07 00:00:00.000000000 Z
+date: 2023-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -123,6 +123,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-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: rubocop-rspec
+  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: rubocop-performance
+  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
@@ -161,6 +203,7 @@ extra_rdoc_files: []
 files:
 - ".github/workflows/build.yml"
 - ".github/workflows/rubocop-challenger.yml"
+- ".github/workflows/rubocop.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -184,6 +227,7 @@ files:
 - app/public/apipie/stylesheets/bundled/bootstrap-responsive.min.css
 - app/public/apipie/stylesheets/bundled/bootstrap.min.css
 - app/public/apipie/stylesheets/bundled/prettify.css
+- app/views/apipie/apipies/_deprecation.html.erb
 - app/views/apipie/apipies/_disqus.html.erb
 - app/views/apipie/apipies/_errors.html.erb
 - app/views/apipie/apipies/_headers.html.erb
@@ -256,6 +300,7 @@ files:
 - lib/apipie/method_description/apis_service.rb
 - lib/apipie/middleware/checksum_in_headers.rb
 - lib/apipie/param_description.rb
+- lib/apipie/param_description/deprecation.rb
 - lib/apipie/railtie.rb
 - lib/apipie/resource_description.rb
 - lib/apipie/response_description.rb
@@ -281,11 +326,10 @@ files:
 - 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/apipies_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/memes_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
@@ -344,38 +388,42 @@ files:
 - spec/dummy/public/favicon.ico
 - spec/dummy/public/stylesheets/.gitkeep
 - spec/dummy/script/rails
-- spec/lib/application_spec.rb
-- spec/lib/extractor/extractor_spec.rb
-- spec/lib/extractor/middleware_spec.rb
-- spec/lib/extractor/writer_spec.rb
-- spec/lib/file_handler_spec.rb
-- spec/lib/generator/swagger/context_spec.rb
-- spec/lib/generator/swagger/operation_id_spec.rb
-- spec/lib/generator/swagger/param_description/builder_spec.rb
-- spec/lib/generator/swagger/param_description/composite_spec.rb
-- spec/lib/generator/swagger/param_description/description_spec.rb
-- spec/lib/generator/swagger/param_description/in_spec.rb
-- spec/lib/generator/swagger/param_description/name_spec.rb
-- spec/lib/generator/swagger/param_description/type_spec.rb
-- spec/lib/generator/swagger/param_description_spec.rb
-- spec/lib/generator/swagger/type_extractor_spec.rb
-- spec/lib/generator/swagger/warning_spec.rb
-- spec/lib/generator/swagger/warning_writer_spec.rb
-- spec/lib/method_description/apis_service_spec.rb
-- spec/lib/method_description_spec.rb
-- spec/lib/param_description_spec.rb
-- spec/lib/param_group_spec.rb
+- spec/lib/apipie/apipies_controller_spec.rb
+- spec/lib/apipie/application_spec.rb
+- spec/lib/apipie/configuration_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/context_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/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/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/validator_spec.rb
 - spec/lib/rake_spec.rb
-- spec/lib/resource_description_spec.rb
 - spec/lib/swagger/openapi_2_0_schema.json
 - spec/lib/swagger/rake_swagger_spec.rb
-- spec/lib/swagger/response_validation_spec.rb
 - spec/lib/swagger/swagger_dsl_spec.rb
-- spec/lib/validator_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
 homepage: http://github.com/Apipie/apipie-rails
 licenses: []
 metadata: {}