Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Finishing YARD import, adding yardocs to address and application cont…

…roller, app readme is complete
  • Loading branch information...
commit 77c6df254b0e8deeac42e1d36c9ea4cb0635a065 1 parent 622f7ce
@airhorns authored
View
171 README
@@ -1,131 +1,33 @@
-== Welcome to Rails
+== Welcome to the ECSE 321 Project Management System
-Rails is a web-application framework that includes everything needed to create
-database-backed web applications according to the Model-View-Control pattern.
+The Project Management System (PMS) is a suite of tools created for the ECSE 321 - Intro to Software Engineering course at McGill University in the winter of 2010.
-This pattern splits the view (also called the presentation) into "dumb" templates
-that are primarily responsible for inserting pre-built data in between HTML tags.
-The model contains the "smart" domain objects (such as Account, Product, Person,
-Post) that holds all the business logic and knows how to persist themselves to
-a database. The controller handles the incoming requests (such as Save New Account,
-Update Product, Show Post) by manipulating the model and directing data to the view.
+The PMS is designed to help a business manage it's employees throughout the duration of a project, and to track the expenses employees incur. It is designed to supplement the vast majority of existing business practices instead of dramatically rewriting them and changing the fundamental operational techniques a business might employ.
-In Rails, the model is handled by what's called an object-relational mapping
-layer entitled Active Record. This layer allows you to present the data from
-database rows as objects and embellish these data objects with business logic
-methods. You can read more about Active Record in
-link:files/vendor/rails/activerecord/README.html.
+The PMS is written in Ruby on Rails. Rails is a web-application framework that includes everything needed to create database-backed web applications according to the Model-View-Control pattern.
-The controller and view are handled by the Action Pack, which handles both
-layers by its two parts: Action View and Action Controller. These two layers
-are bundled in a single package due to their heavy interdependence. This is
-unlike the relationship between the Active Record and Action Pack that is much
-more separate. Each of these packages can be used independently outside of
-Rails. You can read more about Action Pack in
-link:files/vendor/rails/actionpack/README.html.
+This pattern splits the view (also called the presentation) into "dumb" templates that are primarily responsible for inserting pre-built data in between HTML tags. The model contains the "smart" domain objects (such as Client, User, Project, HourReport) that holds all the business logic and knows how to persist themselves to a database. The controller handles the incoming requests (such as Save New Project, Update Client, Approve HourReport) by manipulating the model and directing data to the view.
+In Rails, the model is handled by what's called an object-relational mapping layer entitled Active Record. This layer allows you to present the data from database rows as objects and embellish these data objects with business logic methods. You can read more about Active Record in link:files/vendor/rails/activerecord/README.html.
-== Getting Started
-
-1. At the command prompt, start a new Rails application using the <tt>rails</tt> command
- and your application name. Ex: rails myapp
-2. Change directory into myapp and start the web server: <tt>script/server</tt> (run with --help for options)
-3. Go to http://localhost:3000/ and get "Welcome aboard: You're riding the Rails!"
-4. Follow the guidelines to start developing your application
-
-
-== Web Servers
-
-By default, Rails will try to use Mongrel if it's are installed when started with script/server, otherwise Rails will use WEBrick, the webserver that ships with Ruby. But you can also use Rails
-with a variety of other web servers.
-
-Mongrel is a Ruby-based webserver with a C component (which requires compilation) that is
-suitable for development and deployment of Rails applications. If you have Ruby Gems installed,
-getting up and running with mongrel is as easy as: <tt>gem install mongrel</tt>.
-More info at: http://mongrel.rubyforge.org
-
-Say other Ruby web servers like Thin and Ebb or regular web servers like Apache or LiteSpeed or
-Lighttpd or IIS. The Ruby web servers are run through Rack and the latter can either be setup to use
-FCGI or proxy to a pack of Mongrels/Thin/Ebb servers.
-
-== Apache .htaccess example for FCGI/CGI
-
-# General Apache options
-AddHandler fastcgi-script .fcgi
-AddHandler cgi-script .cgi
-Options +FollowSymLinks +ExecCGI
-
-# If you don't want Rails to look in certain directories,
-# use the following rewrite rules so that Apache won't rewrite certain requests
-#
-# Example:
-# RewriteCond %{REQUEST_URI} ^/notrails.*
-# RewriteRule .* - [L]
-
-# Redirect all requests not available on the filesystem to Rails
-# By default the cgi dispatcher is used which is very slow
-#
-# For better performance replace the dispatcher with the fastcgi one
-#
-# Example:
-# RewriteRule ^(.*)$ dispatch.fcgi [QSA,L]
-RewriteEngine On
-
-# If your Rails application is accessed via an Alias directive,
-# then you MUST also set the RewriteBase in this htaccess file.
-#
-# Example:
-# Alias /myrailsapp /path/to/myrailsapp/public
-# RewriteBase /myrailsapp
+The controller and view are handled by the Action Pack, which handles both layers by its two parts: Action View and Action Controller. These two layers are bundled in a single package due to their heavy interdependence. This is unlike the relationship between the Active Record and Action Pack that is much more separate. Each of these packages can be used independently outside of Rails. You can read more about Action Pack in link:files/vendor/rails/actionpack/README.html.
-RewriteRule ^$ index.html [QSA]
-RewriteRule ^([^.]+)$ $1.html [QSA]
-RewriteCond %{REQUEST_FILENAME} !-f
-RewriteRule ^(.*)$ dispatch.cgi [QSA,L]
-# In case Rails experiences terminal errors
-# Instead of displaying this message you can supply a file here which will be rendered instead
-#
-# Example:
-# ErrorDocument 500 /500.html
-
-ErrorDocument 500 "<h2>Application error</h2>Rails application failed to start properly"
-
-
-== Debugging Rails
-
-Sometimes your application goes wrong. Fortunately there are a lot of tools that
-will help you debug it and get it back on the rails.
-
-First area to check is the application log files. Have "tail -f" commands running
-on the server.log and development.log. Rails will automatically display debugging
-and runtime information to these files. Debugging info will also be shown in the
-browser on requests from 127.0.0.1.
-
-You can also log your own messages directly into the log file from your code using
-the Ruby logger class from inside your controllers. Example:
-
- class WeblogController < ActionController::Base
- def destroy
- @weblog = Weblog.find(params[:id])
- @weblog.destroy
- logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
- end
- end
+== Getting Started
-The result will be a message in your log file along the lines of:
+1. At the command prompt, change directory into the root project directory (ecse321 if you got it from git or a tarball), and start the web server: <tt>script/server</tt> (run with --help for options)
+2. Go to http://localhost:3000/ and see the system.
+3. Log in with the default user name a password, admin : apple123, to begin using the system. Be sure to change this
+password or delete this account to prevent unauthorized access.
- Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1
-More information on how to use the logger is at http://www.ruby-doc.org/core/
+== Web Servers
-Also, Ruby documentation can be found at http://www.ruby-lang.org/ including:
+By default, Rails will try to use Mongrel if it's are installed when started with script/server, otherwise Rails will use WEBrick, the webserver that ships with Ruby. But you can also use Rails with a variety of other web servers.
-* The Learning Ruby (Pickaxe) Book: http://www.ruby-doc.org/docs/ProgrammingRuby/
-* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+Mongrel is a Ruby-based webserver with a C component (which requires compilation) that is suitable for development and deployment of Rails applications. If you have Ruby Gems installed, getting up and running with mongrel is as easy as: <tt>gem install mongrel</tt>. More info at: http://mongrel.rubyforge.org
-These two online (and free) books will bring you up to speed on the Ruby language
-and also on programming in general.
+The PMS was designed with the intention of deployment to Heroku (http://heroku.com), a rock-solid Ruby and Rails platform hosted in the cloud. This gives the PMS supreme reliability, speed, and easy deployment. See a production version of the application at http://ecse321.heroku.com filled with demo data.
== Debugger
@@ -186,58 +88,41 @@ app
Holds all the code that's specific to this particular application.
app/controllers
- Holds controllers that should be named like weblogs_controller.rb for
- automated URL mapping. All controllers should descend from ApplicationController
- which itself descends from ActionController::Base.
+ Holds controllers, all named like projects_controller.rb for automated URL mapping. All controllers extend from ApplicationController which itself descends from ActionController::Base.
app/models
- Holds models that should be named like post.rb.
- Most models will descend from ActiveRecord::Base.
+ Holds models that should be named like project.rb. All models will extend ActiveRecord::Base.
app/views
- Holds the template files for the view that should be named like
- weblogs/index.html.erb for the WeblogsController#index action. All views use eRuby
- syntax.
+ Holds the template files for the view that are named like projects/index.html.erb for the Projects#index action. All views use eRuby (erb) syntax.
app/views/layouts
- Holds the template files for layouts to be used with views. This models the common
- header/footer method of wrapping views. In your views, define a layout using the
- <tt>layout :default</tt> and create a file named default.html.erb. Inside default.html.erb,
- call <% yield %> to render the view using this layout.
+ Holds the template files for layouts to be used with views. This models the common header/footer method of wrapping views. The specified layout is set by the controller using the
+ <tt>layout</tt> method.
app/helpers
- Holds view helpers that should be named like weblogs_helper.rb. These are generated
- for you automatically when using script/generate for controllers. Helpers can be used to
- wrap functionality for your views into methods.
+ Holds view helpers named like projects_helper.rb. Helpers are be used to wrap functionality for your views into methods for code reuse and clean, easy to read views.
config
Configuration files for the Rails environment, the routing map, the database, and other dependencies.
db
- Contains the database schema in schema.rb. db/migrate contains all
- the sequence of Migrations for your schema.
+ Contains the database schema in schema.rb. db/migrate contains all the sequence of Migrations for the schema.
doc
- This directory is where your application documentation will be stored when generated
- using <tt>rake doc:app</tt>
+ This directory is where the application documentation will be stored when generated using <tt>rake doc:app</tt>
lib
- Application specific libraries. Basically, any kind of custom code that doesn't
- belong under controllers, models, or helpers. This directory is in the load path.
+ Application specific libraries. Basically, any kind of custom code that doesn't belong under controllers, models, or helpers. This directory is in the load path.
public
- The directory available for the web server. Contains subdirectories for images, stylesheets,
- and javascripts. Also contains the dispatchers and the default HTML files. This should be
- set as the DOCUMENT_ROOT of your web server.
+ The directory available for the web server. Contains subdirectories for images, stylesheets, and javascripts. Also contains the dispatchers and the default HTML files. This should be set as the DOCUMENT_ROOT of the web server.
script
Helper scripts for automation and generation.
test
- Unit and functional tests along with fixtures. When using the script/generate scripts, template
- test files will be generated for you and placed in this directory.
+ Unit and functional tests along with fixtures.
vendor
- External libraries that the application depends on. Also includes the plugins subdirectory.
- If the app has frozen rails, those gems also go here, under vendor/rails/.
- This directory is in the load path.
+ External libraries that the application depends on. Also includes the plugins subdirectory. If the app has frozen rails, those gems also go here, under vendor/rails/. This directory is in the load path.
View
2  Rakefile
@@ -7,4 +7,4 @@ require 'rake'
require 'rake/testtask'
require 'rake/rdoctask'
-require 'tasks/rails'
+require 'tasks/rails'
View
25 app/controllers/application_controller.rb
@@ -1,5 +1,8 @@
-# Filters added to this controller apply to all controllers in the application.
-# Likewise, all the methods added will be available for all controllers.
+# @author:: Harry Brundage
+
+# Extended by all other controllers. Manages request forger protection, and provides methods to define authenitication requirements,
+# and to access the current user model. Filters added to this controller apply to all controllers in the application. Likewise, all
+# the methods added will be available for all controllers. The application controller never serves any requests itself.
class ApplicationController < ActionController::Base
helper :all # include all helpers, all the time
@@ -9,16 +12,24 @@ class ApplicationController < ActionController::Base
helper_method :current_user_session, :current_user
private
+
+ # Returns the current user's +UserSession+ if it exists. The session will only exist if a user has successfully logged in.
+ # @return [UserSession] the logged in user's session
def current_user_session
return @current_user_session if defined?(@current_user_session)
@current_user_session = UserSession.find
end
+ # Returns the current user object if it exists. The current user will only exist if a user has successfully logged in.
+ # @return [User] the logged in user
def current_user
return @current_user if defined?(@current_user)
@current_user = current_user_session && current_user_session.user
end
+ # This method ensures that the user viewing the page has logged in. Call this method
+ # in a before_filter chain to prevent access to a particular action for users who haven't logged in.
+ # @return [boolean] the result of the authentication check
def require_user
unless current_user
store_location
@@ -28,6 +39,9 @@ def require_user
end
end
+ # This method ensures that the user viewing the page has not logged in. Call this method
+ # in a before_filter chain to prevent access to a particular action by logged in users.
+ # @return [boolean] the result of the authentication check
def require_no_user
if current_user
store_location
@@ -37,10 +51,15 @@ def require_no_user
end
end
+ # Stores the user's intended destination in the event they aren't able to read it due to lack of authorization or authentication.
+ # @return [String] the user's intended destination URL
def store_location
session[:return_to] = request.request_uri
end
-
+
+ # Redirects the user to their previously intended destination if it exists and to a default if not. Called after a user has successfully
+ # logged in to send them back to where they were going if they were interrupted.
+ # @return [nil]
def redirect_back_or_default(default)
redirect_to(session[:return_to] || default)
session[:return_to] = nil
View
17 app/models/address.rb
@@ -2,28 +2,33 @@ class Address < ActiveRecord::Base
belongs_to :addressable, :polymorphic => true
validates_presence_of :street1, :city, :zipcode, :country
+
+ # Ensure the specified state/province belongs to the specified country. Called only if the specified country actually has states.
validate :state_must_belong_to_country, :if => Proc.new {|a| Carmen::states?(a.country) }
after_initialize :default_region
+ # Overrides +Object.to_s+ to print out a well formatted address. Includes the country if it is not standard (not the +Carmen.default_country+) and the second street line if it exists.
+ # @return [String] the address represented as a well formatted string
def to_s
- a = [self.street1,
- self.city,
- self.state,
- self.zipcode]
+ a = [self.street1, self.city, self.state, self.zipcode]
a << Carmen::country_name(self.country) if self.country != Carmen.default_country
- a.insert 1, self.street2 unless self.street2.blank?
-
+ a.insert 1, self.street2 unless self.street2.blank?
a.join(", ")
end
private
+
+ # Sets the object's default region when it is instantiated. Called by the +after_initialize+ callback.
def default_region
if Carmen.default_country == "CA"
self.country ||= "CA"
self.state ||= "ON"
end
end
+
+ # Validation check to ensure the specified state/province belongs to the specified country. Adds to the Rails supplied +errors+ validation error array.
+ # @return [Boolean] the result of the validation
def state_must_belong_to_country
errors.add(:state, "must belong to the selected country") if Carmen::state_name(self.state, self.country).nil?
end
View
2  doc/README_FOR_APP
@@ -1,2 +0,0 @@
-Use this README file to introduce your application and point to useful places in the API for learning more.
-Run "rake doc:app" to generate API documentation for your models, controllers, helpers, and libraries.
View
10 lib/tasks/yard.rake
@@ -1,5 +1,11 @@
require 'yard'
-YARD::Rake::YardocTask.new do |t|
+# Delete the old rails doc:app task that used RDOC
+Rake.application.instance_variable_get('@tasks').delete('doc:app')
+
+#Add the new Rake YARD task, name it :app to preserve the heirarchy.
+namespace :doc do
+YARD::Rake::YardocTask.new(:app) do |t|
t.files = ['app/**/*.rb'] # optional
-# t.options = ['--any', '--extra', '--opts'] # optional
+ t.options = ['--output-dir=doc/app', '--private'] # optional
+end
end
Please sign in to comment.
Something went wrong with that request. Please try again.