app-yml-rails 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- data/CHANGELOG.md +8 -0
- data/MIT-LICENSE +20 -0
- data/README.md +64 -0
- data/Rakefile +11 -0
- data/lib/app_yml.rb +6 -0
- data/lib/app_yml/application_controller_ext.rb +20 -0
- data/lib/app_yml/core_ext.rb +45 -0
- data/lib/app_yml/version.rb +3 -0
- data/lib/generators/app_yml/install/install_generator.rb +25 -0
- data/lib/generators/app_yml/install/templates/app.rb +39 -0
- data/lib/generators/app_yml/install/templates/app.yml +42 -0
- data/test/app_yml_test.rb +5 -0
- data/test/core_ext_test.rb +47 -0
- data/test/dummy/README.rdoc +261 -0
- data/test/dummy/Rakefile +7 -0
- data/test/dummy/app/assets/javascripts/application.js +13 -0
- data/test/dummy/app/assets/stylesheets/application.css +13 -0
- data/test/dummy/app/controllers/application_controller.rb +5 -0
- data/test/dummy/app/controllers/landing_controller.rb +6 -0
- data/test/dummy/app/views/landing/index.html.erb +15 -0
- data/test/dummy/app/views/landing/missing_initializer.html.erb +6 -0
- data/test/dummy/app/views/layouts/application.html.erb +12 -0
- data/test/dummy/config.ru +4 -0
- data/test/dummy/config/app.yml +42 -0
- data/test/dummy/config/application.rb +62 -0
- data/test/dummy/config/boot.rb +10 -0
- data/test/dummy/config/environment.rb +5 -0
- data/test/dummy/config/environments/development.rb +30 -0
- data/test/dummy/config/environments/production.rb +63 -0
- data/test/dummy/config/environments/test.rb +34 -0
- data/test/dummy/config/initializers/app.rb +39 -0
- data/test/dummy/config/initializers/backtrace_silencers.rb +7 -0
- data/test/dummy/config/initializers/inflections.rb +15 -0
- data/test/dummy/config/initializers/mime_types.rb +5 -0
- data/test/dummy/config/initializers/secret_token.rb +7 -0
- data/test/dummy/config/initializers/session_store.rb +8 -0
- data/test/dummy/config/initializers/wrap_parameters.rb +10 -0
- data/test/dummy/config/routes.rb +3 -0
- data/test/dummy/log/development.log +1740 -0
- data/test/dummy/log/test.log +0 -0
- data/test/dummy/public/404.html +26 -0
- data/test/dummy/public/422.html +26 -0
- data/test/dummy/public/500.html +25 -0
- data/test/dummy/public/favicon.ico +0 -0
- data/test/dummy/script/rails +6 -0
- data/test/dummy/tmp/pids/server.pid +1 -0
- data/test/test_helper.rb +15 -0
- metadata +141 -0
data/CHANGELOG.md
ADDED
@@ -0,0 +1,8 @@
|
|
1
|
+
## 0.1.0 (Apr 30, 2012)
|
2
|
+
|
3
|
+
**Features:**
|
4
|
+
|
5
|
+
- Provides project-wide settings via `config/app.yml`
|
6
|
+
- Supports `App.settings.nested_settings` syntax
|
7
|
+
- Supports all/production/staging/development/test environments (specific environment settings over settings from the 'all' environment)
|
8
|
+
- Auto-refreshes `app.yml` changes without requiring an application restart
|
data/MIT-LICENSE
ADDED
@@ -0,0 +1,20 @@
|
|
1
|
+
Copyright 2012 Graham Swan
|
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.md
ADDED
@@ -0,0 +1,64 @@
|
|
1
|
+
# app-yml-rails
|
2
|
+
|
3
|
+
This gem provides a Rails application with project-wide settings via an **app.yml** file.
|
4
|
+
|
5
|
+
## Features
|
6
|
+
|
7
|
+
- Provides project-wide settings via **config/app.yml**.
|
8
|
+
- Supports `App.settings.nested_settings` syntax.
|
9
|
+
- Supports **all/production/staging/development/test** environments (specific environment settings over settings from the 'all' environment).
|
10
|
+
- Auto-refreshes **app.yml** changes without requiring an application restart.
|
11
|
+
|
12
|
+
## Installation
|
13
|
+
|
14
|
+
Add the following line to your project's **Gemfile**:
|
15
|
+
|
16
|
+
gem 'app-yml-rails'
|
17
|
+
|
18
|
+
Install the config and initializer files:
|
19
|
+
|
20
|
+
$ rails generate app_yml:install
|
21
|
+
|
22
|
+
## Usage
|
23
|
+
|
24
|
+
1. Edit your project settings in **config/app.yml**.
|
25
|
+
2. Access settings anywhere in your application via `App.settings.nested_setting` syntax.
|
26
|
+
|
27
|
+
## Examples
|
28
|
+
|
29
|
+
If your **config/app.yml** file appears as follows:
|
30
|
+
|
31
|
+
all:
|
32
|
+
emails:
|
33
|
+
admin: admin@example.com
|
34
|
+
team:
|
35
|
+
ceo: ceo@example.com
|
36
|
+
max_search_results: 20
|
37
|
+
app_name: My Amazing Application
|
38
|
+
|
39
|
+
development:
|
40
|
+
emails:
|
41
|
+
team:
|
42
|
+
ceo: ceo@localhost
|
43
|
+
app_name: My Amazing Application (development)
|
44
|
+
|
45
|
+
production:
|
46
|
+
app_name: My Amazing Application (production)
|
47
|
+
|
48
|
+
Settings in the **development** environment:
|
49
|
+
|
50
|
+
App.emails.admin => 'admin@example.com'
|
51
|
+
App.emails.team.ceo => 'ceo@localhost'
|
52
|
+
App.max_search_results => 20
|
53
|
+
App.app_name => 'My Amazing Application (development)'
|
54
|
+
|
55
|
+
Settings in the **production** environment:
|
56
|
+
|
57
|
+
App.emails.admin => 'admin@example.com'
|
58
|
+
App.emails.team.ceo => 'ceo@example.com'
|
59
|
+
App.max_search_results => 20
|
60
|
+
App.app_name => 'My Amazing Application (production)'
|
61
|
+
|
62
|
+
## License
|
63
|
+
|
64
|
+
[MIT License](https://github.com/thinkswan/app-yml-rails/blob/master/MIT-LICENSE)
|
data/Rakefile
ADDED
data/lib/app_yml.rb
ADDED
@@ -0,0 +1,20 @@
|
|
1
|
+
# Public: Injects a filter into the project's ApplicationController to refresh the 'app.yml' settings for every request.
|
2
|
+
require 'action_controller'
|
3
|
+
|
4
|
+
ActionController::Base.class_eval do
|
5
|
+
private
|
6
|
+
|
7
|
+
# Private: Refreshes all settings from 'app.yml' for every request (no app restarts required).
|
8
|
+
#
|
9
|
+
# Provides a global 'App' constant holding project-wide settings.
|
10
|
+
def _reload_app_yml
|
11
|
+
App::build_settings_hash
|
12
|
+
end
|
13
|
+
end
|
14
|
+
|
15
|
+
ActionController::Base.instance_eval do
|
16
|
+
helper_method :_reload_app_yml
|
17
|
+
|
18
|
+
# Refresh 'app.yml' settings if the 'app.rb' initializer has been installed
|
19
|
+
before_filter :_reload_app_yml, :if => Proc.new { defined? App }
|
20
|
+
end
|
@@ -0,0 +1,45 @@
|
|
1
|
+
# Public: Extends Ruby's Hash class to provide a method for performing a deep update on a hash.
|
2
|
+
class Hash
|
3
|
+
# Public: Performs an in-place deep update on the calling hash with the provided 'new_hash'. Allows us to override 'app.yml'
|
4
|
+
# settings from the 'all' environment with the current environment (test/development/staging/production) with unlimited nesting.
|
5
|
+
#
|
6
|
+
# new_hash - The hash to copy over the calling hash.
|
7
|
+
#
|
8
|
+
# Examples
|
9
|
+
#
|
10
|
+
# { :email => 'email@example.com', :name => 'Graham Swan' }.deep_update!({ :email => 'new_email@example.com' })
|
11
|
+
# => { :email => 'new_email@example.com', :name => 'Graham Swan' }
|
12
|
+
#
|
13
|
+
# Returns the calling hash with the updated values.
|
14
|
+
def deep_update! new_hash={}
|
15
|
+
new_hash.each_pair do |key, val|
|
16
|
+
if val.class.eql? Hash
|
17
|
+
self[key].deep_update! val
|
18
|
+
else
|
19
|
+
self[key] = val
|
20
|
+
end
|
21
|
+
end
|
22
|
+
|
23
|
+
self
|
24
|
+
end
|
25
|
+
end
|
26
|
+
|
27
|
+
# Public: Extends Rails' HashWithIndifferentAccess class to provide a method for accessing a hash's values with dot syntax.
|
28
|
+
module ActiveSupport
|
29
|
+
class HashWithIndifferentAccess < Hash
|
30
|
+
# Public: Causes '{}.arg' to call '{}[:arg]'.
|
31
|
+
#
|
32
|
+
# Note: None of the HashWithIndifferentAccess methods will work here. (http://as.rubyonrails.org/classes/HashWithIndifferentAccess.html)
|
33
|
+
# The aforementioned methods will invoke their expected functionality.
|
34
|
+
#
|
35
|
+
# Examples
|
36
|
+
#
|
37
|
+
# (HashWithIndifferentAccess.new({ :country => 'Canada' })).country
|
38
|
+
# => 'Canada'
|
39
|
+
#
|
40
|
+
# Returns the calling hash with the updated values.
|
41
|
+
def method_missing(method, *args)
|
42
|
+
self[method]
|
43
|
+
end
|
44
|
+
end
|
45
|
+
end
|
@@ -0,0 +1,25 @@
|
|
1
|
+
# Public: A generator used to install the app.yml config file and the app.rb initializer.
|
2
|
+
# Copies lib/generators/app_yml/install/templates/app.yml to config/app.yml
|
3
|
+
# Copies lib/generators/app_yml/install/templates/app.rb to config/initializers/app.rb
|
4
|
+
#
|
5
|
+
# Usage: rails generate app_yml:install
|
6
|
+
module AppYml
|
7
|
+
module Generators
|
8
|
+
class InstallGenerator < Rails::Generators::Base
|
9
|
+
source_root File.expand_path("../templates", __FILE__)
|
10
|
+
|
11
|
+
desc "Creates an app.yml config file in 'config/app.yml' and an app.rb initializer (providing access to the App constant) in 'config/initializers/app.rb'."
|
12
|
+
|
13
|
+
def create_config_file
|
14
|
+
template 'app.yml', File.join('config', 'app.yml')
|
15
|
+
end
|
16
|
+
|
17
|
+
def create_initializer_file
|
18
|
+
template 'app.rb', File.join('config', 'initializers', 'app.rb')
|
19
|
+
end
|
20
|
+
|
21
|
+
end
|
22
|
+
end
|
23
|
+
end
|
24
|
+
|
25
|
+
|
@@ -0,0 +1,39 @@
|
|
1
|
+
# Public: An initializer that provides global access to the App constant (which holds all settings from config/app.yml).
|
2
|
+
#
|
3
|
+
# Thanks to Adrian Danieli (http://sickpea.com/2009/6/rails-app-configuration-in-10-lines) for this idea.
|
4
|
+
module App
|
5
|
+
# Causes App.arg to call App[arg].
|
6
|
+
#
|
7
|
+
# Eg: App.country would call App[:country]
|
8
|
+
def self.method_missing(method, *args)
|
9
|
+
self[method, *args]
|
10
|
+
end
|
11
|
+
|
12
|
+
# Causes App[arg] to return @@settings[arg].
|
13
|
+
#
|
14
|
+
# Eg: If @@settings = { :country => 'Canada' }, then App[:country] will return @@settings[:country] == 'Canada'
|
15
|
+
def self.[](*args)
|
16
|
+
args.inject(@@settings) { |hash, arg| hash[arg] }
|
17
|
+
end
|
18
|
+
|
19
|
+
# Parses 'config/app.yml' and converts it into a HashWithIndifferentAccess (which provides us with dot syntax).
|
20
|
+
#
|
21
|
+
# See 'config/app.yml' for examples.
|
22
|
+
def self.build_settings_hash
|
23
|
+
# Create a hash out of config/app.yml
|
24
|
+
yaml = YAML.load(ERB.new(File.read(Rails.root.join('config', 'app.yml'))).result)
|
25
|
+
|
26
|
+
# Fetch settings from the all: section
|
27
|
+
@@settings = yaml['all']
|
28
|
+
|
29
|
+
# Merge in settings from the current environment's section, giving the environment's settings precedence
|
30
|
+
@@settings.deep_update! yaml[Rails.env] || {}
|
31
|
+
|
32
|
+
# Allow this hash's data to be accessed with both strings and symbols
|
33
|
+
@@settings = HashWithIndifferentAccess.new @@settings
|
34
|
+
end
|
35
|
+
|
36
|
+
# Initialize the settings hash
|
37
|
+
@@settings = {}
|
38
|
+
self.build_settings_hash
|
39
|
+
end
|
@@ -0,0 +1,42 @@
|
|
1
|
+
# This is the app's global key-value store. Retrieve settings from anywhere in the app with App.setting.nested_setting syntax.
|
2
|
+
#
|
3
|
+
# Note: Settings from the current environment (test/development/staging/production) will override settings
|
4
|
+
# with the same name from the 'all' section.
|
5
|
+
#
|
6
|
+
# Example: The following config will result in this resultant hash: App.emails = { :admin => 'admin@localhost', :support => 'support@example.com' }
|
7
|
+
#
|
8
|
+
# all:
|
9
|
+
# emails:
|
10
|
+
# admin: admin@example.com
|
11
|
+
# support: support@example.com
|
12
|
+
# development:
|
13
|
+
# emails:
|
14
|
+
# admin: admin@localhost
|
15
|
+
#
|
16
|
+
# In this example, 'App.emails.admin' will return 'admin@localhost'.
|
17
|
+
|
18
|
+
all:
|
19
|
+
emails:
|
20
|
+
admin: admin@example.com
|
21
|
+
support: support@example.com
|
22
|
+
billing: billing@example.com
|
23
|
+
team:
|
24
|
+
ceo: ceo@example.com
|
25
|
+
cto: cto@example.com
|
26
|
+
max_search_results: 20
|
27
|
+
app_name: My Amazing Application
|
28
|
+
|
29
|
+
test:
|
30
|
+
|
31
|
+
development:
|
32
|
+
emails:
|
33
|
+
admin: admin@localhost
|
34
|
+
team:
|
35
|
+
ceo: ceo@localhost
|
36
|
+
app_name: My Amazing Application (development)
|
37
|
+
|
38
|
+
staging:
|
39
|
+
app_name: My Amazing Application (staging)
|
40
|
+
|
41
|
+
production:
|
42
|
+
app_name: My Amazing Application (production)
|
@@ -0,0 +1,47 @@
|
|
1
|
+
require 'test_helper'
|
2
|
+
|
3
|
+
class CoreExtTest < Test::Unit::TestCase
|
4
|
+
@@all_hash = {
|
5
|
+
:emails => {
|
6
|
+
:admin => 'admin@example.com',
|
7
|
+
:support => 'support@example.com',
|
8
|
+
:billing => 'billing@example.com',
|
9
|
+
:team => {
|
10
|
+
:ceo => 'ceo@example.com',
|
11
|
+
:cto => 'cto@example.com'
|
12
|
+
}
|
13
|
+
},
|
14
|
+
:max_search_results => 20,
|
15
|
+
:app_name => 'My Amazing Application'
|
16
|
+
}
|
17
|
+
@@dev_hash = {
|
18
|
+
:emails => {
|
19
|
+
:admin => 'admin@localhost',
|
20
|
+
:team => {
|
21
|
+
:ceo => 'ceo@localhost'
|
22
|
+
}
|
23
|
+
},
|
24
|
+
:app_name => 'My Amazing Application (development)'
|
25
|
+
}
|
26
|
+
|
27
|
+
def test_hash_dot_syntax
|
28
|
+
hash_with_indifferent_access = HashWithIndifferentAccess.new @@all_hash
|
29
|
+
|
30
|
+
assert_equal 'ceo@example.com', hash_with_indifferent_access.emails.team.ceo
|
31
|
+
assert_equal 20, hash_with_indifferent_access.max_search_results
|
32
|
+
end
|
33
|
+
|
34
|
+
def test_hash_deep_update
|
35
|
+
all_hash_copy = Marshal.load Marshal.dump @@all_hash # Make a deep copy of @@all_hash (so that it maintains its state for subsequent tests)
|
36
|
+
all_hash_copy.deep_update! @@dev_hash
|
37
|
+
app_hash = HashWithIndifferentAccess.new all_hash_copy
|
38
|
+
|
39
|
+
assert_equal 'admin@localhost', app_hash.emails.admin
|
40
|
+
assert_equal 'ceo@localhost', app_hash.emails.team.ceo
|
41
|
+
assert_equal 'My Amazing Application (development)', app_hash.app_name
|
42
|
+
|
43
|
+
assert_equal 'support@example.com', app_hash.emails.support
|
44
|
+
assert_equal 'cto@example.com', app_hash.emails.team.cto
|
45
|
+
assert_equal 20, app_hash.max_search_results
|
46
|
+
end
|
47
|
+
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
|
+
| `-- 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.
|