superconductor 0.0.1
Sign up to get free protection for your applications and to get access to all the features.
- data/MIT-LICENSE +20 -0
- data/README.rdoc +3 -0
- data/Rakefile +40 -0
- data/app/assets/javascripts/superconductor.js +1 -0
- data/app/assets/javascripts/superconductor/panel.js.coffee +80 -0
- data/app/assets/stylesheets/superconductor.css +3 -0
- data/app/assets/stylesheets/superconductor/panel.css.scss +77 -0
- data/app/controllers/file_controller.rb +13 -0
- data/app/helpers/superconductor/panel_helper.rb +5 -0
- data/app/views/superconductor/_panel.html.erb +62 -0
- data/config/routes.rb +5 -0
- data/lib/superconductor.rb +4 -0
- data/lib/superconductor/engine.rb +4 -0
- data/lib/superconductor/version.rb +3 -0
- data/lib/tasks/superconductor_tasks.rake +4 -0
- data/test/dummy/README.rdoc +261 -0
- data/test/dummy/Rakefile +7 -0
- data/test/dummy/app/assets/javascripts/application.js +15 -0
- data/test/dummy/app/assets/stylesheets/application.css +13 -0
- data/test/dummy/app/controllers/application_controller.rb +3 -0
- data/test/dummy/app/helpers/application_helper.rb +2 -0
- data/test/dummy/app/views/layouts/application.html.erb +14 -0
- data/test/dummy/config.ru +4 -0
- data/test/dummy/config/application.rb +56 -0
- data/test/dummy/config/boot.rb +10 -0
- data/test/dummy/config/database.yml +25 -0
- data/test/dummy/config/environment.rb +5 -0
- data/test/dummy/config/environments/development.rb +37 -0
- data/test/dummy/config/environments/production.rb +67 -0
- data/test/dummy/config/environments/test.rb +37 -0
- data/test/dummy/config/initializers/backtrace_silencers.rb +7 -0
- data/test/dummy/config/initializers/inflections.rb +15 -0
- data/test/dummy/config/initializers/mime_types.rb +5 -0
- data/test/dummy/config/initializers/secret_token.rb +7 -0
- data/test/dummy/config/initializers/session_store.rb +8 -0
- data/test/dummy/config/initializers/wrap_parameters.rb +14 -0
- data/test/dummy/config/locales/en.yml +5 -0
- data/test/dummy/config/routes.rb +58 -0
- data/test/dummy/public/404.html +26 -0
- data/test/dummy/public/422.html +26 -0
- data/test/dummy/public/500.html +25 -0
- data/test/dummy/public/favicon.ico +0 -0
- data/test/dummy/script/rails +6 -0
- data/test/integration/navigation_test.rb +10 -0
- data/test/superconductor_test.rb +7 -0
- data/test/test_helper.rb +10 -0
- data/test/unit/helpers/superconductor/panel_helper_test.rb +4 -0
- metadata +169 -0
data/MIT-LICENSE
ADDED
@@ -0,0 +1,20 @@
|
|
1
|
+
Copyright 2012 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.
|
data/README.rdoc
ADDED
data/Rakefile
ADDED
@@ -0,0 +1,40 @@
|
|
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 = 'Superconductor'
|
18
|
+
rdoc.options << '--line-numbers'
|
19
|
+
rdoc.rdoc_files.include('README.rdoc')
|
20
|
+
rdoc.rdoc_files.include('lib/**/*.rb')
|
21
|
+
end
|
22
|
+
|
23
|
+
APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
|
24
|
+
load 'rails/tasks/engine.rake'
|
25
|
+
|
26
|
+
|
27
|
+
|
28
|
+
Bundler::GemHelper.install_tasks
|
29
|
+
|
30
|
+
require 'rake/testtask'
|
31
|
+
|
32
|
+
Rake::TestTask.new(:test) do |t|
|
33
|
+
t.libs << 'lib'
|
34
|
+
t.libs << 'test'
|
35
|
+
t.pattern = 'test/**/*_test.rb'
|
36
|
+
t.verbose = false
|
37
|
+
end
|
38
|
+
|
39
|
+
|
40
|
+
task :default => :test
|
@@ -0,0 +1 @@
|
|
1
|
+
//= require_tree ./superconductor
|
@@ -0,0 +1,80 @@
|
|
1
|
+
ctrl_down = false
|
2
|
+
|
3
|
+
jQuery ->
|
4
|
+
_debug_resize_mousemove = (event) ->
|
5
|
+
$('section#superconductor_panel').css('width',document.width - event.pageX)
|
6
|
+
|
7
|
+
_debug_resize_mouseup = (event) ->
|
8
|
+
$('html').unbind('mousemove',_debug_resize_mousemove)
|
9
|
+
$('html').unbind('mouseup',_debug_resize_mouseup)
|
10
|
+
$('section#superconductor_panel').removeClass('resizing')
|
11
|
+
|
12
|
+
if document.location.hash == '#superconductor'
|
13
|
+
$('section#superconductor_panel').css('right','0px').show()
|
14
|
+
$('body').addClass('debugging')
|
15
|
+
|
16
|
+
$(document)
|
17
|
+
.keydown (event) ->
|
18
|
+
ctrl_down = true if event.which == 17
|
19
|
+
.keyup (event) ->
|
20
|
+
ctrl_down = false if event.keyCode == 17
|
21
|
+
.keydown (event) ->
|
22
|
+
if (ctrl_down && event.which == 192)
|
23
|
+
if $('section#superconductor_panel:hidden').length > 0
|
24
|
+
$('body').addClass('debugging')
|
25
|
+
document.location.hash = 'debug'
|
26
|
+
$('section#superconductor_panel')
|
27
|
+
.show()
|
28
|
+
.animate
|
29
|
+
'right': '0px'
|
30
|
+
, 'fast'
|
31
|
+
else
|
32
|
+
document.location.hash = ''
|
33
|
+
$('section#superconductor_panel')
|
34
|
+
.animate
|
35
|
+
'right': '-'+$('section#superconductor_panel').css('width')
|
36
|
+
, 'fast'
|
37
|
+
->
|
38
|
+
$(this).hide()
|
39
|
+
$('body').removeClass('debugging')
|
40
|
+
return false;
|
41
|
+
return true
|
42
|
+
|
43
|
+
$('section#superconductor_panel .resizer').mousedown (event) ->
|
44
|
+
if event.which == 1
|
45
|
+
$('section#superconductor_panel').addClass('resizing')
|
46
|
+
$('html').bind('mousemove',_debug_resize_mousemove)
|
47
|
+
$('html').bind('mouseup',_debug_resize_mouseup)
|
48
|
+
|
49
|
+
$('section#superconductor_panel details:has(textarea) summary').click (event) ->
|
50
|
+
if event.target.tagName == "SUMMARY" && event.which == 1
|
51
|
+
details = $(this).parent()
|
52
|
+
unless details.attr('open')
|
53
|
+
$('section#superconductor_panel').animate
|
54
|
+
width: '50%'
|
55
|
+
, 'fast'
|
56
|
+
setTimeout( ->
|
57
|
+
textarea = details.find('textarea')
|
58
|
+
content = textarea[0].value
|
59
|
+
lineOffset = 0
|
60
|
+
if line_no = parseInt(textarea.attr('data-line-no'))
|
61
|
+
for i in [1...line_no]
|
62
|
+
lineOffset = content.indexOf("\n",lineOffset)+1
|
63
|
+
textarea[0].setSelectionRange(lineOffset,lineOffset)
|
64
|
+
textarea[0].scrollTop = (line_no - 1) * parseInt(textarea.css('line-height'))
|
65
|
+
, 10)
|
66
|
+
|
67
|
+
$('section#superconductor_panel textarea').keydown (event) ->
|
68
|
+
if ctrl_down && event.which == 83
|
69
|
+
$.ajax
|
70
|
+
type: "post"
|
71
|
+
url: this.form.action
|
72
|
+
data: $(this.form).serialize()
|
73
|
+
dataType: "json"
|
74
|
+
context: this
|
75
|
+
success: ->
|
76
|
+
this.disabled = false
|
77
|
+
window.location.reload(true)
|
78
|
+
this.disabled = true
|
79
|
+
event.preventDefault()
|
80
|
+
return false
|
@@ -0,0 +1,77 @@
|
|
1
|
+
// Place all the styles related to the pages controller here.
|
2
|
+
// They will automatically be included in application.css.
|
3
|
+
// You can use Sass (SCSS) here: http://sass-lang.com/
|
4
|
+
|
5
|
+
body.debugging {
|
6
|
+
overflow-x: hidden;
|
7
|
+
}
|
8
|
+
|
9
|
+
section#superconductor_panel {
|
10
|
+
color: white;
|
11
|
+
z-index: 99999;
|
12
|
+
a, a:link, a:visited { color: white; }
|
13
|
+
-webkit-transition: opacity 0.5s;
|
14
|
+
display: none;
|
15
|
+
font-family: Verdana, Helvetica, sans-serif;
|
16
|
+
font-size: 13px;
|
17
|
+
color: white;
|
18
|
+
background-color: #333333;
|
19
|
+
position: fixed;
|
20
|
+
top: 0px;
|
21
|
+
bottom: 0px;
|
22
|
+
right: -300px;
|
23
|
+
width: 300px;
|
24
|
+
footer { clear: both; height: 0px; }
|
25
|
+
background: -webkit-gradient(linear, left top, left bottom, from(#444444), to(#222222));
|
26
|
+
& > details {
|
27
|
+
-webkit-transition: height 2s;
|
28
|
+
summary {
|
29
|
+
& > a { float: right; }
|
30
|
+
cursor: pointer;
|
31
|
+
white-space: nowrap;
|
32
|
+
padding: 10px;
|
33
|
+
}
|
34
|
+
& > summary {
|
35
|
+
background: -webkit-gradient(linear, left top, left bottom, from(#333333), to(#000000));
|
36
|
+
}
|
37
|
+
dl {
|
38
|
+
padding: 5px 10px 10px 10px;
|
39
|
+
margin: 0px 5px 0px 5px;
|
40
|
+
dt {
|
41
|
+
clear: left;
|
42
|
+
float: left;
|
43
|
+
min-width: 100px;
|
44
|
+
&:after { content: ':' }
|
45
|
+
}
|
46
|
+
dd {
|
47
|
+
&.nowrap {
|
48
|
+
white-space: nowrap;
|
49
|
+
overflow: hidden;
|
50
|
+
text-overflow: ellipsis;
|
51
|
+
}
|
52
|
+
}
|
53
|
+
}
|
54
|
+
}
|
55
|
+
textarea {
|
56
|
+
background-color: #333333;
|
57
|
+
color: white;
|
58
|
+
width: 99%;
|
59
|
+
max-width: 99%;
|
60
|
+
height: 300px;
|
61
|
+
line-height: 16px;
|
62
|
+
}
|
63
|
+
&.resizing {
|
64
|
+
opacity: 0.85;
|
65
|
+
}
|
66
|
+
& .resizer {
|
67
|
+
position: absolute;
|
68
|
+
width: 10px;
|
69
|
+
height: 100%;
|
70
|
+
margin-left: -10px;
|
71
|
+
padding: 0px;
|
72
|
+
background: -webkit-gradient(linear, left top, right top, from(transparent), to(#111111));
|
73
|
+
background: gradient(linear, left top, right top, from(#FFFFFF), to(#111111));
|
74
|
+
cursor: w-resize;
|
75
|
+
border: none;
|
76
|
+
}
|
77
|
+
}
|
@@ -0,0 +1,13 @@
|
|
1
|
+
module Superconductor
|
2
|
+
class FileController < ApplicationController
|
3
|
+
def update
|
4
|
+
@file = File.open(params[:file],'w')
|
5
|
+
@file.puts(params[:content])
|
6
|
+
@file.close
|
7
|
+
|
8
|
+
respond_to do |format|
|
9
|
+
format.json { render json: nil, status: :ok }
|
10
|
+
end
|
11
|
+
end
|
12
|
+
end
|
13
|
+
end
|
@@ -0,0 +1,62 @@
|
|
1
|
+
<section id="superconductor_panel">
|
2
|
+
<button class="resizer"></button>
|
3
|
+
<details open>
|
4
|
+
<summary>
|
5
|
+
<%= request.request_method %> Parameters
|
6
|
+
</summary>
|
7
|
+
<dl>
|
8
|
+
<% params.each do |k,v| %>
|
9
|
+
<dt><%= k %></dt>
|
10
|
+
<dd><%= v %></dd>
|
11
|
+
<% end %>
|
12
|
+
</dl>
|
13
|
+
<details>
|
14
|
+
<summary>More...</summary>
|
15
|
+
<dl>
|
16
|
+
<dt>Remote IP</dt>
|
17
|
+
<dd><%= request.remote_ip %></dd>
|
18
|
+
<dt>User Agent</dt>
|
19
|
+
<dd class="nowrap"><%= request.user_agent %></dd>
|
20
|
+
<dt>Referer</dt>
|
21
|
+
<dd><%= request.referer %></dd>
|
22
|
+
<dt>Format</dt>
|
23
|
+
<dd><%= request.format %></dd>
|
24
|
+
</dl>
|
25
|
+
<footer />
|
26
|
+
</details>
|
27
|
+
</details>
|
28
|
+
<details open>
|
29
|
+
<summary>Variables</summary>
|
30
|
+
<dl>
|
31
|
+
<% controller.instance_variables.reject { |k| k.to_s.starts_with?('@_') }.map { |k| [k, instance_variable_get(k)] }.each do |k, v| %>
|
32
|
+
<dt><%= k %></dt>
|
33
|
+
<dd><%= v %></dd>
|
34
|
+
<% end %>
|
35
|
+
<footer />
|
36
|
+
</dl>
|
37
|
+
</details>
|
38
|
+
<details>
|
39
|
+
<summary>Session</summary>
|
40
|
+
<dl>
|
41
|
+
<% session.each do |k,v| %>
|
42
|
+
<dt><%= k %></dt>
|
43
|
+
<dd><%= v %></dd>
|
44
|
+
<% end %>
|
45
|
+
</dl>
|
46
|
+
</details>
|
47
|
+
<% begin %>
|
48
|
+
<details>
|
49
|
+
<% file, lineno = controller.class.instance_method(action_name).source_location %>
|
50
|
+
<summary>
|
51
|
+
<%= controller.class.name %>#<%= action_name %>
|
52
|
+
<a href="edit-source://<%= file %>?<%= lineno %>">Edit Source</a>
|
53
|
+
<footer />
|
54
|
+
</summary>
|
55
|
+
<%= form_tag superconductor_file_path, :method => :put do %>
|
56
|
+
<%= hidden_field_tag :file, file %>
|
57
|
+
<%= text_area_tag :content, File.read(file), :wrap => "off", 'data-line-no' => lineno %>
|
58
|
+
<% end %>
|
59
|
+
</details>
|
60
|
+
<% rescue %>
|
61
|
+
<% end %>
|
62
|
+
</section>
|
data/config/routes.rb
ADDED
@@ -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.
|