g5_sibling_deployer_engine 0.2.6

Sign up to get free protection for your applications and to get access to all the features.
Files changed (91) hide show
  1. checksums.yaml +15 -0
  2. data/.gitignore +19 -0
  3. data/.rspec +2 -0
  4. data/.travis.yml +13 -0
  5. data/Gemfile +6 -0
  6. data/Guardfile +24 -0
  7. data/LICENSE.txt +22 -0
  8. data/README.md +130 -0
  9. data/Rakefile +2 -0
  10. data/app/controllers/siblings/application_controller.rb +2 -0
  11. data/app/controllers/siblings/deploys_controller.rb +5 -0
  12. data/app/controllers/siblings/instructions_controller.rb +5 -0
  13. data/app/controllers/siblings_controller.rb +14 -0
  14. data/app/controllers/webhooks_controller.rb +6 -0
  15. data/app/models/sibling/deploy.rb +59 -0
  16. data/app/models/sibling/instruction.rb +60 -0
  17. data/app/models/sibling.rb +56 -0
  18. data/app/views/siblings/_nav.html.erb +5 -0
  19. data/app/views/siblings/deploys/index.html.erb +15 -0
  20. data/app/views/siblings/index.html.erb +16 -0
  21. data/app/views/siblings/instructions/index.html.erb +13 -0
  22. data/app/workers/sibling_consumer.rb +15 -0
  23. data/app/workers/sibling_deployer.rb +40 -0
  24. data/app/workers/sibling_instruction_consumer.rb +15 -0
  25. data/config/initializers/github_heroku_deployer.rb +7 -0
  26. data/config/initializers/resque.rb +12 -0
  27. data/config/initializers/table_cloth.rb +3 -0
  28. data/config/routes.rb +12 -0
  29. data/db/migrate/001_create_siblings.rb +14 -0
  30. data/db/migrate/002_create_sibling_deploys.rb +15 -0
  31. data/db/migrate/003_create_sibling_instructions.rb +11 -0
  32. data/g5_sibling_deployer_engine.gemspec +34 -0
  33. data/lib/g5_sibling_deployer_engine/engine.rb +4 -0
  34. data/lib/g5_sibling_deployer_engine/version.rb +3 -0
  35. data/lib/g5_sibling_deployer_engine.rb +12 -0
  36. data/lib/tasks/g5_sibling_deployer_engine_tasks.rake +16 -0
  37. data/lib/tasks/resque.rake +8 -0
  38. data/main_app_v2.html +38 -0
  39. data/spec/controllers/siblings/deploys_controller_spec.rb +12 -0
  40. data/spec/controllers/siblings/instructions_controller_spec.rb +12 -0
  41. data/spec/controllers/siblings_controller_spec.rb +28 -0
  42. data/spec/controllers/webhooks_controller_spec.rb +13 -0
  43. data/spec/dummy/README.rdoc +261 -0
  44. data/spec/dummy/Rakefile +7 -0
  45. data/spec/dummy/app/assets/javascripts/application.js +15 -0
  46. data/spec/dummy/app/assets/stylesheets/application.css +13 -0
  47. data/spec/dummy/app/controllers/application_controller.rb +3 -0
  48. data/spec/dummy/app/helpers/application_helper.rb +2 -0
  49. data/spec/dummy/app/mailers/.gitkeep +0 -0
  50. data/spec/dummy/app/models/.gitkeep +0 -0
  51. data/spec/dummy/app/views/layouts/application.html.erb +14 -0
  52. data/spec/dummy/config/application.rb +65 -0
  53. data/spec/dummy/config/boot.rb +10 -0
  54. data/spec/dummy/config/database.yml +25 -0
  55. data/spec/dummy/config/environment.rb +5 -0
  56. data/spec/dummy/config/environments/development.rb +37 -0
  57. data/spec/dummy/config/environments/production.rb +67 -0
  58. data/spec/dummy/config/environments/test.rb +37 -0
  59. data/spec/dummy/config/initializers/backtrace_silencers.rb +7 -0
  60. data/spec/dummy/config/initializers/inflections.rb +15 -0
  61. data/spec/dummy/config/initializers/mime_types.rb +5 -0
  62. data/spec/dummy/config/initializers/secret_token.rb +7 -0
  63. data/spec/dummy/config/initializers/session_store.rb +8 -0
  64. data/spec/dummy/config/initializers/wrap_parameters.rb +14 -0
  65. data/spec/dummy/config/locales/en.yml +5 -0
  66. data/spec/dummy/config/routes.rb +58 -0
  67. data/spec/dummy/config.ru +4 -0
  68. data/spec/dummy/db/development.sqlite3 +0 -0
  69. data/spec/dummy/db/schema.rb +47 -0
  70. data/spec/dummy/db/test.sqlite3 +0 -0
  71. data/spec/dummy/lib/assets/.gitkeep +0 -0
  72. data/spec/dummy/log/.gitkeep +0 -0
  73. data/spec/dummy/public/404.html +26 -0
  74. data/spec/dummy/public/422.html +26 -0
  75. data/spec/dummy/public/500.html +25 -0
  76. data/spec/dummy/public/favicon.ico +0 -0
  77. data/spec/dummy/script/rails +6 -0
  78. data/spec/lib/g5_sibling_deployer_engine_spec.rb +8 -0
  79. data/spec/models/sibling/deploy_spec.rb +61 -0
  80. data/spec/models/sibling/instruction_spec.rb +63 -0
  81. data/spec/models/sibling_spec.rb +73 -0
  82. data/spec/routing/routes_spec.rb +31 -0
  83. data/spec/spec_helper.rb +42 -0
  84. data/spec/support/g5-configurator-app.html +98 -0
  85. data/spec/support/g5-configurator-entries.html +387 -0
  86. data/spec/support/instructions.html +51 -0
  87. data/spec/support/main_app.html +87 -0
  88. data/spec/workers/sibling_consumer_spec.rb +21 -0
  89. data/spec/workers/sibling_deployer_spec.rb +45 -0
  90. data/spec/workers/sibling_instruction_consumer_spec.rb +15 -0
  91. metadata +352 -0
@@ -0,0 +1,5 @@
1
+ <ul class="nav nav-pills">
2
+ <li class="<%= page == :siblings ? "active" : nil%>"><%= link_to "Siblings", siblings_path %></li>
3
+ <li class="<%= page == :instructions ? "active" : nil%>"><%= link_to "Instructions", siblings_instructions_path %></li>
4
+ <li class="<%= page == :deploys ? "active" : nil%>"><%= link_to "Deploys", siblings_deploys_path %></li>
5
+ </ul>
@@ -0,0 +1,15 @@
1
+ <% title "Deploys" %>
2
+
3
+ <%= render partial: "siblings/nav", locals: { page: :deploys } %>
4
+
5
+ <%= simple_table_for @siblings_deploys do |t| %>
6
+ <% t.column :id %>
7
+ <% t.column :created_at %>
8
+ <% t.column :heroku_app_name %>
9
+ <% t.column :state %>
10
+ <% t.column :git_repo %>
11
+ <% t.column :heroku_repo %>
12
+ <% t.column :sibling_id %>
13
+ <% t.column :instruction_id %>
14
+ <% t.column :manual %>
15
+ <% end %>
@@ -0,0 +1,16 @@
1
+ <% title "Siblings" %>
2
+
3
+ <%= render partial: "nav", locals: { page: :siblings } %>
4
+
5
+ <%= simple_table_for @siblings do |t| %>
6
+ <% t.column :id %>
7
+ <% t.column :name %>
8
+ <% t.column :heroku_app_name %>
9
+ <% t.column :git_repo %>
10
+ <% t.column :heroku_repo %>
11
+ <% t.actions do %>
12
+ <% action { |sibling| link_to "UID", sibling.uid, class: "btn" } %>
13
+ <% action { |sibling| sibling.main_app? ? "" :
14
+ link_to("Deploy", deploy_sibling_path(sibling), class: "btn", method: :post) } %>
15
+ <% end %>
16
+ <% end %>
@@ -0,0 +1,13 @@
1
+ <% title "Instructions" %>
2
+
3
+ <%= render partial: "siblings/nav", locals: { page: :instructions } %>
4
+
5
+ <%= simple_table_for @siblings_instructions do |t| %>
6
+ <% t.column :id %>
7
+ <% t.column :name %>
8
+ <% t.column :published_at %>
9
+ <% t.column :created_at %>
10
+ <% t.actions do %>
11
+ <% action { |instruction| link_to "UID", instruction.uid, class: "btn" } %>
12
+ <% end %>
13
+ <% end %>
@@ -0,0 +1,15 @@
1
+ class SiblingConsumer
2
+ extend HerokuResqueAutoscaler if Rails.env.production?
3
+ @queue = :consumer
4
+
5
+ def self.perform
6
+ Rails.logger.info "Starting sibling consumption..."
7
+
8
+ Sibling.consume_main_app_hcard
9
+
10
+ Rails.logger.info "Succeeded consuming siblings."
11
+ rescue StandardError => e
12
+ Rails.logger.info "Failed consuming siblings."
13
+ raise e
14
+ end
15
+ end
@@ -0,0 +1,40 @@
1
+ class SiblingDeployer
2
+ extend HerokuResqueAutoscaler if Rails.env.production?
3
+ @queue = :deployer
4
+ attr_reader :app, :retries
5
+
6
+ def self.perform(app_id)
7
+ self.new(app_id).perform
8
+ end
9
+
10
+ def initialize(app_id)
11
+ @app = Sibling::Deploy.find(app_id)
12
+ @retries = 0
13
+ end
14
+
15
+ def perform
16
+ Rails.logger.info "Starting deploying sibling..."
17
+ @app.deploy
18
+ Rails.logger.info "Succeeded deploying sibling."
19
+ rescue GithubHerokuDeployer::CommandException,
20
+ Heroku::API::Errors::ErrorWithResponse => e
21
+ if should_retry?
22
+ Rails.logger.info "Retrying deploying sibling..."
23
+ increment_retries
24
+ retry
25
+ else
26
+ raise e
27
+ end
28
+ rescue StandardError => e
29
+ Rails.logger.info "Failed deploying sibling."
30
+ raise e
31
+ end
32
+
33
+ def should_retry?
34
+ @retries < 3
35
+ end
36
+
37
+ def increment_retries
38
+ @retries += 1
39
+ end
40
+ end
@@ -0,0 +1,15 @@
1
+ class SiblingInstructionConsumer
2
+ extend HerokuResqueAutoscaler if Rails.env.production?
3
+ @queue = :consumer
4
+
5
+ def self.perform
6
+ Rails.logger.info "Starting instruction feed consumption..."
7
+
8
+ Sibling::Instruction.consume_feed
9
+
10
+ Rails.logger.info "Succeeded consuming instruction feed."
11
+ rescue StandardError => e
12
+ Rails.logger.info "Failed consuming instruction feed."
13
+ raise e
14
+ end
15
+ end
@@ -0,0 +1,7 @@
1
+ GithubHerokuDeployer.configure do |config|
2
+ config.heroku_api_key = ENV["HEROKU_API_KEY"]
3
+ config.heroku_username = ENV["HEROKU_USERNAME"]
4
+ config.id_rsa = ENV["ID_RSA"]
5
+ config.logger = Rails.logger
6
+ config.repo_dir = File.join(Rails.root, "tmp", "repos")
7
+ end
@@ -0,0 +1,12 @@
1
+ # Setup for Heroku
2
+ Resque.redis = ENV["REDISTOGO_URL"] if ENV["REDISTOGO_URL"]
3
+
4
+ # Establish connection to the database before each job
5
+ Resque.before_fork = Proc.new { ActiveRecord::Base.establish_connection }
6
+
7
+ # Require HTTP Basic Auth to view dashboard
8
+ if ENV["RESQUE_HTTP_USER"] && ENV["RESQUE_HTTP_PASSWORD"]
9
+ Resque::Server.use(Rack::Auth::Basic) do |user, password|
10
+ user == ENV["RESQUE_HTTP_USER"] and password == ENV["RESQUE_HTTP_PASSWORD"]
11
+ end
12
+ end
@@ -0,0 +1,3 @@
1
+ TableCloth::Configuration.configure do |config|
2
+ config.table.class = "table table-striped"
3
+ end
data/config/routes.rb ADDED
@@ -0,0 +1,12 @@
1
+ Rails.application.routes.draw do
2
+ resources :siblings, only: [:index] do
3
+ member do
4
+ post "deploy"
5
+ end
6
+ end
7
+
8
+ get "siblings/instructions" => "siblings/instructions#index", as: :siblings_instructions
9
+ get "siblings/deploys" => "siblings/deploys#index", as: :siblings_deploys
10
+
11
+ post "webhooks/g5-configurator" => "webhooks#g5_configurator", as: :g5_configurator_webhook
12
+ end
@@ -0,0 +1,14 @@
1
+ class CreateSiblings < ActiveRecord::Migration
2
+ def change
3
+ create_table :siblings do |t|
4
+ t.string :uid
5
+ t.string :name
6
+ t.string :git_repo
7
+ t.string :heroku_repo
8
+ t.string :heroku_app_name
9
+ t.boolean :main_app
10
+
11
+ t.timestamps
12
+ end
13
+ end
14
+ end
@@ -0,0 +1,15 @@
1
+ class CreateSiblingDeploys < ActiveRecord::Migration
2
+ def change
3
+ create_table :sibling_deploys do |t|
4
+ t.references :sibling
5
+ t.references :instruction
6
+ t.boolean :manual
7
+ t.string :state
8
+ t.string :git_repo
9
+ t.string :heroku_repo
10
+ t.string :heroku_app_name
11
+
12
+ t.timestamps
13
+ end
14
+ end
15
+ end
@@ -0,0 +1,11 @@
1
+ class CreateSiblingInstructions < ActiveRecord::Migration
2
+ def change
3
+ create_table :sibling_instructions do |t|
4
+ t.string :uid
5
+ t.string :name
6
+ t.datetime :published_at
7
+
8
+ t.timestamps
9
+ end
10
+ end
11
+ end
@@ -0,0 +1,34 @@
1
+ # -*- encoding: utf-8 -*-
2
+ $:.push File.expand_path("../lib", __FILE__)
3
+
4
+ # Maintain your gem's version:
5
+ require "g5_sibling_deployer_engine/version"
6
+
7
+ # Describe your gem and declare its dependencies:
8
+ Gem::Specification.new do |gem|
9
+ gem.name = "g5_sibling_deployer_engine"
10
+ gem.version = G5SiblingDeployerEngine::VERSION
11
+ gem.authors = ["Jessica Lynn Suttles"]
12
+ gem.email = ["jlsuttles@gmail.com"]
13
+ gem.description = "Rails Engine for G5 sibling deployers"
14
+ gem.summary = "Rails Engine for G5 sibling deployers"
15
+ gem.homepage = "https://github.com/G5/g5_sibling_deployer_engine"
16
+
17
+ gem.files = `git ls-files`.split($\)
18
+ gem.test_files = gem.files.grep(%r{^(test|spec|features)/})
19
+ gem.require_paths = ["lib"]
20
+
21
+ gem.add_dependency "rails", "~> 3.2.12"
22
+ gem.add_dependency "table_cloth", "~> 0.2.1"
23
+ gem.add_dependency "state_machine", "~> 1.1.2"
24
+ gem.add_dependency "heroku_resque_autoscaler", "~> 0.1.0"
25
+ gem.add_dependency "microformats2", "~> 2.0.0"
26
+ gem.add_dependency "github_heroku_deployer", "~> 0.2.0"
27
+
28
+ gem.add_development_dependency "sqlite3", "~> 1.3.6"
29
+ gem.add_development_dependency "simplecov", "~> 0.7.1"
30
+ gem.add_development_dependency "rspec-rails", "~> 2.12.0"
31
+ gem.add_development_dependency "guard-rspec", "~> 2.1.0"
32
+ gem.add_development_dependency "spork", "~> 0.9.2"
33
+ gem.add_development_dependency "rb-fsevent", "~> 0.9.2"
34
+ end
@@ -0,0 +1,4 @@
1
+ module G5SiblingDeployerEngine
2
+ class Engine < Rails::Engine
3
+ end
4
+ end
@@ -0,0 +1,3 @@
1
+ module G5SiblingDeployerEngine
2
+ VERSION = "0.2.6"
3
+ end
@@ -0,0 +1,12 @@
1
+ require "rails"
2
+ require "table_cloth"
3
+ require "state_machine"
4
+ require "microformats2"
5
+ require "github_heroku_deployer"
6
+ require "heroku_resque_autoscaler"
7
+ require "g5_sibling_deployer_engine/engine"
8
+ require "g5_sibling_deployer_engine/version"
9
+
10
+ module G5SiblingDeployerEngine
11
+ # Your code goes here...
12
+ end
@@ -0,0 +1,16 @@
1
+ namespace :sibling do
2
+ desc "seeds siblings"
3
+ task :consume => :environment do
4
+ Resque.enqueue(SiblingConsumer)
5
+ end
6
+ desc "deploys all siblings"
7
+ task :deploy => :environment do
8
+ Sibling.deploy_all
9
+ end
10
+ namespace :instruction do
11
+ desc "consumes instruction feed"
12
+ task :consume => :environment do
13
+ Resque.enqueue(SiblingInstructionConsumer)
14
+ end
15
+ end
16
+ end
@@ -0,0 +1,8 @@
1
+ require 'resque/tasks'
2
+
3
+ task "resque:setup" => :environment do
4
+ ENV['QUEUE'] = '*'
5
+ end
6
+
7
+ desc "Alias for resque:work (To run workers on Heroku)"
8
+ task "jobs:work" => "resque:work"
data/main_app_v2.html ADDED
@@ -0,0 +1,38 @@
1
+ <dl class="e-g5-app">
2
+
3
+ <dt>Name</dt>
4
+ <dd class="p-name">Foo Bar</dd>
5
+
6
+ <dt>URN</dt>
7
+ <dd class="p-urn">g5-cl-1354738271-3-foo-bar</dd>
8
+
9
+ <dt>URL</dt>
10
+ <dd>
11
+ <a class="u-urn u-url" href="http://g5-configurator.herokuapp.com">
12
+ http://g5-configurator.herokuapp.com
13
+ </a>
14
+ </dd>
15
+
16
+ <dt>Git Repo</dt>
17
+ <dd class="p-g5-git-repo">git@github</dd>
18
+
19
+ <dt>Heroku Repo</dt>
20
+ <dd class="p-g5-heroku-repo">git@heroku</dd>
21
+
22
+ <dt>Heroku App Name</dt>
23
+ <dd class="p-g5-heroku-app-name">g5-cl-1354738271-3-foo-bar</dd>
24
+
25
+ <dt>Client</dt>
26
+ <dd>
27
+ <dl class="e-g5-client">
28
+ <dt>URN</dt>
29
+ <dd class="p-urn">g5-c-1354738271-3-baz</dd>
30
+ <dt>URL</dt>
31
+ <dd>
32
+ <a class="u-urn u-url" href="http://g5-hub.herokuapp.com">
33
+ http://g5-hub.herokuapp.com
34
+ </a>
35
+ </dd>
36
+ </dl>
37
+ </dd>
38
+ </dl>
@@ -0,0 +1,12 @@
1
+ require 'spec_helper'
2
+
3
+ describe Siblings::DeploysController do
4
+ describe "GET index" do
5
+ it "assigns all siblings deploys to @siblings_deploys" do
6
+ siblings_deploys = stub_model(Sibling::Deploy)
7
+ Sibling::Deploy.stub(:order) { [siblings_deploys] }
8
+ get :index
9
+ expect(assigns(:siblings_deploys)).to eq([siblings_deploys])
10
+ end
11
+ end
12
+ end
@@ -0,0 +1,12 @@
1
+ require 'spec_helper'
2
+
3
+ describe Siblings::InstructionsController do
4
+ describe "GET index" do
5
+ it "assigns all siblings instructions to @siblings_instructions" do
6
+ siblings_instructions = stub_model(Sibling::Instruction)
7
+ Sibling::Instruction.stub(:order) { [siblings_instructions] }
8
+ get :index
9
+ expect(assigns(:siblings_instructions)).to eq([siblings_instructions])
10
+ end
11
+ end
12
+ end
@@ -0,0 +1,28 @@
1
+ require 'spec_helper'
2
+
3
+ describe SiblingsController do
4
+ describe "GET index" do
5
+ it "assigns all siblings to @siblings" do
6
+ sibling = stub_model(Sibling)
7
+ Sibling.stub(:all) { [sibling] }
8
+ get :index
9
+ expect(assigns(:siblings)).to eq([sibling])
10
+ end
11
+ end
12
+ describe "#deploy" do
13
+ before :each do
14
+ sibling = stub_model(Sibling)
15
+ Sibling.stub(:find) { sibling }
16
+ end
17
+ it "redirects if deploy succeeds" do
18
+ Sibling.any_instance.stub(:deploy).and_return(true)
19
+ post :deploy, id: 1
20
+ response.should redirect_to(siblings_deploys_path)
21
+ end
22
+ it "redirects if deploy fails" do
23
+ Sibling.any_instance.stub(:deploy).and_return(false)
24
+ post :deploy, id: 1
25
+ response.should redirect_to(siblings_deploys_path)
26
+ end
27
+ end
28
+ end
@@ -0,0 +1,13 @@
1
+ require File.dirname(__FILE__) + '/../spec_helper'
2
+
3
+ describe WebhooksController do
4
+ describe "#g5_configurator" do
5
+ before do
6
+ Sibling::Instruction.stub(:async_consume_feed).and_return(true)
7
+ end
8
+ it "queues feed consumption" do
9
+ Sibling::Instruction.should_receive(:async_consume_feed).once
10
+ post :g5_configurator
11
+ end
12
+ end
13
+ 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
+ | `-- 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.