gaq 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (70) hide show
  1. data/.gitignore +18 -0
  2. data/Gemfile +15 -0
  3. data/Guardfile +23 -0
  4. data/LICENSE.txt +22 -0
  5. data/README.md +102 -0
  6. data/Rakefile +1 -0
  7. data/gaq.gemspec +22 -0
  8. data/lib/gaq.rb +3 -0
  9. data/lib/gaq/class_cache.rb +32 -0
  10. data/lib/gaq/command_language.rb +145 -0
  11. data/lib/gaq/configuration.rb +159 -0
  12. data/lib/gaq/controller_facade.rb +15 -0
  13. data/lib/gaq/controller_handle.rb +93 -0
  14. data/lib/gaq/dsl_target.rb +51 -0
  15. data/lib/gaq/dsl_target_factory.rb +64 -0
  16. data/lib/gaq/flash_commands_adapter.rb +48 -0
  17. data/lib/gaq/interprets_config.rb +13 -0
  18. data/lib/gaq/railtie.rb +40 -0
  19. data/lib/gaq/snippet_renderer.rb +44 -0
  20. data/lib/gaq/version.rb +3 -0
  21. data/spec-dummy/.rspec +1 -0
  22. data/spec-dummy/README.rdoc +261 -0
  23. data/spec-dummy/Rakefile +7 -0
  24. data/spec-dummy/app/assets/images/rails.png +0 -0
  25. data/spec-dummy/app/assets/javascripts/application.js +13 -0
  26. data/spec-dummy/app/assets/stylesheets/application.css +13 -0
  27. data/spec-dummy/app/controllers/application_controller.rb +3 -0
  28. data/spec-dummy/app/controllers/integration_spec_controller.rb +22 -0
  29. data/spec-dummy/app/helpers/application_helper.rb +2 -0
  30. data/spec-dummy/app/views/integration_spec/view.erb +0 -0
  31. data/spec-dummy/app/views/layouts/application.html.erb +16 -0
  32. data/spec-dummy/config.ru +4 -0
  33. data/spec-dummy/config/application.rb +64 -0
  34. data/spec-dummy/config/boot.rb +6 -0
  35. data/spec-dummy/config/environment.rb +5 -0
  36. data/spec-dummy/config/environments/development.rb +26 -0
  37. data/spec-dummy/config/environments/production.rb +51 -0
  38. data/spec-dummy/config/environments/test_dynamic.rb +39 -0
  39. data/spec-dummy/config/environments/test_static.rb +38 -0
  40. data/spec-dummy/config/initializers/backtrace_silencers.rb +7 -0
  41. data/spec-dummy/config/initializers/inflections.rb +15 -0
  42. data/spec-dummy/config/initializers/mime_types.rb +5 -0
  43. data/spec-dummy/config/initializers/secret_token.rb +7 -0
  44. data/spec-dummy/config/initializers/session_store.rb +8 -0
  45. data/spec-dummy/config/initializers/wrap_parameters.rb +10 -0
  46. data/spec-dummy/config/locales/en.yml +5 -0
  47. data/spec-dummy/config/routes.rb +8 -0
  48. data/spec-dummy/db/seeds.rb +7 -0
  49. data/spec-dummy/public/404.html +26 -0
  50. data/spec-dummy/public/422.html +26 -0
  51. data/spec-dummy/public/500.html +25 -0
  52. data/spec-dummy/public/favicon.ico +0 -0
  53. data/spec-dummy/public/robots.txt +5 -0
  54. data/spec-dummy/script/rails +6 -0
  55. data/spec-dummy/spec/common_spec_methods.rb +88 -0
  56. data/spec-dummy/spec/features/dynamic_config_spec.rb +21 -0
  57. data/spec-dummy/spec/features/next_request_spec.rb +27 -0
  58. data/spec-dummy/spec/features/presence_spec.rb +64 -0
  59. data/spec-dummy/spec/spec_helper.rb +41 -0
  60. data/spec/lib/gaq/class_cache_spec.rb +62 -0
  61. data/spec/lib/gaq/command_language_spec.rb +267 -0
  62. data/spec/lib/gaq/configuration_spec.rb +233 -0
  63. data/spec/lib/gaq/controller_facade_spec.rb +29 -0
  64. data/spec/lib/gaq/controller_handle_spec.rb +510 -0
  65. data/spec/lib/gaq/dsl_target_factory_spec.rb +163 -0
  66. data/spec/lib/gaq/dsl_target_spec.rb +87 -0
  67. data/spec/lib/gaq/flash_commands_adapter_spec.rb +116 -0
  68. data/spec/lib/gaq/interprets_config_spec.rb +37 -0
  69. data/spec/lib/gaq/snippet_renderer_spec.rb +60 -0
  70. metadata +159 -0
@@ -0,0 +1,15 @@
1
+ module Gaq
2
+ class ControllerFacade
3
+ def initialize(controller)
4
+ @controller = controller
5
+ end
6
+
7
+ def flash
8
+ @controller.flash
9
+ end
10
+
11
+ def evaluate_config_lambda(lmbda)
12
+ lmbda.call(@controller)
13
+ end
14
+ end
15
+ end
@@ -0,0 +1,93 @@
1
+ # encoding: utf-8
2
+
3
+ require 'gaq/dsl_target_factory'
4
+ require 'gaq/flash_commands_adapter'
5
+ require 'gaq/interprets_config'
6
+
7
+ module Gaq
8
+ class ControllerHandle
9
+ include InterpretsConfig
10
+
11
+ attr_writer :flash_commands_adapter
12
+
13
+ def initialize(controller_facade, language, class_cache, config)
14
+ @controller_facade, @language, @class_cache, @config =
15
+ controller_facade, language, class_cache, config
16
+ end
17
+
18
+ def root_target
19
+ @root_target ||= target_factory.root_target
20
+ end
21
+
22
+ def immediate_commands
23
+ @immediate_commands ||= flash_commands_adapter.commands_from_flash
24
+ end
25
+
26
+ def finalized_commands_as_segments
27
+ commands = immediate_commands.dup
28
+ commands << @language.new_command(:anonymize_ip) if interpret_config(@config.anonymize_ip)
29
+
30
+ setup_tracker_names = [nil, *track_pageview_tracker_names, *seen_tracker_names].uniq
31
+ setup_tracker_names.each do |tracker_name|
32
+ tracker_config = @config.tracker_config(tracker_name)
33
+ commands += tracker_setup_commands(tracker_config) if tracker_config
34
+ end
35
+
36
+ @language.sort_commands(commands)
37
+ @language.commands_to_segments_for_to_json(commands)
38
+ end
39
+
40
+ private
41
+
42
+ def interpret_config(value)
43
+ super(value, @controller_facade)
44
+ end
45
+
46
+ def seen_tracker_names
47
+ immediate_commands.map(&:tracker_name).uniq
48
+ end
49
+
50
+ def track_pageview_tracker_names
51
+ @config.tracker_names.select do |tracker_name|
52
+ @config.tracker_config(tracker_name).track_pageview?
53
+ end
54
+ end
55
+
56
+ def tracker_setup_commands(tracker_config)
57
+ [set_account_command(tracker_config), track_pageview_command(tracker_config)].compact
58
+ end
59
+
60
+ def track_pageview_command(tracker_config)
61
+ return nil unless tracker_config.track_pageview?
62
+
63
+ command = @language.new_command(:track_pageview)
64
+ command.tracker_name = tracker_config.tracker_name
65
+ command
66
+ end
67
+
68
+ def set_account_command(tracker_config)
69
+ web_property_id = interpret_config(tracker_config.web_property_id)
70
+ command = @language.new_command(:set_account, web_property_id)
71
+ command.tracker_name = tracker_config.tracker_name
72
+ command
73
+ end
74
+
75
+ def target_factory
76
+ @target_factory ||= DslTargetFactory.new(
77
+ @class_cache, flash_commands_adapter, immediate_commands,
78
+ new_command_proc, variables, @config.tracker_names)
79
+ end
80
+
81
+ def flash_commands_adapter
82
+ @flash_commands_adapter ||= FlashCommandsAdapter.new(@language, @controller_facade)
83
+ end
84
+
85
+ def new_command_proc
86
+ @language.method(:new_command)
87
+ end
88
+
89
+ def variables
90
+ @config.variables.values
91
+ end
92
+ end
93
+ end
@@ -0,0 +1,51 @@
1
+ module Gaq
2
+ class DslTarget
3
+ def initialize(target_factory, factory_token, new_command_proc, commands, tracker_name)
4
+ @target_factory, @factory_token, @new_command_proc, @commands, @tracker_name =
5
+ target_factory, factory_token, new_command_proc, commands, tracker_name
6
+ end
7
+
8
+ def tracker(tracker_name)
9
+ @target_factory.target_with_tracker_name(tracker_name, @factory_token)
10
+ end
11
+
12
+ alias_method :[], :tracker
13
+
14
+ def next_request
15
+ @target_factory.target_for_next_request(@factory_token)
16
+ end
17
+
18
+ ## tracker methods
19
+
20
+ def track_event(category, action, label = nil, value = nil, noninteraction = nil)
21
+ array = [noninteraction, value, label, action, category]
22
+ 4.times do
23
+ if array.first.nil?
24
+ array.shift
25
+ else
26
+ break
27
+ end
28
+ end
29
+
30
+ command = @new_command_proc.call(:track_event, *array.reverse)
31
+ command.tracker_name = @tracker_name
32
+ @commands << command
33
+ end
34
+
35
+ class << self
36
+ def variable_commands_module(variables)
37
+ Module.new do
38
+ variables.each do |variable|
39
+ module_eval <<-RUBY_EVAL, __FILE__, __LINE__ + 1
40
+ def #{variable.name}=(value)
41
+ command = @new_command_proc.call(:set_custom_var, #{variable.slot}, #{variable.name.inspect}, value, #{variable.scope})
42
+ command.tracker_name = @tracker_name
43
+ @commands << command
44
+ end
45
+ RUBY_EVAL
46
+ end
47
+ end
48
+ end
49
+ end
50
+ end
51
+ end
@@ -0,0 +1,64 @@
1
+ require 'gaq/dsl_target'
2
+ require 'gaq/command_language'
3
+
4
+ module Gaq
5
+ class DslTargetFactory
6
+ attr_writer :target_base_class #for injecting
7
+
8
+ def initialize(class_cache, flash_commands_adapter, immediate_commands, new_command_proc, variables, tracker_names)
9
+ @class_cache = class_cache
10
+ @flash_commands_adapter = flash_commands_adapter
11
+ @immediate_commands = immediate_commands
12
+ @new_command_proc = new_command_proc
13
+ @variables = variables
14
+ @tracker_names = tracker_names
15
+ end
16
+
17
+ def root_target
18
+ target_for_token(Token.new)
19
+ end
20
+
21
+ def target_with_tracker_name(tracker_name, token)
22
+ tracker_name = tracker_name.to_s unless tracker_name.nil?
23
+ raise "No tracker by name #{tracker_name.inspect}" unless @tracker_names.include?(tracker_name)
24
+
25
+ token = token.dup
26
+ token.tracker_name = tracker_name
27
+ target_for_token(token)
28
+ end
29
+
30
+ def target_for_next_request(token)
31
+ token = token.dup
32
+ token.next_request = true
33
+ target_for_token(token)
34
+ end
35
+
36
+ private
37
+
38
+ Token = Struct.new(:tracker_name, :next_request) do
39
+ alias_method :next_request?, :next_request
40
+ end
41
+
42
+ def target_for_token(token)
43
+ commands = token.next_request? ? @flash_commands_adapter : @immediate_commands
44
+ target_class.new(self, token, @new_command_proc, commands, token.tracker_name)
45
+ end
46
+
47
+ def target_base_class
48
+ @target_base_class || DslTarget
49
+ end
50
+
51
+ def target_class
52
+ ensure_class_cache_set_up
53
+ @class_cache[:target_class]
54
+ end
55
+
56
+ def ensure_class_cache_set_up
57
+ @class_cache_set_up ||= true.tap do
58
+ @class_cache.building(:target_class, target_base_class) do |cls|
59
+ cls.send :include, target_base_class.variable_commands_module(@variables)
60
+ end
61
+ end
62
+ end
63
+ end
64
+ end
@@ -0,0 +1,48 @@
1
+ module Gaq
2
+ class FlashCommandsAdapter
3
+ def initialize(language, controller_facade)
4
+ @language, @controller_facade = language, controller_facade
5
+ @commands = []
6
+ end
7
+
8
+ def <<(command)
9
+ @commands << command
10
+ set_flash
11
+ end
12
+
13
+ FLASH_KEY = :gaqgem
14
+
15
+ # bump this every time picking up old data from a flash
16
+ # (which is part of the session cookie)
17
+ # might break things
18
+ FLASH_FORMAT_VERSION = 1
19
+
20
+ def commands_from_flash
21
+ flash_data = @controller_facade.flash[FLASH_KEY]
22
+ flash_data = [FLASH_FORMAT_VERSION] unless flash_data_current?(flash_data)
23
+
24
+ flash_items = flash_data.drop(1)
25
+ @language.commands_from_flash_items(flash_items)
26
+ end
27
+
28
+ private
29
+
30
+ def set_flash
31
+ @controller_facade.flash[FLASH_KEY] = [
32
+ FLASH_FORMAT_VERSION,
33
+ *@language.commands_to_flash_items(@commands)
34
+ ]
35
+ end
36
+
37
+ def flash_data_current?(flash_data)
38
+ # flash_data may be nil (nothing in flash yet) or an array.
39
+ return false unless flash_data
40
+
41
+ # flash data is legacy unless first array item is a Fixnum
42
+ return false unless flash_data.first.is_a?(Fixnum)
43
+
44
+ # Mismatching versions are not current.
45
+ flash_data.first == FLASH_FORMAT_VERSION
46
+ end
47
+ end
48
+ end
@@ -0,0 +1,13 @@
1
+ module Gaq
2
+ module InterpretsConfig
3
+ private
4
+
5
+ def interpret_config(value, controller_facade)
6
+ if value.respond_to?(:call)
7
+ controller_facade.evaluate_config_lambda(value)
8
+ else
9
+ value
10
+ end
11
+ end
12
+ end
13
+ end
@@ -0,0 +1,40 @@
1
+ require 'gaq/configuration'
2
+ require 'gaq/command_language'
3
+ require 'gaq/class_cache'
4
+ require 'gaq/controller_facade'
5
+ require 'gaq/controller_handle'
6
+ require 'gaq/snippet_renderer'
7
+
8
+ module Gaq
9
+ module Helper
10
+ def render_gaq
11
+ renderer = SnippetRenderer.new(self, Configuration.singleton, Rails.env)
12
+ renderer.render(_gaq_handle.finalized_commands_as_segments)
13
+ end
14
+ end
15
+
16
+ module ControllerMethods
17
+ def _gaq_handle
18
+ @_gaq ||= ControllerHandle.new(
19
+ ControllerFacade.new(self),
20
+ CommandLanguage.singleton,
21
+ ClassCache.singleton,
22
+ Configuration.singleton
23
+ )
24
+ end
25
+
26
+ def gaq
27
+ _gaq_handle.root_target
28
+ end
29
+ end
30
+
31
+ class Railtie < Rails::Railtie
32
+ config.gaq = Configuration.singleton.rails_config
33
+
34
+ initializer "gaq.include_helper" do |app|
35
+ ActionController::Base.send :include, ControllerMethods
36
+ ActionController::Base.helper Helper
37
+ ActionController::Base.helper_method :_gaq_handle
38
+ end
39
+ end
40
+ end
@@ -0,0 +1,44 @@
1
+ require 'json'
2
+
3
+ module Gaq
4
+ class SnippetRenderer
5
+
6
+ SNIPPET = <<EOJ
7
+ (function() {
8
+ var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
9
+ ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
10
+ (document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(ga);
11
+ })();
12
+ EOJ
13
+
14
+ def initialize(rendering_context, config, rails_env)
15
+ @context = rendering_context
16
+ @config = config
17
+ @rails_env = rails_env
18
+ end
19
+
20
+ def render(commands_as_segments)
21
+ js_content_lines = [
22
+ 'var _gaq = _gaq || [];',
23
+ "_gaq.push(#{escape_instructions(commands_as_segments).join(",\n ")});"
24
+ ]
25
+
26
+ js_content = js_content_lines.join("\n")
27
+ js_content << "\n\n" << SNIPPET if render_ga_js?
28
+
29
+ return @context.javascript_tag js_content
30
+ end
31
+
32
+ private
33
+
34
+ def escape_instructions(commands_as_segments)
35
+ commands_as_segments.map do |command_as_segments|
36
+ command_as_segments.to_json
37
+ end
38
+ end
39
+
40
+ def render_ga_js?
41
+ @config.render_ga_js?(@rails_env)
42
+ end
43
+ end
44
+ end
@@ -0,0 +1,3 @@
1
+ module Gaq
2
+ VERSION = "0.2.0"
3
+ end
@@ -0,0 +1 @@
1
+ --color
@@ -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.