apipie-rails 0.8.2 → 0.9.1

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

@@ -374,7 +374,7 @@ describe Apipie::ParamDescription do
 
       subject do
         Apipie::ParamDescription.new(method_desc, :param, Hash) do
-          param :answer, Fixnum
+          param :answer, Integer
         end
       end
 
@@ -392,7 +392,7 @@ describe Apipie::ParamDescription do
 
       subject do
         Apipie::ParamDescription.new(method_desc, :param, Array) do
-          param :answer, Fixnum
+          param :answer, Integer
         end
       end
 
@@ -422,9 +422,9 @@ describe Apipie::ParamDescription do
 
   describe "Array with classes" do
     it "should be valid for objects included in class array" do
-      param = Apipie::ParamDescription.new(method_desc, :param, [Fixnum, String])
+      param = Apipie::ParamDescription.new(method_desc, :param, [Integer, String])
       expect { param.validate("1") }.not_to raise_error
-      expect { param.validate(Fixnum) }.to raise_error(Apipie::ParamInvalid)
+      expect { param.validate(Integer) }.to raise_error(Apipie::ParamInvalid)
     end
   end
 

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
@@ -49,9 +49,7 @@ describe 'rake tasks' do
   end
 
   describe 'apipie:cache' do
-    let(:cache_output) do
-      File.join(::Rails.root, 'public', 'apipie-cache')
-    end
+    let(:cache_output) { Apipie.configuration.cache_dir }
 
     let(:apidoc_html) do
       File.read("#{cache_output}.html")

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/lib/validator_spec.rb

@@ -69,7 +69,7 @@ describe Apipie::Validator do
 
   describe 'ArrayClassValidator' do
     it "should validate by object class" do
-      validator = Apipie::Validator::ArrayClassValidator.new(params_desc, [Fixnum, String])
+      validator = Apipie::Validator::ArrayClassValidator.new(params_desc, [Integer, String])
       expect(validator.validate("1")).to be_truthy
       expect(validator.validate(1)).to be_truthy
       expect(validator.validate({ 1 => 1 })).to be_falsey

data/spec/spec_helper.rb

@@ -6,8 +6,8 @@ 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'
 
@@ -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", __FILE__)].each {|f| require f}
+Dir[File.expand_path('support/**/*.rb', __dir__)].each {|f| require f}
 
 RSpec.configure do |config|
 
@@ -86,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'

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: apipie-rails
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 0.9.1
 platform: ruby
 authors:
 - Pavel Pokorny
 - Ivan Necas
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-02 00:00:00.000000000 Z
+date: 2023-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -40,21 +40,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: rspec-rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: maruku
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -68,7 +54,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: RedCloth
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -82,33 +68,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: maruku
+  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: RedCloth
+  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: rake
   requirement: !ruby/object:Gem::Requirement
@@ -124,7 +110,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rdoc
+  name: rubocop_challenger
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -152,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
@@ -174,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
@@ -245,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
@@ -343,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
@@ -360,7 +361,7 @@ files:
 homepage: http://github.com/Apipie/apipie-rails
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -375,8 +376,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.5
-signing_key: 
+rubygems_version: 3.3.26
+signing_key:
 specification_version: 4
 summary: Rails REST API documentation tool
 test_files: []