active_admin-sortable_tree 0.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +11 -0
- data/.travis.yml +8 -0
- data/Gemfile +10 -0
- data/MIT-LICENSE +20 -0
- data/README.md +163 -0
- data/Rakefile +57 -0
- data/active_admin-sortable_tree.gemspec +30 -0
- data/app/assets/javascripts/active_admin/sortable.js.coffee +91 -0
- data/app/assets/stylesheets/active_admin/sortable.css.sass +79 -0
- data/bin/rails +11 -0
- data/gemfiles/3.2.gemfile +7 -0
- data/gemfiles/4.0.gemfile +10 -0
- data/lib/active_admin/sortable_tree.rb +4 -0
- data/lib/active_admin/sortable_tree/controller_actions.rb +52 -0
- data/lib/active_admin/sortable_tree/engine.rb +19 -0
- data/lib/active_admin/sortable_tree/version.rb +5 -0
- data/lib/active_admin/views/index_as_block_decorator.rb +30 -0
- data/lib/active_admin/views/index_as_sortable.rb +154 -0
- data/lib/activeadmin-sortable-tree.rb +1 -0
- data/script/rails +11 -0
- data/spec/dummy/README.rdoc +261 -0
- data/spec/dummy/Rakefile +7 -0
- data/spec/dummy/app/admin/category.rb +15 -0
- data/spec/dummy/app/admin/category_tree.rb +9 -0
- data/spec/dummy/app/admin/dashboard.rb +5 -0
- data/spec/dummy/app/assets/javascripts/active_admin.js +2 -0
- data/spec/dummy/app/assets/javascripts/application.js +15 -0
- data/spec/dummy/app/assets/javascripts/jquery.simulate.js +314 -0
- data/spec/dummy/app/assets/stylesheets/active_admin.css.scss +17 -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/models/admin_user.rb +6 -0
- data/spec/dummy/app/models/category.rb +4 -0
- data/spec/dummy/app/views/layouts/application.html.erb +14 -0
- data/spec/dummy/config.ru +4 -0
- data/spec/dummy/config/application.rb +56 -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 +28 -0
- data/spec/dummy/config/environments/production.rb +64 -0
- data/spec/dummy/config/environments/test.rb +32 -0
- data/spec/dummy/config/initializers/active_admin.rb +231 -0
- data/spec/dummy/config/initializers/backtrace_silencers.rb +7 -0
- data/spec/dummy/config/initializers/devise.rb +256 -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 +8 -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/devise.en.yml +59 -0
- data/spec/dummy/config/locales/en.yml +5 -0
- data/spec/dummy/config/routes.rb +61 -0
- data/spec/dummy/db/migrate/20140806024135_devise_create_admin_users.rb +48 -0
- data/spec/dummy/db/migrate/20140806024139_create_active_admin_comments.rb +19 -0
- data/spec/dummy/db/migrate/20140806032156_create_categories.rb +12 -0
- data/spec/dummy/db/schema.rb +58 -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/features/sortable_spec.rb +58 -0
- data/spec/rails_helper.rb +65 -0
- data/spec/spec_helper.rb +58 -0
- data/spec/support/wait_for_ajax.rb +19 -0
- data/vendor/assets/javascripts/jquery.mjs.nestedSortable.js +613 -0
- metadata +231 -0
data/bin/rails
ADDED
@@ -0,0 +1,11 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
|
3
|
+
ENGINE_ROOT = File.expand_path('../..', __FILE__)
|
4
|
+
ENGINE_PATH = File.expand_path('../../lib/active_admin/sortable_tree/engine', __FILE__)
|
5
|
+
|
6
|
+
# Set up gems listed in the Gemfile.
|
7
|
+
ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
|
8
|
+
require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
|
9
|
+
|
10
|
+
require 'rails/all'
|
11
|
+
require 'rails/engine/commands'
|
@@ -0,0 +1,52 @@
|
|
1
|
+
module ActiveAdmin::SortableTree
|
2
|
+
module ControllerActions
|
3
|
+
|
4
|
+
attr_accessor :sortable_options
|
5
|
+
|
6
|
+
def sortable(options = {})
|
7
|
+
options.reverse_merge! :sorting_attribute => :position,
|
8
|
+
:parent_method => :parent,
|
9
|
+
:children_method => :children,
|
10
|
+
:roots_method => :roots,
|
11
|
+
:tree => false,
|
12
|
+
:max_levels => 0,
|
13
|
+
:protect_root => false,
|
14
|
+
:collapsible => false, #hides +/- buttons
|
15
|
+
:start_collapsed => false
|
16
|
+
|
17
|
+
# BAD BAD BAD FIXME: don't pollute original class
|
18
|
+
@sortable_options = options
|
19
|
+
|
20
|
+
# disable pagination
|
21
|
+
config.paginate = false
|
22
|
+
|
23
|
+
collection_action :sort, :method => :post do
|
24
|
+
resource_name = active_admin_config.resource_name.to_s.underscore.parameterize('_')
|
25
|
+
|
26
|
+
records = params[resource_name].inject({}) do |res, (resource, parent_resource)|
|
27
|
+
res[resource_class.find(resource)] = resource_class.find(parent_resource) rescue nil
|
28
|
+
res
|
29
|
+
end
|
30
|
+
errors = []
|
31
|
+
ActiveRecord::Base.transaction do
|
32
|
+
records.each_with_index do |(record, parent_record), position|
|
33
|
+
record.send "#{options[:sorting_attribute]}=", position
|
34
|
+
if options[:tree]
|
35
|
+
record.send "#{options[:parent_method]}=", parent_record
|
36
|
+
end
|
37
|
+
errors << {record.id => record.errors} if !record.save
|
38
|
+
end
|
39
|
+
end
|
40
|
+
if errors.empty?
|
41
|
+
head 200
|
42
|
+
else
|
43
|
+
render json: errors, status: 422
|
44
|
+
end
|
45
|
+
end
|
46
|
+
|
47
|
+
end
|
48
|
+
|
49
|
+
end
|
50
|
+
|
51
|
+
::ActiveAdmin::ResourceDSL.send(:include, ControllerActions)
|
52
|
+
end
|
@@ -0,0 +1,19 @@
|
|
1
|
+
require 'activeadmin'
|
2
|
+
|
3
|
+
module ActiveAdmin
|
4
|
+
module SortableTree
|
5
|
+
class Engine < ::Rails::Engine
|
6
|
+
engine_name 'active_admin-sortable_tree'
|
7
|
+
|
8
|
+
initializer "Rails precompile hook", group: :all do |app|
|
9
|
+
app.config.assets.precompile += [ "active_admin/sortable.css",
|
10
|
+
"active_admin/sortable.js" ]
|
11
|
+
end
|
12
|
+
|
13
|
+
initializer "add assets" do
|
14
|
+
ActiveAdmin.application.register_stylesheet "active_admin/sortable.css"
|
15
|
+
ActiveAdmin.application.register_javascript "active_admin/sortable.js"
|
16
|
+
end
|
17
|
+
end
|
18
|
+
end
|
19
|
+
end
|
@@ -0,0 +1,30 @@
|
|
1
|
+
module ActiveAdmin
|
2
|
+
module Views
|
3
|
+
IndexAsBlock.class_eval do
|
4
|
+
|
5
|
+
def build(page_presenter, collection)
|
6
|
+
add_class "index"
|
7
|
+
if active_admin_config.dsl.sortable_options
|
8
|
+
set_attribute "data-sortable-type", "plain"
|
9
|
+
|
10
|
+
sort_url = if (( sort_url_block = active_admin_config.dsl.sortable_options[:sort_url] ))
|
11
|
+
sort_url_block.call(self)
|
12
|
+
else
|
13
|
+
url_for(:action => :sort)
|
14
|
+
end
|
15
|
+
|
16
|
+
set_attribute "data-sortable-url", sort_url
|
17
|
+
collection = collection.sort_by do |a|
|
18
|
+
a.send(active_admin_config.dsl.sortable_options[:sorting_attribute]) || 1
|
19
|
+
end
|
20
|
+
end
|
21
|
+
resource_selection_toggle_panel if active_admin_config.batch_actions.any?
|
22
|
+
collection.each do |obj|
|
23
|
+
instance_exec(obj, &page_presenter.block)
|
24
|
+
end
|
25
|
+
end
|
26
|
+
|
27
|
+
end
|
28
|
+
end
|
29
|
+
end
|
30
|
+
|
@@ -0,0 +1,154 @@
|
|
1
|
+
module ActiveAdmin
|
2
|
+
module Views
|
3
|
+
|
4
|
+
# = Index as a Sortable List or Tree
|
5
|
+
class IndexAsSortable < ActiveAdmin::Component
|
6
|
+
def build(page_presenter, collection)
|
7
|
+
@page_presenter = page_presenter
|
8
|
+
@collection = if tree?
|
9
|
+
roots
|
10
|
+
else
|
11
|
+
collection
|
12
|
+
end
|
13
|
+
@collection = @collection.sort_by do |a|
|
14
|
+
a.send(options[:sorting_attribute]) || 1
|
15
|
+
end
|
16
|
+
@resource_name = active_admin_config.resource_name.to_s.underscore.parameterize('_')
|
17
|
+
|
18
|
+
# Call the block passed in. This will set the
|
19
|
+
# title and body methods
|
20
|
+
instance_eval &page_presenter.block if page_presenter.block
|
21
|
+
|
22
|
+
add_class "index"
|
23
|
+
build_list
|
24
|
+
end
|
25
|
+
|
26
|
+
def self.index_name; "sortable"; end
|
27
|
+
|
28
|
+
def options
|
29
|
+
active_admin_config.dsl.sortable_options
|
30
|
+
end
|
31
|
+
|
32
|
+
def roots
|
33
|
+
roots_collection || default_roots_collection
|
34
|
+
end
|
35
|
+
|
36
|
+
# Find the roots by calling the roots method directly on the resource.
|
37
|
+
# This effectively performs:
|
38
|
+
#
|
39
|
+
# TreeNode.roots # => [#<TreeNode id:1>, ... ]
|
40
|
+
#
|
41
|
+
# Returns collection of roots.
|
42
|
+
def default_roots_collection
|
43
|
+
resource_class.send(options[:roots_method])
|
44
|
+
end
|
45
|
+
|
46
|
+
# Use user-defined logic to find the root nodes. This executes a callable
|
47
|
+
# object within the context of the resource's controller.
|
48
|
+
#
|
49
|
+
# Example
|
50
|
+
#
|
51
|
+
# options[:roots_collection] = proc { current_user.tree_nodes.roots }
|
52
|
+
#
|
53
|
+
# Returns collection of roots.
|
54
|
+
def roots_collection
|
55
|
+
if (callable = options[:roots_collection])
|
56
|
+
controller.instance_exec(&callable)
|
57
|
+
end
|
58
|
+
end
|
59
|
+
|
60
|
+
def tree?
|
61
|
+
!!options[:tree]
|
62
|
+
end
|
63
|
+
|
64
|
+
# Setter method for the configuration of the label
|
65
|
+
def label(method = nil, &block)
|
66
|
+
if block_given? || method
|
67
|
+
@label = block_given? ? block : method
|
68
|
+
end
|
69
|
+
@label
|
70
|
+
end
|
71
|
+
|
72
|
+
# Adds links to View, Edit and Delete
|
73
|
+
def actions(options = {}, &block)
|
74
|
+
options = { :defaults => true }.merge(options)
|
75
|
+
@default_actions = options[:defaults]
|
76
|
+
@other_actions = block
|
77
|
+
end
|
78
|
+
|
79
|
+
|
80
|
+
protected
|
81
|
+
|
82
|
+
def build_list
|
83
|
+
resource_selection_toggle_panel if active_admin_config.batch_actions.any?
|
84
|
+
sort_url = if (( sort_url_block = options[:sort_url] ))
|
85
|
+
sort_url_block.call(self)
|
86
|
+
else
|
87
|
+
url_for(:action => :sort)
|
88
|
+
end
|
89
|
+
data_options = {
|
90
|
+
"data-sortable-type" => (tree? ? "tree" : "list"),
|
91
|
+
"data-sortable-url" => sort_url,
|
92
|
+
}
|
93
|
+
data_options["data-max-levels"] = options[:max_levels]
|
94
|
+
data_options["data-start-collapsed"] = options[:start_collapsed]
|
95
|
+
data_options["data-protect-root"] = true if options[:protect_root]
|
96
|
+
|
97
|
+
ol data_options do
|
98
|
+
@collection.each do |item|
|
99
|
+
build_nested_item(item)
|
100
|
+
end
|
101
|
+
end
|
102
|
+
end
|
103
|
+
|
104
|
+
def build_nested_item(item)
|
105
|
+
li :id => "#{@resource_name}_#{item.id}" do
|
106
|
+
|
107
|
+
div :class => "item " << cycle("odd", "even", :name => "list_class") do
|
108
|
+
div :class => "cell left" do
|
109
|
+
resource_selection_cell(item) if active_admin_config.batch_actions.any?
|
110
|
+
end
|
111
|
+
|
112
|
+
if options[:collapsible] && item.send(options[:children_method]).any?
|
113
|
+
span :class => :disclose do
|
114
|
+
span
|
115
|
+
end
|
116
|
+
end
|
117
|
+
|
118
|
+
h3 :class => "cell left" do
|
119
|
+
call_method_or_proc_on(item, @label)
|
120
|
+
end
|
121
|
+
div :class => "cell right" do
|
122
|
+
build_actions(item)
|
123
|
+
end
|
124
|
+
end
|
125
|
+
|
126
|
+
ol do
|
127
|
+
item.send(options[:children_method]).order(options[:sorting_attribute]).each do |c|
|
128
|
+
build_nested_item(c)
|
129
|
+
end
|
130
|
+
end if tree?
|
131
|
+
end
|
132
|
+
end
|
133
|
+
|
134
|
+
def build_actions(resource)
|
135
|
+
links = ''.html_safe
|
136
|
+
if @default_actions
|
137
|
+
if controller.action_methods.include?('show')
|
138
|
+
links << link_to(I18n.t('active_admin.view'), resource_path(resource), :class => "member_link view_link")
|
139
|
+
end
|
140
|
+
if controller.action_methods.include?('edit')
|
141
|
+
links << link_to(I18n.t('active_admin.edit'), edit_resource_path(resource), :class => "member_link edit_link")
|
142
|
+
end
|
143
|
+
if controller.action_methods.include?('destroy')
|
144
|
+
links << link_to(I18n.t('active_admin.delete'), resource_path(resource), :method => :delete, :data => {:confirm => I18n.t('active_admin.delete_confirmation')}, :class => "member_link delete_link")
|
145
|
+
end
|
146
|
+
end
|
147
|
+
links << instance_exec(resource, &@other_actions) if @other_actions
|
148
|
+
links
|
149
|
+
end
|
150
|
+
|
151
|
+
end
|
152
|
+
end
|
153
|
+
end
|
154
|
+
|
@@ -0,0 +1 @@
|
|
1
|
+
require 'active_admin/sortable'
|
data/script/rails
ADDED
@@ -0,0 +1,11 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
|
3
|
+
ENGINE_ROOT = File.expand_path('../..', __FILE__)
|
4
|
+
ENGINE_PATH = File.expand_path('../../lib/active_admin/sortable_tree/engine', __FILE__)
|
5
|
+
|
6
|
+
# Set up gems listed in the Gemfile.
|
7
|
+
ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
|
8
|
+
require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
|
9
|
+
|
10
|
+
require 'rails/all'
|
11
|
+
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
|
+
| |-- 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.
|