apipie-rails 0.9.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c7d31dc4de8810bc43e818a9d26074a02ed00c2e7fcaec3add9283f595e29c5e
-  data.tar.gz: 7db1cd2f0f3be99a5c0507e8914b7ca1f27542df2e02cdc9275b7cd35371d384
+  metadata.gz: 68c72bdd4204b9dcb285d9f663c4c64dce315af16f9463d9e8ee9b8f28bfc14b
+  data.tar.gz: 25c735365fb4b4733d9eab9b7f5b9439b1d8200113b550ab56c94c9d33253c10
 SHA512:
-  metadata.gz: cd5be5e705f47e1b61849acc946d417526f172affafc8a2742e0dbf89a6fbdbb2ce553d0232cb03edb6ecabad7534d1a37a07bfa58ef336bc6416df8e77196f5
-  data.tar.gz: 7d51ceedcffc6cbea6a857bb4dc905a4122d11909ff5fef8ca0c040f77a3678e55e1df9af389612ce16abd19cc5caa6633bfe597dfb7a1ab09c1228973fad267
+  metadata.gz: dbbfcb973af34864e3e6793d483e32adb3ff8d7e37ee676ec1e485bd4cd094e62c774b41ebe86219cd6e8ffdc2930579125298a918b3d0fc5e48bfaa4fc2260b
+  data.tar.gz: 132c1d5652fc466c42f8f888ce5b9015531ba7d54d1c4c0227d843ed5b3ae0761a0acb365a0ef08135bf10ef8312b30b6fe099f6fe075eec23fd54c079ad9f92

data/.github/workflows/build.yml

@@ -20,6 +20,7 @@ jobs:
           - 2.7
           - '3.0'
           - 3.1
+          - 3.2
         gemfile:
           - Gemfile.rails50
           - Gemfile.rails51
@@ -34,18 +35,24 @@ jobs:
           ruby: '3.0'
         - gemfile: Gemfile.rails50
           ruby: 3.1
+        - gemfile: Gemfile.rails50
+          ruby: 3.2
         - gemfile: Gemfile.rails51
           ruby: 2.7
         - gemfile: Gemfile.rails51
           ruby: '3.0'
         - gemfile: Gemfile.rails51
           ruby: 3.1
+        - gemfile: Gemfile.rails51
+          ruby: 3.2
         - gemfile: Gemfile.rails52
           ruby: 2.7
         - gemfile: Gemfile.rails52
           ruby: '3.0'
         - gemfile: Gemfile.rails52
           ruby: 3.1
+        - gemfile: Gemfile.rails52
+          ruby: 3.2
         - gemfile: Gemfile.rails70
           ruby: 2.6
 

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2022-09-26 23:40:49 UTC using RuboCop version 1.36.0.
+# on 2022-09-30 23:40:43 UTC using RuboCop version 1.36.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -401,7 +401,7 @@ Layout/SpaceAroundOperators:
     - 'spec/lib/swagger/rake_swagger_spec.rb'
     - 'spec/lib/swagger/swagger_dsl_spec.rb'
 
-# Offense count: 40
+# Offense count: 38
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: EnforcedStyle, EnforcedStyleForEmptyBraces.
 # SupportedStyles: space, no_space
@@ -438,7 +438,7 @@ Layout/SpaceInsideArrayLiteralBrackets:
     - 'lib/apipie/extractor/writer.rb'
     - 'spec/controllers/users_controller_spec.rb'
 
-# Offense count: 95
+# Offense count: 91
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: EnforcedStyle, EnforcedStyleForEmptyBraces, SpaceBeforeBlockParameters.
 # SupportedStyles: space, no_space
@@ -1610,10 +1610,9 @@ Style/MissingRespondToMissing:
   Exclude:
     - 'lib/apipie/apipie_module.rb'
 
-# Offense count: 2
+# Offense count: 1
 Style/MultilineBlockChain:
   Exclude:
-    - 'lib/apipie/method_description.rb'
     - 'lib/apipie/param_description.rb'
 
 # Offense count: 2
@@ -1931,15 +1930,6 @@ Style/StringLiterals:
 Style/SymbolArray:
   EnforcedStyle: brackets
 
-# Offense count: 4
-# This cop supports unsafe autocorrection (--autocorrect-all).
-# Configuration parameters: AllowMethodsWithArguments, AllowedMethods, AllowedPatterns, IgnoredMethods, AllowComments.
-# AllowedMethods: respond_to, define_method
-Style/SymbolProc:
-  Exclude:
-    - 'lib/apipie/method_description.rb'
-    - 'lib/tasks/apipie.rake'
-
 # Offense count: 2
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: EnforcedStyleForMultiline.

data/CHANGELOG.md

@@ -4,7 +4,12 @@
 Also deleted the `Gemfile` that was now a broken symlink.
 please use `export BUNDLE_GEMFILE='gemfiles/Gemfile.rails61'; bundle exec rspec` to run the test suite
 
-
+## [v0.9.1](https://github.com/Apipie/apipie-rails/tree/v0.9.1) (2023-01-16)
+[Full Changelog](https://github.com/Apipie/apipie-rails/compare/v0.9.0...v0.9.1)
+* [Refactor] Create test cache files under a not version controlled directory [#809](https://github.com/Apipie/apipie-rails/pull/809) (Panos Dalitsouris)
+* [Ruby] Support for Ruby 3.2 [#807](https://github.com/Apipie/apipie-rails/pull/807) (Mathieu Jobin)
+* [Fix] Reverted conditional assignment operators that caused #559 [#806](https://github.com/Apipie/apipie-rails/pull/806) (Nick L. Deltik)
+* [Rubocop] Autocorrect Style/SymbolProc [#793](https://github.com/Apipie/apipie-rails/pull/793) (Rubocop Challenger)
 
 ## [v0.9.0](https://github.com/Apipie/apipie-rails/tree/v0.9.0) (2023-01-03)
 [Full Changelog](https://github.com/Apipie/apipie-rails/compare/v0.8.2...v0.9.0)

data/README.rst

@@ -150,7 +150,7 @@ Example:
    resource_description do
      short 'Site members'
      formats ['json']
-     param :id, Fixnum, :desc => "User ID", :required => false
+     param :id, Integer, :desc => "User ID", :required => false
      param :resource_param, Hash, :desc => 'Param description for all methods' do
        param :ausername, String, :desc => "Username for login", :required => true
        param :apassword, String, :desc => "Password for login", :required => true
@@ -1375,7 +1375,7 @@ So we create apipie_validators.rb initializer with this content:
      end
 
      def self.build(param_description, argument, options, block)
-       if argument == Integer || argument == Fixnum
+       if argument == Integer
          self.new(param_description, argument)
        end
      end

data/app/controllers/apipie/apipies_controller.rb

@@ -177,7 +177,7 @@ module Apipie
       end
 
       cache_file = File.join(Apipie.configuration.cache_dir, path)
-      if File.exists?(cache_file)
+      if File.exist?(cache_file)
         content_type = case params[:format]
                        when "json" then "application/json"
                        else "text/html"

data/lib/apipie/application.rb

@@ -242,13 +242,13 @@ module Apipie
 
     # initialize variables for gathering dsl data
     def init_env
-      @resource_descriptions ||= HashWithIndifferentAccess.new { |h, version| h[version] = {} }
-      @controller_to_resource_id ||= {}
-      @param_groups ||= {}
+      @resource_descriptions = HashWithIndifferentAccess.new { |h, version| h[version] = {} }
+      @controller_to_resource_id = {}
+      @param_groups = {}
       @swagger_generator = Apipie::SwaggerGenerator.new(self)
 
       # what versions does the controller belong in (specified by resource_description)?
-      @controller_versions ||= Hash.new { |h, controller| h[controller.to_s] = [] }
+      @controller_versions = Hash.new { |h, controller| h[controller.to_s] = [] }
     end
 
     def recorded_examples

data/lib/apipie/dsl_definition.rb

@@ -139,7 +139,7 @@ module Apipie
       #
       # Example:
       # api :desc => "Show user profile", :path => "/users/", :version => '1.0 - 3.4.2012'
-      # param :id, Fixnum, :desc => "User ID", :required => true
+      # param :id, Integer, :desc => "User ID", :required => true
       # desc <<-EOS
       #   Long description...
       # EOS

data/lib/apipie/extractor/writer.rb

@@ -190,7 +190,7 @@ module Apipie
       end
 
       def load_old_examples
-        if File.exists?(@examples_file)
+        if File.exist?(@examples_file)
           if defined? SafeYAML
             return YAML.load_file(@examples_file, :safe=>false)
           else
@@ -295,7 +295,7 @@ module Apipie
       end
 
       def controller_content
-        raise ControllerNotFound.new unless controller_path && File.exists?(controller_path)
+        raise ControllerNotFound.new unless controller_path && File.exist?(controller_path)
         @controller_content ||= File.read(controller_path)
       end
 

data/lib/apipie/method_description.rb

@@ -35,7 +35,7 @@ module Apipie
 
       @params_ordered = dsl_data[:params].map do |args|
         Apipie::ParamDescription.from_dsl_data(self, args)
-      end.reject{|p| p.response_only? }
+      end.reject(&:response_only?)
 
       @params_ordered = ParamDescription.unify(@params_ordered)
       @headers = dsl_data[:headers]
@@ -84,7 +84,7 @@ module Apipie
       parent = Apipie.get_resource_description(@resource.controller.superclass)
 
       # get tags from parent resource description
-      parent_tags = [parent, @resource].compact.flat_map { |resource| resource._tag_list_arg }
+      parent_tags = [parent, @resource].compact.flat_map(&:_tag_list_arg)
       Apipie::TagListDescription.new((parent_tags + @tag_list).uniq.compact)
     end
 

data/lib/apipie/resource_description.rb

@@ -7,7 +7,7 @@ module Apipie
   # path - relative path (/api/articles)
   # methods - array of keys to Apipie.method_descriptions (array of Apipie::MethodDescription)
   # name - human readable alias of resource (Articles)
-  # id - resouce name
+  # id - resource name
   # formats - acceptable request/response format types
   # headers - array of headers
   # deprecated - boolean indicating if resource is deprecated

data/lib/apipie/version.rb

@@ -1,3 +1,3 @@
 module Apipie
-  VERSION = "0.9.0"
+  VERSION = "0.9.1"
 end

data/lib/tasks/apipie.rake

@@ -85,7 +85,7 @@ namespace :apipie do
           counter = 1
           make_reference = true
         else
-          reference_files.sort_by! {|f| f.ctime }
+          reference_files.sort_by!(&:ctime)
           last_ref = reference_files[-1]
           print "Comparing [#{path}] to reference file: [#{last_ref.basename}]: "
           if !FileUtils.compare_file(path, last_ref)
@@ -108,7 +108,7 @@ namespace :apipie do
 
         num_refs_to_keep = 3
         if reference_files.length > num_refs_to_keep
-          (reference_files - reference_files[-num_refs_to_keep..-1]).each{|f| f.delete}
+          (reference_files - reference_files[-num_refs_to_keep..-1]).each(&:delete)
         end
       }
     end

data/spec/controllers/apipies_controller_spec.rb

@@ -253,7 +253,7 @@ describe Apipie::ApipiesController do
     let(:cache_dir) { File.join(Rails.root, "tmp", "apipie-cache") }
 
     before do
-      FileUtils.rm_r(cache_dir) if File.exists?(cache_dir)
+      FileUtils.rm_r(cache_dir) if File.exist?(cache_dir)
       FileUtils.mkdir_p(File.join(cache_dir, "apidoc", "v1", "resource"))
       File.open(File.join(cache_dir, "apidoc", "v1.html"), "w") { |f| f << "apidoc.html cache v1" }
       File.open(File.join(cache_dir, "apidoc", "v2.html"), "w") { |f| f << "apidoc.html cache v2" }
@@ -272,7 +272,7 @@ describe Apipie::ApipiesController do
       Apipie.configuration.use_cache = false
       Apipie.configuration.default_version = @orig_version
       Apipie.configuration.cache_dir = @orig_cache_dir
-      # FileUtils.rm_r(cache_dir) if File.exists?(cache_dir)
+      # FileUtils.rm_r(cache_dir) if File.exist?(cache_dir)
     end
 
     it "uses the file in cache dir instead of generating the content on runtime" do

data/spec/controllers/users_controller_spec.rb

@@ -51,7 +51,7 @@ describe UsersController do
       expect(subject._params_args.count).to eq(2)
       name, type, options = subject._params_args.first
       expect(name).to eq(:id)
-      expect(type).to eq(Fixnum)
+      expect(type).to eq(Integer)
       expect(options).to eq({:required=>false, :desc=>"User ID"})
     end
   end

data/spec/dummy/app/controllers/users_controller.rb

@@ -4,7 +4,7 @@ class UsersController < ApplicationController
     short 'Site members'
     path '/users'
     formats ['json']
-    param :id, Fixnum, :desc => "User ID", :required => false
+    param :id, Integer, :desc => "User ID", :required => false
     param :legacy_param, Hash, :desc => 'Deprecated parameter not documented', :show => false, :required => false do
       param :resource_param, Hash, :desc => 'Param description for all methods' do
         param :ausername, String, :desc => "Username for login", :required => true

data/spec/dummy/config/initializers/apipie.rb

@@ -23,7 +23,7 @@ Apipie.configure do |config|
   #     rake apipie:cache
   #
   config.use_cache = Rails.env.production?
-  # config.cache_dir = File.join(Rails.root, "public", "apipie-cache") # optional
+  config.cache_dir = File.join(Rails.root, "tmp", "apipie-cache") # optional
 
   # set to enable/disable reloading controllers (and the documentation with it),
   # by default enabled in development
@@ -89,7 +89,7 @@ class Apipie::Validator::IntegerValidator < Apipie::Validator::BaseValidator
   end
 
   def self.build(param_description, argument, options, block)
-    if argument == Integer || argument == Fixnum
+    if argument == Integer
       self.new(param_description, argument)
     end
   end

data/spec/lib/extractor/writer_spec.rb

@@ -106,7 +106,7 @@ describe Apipie::Extractor::Writer do
     end
 
     after do
-      File.unlink(test_examples_file) if File.exists?(test_examples_file)
+      File.unlink(test_examples_file) if File.exist?(test_examples_file)
     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

@@ -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/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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apipie-rails
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.1
 platform: ruby
 authors:
 - Pavel Pokorny
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-02 00:00:00.000000000 Z
+date: 2023-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack