effective_roles 0.1
Sign up to get free protection for your applications and to get access to all the features.
- data/MIT-LICENSE +20 -0
- data/README.md +129 -0
- data/Rakefile +23 -0
- data/app/helpers/effective_roles_helper.rb +13 -0
- data/app/models/concerns/acts_as_role_restricted.rb +82 -0
- data/app/views/effective/roles/_roles_fields.html.haml +17 -0
- data/lib/effective_roles.rb +12 -0
- data/lib/effective_roles/engine.rb +27 -0
- data/lib/effective_roles/version.rb +3 -0
- data/lib/generators/effective_roles/install_generator.rb +17 -0
- data/lib/generators/templates/README +1 -0
- data/lib/generators/templates/effective_roles.rb +30 -0
- data/lib/tasks/effective_roles_tasks.rake +4 -0
- data/spec/dummy/README.rdoc +261 -0
- data/spec/dummy/Rakefile +7 -0
- data/spec/dummy/app/assets/javascripts/application.js +15 -0
- data/spec/dummy/app/assets/stylesheets/application.css +13 -0
- data/spec/dummy/app/controllers/application_controller.rb +3 -0
- data/spec/dummy/app/helpers/application_helper.rb +2 -0
- data/spec/dummy/app/views/layouts/application.html.erb +14 -0
- data/spec/dummy/config.ru +4 -0
- data/spec/dummy/config/application.rb +59 -0
- data/spec/dummy/config/boot.rb +10 -0
- data/spec/dummy/config/database.yml +25 -0
- data/spec/dummy/config/environment.rb +5 -0
- data/spec/dummy/config/environments/development.rb +37 -0
- data/spec/dummy/config/environments/production.rb +67 -0
- data/spec/dummy/config/environments/test.rb +37 -0
- data/spec/dummy/config/initializers/backtrace_silencers.rb +7 -0
- data/spec/dummy/config/initializers/inflections.rb +15 -0
- data/spec/dummy/config/initializers/mime_types.rb +5 -0
- data/spec/dummy/config/initializers/secret_token.rb +7 -0
- data/spec/dummy/config/initializers/session_store.rb +8 -0
- data/spec/dummy/config/initializers/wrap_parameters.rb +14 -0
- data/spec/dummy/config/locales/en.yml +5 -0
- data/spec/dummy/config/routes.rb +58 -0
- data/spec/dummy/db/development.sqlite3 +0 -0
- data/spec/dummy/db/schema.rb +16 -0
- data/spec/dummy/db/test.sqlite3 +0 -0
- data/spec/dummy/log/development.log +17 -0
- data/spec/dummy/log/test.log +1 -0
- data/spec/dummy/public/404.html +26 -0
- data/spec/dummy/public/422.html +26 -0
- data/spec/dummy/public/500.html +25 -0
- data/spec/dummy/public/favicon.ico +0 -0
- data/spec/dummy/script/rails +6 -0
- data/spec/effective_roles_spec.rb +7 -0
- data/spec/spec_helper.rb +34 -0
- data/spec/support/factories.rb +1 -0
- metadata +231 -0
data/MIT-LICENSE
ADDED
@@ -0,0 +1,20 @@
|
|
1
|
+
Copyright 2013 Code and Effect Inc.
|
2
|
+
|
3
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
4
|
+
a copy of this software and associated documentation files (the
|
5
|
+
"Software"), to deal in the Software without restriction, including
|
6
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
7
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
8
|
+
permit persons to whom the Software is furnished to do so, subject to
|
9
|
+
the following conditions:
|
10
|
+
|
11
|
+
The above copyright notice and this permission notice shall be
|
12
|
+
included in all copies or substantial portions of the Software.
|
13
|
+
|
14
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
15
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
16
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
17
|
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
18
|
+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
19
|
+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
20
|
+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,129 @@
|
|
1
|
+
# Effective Roles
|
2
|
+
|
3
|
+
Implements multi-role authorization based on an integer roles_mask field
|
4
|
+
|
5
|
+
Includes a mixin for adding authentication for any model.
|
6
|
+
|
7
|
+
SQL Finders for returning a Relation with all permitted records.
|
8
|
+
|
9
|
+
Handy formtastic helper for assigning roles.
|
10
|
+
|
11
|
+
Intended for use with the other effective_* gems
|
12
|
+
|
13
|
+
Designed to work on its own, or with simple pass through to CanCan
|
14
|
+
|
15
|
+
Rails >= 3.2.x, Ruby >= 1.9.x. Has not been tested/developed for Rails4.
|
16
|
+
|
17
|
+
|
18
|
+
## Getting Started
|
19
|
+
|
20
|
+
Add to Gemfile:
|
21
|
+
|
22
|
+
```ruby
|
23
|
+
gem 'effective_roles'
|
24
|
+
```
|
25
|
+
|
26
|
+
Run the bundle command to install it:
|
27
|
+
|
28
|
+
```console
|
29
|
+
bundle install
|
30
|
+
```
|
31
|
+
|
32
|
+
Install the configuration file:
|
33
|
+
|
34
|
+
```console
|
35
|
+
rails generate effective_roles:install
|
36
|
+
```
|
37
|
+
|
38
|
+
The generator will install an initializer which describes all configuration options.
|
39
|
+
|
40
|
+
## Usage
|
41
|
+
|
42
|
+
Add the mixin to an existing model:
|
43
|
+
|
44
|
+
```ruby
|
45
|
+
class Post
|
46
|
+
acts_as_role_restricted
|
47
|
+
end
|
48
|
+
```
|
49
|
+
|
50
|
+
Then create a migration to add the :roles_Mask column to the model.
|
51
|
+
|
52
|
+
```console
|
53
|
+
rails generate migration add_roles_to_post roles_mask:integer
|
54
|
+
```
|
55
|
+
|
56
|
+
which will create a migration something like
|
57
|
+
|
58
|
+
```ruby
|
59
|
+
class AddRolesToPost < ActiveRecord::Migration
|
60
|
+
def change
|
61
|
+
add_column :posts, :roles_mask, :integer
|
62
|
+
end
|
63
|
+
end
|
64
|
+
```
|
65
|
+
|
66
|
+
## Behavior
|
67
|
+
|
68
|
+
### Defining Roles
|
69
|
+
|
70
|
+
All roles are defined in the config/effective_roles.rb initializer.
|
71
|
+
|
72
|
+
### Model
|
73
|
+
|
74
|
+
Assign roles:
|
75
|
+
|
76
|
+
```ruby
|
77
|
+
post.roles = [:admin, :superamdin]
|
78
|
+
post.save
|
79
|
+
```
|
80
|
+
|
81
|
+
See if an object has been assigned a specific role:
|
82
|
+
|
83
|
+
```ruby
|
84
|
+
post.is_role_restricted?
|
85
|
+
=> true
|
86
|
+
|
87
|
+
post.is?(:admin)
|
88
|
+
=> true
|
89
|
+
|
90
|
+
post.roles
|
91
|
+
=> [:admin, :superadmin]
|
92
|
+
```
|
93
|
+
|
94
|
+
### Finder Methods
|
95
|
+
|
96
|
+
Find all objects that have been assigned a specific role (or roles). Will not return posts that have no assigned roles (roles_mask = 0)
|
97
|
+
|
98
|
+
```ruby
|
99
|
+
Post.with_role(:admin, :superadmin) # Can pass as an array if you want
|
100
|
+
```
|
101
|
+
|
102
|
+
Find all objects that are appropriate for a specific role. Will return posts that have no assigned roles
|
103
|
+
|
104
|
+
```ruby
|
105
|
+
Post.for_role(:admin)
|
106
|
+
Post.for_role(current_user.roles)
|
107
|
+
```
|
108
|
+
|
109
|
+
These are both ActiveRecord::Relations, so you can chain them with other methods like normal.
|
110
|
+
|
111
|
+
## License
|
112
|
+
|
113
|
+
MIT License. Copyright Code and Effect Inc. http://www.codeandeffect.com
|
114
|
+
|
115
|
+
You are not granted rights or licenses to the trademarks of Code and Effect
|
116
|
+
|
117
|
+
## Credits
|
118
|
+
|
119
|
+
This model implements the https://github.com/ryanb/cancan/wiki/Role-Based-Authorization multi role based authorization based on the roles_mask field
|
120
|
+
|
121
|
+
### Testing
|
122
|
+
|
123
|
+
The test suite for this gem is unfortunately not yet complete.
|
124
|
+
|
125
|
+
Run tests by:
|
126
|
+
|
127
|
+
```ruby
|
128
|
+
rake spec
|
129
|
+
```
|
data/Rakefile
ADDED
@@ -0,0 +1,23 @@
|
|
1
|
+
#!/usr/bin/env rake
|
2
|
+
begin
|
3
|
+
require 'bundler/setup'
|
4
|
+
rescue LoadError
|
5
|
+
puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
|
6
|
+
end
|
7
|
+
|
8
|
+
# Our tasks
|
9
|
+
load 'lib/tasks/effective_roles_tasks.rake'
|
10
|
+
|
11
|
+
# Testing tasks
|
12
|
+
APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
|
13
|
+
load 'rails/tasks/engine.rake'
|
14
|
+
|
15
|
+
Bundler::GemHelper.install_tasks
|
16
|
+
|
17
|
+
require 'rspec/core'
|
18
|
+
require 'rspec/core/rake_task'
|
19
|
+
|
20
|
+
desc "Run all specs in spec directory (excluding plugin specs)"
|
21
|
+
RSpec::Core::RakeTask.new(:spec => 'app:db:test:prepare')
|
22
|
+
|
23
|
+
task :default => :spec
|
@@ -0,0 +1,13 @@
|
|
1
|
+
module EffectiveRolesHelper
|
2
|
+
# For use in formtastic forms
|
3
|
+
def effective_roles_fields(form, options = {})
|
4
|
+
if EffectiveRoles.role_descriptions.kind_of?(Hash)
|
5
|
+
role_descriptions = EffectiveRoles.role_descriptions[form.object.class.name]
|
6
|
+
end
|
7
|
+
role_descriptions ||= (EffectiveRoles.role_descriptions || [])
|
8
|
+
|
9
|
+
opts = {:f => form, :role_descriptions => role_descriptions}.merge(options)
|
10
|
+
|
11
|
+
render :partial => 'effective/roles/roles_fields', :locals => opts
|
12
|
+
end
|
13
|
+
end
|
@@ -0,0 +1,82 @@
|
|
1
|
+
# ActsAsRoleRestricted
|
2
|
+
#
|
3
|
+
# This model implements the
|
4
|
+
# https://github.com/ryanb/cancan/wiki/Role-Based-Authorization
|
5
|
+
# multi role based authorization based on the roles_mask field
|
6
|
+
#
|
7
|
+
# Mark your model with 'acts_as_role_restricted'
|
8
|
+
#
|
9
|
+
# and create the migration
|
10
|
+
#
|
11
|
+
# structure do
|
12
|
+
# roles_mask :integer, :default => 0
|
13
|
+
# end
|
14
|
+
#
|
15
|
+
|
16
|
+
module ActsAsRoleRestricted
|
17
|
+
extend ActiveSupport::Concern
|
18
|
+
|
19
|
+
module ActiveRecord
|
20
|
+
def acts_as_role_restricted(*options)
|
21
|
+
@acts_as_role_restricted_opts = options || []
|
22
|
+
include ::ActsAsRoleRestricted
|
23
|
+
end
|
24
|
+
end
|
25
|
+
|
26
|
+
included do
|
27
|
+
validates :roles_mask, :numericality => true, :allow_nil => true
|
28
|
+
end
|
29
|
+
|
30
|
+
module ClassMethods
|
31
|
+
# Call with for_role(:admin) or for_role(@user.roles) or for_role([:admin, :member]) or for_role(:admin, :member, ...)
|
32
|
+
|
33
|
+
# Returns all records which have been assigned any of the the given roles
|
34
|
+
def with_role(*roles)
|
35
|
+
where(with_role_sql(roles))
|
36
|
+
end
|
37
|
+
|
38
|
+
# Returns all records which have been assigned any of the given roles, as well as any record with no role assigned
|
39
|
+
def for_role(*roles)
|
40
|
+
sql = with_role_sql(roles) || ''
|
41
|
+
sql += ' OR ' if sql.present?
|
42
|
+
sql += "(#{self.table_name}.roles_mask = 0) OR (#{self.table_name}.roles_mask IS NULL)"
|
43
|
+
where(sql)
|
44
|
+
end
|
45
|
+
|
46
|
+
def with_role_sql(*roles)
|
47
|
+
roles = roles.flatten.compact
|
48
|
+
roles = (roles.map { |role| role.to_sym } & EffectiveRoles.roles)
|
49
|
+
roles.map { |role| "(#{self.table_name}.roles_mask & %d > 0)" % 2**EffectiveRoles.roles.index(role) }.join(' OR ')
|
50
|
+
end
|
51
|
+
end
|
52
|
+
|
53
|
+
def roles=(roles)
|
54
|
+
self.roles_mask = (roles.map(&:to_sym) & EffectiveRoles.roles).map { |r| 2**EffectiveRoles.roles.index(r) }.sum
|
55
|
+
end
|
56
|
+
|
57
|
+
def roles
|
58
|
+
EffectiveRoles.roles.reject { |r| ((roles_mask || 0) & 2**EffectiveRoles.roles.index(r)).zero? }
|
59
|
+
end
|
60
|
+
|
61
|
+
# if user.is? :admin
|
62
|
+
def is?(role)
|
63
|
+
roles.include?(role.try(:to_sym))
|
64
|
+
end
|
65
|
+
|
66
|
+
def roles_match_with?(obj)
|
67
|
+
if is_role_restricted? == false
|
68
|
+
true
|
69
|
+
elsif obj.respond_to?(:is_role_restricted?) == false
|
70
|
+
false
|
71
|
+
elsif obj.is_role_restricted? == false
|
72
|
+
true
|
73
|
+
else
|
74
|
+
(roles & obj.roles).any?
|
75
|
+
end
|
76
|
+
end
|
77
|
+
|
78
|
+
def is_role_restricted?
|
79
|
+
roles_mask > 0
|
80
|
+
end
|
81
|
+
end
|
82
|
+
|
@@ -0,0 +1,17 @@
|
|
1
|
+
- obj = f.object.class.name.downcase.gsub("::", '_')
|
2
|
+
|
3
|
+
%fieldset.inputs
|
4
|
+
%legend
|
5
|
+
%span Role Restricted
|
6
|
+
%ol
|
7
|
+
%li{:id => "#{obj}_roles_input", :class => 'check_boxes input optional'}
|
8
|
+
%fieldset.choices
|
9
|
+
%legend.label
|
10
|
+
%label Roles
|
11
|
+
%input{:type => :hidden, :id => "#{obj}_roles_none", :name => "#{obj}[roles][]"}
|
12
|
+
%ol.choices-group
|
13
|
+
- EffectiveRoles.roles.each_with_index do |role, x|
|
14
|
+
%li.choice
|
15
|
+
%label{:for => "#{obj}_roles_#{role}"}
|
16
|
+
%input{:type => :checkbox, :id => "#{obj}_roles_#{role}", :name => "#{obj}[roles][]", :value => role.to_s, :checked => ("checked" if f.object.roles.include?(role))}= role
|
17
|
+
%p.inline-hints{:style => "margin: 2px 0 16px 0;"}= role_descriptions[x]
|
@@ -0,0 +1,27 @@
|
|
1
|
+
module EffectiveRoles
|
2
|
+
class Engine < ::Rails::Engine
|
3
|
+
engine_name 'effective_roles'
|
4
|
+
|
5
|
+
config.autoload_paths += Dir["#{config.root}/app/models/concerns"]
|
6
|
+
|
7
|
+
# Include Helpers to base application
|
8
|
+
initializer 'effective_roles.action_controller' do |app|
|
9
|
+
ActiveSupport.on_load :action_controller do
|
10
|
+
helper EffectiveRolesHelper
|
11
|
+
end
|
12
|
+
end
|
13
|
+
|
14
|
+
# Include acts_as_addressable concern and allow any ActiveRecord object to call it
|
15
|
+
initializer 'effective_roles.active_record' do |app|
|
16
|
+
ActiveSupport.on_load :active_record do
|
17
|
+
ActiveRecord::Base.extend(ActsAsRoleRestricted::ActiveRecord)
|
18
|
+
end
|
19
|
+
end
|
20
|
+
|
21
|
+
# Set up our default configuration options.
|
22
|
+
initializer "effective_roles.defaults", :before => :load_config_initializers do |app|
|
23
|
+
eval File.read("#{config.root}/lib/generators/templates/effective_roles.rb")
|
24
|
+
end
|
25
|
+
|
26
|
+
end
|
27
|
+
end
|
@@ -0,0 +1,17 @@
|
|
1
|
+
module EffectiveRoles
|
2
|
+
module Generators
|
3
|
+
class InstallGenerator < Rails::Generators::Base
|
4
|
+
desc "Creates an EffectiveRoles initializer in your application."
|
5
|
+
|
6
|
+
source_root File.expand_path("../../templates", __FILE__)
|
7
|
+
|
8
|
+
def copy_initializer
|
9
|
+
template "effective_roles.rb", "config/initializers/effective_roles.rb"
|
10
|
+
end
|
11
|
+
|
12
|
+
def show_readme
|
13
|
+
readme "README" if behavior == :invoke
|
14
|
+
end
|
15
|
+
end
|
16
|
+
end
|
17
|
+
end
|
@@ -0,0 +1 @@
|
|
1
|
+
Thanks for using EffectiveRoles
|
@@ -0,0 +1,30 @@
|
|
1
|
+
EffectiveRoles.setup do |config|
|
2
|
+
config.roles = [:superadmin, :admin, :member] # Only add to the end of this array. Never prepend roles.
|
3
|
+
|
4
|
+
# config.role_descriptions may be an Array or a Hash
|
5
|
+
# These role descriptions are just text displayed by the effective_roles_fields() helper
|
6
|
+
|
7
|
+
# Use a Hash if you want different labels depending on the resource being editted
|
8
|
+
#
|
9
|
+
|
10
|
+
# config.role_descriptions = {
|
11
|
+
# 'User' => [
|
12
|
+
# "full access to everything. Can manage users and all website content.",
|
13
|
+
# "full access to website content. Cannot manage users.",
|
14
|
+
# "cannot access admin area. Can see all content in members-only sections of the website."
|
15
|
+
# ],
|
16
|
+
# 'Effective::Page' => [
|
17
|
+
# "allow superadmins to see this page",
|
18
|
+
# "allow admins to see this page",
|
19
|
+
# "allow members to see this page"
|
20
|
+
# ]
|
21
|
+
# }
|
22
|
+
|
23
|
+
# Or just keep it simple, and use the same Array of labels for everything
|
24
|
+
#
|
25
|
+
config.role_descriptions = [
|
26
|
+
"full access to everything. Can manage users and all website content.",
|
27
|
+
"full access to website content. Cannot manage users.",
|
28
|
+
"cannot access admin area. Can see all content in members-only sections of the website."
|
29
|
+
]
|
30
|
+
end
|
@@ -0,0 +1,261 @@
|
|
1
|
+
== Welcome to Rails
|
2
|
+
|
3
|
+
Rails is a web-application framework that includes everything needed to create
|
4
|
+
database-backed web applications according to the Model-View-Control pattern.
|
5
|
+
|
6
|
+
This pattern splits the view (also called the presentation) into "dumb"
|
7
|
+
templates that are primarily responsible for inserting pre-built data in between
|
8
|
+
HTML tags. The model contains the "smart" domain objects (such as Account,
|
9
|
+
Product, Person, Post) that holds all the business logic and knows how to
|
10
|
+
persist themselves to a database. The controller handles the incoming requests
|
11
|
+
(such as Save New Account, Update Product, Show Post) by manipulating the model
|
12
|
+
and directing data to the view.
|
13
|
+
|
14
|
+
In Rails, the model is handled by what's called an object-relational mapping
|
15
|
+
layer entitled Active Record. This layer allows you to present the data from
|
16
|
+
database rows as objects and embellish these data objects with business logic
|
17
|
+
methods. You can read more about Active Record in
|
18
|
+
link:files/vendor/rails/activerecord/README.html.
|
19
|
+
|
20
|
+
The controller and view are handled by the Action Pack, which handles both
|
21
|
+
layers by its two parts: Action View and Action Controller. These two layers
|
22
|
+
are bundled in a single package due to their heavy interdependence. This is
|
23
|
+
unlike the relationship between the Active Record and Action Pack that is much
|
24
|
+
more separate. Each of these packages can be used independently outside of
|
25
|
+
Rails. You can read more about Action Pack in
|
26
|
+
link:files/vendor/rails/actionpack/README.html.
|
27
|
+
|
28
|
+
|
29
|
+
== Getting Started
|
30
|
+
|
31
|
+
1. At the command prompt, create a new Rails application:
|
32
|
+
<tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
|
33
|
+
|
34
|
+
2. Change directory to <tt>myapp</tt> and start the web server:
|
35
|
+
<tt>cd myapp; rails server</tt> (run with --help for options)
|
36
|
+
|
37
|
+
3. Go to http://localhost:3000/ and you'll see:
|
38
|
+
"Welcome aboard: You're riding Ruby on Rails!"
|
39
|
+
|
40
|
+
4. Follow the guidelines to start developing your application. You can find
|
41
|
+
the following resources handy:
|
42
|
+
|
43
|
+
* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
|
44
|
+
* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
|
45
|
+
|
46
|
+
|
47
|
+
== Debugging Rails
|
48
|
+
|
49
|
+
Sometimes your application goes wrong. Fortunately there are a lot of tools that
|
50
|
+
will help you debug it and get it back on the rails.
|
51
|
+
|
52
|
+
First area to check is the application log files. Have "tail -f" commands
|
53
|
+
running on the server.log and development.log. Rails will automatically display
|
54
|
+
debugging and runtime information to these files. Debugging info will also be
|
55
|
+
shown in the browser on requests from 127.0.0.1.
|
56
|
+
|
57
|
+
You can also log your own messages directly into the log file from your code
|
58
|
+
using the Ruby logger class from inside your controllers. Example:
|
59
|
+
|
60
|
+
class WeblogController < ActionController::Base
|
61
|
+
def destroy
|
62
|
+
@weblog = Weblog.find(params[:id])
|
63
|
+
@weblog.destroy
|
64
|
+
logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
|
65
|
+
end
|
66
|
+
end
|
67
|
+
|
68
|
+
The result will be a message in your log file along the lines of:
|
69
|
+
|
70
|
+
Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
|
71
|
+
|
72
|
+
More information on how to use the logger is at http://www.ruby-doc.org/core/
|
73
|
+
|
74
|
+
Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
|
75
|
+
several books available online as well:
|
76
|
+
|
77
|
+
* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
|
78
|
+
* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
|
79
|
+
|
80
|
+
These two books will bring you up to speed on the Ruby language and also on
|
81
|
+
programming in general.
|
82
|
+
|
83
|
+
|
84
|
+
== Debugger
|
85
|
+
|
86
|
+
Debugger support is available through the debugger command when you start your
|
87
|
+
Mongrel or WEBrick server with --debugger. This means that you can break out of
|
88
|
+
execution at any point in the code, investigate and change the model, and then,
|
89
|
+
resume execution! You need to install ruby-debug to run the server in debugging
|
90
|
+
mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
|
91
|
+
|
92
|
+
class WeblogController < ActionController::Base
|
93
|
+
def index
|
94
|
+
@posts = Post.all
|
95
|
+
debugger
|
96
|
+
end
|
97
|
+
end
|
98
|
+
|
99
|
+
So the controller will accept the action, run the first line, then present you
|
100
|
+
with a IRB prompt in the server window. Here you can do things like:
|
101
|
+
|
102
|
+
>> @posts.inspect
|
103
|
+
=> "[#<Post:0x14a6be8
|
104
|
+
@attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
|
105
|
+
#<Post:0x14a6620
|
106
|
+
@attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
|
107
|
+
>> @posts.first.title = "hello from a debugger"
|
108
|
+
=> "hello from a debugger"
|
109
|
+
|
110
|
+
...and even better, you can examine how your runtime objects actually work:
|
111
|
+
|
112
|
+
>> f = @posts.first
|
113
|
+
=> #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
|
114
|
+
>> f.
|
115
|
+
Display all 152 possibilities? (y or n)
|
116
|
+
|
117
|
+
Finally, when you're ready to resume execution, you can enter "cont".
|
118
|
+
|
119
|
+
|
120
|
+
== Console
|
121
|
+
|
122
|
+
The console is a Ruby shell, which allows you to interact with your
|
123
|
+
application's domain model. Here you'll have all parts of the application
|
124
|
+
configured, just like it is when the application is running. You can inspect
|
125
|
+
domain models, change values, and save to the database. Starting the script
|
126
|
+
without arguments will launch it in the development environment.
|
127
|
+
|
128
|
+
To start the console, run <tt>rails console</tt> from the application
|
129
|
+
directory.
|
130
|
+
|
131
|
+
Options:
|
132
|
+
|
133
|
+
* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
|
134
|
+
made to the database.
|
135
|
+
* Passing an environment name as an argument will load the corresponding
|
136
|
+
environment. Example: <tt>rails console production</tt>.
|
137
|
+
|
138
|
+
To reload your controllers and models after launching the console run
|
139
|
+
<tt>reload!</tt>
|
140
|
+
|
141
|
+
More information about irb can be found at:
|
142
|
+
link:http://www.rubycentral.org/pickaxe/irb.html
|
143
|
+
|
144
|
+
|
145
|
+
== dbconsole
|
146
|
+
|
147
|
+
You can go to the command line of your database directly through <tt>rails
|
148
|
+
dbconsole</tt>. You would be connected to the database with the credentials
|
149
|
+
defined in database.yml. Starting the script without arguments will connect you
|
150
|
+
to the development database. Passing an argument will connect you to a different
|
151
|
+
database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
|
152
|
+
PostgreSQL and SQLite 3.
|
153
|
+
|
154
|
+
== Description of Contents
|
155
|
+
|
156
|
+
The default directory structure of a generated Ruby on Rails application:
|
157
|
+
|
158
|
+
|-- app
|
159
|
+
| |-- assets
|
160
|
+
| | |-- images
|
161
|
+
| | |-- javascripts
|
162
|
+
| | `-- stylesheets
|
163
|
+
| |-- controllers
|
164
|
+
| |-- helpers
|
165
|
+
| |-- mailers
|
166
|
+
| |-- models
|
167
|
+
| `-- views
|
168
|
+
| `-- layouts
|
169
|
+
|-- config
|
170
|
+
| |-- environments
|
171
|
+
| |-- initializers
|
172
|
+
| `-- locales
|
173
|
+
|-- db
|
174
|
+
|-- doc
|
175
|
+
|-- lib
|
176
|
+
| |-- assets
|
177
|
+
| `-- tasks
|
178
|
+
|-- log
|
179
|
+
|-- public
|
180
|
+
|-- script
|
181
|
+
|-- test
|
182
|
+
| |-- fixtures
|
183
|
+
| |-- functional
|
184
|
+
| |-- integration
|
185
|
+
| |-- performance
|
186
|
+
| `-- unit
|
187
|
+
|-- tmp
|
188
|
+
| `-- cache
|
189
|
+
| `-- assets
|
190
|
+
`-- vendor
|
191
|
+
|-- assets
|
192
|
+
| |-- javascripts
|
193
|
+
| `-- stylesheets
|
194
|
+
`-- plugins
|
195
|
+
|
196
|
+
app
|
197
|
+
Holds all the code that's specific to this particular application.
|
198
|
+
|
199
|
+
app/assets
|
200
|
+
Contains subdirectories for images, stylesheets, and JavaScript files.
|
201
|
+
|
202
|
+
app/controllers
|
203
|
+
Holds controllers that should be named like weblogs_controller.rb for
|
204
|
+
automated URL mapping. All controllers should descend from
|
205
|
+
ApplicationController which itself descends from ActionController::Base.
|
206
|
+
|
207
|
+
app/models
|
208
|
+
Holds models that should be named like post.rb. Models descend from
|
209
|
+
ActiveRecord::Base by default.
|
210
|
+
|
211
|
+
app/views
|
212
|
+
Holds the template files for the view that should be named like
|
213
|
+
weblogs/index.html.erb for the WeblogsController#index action. All views use
|
214
|
+
eRuby syntax by default.
|
215
|
+
|
216
|
+
app/views/layouts
|
217
|
+
Holds the template files for layouts to be used with views. This models the
|
218
|
+
common header/footer method of wrapping views. In your views, define a layout
|
219
|
+
using the <tt>layout :default</tt> and create a file named default.html.erb.
|
220
|
+
Inside default.html.erb, call <% yield %> to render the view using this
|
221
|
+
layout.
|
222
|
+
|
223
|
+
app/helpers
|
224
|
+
Holds view helpers that should be named like weblogs_helper.rb. These are
|
225
|
+
generated for you automatically when using generators for controllers.
|
226
|
+
Helpers can be used to wrap functionality for your views into methods.
|
227
|
+
|
228
|
+
config
|
229
|
+
Configuration files for the Rails environment, the routing map, the database,
|
230
|
+
and other dependencies.
|
231
|
+
|
232
|
+
db
|
233
|
+
Contains the database schema in schema.rb. db/migrate contains all the
|
234
|
+
sequence of Migrations for your schema.
|
235
|
+
|
236
|
+
doc
|
237
|
+
This directory is where your application documentation will be stored when
|
238
|
+
generated using <tt>rake doc:app</tt>
|
239
|
+
|
240
|
+
lib
|
241
|
+
Application specific libraries. Basically, any kind of custom code that
|
242
|
+
doesn't belong under controllers, models, or helpers. This directory is in
|
243
|
+
the load path.
|
244
|
+
|
245
|
+
public
|
246
|
+
The directory available for the web server. Also contains the dispatchers and the
|
247
|
+
default HTML files. This should be set as the DOCUMENT_ROOT of your web
|
248
|
+
server.
|
249
|
+
|
250
|
+
script
|
251
|
+
Helper scripts for automation and generation.
|
252
|
+
|
253
|
+
test
|
254
|
+
Unit and functional tests along with fixtures. When using the rails generate
|
255
|
+
command, template test files will be generated for you and placed in this
|
256
|
+
directory.
|
257
|
+
|
258
|
+
vendor
|
259
|
+
External libraries that the application depends on. Also includes the plugins
|
260
|
+
subdirectory. If the app has frozen rails, those gems also go here, under
|
261
|
+
vendor/rails/. This directory is in the load path.
|