apipie-rails 0.8.1 → 0.9.0

data/spec/lib/method_description/apis_service_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+describe Apipie::MethodDescription::ApisService do
+  let(:resource) {}
+  let(:controller_action) {}
+  let(:api_args) { [] }
+  let(:dsl) { { api_args: api_args } }
+  let(:service) { described_class.new(resource, controller_action, dsl) }
+
+  describe '#call' do
+    subject { service.call }
+
+    it { is_expected.to eq(api_args) }
+
+    context 'when api_from_routes is given' do
+      let(:controller) { UsersController }
+      let(:controller_action) { :show }
+      let(:resource) { Apipie::ResourceDescription.new(controller, 'dummy') }
+      let(:short_description) { 'Short description' }
+
+      let(:dsl) do
+        super().merge({
+          api_from_routes: {
+            desc: short_description,
+            options: {}
+          }
+        })
+      end
+
+      it 'returns an array of Apipie::MethodDescription::Api' do
+        expect(subject).to all(be_an_instance_of(Apipie::MethodDescription::Api))
+        expect(subject.count).to eq(1)
+      end
+
+      context 'Apipie::MethodDescription::Api' do
+        subject { service.call.first }
+
+        it 'has the correct values' do
+          expect(subject.short_description).to eq(short_description)
+          expect(subject.path).to eq('/api/users/:id')
+          expect(subject.from_routes).to eq(true)
+          expect(subject.options).to eq({ from_routes: true })
+        end
+
+        context "when it's from concern" do
+          let(:controller) { ConcernsController }
+          let(:controller_action) { :custom }
+          let(:dsl) { super().merge(from_concern: true ) }
+
+          it 'has the correct values' do
+            expect(subject.short_description).to eq(short_description)
+            expect(subject.path).to eq('/api/concern_resources/custom')
+            expect(subject.from_routes).to eq(true)
+            expect(subject.options).to eq({ from_routes: true })
+          end
+        end
+      end
+    end
+  end
+end

data/spec/lib/param_description_spec.rb

@@ -157,11 +157,29 @@ describe Apipie::ParamDescription do
         expect { Apipie::ParamDescription.new(method_desc, :param, :boolean).validate(false) }.to_not raise_error
       end
 
+      it "should still not throw an exception when passed false with explicit allow_blank: false" do
+        expect { Apipie::ParamDescription.new(method_desc, :param, :boolean, allow_blank: false).validate(false) }.to_not raise_error
+      end
+
       it "should throw an exception when passed an empty value" do
         expect { Apipie::ParamDescription.new(method_desc, :param, :boolean).validate('') }.to raise_error(Apipie::ParamInvalid)
       end
     end
 
+    context "when the parameter is a custom type with ignore_allow_blank? returning true" do
+      it "should not throw an exception when passed a blank but valid value" do
+        expect { Apipie::ParamDescription.new(method_desc, :param, :custom_bool).validate(false) }.to_not raise_error
+      end
+
+      it "should still not throw an exception when passed false with explicit allow_blank: false" do
+        expect { Apipie::ParamDescription.new(method_desc, :param, :custom_bool, allow_blank: false).validate(false) }.to_not raise_error
+      end
+
+      it "should throw an exception when passed an invalid but blank value" do
+        expect { Apipie::ParamDescription.new(method_desc, :param, :custom_bool).validate("") }.to raise_error(Apipie::ParamInvalid)
+      end
+    end
+
     context 'when the parameter is a string' do
       context 'when allow_blank is specified as true' do
         it "should throw an exception when passed an empty value" do

data/spec/lib/rake_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe 'rake tasks' do
   include_context "rake"
 
-  let(:doc_path)  { "user_specified_doc_path" }
+  let(:doc_path)  { 'tmp/user_specified_doc_path' }
 
   before do
     Apipie.configuration.doc_path = doc_path

data/spec/lib/swagger/rake_swagger_spec.rb

@@ -1,14 +1,14 @@
 require 'spec_helper'
 require "json-schema"
 
-require File.expand_path("../../../dummy/app/controllers/twitter_example_controller.rb", __FILE__)
-require File.expand_path("../../../dummy/app/controllers/users_controller.rb", __FILE__)
-require File.expand_path("../../../dummy/app/controllers/pets_controller.rb", __FILE__)
+require File.expand_path('../../dummy/app/controllers/twitter_example_controller.rb', __dir__)
+require File.expand_path('../../dummy/app/controllers/users_controller.rb', __dir__)
+require File.expand_path('../../dummy/app/controllers/pets_controller.rb', __dir__)
 
 describe 'rake tasks' do
   include_context "rake"
 
-  let(:doc_path)  { "user_specified_doc_path" }
+  let(:doc_path)  { 'tmp/user_specified_doc_path' }
 
   before do
     Apipie.configuration.doc_path = doc_path

data/spec/spec_helper.rb

@@ -1,9 +1,13 @@
 require 'rubygems'
 require 'bundler/setup'
 
+require 'simplecov'
+SimpleCov.minimum_coverage 89
+SimpleCov.start
+
 ENV["RAILS_ENV"] ||= 'test'
-APIPIE_ROOT = File.expand_path('../..', __FILE__)
-require File.expand_path("../dummy/config/environment", __FILE__)
+APIPIE_ROOT = File.expand_path('..', __dir__)
+require File.expand_path('dummy/config/environment', __dir__)
 
 require 'rspec/rails'
 
@@ -51,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", __FILE__)].each {|f| require f}
+Dir[File.expand_path('support/**/*.rb', __dir__)].each {|f| require f}
 
 RSpec.configure do |config|
 
@@ -82,4 +86,4 @@ RSpec.configure do |config|
   config.infer_spec_type_from_file_location!
 end
 
-require 'action_controller/test_case.rb'
+require 'action_controller/test_case'

data/spec/support/custom_bool_validator.rb

@@ -0,0 +1,17 @@
+class CustomBoolValidator < Apipie::Validator::BaseValidator
+  def validate(value)
+    value.in?([true, false])
+  end
+
+  def self.build(param_description, argument, options, block)
+    new(param_description) if argument == :custom_bool
+  end
+
+  def description
+    "Must be a boolean."
+  end
+
+  def ignore_allow_blank?
+    true
+  end
+end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: apipie-rails
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.9.0
 platform: ruby
 authors:
 - Pavel Pokorny
 - Ivan Necas
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-26 00:00:00.000000000 Z
+date: 2023-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -40,21 +40,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: rspec-rails
+  name: maruku
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: RedCloth
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -68,35 +68,35 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: json-schema
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.8'
 - !ruby/object:Gem::Dependency
-  name: maruku
+  name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: RedCloth
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -110,7 +110,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rubocop_challenger
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -124,7 +124,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rdoc
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -138,19 +138,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: json-schema
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.8'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.8'
+        version: '0'
 description: Rails REST API documentation tool
 email:
 - pajkycz@gmail.com
@@ -160,8 +160,11 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/workflows/build.yml"
+- ".github/workflows/rubocop-challenger.yml"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - APACHE-LICENSE-2.0
 - CHANGELOG.md
 - MIT-LICENSE
@@ -231,9 +234,17 @@ files:
 - lib/apipie/extractor/collector.rb
 - lib/apipie/extractor/recorder.rb
 - lib/apipie/extractor/writer.rb
+- lib/apipie/generator/generator.rb
+- lib/apipie/generator/swagger/swagger.rb
+- lib/apipie/generator/swagger/type.rb
+- lib/apipie/generator/swagger/type_extractor.rb
+- lib/apipie/generator/swagger/warning.rb
+- lib/apipie/generator/swagger/warning_writer.rb
 - lib/apipie/helpers.rb
 - lib/apipie/markup.rb
 - lib/apipie/method_description.rb
+- lib/apipie/method_description/api.rb
+- lib/apipie/method_description/apis_service.rb
 - lib/apipie/middleware/checksum_in_headers.rb
 - lib/apipie/param_description.rb
 - lib/apipie/railtie.rb
@@ -264,6 +275,7 @@ files:
 - 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/users_controller_spec.rb
 - spec/dummy/Rakefile
@@ -279,6 +291,7 @@ files:
 - 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
@@ -288,6 +301,7 @@ files:
 - 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
@@ -326,6 +340,10 @@ files:
 - 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
@@ -338,11 +356,12 @@ files:
 - 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
 homepage: http://github.com/Apipie/apipie-rails
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -357,8 +376,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
-signing_key: 
+rubygems_version: 3.3.26
+signing_key:
 specification_version: 4
 summary: Rails REST API documentation tool
 test_files: []