ballast 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d3677739c7345fff51757aa4480042825e1933c2
-  data.tar.gz: baa5609857d7f710b8a771e684fff697d4acf049
+  metadata.gz: 39130e71a76171f367bfcc3263dddfe12b93d992
+  data.tar.gz: cddecb3d31027a9257dccce575148d2429c2e3bc
 SHA512:
-  metadata.gz: a530c3ccf4f1b983497b5f281cbae6dbc266e5c21f8b51db3350203270706767129de7f291126023dcabd63b2272fe6bb80acbfee411aac87496726657628fa5
-  data.tar.gz: 06cf71b6ebcdc5797a46a812353fc540156ad4a236998b55c65dd81d14bb01e0c4a0a1b3e9efbdc42548be2c3267cfaef5cf2f0a64d666212b79727b0426cace
+  metadata.gz: 04956f35bcf407f268c0dd1f28597339efd9d26e5f7e922db4574ab2b80e3bf6c9ac3ac5a35c29365acd791b4c4f25ecf5495ef18f637b3c8be899e54ed56ff8
+  data.tar.gz: c30ff322b3214a2fa39573bc059c06b44058bdc555a5074845173c7881dcf799ff1bd207fedd3c6ad9f9f2797de3944aa72f68147250ec9d05169f1f4f9144ce

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+### 1.4.0 / 2013-12-30
+
+* Added format parameter to ErrorsHandling#handle_error.
+
 ### 1.3.0 / 2013-12-30
 
 * Added ApplicationConfiguration class.

data/doc/Ballast/Concerns/Ajax.html

@@ -797,7 +797,7 @@
 </div>
 
     <div id="footer">
-  Generated on Mon Dec 30 12:53:19 2013 by
+  Generated on Sat Jan  4 10:09:07 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.3 (ruby-2.1.0).
 </div>

data/doc/Ballast/Concerns/Common.html

@@ -887,7 +887,7 @@ and <code>%:Z</code> for the zone name considering also DST.</p>
 </div>
 
     <div id="footer">
-  Generated on Mon Dec 30 12:53:19 2013 by
+  Generated on Sat Jan  4 10:09:07 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.3 (ruby-2.1.0).
 </div>

data/doc/Ballast/Concerns/ErrorsHandling.html

@@ -116,7 +116,7 @@
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#handle_error-instance_method" title="#handle_error (instance method)">- (Object) <strong>handle_error</strong>(exception = nil, layout = &quot;error&quot;, title = &quot;Error - Application&quot;) </a>
+      <a href="#handle_error-instance_method" title="#handle_error (instance method)">- (Object) <strong>handle_error</strong>(exception = nil, layout = &quot;error&quot;, title = &quot;Error - Application&quot;, format = nil) </a>
     
 
     
@@ -149,7 +149,7 @@
       <div class="method_details first">
   <h3 class="signature first" id="handle_error-instance_method">
   
-    - (<tt>Object</tt>) <strong>handle_error</strong>(exception = nil, layout = &quot;error&quot;, title = &quot;Error - Application&quot;) 
+    - (<tt>Object</tt>) <strong>handle_error</strong>(exception = nil, layout = &quot;error&quot;, title = &quot;Error - Application&quot;, format = nil) 
   
 
   
@@ -217,6 +217,23 @@
       
     </li>
   
+    <li>
+      
+        <span class='name'>format</span>
+      
+      
+        <span class='type'>(<tt>String|Symbol</tt>)</span>
+      
+      
+        <em class="default">(defaults to: <tt>nil</tt>)</em>
+      
+      
+        &mdash;
+        <div class='inline'><p>The format of the response.</p>
+</div>
+      
+    </li>
+  
 </ul>
 
 
@@ -226,7 +243,6 @@
       <pre class="lines">
 
 
-17
 18
 19
 20
@@ -242,12 +258,13 @@
 30
 31
 32
-33</pre>
+33
+34</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ballast/concerns/errors_handling.rb', line 17</span>
+      <pre class="code"><span class="info file"># File 'lib/ballast/concerns/errors_handling.rb', line 18</span>
 
-<span class='kw'>def</span> <span class='id identifier rubyid_handle_error'>handle_error</span><span class='lparen'>(</span><span class='id identifier rubyid_exception'>exception</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_layout'>layout</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>error</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_title'>title</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Error - Application</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_handle_error'>handle_error</span><span class='lparen'>(</span><span class='id identifier rubyid_exception'>exception</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_layout'>layout</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>error</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_title'>title</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Error - Application</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_format'>format</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
   <span class='ivar'>@error</span> <span class='op'>||=</span> <span class='id identifier rubyid_exception'>exception</span>
 
   <span class='kw'>if</span> <span class='ivar'>@error</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Lazier</span><span class='op'>::</span><span class='const'>Exceptions</span><span class='op'>::</span><span class='const'>Debug</span><span class='rparen'>)</span> <span class='kw'>then</span>
@@ -262,7 +279,7 @@
     <span class='ivar'>@error_code</span> <span class='op'>=</span> <span class='int'>500</span>
   <span class='kw'>end</span>
 
-  <span class='id identifier rubyid_send_or_render_error'>send_or_render_error</span><span class='lparen'>(</span><span class='id identifier rubyid_layout'>layout</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_send_or_render_error'>send_or_render_error</span><span class='lparen'>(</span><span class='id identifier rubyid_layout'>layout</span><span class='comma'>,</span> <span class='id identifier rubyid_format'>format</span><span class='rparen'>)</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -274,7 +291,7 @@
 </div>
 
     <div id="footer">
-  Generated on Mon Dec 30 12:53:19 2013 by
+  Generated on Sat Jan  4 10:09:07 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.3 (ruby-2.1.0).
 </div>

data/doc/Ballast/Concerns/View.html

@@ -638,7 +638,7 @@
 </div>
 
     <div id="footer">
-  Generated on Mon Dec 30 12:53:18 2013 by
+  Generated on Sat Jan  4 10:09:07 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.3 (ruby-2.1.0).
 </div>

data/doc/Ballast/Concerns.html

@@ -118,7 +118,7 @@
 </div>
 
     <div id="footer">
-  Generated on Mon Dec 30 12:53:18 2013 by
+  Generated on Sat Jan  4 10:09:07 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.3 (ruby-2.1.0).
 </div>

data/doc/Ballast/Configuration.html

@@ -273,7 +273,7 @@ Subfolders are not supported.</p>
 </div>
 
     <div id="footer">
-  Generated on Mon Dec 30 12:53:19 2013 by
+  Generated on Sat Jan  4 10:09:07 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.3 (ruby-2.1.0).
 </div>

data/doc/Ballast/Context.html

@@ -408,7 +408,7 @@
 </div>
 
     <div id="footer">
-  Generated on Mon Dec 30 12:53:19 2013 by
+  Generated on Sat Jan  4 10:09:07 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.3 (ruby-2.1.0).
 </div>

data/doc/Ballast/Errors/BaseError.html

@@ -317,7 +317,7 @@
 </div>
 
     <div id="footer">
-  Generated on Mon Dec 30 12:53:19 2013 by
+  Generated on Sat Jan  4 10:09:07 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.3 (ruby-2.1.0).
 </div>

data/doc/Ballast/Errors/InvalidDomain.html

@@ -148,7 +148,7 @@
 </div>
 
     <div id="footer">
-  Generated on Mon Dec 30 12:53:19 2013 by
+  Generated on Sat Jan  4 10:09:07 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.3 (ruby-2.1.0).
 </div>

data/doc/Ballast/Errors/PerformError.html

@@ -148,7 +148,7 @@
 </div>
 
     <div id="footer">
-  Generated on Mon Dec 30 12:53:19 2013 by
+  Generated on Sat Jan  4 10:09:07 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.3 (ruby-2.1.0).
 </div>

data/doc/Ballast/Errors/ValidationError.html

@@ -148,7 +148,7 @@
 </div>
 
     <div id="footer">
-  Generated on Mon Dec 30 12:53:19 2013 by
+  Generated on Sat Jan  4 10:09:07 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.3 (ruby-2.1.0).
 </div>

data/doc/Ballast/Errors.html

@@ -116,7 +116,7 @@
 </div>
 
     <div id="footer">
-  Generated on Mon Dec 30 12:53:18 2013 by
+  Generated on Sat Jan  4 10:09:07 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.3 (ruby-2.1.0).
 </div>

data/doc/Ballast/Middlewares/DefaultHost.html

@@ -345,7 +345,7 @@
 </div>
 
     <div id="footer">
-  Generated on Mon Dec 30 12:53:19 2013 by
+  Generated on Sat Jan  4 10:09:07 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.3 (ruby-2.1.0).
 </div>

data/doc/Ballast/Middlewares.html

@@ -116,7 +116,7 @@
 </div>
 
     <div id="footer">
-  Generated on Mon Dec 30 12:53:19 2013 by
+  Generated on Sat Jan  4 10:09:07 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.3 (ruby-2.1.0).
 </div>

data/doc/Ballast/Operation.html

@@ -1295,7 +1295,7 @@ as owner will be created.</p>
 </div>
 
     <div id="footer">
-  Generated on Mon Dec 30 12:53:19 2013 by
+  Generated on Sat Jan  4 10:09:07 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.3 (ruby-2.1.0).
 </div>

data/doc/Ballast/OperationsChain.html

@@ -576,7 +576,7 @@ as owner will be created.</p>
 </div>
 
     <div id="footer">
-  Generated on Mon Dec 30 12:53:19 2013 by
+  Generated on Sat Jan  4 10:09:07 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.3 (ruby-2.1.0).
 </div>

data/doc/Ballast/RequestDomainMatcher.html

@@ -908,7 +908,7 @@
 </div>
 
     <div id="footer">
-  Generated on Mon Dec 30 12:53:19 2013 by
+  Generated on Sat Jan  4 10:09:07 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.3 (ruby-2.1.0).
 </div>

data/doc/Ballast/Version.html

@@ -134,7 +134,7 @@
 
 </div>
         </dt>
-        <dd><pre class="code"><span class='int'>3</span></pre></dd>
+        <dd><pre class="code"><span class='int'>4</span></pre></dd>
       
         <dt id="PATCH-constant" class="">PATCH =
           <div class="docstring">
@@ -180,7 +180,7 @@
 </div>
 
     <div id="footer">
-  Generated on Mon Dec 30 12:53:18 2013 by
+  Generated on Sat Jan  4 10:09:07 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.3 (ruby-2.1.0).
 </div>

data/doc/Ballast.html

@@ -121,7 +121,7 @@ Licensed under the MIT license, which can be found at http://www.opensource.org/
 </div>
 
     <div id="footer">
-  Generated on Mon Dec 30 12:53:18 2013 by
+  Generated on Sat Jan  4 10:09:07 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.3 (ruby-2.1.0).
 </div>

data/doc/_index.html

@@ -310,7 +310,7 @@
 </div>
 
     <div id="footer">
-  Generated on Mon Dec 30 12:53:17 2013 by
+  Generated on Sat Jan  4 10:09:06 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.3 (ruby-2.1.0).
 </div>

data/doc/file.README.html

@@ -106,7 +106,7 @@
 </div></div>
 
     <div id="footer">
-  Generated on Mon Dec 30 12:53:18 2013 by
+  Generated on Sat Jan  4 10:09:06 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.3 (ruby-2.1.0).
 </div>

data/doc/index.html

@@ -106,7 +106,7 @@
 </div></div>
 
     <div id="footer">
-  Generated on Mon Dec 30 12:53:18 2013 by
+  Generated on Sat Jan  4 10:09:06 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.3 (ruby-2.1.0).
 </div>

data/doc/top-level-namespace.html

@@ -103,7 +103,7 @@
 </div>
 
     <div id="footer">
-  Generated on Mon Dec 30 12:53:18 2013 by
+  Generated on Sat Jan  4 10:09:06 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.3 (ruby-2.1.0).
 </div>

data/lib/ballast/concerns/errors_handling.rb

@@ -14,7 +14,8 @@ module Ballast
       # @param exception [Hash|Exception] The exception to handle.
       # @param layout [String] The layout to use to render the error.
       # @param title [String] The title to set in case of custom errors.
-      def handle_error(exception = nil, layout = "error", title = "Error - Application")
+      # @param format [String|Symbol] The format of the response.
+      def handle_error(exception = nil, layout = "error", title = "Error - Application", format = nil)
         @error ||= exception
 
         if @error.is_a?(Lazier::Exceptions::Debug) then
@@ -29,17 +30,22 @@ module Ballast
           @error_code = 500
         end
 
-        send_or_render_error(layout)
+        send_or_render_error(layout, format)
       end
 
       private
         # Send an AJAX error o renders it.
         #
         # @param layout [String] The layout to use to render the error.
-        def send_or_render_error(layout)
-          if is_ajax? then
-            data = prepare_ajax(@error_code, {type: @error_title, backtrace: @error.backtrace.join("\n")}, @error_message || @error.message)
-            send_ajax(data)
+        # @param format [String|Symbol] The format of the response.
+        def send_or_render_error(layout, format = nil)
+          format ||= request.format.to_sym
+
+          if is_ajax? || format.to_s =~ /^json/ then
+            details = {type: @error_title}
+            details[:backtrace] = @error.backtrace.join("\n") if @error.respond_to?(:backtrace)
+            data = prepare_ajax(@error_code, details, @error_message || @error.message)
+            send_ajax(data, format: format)
           else
             render(nothing: true, status: @error_code, layout: layout, formats: [:html])
           end

data/lib/ballast/version.rb

@@ -13,7 +13,7 @@ module Ballast
     MAJOR = 1
 
     # The minor version.
-    MINOR = 3
+    MINOR = 4
 
     # The patch version.
     PATCH = 0

data/spec/ballast/concerns/errors_handling_spec.rb

@@ -21,7 +21,7 @@ describe Ballast::Concerns::ErrorsHandling do
   describe "#handle_error" do
     it "should handle a custom error" do
       error = {status: "STATUS", error: "ERROR"}
-      expect(subject).to receive(:send_or_render_error).with("LAYOUT")
+      expect(subject).to receive(:send_or_render_error).with("LAYOUT", nil)
       subject.handle_error(error, "LAYOUT", "TITLE")
 
       expect(subject.instance_variable_get(:@error)).to eq(error)
@@ -50,12 +50,19 @@ describe Ballast::Concerns::ErrorsHandling do
 
     it "should render an AJAX error" do
       expect_any_instance_of(RuntimeError).to receive(:backtrace).and_return(["A", "B"])
-      expect(subject).to receive(:is_ajax?).and_return(true)
-      expect(subject).to receive(:send_ajax).with({status: 500, error: "ERROR", data: {type: "Error - RuntimeError", backtrace: "A\nB"}}.with_indifferent_access)
+      allow(subject).to receive(:request).and_return(OpenStruct.new(format: :json))
+      expect(subject).to receive(:is_ajax?).exactly(2).and_return(true, false)
+      
+      expect(subject).to receive(:send_ajax).with({status: 500, error: "ERROR", data: {type: "Error - RuntimeError", backtrace: "A\nB"}}.with_indifferent_access, {format: :json})
+      expect(subject).to receive(:send_ajax).with({status: :forbidden, error: "ERROR", data: {type: "TITLE"}}.with_indifferent_access, {format: :json})
+
       subject.handle_error(RuntimeError.new("ERROR"), "LAYOUT")
+      subject.instance_variable_set(:@error, nil)
+      subject.handle_error({title: "TITLE", status: :forbidden, error: "ERROR"}, :json)
     end
 
     it "should render a HTML error" do
+      allow(subject).to receive(:request).and_return(OpenStruct.new(format: :html))
       expect(subject).to receive(:render).with(nothing: true, status: 500, layout: "LAYOUT", formats: [:html])
       subject.handle_error(RuntimeError.new("ERROR"), "LAYOUT")
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ballast
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Shogun
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-30 00:00:00.000000000 Z
+date: 2014-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack