got_fixed 0.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/LICENSE.txt +22 -0
- data/README.rdoc +3 -0
- data/Rakefile +21 -0
- data/app/assets/javascripts/got_fixed/application.js +15 -0
- data/app/assets/javascripts/got_fixed/issues.js +2 -0
- data/app/assets/stylesheets/got_fixed/application.css +13 -0
- data/app/assets/stylesheets/got_fixed/issues.css +4 -0
- data/app/assets/stylesheets/scaffold.css +56 -0
- data/app/controllers/got_fixed/application_controller.rb +4 -0
- data/app/controllers/got_fixed/issues_controller.rb +84 -0
- data/app/helpers/got_fixed/application_helper.rb +4 -0
- data/app/helpers/got_fixed/issues_helper.rb +4 -0
- data/app/mailers/got_fixed/user_mailer.rb +16 -0
- data/app/models/got_fixed/issue.rb +36 -0
- data/app/models/got_fixed/user.rb +25 -0
- data/app/views/got_fixed/issues/index.html.erb +21 -0
- data/app/views/got_fixed/issues/subscribe.js.erb +1 -0
- data/app/views/got_fixed/user_mailer/issue_got_fixed_email.text.erb +13 -0
- data/app/views/layouts/got_fixed/application.html.erb +14 -0
- data/config/initializers/got_fixed.rb +17 -0
- data/config/routes.rb +12 -0
- data/db/migrate/20130912175851_create_got_fixed_issues.rb +10 -0
- data/db/migrate/20130913195152_add_number_to_got_fixed_issue.rb +6 -0
- data/db/migrate/20130914085003_add_vendor_to_got_fixed_issue.rb +5 -0
- data/db/migrate/20130924121816_create_got_fixed_users.rb +9 -0
- data/db/migrate/20130924123004_has_and_belongs_to_many_issues_user.rb +8 -0
- data/db/migrate/20130929180909_unique_user_emails.rb +5 -0
- data/lib/got_fixed/adapters/github.rb +78 -0
- data/lib/got_fixed/engine.rb +12 -0
- data/lib/got_fixed/issue_factory.rb +11 -0
- data/lib/got_fixed/receivers/github_webhook.rb +21 -0
- data/lib/got_fixed/version.rb +3 -0
- data/lib/got_fixed.rb +10 -0
- data/lib/tasks/auto_annotate_models.rake +34 -0
- data/lib/tasks/got_fixed_tasks.rake +56 -0
- data/spec/controllers/got_fixed/issues_controller_spec.rb +194 -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/views/layouts/application.html.erb +14 -0
- data/spec/dummy/config/application.rb +65 -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 +39 -0
- data/spec/dummy/config/environments/production.rb +67 -0
- data/spec/dummy/config/environments/test.rb +36 -0
- data/spec/dummy/config/got_fixed.yml +15 -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/routes.rb +5 -0
- data/spec/dummy/config.ru +4 -0
- data/spec/dummy/db/development.sqlite3 +0 -0
- data/spec/dummy/db/schema.rb +44 -0
- data/spec/dummy/db/test.sqlite3 +0 -0
- data/spec/dummy/log/development.log +3113 -0
- data/spec/dummy/log/production.log +0 -0
- data/spec/dummy/log/test.log +11243 -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/dummy/tmp/cache/assets/development/sprockets/0ec0faefe9b37b9024c6fb43e9577379 +0 -0
- data/spec/dummy/tmp/cache/assets/development/sprockets/1ad476961916298df66abf55b6b446de +0 -0
- data/spec/dummy/tmp/cache/assets/development/sprockets/2286292795a62721269b8a751f3ce3de +0 -0
- data/spec/dummy/tmp/cache/assets/development/sprockets/34f9216c794a67fd776c9e8dfe99f905 +0 -0
- data/spec/dummy/tmp/cache/assets/development/sprockets/37a2b058893add5bb1b23726e10e90f1 +0 -0
- data/spec/dummy/tmp/cache/assets/development/sprockets/3d7c2feaa3d73a9b02a2523a2bf8c6c9 +0 -0
- data/spec/dummy/tmp/cache/assets/development/sprockets/41bea58eab5eb570004a03e4c0cb9bfe +0 -0
- data/spec/dummy/tmp/cache/assets/development/sprockets/43e404632c89edec855c1fe4e66bbfe8 +0 -0
- data/spec/dummy/tmp/cache/assets/development/sprockets/52a4f1330e8756eedff2b67442d10802 +0 -0
- data/spec/dummy/tmp/cache/assets/development/sprockets/79b7d2d69028ec9f2efa155d4bf7067a +0 -0
- data/spec/dummy/tmp/cache/assets/development/sprockets/8407d75ea9f26f3effb102acd4b2746d +0 -0
- data/spec/dummy/tmp/cache/assets/development/sprockets/962e8b0955e30143673ce7bf6b31f8d5 +0 -0
- data/spec/dummy/tmp/cache/assets/development/sprockets/98b0301bcea3ebb889faa9d47cbf2419 +0 -0
- data/spec/dummy/tmp/cache/assets/development/sprockets/aaf7d9ec41e452e8a7e8a9b8ee74f1cd +0 -0
- data/spec/dummy/tmp/cache/assets/development/sprockets/b1f9d4de39dbaca4f213e1d9df6bd0bd +0 -0
- data/spec/dummy/tmp/cache/assets/development/sprockets/c12af3e3ef3886081600da84f6d72c52 +0 -0
- data/spec/dummy/tmp/cache/assets/development/sprockets/db5ae29d7657f4561f01010b7442354a +0 -0
- data/spec/dummy/tmp/cache/assets/development/sprockets/f310f9446657cf410e5ef48cc74de9d2 +0 -0
- data/spec/factories/github/closed.json +222 -0
- data/spec/factories/github/hook-issues-event.json +164 -0
- data/spec/factories/github/open.json +50 -0
- data/spec/factories/got_fixed_issues.rb +10 -0
- data/spec/factories/got_fixed_users.rb +9 -0
- data/spec/lib/got_fixed/adapters/github_spec.rb +70 -0
- data/spec/lib/got_fixed/issue_factory_spec.rb +33 -0
- data/spec/lib/got_fixed/receivers/github_webhook_spec.rb +16 -0
- data/spec/mailers/got_fixed/user_mailer_spec.rb +20 -0
- data/spec/models/got_fixed/issue_spec.rb +52 -0
- data/spec/models/got_fixed/user_spec.rb +35 -0
- data/spec/routing/got_fixed/issues_routing_spec.rb +15 -0
- data/spec/spec_helper.rb +23 -0
- metadata +311 -0
@@ -0,0 +1,56 @@
|
|
1
|
+
# desc "Explaining what the task does"
|
2
|
+
# task :got_fixed do
|
3
|
+
# # Task goes here
|
4
|
+
# end
|
5
|
+
|
6
|
+
namespace :got_fixed do
|
7
|
+
|
8
|
+
desc "Import github issues from repos found in config/got_fixed.yml"
|
9
|
+
task :import_github => :environment do
|
10
|
+
issue_factory = GotFixed::IssueFactory.new
|
11
|
+
|
12
|
+
GotFixed.config[:github].each do |repo|
|
13
|
+
github = GotFixed::Adapters::Github.new
|
14
|
+
issues = github.issues(repo)
|
15
|
+
puts "Found #{issues.size} issues for #{repo_name(repo)}, filtering on labels '#{repo[:labels]}'"
|
16
|
+
|
17
|
+
issues.each do |gh_issue|
|
18
|
+
issue = issue_factory.from_github gh_issue
|
19
|
+
if issue.save
|
20
|
+
puts "Issue ##{gh_issue["number"]} #{issue.persisted? ? "updat" : "import"}ed: #{gh_issue["title"]}"
|
21
|
+
else
|
22
|
+
puts "\e[32mCould not import issue ##{gh_issue["number"]} from #{repo_name(repo)}: #{issue.errors.messages}\e[0;0m"
|
23
|
+
end
|
24
|
+
end
|
25
|
+
end
|
26
|
+
end
|
27
|
+
|
28
|
+
task :register_github_webhook => :environment do
|
29
|
+
listener_url = nil
|
30
|
+
while true
|
31
|
+
puts "What is the base URI of your host app? (e.g. https://myapp.herokuapp.com)"
|
32
|
+
host = STDIN.gets.strip
|
33
|
+
|
34
|
+
listener_url = GotFixed::Engine.routes.url_helpers.github_webhook_issues_url :host => host
|
35
|
+
puts "We'll tell Github to post issue changes to \e[32m#{listener_url}\e[0;0m. Looks good? (y/n)"
|
36
|
+
break if STDIN.gets.strip == "y"
|
37
|
+
end
|
38
|
+
|
39
|
+
GotFixed.config[:github].each do |repo|
|
40
|
+
if repo[:webhook_secret].blank?
|
41
|
+
puts "/!\\ Empty webhook_secret for repository #{repo_name(repo)}, skipping webhook creation"
|
42
|
+
next
|
43
|
+
end
|
44
|
+
|
45
|
+
github = GotFixed::Adapters::Github.new(repo)
|
46
|
+
github.create_hook :url => listener_url, :secret => repo[:webhook_secret]
|
47
|
+
puts "Successfully created hook for #{repo_name(repo)}. " +
|
48
|
+
"You can visualize it at https://github.com/#{repo_name(repo)}/settings/hooks"
|
49
|
+
end
|
50
|
+
end
|
51
|
+
|
52
|
+
def repo_name(repo)
|
53
|
+
"#{repo[:owner]}/#{repo[:repo]}}"
|
54
|
+
end
|
55
|
+
|
56
|
+
end
|
@@ -0,0 +1,194 @@
|
|
1
|
+
require 'spec_helper'
|
2
|
+
|
3
|
+
# This spec was generated by rspec-rails when you ran the scaffold generator.
|
4
|
+
# It demonstrates how one might use RSpec to specify the controller code that
|
5
|
+
# was generated by Rails when you ran the scaffold generator.
|
6
|
+
#
|
7
|
+
# It assumes that the implementation code is generated by the rails scaffold
|
8
|
+
# generator. If you are using any extension libraries to generate different
|
9
|
+
# controller code, this generated spec may or may not pass.
|
10
|
+
#
|
11
|
+
# It only uses APIs available in rails and/or rspec-rails. There are a number
|
12
|
+
# of tools you can use to make these specs even more expressive, but we're
|
13
|
+
# sticking to rails and rspec-rails APIs to keep things simple and stable.
|
14
|
+
#
|
15
|
+
# Compared to earlier versions of this generator, there is very limited use of
|
16
|
+
# stubs and message expectations in this spec. Stubs are only used when there
|
17
|
+
# is no simpler way to get a handle on the object needed for the example.
|
18
|
+
# Message expectations are only used when there is no simpler way to specify
|
19
|
+
# that an instance is receiving a specific message.
|
20
|
+
|
21
|
+
module GotFixed
|
22
|
+
describe IssuesController do
|
23
|
+
|
24
|
+
routes { GotFixed::Engine.routes }
|
25
|
+
|
26
|
+
# This should return the minimal set of attributes required to create a valid
|
27
|
+
# Issue. As you add validations to Issue, be sure to
|
28
|
+
# update the return value of this method accordingly.
|
29
|
+
def valid_attributes
|
30
|
+
{ "title" => "MyString" }
|
31
|
+
end
|
32
|
+
|
33
|
+
# This should return the minimal set of values that should be in the session
|
34
|
+
# in order to pass any filters (e.g. authentication) defined in
|
35
|
+
# IssuesController. Be sure to keep this updated too.
|
36
|
+
def valid_session
|
37
|
+
{}
|
38
|
+
end
|
39
|
+
|
40
|
+
describe "GET index" do
|
41
|
+
it "assigns all issues as @issues" do
|
42
|
+
issue = Issue.create! valid_attributes
|
43
|
+
get :index, {}, valid_session
|
44
|
+
assigns(:issues).should eq([issue])
|
45
|
+
end
|
46
|
+
end
|
47
|
+
|
48
|
+
describe "POST github_webhook" do
|
49
|
+
it "creates an issue from an 'closed' event" do
|
50
|
+
params = JSON.load(File.open "spec/factories/github/hook-issues-event.json")
|
51
|
+
request.headers["X-Hub-Signature"] = "sha1=7e5f575e2e92360b4f13a2100d930e770f26fde3"
|
52
|
+
request.headers["Content-Type"] = "application/json"
|
53
|
+
request.env["RAW_POST_DATA"] = JSON.generate(params) # Hackish as Rspec creates a url-encoded payload...
|
54
|
+
post :github_webhook, params, :format => :json
|
55
|
+
|
56
|
+
@issue = assigns(:issue)
|
57
|
+
@issue.should be_valid
|
58
|
+
@issue.vendor_id.should eq params["issue"]["id"].to_s
|
59
|
+
@issue.title.should eq params["issue"]["title"]
|
60
|
+
@issue.closed.should be_true
|
61
|
+
end
|
62
|
+
end
|
63
|
+
|
64
|
+
describe "POST subscribe" do
|
65
|
+
before(:each) do
|
66
|
+
@issue = FactoryGirl.create :got_fixed_issue
|
67
|
+
@issue.users.should be_blank
|
68
|
+
end
|
69
|
+
|
70
|
+
it "creates a user and subscribe him if the email does not exist" do
|
71
|
+
post :subscribe, :id => @issue.id, :user => { :email => "foo@bar.com" }, :format => :js
|
72
|
+
|
73
|
+
@user = assigns(:user)
|
74
|
+
@user.email.should eq "foo@bar.com"
|
75
|
+
@issue.reload.users.should_not be_blank
|
76
|
+
end
|
77
|
+
|
78
|
+
it "should subscribe an existing user" do
|
79
|
+
User.create! :email => "foo@bar.com"
|
80
|
+
post :subscribe, :id => @issue.id, :user => { :email => "foo@bar.com" }, :format => :js
|
81
|
+
|
82
|
+
@user = assigns(:user)
|
83
|
+
@user.email.should eq "foo@bar.com"
|
84
|
+
@issue.reload.users.should_not be_blank
|
85
|
+
end
|
86
|
+
|
87
|
+
it "should behave well when user already registered (not register him twice)" do
|
88
|
+
@issue.users << User.create!(:email => "foo@bar.com")
|
89
|
+
@issue.save
|
90
|
+
|
91
|
+
post :subscribe, :id => @issue.id, :user => { :email => "foo@bar.com" }, :format => :js
|
92
|
+
|
93
|
+
@issue.reload.users.size.should eq 1
|
94
|
+
end
|
95
|
+
end
|
96
|
+
|
97
|
+
# describe "POST create" do
|
98
|
+
# describe "with valid params" do
|
99
|
+
# it "creates a new Issue" do
|
100
|
+
# expect {
|
101
|
+
# post :create, {:issue => valid_attributes}, valid_session
|
102
|
+
# }.to change(Issue, :count).by(1)
|
103
|
+
# end
|
104
|
+
|
105
|
+
# it "assigns a newly created issue as @issue" do
|
106
|
+
# post :create, {:issue => valid_attributes}, valid_session
|
107
|
+
# assigns(:issue).should be_a(Issue)
|
108
|
+
# assigns(:issue).should be_persisted
|
109
|
+
# end
|
110
|
+
|
111
|
+
# it "redirects to the created issue" do
|
112
|
+
# post :create, {:issue => valid_attributes}, valid_session
|
113
|
+
# response.should redirect_to(Issue.last)
|
114
|
+
# end
|
115
|
+
# end
|
116
|
+
|
117
|
+
# describe "with invalid params" do
|
118
|
+
# it "assigns a newly created but unsaved issue as @issue" do
|
119
|
+
# # Trigger the behavior that occurs when invalid params are submitted
|
120
|
+
# Issue.any_instance.stub(:save).and_return(false)
|
121
|
+
# post :create, {:issue => { "title" => "invalid value" }}, valid_session
|
122
|
+
# assigns(:issue).should be_a_new(Issue)
|
123
|
+
# end
|
124
|
+
|
125
|
+
# it "re-renders the 'new' template" do
|
126
|
+
# # Trigger the behavior that occurs when invalid params are submitted
|
127
|
+
# Issue.any_instance.stub(:save).and_return(false)
|
128
|
+
# post :create, {:issue => { "title" => "invalid value" }}, valid_session
|
129
|
+
# response.should render_template("new")
|
130
|
+
# end
|
131
|
+
# end
|
132
|
+
# end
|
133
|
+
|
134
|
+
# describe "PUT update" do
|
135
|
+
# describe "with valid params" do
|
136
|
+
# it "updates the requested issue" do
|
137
|
+
# issue = Issue.create! valid_attributes
|
138
|
+
# # Assuming there are no other issues in the database, this
|
139
|
+
# # specifies that the Issue created on the previous line
|
140
|
+
# # receives the :update_attributes message with whatever params are
|
141
|
+
# # submitted in the request.
|
142
|
+
# Issue.any_instance.should_receive(:update_attributes).with({ "title" => "MyString" })
|
143
|
+
# put :update, {:id => issue.to_param, :issue => { "title" => "MyString" }}, valid_session
|
144
|
+
# end
|
145
|
+
|
146
|
+
# it "assigns the requested issue as @issue" do
|
147
|
+
# issue = Issue.create! valid_attributes
|
148
|
+
# put :update, {:id => issue.to_param, :issue => valid_attributes}, valid_session
|
149
|
+
# assigns(:issue).should eq(issue)
|
150
|
+
# end
|
151
|
+
|
152
|
+
# it "redirects to the issue" do
|
153
|
+
# issue = Issue.create! valid_attributes
|
154
|
+
# put :update, {:id => issue.to_param, :issue => valid_attributes}, valid_session
|
155
|
+
# response.should redirect_to(issue)
|
156
|
+
# end
|
157
|
+
# end
|
158
|
+
|
159
|
+
# describe "with invalid params" do
|
160
|
+
# it "assigns the issue as @issue" do
|
161
|
+
# issue = Issue.create! valid_attributes
|
162
|
+
# # Trigger the behavior that occurs when invalid params are submitted
|
163
|
+
# Issue.any_instance.stub(:save).and_return(false)
|
164
|
+
# put :update, {:id => issue.to_param, :issue => { "title" => "invalid value" }}, valid_session
|
165
|
+
# assigns(:issue).should eq(issue)
|
166
|
+
# end
|
167
|
+
|
168
|
+
# it "re-renders the 'edit' template" do
|
169
|
+
# issue = Issue.create! valid_attributes
|
170
|
+
# # Trigger the behavior that occurs when invalid params are submitted
|
171
|
+
# Issue.any_instance.stub(:save).and_return(false)
|
172
|
+
# put :update, {:id => issue.to_param, :issue => { "title" => "invalid value" }}, valid_session
|
173
|
+
# response.should render_template("edit")
|
174
|
+
# end
|
175
|
+
# end
|
176
|
+
# end
|
177
|
+
|
178
|
+
# describe "DELETE destroy" do
|
179
|
+
# it "destroys the requested issue" do
|
180
|
+
# issue = Issue.create! valid_attributes
|
181
|
+
# expect {
|
182
|
+
# delete :destroy, {:id => issue.to_param}, valid_session
|
183
|
+
# }.to change(Issue, :count).by(-1)
|
184
|
+
# end
|
185
|
+
|
186
|
+
# it "redirects to the issues list" do
|
187
|
+
# issue = Issue.create! valid_attributes
|
188
|
+
# delete :destroy, {:id => issue.to_param}, valid_session
|
189
|
+
# response.should redirect_to(issues_url)
|
190
|
+
# end
|
191
|
+
# end
|
192
|
+
|
193
|
+
end
|
194
|
+
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.
|
data/spec/dummy/Rakefile
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
#!/usr/bin/env rake
|
2
|
+
# Add your own tasks in files placed in lib/tasks ending in .rake,
|
3
|
+
# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
|
4
|
+
|
5
|
+
require File.expand_path('../config/application', __FILE__)
|
6
|
+
|
7
|
+
Dummy::Application.load_tasks
|
@@ -0,0 +1,15 @@
|
|
1
|
+
// This is a manifest file that'll be compiled into application.js, which will include all the files
|
2
|
+
// listed below.
|
3
|
+
//
|
4
|
+
// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
|
5
|
+
// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
|
6
|
+
//
|
7
|
+
// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
|
8
|
+
// the compiled file.
|
9
|
+
//
|
10
|
+
// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
|
11
|
+
// GO AFTER THE REQUIRES BELOW.
|
12
|
+
//
|
13
|
+
//= require jquery
|
14
|
+
//= require jquery_ujs
|
15
|
+
//= require_tree .
|
@@ -0,0 +1,13 @@
|
|
1
|
+
/*
|
2
|
+
* This is a manifest file that'll be compiled into application.css, which will include all the files
|
3
|
+
* listed below.
|
4
|
+
*
|
5
|
+
* Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
|
6
|
+
* or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
|
7
|
+
*
|
8
|
+
* You're free to add application-wide styles to this file and they'll appear at the top of the
|
9
|
+
* compiled file, but it's generally better to create a new file per style scope.
|
10
|
+
*
|
11
|
+
*= require_self
|
12
|
+
*= require_tree .
|
13
|
+
*/
|
@@ -0,0 +1,65 @@
|
|
1
|
+
require File.expand_path('../boot', __FILE__)
|
2
|
+
|
3
|
+
# Pick the frameworks you want:
|
4
|
+
require "active_record/railtie"
|
5
|
+
require "action_controller/railtie"
|
6
|
+
require "action_mailer/railtie"
|
7
|
+
# require "active_resource/railtie"
|
8
|
+
require "sprockets/railtie"
|
9
|
+
# require "rails/test_unit/railtie"
|
10
|
+
|
11
|
+
Bundler.require(*Rails.groups)
|
12
|
+
require "got_fixed"
|
13
|
+
|
14
|
+
module Dummy
|
15
|
+
class Application < Rails::Application
|
16
|
+
# Settings in config/environments/* take precedence over those specified here.
|
17
|
+
# Application configuration should go into files in config/initializers
|
18
|
+
# -- all .rb files in that directory are automatically loaded.
|
19
|
+
|
20
|
+
# Custom directories with classes and modules you want to be autoloadable.
|
21
|
+
# config.autoload_paths += %W(#{config.root}/extras)
|
22
|
+
|
23
|
+
# Only load the plugins named here, in the order given (default is alphabetical).
|
24
|
+
# :all can be used as a placeholder for all plugins not explicitly named.
|
25
|
+
# config.plugins = [ :exception_notification, :ssl_requirement, :all ]
|
26
|
+
|
27
|
+
# Activate observers that should always be running.
|
28
|
+
# config.active_record.observers = :cacher, :garbage_collector, :forum_observer
|
29
|
+
|
30
|
+
# Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
|
31
|
+
# Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
|
32
|
+
# config.time_zone = 'Central Time (US & Canada)'
|
33
|
+
|
34
|
+
# The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
|
35
|
+
# config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
|
36
|
+
# config.i18n.default_locale = :de
|
37
|
+
|
38
|
+
# Configure the default encoding used in templates for Ruby 1.9.
|
39
|
+
config.encoding = "utf-8"
|
40
|
+
|
41
|
+
# Configure sensitive parameters which will be filtered from the log file.
|
42
|
+
config.filter_parameters += [:password]
|
43
|
+
|
44
|
+
# Enable escaping HTML in JSON.
|
45
|
+
config.active_support.escape_html_entities_in_json = true
|
46
|
+
|
47
|
+
# Use SQL instead of Active Record's schema dumper when creating the database.
|
48
|
+
# This is necessary if your schema can't be completely dumped by the schema dumper,
|
49
|
+
# like if you have constraints or database-specific column types
|
50
|
+
# config.active_record.schema_format = :sql
|
51
|
+
|
52
|
+
# Enforce whitelist mode for mass assignment.
|
53
|
+
# This will create an empty whitelist of attributes available for mass-assignment for all models
|
54
|
+
# in your app. As such, your models will need to explicitly whitelist or blacklist accessible
|
55
|
+
# parameters by using an attr_accessible or attr_protected declaration.
|
56
|
+
# config.active_record.whitelist_attributes = true
|
57
|
+
|
58
|
+
# Enable the asset pipeline
|
59
|
+
config.assets.enabled = true
|
60
|
+
|
61
|
+
# Version of your assets, change this if you want to expire all your assets
|
62
|
+
config.assets.version = '1.0'
|
63
|
+
end
|
64
|
+
end
|
65
|
+
|
@@ -0,0 +1,25 @@
|
|
1
|
+
# SQLite version 3.x
|
2
|
+
# gem install sqlite3
|
3
|
+
#
|
4
|
+
# Ensure the SQLite 3 gem is defined in your Gemfile
|
5
|
+
# gem 'sqlite3'
|
6
|
+
development:
|
7
|
+
adapter: sqlite3
|
8
|
+
database: db/development.sqlite3
|
9
|
+
pool: 5
|
10
|
+
timeout: 5000
|
11
|
+
|
12
|
+
# Warning: The database defined as "test" will be erased and
|
13
|
+
# re-generated from your development database when you run "rake".
|
14
|
+
# Do not set this db to the same as development or production.
|
15
|
+
test:
|
16
|
+
adapter: sqlite3
|
17
|
+
database: db/test.sqlite3
|
18
|
+
pool: 5
|
19
|
+
timeout: 5000
|
20
|
+
|
21
|
+
production:
|
22
|
+
adapter: sqlite3
|
23
|
+
database: db/production.sqlite3
|
24
|
+
pool: 5
|
25
|
+
timeout: 5000
|