tuttle 0.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (85) hide show
  1. checksums.yaml +7 -0
  2. data/MIT-LICENSE +20 -0
  3. data/README.md +22 -0
  4. data/Rakefile +37 -0
  5. data/app/assets/javascripts/tuttle/application.js +12 -0
  6. data/app/assets/stylesheets/scaffold.css +56 -0
  7. data/app/assets/stylesheets/tuttle/application.css +71 -0
  8. data/app/controllers/tuttle/application_controller.rb +20 -0
  9. data/app/controllers/tuttle/cancancan_controller.rb +29 -0
  10. data/app/controllers/tuttle/devise_controller.rb +12 -0
  11. data/app/controllers/tuttle/home_controller.rb +14 -0
  12. data/app/controllers/tuttle/rails_controller.rb +52 -0
  13. data/app/controllers/tuttle/ruby_controller.rb +10 -0
  14. data/app/helpers/tuttle/application_helper.rb +4 -0
  15. data/app/views/layouts/tuttle/application.html.erb +68 -0
  16. data/app/views/tuttle/cancancan/_rule_table.html.erb +31 -0
  17. data/app/views/tuttle/cancancan/index.html.erb +45 -0
  18. data/app/views/tuttle/cancancan/rule_tester.html.erb +68 -0
  19. data/app/views/tuttle/devise/index.html.erb +84 -0
  20. data/app/views/tuttle/home/index.html.erb +74 -0
  21. data/app/views/tuttle/rails/assets.html.erb +44 -0
  22. data/app/views/tuttle/rails/controllers.html.erb +10 -0
  23. data/app/views/tuttle/rails/database.html.erb +46 -0
  24. data/app/views/tuttle/rails/helpers.html.erb +35 -0
  25. data/app/views/tuttle/rails/index.html.erb +235 -0
  26. data/app/views/tuttle/rails/instrumentation.html.erb +22 -0
  27. data/app/views/tuttle/rails/models.html.erb +61 -0
  28. data/app/views/tuttle/rails/routes.html.erb +37 -0
  29. data/app/views/tuttle/ruby/index.html.erb +83 -0
  30. data/config/routes.rb +21 -0
  31. data/lib/tasks/tuttle_tasks.rake +4 -0
  32. data/lib/tuttle.rb +4 -0
  33. data/lib/tuttle/engine.rb +39 -0
  34. data/lib/tuttle/version.rb +3 -0
  35. data/test/controllers/tuttle/cancancan_controller_test.rb +60 -0
  36. data/test/controllers/tuttle/devise_controller_test.rb +12 -0
  37. data/test/controllers/tuttle/home_controller_test.rb +13 -0
  38. data/test/controllers/tuttle/rails_controller_test.rb +56 -0
  39. data/test/controllers/tuttle/ruby_controller_test.rb +12 -0
  40. data/test/dummy/Gemfile.lock +142 -0
  41. data/test/dummy/README.rdoc +261 -0
  42. data/test/dummy/Rakefile +7 -0
  43. data/test/dummy/app/assets/javascripts/application.js +15 -0
  44. data/test/dummy/app/assets/stylesheets/application.css +13 -0
  45. data/test/dummy/app/controllers/application_controller.rb +3 -0
  46. data/test/dummy/app/helpers/application_helper.rb +2 -0
  47. data/test/dummy/app/models/ability.rb +7 -0
  48. data/test/dummy/app/models/user.rb +6 -0
  49. data/test/dummy/app/views/layouts/application.html.erb +14 -0
  50. data/test/dummy/config.ru +4 -0
  51. data/test/dummy/config/application.rb +52 -0
  52. data/test/dummy/config/boot.rb +11 -0
  53. data/test/dummy/config/database.yml +25 -0
  54. data/test/dummy/config/environment.rb +5 -0
  55. data/test/dummy/config/environments/development.rb +30 -0
  56. data/test/dummy/config/environments/test.rb +38 -0
  57. data/test/dummy/config/initializers/backtrace_silencers.rb +7 -0
  58. data/test/dummy/config/initializers/devise.rb +257 -0
  59. data/test/dummy/config/initializers/inflections.rb +15 -0
  60. data/test/dummy/config/initializers/mime_types.rb +5 -0
  61. data/test/dummy/config/initializers/secret_token.rb +7 -0
  62. data/test/dummy/config/initializers/session_store.rb +8 -0
  63. data/test/dummy/config/initializers/wrap_parameters.rb +14 -0
  64. data/test/dummy/config/locales/en.yml +5 -0
  65. data/test/dummy/config/routes.rb +6 -0
  66. data/test/dummy/db/migrate/20141229204528_devise_create_users.rb +42 -0
  67. data/test/dummy/db/schema.rb +34 -0
  68. data/test/dummy/public/404.html +26 -0
  69. data/test/dummy/public/422.html +26 -0
  70. data/test/dummy/public/500.html +25 -0
  71. data/test/dummy/public/favicon.ico +0 -0
  72. data/test/dummy/script/rails +6 -0
  73. data/test/dummy/test/fixtures/users.yml +6 -0
  74. data/test/dummy/test/models/user_test.rb +7 -0
  75. data/test/dummy/tmp/cache/assets/test/sprockets/00091e0cb6df543a8e704290f4dec8db +0 -0
  76. data/test/dummy/tmp/cache/assets/test/sprockets/11599cd5b5d6a0a58a5e98c0902e1997 +0 -0
  77. data/test/dummy/tmp/cache/assets/test/sprockets/9b2e26c1e54d4ff5ae04270e8f03907f +0 -0
  78. data/test/dummy/tmp/cache/assets/test/sprockets/a65793481a75afa9f660d1032ee66ef5 +0 -0
  79. data/test/dummy/tmp/cache/assets/test/sprockets/d9450766086a9f3f994e8c4a2273bfaa +0 -0
  80. data/test/dummy/tmp/cache/assets/test/sprockets/e117b0425a7b9daef8a213c1a2203f00 +0 -0
  81. data/test/integration/navigation_test.rb +9 -0
  82. data/test/test_helper.rb +37 -0
  83. data/test/tuttle_test.rb +7 -0
  84. data/test/unit/tuttle/note_test.rb +9 -0
  85. metadata +219 -0
@@ -0,0 +1,4 @@
1
+ # desc "Explaining what the task does"
2
+ # task :tuttle do
3
+ # # Task goes here
4
+ # end
data/lib/tuttle.rb ADDED
@@ -0,0 +1,4 @@
1
+ require 'tuttle/engine'
2
+
3
+ module Tuttle
4
+ end
@@ -0,0 +1,39 @@
1
+ module Tuttle
2
+ class Engine < ::Rails::Engine
3
+ isolate_namespace Tuttle
4
+
5
+ attr_accessor :reload_needed
6
+ attr_accessor :events, :event_counts
7
+ attr_accessor :session_start, :session_id
8
+
9
+ initializer :tuttle_startup do
10
+ Tuttle::Engine.session_start = Time.now
11
+ Tuttle::Engine.session_id = SecureRandom.uuid
12
+ end
13
+
14
+ initializer :tuttle_assets_precompile do |app|
15
+ app.config.assets.precompile += %w(tuttle/application.css tuttle/application.js )
16
+ end
17
+
18
+ initializer :tuttle_track_reloads, group: :all do
19
+ ActionDispatch::Reloader.to_prepare do
20
+ Rails.logger.warn('Tuttle: ActionDispatch::Reloader called to_prepare')
21
+ Tuttle::Engine.reload_needed = true
22
+ end
23
+ end
24
+
25
+ initializer :tuttle_global_instrumenter, group: :all do
26
+ Tuttle::Engine.events = []
27
+ Tuttle::Engine.event_counts = Hash.new(0)
28
+
29
+ # For now, only instrument non-production mode
30
+ return if Rails.env.production?
31
+
32
+ ActiveSupport::Notifications.subscribe(/.*/) do |*args|
33
+ event = ActiveSupport::Notifications::Event.new(*args)
34
+ Tuttle::Engine.events << event
35
+ Tuttle::Engine.event_counts[event.name] += 1
36
+ end
37
+ end
38
+ end
39
+ end
@@ -0,0 +1,3 @@
1
+ module Tuttle
2
+ VERSION = '0.0.1'
3
+ end
@@ -0,0 +1,60 @@
1
+ require 'test_helper'
2
+
3
+ module Tuttle
4
+ class CancancanControllerTest < ActionController::TestCase
5
+
6
+ test 'should get index' do
7
+ get :index
8
+ assert_response :success
9
+
10
+ assert_not_nil assigns(:cancan_user)
11
+ assert_not_nil assigns(:ability)
12
+ end
13
+
14
+ test 'should get rule_tester' do
15
+ get :rule_tester
16
+ assert_response :success
17
+
18
+ assert_not_nil assigns(:action)
19
+ assert_not_nil assigns(:cancan_user)
20
+ assert_not_nil assigns(:ability)
21
+ assert_nil assigns(:subject)
22
+ end
23
+
24
+ test 'should get rule_tester with subject' do
25
+ get :rule_tester, { :action_name => 'manage', :subject_class => 'User' }
26
+
27
+ assert_response :success
28
+
29
+ assert_not_nil assigns(:action)
30
+ assert_not_nil assigns(:cancan_user)
31
+ assert_not_nil assigns(:ability)
32
+ assert_not_nil assigns(:subject)
33
+ end
34
+
35
+ test 'should get rule_tester with subject and subject_id' do
36
+ get :rule_tester, { :action_name => 'manage', :subject_class => 'User', :subject_id => 1 }
37
+
38
+ assert_response :success
39
+
40
+ assert_not_nil assigns(:action)
41
+ assert_not_nil assigns(:cancan_user)
42
+ assert_not_nil assigns(:ability)
43
+ assert_not_nil assigns(:subject)
44
+ end
45
+
46
+ test 'should get rule_tester with invalid subject' do
47
+
48
+ get :rule_tester, { :action_name => 'manage', :subject_class => 'ClassDoesNotExist' }
49
+
50
+ assert_response :success
51
+
52
+ assert_not_nil assigns(:action)
53
+ assert_not_nil assigns(:cancan_user)
54
+ assert_not_nil assigns(:ability)
55
+ assert_nil assigns(:subject)
56
+ end
57
+
58
+ end
59
+
60
+ end
@@ -0,0 +1,12 @@
1
+ require 'test_helper'
2
+
3
+ module Tuttle
4
+ class DeviseControllerTest < ActionController::TestCase
5
+
6
+ test 'should get index' do
7
+ get :index
8
+ assert_response :success
9
+ end
10
+
11
+ end
12
+ end
@@ -0,0 +1,13 @@
1
+ require 'test_helper'
2
+
3
+ module Tuttle
4
+ class HomeControllerTest < ActionController::TestCase
5
+
6
+ test 'should get index' do
7
+ get :index
8
+ assert_response :success
9
+ assert_not_nil assigns(:event_counts)
10
+ end
11
+
12
+ end
13
+ end
@@ -0,0 +1,56 @@
1
+ require 'test_helper'
2
+
3
+ module Tuttle
4
+ class RailsControllerTest < ActionController::TestCase
5
+
6
+ test 'should get index' do
7
+ get :index
8
+ assert_response :success
9
+ end
10
+
11
+ test 'should get controllers' do
12
+ get :controllers
13
+ assert_response :success
14
+ assert_not_nil assigns(:controllers)
15
+ end
16
+
17
+ test 'should get models' do
18
+ get :models
19
+ assert_response :success
20
+ assert_not_nil assigns(:models)
21
+ end
22
+
23
+ test 'should get database' do
24
+ get :database
25
+ assert_response :success
26
+ assert_not_nil assigns(:conn)
27
+ end
28
+
29
+ test 'should get helpers' do
30
+ get :helpers
31
+ assert_response :success
32
+ assert_not_nil assigns(:helpers)
33
+ end
34
+
35
+ test 'should get assets' do
36
+ get :assets
37
+ assert_response :success
38
+ assert_not_nil assigns(:sprockets)
39
+ assert_not_nil assigns(:engines)
40
+ end
41
+
42
+ test 'should get routes' do
43
+ get :routes
44
+ assert_response :success
45
+ assert_not_nil assigns(:routes)
46
+ end
47
+
48
+ test 'should get instrumentation' do
49
+ get :instrumentation
50
+ assert_response :success
51
+ assert_not_nil assigns(:events)
52
+ assert_not_nil assigns(:event_counts)
53
+ end
54
+ end
55
+
56
+ end
@@ -0,0 +1,12 @@
1
+ require 'test_helper'
2
+
3
+ module Tuttle
4
+ class RubyControllerTest < ActionController::TestCase
5
+
6
+ test 'should get index' do
7
+ get :index
8
+ assert_response :success
9
+ end
10
+
11
+ end
12
+ end
@@ -0,0 +1,142 @@
1
+ PATH
2
+ remote: ../..
3
+ specs:
4
+ tuttle (0.0.1)
5
+ rails (>= 4.1.8)
6
+
7
+ GEM
8
+ remote: https://rubygems.org/
9
+ specs:
10
+ actionmailer (4.2.0)
11
+ actionpack (= 4.2.0)
12
+ actionview (= 4.2.0)
13
+ activejob (= 4.2.0)
14
+ mail (~> 2.5, >= 2.5.4)
15
+ rails-dom-testing (~> 1.0, >= 1.0.5)
16
+ actionpack (4.2.0)
17
+ actionview (= 4.2.0)
18
+ activesupport (= 4.2.0)
19
+ rack (~> 1.6.0)
20
+ rack-test (~> 0.6.2)
21
+ rails-dom-testing (~> 1.0, >= 1.0.5)
22
+ rails-html-sanitizer (~> 1.0, >= 1.0.1)
23
+ actionview (4.2.0)
24
+ activesupport (= 4.2.0)
25
+ builder (~> 3.1)
26
+ erubis (~> 2.7.0)
27
+ rails-dom-testing (~> 1.0, >= 1.0.5)
28
+ rails-html-sanitizer (~> 1.0, >= 1.0.1)
29
+ activejob (4.2.0)
30
+ activesupport (= 4.2.0)
31
+ globalid (>= 0.3.0)
32
+ activemodel (4.2.0)
33
+ activesupport (= 4.2.0)
34
+ builder (~> 3.1)
35
+ activerecord (4.2.0)
36
+ activemodel (= 4.2.0)
37
+ activesupport (= 4.2.0)
38
+ arel (~> 6.0)
39
+ activesupport (4.2.0)
40
+ i18n (~> 0.7)
41
+ json (~> 1.7, >= 1.7.7)
42
+ minitest (~> 5.1)
43
+ thread_safe (~> 0.3, >= 0.3.4)
44
+ tzinfo (~> 1.1)
45
+ arel (6.0.0)
46
+ bcrypt (3.1.9)
47
+ builder (3.2.2)
48
+ cancancan (1.9.2)
49
+ codeclimate-test-reporter (0.4.4)
50
+ simplecov (>= 0.7.1, < 1.0.0)
51
+ devise (3.4.1)
52
+ bcrypt (~> 3.0)
53
+ orm_adapter (~> 0.1)
54
+ railties (>= 3.2.6, < 5)
55
+ responders
56
+ thread_safe (~> 0.1)
57
+ warden (~> 1.2.3)
58
+ docile (1.1.5)
59
+ erubis (2.7.0)
60
+ globalid (0.3.0)
61
+ activesupport (>= 4.1.0)
62
+ hike (1.2.3)
63
+ i18n (0.7.0)
64
+ jquery-rails (4.0.3)
65
+ rails-dom-testing (~> 1.0)
66
+ railties (>= 4.2.0)
67
+ thor (>= 0.14, < 2.0)
68
+ json (1.8.1)
69
+ loofah (2.0.1)
70
+ nokogiri (>= 1.5.9)
71
+ mail (2.6.3)
72
+ mime-types (>= 1.16, < 3)
73
+ mime-types (2.4.3)
74
+ mini_portile (0.6.2)
75
+ minitest (5.5.0)
76
+ multi_json (1.10.1)
77
+ nokogiri (1.6.5)
78
+ mini_portile (~> 0.6.0)
79
+ orm_adapter (0.5.0)
80
+ rack (1.6.0)
81
+ rack-test (0.6.2)
82
+ rack (>= 1.0)
83
+ rails (4.2.0)
84
+ actionmailer (= 4.2.0)
85
+ actionpack (= 4.2.0)
86
+ actionview (= 4.2.0)
87
+ activejob (= 4.2.0)
88
+ activemodel (= 4.2.0)
89
+ activerecord (= 4.2.0)
90
+ activesupport (= 4.2.0)
91
+ bundler (>= 1.3.0, < 2.0)
92
+ railties (= 4.2.0)
93
+ sprockets-rails
94
+ rails-deprecated_sanitizer (1.0.3)
95
+ activesupport (>= 4.2.0.alpha)
96
+ rails-dom-testing (1.0.5)
97
+ activesupport (>= 4.2.0.beta, < 5.0)
98
+ nokogiri (~> 1.6.0)
99
+ rails-deprecated_sanitizer (>= 1.0.1)
100
+ rails-html-sanitizer (1.0.1)
101
+ loofah (~> 2.0)
102
+ railties (4.2.0)
103
+ actionpack (= 4.2.0)
104
+ activesupport (= 4.2.0)
105
+ rake (>= 0.8.7)
106
+ thor (>= 0.18.1, < 2.0)
107
+ rake (10.4.2)
108
+ responders (2.0.2)
109
+ railties (>= 4.2.0.alpha, < 5)
110
+ simplecov (0.9.1)
111
+ docile (~> 1.1.0)
112
+ multi_json (~> 1.0)
113
+ simplecov-html (~> 0.8.0)
114
+ simplecov-html (0.8.0)
115
+ sprockets (2.12.3)
116
+ hike (~> 1.2)
117
+ multi_json (~> 1.0)
118
+ rack (~> 1.0)
119
+ tilt (~> 1.1, != 1.3.0)
120
+ sprockets-rails (2.2.2)
121
+ actionpack (>= 3.0)
122
+ activesupport (>= 3.0)
123
+ sprockets (>= 2.8, < 4.0)
124
+ sqlite3 (1.3.10)
125
+ thor (0.19.1)
126
+ thread_safe (0.3.4)
127
+ tilt (1.4.1)
128
+ tzinfo (1.2.2)
129
+ thread_safe (~> 0.1)
130
+ warden (1.2.3)
131
+ rack (>= 1.0)
132
+
133
+ PLATFORMS
134
+ ruby
135
+
136
+ DEPENDENCIES
137
+ cancancan
138
+ codeclimate-test-reporter
139
+ devise
140
+ jquery-rails
141
+ sqlite3
142
+ tuttle!
@@ -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.