exlibris-primo 0.1.1 → 0.1.4

Sign up to get free protection for your applications and to get access to all the features.
Files changed (85) hide show
  1. data/README.rdoc +5 -2
  2. data/Rakefile +1 -5
  3. data/lib/exlibris/primo/eshelf.rb +4 -3
  4. data/lib/exlibris/primo/holding.rb +2 -10
  5. data/lib/exlibris/primo/record.rb +11 -6
  6. data/lib/exlibris/primo/searcher.rb +2 -4
  7. data/lib/exlibris/primo/version.rb +2 -2
  8. data/test/exlibris-primo_test.rb +3 -3
  9. data/test/test_helper.rb +33 -7
  10. data/test/unit/eshelf_test.rb +106 -87
  11. data/test/unit/record_test.rb +64 -45
  12. data/test/unit/searcher_benchmarks.rb +20 -28
  13. data/test/unit/searcher_test.rb +298 -273
  14. data/test/unit/web_service_benchmarks.rb +19 -21
  15. data/test/unit/web_service_test.rb +130 -102
  16. data/test/vcr_cassettes/eshelf_add_invalid_records.yml +107 -0
  17. data/test/vcr_cassettes/eshelf_add_same_record_twice.yml +159 -0
  18. data/test/vcr_cassettes/eshelf_add_to_empty_basket.yml +107 -0
  19. data/test/vcr_cassettes/eshelf_add_to_invalid_basket.yml +55 -0
  20. data/test/vcr_cassettes/eshelf_invalid_eshelf.yml +55 -0
  21. data/test/vcr_cassettes/eshelf_invalid_institution.yml +55 -0
  22. data/test/vcr_cassettes/eshelf_valid_eshelf.yml +2553 -0
  23. data/test/vcr_cassettes/eshelf_valid_eshelf_structure.yml +47 -0
  24. data/test/vcr_cassettes/record.yml +212 -0
  25. data/test/vcr_cassettes/record_invalid_record.yml +55 -0
  26. data/test/vcr_cassettes/record_sub_record.yml +212 -0
  27. data/test/vcr_cassettes/record_valid_record.yml +212 -0
  28. data/test/vcr_cassettes/searcher_base_holdings_by_id.yml +212 -0
  29. data/test/vcr_cassettes/searcher_dedupmrg_by_id.yml +347 -0
  30. data/test/vcr_cassettes/searcher_diacritics1_by_id.yml +207 -0
  31. data/test/vcr_cassettes/searcher_diacritics2_by_id.yml +232 -0
  32. data/test/vcr_cassettes/searcher_holdings_by_id.yml +212 -0
  33. data/test/vcr_cassettes/searcher_invalid_id.yml +55 -0
  34. data/test/vcr_cassettes/searcher_rsrcs_by_id.yml +270 -0
  35. data/test/vcr_cassettes/searcher_search_by_isbn.yml +278 -0
  36. data/test/vcr_cassettes/searcher_search_by_issn.yml +297 -0
  37. data/test/vcr_cassettes/searcher_search_by_title_author_genre.yml +671 -0
  38. data/test/vcr_cassettes/searcher_test_bug_1361.yml +224 -0
  39. data/test/vcr_cassettes/searcher_test_problem_by_id.yml +194 -0
  40. data/test/vcr_cassettes/searcher_tocs_by_id.yml +217 -0
  41. data/test/vcr_cassettes/web_service_author_search.yml +1269 -0
  42. data/test/vcr_cassettes/web_service_bogus_200.yml +392 -0
  43. data/test/vcr_cassettes/web_service_brief_search.yml +299 -0
  44. data/test/vcr_cassettes/web_service_get_eshelf.yml +11823 -0
  45. data/test/vcr_cassettes/web_service_get_eshelf_structure_search.yml +47 -0
  46. data/test/vcr_cassettes/web_service_invalid_document.yml +54 -0
  47. data/test/vcr_cassettes/web_service_isbn_search.yml +299 -0
  48. data/test/vcr_cassettes/web_service_issn_search.yml +293 -0
  49. data/test/vcr_cassettes/web_service_problem_document.yml +193 -0
  50. data/test/vcr_cassettes/web_service_single_document.yml +233 -0
  51. data/test/vcr_cassettes/web_service_title_author_genre_search.yml +719 -0
  52. data/test/vcr_cassettes/web_service_title_search.yml +1035 -0
  53. metadata +147 -77
  54. data/lib/tasks/exlibris-primo_tasks.rake +0 -4
  55. data/test/dummy/README.rdoc +0 -261
  56. data/test/dummy/Rakefile +0 -7
  57. data/test/dummy/app/assets/javascripts/application.js +0 -15
  58. data/test/dummy/app/assets/stylesheets/application.css +0 -13
  59. data/test/dummy/app/controllers/application_controller.rb +0 -3
  60. data/test/dummy/app/helpers/application_helper.rb +0 -2
  61. data/test/dummy/app/views/layouts/application.html.erb +0 -14
  62. data/test/dummy/config.ru +0 -4
  63. data/test/dummy/config/application.rb +0 -56
  64. data/test/dummy/config/boot.rb +0 -10
  65. data/test/dummy/config/database.yml +0 -25
  66. data/test/dummy/config/environment.rb +0 -5
  67. data/test/dummy/config/environments/development.rb +0 -37
  68. data/test/dummy/config/environments/production.rb +0 -67
  69. data/test/dummy/config/environments/test.rb +0 -37
  70. data/test/dummy/config/initializers/backtrace_silencers.rb +0 -7
  71. data/test/dummy/config/initializers/inflections.rb +0 -15
  72. data/test/dummy/config/initializers/mime_types.rb +0 -5
  73. data/test/dummy/config/initializers/secret_token.rb +0 -7
  74. data/test/dummy/config/initializers/session_store.rb +0 -8
  75. data/test/dummy/config/initializers/wrap_parameters.rb +0 -14
  76. data/test/dummy/config/locales/en.yml +0 -5
  77. data/test/dummy/config/routes.rb +0 -58
  78. data/test/dummy/db/README +0 -0
  79. data/test/dummy/db/test.sqlite3 +0 -0
  80. data/test/dummy/log/test.log +0 -1704
  81. data/test/dummy/public/404.html +0 -26
  82. data/test/dummy/public/422.html +0 -26
  83. data/test/dummy/public/500.html +0 -25
  84. data/test/dummy/public/favicon.ico +0 -0
  85. data/test/dummy/script/rails +0 -6
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: exlibris-primo
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.1
4
+ version: 0.1.4
5
5
  prerelease:
6
6
  platform: ruby
7
7
  authors:
@@ -9,11 +9,11 @@ authors:
9
9
  autorequire:
10
10
  bindir: bin
11
11
  cert_chain: []
12
- date: 2012-04-11 00:00:00.000000000 Z
12
+ date: 2012-10-12 00:00:00.000000000 Z
13
13
  dependencies:
14
14
  - !ruby/object:Gem::Dependency
15
- name: rails
16
- requirement: &2152674040 !ruby/object:Gem::Requirement
15
+ name: activesupport
16
+ requirement: !ruby/object:Gem::Requirement
17
17
  none: false
18
18
  requirements:
19
19
  - - ~>
@@ -21,10 +21,15 @@ dependencies:
21
21
  version: 3.2.0
22
22
  type: :runtime
23
23
  prerelease: false
24
- version_requirements: *2152674040
24
+ version_requirements: !ruby/object:Gem::Requirement
25
+ none: false
26
+ requirements:
27
+ - - ~>
28
+ - !ruby/object:Gem::Version
29
+ version: 3.2.0
25
30
  - !ruby/object:Gem::Dependency
26
31
  name: nokogiri
27
- requirement: &2152673580 !ruby/object:Gem::Requirement
32
+ requirement: !ruby/object:Gem::Requirement
28
33
  none: false
29
34
  requirements:
30
35
  - - ! '>='
@@ -32,10 +37,31 @@ dependencies:
32
37
  version: '0'
33
38
  type: :runtime
34
39
  prerelease: false
35
- version_requirements: *2152673580
40
+ version_requirements: !ruby/object:Gem::Requirement
41
+ none: false
42
+ requirements:
43
+ - - ! '>='
44
+ - !ruby/object:Gem::Version
45
+ version: '0'
46
+ - !ruby/object:Gem::Dependency
47
+ name: json
48
+ requirement: !ruby/object:Gem::Requirement
49
+ none: false
50
+ requirements:
51
+ - - ! '>='
52
+ - !ruby/object:Gem::Version
53
+ version: '0'
54
+ type: :runtime
55
+ prerelease: false
56
+ version_requirements: !ruby/object:Gem::Requirement
57
+ none: false
58
+ requirements:
59
+ - - ! '>='
60
+ - !ruby/object:Gem::Version
61
+ version: '0'
36
62
  - !ruby/object:Gem::Dependency
37
63
  name: soap4r-ruby1.9
38
- requirement: &2152672900 !ruby/object:Gem::Requirement
64
+ requirement: !ruby/object:Gem::Requirement
39
65
  none: false
40
66
  requirements:
41
67
  - - ! '>='
@@ -43,10 +69,15 @@ dependencies:
43
69
  version: '0'
44
70
  type: :runtime
45
71
  prerelease: false
46
- version_requirements: *2152672900
72
+ version_requirements: !ruby/object:Gem::Requirement
73
+ none: false
74
+ requirements:
75
+ - - ! '>='
76
+ - !ruby/object:Gem::Version
77
+ version: '0'
47
78
  - !ruby/object:Gem::Dependency
48
- name: sqlite3
49
- requirement: &2152672320 !ruby/object:Gem::Requirement
79
+ name: vcr
80
+ requirement: !ruby/object:Gem::Requirement
50
81
  none: false
51
82
  requirements:
52
83
  - - ! '>='
@@ -54,8 +85,30 @@ dependencies:
54
85
  version: '0'
55
86
  type: :development
56
87
  prerelease: false
57
- version_requirements: *2152672320
58
- description: Library to work with Exlibris' Primo discovery system.
88
+ version_requirements: !ruby/object:Gem::Requirement
89
+ none: false
90
+ requirements:
91
+ - - ! '>='
92
+ - !ruby/object:Gem::Version
93
+ version: '0'
94
+ - !ruby/object:Gem::Dependency
95
+ name: webmock
96
+ requirement: !ruby/object:Gem::Requirement
97
+ none: false
98
+ requirements:
99
+ - - ! '>='
100
+ - !ruby/object:Gem::Version
101
+ version: '0'
102
+ type: :development
103
+ prerelease: false
104
+ version_requirements: !ruby/object:Gem::Requirement
105
+ none: false
106
+ requirements:
107
+ - - ! '>='
108
+ - !ruby/object:Gem::Version
109
+ version: '0'
110
+ description: Library to work with Exlibris' Primo discovery system. Does not require
111
+ Rails.
59
112
  email:
60
113
  - scotdalton@gmail.com
61
114
  executables: []
@@ -73,41 +126,9 @@ files:
73
126
  - lib/exlibris/primo/version.rb
74
127
  - lib/exlibris/primo/web_service.rb
75
128
  - lib/exlibris-primo.rb
76
- - lib/tasks/exlibris-primo_tasks.rake
77
129
  - MIT-LICENSE
78
130
  - Rakefile
79
131
  - README.rdoc
80
- - test/dummy/app/assets/javascripts/application.js
81
- - test/dummy/app/assets/stylesheets/application.css
82
- - test/dummy/app/controllers/application_controller.rb
83
- - test/dummy/app/helpers/application_helper.rb
84
- - test/dummy/app/views/layouts/application.html.erb
85
- - test/dummy/config/application.rb
86
- - test/dummy/config/boot.rb
87
- - test/dummy/config/database.yml
88
- - test/dummy/config/environment.rb
89
- - test/dummy/config/environments/development.rb
90
- - test/dummy/config/environments/production.rb
91
- - test/dummy/config/environments/test.rb
92
- - test/dummy/config/initializers/backtrace_silencers.rb
93
- - test/dummy/config/initializers/inflections.rb
94
- - test/dummy/config/initializers/mime_types.rb
95
- - test/dummy/config/initializers/secret_token.rb
96
- - test/dummy/config/initializers/session_store.rb
97
- - test/dummy/config/initializers/wrap_parameters.rb
98
- - test/dummy/config/locales/en.yml
99
- - test/dummy/config/routes.rb
100
- - test/dummy/config.ru
101
- - test/dummy/db/README
102
- - test/dummy/db/test.sqlite3
103
- - test/dummy/log/test.log
104
- - test/dummy/public/404.html
105
- - test/dummy/public/422.html
106
- - test/dummy/public/500.html
107
- - test/dummy/public/favicon.ico
108
- - test/dummy/Rakefile
109
- - test/dummy/README.rdoc
110
- - test/dummy/script/rails
111
132
  - test/exlibris-primo_test.rb
112
133
  - test/test_helper.rb
113
134
  - test/unit/eshelf_test.rb
@@ -116,6 +137,43 @@ files:
116
137
  - test/unit/searcher_test.rb
117
138
  - test/unit/web_service_benchmarks.rb
118
139
  - test/unit/web_service_test.rb
140
+ - test/vcr_cassettes/eshelf_add_invalid_records.yml
141
+ - test/vcr_cassettes/eshelf_add_same_record_twice.yml
142
+ - test/vcr_cassettes/eshelf_add_to_empty_basket.yml
143
+ - test/vcr_cassettes/eshelf_add_to_invalid_basket.yml
144
+ - test/vcr_cassettes/eshelf_invalid_eshelf.yml
145
+ - test/vcr_cassettes/eshelf_invalid_institution.yml
146
+ - test/vcr_cassettes/eshelf_valid_eshelf.yml
147
+ - test/vcr_cassettes/eshelf_valid_eshelf_structure.yml
148
+ - test/vcr_cassettes/record.yml
149
+ - test/vcr_cassettes/record_invalid_record.yml
150
+ - test/vcr_cassettes/record_sub_record.yml
151
+ - test/vcr_cassettes/record_valid_record.yml
152
+ - test/vcr_cassettes/searcher_base_holdings_by_id.yml
153
+ - test/vcr_cassettes/searcher_dedupmrg_by_id.yml
154
+ - test/vcr_cassettes/searcher_diacritics1_by_id.yml
155
+ - test/vcr_cassettes/searcher_diacritics2_by_id.yml
156
+ - test/vcr_cassettes/searcher_holdings_by_id.yml
157
+ - test/vcr_cassettes/searcher_invalid_id.yml
158
+ - test/vcr_cassettes/searcher_rsrcs_by_id.yml
159
+ - test/vcr_cassettes/searcher_search_by_isbn.yml
160
+ - test/vcr_cassettes/searcher_search_by_issn.yml
161
+ - test/vcr_cassettes/searcher_search_by_title_author_genre.yml
162
+ - test/vcr_cassettes/searcher_test_bug_1361.yml
163
+ - test/vcr_cassettes/searcher_test_problem_by_id.yml
164
+ - test/vcr_cassettes/searcher_tocs_by_id.yml
165
+ - test/vcr_cassettes/web_service_author_search.yml
166
+ - test/vcr_cassettes/web_service_bogus_200.yml
167
+ - test/vcr_cassettes/web_service_brief_search.yml
168
+ - test/vcr_cassettes/web_service_get_eshelf.yml
169
+ - test/vcr_cassettes/web_service_get_eshelf_structure_search.yml
170
+ - test/vcr_cassettes/web_service_invalid_document.yml
171
+ - test/vcr_cassettes/web_service_isbn_search.yml
172
+ - test/vcr_cassettes/web_service_issn_search.yml
173
+ - test/vcr_cassettes/web_service_problem_document.yml
174
+ - test/vcr_cassettes/web_service_single_document.yml
175
+ - test/vcr_cassettes/web_service_title_author_genre_search.yml
176
+ - test/vcr_cassettes/web_service_title_search.yml
119
177
  homepage: https://github.com/scotdalton/exlibris-primo
120
178
  licenses: []
121
179
  post_install_message:
@@ -128,50 +186,25 @@ required_ruby_version: !ruby/object:Gem::Requirement
128
186
  - - ! '>='
129
187
  - !ruby/object:Gem::Version
130
188
  version: '0'
189
+ segments:
190
+ - 0
191
+ hash: -2827550050257447414
131
192
  required_rubygems_version: !ruby/object:Gem::Requirement
132
193
  none: false
133
194
  requirements:
134
195
  - - ! '>='
135
196
  - !ruby/object:Gem::Version
136
197
  version: '0'
198
+ segments:
199
+ - 0
200
+ hash: -2827550050257447414
137
201
  requirements: []
138
202
  rubyforge_project:
139
- rubygems_version: 1.8.15
203
+ rubygems_version: 1.8.24
140
204
  signing_key:
141
205
  specification_version: 3
142
206
  summary: Library to work with Exlibris' Primo discovery system.
143
207
  test_files:
144
- - test/dummy/app/assets/javascripts/application.js
145
- - test/dummy/app/assets/stylesheets/application.css
146
- - test/dummy/app/controllers/application_controller.rb
147
- - test/dummy/app/helpers/application_helper.rb
148
- - test/dummy/app/views/layouts/application.html.erb
149
- - test/dummy/config/application.rb
150
- - test/dummy/config/boot.rb
151
- - test/dummy/config/database.yml
152
- - test/dummy/config/environment.rb
153
- - test/dummy/config/environments/development.rb
154
- - test/dummy/config/environments/production.rb
155
- - test/dummy/config/environments/test.rb
156
- - test/dummy/config/initializers/backtrace_silencers.rb
157
- - test/dummy/config/initializers/inflections.rb
158
- - test/dummy/config/initializers/mime_types.rb
159
- - test/dummy/config/initializers/secret_token.rb
160
- - test/dummy/config/initializers/session_store.rb
161
- - test/dummy/config/initializers/wrap_parameters.rb
162
- - test/dummy/config/locales/en.yml
163
- - test/dummy/config/routes.rb
164
- - test/dummy/config.ru
165
- - test/dummy/db/README
166
- - test/dummy/db/test.sqlite3
167
- - test/dummy/log/test.log
168
- - test/dummy/public/404.html
169
- - test/dummy/public/422.html
170
- - test/dummy/public/500.html
171
- - test/dummy/public/favicon.ico
172
- - test/dummy/Rakefile
173
- - test/dummy/README.rdoc
174
- - test/dummy/script/rails
175
208
  - test/exlibris-primo_test.rb
176
209
  - test/test_helper.rb
177
210
  - test/unit/eshelf_test.rb
@@ -180,3 +213,40 @@ test_files:
180
213
  - test/unit/searcher_test.rb
181
214
  - test/unit/web_service_benchmarks.rb
182
215
  - test/unit/web_service_test.rb
216
+ - test/vcr_cassettes/eshelf_add_invalid_records.yml
217
+ - test/vcr_cassettes/eshelf_add_same_record_twice.yml
218
+ - test/vcr_cassettes/eshelf_add_to_empty_basket.yml
219
+ - test/vcr_cassettes/eshelf_add_to_invalid_basket.yml
220
+ - test/vcr_cassettes/eshelf_invalid_eshelf.yml
221
+ - test/vcr_cassettes/eshelf_invalid_institution.yml
222
+ - test/vcr_cassettes/eshelf_valid_eshelf.yml
223
+ - test/vcr_cassettes/eshelf_valid_eshelf_structure.yml
224
+ - test/vcr_cassettes/record.yml
225
+ - test/vcr_cassettes/record_invalid_record.yml
226
+ - test/vcr_cassettes/record_sub_record.yml
227
+ - test/vcr_cassettes/record_valid_record.yml
228
+ - test/vcr_cassettes/searcher_base_holdings_by_id.yml
229
+ - test/vcr_cassettes/searcher_dedupmrg_by_id.yml
230
+ - test/vcr_cassettes/searcher_diacritics1_by_id.yml
231
+ - test/vcr_cassettes/searcher_diacritics2_by_id.yml
232
+ - test/vcr_cassettes/searcher_holdings_by_id.yml
233
+ - test/vcr_cassettes/searcher_invalid_id.yml
234
+ - test/vcr_cassettes/searcher_rsrcs_by_id.yml
235
+ - test/vcr_cassettes/searcher_search_by_isbn.yml
236
+ - test/vcr_cassettes/searcher_search_by_issn.yml
237
+ - test/vcr_cassettes/searcher_search_by_title_author_genre.yml
238
+ - test/vcr_cassettes/searcher_test_bug_1361.yml
239
+ - test/vcr_cassettes/searcher_test_problem_by_id.yml
240
+ - test/vcr_cassettes/searcher_tocs_by_id.yml
241
+ - test/vcr_cassettes/web_service_author_search.yml
242
+ - test/vcr_cassettes/web_service_bogus_200.yml
243
+ - test/vcr_cassettes/web_service_brief_search.yml
244
+ - test/vcr_cassettes/web_service_get_eshelf.yml
245
+ - test/vcr_cassettes/web_service_get_eshelf_structure_search.yml
246
+ - test/vcr_cassettes/web_service_invalid_document.yml
247
+ - test/vcr_cassettes/web_service_isbn_search.yml
248
+ - test/vcr_cassettes/web_service_issn_search.yml
249
+ - test/vcr_cassettes/web_service_problem_document.yml
250
+ - test/vcr_cassettes/web_service_single_document.yml
251
+ - test/vcr_cassettes/web_service_title_author_genre_search.yml
252
+ - test/vcr_cassettes/web_service_title_search.yml
@@ -1,4 +0,0 @@
1
- # desc "Explaining what the task does"
2
- # task :exlibris-primo do
3
- # # Task goes here
4
- # end
@@ -1,261 +0,0 @@
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.