Skip to content

Commit

Permalink
doc updates
Browse files Browse the repository at this point in the history
  • Loading branch information
Michael Bulat committed Nov 18, 2010
1 parent 9caca7b commit 65a7fd2
Showing 18 changed files with 98 additions and 75 deletions.
4 changes: 4 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -10,6 +10,10 @@ furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

Except as contained in this notice, the name(s) of the above copyright holders
shall not be used in advertising or otherwise to promote the sale, use or
other dealings in this Software without prior written authorization.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17 changes: 11 additions & 6 deletions README.markdown
Original file line number Diff line number Diff line change
@@ -6,7 +6,7 @@ This plutus plugin is a Ruby on Rails Engine which provides a double entry accou
Installation
============

- install plugin `./script/plugin install plutus`
- install plugin `./script/plugin install git://github.com/mbulat/plutus.git`

- generate migration files `./script/generate plutus plutus`

@@ -72,17 +72,22 @@ Calculating the Trial Balance
Access & Security
=================

The Engine provides controllers and views for accessing Accounts and Transactions via the {AccountsController} and {TransactionsController} classes. The controllers will render HTML, XML and JSON, and are compatible with [ActiveResource](http://api.rubyonrails.org/classes/ActiveResource/Base.html)
The Engine provides controllers and views for viewing Accounts and Transactions via the {AccountsController} and {TransactionsController} classes. The controllers will render HTML, XML and JSON, and are compatible with [ActiveResource](http://api.rubyonrails.org/classes/ActiveResource/Base.html)

Routing is also supplied by the Engine.
Routing is NOT supplied by the engine. You can add routes to your application in your config/routes.rb with something
like the following

Only GET requests are supported. You should ensure that your application controller enforces its own authentication and authorization, which this controller will inherit.
map.resources :transactions, :only => [:index, :show], :conditions => { :method => :get }
map.resources :accounts, :only => [:index, :show], :conditions => { :method => :get }

*NOTE: If you enable routing, you should ensure that your ApplicationController enforces its own authentication and authorization, which this controller will inherit.*

Testing
=======

[Rspec](http://rspec.info/) tests are provided. Install both the rpsec and rspec-rails gems to run the tests.
[Rspec](http://rspec.info/) tests are provided. Install both the rpsec and rspec-rails gems, and install this plugin
into a working rails application to run the tests.

* * *

Copyright (c) 2009 The Tidewinds Group Inc. All Rights Reserved.
Copyright (c) 2010 Michael Bulat
3 changes: 2 additions & 1 deletion Rakefile
Original file line number Diff line number Diff line change
@@ -6,8 +6,9 @@ begin
Jeweler::Tasks.new do |gem|
gem.name = "plutus"
gem.summary = "A Plugin providing a Double Entry Accounting Engine for Rails"
gem.description = "The plutus plugin provides a complete double entry accounting system for use in any Ruby on Rails application. The plugin follows general Double Entry Bookkeeping practices. All calculations are done using BigDecimal in order to prevent floating point rounding errors. The plugin requires a decimal type on your database as well."
gem.email = "[email protected]"
gem.homepage = ""
gem.homepage = "http://github.com/mbulat/Plutus"
gem.authors = ["Michael Bulat"]
# gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
end
2 changes: 1 addition & 1 deletion doc/Account.html
Original file line number Diff line number Diff line change
@@ -291,7 +291,7 @@ <h3>Returns:</h3>
</div>

<div id="footer">
Generated on Thu Nov 18 08:50:45 2010 by
Generated on Thu Nov 18 09:40:09 2010 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.6.2 (ruby-1.8.7).
</div>
2 changes: 1 addition & 1 deletion doc/AccountsController.html
Original file line number Diff line number Diff line change
@@ -308,7 +308,7 @@ <h4><div class='inline'></div></h4>
</div>

<div id="footer">
Generated on Thu Nov 18 08:50:46 2010 by
Generated on Thu Nov 18 09:40:09 2010 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.6.2 (ruby-1.8.7).
</div>
2 changes: 1 addition & 1 deletion doc/Asset.html
Original file line number Diff line number Diff line change
@@ -601,7 +601,7 @@ <h3>Returns:</h3>
</div>

<div id="footer">
Generated on Thu Nov 18 08:50:45 2010 by
Generated on Thu Nov 18 09:40:10 2010 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.6.2 (ruby-1.8.7).
</div>
2 changes: 1 addition & 1 deletion doc/Equity.html
Original file line number Diff line number Diff line change
@@ -601,7 +601,7 @@ <h3>Returns:</h3>
</div>

<div id="footer">
Generated on Thu Nov 18 08:50:45 2010 by
Generated on Thu Nov 18 09:40:09 2010 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.6.2 (ruby-1.8.7).
</div>
2 changes: 1 addition & 1 deletion doc/Expense.html
Original file line number Diff line number Diff line change
@@ -601,7 +601,7 @@ <h3>Returns:</h3>
</div>

<div id="footer">
Generated on Thu Nov 18 08:50:46 2010 by
Generated on Thu Nov 18 09:40:10 2010 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.6.2 (ruby-1.8.7).
</div>
2 changes: 1 addition & 1 deletion doc/Liability.html
Original file line number Diff line number Diff line change
@@ -579,7 +579,7 @@ <h3>Returns:</h3>
</div>

<div id="footer">
Generated on Thu Nov 18 08:50:46 2010 by
Generated on Thu Nov 18 09:40:09 2010 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.6.2 (ruby-1.8.7).
</div>
2 changes: 1 addition & 1 deletion doc/Revenue.html
Original file line number Diff line number Diff line change
@@ -601,7 +601,7 @@ <h3>Returns:</h3>
</div>

<div id="footer">
Generated on Thu Nov 18 08:50:46 2010 by
Generated on Thu Nov 18 09:40:10 2010 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.6.2 (ruby-1.8.7).
</div>
2 changes: 1 addition & 1 deletion doc/Transaction.html
Original file line number Diff line number Diff line change
@@ -147,7 +147,7 @@ <h3>Author:</h3>
</div>

<div id="footer">
Generated on Thu Nov 18 08:50:45 2010 by
Generated on Thu Nov 18 09:40:09 2010 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.6.2 (ruby-1.8.7).
</div>
2 changes: 1 addition & 1 deletion doc/TransactionsController.html
Original file line number Diff line number Diff line change
@@ -308,7 +308,7 @@ <h4><div class='inline'></div></h4>
</div>

<div id="footer">
Generated on Thu Nov 18 08:50:45 2010 by
Generated on Thu Nov 18 09:40:09 2010 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.6.2 (ruby-1.8.7).
</div>
2 changes: 1 addition & 1 deletion doc/_index.html
Original file line number Diff line number Diff line change
@@ -157,7 +157,7 @@ <h2>Namespace Listing A-Z</h2>
</div></div>

<div id="footer">
Generated on Thu Nov 18 08:50:44 2010 by
Generated on Thu Nov 18 09:40:08 2010 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.6.2 (ruby-1.8.7).
</div>
20 changes: 13 additions & 7 deletions doc/file.README.html
Original file line number Diff line number Diff line change
@@ -48,7 +48,7 @@
<h1>Installation</h1>

<ul>
<li><p>install plugin <code>./script/plugin install plutus</code></p></li>
<li><p>install plugin <code>./script/plugin install git://github.com/mbulat/plutus.git</code></p></li>
<li><p>generate migration files <code>./script/generate plutus plutus</code></p></li>
<li><p>run migrations <code>rake db:migrate</code></p></li>
</ul>
@@ -109,22 +109,28 @@ <h2>Calculating the Trial Balance</h2>

<h1>Access &amp; Security</h1>

<p>The Engine provides controllers and views for accessing Accounts and Transactions via the <span class='object_link'><a href="AccountsController.html" title="AccountsController (class)">AccountsController</a></span> and <span class='object_link'><a href="TransactionsController.html" title="TransactionsController (class)">TransactionsController</a></span> classes. The controllers will render HTML, XML and JSON, and are compatible with <a href="http://api.rubyonrails.org/classes/ActiveResource/Base.html">ActiveResource</a></p>
<p>The Engine provides controllers and views for viewing Accounts and Transactions via the <span class='object_link'><a href="AccountsController.html" title="AccountsController (class)">AccountsController</a></span> and <span class='object_link'><a href="TransactionsController.html" title="TransactionsController (class)">TransactionsController</a></span> classes. The controllers will render HTML, XML and JSON, and are compatible with <a href="http://api.rubyonrails.org/classes/ActiveResource/Base.html">ActiveResource</a></p>

<p>Routing is also supplied by the Engine.</p>
<p>Routing is NOT supplied by the engine. You can add routes to your application in your config/routes.rb with something
like the following</p>

<p>Only GET requests are supported. You should ensure that your application controller enforces its own authentication and authorization, which this controller will inherit.</p>
<pre class="code"> <span class='map identifier id'>map</span><span class='dot token'>.</span><span class='resources identifier id'>resources</span> <span class='symbol val'>:transactions</span><span class='comma token'>,</span> <span class='symbol val'>:only</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='lbrack token'>[</span><span class='symbol val'>:index</span><span class='comma token'>,</span> <span class='symbol val'>:show</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:conditions</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='lbrace token'>{</span> <span class='symbol val'>:method</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='symbol val'>:get</span> <span class='rbrace token'>}</span>
<span class='map identifier id'>map</span><span class='dot token'>.</span><span class='resources identifier id'>resources</span> <span class='symbol val'>:accounts</span><span class='comma token'>,</span> <span class='symbol val'>:only</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='lbrack token'>[</span><span class='symbol val'>:index</span><span class='comma token'>,</span> <span class='symbol val'>:show</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:conditions</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='lbrace token'>{</span> <span class='symbol val'>:method</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='symbol val'>:get</span> <span class='rbrace token'>}</span>
</pre>

<p><em>NOTE: If you enable routing, you should ensure that your ApplicationController enforces its own authentication and authorization, which this controller will inherit.</em></p>

<h1>Testing</h1>

<p><a href="http://rspec.info/">Rspec</a> tests are provided. Install both the rpsec and rspec-rails gems to run the tests.</p>
<p><a href="http://rspec.info/">Rspec</a> tests are provided. Install both the rpsec and rspec-rails gems, and install this plugin
into a working rails application to run the tests.</p>

<hr />

<p>Copyright (c) 2009 The Tidewinds Group Inc. All Rights Reserved.</p></div></div>
<p>Copyright (c) 2010 Michael Bulat</p></div></div>

<div id="footer">
Generated on Thu Nov 18 08:50:44 2010 by
Generated on Thu Nov 18 09:40:08 2010 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.6.2 (ruby-1.8.7).
</div>
20 changes: 13 additions & 7 deletions doc/index.html
Original file line number Diff line number Diff line change
@@ -48,7 +48,7 @@
<h1>Installation</h1>

<ul>
<li><p>install plugin <code>./script/plugin install plutus</code></p></li>
<li><p>install plugin <code>./script/plugin install git://github.com/mbulat/plutus.git</code></p></li>
<li><p>generate migration files <code>./script/generate plutus plutus</code></p></li>
<li><p>run migrations <code>rake db:migrate</code></p></li>
</ul>
@@ -109,22 +109,28 @@ <h2>Calculating the Trial Balance</h2>

<h1>Access &amp; Security</h1>

<p>The Engine provides controllers and views for accessing Accounts and Transactions via the <span class='object_link'><a href="AccountsController.html" title="AccountsController (class)">AccountsController</a></span> and <span class='object_link'><a href="TransactionsController.html" title="TransactionsController (class)">TransactionsController</a></span> classes. The controllers will render HTML, XML and JSON, and are compatible with <a href="http://api.rubyonrails.org/classes/ActiveResource/Base.html">ActiveResource</a></p>
<p>The Engine provides controllers and views for viewing Accounts and Transactions via the <span class='object_link'><a href="AccountsController.html" title="AccountsController (class)">AccountsController</a></span> and <span class='object_link'><a href="TransactionsController.html" title="TransactionsController (class)">TransactionsController</a></span> classes. The controllers will render HTML, XML and JSON, and are compatible with <a href="http://api.rubyonrails.org/classes/ActiveResource/Base.html">ActiveResource</a></p>

<p>Routing is also supplied by the Engine.</p>
<p>Routing is NOT supplied by the engine. You can add routes to your application in your config/routes.rb with something
like the following</p>

<p>Only GET requests are supported. You should ensure that your application controller enforces its own authentication and authorization, which this controller will inherit.</p>
<pre class="code"> <span class='map identifier id'>map</span><span class='dot token'>.</span><span class='resources identifier id'>resources</span> <span class='symbol val'>:transactions</span><span class='comma token'>,</span> <span class='symbol val'>:only</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='lbrack token'>[</span><span class='symbol val'>:index</span><span class='comma token'>,</span> <span class='symbol val'>:show</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:conditions</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='lbrace token'>{</span> <span class='symbol val'>:method</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='symbol val'>:get</span> <span class='rbrace token'>}</span>
<span class='map identifier id'>map</span><span class='dot token'>.</span><span class='resources identifier id'>resources</span> <span class='symbol val'>:accounts</span><span class='comma token'>,</span> <span class='symbol val'>:only</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='lbrack token'>[</span><span class='symbol val'>:index</span><span class='comma token'>,</span> <span class='symbol val'>:show</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:conditions</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='lbrace token'>{</span> <span class='symbol val'>:method</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='symbol val'>:get</span> <span class='rbrace token'>}</span>
</pre>

<p><em>NOTE: If you enable routing, you should ensure that your ApplicationController enforces its own authentication and authorization, which this controller will inherit.</em></p>

<h1>Testing</h1>

<p><a href="http://rspec.info/">Rspec</a> tests are provided. Install both the rpsec and rspec-rails gems to run the tests.</p>
<p><a href="http://rspec.info/">Rspec</a> tests are provided. Install both the rpsec and rspec-rails gems, and install this plugin
into a working rails application to run the tests.</p>

<hr />

<p>Copyright (c) 2009 The Tidewinds Group Inc. All Rights Reserved.</p></div></div>
<p>Copyright (c) 2010 Michael Bulat</p></div></div>

<div id="footer">
Generated on Thu Nov 18 08:50:44 2010 by
Generated on Thu Nov 18 09:40:08 2010 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.6.2 (ruby-1.8.7).
</div>
Loading

0 comments on commit 65a7fd2

Please sign in to comment.