Merge pull request #71 from civisanalytics/civis-5620-ruby-3-support

[CIVIS-5620] Ruby 3 support

Author: vfu116

.rubocop.yml

@@ -1,7 +1,8 @@
 AllCops:
-  TargetRubyVersion: 2.1
+  TargetRubyVersion: 2.7
+  NewCops: enable
 
-Layout/IndentHeredoc:
+Layout/HeredocIndentation:
   Enabled: false
 
 Metrics/AbcSize:
@@ -15,7 +16,7 @@ Metrics/BlockLength:
 Metrics/ClassLength:
   Max: 250
 
-Metrics/LineLength:
+Layout/LineLength:
   Max: 120
 
 Metrics/MethodLength:
@@ -31,7 +32,7 @@ Security/YAMLLoad:
 Style/Documentation:
   Enabled: false
 
-Style/FileName:
+Naming/FileName:
   Enabled: false
 
 Style/FrozenStringLiteralComment:

.ruby-version

@@ -1 +1 @@
-2.5.0
+3.2.1

.travis.yml

@@ -1,12 +1,10 @@
 language: ruby
 cache: bundler
 rvm:
-  - 2.0
-  - 2.1.10
-  - 2.2.9
-  - 2.3.6
-  - 2.4.3
-  - 2.5.0
+  - 2.7.7
+  - 3.0.5
+  - 3.1.3
+  - 3.2.1
 before_install:
   - gem update --system
   - rvm @global do gem install bundler

CHANGELOG.md

@@ -5,17 +5,15 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
-### Added
-
-* Added 2.5.0 to the Travis matrix
+## [2.0.0]
 
 ### Changed
 
-* Bumped the Ruby version for development to 2.5.0
-* Bumped the Travis matrix to 2.2.9, 2.3.6, and 2.4.3
-* Bumped the Pry version for development to 0.11
-* Bumped the Rake version for development to 12
-* Bumped the VCR version for development to 4
+* Bumped the Ruby version for development to 2.7.7
+* Bumped the RuboCop version for development to 1.48.0
+* Bumped the Travis matrix to 2.7.7, 3.0.5, 3.1.3, 3.2.1
+* Bumped the Pry version for development to 0.14.1
+* Bumped the VCR version for development to 6.1
 * RuboCop fixes
 
 ## [1.1.2] - 2017-09-13

lib/swagger/diff/diff.rb

@@ -133,6 +133,7 @@ def new_or_changed_request_params
       def new_child?(req, old)
         idx = req.rindex('/')
         return false unless idx
+
         key = req[0..idx]
         old.none? { |param| param.start_with?(key) }
       end
@@ -142,8 +143,10 @@ def changed_request_params_enumerator(from, to, req_msg, missing_msg)
           from.request_params.each do |key, old_params|
             new_params = to.request_params[key]
             next if new_params.nil?
+
             (new_params[:required] - old_params[:required]).each do |req|
               next if new_child?(req, old_params[:all])
+
               yielder << [key, format(req_msg, req: req)]
             end
             (old_params[:all] - new_params[:all]).each do |req|
@@ -181,7 +184,8 @@ def changed_response_attributes_enumerator(from, to, attr_msg, code_msg)
           from.response_attributes.each do |key, old_attributes|
             new_attributes = to.response_attributes[key]
             next if new_attributes.nil?
-            old_attributes.keys.each do |code|
+
+            old_attributes.each_key do |code|
               if new_attributes.key?(code)
                 (old_attributes[code] - new_attributes[code]).each do |resp|
                   yielder << [key, format(attr_msg, code: code, resp: resp)]

lib/swagger/diff/specification.rb

@@ -14,46 +14,48 @@ def endpoints
 
       def request_params
         @request_params ||= begin
-                              ret = {}
-                              @endpoint_hash.each do |key, endpoint|
-                                ret[key] = request_params_inner(params_or_nil(endpoint))
-                              end
-                              ret
-                            end
+          ret = {}
+          @endpoint_hash.each do |key, endpoint|
+            ret[key] = request_params_inner(params_or_nil(endpoint))
+          end
+          ret
+        end
       end
 
       def response_attributes
         @response_attributes ||= begin
-                                   ret = {}
-                                   @endpoint_hash.each do |key, endpoint|
-                                     ret[key] = response_attributes_inner(endpoint)
-                                   end
-                                   ret
-                                 end
+          ret = {}
+          @endpoint_hash.each do |key, endpoint|
+            ret[key] = response_attributes_inner(endpoint)
+          end
+          ret
+        end
       end
 
       private
 
-      def merge_refs!(h1, h2)
-        h2.each do |k, v|
-          if h1.include?(k)
-            h1[k] += h1[k].merge(v)
+      def merge_refs!(hash1, hash2)
+        hash2.each do |k, v|
+          if hash1.include?(k)
+            hash1[k] += hash1[k].merge(v)
           else
-            h1[k] = v
+            hash1[k] = v
           end
         end
       end
 
       def params_or_nil(endpoint)
-        endpoint && endpoint['parameters'] || nil
+        (endpoint && endpoint['parameters']) || nil
       end
 
       def parse_swagger(swagger)
         if swagger.is_a? Hash
           swagger
         else
-          if File.exist?(swagger) || swagger[0..7] =~ %r{^https?://}
-            swagger = open(swagger).read
+          if File.exist?(swagger)
+            swagger = File.read(swagger)
+          elsif swagger[0..7] =~ %r{^https?://}
+            swagger = URI.parse(swagger).read
           end
           begin
             JSON.parse(swagger)
@@ -104,7 +106,7 @@ def refs(ref, prefix = '')
                  {}
                end
         idx = ref.rindex('/')
-        key = ref[idx + 1..-1]
+        key = ref[idx + 1..]
         schema(defs.fetch(key, {}), prefix)
       end
 
@@ -150,7 +152,7 @@ def schema(definition, prefix = '')
       # rubocop:enable Metrics/CyclomaticComplexity
       # rubocop:enable Metrics/AbcSize
 
-      def nested(ref, prefix, name, list = false)
+      def nested(ref, prefix, name, list: false)
         # Check for cycles by testing whether name was already added to
         # prefix.
         key = "#{prefix}#{name}#{'[]' if list}"
@@ -175,20 +177,16 @@ def properties_for_param(prefix, definition)
       # rubocop:disable Metrics/ParameterLists
       def add_property(ret, prefix, name, schema, required, list)
         key = "#{prefix}#{name}"
-        ret[:required].add(key) if required && required.include?(name)
-        loc = if schema['in']
-                schema['in']
-              else
-                'body'
-              end
+        ret[:required].add(key) if required&.include?(name)
+        loc = schema['in'] || 'body'
         ret[:all].add("#{key} (in: #{loc}, type: #{schema['type']}#{'[]' if list})")
       end
       # rubocop:enable Metrics/ParameterLists
 
-      def properties_for_ref(prefix, name, schema, required, list = false)
+      def properties_for_ref(prefix, name, schema, required, list: false)
         ret = { required: Set.new, all: Set.new }
         if schema['$ref']
-          merge_refs!(ret, nested(schema['$ref'], prefix, name, list))
+          merge_refs!(ret, nested(schema['$ref'], prefix, name, list: list))
         elsif schema['properties']
           prefix = "#{name}#{'[]' if list}/"
           merge_refs!(ret, properties(schema['properties'], schema['required'], prefix))
@@ -224,7 +222,7 @@ def properties(properties, required, prefix = '')
         ret = { required: Set.new, all: Set.new }
         properties.each do |name, schema|
           if schema['type'] == 'array'
-            merge_refs!(ret, properties_for_ref(prefix, name, schema['items'], required, true))
+            merge_refs!(ret, properties_for_ref(prefix, name, schema['items'], required, list: true))
           elsif schema['type'] == 'object' || schema['properties']
             if schema['allOf']
               # TODO: handle nested allOfs.
@@ -243,6 +241,7 @@ def properties(properties, required, prefix = '')
       def request_params_inner(params)
         ret = { required: Set.new, all: Set.new }
         return ret if params.nil?
+
         params.each do |param|
           if param['in'] == 'body'
             merge_refs!(ret, schema(param['schema']))
@@ -287,6 +286,7 @@ def validate_swagger
         JSON::Validator.add_schema(json_schema)
         errors = JSON::Validator.fully_validate(schema_for('oai'), JSON.dump(@parsed))
         return if errors.empty?
+
         spec = if @spec.to_s.length > 80
                  "#{@spec.to_s[0..74]} ..."
                else

spec/swagger/diff/rspec_matchers_spec.rb

@@ -53,7 +53,7 @@
 
     it 'should raise Exception without contents when incompatible' do
       msg = 'expected Swagger to be compatible, found:'
-      expected = File.open('spec/fixtures/dummy.v1.json').read
+      expected = File.read('spec/fixtures/dummy.v1.json')
       expect do
         expect('spec/fixtures/dummy.v2.json').to be_compatible_with(expected)
       end.to raise_error(RSpec::Expectations::ExpectationNotMetError, /#{msg}/)

spec/swagger/diff/specification_spec.rb

@@ -28,19 +28,19 @@
     end
 
     it 'from JSON string' do
-      contents = File.open('spec/fixtures/petstore.json', 'r').read
+      contents = File.read('spec/fixtures/petstore.json')
       spec = Swagger::Diff::Specification.new(contents)
       expect(spec.instance_variable_get(:@parsed)['swagger']).to eq('2.0')
     end
 
     it 'from YAML string' do
-      contents = File.open('spec/fixtures/petstore.yaml', 'r').read
+      contents = File.read('spec/fixtures/petstore.yaml')
       spec = Swagger::Diff::Specification.new(contents)
       expect(spec.instance_variable_get(:@parsed)['swagger']).to eq('2.0')
     end
 
     it 'from Hash' do
-      contents = File.open('spec/fixtures/petstore.json', 'r').read
+      contents = File.read('spec/fixtures/petstore.json')
       hash = JSON.parse(contents)
       spec = Swagger::Diff::Specification.new(hash)
       expect(spec.instance_variable_get(:@parsed)['swagger']).to eq('2.0')
@@ -224,7 +224,7 @@
 {"swagger"=>"2.0", "info"=>{"title"=>"Swagger Fixture", "version"=>"1.0"},  ... is not a valid Swagger specification:
 
 The property '#/paths//a//get' did not contain a required property of 'responses' in schema http://swagger.io/v2/schema.json#
-                     WARNING
+        WARNING
                     ).to_stderr
       end
     end

swagger-diff.gemspec

@@ -25,15 +25,16 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '~> 2.0'
+  spec.required_ruby_version = '>= 2.7'
 
-  spec.add_dependency 'json-schema', '~> 2.6'
+  spec.add_dependency 'json-schema', '~> 3.0'
   spec.add_dependency 'rspec-expectations', '~> 3.3'
-  spec.add_development_dependency 'bundler', '~> 1.9'
-  spec.add_development_dependency 'pry', '~> 0.11.3'
+  spec.add_development_dependency 'bundler', '~> 2.4.9'
+  spec.add_development_dependency 'pry', '~> 0.14.1'
   spec.add_development_dependency 'rake', '~> 12.3'
   spec.add_development_dependency 'rspec', '~> 3.3'
-  spec.add_development_dependency 'rubocop', '~> 0.49.0'
-  spec.add_development_dependency 'vcr', '~> 4.0'
+  spec.add_development_dependency 'rubocop', '~> 1.48.1'
+  spec.add_development_dependency 'vcr', '~> 6.1'
   spec.add_development_dependency 'webmock', '~> 3.0'
+  spec.metadata['rubygems_mfa_required'] = 'true'
 end