district_cn_selector 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- data/.gitignore +27 -0
- data/.rspec +1 -0
- data/.travis.yml +14 -0
- data/Gemfile +37 -0
- data/LICENSE.txt +22 -0
- data/README.md +138 -0
- data/Rakefile +21 -0
- data/config/routes.rb +7 -0
- data/district_cn_selector.gemspec +27 -0
- data/lib/district_cn_selector.rb +22 -0
- data/lib/district_cn_selector/district_controller.rb +26 -0
- data/lib/district_cn_selector/district_select_helper.rb +46 -0
- data/lib/district_cn_selector/district_select_ul_helper.rb +48 -0
- data/lib/district_cn_selector/engine.rb +22 -0
- data/lib/district_cn_selector/helpers/form_builder.rb +13 -0
- data/lib/district_cn_selector/helpers/form_builder_extension.rb +49 -0
- data/lib/district_cn_selector/hooks/simple_form.rb +72 -0
- data/lib/district_cn_selector/selector.rb +202 -0
- data/lib/district_cn_selector/theme.rb +19 -0
- data/lib/district_cn_selector/version.rb +3 -0
- data/spec/controllers/district_cn_selector/district_controller_spec.rb +13 -0
- data/spec/dummy/README.rdoc +261 -0
- data/spec/dummy/Rakefile +7 -0
- data/spec/dummy/app/assets/javascripts/application.js +5 -0
- data/spec/dummy/app/assets/stylesheets/application.css.scss +31 -0
- data/spec/dummy/app/controllers/application_controller.rb +3 -0
- data/spec/dummy/app/controllers/home_controller.rb +7 -0
- data/spec/dummy/app/controllers/tests_controller.rb +10 -0
- data/spec/dummy/app/helpers/application_helper.rb +2 -0
- data/spec/dummy/app/mailers/.gitkeep +0 -0
- data/spec/dummy/app/models/company.rb +8 -0
- data/spec/dummy/app/views/home/index.html.erb +31 -0
- data/spec/dummy/app/views/home/select2_backup.html.erb +49 -0
- data/spec/dummy/app/views/layouts/application.html.erb +15 -0
- data/spec/dummy/app/views/tests/1.html.erb +8 -0
- data/spec/dummy/app/views/tests/2.html.erb +9 -0
- data/spec/dummy/app/views/tests/3.html.erb +7 -0
- data/spec/dummy/app/views/tests/4.html.erb +7 -0
- data/spec/dummy/app/views/tests/5.html.erb +7 -0
- data/spec/dummy/app/views/tests/6.html.erb +7 -0
- data/spec/dummy/config.ru +4 -0
- data/spec/dummy/config/application.rb +75 -0
- data/spec/dummy/config/boot.rb +10 -0
- data/spec/dummy/config/database.yml +16 -0
- data/spec/dummy/config/environment.rb +5 -0
- data/spec/dummy/config/environments/development.rb +37 -0
- data/spec/dummy/config/environments/production.rb +67 -0
- data/spec/dummy/config/environments/test.rb +37 -0
- data/spec/dummy/config/initializers/backtrace_silencers.rb +7 -0
- data/spec/dummy/config/initializers/inflections.rb +15 -0
- data/spec/dummy/config/initializers/mime_types.rb +5 -0
- data/spec/dummy/config/initializers/secret_token.rb +7 -0
- data/spec/dummy/config/initializers/session_store.rb +8 -0
- data/spec/dummy/config/initializers/simple_form.rb +142 -0
- data/spec/dummy/config/initializers/simple_form_bootstrap.rb +45 -0
- data/spec/dummy/config/initializers/wrap_parameters.rb +14 -0
- data/spec/dummy/config/locales/active_record.zh-CN.yml +11 -0
- data/spec/dummy/config/locales/en.yml +5 -0
- data/spec/dummy/config/locales/simple_form.en.yml +26 -0
- data/spec/dummy/config/routes.rb +5 -0
- data/spec/dummy/db/migrate/20130717055253_create_companies.rb +10 -0
- data/spec/dummy/db/schema.rb +24 -0
- data/spec/dummy/lib/assets/.gitkeep +0 -0
- data/spec/dummy/log/.gitkeep +0 -0
- data/spec/dummy/public/404.html +26 -0
- data/spec/dummy/public/422.html +26 -0
- data/spec/dummy/public/500.html +25 -0
- data/spec/dummy/public/area_select_cn/area-bg1.jpg +0 -0
- data/spec/dummy/public/area_select_cn/area-bg2.jpg +0 -0
- data/spec/dummy/public/favicon.ico +0 -0
- data/spec/dummy/script/rails +6 -0
- data/spec/factories/.gitkeep +0 -0
- data/spec/features/visit_testpage_spec.rb +93 -0
- data/spec/helpers/form_spec.rb +106 -0
- data/spec/helpers/simple_form_spec.rb +101 -0
- data/spec/spec_helper.rb +48 -0
- data/spec/support/mock_controller.rb +22 -0
- data/spec/support/view_test_helper.rb +29 -0
- data/vendor/assets/images/district_cn_selector/area-bg1.jpg +0 -0
- data/vendor/assets/images/district_cn_selector/area-bg2.jpg +0 -0
- data/vendor/assets/images/district_cn_selector/bootstrap-theme.png +0 -0
- data/vendor/assets/images/district_cn_selector/default-theme.png +0 -0
- data/vendor/assets/javascripts/district_cn_selector/jquery.district-ul.js +224 -0
- data/vendor/assets/javascripts/district_cn_selector/jquery.district.js +119 -0
- data/vendor/assets/stylesheets/district_cn_selector/district-ul.css +93 -0
- metadata +269 -0
@@ -0,0 +1,22 @@
|
|
1
|
+
module DistrictCnSelector
|
2
|
+
class Engine < ::Rails::Engine
|
3
|
+
|
4
|
+
end
|
5
|
+
end
|
6
|
+
# initializer "area_select_cn.active_model_ext" do
|
7
|
+
# ActiveSupport.on_load :active_record do
|
8
|
+
# ActiveRecord::Base.send :include, AreaSelectCn::ActsAsAreaSelectable
|
9
|
+
# end
|
10
|
+
# end
|
11
|
+
#config.generators do |g|
|
12
|
+
# g.test_framework :rspec, :fixture => false
|
13
|
+
# g.fixture_replacement :factory_girl, :dir => 'spec/factories'
|
14
|
+
# g.assets false
|
15
|
+
# g.helper false
|
16
|
+
#end
|
17
|
+
#initializer "area_select_cn.view_helpers" do
|
18
|
+
# ::ActiveSupport.on_load(:action_view) do
|
19
|
+
# ::ActionView::Base.send :include, AreaSelectCn::Helper
|
20
|
+
# end
|
21
|
+
#end
|
22
|
+
|
@@ -0,0 +1,13 @@
|
|
1
|
+
# encoding: utf-8
|
2
|
+
module DistrictCnSelector
|
3
|
+
module Helpers
|
4
|
+
class FormBuilder < ActionView::Helpers::FormBuilder
|
5
|
+
include FormBuilderExtension
|
6
|
+
end
|
7
|
+
end
|
8
|
+
end
|
9
|
+
|
10
|
+
# def skyeye_form_for(object, *args, &block)
|
11
|
+
# options = args.extract_options!
|
12
|
+
# simple_form_for(object, *(args << options.merge(:builder => Skyeye::FormBuilder)), &block)
|
13
|
+
# end
|
@@ -0,0 +1,49 @@
|
|
1
|
+
# encoding: utf-8
|
2
|
+
module DistrictCnSelector
|
3
|
+
module Helpers
|
4
|
+
module FormBuilderExtension
|
5
|
+
#select
|
6
|
+
def district_select(method, options={}, html_options={})
|
7
|
+
region_code = self.object.public_send(method)
|
8
|
+
@template.district_select(@object_name, method,
|
9
|
+
region_code, objectify_options(options), html_options)
|
10
|
+
end
|
11
|
+
alias_method :area_select, :district_select
|
12
|
+
|
13
|
+
def city_select(method, options={}, html_options={})
|
14
|
+
region_code = self.object.public_send(method)
|
15
|
+
@template.city_select(@object_name, method,
|
16
|
+
region_code, objectify_options(options), html_options)
|
17
|
+
end
|
18
|
+
|
19
|
+
def province_select(method, options={}, html_options={})
|
20
|
+
region_code = self.object.public_send(method)
|
21
|
+
@template.province_select(@object_name, method,
|
22
|
+
region_code, objectify_options(options), html_options)
|
23
|
+
end
|
24
|
+
|
25
|
+
|
26
|
+
#select-ul
|
27
|
+
def district_select_ul(method, options={}, html_options={})
|
28
|
+
region_code = self.object.public_send(method)
|
29
|
+
@template.area_select_ul(@object_name, method,
|
30
|
+
region_code, objectify_options(options), html_options)
|
31
|
+
end
|
32
|
+
alias_method :area_select_ul, :district_select_ul
|
33
|
+
|
34
|
+
def city_select_ul(method, options={}, html_options={})
|
35
|
+
region_code = self.object.public_send(method)
|
36
|
+
@template.city_select_ul(@object_name, method,
|
37
|
+
region_code, objectify_options(options), html_options)
|
38
|
+
end
|
39
|
+
|
40
|
+
def province_select_ul(method, options={}, html_options={})
|
41
|
+
region_code = self.object.public_send(method)
|
42
|
+
@template.province_select_ul(@object_name, method,
|
43
|
+
region_code, objectify_options(options), html_options)
|
44
|
+
end
|
45
|
+
|
46
|
+
|
47
|
+
end
|
48
|
+
end
|
49
|
+
end
|
@@ -0,0 +1,72 @@
|
|
1
|
+
#require 'active_support/concern'
|
2
|
+
module DistrictCnSelector
|
3
|
+
module Hooks
|
4
|
+
module SimpleFormBuilderExtension
|
5
|
+
class SelectBase < SimpleForm::Inputs::Base
|
6
|
+
def scope_input(scope)
|
7
|
+
opts = options.extract!(:theme, :prompt_class)
|
8
|
+
if SimpleForm.default_wrapper.eql?(:bootstrap) && opts[:theme].nil?
|
9
|
+
opts.merge!(:theme => :bootstrap)
|
10
|
+
end
|
11
|
+
@builder.public_send(scope, attribute_name, opts.merge(:simple_form => true))
|
12
|
+
end
|
13
|
+
end
|
14
|
+
#select
|
15
|
+
class DistrictSelectInput < SelectBase
|
16
|
+
def input
|
17
|
+
scope_input(:district_select)
|
18
|
+
end
|
19
|
+
end
|
20
|
+
|
21
|
+
class AreaSelectInput < DistrictSelectInput
|
22
|
+
|
23
|
+
end
|
24
|
+
|
25
|
+
class CitySelectInput < SelectBase
|
26
|
+
def input
|
27
|
+
scope_input(:city_select)
|
28
|
+
end
|
29
|
+
end
|
30
|
+
|
31
|
+
class ProvinceSelectInput < SelectBase
|
32
|
+
def input
|
33
|
+
scope_input(:province_select)
|
34
|
+
end
|
35
|
+
end
|
36
|
+
|
37
|
+
#select-ul
|
38
|
+
class DistrictSelectUlInput < SelectBase
|
39
|
+
def input
|
40
|
+
scope_input(:area_select_ul)
|
41
|
+
end
|
42
|
+
end
|
43
|
+
|
44
|
+
class AreaSelectUlInput < DistrictSelectUlInput
|
45
|
+
|
46
|
+
end
|
47
|
+
|
48
|
+
class CitySelectUlInput < SelectBase
|
49
|
+
def input
|
50
|
+
scope_input(:city_select_ul)
|
51
|
+
end
|
52
|
+
end
|
53
|
+
|
54
|
+
class ProvinceSelectUlInput < SelectBase
|
55
|
+
def input
|
56
|
+
scope_input(:province_select_ul)
|
57
|
+
end
|
58
|
+
end
|
59
|
+
|
60
|
+
|
61
|
+
end
|
62
|
+
end
|
63
|
+
end
|
64
|
+
|
65
|
+
::SimpleForm::FormBuilder.send :include,
|
66
|
+
DistrictCnSelector::Helpers::FormBuilderExtension
|
67
|
+
::SimpleForm::FormBuilder.send :include,
|
68
|
+
DistrictCnSelector::Hooks::SimpleFormBuilderExtension
|
69
|
+
|
70
|
+
|
71
|
+
|
72
|
+
|
@@ -0,0 +1,202 @@
|
|
1
|
+
# encoding: utf-8
|
2
|
+
require 'action_view/helpers/tag_helper'
|
3
|
+
require 'action_view/helpers/url_helper'
|
4
|
+
|
5
|
+
module DistrictCnSelector
|
6
|
+
|
7
|
+
class Selector
|
8
|
+
include ActionView::Helpers::TagHelper
|
9
|
+
include ActionView::Helpers::UrlHelper
|
10
|
+
attr_reader :instance_tag,:region_code,:options,:html_options
|
11
|
+
|
12
|
+
def initialize(instance_tag, region_code, options = {}, html_options = {})
|
13
|
+
@instance_tag = instance_tag
|
14
|
+
@region_code = region_code
|
15
|
+
@options = options.dup.merge(objectify_code.as_options)
|
16
|
+
@html_options = html_options.dup
|
17
|
+
end
|
18
|
+
|
19
|
+
def objectify_code
|
20
|
+
@objectify_code ||=
|
21
|
+
region_code.is_a?(DistrictCn::Code) && region_code || DistrictCn::Code.new(region_code)
|
22
|
+
end
|
23
|
+
|
24
|
+
def secure_random
|
25
|
+
@secure_random ||= "selector_#{SecureRandom.hex}"
|
26
|
+
end
|
27
|
+
|
28
|
+
def control_group(type)
|
29
|
+
controls = instance_tag.content_tag(:div, build_select(type), :class => "controls")
|
30
|
+
label = instance_tag.to_label_tag(nil, :class => "control-label")
|
31
|
+
content_tag(:div, [label, controls].join.html_safe, :class => "control-group district_cn_selector")
|
32
|
+
end
|
33
|
+
|
34
|
+
def build_hidden
|
35
|
+
instance_tag.to_input_field_tag("hidden", :class => "select-value", :value => objectify_code.value)
|
36
|
+
end
|
37
|
+
|
38
|
+
def to_select(type)
|
39
|
+
options[:simple_form] ? build_select(type) : control_group(type)
|
40
|
+
end
|
41
|
+
|
42
|
+
def build_select(type)
|
43
|
+
#overwrite
|
44
|
+
end
|
45
|
+
|
46
|
+
def build_one(type)
|
47
|
+
#overwrite
|
48
|
+
end
|
49
|
+
|
50
|
+
def select_district
|
51
|
+
[:province, :city, :district].map do |type|
|
52
|
+
build_one(type)
|
53
|
+
end.join
|
54
|
+
end
|
55
|
+
|
56
|
+
def select_city
|
57
|
+
[:province, :city].map do |type|
|
58
|
+
build_one(type)
|
59
|
+
end.join
|
60
|
+
end
|
61
|
+
|
62
|
+
def select_province
|
63
|
+
build_one(:province)
|
64
|
+
end
|
65
|
+
|
66
|
+
def selected(cur, required, class_name="active")
|
67
|
+
required = [required].flatten
|
68
|
+
required.index(cur) && class_name
|
69
|
+
end
|
70
|
+
end
|
71
|
+
|
72
|
+
class SelectUlSelector < Selector
|
73
|
+
BLANK = {:province => "省 份", :city => "城 市", :district => "区 县"}
|
74
|
+
|
75
|
+
def options
|
76
|
+
super.merge(theme_options(super))
|
77
|
+
end
|
78
|
+
|
79
|
+
def theme_options(opts)
|
80
|
+
theme = DistrictCnSelector::Theme.district_select_ul
|
81
|
+
theme_options = theme[opts[:theme]]
|
82
|
+
theme_options ||= theme[:default]
|
83
|
+
|
84
|
+
if opts[:theme].eql?(:bootstrap) && opts[:prompt_class].nil?
|
85
|
+
theme_options[:prompt_class] = "btn"
|
86
|
+
else
|
87
|
+
theme_options[:prompt_class] = opts[:prompt_class]
|
88
|
+
end
|
89
|
+
theme_options
|
90
|
+
end
|
91
|
+
|
92
|
+
def build_select(type)
|
93
|
+
content_tag(
|
94
|
+
:div,
|
95
|
+
[build_hidden, public_send("select_#{type}"), javascript_tag].join.html_safe,
|
96
|
+
:class => "#{secure_random}"
|
97
|
+
)
|
98
|
+
end
|
99
|
+
|
100
|
+
def javascript_tag
|
101
|
+
javascript = <<-JAVASCRIPT
|
102
|
+
<script>
|
103
|
+
if(window.AREA_SELECT_CN_DISTRICT_UL_FIELDS === undefined) {
|
104
|
+
window.AREA_SELECT_CN_DISTRICT_UL_FIELDS = [];
|
105
|
+
}
|
106
|
+
window.AREA_SELECT_CN_DISTRICT_UL_FIELDS.push(
|
107
|
+
[".#{secure_random}",
|
108
|
+
{
|
109
|
+
selectContainer: '.#{options[:select][:class]}',
|
110
|
+
selectOptsContainer: '.#{options[:select_options][:class]}',
|
111
|
+
selectPromptContainer: '.#{options[:select_prompt][:class]}',
|
112
|
+
onChange: function($container,code){
|
113
|
+
$container.find(".select-value").val(code);
|
114
|
+
}
|
115
|
+
}
|
116
|
+
]
|
117
|
+
);
|
118
|
+
</script>
|
119
|
+
JAVASCRIPT
|
120
|
+
javascript
|
121
|
+
end
|
122
|
+
|
123
|
+
def build_one(type)
|
124
|
+
selected_scope = options["selected_#{type}".intern]
|
125
|
+
selected_scopes = options["selected_#{type.to_s.pluralize}".intern]
|
126
|
+
|
127
|
+
pmt = ''
|
128
|
+
data_value = selected_scope && {:value => selected_scope[1]} || {}
|
129
|
+
data_text = selected_scope && selected_scope[0] || BLANK[type]
|
130
|
+
pmt << content_tag(:span, data_text, :class => "select-content", :data => data_value)
|
131
|
+
pmt << content_tag(:span, "", options[:caret])
|
132
|
+
|
133
|
+
opts = ''
|
134
|
+
blank_link = link_to(BLANK[type], "javascript:void(0);")
|
135
|
+
opts << content_tag(:li, blank_link, :class => selected(selected_scope, nil), :data => {:value => ""})
|
136
|
+
|
137
|
+
selected_scopes.each do |type|
|
138
|
+
scope_link = link_to type[0], "javascript:void(0);"
|
139
|
+
opts << content_tag(:li, scope_link, :class => selected(type[1], selected_scope && selected_scope[1]), :data => {:value => type[1]})
|
140
|
+
end
|
141
|
+
|
142
|
+
prompt_class = {
|
143
|
+
:class => [options[:select_prompt][:class], options[:prompt_class]].join(" ")
|
144
|
+
}
|
145
|
+
prompt = link_to(pmt.html_safe, "javascript:void(0);", options[:select_prompt].merge(prompt_class))
|
146
|
+
select_options = content_tag(:ul, opts.html_safe, options[:select_options].merge(:style => "max-height:350px;overflow:scroll"))
|
147
|
+
|
148
|
+
select = prompt + select_options
|
149
|
+
select_class = options[:select][:class]
|
150
|
+
content_tag(:div, select, options[:select].merge(:class => [select_class, type].join(" ")))
|
151
|
+
end
|
152
|
+
|
153
|
+
end
|
154
|
+
|
155
|
+
class SelectSelector < Selector
|
156
|
+
BLANK = {
|
157
|
+
:province => ["省 份",""],
|
158
|
+
:city => ["城 市",""],
|
159
|
+
:district => ["区 县",""]
|
160
|
+
}
|
161
|
+
|
162
|
+
def javascript_tag
|
163
|
+
javascript = <<-JAVASCRIPT
|
164
|
+
<script>
|
165
|
+
if(window.AREA_SELECT_CN_DISTRICT_FIELDS === undefined) {
|
166
|
+
window.AREA_SELECT_CN_DISTRICT_FIELDS = [];
|
167
|
+
}
|
168
|
+
window.AREA_SELECT_CN_DISTRICT_FIELDS.push(
|
169
|
+
[".#{secure_random}",
|
170
|
+
{
|
171
|
+
onChange: function($container,code){
|
172
|
+
$container.find(".select-value").val(code);
|
173
|
+
}
|
174
|
+
}
|
175
|
+
]
|
176
|
+
);
|
177
|
+
</script>
|
178
|
+
JAVASCRIPT
|
179
|
+
javascript
|
180
|
+
end
|
181
|
+
|
182
|
+
def build_select(type)
|
183
|
+
content_tag(
|
184
|
+
:div,
|
185
|
+
[public_send("select_#{type}"), build_hidden, javascript_tag].join.html_safe,
|
186
|
+
:class => "#{secure_random}"
|
187
|
+
)
|
188
|
+
end
|
189
|
+
|
190
|
+
def build_one(type)
|
191
|
+
selected_scope = options["selected_#{type}".intern]
|
192
|
+
selected_scopes = options["selected_#{type.to_s.pluralize}".intern]
|
193
|
+
|
194
|
+
instance_tag.to_select_tag(
|
195
|
+
selected_scopes.unshift(BLANK[type]),
|
196
|
+
{:selected =>selected_scope && selected_scope[1]}.merge(options),
|
197
|
+
{:id=>nil,:class=>type}.merge(html_options)
|
198
|
+
)
|
199
|
+
end
|
200
|
+
|
201
|
+
end
|
202
|
+
end
|
@@ -0,0 +1,19 @@
|
|
1
|
+
module DistrictCnSelector
|
2
|
+
module Theme
|
3
|
+
def self.district_select_ul
|
4
|
+
{
|
5
|
+
:default => {
|
6
|
+
:select => {:class=>"select-input"},
|
7
|
+
:select_options => {:class=>"select-opts"},
|
8
|
+
:select_prompt => {:class=>"select-prompt"},
|
9
|
+
:caret => {:class=>"select-tangle"} },
|
10
|
+
|
11
|
+
:bootstrap => {
|
12
|
+
:select => {:class=>"btn-group"},
|
13
|
+
:select_options => {:class=>"dropdown-menu"},
|
14
|
+
:select_prompt => {:class=>"dropdown-toggle"},
|
15
|
+
:caret => {:class=>"caret"}}
|
16
|
+
}
|
17
|
+
end
|
18
|
+
end
|
19
|
+
end
|
@@ -0,0 +1,13 @@
|
|
1
|
+
# encoding: utf-8
|
2
|
+
require 'spec_helper'
|
3
|
+
|
4
|
+
describe DistrictCnSelector::DistrictController do
|
5
|
+
|
6
|
+
it "should return json list" do
|
7
|
+
expected={"330000" => { :text=>"浙江省",:children=>{ "330100"=> { :text=>"杭州市", :children=>{ "330108"=>{:text=>"滨江区"} }}}}}
|
8
|
+
DistrictCn.stub(:tree).and_return(expected)
|
9
|
+
get :index, {}
|
10
|
+
expect(response.body).to eq(expected.to_json)
|
11
|
+
end
|
12
|
+
|
13
|
+
end
|
@@ -0,0 +1,261 @@
|
|
1
|
+
== Welcome to Rails
|
2
|
+
|
3
|
+
Rails is a web-application framework that includes everything needed to create
|
4
|
+
database-backed web applications according to the Model-View-Control pattern.
|
5
|
+
|
6
|
+
This pattern splits the view (also called the presentation) into "dumb"
|
7
|
+
templates that are primarily responsible for inserting pre-built data in between
|
8
|
+
HTML tags. The model contains the "smart" domain objects (such as Account,
|
9
|
+
Product, Person, Post) that holds all the business logic and knows how to
|
10
|
+
persist themselves to a database. The controller handles the incoming requests
|
11
|
+
(such as Save New Account, Update Product, Show Post) by manipulating the model
|
12
|
+
and directing data to the view.
|
13
|
+
|
14
|
+
In Rails, the model is handled by what's called an object-relational mapping
|
15
|
+
layer entitled Active Record. This layer allows you to present the data from
|
16
|
+
database rows as objects and embellish these data objects with business logic
|
17
|
+
methods. You can read more about Active Record in
|
18
|
+
link:files/vendor/rails/activerecord/README.html.
|
19
|
+
|
20
|
+
The controller and view are handled by the Action Pack, which handles both
|
21
|
+
layers by its two parts: Action View and Action Controller. These two layers
|
22
|
+
are bundled in a single package due to their heavy interdependence. This is
|
23
|
+
unlike the relationship between the Active Record and Action Pack that is much
|
24
|
+
more separate. Each of these packages can be used independently outside of
|
25
|
+
Rails. You can read more about Action Pack in
|
26
|
+
link:files/vendor/rails/actionpack/README.html.
|
27
|
+
|
28
|
+
|
29
|
+
== Getting Started
|
30
|
+
|
31
|
+
1. At the command prompt, create a new Rails application:
|
32
|
+
<tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
|
33
|
+
|
34
|
+
2. Change directory to <tt>myapp</tt> and start the web server:
|
35
|
+
<tt>cd myapp; rails server</tt> (run with --help for options)
|
36
|
+
|
37
|
+
3. Go to http://localhost:3000/ and you'll see:
|
38
|
+
"Welcome aboard: You're riding Ruby on Rails!"
|
39
|
+
|
40
|
+
4. Follow the guidelines to start developing your application. You can find
|
41
|
+
the following resources handy:
|
42
|
+
|
43
|
+
* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
|
44
|
+
* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
|
45
|
+
|
46
|
+
|
47
|
+
== Debugging Rails
|
48
|
+
|
49
|
+
Sometimes your application goes wrong. Fortunately there are a lot of tools that
|
50
|
+
will help you debug it and get it back on the rails.
|
51
|
+
|
52
|
+
First area to check is the application log files. Have "tail -f" commands
|
53
|
+
running on the server.log and development.log. Rails will automatically display
|
54
|
+
debugging and runtime information to these files. Debugging info will also be
|
55
|
+
shown in the browser on requests from 127.0.0.1.
|
56
|
+
|
57
|
+
You can also log your own messages directly into the log file from your code
|
58
|
+
using the Ruby logger class from inside your controllers. Example:
|
59
|
+
|
60
|
+
class WeblogController < ActionController::Base
|
61
|
+
def destroy
|
62
|
+
@weblog = Weblog.find(params[:id])
|
63
|
+
@weblog.destroy
|
64
|
+
logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
|
65
|
+
end
|
66
|
+
end
|
67
|
+
|
68
|
+
The result will be a message in your log file along the lines of:
|
69
|
+
|
70
|
+
Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
|
71
|
+
|
72
|
+
More information on how to use the logger is at http://www.ruby-doc.org/core/
|
73
|
+
|
74
|
+
Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
|
75
|
+
several books available online as well:
|
76
|
+
|
77
|
+
* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
|
78
|
+
* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
|
79
|
+
|
80
|
+
These two books will bring you up to speed on the Ruby language and also on
|
81
|
+
programming in general.
|
82
|
+
|
83
|
+
|
84
|
+
== Debugger
|
85
|
+
|
86
|
+
Debugger support is available through the debugger command when you start your
|
87
|
+
Mongrel or WEBrick server with --debugger. This means that you can break out of
|
88
|
+
execution at any point in the code, investigate and change the model, and then,
|
89
|
+
resume execution! You need to install ruby-debug to run the server in debugging
|
90
|
+
mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
|
91
|
+
|
92
|
+
class WeblogController < ActionController::Base
|
93
|
+
def index
|
94
|
+
@posts = Post.all
|
95
|
+
debugger
|
96
|
+
end
|
97
|
+
end
|
98
|
+
|
99
|
+
So the controller will accept the action, run the first line, then present you
|
100
|
+
with a IRB prompt in the server window. Here you can do things like:
|
101
|
+
|
102
|
+
>> @posts.inspect
|
103
|
+
=> "[#<Post:0x14a6be8
|
104
|
+
@attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
|
105
|
+
#<Post:0x14a6620
|
106
|
+
@attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
|
107
|
+
>> @posts.first.title = "hello from a debugger"
|
108
|
+
=> "hello from a debugger"
|
109
|
+
|
110
|
+
...and even better, you can examine how your runtime objects actually work:
|
111
|
+
|
112
|
+
>> f = @posts.first
|
113
|
+
=> #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
|
114
|
+
>> f.
|
115
|
+
Display all 152 possibilities? (y or n)
|
116
|
+
|
117
|
+
Finally, when you're ready to resume execution, you can enter "cont".
|
118
|
+
|
119
|
+
|
120
|
+
== Console
|
121
|
+
|
122
|
+
The console is a Ruby shell, which allows you to interact with your
|
123
|
+
application's domain model. Here you'll have all parts of the application
|
124
|
+
configured, just like it is when the application is running. You can inspect
|
125
|
+
domain models, change values, and save to the database. Starting the script
|
126
|
+
without arguments will launch it in the development environment.
|
127
|
+
|
128
|
+
To start the console, run <tt>rails console</tt> from the application
|
129
|
+
directory.
|
130
|
+
|
131
|
+
Options:
|
132
|
+
|
133
|
+
* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
|
134
|
+
made to the database.
|
135
|
+
* Passing an environment name as an argument will load the corresponding
|
136
|
+
environment. Example: <tt>rails console production</tt>.
|
137
|
+
|
138
|
+
To reload your controllers and models after launching the console run
|
139
|
+
<tt>reload!</tt>
|
140
|
+
|
141
|
+
More information about irb can be found at:
|
142
|
+
link:http://www.rubycentral.org/pickaxe/irb.html
|
143
|
+
|
144
|
+
|
145
|
+
== dbconsole
|
146
|
+
|
147
|
+
You can go to the command line of your database directly through <tt>rails
|
148
|
+
dbconsole</tt>. You would be connected to the database with the credentials
|
149
|
+
defined in database.yml. Starting the script without arguments will connect you
|
150
|
+
to the development database. Passing an argument will connect you to a different
|
151
|
+
database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
|
152
|
+
PostgreSQL and SQLite 3.
|
153
|
+
|
154
|
+
== Description of Contents
|
155
|
+
|
156
|
+
The default directory structure of a generated Ruby on Rails application:
|
157
|
+
|
158
|
+
|-- app
|
159
|
+
| |-- assets
|
160
|
+
| | |-- images
|
161
|
+
| | |-- javascripts
|
162
|
+
| | `-- stylesheets
|
163
|
+
| |-- controllers
|
164
|
+
| |-- helpers
|
165
|
+
| |-- mailers
|
166
|
+
| |-- models
|
167
|
+
| `-- views
|
168
|
+
| `-- layouts
|
169
|
+
|-- config
|
170
|
+
| |-- environments
|
171
|
+
| |-- initializers
|
172
|
+
| `-- locales
|
173
|
+
|-- db
|
174
|
+
|-- doc
|
175
|
+
|-- lib
|
176
|
+
| |-- assets
|
177
|
+
| `-- tasks
|
178
|
+
|-- log
|
179
|
+
|-- public
|
180
|
+
|-- script
|
181
|
+
|-- test
|
182
|
+
| |-- fixtures
|
183
|
+
| |-- functional
|
184
|
+
| |-- integration
|
185
|
+
| |-- performance
|
186
|
+
| `-- unit
|
187
|
+
|-- tmp
|
188
|
+
| `-- cache
|
189
|
+
| `-- assets
|
190
|
+
`-- vendor
|
191
|
+
|-- assets
|
192
|
+
| |-- javascripts
|
193
|
+
| `-- stylesheets
|
194
|
+
`-- plugins
|
195
|
+
|
196
|
+
app
|
197
|
+
Holds all the code that's specific to this particular application.
|
198
|
+
|
199
|
+
app/assets
|
200
|
+
Contains subdirectories for images, stylesheets, and JavaScript files.
|
201
|
+
|
202
|
+
app/controllers
|
203
|
+
Holds controllers that should be named like weblogs_controller.rb for
|
204
|
+
automated URL mapping. All controllers should descend from
|
205
|
+
ApplicationController which itself descends from ActionController::Base.
|
206
|
+
|
207
|
+
app/models
|
208
|
+
Holds models that should be named like post.rb. Models descend from
|
209
|
+
ActiveRecord::Base by default.
|
210
|
+
|
211
|
+
app/views
|
212
|
+
Holds the template files for the view that should be named like
|
213
|
+
weblogs/index.html.erb for the WeblogsController#index action. All views use
|
214
|
+
eRuby syntax by default.
|
215
|
+
|
216
|
+
app/views/layouts
|
217
|
+
Holds the template files for layouts to be used with views. This models the
|
218
|
+
common header/footer method of wrapping views. In your views, define a layout
|
219
|
+
using the <tt>layout :default</tt> and create a file named default.html.erb.
|
220
|
+
Inside default.html.erb, call <% yield %> to render the view using this
|
221
|
+
layout.
|
222
|
+
|
223
|
+
app/helpers
|
224
|
+
Holds view helpers that should be named like weblogs_helper.rb. These are
|
225
|
+
generated for you automatically when using generators for controllers.
|
226
|
+
Helpers can be used to wrap functionality for your views into methods.
|
227
|
+
|
228
|
+
config
|
229
|
+
Configuration files for the Rails environment, the routing map, the database,
|
230
|
+
and other dependencies.
|
231
|
+
|
232
|
+
db
|
233
|
+
Contains the database schema in schema.rb. db/migrate contains all the
|
234
|
+
sequence of Migrations for your schema.
|
235
|
+
|
236
|
+
doc
|
237
|
+
This directory is where your application documentation will be stored when
|
238
|
+
generated using <tt>rake doc:app</tt>
|
239
|
+
|
240
|
+
lib
|
241
|
+
Application specific libraries. Basically, any kind of custom code that
|
242
|
+
doesn't belong under controllers, models, or helpers. This directory is in
|
243
|
+
the load path.
|
244
|
+
|
245
|
+
public
|
246
|
+
The directory available for the web server. Also contains the dispatchers and the
|
247
|
+
default HTML files. This should be set as the DOCUMENT_ROOT of your web
|
248
|
+
server.
|
249
|
+
|
250
|
+
script
|
251
|
+
Helper scripts for automation and generation.
|
252
|
+
|
253
|
+
test
|
254
|
+
Unit and functional tests along with fixtures. When using the rails generate
|
255
|
+
command, template test files will be generated for you and placed in this
|
256
|
+
directory.
|
257
|
+
|
258
|
+
vendor
|
259
|
+
External libraries that the application depends on. Also includes the plugins
|
260
|
+
subdirectory. If the app has frozen rails, those gems also go here, under
|
261
|
+
vendor/rails/. This directory is in the load path.
|