18 Finding Your Way Around 16 Deployment
edit README.rdoc
= 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
SessionsController, 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) 2013 The Pragmatic Programmers, LLC.
It is released under the same license as Ruby.
rake doc:app
rm -r doc/app
Parsing sources...
3% [ 1/26] README.rdoc
7% [ 2/26] app/controllers/admin_controller.rb
11% [ 3/26] app/controllers/application_controller.rb
15% [ 4/26] app/controllers/carts_controller.rb
19% [ 5/26] app/controllers/concerns/current_cart.rb
23% [ 6/26] app/controllers/line_items_controller.rb
26% [ 7/26] app/controllers/orders_controller.rb
30% [ 8/26] app/controllers/products_controller.rb
34% [ 9/26] app/controllers/sessions_controller.rb
38% [10/26] app/controllers/store_controller.rb
42% [11/26] app/controllers/users_controller.rb
46% [12/26] app/helpers/admin_helper.rb
50% [13/26] app/helpers/application_helper.rb
53% [14/26] app/helpers/carts_helper.rb
57% [15/26] app/helpers/line_items_helper.rb
61% [16/26] app/helpers/orders_helper.rb
65% [17/26] app/helpers/products_helper.rb
69% [18/26] app/helpers/sessions_helper.rb
73% [19/26] app/helpers/store_helper.rb
76% [20/26] app/helpers/users_helper.rb
80% [21/26] app/mailers/order_notifier.rb
84% [22/26] app/models/cart.rb
88% [23/26] app/models/line_item.rb
92% [24/26] app/models/order.rb
96% [25/26] app/models/product.rb
100% [26/26] app/models/user.rb
Generating Darkfish format into /home/rubys/git/awdwr/edition4/work-215-41/depot/doc/app...
Files: 26
Classes: 15 ( 7 undocumented)
Modules: 11 (11 undocumented)
Constants: 1 ( 0 undocumented)
Attributes: 0 ( 0 undocumented)
Methods: 53 ( 5 undocumented)
Total: 80 (23 undocumented)
71.25% documented
Elapsed: 0.3s
rake stats
+----------------------+-------+-------+---------+---------+-----+-------+
| Name | Lines | LOC | Classes | Methods | M/C | LOC/M |
+----------------------+-------+-------+---------+---------+-----+-------+
| Controllers | 634 | 393 | 9 | 57 | 6 | 4 |
| Helpers | 26 | 24 | 0 | 1 | 0 | 22 |
| Models | 116 | 72 | 5 | 7 | 1 | 8 |
| Mailers | 29 | 11 | 1 | 2 | 2 | 3 |
| Javascripts | 51 | 3 | 0 | 2 | 0 | -1 |
| Libraries | 0 | 0 | 0 | 0 | 0 | 0 |
| Controller tests | 383 | 279 | 8 | 0 | 0 | 0 |
| Helper tests | 32 | 24 | 8 | 0 | 0 | 0 |
| Model tests | 130 | 90 | 5 | 2 | 0 | 43 |
| Mailer tests | 39 | 26 | 2 | 2 | 1 | 11 |
| Integration tests | 198 | 138 | 2 | 9 | 4 | 13 |
+----------------------+-------+-------+---------+---------+-----+-------+
| Total | 1638 | 1060 | 40 | 82 | 2 | 10 |
+----------------------+-------+-------+---------+---------+-----+-------+
Code LOC: 503 Test LOC: 557 Code to Test Ratio: 1:1.1