meta_types 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/README.rdoc +184 -0
- data/Rakefile +40 -0
- data/app/assets/javascripts/meta_types/application.js +15 -0
- data/app/assets/stylesheets/meta_types/application.css +13 -0
- data/app/controllers/meta_types/application_controller.rb +4 -0
- data/app/helpers/meta_types/application_helper.rb +4 -0
- data/app/models/meta_type.rb +36 -0
- data/app/models/meta_type_member.rb +29 -0
- data/app/models/meta_type_property.rb +74 -0
- data/app/views/layouts/meta_types/application.html.erb +14 -0
- data/config/routes.rb +2 -0
- data/db/migrate/20120507130230_create_hstore.rb +9 -0
- data/db/migrate/20120507130237_meta_type.rb +19 -0
- data/db/migrate/20120507130255_meta_type_property.rb +23 -0
- data/db/migrate/20120507130303_meta_type_member.rb +18 -0
- data/lib/meta_types.rb +9 -0
- data/lib/meta_types/active_record.rb +48 -0
- data/lib/meta_types/engine.rb +5 -0
- data/lib/meta_types/meta_properties.rb +93 -0
- data/lib/meta_types/meta_property.rb +27 -0
- data/lib/meta_types/meta_property_type.rb +59 -0
- data/lib/meta_types/version.rb +3 -0
- data/lib/tasks/meta_types_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 +16 -0
- data/test/dummy/app/assets/stylesheets/application.scss +15 -0
- data/test/dummy/app/controllers/application_controller.rb +3 -0
- data/test/dummy/app/controllers/dashboard_controller.rb +3 -0
- data/test/dummy/app/controllers/meta_type_properties_controller.rb +7 -0
- data/test/dummy/app/controllers/meta_types_controller.rb +7 -0
- data/test/dummy/app/controllers/things_controller.rb +34 -0
- data/test/dummy/app/helpers/application_helper.rb +2 -0
- data/test/dummy/app/models/thing.rb +6 -0
- data/test/dummy/app/views/dashboard/index.html.erb +14 -0
- data/test/dummy/app/views/layouts/application.html.erb +58 -0
- data/test/dummy/app/views/meta_type_properties/_meta_type_property.html.erb +10 -0
- data/test/dummy/app/views/meta_type_properties/edit.html.erb +5 -0
- data/test/dummy/app/views/meta_type_properties/index.html.erb +9 -0
- data/test/dummy/app/views/meta_type_properties/new.html.erb +5 -0
- data/test/dummy/app/views/meta_types/_meta_type.html.erb +6 -0
- data/test/dummy/app/views/meta_types/edit.html.erb +5 -0
- data/test/dummy/app/views/meta_types/index.html.erb +9 -0
- data/test/dummy/app/views/meta_types/new.html.erb +5 -0
- data/test/dummy/app/views/things/_thing.html.erb +10 -0
- data/test/dummy/app/views/things/edit.html.erb +5 -0
- data/test/dummy/app/views/things/index.html.erb +9 -0
- data/test/dummy/app/views/things/new.html.erb +12 -0
- data/test/dummy/app/views/things/show.html.erb +10 -0
- data/test/dummy/config.ru +4 -0
- data/test/dummy/config/application.rb +58 -0
- data/test/dummy/config/boot.rb +10 -0
- data/test/dummy/config/database.yml +25 -0
- data/test/dummy/config/environment.rb +5 -0
- data/test/dummy/config/environments/development.rb +37 -0
- data/test/dummy/config/environments/production.rb +67 -0
- data/test/dummy/config/environments/test.rb +37 -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/simple_form.rb +178 -0
- data/test/dummy/config/initializers/wrap_parameters.rb +14 -0
- data/test/dummy/config/locales/en.yml +5 -0
- data/test/dummy/config/locales/simple_form.en.yml +26 -0
- data/test/dummy/config/routes.rb +6 -0
- data/test/dummy/db/migrate/20120507130230_create_hstore.rb +9 -0
- data/test/dummy/db/migrate/20120507130237_meta_type.rb +19 -0
- data/test/dummy/db/migrate/20120507130255_meta_type_property.rb +23 -0
- data/test/dummy/db/migrate/20120507130303_meta_type_member.rb +18 -0
- data/test/dummy/db/migrate/20120508143058_create_things.rb +14 -0
- data/test/dummy/db/seeds.rb +28 -0
- data/test/dummy/db/structure.sql +309 -0
- data/test/dummy/lib/templates/erb/scaffold/_form.html.erb +13 -0
- data/test/dummy/log/development.log +8958 -0
- data/test/dummy/log/test.log +5559 -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/cache/assets/C7F/AF0/sprockets%2F1f64b7e05e310702c90b98e4816685a2 +0 -0
- data/test/dummy/tmp/cache/assets/C94/420/sprockets%2F639d84895339654f12ac2bde8292d447 +0 -0
- data/test/dummy/tmp/cache/assets/CB1/FD0/sprockets%2F6e1bd95023705b5529e7ccc754a02867 +0 -0
- data/test/dummy/tmp/cache/assets/CD8/370/sprockets%2F357970feca3ac29060c1e3861e2c0953 +0 -0
- data/test/dummy/tmp/cache/assets/CFF/E00/sprockets%2F352bab412d75fa19d0a07504553b59df +0 -0
- data/test/dummy/tmp/cache/assets/D32/A10/sprockets%2F13fe41fee1fe35b49d145bcc06610705 +0 -0
- data/test/dummy/tmp/cache/assets/D49/8D0/sprockets%2F92613a75279536c4bcf4f3ba6cfde494 +0 -0
- data/test/dummy/tmp/cache/assets/D4E/1B0/sprockets%2Ff7cbd26ba1d28d48de824f0e94586655 +0 -0
- data/test/dummy/tmp/cache/assets/D59/6F0/sprockets%2F7c015202319d3bb46ea41d4ff9b5ac0d +0 -0
- data/test/dummy/tmp/cache/assets/D5A/EA0/sprockets%2Fd771ace226fc8215a3572e0aa35bb0d6 +0 -0
- data/test/dummy/tmp/cache/assets/D9F/640/sprockets%2Fbbc63c99f5e0eef2a890442ea3431dd7 +0 -0
- data/test/dummy/tmp/cache/assets/DB1/370/sprockets%2F18d79bbfdd80aa3bde79ab687266d992 +0 -0
- data/test/dummy/tmp/cache/assets/DDC/400/sprockets%2Fcffd775d018f68ce5dba1ee0d951a994 +0 -0
- data/test/dummy/tmp/cache/assets/E02/0E0/sprockets%2Fa8f15cbf61c3d8edb5a99dbafd690721 +0 -0
- data/test/dummy/tmp/cache/assets/E04/890/sprockets%2F2f5173deea6c795b8fdde723bb4b63af +0 -0
- data/test/meta_types_test.rb +7 -0
- data/test/test_helper.rb +15 -0
- data/test/unit/meta_types/meta_type_test.rb +181 -0
- metadata +257 -0
data/config/routes.rb
ADDED
@@ -0,0 +1,19 @@
|
|
1
|
+
class MetaType < ActiveRecord::Migration
|
2
|
+
def up
|
3
|
+
# we have a type column to allow STI to have a ProductType, a CustomerType and the like
|
4
|
+
execute <<-CREATE_SQL
|
5
|
+
create table meta_types (
|
6
|
+
id serial PRIMARY KEY,
|
7
|
+
sid character varying not null UNIQUE,
|
8
|
+
type character varying,
|
9
|
+
title character varying not null UNIQUE,
|
10
|
+
created_at timestamp without time zone,
|
11
|
+
updated_at timestamp without time zone
|
12
|
+
);
|
13
|
+
CREATE_SQL
|
14
|
+
end
|
15
|
+
|
16
|
+
def down
|
17
|
+
execute "DROP TABLE meta_types"
|
18
|
+
end
|
19
|
+
end
|
@@ -0,0 +1,23 @@
|
|
1
|
+
class MetaTypeProperty < ActiveRecord::Migration
|
2
|
+
def up
|
3
|
+
execute <<-CREATE_SQL
|
4
|
+
create table meta_type_properties (
|
5
|
+
id serial NOT NULL PRIMARY KEY,
|
6
|
+
sid character varying,
|
7
|
+
label character varying not null,
|
8
|
+
property_type_sid character varying not null,
|
9
|
+
required boolean not null default false,
|
10
|
+
system boolean not null default false,
|
11
|
+
dimension character varying null default null,
|
12
|
+
default_value character varying null default null,
|
13
|
+
choices character varying,
|
14
|
+
created_at timestamp without time zone,
|
15
|
+
updated_at timestamp without time zone
|
16
|
+
);
|
17
|
+
CREATE_SQL
|
18
|
+
end
|
19
|
+
|
20
|
+
def down
|
21
|
+
execute "drop table meta_type_properties"
|
22
|
+
end
|
23
|
+
end
|
@@ -0,0 +1,18 @@
|
|
1
|
+
class MetaTypeMember < ActiveRecord::Migration
|
2
|
+
def up
|
3
|
+
execute <<-CREATE_SQL
|
4
|
+
create table meta_type_members (
|
5
|
+
id serial PRIMARY KEY,
|
6
|
+
meta_type_id integer references meta_types(id),
|
7
|
+
meta_type_property_id integer references meta_type_properties(id),
|
8
|
+
position integer,
|
9
|
+
created_at timestamp without time zone,
|
10
|
+
updated_at timestamp without time zone
|
11
|
+
);
|
12
|
+
CREATE_SQL
|
13
|
+
end
|
14
|
+
|
15
|
+
def down
|
16
|
+
execute "drop table meta_type_members"
|
17
|
+
end
|
18
|
+
end
|
data/lib/meta_types.rb
ADDED
@@ -0,0 +1,48 @@
|
|
1
|
+
module MetaTypes::ActiveRecordAddons
|
2
|
+
|
3
|
+
module ClassMethods
|
4
|
+
def meta_typed(nam, hstore=nil)
|
5
|
+
hstore ||= "#{nam}_hstore"
|
6
|
+
raise "No column named '#{hstore}' found." unless attribute_names.member? hstore
|
7
|
+
vnam = "@_meta_properties_#{nam}"
|
8
|
+
belongs_to :meta_type
|
9
|
+
|
10
|
+
define_method nam do
|
11
|
+
return nil unless meta_type
|
12
|
+
m = instance_variable_get(vnam)
|
13
|
+
m ||= instance_variable_set(vnam, MetaTypes::MetaProperties.new(self, hstore))
|
14
|
+
end
|
15
|
+
|
16
|
+
define_method "#{nam}_attributes=" do |hash|
|
17
|
+
self.send(nam).update_attributes(hash)
|
18
|
+
end
|
19
|
+
attr_accessible "#{nam}_attributes"
|
20
|
+
|
21
|
+
self.define_singleton_method "where_#{nam}" do |conditions_hash|
|
22
|
+
conditions_hash.inject(where("1=1")) do |relation, (k,v)|
|
23
|
+
relation.where("#{hstore} @> (? => ?)", k.to_s, v.to_s)
|
24
|
+
end
|
25
|
+
end
|
26
|
+
|
27
|
+
self.define_singleton_method "where_#{nam}_like" do |conditions_hash|
|
28
|
+
conditions_hash.inject(where("1=1")) do |relation, (k,v)|
|
29
|
+
relation.where("#{hstore} -> ? LIKE ?", k.to_s, v.to_s)
|
30
|
+
end
|
31
|
+
end
|
32
|
+
|
33
|
+
# validate do
|
34
|
+
# v = self.send(nam).valid?
|
35
|
+
# errors.add(nam, v) if v.present?
|
36
|
+
# end
|
37
|
+
end
|
38
|
+
end
|
39
|
+
|
40
|
+
class << self
|
41
|
+
def included(by)
|
42
|
+
by.send :extend, MetaTypes::ActiveRecordAddons::ClassMethods
|
43
|
+
end
|
44
|
+
end
|
45
|
+
|
46
|
+
end
|
47
|
+
|
48
|
+
ActiveRecord::Base.send :include, MetaTypes::ActiveRecordAddons
|
@@ -0,0 +1,93 @@
|
|
1
|
+
class MetaTypes::MetaProperties
|
2
|
+
|
3
|
+
include Enumerable
|
4
|
+
|
5
|
+
attr_accessor :_model
|
6
|
+
attr_accessor :_hsname
|
7
|
+
attr_accessor :_props
|
8
|
+
|
9
|
+
def initialize(model, hsname)
|
10
|
+
self._model = model
|
11
|
+
self._hsname = hsname
|
12
|
+
self._props = meta_type && meta_type.meta_type_properties.ordered.inject({}) do |h, mp|
|
13
|
+
|
14
|
+
h[mp.sid] = MetaTypes::MetaProperty.new(self, mp.sid)
|
15
|
+
|
16
|
+
self.define_singleton_method mp.sid do
|
17
|
+
h[mp.sid].value
|
18
|
+
end
|
19
|
+
|
20
|
+
self.define_singleton_method "#{mp.sid}=" do |v|
|
21
|
+
h[mp.sid].value = v
|
22
|
+
end
|
23
|
+
|
24
|
+
h
|
25
|
+
end
|
26
|
+
end
|
27
|
+
|
28
|
+
def update_attributes(hashh)
|
29
|
+
hash = hashh.dup
|
30
|
+
date_keys = hash.keys.select{|k| /\([123]i\)\Z/.match(k) }.map{|k|
|
31
|
+
k.split("(").first
|
32
|
+
}.uniq.each{|k|
|
33
|
+
dats = (1..3).map{|i| hash.delete("#{k}(#{i}i)")}.join("-")
|
34
|
+
self.send "#{k}=", dats
|
35
|
+
}
|
36
|
+
hash.each do |k,v|
|
37
|
+
self.send "#{k}=", v
|
38
|
+
end
|
39
|
+
end
|
40
|
+
|
41
|
+
def validate
|
42
|
+
raise "saa"
|
43
|
+
end
|
44
|
+
|
45
|
+
def valid?
|
46
|
+
inject([]) do |e, v|
|
47
|
+
v.required && v.value.blank? ?
|
48
|
+
e << "#{v.label} must be present" :
|
49
|
+
e
|
50
|
+
end.join(", ").presence
|
51
|
+
end
|
52
|
+
|
53
|
+
def persisted?()
|
54
|
+
false
|
55
|
+
end
|
56
|
+
|
57
|
+
def each()
|
58
|
+
_props.each { |k,v| yield(v) }
|
59
|
+
end
|
60
|
+
|
61
|
+
def length
|
62
|
+
_props.length
|
63
|
+
end
|
64
|
+
alias_method :count, :length
|
65
|
+
|
66
|
+
def meta_type()
|
67
|
+
_model.meta_type
|
68
|
+
end
|
69
|
+
|
70
|
+
def set_value(sid, val)
|
71
|
+
_model.send "#{_hsname}=", (_model.send("#{_hsname}") || {}).merge(sid => val)
|
72
|
+
end
|
73
|
+
|
74
|
+
def get_value(sid)
|
75
|
+
_model.send(_hsname).try :[], sid
|
76
|
+
end
|
77
|
+
|
78
|
+
def [](sid)
|
79
|
+
_props[sid.to_s]
|
80
|
+
end
|
81
|
+
|
82
|
+
def column_for_attribute(sid)
|
83
|
+
MetaTypeProperty[sid]
|
84
|
+
end
|
85
|
+
|
86
|
+
class << self
|
87
|
+
def validators_on(sid)
|
88
|
+
MetaTypeProperty[sid].required? ?
|
89
|
+
[ActiveModel::Validations::PresenceValidator.new(attributes: [:title])] :
|
90
|
+
[]
|
91
|
+
end
|
92
|
+
end
|
93
|
+
end
|
@@ -0,0 +1,27 @@
|
|
1
|
+
class MetaTypes::MetaProperty
|
2
|
+
attr_accessor :meta_properties
|
3
|
+
attr_accessor :meta_type_property
|
4
|
+
attr_accessor :sid
|
5
|
+
|
6
|
+
def initialize(meta_properties, sid)
|
7
|
+
self.meta_properties = meta_properties
|
8
|
+
self.sid = sid
|
9
|
+
self.meta_type_property = MetaTypeProperty[sid]
|
10
|
+
end
|
11
|
+
|
12
|
+
def value
|
13
|
+
meta_type_property.cast(meta_properties.try(:get_value, sid) || meta_type_property.default_value)
|
14
|
+
end
|
15
|
+
|
16
|
+
def value=(val)
|
17
|
+
meta_properties.set_value(sid, meta_type_property.parse(val))
|
18
|
+
end
|
19
|
+
|
20
|
+
def choices()
|
21
|
+
ch = meta_type_property.choices.presence
|
22
|
+
ch && ch.split('||').map(&:strip)
|
23
|
+
end
|
24
|
+
|
25
|
+
delegate :sid, :label, :default_value, :unit, :meta_property_type, :required,
|
26
|
+
to: :meta_type_property
|
27
|
+
end
|
@@ -0,0 +1,59 @@
|
|
1
|
+
class MetaTypes::MetaPropertyType
|
2
|
+
|
3
|
+
attr_accessor :sid
|
4
|
+
attr_accessor :name
|
5
|
+
|
6
|
+
def initialize(sid, name)
|
7
|
+
self.sid = sid
|
8
|
+
self.name = name
|
9
|
+
end
|
10
|
+
|
11
|
+
Instances = {
|
12
|
+
integer: new('integer', 'Integer'),
|
13
|
+
string: new('string', 'String'),
|
14
|
+
boolean: new('boolean', 'Boolean'),
|
15
|
+
float: new('float', 'Float'),
|
16
|
+
text: new('text', 'Text'),
|
17
|
+
date: new('date', 'Date')
|
18
|
+
}
|
19
|
+
|
20
|
+
BoolTrueReps = %w{1 t true}
|
21
|
+
|
22
|
+
# cast is called to transform the string-value from the db
|
23
|
+
# into the desired ruby type
|
24
|
+
def cast(sval)
|
25
|
+
case sid
|
26
|
+
when 'integer' then sval.to_i
|
27
|
+
when 'string', 'text' then sval
|
28
|
+
when 'boolean' then BoolTrueReps.member?(sval.to_s)
|
29
|
+
when 'float' then sval.to_f
|
30
|
+
when 'date' then sval && Date.parse(sval)
|
31
|
+
else raise "Don't know how to handle MetaPropertyType with sid '#{sid}'."
|
32
|
+
end
|
33
|
+
end
|
34
|
+
|
35
|
+
# parse is called to transform the given ruby type into the
|
36
|
+
# db string format
|
37
|
+
def parse(sval)
|
38
|
+
case sid
|
39
|
+
when 'integer' then sval.to_s
|
40
|
+
when 'string', 'text' then sval.to_s
|
41
|
+
when 'boolean' then BoolTrueReps.member?(sval.to_s).to_s
|
42
|
+
when 'float' then sval.to_s
|
43
|
+
when 'date' then sval.presence && (sval.is_a?(String) ? Date.parse(sval) : sval).strftime("%Y-%m-%d")
|
44
|
+
else raise "Don't know how to handle MetaPropertyType with sid '#{sid}'."
|
45
|
+
end
|
46
|
+
end
|
47
|
+
|
48
|
+
class << self
|
49
|
+
def find(sid)
|
50
|
+
Instances[sid.to_sym] || raise("No MetaPropertyType with sid '#{sid}' found.")
|
51
|
+
end
|
52
|
+
|
53
|
+
alias_method :[], :find
|
54
|
+
|
55
|
+
def sids() %w{integer string boolean float text date} end
|
56
|
+
end
|
57
|
+
|
58
|
+
end
|
59
|
+
|
@@ -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.
|