jobbr 1.0.1
Sign up to get free protection for your applications and to get access to all the features.
- data/.gitignore +10 -0
- data/.rspec +1 -0
- data/Gemfile +22 -0
- data/Gemfile.lock +164 -0
- data/MIT-LICENSE +20 -0
- data/README.rdoc +3 -0
- data/Rakefile +28 -0
- data/app/assets/images/jobbr/.gitkeep +0 -0
- data/app/assets/javascripts/jobbr/application.js.coffee +34 -0
- data/app/assets/stylesheets/jobbr/application.css.scss +79 -0
- data/app/controllers/jobbr/application_controller.rb +19 -0
- data/app/controllers/jobbr/delayed_jobs_controller.rb +17 -0
- data/app/controllers/jobbr/jobs_controller.rb +17 -0
- data/app/controllers/jobbr/runs_controller.rb +12 -0
- data/app/helpers/jobbr/application_helper.rb +36 -0
- data/app/models/jobbr/delayed_job.rb +38 -0
- data/app/models/jobbr/job.rb +110 -0
- data/app/models/jobbr/log_message.rb +15 -0
- data/app/models/jobbr/run.rb +61 -0
- data/app/models/jobbr/scheduled_job.rb +29 -0
- data/app/models/jobbr/standalone_tasks.rb +56 -0
- data/app/views/jobbr/jobs/_job_list.html.haml +23 -0
- data/app/views/jobbr/jobs/index.html.haml +6 -0
- data/app/views/jobbr/jobs/show.html.haml +30 -0
- data/app/views/jobbr/runs/_logs.html.haml +7 -0
- data/app/views/jobbr/runs/show.html.haml +31 -0
- data/app/views/layouts/jobbr/application.html.haml +20 -0
- data/config/locales/jobbr.en.yml +39 -0
- data/config/routes.rb +11 -0
- data/jobbr.gemspec +25 -0
- data/lib/jobbr.rb +4 -0
- data/lib/jobbr/engine.rb +7 -0
- data/lib/jobbr/logger.rb +55 -0
- data/lib/jobbr/mongoid.rb +54 -0
- data/lib/jobbr/version.rb +3 -0
- data/lib/jobbr/whenever.rb +24 -0
- data/lib/tasks/jobbr_tasks.rake +14 -0
- data/script/rails +8 -0
- data/spec/dummy/README.rdoc +261 -0
- data/spec/dummy/Rakefile +7 -0
- data/spec/dummy/app/assets/javascripts/application.js +15 -0
- data/spec/dummy/app/assets/stylesheets/application.css +13 -0
- data/spec/dummy/app/controllers/application_controller.rb +3 -0
- data/spec/dummy/app/helpers/application_helper.rb +2 -0
- data/spec/dummy/app/mailers/.gitkeep +0 -0
- data/spec/dummy/app/models/.gitkeep +0 -0
- data/spec/dummy/app/models/scheduled_jobs/dummy_scheduled_job.rb +15 -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 +62 -0
- data/spec/dummy/config/boot.rb +10 -0
- data/spec/dummy/config/database.yml +25 -0
- data/spec/dummy/config/environment.rb +5 -0
- data/spec/dummy/config/environments/development.rb +37 -0
- data/spec/dummy/config/environments/production.rb +67 -0
- data/spec/dummy/config/environments/test.rb +37 -0
- data/spec/dummy/config/initializers/backtrace_silencers.rb +7 -0
- data/spec/dummy/config/initializers/inflections.rb +15 -0
- data/spec/dummy/config/initializers/mime_types.rb +5 -0
- data/spec/dummy/config/initializers/secret_token.rb +7 -0
- data/spec/dummy/config/initializers/session_store.rb +8 -0
- data/spec/dummy/config/initializers/wrap_parameters.rb +14 -0
- data/spec/dummy/config/locales/en.yml +5 -0
- data/spec/dummy/config/mongoid.yml +80 -0
- data/spec/dummy/config/routes.rb +4 -0
- data/spec/dummy/config/schedule.rb +10 -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/models/delayed_job_spec.rb +37 -0
- data/spec/models/scheduled_job_spec.rb +106 -0
- data/spec/spec_helper.rb +32 -0
- data/vendor/assets/fonts/FontAwesome.otf +0 -0
- data/vendor/assets/fonts/fontawesome-webfont.eot +0 -0
- data/vendor/assets/fonts/fontawesome-webfont.svg +284 -0
- data/vendor/assets/fonts/fontawesome-webfont.ttf +0 -0
- data/vendor/assets/fonts/fontawesome-webfont.woff +0 -0
- data/vendor/assets/javascripts/bootstrap.js +7 -0
- data/vendor/assets/javascripts/jquery-pjax.js +677 -0
- data/vendor/assets/stylesheets/bootstrap.css.scss +705 -0
- data/vendor/assets/stylesheets/font-awesome.css.scss +534 -0
- metadata +275 -0
@@ -0,0 +1,20 @@
|
|
1
|
+
!!! XML
|
2
|
+
!!!
|
3
|
+
%html{ :xmlns => 'http://www.w3.org/1999/xhtml' }
|
4
|
+
%head
|
5
|
+
%title JobbR
|
6
|
+
|
7
|
+
= csrf_meta_tags
|
8
|
+
|
9
|
+
= stylesheet_link_tag 'jobbr/application'
|
10
|
+
= javascript_include_tag 'jobbr/application'
|
11
|
+
|
12
|
+
%body
|
13
|
+
.navbar
|
14
|
+
.navbar-inner
|
15
|
+
%a.brand= t('.title')
|
16
|
+
%button.btn#auto-refresh{type: 'button', 'data-toggle' => 'button'}
|
17
|
+
%i.icon-refresh
|
18
|
+
= t('.auto_refresh')
|
19
|
+
#main.container
|
20
|
+
= yield
|
@@ -0,0 +1,39 @@
|
|
1
|
+
en:
|
2
|
+
|
3
|
+
layouts:
|
4
|
+
jobbr:
|
5
|
+
application:
|
6
|
+
title: JobbR
|
7
|
+
auto_refresh: Auto-refresh
|
8
|
+
|
9
|
+
jobbr:
|
10
|
+
|
11
|
+
jobs:
|
12
|
+
|
13
|
+
index:
|
14
|
+
title: Job list
|
15
|
+
scheduled_jobs: Scheduled Jobs
|
16
|
+
delayed_jobs: Delayed Jobs
|
17
|
+
|
18
|
+
job_list:
|
19
|
+
status: Status
|
20
|
+
job_name: Name
|
21
|
+
last_run: Last runned at
|
22
|
+
average_run_time: Average run time
|
23
|
+
see_all_runs: See all runs
|
24
|
+
see_last_run: See last run
|
25
|
+
|
26
|
+
show:
|
27
|
+
status: Status
|
28
|
+
last_run: Last run
|
29
|
+
last_run_logs: Last run logs
|
30
|
+
duration: Duration
|
31
|
+
scheduling: "Scheduled every <strong>%{scheduling}</strong>"
|
32
|
+
average_run_time: "Average duration: <strong>%{run_time}</strong>"
|
33
|
+
see_run: See details for this run
|
34
|
+
|
35
|
+
runs:
|
36
|
+
show:
|
37
|
+
run_time: "Run time: %{run_time}"
|
38
|
+
previous_run: "Previous run"
|
39
|
+
next_run: "Next run"
|
data/config/routes.rb
ADDED
data/jobbr.gemspec
ADDED
@@ -0,0 +1,25 @@
|
|
1
|
+
$:.push File.expand_path("../lib", __FILE__)
|
2
|
+
|
3
|
+
require "jobbr/version"
|
4
|
+
|
5
|
+
Gem::Specification.new do |s|
|
6
|
+
s.name = "jobbr"
|
7
|
+
s.version = Jobbr::VERSION
|
8
|
+
s.authors = ["Christian Blavier"]
|
9
|
+
s.email = ["cblavier@gmail.com"]
|
10
|
+
s.homepage = "https://github.com/cblavier/jobbr"
|
11
|
+
s.summary = "Rails supervision UI for your Cron jobs and your Delayed Jobs."
|
12
|
+
s.description = "Jobbr provideds a convenient framework and UI to make your Cron jobs and Scheduled Jobs more manageable."
|
13
|
+
|
14
|
+
s.files = `git ls-files`.split("\n")
|
15
|
+
s.test_files = `git ls-files -- spec/*`.split("\n")
|
16
|
+
s.require_paths = ["lib"]
|
17
|
+
|
18
|
+
s.add_dependency "rails", "~> 3.2"
|
19
|
+
s.add_dependency "mongoid", "~> 3.0"
|
20
|
+
s.add_dependency "whenever"
|
21
|
+
s.add_dependency "chronic_duration"
|
22
|
+
|
23
|
+
s.add_development_dependency 'sqlite3'
|
24
|
+
s.add_development_dependency 'combustion', '~> 0.3.1'
|
25
|
+
end
|
data/lib/jobbr.rb
ADDED
data/lib/jobbr/engine.rb
ADDED
data/lib/jobbr/logger.rb
ADDED
@@ -0,0 +1,55 @@
|
|
1
|
+
module Jobbr
|
2
|
+
|
3
|
+
class Logger
|
4
|
+
|
5
|
+
FLUSH_DELAY = 5
|
6
|
+
|
7
|
+
attr_accessor :run, :last_flush_at, :wrapped_logger, :level
|
8
|
+
|
9
|
+
def initialize(logger, run)
|
10
|
+
self.wrapped_logger = logger
|
11
|
+
self.run = run
|
12
|
+
self.level = 0
|
13
|
+
end
|
14
|
+
|
15
|
+
def debug(message)
|
16
|
+
wrapped_logger.debug(message)
|
17
|
+
write_message(:debug, message)
|
18
|
+
end
|
19
|
+
|
20
|
+
def info(message)
|
21
|
+
wrapped_logger.info(message)
|
22
|
+
write_message(:info, message)
|
23
|
+
end
|
24
|
+
|
25
|
+
def warn(message)
|
26
|
+
wrapped_logger.warn(message)
|
27
|
+
write_message(:warn, message)
|
28
|
+
end
|
29
|
+
|
30
|
+
def error(message)
|
31
|
+
wrapped_logger.error(message)
|
32
|
+
write_message(:error, message)
|
33
|
+
end
|
34
|
+
|
35
|
+
def fatal(message)
|
36
|
+
wrapped_logger.error(message)
|
37
|
+
write_message(:fatal, message)
|
38
|
+
end
|
39
|
+
|
40
|
+
protected
|
41
|
+
|
42
|
+
def write_message(kind, message)
|
43
|
+
if message.is_a? Array
|
44
|
+
message = message.join('<br/>')
|
45
|
+
end
|
46
|
+
run.log_messages << Jobbr::LogMessage.new(kind: kind, message: message, date: Time.now)
|
47
|
+
if last_flush_at.nil? || (last_flush_at + FLUSH_DELAY.seconds < Time.now)
|
48
|
+
run.save!
|
49
|
+
self.last_flush_at = Time.now
|
50
|
+
end
|
51
|
+
end
|
52
|
+
|
53
|
+
end
|
54
|
+
|
55
|
+
end
|
@@ -0,0 +1,54 @@
|
|
1
|
+
module Jobbr
|
2
|
+
|
3
|
+
module Mongoid
|
4
|
+
|
5
|
+
include ::Mongoid
|
6
|
+
|
7
|
+
extend self
|
8
|
+
|
9
|
+
# Return all Mongoid models.
|
10
|
+
# You can also pass a parent class to get all Mongoid childrens
|
11
|
+
#
|
12
|
+
# @example Return *all* models.
|
13
|
+
# Rails::Mongoid.models
|
14
|
+
#
|
15
|
+
# @example Return Job children models.
|
16
|
+
# Rails::Mongoid.models(Job)
|
17
|
+
#
|
18
|
+
# @param [ Class ] parent The parent model class.
|
19
|
+
#
|
20
|
+
# @return [ Array<Class> ] The models.
|
21
|
+
#
|
22
|
+
def models(parent = nil)
|
23
|
+
model_paths = Dir["#{Rails.root}/app/models/**/*.rb"]
|
24
|
+
sanitized_model_paths = model_paths.map { |path| path.gsub(/.*\/app\/models\//, '').gsub('.rb', '') }
|
25
|
+
model_constants = sanitized_model_paths.map do |path|
|
26
|
+
path.split('/').map { |token| token.camelize }.join('::').constantize
|
27
|
+
end
|
28
|
+
model_constants = model_constants.select { |constant| constant.include?(Mongoid::Document) }
|
29
|
+
|
30
|
+
if parent
|
31
|
+
model_constants.select { |model| superclasses(model).include?(parent) }
|
32
|
+
else
|
33
|
+
model_constants
|
34
|
+
end
|
35
|
+
end
|
36
|
+
|
37
|
+
# Return all superclasses for a given class.
|
38
|
+
#
|
39
|
+
# @param [ Class ] parent The class you want to get superclasses from.
|
40
|
+
#
|
41
|
+
# @return [ Array<Class> ] The superclasses.
|
42
|
+
#
|
43
|
+
def superclasses(klass)
|
44
|
+
super_classes = []
|
45
|
+
while klass != Object
|
46
|
+
klass = klass.superclass
|
47
|
+
super_classes << klass
|
48
|
+
end
|
49
|
+
super_classes
|
50
|
+
end
|
51
|
+
|
52
|
+
end
|
53
|
+
|
54
|
+
end
|
@@ -0,0 +1,24 @@
|
|
1
|
+
require "jobbr/mongoid"
|
2
|
+
|
3
|
+
module Jobbr
|
4
|
+
|
5
|
+
module Whenever
|
6
|
+
|
7
|
+
extend self
|
8
|
+
|
9
|
+
#
|
10
|
+
# Generates crontab for each scheduled Job using Whenever DSL.
|
11
|
+
#
|
12
|
+
def schedule_jobs(job_list)
|
13
|
+
Jobbr::Mongoid.models(Jobbr::ScheduledJob).each do |job|
|
14
|
+
if job.every
|
15
|
+
job_list.every job.every[0], job.every[1] do
|
16
|
+
job_list.rake job.task_name(true)
|
17
|
+
end
|
18
|
+
end
|
19
|
+
end
|
20
|
+
end
|
21
|
+
|
22
|
+
end
|
23
|
+
|
24
|
+
end
|
@@ -0,0 +1,14 @@
|
|
1
|
+
models_root = File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'app', 'models'))
|
2
|
+
require File.join(models_root, 'jobbr', 'standalone_tasks')
|
3
|
+
|
4
|
+
namespace :jobbr do
|
5
|
+
|
6
|
+
Jobbr::StandaloneTasks.all(:scheduled_job).each do |info|
|
7
|
+
# dynamically create a rake task for each individual Jobbr::ScheduledJob
|
8
|
+
desc info[:desc]
|
9
|
+
task info[:name] => :environment do
|
10
|
+
info[:dependencies].each { |lib| load lib }
|
11
|
+
info[:klass_name].constantize.run
|
12
|
+
end
|
13
|
+
end
|
14
|
+
end
|
data/script/rails
ADDED
@@ -0,0 +1,8 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
|
3
|
+
|
4
|
+
ENGINE_ROOT = File.expand_path('../..', __FILE__)
|
5
|
+
ENGINE_PATH = File.expand_path('../../lib/jobbr/engine', __FILE__)
|
6
|
+
|
7
|
+
require 'rails/all'
|
8
|
+
require 'rails/engine/commands'
|
@@ -0,0 +1,261 @@
|
|
1
|
+
== Welcome to Rails
|
2
|
+
|
3
|
+
Rails is a web-application framework that includes everything needed to create
|
4
|
+
database-backed web applications according to the Model-View-Control pattern.
|
5
|
+
|
6
|
+
This pattern splits the view (also called the presentation) into "dumb"
|
7
|
+
templates that are primarily responsible for inserting pre-built data in between
|
8
|
+
HTML tags. The model contains the "smart" domain objects (such as Account,
|
9
|
+
Product, Person, Post) that holds all the business logic and knows how to
|
10
|
+
persist themselves to a database. The controller handles the incoming requests
|
11
|
+
(such as Save New Account, Update Product, Show Post) by manipulating the model
|
12
|
+
and directing data to the view.
|
13
|
+
|
14
|
+
In Rails, the model is handled by what's called an object-relational mapping
|
15
|
+
layer entitled Active Record. This layer allows you to present the data from
|
16
|
+
database rows as objects and embellish these data objects with business logic
|
17
|
+
methods. You can read more about Active Record in
|
18
|
+
link:files/vendor/rails/activerecord/README.html.
|
19
|
+
|
20
|
+
The controller and view are handled by the Action Pack, which handles both
|
21
|
+
layers by its two parts: Action View and Action Controller. These two layers
|
22
|
+
are bundled in a single package due to their heavy interdependence. This is
|
23
|
+
unlike the relationship between the Active Record and Action Pack that is much
|
24
|
+
more separate. Each of these packages can be used independently outside of
|
25
|
+
Rails. You can read more about Action Pack in
|
26
|
+
link:files/vendor/rails/actionpack/README.html.
|
27
|
+
|
28
|
+
|
29
|
+
== Getting Started
|
30
|
+
|
31
|
+
1. At the command prompt, create a new Rails application:
|
32
|
+
<tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
|
33
|
+
|
34
|
+
2. Change directory to <tt>myapp</tt> and start the web server:
|
35
|
+
<tt>cd myapp; rails server</tt> (run with --help for options)
|
36
|
+
|
37
|
+
3. Go to http://localhost:3000/ and you'll see:
|
38
|
+
"Welcome aboard: You're riding Ruby on Rails!"
|
39
|
+
|
40
|
+
4. Follow the guidelines to start developing your application. You can find
|
41
|
+
the following resources handy:
|
42
|
+
|
43
|
+
* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
|
44
|
+
* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
|
45
|
+
|
46
|
+
|
47
|
+
== Debugging Rails
|
48
|
+
|
49
|
+
Sometimes your application goes wrong. Fortunately there are a lot of tools that
|
50
|
+
will help you debug it and get it back on the rails.
|
51
|
+
|
52
|
+
First area to check is the application log files. Have "tail -f" commands
|
53
|
+
running on the server.log and development.log. Rails will automatically display
|
54
|
+
debugging and runtime information to these files. Debugging info will also be
|
55
|
+
shown in the browser on requests from 127.0.0.1.
|
56
|
+
|
57
|
+
You can also log your own messages directly into the log file from your code
|
58
|
+
using the Ruby logger class from inside your controllers. Example:
|
59
|
+
|
60
|
+
class WeblogController < ActionController::Base
|
61
|
+
def destroy
|
62
|
+
@weblog = Weblog.find(params[:id])
|
63
|
+
@weblog.destroy
|
64
|
+
logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
|
65
|
+
end
|
66
|
+
end
|
67
|
+
|
68
|
+
The result will be a message in your log file along the lines of:
|
69
|
+
|
70
|
+
Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
|
71
|
+
|
72
|
+
More information on how to use the logger is at http://www.ruby-doc.org/core/
|
73
|
+
|
74
|
+
Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
|
75
|
+
several books available online as well:
|
76
|
+
|
77
|
+
* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
|
78
|
+
* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
|
79
|
+
|
80
|
+
These two books will bring you up to speed on the Ruby language and also on
|
81
|
+
programming in general.
|
82
|
+
|
83
|
+
|
84
|
+
== Debugger
|
85
|
+
|
86
|
+
Debugger support is available through the debugger command when you start your
|
87
|
+
Mongrel or WEBrick server with --debugger. This means that you can break out of
|
88
|
+
execution at any point in the code, investigate and change the model, and then,
|
89
|
+
resume execution! You need to install ruby-debug to run the server in debugging
|
90
|
+
mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
|
91
|
+
|
92
|
+
class WeblogController < ActionController::Base
|
93
|
+
def index
|
94
|
+
@posts = Post.all
|
95
|
+
debugger
|
96
|
+
end
|
97
|
+
end
|
98
|
+
|
99
|
+
So the controller will accept the action, run the first line, then present you
|
100
|
+
with a IRB prompt in the server window. Here you can do things like:
|
101
|
+
|
102
|
+
>> @posts.inspect
|
103
|
+
=> "[#<Post:0x14a6be8
|
104
|
+
@attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
|
105
|
+
#<Post:0x14a6620
|
106
|
+
@attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
|
107
|
+
>> @posts.first.title = "hello from a debugger"
|
108
|
+
=> "hello from a debugger"
|
109
|
+
|
110
|
+
...and even better, you can examine how your runtime objects actually work:
|
111
|
+
|
112
|
+
>> f = @posts.first
|
113
|
+
=> #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
|
114
|
+
>> f.
|
115
|
+
Display all 152 possibilities? (y or n)
|
116
|
+
|
117
|
+
Finally, when you're ready to resume execution, you can enter "cont".
|
118
|
+
|
119
|
+
|
120
|
+
== Console
|
121
|
+
|
122
|
+
The console is a Ruby shell, which allows you to interact with your
|
123
|
+
application's domain model. Here you'll have all parts of the application
|
124
|
+
configured, just like it is when the application is running. You can inspect
|
125
|
+
domain models, change values, and save to the database. Starting the script
|
126
|
+
without arguments will launch it in the development environment.
|
127
|
+
|
128
|
+
To start the console, run <tt>rails console</tt> from the application
|
129
|
+
directory.
|
130
|
+
|
131
|
+
Options:
|
132
|
+
|
133
|
+
* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
|
134
|
+
made to the database.
|
135
|
+
* Passing an environment name as an argument will load the corresponding
|
136
|
+
environment. Example: <tt>rails console production</tt>.
|
137
|
+
|
138
|
+
To reload your controllers and models after launching the console run
|
139
|
+
<tt>reload!</tt>
|
140
|
+
|
141
|
+
More information about irb can be found at:
|
142
|
+
link:http://www.rubycentral.org/pickaxe/irb.html
|
143
|
+
|
144
|
+
|
145
|
+
== dbconsole
|
146
|
+
|
147
|
+
You can go to the command line of your database directly through <tt>rails
|
148
|
+
dbconsole</tt>. You would be connected to the database with the credentials
|
149
|
+
defined in database.yml. Starting the script without arguments will connect you
|
150
|
+
to the development database. Passing an argument will connect you to a different
|
151
|
+
database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
|
152
|
+
PostgreSQL and SQLite 3.
|
153
|
+
|
154
|
+
== Description of Contents
|
155
|
+
|
156
|
+
The default directory structure of a generated Ruby on Rails application:
|
157
|
+
|
158
|
+
|-- app
|
159
|
+
| |-- assets
|
160
|
+
| |-- images
|
161
|
+
| |-- javascripts
|
162
|
+
| `-- stylesheets
|
163
|
+
| |-- controllers
|
164
|
+
| |-- helpers
|
165
|
+
| |-- mailers
|
166
|
+
| |-- models
|
167
|
+
| `-- views
|
168
|
+
| `-- layouts
|
169
|
+
|-- config
|
170
|
+
| |-- environments
|
171
|
+
| |-- initializers
|
172
|
+
| `-- locales
|
173
|
+
|-- db
|
174
|
+
|-- doc
|
175
|
+
|-- lib
|
176
|
+
| `-- tasks
|
177
|
+
|-- log
|
178
|
+
|-- public
|
179
|
+
|-- script
|
180
|
+
|-- test
|
181
|
+
| |-- fixtures
|
182
|
+
| |-- functional
|
183
|
+
| |-- integration
|
184
|
+
| |-- performance
|
185
|
+
| `-- unit
|
186
|
+
|-- tmp
|
187
|
+
| |-- cache
|
188
|
+
| |-- pids
|
189
|
+
| |-- sessions
|
190
|
+
| `-- sockets
|
191
|
+
`-- vendor
|
192
|
+
|-- assets
|
193
|
+
`-- stylesheets
|
194
|
+
`-- plugins
|
195
|
+
|
196
|
+
app
|
197
|
+
Holds all the code that's specific to this particular application.
|
198
|
+
|
199
|
+
app/assets
|
200
|
+
Contains subdirectories for images, stylesheets, and JavaScript files.
|
201
|
+
|
202
|
+
app/controllers
|
203
|
+
Holds controllers that should be named like weblogs_controller.rb for
|
204
|
+
automated URL mapping. All controllers should descend from
|
205
|
+
ApplicationController which itself descends from ActionController::Base.
|
206
|
+
|
207
|
+
app/models
|
208
|
+
Holds models that should be named like post.rb. Models descend from
|
209
|
+
ActiveRecord::Base by default.
|
210
|
+
|
211
|
+
app/views
|
212
|
+
Holds the template files for the view that should be named like
|
213
|
+
weblogs/index.html.erb for the WeblogsController#index action. All views use
|
214
|
+
eRuby syntax by default.
|
215
|
+
|
216
|
+
app/views/layouts
|
217
|
+
Holds the template files for layouts to be used with views. This models the
|
218
|
+
common header/footer method of wrapping views. In your views, define a layout
|
219
|
+
using the <tt>layout :default</tt> and create a file named default.html.erb.
|
220
|
+
Inside default.html.erb, call <% yield %> to render the view using this
|
221
|
+
layout.
|
222
|
+
|
223
|
+
app/helpers
|
224
|
+
Holds view helpers that should be named like weblogs_helper.rb. These are
|
225
|
+
generated for you automatically when using generators for controllers.
|
226
|
+
Helpers can be used to wrap functionality for your views into methods.
|
227
|
+
|
228
|
+
config
|
229
|
+
Configuration files for the Rails environment, the routing map, the database,
|
230
|
+
and other dependencies.
|
231
|
+
|
232
|
+
db
|
233
|
+
Contains the database schema in schema.rb. db/migrate contains all the
|
234
|
+
sequence of Migrations for your schema.
|
235
|
+
|
236
|
+
doc
|
237
|
+
This directory is where your application documentation will be stored when
|
238
|
+
generated using <tt>rake doc:app</tt>
|
239
|
+
|
240
|
+
lib
|
241
|
+
Application specific libraries. Basically, any kind of custom code that
|
242
|
+
doesn't belong under controllers, models, or helpers. This directory is in
|
243
|
+
the load path.
|
244
|
+
|
245
|
+
public
|
246
|
+
The directory available for the web server. Also contains the dispatchers and the
|
247
|
+
default HTML files. This should be set as the DOCUMENT_ROOT of your web
|
248
|
+
server.
|
249
|
+
|
250
|
+
script
|
251
|
+
Helper scripts for automation and generation.
|
252
|
+
|
253
|
+
test
|
254
|
+
Unit and functional tests along with fixtures. When using the rails generate
|
255
|
+
command, template test files will be generated for you and placed in this
|
256
|
+
directory.
|
257
|
+
|
258
|
+
vendor
|
259
|
+
External libraries that the application depends on. Also includes the plugins
|
260
|
+
subdirectory. If the app has frozen rails, those gems also go here, under
|
261
|
+
vendor/rails/. This directory is in the load path.
|