nweintraut-forem 0.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (195) hide show
  1. data/.gitignore +7 -0
  2. data/Gemfile +17 -0
  3. data/Gemfile.lock +136 -0
  4. data/MIT-LICENSE +20 -0
  5. data/README.rdoc +3 -0
  6. data/Rakefile +45 -0
  7. data/app/assets/images/forem/.gitkeep +0 -0
  8. data/app/assets/javascripts/forem/application.js +15 -0
  9. data/app/assets/javascripts/forem/forem/goofy.js +2 -0
  10. data/app/assets/javascripts/forem/goofy.js +2 -0
  11. data/app/assets/javascripts/forem/placeholder.js +2 -0
  12. data/app/assets/javascripts/forem/posts.js +2 -0
  13. data/app/assets/javascripts/forem/topics.js +2 -0
  14. data/app/assets/stylesheets/forem/application.css +13 -0
  15. data/app/assets/stylesheets/forem/forem/goofy.css +4 -0
  16. data/app/assets/stylesheets/forem/goofy.css +4 -0
  17. data/app/assets/stylesheets/forem/placeholder.css +4 -0
  18. data/app/assets/stylesheets/forem/posts.css +4 -0
  19. data/app/assets/stylesheets/forem/topics.css +4 -0
  20. data/app/controllers/forem/application_controller.rb +4 -0
  21. data/app/controllers/forem/placeholder_controller.rb +2 -0
  22. data/app/controllers/forem/posts_controller.rb +25 -0
  23. data/app/controllers/forem/topics_controller.rb +35 -0
  24. data/app/helpers/forem/application_helper.rb +4 -0
  25. data/app/helpers/forem/placeholder_helper.rb +2 -0
  26. data/app/helpers/forem/posts_helper.rb +2 -0
  27. data/app/helpers/forem/topics_helper.rb +2 -0
  28. data/app/models/forem/post.rb +5 -0
  29. data/app/models/forem/topic.rb +14 -0
  30. data/app/models/forem.rb +5 -0
  31. data/app/views/forem/posts/_form.html.erb +4 -0
  32. data/app/views/forem/posts/_post.html.erb +11 -0
  33. data/app/views/forem/posts/new.html.erb +5 -0
  34. data/app/views/forem/topics/_form.html.erb +10 -0
  35. data/app/views/forem/topics/index.html.erb +27 -0
  36. data/app/views/forem/topics/new.html.erb +2 -0
  37. data/app/views/forem/topics/show.html.erb +6 -0
  38. data/app/views/layouts/forem/_application.html.erb +13 -0
  39. data/bin/autospec +16 -0
  40. data/bin/erubis +16 -0
  41. data/bin/htmldiff +16 -0
  42. data/bin/ldiff +16 -0
  43. data/bin/nokogiri +16 -0
  44. data/bin/rackup +16 -0
  45. data/bin/rails +16 -0
  46. data/bin/rake +16 -0
  47. data/bin/rake2thor +16 -0
  48. data/bin/rdoc +16 -0
  49. data/bin/ri +16 -0
  50. data/bin/rspec +16 -0
  51. data/bin/thor +16 -0
  52. data/bin/tilt +16 -0
  53. data/bin/tt +16 -0
  54. data/config/routes.rb +6 -0
  55. data/db/migrate/20120501042813_create_forem_topics.rb +10 -0
  56. data/db/migrate/20120501050428_create_forem_posts.rb +11 -0
  57. data/db/migrate/20120501064638_add_posts_count_to_forem_topics.rb +5 -0
  58. data/db/migrate/20120520151511_add_user_id_to_forem_topics.rb +5 -0
  59. data/lib/forem/engine.rb +14 -0
  60. data/lib/forem/version.rb +3 -0
  61. data/lib/forem.rb +6 -0
  62. data/lib/tasks/forem_tasks.rake +4 -0
  63. data/nweintraut-forem.gemspec +28 -0
  64. data/script/rails +9 -0
  65. data/spec/configuration_spec.rb +17 -0
  66. data/spec/dummy/README.rdoc +261 -0
  67. data/spec/dummy/Rakefile +7 -0
  68. data/spec/dummy/app/assets/javascripts/application.js +15 -0
  69. data/spec/dummy/app/assets/javascripts/forem/goofy.js +2 -0
  70. data/spec/dummy/app/assets/stylesheets/application.css +13 -0
  71. data/spec/dummy/app/assets/stylesheets/forem/goofy.css +4 -0
  72. data/spec/dummy/app/controllers/application_controller.rb +4 -0
  73. data/spec/dummy/app/controllers/fake_controller.rb +5 -0
  74. data/spec/dummy/app/helpers/application_helper.rb +2 -0
  75. data/spec/dummy/app/mailers/.gitkeep +0 -0
  76. data/spec/dummy/app/models/.gitkeep +0 -0
  77. data/spec/dummy/app/models/user.rb +6 -0
  78. data/spec/dummy/app/views/layouts/application.html.erb +16 -0
  79. data/spec/dummy/config/application.rb +56 -0
  80. data/spec/dummy/config/boot.rb +10 -0
  81. data/spec/dummy/config/database.yml +56 -0
  82. data/spec/dummy/config/environment.rb +5 -0
  83. data/spec/dummy/config/environments/development.rb +37 -0
  84. data/spec/dummy/config/environments/production.rb +67 -0
  85. data/spec/dummy/config/environments/test.rb +37 -0
  86. data/spec/dummy/config/initializers/backtrace_silencers.rb +7 -0
  87. data/spec/dummy/config/initializers/forem.rb +1 -0
  88. data/spec/dummy/config/initializers/inflections.rb +15 -0
  89. data/spec/dummy/config/initializers/mime_types.rb +5 -0
  90. data/spec/dummy/config/initializers/secret_token.rb +7 -0
  91. data/spec/dummy/config/initializers/session_store.rb +8 -0
  92. data/spec/dummy/config/initializers/wrap_parameters.rb +14 -0
  93. data/spec/dummy/config/locales/en.yml +5 -0
  94. data/spec/dummy/config/routes.rb +5 -0
  95. data/spec/dummy/config.ru +4 -0
  96. data/spec/dummy/db/migrate/20120501050517_create_forem_topics.forem.rb_ +11 -0
  97. data/spec/dummy/db/migrate/20120501050518_create_forem_posts.forem.rb_ +12 -0
  98. data/spec/dummy/db/migrate/20120501064803_add_posts_count_to_forem_topics.forem.rb +6 -0
  99. data/spec/dummy/db/migrate/20120520055828_create_users.rb +9 -0
  100. data/spec/dummy/db/schema.rb +38 -0
  101. data/spec/dummy/lib/assets/.gitkeep +0 -0
  102. data/spec/dummy/log/.gitkeep +0 -0
  103. data/spec/dummy/log/development.log +1745 -0
  104. data/spec/dummy/log/test.log +8320 -0
  105. data/spec/dummy/public/404.html +26 -0
  106. data/spec/dummy/public/422.html +26 -0
  107. data/spec/dummy/public/500.html +25 -0
  108. data/spec/dummy/public/favicon.ico +0 -0
  109. data/spec/dummy/script/rails +6 -0
  110. data/spec/dummy/test/fixtures/users.yml +7 -0
  111. data/spec/dummy/test/functional/forem/goofy_controller_test.rb +7 -0
  112. data/spec/dummy/test/unit/helpers/forem/goofy_helper_test.rb +4 -0
  113. data/spec/dummy/test/unit/user_test.rb +7 -0
  114. data/spec/dummy/tmp/cache/assets/C83/890/sprockets%2F04b7712512f728c84bb2dd94742c5909 +0 -0
  115. data/spec/dummy/tmp/cache/assets/CC8/790/sprockets%2Fce93eb9b88e2d7904b44649437f51169 +0 -0
  116. data/spec/dummy/tmp/cache/assets/CD8/370/sprockets%2F357970feca3ac29060c1e3861e2c0953 +0 -0
  117. data/spec/dummy/tmp/cache/assets/CE7/8B0/sprockets%2F077815b5af9649318a9a2fc603e184bf +0 -0
  118. data/spec/dummy/tmp/cache/assets/D0D/490/sprockets%2F314449a2a810fe259b55ceae428f0c87 +0 -0
  119. data/spec/dummy/tmp/cache/assets/D28/030/sprockets%2Ffd60a7a8345f40bfb0264ac5085c23a0 +0 -0
  120. data/spec/dummy/tmp/cache/assets/D32/A10/sprockets%2F13fe41fee1fe35b49d145bcc06610705 +0 -0
  121. data/spec/dummy/tmp/cache/assets/D4E/1B0/sprockets%2Ff7cbd26ba1d28d48de824f0e94586655 +0 -0
  122. data/spec/dummy/tmp/cache/assets/D5A/EA0/sprockets%2Fd771ace226fc8215a3572e0aa35bb0d6 +0 -0
  123. data/spec/dummy/tmp/cache/assets/DA2/6B0/sprockets%2F8f1fcf792b440d9cb2ad3f9b1836e4a3 +0 -0
  124. data/spec/dummy/tmp/cache/assets/DC0/120/sprockets%2F8eb27b4d88f6595dc5ee7eb679cc367c +0 -0
  125. data/spec/dummy/tmp/cache/assets/DD5/5A0/sprockets%2F82bc4ebce47cb9dc9e38557bda8c0092 +0 -0
  126. data/spec/dummy/tmp/cache/assets/DDC/400/sprockets%2Fcffd775d018f68ce5dba1ee0d951a994 +0 -0
  127. data/spec/dummy/tmp/cache/assets/E04/890/sprockets%2F2f5173deea6c795b8fdde723bb4b63af +0 -0
  128. data/spec/integration/posts_spec.rb +51 -0
  129. data/spec/integration/topics_spec.rb +40 -0
  130. data/spec/spec_helper.rb +20 -0
  131. data/spec/support/capybara.rb +7 -0
  132. data/spec/support/dummy_login.rb +17 -0
  133. data/spec/support/load_routes.rb +3 -0
  134. data/test/dummy/README.rdoc +261 -0
  135. data/test/dummy/Rakefile +7 -0
  136. data/test/dummy/app/assets/javascripts/application.js +15 -0
  137. data/test/dummy/app/assets/stylesheets/application.css +13 -0
  138. data/test/dummy/app/controllers/application_controller.rb +3 -0
  139. data/test/dummy/app/helpers/application_helper.rb +2 -0
  140. data/test/dummy/app/mailers/.gitkeep +0 -0
  141. data/test/dummy/app/models/.gitkeep +0 -0
  142. data/test/dummy/app/views/layouts/application.html.erb +14 -0
  143. data/test/dummy/config/application.rb +56 -0
  144. data/test/dummy/config/boot.rb +10 -0
  145. data/test/dummy/config/database.yml +55 -0
  146. data/test/dummy/config/environment.rb +5 -0
  147. data/test/dummy/config/environments/development.rb +37 -0
  148. data/test/dummy/config/environments/production.rb +67 -0
  149. data/test/dummy/config/environments/test.rb +37 -0
  150. data/test/dummy/config/initializers/backtrace_silencers.rb +7 -0
  151. data/test/dummy/config/initializers/inflections.rb +15 -0
  152. data/test/dummy/config/initializers/mime_types.rb +5 -0
  153. data/test/dummy/config/initializers/secret_token.rb +7 -0
  154. data/test/dummy/config/initializers/session_store.rb +8 -0
  155. data/test/dummy/config/initializers/wrap_parameters.rb +14 -0
  156. data/test/dummy/config/locales/en.yml +5 -0
  157. data/test/dummy/config/routes.rb +4 -0
  158. data/test/dummy/config.ru +4 -0
  159. data/test/dummy/db/migrate/20120501044219_create_forem_topics.forem.rb +11 -0
  160. data/test/dummy/db/schema.rb +23 -0
  161. data/test/dummy/lib/assets/.gitkeep +0 -0
  162. data/test/dummy/log/.gitkeep +0 -0
  163. data/test/dummy/log/development.log +3588 -0
  164. data/test/dummy/public/404.html +26 -0
  165. data/test/dummy/public/422.html +26 -0
  166. data/test/dummy/public/500.html +25 -0
  167. data/test/dummy/public/favicon.ico +0 -0
  168. data/test/dummy/script/rails +6 -0
  169. data/test/dummy/tmp/cache/assets/CC8/790/sprockets%2Fce93eb9b88e2d7904b44649437f51169 +0 -0
  170. data/test/dummy/tmp/cache/assets/CD8/370/sprockets%2F357970feca3ac29060c1e3861e2c0953 +0 -0
  171. data/test/dummy/tmp/cache/assets/D0D/490/sprockets%2F314449a2a810fe259b55ceae428f0c87 +0 -0
  172. data/test/dummy/tmp/cache/assets/D28/030/sprockets%2Ffd60a7a8345f40bfb0264ac5085c23a0 +0 -0
  173. data/test/dummy/tmp/cache/assets/D32/A10/sprockets%2F13fe41fee1fe35b49d145bcc06610705 +0 -0
  174. data/test/dummy/tmp/cache/assets/D4E/1B0/sprockets%2Ff7cbd26ba1d28d48de824f0e94586655 +0 -0
  175. data/test/dummy/tmp/cache/assets/D5A/EA0/sprockets%2Fd771ace226fc8215a3572e0aa35bb0d6 +0 -0
  176. data/test/dummy/tmp/cache/assets/DA2/6B0/sprockets%2F8f1fcf792b440d9cb2ad3f9b1836e4a3 +0 -0
  177. data/test/dummy/tmp/cache/assets/DDC/400/sprockets%2Fcffd775d018f68ce5dba1ee0d951a994 +0 -0
  178. data/test/dummy/tmp/cache/assets/E04/890/sprockets%2F2f5173deea6c795b8fdde723bb4b63af +0 -0
  179. data/test/fixtures/forem/posts.yml +11 -0
  180. data/test/fixtures/forem/topics.yml +9 -0
  181. data/test/fixtures/topics.yml +9 -0
  182. data/test/forem_test.rb +7 -0
  183. data/test/functional/forem/placeholder_controller_test.rb +7 -0
  184. data/test/functional/forem/posts_controller_test.rb +7 -0
  185. data/test/functional/forem/topics_controller_test.rb +7 -0
  186. data/test/integration/navigation_test.rb +10 -0
  187. data/test/test_helper.rb +15 -0
  188. data/test/unit/forem/post_test.rb +7 -0
  189. data/test/unit/forem/topic_test.rb +7 -0
  190. data/test/unit/helpers/forem/goofy_helper_test.rb +4 -0
  191. data/test/unit/helpers/forem/placeholder_helper_test.rb +4 -0
  192. data/test/unit/helpers/forem/posts_helper_test.rb +4 -0
  193. data/test/unit/helpers/forem/topics_helper_test.rb +4 -0
  194. data/test/unit/topic_test.rb +7 -0
  195. metadata +357 -0
data/bin/rake ADDED
@@ -0,0 +1,16 @@
1
+ #!/usr/bin/env ruby
2
+ #
3
+ # This file was generated by Bundler.
4
+ #
5
+ # The application 'rake' is installed as part of a gem, and
6
+ # this file is here to facilitate running it.
7
+ #
8
+
9
+ require 'pathname'
10
+ ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
11
+ Pathname.new(__FILE__).realpath)
12
+
13
+ require 'rubygems'
14
+ require 'bundler/setup'
15
+
16
+ load Gem.bin_path('rake', 'rake')
data/bin/rake2thor ADDED
@@ -0,0 +1,16 @@
1
+ #!/usr/bin/env ruby
2
+ #
3
+ # This file was generated by Bundler.
4
+ #
5
+ # The application 'rake2thor' is installed as part of a gem, and
6
+ # this file is here to facilitate running it.
7
+ #
8
+
9
+ require 'pathname'
10
+ ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
11
+ Pathname.new(__FILE__).realpath)
12
+
13
+ require 'rubygems'
14
+ require 'bundler/setup'
15
+
16
+ load Gem.bin_path('thor', 'rake2thor')
data/bin/rdoc ADDED
@@ -0,0 +1,16 @@
1
+ #!/usr/bin/env ruby
2
+ #
3
+ # This file was generated by Bundler.
4
+ #
5
+ # The application 'rdoc' is installed as part of a gem, and
6
+ # this file is here to facilitate running it.
7
+ #
8
+
9
+ require 'pathname'
10
+ ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
11
+ Pathname.new(__FILE__).realpath)
12
+
13
+ require 'rubygems'
14
+ require 'bundler/setup'
15
+
16
+ load Gem.bin_path('rdoc', 'rdoc')
data/bin/ri ADDED
@@ -0,0 +1,16 @@
1
+ #!/usr/bin/env ruby
2
+ #
3
+ # This file was generated by Bundler.
4
+ #
5
+ # The application 'ri' is installed as part of a gem, and
6
+ # this file is here to facilitate running it.
7
+ #
8
+
9
+ require 'pathname'
10
+ ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
11
+ Pathname.new(__FILE__).realpath)
12
+
13
+ require 'rubygems'
14
+ require 'bundler/setup'
15
+
16
+ load Gem.bin_path('rdoc', 'ri')
data/bin/rspec ADDED
@@ -0,0 +1,16 @@
1
+ #!/usr/bin/env ruby
2
+ #
3
+ # This file was generated by Bundler.
4
+ #
5
+ # The application 'rspec' is installed as part of a gem, and
6
+ # this file is here to facilitate running it.
7
+ #
8
+
9
+ require 'pathname'
10
+ ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
11
+ Pathname.new(__FILE__).realpath)
12
+
13
+ require 'rubygems'
14
+ require 'bundler/setup'
15
+
16
+ load Gem.bin_path('rspec-core', 'rspec')
data/bin/thor ADDED
@@ -0,0 +1,16 @@
1
+ #!/usr/bin/env ruby
2
+ #
3
+ # This file was generated by Bundler.
4
+ #
5
+ # The application 'thor' is installed as part of a gem, and
6
+ # this file is here to facilitate running it.
7
+ #
8
+
9
+ require 'pathname'
10
+ ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
11
+ Pathname.new(__FILE__).realpath)
12
+
13
+ require 'rubygems'
14
+ require 'bundler/setup'
15
+
16
+ load Gem.bin_path('thor', 'thor')
data/bin/tilt ADDED
@@ -0,0 +1,16 @@
1
+ #!/usr/bin/env ruby
2
+ #
3
+ # This file was generated by Bundler.
4
+ #
5
+ # The application 'tilt' is installed as part of a gem, and
6
+ # this file is here to facilitate running it.
7
+ #
8
+
9
+ require 'pathname'
10
+ ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
11
+ Pathname.new(__FILE__).realpath)
12
+
13
+ require 'rubygems'
14
+ require 'bundler/setup'
15
+
16
+ load Gem.bin_path('tilt', 'tilt')
data/bin/tt ADDED
@@ -0,0 +1,16 @@
1
+ #!/usr/bin/env ruby
2
+ #
3
+ # This file was generated by Bundler.
4
+ #
5
+ # The application 'tt' is installed as part of a gem, and
6
+ # this file is here to facilitate running it.
7
+ #
8
+
9
+ require 'pathname'
10
+ ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
11
+ Pathname.new(__FILE__).realpath)
12
+
13
+ require 'rubygems'
14
+ require 'bundler/setup'
15
+
16
+ load Gem.bin_path('treetop', 'tt')
data/config/routes.rb ADDED
@@ -0,0 +1,6 @@
1
+ Forem::Engine.routes.draw do
2
+ resources :topics do
3
+ resources :posts
4
+ end
5
+ root to: "topics#index"
6
+ end
@@ -0,0 +1,10 @@
1
+ class CreateForemTopics < ActiveRecord::Migration
2
+ def change
3
+ create_table :forem_topics do |t|
4
+ t.text :subject
5
+ t.integer :user_id
6
+
7
+ t.timestamps
8
+ end
9
+ end
10
+ end
@@ -0,0 +1,11 @@
1
+ class CreateForemPosts < ActiveRecord::Migration
2
+ def change
3
+ create_table :forem_posts do |t|
4
+ t.integer :topic_id
5
+ t.text :text
6
+ t.integer :user_id
7
+
8
+ t.timestamps
9
+ end
10
+ end
11
+ end
@@ -0,0 +1,5 @@
1
+ class AddPostsCountToForemTopics < ActiveRecord::Migration
2
+ def change
3
+ add_column :forem_topics, :posts_count, :integer, default: 0
4
+ end
5
+ end
@@ -0,0 +1,5 @@
1
+ class AddUserIdToForemTopics < ActiveRecord::Migration
2
+ def change
3
+ add_column :forem_topics, :user_id, :integer
4
+ end
5
+ end
@@ -0,0 +1,14 @@
1
+ module Forem
2
+ class Engine < ::Rails::Engine
3
+ isolate_namespace Forem
4
+ config.generators.integration_tool :rspec
5
+ config.generators.test_framework :rspec
6
+ class << self
7
+ attr_accessor :user_class
8
+ end
9
+ def self.user_class
10
+ error = "Please define Forem::Engine.user_class" + " in config/initializers/forem.rb"
11
+ @user_class || raise(ConfigurationNotSet, error)
12
+ end
13
+ end
14
+ end
@@ -0,0 +1,3 @@
1
+ module Forem
2
+ VERSION = "0.0.1"
3
+ end
data/lib/forem.rb ADDED
@@ -0,0 +1,6 @@
1
+ require "forem/engine"
2
+ puts "#in lib/forem"
3
+ module Forem
4
+ class ConfigurationNotSet < StandardError
5
+ end
6
+ end
@@ -0,0 +1,4 @@
1
+ # desc "Explaining what the task does"
2
+ # task :forem do
3
+ # # Task goes here
4
+ # end
@@ -0,0 +1,28 @@
1
+ $:.push File.expand_path("../lib", __FILE__)
2
+
3
+ # Maintain your gem's version:
4
+ require "forem/version"
5
+
6
+ # Describe your gem and declare its dependencies:
7
+ Gem::Specification.new do |s|
8
+ s.name = "nweintraut-forem"
9
+ s.version = Forem::VERSION
10
+ s.authors = ["Neil Weintraut"]
11
+ s.email = ["neil.weintraut@gmail.com"]
12
+ s.homepage = "http://rubygems.org/gems/nweintraut-forem"
13
+ s.summary = "Summary of Forem."
14
+ s.description = "Description of Forem."
15
+
16
+ # s.files = Dir["{app,config,db,lib}/**/*"] + ["MIT-LICENSE", "Rakefile", "README.rdoc"]
17
+ s.files = `git ls-files`.split("\n")
18
+ s.test_files = Dir["test/**/*"]
19
+
20
+ s.add_dependency "rails", "~> 3.2.3"
21
+ # s.add_dependency "jquery-rails"
22
+
23
+ s.add_development_dependency "pg"
24
+ s.add_development_dependency 'rspec-rails'
25
+ s.add_development_dependency 'rspec-rails'
26
+ s.add_development_dependency 'capybara'
27
+
28
+ end
data/script/rails ADDED
@@ -0,0 +1,9 @@
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/forem/engine', __FILE__)
6
+ load File.expand_path('../../spec/dummy/script/rails', __FILE__)
7
+ require 'rails/all'
8
+ require 'rails/engine/commands'
9
+
@@ -0,0 +1,17 @@
1
+ require 'spec_helper'
2
+
3
+ describe 'Configuration' do
4
+ before do
5
+ Forem::Engine.user_class = nil
6
+ end
7
+ after do
8
+ Forem::Engine.user_class = User
9
+ end
10
+ it "user_class must be set" do
11
+ config = lambda{Forem::Engine.user_class}
12
+ error = "Please define Forem::Engine.user_class" + " in config/initializers/forem.rb"
13
+ config.should raise_error(Forem::ConfigurationNotSet, error)
14
+ Forem::Engine.user_class = User
15
+ config.should_not raise_error(Forem::ConfigurationNotSet)
16
+ end
17
+ 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.
@@ -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,2 @@
1
+ // Place all the behaviors and hooks related to the matching controller here.
2
+ // All this logic will automatically be available in application.js.
@@ -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,4 @@
1
+ /*
2
+ Place all the styles related to the matching controller here.
3
+ They will automatically be included in application.css.
4
+ */
@@ -0,0 +1,4 @@
1
+ class ApplicationController < ActionController::Base
2
+ protect_from_forgery
3
+
4
+ end
@@ -0,0 +1,5 @@
1
+ class FakeController < ApplicationController
2
+ def sign_in
3
+ render :text => "Placeholder login page."
4
+ end
5
+ end
@@ -0,0 +1,2 @@
1
+ module ApplicationHelper
2
+ end
File without changes
File without changes
@@ -0,0 +1,6 @@
1
+ class User < ActiveRecord::Base
2
+ attr_accessible :login
3
+ def to_s
4
+ login
5
+ end
6
+ end
@@ -0,0 +1,16 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <title>Dummy 2</title>
5
+ <%= stylesheet_link_tag "application", :media => "all" %>
6
+ <%= javascript_include_tag "application" %>
7
+ <%= csrf_meta_tags %>
8
+ </head>
9
+ <body>
10
+ <% flash.each do |key, message| %>
11
+ <div id='flash_<%= key %>'><%= message %></div>
12
+ <% end %>
13
+ <%= yield %>
14
+
15
+ </body>
16
+ </html>