leap_web_core 0.0.1
Sign up to get free protection for your applications and to get access to all the features.
- data/MIT-LICENSE +20 -0
- data/Rakefile +38 -0
- data/Readme.md +4 -0
- data/app/controllers/home_controller.rb +5 -0
- data/app/views/home/index.html.haml +1 -0
- data/config/initializers/backtrace_silencers.rb +7 -0
- data/config/initializers/inflections.rb +15 -0
- data/config/initializers/mime_types.rb +5 -0
- data/config/initializers/simple_form.rb +181 -0
- data/config/initializers/validations.rb +4 -0
- data/config/initializers/wrap_parameters.rb +10 -0
- data/config/routes.rb +3 -0
- data/lib/extensions/testing.rb +24 -0
- data/lib/leap_web_core.rb +6 -0
- data/lib/leap_web_core/dependencies.rb +40 -0
- data/lib/leap_web_core/engine.rb +9 -0
- data/lib/leap_web_core/version.rb +3 -0
- data/lib/tasks/leap_web_core_tasks.rake +4 -0
- data/test/dummy/README.rdoc +261 -0
- data/test/dummy/Rakefile +7 -0
- data/test/dummy/app/assets/javascripts/application.js +15 -0
- data/test/dummy/app/assets/stylesheets/application.css +13 -0
- data/test/dummy/app/controllers/application_controller.rb +3 -0
- data/test/dummy/app/helpers/application_helper.rb +2 -0
- data/test/dummy/app/views/layouts/application.html.erb +14 -0
- data/test/dummy/config.ru +4 -0
- data/test/dummy/config/application.rb +65 -0
- data/test/dummy/config/boot.rb +10 -0
- data/test/dummy/config/environment.rb +5 -0
- data/test/dummy/config/environments/development.rb +31 -0
- data/test/dummy/config/environments/production.rb +64 -0
- data/test/dummy/config/environments/test.rb +35 -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/locales/en.yml +5 -0
- data/test/dummy/config/routes.rb +58 -0
- data/test/dummy/log/development.log +129 -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/integration/navigation_test.rb +9 -0
- data/test/leap_web_core_test.rb +7 -0
- data/test/test_helper.rb +15 -0
- metadata +195 -0
data/MIT-LICENSE
ADDED
@@ -0,0 +1,20 @@
|
|
1
|
+
Copyright 2012 YOURNAME
|
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/Rakefile
ADDED
@@ -0,0 +1,38 @@
|
|
1
|
+
#!/usr/bin/env rake
|
2
|
+
begin
|
3
|
+
require 'bundler/setup'
|
4
|
+
rescue LoadError
|
5
|
+
puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
|
6
|
+
end
|
7
|
+
begin
|
8
|
+
require 'rdoc/task'
|
9
|
+
rescue LoadError
|
10
|
+
require 'rdoc/rdoc'
|
11
|
+
require 'rake/rdoctask'
|
12
|
+
RDoc::Task = Rake::RDocTask
|
13
|
+
end
|
14
|
+
|
15
|
+
RDoc::Task.new(:rdoc) do |rdoc|
|
16
|
+
rdoc.rdoc_dir = 'rdoc'
|
17
|
+
rdoc.title = 'LeapWebCore'
|
18
|
+
rdoc.options << '--line-numbers'
|
19
|
+
rdoc.rdoc_files.include('README.rdoc')
|
20
|
+
rdoc.rdoc_files.include('lib/**/*.rb')
|
21
|
+
end
|
22
|
+
|
23
|
+
|
24
|
+
|
25
|
+
|
26
|
+
Bundler::GemHelper.install_tasks
|
27
|
+
|
28
|
+
require 'rake/testtask'
|
29
|
+
|
30
|
+
Rake::TestTask.new(:test) do |t|
|
31
|
+
t.libs << 'lib'
|
32
|
+
t.libs << 'test'
|
33
|
+
t.pattern = 'test/**/*_test.rb'
|
34
|
+
t.verbose = false
|
35
|
+
end
|
36
|
+
|
37
|
+
|
38
|
+
task :default => :test
|
data/Readme.md
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
%h3 Home
|
@@ -0,0 +1,7 @@
|
|
1
|
+
# Be sure to restart your server when you modify this file.
|
2
|
+
|
3
|
+
# You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces.
|
4
|
+
# Rails.backtrace_cleaner.add_silencer { |line| line =~ /my_noisy_library/ }
|
5
|
+
|
6
|
+
# You can also remove all the silencers if you're trying to debug a problem that might stem from framework code.
|
7
|
+
# Rails.backtrace_cleaner.remove_silencers!
|
@@ -0,0 +1,15 @@
|
|
1
|
+
# Be sure to restart your server when you modify this file.
|
2
|
+
|
3
|
+
# Add new inflection rules using the following format
|
4
|
+
# (all these examples are active by default):
|
5
|
+
# ActiveSupport::Inflector.inflections do |inflect|
|
6
|
+
# inflect.plural /^(ox)$/i, '\1en'
|
7
|
+
# inflect.singular /^(ox)en/i, '\1'
|
8
|
+
# inflect.irregular 'person', 'people'
|
9
|
+
# inflect.uncountable %w( fish sheep )
|
10
|
+
# end
|
11
|
+
#
|
12
|
+
# These inflection rules are supported but not enabled by default:
|
13
|
+
# ActiveSupport::Inflector.inflections do |inflect|
|
14
|
+
# inflect.acronym 'RESTful'
|
15
|
+
# end
|
@@ -0,0 +1,181 @@
|
|
1
|
+
# Use this setup block to configure all options available in SimpleForm.
|
2
|
+
|
3
|
+
if defined? SimpleForm
|
4
|
+
SimpleForm.setup do |config|
|
5
|
+
# Wrappers are used by the form builder to generate a
|
6
|
+
# complete input. You can remove any component from the
|
7
|
+
# wrapper, change the order or even add your own to the
|
8
|
+
# stack. The options given below are used to wrap the
|
9
|
+
# whole input.
|
10
|
+
config.wrappers :default, :class => :input,
|
11
|
+
:hint_class => :field_with_hint, :error_class => :field_with_errors do |b|
|
12
|
+
## Extensions enabled by default
|
13
|
+
# Any of these extensions can be disabled for a
|
14
|
+
# given input by passing: `f.input EXTENSION_NAME => false`.
|
15
|
+
# You can make any of these extensions optional by
|
16
|
+
# renaming `b.use` to `b.optional`.
|
17
|
+
|
18
|
+
# Determines whether to use HTML5 (:email, :url, ...)
|
19
|
+
# and required attributes
|
20
|
+
b.use :html5
|
21
|
+
|
22
|
+
# Calculates placeholders automatically from I18n
|
23
|
+
# You can also pass a string as f.input :placeholder => "Placeholder"
|
24
|
+
b.use :placeholder
|
25
|
+
|
26
|
+
## Optional extensions
|
27
|
+
# They are disabled unless you pass `f.input EXTENSION_NAME => :lookup`
|
28
|
+
# to the input. If so, they will retrieve the values from the model
|
29
|
+
# if any exists. If you want to enable the lookup for any of those
|
30
|
+
# extensions by default, you can change `b.optional` to `b.use`.
|
31
|
+
|
32
|
+
# Calculates maxlength from length validations for string inputs
|
33
|
+
b.optional :maxlength
|
34
|
+
|
35
|
+
# Calculates pattern from format validations for string inputs
|
36
|
+
b.optional :pattern
|
37
|
+
|
38
|
+
# Calculates min and max from length validations for numeric inputs
|
39
|
+
b.optional :min_max
|
40
|
+
|
41
|
+
# Calculates readonly automatically from readonly attributes
|
42
|
+
b.optional :readonly
|
43
|
+
|
44
|
+
## Inputs
|
45
|
+
b.use :label_input
|
46
|
+
b.use :hint, :wrap_with => { :tag => :span, :class => :hint }
|
47
|
+
b.use :error, :wrap_with => { :tag => :span, :class => :error }
|
48
|
+
end
|
49
|
+
|
50
|
+
config.wrappers :bootstrap, :tag => 'div', :class => 'control-group', :error_class => 'error' do |b|
|
51
|
+
b.use :html5
|
52
|
+
b.use :placeholder
|
53
|
+
b.use :label
|
54
|
+
b.wrapper :tag => 'div', :class => 'controls' do |ba|
|
55
|
+
ba.use :input
|
56
|
+
ba.use :error, :wrap_with => { :tag => 'span', :class => 'help-inline' }
|
57
|
+
ba.use :hint, :wrap_with => { :tag => 'p', :class => 'help-block' }
|
58
|
+
end
|
59
|
+
end
|
60
|
+
|
61
|
+
config.wrappers :prepend, :tag => 'div', :class => "control-group", :error_class => 'error' do |b|
|
62
|
+
b.use :html5
|
63
|
+
b.use :placeholder
|
64
|
+
b.use :label
|
65
|
+
b.wrapper :tag => 'div', :class => 'controls' do |input|
|
66
|
+
input.wrapper :tag => 'div', :class => 'input-prepend' do |prepend|
|
67
|
+
prepend.use :input
|
68
|
+
end
|
69
|
+
input.use :hint, :wrap_with => { :tag => 'span', :class => 'help-block' }
|
70
|
+
input.use :error, :wrap_with => { :tag => 'span', :class => 'help-inline' }
|
71
|
+
end
|
72
|
+
end
|
73
|
+
|
74
|
+
config.wrappers :append, :tag => 'div', :class => "control-group", :error_class => 'error' do |b|
|
75
|
+
b.use :html5
|
76
|
+
b.use :placeholder
|
77
|
+
b.use :label
|
78
|
+
b.wrapper :tag => 'div', :class => 'controls' do |input|
|
79
|
+
input.wrapper :tag => 'div', :class => 'input-append' do |append|
|
80
|
+
append.use :input
|
81
|
+
end
|
82
|
+
input.use :hint, :wrap_with => { :tag => 'span', :class => 'help-block' }
|
83
|
+
input.use :error, :wrap_with => { :tag => 'span', :class => 'help-inline' }
|
84
|
+
end
|
85
|
+
end
|
86
|
+
|
87
|
+
# Wrappers for forms and inputs using the Twitter Bootstrap toolkit.
|
88
|
+
# Check the Bootstrap docs (http://twitter.github.com/bootstrap)
|
89
|
+
# to learn about the different styles for forms and inputs,
|
90
|
+
# buttons and other elements.
|
91
|
+
config.default_wrapper = :bootstrap
|
92
|
+
|
93
|
+
# Define the way to render check boxes / radio buttons with labels.
|
94
|
+
# Defaults to :nested for bootstrap config.
|
95
|
+
# :inline => input + label
|
96
|
+
# :nested => label > input
|
97
|
+
config.boolean_style = :nested
|
98
|
+
|
99
|
+
# Default class for buttons
|
100
|
+
config.button_class = 'btn'
|
101
|
+
|
102
|
+
# Method used to tidy up errors. Specify any Rails Array method.
|
103
|
+
# :first lists the first message for each field.
|
104
|
+
# Use :to_sentence to list all errors for each field.
|
105
|
+
# config.error_method = :first
|
106
|
+
|
107
|
+
# Default tag used for error notification helper.
|
108
|
+
config.error_notification_tag = :div
|
109
|
+
|
110
|
+
# CSS class to add for error notification helper.
|
111
|
+
config.error_notification_class = 'alert alert-error'
|
112
|
+
|
113
|
+
# ID to add for error notification helper.
|
114
|
+
# config.error_notification_id = nil
|
115
|
+
|
116
|
+
# Series of attempts to detect a default label method for collection.
|
117
|
+
# config.collection_label_methods = [ :to_label, :name, :title, :to_s ]
|
118
|
+
|
119
|
+
# Series of attempts to detect a default value method for collection.
|
120
|
+
# config.collection_value_methods = [ :id, :to_s ]
|
121
|
+
|
122
|
+
# You can wrap a collection of radio/check boxes in a pre-defined tag, defaulting to none.
|
123
|
+
# config.collection_wrapper_tag = nil
|
124
|
+
|
125
|
+
# You can define the class to use on all collection wrappers. Defaulting to none.
|
126
|
+
# config.collection_wrapper_class = nil
|
127
|
+
|
128
|
+
# You can wrap each item in a collection of radio/check boxes with a tag,
|
129
|
+
# defaulting to :span. Please note that when using :boolean_style = :nested,
|
130
|
+
# SimpleForm will force this option to be a label.
|
131
|
+
# config.item_wrapper_tag = :span
|
132
|
+
|
133
|
+
# You can define a class to use in all item wrappers. Defaulting to none.
|
134
|
+
# config.item_wrapper_class = nil
|
135
|
+
|
136
|
+
# How the label text should be generated altogether with the required text.
|
137
|
+
# config.label_text = lambda { |label, required| "#{required} #{label}" }
|
138
|
+
|
139
|
+
# You can define the class to use on all labels. Default is nil.
|
140
|
+
config.label_class = 'control-label'
|
141
|
+
|
142
|
+
# You can define the class to use on all forms. Default is simple_form.
|
143
|
+
config.form_class = 'form-horizontal'
|
144
|
+
|
145
|
+
# You can define which elements should obtain additional classes
|
146
|
+
# config.generate_additional_classes_for = [:wrapper, :label, :input]
|
147
|
+
|
148
|
+
# Whether attributes are required by default (or not). Default is true.
|
149
|
+
# config.required_by_default = true
|
150
|
+
|
151
|
+
# Tell browsers whether to use default HTML5 validations (novalidate option).
|
152
|
+
# Default is enabled.
|
153
|
+
config.browser_validations = true
|
154
|
+
|
155
|
+
# Collection of methods to detect if a file type was given.
|
156
|
+
# config.file_methods = [ :mounted_as, :file?, :public_filename ]
|
157
|
+
|
158
|
+
# Custom mappings for input types. This should be a hash containing a regexp
|
159
|
+
# to match as key, and the input type that will be used when the field name
|
160
|
+
# matches the regexp as value.
|
161
|
+
# config.input_mappings = { /count/ => :integer }
|
162
|
+
|
163
|
+
# Default priority for time_zone inputs.
|
164
|
+
# config.time_zone_priority = nil
|
165
|
+
|
166
|
+
# Default priority for country inputs.
|
167
|
+
# config.country_priority = nil
|
168
|
+
|
169
|
+
# Default size for text inputs.
|
170
|
+
# config.default_input_size = 50
|
171
|
+
|
172
|
+
# When false, do not use translations for labels.
|
173
|
+
# config.translate_labels = true
|
174
|
+
|
175
|
+
# Automatically discover new inputs in Rails' autoload path.
|
176
|
+
# config.inputs_discovery = true
|
177
|
+
|
178
|
+
# Cache SimpleForm inputs discovery
|
179
|
+
# config.cache_discovery = !Rails.env.development?
|
180
|
+
end
|
181
|
+
end
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# Be sure to restart your server when you modify this file.
|
2
|
+
#
|
3
|
+
# This file contains settings for ActionController::ParamsWrapper which
|
4
|
+
# is enabled by default.
|
5
|
+
|
6
|
+
# Enable parameter wrapping for JSON. You can disable this by setting :format to an empty array.
|
7
|
+
ActiveSupport.on_load(:action_controller) do
|
8
|
+
wrap_parameters :format => [:json]
|
9
|
+
end
|
10
|
+
|
data/config/routes.rb
ADDED
@@ -0,0 +1,24 @@
|
|
1
|
+
module LeapWebCore
|
2
|
+
module AssertResponses
|
3
|
+
|
4
|
+
def assert_attachement_filename(name)
|
5
|
+
assert_equal %Q(attachment; filename="#{name}"),
|
6
|
+
@response.headers["Content-Disposition"]
|
7
|
+
end
|
8
|
+
|
9
|
+
|
10
|
+
def assert_json_response(object)
|
11
|
+
object.stringify_keys! if object.respond_to? :stringify_keys!
|
12
|
+
assert_equal object, JSON.parse(@response.body)
|
13
|
+
end
|
14
|
+
|
15
|
+
end
|
16
|
+
end
|
17
|
+
|
18
|
+
class ::ActionController::TestCase
|
19
|
+
include LeapWebCore::AssertResponses
|
20
|
+
end
|
21
|
+
|
22
|
+
class ::ActionDispatch::IntegrationTest
|
23
|
+
include LeapWebCore::AssertResponses
|
24
|
+
end
|
@@ -0,0 +1,40 @@
|
|
1
|
+
module LeapWebCore
|
2
|
+
class Dependencies
|
3
|
+
UI_DEV = {
|
4
|
+
"haml-rails" => "~> 0.3.4",
|
5
|
+
"sass-rails" => "~> 3.2.5",
|
6
|
+
"coffee-rails" => "~> 3.2.2",
|
7
|
+
"uglifier" => "~> 1.2.7"
|
8
|
+
}
|
9
|
+
|
10
|
+
UI = {
|
11
|
+
"haml" => "~> 3.1.7",
|
12
|
+
"bootstrap-sass" => "~> 2.0.4",
|
13
|
+
"jquery-rails" => nil,
|
14
|
+
"simple_form" => nil
|
15
|
+
}
|
16
|
+
|
17
|
+
def self.require_ui_gems
|
18
|
+
UI.keys.each {|dep| require dep}
|
19
|
+
if Rails.env == "development"
|
20
|
+
# This will be run in the app including plugins that run it.
|
21
|
+
# However not all development_dependencies might be present.
|
22
|
+
# So we better only require those that are.
|
23
|
+
available = Bundler.definition.specs.map(&:name)
|
24
|
+
gems_to_require = available & UI_DEV.keys
|
25
|
+
gems_to_require.each {|dep| require dep}
|
26
|
+
end
|
27
|
+
end
|
28
|
+
|
29
|
+
def self.add_ui_gems_to_spec(spec)
|
30
|
+
UI.each do |dep, version|
|
31
|
+
spec.add_dependency dep, version
|
32
|
+
end
|
33
|
+
|
34
|
+
UI_DEV.each do |dep, version|
|
35
|
+
spec.add_development_dependency dep, version
|
36
|
+
end
|
37
|
+
end
|
38
|
+
|
39
|
+
end
|
40
|
+
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.
|