dossier 2.11.0 → 2.12.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (55) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +2 -2
  3. data/Rakefile +3 -18
  4. data/lib/dossier.rb +1 -0
  5. data/lib/dossier/configuration.rb +14 -3
  6. data/lib/dossier/connection_url.rb +29 -0
  7. data/lib/dossier/version.rb +1 -1
  8. data/spec/dossier/configuration_spec.rb +18 -3
  9. data/spec/dossier/connection_url_spec.rb +23 -0
  10. data/spec/dummy/config.ru +0 -3
  11. data/spec/dummy/db/test.sqlite3 +0 -0
  12. data/spec/dummy/log/test.log +329 -7123
  13. data/spec/spec_helper.rb +7 -4
  14. metadata +19 -84
  15. data/spec/dummy/README.rdoc +0 -261
  16. data/spec/dummy/Rakefile +0 -7
  17. data/spec/dummy/app/controllers/application_controller.rb +0 -3
  18. data/spec/dummy/config/application.rb +0 -56
  19. data/spec/dummy/config/boot.rb +0 -10
  20. data/spec/dummy/config/environment.rb +0 -5
  21. data/spec/dummy/config/environments/development.rb +0 -39
  22. data/spec/dummy/config/environments/production.rb +0 -69
  23. data/spec/dummy/config/environments/test.rb +0 -39
  24. data/spec/dummy/config/initializers/backtrace_silencers.rb +0 -7
  25. data/spec/dummy/config/initializers/inflections.rb +0 -15
  26. data/spec/dummy/config/initializers/mime_types.rb +0 -5
  27. data/spec/dummy/config/initializers/secret_token.rb +0 -7
  28. data/spec/dummy/config/initializers/session_store.rb +0 -8
  29. data/spec/dummy/config/initializers/wrap_parameters.rb +0 -14
  30. data/spec/dummy/config/locales/en.yml +0 -5
  31. data/spec/dummy/config/setup_load_paths.rb +0 -12
  32. data/spec/dummy/public/404.html +0 -26
  33. data/spec/dummy/public/422.html +0 -26
  34. data/spec/dummy/public/500.html +0 -25
  35. data/spec/dummy/public/favicon.ico +0 -0
  36. data/spec/dummy/script/rails +0 -6
  37. data/spec/dummy/tmp/cache/assets/C35/BF0/sprockets%2F64292e0008108df585a755f2876c7869 +0 -0
  38. data/spec/dummy/tmp/cache/assets/CAE/C40/sprockets%2F52b52a56f21c0d96d671468570a3ec47 +0 -0
  39. data/spec/dummy/tmp/cache/assets/CD8/370/sprockets%2F357970feca3ac29060c1e3861e2c0953 +0 -0
  40. data/spec/dummy/tmp/cache/assets/CEA/5A0/sprockets%2Fc0534884cbc43494a05d9e957ea1298d +0 -0
  41. data/spec/dummy/tmp/cache/assets/D00/EF0/sprockets%2F4e1e8b85785ee1929c8e355c96902e9c +0 -0
  42. data/spec/dummy/tmp/cache/assets/D32/A10/sprockets%2F13fe41fee1fe35b49d145bcc06610705 +0 -0
  43. data/spec/dummy/tmp/cache/assets/D40/0D0/sprockets%2F15a6bb0a1346b6d7fe859c14bf729a49 +0 -0
  44. data/spec/dummy/tmp/cache/assets/D45/6A0/sprockets%2F22f3562bf7d5e640880df2a5d683f2fc +0 -0
  45. data/spec/dummy/tmp/cache/assets/D4E/1B0/sprockets%2Ff7cbd26ba1d28d48de824f0e94586655 +0 -0
  46. data/spec/dummy/tmp/cache/assets/D51/510/sprockets%2Fca0353abc266080173bbc3c13efa935a +0 -0
  47. data/spec/dummy/tmp/cache/assets/D58/4B0/sprockets%2F912ab2da4b05c27efb630ba66f2830b5 +0 -0
  48. data/spec/dummy/tmp/cache/assets/D5A/EA0/sprockets%2Fd771ace226fc8215a3572e0aa35bb0d6 +0 -0
  49. data/spec/dummy/tmp/cache/assets/D6C/400/sprockets%2F7fa180a6e05c7ca4346ef58c54bb30f8 +0 -0
  50. data/spec/dummy/tmp/cache/assets/DBF/290/sprockets%2F2f8bb1f9081cadc350e5bb6ab1458d5a +0 -0
  51. data/spec/dummy/tmp/cache/assets/DC4/970/sprockets%2F2b0c9d55a697a19f1cec43cf160baef1 +0 -0
  52. data/spec/dummy/tmp/cache/assets/DCF/420/sprockets%2F9f127ea0ab7236994d1ceaa7bbea86c8 +0 -0
  53. data/spec/dummy/tmp/cache/assets/DDC/400/sprockets%2Fcffd775d018f68ce5dba1ee0d951a994 +0 -0
  54. data/spec/dummy/tmp/cache/assets/E04/890/sprockets%2F2f5173deea6c795b8fdde723bb4b63af +0 -0
  55. data/spec/dummy/tmp/restart.txt +0 -0
@@ -1,9 +1,13 @@
1
- # Configure Rails Environment
2
- ENV["RAILS_ENV"] = "test"
3
-
1
+ require 'rails/all'
2
+ require 'dummy/application'
3
+ require 'active_model'
4
4
  require 'simplecov'
5
5
  require 'coveralls'
6
6
 
7
+ # not sure why I need to do this now, its after I added dummy-application
8
+ ApplicationController.helper Dossier::ApplicationHelper
9
+ SiteController.helper Dossier::ApplicationHelper
10
+
7
11
  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
8
12
  SimpleCov::Formatter::HTMLFormatter,
9
13
  Coveralls::SimpleCov::Formatter
@@ -11,7 +15,6 @@ SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
11
15
  SimpleCov.start
12
16
  Coveralls.wear!('rails')
13
17
 
14
- require File.expand_path("../dummy/config/environment.rb", __FILE__)
15
18
  require "rails/test_help"
16
19
  require 'rspec/rails'
17
20
  require 'pry'
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: dossier
3
3
  version: !ruby/object:Gem::Version
4
- version: 2.11.0
4
+ version: 2.12.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Adam Hunter
@@ -10,7 +10,7 @@ authors:
10
10
  autorequire:
11
11
  bindir: bin
12
12
  cert_chain: []
13
- date: 2014-04-25 00:00:00.000000000 Z
13
+ date: 2014-06-05 00:00:00.000000000 Z
14
14
  dependencies:
15
15
  - !ruby/object:Gem::Dependency
16
16
  name: arel
@@ -194,6 +194,20 @@ dependencies:
194
194
  - - "~>"
195
195
  - !ruby/object:Gem::Version
196
196
  version: 0.7.1
197
+ - !ruby/object:Gem::Dependency
198
+ name: dummy-application
199
+ requirement: !ruby/object:Gem::Requirement
200
+ requirements:
201
+ - - ">="
202
+ - !ruby/object:Gem::Version
203
+ version: '0'
204
+ type: :development
205
+ prerelease: false
206
+ version_requirements: !ruby/object:Gem::Requirement
207
+ requirements:
208
+ - - ">="
209
+ - !ruby/object:Gem::Version
210
+ version: '0'
197
211
  description: Easy SQL based report generation with the ability to accept request parameters
198
212
  and render multiple formats.
199
213
  email:
@@ -222,6 +236,7 @@ files:
222
236
  - lib/dossier/adapter/active_record/result.rb
223
237
  - lib/dossier/client.rb
224
238
  - lib/dossier/configuration.rb
239
+ - lib/dossier/connection_url.rb
225
240
  - lib/dossier/engine.rb
226
241
  - lib/dossier/formatter.rb
227
242
  - lib/dossier/multi_report.rb
@@ -242,6 +257,7 @@ files:
242
257
  - spec/dossier/adapter/active_record_spec.rb
243
258
  - spec/dossier/client_spec.rb
244
259
  - spec/dossier/configuration_spec.rb
260
+ - spec/dossier/connection_url_spec.rb
245
261
  - spec/dossier/formatter_spec.rb
246
262
  - spec/dossier/multi_report_spec.rb
247
263
  - spec/dossier/naming_spec.rb
@@ -252,9 +268,6 @@ files:
252
268
  - spec/dossier/result_spec.rb
253
269
  - spec/dossier/stream_csv_spec.rb
254
270
  - spec/dossier_spec.rb
255
- - spec/dummy/README.rdoc
256
- - spec/dummy/Rakefile
257
- - spec/dummy/app/controllers/application_controller.rb
258
271
  - spec/dummy/app/controllers/site_controller.rb
259
272
  - spec/dummy/app/reports/cats/are/super_fun_report.rb
260
273
  - spec/dummy/app/reports/combination_report.rb
@@ -268,51 +281,13 @@ files:
268
281
  - spec/dummy/app/views/dossier/reports/employee_with_custom_view/_options.html.haml
269
282
  - spec/dummy/app/views/layouts/application.html.erb
270
283
  - spec/dummy/config.ru
271
- - spec/dummy/config/application.rb
272
- - spec/dummy/config/boot.rb
273
284
  - spec/dummy/config/database.yml
274
285
  - spec/dummy/config/database.yml.example
275
286
  - spec/dummy/config/database.yml.travis
276
- - spec/dummy/config/environment.rb
277
- - spec/dummy/config/environments/development.rb
278
- - spec/dummy/config/environments/production.rb
279
- - spec/dummy/config/environments/test.rb
280
- - spec/dummy/config/initializers/backtrace_silencers.rb
281
- - spec/dummy/config/initializers/inflections.rb
282
- - spec/dummy/config/initializers/mime_types.rb
283
- - spec/dummy/config/initializers/secret_token.rb
284
- - spec/dummy/config/initializers/session_store.rb
285
- - spec/dummy/config/initializers/wrap_parameters.rb
286
- - spec/dummy/config/locales/en.yml
287
287
  - spec/dummy/config/routes.rb
288
- - spec/dummy/config/setup_load_paths.rb
289
288
  - spec/dummy/db/schema.rb
290
289
  - spec/dummy/db/test.sqlite3
291
290
  - spec/dummy/log/test.log
292
- - spec/dummy/public/404.html
293
- - spec/dummy/public/422.html
294
- - spec/dummy/public/500.html
295
- - spec/dummy/public/favicon.ico
296
- - spec/dummy/script/rails
297
- - spec/dummy/tmp/cache/assets/C35/BF0/sprockets%2F64292e0008108df585a755f2876c7869
298
- - spec/dummy/tmp/cache/assets/CAE/C40/sprockets%2F52b52a56f21c0d96d671468570a3ec47
299
- - spec/dummy/tmp/cache/assets/CD8/370/sprockets%2F357970feca3ac29060c1e3861e2c0953
300
- - spec/dummy/tmp/cache/assets/CEA/5A0/sprockets%2Fc0534884cbc43494a05d9e957ea1298d
301
- - spec/dummy/tmp/cache/assets/D00/EF0/sprockets%2F4e1e8b85785ee1929c8e355c96902e9c
302
- - spec/dummy/tmp/cache/assets/D32/A10/sprockets%2F13fe41fee1fe35b49d145bcc06610705
303
- - spec/dummy/tmp/cache/assets/D40/0D0/sprockets%2F15a6bb0a1346b6d7fe859c14bf729a49
304
- - spec/dummy/tmp/cache/assets/D45/6A0/sprockets%2F22f3562bf7d5e640880df2a5d683f2fc
305
- - spec/dummy/tmp/cache/assets/D4E/1B0/sprockets%2Ff7cbd26ba1d28d48de824f0e94586655
306
- - spec/dummy/tmp/cache/assets/D51/510/sprockets%2Fca0353abc266080173bbc3c13efa935a
307
- - spec/dummy/tmp/cache/assets/D58/4B0/sprockets%2F912ab2da4b05c27efb630ba66f2830b5
308
- - spec/dummy/tmp/cache/assets/D5A/EA0/sprockets%2Fd771ace226fc8215a3572e0aa35bb0d6
309
- - spec/dummy/tmp/cache/assets/D6C/400/sprockets%2F7fa180a6e05c7ca4346ef58c54bb30f8
310
- - spec/dummy/tmp/cache/assets/DBF/290/sprockets%2F2f8bb1f9081cadc350e5bb6ab1458d5a
311
- - spec/dummy/tmp/cache/assets/DC4/970/sprockets%2F2b0c9d55a697a19f1cec43cf160baef1
312
- - spec/dummy/tmp/cache/assets/DCF/420/sprockets%2F9f127ea0ab7236994d1ceaa7bbea86c8
313
- - spec/dummy/tmp/cache/assets/DDC/400/sprockets%2Fcffd775d018f68ce5dba1ee0d951a994
314
- - spec/dummy/tmp/cache/assets/E04/890/sprockets%2F2f5173deea6c795b8fdde723bb4b63af
315
- - spec/dummy/tmp/restart.txt
316
291
  - spec/features/combination_report_spec.rb
317
292
  - spec/features/employee_spec.rb
318
293
  - spec/features/employee_with_custom_client_spec.rb
@@ -360,6 +335,7 @@ test_files:
360
335
  - spec/dossier/adapter/active_record_spec.rb
361
336
  - spec/dossier/client_spec.rb
362
337
  - spec/dossier/configuration_spec.rb
338
+ - spec/dossier/connection_url_spec.rb
363
339
  - spec/dossier/formatter_spec.rb
364
340
  - spec/dossier/multi_report_spec.rb
365
341
  - spec/dossier/naming_spec.rb
@@ -370,7 +346,6 @@ test_files:
370
346
  - spec/dossier/result_spec.rb
371
347
  - spec/dossier/stream_csv_spec.rb
372
348
  - spec/dossier_spec.rb
373
- - spec/dummy/app/controllers/application_controller.rb
374
349
  - spec/dummy/app/controllers/site_controller.rb
375
350
  - spec/dummy/app/reports/cats/are/super_fun_report.rb
376
351
  - spec/dummy/app/reports/combination_report.rb
@@ -383,54 +358,14 @@ test_files:
383
358
  - spec/dummy/app/views/dossier/reports/employee_with_custom_view/_options.html.haml
384
359
  - spec/dummy/app/views/dossier/reports/employee_with_custom_view.html.haml
385
360
  - spec/dummy/app/views/layouts/application.html.erb
386
- - spec/dummy/config/application.rb
387
- - spec/dummy/config/boot.rb
388
361
  - spec/dummy/config/database.yml
389
362
  - spec/dummy/config/database.yml.example
390
363
  - spec/dummy/config/database.yml.travis
391
- - spec/dummy/config/environment.rb
392
- - spec/dummy/config/environments/development.rb
393
- - spec/dummy/config/environments/production.rb
394
- - spec/dummy/config/environments/test.rb
395
- - spec/dummy/config/initializers/backtrace_silencers.rb
396
- - spec/dummy/config/initializers/inflections.rb
397
- - spec/dummy/config/initializers/mime_types.rb
398
- - spec/dummy/config/initializers/secret_token.rb
399
- - spec/dummy/config/initializers/session_store.rb
400
- - spec/dummy/config/initializers/wrap_parameters.rb
401
- - spec/dummy/config/locales/en.yml
402
364
  - spec/dummy/config/routes.rb
403
- - spec/dummy/config/setup_load_paths.rb
404
365
  - spec/dummy/config.ru
405
366
  - spec/dummy/db/schema.rb
406
367
  - spec/dummy/db/test.sqlite3
407
368
  - spec/dummy/log/test.log
408
- - spec/dummy/public/404.html
409
- - spec/dummy/public/422.html
410
- - spec/dummy/public/500.html
411
- - spec/dummy/public/favicon.ico
412
- - spec/dummy/Rakefile
413
- - spec/dummy/README.rdoc
414
- - spec/dummy/script/rails
415
- - spec/dummy/tmp/cache/assets/C35/BF0/sprockets%2F64292e0008108df585a755f2876c7869
416
- - spec/dummy/tmp/cache/assets/CAE/C40/sprockets%2F52b52a56f21c0d96d671468570a3ec47
417
- - spec/dummy/tmp/cache/assets/CD8/370/sprockets%2F357970feca3ac29060c1e3861e2c0953
418
- - spec/dummy/tmp/cache/assets/CEA/5A0/sprockets%2Fc0534884cbc43494a05d9e957ea1298d
419
- - spec/dummy/tmp/cache/assets/D00/EF0/sprockets%2F4e1e8b85785ee1929c8e355c96902e9c
420
- - spec/dummy/tmp/cache/assets/D32/A10/sprockets%2F13fe41fee1fe35b49d145bcc06610705
421
- - spec/dummy/tmp/cache/assets/D40/0D0/sprockets%2F15a6bb0a1346b6d7fe859c14bf729a49
422
- - spec/dummy/tmp/cache/assets/D45/6A0/sprockets%2F22f3562bf7d5e640880df2a5d683f2fc
423
- - spec/dummy/tmp/cache/assets/D4E/1B0/sprockets%2Ff7cbd26ba1d28d48de824f0e94586655
424
- - spec/dummy/tmp/cache/assets/D51/510/sprockets%2Fca0353abc266080173bbc3c13efa935a
425
- - spec/dummy/tmp/cache/assets/D58/4B0/sprockets%2F912ab2da4b05c27efb630ba66f2830b5
426
- - spec/dummy/tmp/cache/assets/D5A/EA0/sprockets%2Fd771ace226fc8215a3572e0aa35bb0d6
427
- - spec/dummy/tmp/cache/assets/D6C/400/sprockets%2F7fa180a6e05c7ca4346ef58c54bb30f8
428
- - spec/dummy/tmp/cache/assets/DBF/290/sprockets%2F2f8bb1f9081cadc350e5bb6ab1458d5a
429
- - spec/dummy/tmp/cache/assets/DC4/970/sprockets%2F2b0c9d55a697a19f1cec43cf160baef1
430
- - spec/dummy/tmp/cache/assets/DCF/420/sprockets%2F9f127ea0ab7236994d1ceaa7bbea86c8
431
- - spec/dummy/tmp/cache/assets/DDC/400/sprockets%2Fcffd775d018f68ce5dba1ee0d951a994
432
- - spec/dummy/tmp/cache/assets/E04/890/sprockets%2F2f5173deea6c795b8fdde723bb4b63af
433
- - spec/dummy/tmp/restart.txt
434
369
  - spec/features/combination_report_spec.rb
435
370
  - spec/features/employee_spec.rb
436
371
  - spec/features/employee_with_custom_client_spec.rb
@@ -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.