pparams 0.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (53) hide show
  1. data/.document +5 -0
  2. data/.gitignore +22 -0
  3. data/LICENSE +20 -0
  4. data/README.rdoc +26 -0
  5. data/Rakefile +33 -0
  6. data/VERSION +1 -0
  7. data/lib/pparams.rb +14 -0
  8. data/pparams.gemspec +114 -0
  9. data/test/helper.rb +9 -0
  10. data/test/rails3x_root/.gitignore +4 -0
  11. data/test/rails3x_root/Gemfile +32 -0
  12. data/test/rails3x_root/Gemfile.lock +77 -0
  13. data/test/rails3x_root/README +256 -0
  14. data/test/rails3x_root/Rakefile +7 -0
  15. data/test/rails3x_root/app/controllers/application_controller.rb +3 -0
  16. data/test/rails3x_root/app/controllers/public_controller.rb +13 -0
  17. data/test/rails3x_root/app/helpers/application_helper.rb +2 -0
  18. data/test/rails3x_root/app/helpers/public_helper.rb +2 -0
  19. data/test/rails3x_root/app/views/layouts/application.html.erb +14 -0
  20. data/test/rails3x_root/app/views/public/test.html.erb +1 -0
  21. data/test/rails3x_root/config.ru +4 -0
  22. data/test/rails3x_root/config/application.rb +47 -0
  23. data/test/rails3x_root/config/boot.rb +13 -0
  24. data/test/rails3x_root/config/environment.rb +5 -0
  25. data/test/rails3x_root/config/environments/development.rb +26 -0
  26. data/test/rails3x_root/config/environments/production.rb +49 -0
  27. data/test/rails3x_root/config/environments/test.rb +35 -0
  28. data/test/rails3x_root/config/initializers/backtrace_silencers.rb +7 -0
  29. data/test/rails3x_root/config/initializers/inflections.rb +10 -0
  30. data/test/rails3x_root/config/initializers/mime_types.rb +5 -0
  31. data/test/rails3x_root/config/initializers/secret_token.rb +7 -0
  32. data/test/rails3x_root/config/initializers/session_store.rb +8 -0
  33. data/test/rails3x_root/config/locales/en.yml +5 -0
  34. data/test/rails3x_root/config/routes.rb +58 -0
  35. data/test/rails3x_root/db/seeds.rb +7 -0
  36. data/test/rails3x_root/lib/tasks/.gitkeep +0 -0
  37. data/test/rails3x_root/public/404.html +26 -0
  38. data/test/rails3x_root/public/422.html +26 -0
  39. data/test/rails3x_root/public/500.html +26 -0
  40. data/test/rails3x_root/public/favicon.ico +0 -0
  41. data/test/rails3x_root/public/images/rails.png +0 -0
  42. data/test/rails3x_root/public/javascripts/.gitkeep +0 -0
  43. data/test/rails3x_root/public/javascripts/application.js +0 -0
  44. data/test/rails3x_root/public/robots.txt +5 -0
  45. data/test/rails3x_root/public/stylesheets/.gitkeep +0 -0
  46. data/test/rails3x_root/script/rails +6 -0
  47. data/test/rails3x_root/test/functional/public_controller_test.rb +16 -0
  48. data/test/rails3x_root/test/performance/browsing_test.rb +9 -0
  49. data/test/rails3x_root/test/test_helper.rb +7 -0
  50. data/test/rails3x_root/test/unit/helpers/public_helper_test.rb +4 -0
  51. data/test/rails3x_root/vendor/plugins/.gitkeep +0 -0
  52. data/test/test_pparams.rb +7 -0
  53. metadata +138 -0
data/.document ADDED
@@ -0,0 +1,5 @@
1
+ README.rdoc
2
+ lib/**/*.rb
3
+ bin/*
4
+ features/**/*.feature
5
+ LICENSE
data/.gitignore ADDED
@@ -0,0 +1,22 @@
1
+ ## MAC OS
2
+ .DS_Store
3
+
4
+ ## TEXTMATE
5
+ *.tmproj
6
+ tmtags
7
+
8
+ ## EMACS
9
+ *~
10
+ \#*
11
+ .\#*
12
+
13
+ ## VIM
14
+ *.swp
15
+
16
+ ## PROJECT::GENERAL
17
+ coverage
18
+ rdoc
19
+ pkg
20
+
21
+ ## PROJECT::SPECIFIC
22
+ doc
data/LICENSE ADDED
@@ -0,0 +1,20 @@
1
+ Copyright (c) 2009 Kevin Swope
2
+
3
+ Permission is hereby granted, free of charge, to any person obtaining
4
+ a copy of this software and associated documentation files (the
5
+ "Software"), to deal in the Software without restriction, including
6
+ without limitation the rights to use, copy, modify, merge, publish,
7
+ distribute, sublicense, and/or sell copies of the Software, and to
8
+ permit persons to whom the Software is furnished to do so, subject to
9
+ the following conditions:
10
+
11
+ The above copyright notice and this permission notice shall be
12
+ included in all copies or substantial portions of the Software.
13
+
14
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
17
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
18
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
19
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
20
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
data/README.rdoc ADDED
@@ -0,0 +1,26 @@
1
+ = pparams
2
+
3
+ pparams is ridiculously simple rails plugin that aliases params to p.
4
+
5
+ Instead of
6
+
7
+ user = User.find_by_email( params[:email] )
8
+
9
+ you can use
10
+
11
+ user = User.find_by_email( p[:email] )
12
+
13
+ === Sounds dumb
14
+
15
+ But I often find myself with one-liners, with mutiple calls to params,
16
+ that don't fit on a single line, and that bugs me.
17
+
18
+ For example, this doesn't fit indented, without pparams, in 80 columns:
19
+
20
+ user = User.new(:email => p[:email_new], :password => p[:password_new])
21
+
22
+ The ruby function p, which is like puts with inspect, isn't that useful in rails,
23
+ so its no big deal to overwrite it, especially since I use clog for logging.
24
+
25
+
26
+ Copyright (c) 2010 Kevin Swope. See LICENSE for details.
data/Rakefile ADDED
@@ -0,0 +1,33 @@
1
+ require 'rubygems'
2
+ require 'rake'
3
+
4
+ begin
5
+ require 'jeweler'
6
+ Jeweler::Tasks.new do |gem|
7
+ desc = 'alias params to p in rails'
8
+ gem.name = "pparams"
9
+ gem.summary = desc
10
+ gem.description = desc
11
+ gem.email = "git-kevdev@snkmail.com"
12
+ gem.homepage = "http://github.com/kswope/pparams"
13
+ gem.authors = ["Kevin Swope"]
14
+ # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
15
+ end
16
+ Jeweler::GemcutterTasks.new
17
+ rescue LoadError
18
+ puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
19
+ end
20
+
21
+ desc "build README.html from README.doc (for previewing in browser)"
22
+ task :readme do
23
+ system "rdoc README.rdoc"
24
+ end
25
+
26
+ task :test => :default
27
+ task :default => :test_rails3x
28
+
29
+ task :test_rails3x do |t|
30
+ chdir "test/rails3x_root" do
31
+ system "rake"
32
+ end
33
+ end
data/VERSION ADDED
@@ -0,0 +1 @@
1
+ 0.0.0
data/lib/pparams.rb ADDED
@@ -0,0 +1,14 @@
1
+
2
+ # Monkey patching is the only way I could figure out how to get this to work.
3
+ # Other ways I tried would get a "undefined method `params'" error. Probably
4
+ # because monkey patching happens after params has been defined, while other
5
+ # ways of including the code happens to early, like extend, include, etc.
6
+
7
+ class ActionController::Base
8
+ alias p params
9
+ end
10
+
11
+ class ActionView::Base
12
+ alias p params
13
+ end
14
+
data/pparams.gemspec ADDED
@@ -0,0 +1,114 @@
1
+ # Generated by jeweler
2
+ # DO NOT EDIT THIS FILE DIRECTLY
3
+ # Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
4
+ # -*- encoding: utf-8 -*-
5
+
6
+ Gem::Specification.new do |s|
7
+ s.name = %q{pparams}
8
+ s.version = "0.0.0"
9
+
10
+ s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
11
+ s.authors = ["Kevin Swope"]
12
+ s.date = %q{2010-10-06}
13
+ s.description = %q{alias params to p in rails}
14
+ s.email = %q{git-kevdev@snkmail.com}
15
+ s.extra_rdoc_files = [
16
+ "LICENSE",
17
+ "README.rdoc"
18
+ ]
19
+ s.files = [
20
+ ".document",
21
+ ".gitignore",
22
+ "LICENSE",
23
+ "README.rdoc",
24
+ "Rakefile",
25
+ "VERSION",
26
+ "lib/pparams.rb",
27
+ "pparams.gemspec",
28
+ "test/helper.rb",
29
+ "test/rails3x_root/.gitignore",
30
+ "test/rails3x_root/Gemfile",
31
+ "test/rails3x_root/Gemfile.lock",
32
+ "test/rails3x_root/README",
33
+ "test/rails3x_root/Rakefile",
34
+ "test/rails3x_root/app/controllers/application_controller.rb",
35
+ "test/rails3x_root/app/controllers/public_controller.rb",
36
+ "test/rails3x_root/app/helpers/application_helper.rb",
37
+ "test/rails3x_root/app/helpers/public_helper.rb",
38
+ "test/rails3x_root/app/views/layouts/application.html.erb",
39
+ "test/rails3x_root/app/views/public/test.html.erb",
40
+ "test/rails3x_root/config.ru",
41
+ "test/rails3x_root/config/application.rb",
42
+ "test/rails3x_root/config/boot.rb",
43
+ "test/rails3x_root/config/environment.rb",
44
+ "test/rails3x_root/config/environments/development.rb",
45
+ "test/rails3x_root/config/environments/production.rb",
46
+ "test/rails3x_root/config/environments/test.rb",
47
+ "test/rails3x_root/config/initializers/backtrace_silencers.rb",
48
+ "test/rails3x_root/config/initializers/inflections.rb",
49
+ "test/rails3x_root/config/initializers/mime_types.rb",
50
+ "test/rails3x_root/config/initializers/secret_token.rb",
51
+ "test/rails3x_root/config/initializers/session_store.rb",
52
+ "test/rails3x_root/config/locales/en.yml",
53
+ "test/rails3x_root/config/routes.rb",
54
+ "test/rails3x_root/db/seeds.rb",
55
+ "test/rails3x_root/lib/tasks/.gitkeep",
56
+ "test/rails3x_root/public/404.html",
57
+ "test/rails3x_root/public/422.html",
58
+ "test/rails3x_root/public/500.html",
59
+ "test/rails3x_root/public/favicon.ico",
60
+ "test/rails3x_root/public/images/rails.png",
61
+ "test/rails3x_root/public/javascripts/.gitkeep",
62
+ "test/rails3x_root/public/javascripts/application.js",
63
+ "test/rails3x_root/public/robots.txt",
64
+ "test/rails3x_root/public/stylesheets/.gitkeep",
65
+ "test/rails3x_root/script/rails",
66
+ "test/rails3x_root/test/functional/public_controller_test.rb",
67
+ "test/rails3x_root/test/performance/browsing_test.rb",
68
+ "test/rails3x_root/test/test_helper.rb",
69
+ "test/rails3x_root/test/unit/helpers/public_helper_test.rb",
70
+ "test/rails3x_root/vendor/plugins/.gitkeep",
71
+ "test/test_pparams.rb"
72
+ ]
73
+ s.homepage = %q{http://github.com/kswope/pparams}
74
+ s.rdoc_options = ["--charset=UTF-8"]
75
+ s.require_paths = ["lib"]
76
+ s.rubygems_version = %q{1.3.7}
77
+ s.summary = %q{alias params to p in rails}
78
+ s.test_files = [
79
+ "test/helper.rb",
80
+ "test/rails3x_root/app/controllers/application_controller.rb",
81
+ "test/rails3x_root/app/controllers/public_controller.rb",
82
+ "test/rails3x_root/app/helpers/application_helper.rb",
83
+ "test/rails3x_root/app/helpers/public_helper.rb",
84
+ "test/rails3x_root/config/application.rb",
85
+ "test/rails3x_root/config/boot.rb",
86
+ "test/rails3x_root/config/environment.rb",
87
+ "test/rails3x_root/config/environments/development.rb",
88
+ "test/rails3x_root/config/environments/production.rb",
89
+ "test/rails3x_root/config/environments/test.rb",
90
+ "test/rails3x_root/config/initializers/backtrace_silencers.rb",
91
+ "test/rails3x_root/config/initializers/inflections.rb",
92
+ "test/rails3x_root/config/initializers/mime_types.rb",
93
+ "test/rails3x_root/config/initializers/secret_token.rb",
94
+ "test/rails3x_root/config/initializers/session_store.rb",
95
+ "test/rails3x_root/config/routes.rb",
96
+ "test/rails3x_root/db/seeds.rb",
97
+ "test/rails3x_root/test/functional/public_controller_test.rb",
98
+ "test/rails3x_root/test/performance/browsing_test.rb",
99
+ "test/rails3x_root/test/test_helper.rb",
100
+ "test/rails3x_root/test/unit/helpers/public_helper_test.rb",
101
+ "test/test_pparams.rb"
102
+ ]
103
+
104
+ if s.respond_to? :specification_version then
105
+ current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
106
+ s.specification_version = 3
107
+
108
+ if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
109
+ else
110
+ end
111
+ else
112
+ end
113
+ end
114
+
data/test/helper.rb ADDED
@@ -0,0 +1,9 @@
1
+ require 'rubygems'
2
+ require 'test/unit'
3
+
4
+ $LOAD_PATH.unshift(File.dirname(__FILE__))
5
+ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
6
+ require 'pparams'
7
+
8
+ class Test::Unit::TestCase
9
+ end
@@ -0,0 +1,4 @@
1
+ .bundle
2
+ db/*.sqlite3
3
+ log/*.log
4
+ tmp/**/*
@@ -0,0 +1,32 @@
1
+ source 'http://rubygems.org'
2
+
3
+ gem 'rails', '3.0.0'
4
+
5
+ # Bundle edge Rails instead:
6
+ # gem 'rails', :git => 'git://github.com/rails/rails.git'
7
+
8
+
9
+ # Use unicorn as the web server
10
+ # gem 'unicorn'
11
+
12
+ # Deploy with Capistrano
13
+ # gem 'capistrano'
14
+
15
+ # To use debugger
16
+ # gem 'ruby-debug'
17
+
18
+ # Bundle the extra gems:
19
+ # gem 'bj'
20
+ # gem 'nokogiri'
21
+ # gem 'sqlite3-ruby', :require => 'sqlite3'
22
+ # gem 'aws-s3', :require => 'aws/s3'
23
+
24
+ # Bundle gems for the local environment. Make sure to
25
+ # put test-only gems in this group so their generators
26
+ # and rake tasks are available in development mode:
27
+ # group :development, :test do
28
+ # gem 'webrat'
29
+ # end
30
+
31
+ gem "pparams", :path => "../.."
32
+
@@ -0,0 +1,77 @@
1
+ PATH
2
+ remote: /Users/kevin/Development/pparams
3
+ specs:
4
+ pparams (0.0.0)
5
+
6
+ GEM
7
+ remote: http://rubygems.org/
8
+ specs:
9
+ abstract (1.0.0)
10
+ actionmailer (3.0.0)
11
+ actionpack (= 3.0.0)
12
+ mail (~> 2.2.5)
13
+ actionpack (3.0.0)
14
+ activemodel (= 3.0.0)
15
+ activesupport (= 3.0.0)
16
+ builder (~> 2.1.2)
17
+ erubis (~> 2.6.6)
18
+ i18n (~> 0.4.1)
19
+ rack (~> 1.2.1)
20
+ rack-mount (~> 0.6.12)
21
+ rack-test (~> 0.5.4)
22
+ tzinfo (~> 0.3.23)
23
+ activemodel (3.0.0)
24
+ activesupport (= 3.0.0)
25
+ builder (~> 2.1.2)
26
+ i18n (~> 0.4.1)
27
+ activerecord (3.0.0)
28
+ activemodel (= 3.0.0)
29
+ activesupport (= 3.0.0)
30
+ arel (~> 1.0.0)
31
+ tzinfo (~> 0.3.23)
32
+ activeresource (3.0.0)
33
+ activemodel (= 3.0.0)
34
+ activesupport (= 3.0.0)
35
+ activesupport (3.0.0)
36
+ arel (1.0.1)
37
+ activesupport (~> 3.0.0)
38
+ builder (2.1.2)
39
+ erubis (2.6.6)
40
+ abstract (>= 1.0.0)
41
+ i18n (0.4.1)
42
+ mail (2.2.6.1)
43
+ activesupport (>= 2.3.6)
44
+ mime-types
45
+ treetop (>= 1.4.5)
46
+ mime-types (1.16)
47
+ polyglot (0.3.1)
48
+ rack (1.2.1)
49
+ rack-mount (0.6.13)
50
+ rack (>= 1.0.0)
51
+ rack-test (0.5.6)
52
+ rack (>= 1.0)
53
+ rails (3.0.0)
54
+ actionmailer (= 3.0.0)
55
+ actionpack (= 3.0.0)
56
+ activerecord (= 3.0.0)
57
+ activeresource (= 3.0.0)
58
+ activesupport (= 3.0.0)
59
+ bundler (~> 1.0.0)
60
+ railties (= 3.0.0)
61
+ railties (3.0.0)
62
+ actionpack (= 3.0.0)
63
+ activesupport (= 3.0.0)
64
+ rake (>= 0.8.4)
65
+ thor (~> 0.14.0)
66
+ rake (0.8.7)
67
+ thor (0.14.2)
68
+ treetop (1.4.8)
69
+ polyglot (>= 0.3.1)
70
+ tzinfo (0.3.23)
71
+
72
+ PLATFORMS
73
+ ruby
74
+
75
+ DEPENDENCIES
76
+ pparams!
77
+ rails (= 3.0.0)
@@ -0,0 +1,256 @@
1
+ == Welcome to Rails
2
+
3
+ Rails is a web-application framework that includes everything needed to create
4
+ database-backed web applications according to the Model-View-Control pattern.
5
+
6
+ This pattern splits the view (also called the presentation) into "dumb"
7
+ templates that are primarily responsible for inserting pre-built data in between
8
+ HTML tags. The model contains the "smart" domain objects (such as Account,
9
+ Product, Person, Post) that holds all the business logic and knows how to
10
+ persist themselves to a database. The controller handles the incoming requests
11
+ (such as Save New Account, Update Product, Show Post) by manipulating the model
12
+ and directing data to the view.
13
+
14
+ In Rails, the model is handled by what's called an object-relational mapping
15
+ layer entitled Active Record. This layer allows you to present the data from
16
+ database rows as objects and embellish these data objects with business logic
17
+ methods. You can read more about Active Record in
18
+ link:files/vendor/rails/activerecord/README.html.
19
+
20
+ The controller and view are handled by the Action Pack, which handles both
21
+ layers by its two parts: Action View and Action Controller. These two layers
22
+ are bundled in a single package due to their heavy interdependence. This is
23
+ unlike the relationship between the Active Record and Action Pack that is much
24
+ more separate. Each of these packages can be used independently outside of
25
+ Rails. You can read more about Action Pack in
26
+ link:files/vendor/rails/actionpack/README.html.
27
+
28
+
29
+ == Getting Started
30
+
31
+ 1. At the command prompt, create a new Rails application:
32
+ <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
33
+
34
+ 2. Change directory to <tt>myapp</tt> and start the web server:
35
+ <tt>cd myapp; rails server</tt> (run with --help for options)
36
+
37
+ 3. Go to http://localhost:3000/ and you'll see:
38
+ "Welcome aboard: You're riding Ruby on Rails!"
39
+
40
+ 4. Follow the guidelines to start developing your application. You can find
41
+ the following resources handy:
42
+
43
+ * The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
44
+ * Ruby on Rails Tutorial Book: http://www.railstutorial.org/
45
+
46
+
47
+ == Debugging Rails
48
+
49
+ Sometimes your application goes wrong. Fortunately there are a lot of tools that
50
+ will help you debug it and get it back on the rails.
51
+
52
+ First area to check is the application log files. Have "tail -f" commands
53
+ running on the server.log and development.log. Rails will automatically display
54
+ debugging and runtime information to these files. Debugging info will also be
55
+ shown in the browser on requests from 127.0.0.1.
56
+
57
+ You can also log your own messages directly into the log file from your code
58
+ using the Ruby logger class from inside your controllers. Example:
59
+
60
+ class WeblogController < ActionController::Base
61
+ def destroy
62
+ @weblog = Weblog.find(params[:id])
63
+ @weblog.destroy
64
+ logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
65
+ end
66
+ end
67
+
68
+ The result will be a message in your log file along the lines of:
69
+
70
+ Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
71
+
72
+ More information on how to use the logger is at http://www.ruby-doc.org/core/
73
+
74
+ Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
75
+ several books available online as well:
76
+
77
+ * Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
78
+ * Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
79
+
80
+ These two books will bring you up to speed on the Ruby language and also on
81
+ programming in general.
82
+
83
+
84
+ == Debugger
85
+
86
+ Debugger support is available through the debugger command when you start your
87
+ Mongrel or WEBrick server with --debugger. This means that you can break out of
88
+ execution at any point in the code, investigate and change the model, and then,
89
+ resume execution! You need to install ruby-debug to run the server in debugging
90
+ mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
91
+
92
+ class WeblogController < ActionController::Base
93
+ def index
94
+ @posts = Post.find(:all)
95
+ debugger
96
+ end
97
+ end
98
+
99
+ So the controller will accept the action, run the first line, then present you
100
+ with a IRB prompt in the server window. Here you can do things like:
101
+
102
+ >> @posts.inspect
103
+ => "[#<Post:0x14a6be8
104
+ @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
105
+ #<Post:0x14a6620
106
+ @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
107
+ >> @posts.first.title = "hello from a debugger"
108
+ => "hello from a debugger"
109
+
110
+ ...and even better, you can examine how your runtime objects actually work:
111
+
112
+ >> f = @posts.first
113
+ => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
114
+ >> f.
115
+ Display all 152 possibilities? (y or n)
116
+
117
+ Finally, when you're ready to resume execution, you can enter "cont".
118
+
119
+
120
+ == Console
121
+
122
+ The console is a Ruby shell, which allows you to interact with your
123
+ application's domain model. Here you'll have all parts of the application
124
+ configured, just like it is when the application is running. You can inspect
125
+ domain models, change values, and save to the database. Starting the script
126
+ without arguments will launch it in the development environment.
127
+
128
+ To start the console, run <tt>rails console</tt> from the application
129
+ directory.
130
+
131
+ Options:
132
+
133
+ * Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
134
+ made to the database.
135
+ * Passing an environment name as an argument will load the corresponding
136
+ environment. Example: <tt>rails console production</tt>.
137
+
138
+ To reload your controllers and models after launching the console run
139
+ <tt>reload!</tt>
140
+
141
+ More information about irb can be found at:
142
+ link:http://www.rubycentral.com/pickaxe/irb.html
143
+
144
+
145
+ == dbconsole
146
+
147
+ You can go to the command line of your database directly through <tt>rails
148
+ dbconsole</tt>. You would be connected to the database with the credentials
149
+ defined in database.yml. Starting the script without arguments will connect you
150
+ to the development database. Passing an argument will connect you to a different
151
+ database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
152
+ PostgreSQL and SQLite 3.
153
+
154
+ == Description of Contents
155
+
156
+ The default directory structure of a generated Ruby on Rails application:
157
+
158
+ |-- app
159
+ | |-- controllers
160
+ | |-- helpers
161
+ | |-- models
162
+ | `-- views
163
+ | `-- layouts
164
+ |-- config
165
+ | |-- environments
166
+ | |-- initializers
167
+ | `-- locales
168
+ |-- db
169
+ |-- doc
170
+ |-- lib
171
+ | `-- tasks
172
+ |-- log
173
+ |-- public
174
+ | |-- images
175
+ | |-- javascripts
176
+ | `-- stylesheets
177
+ |-- script
178
+ | `-- performance
179
+ |-- test
180
+ | |-- fixtures
181
+ | |-- functional
182
+ | |-- integration
183
+ | |-- performance
184
+ | `-- unit
185
+ |-- tmp
186
+ | |-- cache
187
+ | |-- pids
188
+ | |-- sessions
189
+ | `-- sockets
190
+ `-- vendor
191
+ `-- plugins
192
+
193
+ app
194
+ Holds all the code that's specific to this particular application.
195
+
196
+ app/controllers
197
+ Holds controllers that should be named like weblogs_controller.rb for
198
+ automated URL mapping. All controllers should descend from
199
+ ApplicationController which itself descends from ActionController::Base.
200
+
201
+ app/models
202
+ Holds models that should be named like post.rb. Models descend from
203
+ ActiveRecord::Base by default.
204
+
205
+ app/views
206
+ Holds the template files for the view that should be named like
207
+ weblogs/index.html.erb for the WeblogsController#index action. All views use
208
+ eRuby syntax by default.
209
+
210
+ app/views/layouts
211
+ Holds the template files for layouts to be used with views. This models the
212
+ common header/footer method of wrapping views. In your views, define a layout
213
+ using the <tt>layout :default</tt> and create a file named default.html.erb.
214
+ Inside default.html.erb, call <% yield %> to render the view using this
215
+ layout.
216
+
217
+ app/helpers
218
+ Holds view helpers that should be named like weblogs_helper.rb. These are
219
+ generated for you automatically when using generators for controllers.
220
+ Helpers can be used to wrap functionality for your views into methods.
221
+
222
+ config
223
+ Configuration files for the Rails environment, the routing map, the database,
224
+ and other dependencies.
225
+
226
+ db
227
+ Contains the database schema in schema.rb. db/migrate contains all the
228
+ sequence of Migrations for your schema.
229
+
230
+ doc
231
+ This directory is where your application documentation will be stored when
232
+ generated using <tt>rake doc:app</tt>
233
+
234
+ lib
235
+ Application specific libraries. Basically, any kind of custom code that
236
+ doesn't belong under controllers, models, or helpers. This directory is in
237
+ the load path.
238
+
239
+ public
240
+ The directory available for the web server. Contains subdirectories for
241
+ images, stylesheets, and javascripts. Also contains the dispatchers and the
242
+ default HTML files. This should be set as the DOCUMENT_ROOT of your web
243
+ server.
244
+
245
+ script
246
+ Helper scripts for automation and generation.
247
+
248
+ test
249
+ Unit and functional tests along with fixtures. When using the rails generate
250
+ command, template test files will be generated for you and placed in this
251
+ directory.
252
+
253
+ vendor
254
+ External libraries that the application depends on. Also includes the plugins
255
+ subdirectory. If the app has frozen rails, those gems also go here, under
256
+ vendor/rails/. This directory is in the load path.