Don't require multi_json and multi_xml.

Author: dblock

.rubocop_todo.yml

@@ -1,16 +1,22 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2017-06-12 13:25:24 -0600 using RuboCop version 0.47.0.
+# on 2017-06-13 11:28:56 -0400 using RuboCop version 0.47.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
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 44
+# Offense count: 2
+Lint/HandleExceptions:
+  Exclude:
+    - 'lib/grape/util/json.rb'
+    - 'lib/grape/util/xml.rb'
+
+# Offense count: 45
 Metrics/AbcSize:
   Max: 44
 
-# Offense count: 277
+# Offense count: 278
 # Configuration parameters: CountComments, ExcludedMethods.
 Metrics/BlockLength:
   Max: 3104
@@ -24,7 +30,7 @@ Metrics/ClassLength:
 Metrics/CyclomaticComplexity:
   Max: 14
 
-# Offense count: 1098
+# Offense count: 1102
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
 # URISchemes: http, https
 Metrics/LineLength:

CHANGELOG.md

@@ -6,6 +6,7 @@
 * [#1622](https://github.com/ruby-grape/grape/pull/1622): Add `except_values` validator to replace `except` option of `values` validator - [@jlfaber](https://github.com/jlfaber).
 * [#1635](https://github.com/ruby-grape/grape/pull/1635): Instrument validators with ActiveSupport::Notifications - [@ktimothy](https://github.com/ktimothy).
 * [#1646](https://github.com/ruby-grape/grape/pull/1646): Add ability to include an array of modules as helpers - [@pablonahuelgomez](https://github.com/pablonahuelgomez).
+* [#1623](https://github.com/ruby-grape/grape/pull/1623): Removed `multi_json` and `multi_xml` dependencies - [@dblock](https://github.com/dblock).
 * Your contribution here.
 
 #### Fixes

Gemfile

@@ -22,6 +22,8 @@ group :development do
 end
 
 group :test do
+  gem 'multi_json'
+  gem 'multi_xml'
   gem 'grape-entity', '~> 0.6'
   gem 'maruku'
   gem 'rack-test'

gemfiles/rack_1.5.2.gemfile

@@ -22,6 +22,8 @@ group :development do
 end
 
 group :test do
+  gem 'multi_json'
+  gem 'multi_xml'
   gem 'grape-entity', '~> 0.6'
   gem 'maruku'
   gem 'rack-test'

gemfiles/rack_edge.gemfile

@@ -22,6 +22,8 @@ group :development do
 end
 
 group :test do
+  gem 'multi_json'
+  gem 'multi_xml'
   gem 'grape-entity', '~> 0.6'
   gem 'maruku'
   gem 'rack-test'

gemfiles/rails_3.gemfile

@@ -23,6 +23,8 @@ group :development do
 end
 
 group :test do
+  gem 'multi_json'
+  gem 'multi_xml'
   gem 'grape-entity', '~> 0.6'
   gem 'maruku'
   gem 'rack-test'

gemfiles/rails_4.gemfile

@@ -22,6 +22,8 @@ group :development do
 end
 
 group :test do
+  gem 'multi_json'
+  gem 'multi_xml'
   gem 'grape-entity', '~> 0.6'
   gem 'maruku'
   gem 'rack-test'

gemfiles/rails_5.gemfile

@@ -22,6 +22,8 @@ group :development do
 end
 
 group :test do
+  gem 'multi_json'
+  gem 'multi_xml'
   gem 'grape-entity', '~> 0.6'
   gem 'maruku'
   gem 'rack-test'

gemfiles/rails_edge.gemfile

@@ -22,6 +22,8 @@ group :development do
 end
 
 group :test do
+  gem 'multi_json'
+  gem 'multi_xml'
   gem 'grape-entity', '~> 0.6'
   gem 'maruku'
   gem 'rack-test'

grape.gemspec

@@ -16,8 +16,6 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'mustermann-grape', '~> 1.0.0'
   s.add_runtime_dependency 'rack-accept'
   s.add_runtime_dependency 'activesupport'
-  s.add_runtime_dependency 'multi_json', '>= 1.3.2'
-  s.add_runtime_dependency 'multi_xml', '>= 0.5.2'
   s.add_runtime_dependency 'virtus', '>= 1.0.0'
   s.add_runtime_dependency 'builder'
 

lib/grape.rb

@@ -16,8 +16,6 @@
 require 'active_support/core_ext/hash/conversions'
 require 'active_support/dependencies/autoload'
 require 'active_support/notifications'
-require 'multi_json'
-require 'multi_xml'
 require 'i18n'
 require 'thread'
 
@@ -44,6 +42,8 @@ module Grape
     autoload :Parser
     autoload :Request
     autoload :Env, 'grape/util/env'
+    autoload :Json, 'grape/util/json'
+    autoload :Xml, 'grape/util/xml'
   end
 
   module Http

lib/grape/error_formatter/json.rb

@@ -10,7 +10,7 @@ def call(message, backtrace, options = {}, env = nil)
           if (options[:rescue_options] || {})[:backtrace] && backtrace && !backtrace.empty?
             result = result.merge(backtrace: backtrace)
           end
-          MultiJson.dump(result)
+          ::Grape::Json.dump(result)
         end
 
         private

lib/grape/error_formatter/txt.rb

@@ -7,7 +7,7 @@ class << self
         def call(message, backtrace, options = {}, env = nil)
           message = present(message, env)
 
-          result = message.is_a?(Hash) ? MultiJson.dump(message) : message
+          result = message.is_a?(Hash) ? ::Grape::Json.dump(message) : message
           if (options[:rescue_options] || {})[:backtrace] && backtrace && !backtrace.empty?
             result += "\r\n "
             result += backtrace.join("\r\n ")

lib/grape/formatter/json.rb

@@ -4,7 +4,7 @@ module Json
       class << self
         def call(object, _env)
           return object.to_json if object.respond_to?(:to_json)
-          MultiJson.dump(object)
+          ::Grape::Json.dump(object)
         end
       end
     end

lib/grape/formatter/serializable_hash.rb

@@ -4,9 +4,9 @@ module SerializableHash
       class << self
         def call(object, _env)
           return object if object.is_a?(String)
-          return MultiJson.dump(serialize(object)) if serializable?(object)
+          return ::Grape::Json.dump(serialize(object)) if serializable?(object)
           return object.to_json if object.respond_to?(:to_json)
-          MultiJson.dump(object)
+          ::Grape::Json.dump(object)
         end
 
         private

lib/grape/parser/json.rb

@@ -3,8 +3,8 @@ module Parser
     module Json
       class << self
         def call(object, _env)
-          MultiJson.load(object)
-        rescue MultiJson::ParseError
+          ::Grape::Json.load(object)
+        rescue ::Grape::Json::ParseError
           # handle JSON parsing errors via the rescue handlers or provide error message
           raise Grape::Exceptions::InvalidMessageBody, 'application/json'
         end

lib/grape/parser/xml.rb

@@ -3,8 +3,8 @@ module Parser
     module Xml
       class << self
         def call(object, _env)
-          MultiXml.parse(object)
-        rescue MultiXml::ParseError
+          ::Grape::Xml.parse(object)
+        rescue ::Grape::Xml::ParseError
           # handle XML parsing errors via the rescue handlers or provide error message
           raise Grape::Exceptions::InvalidMessageBody, 'application/xml'
         end

lib/grape/util/json.rb

@@ -0,0 +1,13 @@
+begin
+  require 'multi_json'
+rescue LoadError
+end
+
+module Grape
+  if Object.const_defined? :MultiJson
+    Json = ::MultiJson
+  else
+    Json = ::JSON
+    Json::ParseError = Json::ParserError
+  end
+end

lib/grape/util/xml.rb

@@ -0,0 +1,13 @@
+begin
+  require 'multi_xml'
+rescue LoadError
+end
+
+module Grape
+  if Object.const_defined? :MultiXml
+    Xml = ::MultiXml
+  else
+    Xml = ::ActiveSupport::XmlMini
+    Xml::ParseError = StandardError
+  end
+end

spec/grape/api/invalid_format_spec.rb

@@ -27,17 +27,17 @@ def app
     it 'no format' do
       get '/foo'
       expect(last_response.status).to eq 200
-      expect(last_response.body).to eq(MultiJson.dump(id: 'foo', format: nil))
+      expect(last_response.body).to eq(::Grape::Json.dump(id: 'foo', format: nil))
     end
     it 'json format' do
       get '/foo.json'
       expect(last_response.status).to eq 200
-      expect(last_response.body).to eq(MultiJson.dump(id: 'foo', format: 'json'))
+      expect(last_response.body).to eq(::Grape::Json.dump(id: 'foo', format: 'json'))
     end
     it 'invalid format' do
       get '/foo.invalid'
       expect(last_response.status).to eq 200
-      expect(last_response.body).to eq(MultiJson.dump(id: 'foo', format: 'invalid'))
+      expect(last_response.body).to eq(::Grape::Json.dump(id: 'foo', format: 'invalid'))
     end
   end
 end

spec/grape/api_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 require 'shared/versioning_examples'
-require 'grape-entity'
+# require 'grape-entity'
 
 describe Grape::API do
   subject { Class.new(Grape::API) }
@@ -444,29 +444,29 @@ class DummyFormatClass
             subject.send(verb) do
               env['api.request.body']
             end
-            send verb, '/', MultiJson.dump(object), 'CONTENT_TYPE' => 'application/json'
+            send verb, '/', ::Grape::Json.dump(object), 'CONTENT_TYPE' => 'application/json'
             expect(last_response.status).to eq(verb == :post ? 201 : 200)
-            expect(last_response.body).to eql MultiJson.dump(object)
+            expect(last_response.body).to eql ::Grape::Json.dump(object)
             expect(last_request.params).to eql({})
           end
           it 'stores input in api.request.input' do
             subject.format :json
             subject.send(verb) do
               env['api.request.input']
             end
-            send verb, '/', MultiJson.dump(object), 'CONTENT_TYPE' => 'application/json'
+            send verb, '/', ::Grape::Json.dump(object), 'CONTENT_TYPE' => 'application/json'
             expect(last_response.status).to eq(verb == :post ? 201 : 200)
-            expect(last_response.body).to eql MultiJson.dump(object).to_json
+            expect(last_response.body).to eql ::Grape::Json.dump(object).to_json
           end
           context 'chunked transfer encoding' do
             it 'stores input in api.request.input' do
               subject.format :json
               subject.send(verb) do
                 env['api.request.input']
               end
-              send verb, '/', MultiJson.dump(object), 'CONTENT_TYPE' => 'application/json', 'HTTP_TRANSFER_ENCODING' => 'chunked', 'CONTENT_LENGTH' => nil
+              send verb, '/', ::Grape::Json.dump(object), 'CONTENT_TYPE' => 'application/json', 'HTTP_TRANSFER_ENCODING' => 'chunked', 'CONTENT_LENGTH' => nil
               expect(last_response.status).to eq(verb == :post ? 201 : 200)
-              expect(last_response.body).to eql MultiJson.dump(object).to_json
+              expect(last_response.body).to eql ::Grape::Json.dump(object).to_json
             end
           end
         end
@@ -2053,7 +2053,7 @@ def self.call(message, _backtrace, _option, _env)
         raise 'rain!'
       end
       get '/exception'
-      json = MultiJson.load(last_response.body)
+      json = ::Grape::Json.load(last_response.body)
       expect(json['error']).to eql 'rain!'
       expect(json['backtrace'].length).to be > 0
     end
@@ -3156,7 +3156,7 @@ def static
     end
     it 'path' do
       get '/endpoint/options'
-      options = MultiJson.load(last_response.body)
+      options = ::Grape::Json.load(last_response.body)
       expect(options['path']).to eq(['/endpoint/options'])
       expect(options['source_location'][0]).to include 'api_spec.rb'
       expect(options['source_location'][1].to_i).to be > 0

spec/grape/endpoint_spec.rb

@@ -470,7 +470,7 @@ def app
         ''
       end
 
-      post '/declared', MultiJson.dump(first: 'one', boolean: false), 'CONTENT_TYPE' => 'application/json'
+      post '/declared', ::Grape::Json.dump(first: 'one', boolean: false), 'CONTENT_TYPE' => 'application/json'
       expect(last_response.status).to eq(201)
     end
 
@@ -485,7 +485,7 @@ def app
         ''
       end
 
-      post '/declared', MultiJson.dump(first: 'one', second: nil), 'CONTENT_TYPE' => 'application/json'
+      post '/declared', ::Grape::Json.dump(first: 'one', second: nil), 'CONTENT_TYPE' => 'application/json'
       expect(last_response.status).to eq(201)
     end
 
@@ -873,7 +873,7 @@ def app
       end
 
       it 'converts JSON bodies to params' do
-        post '/request_body', MultiJson.dump(user: 'Bobby T.'), 'CONTENT_TYPE' => 'application/json'
+        post '/request_body', ::Grape::Json.dump(user: 'Bobby T.'), 'CONTENT_TYPE' => 'application/json'
         expect(last_response.body).to eq('Bobby T.')
       end
 
@@ -897,7 +897,7 @@ def app
           error! 400, 'expected nil' if params[:version]
           params[:user]
         end
-        post '/omitted_params', MultiJson.dump(user: 'Bob'), 'CONTENT_TYPE' => 'application/json'
+        post '/omitted_params', ::Grape::Json.dump(user: 'Bob'), 'CONTENT_TYPE' => 'application/json'
         expect(last_response.status).to eq(201)
         expect(last_response.body).to eq('Bob')
       end
@@ -920,7 +920,7 @@ def app
       subject.put '/request_body' do
         params[:user]
       end
-      put '/request_body', MultiJson.dump(user: 'Bob'), 'CONTENT_TYPE' => 'text/plain'
+      put '/request_body', ::Grape::Json.dump(user: 'Bob'), 'CONTENT_TYPE' => 'text/plain'
 
       expect(last_response.status).to eq(406)
       expect(last_response.body).to eq('{"error":"The requested content-type \'text/plain\' is not supported."}')
@@ -934,7 +934,7 @@ def app
         subject.post do
           params[:data]
         end
-        post '/', MultiJson.dump(data: { some: 'payload' }), 'CONTENT_TYPE' => 'application/json'
+        post '/', ::Grape::Json.dump(data: { some: 'payload' }), 'CONTENT_TYPE' => 'application/json'
       end
 
       it 'should not response with 406 for same type without params' do

spec/grape/middleware/formatter_spec.rb

@@ -11,7 +11,7 @@
     let(:body) { { 'abc' => 'def' } }
     it 'looks at the bodies for possibly serializable data' do
       _, _, bodies = *subject.call('PATH_INFO' => '/somewhere', 'HTTP_ACCEPT' => 'application/json')
-      bodies.each { |b| expect(b).to eq(MultiJson.dump(body)) }
+      bodies.each { |b| expect(b).to eq(::Grape::Json.dump(body)) }
     end
 
     context 'default format' do