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
DEPRECATION WARNING: railtie_name is deprecated and has no effect. (called from <class:Railtie> at /home/rubys/.rvm/gems/ruby-1.9.3-r28190/gems/will_paginate-3.0.pre/lib/will_paginate/railtie.rb:6)
rm -r doc/app
invalid options: --line-numbers, --inline-source
(invalid options are ignored)
(in /home/rubys/svn/rails4/Book/util/work-193/depot)
Parsing sources...
4% [ 1/25] doc/README_FOR_APP
8% [ 2/25] app/helpers/application_helper.rb
12% [ 3/25] app/helpers/store_helper.rb
16% [ 4/25] app/helpers/admin_helper.rb
20% [ 5/25] app/helpers/line_items_helper.rb
24% [ 6/25] app/helpers/orders_helper.rb
28% [ 7/25] app/helpers/users_helper.rb
32% [ 8/25] app/helpers/products_helper.rb
36% [ 9/25] app/helpers/sessions_helper.rb
40% [10/25] app/helpers/carts_helper.rb
44% [11/25] app/controllers/users_controller.rb
48% [12/25] app/controllers/store_controller.rb
52% [13/25] app/controllers/line_items_controller.rb
56% [14/25] app/controllers/sessions_controller.rb
60% [15/25] app/controllers/application_controller.rb
64% [16/25] app/controllers/admin_controller.rb
68% [17/25] app/controllers/products_controller.rb
72% [18/25] app/controllers/carts_controller.rb
76% [19/25] app/controllers/orders_controller.rb
80% [20/25] app/mailers/notifier.rb
84% [21/25] app/models/cart.rb
88% [22/25] app/models/user.rb
92% [23/25] app/models/product.rb
96% [24/25] app/models/line_item.rb
100% [25/25] app/models/order.rb
Generating Darkfish...
Files: 25
Classes: 15 ( 6 undocumented)
Constants: 1 ( 0 undocumented)
Modules: 9 ( 9 undocumented)
Methods: 60 ( 7 undocumented)
74.12% documented
Elapsed: 1.0s
rake stats
DEPRECATION WARNING: railtie_name is deprecated and has no effect. (called from <class:Railtie> at /home/rubys/.rvm/gems/ruby-1.9.3-r28190/gems/will_paginate-3.0.pre/lib/will_paginate/railtie.rb:6)
(in /home/rubys/svn/rails4/Book/util/work-193/depot)
+----------------------+-------+-------+---------+---------+-----+-------+
| Name | Lines | LOC | Classes | Methods | M/C | LOC/M |
+----------------------+-------+-------+---------+---------+-----+-------+
| Controllers | 636 | 409 | 9 | 45 | 5 | 7 |
| Helpers | 24 | 24 | 0 | 1 | 0 | 22 |
| Models | 192 | 101 | 5 | 12 | 2 | 6 |
| Libraries | 0 | 0 | 0 | 0 | 0 | 0 |
| Integration tests | 201 | 138 | 2 | 9 | 4 | 13 |
| Functional tests | 424 | 285 | 9 | 0 | 0 | 0 |
| Unit tests | 163 | 123 | 13 | 2 | 0 | 59 |
+----------------------+-------+-------+---------+---------+-----+-------+
| Total | 1640 | 1080 | 38 | 69 | 1 | 13 |
+----------------------+-------+-------+---------+---------+-----+-------+
Code LOC: 534 Test LOC: 546 Code to Test Ratio: 1:1.0