ballast 2.0.1 → 2.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (53) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +1 -2
  3. data/.rubocop.yml +3 -0
  4. data/CHANGELOG.md +4 -0
  5. data/README.md +2 -2
  6. data/ballast.gemspec +1 -1
  7. data/doc/Ballast/AjaxResponse.html +312 -264
  8. data/doc/Ballast/Concerns/AjaxHandling.html +39 -34
  9. data/doc/Ballast/Concerns/Common.html +231 -93
  10. data/doc/Ballast/Concerns/ErrorsHandling.html +15 -14
  11. data/doc/Ballast/Concerns/View.html +43 -36
  12. data/doc/Ballast/Concerns.html +2 -2
  13. data/doc/Ballast/Configuration.html +23 -20
  14. data/doc/Ballast/Emoji/Character.html +19 -16
  15. data/doc/Ballast/Emoji/Utils.html +87 -82
  16. data/doc/Ballast/Emoji.html +2 -2
  17. data/doc/Ballast/Errors/Base.html +19 -17
  18. data/doc/Ballast/Errors/Failure.html +2 -2
  19. data/doc/Ballast/Errors/InvalidDomain.html +2 -2
  20. data/doc/Ballast/Errors/ValidationFailure.html +2 -2
  21. data/doc/Ballast/Errors.html +3 -3
  22. data/doc/Ballast/Middlewares/DefaultHost.html +19 -17
  23. data/doc/Ballast/Middlewares.html +2 -2
  24. data/doc/Ballast/RequestDomainMatcher.html +118 -112
  25. data/doc/Ballast/Service/Response.html +216 -208
  26. data/doc/Ballast/Service.html +172 -178
  27. data/doc/Ballast/Version.html +10 -6
  28. data/doc/Ballast.html +15 -14
  29. data/doc/_index.html +2 -2
  30. data/doc/file.README.html +4 -4
  31. data/doc/index.html +4 -4
  32. data/doc/method_list.html +24 -18
  33. data/doc/top-level-namespace.html +2 -39
  34. data/lib/ballast/ajax_response.rb +6 -1
  35. data/lib/ballast/concerns/common.rb +10 -0
  36. data/lib/ballast/errors.rb +1 -1
  37. data/lib/ballast/version.rb +3 -3
  38. data/spec/ballast/concerns/common_spec.rb +26 -0
  39. metadata +5 -19
  40. data/tmp/saikuro/index_cyclo.html +0 -158
  41. data/tmp/saikuro/lib/ballast/concerns/ajax.rb_cyclo.html +0 -21
  42. data/tmp/saikuro/lib/ballast/concerns/common.rb_cyclo.html +0 -20
  43. data/tmp/saikuro/lib/ballast/concerns/errors_handling.rb_cyclo.html +0 -14
  44. data/tmp/saikuro/lib/ballast/concerns/view.rb_cyclo.html +0 -20
  45. data/tmp/saikuro/lib/ballast/configuration.rb_cyclo.html +0 -10
  46. data/tmp/saikuro/lib/ballast/context.rb_cyclo.html +0 -11
  47. data/tmp/saikuro/lib/ballast/errors.rb_cyclo.html +0 -22
  48. data/tmp/saikuro/lib/ballast/middlewares/default_host.rb_cyclo.html +0 -14
  49. data/tmp/saikuro/lib/ballast/operation.rb_cyclo.html +0 -19
  50. data/tmp/saikuro/lib/ballast/operations_chain.rb_cyclo.html +0 -12
  51. data/tmp/saikuro/lib/ballast/request_domain_matcher.rb_cyclo.html +0 -11
  52. data/tmp/saikuro/lib/ballast/version.rb_cyclo.html +0 -9
  53. data/tmp/saikuro/lib/ballast.rb_cyclo.html +0 -8
data/doc/Ballast/Service/Response.html CHANGED
@@ -442,13 +442,14 @@
442
442
  <td>
443
443
  <pre class="code"><span class="info file"># File 'lib/ballast/service.rb', line 29</span>
444
444
 
445
- <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_success'>success</span> <span class='op'>=</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>errors:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>error:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
446
- <span class='id identifier rubyid_errors'>errors</span> <span class='op'>||=</span> <span class='id identifier rubyid_error'>error</span><span class='period'>.</span><span class='id identifier rubyid_ensure_array'>ensure_array</span>
447
-
448
- <span class='ivar'>@success</span> <span class='op'>=</span> <span class='id identifier rubyid_success'>success</span><span class='period'>.</span><span class='id identifier rubyid_to_boolean'>to_boolean</span>
449
- <span class='ivar'>@data</span> <span class='op'>=</span> <span class='id identifier rubyid_data'>data</span>
450
- <span class='ivar'>@errors</span> <span class='op'>=</span> <span class='id identifier rubyid_errors'>errors</span><span class='period'>.</span><span class='id identifier rubyid_ensure_array'>ensure_array</span><span class='lparen'>(</span><span class='label'>no_duplicates:</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='label'>compact:</span> <span class='kw'>true</span><span class='rparen'>)</span>
451
- <span class='kw'>end</span></pre>
445
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='rubyid_success identifier id'>success</span> <span class='assign token'>=</span> <span class='rubyid_true true kw'>true</span><span class='comma token'>,</span> <span class='label val'>data:</span> <span class='rubyid_nil nil kw'>nil</span><span class='comma token'>,</span> <span class='label val'>errors:</span> <span class='rubyid_nil nil kw'>nil</span><span class='comma token'>,</span> <span class='label val'>error:</span> <span class='rubyid_nil nil kw'>nil</span><span class='rparen token'>)</span>
446
+ <span class='rubyid_errors identifier id'>errors</span> <span class='opasgn op'>||=</span> <span class='rubyid_error identifier id'>error</span><span class='dot token'>.</span><span class='rubyid_ensure_array identifier id'>ensure_array</span>
447
+
448
+ <span class='rubyid_@success ivar id'>@success</span> <span class='assign token'>=</span> <span class='rubyid_success identifier id'>success</span><span class='dot token'>.</span><span class='rubyid_to_boolean identifier id'>to_boolean</span>
449
+ <span class='rubyid_@data ivar id'>@data</span> <span class='assign token'>=</span> <span class='rubyid_data identifier id'>data</span>
450
+ <span class='rubyid_@errors ivar id'>@errors</span> <span class='assign token'>=</span> <span class='rubyid_errors identifier id'>errors</span><span class='dot token'>.</span><span class='rubyid_ensure_array identifier id'>ensure_array</span><span class='lparen token'>(</span><span class='label val'>no_duplicates:</span> <span class='rubyid_true true kw'>true</span><span class='comma token'>,</span> <span class='label val'>compact:</span> <span class='rubyid_true true kw'>true</span><span class='rparen token'>)</span>
451
+ <span class='rubyid_end end kw'>end</span>
452
+ </pre>
452
453
  </td>
453
454
  </tr>
454
455
  </table>
@@ -566,65 +567,66 @@
566
567
  <td>
567
568
  <pre class="code"><span class="info file"># File 'lib/ballast/service.rb', line 20</span>
568
569
 
569
- <span class='kw'>class</span> <span class='const'>Response</span>
570
- <span class='id identifier rubyid_attr_reader'>attr_reader</span> <span class='symbol'>:success</span><span class='comma'>,</span> <span class='symbol'>:data</span><span class='comma'>,</span> <span class='symbol'>:errors</span>
571
-
572
- <span class='comment'># Creates a new service response.
573
- </span> <span class='comment'>#
574
- </span> <span class='comment'># @param success [Boolean] Whether the invocation was successful or not.
575
- </span> <span class='comment'># @param data [Object|NilClass] The data returned by the operation.
576
- </span> <span class='comment'># @param errors [Array|NilClass] The errors returned by the operation.
577
- </span> <span class='comment'># @param error [Object|NilClass] Alias for errors. *Ignored if `errors` is present.*
578
- </span> <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_success'>success</span> <span class='op'>=</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>errors:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>error:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
579
- <span class='id identifier rubyid_errors'>errors</span> <span class='op'>||=</span> <span class='id identifier rubyid_error'>error</span><span class='period'>.</span><span class='id identifier rubyid_ensure_array'>ensure_array</span>
580
-
581
- <span class='ivar'>@success</span> <span class='op'>=</span> <span class='id identifier rubyid_success'>success</span><span class='period'>.</span><span class='id identifier rubyid_to_boolean'>to_boolean</span>
582
- <span class='ivar'>@data</span> <span class='op'>=</span> <span class='id identifier rubyid_data'>data</span>
583
- <span class='ivar'>@errors</span> <span class='op'>=</span> <span class='id identifier rubyid_errors'>errors</span><span class='period'>.</span><span class='id identifier rubyid_ensure_array'>ensure_array</span><span class='lparen'>(</span><span class='label'>no_duplicates:</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='label'>compact:</span> <span class='kw'>true</span><span class='rparen'>)</span>
584
- <span class='kw'>end</span>
585
-
586
- <span class='comment'># Returns whether the invocation was successful or not.
587
- </span> <span class='comment'>#
588
- </span> <span class='comment'># @return [Boolean] `true` if the service invocation was successful, `false` otherwise.
589
- </span> <span class='kw'>def</span> <span class='id identifier rubyid_success?'>success?</span>
590
- <span class='comment'># TODO@PI: Ignore rubocop on this
591
- </span> <span class='ivar'>@success</span>
592
- <span class='kw'>end</span>
593
- <span class='id identifier rubyid_alias_method'>alias_method</span> <span class='symbol'>:successful?</span><span class='comma'>,</span> <span class='symbol'>:success?</span>
594
- <span class='id identifier rubyid_alias_method'>alias_method</span> <span class='symbol'>:succeeded?</span><span class='comma'>,</span> <span class='symbol'>:success?</span>
595
-
596
- <span class='comment'># Returns whether the invocation failed or not.
597
- </span> <span class='comment'>#
598
- </span> <span class='comment'># @return [Boolean] `true` if the service invocation failed, `false` otherwise.
599
- </span> <span class='kw'>def</span> <span class='id identifier rubyid_fail?'>fail?</span>
600
- <span class='op'>!</span><span class='ivar'>@success</span>
601
- <span class='kw'>end</span>
602
- <span class='id identifier rubyid_alias_method'>alias_method</span> <span class='symbol'>:failed?</span><span class='comma'>,</span> <span class='symbol'>:fail?</span>
603
-
604
- <span class='comment'># Returns the first error returned by the operation.
605
- </span> <span class='comment'>#
606
- </span> <span class='comment'># @return [Object] The first error returned by the service.
607
- </span> <span class='kw'>def</span> <span class='id identifier rubyid_error'>error</span>
608
- <span class='ivar'>@errors</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span>
609
- <span class='kw'>end</span>
610
-
611
- <span class='comment'># Converts this response to a AJAX response.
612
- </span> <span class='comment'>#
613
- </span> <span class='comment'># @param transport [Object|NilClass] The transport to use for sending. Must respond to `render`, `params`, `request.format` and `performed?`.
614
- </span> <span class='comment'># @return [AjaxResponse] The AJAX response, which will include only the first error.
615
- </span> <span class='kw'>def</span> <span class='id identifier rubyid_as_ajax_response'>as_ajax_response</span><span class='lparen'>(</span><span class='id identifier rubyid_transport'>transport</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
616
- <span class='id identifier rubyid_status'>status</span><span class='comma'>,</span> <span class='id identifier rubyid_error_message'>error_message</span> <span class='op'>=</span>
617
- <span class='kw'>if</span> <span class='id identifier rubyid_successful?'>successful?</span>
618
- <span class='lbracket'>[</span><span class='symbol'>:ok</span><span class='comma'>,</span> <span class='kw'>nil</span><span class='rbracket'>]</span>
619
- <span class='kw'>elsif</span> <span class='id identifier rubyid_error'>error</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Hash</span><span class='rparen'>)</span>
620
- <span class='lbracket'>[</span><span class='id identifier rubyid_error'>error</span><span class='lbracket'>[</span><span class='symbol'>:status</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_error'>error</span><span class='lbracket'>[</span><span class='symbol'>:error</span><span class='rbracket'>]</span><span class='rbracket'>]</span>
621
- <span class='kw'>else</span>
622
- <span class='lbracket'>[</span><span class='symbol'>:unknown</span><span class='comma'>,</span> <span class='id identifier rubyid_error'>error</span><span class='rbracket'>]</span>
623
- <span class='kw'>end</span>
624
-
625
- <span class='const'>AjaxResponse</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='label'>status:</span> <span class='id identifier rubyid_status'>status</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='label'>error:</span> <span class='id identifier rubyid_error_message'>error_message</span><span class='comma'>,</span> <span class='label'>transport:</span> <span class='id identifier rubyid_transport'>transport</span><span class='rparen'>)</span>
626
- <span class='kw'>end</span>
627
- <span class='kw'>end</span></pre>
570
+ <span class='rubyid_class class kw'>class</span> <span class='rubyid_Response constant id'>Response</span>
571
+ <span class='rubyid_attr_reader identifier id'>attr_reader</span> <span class='symbol val'>:success</span><span class='comma token'>,</span> <span class='symbol val'>:data</span><span class='comma token'>,</span> <span class='symbol val'>:errors</span>
572
+
573
+ <span class='comment val'># Creates a new service response.</span>
574
+ <span class='comment val'>#</span>
575
+ <span class='comment val'># @param success [Boolean] Whether the invocation was successful or not.</span>
576
+ <span class='comment val'># @param data [Object|NilClass] The data returned by the operation.</span>
577
+ <span class='comment val'># @param errors [Array|NilClass] The errors returned by the operation.</span>
578
+ <span class='comment val'># @param error [Object|NilClass] Alias for errors. *Ignored if `errors` is present.*</span>
579
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='rubyid_success identifier id'>success</span> <span class='assign token'>=</span> <span class='rubyid_true true kw'>true</span><span class='comma token'>,</span> <span class='label val'>data:</span> <span class='rubyid_nil nil kw'>nil</span><span class='comma token'>,</span> <span class='label val'>errors:</span> <span class='rubyid_nil nil kw'>nil</span><span class='comma token'>,</span> <span class='label val'>error:</span> <span class='rubyid_nil nil kw'>nil</span><span class='rparen token'>)</span>
580
+ <span class='rubyid_errors identifier id'>errors</span> <span class='opasgn op'>||=</span> <span class='rubyid_error identifier id'>error</span><span class='dot token'>.</span><span class='rubyid_ensure_array identifier id'>ensure_array</span>
581
+
582
+ <span class='rubyid_@success ivar id'>@success</span> <span class='assign token'>=</span> <span class='rubyid_success identifier id'>success</span><span class='dot token'>.</span><span class='rubyid_to_boolean identifier id'>to_boolean</span>
583
+ <span class='rubyid_@data ivar id'>@data</span> <span class='assign token'>=</span> <span class='rubyid_data identifier id'>data</span>
584
+ <span class='rubyid_@errors ivar id'>@errors</span> <span class='assign token'>=</span> <span class='rubyid_errors identifier id'>errors</span><span class='dot token'>.</span><span class='rubyid_ensure_array identifier id'>ensure_array</span><span class='lparen token'>(</span><span class='label val'>no_duplicates:</span> <span class='rubyid_true true kw'>true</span><span class='comma token'>,</span> <span class='label val'>compact:</span> <span class='rubyid_true true kw'>true</span><span class='rparen token'>)</span>
585
+ <span class='rubyid_end end kw'>end</span>
586
+
587
+ <span class='comment val'># Returns whether the invocation was successful or not.</span>
588
+ <span class='comment val'>#</span>
589
+ <span class='comment val'># @return [Boolean] `true` if the service invocation was successful, `false` otherwise.</span>
590
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_success? fid id'>success?</span>
591
+ <span class='comment val'># TODO@PI: Ignore rubocop on this</span>
592
+ <span class='rubyid_@success ivar id'>@success</span>
593
+ <span class='rubyid_end end kw'>end</span>
594
+ <span class='rubyid_alias_method identifier id'>alias_method</span> <span class='symbol val'>:successful?</span><span class='comma token'>,</span> <span class='symbol val'>:success?</span>
595
+ <span class='rubyid_alias_method identifier id'>alias_method</span> <span class='symbol val'>:succeeded?</span><span class='comma token'>,</span> <span class='symbol val'>:success?</span>
596
+
597
+ <span class='comment val'># Returns whether the invocation failed or not.</span>
598
+ <span class='comment val'>#</span>
599
+ <span class='comment val'># @return [Boolean] `true` if the service invocation failed, `false` otherwise.</span>
600
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_fail? fid id'>fail?</span>
601
+ <span class='notop op'>!</span><span class='rubyid_@success ivar id'>@success</span>
602
+ <span class='rubyid_end end kw'>end</span>
603
+ <span class='rubyid_alias_method identifier id'>alias_method</span> <span class='symbol val'>:failed?</span><span class='comma token'>,</span> <span class='symbol val'>:fail?</span>
604
+
605
+ <span class='comment val'># Returns the first error returned by the operation.</span>
606
+ <span class='comment val'>#</span>
607
+ <span class='comment val'># @return [Object] The first error returned by the service.</span>
608
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_error identifier id'>error</span>
609
+ <span class='rubyid_@errors ivar id'>@errors</span><span class='dot token'>.</span><span class='rubyid_first identifier id'>first</span>
610
+ <span class='rubyid_end end kw'>end</span>
611
+
612
+ <span class='comment val'># Converts this response to a AJAX response.</span>
613
+ <span class='comment val'>#</span>
614
+ <span class='comment val'># @param transport [Object|NilClass] The transport to use for sending. Must respond to `render`, `params`, `request.format` and `performed?`.</span>
615
+ <span class='comment val'># @return [AjaxResponse] The AJAX response, which will include only the first error.</span>
616
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_as_ajax_response identifier id'>as_ajax_response</span><span class='lparen token'>(</span><span class='rubyid_transport identifier id'>transport</span> <span class='assign token'>=</span> <span class='rubyid_nil nil kw'>nil</span><span class='rparen token'>)</span>
617
+ <span class='rubyid_status identifier id'>status</span><span class='comma token'>,</span> <span class='rubyid_error_message identifier id'>error_message</span> <span class='assign token'>=</span>
618
+ <span class='rubyid_if if kw'>if</span> <span class='rubyid_successful? fid id'>successful?</span>
619
+ <span class='lbrack token'>[</span><span class='symbol val'>:ok</span><span class='comma token'>,</span> <span class='rubyid_nil nil kw'>nil</span><span class='rbrack token'>]</span>
620
+ <span class='rubyid_elsif elsif kw'>elsif</span> <span class='rubyid_error identifier id'>error</span><span class='dot token'>.</span><span class='rubyid_is_a? fid id'>is_a?</span><span class='lparen token'>(</span><span class='rubyid_Hash constant id'>Hash</span><span class='rparen token'>)</span>
621
+ <span class='lbrack token'>[</span><span class='rubyid_error identifier id'>error</span><span class='lbrack token'>[</span><span class='symbol val'>:status</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='rubyid_error identifier id'>error</span><span class='lbrack token'>[</span><span class='symbol val'>:error</span><span class='rbrack token'>]</span><span class='rbrack token'>]</span>
622
+ <span class='rubyid_else else kw'>else</span>
623
+ <span class='lbrack token'>[</span><span class='symbol val'>:unknown</span><span class='comma token'>,</span> <span class='rubyid_error identifier id'>error</span><span class='rbrack token'>]</span>
624
+ <span class='rubyid_end end kw'>end</span>
625
+
626
+ <span class='rubyid_AjaxResponse constant id'>AjaxResponse</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='label val'>status:</span> <span class='rubyid_status identifier id'>status</span><span class='comma token'>,</span> <span class='label val'>data:</span> <span class='rubyid_data identifier id'>data</span><span class='comma token'>,</span> <span class='label val'>error:</span> <span class='rubyid_error_message identifier id'>error_message</span><span class='comma token'>,</span> <span class='label val'>transport:</span> <span class='rubyid_transport identifier id'>transport</span><span class='rparen token'>)</span>
627
+ <span class='rubyid_end end kw'>end</span>
628
+ <span class='rubyid_end end kw'>end</span>
629
+ </pre>
628
630
  </td>
629
631
  </tr>
630
632
  </table>
@@ -737,65 +739,66 @@
737
739
  <td>
738
740
  <pre class="code"><span class="info file"># File 'lib/ballast/service.rb', line 20</span>
739
741
 
740
- <span class='kw'>class</span> <span class='const'>Response</span>
741
- <span class='id identifier rubyid_attr_reader'>attr_reader</span> <span class='symbol'>:success</span><span class='comma'>,</span> <span class='symbol'>:data</span><span class='comma'>,</span> <span class='symbol'>:errors</span>
742
-
743
- <span class='comment'># Creates a new service response.
744
- </span> <span class='comment'>#
745
- </span> <span class='comment'># @param success [Boolean] Whether the invocation was successful or not.
746
- </span> <span class='comment'># @param data [Object|NilClass] The data returned by the operation.
747
- </span> <span class='comment'># @param errors [Array|NilClass] The errors returned by the operation.
748
- </span> <span class='comment'># @param error [Object|NilClass] Alias for errors. *Ignored if `errors` is present.*
749
- </span> <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_success'>success</span> <span class='op'>=</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>errors:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>error:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
750
- <span class='id identifier rubyid_errors'>errors</span> <span class='op'>||=</span> <span class='id identifier rubyid_error'>error</span><span class='period'>.</span><span class='id identifier rubyid_ensure_array'>ensure_array</span>
751
-
752
- <span class='ivar'>@success</span> <span class='op'>=</span> <span class='id identifier rubyid_success'>success</span><span class='period'>.</span><span class='id identifier rubyid_to_boolean'>to_boolean</span>
753
- <span class='ivar'>@data</span> <span class='op'>=</span> <span class='id identifier rubyid_data'>data</span>
754
- <span class='ivar'>@errors</span> <span class='op'>=</span> <span class='id identifier rubyid_errors'>errors</span><span class='period'>.</span><span class='id identifier rubyid_ensure_array'>ensure_array</span><span class='lparen'>(</span><span class='label'>no_duplicates:</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='label'>compact:</span> <span class='kw'>true</span><span class='rparen'>)</span>
755
- <span class='kw'>end</span>
756
-
757
- <span class='comment'># Returns whether the invocation was successful or not.
758
- </span> <span class='comment'>#
759
- </span> <span class='comment'># @return [Boolean] `true` if the service invocation was successful, `false` otherwise.
760
- </span> <span class='kw'>def</span> <span class='id identifier rubyid_success?'>success?</span>
761
- <span class='comment'># TODO@PI: Ignore rubocop on this
762
- </span> <span class='ivar'>@success</span>
763
- <span class='kw'>end</span>
764
- <span class='id identifier rubyid_alias_method'>alias_method</span> <span class='symbol'>:successful?</span><span class='comma'>,</span> <span class='symbol'>:success?</span>
765
- <span class='id identifier rubyid_alias_method'>alias_method</span> <span class='symbol'>:succeeded?</span><span class='comma'>,</span> <span class='symbol'>:success?</span>
766
-
767
- <span class='comment'># Returns whether the invocation failed or not.
768
- </span> <span class='comment'>#
769
- </span> <span class='comment'># @return [Boolean] `true` if the service invocation failed, `false` otherwise.
770
- </span> <span class='kw'>def</span> <span class='id identifier rubyid_fail?'>fail?</span>
771
- <span class='op'>!</span><span class='ivar'>@success</span>
772
- <span class='kw'>end</span>
773
- <span class='id identifier rubyid_alias_method'>alias_method</span> <span class='symbol'>:failed?</span><span class='comma'>,</span> <span class='symbol'>:fail?</span>
774
-
775
- <span class='comment'># Returns the first error returned by the operation.
776
- </span> <span class='comment'>#
777
- </span> <span class='comment'># @return [Object] The first error returned by the service.
778
- </span> <span class='kw'>def</span> <span class='id identifier rubyid_error'>error</span>
779
- <span class='ivar'>@errors</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span>
780
- <span class='kw'>end</span>
781
-
782
- <span class='comment'># Converts this response to a AJAX response.
783
- </span> <span class='comment'>#
784
- </span> <span class='comment'># @param transport [Object|NilClass] The transport to use for sending. Must respond to `render`, `params`, `request.format` and `performed?`.
785
- </span> <span class='comment'># @return [AjaxResponse] The AJAX response, which will include only the first error.
786
- </span> <span class='kw'>def</span> <span class='id identifier rubyid_as_ajax_response'>as_ajax_response</span><span class='lparen'>(</span><span class='id identifier rubyid_transport'>transport</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
787
- <span class='id identifier rubyid_status'>status</span><span class='comma'>,</span> <span class='id identifier rubyid_error_message'>error_message</span> <span class='op'>=</span>
788
- <span class='kw'>if</span> <span class='id identifier rubyid_successful?'>successful?</span>
789
- <span class='lbracket'>[</span><span class='symbol'>:ok</span><span class='comma'>,</span> <span class='kw'>nil</span><span class='rbracket'>]</span>
790
- <span class='kw'>elsif</span> <span class='id identifier rubyid_error'>error</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Hash</span><span class='rparen'>)</span>
791
- <span class='lbracket'>[</span><span class='id identifier rubyid_error'>error</span><span class='lbracket'>[</span><span class='symbol'>:status</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_error'>error</span><span class='lbracket'>[</span><span class='symbol'>:error</span><span class='rbracket'>]</span><span class='rbracket'>]</span>
792
- <span class='kw'>else</span>
793
- <span class='lbracket'>[</span><span class='symbol'>:unknown</span><span class='comma'>,</span> <span class='id identifier rubyid_error'>error</span><span class='rbracket'>]</span>
794
- <span class='kw'>end</span>
795
-
796
- <span class='const'>AjaxResponse</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='label'>status:</span> <span class='id identifier rubyid_status'>status</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='label'>error:</span> <span class='id identifier rubyid_error_message'>error_message</span><span class='comma'>,</span> <span class='label'>transport:</span> <span class='id identifier rubyid_transport'>transport</span><span class='rparen'>)</span>
797
- <span class='kw'>end</span>
798
- <span class='kw'>end</span></pre>
742
+ <span class='rubyid_class class kw'>class</span> <span class='rubyid_Response constant id'>Response</span>
743
+ <span class='rubyid_attr_reader identifier id'>attr_reader</span> <span class='symbol val'>:success</span><span class='comma token'>,</span> <span class='symbol val'>:data</span><span class='comma token'>,</span> <span class='symbol val'>:errors</span>
744
+
745
+ <span class='comment val'># Creates a new service response.</span>
746
+ <span class='comment val'>#</span>
747
+ <span class='comment val'># @param success [Boolean] Whether the invocation was successful or not.</span>
748
+ <span class='comment val'># @param data [Object|NilClass] The data returned by the operation.</span>
749
+ <span class='comment val'># @param errors [Array|NilClass] The errors returned by the operation.</span>
750
+ <span class='comment val'># @param error [Object|NilClass] Alias for errors. *Ignored if `errors` is present.*</span>
751
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='rubyid_success identifier id'>success</span> <span class='assign token'>=</span> <span class='rubyid_true true kw'>true</span><span class='comma token'>,</span> <span class='label val'>data:</span> <span class='rubyid_nil nil kw'>nil</span><span class='comma token'>,</span> <span class='label val'>errors:</span> <span class='rubyid_nil nil kw'>nil</span><span class='comma token'>,</span> <span class='label val'>error:</span> <span class='rubyid_nil nil kw'>nil</span><span class='rparen token'>)</span>
752
+ <span class='rubyid_errors identifier id'>errors</span> <span class='opasgn op'>||=</span> <span class='rubyid_error identifier id'>error</span><span class='dot token'>.</span><span class='rubyid_ensure_array identifier id'>ensure_array</span>
753
+
754
+ <span class='rubyid_@success ivar id'>@success</span> <span class='assign token'>=</span> <span class='rubyid_success identifier id'>success</span><span class='dot token'>.</span><span class='rubyid_to_boolean identifier id'>to_boolean</span>
755
+ <span class='rubyid_@data ivar id'>@data</span> <span class='assign token'>=</span> <span class='rubyid_data identifier id'>data</span>
756
+ <span class='rubyid_@errors ivar id'>@errors</span> <span class='assign token'>=</span> <span class='rubyid_errors identifier id'>errors</span><span class='dot token'>.</span><span class='rubyid_ensure_array identifier id'>ensure_array</span><span class='lparen token'>(</span><span class='label val'>no_duplicates:</span> <span class='rubyid_true true kw'>true</span><span class='comma token'>,</span> <span class='label val'>compact:</span> <span class='rubyid_true true kw'>true</span><span class='rparen token'>)</span>
757
+ <span class='rubyid_end end kw'>end</span>
758
+
759
+ <span class='comment val'># Returns whether the invocation was successful or not.</span>
760
+ <span class='comment val'>#</span>
761
+ <span class='comment val'># @return [Boolean] `true` if the service invocation was successful, `false` otherwise.</span>
762
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_success? fid id'>success?</span>
763
+ <span class='comment val'># TODO@PI: Ignore rubocop on this</span>
764
+ <span class='rubyid_@success ivar id'>@success</span>
765
+ <span class='rubyid_end end kw'>end</span>
766
+ <span class='rubyid_alias_method identifier id'>alias_method</span> <span class='symbol val'>:successful?</span><span class='comma token'>,</span> <span class='symbol val'>:success?</span>
767
+ <span class='rubyid_alias_method identifier id'>alias_method</span> <span class='symbol val'>:succeeded?</span><span class='comma token'>,</span> <span class='symbol val'>:success?</span>
768
+
769
+ <span class='comment val'># Returns whether the invocation failed or not.</span>
770
+ <span class='comment val'>#</span>
771
+ <span class='comment val'># @return [Boolean] `true` if the service invocation failed, `false` otherwise.</span>
772
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_fail? fid id'>fail?</span>
773
+ <span class='notop op'>!</span><span class='rubyid_@success ivar id'>@success</span>
774
+ <span class='rubyid_end end kw'>end</span>
775
+ <span class='rubyid_alias_method identifier id'>alias_method</span> <span class='symbol val'>:failed?</span><span class='comma token'>,</span> <span class='symbol val'>:fail?</span>
776
+
777
+ <span class='comment val'># Returns the first error returned by the operation.</span>
778
+ <span class='comment val'>#</span>
779
+ <span class='comment val'># @return [Object] The first error returned by the service.</span>
780
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_error identifier id'>error</span>
781
+ <span class='rubyid_@errors ivar id'>@errors</span><span class='dot token'>.</span><span class='rubyid_first identifier id'>first</span>
782
+ <span class='rubyid_end end kw'>end</span>
783
+
784
+ <span class='comment val'># Converts this response to a AJAX response.</span>
785
+ <span class='comment val'>#</span>
786
+ <span class='comment val'># @param transport [Object|NilClass] The transport to use for sending. Must respond to `render`, `params`, `request.format` and `performed?`.</span>
787
+ <span class='comment val'># @return [AjaxResponse] The AJAX response, which will include only the first error.</span>
788
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_as_ajax_response identifier id'>as_ajax_response</span><span class='lparen token'>(</span><span class='rubyid_transport identifier id'>transport</span> <span class='assign token'>=</span> <span class='rubyid_nil nil kw'>nil</span><span class='rparen token'>)</span>
789
+ <span class='rubyid_status identifier id'>status</span><span class='comma token'>,</span> <span class='rubyid_error_message identifier id'>error_message</span> <span class='assign token'>=</span>
790
+ <span class='rubyid_if if kw'>if</span> <span class='rubyid_successful? fid id'>successful?</span>
791
+ <span class='lbrack token'>[</span><span class='symbol val'>:ok</span><span class='comma token'>,</span> <span class='rubyid_nil nil kw'>nil</span><span class='rbrack token'>]</span>
792
+ <span class='rubyid_elsif elsif kw'>elsif</span> <span class='rubyid_error identifier id'>error</span><span class='dot token'>.</span><span class='rubyid_is_a? fid id'>is_a?</span><span class='lparen token'>(</span><span class='rubyid_Hash constant id'>Hash</span><span class='rparen token'>)</span>
793
+ <span class='lbrack token'>[</span><span class='rubyid_error identifier id'>error</span><span class='lbrack token'>[</span><span class='symbol val'>:status</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='rubyid_error identifier id'>error</span><span class='lbrack token'>[</span><span class='symbol val'>:error</span><span class='rbrack token'>]</span><span class='rbrack token'>]</span>
794
+ <span class='rubyid_else else kw'>else</span>
795
+ <span class='lbrack token'>[</span><span class='symbol val'>:unknown</span><span class='comma token'>,</span> <span class='rubyid_error identifier id'>error</span><span class='rbrack token'>]</span>
796
+ <span class='rubyid_end end kw'>end</span>
797
+
798
+ <span class='rubyid_AjaxResponse constant id'>AjaxResponse</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='label val'>status:</span> <span class='rubyid_status identifier id'>status</span><span class='comma token'>,</span> <span class='label val'>data:</span> <span class='rubyid_data identifier id'>data</span><span class='comma token'>,</span> <span class='label val'>error:</span> <span class='rubyid_error_message identifier id'>error_message</span><span class='comma token'>,</span> <span class='label val'>transport:</span> <span class='rubyid_transport identifier id'>transport</span><span class='rparen token'>)</span>
799
+ <span class='rubyid_end end kw'>end</span>
800
+ <span class='rubyid_end end kw'>end</span>
801
+ </pre>
799
802
  </td>
800
803
  </tr>
801
804
  </table>
@@ -908,65 +911,66 @@
908
911
  <td>
909
912
  <pre class="code"><span class="info file"># File 'lib/ballast/service.rb', line 20</span>
910
913
 
911
- <span class='kw'>class</span> <span class='const'>Response</span>
912
- <span class='id identifier rubyid_attr_reader'>attr_reader</span> <span class='symbol'>:success</span><span class='comma'>,</span> <span class='symbol'>:data</span><span class='comma'>,</span> <span class='symbol'>:errors</span>
913
-
914
- <span class='comment'># Creates a new service response.
915
- </span> <span class='comment'>#
916
- </span> <span class='comment'># @param success [Boolean] Whether the invocation was successful or not.
917
- </span> <span class='comment'># @param data [Object|NilClass] The data returned by the operation.
918
- </span> <span class='comment'># @param errors [Array|NilClass] The errors returned by the operation.
919
- </span> <span class='comment'># @param error [Object|NilClass] Alias for errors. *Ignored if `errors` is present.*
920
- </span> <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_success'>success</span> <span class='op'>=</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>errors:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>error:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
921
- <span class='id identifier rubyid_errors'>errors</span> <span class='op'>||=</span> <span class='id identifier rubyid_error'>error</span><span class='period'>.</span><span class='id identifier rubyid_ensure_array'>ensure_array</span>
922
-
923
- <span class='ivar'>@success</span> <span class='op'>=</span> <span class='id identifier rubyid_success'>success</span><span class='period'>.</span><span class='id identifier rubyid_to_boolean'>to_boolean</span>
924
- <span class='ivar'>@data</span> <span class='op'>=</span> <span class='id identifier rubyid_data'>data</span>
925
- <span class='ivar'>@errors</span> <span class='op'>=</span> <span class='id identifier rubyid_errors'>errors</span><span class='period'>.</span><span class='id identifier rubyid_ensure_array'>ensure_array</span><span class='lparen'>(</span><span class='label'>no_duplicates:</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='label'>compact:</span> <span class='kw'>true</span><span class='rparen'>)</span>
926
- <span class='kw'>end</span>
927
-
928
- <span class='comment'># Returns whether the invocation was successful or not.
929
- </span> <span class='comment'>#
930
- </span> <span class='comment'># @return [Boolean] `true` if the service invocation was successful, `false` otherwise.
931
- </span> <span class='kw'>def</span> <span class='id identifier rubyid_success?'>success?</span>
932
- <span class='comment'># TODO@PI: Ignore rubocop on this
933
- </span> <span class='ivar'>@success</span>
934
- <span class='kw'>end</span>
935
- <span class='id identifier rubyid_alias_method'>alias_method</span> <span class='symbol'>:successful?</span><span class='comma'>,</span> <span class='symbol'>:success?</span>
936
- <span class='id identifier rubyid_alias_method'>alias_method</span> <span class='symbol'>:succeeded?</span><span class='comma'>,</span> <span class='symbol'>:success?</span>
937
-
938
- <span class='comment'># Returns whether the invocation failed or not.
939
- </span> <span class='comment'>#
940
- </span> <span class='comment'># @return [Boolean] `true` if the service invocation failed, `false` otherwise.
941
- </span> <span class='kw'>def</span> <span class='id identifier rubyid_fail?'>fail?</span>
942
- <span class='op'>!</span><span class='ivar'>@success</span>
943
- <span class='kw'>end</span>
944
- <span class='id identifier rubyid_alias_method'>alias_method</span> <span class='symbol'>:failed?</span><span class='comma'>,</span> <span class='symbol'>:fail?</span>
945
-
946
- <span class='comment'># Returns the first error returned by the operation.
947
- </span> <span class='comment'>#
948
- </span> <span class='comment'># @return [Object] The first error returned by the service.
949
- </span> <span class='kw'>def</span> <span class='id identifier rubyid_error'>error</span>
950
- <span class='ivar'>@errors</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span>
951
- <span class='kw'>end</span>
952
-
953
- <span class='comment'># Converts this response to a AJAX response.
954
- </span> <span class='comment'>#
955
- </span> <span class='comment'># @param transport [Object|NilClass] The transport to use for sending. Must respond to `render`, `params`, `request.format` and `performed?`.
956
- </span> <span class='comment'># @return [AjaxResponse] The AJAX response, which will include only the first error.
957
- </span> <span class='kw'>def</span> <span class='id identifier rubyid_as_ajax_response'>as_ajax_response</span><span class='lparen'>(</span><span class='id identifier rubyid_transport'>transport</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
958
- <span class='id identifier rubyid_status'>status</span><span class='comma'>,</span> <span class='id identifier rubyid_error_message'>error_message</span> <span class='op'>=</span>
959
- <span class='kw'>if</span> <span class='id identifier rubyid_successful?'>successful?</span>
960
- <span class='lbracket'>[</span><span class='symbol'>:ok</span><span class='comma'>,</span> <span class='kw'>nil</span><span class='rbracket'>]</span>
961
- <span class='kw'>elsif</span> <span class='id identifier rubyid_error'>error</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Hash</span><span class='rparen'>)</span>
962
- <span class='lbracket'>[</span><span class='id identifier rubyid_error'>error</span><span class='lbracket'>[</span><span class='symbol'>:status</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_error'>error</span><span class='lbracket'>[</span><span class='symbol'>:error</span><span class='rbracket'>]</span><span class='rbracket'>]</span>
963
- <span class='kw'>else</span>
964
- <span class='lbracket'>[</span><span class='symbol'>:unknown</span><span class='comma'>,</span> <span class='id identifier rubyid_error'>error</span><span class='rbracket'>]</span>
965
- <span class='kw'>end</span>
966
-
967
- <span class='const'>AjaxResponse</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='label'>status:</span> <span class='id identifier rubyid_status'>status</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='label'>error:</span> <span class='id identifier rubyid_error_message'>error_message</span><span class='comma'>,</span> <span class='label'>transport:</span> <span class='id identifier rubyid_transport'>transport</span><span class='rparen'>)</span>
968
- <span class='kw'>end</span>
969
- <span class='kw'>end</span></pre>
914
+ <span class='rubyid_class class kw'>class</span> <span class='rubyid_Response constant id'>Response</span>
915
+ <span class='rubyid_attr_reader identifier id'>attr_reader</span> <span class='symbol val'>:success</span><span class='comma token'>,</span> <span class='symbol val'>:data</span><span class='comma token'>,</span> <span class='symbol val'>:errors</span>
916
+
917
+ <span class='comment val'># Creates a new service response.</span>
918
+ <span class='comment val'>#</span>
919
+ <span class='comment val'># @param success [Boolean] Whether the invocation was successful or not.</span>
920
+ <span class='comment val'># @param data [Object|NilClass] The data returned by the operation.</span>
921
+ <span class='comment val'># @param errors [Array|NilClass] The errors returned by the operation.</span>
922
+ <span class='comment val'># @param error [Object|NilClass] Alias for errors. *Ignored if `errors` is present.*</span>
923
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='rubyid_success identifier id'>success</span> <span class='assign token'>=</span> <span class='rubyid_true true kw'>true</span><span class='comma token'>,</span> <span class='label val'>data:</span> <span class='rubyid_nil nil kw'>nil</span><span class='comma token'>,</span> <span class='label val'>errors:</span> <span class='rubyid_nil nil kw'>nil</span><span class='comma token'>,</span> <span class='label val'>error:</span> <span class='rubyid_nil nil kw'>nil</span><span class='rparen token'>)</span>
924
+ <span class='rubyid_errors identifier id'>errors</span> <span class='opasgn op'>||=</span> <span class='rubyid_error identifier id'>error</span><span class='dot token'>.</span><span class='rubyid_ensure_array identifier id'>ensure_array</span>
925
+
926
+ <span class='rubyid_@success ivar id'>@success</span> <span class='assign token'>=</span> <span class='rubyid_success identifier id'>success</span><span class='dot token'>.</span><span class='rubyid_to_boolean identifier id'>to_boolean</span>
927
+ <span class='rubyid_@data ivar id'>@data</span> <span class='assign token'>=</span> <span class='rubyid_data identifier id'>data</span>
928
+ <span class='rubyid_@errors ivar id'>@errors</span> <span class='assign token'>=</span> <span class='rubyid_errors identifier id'>errors</span><span class='dot token'>.</span><span class='rubyid_ensure_array identifier id'>ensure_array</span><span class='lparen token'>(</span><span class='label val'>no_duplicates:</span> <span class='rubyid_true true kw'>true</span><span class='comma token'>,</span> <span class='label val'>compact:</span> <span class='rubyid_true true kw'>true</span><span class='rparen token'>)</span>
929
+ <span class='rubyid_end end kw'>end</span>
930
+
931
+ <span class='comment val'># Returns whether the invocation was successful or not.</span>
932
+ <span class='comment val'>#</span>
933
+ <span class='comment val'># @return [Boolean] `true` if the service invocation was successful, `false` otherwise.</span>
934
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_success? fid id'>success?</span>
935
+ <span class='comment val'># TODO@PI: Ignore rubocop on this</span>
936
+ <span class='rubyid_@success ivar id'>@success</span>
937
+ <span class='rubyid_end end kw'>end</span>
938
+ <span class='rubyid_alias_method identifier id'>alias_method</span> <span class='symbol val'>:successful?</span><span class='comma token'>,</span> <span class='symbol val'>:success?</span>
939
+ <span class='rubyid_alias_method identifier id'>alias_method</span> <span class='symbol val'>:succeeded?</span><span class='comma token'>,</span> <span class='symbol val'>:success?</span>
940
+
941
+ <span class='comment val'># Returns whether the invocation failed or not.</span>
942
+ <span class='comment val'>#</span>
943
+ <span class='comment val'># @return [Boolean] `true` if the service invocation failed, `false` otherwise.</span>
944
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_fail? fid id'>fail?</span>
945
+ <span class='notop op'>!</span><span class='rubyid_@success ivar id'>@success</span>
946
+ <span class='rubyid_end end kw'>end</span>
947
+ <span class='rubyid_alias_method identifier id'>alias_method</span> <span class='symbol val'>:failed?</span><span class='comma token'>,</span> <span class='symbol val'>:fail?</span>
948
+
949
+ <span class='comment val'># Returns the first error returned by the operation.</span>
950
+ <span class='comment val'>#</span>
951
+ <span class='comment val'># @return [Object] The first error returned by the service.</span>
952
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_error identifier id'>error</span>
953
+ <span class='rubyid_@errors ivar id'>@errors</span><span class='dot token'>.</span><span class='rubyid_first identifier id'>first</span>
954
+ <span class='rubyid_end end kw'>end</span>
955
+
956
+ <span class='comment val'># Converts this response to a AJAX response.</span>
957
+ <span class='comment val'>#</span>
958
+ <span class='comment val'># @param transport [Object|NilClass] The transport to use for sending. Must respond to `render`, `params`, `request.format` and `performed?`.</span>
959
+ <span class='comment val'># @return [AjaxResponse] The AJAX response, which will include only the first error.</span>
960
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_as_ajax_response identifier id'>as_ajax_response</span><span class='lparen token'>(</span><span class='rubyid_transport identifier id'>transport</span> <span class='assign token'>=</span> <span class='rubyid_nil nil kw'>nil</span><span class='rparen token'>)</span>
961
+ <span class='rubyid_status identifier id'>status</span><span class='comma token'>,</span> <span class='rubyid_error_message identifier id'>error_message</span> <span class='assign token'>=</span>
962
+ <span class='rubyid_if if kw'>if</span> <span class='rubyid_successful? fid id'>successful?</span>
963
+ <span class='lbrack token'>[</span><span class='symbol val'>:ok</span><span class='comma token'>,</span> <span class='rubyid_nil nil kw'>nil</span><span class='rbrack token'>]</span>
964
+ <span class='rubyid_elsif elsif kw'>elsif</span> <span class='rubyid_error identifier id'>error</span><span class='dot token'>.</span><span class='rubyid_is_a? fid id'>is_a?</span><span class='lparen token'>(</span><span class='rubyid_Hash constant id'>Hash</span><span class='rparen token'>)</span>
965
+ <span class='lbrack token'>[</span><span class='rubyid_error identifier id'>error</span><span class='lbrack token'>[</span><span class='symbol val'>:status</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='rubyid_error identifier id'>error</span><span class='lbrack token'>[</span><span class='symbol val'>:error</span><span class='rbrack token'>]</span><span class='rbrack token'>]</span>
966
+ <span class='rubyid_else else kw'>else</span>
967
+ <span class='lbrack token'>[</span><span class='symbol val'>:unknown</span><span class='comma token'>,</span> <span class='rubyid_error identifier id'>error</span><span class='rbrack token'>]</span>
968
+ <span class='rubyid_end end kw'>end</span>
969
+
970
+ <span class='rubyid_AjaxResponse constant id'>AjaxResponse</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='label val'>status:</span> <span class='rubyid_status identifier id'>status</span><span class='comma token'>,</span> <span class='label val'>data:</span> <span class='rubyid_data identifier id'>data</span><span class='comma token'>,</span> <span class='label val'>error:</span> <span class='rubyid_error_message identifier id'>error_message</span><span class='comma token'>,</span> <span class='label val'>transport:</span> <span class='rubyid_transport identifier id'>transport</span><span class='rparen token'>)</span>
971
+ <span class='rubyid_end end kw'>end</span>
972
+ <span class='rubyid_end end kw'>end</span>
973
+ </pre>
970
974
  </td>
971
975
  </tr>
972
976
  </table>
@@ -1058,18 +1062,19 @@
1058
1062
  <td>
1059
1063
  <pre class="code"><span class="info file"># File 'lib/ballast/service.rb', line 66</span>
1060
1064
 
1061
- <span class='kw'>def</span> <span class='id identifier rubyid_as_ajax_response'>as_ajax_response</span><span class='lparen'>(</span><span class='id identifier rubyid_transport'>transport</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
1062
- <span class='id identifier rubyid_status'>status</span><span class='comma'>,</span> <span class='id identifier rubyid_error_message'>error_message</span> <span class='op'>=</span>
1063
- <span class='kw'>if</span> <span class='id identifier rubyid_successful?'>successful?</span>
1064
- <span class='lbracket'>[</span><span class='symbol'>:ok</span><span class='comma'>,</span> <span class='kw'>nil</span><span class='rbracket'>]</span>
1065
- <span class='kw'>elsif</span> <span class='id identifier rubyid_error'>error</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Hash</span><span class='rparen'>)</span>
1066
- <span class='lbracket'>[</span><span class='id identifier rubyid_error'>error</span><span class='lbracket'>[</span><span class='symbol'>:status</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_error'>error</span><span class='lbracket'>[</span><span class='symbol'>:error</span><span class='rbracket'>]</span><span class='rbracket'>]</span>
1067
- <span class='kw'>else</span>
1068
- <span class='lbracket'>[</span><span class='symbol'>:unknown</span><span class='comma'>,</span> <span class='id identifier rubyid_error'>error</span><span class='rbracket'>]</span>
1069
- <span class='kw'>end</span>
1070
-
1071
- <span class='const'>AjaxResponse</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='label'>status:</span> <span class='id identifier rubyid_status'>status</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='label'>error:</span> <span class='id identifier rubyid_error_message'>error_message</span><span class='comma'>,</span> <span class='label'>transport:</span> <span class='id identifier rubyid_transport'>transport</span><span class='rparen'>)</span>
1072
- <span class='kw'>end</span></pre>
1065
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_as_ajax_response identifier id'>as_ajax_response</span><span class='lparen token'>(</span><span class='rubyid_transport identifier id'>transport</span> <span class='assign token'>=</span> <span class='rubyid_nil nil kw'>nil</span><span class='rparen token'>)</span>
1066
+ <span class='rubyid_status identifier id'>status</span><span class='comma token'>,</span> <span class='rubyid_error_message identifier id'>error_message</span> <span class='assign token'>=</span>
1067
+ <span class='rubyid_if if kw'>if</span> <span class='rubyid_successful? fid id'>successful?</span>
1068
+ <span class='lbrack token'>[</span><span class='symbol val'>:ok</span><span class='comma token'>,</span> <span class='rubyid_nil nil kw'>nil</span><span class='rbrack token'>]</span>
1069
+ <span class='rubyid_elsif elsif kw'>elsif</span> <span class='rubyid_error identifier id'>error</span><span class='dot token'>.</span><span class='rubyid_is_a? fid id'>is_a?</span><span class='lparen token'>(</span><span class='rubyid_Hash constant id'>Hash</span><span class='rparen token'>)</span>
1070
+ <span class='lbrack token'>[</span><span class='rubyid_error identifier id'>error</span><span class='lbrack token'>[</span><span class='symbol val'>:status</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='rubyid_error identifier id'>error</span><span class='lbrack token'>[</span><span class='symbol val'>:error</span><span class='rbrack token'>]</span><span class='rbrack token'>]</span>
1071
+ <span class='rubyid_else else kw'>else</span>
1072
+ <span class='lbrack token'>[</span><span class='symbol val'>:unknown</span><span class='comma token'>,</span> <span class='rubyid_error identifier id'>error</span><span class='rbrack token'>]</span>
1073
+ <span class='rubyid_end end kw'>end</span>
1074
+
1075
+ <span class='rubyid_AjaxResponse constant id'>AjaxResponse</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='label val'>status:</span> <span class='rubyid_status identifier id'>status</span><span class='comma token'>,</span> <span class='label val'>data:</span> <span class='rubyid_data identifier id'>data</span><span class='comma token'>,</span> <span class='label val'>error:</span> <span class='rubyid_error_message identifier id'>error_message</span><span class='comma token'>,</span> <span class='label val'>transport:</span> <span class='rubyid_transport identifier id'>transport</span><span class='rparen token'>)</span>
1076
+ <span class='rubyid_end end kw'>end</span>
1077
+ </pre>
1073
1078
  </td>
1074
1079
  </tr>
1075
1080
  </table>
@@ -1124,9 +1129,10 @@
1124
1129
  <td>
1125
1130
  <pre class="code"><span class="info file"># File 'lib/ballast/service.rb', line 58</span>
1126
1131
 
1127
- <span class='kw'>def</span> <span class='id identifier rubyid_error'>error</span>
1128
- <span class='ivar'>@errors</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span>
1129
- <span class='kw'>end</span></pre>
1132
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_error identifier id'>error</span>
1133
+ <span class='rubyid_@errors ivar id'>@errors</span><span class='dot token'>.</span><span class='rubyid_first identifier id'>first</span>
1134
+ <span class='rubyid_end end kw'>end</span>
1135
+ </pre>
1130
1136
  </td>
1131
1137
  </tr>
1132
1138
  </table>
@@ -1185,9 +1191,10 @@
1185
1191
  <td>
1186
1192
  <pre class="code"><span class="info file"># File 'lib/ballast/service.rb', line 50</span>
1187
1193
 
1188
- <span class='kw'>def</span> <span class='id identifier rubyid_fail?'>fail?</span>
1189
- <span class='op'>!</span><span class='ivar'>@success</span>
1190
- <span class='kw'>end</span></pre>
1194
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_fail? fid id'>fail?</span>
1195
+ <span class='notop op'>!</span><span class='rubyid_@success ivar id'>@success</span>
1196
+ <span class='rubyid_end end kw'>end</span>
1197
+ </pre>
1191
1198
  </td>
1192
1199
  </tr>
1193
1200
  </table>
@@ -1247,10 +1254,11 @@
1247
1254
  <td>
1248
1255
  <pre class="code"><span class="info file"># File 'lib/ballast/service.rb', line 40</span>
1249
1256
 
1250
- <span class='kw'>def</span> <span class='id identifier rubyid_success?'>success?</span>
1251
- <span class='comment'># TODO@PI: Ignore rubocop on this
1252
- </span> <span class='ivar'>@success</span>
1253
- <span class='kw'>end</span></pre>
1257
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_success? fid id'>success?</span>
1258
+ <span class='comment val'># TODO@PI: Ignore rubocop on this</span>
1259
+ <span class='rubyid_@success ivar id'>@success</span>
1260
+ <span class='rubyid_end end kw'>end</span>
1261
+ </pre>
1254
1262
  </td>
1255
1263
  </tr>
1256
1264
  </table>
@@ -1261,9 +1269,9 @@
1261
1269
  </div>
1262
1270
 
1263
1271
  <div id="footer">
1264
- Generated on Fri Dec 26 11:54:47 2014 by
1272
+ Generated on Sun Jan 18 13:27:09 2015 by
1265
1273
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1266
- 0.8.7.6 (ruby-2.1.3).
1274
+ 0.8.7.6 (ruby-2.2.0).
1267
1275
  </div>
1268
1276
 
1269
1277
  </body>