modulate 0.0.1
Sign up to get free protection for your applications and to get access to all the features.
- data/app/controllers/modulate/application_controller.rb +3 -0
- data/app/models/modulate/document.rb +39 -0
- data/app/uploaders/modulate/document_uploader.rb +5 -0
- data/config/routes.rb +5 -0
- data/db/migrate/20130320174022_add_modulate_document_table.rb +27 -0
- data/lib/generators/modulate/USAGE +8 -0
- data/lib/generators/modulate/modulate_generator.rb +33 -0
- data/lib/generators/modulate/templates/_carrierwave.rb +5 -0
- data/lib/generators/modulate/templates/_modulate_attachments.html.haml +11 -0
- data/lib/generators/modulate/templates/_modulate_documents.html.haml +31 -0
- data/lib/modulate.rb +20 -0
- data/lib/modulate/configuration.rb +10 -0
- data/lib/modulate/engine.rb +21 -0
- data/lib/modulate/relation.rb +10 -0
- data/lib/modulate/version.rb +3 -0
- data/lib/tasks/modulate_tasks.rake +4 -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/accounts_controller.rb +23 -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/models/account.rb +5 -0
- data/spec/dummy/app/views/accounts/_modulate_account_documents.html.haml +31 -0
- data/spec/dummy/app/views/accounts/_modulate_attachments.html.haml +11 -0
- data/spec/dummy/app/views/accounts/index.html.haml +0 -0
- data/spec/dummy/app/views/accounts/show.html.erb +1 -0
- data/spec/dummy/app/views/layouts/application.html.erb +16 -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/carrierwave.rb +5 -0
- data/spec/dummy/config/database.yml +19 -0
- data/spec/dummy/config/database.yml.example +19 -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/carrierwave.rb +5 -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 +6 -0
- data/spec/dummy/config/setup_load_paths.rb +13 -0
- data/spec/dummy/db/migrate/20130325151020_create_account_table.rb +13 -0
- data/spec/dummy/db/migrate/20130326150838_add_modulate_document_table.modulate_engine.rb +28 -0
- data/spec/dummy/db/schema.rb +39 -0
- data/spec/dummy/log/development.log +3082 -0
- data/spec/dummy/log/test.log +158 -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/uploads/tmp/20130325-1326-99529-7743/test.txt +1 -0
- data/spec/dummy/public/uploads/tmp/20130325-1339-356-7432/test.txt +1 -0
- data/spec/dummy/public/uploads/tmp/20130325-1346-523-3336/test.txt +1 -0
- data/spec/dummy/public/uploads/tmp/20130325-1356-749-8446/test.txt +1 -0
- data/spec/dummy/public/uploads/tmp/20130325-1400-850-1252/test.txt +1 -0
- data/spec/dummy/public/uploads/tmp/20130325-1415-1419-1757/test.txt +1 -0
- data/spec/dummy/public/uploads/tmp/20130325-1907-5106-0607/test.txt +1 -0
- data/spec/dummy/public/uploads/tmp/20130325-1911-5106-7321/test.txt +1 -0
- data/spec/dummy/public/uploads/tmp/20130325-1912-5106-9847/test.txt +1 -0
- data/spec/dummy/public/uploads/tmp/20130325-1921-5966-2686/test.txt +1 -0
- data/spec/dummy/public/uploads/tmp/20130325-1921-5993-4088/test.txt +1 -0
- data/spec/dummy/public/uploads/tmp/20130325-1925-6117-8582/test.txt +1 -0
- data/spec/dummy/public/uploads/tmp/20130325-1925-6144-5138/test.txt +1 -0
- data/spec/dummy/public/uploads/tmp/20130325-1927-6226-6892/cheat_sheet.txt +45 -0
- data/spec/dummy/public/uploads/tmp/20130325-1929-6226-5235/cheat_sheet.txt +45 -0
- data/spec/dummy/public/uploads/tmp/20130325-1929-6229-8925/cheat_sheet.txt +45 -0
- data/spec/dummy/public/uploads/tmp/20130325-1929-6258-0126/cheat_sheet.txt +45 -0
- data/spec/dummy/public/uploads/tmp/20130325-1930-6203-2358/cheat_sheet.txt +45 -0
- data/spec/dummy/public/uploads/tmp/20130325-1930-6226-1942/cheat_sheet.txt +45 -0
- data/spec/dummy/public/uploads/tmp/20130325-1930-6226-6311/cheat_sheet.txt +45 -0
- data/spec/dummy/public/uploads/tmp/20130325-1931-6258-4650/cheat_sheet.txt +45 -0
- data/spec/dummy/public/uploads/tmp/20130325-1932-6229-3505/cheat_sheet.txt +45 -0
- data/spec/dummy/public/uploads/tmp/20130325-1959-6759-5643/test.txt +1 -0
- data/spec/dummy/public/uploads/tmp/20130325-2000-6796-5968/test.txt +1 -0
- data/spec/dummy/public/uploads/tmp/20130325-2011-7688-7128/cheat_sheet.txt +45 -0
- data/spec/dummy/public/uploads/tmp/20130326-1409-11412-4323/test.txt +1 -0
- data/spec/dummy/public/uploads/tmp/20130326-1410-11453-4835/test.txt +1 -0
- data/spec/dummy/public/uploads/tmp/20130326-1411-11541-3107/test.txt +1 -0
- data/spec/dummy/script/rails +6 -0
- data/spec/dummy/tmp/cache/assets/CD8/370/sprockets%2F357970feca3ac29060c1e3861e2c0953 +0 -0
- data/spec/dummy/tmp/cache/assets/CE1/F20/sprockets%2F27802e706f9b4a4cb47f23279b8ef112 +0 -0
- data/spec/dummy/tmp/cache/assets/D32/A10/sprockets%2F13fe41fee1fe35b49d145bcc06610705 +0 -0
- data/spec/dummy/tmp/cache/assets/D4E/1B0/sprockets%2Ff7cbd26ba1d28d48de824f0e94586655 +0 -0
- data/spec/dummy/tmp/cache/assets/D5A/EA0/sprockets%2Fd771ace226fc8215a3572e0aa35bb0d6 +0 -0
- data/spec/dummy/tmp/cache/assets/D8B/5A0/sprockets%2Fd3f389f822beaa012aea0e1608a7a72c +0 -0
- data/spec/dummy/tmp/cache/assets/D9F/9E0/sprockets%2Ffa7ea1d234b86f62fd44bcd872e804f0 +0 -0
- data/spec/dummy/tmp/cache/assets/DDC/400/sprockets%2Fcffd775d018f68ce5dba1ee0d951a994 +0 -0
- data/spec/dummy/tmp/cache/assets/E04/890/sprockets%2F2f5173deea6c795b8fdde723bb4b63af +0 -0
- data/spec/dummy/tmp/cache/assets/E46/F00/sprockets%2Fef28af54ec693affaad6788eac6597af +0 -0
- data/spec/dummy/tmp/capybara/capybara-20130325113329863132478.html +15 -0
- data/spec/dummy/tmp/capybara/capybara-201303251136086016711973.html +43 -0
- data/spec/dummy/tmp/capybara/capybara-2013032511414321142326.html +43 -0
- data/spec/dummy/tmp/capybara/capybara-20130325114349437448737.html +43 -0
- data/spec/dummy/tmp/capybara/capybara-201303251145079289531432.html +43 -0
- data/spec/dummy/tmp/capybara/capybara-201303251146231982487841.html +43 -0
- data/spec/dummy/tmp/capybara/capybara-201303251501229219755210.html +43 -0
- data/spec/dummy/tmp/capybara/capybara-201303251504055386888420.html +43 -0
- data/spec/dummy/tmp/restart.txt +0 -0
- data/spec/factories/account_factory.rb +6 -0
- data/spec/features/modulate_spec.rb +14 -0
- data/spec/fixtures/test.txt +1 -0
- data/spec/modulate/configuration_spec.rb +34 -0
- data/spec/modulate/relation_spec.rb +40 -0
- data/spec/modulate_spec.rb +55 -0
- data/spec/spec_helper.rb +22 -0
- metadata +405 -0
@@ -0,0 +1,39 @@
|
|
1
|
+
class Modulate::Document < ActiveRecord::Base
|
2
|
+
|
3
|
+
attr_accessible :label, :public, :attachment
|
4
|
+
|
5
|
+
self.table_name = :modulate_documents
|
6
|
+
|
7
|
+
mount_uploader :attachment, Modulate::DocumentUploader
|
8
|
+
|
9
|
+
validates :attachable_id, :attachable_type, :bucket, :key, :filename, :content_type, :attachment, presence: true
|
10
|
+
validates :key, uniqueness: {scope: :bucket}
|
11
|
+
|
12
|
+
belongs_to :attachable, polymorphic: true
|
13
|
+
|
14
|
+
def key
|
15
|
+
return if filename.blank? || attachable.blank? || attachable.id.blank?
|
16
|
+
self[:key] ||= "#{attachable.id}-#{filename}"
|
17
|
+
end
|
18
|
+
|
19
|
+
def bucket
|
20
|
+
return if attachable_type.blank?
|
21
|
+
self[:bucket] ||= "#{Modulate.application_namespace}::#{attachable_type}"
|
22
|
+
end
|
23
|
+
|
24
|
+
def filename
|
25
|
+
return if attachment.file.blank?
|
26
|
+
self[:filename] ||= File.basename(attachment.file.file)
|
27
|
+
end
|
28
|
+
|
29
|
+
def content_type=(content_type)
|
30
|
+
return unless attachment.file
|
31
|
+
self[:content_type] = attachment.file.content_type = content_type
|
32
|
+
end
|
33
|
+
|
34
|
+
def content_type
|
35
|
+
return unless attachment.file
|
36
|
+
self[:content_type] ||= attachment.file.content_type
|
37
|
+
end
|
38
|
+
|
39
|
+
end
|
data/config/routes.rb
ADDED
@@ -0,0 +1,27 @@
|
|
1
|
+
class AddModulateDocumentTable < ActiveRecord::Migration
|
2
|
+
def up
|
3
|
+
|
4
|
+
create_table :modulate_documents do |z|
|
5
|
+
z.integer :attached_by_id
|
6
|
+
z.integer :attachable_id, null: false
|
7
|
+
z.string :attachable_type, null: false
|
8
|
+
z.string :attachment, null: false
|
9
|
+
z.string :content_type, null: false
|
10
|
+
z.string :filename, null: false
|
11
|
+
z.string :bucket, null: false
|
12
|
+
z.string :key, null: false
|
13
|
+
z.string :label
|
14
|
+
z.boolean :public, null: false, default: 0
|
15
|
+
|
16
|
+
z.timestamps
|
17
|
+
end
|
18
|
+
|
19
|
+
add_index :modulate_documents, :key, unique: true
|
20
|
+
|
21
|
+
end
|
22
|
+
|
23
|
+
def down
|
24
|
+
drop_table :modulate_documents
|
25
|
+
end
|
26
|
+
|
27
|
+
end
|
@@ -0,0 +1,33 @@
|
|
1
|
+
class ModulateGenerator < Rails::Generators::Base
|
2
|
+
source_root File.expand_path('../templates', __FILE__)
|
3
|
+
|
4
|
+
desc "This generator will add document uploading functionality to a model you specify and create two views"
|
5
|
+
|
6
|
+
argument :model_name, type: :string, required: true
|
7
|
+
|
8
|
+
def edit_model
|
9
|
+
line = "class #{model_name.constantize} < ActiveRecord::Base"
|
10
|
+
gsub_file "app/models/#{model_name.underscore}.rb", /(#{Regexp.escape(line)})/mi do |match|
|
11
|
+
"#{match}\n modulate\n"
|
12
|
+
end
|
13
|
+
end
|
14
|
+
|
15
|
+
def copy_view_files
|
16
|
+
template "_modulate_documents.html.haml", "app/views/#{model_name.underscore}s/_modulate_#{model_name.underscore}_documents.html.haml"
|
17
|
+
template "_modulate_attachments.html.haml", "app/views/#{model_name.underscore}s/_modulate_attachments.html.haml"
|
18
|
+
end
|
19
|
+
|
20
|
+
def copy_initializer
|
21
|
+
copy_file "_carrierwave.rb", "config/initializers/carrierwave.rb"
|
22
|
+
end
|
23
|
+
|
24
|
+
private
|
25
|
+
|
26
|
+
def gsub_file(relative_destination, regexp, *args, &block)
|
27
|
+
path = relative_destination
|
28
|
+
content = File.read(path).gsub(regexp, *args, &block)
|
29
|
+
File.open(path, 'wb') { |file| file.write(content) }
|
30
|
+
end
|
31
|
+
|
32
|
+
end
|
33
|
+
|
@@ -0,0 +1,11 @@
|
|
1
|
+
= semantic_form_for @<%= model_name.underscore %> do |f|
|
2
|
+
= render "modulate_<%= model_name.underscore %>_documents", f: f
|
3
|
+
|
4
|
+
= f.inputs do
|
5
|
+
= f.semantic_fields_for :modulate_documents, @<%= model_name.underscore %>.modulate_documents.build do |d|
|
6
|
+
= d.input(:attachment, as: :file, label: 'Choose document to attach', required: true,
|
7
|
+
input_html: {multiple: true}).sub('[attachment][]', '[attachment]').html_safe
|
8
|
+
|
9
|
+
= f.actions do
|
10
|
+
= f.action :submit, as: 'button', button_html: {class: 'btn btn-primary'}
|
11
|
+
= f.action :cancel, as: 'link', :label => "Cancel"
|
@@ -0,0 +1,31 @@
|
|
1
|
+
%table.table.table-bordered.table-compressed
|
2
|
+
%thead
|
3
|
+
%tr
|
4
|
+
%th Label
|
5
|
+
%th File Name
|
6
|
+
%th Content Type
|
7
|
+
%th Uploaded At
|
8
|
+
%th Public
|
9
|
+
%th
|
10
|
+
%th
|
11
|
+
%tbody
|
12
|
+
- if @<%= model_name.underscore %>.modulate_documents.any?
|
13
|
+
- @<%= model_name.underscore %>.modulate_documents.each do |document|
|
14
|
+
- next unless document.persisted?
|
15
|
+
= f.fields_for :modulate_documents, document do |d|
|
16
|
+
%tr
|
17
|
+
%td= d.text_field :label
|
18
|
+
%td= document.filename
|
19
|
+
%td= document.content_type
|
20
|
+
%td= I18n.l document.created_at
|
21
|
+
%td= d.check_box :public
|
22
|
+
%td
|
23
|
+
= link_to modulate_document_path(document), rel: 'tooltip', title: 'Download' do
|
24
|
+
%i.icon-download
|
25
|
+
%td
|
26
|
+
= link_to modulate_document_path(document), data: {method: :delete, confirm: "Are you sure?"}, rel: 'tooltip', title: 'Delete' do
|
27
|
+
%i.icon-remove-circle
|
28
|
+
- else
|
29
|
+
%tr
|
30
|
+
%td{colspan: 7}
|
31
|
+
.no-results There are no documents.
|
data/lib/modulate.rb
ADDED
@@ -0,0 +1,20 @@
|
|
1
|
+
require "modulate/engine"
|
2
|
+
|
3
|
+
module Modulate
|
4
|
+
|
5
|
+
extend self
|
6
|
+
|
7
|
+
def application_namespace
|
8
|
+
Rails.application.class.name.split('::').first
|
9
|
+
end
|
10
|
+
|
11
|
+
def configuration
|
12
|
+
@configuration || configure
|
13
|
+
end
|
14
|
+
|
15
|
+
def configure
|
16
|
+
@configuration = Configuration.new
|
17
|
+
yield(@configuration) if block_given?
|
18
|
+
@configuration
|
19
|
+
end
|
20
|
+
end
|
@@ -0,0 +1,21 @@
|
|
1
|
+
require 'carrierwave/riak'
|
2
|
+
require 'modulate/relation'
|
3
|
+
require 'modulate/configuration'
|
4
|
+
|
5
|
+
module Modulate
|
6
|
+
|
7
|
+
class Engine < ::Rails::Engine
|
8
|
+
|
9
|
+
config.to_prepare do
|
10
|
+
ActiveRecord::Base.extend Modulate::Relation
|
11
|
+
end
|
12
|
+
|
13
|
+
initializer "modulate.carrierwave.riak" do
|
14
|
+
CarrierWave.configure do |config|
|
15
|
+
config.storage = :riak
|
16
|
+
end
|
17
|
+
end
|
18
|
+
|
19
|
+
end
|
20
|
+
|
21
|
+
end
|
@@ -0,0 +1,10 @@
|
|
1
|
+
module Modulate::Relation
|
2
|
+
|
3
|
+
def modulate(name=:modulate_documents, options={})
|
4
|
+
has_many name, {as: :attachable, class_name: "Modulate::Document"}.reverse_merge(options)
|
5
|
+
accepts_nested_attributes_for name
|
6
|
+
attr_accessible :"#{name}_attributes"
|
7
|
+
attr_accessor :"#{Modulate.configuration.user_method}" unless Modulate.configuration.user_method == nil
|
8
|
+
end
|
9
|
+
|
10
|
+
end
|
@@ -0,0 +1,261 @@
|
|
1
|
+
== Welcome to Rails
|
2
|
+
|
3
|
+
Rails is a web-application framework that includes everything needed to create
|
4
|
+
database-backed web applications according to the Model-View-Control pattern.
|
5
|
+
|
6
|
+
This pattern splits the view (also called the presentation) into "dumb"
|
7
|
+
templates that are primarily responsible for inserting pre-built data in between
|
8
|
+
HTML tags. The model contains the "smart" domain objects (such as Account,
|
9
|
+
Product, Person, Post) that holds all the business logic and knows how to
|
10
|
+
persist themselves to a database. The controller handles the incoming requests
|
11
|
+
(such as Save New Account, Update Product, Show Post) by manipulating the model
|
12
|
+
and directing data to the view.
|
13
|
+
|
14
|
+
In Rails, the model is handled by what's called an object-relational mapping
|
15
|
+
layer entitled Active Record. This layer allows you to present the data from
|
16
|
+
database rows as objects and embellish these data objects with business logic
|
17
|
+
methods. You can read more about Active Record in
|
18
|
+
link:files/vendor/rails/activerecord/README.html.
|
19
|
+
|
20
|
+
The controller and view are handled by the Action Pack, which handles both
|
21
|
+
layers by its two parts: Action View and Action Controller. These two layers
|
22
|
+
are bundled in a single package due to their heavy interdependence. This is
|
23
|
+
unlike the relationship between the Active Record and Action Pack that is much
|
24
|
+
more separate. Each of these packages can be used independently outside of
|
25
|
+
Rails. You can read more about Action Pack in
|
26
|
+
link:files/vendor/rails/actionpack/README.html.
|
27
|
+
|
28
|
+
|
29
|
+
== Getting Started
|
30
|
+
|
31
|
+
1. At the command prompt, create a new Rails application:
|
32
|
+
<tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
|
33
|
+
|
34
|
+
2. Change directory to <tt>myapp</tt> and start the web server:
|
35
|
+
<tt>cd myapp; rails server</tt> (run with --help for options)
|
36
|
+
|
37
|
+
3. Go to http://localhost:3000/ and you'll see:
|
38
|
+
"Welcome aboard: You're riding Ruby on Rails!"
|
39
|
+
|
40
|
+
4. Follow the guidelines to start developing your application. You can find
|
41
|
+
the following resources handy:
|
42
|
+
|
43
|
+
* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
|
44
|
+
* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
|
45
|
+
|
46
|
+
|
47
|
+
== Debugging Rails
|
48
|
+
|
49
|
+
Sometimes your application goes wrong. Fortunately there are a lot of tools that
|
50
|
+
will help you debug it and get it back on the rails.
|
51
|
+
|
52
|
+
First area to check is the application log files. Have "tail -f" commands
|
53
|
+
running on the server.log and development.log. Rails will automatically display
|
54
|
+
debugging and runtime information to these files. Debugging info will also be
|
55
|
+
shown in the browser on requests from 127.0.0.1.
|
56
|
+
|
57
|
+
You can also log your own messages directly into the log file from your code
|
58
|
+
using the Ruby logger class from inside your controllers. Example:
|
59
|
+
|
60
|
+
class WeblogController < ActionController::Base
|
61
|
+
def destroy
|
62
|
+
@weblog = Weblog.find(params[:id])
|
63
|
+
@weblog.destroy
|
64
|
+
logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
|
65
|
+
end
|
66
|
+
end
|
67
|
+
|
68
|
+
The result will be a message in your log file along the lines of:
|
69
|
+
|
70
|
+
Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
|
71
|
+
|
72
|
+
More information on how to use the logger is at http://www.ruby-doc.org/core/
|
73
|
+
|
74
|
+
Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
|
75
|
+
several books available online as well:
|
76
|
+
|
77
|
+
* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
|
78
|
+
* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
|
79
|
+
|
80
|
+
These two books will bring you up to speed on the Ruby language and also on
|
81
|
+
programming in general.
|
82
|
+
|
83
|
+
|
84
|
+
== Debugger
|
85
|
+
|
86
|
+
Debugger support is available through the debugger command when you start your
|
87
|
+
Mongrel or WEBrick server with --debugger. This means that you can break out of
|
88
|
+
execution at any point in the code, investigate and change the model, and then,
|
89
|
+
resume execution! You need to install ruby-debug to run the server in debugging
|
90
|
+
mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
|
91
|
+
|
92
|
+
class WeblogController < ActionController::Base
|
93
|
+
def index
|
94
|
+
@posts = Post.all
|
95
|
+
debugger
|
96
|
+
end
|
97
|
+
end
|
98
|
+
|
99
|
+
So the controller will accept the action, run the first line, then present you
|
100
|
+
with a IRB prompt in the server window. Here you can do things like:
|
101
|
+
|
102
|
+
>> @posts.inspect
|
103
|
+
=> "[#<Post:0x14a6be8
|
104
|
+
@attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
|
105
|
+
#<Post:0x14a6620
|
106
|
+
@attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
|
107
|
+
>> @posts.first.title = "hello from a debugger"
|
108
|
+
=> "hello from a debugger"
|
109
|
+
|
110
|
+
...and even better, you can examine how your runtime objects actually work:
|
111
|
+
|
112
|
+
>> f = @posts.first
|
113
|
+
=> #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
|
114
|
+
>> f.
|
115
|
+
Display all 152 possibilities? (y or n)
|
116
|
+
|
117
|
+
Finally, when you're ready to resume execution, you can enter "cont".
|
118
|
+
|
119
|
+
|
120
|
+
== Console
|
121
|
+
|
122
|
+
The console is a Ruby shell, which allows you to interact with your
|
123
|
+
application's domain model. Here you'll have all parts of the application
|
124
|
+
configured, just like it is when the application is running. You can inspect
|
125
|
+
domain models, change values, and save to the database. Starting the script
|
126
|
+
without arguments will launch it in the development environment.
|
127
|
+
|
128
|
+
To start the console, run <tt>rails console</tt> from the application
|
129
|
+
directory.
|
130
|
+
|
131
|
+
Options:
|
132
|
+
|
133
|
+
* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
|
134
|
+
made to the database.
|
135
|
+
* Passing an environment name as an argument will load the corresponding
|
136
|
+
environment. Example: <tt>rails console production</tt>.
|
137
|
+
|
138
|
+
To reload your controllers and models after launching the console run
|
139
|
+
<tt>reload!</tt>
|
140
|
+
|
141
|
+
More information about irb can be found at:
|
142
|
+
link:http://www.rubycentral.org/pickaxe/irb.html
|
143
|
+
|
144
|
+
|
145
|
+
== dbconsole
|
146
|
+
|
147
|
+
You can go to the command line of your database directly through <tt>rails
|
148
|
+
dbconsole</tt>. You would be connected to the database with the credentials
|
149
|
+
defined in database.yml. Starting the script without arguments will connect you
|
150
|
+
to the development database. Passing an argument will connect you to a different
|
151
|
+
database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
|
152
|
+
PostgreSQL and SQLite 3.
|
153
|
+
|
154
|
+
== Description of Contents
|
155
|
+
|
156
|
+
The default directory structure of a generated Ruby on Rails application:
|
157
|
+
|
158
|
+
|-- app
|
159
|
+
| |-- assets
|
160
|
+
| | |-- images
|
161
|
+
| | |-- javascripts
|
162
|
+
| | `-- stylesheets
|
163
|
+
| |-- controllers
|
164
|
+
| |-- helpers
|
165
|
+
| |-- mailers
|
166
|
+
| |-- models
|
167
|
+
| `-- views
|
168
|
+
| `-- layouts
|
169
|
+
|-- config
|
170
|
+
| |-- environments
|
171
|
+
| |-- initializers
|
172
|
+
| `-- locales
|
173
|
+
|-- db
|
174
|
+
|-- doc
|
175
|
+
|-- lib
|
176
|
+
| |-- assets
|
177
|
+
| `-- tasks
|
178
|
+
|-- log
|
179
|
+
|-- public
|
180
|
+
|-- script
|
181
|
+
|-- test
|
182
|
+
| |-- fixtures
|
183
|
+
| |-- functional
|
184
|
+
| |-- integration
|
185
|
+
| |-- performance
|
186
|
+
| `-- unit
|
187
|
+
|-- tmp
|
188
|
+
| `-- cache
|
189
|
+
| `-- assets
|
190
|
+
`-- vendor
|
191
|
+
|-- assets
|
192
|
+
| |-- javascripts
|
193
|
+
| `-- stylesheets
|
194
|
+
`-- plugins
|
195
|
+
|
196
|
+
app
|
197
|
+
Holds all the code that's specific to this particular application.
|
198
|
+
|
199
|
+
app/assets
|
200
|
+
Contains subdirectories for images, stylesheets, and JavaScript files.
|
201
|
+
|
202
|
+
app/controllers
|
203
|
+
Holds controllers that should be named like weblogs_controller.rb for
|
204
|
+
automated URL mapping. All controllers should descend from
|
205
|
+
ApplicationController which itself descends from ActionController::Base.
|
206
|
+
|
207
|
+
app/models
|
208
|
+
Holds models that should be named like post.rb. Models descend from
|
209
|
+
ActiveRecord::Base by default.
|
210
|
+
|
211
|
+
app/views
|
212
|
+
Holds the template files for the view that should be named like
|
213
|
+
weblogs/index.html.erb for the WeblogsController#index action. All views use
|
214
|
+
eRuby syntax by default.
|
215
|
+
|
216
|
+
app/views/layouts
|
217
|
+
Holds the template files for layouts to be used with views. This models the
|
218
|
+
common header/footer method of wrapping views. In your views, define a layout
|
219
|
+
using the <tt>layout :default</tt> and create a file named default.html.erb.
|
220
|
+
Inside default.html.erb, call <% yield %> to render the view using this
|
221
|
+
layout.
|
222
|
+
|
223
|
+
app/helpers
|
224
|
+
Holds view helpers that should be named like weblogs_helper.rb. These are
|
225
|
+
generated for you automatically when using generators for controllers.
|
226
|
+
Helpers can be used to wrap functionality for your views into methods.
|
227
|
+
|
228
|
+
config
|
229
|
+
Configuration files for the Rails environment, the routing map, the database,
|
230
|
+
and other dependencies.
|
231
|
+
|
232
|
+
db
|
233
|
+
Contains the database schema in schema.rb. db/migrate contains all the
|
234
|
+
sequence of Migrations for your schema.
|
235
|
+
|
236
|
+
doc
|
237
|
+
This directory is where your application documentation will be stored when
|
238
|
+
generated using <tt>rake doc:app</tt>
|
239
|
+
|
240
|
+
lib
|
241
|
+
Application specific libraries. Basically, any kind of custom code that
|
242
|
+
doesn't belong under controllers, models, or helpers. This directory is in
|
243
|
+
the load path.
|
244
|
+
|
245
|
+
public
|
246
|
+
The directory available for the web server. Also contains the dispatchers and the
|
247
|
+
default HTML files. This should be set as the DOCUMENT_ROOT of your web
|
248
|
+
server.
|
249
|
+
|
250
|
+
script
|
251
|
+
Helper scripts for automation and generation.
|
252
|
+
|
253
|
+
test
|
254
|
+
Unit and functional tests along with fixtures. When using the rails generate
|
255
|
+
command, template test files will be generated for you and placed in this
|
256
|
+
directory.
|
257
|
+
|
258
|
+
vendor
|
259
|
+
External libraries that the application depends on. Also includes the plugins
|
260
|
+
subdirectory. If the app has frozen rails, those gems also go here, under
|
261
|
+
vendor/rails/. This directory is in the load path.
|