engine-rea 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- data/.watchr +55 -0
- data/Gemfile +29 -0
- data/Gemfile.lock +165 -0
- data/MIT-LICENSE +20 -0
- data/README.md +4 -0
- data/Rakefile +48 -0
- data/VERSION +1 -0
- data/app/assets/images/rea/.gitkeep +0 -0
- data/app/assets/javascripts/rea/application.js +15 -0
- data/app/assets/stylesheets/rea/application.css +13 -0
- data/app/controllers/rea/application_controller.rb +4 -0
- data/app/helpers/rea/application_helper.rb +4 -0
- data/app/models/rea/category.rb +8 -0
- data/app/models/rea/category_member.rb +7 -0
- data/app/models/rea/category_type.rb +7 -0
- data/app/models/rea/group.rb +11 -0
- data/app/models/rea/group_entity.rb +7 -0
- data/app/models/rea/identifier.rb +42 -0
- data/app/views/layouts/rea/application.html.erb +14 -0
- data/config/routes.rb +2 -0
- data/db/migrate/20120601074531_create_rea_category_types.rb +13 -0
- data/db/migrate/20120601074540_create_rea_categories.rb +12 -0
- data/db/migrate/20120605023205_create_rea_category_members.rb +12 -0
- data/db/migrate/20120605030658_create_rea_groups.rb +9 -0
- data/db/migrate/20120605030708_create_rea_group_entities.rb +9 -0
- data/db/migrate/20120605082028_create_rea_identifiers.rb +11 -0
- data/lib/generators/rea/install/USAGE +8 -0
- data/lib/generators/rea/install/install_generator.rb +20 -0
- data/lib/rea/dsl/behavioral.rb +40 -0
- data/lib/rea/dsl/structural.rb +70 -0
- data/lib/rea/dsl.rb +20 -0
- data/lib/rea/engine.rb +11 -0
- data/lib/rea.rb +7 -0
- data/lib/tasks/cucumber.rake +65 -0
- data/lib/tasks/rea_tasks.rake +4 -0
- data/lib/tasks/watchr.rake +4 -0
- data/rea.gemspec +169 -0
- data/script/cucumber +10 -0
- data/script/rails +8 -0
- data/spec/dummy/README.rdoc +261 -0
- data/spec/dummy/Rakefile +7 -0
- data/spec/dummy/app/assets/javascripts/application.js +15 -0
- data/spec/dummy/app/assets/stylesheets/application.css +13 -0
- data/spec/dummy/app/controllers/application_controller.rb +3 -0
- data/spec/dummy/app/helpers/application_helper.rb +2 -0
- data/spec/dummy/app/mailers/.gitkeep +0 -0
- data/spec/dummy/app/models/.gitkeep +0 -0
- data/spec/dummy/app/views/layouts/application.html.erb +14 -0
- data/spec/dummy/config/application.rb +61 -0
- data/spec/dummy/config/boot.rb +10 -0
- data/spec/dummy/config/database.yml +25 -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/wrap_parameters.rb +14 -0
- data/spec/dummy/config/locales/en.yml +5 -0
- data/spec/dummy/config/routes.rb +4 -0
- data/spec/dummy/config.ru +4 -0
- data/spec/dummy/db/development.sqlite3 +0 -0
- data/spec/dummy/db/schema.rb +71 -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/favicon.ico +0 -0
- data/spec/dummy/script/rails +6 -0
- data/spec/factories/rea_resources.rb +6 -0
- data/spec/generators/rea/install/install_generator_spec.rb +27 -0
- data/spec/models/rea/category_member_spec.rb +5 -0
- data/spec/models/rea/category_spec.rb +5 -0
- data/spec/models/rea/category_type_spec.rb +5 -0
- data/spec/models/rea/group_entity_spec.rb +5 -0
- data/spec/models/rea/group_spec.rb +5 -0
- data/spec/models/rea/identifier_spec.rb +48 -0
- data/spec/rea/dsl/behavioral_spec.rb +81 -0
- data/spec/rea/dsl/structural_spec.rb +141 -0
- data/spec/rea/dsl_spec.rb +11 -0
- data/spec/rea/engine_spec.rb +10 -0
- data/spec/spec_helper.rb +35 -0
- metadata +391 -0
@@ -0,0 +1,70 @@
|
|
1
|
+
module Rea
|
2
|
+
module Dsl
|
3
|
+
module Structural
|
4
|
+
def self.included base
|
5
|
+
base.extend ClassMethods
|
6
|
+
end
|
7
|
+
|
8
|
+
module ClassMethods
|
9
|
+
|
10
|
+
def def_entity options={}, &block
|
11
|
+
validates_presence_of :name
|
12
|
+
block.call if block_given?
|
13
|
+
end
|
14
|
+
|
15
|
+
|
16
|
+
def item name, options={}, &block
|
17
|
+
@context = self.find_or_create_by_name name, options
|
18
|
+
block.call if block_given?
|
19
|
+
end
|
20
|
+
|
21
|
+
def resource options={}, &block
|
22
|
+
def_entity options, &block
|
23
|
+
end
|
24
|
+
|
25
|
+
def event increase=true, options={}, &block
|
26
|
+
def_entity options, &block
|
27
|
+
cattr_accessor :increase
|
28
|
+
self.increase = increase
|
29
|
+
end
|
30
|
+
|
31
|
+
def increase_event options={}, &block
|
32
|
+
event true, options, &block
|
33
|
+
end
|
34
|
+
|
35
|
+
def decrease_event options={}, &block
|
36
|
+
event false, options, &block
|
37
|
+
end
|
38
|
+
|
39
|
+
def agent options={}, &block
|
40
|
+
def_entity options, &block
|
41
|
+
end
|
42
|
+
|
43
|
+
def grouping options={}, &block
|
44
|
+
has_many :group_entities, :as=>:entity
|
45
|
+
has_many :groups, :through=>:group_entities
|
46
|
+
#group_class.entity_classes << self
|
47
|
+
block.call if block_given?
|
48
|
+
end
|
49
|
+
|
50
|
+
def group_item *group_names, &block
|
51
|
+
options = group_names.extract_options!
|
52
|
+
group_names.flatten.each do |name|
|
53
|
+
@context = Rea::Group.groups(self).find_or_create_by_name(name, :entity_types=>self.name)
|
54
|
+
block.call if block_given?
|
55
|
+
end
|
56
|
+
end
|
57
|
+
|
58
|
+
def entity_type name, options={}, &block
|
59
|
+
has_many name, options
|
60
|
+
def_entity options, &block
|
61
|
+
end
|
62
|
+
|
63
|
+
def specification name, options={}
|
64
|
+
belongs_to name, options
|
65
|
+
end
|
66
|
+
|
67
|
+
end
|
68
|
+
end
|
69
|
+
end
|
70
|
+
end
|
data/lib/rea/dsl.rb
ADDED
@@ -0,0 +1,20 @@
|
|
1
|
+
module Rea
|
2
|
+
module Dsl
|
3
|
+
|
4
|
+
autoload :Structural, 'rea/dsl/structural'
|
5
|
+
autoload :Behavioral, 'rea/dsl/behavioral'
|
6
|
+
|
7
|
+
|
8
|
+
def self.included base
|
9
|
+
base.extend ClassMethods
|
10
|
+
base.class_eval do
|
11
|
+
include Structural
|
12
|
+
include Behavioral
|
13
|
+
end
|
14
|
+
end
|
15
|
+
|
16
|
+
module ClassMethods
|
17
|
+
end
|
18
|
+
end
|
19
|
+
end
|
20
|
+
|
data/lib/rea/engine.rb
ADDED
data/lib/rea.rb
ADDED
@@ -0,0 +1,65 @@
|
|
1
|
+
# IMPORTANT: This file is generated by cucumber-rails - edit at your own peril.
|
2
|
+
# It is recommended to regenerate this file in the future when you upgrade to a
|
3
|
+
# newer version of cucumber-rails. Consider adding your own code to a new file
|
4
|
+
# instead of editing this one. Cucumber will automatically load all features/**/*.rb
|
5
|
+
# files.
|
6
|
+
|
7
|
+
|
8
|
+
unless ARGV.any? {|a| a =~ /^gems/} # Don't load anything when running the gems:* tasks
|
9
|
+
|
10
|
+
vendored_cucumber_bin = Dir["#{Rails.root}/vendor/{gems,plugins}/cucumber*/bin/cucumber"].first
|
11
|
+
$LOAD_PATH.unshift(File.dirname(vendored_cucumber_bin) + '/../lib') unless vendored_cucumber_bin.nil?
|
12
|
+
|
13
|
+
begin
|
14
|
+
require 'cucumber/rake/task'
|
15
|
+
|
16
|
+
namespace :cucumber do
|
17
|
+
Cucumber::Rake::Task.new({:ok => 'db:test:prepare'}, 'Run features that should pass') do |t|
|
18
|
+
t.binary = vendored_cucumber_bin # If nil, the gem's binary is used.
|
19
|
+
t.fork = true # You may get faster startup if you set this to false
|
20
|
+
t.profile = 'default'
|
21
|
+
end
|
22
|
+
|
23
|
+
Cucumber::Rake::Task.new({:wip => 'db:test:prepare'}, 'Run features that are being worked on') do |t|
|
24
|
+
t.binary = vendored_cucumber_bin
|
25
|
+
t.fork = true # You may get faster startup if you set this to false
|
26
|
+
t.profile = 'wip'
|
27
|
+
end
|
28
|
+
|
29
|
+
Cucumber::Rake::Task.new({:rerun => 'db:test:prepare'}, 'Record failing features and run only them if any exist') do |t|
|
30
|
+
t.binary = vendored_cucumber_bin
|
31
|
+
t.fork = true # You may get faster startup if you set this to false
|
32
|
+
t.profile = 'rerun'
|
33
|
+
end
|
34
|
+
|
35
|
+
desc 'Run all features'
|
36
|
+
task :all => [:ok, :wip]
|
37
|
+
|
38
|
+
task :statsetup do
|
39
|
+
require 'rails/code_statistics'
|
40
|
+
::STATS_DIRECTORIES << %w(Cucumber\ features features) if File.exist?('features')
|
41
|
+
::CodeStatistics::TEST_TYPES << "Cucumber features" if File.exist?('features')
|
42
|
+
end
|
43
|
+
end
|
44
|
+
desc 'Alias for cucumber:ok'
|
45
|
+
task :cucumber => 'cucumber:ok'
|
46
|
+
|
47
|
+
task :default => :cucumber
|
48
|
+
|
49
|
+
task :features => :cucumber do
|
50
|
+
STDERR.puts "*** The 'features' task is deprecated. See rake -T cucumber ***"
|
51
|
+
end
|
52
|
+
|
53
|
+
# In case we don't have ActiveRecord, append a no-op task that we can depend upon.
|
54
|
+
task 'db:test:prepare' do
|
55
|
+
end
|
56
|
+
|
57
|
+
task :stats => 'cucumber:statsetup'
|
58
|
+
rescue LoadError
|
59
|
+
desc 'cucumber rake task not available (cucumber not installed)'
|
60
|
+
task :cucumber do
|
61
|
+
abort 'Cucumber rake task is not available. Be sure to install cucumber as a gem or plugin'
|
62
|
+
end
|
63
|
+
end
|
64
|
+
|
65
|
+
end
|
data/rea.gemspec
ADDED
@@ -0,0 +1,169 @@
|
|
1
|
+
# Generated by jeweler
|
2
|
+
# DO NOT EDIT THIS FILE DIRECTLY
|
3
|
+
# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
|
4
|
+
# -*- encoding: utf-8 -*-
|
5
|
+
|
6
|
+
Gem::Specification.new do |s|
|
7
|
+
s.name = "rea"
|
8
|
+
s.version = "0.1.0"
|
9
|
+
|
10
|
+
s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
|
11
|
+
s.authors = ["Ryan Wong"]
|
12
|
+
s.date = "2012-06-06"
|
13
|
+
s.description = "\n follow REA model\n\t"
|
14
|
+
s.email = "lazing@gmail.com"
|
15
|
+
s.extra_rdoc_files = [
|
16
|
+
"README.md"
|
17
|
+
]
|
18
|
+
s.files = [
|
19
|
+
".watchr",
|
20
|
+
"Gemfile",
|
21
|
+
"Gemfile.lock",
|
22
|
+
"MIT-LICENSE",
|
23
|
+
"README.md",
|
24
|
+
"Rakefile",
|
25
|
+
"VERSION",
|
26
|
+
"app/assets/images/rea/.gitkeep",
|
27
|
+
"app/assets/javascripts/rea/application.js",
|
28
|
+
"app/assets/stylesheets/rea/application.css",
|
29
|
+
"app/controllers/rea/application_controller.rb",
|
30
|
+
"app/helpers/rea/application_helper.rb",
|
31
|
+
"app/models/rea/category.rb",
|
32
|
+
"app/models/rea/category_member.rb",
|
33
|
+
"app/models/rea/category_type.rb",
|
34
|
+
"app/models/rea/group.rb",
|
35
|
+
"app/models/rea/group_entity.rb",
|
36
|
+
"app/models/rea/identifier.rb",
|
37
|
+
"app/views/layouts/rea/application.html.erb",
|
38
|
+
"config/routes.rb",
|
39
|
+
"db/migrate/20120601074531_create_rea_category_types.rb",
|
40
|
+
"db/migrate/20120601074540_create_rea_categories.rb",
|
41
|
+
"db/migrate/20120605023205_create_rea_category_members.rb",
|
42
|
+
"db/migrate/20120605030658_create_rea_groups.rb",
|
43
|
+
"db/migrate/20120605030708_create_rea_group_entities.rb",
|
44
|
+
"db/migrate/20120605082028_create_rea_identifiers.rb",
|
45
|
+
"lib/generators/rea/install/USAGE",
|
46
|
+
"lib/generators/rea/install/install_generator.rb",
|
47
|
+
"lib/rea.rb",
|
48
|
+
"lib/rea/dsl.rb",
|
49
|
+
"lib/rea/dsl/behavioral.rb",
|
50
|
+
"lib/rea/dsl/structural.rb",
|
51
|
+
"lib/rea/engine.rb",
|
52
|
+
"lib/tasks/cucumber.rake",
|
53
|
+
"lib/tasks/rea_tasks.rake",
|
54
|
+
"lib/tasks/watchr.rake",
|
55
|
+
"rea.gemspec",
|
56
|
+
"script/cucumber",
|
57
|
+
"script/rails",
|
58
|
+
"spec/dummy/README.rdoc",
|
59
|
+
"spec/dummy/Rakefile",
|
60
|
+
"spec/dummy/app/assets/javascripts/application.js",
|
61
|
+
"spec/dummy/app/assets/stylesheets/application.css",
|
62
|
+
"spec/dummy/app/controllers/application_controller.rb",
|
63
|
+
"spec/dummy/app/helpers/application_helper.rb",
|
64
|
+
"spec/dummy/app/mailers/.gitkeep",
|
65
|
+
"spec/dummy/app/models/.gitkeep",
|
66
|
+
"spec/dummy/app/views/layouts/application.html.erb",
|
67
|
+
"spec/dummy/config.ru",
|
68
|
+
"spec/dummy/config/application.rb",
|
69
|
+
"spec/dummy/config/boot.rb",
|
70
|
+
"spec/dummy/config/database.yml",
|
71
|
+
"spec/dummy/config/environment.rb",
|
72
|
+
"spec/dummy/config/environments/development.rb",
|
73
|
+
"spec/dummy/config/environments/production.rb",
|
74
|
+
"spec/dummy/config/environments/test.rb",
|
75
|
+
"spec/dummy/config/initializers/backtrace_silencers.rb",
|
76
|
+
"spec/dummy/config/initializers/inflections.rb",
|
77
|
+
"spec/dummy/config/initializers/mime_types.rb",
|
78
|
+
"spec/dummy/config/initializers/secret_token.rb",
|
79
|
+
"spec/dummy/config/initializers/session_store.rb",
|
80
|
+
"spec/dummy/config/initializers/wrap_parameters.rb",
|
81
|
+
"spec/dummy/config/locales/en.yml",
|
82
|
+
"spec/dummy/config/routes.rb",
|
83
|
+
"spec/dummy/db/development.sqlite3",
|
84
|
+
"spec/dummy/db/schema.rb",
|
85
|
+
"spec/dummy/lib/assets/.gitkeep",
|
86
|
+
"spec/dummy/log/.gitkeep",
|
87
|
+
"spec/dummy/public/404.html",
|
88
|
+
"spec/dummy/public/422.html",
|
89
|
+
"spec/dummy/public/500.html",
|
90
|
+
"spec/dummy/public/favicon.ico",
|
91
|
+
"spec/dummy/script/rails",
|
92
|
+
"spec/factories/rea_resources.rb",
|
93
|
+
"spec/generators/rea/install/install_generator_spec.rb",
|
94
|
+
"spec/models/rea/category_member_spec.rb",
|
95
|
+
"spec/models/rea/category_spec.rb",
|
96
|
+
"spec/models/rea/category_type_spec.rb",
|
97
|
+
"spec/models/rea/group_entity_spec.rb",
|
98
|
+
"spec/models/rea/group_spec.rb",
|
99
|
+
"spec/models/rea/identifier_spec.rb",
|
100
|
+
"spec/rea/dsl/behavioral_spec.rb",
|
101
|
+
"spec/rea/dsl/structural_spec.rb",
|
102
|
+
"spec/rea/dsl_spec.rb",
|
103
|
+
"spec/rea/engine_spec.rb",
|
104
|
+
"spec/spec_helper.rb"
|
105
|
+
]
|
106
|
+
s.homepage = "http://github.com/lazing/rea"
|
107
|
+
s.licenses = ["MIT"]
|
108
|
+
s.require_paths = ["lib"]
|
109
|
+
s.rubygems_version = "1.8.21"
|
110
|
+
s.summary = "Rails Engine for MDA pattern Resource Event Agent"
|
111
|
+
|
112
|
+
if s.respond_to? :specification_version then
|
113
|
+
s.specification_version = 3
|
114
|
+
|
115
|
+
if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
|
116
|
+
s.add_runtime_dependency(%q<rails>, [">= 3.2.0"])
|
117
|
+
s.add_runtime_dependency(%q<capybara>, [">= 0.4.0"])
|
118
|
+
s.add_development_dependency(%q<database_cleaner>, [">= 0"])
|
119
|
+
s.add_development_dependency(%q<sqlite3>, [">= 0"])
|
120
|
+
s.add_development_dependency(%q<factory_girl_rails>, [">= 0"])
|
121
|
+
s.add_development_dependency(%q<minitest>, [">= 0"])
|
122
|
+
s.add_development_dependency(%q<rspec-rails>, [">= 2.8.0"])
|
123
|
+
s.add_development_dependency(%q<sqlite3-ruby>, [">= 0"])
|
124
|
+
s.add_development_dependency(%q<with_model>, [">= 0.1.5"])
|
125
|
+
s.add_development_dependency(%q<generator_spec>, [">= 0"])
|
126
|
+
s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
|
127
|
+
s.add_development_dependency(%q<bundler>, [">= 1.0.0"])
|
128
|
+
s.add_development_dependency(%q<jeweler>, [">= 1.8.3"])
|
129
|
+
s.add_development_dependency(%q<simplecov>, [">= 0"])
|
130
|
+
s.add_development_dependency(%q<spork>, ["~> 1.0rc"])
|
131
|
+
s.add_development_dependency(%q<watchr>, [">= 0"])
|
132
|
+
else
|
133
|
+
s.add_dependency(%q<rails>, [">= 3.2.0"])
|
134
|
+
s.add_dependency(%q<capybara>, [">= 0.4.0"])
|
135
|
+
s.add_dependency(%q<database_cleaner>, [">= 0"])
|
136
|
+
s.add_dependency(%q<sqlite3>, [">= 0"])
|
137
|
+
s.add_dependency(%q<factory_girl_rails>, [">= 0"])
|
138
|
+
s.add_dependency(%q<minitest>, [">= 0"])
|
139
|
+
s.add_dependency(%q<rspec-rails>, [">= 2.8.0"])
|
140
|
+
s.add_dependency(%q<sqlite3-ruby>, [">= 0"])
|
141
|
+
s.add_dependency(%q<with_model>, [">= 0.1.5"])
|
142
|
+
s.add_dependency(%q<generator_spec>, [">= 0"])
|
143
|
+
s.add_dependency(%q<rdoc>, ["~> 3.12"])
|
144
|
+
s.add_dependency(%q<bundler>, [">= 1.0.0"])
|
145
|
+
s.add_dependency(%q<jeweler>, [">= 1.8.3"])
|
146
|
+
s.add_dependency(%q<simplecov>, [">= 0"])
|
147
|
+
s.add_dependency(%q<spork>, ["~> 1.0rc"])
|
148
|
+
s.add_dependency(%q<watchr>, [">= 0"])
|
149
|
+
end
|
150
|
+
else
|
151
|
+
s.add_dependency(%q<rails>, [">= 3.2.0"])
|
152
|
+
s.add_dependency(%q<capybara>, [">= 0.4.0"])
|
153
|
+
s.add_dependency(%q<database_cleaner>, [">= 0"])
|
154
|
+
s.add_dependency(%q<sqlite3>, [">= 0"])
|
155
|
+
s.add_dependency(%q<factory_girl_rails>, [">= 0"])
|
156
|
+
s.add_dependency(%q<minitest>, [">= 0"])
|
157
|
+
s.add_dependency(%q<rspec-rails>, [">= 2.8.0"])
|
158
|
+
s.add_dependency(%q<sqlite3-ruby>, [">= 0"])
|
159
|
+
s.add_dependency(%q<with_model>, [">= 0.1.5"])
|
160
|
+
s.add_dependency(%q<generator_spec>, [">= 0"])
|
161
|
+
s.add_dependency(%q<rdoc>, ["~> 3.12"])
|
162
|
+
s.add_dependency(%q<bundler>, [">= 1.0.0"])
|
163
|
+
s.add_dependency(%q<jeweler>, [">= 1.8.3"])
|
164
|
+
s.add_dependency(%q<simplecov>, [">= 0"])
|
165
|
+
s.add_dependency(%q<spork>, ["~> 1.0rc"])
|
166
|
+
s.add_dependency(%q<watchr>, [">= 0"])
|
167
|
+
end
|
168
|
+
end
|
169
|
+
|
data/script/cucumber
ADDED
@@ -0,0 +1,10 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
|
3
|
+
vendored_cucumber_bin = Dir["#{File.dirname(__FILE__)}/../vendor/{gems,plugins}/cucumber*/bin/cucumber"].first
|
4
|
+
if vendored_cucumber_bin
|
5
|
+
load File.expand_path(vendored_cucumber_bin)
|
6
|
+
else
|
7
|
+
require 'rubygems' unless ENV['NO_RUBYGEMS']
|
8
|
+
require 'cucumber'
|
9
|
+
load Cucumber::BINARY
|
10
|
+
end
|
data/script/rails
ADDED
@@ -0,0 +1,8 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
|
3
|
+
|
4
|
+
ENGINE_ROOT = File.expand_path('../..', __FILE__)
|
5
|
+
ENGINE_PATH = File.expand_path('../../lib/rea/engine', __FILE__)
|
6
|
+
|
7
|
+
require 'rails/all'
|
8
|
+
require 'rails/engine/commands'
|
@@ -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.
|
data/spec/dummy/Rakefile
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
#!/usr/bin/env rake
|
2
|
+
# Add your own tasks in files placed in lib/tasks ending in .rake,
|
3
|
+
# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
|
4
|
+
|
5
|
+
require File.expand_path('../config/application', __FILE__)
|
6
|
+
|
7
|
+
Dummy::Application.load_tasks
|
@@ -0,0 +1,15 @@
|
|
1
|
+
// This is a manifest file that'll be compiled into application.js, which will include all the files
|
2
|
+
// listed below.
|
3
|
+
//
|
4
|
+
// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
|
5
|
+
// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
|
6
|
+
//
|
7
|
+
// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
|
8
|
+
// the compiled file.
|
9
|
+
//
|
10
|
+
// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
|
11
|
+
// GO AFTER THE REQUIRES BELOW.
|
12
|
+
//
|
13
|
+
//= require jquery
|
14
|
+
//= require jquery_ujs
|
15
|
+
//= require_tree .
|
@@ -0,0 +1,13 @@
|
|
1
|
+
/*
|
2
|
+
* This is a manifest file that'll be compiled into application.css, which will include all the files
|
3
|
+
* listed below.
|
4
|
+
*
|
5
|
+
* Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
|
6
|
+
* or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
|
7
|
+
*
|
8
|
+
* You're free to add application-wide styles to this file and they'll appear at the top of the
|
9
|
+
* compiled file, but it's generally better to create a new file per style scope.
|
10
|
+
*
|
11
|
+
*= require_self
|
12
|
+
*= require_tree .
|
13
|
+
*/
|