Merge pull request #1333 from namusyaka/update-1330

Update some points, ref #1330

Author: dblock

CHANGELOG.md

@@ -11,7 +11,7 @@
 
 * [#1325](https://github.com/ruby-grape/grape/pull/1325): Params: Fix coerce_with helper with Array types - [@ngonzalez](https://github.com/ngonzalez).
 * [#1326](https://github.com/ruby-grape/grape/pull/1326): Fix wrong behavior for OPTIONS and HEAD requests with catch-all - [@ekampp](https://github.com/ekampp), [@namusyaka](https://github.com/namusyaka).
-* [#1330](https://github.com/ruby-grape/grape/pull/1330): Fix built-in parsers and formatters - [@namusyaka](https://github.com/namusyaka).
+* [#1330](https://github.com/ruby-grape/grape/pull/1330): Add `register` keyword for adding customized parsers and formatters - [@namusyaka](https://github.com/namusyaka).
 
 0.15.0 (3/8/2016)
 =================

grape.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |s|
   s.license     = 'MIT'
 
   s.add_runtime_dependency 'rack', '>= 1.3.0'
-  s.add_runtime_dependency 'mustermann19', '~> 0.4.2'
+  s.add_runtime_dependency 'mustermann19', '~> 0.4.3'
   s.add_runtime_dependency 'rack-accept'
   s.add_runtime_dependency 'activesupport'
   s.add_runtime_dependency 'multi_json', '>= 1.3.2'

lib/grape.rb

@@ -77,28 +77,6 @@ module Exceptions
     autoload :MethodNotAllowed
   end
 
-  module ErrorFormatter
-    extend ActiveSupport::Autoload
-    autoload :Base
-    autoload :Json
-    autoload :Txt
-    autoload :Xml
-  end
-
-  module Formatter
-    extend ActiveSupport::Autoload
-    autoload :Json
-    autoload :SerializableHash
-    autoload :Txt
-    autoload :Xml
-  end
-
-  module Parser
-    extend ActiveSupport::Autoload
-    autoload :Json
-    autoload :Xml
-  end
-
   module Middleware
     extend ActiveSupport::Autoload
     autoload :Base
@@ -130,6 +108,29 @@ module Util
     autoload :StackableValues
     autoload :InheritableSetting
     autoload :StrictHashConfiguration
+    autoload :Registrable
+  end
+
+  module ErrorFormatter
+    extend ActiveSupport::Autoload
+    autoload :Base
+    autoload :Json
+    autoload :Txt
+    autoload :Xml
+  end
+
+  module Formatter
+    extend ActiveSupport::Autoload
+    autoload :Json
+    autoload :SerializableHash
+    autoload :Txt
+    autoload :Xml
+  end
+
+  module Parser
+    extend ActiveSupport::Autoload
+    autoload :Json
+    autoload :Xml
   end
 
   module DSL

lib/grape/error_formatter.rb

@@ -1,8 +1,7 @@
-require 'grape/util/registrable'
-
 module Grape
   module ErrorFormatter
-    extend Registrable
+    extend Util::Registrable
+
     class << self
       def builtin_formatters
         @builtin_formatters ||= {

lib/grape/formatter.rb

@@ -1,8 +1,6 @@
-require 'grape/util/registrable'
-
 module Grape
   module Formatter
-    extend Registrable
+    extend Util::Registrable
 
     class << self
       def builtin_formmaters

lib/grape/parser.rb

@@ -1,8 +1,6 @@
-require 'grape/util/registrable'
-
 module Grape
   module Parser
-    extend Registrable
+    extend Util::Registrable
 
     class << self
       def builtin_parsers

lib/grape/util/registrable.rb

@@ -1,11 +1,13 @@
 module Grape
-  module Registrable
-    def default_elements
-      @default_elements ||= {}
-    end
+  module Util
+    module Registrable
+      def default_elements
+        @default_elements ||= {}
+      end
 
-    def register(format, element)
-      default_elements[format] = element unless default_elements[format]
+      def register(format, element)
+        default_elements[format] = element unless default_elements[format]
+      end
     end
   end
 end

spec/grape/parser_spec.rb

@@ -0,0 +1,82 @@
+require 'spec_helper'
+
+describe Grape::Parser do
+  subject { described_class }
+
+  describe '.builtin_parsers' do
+    it 'returns an instance of Hash' do
+      expect(subject.builtin_parsers).to be_an_instance_of(Hash)
+    end
+
+    it 'includes json and xml parsers by default' do
+      expect(subject.builtin_parsers).to include(json: Grape::Parser::Json, xml: Grape::Parser::Xml)
+    end
+  end
+
+  describe '.parsers' do
+    it 'returns an instance of Hash' do
+      expect(subject.parsers({})).to be_an_instance_of(Hash)
+    end
+
+    it 'includes built-in parsers' do
+      expect(subject.parsers({})).to include(subject.builtin_parsers)
+    end
+
+    context 'with :parsers option' do
+      let(:parsers) { { customized: Class.new } }
+      it 'includes passed :parsers values' do
+        expect(subject.parsers(parsers: parsers)).to include(parsers)
+      end
+    end
+
+    context 'with added parser by using `register` keyword' do
+      let(:added_parser) { Class.new }
+      before { subject.register :added, added_parser }
+      it 'includes added parser' do
+        expect(subject.parsers({})).to include(added: added_parser)
+      end
+    end
+  end
+
+  describe '.parser_for' do
+    let(:options) { {} }
+
+    it 'calls .parsers' do
+      expect(subject).to receive(:parsers).with(options).and_return(subject.builtin_parsers)
+      subject.parser_for(:json, options)
+    end
+
+    it 'returns parser correctly' do
+      expect(subject.parser_for(:json)).to eq(Grape::Parser::Json)
+    end
+
+    context 'when parser is available' do
+      before { subject.register :customized_json, Grape::Parser::Json }
+      it 'returns registered parser if available' do
+        expect(subject.parser_for(:customized_json)).to eq(Grape::Parser::Json)
+      end
+    end
+
+    context 'when parser is an instance of Symbol' do
+      before do
+        allow(subject).to receive(:foo).and_return(:bar)
+        subject.register :foo, :foo
+      end
+
+      it 'returns an instance of Method' do
+        expect(subject.parser_for(:foo)).to be_an_instance_of(Method)
+      end
+
+      it 'returns object which can be called' do
+        method = subject.parser_for(:foo)
+        expect(method.call).to eq(:bar)
+      end
+    end
+
+    context 'when parser does not exist' do
+      it 'returns nil' do
+        expect(subject.parser_for(:undefined)).to be_nil
+      end
+    end
+  end
+end