swagger-diff 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7025ab8a26aa9eb452cbb399bf2fbde273f46299
-  data.tar.gz: 2a57c963078b714a2e1fa042ce12b2c3fbfa37a3
+  metadata.gz: ddac5fb36158431f343142208ecd61a858bd66cf
+  data.tar.gz: 74fab6bd47f4cf4c52865451bb25dc0fa082591b
 SHA512:
-  metadata.gz: 5963d3d5faf6c84097ffa29ab5cbe45a91b9b7dfa945571aa418ea6a1cb48c9c907a125f47df06c31f5f8b6bb4bdb0c0043a339d15fdb0ccebb6c4545e79b575
-  data.tar.gz: 5f3579dd89962e0ebb2e88440f8b195886a00002fc147b94e0369f81be4ec2a686dc008918e4a5b129374e089691ebbc3ecfdb57c60bc8359857d00b6da76127
+  metadata.gz: b23daecdda524a3181d6c321a73ddabcd6a1431320caccebd1fee8a17ff33c4cd5bc74385e1a97b268f7d2c02faecc87573ed1d8c60310076b707722b9db466b
+  data.tar.gz: 2213e486e794349ea51a0dc38fcd4d3f03748285a40050b0e1c4a070b75e22ffc65ad842742c44b1ce31576d2e3a558399dfe05238108167ec05e2887fc4aae4

data/.rubocop.yml

@@ -1,8 +1,19 @@
+AllCops:
+  TargetRubyVersion: 2.4
+
+Layout/IndentHeredoc:
+  Enabled: false
+
 Metrics/AbcSize:
   Max: 30
 
+Metrics/BlockLength:
+  Exclude:
+    - 'swagger-diff.gemspec'
+    - 'spec/**/*.rb'
+
 Metrics/ClassLength:
-  Max: 240
+  Max: 250
 
 Metrics/LineLength:
   Max: 120
@@ -13,8 +24,15 @@ Metrics/MethodLength:
 Metrics/PerceivedComplexity:
   Max: 10
 
+# YAML.safe_load is not present in Ruby 2.0.
+Security/YAMLLoad:
+  Enabled: false
+
 Style/Documentation:
   Enabled: false
 
 Style/FileName:
   Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false

data/.ruby-version

@@ -1 +1 @@
-2.3.1
+2.4.1

data/.travis.yml

@@ -2,9 +2,10 @@ language: ruby
 cache: bundler
 rvm:
   - 2.0
-  - 2.1.9
-  - 2.2.5
-  - 2.3.1
+  - 2.1.10
+  - 2.2.7
+  - 2.3.4
+  - 2.4.1
 before_install:
   - gem update --system
   - rvm @global do gem install bundler

data/CHANGELOG.md

@@ -5,6 +5,25 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+## [1.1.1] - 2017-08-23
+
+### Added
+
+* Added 2.4 to the Travis matrix
+
+### Changed
+
+* Bumped the Ruby version for development to 2.4.1
+* Bumped the RuboCop version for development to 0.49
+* Bumped the WebMock version for development to 3
+* Bumped the Travis matrix to 2.1.10, 2.2.7, and 2.3.4
+* RuboCop fixes
+
+### Fixed
+
+* [#51](https://github.com/civisanalytics/swagger-diff/pull/51)
+  parse nested inline objects
+
 ## [1.1.0] - 2016-05-20
 
 ### Added
@@ -78,7 +97,8 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 * Initial Release
 
-[Unreleased]: https://github.com/civisanalytics/swagger-diff/compare/v1.1.0...HEAD
+[Unreleased]: https://github.com/civisanalytics/swagger-diff/compare/v1.1.1...HEAD
+[1.1.1]: https://github.com/civisanalytics/swagger-diff/compare/v1.1.0...v1.1.1
 [1.1.0]: https://github.com/civisanalytics/swagger-diff/compare/v1.0.5...v1.1.0
 [1.0.5]: https://github.com/civisanalytics/swagger-diff/compare/v1.0.4...v1.0.5
 [1.0.4]: https://github.com/civisanalytics/swagger-diff/compare/v1.0.3...v1.0.4

data/README.md

@@ -51,11 +51,11 @@ Or install it yourself as:
 
 ## Usage
 
-Swagger specifications can be any valid Swagger file format, raw or parsed:
+OAI specifications can be any valid OAI file format, raw or parsed:
 
 - the path to a file containing an OAI specification.
-  This may be local (*e.g.*, `/path/to/swagger.json`) or remote (*e.g.*,
-  `http://host.domain/swagger.yml`)
+  This may be local (*e.g.*, `/path/to/specification.json`) or remote (*e.g.*,
+  `http://host.domain/specification.yml`)
 - a Hash containing a parsed OAI specification (*e.g.*, the output of
   `JSON.parse`)
 - a string of JSON containing an OAI specification

data/Rakefile

@@ -6,4 +6,4 @@ RSpec::Core::RakeTask.new
 require 'rubocop/rake_task'
 RuboCop::RakeTask.new
 
-task default: [:rubocop, :spec]
+task default: %i[rubocop spec]

data/lib/swagger/diff/diff.rb

@@ -124,8 +124,8 @@ module Swagger
         enumerator = changed_request_params_enumerator(
           @new_specification,
           @old_specification,
-          '%{req} is no longer required',
-          'new request param: %{req}'
+          '%<req>s is no longer required',
+          'new request param: %<req>s'
         )
         change_hash(enumerator)
       end
@@ -134,7 +134,7 @@ module Swagger
         idx = req.rindex('/')
         return false unless idx
         key = req[0..idx]
-        !old.any? { |param| param.start_with?(key) }
+        old.none? { |param| param.start_with?(key) }
       end
 
       def changed_request_params_enumerator(from, to, req_msg, missing_msg)
@@ -144,10 +144,10 @@ module Swagger
             next if new_params.nil?
             (new_params[:required] - old_params[:required]).each do |req|
               next if new_child?(req, old_params[:all])
-              yielder << [key, req_msg % { req: req }]
+              yielder << [key, format(req_msg, req: req)]
             end
             (old_params[:all] - new_params[:all]).each do |req|
-              yielder << [key, missing_msg % { req: req }]
+              yielder << [key, format(missing_msg, req: req)]
             end
           end
         end.lazy
@@ -157,8 +157,8 @@ module Swagger
         changed_request_params_enumerator(
           @old_specification,
           @new_specification,
-          'new required request param: %{req}',
-          'missing request param: %{req}'
+          'new required request param: %<req>s',
+          'missing request param: %<req>s'
         )
       end
 
@@ -170,8 +170,8 @@ module Swagger
         enumerator = changed_response_attributes_enumerator(
           @new_specification,
           @old_specification,
-          'new attribute for %{code} response: %{resp}',
-          'new %{code} response'
+          'new attribute for %<code>s response: %<resp>s',
+          'new %<code>s response'
         )
         change_hash(enumerator)
       end
@@ -184,10 +184,10 @@ module Swagger
             old_attributes.keys.each do |code|
               if new_attributes.key?(code)
                 (old_attributes[code] - new_attributes[code]).each do |resp|
-                  yielder << [key, attr_msg % { code: code, resp: resp }]
+                  yielder << [key, format(attr_msg, code: code, resp: resp)]
                 end
               else
-                yielder << [key, code_msg % { code: code }]
+                yielder << [key, format(code_msg, code: code)]
               end
             end
           end
@@ -198,8 +198,8 @@ module Swagger
         changed_response_attributes_enumerator(
           @old_specification,
           @new_specification,
-          'missing attribute from %{code} response: %{resp}',
-          'missing %{code} response'
+          'missing attribute from %<code>s response: %<resp>s',
+          'missing %<code>s response'
         )
       end
 

data/lib/swagger/diff/specification.rb

@@ -211,6 +211,7 @@ module Swagger
         "#{key} (in: body, type: Hash[string, #{type}])"
       end
 
+      # rubocop:disable Metrics/CyclomaticComplexity
       def properties(properties, required, prefix = '')
         ret = { required: Set.new, all: Set.new }
         properties.each do |name, schema|
@@ -219,6 +220,8 @@ module Swagger
           elsif schema['type'] == 'object'
             if schema['allOf']
               # TODO: handle nested allOfs.
+            elsif schema['type'] && schema['type'] == 'object' && schema['properties']
+              merge_refs!(ret, properties(schema['properties'], required, "#{prefix}#{name}/"))
             else
               ret[:all].add(hash_property(schema, prefix, name))
             end
@@ -228,6 +231,7 @@ module Swagger
         end
         ret
       end
+      # rubocop:enable Metrics/CyclomaticComplexity
 
       def request_params_inner(params)
         ret = { required: Set.new, all: Set.new }
@@ -275,14 +279,13 @@ module Swagger
         end
         JSON::Validator.add_schema(json_schema)
         errors = JSON::Validator.fully_validate(schema_for('oai'), JSON.dump(@parsed))
-        unless errors.empty?
-          spec = if @spec.to_s.length > 80
-                   "#{@spec.to_s[0..74]} ..."
-                 else
-                   @spec
-                 end
-          warn "#{spec} is not a valid Swagger specification:\n\n#{errors.join("\n")}"
-        end
+        return if errors.empty?
+        spec = if @spec.to_s.length > 80
+                 "#{@spec.to_s[0..74]} ..."
+               else
+                 @spec
+               end
+        warn "#{spec} is not a valid Swagger specification:\n\n#{errors.join("\n")}"
       end
     end
   end

data/lib/swagger/diff/version.rb

@@ -1,5 +1,5 @@
 module Swagger
   module Diff
-    VERSION = '1.1.0'.freeze
+    VERSION = '1.1.1'.freeze
   end
 end

data/swagger-diff.gemspec

@@ -1,4 +1,5 @@
 # coding: utf-8
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'swagger/diff/version'
@@ -34,7 +35,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 11.1'
   spec.add_development_dependency 'rspec', '~> 3.3'
   spec.add_development_dependency 'pry', '~> 0.10.1'
-  spec.add_development_dependency 'rubocop', '~> 0.40.0'
+  spec.add_development_dependency 'rubocop', '~> 0.49.0'
   spec.add_development_dependency 'vcr', '~> 3.0'
-  spec.add_development_dependency 'webmock', '~> 2.0'
+  spec.add_development_dependency 'webmock', '~> 3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: swagger-diff
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Jeff Cousens
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-05-20 00:00:00.000000000 Z
+date: 2017-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json-schema
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.40.0
+        version: 0.49.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.40.0
+        version: 0.49.0
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
@@ -128,14 +128,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
 description: Swagger::Diff is a utility for comparing two different Open API Initiative
   (OAI) specifications (fka Swagger specifications). It is intended to determine whether
   a newer API specification is backwards-compatible with an older API specification.
@@ -193,7 +193,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.4
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Utility for comparing two OAI (fka Swagger) specifications.