apipie-rails 0.9.1 → 0.9.3

data/spec/lib/apipie/generator/swagger/param_description/type_spec.rb

@@ -0,0 +1,178 @@
+require 'spec_helper'
+
+describe Apipie::Generator::Swagger::ParamDescription::Type do
+  let(:validator_options) { {} }
+  let(:param_description_options) { {}.merge(validator_options) }
+  let(:with_null) { false }
+  let(:http_method) { :GET }
+  let(:path) { '/api' }
+  let(:validator) { String }
+
+  let(:base_dsl_data) do
+    {
+      :api => false,
+      :api_args => [],
+      :api_from_routes => nil,
+      :errors => [],
+      :tag_list => [],
+      :returns => {},
+      :params => [],
+      :headers => [],
+      :resource_id => nil,
+      :short_description => nil,
+      :description => nil,
+      :examples => [],
+      :see => [],
+      :formats => nil,
+      :api_versions => [],
+      :meta => nil,
+      :show => true,
+      :deprecated => false
+    }
+  end
+
+  let(:dsl_data) do
+    base_dsl_data.merge({
+      api_args: [
+        [
+          http_method,
+          path,
+          'description',
+          { deprecated: true }
+        ]
+      ]
+    })
+  end
+
+  let(:resource_desc) do
+    Apipie::ResourceDescription.new(UsersController, 'dummy')
+  end
+
+  let(:method_desc) do
+    Apipie::MethodDescription.new(:show, resource_desc, dsl_data)
+  end
+
+  let(:param_description_name) { 'some_param' }
+
+  let(:param_description) do
+    Apipie::ParamDescription.new(
+      method_desc,
+      param_description_name,
+      validator,
+      param_description_options
+    )
+  end
+
+  let(:type_definition) do
+    described_class.
+      new(param_description, with_null: with_null, controller_method: 'index').
+      to_hash
+  end
+
+  describe 'type' do
+    subject { type_definition[:type] }
+
+    it { is_expected.to eq(validator.to_s.downcase) }
+
+    context 'when validator is enum' do
+      let(:validator) { ['name', 'enum'] }
+
+      it { is_expected.to eq('string') }
+    end
+
+    context 'when validator is a Hash' do
+      let(:validator) { Hash }
+
+      it { is_expected.to eq('object') }
+    end
+  end
+
+  describe 'items' do
+    let(:items) { type_definition[:items] }
+
+    subject { items }
+
+    context 'when has validator is Array' do
+      let(:validator) { Array }
+
+      it { is_expected.to eq({ type: 'string' }) }
+
+      context 'of Hash' do
+        let(:validator_options) { { of: Hash } }
+
+        let(:reference) do
+          Apipie::Generator::Swagger::OperationId.
+            new(http_method: http_method, path: path, param: param_description_name).
+            to_s
+        end
+
+        it { is_expected.to eq({ type: 'string' }) }
+
+        context 'and swagger_json_input_uses_refs is set to true' do
+          before { Apipie.configuration.swagger_json_input_uses_refs = true }
+          after { Apipie.configuration.swagger_json_input_uses_refs = false }
+
+          it 'returns the reference' do
+            expect(subject).to eq({ '$ref' => reference })
+          end
+
+        end
+      end
+
+      describe 'enum' do
+        subject { items[:enum] }
+
+        it { is_expected.to be_blank }
+
+        context 'when validator is Array' do
+          let(:validator) { Array }
+
+          it { is_expected.to be_blank }
+
+          context 'and an array of in values is given' do
+            let(:enum_values) { ['enum-value-1', 'enum-value-2'] }
+            let(:validator_options) { { in: ['enum-value-1', 'enum-value-2'] } }
+
+            it { is_expected.to eq(enum_values) }
+          end
+        end
+      end
+    end
+  end
+
+  describe 'enum' do
+    subject { type_definition[:enum] }
+
+    context 'and an array of in values is given' do
+      let(:validator) { ['enum-value-1', 'enum-value-2'] }
+
+      it { is_expected.to eq(validator) }
+    end
+  end
+
+  describe 'additionalProperties' do
+    subject { type_definition[:additionalProperties] }
+
+    it  { is_expected.to be_blank }
+
+    context 'when validator is a Hash' do
+      let(:validator) { Hash }
+
+      it { is_expected.to be_truthy }
+    end
+  end
+
+  describe 'warnings' do
+    before { Singleton.__init__(Apipie::Generator::Swagger::WarningWriter) }
+
+    subject { type_definition }
+
+    context 'when validator is a Hash' do
+      let(:validator) { Hash }
+
+      it 'outputs a hash without internal typespec warning' do
+        expect { subject }.to output(/is a generic Hash without an internal type specification/).to_stderr
+      end
+    end
+  end
+end

data/spec/lib/apipie/generator/swagger/param_description_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe Apipie::Generator::Swagger::ParamDescription do
+  describe '.create_for_missing_param' do
+    let(:name) { 'ok' }
+
+    let(:method_description) do
+      Apipie.get_method_description(UsersController, :update)
+    end
+
+    subject do
+      described_class.create_for_missing_param(method_description, name)
+    end
+
+    it 'creates a required param description' do
+      expect(subject.required).to eq(true)
+    end
+
+    it 'has the correct name' do
+      expect(subject.name).to eq(name)
+    end
+
+    it 'has been created from path' do
+      expect(subject.options[:added_from_path]).to eq(true)
+    end
+  end
+end
+

data/spec/lib/{generator → apipie/generator}/swagger/type_extractor_spec.rb

@@ -1,15 +1,11 @@
 require 'spec_helper'
 
 describe Apipie::Generator::Swagger::TypeExtractor do
-  let(:validator) {}
   let(:extractor) { described_class.new(validator) }
 
-  describe '#extarct_with_warnings' do
+  shared_examples 'extractable method' do
     let(:warnings) { {} }
-
-    before { Apipie.configuration.swagger_suppress_warnings = false }
-
-    subject { extractor.extract_with_warnings(warnings) }
+    let(:validator) {}
 
     it { is_expected.to eq(Apipie::Generator::Swagger::TypeExtractor::TYPES[:string]) }
 
@@ -38,21 +34,45 @@ describe Apipie::Generator::Swagger::TypeExtractor do
           it 'returns a boolean type' do
             expect(subject).to eq(Apipie::Generator::Swagger::TypeExtractor::TYPES[:boolean])
           end
+        end
+      end
+    end
+  end
+
+  describe '#extract' do
+    subject { extractor.extract }
 
-          context 'and a boolean warning is passed' do
-            let(:boolean_warning) do
-              Apipie::Generator::Swagger::Warning.for_code(
-                Apipie::Generator::Swagger::Warning::INFERRING_BOOLEAN_CODE,
-                'SampleController#action',
-                { parameter: 'some-param' }
-              )
-            end
+    it_behaves_like 'extractable method'
+  end
+
+  describe '#extarct_with_warnings' do
+    before { Apipie.configuration.swagger_suppress_warnings = false }
+
+    subject { extractor.extract_with_warnings(warnings) }
+
+    it_behaves_like 'extractable method'
+
+    context "when enum validator is used" do
+      context "and has `true`, `false` as values" do
+        let(:enum_values) { [true, false] }
+
+        let(:validator) do
+          Apipie::ResponseDescriptionAdapter::PropDesc::Validator.new('some-type', enum_values)
+        end
+
+        context 'and a boolean warning is passed' do
+          let(:boolean_warning) do
+            Apipie::Generator::Swagger::Warning.for_code(
+              Apipie::Generator::Swagger::Warning::INFERRING_BOOLEAN_CODE,
+              'SampleController#action',
+              { parameter: 'some-param' }
+            )
+          end
 
-            let(:warnings) { { boolean: boolean_warning } }
+          let(:warnings) { { boolean: boolean_warning } }
 
-            it 'outputs the warning' do
-              expect { subject }.to output(boolean_warning.warning_message).to_stderr
-            end
+          it 'outputs the warning' do
+            expect { subject }.to output(boolean_warning.warning_message).to_stderr
           end
         end
       end

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

@@ -58,12 +58,12 @@ describe Apipie::MethodDescription do
 
     it "should be ordered" do
       expect(@method.params.keys).to eq([:a, :b, :c])
-      expect(@method.to_json[:params].map{|h| h[:name]}).to eq(['a', 'b', 'c'])
+      expect(@method.to_json[:params].map { |h| h[:name] }).to eq(['a', 'b', 'c'])
     end
 
     it "should be still ordered" do
       expect(@method.params.keys).to eq([:a, :b, :c])
-      expect(@method.to_json[:params].map{|h| h[:name]}).to eq(['a', 'b', 'c'])
+      expect(@method.to_json[:params].map { |h| h[:name] }).to eq(['a', 'b', 'c'])
     end
 
   end
@@ -80,7 +80,7 @@ describe Apipie::MethodDescription do
 
     it "should ignore response-only parameters" do
       expect(@method.params.keys).to eq([:a, :c])
-      expect(@method.to_json[:params].map{|h| h[:name]}).to eq(['a', 'c'])
+      expect(@method.to_json[:params].map { |h| h[:name] }).to eq(['a', 'c'])
     end
   end
 
@@ -90,7 +90,7 @@ describe Apipie::MethodDescription do
       @resource = Apipie::ResourceDescription.new(ApplicationController, "dummy")
       dsl_data[:returns] = { 200 => [{:param_group => 'pet', :array_of => 'pet'}, nil, nil] }
 
-      expect {Apipie::MethodDescription.new(:a, @resource, dsl_data)}.to raise_error(Apipie::ReturnsMultipleDefinitionError)
+      expect { Apipie::MethodDescription.new(:a, @resource, dsl_data) }.to raise_error(Apipie::ReturnsMultipleDefinitionError)
     end
   end
 

data/spec/lib/apipie/param_description/deprecation_spec.rb

@@ -0,0 +1,31 @@
+require "spec_helper"
+
+describe Apipie::ParamDescription::Deprecation do
+  let(:info) { nil }
+  let(:deprecated_in) { nil }
+  let(:sunset_at) { nil }
+
+  let(:deprecation) do
+    described_class.new(
+      info: info,
+      deprecated_in: deprecated_in,
+      sunset_at: sunset_at
+    )
+  end
+
+  describe '#to_json' do
+    subject { deprecation.to_json }
+
+    it { is_expected.to eq({ info: nil, deprecated_in: nil, sunset_at: nil }) }
+
+    context 'when attributes are given' do
+      let(:info) { 'info' }
+      let(:deprecated_in) { '2.3' }
+      let(:sunset_at) { '3.0' }
+
+      it 'returns the correct attributes' do
+        expect(subject).to eq({ info: info, deprecated_in: deprecated_in, sunset_at: sunset_at })
+      end
+    end
+  end
+end

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/{param_group_spec.rb → apipie/param_group_spec.rb}

@@ -43,17 +43,17 @@ describe "param groups" do
   end
 
   it "should replace parameter name in a group when it comes from concern" do
-    expect(Apipie["overridden_concern_resources#update"].params.has_key?(:user)).to eq(true)
+    expect(Apipie["overridden_concern_resources#update"].params.key?(:user)).to eq(true)
   end
 
   it "shouldn't replace parameter name in a group redefined in the controller" do
-    expect(Apipie["overridden_concern_resources#create"].params.has_key?(:concern)).to eq(true)
-    expect(Apipie["overridden_concern_resources#create"].params.has_key?(:user)).to eq(false)
+    expect(Apipie["overridden_concern_resources#create"].params.key?(:concern)).to eq(true)
+    expect(Apipie["overridden_concern_resources#create"].params.key?(:user)).to eq(false)
   end
 
 it "shouldn't replace name of a parameter defined in the controller" do
-    expect(Apipie["overridden_concern_resources#custom"].params.has_key?(:concern)).to eq(true)
-    expect(Apipie["overridden_concern_resources#custom"].params.has_key?(:user)).to eq(false)
+    expect(Apipie["overridden_concern_resources#custom"].params.key?(:concern)).to eq(true)
+    expect(Apipie["overridden_concern_resources#custom"].params.key?(:user)).to eq(false)
   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.1
+  version: 0.9.3
 platform: ruby
 authors:
 - Pavel Pokorny
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-16 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
@@ -235,6 +279,15 @@ files:
 - lib/apipie/extractor/recorder.rb
 - lib/apipie/extractor/writer.rb
 - lib/apipie/generator/generator.rb
+- lib/apipie/generator/swagger/context.rb
+- lib/apipie/generator/swagger/operation_id.rb
+- lib/apipie/generator/swagger/param_description.rb
+- lib/apipie/generator/swagger/param_description/builder.rb
+- lib/apipie/generator/swagger/param_description/composite.rb
+- lib/apipie/generator/swagger/param_description/description.rb
+- lib/apipie/generator/swagger/param_description/in.rb
+- lib/apipie/generator/swagger/param_description/name.rb
+- lib/apipie/generator/swagger/param_description/type.rb
 - lib/apipie/generator/swagger/swagger.rb
 - lib/apipie/generator/swagger/type.rb
 - lib/apipie/generator/swagger/type_extractor.rb
@@ -247,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
@@ -272,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
@@ -335,29 +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/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: {}