attributarchy 0.0.1

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 (58) hide show
  1. data/MIT-LICENSE +20 -0
  2. data/README.md +80 -0
  3. data/Rakefile +28 -0
  4. data/lib/attributarchy.rb +10 -0
  5. data/lib/attributarchy/controller_methods.rb +58 -0
  6. data/lib/attributarchy/helpers.rb +28 -0
  7. data/lib/attributarchy/version.rb +3 -0
  8. data/lib/tasks/attributarchy_tasks.rake +4 -0
  9. data/spec/controller_methods_spec.rb +78 -0
  10. data/spec/dummy/README.rdoc +261 -0
  11. data/spec/dummy/Rakefile +7 -0
  12. data/spec/dummy/app/assets/javascripts/application.js +13 -0
  13. data/spec/dummy/app/assets/stylesheets/application.css +22 -0
  14. data/spec/dummy/app/controllers/application_controller.rb +3 -0
  15. data/spec/dummy/app/controllers/examples_controller.rb +15 -0
  16. data/spec/dummy/app/helpers/application_helper.rb +2 -0
  17. data/spec/dummy/app/views/examples/_continent.html.erb +1 -0
  18. data/spec/dummy/app/views/examples/_country.html.erb +1 -0
  19. data/spec/dummy/app/views/examples/index.html.erb +1 -0
  20. data/spec/dummy/app/views/layouts/application.html.erb +14 -0
  21. data/spec/dummy/config.ru +4 -0
  22. data/spec/dummy/config/application.rb +65 -0
  23. data/spec/dummy/config/boot.rb +10 -0
  24. data/spec/dummy/config/environment.rb +5 -0
  25. data/spec/dummy/config/environments/development.rb +31 -0
  26. data/spec/dummy/config/environments/production.rb +64 -0
  27. data/spec/dummy/config/environments/test.rb +35 -0
  28. data/spec/dummy/config/initializers/backtrace_silencers.rb +7 -0
  29. data/spec/dummy/config/initializers/inflections.rb +15 -0
  30. data/spec/dummy/config/initializers/mime_types.rb +5 -0
  31. data/spec/dummy/config/initializers/secret_token.rb +7 -0
  32. data/spec/dummy/config/initializers/session_store.rb +8 -0
  33. data/spec/dummy/config/initializers/wrap_parameters.rb +10 -0
  34. data/spec/dummy/config/locales/en.yml +5 -0
  35. data/spec/dummy/config/routes.rb +4 -0
  36. data/spec/dummy/log/development.log +28885 -0
  37. data/spec/dummy/log/test.log +23070 -0
  38. data/spec/dummy/public/404.html +26 -0
  39. data/spec/dummy/public/422.html +26 -0
  40. data/spec/dummy/public/500.html +25 -0
  41. data/spec/dummy/public/favicon.ico +0 -0
  42. data/spec/dummy/script/rails +6 -0
  43. data/spec/dummy/tmp/cache/assets/CD8/370/sprockets%2F357970feca3ac29060c1e3861e2c0953 +0 -0
  44. data/spec/dummy/tmp/cache/assets/D32/A10/sprockets%2F13fe41fee1fe35b49d145bcc06610705 +0 -0
  45. data/spec/dummy/tmp/cache/assets/D4E/1B0/sprockets%2Ff7cbd26ba1d28d48de824f0e94586655 +0 -0
  46. data/spec/dummy/tmp/cache/assets/D5A/EA0/sprockets%2Fd771ace226fc8215a3572e0aa35bb0d6 +0 -0
  47. data/spec/dummy/tmp/cache/assets/DDC/400/sprockets%2Fcffd775d018f68ce5dba1ee0d951a994 +0 -0
  48. data/spec/dummy/tmp/cache/assets/E04/890/sprockets%2F2f5173deea6c795b8fdde723bb4b63af +0 -0
  49. data/spec/fixtures/expectations/one_attributarchy.html +22 -0
  50. data/spec/fixtures/expectations/two_attributarchies.html +70 -0
  51. data/spec/fixtures/expectations/two_attributarchies_without_rendering_country.html +52 -0
  52. data/spec/fixtures/partials/_country.html.erb +15 -0
  53. data/spec/fixtures/partials/_state.html.erb +15 -0
  54. data/spec/helpers_spec.rb +219 -0
  55. data/spec/spec_helper.rb +51 -0
  56. data/spec/support/helpers.rb +27 -0
  57. data/spec/support/shared_examples_group_spec.rb +9 -0
  58. metadata +156 -0
@@ -0,0 +1,20 @@
1
+ Copyright 2013 YOURNAME
2
+
3
+ Permission is hereby granted, free of charge, to any person obtaining
4
+ a copy of this software and associated documentation files (the
5
+ "Software"), to deal in the Software without restriction, including
6
+ without limitation the rights to use, copy, modify, merge, publish,
7
+ distribute, sublicense, and/or sell copies of the Software, and to
8
+ permit persons to whom the Software is furnished to do so, subject to
9
+ the following conditions:
10
+
11
+ The above copyright notice and this permission notice shall be
12
+ included in all copies or substantial portions of the Software.
13
+
14
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
17
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
18
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
19
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
20
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
@@ -0,0 +1,80 @@
1
+ [![Version](http://allthebadges.io/epicyclist/attributarchy/badge_fury.png)](http://allthebadges.io/epicyclist/attributarchy/badge_fury)
2
+ [![Dependency Status](https://gemnasium.com/epicyclist/attributarchy.png)](https://gemnasium.com/epicyclist/attributarchy)
3
+ [![Build Status](https://travis-ci.org/epicyclist/attributarchy.png?branch=master)](https://travis-ci.org/epicyclist/attributarchy)
4
+ [![Coverage Status](https://coveralls.io/repos/epicyclist/attributarchy/badge.png)](https://coveralls.io/r/epicyclist/attributarchy)
5
+ [![Code Climate](http://allthebadges.io/epicyclist/attributarchy/code_climate.png)](http://allthebadges.io/epicyclist/attributarchy/code_climate)
6
+
7
+
8
+ # Attributarchy
9
+
10
+ An attribute-driven hierarchy builder for Rails views.
11
+
12
+ ## The Idea
13
+
14
+ **You do this:**
15
+
16
+ 1. Configure a hierarchy (or hierarchies) of attributes
17
+ 1. Create partials for each attribute
18
+ 1. Feed this duo some data
19
+
20
+ **And you get this:**
21
+
22
+ Dynamic, hierarchical views that allow you to easily dish out an array of layouts, styles, and behavior. All as simple or complex as you'd like.
23
+
24
+ ## Usage
25
+
26
+ ##### In your Gemfile:
27
+
28
+ ```ruby
29
+ gem 'attributarchy'
30
+ ```
31
+
32
+ ##### In your controller:
33
+
34
+ ```ruby
35
+ include Attributarchy
36
+
37
+ has_attributarchy \
38
+ #----------#
39
+ # Required #
40
+ #----------#
41
+ # Name it, as you can define multiple
42
+ :name,
43
+ # Specify an array of attributes that constitute the (?:attribut|hier)archy
44
+ as: [:attribute, ...],
45
+ #----------#
46
+ # Optional #
47
+ #----------#
48
+ # Specify an additional lookup path (as a string) or paths (as an array)
49
+ in: %w[this_path that_path],
50
+ # Specify an attribute (as a symbol) or attributes (as an array) that will
51
+ # only be used for grouping -- not rendering
52
+ without_rendering: [:a_no_show]
53
+ ```
54
+
55
+ ##### In your controller's corresponding view directory (or another location configured via :in):
56
+
57
+ Define a partial for all rendering attributes. The locals provided to these are:
58
+
59
+ 1. *group_data* -- The data set of the grouped-by attribute
60
+ 1. *group_value* -- The name of the grouped-by attribute
61
+ 1. *group_level* -- An integer representing the position of the grouping within the hierarchy
62
+
63
+ ##### And, finally, in your view:
64
+
65
+ ```ruby
66
+ build_attributarchy(:name, data_set)
67
+ ```
68
+
69
+ ## Working With Engines
70
+
71
+ My knowledge is limited here, but to get this working in an engine you must specify a full lookup path, e.g.:
72
+ ````ruby
73
+ in: "#{YourEngine::Engine.root}/app/views/your_engine/..."
74
+ ````
75
+
76
+ I believe this is the only way to do this short of converting the gem to a rail tie, but I'm not positive. Besides, I don't want Attributarchy included in *every* controller anyway — it seems quite specialized.
77
+
78
+ ## Examples
79
+
80
+ To see a simple example, start the dummy rails app and hit its root.
@@ -0,0 +1,28 @@
1
+ #!/usr/bin/env rake
2
+ begin
3
+ require 'bundler/setup'
4
+ rescue LoadError
5
+ puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
6
+ end
7
+ begin
8
+ require 'rdoc/task'
9
+ rescue LoadError
10
+ require 'rdoc/rdoc'
11
+ require 'rake/rdoctask'
12
+ RDoc::Task = Rake::RDocTask
13
+ end
14
+
15
+ RDoc::Task.new(:rdoc) do |rdoc|
16
+ rdoc.rdoc_dir = 'rdoc'
17
+ rdoc.title = 'Attributarchy'
18
+ rdoc.options << '--line-numbers'
19
+ rdoc.rdoc_files.include('README.rdoc')
20
+ rdoc.rdoc_files.include('lib/**/*.rb')
21
+ end
22
+
23
+ require 'rspec/core/rake_task'
24
+ RSpec::Core::RakeTask.new(:spec)
25
+ task default: :spec
26
+
27
+ Bundler::GemHelper.install_tasks
28
+
@@ -0,0 +1,10 @@
1
+ require 'attributarchy/controller_methods'
2
+ require 'attributarchy/helpers'
3
+
4
+ module Attributarchy
5
+ extend ActiveSupport::Concern
6
+ included do
7
+ include Attributarchy::ControllerMethods
8
+ include Attributarchy::Helpers
9
+ end
10
+ end
@@ -0,0 +1,58 @@
1
+ module Attributarchy
2
+ module ControllerMethods
3
+ extend ActiveSupport::Concern
4
+
5
+ included do
6
+ class_attribute :attributarchy_configuration
7
+ helper_method :build_attributarchy
8
+ helper_method :attributarchy_configuration
9
+ end
10
+
11
+ def attributarchy_configuration
12
+ self.attributarchy_configuration
13
+ end
14
+
15
+ module ClassMethods
16
+ def has_attributarchy(name, arguments = {})
17
+ ### Check attribute configuration.
18
+ raise ArgumentErorr, 'No attributarchy specified' \
19
+ unless arguments.is_a?(Hash) && arguments.has_key?(:as)
20
+ attributes = arguments[:as]
21
+ raise ArgumentError, 'Expecting attributarchy (an array of symbols representing attributes)' \
22
+ unless attributes.is_a? Array
23
+ raise ArgumentError, 'Attributarchy cannot be empty' \
24
+ if attributes.empty?
25
+ raise ArgumentError, 'Attributarchy should be specified using symbols' \
26
+ unless attributes.all? { |a| a.is_a? Symbol }
27
+ ### Lookup prefixes (optional). Always include controller.
28
+ lookup_prefixes = [controller_name]
29
+ if arguments.has_key?(:in)
30
+ additional_lookup_prefixes = arguments[:in]
31
+ raise ArgumentError, 'Lookup prefixes must be specified as a string or array' \
32
+ unless [Array, String].any? { |type| additional_lookup_prefixes.is_a?(type) }
33
+ lookup_prefixes << additional_lookup_prefixes
34
+ end
35
+ lookup_prefixes.flatten!
36
+ lookup_prefixes.map! { |prefix|
37
+ prefix = "app/views/#{prefix}" unless prefix[0] == '/'
38
+ prefix
39
+ }
40
+ prepend_view_path(lookup_prefixes)
41
+ ### Group-only attributes that do not render (optional).
42
+ without_rendering = {}
43
+ if arguments.has_key?(:without_rendering)
44
+ without_rendering = arguments[:without_rendering]
45
+ raise ArgumentError, ':without_rendering must be specified as a symbol or array' \
46
+ unless [Array, Symbol].any? { |type| without_rendering.is_a?(type) }
47
+ without_rendering = Hash[*[without_rendering].flatten.map { |k| [k, nil] }.flatten]
48
+ end
49
+ ### Set configuration
50
+ self.attributarchy_configuration ||= {}
51
+ self.attributarchy_configuration[name] = attributes
52
+ self.attributarchy_configuration[:without_rendering] = without_rendering
53
+ end
54
+ end
55
+
56
+ end
57
+
58
+ end
@@ -0,0 +1,28 @@
1
+ module Attributarchy
2
+ module Helpers
3
+ def build_attributarchy(name, data, level_index = 0)
4
+ output ||= ''
5
+ output = %{<div class="attributarchy">} if level_index == 0 # Outermost wrapper
6
+ current_level = attributarchy_configuration[name][level_index]
7
+ data.group_by(&current_level).each_with_index do |(group_value, group_data), index|
8
+ output << %{<div class="#{current_level}-attributarchy">}
9
+ unless attributarchy_configuration[:without_rendering].has_key?(current_level)
10
+ output << (
11
+ # TODO: / desired?
12
+ render_to_string partial: "/#{current_level}", locals: {
13
+ group_data: group_data,
14
+ group_value: group_value,
15
+ group_level: level_index
16
+ }
17
+ )
18
+ end
19
+ if level_index < attributarchy_configuration[name].count - 1
20
+ output << build_attributarchy(name, group_data, level_index + 1)
21
+ end
22
+ output << '</div>'
23
+ end
24
+ output << '</div>' if level_index == 0 # End outermost wrapper
25
+ output.html_safe
26
+ end
27
+ end
28
+ end
@@ -0,0 +1,3 @@
1
+ module Attributarchy
2
+ VERSION = "0.0.1"
3
+ end
@@ -0,0 +1,4 @@
1
+ # desc "Explaining what the task does"
2
+ # task :attributarchy do
3
+ # # Task goes here
4
+ # end
@@ -0,0 +1,78 @@
1
+ require 'spec_helper'
2
+
3
+ module Attributarchy
4
+ describe ControllerMethods do
5
+
6
+ subject { ControllerWithAttributarchy }
7
+ let(:attributarchy_name) { :a_symbol }
8
+ let(:valid_attributarchy) {[
9
+ :a_symbol_representing_an_attribute,
10
+ :a_symbol_representing_another_attribute,
11
+ :a_symbol_representing_yet_another_attribute,
12
+ ]}
13
+
14
+ it 'defines the build_attributarchy helper' do
15
+ expect(subject.new.view_context).to respond_to(:build_attributarchy)
16
+ end
17
+
18
+ it 'defines the attributarchy_configuration helper' do
19
+ expect(subject.new.view_context).to respond_to(:attributarchy_configuration)
20
+ end
21
+
22
+ describe '#has_attributarchy' do
23
+
24
+ context 'when the arguments are invalid' do
25
+ it 'raises ArgumentError exceptions' do
26
+ expect { subject.has_attributarchy }.to raise_error ArgumentError
27
+ expect { subject.has_attributarchy :attributarchy_name, as: [] }.to raise_error ArgumentError
28
+ expect { subject.has_attributarchy :attributarchy_name, as: ['attribute'] }.to raise_error ArgumentError
29
+ expect { subject.has_attributarchy :attributarchy_name, as: [:attribute, 'attribute'] }.to raise_error ArgumentError
30
+ end
31
+ end
32
+
33
+ context 'when the arguments are valid' do
34
+ let(:attributarchy_view_path) { File.join(rails_view_path, subject.controller_name) }
35
+ let(:view_paths) { subject.view_paths.to_a.map { |path| path.to_s } }
36
+
37
+ it 'sets the attributarchy' do
38
+ subject.has_attributarchy attributarchy_name, as: valid_attributarchy
39
+ expect(subject.attributarchy_configuration[attributarchy_name]).to eq(valid_attributarchy)
40
+ expect(subject.new.view_context.attributarchy_configuration[attributarchy_name]).to eq(valid_attributarchy)
41
+ end
42
+
43
+ it "adds the default lookup path (the controller's views) to the view path" do
44
+ subject.has_attributarchy attributarchy_name, as: valid_attributarchy
45
+ expect(view_paths).to include(attributarchy_view_path)
46
+ end
47
+
48
+ context 'when a non-rendering attribute is specified as a symbol' do
49
+ it 'defines the attribute as non-rendering' do
50
+ subject.has_attributarchy attributarchy_name,
51
+ as: [:do_not_render], without_rendering: :do_not_render
52
+ expect(subject.attributarchy_configuration[:without_rendering]).to include(:do_not_render)
53
+ end
54
+ end
55
+
56
+ context 'when non-rendering attributes are specified as an array' do
57
+ it 'defines the attributes as non-rendering' do
58
+ subject.has_attributarchy attributarchy_name,
59
+ as: [:do_not_render, :do_not_render_either], without_rendering: [:do_not_render, :do_not_render_either]
60
+ expect(subject.attributarchy_configuration[:without_rendering]).to include(:do_not_render)
61
+ expect(subject.attributarchy_configuration[:without_rendering]).to include(:do_not_render_either)
62
+ end
63
+ end
64
+
65
+ context 'when a lookup path is specified' do
66
+ it 'accepts a string' do
67
+ subject.has_attributarchy attributarchy_name, as: valid_attributarchy, in: 'path'
68
+ expect(view_paths).to include(File.join(rails_view_path, 'path'))
69
+ end
70
+ it 'accepts an array' do
71
+ subject.has_attributarchy attributarchy_name, as: valid_attributarchy, in: ['path']
72
+ expect(view_paths).to include(File.join(rails_view_path, 'path'))
73
+ end
74
+ end
75
+ end
76
+ end
77
+ end
78
+ 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.