18 Finding Your Way Around 16 Deployment
edit doc/README_FOR_APP
= The Depot Online Store
This application implements an online store, with a catalog, cart, and orders.
It is divided into two main sections:
* The buyer's side of the application manages the catalog, cart,
and checkout. It is implementation spans in four models and associated
controllers and views: Cart, LineItem, Order, and Product. Additionally,
there is a StoreController for the store front itself, and a
SessionsController to manage sessions.
* Only administrators can access stuff in the seller's side
(product maintenance and order fulfillment). This is implemented by the
LoginController, is enforced by the ApplicationController#authorize
method, and assisted by the Users and Carts resources.
This code was produced as an example for the book {Agile Web Development with
Rails}[http://www.pragprog.com/titles/rails4/agile-web-development-with-rails-4th-edition]. It should not be
run as a real online store.
=== Authors
* Sam Ruby, IBM
* Dave Thomas, The Pragmatic Programmers, LLC
* David Heinemeier Hansson, 37signals
=== Warranty
This code is provided for educational purposes only, and comes with
absolutely no warranty. It should not be used in live applications.
== Copyright
This code is Copyright (c) 2010 The Pragmatic Programmers, LLC.
It is released under the same license as Ruby.
rake doc:app
rm -r doc/app
option --inline-source is deprecated: source code is now always inlined
Generating Darkfish format into /home/rubys/git/awdwr/edition4/work-30/depot/doc/app...
Files: 25
Classes: 15 ( 6 undocumented)
Modules: 9 ( 9 undocumented)
Constants: 1 ( 0 undocumented)
Attributes: 2 ( 2 undocumented)
Methods: 55 ( 3 undocumented)
Total: 82 (20 undocumented)
75.61% documented
Elapsed: 1.7s
rake stats
+----------------------+-------+-------+---------+---------+-----+-------+
| Name | Lines | LOC | Classes | Methods | M/C | LOC/M |
+----------------------+-------+-------+---------+---------+-----+-------+
| Controllers | 646 | 417 | 9 | 45 | 5 | 7 |
| Helpers | 26 | 24 | 0 | 1 | 0 | 22 |
| Models | 165 | 100 | 5 | 10 | 2 | 8 |
| Libraries | 0 | 0 | 0 | 0 | 0 | 0 |
| Integration tests | 201 | 138 | 2 | 9 | 4 | 13 |
| Functional tests | 426 | 300 | 9 | 0 | 0 | 0 |
| Unit tests | 163 | 123 | 13 | 2 | 0 | 59 |
+----------------------+-------+-------+---------+---------+-----+-------+
| Total | 1627 | 1102 | 38 | 67 | 1 | 14 |
+----------------------+-------+-------+---------+---------+-----+-------+
Code LOC: 541 Test LOC: 561 Code to Test Ratio: 1:1.0