Done with basic Rails 2.0 port. Imported will_paginate gem to replace legacy pagination code.

Author: Lennon Day-Reynolds

README

@@ -1,191 +1,203 @@
 == Welcome to Rails
 
-Rails is a web-application and persistance framework that includes everything
+Rails is a web-application and persistence framework that includes everything
 needed to create database-backed web-applications according to the
 Model-View-Control pattern of separation. This pattern splits the view (also
 called the presentation) into "dumb" templates that are primarily responsible
-for inserting pre-build data in between HTML tags. The model contains the
+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.
 
-In Rails, the model is handled by what's called a object-relational mapping
+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 
+methods. You can read more about Active Record in
 link:files/vendor/rails/activerecord/README.html.
 
-The controller and view is handled by the Action Pack, which handles both
+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 
+Rails.  You can read more about Action Pack in
 link:files/vendor/rails/actionpack/README.html.
 
 
-== Requirements
-
-* Database and driver (MySQL, PostgreSQL, or SQLite)
-* Rake[http://rake.rubyforge.org] for running tests and the generating documentation
-
-== Optionals
-
-* Apache 1.3.x or 2.x or lighttpd 1.3.11+ (or any FastCGI-capable webserver with a
-  mod_rewrite-like module)
-* FastCGI (or mod_ruby) for better performance on Apache
-
-== Getting started
-
-1. Run the WEBrick servlet: <tt>ruby script/server</tt>
-   (run with --help for options)
-2. Go to http://localhost:3000/ and get "Congratulations, you've put Ruby on Rails!"
-3. Follow the guidelines on the "Congratulations, you've put Ruby on Rails!" screen
-
-
-== Example for Apache conf
-
-  <VirtualHost *:80>
-    ServerName rails
-    DocumentRoot /path/application/public/
-    ErrorLog /path/application/log/server.log
-  
-    <Directory /path/application/public/>
-      Options ExecCGI FollowSymLinks
-      AllowOverride all
-      Allow from all
-      Order allow,deny
-    </Directory>
-  </VirtualHost>
-
-NOTE: Be sure that CGIs can be executed in that directory as well. So ExecCGI
-should be on and ".cgi" should respond. All requests from 127.0.0.1 goes
-through CGI, so no Apache restart is necessary for changes. All other requests
-goes through FCGI (or mod_ruby) that requires restart to show changes.
-
-
-== Example for lighttpd conf (with FastCGI)
-
-  server.port = 8080
-  server.bind = "127.0.0.1"
-  # server.event-handler = "freebsd-kqueue" # needed on OS X
-  
-  server.modules = ( "mod_rewrite", "mod_fastcgi" )
-  
-  url.rewrite = ( "^/$" => "index.html", "^([^.]+)$" => "$1.html" )
-  server.error-handler-404 = "/dispatch.fcgi"
-  
-  server.document-root = "/path/application/public"
-  server.errorlog      = "/path/application/log/server.log"
-  
-  fastcgi.server = ( ".fcgi" =>
-    ( "localhost" =>
-        (
-          "min-procs" => 1, 
-          "max-procs" => 5,
-          "socket"   => "/tmp/application.fcgi.socket",
-          "bin-path" => "/path/application/public/dispatch.fcgi",
-          "bin-environment" => ( "RAILS_ENV" => "development" )
-        )
-    )
-  )
-  
+== 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
+   (If you've downloaded Rails in a complete tgz or zip, this step is already done)
+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 and lighttpd if they are installed, otherwise
+Rails will use WEBrick, the webserver that ships with Ruby. When you run script/server,
+Rails will check if Mongrel exists, then lighttpd and finally fall back to WEBrick. This ensures
+that you can always get up and running quickly.
+
+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
+
+If Mongrel is not installed, Rails will look for lighttpd. It's considerably faster than
+Mongrel and WEBrick and also suited for production use, but requires additional
+installation and currently only works well on OS X/Unix (Windows users are encouraged
+to start with Mongrel). We recommend version 1.4.11 and higher. You can download it from
+http://www.lighttpd.net.
+
+And finally, if neither Mongrel or lighttpd are installed, Rails will use the built-in Ruby
+web server, WEBrick. WEBrick is a small Ruby web server suitable for development, but not
+for production.
+
+But of course its also possible to run Rails on any platform that supports FCGI.
+Apache, LiteSpeed, IIS are just a few. For more information on FCGI,
+please visit: http://wiki.rubyonrails.com/rails/pages/FastCGI
+
 
 == Debugging Rails
 
-Have "tail -f" commands running on both the server.log, production.log, and
-test.log files. 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.
+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
+
+The result will be a message in your log file along the lines of:
+
+  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/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/ including:
 
+* The Learning Ruby (Pickaxe) Book: http://www.ruby-doc.org/docs/ProgrammingRuby/
+* Learn to Program: http://pine.fm/LearnToProgram/  (a beginners guide)
 
-== Breakpoints
+These two online (and free) books will bring you up to speed on the Ruby language
+and also on programming in general.
 
-Breakpoint support is available through the script/breakpointer client. This
-means that you can break out of execution at any point in the code, investigate
-and change the model, AND then resume execution! Example:
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your Mongrel or
+Webrick server with --debugger. This means that you can break out of execution at any point
+in the code, investigate and change the model, AND then resume execution! Example:
 
   class WeblogController < ActionController::Base
     def index
-      @posts = Post.find_all
-      breakpoint "Breaking out from the list"
+      @posts = Post.find(:all)
+      debugger
     end
   end
-  
-So the controller will accept the action, run the first line, then present you
-with a IRB prompt in the breakpointer window. Here you can do things like:
 
-Executing breakpoint "Breaking out from the list" at .../webrick_server.rb:16 in 'breakpoint'
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
 
   >> @posts.inspect
-  => "[#<Post:0x14a6be8 @attributes={\"title\"=>nil, \"body\"=>nil, \"id\"=>\"1\"}>, 
+  => "[#<Post:0x14a6be8 @attributes={\"title\"=>nil, \"body\"=>nil, \"id\"=>\"1\"}>,
        #<Post:0x14a6620 @attributes={\"title\"=>\"Rails you know!\", \"body\"=>\"Only ten..\", \"id\"=>\"2\"}>]"
-  >> @posts.first.title = "hello from a breakpoint"
-  => "hello from a breakpoint"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
 
 ...and even better is that you can examine how your runtime objects actually work:
 
-  >> f = @posts.first 
+  >> f = @posts.first
   => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
   >> f.
   Display all 152 possibilities? (y or n)
 
-Finally, when you're ready to resume execution, you press CTRL-D
+Finally, when you're ready to resume execution, you enter "cont"
 
 
 == Console
 
-You can interact with the domain model by starting the console through script/console. 
+You can interact with the domain model by starting the console through <tt>script/console</tt>.
 Here you'll have all parts of the application configured, just like it is when the
 application is running. You can inspect domain models, change values, and save to the
-database. Start the script without arguments will launch it in the development environment.
-Passing an argument will specify a different environment, like <tt>console production</tt>.
+database. Starting the script without arguments will launch it in the development environment.
+Passing an argument will specify a different environment, like <tt>script/console production</tt>.
 
+To reload your controllers and models after launching the console run <tt>reload!</tt>
 
-== Description of contents
+
+== Description of Contents
 
 app
   Holds all the code that's specific to this particular application.
 
 app/controllers
-  Holds controllers that should be named like weblog_controller.rb for
-  automated URL mapping. All controllers should descend from
-  ActionController::Base.
+  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.
 
 app/models
   Holds models that should be named like post.rb.
-  Most models will descent from ActiveRecord::Base.
-  
+  Most models will descend from ActiveRecord::Base.
+
 app/views
   Holds the template files for the view that should be named like
-  weblog/index.rhtml for the WeblogController#index action. All views uses eRuby
-  syntax. This directory can also be used to keep stylesheets, images, and so on
-  that can be symlinked to public.
-  
+  weblogs/index.erb for the WeblogsController#index action. All views use eRuby
+  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.erb. Inside default.erb,
+  call <% yield %> to render the view using this layout.
+
 app/helpers
-  Holds view helpers that should be named like weblog_helper.rb.
+  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.
 
 config
   Configuration files for the Rails environment, the routing map, the database, and other dependencies.
 
-components
-  Self-contained mini-applications that can bundle controllers, models, and views together.
+db
+  Contains the database schema in schema.rb.  db/migrate contains all
+  the sequence of Migrations for your schema.
+
+doc
+  This directory is where your 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 controllers, models, or helpers. This directory is in the load path.
-    
+  belong under controllers, models, or helpers. This directory is in the load path.
+
 public
-  The directory available for the web server. Contains sub-directories for images, stylesheets,
-  and javascripts. Also contains the dispatchers and the default HTML files.
+  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.
 
 script
   Helper scripts for automation and generation.
 
 test
-  Unit and functional tests along with fixtures.
+  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.
 
 vendor
-  External libraries that the application depend on. This directory is in the load path.
-
+  External libraries that the application depends on. Also includes the plugins subdirectory.
+  This directory is in the load path.

Rakefile

@@ -1,11 +1,10 @@
 # Add your own tasks in files placed in lib/tasks ending in .rake,
-# for example lib/tasks/switchtower.rake, and they will automatically be available to Rake.
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
 
 require(File.join(File.dirname(__FILE__), 'config', 'boot'))
 
-task :default => [ :test_units, :test_functional ]
-
 require 'rake'
 require 'rake/testtask'
 require 'rake/rdoctask'
+
 require 'tasks/rails'

app/controllers/application.rb

@@ -1,6 +1,9 @@
 # The filters added to this controller will be run for all controllers in the application.
 # Likewise will all the methods added be available for all controllers.
 class ApplicationController < ActionController::Base
+  # See ActionController::RequestForgeryProtection for details
+  # Uncomment the :secret if you're not using the cookie session store
+  protect_from_forgery # :secret => 'a993580a90b7793c250f29bd2d2672a3'
 
   # check to see if the current user is logged in as a valid
   # member, if not, log them out

app/controllers/articles_controller.rb

@@ -1,14 +1,14 @@
 class ArticlesController < ApplicationController
   before_filter :member_is_author, :only => [ :edit, :destroy, :update ]
   before_filter :authenticate, :only => [ :new ]
-  
+
   def index
     list
     render :action => 'list'
   end
 
   def list
-    @article_pages, @articles = paginate :article, :per_page => 10, :order_by => 'modified_at'
+    @articles = Article.paginate(:page => params[:page], :order => 'modified_at')
   end
 
   def show
@@ -49,9 +49,9 @@ def destroy
     flash[:notice] = 'Article deleted.'
     redirect_to :action => 'list'
   end
-  
-  private 
-  
+
+  private
+
   def member_is_author
     if !member_is_this_member? Article.find(params[:id]).member.id
       flash[:notice] = "Only the author can edit or remove articles."