introduces request and response format

and deprecates default_format
hanami · Sep 15, 2015 · 8a97bf7 · 8a97bf7
1 parent 8625819
commit 8a97bf7
Show file tree

Hide file tree

Showing 10 changed files with 136 additions and 25 deletions.
diff --git a/Gemfile b/Gemfile
@@ -9,7 +9,8 @@ end
 gem 'lotus-utils',       '~> 0.5', require: false, github: 'lotus/utils',       branch: '0.5.x'
 gem 'lotus-validations', '~> 0.3', require: false, github: 'lotus/validations', branch: '0.3.x'
 gem 'lotus-router',      '~> 0.4', require: false, github: 'lotus/router',      branch: '0.4.x'
-gem 'lotus-controller',  '~> 0.4', require: false, github: 'lotus/controller',  branch: '0.4.x'
+gem 'lotus-controller',  '~> 0.4', require: false, github: 'theocodes/controller', branch: 'response-format-improvements'
+# gem 'lotus-controller',  '~> 0.4', require: false, github: 'lotus/controller',  branch: '0.4.x'
 gem 'lotus-view',        '~> 0.4', require: false, github: 'lotus/view',        branch: '0.4.x'
 gem 'lotus-model',       '~> 0.4', require: false, github: 'lotus/model',       branch: '0.4.x'
 gem 'lotus-helpers',     '~> 0.2', require: false, github: 'lotus/helpers',     branch: '0.2.x'

diff --git a/lib/lotus/configuration.rb b/lib/lotus/configuration.rb
@@ -1,4 +1,5 @@
 require 'lotus/utils/kernel'
+require 'lotus/utils/deprecation'
 require 'lotus/environment'
 require 'lotus/config/framework_configuration'
 require 'lotus/config/load_paths'
@@ -958,18 +959,18 @@ def adapter(options = {})
     # an argument, it will set the corresponding instance variable. When
     # called without, it will return the already set value, or the default.
     #
-    # @overload default_format(format)
+    # @overload default_request_format(format)
     #   Sets the given value
     #   @param format [#to_sym] the symbol format
     #   @raise [TypeError] if it cannot be coerced to a symbol
     #
-    # @overload default_format
+    # @overload default_request_format
     #   Gets the value
     #   @return [Symbol]
     #
     # @since 0.1.0
     #
-    # @see http://rdoc.info/gems/lotus-controller/Lotus/Controller/Configuration#default_format
+    # @see http://rdoc.info/gems/lotus-controller/Lotus/Controller/Configuration#default_request_format
     #
     # @example Getting the value
     #   require 'lotus'
@@ -979,28 +980,92 @@ def adapter(options = {})
     #     end
     #   end
     #
-    #   Bookshelf::Application.configuration.default_format # => :html
+    #   Bookshelf::Application.configuration.default_request_format # => :html
     #
     # @example Setting the value
     #   require 'lotus'
     #
     #   module Bookshelf
     #     class Application < Lotus::Application
     #       configure do
-    #         default_format :json
+    #         default_request_format :json
     #       end
     #     end
     #   end
     #
-    #   Bookshelf::Application.configuration.default_format # => :json
-    def default_format(format = nil)
+    #   Bookshelf::Application.configuration.default_request_format # => :json
+    def default_request_format(format = nil)
       if format
-        @default_format = Utils::Kernel.Symbol(format)
+        @default_request_format = Utils::Kernel.Symbol(format)
       else
-        @default_format || :html
+        @default_request_format || :html
       end
     end
 
+    # Set a format to be used for all responses regardless of the request type.
+    #
+    # The given format must be coercible to a symbol, and be a valid mime type
+    # alias. If it isn't, at the runtime the framework will raise a
+    # `Lotus::Controller::UnknownFormatError`.
+    #
+    # By default this value is `:html`.
+    #
+    # This is part of a DSL, for this reason when this method is called with
+    # an argument, it will set the corresponding instance variable. When
+    # called without, it will return the already set value, or the default.
+    #
+    # @overload default_response_format(format)
+    #   Sets the given value
+    #   @param format [#to_sym] the symbol format
+    #   @raise [TypeError] if it cannot be coerced to a symbol
+    #
+    # @overload default_response_format
+    #   Gets the value
+    #   @return [Symbol,nil]
+    #
+    # @example Getting the value
+    #   require 'lotus'
+    #
+    #   module Bookshelf
+    #     class Application < Lotus::Application
+    #     end
+    #   end
+    #
+    #   Bookshelf::Application.configuration.default_response_format # => :html
+    #
+    # @example Setting the value
+    #   require 'lotus'
+    #
+    #   module Bookshelf
+    #     class Application < Lotus::Application
+    #       configure do
+    #         default_response_format :json
+    #       end
+    #     end
+    #   end
+    #
+    #   Bookshelf::Application.configuration.default_request_format # => :json
+    #
+    # @since 0.5.0 TODO: Confirm?
+    def default_response_format(format = nil)
+      if format
+        @default_response_format = Utils::Kernel.Symbol(format)
+      else
+        @default_response_format
+      end
+    end
+
+    # Set a format as default fallback for all the requests without a strict
+    # requirement for the mime type.
+    #
+    # @since 0.1.0
+    #
+    # @deprecated Use {#default_request_format} instead.
+    def default_format(format = nil)
+      Lotus::Utils::Deprecation.new('default_format is deprecated, please use default_request_format')
+      default_request_format(format)
+    end
+
     # The URI scheme for this application.
     # This is used by the router helpers to generate absolute URLs.
     #
@@ -1577,7 +1642,7 @@ def model
     #   module Bookshelf
     #     class Application < Lotus::Application
     #       configure do
-    #         controller.default_format :json
+    #         controller.default_request_format :json
     #       end
     #     end
     #   end

diff --git a/lib/lotus/generators/application/app/config/application.rb.tt b/lib/lotus/generators/application/app/config/application.rb.tt
@@ -84,7 +84,12 @@ module <%= config[:classified_app_name] %>
       # Default format for the requests that don't specify an HTTP_ACCEPT header
       # Argument: A symbol representation of a mime type, default to :html
       #
-      # default_format :html
+      # default_request_format :html
+
+      # Default format for responses that doesn't take into account the request format
+      # Argument: A symbol representation of a mime type, default to :html
+      #
+      # default_response_format :html
 
       # HTTP Body parsers
       # Parse non GET responses body for a specific mime type

diff --git a/lib/lotus/generators/slice/application.rb.tt b/lib/lotus/generators/slice/application.rb.tt
@@ -82,7 +82,12 @@ module <%= config[:classified_slice_name] %>
       # Default format for the requests that don't specify an HTTP_ACCEPT header
       # Argument: A symbol representation of a mime type, default to :html
       #
-      # default_format :html
+      # default_request_format :html
+
+      # Default format for responses that doesn't take into account the request format
+      # Argument: A symbol representation of a mime type, default to :html
+      #
+      # default_response_format :html
 
       # HTTP Body parsers
       # Parse non GET responses body for a specific mime type

diff --git a/lib/lotus/loader.rb b/lib/lotus/loader.rb
@@ -53,7 +53,8 @@ def _configure_controller_framework!
       unless namespace.const_defined?('Controller')
         controller = Lotus::Controller.duplicate(namespace) do
           handle_exceptions config.handle_exceptions
-          default_format    config.default_format
+          default_request_format config.default_request_format
+          default_response_format config.default_response_format
           default_headers({
             Lotus::Config::Security::X_FRAME_OPTIONS_HEADER         => config.security.x_frame_options,
             Lotus::Config::Security::CONTENT_SECURITY_POLICY_HEADER => config.security.content_security_policy

diff --git a/test/configuration_test.rb b/test/configuration_test.rb
@@ -605,25 +605,47 @@ class FileSystem
     end
   end
 
-  describe '#default_format' do
+  describe '#default_request_format' do
+    describe "when not previously set" do
+      it 'returns :html' do
+        @configuration.default_request_format.must_equal :html
+      end
+    end
+
+    describe "when set" do
+      before do
+        @configuration.default_request_format :json
+      end
+
+      it 'returns the value' do
+        @configuration.default_request_format.must_equal :json
+      end
+    end
+
+    it 'raises an error if the given format cannot be coerced into symbol' do
+      -> { @configuration.default_request_format(23) }.must_raise TypeError
+    end
+  end
+
+  describe '#default_response_format' do
     describe "when not previously set" do
       it 'returns nil' do
-        @configuration.default_format.must_equal :html
+        @configuration.default_response_format.must_equal nil
       end
     end
 
     describe "when set" do
       before do
-        @configuration.default_format :json
+        @configuration.default_response_format :json
       end
 
       it 'returns the value' do
-        @configuration.default_format.must_equal :json
+        @configuration.default_response_format.must_equal :json
       end
     end
 
     it 'raises an error if the given format cannot be coerced into symbol' do
-      -> { @configuration.default_format(23) }.must_raise TypeError
+      -> { @configuration.default_response_format(23) }.must_raise TypeError
     end
   end
 
@@ -774,8 +796,12 @@ class FileSystem
       -> { @configuration.view_pattern('%{controller}::%{action}') }.must_raise RuntimeError
     end
 
-    it 'it raises error when try to mutate the default_format' do
-      -> { @configuration.default_format(:xml) }.must_raise RuntimeError
+    it 'it raises error when try to mutate the default_request_format' do
+      -> { @configuration.default_request_format(:xml) }.must_raise RuntimeError
+    end
+
+    it 'it raises error when try to mutate the default_response_format' do
+      -> { @configuration.default_response_format(:xml) }.must_raise RuntimeError
     end
 
     it 'it raises error when try to mutate the scheme' do

diff --git a/test/fixtures.rb b/test/fixtures.rb
@@ -19,6 +19,8 @@ class Application < Lotus::Application
       load_paths.clear
       templates 'app/templates'
 
+      default_response_format :html
+
       scheme 'https'
       host   'lotus-coffeeshop.org'
 

diff --git a/test/fixtures/configurable/application.rb b/test/fixtures/configurable/application.rb
@@ -18,7 +18,8 @@ class Application < Lotus::Application
       model.adapter type: :memory, uri: 'memory://localhost'
       model.mapping { }
 
-      controller.default_format :xml
+      controller.default_request_format :xml
+      controller.default_response_format :json
       controller.default_charset 'koi8-r'
       controller.prepare do
         include Authentication

diff --git a/test/integration/configuration_test.rb b/test/integration/configuration_test.rb
@@ -52,7 +52,8 @@ def request
 
   describe "controller configuration" do
     it 'forwards settings' do
-      Configurable::Controller.configuration.default_format.must_equal  :xml
+      Configurable::Controller.configuration.default_request_format.must_equal  :xml
+      Configurable::Controller.configuration.default_response_format.must_equal  :json
       Configurable::Controller.configuration.default_charset.must_equal 'koi8-r'
     end
   end

diff --git a/test/loader_test.rb b/test/loader_test.rb
@@ -37,8 +37,12 @@
         CoffeeShop::Controller.configuration.action_module.must_equal(CoffeeShop::Action)
       end
 
-      it 'configures controller to use default format' do
-        CoffeeShop::Controller.configuration.default_format.must_equal(:html)
+      it 'configures controller to use default request format' do
+        CoffeeShop::Controller.configuration.default_request_format.must_equal(:html)
+      end
+
+      it 'configures controller to use default response format' do
+        CoffeeShop::Controller.configuration.default_response_format.must_equal(:html)
       end
 
       it 'generates controllers namespace' do