role-haml 1.2.1
Sign up to get free protection for your applications and to get access to all the features.
- data/.gitignore +6 -0
- data/.gitmodules +3 -0
- data/Gemfile +6 -0
- data/README.md +140 -0
- data/Rakefile +34 -0
- data/lib/role-haml.rb +2 -0
- data/lib/role-haml/engine.rb +85 -0
- data/lib/role-haml/version.rb +3 -0
- data/role-haml.gemspec +36 -0
- data/test/dummy/README.rdoc +261 -0
- data/test/dummy/Rakefile +7 -0
- data/test/dummy/app/assets/javascripts/application.js +13 -0
- data/test/dummy/app/assets/javascripts/control.jst.skim +5 -0
- data/test/dummy/app/assets/stylesheets/application.css +13 -0
- data/test/dummy/app/controllers/application_controller.rb +9 -0
- data/test/dummy/app/helpers/application_helper.rb +2 -0
- data/test/dummy/app/mailers/.gitkeep +0 -0
- data/test/dummy/app/models/.gitkeep +0 -0
- data/test/dummy/app/views/application/index.html.slim +8 -0
- data/test/dummy/app/views/application/index_h.html.haml +8 -0
- data/test/dummy/app/views/layouts/application.html.erb +14 -0
- data/test/dummy/config.ru +4 -0
- data/test/dummy/config/application.rb +55 -0
- data/test/dummy/config/boot.rb +10 -0
- data/test/dummy/config/database.yml +3 -0
- data/test/dummy/config/environment.rb +5 -0
- data/test/dummy/config/environments/development.rb +37 -0
- data/test/dummy/config/environments/production.rb +67 -0
- data/test/dummy/config/environments/test.rb +37 -0
- data/test/dummy/config/initializers/backtrace_silencers.rb +7 -0
- data/test/dummy/config/initializers/inflections.rb +15 -0
- data/test/dummy/config/initializers/mime_types.rb +5 -0
- data/test/dummy/config/initializers/secret_token.rb +7 -0
- data/test/dummy/config/initializers/session_store.rb +8 -0
- data/test/dummy/config/initializers/wrap_parameters.rb +14 -0
- data/test/dummy/config/locales/en.yml +5 -0
- data/test/dummy/config/routes.rb +4 -0
- data/test/dummy/lib/assets/.gitkeep +0 -0
- data/test/dummy/log/.gitkeep +0 -0
- data/test/dummy/public/404.html +26 -0
- data/test/dummy/public/422.html +26 -0
- data/test/dummy/public/500.html +25 -0
- data/test/dummy/public/favicon.ico +0 -0
- data/test/dummy/script/rails +6 -0
- data/test/helper.rb +20 -0
- data/test/integration/haml_engines_test.rb +15 -0
- data/vendor/assets/javascripts/jquery.role.js +19 -0
- data/vendor/assets/javascripts/jquery.role.min.js +1 -0
- data/vendor/assets/javascripts/role.js +18 -0
- data/vendor/assets/javascripts/role.min.js +1 -0
- metadata +214 -0
data/.gitignore
ADDED
data/.gitmodules
ADDED
data/Gemfile
ADDED
data/README.md
ADDED
@@ -0,0 +1,140 @@
|
|
1
|
+
## This is gem for Haml support for jQuery plugin [role](https://github.com/kossnocorp/role) by [@kossnocorp](https://github.com/kossnocorp)
|
2
|
+
|
3
|
+
Sponsored by [Evil Martians](http://evilmartians.com/).
|
4
|
+
|
5
|
+
## Usage
|
6
|
+
|
7
|
+
`app/views/home/index.html`
|
8
|
+
|
9
|
+
```haml
|
10
|
+
%a@some-role@another-role...
|
11
|
+
```
|
12
|
+
|
13
|
+
Will produce:
|
14
|
+
|
15
|
+
```html
|
16
|
+
<a role='some-role another-role'...
|
17
|
+
```
|
18
|
+
|
19
|
+
## Install
|
20
|
+
|
21
|
+
In your `Gemfile`:
|
22
|
+
|
23
|
+
`gem 'role-haml'`
|
24
|
+
|
25
|
+
## Contributors
|
26
|
+
|
27
|
+
* [@kossnocorp](http://github.com/kossnocorp)
|
28
|
+
* @gazay
|
29
|
+
|
30
|
+
## License
|
31
|
+
|
32
|
+
MIT (look into repo LICENSE)
|
33
|
+
|
34
|
+
# jQuery plagin role readme
|
35
|
+
|
36
|
+
This project uses [Semantic Versioning](http://semver.org/) for release numbering.
|
37
|
+
|
38
|
+
## Downloads
|
39
|
+
|
40
|
+
* [jquery.role.min.js](https://raw.github.com/kossnocorp/role/master/lib/jquery.role.min.js)
|
41
|
+
* [role.min.js](https://raw.github.com/kossnocorp/role/master/lib/jquery.role.min.js)
|
42
|
+
* [jquery.role.js](https://raw.github.com/kossnocorp/role/master/lib/jquery.role.js)
|
43
|
+
* [role.js](https://raw.github.com/kossnocorp/role/master/lib/role.js)
|
44
|
+
|
45
|
+
Also you can add jquery.role.js and role.js by bundle `role-rails` gem. For futher details see *installation* section below.
|
46
|
+
|
47
|
+
## Use `role` attribute FTW
|
48
|
+
|
49
|
+
```
|
50
|
+
Use cases for a role attribute for HTML5, include:
|
51
|
+
|
52
|
+
* accessibility,
|
53
|
+
* device adaptation,
|
54
|
+
* server-side processing, and
|
55
|
+
* complex data description.
|
56
|
+
```
|
57
|
+
|
58
|
+
This is a quote from [W3C Specification on Role attribute](http://www.w3.org/wiki/PF/XTech/HTML5/RoleAttribute#A_Role_Attribute_for_HTML5).
|
59
|
+
|
60
|
+
In [Evil Martians](http://evilmartians.com/) we came up with a way to use this attribute for our own purposes.
|
61
|
+
|
62
|
+
Say you have to update your website page design. HTML markup is done and you have to apply it to the existing site. Of course this marvelous page is crammed with Javascript code tied to an existing structure.
|
63
|
+
|
64
|
+
``` javascript
|
65
|
+
$('.list .item img')
|
66
|
+
.mouseenter(function () {
|
67
|
+
$(this).rotateTo(30, 300)
|
68
|
+
})
|
69
|
+
.mouseleave(function () {
|
70
|
+
$(this).rotateTo(0, 300)
|
71
|
+
});
|
72
|
+
```
|
73
|
+
|
74
|
+
Obviously, you'll have to rewrite all the selectors for the new layout. And it would be nice if you had to fix only one (or even ten) of these selectors. In reality, most likely, there will be several dozen of them.
|
75
|
+
|
76
|
+
Another issue is that refactoring process requires you to change the names or a number of classes. You'll have to muddle through every JS file to find all classes you are going to change.
|
77
|
+
|
78
|
+
And, of course, in both cases the end result is absolutely unpredictable, because layout alone is not enougn to figure out if a class is actualy used in JS.
|
79
|
+
|
80
|
+
The `.js-class_name` prefix use may seem like a good idea, except that someone will surely add styles to this class in a future... Let alone the difficulty to spot, among a large of number of classes, one with a prefix.
|
81
|
+
|
82
|
+
In order to avoid this problems, we can "attach" JS to DOM elements by a `role` attribute.
|
83
|
+
|
84
|
+
It's a lot safer then prefixes, beacause it's much harder to attach styles to `role` and it feals morally difficult to break the `role` use convention.
|
85
|
+
|
86
|
+
With the use of `role`, layout update becomes very straightforward: you just have to add roles to a new element, and if you are not tied to the "magic numbers" -- it will work with no further hassle.
|
87
|
+
|
88
|
+
To make life easier (shoutout to [@alex_chrome](https://twitter.com/#!/alex_chrome) for the great idea) we also extended jQuery selector syntax:
|
89
|
+
|
90
|
+
``` javascript
|
91
|
+
$('@list @item @image')
|
92
|
+
.mouseenter(function () {
|
93
|
+
$(this).rotateTo(30, 300)
|
94
|
+
})
|
95
|
+
.mouseleave(function () {
|
96
|
+
$(this).rotateTo(0, 300)
|
97
|
+
});
|
98
|
+
```
|
99
|
+
|
100
|
+
`$('@list @item @image')` is the same as `$('[role="list"] [role="item] [role="image"]')` and you can use "multirole": `$('@list@coupons')`.
|
101
|
+
|
102
|
+
In addition to the jQuery plug-in, I also wrote a version that extends `querySelectorAll` of [Zepto.js](http://zeptojs.com/) with a Role functionality.
|
103
|
+
|
104
|
+
Using of 'role' in a query may work a bit slower compared to usual selectors, but it's neglectable even in a large number of queries.
|
105
|
+
|
106
|
+
In addition to `role`, I sometimes use `id`, but only in very extraodinary cases — because if there is only single element on a page today, it may happen that there will be a few tomorrow, even if that wasn't planned.
|
107
|
+
|
108
|
+
## Usage
|
109
|
+
|
110
|
+
### Using selectors
|
111
|
+
|
112
|
+
You can use shortcut `@` in jQuery selectors to find elements with roles.
|
113
|
+
|
114
|
+
Will select all elements in document with `role="ajax-link"`:
|
115
|
+
|
116
|
+
``` js
|
117
|
+
$('@ajax-link')
|
118
|
+
```
|
119
|
+
|
120
|
+
Also you can combinate roles:
|
121
|
+
|
122
|
+
`<form role="form login_form"></form>`:
|
123
|
+
|
124
|
+
``` js
|
125
|
+
$('@form@login_form')
|
126
|
+
```
|
127
|
+
|
128
|
+
Will select all forms with "form" as role `<form role="form login_form"></form><form role="form registration_form"></form>`:
|
129
|
+
|
130
|
+
``` js
|
131
|
+
$('@form')
|
132
|
+
```
|
133
|
+
|
134
|
+
You can combine role with other selectors, but that is not recommended:
|
135
|
+
|
136
|
+
`<form class="dark" role="login_form" method="post"></form>`:
|
137
|
+
|
138
|
+
``` js
|
139
|
+
$('form.dark@login_form[method=post]')
|
140
|
+
```
|
data/Rakefile
ADDED
@@ -0,0 +1,34 @@
|
|
1
|
+
#!/usr/bin/env rake
|
2
|
+
require 'bundler/gem_tasks'
|
3
|
+
require 'rake/testtask'
|
4
|
+
require 'rdoc/task'
|
5
|
+
require 'fileutils'
|
6
|
+
|
7
|
+
Rake::TestTask.new(:test) do |test|
|
8
|
+
test.libs << 'lib' << 'test'
|
9
|
+
test.pattern = 'test/**/*_test.rb'
|
10
|
+
test.verbose = true
|
11
|
+
end
|
12
|
+
|
13
|
+
task :default => :test
|
14
|
+
Rake::RDocTask.new do |rdoc|
|
15
|
+
version = RoleHaml::VERSION
|
16
|
+
|
17
|
+
rdoc.rdoc_dir = 'rdoc'
|
18
|
+
rdoc.title = "role-haml #{version}"
|
19
|
+
rdoc.rdoc_files.include('README*')
|
20
|
+
rdoc.rdoc_files.include('lib/**/*.rb')
|
21
|
+
end
|
22
|
+
|
23
|
+
namespace :role do
|
24
|
+
|
25
|
+
desc 'Pull role/master subtree.'
|
26
|
+
task :pull do
|
27
|
+
system "cd role ; git checkout v#{RoleHaml::VERSION}"
|
28
|
+
end
|
29
|
+
|
30
|
+
desc 'Update role assets.'
|
31
|
+
task :update => 'role:pull' do
|
32
|
+
FileUtils.cp_r('role/lib/.', 'vendor/assets/javascripts')
|
33
|
+
end
|
34
|
+
end
|
data/lib/role-haml.rb
ADDED
@@ -0,0 +1,85 @@
|
|
1
|
+
module RoleHaml
|
2
|
+
class Engine < ::Rails::Engine
|
3
|
+
initializer "role-haml.register" do |app|
|
4
|
+
if defined?(Haml::Parser)
|
5
|
+
module Haml::Parser
|
6
|
+
DIV_ROLE = ?@
|
7
|
+
|
8
|
+
private
|
9
|
+
|
10
|
+
original_process_line_method = instance_method :process_line
|
11
|
+
define_method :process_line do |text, index|
|
12
|
+
if text[0] === DIV_ROLE
|
13
|
+
push div(text)
|
14
|
+
else
|
15
|
+
original_process_line_method.bind(self).call(text, index)
|
16
|
+
end
|
17
|
+
end
|
18
|
+
|
19
|
+
def self.parse_class_and_id(list)
|
20
|
+
attributes = {}
|
21
|
+
list.scan(/([#.@])([-:_a-zA-Z0-9]+)/) do |type, property|
|
22
|
+
case type
|
23
|
+
when '.'
|
24
|
+
if attributes['class']
|
25
|
+
attributes['class'] += " "
|
26
|
+
else
|
27
|
+
attributes['class'] = ""
|
28
|
+
end
|
29
|
+
attributes['class'] += property
|
30
|
+
when '#'; attributes['id'] = property
|
31
|
+
when '@'
|
32
|
+
if attributes['role']
|
33
|
+
attributes['role'] += " "
|
34
|
+
else
|
35
|
+
attributes['role'] = ""
|
36
|
+
end
|
37
|
+
attributes['role'] += property
|
38
|
+
end
|
39
|
+
end
|
40
|
+
attributes
|
41
|
+
end
|
42
|
+
|
43
|
+
def parse_tag(line)
|
44
|
+
raise SyntaxError.new("Invalid tag: \"#{line}\".") unless match = line.scan(/%([-:\w]+)([-:\w\.\#\@]*)(.*)/)[0]
|
45
|
+
|
46
|
+
tag_name, attributes, rest = match
|
47
|
+
raise SyntaxError.new("Illegal element: classes and ids must have values.") if attributes =~ /[\.#](\.|#|\z)/
|
48
|
+
|
49
|
+
new_attributes_hash = old_attributes_hash = last_line = nil
|
50
|
+
object_ref = "nil"
|
51
|
+
attributes_hashes = {}
|
52
|
+
while rest
|
53
|
+
case rest[0]
|
54
|
+
when ?{
|
55
|
+
break if old_attributes_hash
|
56
|
+
old_attributes_hash, rest, last_line = parse_old_attributes(rest)
|
57
|
+
attributes_hashes[:old] = old_attributes_hash
|
58
|
+
when ?(
|
59
|
+
break if new_attributes_hash
|
60
|
+
new_attributes_hash, rest, last_line = parse_new_attributes(rest)
|
61
|
+
attributes_hashes[:new] = new_attributes_hash
|
62
|
+
when ?[
|
63
|
+
break unless object_ref == "nil"
|
64
|
+
object_ref, rest = balance(rest, ?[, ?])
|
65
|
+
else; break
|
66
|
+
end
|
67
|
+
end
|
68
|
+
|
69
|
+
if rest
|
70
|
+
nuke_whitespace, action, value = rest.scan(/(<>|><|[><])?([=\/\~&!])?(.*)?/)[0]
|
71
|
+
nuke_whitespace ||= ''
|
72
|
+
nuke_outer_whitespace = nuke_whitespace.include? '>'
|
73
|
+
nuke_inner_whitespace = nuke_whitespace.include? '<'
|
74
|
+
end
|
75
|
+
|
76
|
+
value = value.to_s.strip
|
77
|
+
[tag_name, attributes, attributes_hashes, object_ref, nuke_outer_whitespace,
|
78
|
+
nuke_inner_whitespace, action, value, last_line || @index]
|
79
|
+
end
|
80
|
+
|
81
|
+
end
|
82
|
+
end
|
83
|
+
end
|
84
|
+
end
|
85
|
+
end
|
data/role-haml.gemspec
ADDED
@@ -0,0 +1,36 @@
|
|
1
|
+
# -*- encoding: utf-8 -*-
|
2
|
+
|
3
|
+
require File.expand_path('../lib/role-haml/version', __FILE__)
|
4
|
+
|
5
|
+
Gem::Specification.new do |gem|
|
6
|
+
gem.name = "role-haml"
|
7
|
+
gem.rubyforge_project = "role-haml"
|
8
|
+
gem.version = RoleHaml::VERSION
|
9
|
+
|
10
|
+
gem.authors = ["kossnocorp, gazay"]
|
11
|
+
gem.email = "koss@nocorp.me"
|
12
|
+
gem.date = "2012-03-23"
|
13
|
+
|
14
|
+
gem.description = "Gem for jQuery plugin to provide easy way to handle DOM elements by role attribute"
|
15
|
+
gem.summary = "Gem for jQuery plugin to provide easy way to handle DOM elements by role attribute"
|
16
|
+
gem.homepage = "https://github.com/gazay/role-haml"
|
17
|
+
|
18
|
+
gem.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
|
19
|
+
gem.files = `git ls-files`.split("\n")
|
20
|
+
gem.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
|
21
|
+
|
22
|
+
gem.files.reject! { |fn| fn.include? "vendor/role" }
|
23
|
+
|
24
|
+
gem.licenses = ["MIT"]
|
25
|
+
|
26
|
+
gem.require_paths = ["lib"]
|
27
|
+
|
28
|
+
gem.rubygems_version = "1.8.15"
|
29
|
+
|
30
|
+
gem.add_dependency "rails", ">= 3.1.0"
|
31
|
+
|
32
|
+
gem.add_development_dependency "haml", ">= 3.0.0"
|
33
|
+
gem.add_development_dependency "sqlite3"
|
34
|
+
gem.add_development_dependency "shoulda"
|
35
|
+
gem.add_development_dependency "bundler", ">= 1.0.0"
|
36
|
+
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
|
+
| `-- tasks
|
177
|
+
|-- log
|
178
|
+
|-- public
|
179
|
+
|-- script
|
180
|
+
|-- test
|
181
|
+
| |-- fixtures
|
182
|
+
| |-- functional
|
183
|
+
| |-- integration
|
184
|
+
| |-- performance
|
185
|
+
| `-- unit
|
186
|
+
|-- tmp
|
187
|
+
| |-- cache
|
188
|
+
| |-- pids
|
189
|
+
| |-- sessions
|
190
|
+
| `-- sockets
|
191
|
+
`-- vendor
|
192
|
+
|-- assets
|
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.
|