cancan-unit-test 0.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (67) hide show
  1. checksums.yaml +7 -0
  2. data/.gitignore +33 -0
  3. data/.pairs +18 -0
  4. data/.rspec +1 -0
  5. data/.travis.yml +3 -0
  6. data/Gemfile +12 -0
  7. data/Gemfile.lock +131 -0
  8. data/LICENSE.txt +22 -0
  9. data/README.md +31 -0
  10. data/Rakefile +15 -0
  11. data/cancan_unit_test.gemspec +31 -0
  12. data/integration/controllers/mocks_spec.rb +25 -0
  13. data/integration/fixtures/dummy/README.rdoc +261 -0
  14. data/integration/fixtures/dummy/Rakefile +7 -0
  15. data/integration/fixtures/dummy/app/assets/javascripts/application.js +15 -0
  16. data/integration/fixtures/dummy/app/assets/stylesheets/application.css +13 -0
  17. data/integration/fixtures/dummy/app/controllers/application_controller.rb +7 -0
  18. data/integration/fixtures/dummy/app/controllers/posts_controller.rb +8 -0
  19. data/integration/fixtures/dummy/app/helpers/application_helper.rb +2 -0
  20. data/integration/fixtures/dummy/app/mailers/.gitkeep +0 -0
  21. data/integration/fixtures/dummy/app/models/.gitkeep +0 -0
  22. data/integration/fixtures/dummy/app/models/ability.rb +7 -0
  23. data/integration/fixtures/dummy/app/models/post.rb +3 -0
  24. data/integration/fixtures/dummy/app/views/layouts/application.html.erb +14 -0
  25. data/integration/fixtures/dummy/app/views/posts/index.erb +0 -0
  26. data/integration/fixtures/dummy/config.ru +4 -0
  27. data/integration/fixtures/dummy/config/application.rb +58 -0
  28. data/integration/fixtures/dummy/config/boot.rb +10 -0
  29. data/integration/fixtures/dummy/config/database.yml +25 -0
  30. data/integration/fixtures/dummy/config/environment.rb +5 -0
  31. data/integration/fixtures/dummy/config/environments/development.rb +37 -0
  32. data/integration/fixtures/dummy/config/environments/production.rb +67 -0
  33. data/integration/fixtures/dummy/config/environments/test.rb +37 -0
  34. data/integration/fixtures/dummy/config/initializers/backtrace_silencers.rb +7 -0
  35. data/integration/fixtures/dummy/config/initializers/inflections.rb +15 -0
  36. data/integration/fixtures/dummy/config/initializers/mime_types.rb +5 -0
  37. data/integration/fixtures/dummy/config/initializers/secret_token.rb +7 -0
  38. data/integration/fixtures/dummy/config/initializers/session_store.rb +8 -0
  39. data/integration/fixtures/dummy/config/initializers/wrap_parameters.rb +14 -0
  40. data/integration/fixtures/dummy/config/locales/en.yml +5 -0
  41. data/integration/fixtures/dummy/config/routes.rb +61 -0
  42. data/integration/fixtures/dummy/db/development.sqlite3 +0 -0
  43. data/integration/fixtures/dummy/db/migrate/20130709143526_create_posts.rb +10 -0
  44. data/integration/fixtures/dummy/db/schema.rb +23 -0
  45. data/integration/fixtures/dummy/db/structure.sql +1 -0
  46. data/integration/fixtures/dummy/db/test.sqlite3 +0 -0
  47. data/integration/fixtures/dummy/lib/assets/.gitkeep +0 -0
  48. data/integration/fixtures/dummy/public/404.html +26 -0
  49. data/integration/fixtures/dummy/public/422.html +26 -0
  50. data/integration/fixtures/dummy/public/500.html +25 -0
  51. data/integration/fixtures/dummy/public/favicon.ico +0 -0
  52. data/integration/fixtures/dummy/script/rails +6 -0
  53. data/lib/cancan_unit_test.rb +11 -0
  54. data/lib/cancan_unit_test/action_controller/stub_registry.rb +28 -0
  55. data/lib/cancan_unit_test/action_controller_extensions.rb +1 -0
  56. data/lib/cancan_unit_test/cancan/controller_resource.rb +37 -0
  57. data/lib/cancan_unit_test/cancan_extensions.rb +1 -0
  58. data/lib/cancan_unit_test/mocks.rb +9 -0
  59. data/lib/cancan_unit_test/stub_finder.rb +30 -0
  60. data/lib/cancan_unit_test/version.rb +3 -0
  61. data/spec/cancan/controller_resource_spec.rb +115 -0
  62. data/spec/integration_helper.rb +36 -0
  63. data/spec/mocks_spec.rb +40 -0
  64. data/spec/rails/action_controller/stub_registry_spec.rb +98 -0
  65. data/spec/spec_helper.rb +18 -0
  66. data/spec/stub_finder_spec.rb +60 -0
  67. metadata +241 -0
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: d6177faaa08bc88c1f286f8c76f68155b41f4f78
4
+ data.tar.gz: 6db7a439ae237ff7a0b349fa8804f218fd4a8d74
5
+ SHA512:
6
+ metadata.gz: 3b32f869d10ce6f4aa136d676e244a46800d8d6b7cf83043cbb86198a2b8cc7f754a300b5515fad5c45a09fbbed7184234def2e942865c879fe8fd7e45c1956a
7
+ data.tar.gz: 11414c0895523b948e26d3f081302e6ab433955ccdb2823defecb851f586b1d1a507b7bc3a7ea3492087bd66e09c25d232a8c86c38f8a88938e1f7027550762a
@@ -0,0 +1,33 @@
1
+ *.gem
2
+ *.rbc
3
+ .bundle
4
+ .config
5
+ .yardoc
6
+ InstalledFiles
7
+ _yardoc
8
+ coverage
9
+ doc/
10
+ lib/bundler/man
11
+ pkg
12
+ rdoc
13
+ spec/reports
14
+ test/tmp
15
+ test/version_tmp
16
+ tmp
17
+ integration/fixtures/dummy/log
18
+ integration/fixtures/dummy/*.gem
19
+ integration/fixtures/dummy/*.rbc
20
+ integration/fixtures/dummy/.bundle
21
+ integration/fixtures/dummy/.config
22
+ integration/fixtures/dummy/.yardoc
23
+ integration/fixtures/dummy/InstalledFiles
24
+ integration/fixtures/dummy/_yardoc
25
+ integration/fixtures/dummy/coverage
26
+ integration/fixtures/dummy/doc/
27
+ integration/fixtures/dummy/lib/bundler/man
28
+ integration/fixtures/dummy/pkg
29
+ integration/fixtures/dummy/rdoc
30
+ integration/fixtures/dummy/spec/reports
31
+ integration/fixtures/dummy/test/tmp
32
+ integration/fixtures/dummy/test/version_tmp
33
+ integration/fixtures/dummy/tmp
data/.pairs ADDED
@@ -0,0 +1,18 @@
1
+ pairs:
2
+ co: Cathy O'Connell; cathy
3
+ ck: Chien Kuo; ckuo
4
+ ra: Rasheed Abdul-Aziz; rabdulaziz
5
+ rm: Ryan McGarvey; ryan
6
+ mf: Michael Frederick; mike
7
+ tm: Todd Mohney; todd
8
+ my: Micah Young; myoung
9
+ ba: Alex Babkin; ababkin
10
+ rn: Ryan Nash; rnash
11
+ dmc: Dennis Cahillane; dcahillane
12
+ jl: Joe Letizia; joe
13
+ jlm: Joe Moore; joemoore
14
+ dc: Dan Connor; dconner
15
+ lo: Lee Ourand; lourand
16
+ email:
17
+ prefix: zephyr-eng
18
+ domain: gust.com
data/.rspec ADDED
@@ -0,0 +1 @@
1
+ --color
@@ -0,0 +1,3 @@
1
+ language: ruby
2
+ rvm:
3
+ - 2.0.0
data/Gemfile ADDED
@@ -0,0 +1,12 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in cancan_unit_test.gemspec
4
+ gemspec
5
+
6
+ # expected by the dummy app:
7
+ gem "rails"
8
+ gem "rspec-rails"
9
+ gem "jquery-rails"
10
+ gem "sqlite3"
11
+ gem "cancan"
12
+ gem "railties"
@@ -0,0 +1,131 @@
1
+ PATH
2
+ remote: .
3
+ specs:
4
+ cancan-unit-test (0.0.1)
5
+ activesupport
6
+ cancan
7
+
8
+ GEM
9
+ remote: https://rubygems.org/
10
+ specs:
11
+ actionmailer (3.2.13)
12
+ actionpack (= 3.2.13)
13
+ mail (~> 2.5.3)
14
+ actionpack (3.2.13)
15
+ activemodel (= 3.2.13)
16
+ activesupport (= 3.2.13)
17
+ builder (~> 3.0.0)
18
+ erubis (~> 2.7.0)
19
+ journey (~> 1.0.4)
20
+ rack (~> 1.4.5)
21
+ rack-cache (~> 1.2)
22
+ rack-test (~> 0.6.1)
23
+ sprockets (~> 2.2.1)
24
+ activemodel (3.2.13)
25
+ activesupport (= 3.2.13)
26
+ builder (~> 3.0.0)
27
+ activerecord (3.2.13)
28
+ activemodel (= 3.2.13)
29
+ activesupport (= 3.2.13)
30
+ arel (~> 3.0.2)
31
+ tzinfo (~> 0.3.29)
32
+ activeresource (3.2.13)
33
+ activemodel (= 3.2.13)
34
+ activesupport (= 3.2.13)
35
+ activesupport (3.2.13)
36
+ i18n (= 0.6.1)
37
+ multi_json (~> 1.0)
38
+ arel (3.0.2)
39
+ builder (3.0.4)
40
+ cancan (1.6.10)
41
+ coderay (1.0.9)
42
+ diff-lcs (1.2.4)
43
+ erubis (2.7.0)
44
+ hike (1.2.3)
45
+ i18n (0.6.1)
46
+ journey (1.0.4)
47
+ jquery-rails (3.0.2)
48
+ railties (>= 3.0, < 5.0)
49
+ thor (>= 0.14, < 2.0)
50
+ json (1.8.0)
51
+ mail (2.5.4)
52
+ mime-types (~> 1.16)
53
+ treetop (~> 1.4.8)
54
+ method_source (0.8.1)
55
+ mime-types (1.23)
56
+ multi_json (1.7.7)
57
+ polyglot (0.3.3)
58
+ pry (0.9.12.2)
59
+ coderay (~> 1.0.5)
60
+ method_source (~> 0.8)
61
+ slop (~> 3.4)
62
+ rack (1.4.5)
63
+ rack-cache (1.2)
64
+ rack (>= 0.4)
65
+ rack-ssl (1.3.3)
66
+ rack
67
+ rack-test (0.6.2)
68
+ rack (>= 1.0)
69
+ rails (3.2.13)
70
+ actionmailer (= 3.2.13)
71
+ actionpack (= 3.2.13)
72
+ activerecord (= 3.2.13)
73
+ activeresource (= 3.2.13)
74
+ activesupport (= 3.2.13)
75
+ bundler (~> 1.0)
76
+ railties (= 3.2.13)
77
+ railties (3.2.13)
78
+ actionpack (= 3.2.13)
79
+ activesupport (= 3.2.13)
80
+ rack-ssl (~> 1.3.2)
81
+ rake (>= 0.8.7)
82
+ rdoc (~> 3.4)
83
+ thor (>= 0.14.6, < 2.0)
84
+ rake (10.1.0)
85
+ rdoc (3.12.2)
86
+ json (~> 1.4)
87
+ rspec (2.14.0)
88
+ rspec-core (~> 2.14.0)
89
+ rspec-expectations (~> 2.14.0)
90
+ rspec-mocks (~> 2.14.0)
91
+ rspec-core (2.14.0)
92
+ rspec-expectations (2.14.0)
93
+ diff-lcs (>= 1.1.3, < 2.0)
94
+ rspec-mocks (2.14.1)
95
+ rspec-mocks-extensions (0.0.1)
96
+ rspec-rails (2.14.0)
97
+ actionpack (>= 3.0)
98
+ activesupport (>= 3.0)
99
+ railties (>= 3.0)
100
+ rspec-core (~> 2.14.0)
101
+ rspec-expectations (~> 2.14.0)
102
+ rspec-mocks (~> 2.14.0)
103
+ slop (3.4.5)
104
+ sprockets (2.2.2)
105
+ hike (~> 1.2)
106
+ multi_json (~> 1.0)
107
+ rack (~> 1.0)
108
+ tilt (~> 1.1, != 1.3.0)
109
+ sqlite3 (1.3.7)
110
+ thor (0.18.1)
111
+ tilt (1.4.1)
112
+ treetop (1.4.14)
113
+ polyglot
114
+ polyglot (>= 0.3.1)
115
+ tzinfo (0.3.37)
116
+
117
+ PLATFORMS
118
+ ruby
119
+
120
+ DEPENDENCIES
121
+ cancan
122
+ cancan-unit-test!
123
+ jquery-rails
124
+ pry
125
+ rails
126
+ railties
127
+ rake
128
+ rspec
129
+ rspec-mocks-extensions
130
+ rspec-rails
131
+ sqlite3
@@ -0,0 +1,22 @@
1
+ Copyright (c) 2013 Mike Frederick, mikefrederick
2
+
3
+ MIT License
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining
6
+ a copy of this software and associated documentation files (the
7
+ "Software"), to deal in the Software without restriction, including
8
+ without limitation the rights to use, copy, modify, merge, publish,
9
+ distribute, sublicense, and/or sell copies of the Software, and to
10
+ permit persons to whom the Software is furnished to do so, subject to
11
+ the following conditions:
12
+
13
+ The above copyright notice and this permission notice shall be
14
+ included in all copies or substantial portions of the Software.
15
+
16
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
20
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
21
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
22
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
@@ -0,0 +1,31 @@
1
+ [![Build Status](https://travis-ci.org/gustly/cancan_unit_test.png?branch=master)](https://travis-ci.org/gustly/cancan_unit_test)
2
+
3
+ # CancanUnitTest
4
+
5
+ RSpec helpers to easily stub CanCan's load_and_authorize_resource methods for better controller unit testing
6
+
7
+ ## Installation
8
+
9
+ Add this line to your application's Gemfile:
10
+
11
+ gem 'cancan_unit_test'
12
+
13
+ And then execute:
14
+
15
+ $ bundle
16
+
17
+ Or install it yourself as:
18
+
19
+ $ gem install cancan_unit_test
20
+
21
+ ## Usage
22
+
23
+ stub_load_and_authorize_resource(:model_name, options_hash)
24
+
25
+ ## Contributing
26
+
27
+ 1. Fork it
28
+ 2. Create your feature branch (`git checkout -b my-new-feature`)
29
+ 3. Commit your changes (`git commit -am 'Add some feature'`)
30
+ 4. Push to the branch (`git push origin my-new-feature`)
31
+ 5. Create new Pull Request
@@ -0,0 +1,15 @@
1
+ require 'bundler/gem_tasks'
2
+ require 'rspec/core/rake_task'
3
+ require 'rails'
4
+ require 'rspec-rails'
5
+
6
+ RSpec::Core::RakeTask.new(:spec)
7
+ RSpec::Core::RakeTask.new(:integration) do |integration_task|
8
+ integration_task.pattern = "integration/**/*_spec.rb"
9
+ end
10
+
11
+ task :default => [:spec, :integration]
12
+
13
+ APP_RAKEFILE = File.expand_path("../integration/fixtures/dummy/Rakefile", __FILE__)
14
+ load 'rails/tasks/engine.rake'
15
+
@@ -0,0 +1,31 @@
1
+ # -*- encoding: utf-8 -*-
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'cancan_unit_test/version'
5
+
6
+ Gem::Specification.new do |gem|
7
+ gem.name = "cancan-unit-test"
8
+ gem.version = CancanUnitTest::VERSION
9
+ gem.authors = ["Todd Mohney, Rasheed Abdul-Aziz"]
10
+ gem.email = ["zephyr-dev@googlegroups.com"]
11
+ gem.description = %q{Unit test helpers for CanCan}
12
+ gem.summary = %q{Unit test helpers for CanCan}
13
+ gem.homepage = ""
14
+
15
+ gem.files = `git ls-files`.split($/)
16
+ gem.test_files = gem.files.grep(%r{^(integraton|spec)/})
17
+ gem.require_paths = ["lib"]
18
+
19
+ # Expected by the gem when installed
20
+ gem.add_dependency "cancan"
21
+ gem.add_dependency "activesupport"
22
+
23
+ # expected for running the gem dev env
24
+ gem.add_development_dependency "rake"
25
+ gem.add_development_dependency "pry"
26
+ gem.add_development_dependency "rspec"
27
+ gem.add_development_dependency "rspec-rails"
28
+ gem.add_development_dependency "sqlite3"
29
+ gem.add_development_dependency "railties"
30
+ gem.add_development_dependency "rspec-mocks-extensions"
31
+ end
@@ -0,0 +1,25 @@
1
+ require 'integration_helper'
2
+
3
+ describe PostsController do
4
+
5
+ context "not stubbing" do
6
+ it "uses can can" do
7
+ post :create
8
+ assigns(:post).should be_a Post
9
+ end
10
+ end
11
+
12
+ context "stubbing" do
13
+ let_double(:article)
14
+
15
+ before do
16
+ stub_load_and_authorize_resource(:post) { article }
17
+ end
18
+
19
+ it "uses the stub" do
20
+ post :create
21
+ assigns(:post).should == article
22
+ end
23
+ end
24
+
25
+ end
@@ -0,0 +1,261 @@
1
+ == Welcome to Rails
2
+
3
+ Rails is a web-application framework that includes everything needed to create
4
+ database-backed web applications according to the Model-View-Control pattern.
5
+
6
+ This pattern splits the view (also called the presentation) into "dumb"
7
+ templates that are primarily responsible for inserting pre-built data in between
8
+ HTML tags. The model contains the "smart" domain objects (such as Account,
9
+ Product, Person, Post) that holds all the business logic and knows how to
10
+ persist themselves to a database. The controller handles the incoming requests
11
+ (such as Save New Account, Update Product, Show Post) by manipulating the model
12
+ and directing data to the view.
13
+
14
+ In Rails, the model is handled by what's called an object-relational mapping
15
+ layer entitled Active Record. This layer allows you to present the data from
16
+ database rows as objects and embellish these data objects with business logic
17
+ methods. You can read more about Active Record in
18
+ link:files/vendor/rails/activerecord/README.html.
19
+
20
+ The controller and view are handled by the Action Pack, which handles both
21
+ layers by its two parts: Action View and Action Controller. These two layers
22
+ are bundled in a single package due to their heavy interdependence. This is
23
+ unlike the relationship between the Active Record and Action Pack that is much
24
+ more separate. Each of these packages can be used independently outside of
25
+ Rails. You can read more about Action Pack in
26
+ link:files/vendor/rails/actionpack/README.html.
27
+
28
+
29
+ == Getting Started
30
+
31
+ 1. At the command prompt, create a new Rails application:
32
+ <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
33
+
34
+ 2. Change directory to <tt>myapp</tt> and start the web server:
35
+ <tt>cd myapp; rails server</tt> (run with --help for options)
36
+
37
+ 3. Go to http://localhost:3000/ and you'll see:
38
+ "Welcome aboard: You're riding Ruby on Rails!"
39
+
40
+ 4. Follow the guidelines to start developing your application. You can find
41
+ the following resources handy:
42
+
43
+ * The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
44
+ * Ruby on Rails Tutorial Book: http://www.railstutorial.org/
45
+
46
+
47
+ == Debugging Rails
48
+
49
+ Sometimes your application goes wrong. Fortunately there are a lot of tools that
50
+ will help you debug it and get it back on the rails.
51
+
52
+ First area to check is the application log files. Have "tail -f" commands
53
+ running on the server.log and development.log. Rails will automatically display
54
+ debugging and runtime information to these files. Debugging info will also be
55
+ shown in the browser on requests from 127.0.0.1.
56
+
57
+ You can also log your own messages directly into the log file from your code
58
+ using the Ruby logger class from inside your controllers. Example:
59
+
60
+ class WeblogController < ActionController::Base
61
+ def destroy
62
+ @weblog = Weblog.find(params[:id])
63
+ @weblog.destroy
64
+ logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
65
+ end
66
+ end
67
+
68
+ The result will be a message in your log file along the lines of:
69
+
70
+ Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
71
+
72
+ More information on how to use the logger is at http://www.ruby-doc.org/core/
73
+
74
+ Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
75
+ several books available online as well:
76
+
77
+ * Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
78
+ * Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
79
+
80
+ These two books will bring you up to speed on the Ruby language and also on
81
+ programming in general.
82
+
83
+
84
+ == Debugger
85
+
86
+ Debugger support is available through the debugger command when you start your
87
+ Mongrel or WEBrick server with --debugger. This means that you can break out of
88
+ execution at any point in the code, investigate and change the model, and then,
89
+ resume execution! You need to install ruby-debug to run the server in debugging
90
+ mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
91
+
92
+ class WeblogController < ActionController::Base
93
+ def index
94
+ @posts = Post.all
95
+ debugger
96
+ end
97
+ end
98
+
99
+ So the controller will accept the action, run the first line, then present you
100
+ with a IRB prompt in the server window. Here you can do things like:
101
+
102
+ >> @posts.inspect
103
+ => "[#<Post:0x14a6be8
104
+ @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
105
+ #<Post:0x14a6620
106
+ @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
107
+ >> @posts.first.title = "hello from a debugger"
108
+ => "hello from a debugger"
109
+
110
+ ...and even better, you can examine how your runtime objects actually work:
111
+
112
+ >> f = @posts.first
113
+ => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
114
+ >> f.
115
+ Display all 152 possibilities? (y or n)
116
+
117
+ Finally, when you're ready to resume execution, you can enter "cont".
118
+
119
+
120
+ == Console
121
+
122
+ The console is a Ruby shell, which allows you to interact with your
123
+ application's domain model. Here you'll have all parts of the application
124
+ configured, just like it is when the application is running. You can inspect
125
+ domain models, change values, and save to the database. Starting the script
126
+ without arguments will launch it in the development environment.
127
+
128
+ To start the console, run <tt>rails console</tt> from the application
129
+ directory.
130
+
131
+ Options:
132
+
133
+ * Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
134
+ made to the database.
135
+ * Passing an environment name as an argument will load the corresponding
136
+ environment. Example: <tt>rails console production</tt>.
137
+
138
+ To reload your controllers and models after launching the console run
139
+ <tt>reload!</tt>
140
+
141
+ More information about irb can be found at:
142
+ link:http://www.rubycentral.org/pickaxe/irb.html
143
+
144
+
145
+ == dbconsole
146
+
147
+ You can go to the command line of your database directly through <tt>rails
148
+ dbconsole</tt>. You would be connected to the database with the credentials
149
+ defined in database.yml. Starting the script without arguments will connect you
150
+ to the development database. Passing an argument will connect you to a different
151
+ database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
152
+ PostgreSQL and SQLite 3.
153
+
154
+ == Description of Contents
155
+
156
+ The default directory structure of a generated Ruby on Rails application:
157
+
158
+ |-- app
159
+ | |-- assets
160
+ | | |-- images
161
+ | | |-- javascripts
162
+ | | `-- stylesheets
163
+ | |-- controllers
164
+ | |-- helpers
165
+ | |-- mailers
166
+ | |-- models
167
+ | `-- views
168
+ | `-- layouts
169
+ |-- config
170
+ | |-- environments
171
+ | |-- initializers
172
+ | `-- locales
173
+ |-- db
174
+ |-- doc
175
+ |-- lib
176
+ | |-- assets
177
+ | `-- tasks
178
+ |-- log
179
+ |-- public
180
+ |-- script
181
+ |-- test
182
+ | |-- fixtures
183
+ | |-- functional
184
+ | |-- integration
185
+ | |-- performance
186
+ | `-- unit
187
+ |-- tmp
188
+ | `-- cache
189
+ | `-- assets
190
+ `-- vendor
191
+ |-- assets
192
+ | |-- javascripts
193
+ | `-- stylesheets
194
+ `-- plugins
195
+
196
+ app
197
+ Holds all the code that's specific to this particular application.
198
+
199
+ app/assets
200
+ Contains subdirectories for images, stylesheets, and JavaScript files.
201
+
202
+ app/controllers
203
+ Holds controllers that should be named like weblogs_controller.rb for
204
+ automated URL mapping. All controllers should descend from
205
+ ApplicationController which itself descends from ActionController::Base.
206
+
207
+ app/models
208
+ Holds models that should be named like post.rb. Models descend from
209
+ ActiveRecord::Base by default.
210
+
211
+ app/views
212
+ Holds the template files for the view that should be named like
213
+ weblogs/index.html.erb for the WeblogsController#index action. All views use
214
+ eRuby syntax by default.
215
+
216
+ app/views/layouts
217
+ Holds the template files for layouts to be used with views. This models the
218
+ common header/footer method of wrapping views. In your views, define a layout
219
+ using the <tt>layout :default</tt> and create a file named default.html.erb.
220
+ Inside default.html.erb, call <% yield %> to render the view using this
221
+ layout.
222
+
223
+ app/helpers
224
+ Holds view helpers that should be named like weblogs_helper.rb. These are
225
+ generated for you automatically when using generators for controllers.
226
+ Helpers can be used to wrap functionality for your views into methods.
227
+
228
+ config
229
+ Configuration files for the Rails environment, the routing map, the database,
230
+ and other dependencies.
231
+
232
+ db
233
+ Contains the database schema in schema.rb. db/migrate contains all the
234
+ sequence of Migrations for your schema.
235
+
236
+ doc
237
+ This directory is where your application documentation will be stored when
238
+ generated using <tt>rake doc:app</tt>
239
+
240
+ lib
241
+ Application specific libraries. Basically, any kind of custom code that
242
+ doesn't belong under controllers, models, or helpers. This directory is in
243
+ the load path.
244
+
245
+ public
246
+ The directory available for the web server. Also contains the dispatchers and the
247
+ default HTML files. This should be set as the DOCUMENT_ROOT of your web
248
+ server.
249
+
250
+ script
251
+ Helper scripts for automation and generation.
252
+
253
+ test
254
+ Unit and functional tests along with fixtures. When using the rails generate
255
+ command, template test files will be generated for you and placed in this
256
+ directory.
257
+
258
+ vendor
259
+ External libraries that the application depends on. Also includes the plugins
260
+ subdirectory. If the app has frozen rails, those gems also go here, under
261
+ vendor/rails/. This directory is in the load path.