Rails is a web-application framework that includes everything needed to create database-backed web applications according to the Model-View-Control pattern.
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 requestsTodo
Todo is a web-based application that allows you to create task lists. Tasks in these lists can have optional dates which allows users to stay organized with a due this week bar to see what is due soon and a calendar page that lets you see tasks by month. Todo task lists are sharable which allows collaborators to stay on top of group assignments.
Todo was created by Group B in Ruby on Rails for Ohio State’s CSE 3901 class.
These are instructions for running Todo on a Linux machine assuming that you already have the repositories. On windows machines you will need to install node.js nodejs.org/download/ before setting up the application.
1. To start using Todo you must first prepare the application for use:
2. Start by moving to the todo-app directory where the application files are
located
3. You must then run the following commands
bundle install --without production
bundle update
rake db:migrate
4. Once those actions are completed you start the rails server with the command
rails server
5. When this is complete, in a web browser go to localhost:3000 to use the
application
The first time you use Todo is will direct you to the signup page where you must create an account with your name, email and password. Once signed up you should be redirected to the main page where you can see application in list view. The navbar on the top of the page allows you to switch between list and calendar views, log out, or change your settings.
The list view page is where you can see upcoming tasks and manage task lists. To create a new task list click the “Add Task List button” a window will then appear asking for the name of the task list, once you select create task list the window disappears and a task list appears in the task list area. Task lists have three options: Add new task, share task list, and remove task list.
- The Add new task feature allows you to add tasks to a list, when the button is clicked a window appears with fields for task name and the potential to add a due date to the task - The share task button allows you to share this list with another user, when clicked a window appears asking for the email you would like to share the list with. - The remove task list button allows you to delete task lists for just yourself or everyone.
The calendar view allows you to see tasks by date in a standard monthly calendar, this view still has the upcoming task sidebar.
pages_controller.rb This controller gets the users task lists if they are signed in for the list and calendar views sessions_controller.rb This controls the current session, which checks if someone is signed in and creates a new session upon logging in. it also handles signing out task_list_users_controller.rb This controls list sharing, by adding another email from the share modal to the task_list_user model for that list. task_lists_controller.rb This controls the creation and removal of tasklist objects tasks_controller.rb This controls the creation of tasks and the actions of the finished button users_controller.rb This controls the creation of new accounts
task.rb This model is in charge of the task objects. gives the task object the attributes :duedate, :task, :task_list_id, :has_due_date and gives tasks a realation to task_list task_list.rb This model is in charge of the TaskList object. gives the tasklist object the name attribute, ans sets relationships between the tasklist, tasks, task_list_users, and users models task_list_user.rb This model is in charge of the relationships between tasklists and users. It gives the object the attributes task_list_id and user_id user.rb This model is in charge of the user object. It sets the relationships between users and tasklists and task_list_users. It gives the attributes email, name, password, and remember token. It has functions new_remember_token, encrypt, getTasks, and create_remember_token. The getTasks function gets the tasks that have due dates for that user.
layouts/application.html.erb This file contains the links to the stylesheets, javascript, renders the navbar then yields. pages/calendar.html.erb This file contains the eRuby HTML for the calendar page of the application pages/home.html.erb This file contains the eRuby HTML for the list view page including the code for the modals for creating, adding to, sharing and removing lists sessions/new.html.erb This file contains the HTML for the log in page users/new.html.erb This file contains the eRuby HTML for the sign up page and passes the information to the controller to create a new account users/show.html.erb This file contains the eRuby HTML for the users profile, where users can change their settings such as name, email, and password
pages_helper.rb Empty, Generated Automatically sessions_helper.rb Useful functions used for authenticating users
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 files/vendor/rails/activerecord/README.html.
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 files/vendor/rails/actionpack/README.html.
-
At the command prompt, create a new Rails application:
<tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
-
Change directory to
myappand start the web server:<tt>cd myapp; rails server</tt> (run with --help for options)
-
Go to localhost:3000/ and you’ll see:
"Welcome aboard: You're riding Ruby on Rails!" -
Follow the guidelines to start developing your application. You can find
the following resources handy:
-
The Getting Started Guide: guides.rubyonrails.org/getting_started.html
-
Ruby on Rails Tutorial Book: www.railstutorial.org/
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 www.ruby-doc.org/core/
Also, Ruby documentation can be found at www.ruby-lang.org/. There are several books available online as well:
-
Programming Ruby: www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
-
Learn to Program: pine.fm/LearnToProgram/ (a beginners guide)
These two books will bring you up to speed on the Ruby language and also on programming in general.
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! You need to install ruby-debug to run the server in debugging mode. With gems, use sudo gem install ruby-debug. Example:
class WeblogController < ActionController::Base def index @posts = Post.all debugger end end
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:0x14a6620
@attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
>> @posts.first.title = "hello from a debugger"
=> "hello from a debugger"
…and even better, you can examine how your runtime objects actually work:
>> 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 can enter “cont”.
The console is a Ruby shell, which allows you to interact with your application’s domain model. 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. Starting the script without arguments will launch it in the development environment.
To start the console, run rails console from the application directory.
Options:
-
Passing the
-s, --sandboxargument will rollback any modifications made to the database. -
Passing an environment name as an argument will load the corresponding environment. Example:
rails console production.
To reload your controllers and models after launching the console run reload!
More information about irb can be found at: http://www.rubycentral.org/pickaxe/irb.html
You can go to the command line of your database directly through rails dbconsole. You would be connected to the database with the credentials defined in database.yml. Starting the script without arguments will connect you to the development database. Passing an argument will connect you to a different database, like rails dbconsole production. Currently works for MySQL, PostgreSQL and SQLite 3.
The default directory structure of a generated Ruby on Rails application:
|-- app
| |-- assets
| | |-- images
| | |-- javascripts
| | `-- stylesheets
| |-- controllers
| |-- helpers
| |-- mailers
| |-- models
| `-- views
| `-- layouts
|-- config
| |-- environments
| |-- initializers
| `-- locales
|-- db
|-- doc
|-- lib
| |-- assets
| `-- tasks
|-- log
|-- public
|-- script
|-- test
| |-- fixtures
| |-- functional
| |-- integration
| |-- performance
| `-- unit
|-- tmp
| `-- cache
| `-- assets
`-- vendor
|-- assets
| |-- javascripts
| `-- stylesheets
`-- plugins
app
Holds all the code that's specific to this particular application.
app/assets
Contains subdirectories for images, stylesheets, and JavaScript files.
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.
app/models
Holds models that should be named like post.rb. Models descend from ActiveRecord::Base by default.
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 by default.
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.
app/helpers
Holds view helpers that should be named like weblogs_helper.rb. These are generated for you automatically when using generators 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.
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 under controllers, models, or helpers. This directory is in the load path.
public
The directory available for the web server. 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. When using the rails generate command, template test files will be generated for you and placed in this directory.
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.