RubyGems - ballast - Versions diffs - 1.9.3 → 2.0.0 - Mend

ballast 1.9.3 → 2.0.0

Files changed (78) hide show

checksums.yaml +4 -4
data/.rubocop.yml +35 -0
data/.travis-gemfile +4 -5
data/.travis.yml +3 -2
data/CHANGELOG.md +62 -6
data/Gemfile +7 -8
data/README.md +2 -2
data/ballast.gemspec +9 -12
data/doc/Ballast/AjaxResponse.html +1380 -0
data/doc/Ballast/Concerns/AjaxHandling.html +662 -0
data/doc/Ballast/Concerns/Common.html +81 -361
data/doc/Ballast/Concerns/ErrorsHandling.html +18 -36
data/doc/Ballast/Concerns/View.html +181 -157
data/doc/Ballast/Concerns.html +6 -6
data/doc/Ballast/Configuration.html +204 -31
data/doc/Ballast/Emoji/Character.html +411 -0
data/doc/Ballast/Emoji/Utils.html +794 -0
data/doc/Ballast/Emoji.html +125 -0
data/doc/Ballast/Errors/{BaseError.html → Base.html} +61 -34
data/doc/Ballast/Errors/{PerformError.html → Failure.html} +21 -17
data/doc/Ballast/Errors/InvalidDomain.html +11 -11
data/doc/Ballast/Errors/{ValidationError.html → ValidationFailure.html} +24 -16
data/doc/Ballast/Errors.html +5 -5
data/doc/Ballast/Middlewares/DefaultHost.html +6 -6
data/doc/Ballast/Middlewares.html +4 -4
data/doc/Ballast/RequestDomainMatcher.html +28 -28
data/doc/Ballast/Service/Response.html +1243 -0
data/doc/Ballast/Service.html +1314 -0
data/doc/Ballast/Version.html +7 -7
data/doc/Ballast.html +15 -15
data/doc/_index.html +59 -30
data/doc/class_list.html +6 -2
data/doc/css/style.css +1 -0
data/doc/file.README.html +6 -6
data/doc/file_list.html +5 -1
data/doc/frames.html +1 -1
data/doc/index.html +6 -6
data/doc/js/full_list.js +4 -1
data/doc/method_list.html +167 -79
data/doc/top-level-namespace.html +41 -4
data/lib/ballast/ajax_response.rb +76 -0
data/lib/ballast/concerns/ajax_handling.rb +73 -0
data/lib/ballast/concerns/common.rb +25 -47
data/lib/ballast/concerns/errors_handling.rb +21 -30
data/lib/ballast/concerns/view.rb +24 -22
data/lib/ballast/configuration.rb +30 -10
data/lib/ballast/emoji.rb +114 -0
data/lib/ballast/errors.rb +16 -13
data/lib/ballast/middlewares/default_host.rb +3 -3
data/lib/ballast/request_domain_matcher.rb +7 -7
data/lib/ballast/service.rb +147 -0
data/lib/ballast/version.rb +3 -3
data/lib/ballast.rb +22 -22
data/spec/ballast/ajax_response_spec.rb +61 -0
data/spec/ballast/concerns/ajax_handling_spec.rb +86 -0
data/spec/ballast/concerns/common_spec.rb +17 -52
data/spec/ballast/concerns/errors_handling_spec.rb +35 -29
data/spec/ballast/concerns/view_spec.rb +21 -32
data/spec/ballast/configuration_spec.rb +66 -16
data/spec/ballast/emoji_spec.rb +103 -0
data/spec/ballast/errors_spec.rb +5 -5
data/spec/ballast/middlewares/default_host_spec.rb +3 -5
data/spec/ballast/request_domain_matcher_spec.rb +4 -4
data/spec/ballast/service_spec.rb +137 -0
data/spec/spec_helper.rb +1 -13
metadata +42 -80
data/doc/Ballast/Concerns/Ajax.html +0 -945
data/doc/Ballast/Context.html +0 -417
data/doc/Ballast/Operation.html +0 -1304
data/doc/Ballast/OperationsChain.html +0 -597
data/lib/ballast/concerns/ajax.rb +0 -134
data/lib/ballast/context.rb +0 -38
data/lib/ballast/operation.rb +0 -136
data/lib/ballast/operations_chain.rb +0 -45
data/spec/ballast/concerns/ajax_spec.rb +0 -141
data/spec/ballast/context_spec.rb +0 -23
data/spec/ballast/operation_spec.rb +0 -177
data/spec/ballast/operations_chain_spec.rb +0 -61

data/doc/Ballast/Concerns/Ajax.html DELETED Viewed

@@ -1,945 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
-  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-  <head>
-    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-<title>
-  Module: Ballast::Concerns::Ajax
-    &mdash; Documentation by YARD 0.8.7.3
-</title>
-  <link rel="stylesheet" href="../../css/style.css" type="text/css" charset="utf-8" />
-  <link rel="stylesheet" href="../../css/common.css" type="text/css" charset="utf-8" />
-<script type="text/javascript" charset="utf-8">
-  hasFrames = window.top.frames.main ? true : false;
-  relpath = '../../';
-  framesUrl = "../../frames.html#!" + escape(window.location.href);
-</script>
-  <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
-  <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
-  </head>
-  <body>
-    <div id="header">
-      <div id="menu">
-    <a href="../../_index.html">Index (A)</a> &raquo;
-    <span class='title'><span class='object_link'><a href="../../Ballast.html" title="Ballast (module)">Ballast</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Concerns.html" title="Ballast::Concerns (module)">Concerns</a></span></span>
-     &raquo;
-    <span class="title">Ajax</span>
-  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
-</div>
-      <div id="search">
-    <a class="full_list_link" id="class_list_link"
-        href="../../class_list.html">
-      Class List
-    </a>
-    <a class="full_list_link" id="method_list_link"
-        href="../../method_list.html">
-      Method List
-    </a>
-    <a class="full_list_link" id="file_list_link"
-        href="../../file_list.html">
-      File List
-    </a>
-</div>
-      <div class="clear"></div>
-    </div>
-    <iframe id="search_frame"></iframe>
-    <div id="content"><h1>Module: Ballast::Concerns::Ajax
-</h1>
-<dl class="box">
-      <dt class="r1">Extended by:</dt>
-      <dd class="r1">ActiveSupport::Concern</dd>
-    <dt class="r2 last">Defined in:</dt>
-    <dd class="r2 last">lib/ballast/concerns/ajax.rb</dd>
-</dl>
-<div class="clear"></div>
-<h2>Overview</h2><div class="docstring">
-  <div class="discussion">
-    <p>A concern to handle AJAX and HTTP requests.</p>
-  </div>
-</div>
-<div class="tags">
-</div>
-    <h2>
-      Instance Method Summary
-      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
-    </h2>
-    <ul class="summary">
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#allow_cors-instance_method" title="#allow_cors (instance method)">- (Object) <strong>allow_cors</strong>(allow_origin: &quot;*&quot;, allow_methods: [:post, :get, :options], allow_headers: &quot;*&quot;, max_age: 1.year, allow_credentials: false) </a>
-  </span>
-    <span class="summary_desc"><div class='inline'><p>Allows HTTP Cross-Origin Resource Sharing.</p>
-</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#generate_robots_txt-instance_method" title="#generate_robots_txt (instance method)">- (Object) <strong>generate_robots_txt</strong>(configuration = nil) </a>
-      (also: #disallow_robots)
-  </span>
-    <span class="summary_desc"><div class='inline'><p>Generates a robots.txt file.</p>
-</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#is_ajax%3F-instance_method" title="#is_ajax? (instance method)">- (Boolean) <strong>is_ajax?</strong> </a>
-  </span>
-    <span class="summary_desc"><div class='inline'><p>Checks if the current request is AJAX.</p>
-</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#prepare_ajax-instance_method" title="#prepare_ajax (instance method)">- (Object) <strong>prepare_ajax</strong>(status = :ok, data = nil, error = nil) </a>
-  </span>
-    <span class="summary_desc"><div class='inline'><p>Prepares an AJAX response.</p>
-</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#prevent_caching-instance_method" title="#prevent_caching (instance method)">- (Object) <strong>prevent_caching</strong> </a>
-  </span>
-    <span class="summary_desc"><div class='inline'><p>Prevents HTTP caching.</p>
-</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#send_ajax-instance_method" title="#send_ajax (instance method)">- (Object) <strong>send_ajax</strong>(data, status: :ok, format: :json, pretty_json: false) </a>
-  </span>
-    <span class="summary_desc"><div class='inline'><p>Sends an AJAX response to the client.</p>
-</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#update_ajax-instance_method" title="#update_ajax (instance method)">- (Hash) <strong>update_ajax</strong>(data, operation = nil) </a>
-  </span>
-    <span class="summary_desc"><div class='inline'><p>Updates an AJAX response from a operation, taking either the response data or the first error.</p>
-</div></span>
-</li>
-    </ul>
-  <div id="instance_method_details" class="method_details_list">
-    <h2>Instance Method Details</h2>
-      <div class="method_details first">
-  <h3 class="signature first" id="allow_cors-instance_method">
-    - (<tt>Object</tt>) <strong>allow_cors</strong>(allow_origin: &quot;*&quot;, allow_methods: [:post, :get, :options], allow_headers: &quot;*&quot;, max_age: 1.year, allow_credentials: false)
-</h3><div class="docstring">
-  <div class="discussion">
-    <p>Allows HTTP Cross-Origin Resource Sharing.</p>
-  </div>
-</div>
-<div class="tags">
-  <p class="tag_title">Parameters:</p>
-<ul class="param">
-    <li>
-        <span class='name'>allow_origin</span>
-        <span class='type'>(<tt>String</tt>)</span>
-        &mdash;
-        <div class='inline'><p>The value for the <code>Access-Control-Allow-Origin</code> header.</p>
-</div>
-    </li>
-    <li>
-        <span class='name'>allow_methods</span>
-        <span class='type'>(<tt>Array</tt>)</span>
-        &mdash;
-        <div class='inline'><p>A list of methods for the <code>Access-Control-Allow-Methods</code> header.</p>
-</div>
-    </li>
-    <li>
-        <span class='name'>allow_headers</span>
-        <span class='type'>(<tt>String</tt>)</span>
-        &mdash;
-        <div class='inline'><p>The value for the <code>Access-Control-Allow-Headers</code> header.</p>
-</div>
-    </li>
-    <li>
-        <span class='name'>max_age</span>
-        <span class='type'>(<tt>Float|Fixnum</tt>)</span>
-        &mdash;
-        <div class='inline'><p>The value for the <code>Access-Control-Max-Age</code> header.</p>
-</div>
-    </li>
-    <li>
-        <span class='name'>allow_credentials</span>
-        <span class='type'>(<tt>Boolean</tt>)</span>
-        &mdash;
-        <div class='inline'><p>The value for the <code>Access-Control-Allow-Credentials</code> header.</p>
-</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-82
-83
-84
-85
-86
-87
-88
-89
-90
-91</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/ballast/concerns/ajax.rb', line 82</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_allow_cors'>allow_cors</span><span class='lparen'>(</span><span class='label'>allow_origin:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>*</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>allow_methods:</span> <span class='lbracket'>[</span><span class='symbol'>:post</span><span class='comma'>,</span> <span class='symbol'>:get</span><span class='comma'>,</span> <span class='symbol'>:options</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='label'>allow_headers:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>*</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>max_age:</span> <span class='int'>1</span><span class='period'>.</span><span class='id identifier rubyid_year'>year</span><span class='comma'>,</span> <span class='label'>allow_credentials:</span> <span class='kw'>false</span><span class='rparen'>)</span>
-  <span class='id identifier rubyid_headers'>headers</span><span class='period'>.</span><span class='id identifier rubyid_merge!'>merge!</span><span class='lparen'>(</span><span class='lbrace'>{</span>
-    <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Access-Control-Allow-Origin</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_allow_origin'>allow_origin</span><span class='comma'>,</span>
-    <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Access-Control-Allow-Methods</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_allow_methods'>allow_methods</span><span class='period'>.</span><span class='id identifier rubyid_collect'>collect</span> <span class='lbrace'>{</span><span class='op'>|</span><span class='id identifier rubyid_m'>m</span><span class='op'>|</span> <span class='id identifier rubyid_m'>m</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='period'>.</span><span class='id identifier rubyid_upcase'>upcase</span> <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>, </span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='comma'>,</span>
-    <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Access-Control-Allow-Headers</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_allow_headers'>allow_headers</span><span class='comma'>,</span>
-    <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Access-Control-Max-Age</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_max_age'>max_age</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>
-  <span class='rbrace'>}</span><span class='rparen'>)</span>
-  <span class='id identifier rubyid_headers'>headers</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Access-Control-Allow-Credentials</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>true</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_allow_credentials'>allow_credentials</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <h3 class="signature " id="generate_robots_txt-instance_method">
-    - (<tt>Object</tt>) <strong>generate_robots_txt</strong>(configuration = nil)
-    <span class="aliases">Also known as:
-    <span class="names"><span id='disallow_robots-instance_method'>disallow_robots</span></span>
-    </span>
-</h3><div class="docstring">
-  <div class="discussion">
-    <p>Generates a robots.txt file.</p>
-  </div>
-</div>
-<div class="tags">
-  <p class="tag_title">Parameters:</p>
-<ul class="param">
-    <li>
-        <span class='name'>configuration</span>
-        <span class='type'>(<tt>Array</tt>)</span>
-        <em class="default">(defaults to: <tt>nil</tt>)</em>
-        &mdash;
-        <div class='inline'><p>An array of list of agent and paths to include.</p>
-</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-96
-97
-98
-99
-100
-101
-102
-103
-104
-105</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/ballast/concerns/ajax.rb', line 96</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_generate_robots_txt'>generate_robots_txt</span><span class='lparen'>(</span><span class='id identifier rubyid_configuration'>configuration</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
-  <span class='id identifier rubyid_rv'>rv</span> <span class='op'>=</span> <span class='id identifier rubyid_configuration'>configuration</span><span class='period'>.</span><span class='id identifier rubyid_ensure_array'>ensure_array</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>*</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='kw'>false</span><span class='rparen'>)</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_entry'>entry</span><span class='op'>|</span>
-    <span class='id identifier rubyid_agent'>agent</span> <span class='op'>=</span> <span class='id identifier rubyid_entry'>entry</span><span class='period'>.</span><span class='id identifier rubyid_shift'>shift</span>
-    <span class='id identifier rubyid_paths'>paths</span> <span class='op'>=</span> <span class='id identifier rubyid_entry'>entry</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span><span class='op'>|</span><span class='id identifier rubyid_e'>e</span><span class='op'>|</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Disallow: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_e'>e</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span> <span class='rbrace'>}</span>
-    <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>User-agent: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_agent'>agent</span><span class='embexpr_end'>}</span><span class='tstring_content'>\n</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_paths'>paths</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\n</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
-  <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\n\n</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
-  <span class='id identifier rubyid_render'>render</span><span class='lparen'>(</span><span class='label'>text:</span> <span class='id identifier rubyid_rv'>rv</span><span class='comma'>,</span> <span class='label'>content_type:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>text/plain</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <h3 class="signature " id="is_ajax?-instance_method">
-    - (<tt>Boolean</tt>) <strong>is_ajax?</strong>
-</h3><div class="docstring">
-  <div class="discussion">
-    <p>Checks if the current request is AJAX.</p>
-  </div>
-</div>
-<div class="tags">
-<p class="tag_title">Returns:</p>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt>Boolean</tt>)</span>
-        &mdash;
-        <div class='inline'><p><code>true</code> if the request is AJAX, <code>false</code> otherwise.</p>
-</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-16
-17
-18</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/ballast/concerns/ajax.rb', line 16</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_is_ajax?'>is_ajax?</span>
-  <span class='lparen'>(</span><span class='lparen'>(</span><span class='id identifier rubyid_request'>request</span><span class='period'>.</span><span class='id identifier rubyid_respond_to?'>respond_to?</span><span class='lparen'>(</span><span class='symbol'>:xhr?</span><span class='rparen'>)</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_request'>request</span><span class='period'>.</span><span class='id identifier rubyid_xhr?'>xhr?</span><span class='rparen'>)</span> <span class='op'>||</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:xhr</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_to_boolean'>to_boolean</span><span class='rparen'>)</span> <span class='op'>?</span> <span class='kw'>true</span> <span class='op'>:</span> <span class='kw'>false</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <h3 class="signature " id="prepare_ajax-instance_method">
-    - (<tt>Object</tt>) <strong>prepare_ajax</strong>(status = :ok, data = nil, error = nil)
-</h3><div class="docstring">
-  <div class="discussion">
-    <p>Prepares an AJAX response.</p>
-  </div>
-</div>
-<div class="tags">
-  <p class="tag_title">Parameters:</p>
-<ul class="param">
-    <li>
-        <span class='name'>status</span>
-        <span class='type'>(<tt>Symbol|Fixnum</tt>)</span>
-        <em class="default">(defaults to: <tt>:ok</tt>)</em>
-        &mdash;
-        <div class='inline'><p>The HTTP status of the response.</p>
-</div>
-    </li>
-    <li>
-        <span class='name'>data</span>
-        <span class='type'>(<tt>Object</tt>)</span>
-        <em class="default">(defaults to: <tt>nil</tt>)</em>
-        &mdash;
-        <div class='inline'><p>Additional data to append to the response.</p>
-</div>
-    </li>
-    <li>
-        <span class='name'>error</span>
-        <span class='type'>(<tt>Object</tt>)</span>
-        <em class="default">(defaults to: <tt>nil</tt>)</em>
-        &mdash;
-        <div class='inline'><p>A error to append to the response.</p>
-</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-25
-26
-27
-28
-29
-30</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/ballast/concerns/ajax.rb', line 25</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_prepare_ajax'>prepare_ajax</span><span class='lparen'>(</span><span class='id identifier rubyid_status'>status</span> <span class='op'>=</span> <span class='symbol'>:ok</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_error'>error</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
-  <span class='id identifier rubyid_rv'>rv</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='label'>status:</span> <span class='id identifier rubyid_status'>status</span><span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_ensure_access'>ensure_access</span><span class='lparen'>(</span><span class='symbol'>:indifferent</span><span class='rparen'>)</span>
-  <span class='id identifier rubyid_rv'>rv</span><span class='lbracket'>[</span><span class='symbol'>:error</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_error'>error</span> <span class='kw'>if</span> <span class='id identifier rubyid_error'>error</span><span class='period'>.</span><span class='id identifier rubyid_present?'>present?</span>
-  <span class='id identifier rubyid_rv'>rv</span><span class='lbracket'>[</span><span class='symbol'>:data</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_data'>data</span> <span class='kw'>if</span> <span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_present?'>present?</span>
-  <span class='id identifier rubyid_rv'>rv</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <h3 class="signature " id="prevent_caching-instance_method">
-    - (<tt>Object</tt>) <strong>prevent_caching</strong>
-</h3><div class="docstring">
-  <div class="discussion">
-    <p>Prevents HTTP caching.</p>
-  </div>
-</div>
-<div class="tags">
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-67
-68
-69
-70
-71
-72
-73</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/ballast/concerns/ajax.rb', line 67</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_prevent_caching'>prevent_caching</span>
-  <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_headers'>headers</span><span class='period'>.</span><span class='id identifier rubyid_merge!'>merge!</span><span class='lparen'>(</span><span class='lbrace'>{</span>
-    <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Cache-Control</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>no-cache, no-store, max-age=0, must-revalidate</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
-    <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Pragma</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>no-cache</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
-    <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Expires</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Fri, 01 Jan 1990 00:00:00 GMT</span><span class='tstring_end'>&quot;</span></span>
-  <span class='rbrace'>}</span><span class='rparen'>)</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <h3 class="signature " id="send_ajax-instance_method">
-    - (<tt>Object</tt>) <strong>send_ajax</strong>(data, status: :ok, format: :json, pretty_json: false)
-</h3><div class="docstring">
-  <div class="discussion">
-    <p>Sends an AJAX response to the client.</p>
-  </div>
-</div>
-<div class="tags">
-  <p class="tag_title">Parameters:</p>
-<ul class="param">
-    <li>
-        <span class='name'>data</span>
-        <span class='type'>(<tt>Hash</tt>)</span>
-        &mdash;
-        <div class='inline'><p>The response to send.</p>
-</div>
-    </li>
-    <li>
-        <span class='name'>status</span>
-        <span class='type'>(<tt>Symbol|Fixnum</tt>)</span>
-        &mdash;
-        <div class='inline'><p>The HTTP status of the response, <em>ignored if already set in data</em>.</p>
-</div>
-    </li>
-    <li>
-        <span class='name'>format</span>
-        <span class='type'>(<tt>Symbol</tt>)</span>
-        &mdash;
-        <div class='inline'><p>The content type of the response.</p>
-</div>
-    </li>
-    <li>
-        <span class='name'>pretty_json</span>
-        <span class='type'>(<tt>Boolean</tt>)</span>
-        &mdash;
-        <div class='inline'><p>If JSON response must be pretty formatted.</p>
-</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-38
-39
-40
-41
-42
-43
-44
-45
-46
-47
-48
-49
-50
-51
-52
-53</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/ballast/concerns/ajax.rb', line 38</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_send_ajax'>send_ajax</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='label'>status:</span> <span class='symbol'>:ok</span><span class='comma'>,</span> <span class='label'>format:</span> <span class='symbol'>:json</span><span class='comma'>,</span> <span class='label'>pretty_json:</span> <span class='kw'>false</span><span class='rparen'>)</span>
-  <span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_performed?'>performed?</span> <span class='kw'>then</span>
-    <span class='comment'># Prepare data
-</span>    <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='id identifier rubyid_prepare_ajax_send'>prepare_ajax_send</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='id identifier rubyid_status'>status</span><span class='rparen'>)</span>
-    <span class='comment'># Setup callback and format
-</span>    <span class='id identifier rubyid_format'>format</span><span class='comma'>,</span> <span class='id identifier rubyid_callback'>callback</span><span class='comma'>,</span> <span class='id identifier rubyid_content_type'>content_type</span> <span class='op'>=</span> <span class='id identifier rubyid_format_ajax_send'>format_ajax_send</span><span class='lparen'>(</span><span class='id identifier rubyid_format'>format</span><span class='rparen'>)</span>
-    <span class='id identifier rubyid_status'>status</span> <span class='op'>=</span> <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:status</span><span class='rbracket'>]</span>
-    <span class='comment'># Adjust data
-</span>    <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lparen'>(</span><span class='id identifier rubyid_pretty_json'>pretty_json</span> <span class='op'>?</span> <span class='const'>Oj</span><span class='period'>.</span><span class='id identifier rubyid_dump'>dump</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span> <span class='op'>:</span> <span class='const'>ActiveSupport</span><span class='op'>::</span><span class='const'>JSON</span><span class='period'>.</span><span class='id identifier rubyid_encode'>encode</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='lbracket'>[</span><span class='symbol'>:json</span><span class='comma'>,</span> <span class='symbol'>:jsonp</span><span class='comma'>,</span> <span class='symbol'>:text</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='id identifier rubyid_format'>format</span><span class='rparen'>)</span>
-    <span class='comment'># Render
-</span>    <span class='id identifier rubyid_render'>render</span><span class='lparen'>(</span><span class='id identifier rubyid_format'>format</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='label'>status:</span> <span class='id identifier rubyid_status'>status</span><span class='comma'>,</span> <span class='label'>callback:</span> <span class='id identifier rubyid_callback'>callback</span><span class='comma'>,</span> <span class='label'>content_type:</span> <span class='id identifier rubyid_content_type'>content_type</span><span class='rparen'>)</span>
-  <span class='kw'>end</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <h3 class="signature " id="update_ajax-instance_method">
-    - (<tt>Hash</tt>) <strong>update_ajax</strong>(data, operation = nil)
-</h3><div class="docstring">
-  <div class="discussion">
-    <p>Updates an AJAX response from a operation, taking either the response data or the first error.</p>
-  </div>
-</div>
-<div class="tags">
-  <p class="tag_title">Parameters:</p>
-<ul class="param">
-    <li>
-        <span class='name'>data</span>
-        <span class='type'>(<tt>Hash</tt>)</span>
-        &mdash;
-        <div class='inline'><p>The current data.</p>
-</div>
-    </li>
-    <li>
-        <span class='name'>operation</span>
-        <span class='type'>(<tt><span class='object_link'><a href="../Operation.html" title="Ballast::Operation (class)">Operation</a></span></tt>)</span>
-        <em class="default">(defaults to: <tt>nil</tt>)</em>
-        &mdash;
-        <div class='inline'><p>The operation to gather data from.</p>
-</div>
-    </li>
-</ul>
-<p class="tag_title">Returns:</p>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt>Hash</tt>)</span>
-        &mdash;
-        <div class='inline'><p>The updated data.</p>
-</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-60
-61
-62
-63
-64</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/ballast/concerns/ajax.rb', line 60</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_update_ajax'>update_ajax</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='id identifier rubyid_operation'>operation</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
-  <span class='id identifier rubyid_operation'>operation</span> <span class='op'>||=</span> <span class='ivar'>@operation</span>
-  <span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_merge!'>merge!</span><span class='lparen'>(</span><span class='id identifier rubyid_operation'>operation</span><span class='period'>.</span><span class='id identifier rubyid_success?'>success?</span> <span class='op'>?</span> <span class='lbrace'>{</span><span class='label'>data:</span> <span class='id identifier rubyid_operation'>operation</span><span class='period'>.</span><span class='id identifier rubyid_response'>response</span><span class='lbracket'>[</span><span class='symbol'>:data</span><span class='rbracket'>]</span><span class='rbrace'>}</span> <span class='op'>:</span> <span class='lbrace'>{</span><span class='label'>error:</span> <span class='id identifier rubyid_operation'>operation</span><span class='period'>.</span><span class='id identifier rubyid_errors'>errors</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span><span class='rbrace'>}</span><span class='rparen'>)</span>
-  <span class='id identifier rubyid_data'>data</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-  </div>
-</div>
-    <div id="footer">
-  Generated on Sat Mar 15 14:04:12 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>
-  </body>
-</html>