rails3-jquery-autocomplete 0.6.0 → 0.6.1
Sign up to get free protection for your applications and to get access to all the features.
- data/.document +5 -0
- data/.gitignore +24 -0
- data/Gemfile +18 -0
- data/Gemfile.lock +96 -0
- data/README.markdown +16 -1
- data/Rakefile +2 -47
- data/integration/.gitignore +2 -0
- data/integration/Gemfile +14 -0
- data/integration/Gemfile.lock +159 -0
- data/integration/README +256 -0
- data/integration/Rakefile +7 -0
- data/integration/app/controllers/application_controller.rb +3 -0
- data/integration/app/controllers/autocomplete_controller.rb +7 -0
- data/integration/app/controllers/id_elements_controller.rb +8 -0
- data/integration/app/controllers/multiple_selections_controller.rb +7 -0
- data/integration/app/controllers/sub_classes_controller.rb +7 -0
- data/integration/app/helpers/application_helper.rb +2 -0
- data/integration/app/helpers/autocomplete_helper.rb +2 -0
- data/integration/app/helpers/error_messages_helper.rb +23 -0
- data/integration/app/helpers/id_elements_helper.rb +2 -0
- data/integration/app/helpers/layout_helper.rb +22 -0
- data/integration/app/helpers/sub_classes_helper.rb +2 -0
- data/integration/app/models/brand.rb +2 -0
- data/integration/app/models/foreign_brand.rb +3 -0
- data/integration/app/models/product.rb +3 -0
- data/integration/app/views/autocomplete/new.html.haml +10 -0
- data/integration/app/views/id_elements/new.html.haml +12 -0
- data/integration/app/views/layouts/application.html.haml +21 -0
- data/integration/app/views/multiple_selections/new.html.haml +9 -0
- data/integration/app/views/sub_classes/new.html.haml +9 -0
- data/integration/config.ru +4 -0
- data/integration/config/application.rb +42 -0
- data/integration/config/boot.rb +13 -0
- data/integration/config/cucumber.yml +8 -0
- data/integration/config/database.yml +25 -0
- data/integration/config/environment.rb +5 -0
- data/integration/config/environments/development.rb +26 -0
- data/integration/config/environments/production.rb +49 -0
- data/integration/config/environments/test.rb +35 -0
- data/integration/config/initializers/backtrace_silencers.rb +7 -0
- data/integration/config/initializers/inflections.rb +10 -0
- data/integration/config/initializers/mime_types.rb +5 -0
- data/integration/config/initializers/secret_token.rb +7 -0
- data/integration/config/initializers/session_store.rb +8 -0
- data/integration/config/locales/en.yml +5 -0
- data/integration/config/routes.rb +18 -0
- data/integration/db/migrate/20101209014338_create_brands.rb +13 -0
- data/integration/db/migrate/20101209014355_create_products.rb +14 -0
- data/integration/db/migrate/20101209053936_add_type_to_brand.rb +9 -0
- data/integration/db/schema.rb +29 -0
- data/integration/db/seeds.rb +3 -0
- data/integration/doc/README_FOR_APP +2 -0
- data/integration/features/autocomplete.feature +45 -0
- data/integration/features/step_definitions/autocomplete_steps.rb +5 -0
- data/integration/features/step_definitions/pickle_steps.rb +100 -0
- data/integration/features/step_definitions/web_steps.rb +219 -0
- data/integration/features/support/env.rb +62 -0
- data/integration/features/support/paths.rb +33 -0
- data/integration/features/support/pickle.rb +24 -0
- data/integration/lib/tasks/cucumber.rake +53 -0
- data/integration/public/404.html +26 -0
- data/integration/public/422.html +26 -0
- data/integration/public/500.html +26 -0
- data/integration/public/favicon.ico +0 -0
- data/integration/public/images/rails.png +0 -0
- data/integration/public/javascripts/application.js +0 -0
- data/integration/public/javascripts/autocomplete-rails.js +91 -0
- data/integration/public/javascripts/jquery-ui.js +11437 -0
- data/integration/public/javascripts/jquery-ui.min.js +401 -0
- data/integration/public/javascripts/jquery.js +7179 -0
- data/integration/public/javascripts/jquery.min.js +167 -0
- data/integration/public/javascripts/rails.js +163 -0
- data/integration/public/robots.txt +5 -0
- data/integration/public/stylesheets/application.css +61 -0
- data/integration/public/stylesheets/jquery-ui-1.8.2.custom.css +489 -0
- data/integration/public/stylesheets/sass/application.sass +66 -0
- data/integration/script/cucumber +10 -0
- data/integration/script/rails +6 -0
- data/lib/generators/templates/autocomplete-rails.js +1 -1
- data/lib/rails3-jquery-autocomplete/autocomplete.rb +3 -1
- data/lib/rails3-jquery-autocomplete/version.rb +3 -0
- data/rails3-jquery-autocomplete.gemspec +28 -0
- metadata +165 -12
data/.document
ADDED
data/.gitignore
ADDED
data/Gemfile
ADDED
@@ -0,0 +1,18 @@
|
|
1
|
+
#A sample Gemfile
|
2
|
+
#source :gemcutter
|
3
|
+
|
4
|
+
#gem 'rails', '~>3.0.0'
|
5
|
+
#gem 'sqlite3-ruby'
|
6
|
+
#gem 'jeweler'
|
7
|
+
#gem 'reek'
|
8
|
+
#gem 'mongoid', '>= 2.0.0.beta.17'
|
9
|
+
#gem 'formtastic'
|
10
|
+
|
11
|
+
#group :test do
|
12
|
+
#gem 'shoulda', '2.11.1'
|
13
|
+
#gem 'redgreen'
|
14
|
+
#end
|
15
|
+
#
|
16
|
+
source "http://rubygems.org"
|
17
|
+
|
18
|
+
gemspec
|
data/Gemfile.lock
ADDED
@@ -0,0 +1,96 @@
|
|
1
|
+
PATH
|
2
|
+
remote: .
|
3
|
+
specs:
|
4
|
+
rails3-jquery-autocomplete (0.6.0)
|
5
|
+
rails (~> 3.0.0)
|
6
|
+
|
7
|
+
GEM
|
8
|
+
remote: http://rubygems.org/
|
9
|
+
specs:
|
10
|
+
abstract (1.0.0)
|
11
|
+
actionmailer (3.0.3)
|
12
|
+
actionpack (= 3.0.3)
|
13
|
+
mail (~> 2.2.9)
|
14
|
+
actionpack (3.0.3)
|
15
|
+
activemodel (= 3.0.3)
|
16
|
+
activesupport (= 3.0.3)
|
17
|
+
builder (~> 2.1.2)
|
18
|
+
erubis (~> 2.6.6)
|
19
|
+
i18n (~> 0.4)
|
20
|
+
rack (~> 1.2.1)
|
21
|
+
rack-mount (~> 0.6.13)
|
22
|
+
rack-test (~> 0.5.6)
|
23
|
+
tzinfo (~> 0.3.23)
|
24
|
+
activemodel (3.0.3)
|
25
|
+
activesupport (= 3.0.3)
|
26
|
+
builder (~> 2.1.2)
|
27
|
+
i18n (~> 0.4)
|
28
|
+
activerecord (3.0.3)
|
29
|
+
activemodel (= 3.0.3)
|
30
|
+
activesupport (= 3.0.3)
|
31
|
+
arel (~> 2.0.2)
|
32
|
+
tzinfo (~> 0.3.23)
|
33
|
+
activeresource (3.0.3)
|
34
|
+
activemodel (= 3.0.3)
|
35
|
+
activesupport (= 3.0.3)
|
36
|
+
activesupport (3.0.3)
|
37
|
+
arel (2.0.6)
|
38
|
+
bson (1.1.4)
|
39
|
+
builder (2.1.2)
|
40
|
+
erubis (2.6.6)
|
41
|
+
abstract (>= 1.0.0)
|
42
|
+
i18n (0.5.0)
|
43
|
+
json (1.4.6)
|
44
|
+
mail (2.2.12)
|
45
|
+
activesupport (>= 2.3.6)
|
46
|
+
i18n (>= 0.4.0)
|
47
|
+
mime-types (~> 1.16)
|
48
|
+
treetop (~> 1.4.8)
|
49
|
+
mime-types (1.16)
|
50
|
+
mongo (1.1.4)
|
51
|
+
bson (>= 1.1.1)
|
52
|
+
mongoid (2.0.0.beta.20)
|
53
|
+
activemodel (~> 3.0)
|
54
|
+
mongo (~> 1.1)
|
55
|
+
tzinfo (~> 0.3.22)
|
56
|
+
will_paginate (~> 3.0.pre)
|
57
|
+
polyglot (0.3.1)
|
58
|
+
rack (1.2.1)
|
59
|
+
rack-mount (0.6.13)
|
60
|
+
rack (>= 1.0.0)
|
61
|
+
rack-test (0.5.6)
|
62
|
+
rack (>= 1.0)
|
63
|
+
rails (3.0.3)
|
64
|
+
actionmailer (= 3.0.3)
|
65
|
+
actionpack (= 3.0.3)
|
66
|
+
activerecord (= 3.0.3)
|
67
|
+
activeresource (= 3.0.3)
|
68
|
+
activesupport (= 3.0.3)
|
69
|
+
bundler (~> 1.0)
|
70
|
+
railties (= 3.0.3)
|
71
|
+
railties (3.0.3)
|
72
|
+
actionpack (= 3.0.3)
|
73
|
+
activesupport (= 3.0.3)
|
74
|
+
rake (>= 0.8.7)
|
75
|
+
thor (~> 0.14.4)
|
76
|
+
rake (0.8.7)
|
77
|
+
redgreen (1.2.2)
|
78
|
+
shoulda (2.11.3)
|
79
|
+
sqlite3-ruby (1.3.2)
|
80
|
+
thor (0.14.6)
|
81
|
+
treetop (1.4.9)
|
82
|
+
polyglot (>= 0.3.1)
|
83
|
+
tzinfo (0.3.23)
|
84
|
+
will_paginate (3.0.pre2)
|
85
|
+
|
86
|
+
PLATFORMS
|
87
|
+
ruby
|
88
|
+
|
89
|
+
DEPENDENCIES
|
90
|
+
json
|
91
|
+
mongoid (>= 2.0.0.beta.17)
|
92
|
+
rails (~> 3.0.0)
|
93
|
+
rails3-jquery-autocomplete!
|
94
|
+
redgreen
|
95
|
+
shoulda (~> 2.11.1)
|
96
|
+
sqlite3-ruby
|
data/README.markdown
CHANGED
@@ -171,7 +171,7 @@ The only difference with the original helper is that you must specify the autoco
|
|
171
171
|
I have created a step to test your autocomplete with Cucumber and Capybara, all you have to do is add the following lines to your *env.rb* file:
|
172
172
|
|
173
173
|
require 'cucumber/autocomplete'
|
174
|
-
|
174
|
+
|
175
175
|
Then you'll have access to the following step:
|
176
176
|
|
177
177
|
I choose "([^"]*)" in the autocomplete list
|
@@ -208,8 +208,23 @@ You need to have an instance of MongoDB running on your computer or all the mong
|
|
208
208
|
|
209
209
|
rake test
|
210
210
|
|
211
|
+
## Integration tests
|
212
|
+
|
213
|
+
If you make changes or add features to the jQuery part, please make sure
|
214
|
+
you write a cucumber test for it.
|
215
|
+
|
216
|
+
You can find an example Rails app on the *integration* folder.
|
217
|
+
|
218
|
+
You can run the integration tests with the cucumber command while on the
|
219
|
+
integration folder:
|
220
|
+
|
221
|
+
cd integration
|
222
|
+
cucumber
|
223
|
+
|
211
224
|
# Changelog
|
212
225
|
|
226
|
+
* 0.6.1 Allow specifying fully qualified class name for model object as an option to autocomplete
|
227
|
+
* 0.6.0 JS Code cleanup
|
213
228
|
* 0.5.1 Add STI support
|
214
229
|
* 0.5.0 Formtastic support
|
215
230
|
* 0.4.0 MongoID support
|
data/Rakefile
CHANGED
@@ -1,23 +1,5 @@
|
|
1
|
-
require '
|
2
|
-
|
3
|
-
|
4
|
-
begin
|
5
|
-
require 'jeweler'
|
6
|
-
Jeweler::Tasks.new do |gem|
|
7
|
-
gem.name = "rails3-jquery-autocomplete"
|
8
|
-
gem.summary = %Q{Use jQuery's autocomplete plugin with Rails 3.}
|
9
|
-
gem.description = %Q{Use jQuery's autocomplete plugin with Rails 3.}
|
10
|
-
gem.email = "david.padilla@crowdint.com"
|
11
|
-
gem.homepage = "http://github.com/crowdint/rails3-jquery-autocomplete"
|
12
|
-
gem.authors = ["David Padilla"]
|
13
|
-
gem.add_development_dependency "rails", ">= 3.0.0"
|
14
|
-
gem.files = %w(README.markdown Rakefile) + Dir.glob("{lib,test}/**/*")
|
15
|
-
|
16
|
-
end
|
17
|
-
Jeweler::GemcutterTasks.new
|
18
|
-
rescue LoadError
|
19
|
-
puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
|
20
|
-
end
|
1
|
+
require 'bundler'
|
2
|
+
Bundler::GemHelper.install_tasks
|
21
3
|
|
22
4
|
require 'rake/testtask'
|
23
5
|
Rake::TestTask.new(:test) do |test|
|
@@ -25,30 +7,3 @@ Rake::TestTask.new(:test) do |test|
|
|
25
7
|
test.pattern = 'test/**/*_test.rb'
|
26
8
|
test.verbose = true
|
27
9
|
end
|
28
|
-
|
29
|
-
begin
|
30
|
-
require 'rcov/rcovtask'
|
31
|
-
Rcov::RcovTask.new do |test|
|
32
|
-
test.libs << 'test'
|
33
|
-
test.pattern = 'test/**/test_*.rb'
|
34
|
-
test.verbose = true
|
35
|
-
end
|
36
|
-
rescue LoadError
|
37
|
-
task :rcov do
|
38
|
-
abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
|
39
|
-
end
|
40
|
-
end
|
41
|
-
|
42
|
-
task :test => :check_dependencies
|
43
|
-
|
44
|
-
task :default => :test
|
45
|
-
|
46
|
-
require 'rake/rdoctask'
|
47
|
-
Rake::RDocTask.new do |rdoc|
|
48
|
-
version = File.exist?('VERSION') ? File.read('VERSION') : ""
|
49
|
-
|
50
|
-
rdoc.rdoc_dir = 'rdoc'
|
51
|
-
rdoc.title = "rails3-jquery-autocomplete #{version}"
|
52
|
-
rdoc.rdoc_files.include('README*')
|
53
|
-
rdoc.rdoc_files.include('lib/**/*.rb')
|
54
|
-
end
|
data/integration/Gemfile
ADDED
@@ -0,0 +1,14 @@
|
|
1
|
+
source 'http://rubygems.org'
|
2
|
+
|
3
|
+
gem 'rails', '~>3.0.3'
|
4
|
+
|
5
|
+
gem 'sqlite3-ruby', :require => 'sqlite3'
|
6
|
+
gem 'cucumber-rails', '~>0.3.2'
|
7
|
+
gem 'capybara', '~>0.4.0'
|
8
|
+
gem 'rails3-jquery-autocomplete', :path => '../'
|
9
|
+
gem 'nifty-generators'
|
10
|
+
gem 'haml-rails'
|
11
|
+
gem 'jquery-rails'
|
12
|
+
gem 'pickle'
|
13
|
+
gem 'database_cleaner'
|
14
|
+
gem 'send-keys', :git => 'git@github.com:crowdint/send-keys.git'
|
@@ -0,0 +1,159 @@
|
|
1
|
+
GIT
|
2
|
+
remote: git@github.com:crowdint/send-keys.git
|
3
|
+
revision: 23080296ce7f582c04a4818aec015fc854e2303d
|
4
|
+
specs:
|
5
|
+
send-keys (0.1.0)
|
6
|
+
capybara
|
7
|
+
|
8
|
+
PATH
|
9
|
+
remote: /Users/dab/gems/rails3-jquery-autocomplete
|
10
|
+
specs:
|
11
|
+
rails3-jquery-autocomplete (0.6.0)
|
12
|
+
rails (~> 3.0.0)
|
13
|
+
|
14
|
+
GEM
|
15
|
+
remote: http://rubygems.org/
|
16
|
+
specs:
|
17
|
+
abstract (1.0.0)
|
18
|
+
actionmailer (3.0.3)
|
19
|
+
actionpack (= 3.0.3)
|
20
|
+
mail (~> 2.2.9)
|
21
|
+
actionpack (3.0.3)
|
22
|
+
activemodel (= 3.0.3)
|
23
|
+
activesupport (= 3.0.3)
|
24
|
+
builder (~> 2.1.2)
|
25
|
+
erubis (~> 2.6.6)
|
26
|
+
i18n (~> 0.4)
|
27
|
+
rack (~> 1.2.1)
|
28
|
+
rack-mount (~> 0.6.13)
|
29
|
+
rack-test (~> 0.5.6)
|
30
|
+
tzinfo (~> 0.3.23)
|
31
|
+
activemodel (3.0.3)
|
32
|
+
activesupport (= 3.0.3)
|
33
|
+
builder (~> 2.1.2)
|
34
|
+
i18n (~> 0.4)
|
35
|
+
activerecord (3.0.3)
|
36
|
+
activemodel (= 3.0.3)
|
37
|
+
activesupport (= 3.0.3)
|
38
|
+
arel (~> 2.0.2)
|
39
|
+
tzinfo (~> 0.3.23)
|
40
|
+
activeresource (3.0.3)
|
41
|
+
activemodel (= 3.0.3)
|
42
|
+
activesupport (= 3.0.3)
|
43
|
+
activesupport (3.0.3)
|
44
|
+
arel (2.0.6)
|
45
|
+
builder (2.1.2)
|
46
|
+
capybara (0.4.0)
|
47
|
+
celerity (>= 0.7.9)
|
48
|
+
culerity (>= 0.2.4)
|
49
|
+
mime-types (>= 1.16)
|
50
|
+
nokogiri (>= 1.3.3)
|
51
|
+
rack (>= 1.0.0)
|
52
|
+
rack-test (>= 0.5.4)
|
53
|
+
selenium-webdriver (>= 0.0.27)
|
54
|
+
xpath (~> 0.1.2)
|
55
|
+
celerity (0.8.5)
|
56
|
+
childprocess (0.1.4)
|
57
|
+
ffi (~> 0.6.3)
|
58
|
+
cucumber (0.10.0)
|
59
|
+
builder (>= 2.1.2)
|
60
|
+
diff-lcs (~> 1.1.2)
|
61
|
+
gherkin (~> 2.3.2)
|
62
|
+
json (~> 1.4.6)
|
63
|
+
term-ansicolor (~> 1.0.5)
|
64
|
+
cucumber-rails (0.3.2)
|
65
|
+
cucumber (>= 0.8.0)
|
66
|
+
culerity (0.2.12)
|
67
|
+
database_cleaner (0.6.0)
|
68
|
+
diff-lcs (1.1.2)
|
69
|
+
erubis (2.6.6)
|
70
|
+
abstract (>= 1.0.0)
|
71
|
+
ffi (0.6.3)
|
72
|
+
rake (>= 0.8.7)
|
73
|
+
gherkin (2.3.2)
|
74
|
+
json (~> 1.4.6)
|
75
|
+
term-ansicolor (~> 1.0.5)
|
76
|
+
haml (3.0.24)
|
77
|
+
haml-rails (0.3.4)
|
78
|
+
actionpack (~> 3.0)
|
79
|
+
activesupport (~> 3.0)
|
80
|
+
haml (~> 3.0)
|
81
|
+
railties (~> 3.0)
|
82
|
+
i18n (0.5.0)
|
83
|
+
jquery-rails (0.2.6)
|
84
|
+
rails (~> 3.0)
|
85
|
+
thor (~> 0.14.4)
|
86
|
+
json (1.4.6)
|
87
|
+
json_pure (1.4.6)
|
88
|
+
mail (2.2.12)
|
89
|
+
activesupport (>= 2.3.6)
|
90
|
+
i18n (>= 0.4.0)
|
91
|
+
mime-types (~> 1.16)
|
92
|
+
treetop (~> 1.4.8)
|
93
|
+
mime-types (1.16)
|
94
|
+
nifty-generators (0.4.2)
|
95
|
+
nokogiri (1.4.4)
|
96
|
+
pickle (0.4.3)
|
97
|
+
cucumber (>= 0.8)
|
98
|
+
rake
|
99
|
+
rspec (>= 1.3)
|
100
|
+
yard
|
101
|
+
polyglot (0.3.1)
|
102
|
+
rack (1.2.1)
|
103
|
+
rack-mount (0.6.13)
|
104
|
+
rack (>= 1.0.0)
|
105
|
+
rack-test (0.5.6)
|
106
|
+
rack (>= 1.0)
|
107
|
+
rails (3.0.3)
|
108
|
+
actionmailer (= 3.0.3)
|
109
|
+
actionpack (= 3.0.3)
|
110
|
+
activerecord (= 3.0.3)
|
111
|
+
activeresource (= 3.0.3)
|
112
|
+
activesupport (= 3.0.3)
|
113
|
+
bundler (~> 1.0)
|
114
|
+
railties (= 3.0.3)
|
115
|
+
railties (3.0.3)
|
116
|
+
actionpack (= 3.0.3)
|
117
|
+
activesupport (= 3.0.3)
|
118
|
+
rake (>= 0.8.7)
|
119
|
+
thor (~> 0.14.4)
|
120
|
+
rake (0.8.7)
|
121
|
+
rspec (2.2.0)
|
122
|
+
rspec-core (~> 2.2)
|
123
|
+
rspec-expectations (~> 2.2)
|
124
|
+
rspec-mocks (~> 2.2)
|
125
|
+
rspec-core (2.2.1)
|
126
|
+
rspec-expectations (2.2.0)
|
127
|
+
diff-lcs (~> 1.1.2)
|
128
|
+
rspec-mocks (2.2.0)
|
129
|
+
rubyzip (0.9.4)
|
130
|
+
selenium-webdriver (0.1.1)
|
131
|
+
childprocess (= 0.1.4)
|
132
|
+
ffi (~> 0.6.3)
|
133
|
+
json_pure
|
134
|
+
rubyzip
|
135
|
+
sqlite3-ruby (1.3.2)
|
136
|
+
term-ansicolor (1.0.5)
|
137
|
+
thor (0.14.6)
|
138
|
+
treetop (1.4.9)
|
139
|
+
polyglot (>= 0.3.1)
|
140
|
+
tzinfo (0.3.23)
|
141
|
+
xpath (0.1.2)
|
142
|
+
nokogiri (~> 1.3)
|
143
|
+
yard (0.6.3)
|
144
|
+
|
145
|
+
PLATFORMS
|
146
|
+
ruby
|
147
|
+
|
148
|
+
DEPENDENCIES
|
149
|
+
capybara (~> 0.4.0)
|
150
|
+
cucumber-rails (~> 0.3.2)
|
151
|
+
database_cleaner
|
152
|
+
haml-rails
|
153
|
+
jquery-rails
|
154
|
+
nifty-generators
|
155
|
+
pickle
|
156
|
+
rails (~> 3.0.3)
|
157
|
+
rails3-jquery-autocomplete!
|
158
|
+
send-keys!
|
159
|
+
sqlite3-ruby
|
data/integration/README
ADDED
@@ -0,0 +1,256 @@
|
|
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.find(: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.com/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
|
+
| |-- controllers
|
160
|
+
| |-- helpers
|
161
|
+
| |-- mailers
|
162
|
+
| |-- models
|
163
|
+
| `-- views
|
164
|
+
| `-- layouts
|
165
|
+
|-- config
|
166
|
+
| |-- environments
|
167
|
+
| |-- initializers
|
168
|
+
| `-- locales
|
169
|
+
|-- db
|
170
|
+
|-- doc
|
171
|
+
|-- lib
|
172
|
+
| `-- tasks
|
173
|
+
|-- log
|
174
|
+
|-- public
|
175
|
+
| |-- images
|
176
|
+
| |-- javascripts
|
177
|
+
| `-- stylesheets
|
178
|
+
|-- script
|
179
|
+
|-- test
|
180
|
+
| |-- fixtures
|
181
|
+
| |-- functional
|
182
|
+
| |-- integration
|
183
|
+
| |-- performance
|
184
|
+
| `-- unit
|
185
|
+
|-- tmp
|
186
|
+
| |-- cache
|
187
|
+
| |-- pids
|
188
|
+
| |-- sessions
|
189
|
+
| `-- sockets
|
190
|
+
`-- vendor
|
191
|
+
`-- plugins
|
192
|
+
|
193
|
+
app
|
194
|
+
Holds all the code that's specific to this particular application.
|
195
|
+
|
196
|
+
app/controllers
|
197
|
+
Holds controllers that should be named like weblogs_controller.rb for
|
198
|
+
automated URL mapping. All controllers should descend from
|
199
|
+
ApplicationController which itself descends from ActionController::Base.
|
200
|
+
|
201
|
+
app/models
|
202
|
+
Holds models that should be named like post.rb. Models descend from
|
203
|
+
ActiveRecord::Base by default.
|
204
|
+
|
205
|
+
app/views
|
206
|
+
Holds the template files for the view that should be named like
|
207
|
+
weblogs/index.html.erb for the WeblogsController#index action. All views use
|
208
|
+
eRuby syntax by default.
|
209
|
+
|
210
|
+
app/views/layouts
|
211
|
+
Holds the template files for layouts to be used with views. This models the
|
212
|
+
common header/footer method of wrapping views. In your views, define a layout
|
213
|
+
using the <tt>layout :default</tt> and create a file named default.html.erb.
|
214
|
+
Inside default.html.erb, call <% yield %> to render the view using this
|
215
|
+
layout.
|
216
|
+
|
217
|
+
app/helpers
|
218
|
+
Holds view helpers that should be named like weblogs_helper.rb. These are
|
219
|
+
generated for you automatically when using generators for controllers.
|
220
|
+
Helpers can be used to wrap functionality for your views into methods.
|
221
|
+
|
222
|
+
config
|
223
|
+
Configuration files for the Rails environment, the routing map, the database,
|
224
|
+
and other dependencies.
|
225
|
+
|
226
|
+
db
|
227
|
+
Contains the database schema in schema.rb. db/migrate contains all the
|
228
|
+
sequence of Migrations for your schema.
|
229
|
+
|
230
|
+
doc
|
231
|
+
This directory is where your application documentation will be stored when
|
232
|
+
generated using <tt>rake doc:app</tt>
|
233
|
+
|
234
|
+
lib
|
235
|
+
Application specific libraries. Basically, any kind of custom code that
|
236
|
+
doesn't belong under controllers, models, or helpers. This directory is in
|
237
|
+
the load path.
|
238
|
+
|
239
|
+
public
|
240
|
+
The directory available for the web server. Contains subdirectories for
|
241
|
+
images, stylesheets, and javascripts. Also contains the dispatchers and the
|
242
|
+
default HTML files. This should be set as the DOCUMENT_ROOT of your web
|
243
|
+
server.
|
244
|
+
|
245
|
+
script
|
246
|
+
Helper scripts for automation and generation.
|
247
|
+
|
248
|
+
test
|
249
|
+
Unit and functional tests along with fixtures. When using the rails generate
|
250
|
+
command, template test files will be generated for you and placed in this
|
251
|
+
directory.
|
252
|
+
|
253
|
+
vendor
|
254
|
+
External libraries that the application depends on. Also includes the plugins
|
255
|
+
subdirectory. If the app has frozen rails, those gems also go here, under
|
256
|
+
vendor/rails/. This directory is in the load path.
|