Skip to content
This repository has been archived by the owner on Sep 30, 2020. It is now read-only.

Commit

Permalink
Updated docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
Shogun committed Aug 18, 2016
1 parent 28b7d49 commit 623cbff
Show file tree
Hide file tree
Showing 37 changed files with 3,087 additions and 82 deletions.
3 changes: 0 additions & 3 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,3 @@ script: bundle exec rake spec:ci
gemfile: .travis-gemfile
notifications:
email: false
addons:
code_climate:
repo_token: f1f849a73d0b5cee836daa54676bd10662e87e8e726b396f212a99a77797ab4c
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,11 @@
[![Dependency Status](https://gemnasium.com/ShogunPanda/ballast.png?travis)](https://gemnasium.com/ShogunPanda/ballast)
[![Build Status](https://secure.travis-ci.org/ShogunPanda/ballast.png?branch=master)](https://travis-ci.org/ShogunPanda/ballast)
[![Code Climate](https://codeclimate.com/github/ShogunPanda/ballast.png)](https://codeclimate.com/github/ShogunPanda/ballast)
[![Coverage Status](https://coveralls.io/repos/ShogunPanda/ballast/badge.png)](https://coveralls.io/r/ShogunPanda/ballast)
[![Coverage Status](https://coveralls.io/repos/github/ShogunPanda/ballast/badge.svg?branch=master)](https://coveralls.io/github/ShogunPanda/ballast?branch=master)

A collection of base utilities for web frameworks.

http://sw.cowtech.it/ballast

http://rdoc.info/gems/ballast
https://sw.cowtech.it/ballast

# Description

Expand All @@ -22,8 +20,12 @@ The second issue is handling AJAX actions in a short way. To solve this, ballast

Finally, minor concerns are provided to scope CSS and handling errors.

## API Documentation

The API documentation can be found [here](https://sw.cowtech.it/ballast/docs).

## Contributing to ballast

* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
* Fork the project.
Expand Down
4 changes: 2 additions & 2 deletions doc/Ballast.html
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@

<dt class="r1 last">Defined in:</dt>
<dd class="r1 last">lib/ballast.rb<span class="defines">,<br />
lib/ballast/emoji.rb,<br /> lib/ballast/errors.rb,<br /> lib/ballast/service.rb,<br /> lib/ballast/version.rb,<br /> lib/ballast/concerns/view.rb,<br /> lib/ballast/configuration.rb,<br /> lib/ballast/ajax_response.rb,<br /> lib/ballast/concerns/common.rb,<br /> lib/ballast/request_domain_matcher.rb,<br /> lib/ballast/concerns/ajax_handling.rb,<br /> lib/ballast/middlewares/default_host.rb,<br /> lib/ballast/concerns/errors_handling.rb</span>
lib/ballast/emoji.rb,<br /> lib/ballast/errors.rb,<br /> lib/ballast/version.rb,<br /> lib/ballast/service.rb,<br /> lib/ballast/configuration.rb,<br /> lib/ballast/concerns/view.rb,<br /> lib/ballast/ajax_response.rb,<br /> lib/ballast/concerns/common.rb,<br /> lib/ballast/request_domain_matcher.rb,<br /> lib/ballast/concerns/ajax_handling.rb,<br /> lib/ballast/middlewares/default_host.rb,<br /> lib/ballast/concerns/errors_handling.rb,<br /> lib/ballast/concerns/json_api/request_handling.rb,<br /> lib/ballast/concerns/json_api/response_handling.rb,<br /> lib/ballast/concerns/json_api/pagination_handling.rb</span>
</dd>

</dl>
Expand Down Expand Up @@ -324,7 +324,7 @@ <h3 class="signature " id="run_in_thread-class_method">
</div>

<div id="footer">
Generated on Tue Mar 29 10:52:51 2016 by
Generated on Thu Aug 18 15:35:09 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.3.0).
</div>
Expand Down
2 changes: 1 addition & 1 deletion doc/Ballast/AjaxResponse.html
Original file line number Diff line number Diff line change
Expand Up @@ -1469,7 +1469,7 @@ <h3 class="signature " id="reply-instance_method">
</div>

<div id="footer">
Generated on Tue Mar 29 10:52:51 2016 by
Generated on Thu Aug 18 15:35:09 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.3.0).
</div>
Expand Down
6 changes: 3 additions & 3 deletions doc/Ballast/Concerns.html
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@

<dt class="r1 last">Defined in:</dt>
<dd class="r1 last">lib/ballast/concerns/ajax_handling.rb<span class="defines">,<br />
lib/ballast/concerns/view.rb,<br /> lib/ballast/concerns/common.rb,<br /> lib/ballast/concerns/errors_handling.rb</span>
lib/ballast/concerns/view.rb,<br /> lib/ballast/concerns/common.rb,<br /> lib/ballast/concerns/errors_handling.rb,<br /> lib/ballast/concerns/json_api/request_handling.rb,<br /> lib/ballast/concerns/json_api/response_handling.rb,<br /> lib/ballast/concerns/json_api/pagination_handling.rb</span>
</dd>

</dl>
Expand All @@ -100,7 +100,7 @@ <h2>Overview</h2><div class="docstring">
<p class="children">


<strong class="modules">Modules:</strong> <span class='object_link'><a href="Concerns/AjaxHandling.html" title="Ballast::Concerns::AjaxHandling (module)">AjaxHandling</a></span>, <span class='object_link'><a href="Concerns/Common.html" title="Ballast::Concerns::Common (module)">Common</a></span>, <span class='object_link'><a href="Concerns/ErrorsHandling.html" title="Ballast::Concerns::ErrorsHandling (module)">ErrorsHandling</a></span>, <span class='object_link'><a href="Concerns/View.html" title="Ballast::Concerns::View (module)">View</a></span>
<strong class="modules">Modules:</strong> <span class='object_link'><a href="Concerns/AjaxHandling.html" title="Ballast::Concerns::AjaxHandling (module)">AjaxHandling</a></span>, <span class='object_link'><a href="Concerns/Common.html" title="Ballast::Concerns::Common (module)">Common</a></span>, <span class='object_link'><a href="Concerns/ErrorsHandling.html" title="Ballast::Concerns::ErrorsHandling (module)">ErrorsHandling</a></span>, <span class='object_link'><a href="Concerns/JSONApi.html" title="Ballast::Concerns::JSONApi (module)">JSONApi</a></span>, <span class='object_link'><a href="Concerns/View.html" title="Ballast::Concerns::View (module)">View</a></span>



Expand All @@ -118,7 +118,7 @@ <h2>Overview</h2><div class="docstring">
</div>

<div id="footer">
Generated on Tue Mar 29 10:52:51 2016 by
Generated on Thu Aug 18 15:35:09 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.3.0).
</div>
Expand Down
2 changes: 1 addition & 1 deletion doc/Ballast/Concerns/AjaxHandling.html
Original file line number Diff line number Diff line change
Expand Up @@ -658,7 +658,7 @@ <h3 class="signature " id="prevent_caching-instance_method">
</div>

<div id="footer">
Generated on Tue Mar 29 10:52:51 2016 by
Generated on Thu Aug 18 15:35:09 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.3.0).
</div>
Expand Down
2 changes: 1 addition & 1 deletion doc/Ballast/Concerns/Common.html
Original file line number Diff line number Diff line change
Expand Up @@ -956,7 +956,7 @@ <h3 class="signature " id="request_data?-instance_method">
</div>

<div id="footer">
Generated on Tue Mar 29 10:52:51 2016 by
Generated on Thu Aug 18 15:35:09 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.3.0).
</div>
Expand Down
2 changes: 1 addition & 1 deletion doc/Ballast/Concerns/ErrorsHandling.html
Original file line number Diff line number Diff line change
Expand Up @@ -274,7 +274,7 @@ <h3 class="signature first" id="handle_error-instance_method">
</div>

<div id="footer">
Generated on Tue Mar 29 10:52:51 2016 by
Generated on Thu Aug 18 15:35:09 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.3.0).
</div>
Expand Down
127 changes: 127 additions & 0 deletions doc/Ballast/Concerns/JSONApi.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,127 @@
<!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::JSONApi

&mdash; Documentation by YARD 0.8.7.6

</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#!Ballast/Concerns/JSONApi.html";
</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 (J)</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">JSONApi</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::JSONApi



</h1>

<dl class="box">








<dt class="r1 last">Defined in:</dt>
<dd class="r1 last">lib/ballast/concerns/json_api/request_handling.rb<span class="defines">,<br />
lib/ballast/concerns/json_api/response_handling.rb,<br /> lib/ballast/concerns/json_api/pagination_handling.rb</span>
</dd>

</dl>
<div class="clear"></div>

<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>A concern to handle JSON API backends.</p>


</div>
</div>
<div class="tags">


</div><h2>Defined Under Namespace</h2>
<p class="children">


<strong class="modules">Modules:</strong> <span class='object_link'><a href="JSONApi/PaginationHandling.html" title="Ballast::Concerns::JSONApi::PaginationHandling (module)">PaginationHandling</a></span>, <span class='object_link'><a href="JSONApi/RequestHandling.html" title="Ballast::Concerns::JSONApi::RequestHandling (module)">RequestHandling</a></span>, <span class='object_link'><a href="JSONApi/ResponseHandling.html" title="Ballast::Concerns::JSONApi::ResponseHandling (module)">ResponseHandling</a></span>




</p>









</div>

<div id="footer">
Generated on Thu Aug 18 15:35:09 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.3.0).
</div>

</body>
</html>
Loading

0 comments on commit 623cbff

Please sign in to comment.