brightcontent-attachments 2.0.6
Sign up to get free protection for your applications and to get access to all the features.
- data/.gitignore +9 -0
- data/Gemfile +5 -0
- data/Gemfile.lock +183 -0
- data/Rakefile +14 -0
- data/app/assets/javascripts/brightcontent/.gitkeep +0 -0
- data/app/assets/javascripts/brightcontent/attachments.js +14 -0
- data/app/controllers/brightcontent/attachments_controller.rb +21 -0
- data/app/helpers/brightcontent/attachments_helper.rb +4 -0
- data/app/models/brightcontent/attachment.rb +11 -0
- data/app/views/brightcontent/attachments/_form_field.html.erb +15 -0
- data/app/views/brightcontent/attachments/show.html.erb +3 -0
- data/brightcontent-attachments.gemspec +27 -0
- data/config/routes.rb +5 -0
- data/db/migrate/20121222172513_create_attachments.rb +19 -0
- data/lib/brightcontent-attachments.rb +1 -0
- data/lib/brightcontent/attachments.rb +10 -0
- data/lib/brightcontent/attachments/engine.rb +6 -0
- data/lib/generators/brightcontent/attachments/install_generator.rb +15 -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/javascripts/brightcontent/custom.js +1 -0
- data/spec/dummy/app/assets/stylesheets/application.css +13 -0
- data/spec/dummy/app/assets/stylesheets/brightcontent/custom.css +1 -0
- data/spec/dummy/app/controllers/application_controller.rb +3 -0
- data/spec/dummy/app/controllers/brightcontent/blogs_controller.rb +11 -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/blog.rb +4 -0
- data/spec/dummy/app/views/brightcontent/blogs/_form_field_assets.html.erb +1 -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 +59 -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/brightcontent.rb +3 -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/routes.rb +5 -0
- data/spec/dummy/db/migrate/20121206121725_create_brightcontent_admin_users.rb +12 -0
- data/spec/dummy/db/migrate/20121206225720_create_blogs.rb +10 -0
- data/spec/dummy/db/schema.rb +44 -0
- data/spec/dummy/lib/assets/.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/public/system/brightcontent/assets/assets/000/000/001/original/icon-socialmedia.png +0 -0
- data/spec/dummy/public/system/brightcontent/assets/assets/000/000/002/original/bg_direction_nav.png +0 -0
- data/spec/dummy/public/system/brightcontent/assets/assets/000/000/003/original/icon-android.png +0 -0
- data/spec/dummy/public/system/brightcontent/assets/assets/000/000/004/original/icon-calendar.png +0 -0
- data/spec/dummy/public/system/brightcontent/assets/assets/000/000/005/original/icon-iphone.png +0 -0
- data/spec/dummy/public/system/brightcontent/assets/assets/000/000/006/original/icon-socialmedia.png +0 -0
- data/spec/dummy/public/system/brightcontent/assets/assets/000/000/007/original/iphone.png +0 -0
- data/spec/dummy/public/system/brightcontent/assets/assets/000/000/008/original/logo.png +0 -0
- data/spec/dummy/public/system/brightcontent/assets/assets/000/000/009/original/menu-button.png +0 -0
- data/spec/dummy/public/system/brightcontent/assets/assets/000/000/010/original/bestuur.jpg +0 -0
- data/spec/dummy/public/system/brightcontent/attachments/assets/000/000/001/original/bestuur.jpg +0 -0
- data/spec/dummy/public/system/brightcontent/attachments/assets/000/000/002/original/carousel.jpg +0 -0
- data/spec/dummy/public/system/brightcontent/attachments/assets/000/000/003/original/icon-socialmedia.png +0 -0
- data/spec/dummy/public/system/brightcontent/attachments/assets/000/000/004/original/icon-calendar.png +0 -0
- data/spec/dummy/public/system/brightcontent/attachments/assets/000/000/005/original/bg_direction_nav.png +0 -0
- data/spec/dummy/script/rails +6 -0
- data/spec/factories.rb +15 -0
- data/spec/features/attachments_spec.rb +17 -0
- data/spec/models/brightcontent/attachment_spec.rb +6 -0
- data/spec/spec_helper.rb +18 -0
- data/spec/support/acceptance_helper.rb +8 -0
- metadata +317 -0
data/.gitignore
ADDED
data/Gemfile
ADDED
data/Gemfile.lock
ADDED
@@ -0,0 +1,183 @@
|
|
1
|
+
PATH
|
2
|
+
remote: .
|
3
|
+
specs:
|
4
|
+
brightcontent-attachments (2.0.6)
|
5
|
+
brightcontent-core (= 2.0.6)
|
6
|
+
jquery-fileupload-rails
|
7
|
+
paperclip
|
8
|
+
|
9
|
+
PATH
|
10
|
+
remote: ../core
|
11
|
+
specs:
|
12
|
+
brightcontent-core (2.0.6)
|
13
|
+
bcrypt-ruby
|
14
|
+
bootstrap-wysihtml5-rails
|
15
|
+
has_scope
|
16
|
+
inherited_resources
|
17
|
+
jquery-rails
|
18
|
+
rails (~> 3.2.9)
|
19
|
+
simple_form
|
20
|
+
will_paginate
|
21
|
+
|
22
|
+
GEM
|
23
|
+
remote: http://rubygems.org/
|
24
|
+
specs:
|
25
|
+
actionmailer (3.2.9)
|
26
|
+
actionpack (= 3.2.9)
|
27
|
+
mail (~> 2.4.4)
|
28
|
+
actionpack (3.2.9)
|
29
|
+
activemodel (= 3.2.9)
|
30
|
+
activesupport (= 3.2.9)
|
31
|
+
builder (~> 3.0.0)
|
32
|
+
erubis (~> 2.7.0)
|
33
|
+
journey (~> 1.0.4)
|
34
|
+
rack (~> 1.4.0)
|
35
|
+
rack-cache (~> 1.2)
|
36
|
+
rack-test (~> 0.6.1)
|
37
|
+
sprockets (~> 2.2.1)
|
38
|
+
activemodel (3.2.9)
|
39
|
+
activesupport (= 3.2.9)
|
40
|
+
builder (~> 3.0.0)
|
41
|
+
activerecord (3.2.9)
|
42
|
+
activemodel (= 3.2.9)
|
43
|
+
activesupport (= 3.2.9)
|
44
|
+
arel (~> 3.0.2)
|
45
|
+
tzinfo (~> 0.3.29)
|
46
|
+
activeresource (3.2.9)
|
47
|
+
activemodel (= 3.2.9)
|
48
|
+
activesupport (= 3.2.9)
|
49
|
+
activesupport (3.2.9)
|
50
|
+
i18n (~> 0.6)
|
51
|
+
multi_json (~> 1.0)
|
52
|
+
addressable (2.3.2)
|
53
|
+
arel (3.0.2)
|
54
|
+
bcrypt-ruby (3.0.1)
|
55
|
+
bootstrap-wysihtml5-rails (0.3.1.13)
|
56
|
+
railties (>= 3.0)
|
57
|
+
builder (3.0.4)
|
58
|
+
capybara (2.0.1)
|
59
|
+
mime-types (>= 1.16)
|
60
|
+
nokogiri (>= 1.3.3)
|
61
|
+
rack (>= 1.0.0)
|
62
|
+
rack-test (>= 0.5.4)
|
63
|
+
selenium-webdriver (~> 2.0)
|
64
|
+
xpath (~> 1.0.0)
|
65
|
+
childprocess (0.3.6)
|
66
|
+
ffi (~> 1.0, >= 1.0.6)
|
67
|
+
cocaine (0.4.2)
|
68
|
+
diff-lcs (1.1.3)
|
69
|
+
erubis (2.7.0)
|
70
|
+
factory_girl (4.1.0)
|
71
|
+
activesupport (>= 3.0.0)
|
72
|
+
factory_girl_rails (4.1.0)
|
73
|
+
factory_girl (~> 4.1.0)
|
74
|
+
railties (>= 3.0.0)
|
75
|
+
ffi (1.2.0)
|
76
|
+
has_scope (0.5.1)
|
77
|
+
hike (1.2.1)
|
78
|
+
i18n (0.6.1)
|
79
|
+
inherited_resources (1.3.1)
|
80
|
+
has_scope (~> 0.5.0)
|
81
|
+
responders (~> 0.6)
|
82
|
+
journey (1.0.4)
|
83
|
+
jquery-fileupload-rails (0.4.0)
|
84
|
+
actionpack (>= 3.1)
|
85
|
+
railties (>= 3.1)
|
86
|
+
jquery-rails (2.1.4)
|
87
|
+
railties (>= 3.0, < 5.0)
|
88
|
+
thor (>= 0.14, < 2.0)
|
89
|
+
json (1.7.5)
|
90
|
+
launchy (2.1.2)
|
91
|
+
addressable (~> 2.3)
|
92
|
+
libwebsocket (0.1.7.1)
|
93
|
+
addressable
|
94
|
+
websocket
|
95
|
+
mail (2.4.4)
|
96
|
+
i18n (>= 0.4.0)
|
97
|
+
mime-types (~> 1.16)
|
98
|
+
treetop (~> 1.4.8)
|
99
|
+
mime-types (1.19)
|
100
|
+
multi_json (1.5.0)
|
101
|
+
nokogiri (1.5.6)
|
102
|
+
paperclip (3.4.0)
|
103
|
+
activemodel (>= 3.0.0)
|
104
|
+
activerecord (>= 3.0.0)
|
105
|
+
activesupport (>= 3.0.0)
|
106
|
+
cocaine (~> 0.4.0)
|
107
|
+
mime-types
|
108
|
+
polyglot (0.3.3)
|
109
|
+
rack (1.4.1)
|
110
|
+
rack-cache (1.2)
|
111
|
+
rack (>= 0.4)
|
112
|
+
rack-ssl (1.3.2)
|
113
|
+
rack
|
114
|
+
rack-test (0.6.2)
|
115
|
+
rack (>= 1.0)
|
116
|
+
rails (3.2.9)
|
117
|
+
actionmailer (= 3.2.9)
|
118
|
+
actionpack (= 3.2.9)
|
119
|
+
activerecord (= 3.2.9)
|
120
|
+
activeresource (= 3.2.9)
|
121
|
+
activesupport (= 3.2.9)
|
122
|
+
bundler (~> 1.0)
|
123
|
+
railties (= 3.2.9)
|
124
|
+
railties (3.2.9)
|
125
|
+
actionpack (= 3.2.9)
|
126
|
+
activesupport (= 3.2.9)
|
127
|
+
rack-ssl (~> 1.3.2)
|
128
|
+
rake (>= 0.8.7)
|
129
|
+
rdoc (~> 3.4)
|
130
|
+
thor (>= 0.14.6, < 2.0)
|
131
|
+
rake (10.0.3)
|
132
|
+
rdoc (3.12)
|
133
|
+
json (~> 1.4)
|
134
|
+
responders (0.9.3)
|
135
|
+
railties (~> 3.1)
|
136
|
+
rspec-core (2.12.2)
|
137
|
+
rspec-expectations (2.12.1)
|
138
|
+
diff-lcs (~> 1.1.3)
|
139
|
+
rspec-mocks (2.12.1)
|
140
|
+
rspec-rails (2.12.0)
|
141
|
+
actionpack (>= 3.0)
|
142
|
+
activesupport (>= 3.0)
|
143
|
+
railties (>= 3.0)
|
144
|
+
rspec-core (~> 2.12.0)
|
145
|
+
rspec-expectations (~> 2.12.0)
|
146
|
+
rspec-mocks (~> 2.12.0)
|
147
|
+
rubyzip (0.9.9)
|
148
|
+
selenium-webdriver (2.27.2)
|
149
|
+
childprocess (>= 0.2.5)
|
150
|
+
libwebsocket (~> 0.1.3)
|
151
|
+
multi_json (~> 1.0)
|
152
|
+
rubyzip
|
153
|
+
simple_form (2.0.4)
|
154
|
+
actionpack (~> 3.0)
|
155
|
+
activemodel (~> 3.0)
|
156
|
+
sprockets (2.2.2)
|
157
|
+
hike (~> 1.2)
|
158
|
+
multi_json (~> 1.0)
|
159
|
+
rack (~> 1.0)
|
160
|
+
tilt (~> 1.1, != 1.3.0)
|
161
|
+
sqlite3 (1.3.6)
|
162
|
+
thor (0.16.0)
|
163
|
+
tilt (1.3.3)
|
164
|
+
treetop (1.4.12)
|
165
|
+
polyglot
|
166
|
+
polyglot (>= 0.3.1)
|
167
|
+
tzinfo (0.3.35)
|
168
|
+
websocket (1.0.6)
|
169
|
+
will_paginate (3.0.3)
|
170
|
+
xpath (1.0.0)
|
171
|
+
nokogiri (~> 1.3)
|
172
|
+
|
173
|
+
PLATFORMS
|
174
|
+
ruby
|
175
|
+
|
176
|
+
DEPENDENCIES
|
177
|
+
brightcontent-attachments!
|
178
|
+
brightcontent-core!
|
179
|
+
capybara
|
180
|
+
factory_girl_rails
|
181
|
+
launchy
|
182
|
+
rspec-rails
|
183
|
+
sqlite3
|
data/Rakefile
ADDED
@@ -0,0 +1,14 @@
|
|
1
|
+
begin
|
2
|
+
require 'bundler/setup'
|
3
|
+
rescue LoadError
|
4
|
+
puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
|
5
|
+
end
|
6
|
+
|
7
|
+
APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
|
8
|
+
load 'rails/tasks/engine.rake'
|
9
|
+
|
10
|
+
require 'rspec/core/rake_task'
|
11
|
+
RSpec::Core::RakeTask.new(:spec)
|
12
|
+
task :default => :spec
|
13
|
+
|
14
|
+
Bundler::GemHelper.install_tasks
|
File without changes
|
@@ -0,0 +1,14 @@
|
|
1
|
+
//= require jquery-fileupload/basic
|
2
|
+
|
3
|
+
$(function () {
|
4
|
+
|
5
|
+
var request_url = $("#attachable_url").val();
|
6
|
+
|
7
|
+
$('#fileupload').fileupload({
|
8
|
+
done: function (e, data) {
|
9
|
+
$.get(request_url, function(data) {
|
10
|
+
$('#attachments').html(data);
|
11
|
+
});
|
12
|
+
}
|
13
|
+
});
|
14
|
+
});
|
@@ -0,0 +1,21 @@
|
|
1
|
+
require_dependency "brightcontent/application_controller"
|
2
|
+
|
3
|
+
module Brightcontent
|
4
|
+
class AttachmentsController < ApplicationController
|
5
|
+
|
6
|
+
def show
|
7
|
+
@attachments = Attachment.where(attachable_type: params[:type].classify, attachable_id: params[:id])
|
8
|
+
render layout: false
|
9
|
+
end
|
10
|
+
|
11
|
+
def create
|
12
|
+
@attachment = Attachment.new(params.slice(:attachable_id, :attachable_type, :asset))
|
13
|
+
if @attachment.save
|
14
|
+
render json: @attachments.to_json, status: :created
|
15
|
+
else
|
16
|
+
render json: @attachments.errors, status: :unprocessable_entity
|
17
|
+
end
|
18
|
+
end
|
19
|
+
|
20
|
+
end
|
21
|
+
end
|
@@ -0,0 +1,11 @@
|
|
1
|
+
module Brightcontent
|
2
|
+
class Attachment < ActiveRecord::Base
|
3
|
+
attr_accessible :attachable_id, :attachable_type, :asset
|
4
|
+
|
5
|
+
belongs_to :attachable, polymorphic: true
|
6
|
+
has_attached_file :asset
|
7
|
+
delegate :url, to: :asset
|
8
|
+
|
9
|
+
validates :asset, attachment_presence: true
|
10
|
+
end
|
11
|
+
end
|
@@ -0,0 +1,15 @@
|
|
1
|
+
<% if item.persisted? %>
|
2
|
+
<div id="attachments">
|
3
|
+
<% item.attachments.each do |attachment| %>
|
4
|
+
<%= image_tag attachment.url %>
|
5
|
+
<% end %>
|
6
|
+
</div>
|
7
|
+
|
8
|
+
<input id="fileupload" type="file" name="asset" data-url="<%= new_attachment_path %>" multiple>
|
9
|
+
<%= hidden_field_tag "attachable_id", item.id %>
|
10
|
+
<%= hidden_field_tag "attachable_type", item.class.to_s %>
|
11
|
+
<%= hidden_field_tag "attachable_url", attachments_path(item.class.to_s, item.id) %>
|
12
|
+
|
13
|
+
<% else %>
|
14
|
+
First save to enable uploads
|
15
|
+
<% end %>
|
@@ -0,0 +1,27 @@
|
|
1
|
+
$:.push File.expand_path("../lib", __FILE__)
|
2
|
+
|
3
|
+
version = File.read(File.expand_path("../../VERSION",__FILE__)).strip
|
4
|
+
|
5
|
+
Gem::Specification.new do |s|
|
6
|
+
s.name = "brightcontent-attachments"
|
7
|
+
s.version = version
|
8
|
+
s.email = "developers@brightin.nl"
|
9
|
+
s.homepage = "http://brightin.nl"
|
10
|
+
s.summary = "Assets resource for brightcontent"
|
11
|
+
s.description = "Separate attachment resource for brightcontent"
|
12
|
+
s.authors = ["Developers at Brightin"]
|
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 "brightcontent-core", version
|
19
|
+
s.add_dependency "paperclip"
|
20
|
+
s.add_dependency "jquery-fileupload-rails"
|
21
|
+
|
22
|
+
s.add_development_dependency "sqlite3"
|
23
|
+
s.add_development_dependency "rspec-rails"
|
24
|
+
s.add_development_dependency "capybara"
|
25
|
+
s.add_development_dependency "launchy"
|
26
|
+
s.add_development_dependency "factory_girl_rails"
|
27
|
+
end
|
data/config/routes.rb
ADDED
@@ -0,0 +1,19 @@
|
|
1
|
+
class CreateAttachments < ActiveRecord::Migration
|
2
|
+
def self.up
|
3
|
+
create_table :brightcontent_attachments do |t|
|
4
|
+
t.integer :attachable_id
|
5
|
+
t.string :attachable_type
|
6
|
+
t.string :asset_file_name
|
7
|
+
t.string :asset_content_type
|
8
|
+
t.integer :asset_file_size
|
9
|
+
t.datetime :asset_updated_at
|
10
|
+
t.timestamps
|
11
|
+
end
|
12
|
+
add_index :brightcontent_attachments, :attachable_id
|
13
|
+
add_index :brightcontent_attachments, :attachable_type
|
14
|
+
end
|
15
|
+
|
16
|
+
def self.down
|
17
|
+
drop_table :brightcontent_attachments
|
18
|
+
end
|
19
|
+
end
|
@@ -0,0 +1 @@
|
|
1
|
+
require "brightcontent/attachments"
|
@@ -0,0 +1,15 @@
|
|
1
|
+
module Brightcontent
|
2
|
+
module Attachments
|
3
|
+
module Generators
|
4
|
+
class InstallGenerator < Rails::Generators::Base
|
5
|
+
|
6
|
+
desc "Install migrations for Brightcontent Attachments"
|
7
|
+
|
8
|
+
def copy_migrations
|
9
|
+
rake "brightcontent_attachments_engine:install:migrations"
|
10
|
+
end
|
11
|
+
|
12
|
+
end
|
13
|
+
end
|
14
|
+
end
|
15
|
+
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/brightcontent/assets/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.
|