atom_smasher 0.0.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (127) hide show
  1. checksums.yaml +15 -0
  2. data/MIT-LICENSE +20 -0
  3. data/README.rdoc +3 -0
  4. data/Rakefile +40 -0
  5. data/app/assets/javascripts/atom_smasher/application.js +16 -0
  6. data/app/assets/javascripts/atom_smasher/feeds.js +2 -0
  7. data/app/assets/javascripts/atom_smasher/zepto.js +1565 -0
  8. data/app/assets/stylesheets/atom_smasher/application.css +13 -0
  9. data/app/assets/stylesheets/atom_smasher/feeds.css +4 -0
  10. data/app/controllers/atom_smasher/application_controller.rb +5 -0
  11. data/app/controllers/atom_smasher/feeds_controller.rb +35 -0
  12. data/app/helpers/atom_smasher/application_helper.rb +4 -0
  13. data/app/helpers/atom_smasher/feeds_helper.rb +4 -0
  14. data/app/models/atom_smasher/feed.rb +36 -0
  15. data/app/models/atom_smasher/post.rb +6 -0
  16. data/app/views/atom_smasher/feeds/_form.html.haml +13 -0
  17. data/app/views/atom_smasher/feeds/index.html.haml +1 -0
  18. data/app/views/atom_smasher/feeds/new.html.haml +5 -0
  19. data/app/views/atom_smasher/feeds/show.html.haml +15 -0
  20. data/app/views/layouts/atom_smasher/application.html.haml +18 -0
  21. data/config/routes.rb +4 -0
  22. data/db/migrate/20130403174525_create_atom_smasher_feeds.rb +9 -0
  23. data/db/migrate/20130403191447_create_atom_smasher_posts.rb +11 -0
  24. data/db/migrate/20130404120536_add_link_to_atom_smasher_posts.rb +5 -0
  25. data/lib/atom_smasher.rb +5 -0
  26. data/lib/atom_smasher/engine.rb +5 -0
  27. data/lib/atom_smasher/version.rb +3 -0
  28. data/lib/tasks/atom_smasher_tasks.rake +4 -0
  29. data/test/atom_smasher_test.rb +7 -0
  30. data/test/dummy/README.rdoc +261 -0
  31. data/test/dummy/Rakefile +7 -0
  32. data/test/dummy/app/assets/javascripts/application.js +15 -0
  33. data/test/dummy/app/assets/stylesheets/application.css +13 -0
  34. data/test/dummy/app/controllers/application_controller.rb +3 -0
  35. data/test/dummy/app/helpers/application_helper.rb +2 -0
  36. data/test/dummy/app/views/layouts/application.html.erb +15 -0
  37. data/test/dummy/config.ru +4 -0
  38. data/test/dummy/config/application.rb +59 -0
  39. data/test/dummy/config/boot.rb +10 -0
  40. data/test/dummy/config/database.yml +20 -0
  41. data/test/dummy/config/environment.rb +5 -0
  42. data/test/dummy/config/environments/development.rb +37 -0
  43. data/test/dummy/config/environments/production.rb +67 -0
  44. data/test/dummy/config/environments/test.rb +37 -0
  45. data/test/dummy/config/initializers/backtrace_silencers.rb +7 -0
  46. data/test/dummy/config/initializers/inflections.rb +15 -0
  47. data/test/dummy/config/initializers/mime_types.rb +5 -0
  48. data/test/dummy/config/initializers/secret_token.rb +7 -0
  49. data/test/dummy/config/initializers/session_store.rb +8 -0
  50. data/test/dummy/config/initializers/wrap_parameters.rb +14 -0
  51. data/test/dummy/config/locales/en.yml +5 -0
  52. data/test/dummy/config/routes.rb +4 -0
  53. data/test/dummy/db/development.sqlite3 +0 -0
  54. data/test/dummy/db/migrate/20130405162837_create_atom_smasher_feeds.atom_smasher.rb +10 -0
  55. data/test/dummy/db/migrate/20130405162838_create_atom_smasher_posts.atom_smasher.rb +12 -0
  56. data/test/dummy/db/migrate/20130405163239_add_link_to_atom_smasher_posts.atom_smasher.rb +6 -0
  57. data/test/dummy/db/schema.rb +31 -0
  58. data/test/dummy/log/development.log +23833 -0
  59. data/test/dummy/public/404.html +26 -0
  60. data/test/dummy/public/422.html +26 -0
  61. data/test/dummy/public/500.html +25 -0
  62. data/test/dummy/public/favicon.ico +0 -0
  63. data/test/dummy/script/rails +6 -0
  64. data/test/dummy/tmp/cache/assets/C1D/4E0/sprockets%2F739624486543201dc3434ad6729370bc +0 -0
  65. data/test/dummy/tmp/cache/assets/C4E/D70/sprockets%2Ff5e5310a254eb54036f350b791585782 +0 -0
  66. data/test/dummy/tmp/cache/assets/C55/2B0/sprockets%2F1626871070b0d633088854fdeb9f3481 +0 -0
  67. data/test/dummy/tmp/cache/assets/C74/A60/sprockets%2F755dd98111da6803e0921a2b936c2431 +0 -0
  68. data/test/dummy/tmp/cache/assets/C77/F70/sprockets%2F7a6537b67d6941d04be3b048247130b4 +0 -0
  69. data/test/dummy/tmp/cache/assets/C8C/180/sprockets%2Fe57b64f1f26a999459a445f61132640e +0 -0
  70. data/test/dummy/tmp/cache/assets/C90/550/sprockets%2F855219924e750f228e295eff64e0930c +0 -0
  71. data/test/dummy/tmp/cache/assets/CAD/F80/sprockets%2F108682e15466bac605e45b535c8d8b51 +0 -0
  72. data/test/dummy/tmp/cache/assets/CB3/E00/sprockets%2F1487a0b790ea9c113356f8843d9c1c46 +0 -0
  73. data/test/dummy/tmp/cache/assets/CBA/7F0/sprockets%2Fa45db09679196c64ca77a30e5367b709 +0 -0
  74. data/test/dummy/tmp/cache/assets/CBC/EE0/sprockets%2F719c209c142d29f28cd94b578db12957 +0 -0
  75. data/test/dummy/tmp/cache/assets/CC3/0D0/sprockets%2F25b071420aae38405c5a8fc26a005a93 +0 -0
  76. data/test/dummy/tmp/cache/assets/CD8/370/sprockets%2F357970feca3ac29060c1e3861e2c0953 +0 -0
  77. data/test/dummy/tmp/cache/assets/CDB/3F0/sprockets%2Fad645ac4a1e33af5590c9a6978342161 +0 -0
  78. data/test/dummy/tmp/cache/assets/CE3/850/sprockets%2F40be67a644b41366f932af60a9579b3e +0 -0
  79. data/test/dummy/tmp/cache/assets/CEF/3A0/sprockets%2F6ac171e3c8757bae6f047955b97860a7 +0 -0
  80. data/test/dummy/tmp/cache/assets/CF2/D90/sprockets%2F1491646b6d61f9f5188be97d08e81f0b +0 -0
  81. data/test/dummy/tmp/cache/assets/CF6/3A0/sprockets%2Faf07db99788233cefc36778823457dd0 +0 -0
  82. data/test/dummy/tmp/cache/assets/CFC/D90/sprockets%2Fe4b05e0b49eb4b43717ed0c11874241a +0 -0
  83. data/test/dummy/tmp/cache/assets/D02/950/sprockets%2F903bb0454bd7d7029ae4e18042c18e3d +0 -0
  84. data/test/dummy/tmp/cache/assets/D03/C30/sprockets%2Fb3392033dc620d6c18c1eb53325f79ea +0 -0
  85. data/test/dummy/tmp/cache/assets/D11/1D0/sprockets%2Ffb6857e1a830b5c01a7a7f95061d75e6 +0 -0
  86. data/test/dummy/tmp/cache/assets/D11/2D0/sprockets%2F61048ddf16f9170372e395fdbfe7c111 +0 -0
  87. data/test/dummy/tmp/cache/assets/D26/BE0/sprockets%2Fd9e65a9a7b44ee9e174852d4f02877c5 +0 -0
  88. data/test/dummy/tmp/cache/assets/D2B/EE0/sprockets%2Fdaf1a1ec1603262c76f2790d4a7d16b0 +0 -0
  89. data/test/dummy/tmp/cache/assets/D30/110/sprockets%2F03ad68ef28529deffab712032321b09a +0 -0
  90. data/test/dummy/tmp/cache/assets/D32/A10/sprockets%2F13fe41fee1fe35b49d145bcc06610705 +0 -0
  91. data/test/dummy/tmp/cache/assets/D48/2C0/sprockets%2F8e529e98372f1f3f053a0548dbc8eb1d +0 -0
  92. data/test/dummy/tmp/cache/assets/D49/BB0/sprockets%2F4a893aee169533fae97b14d92d81a2e7 +0 -0
  93. data/test/dummy/tmp/cache/assets/D4E/1B0/sprockets%2Ff7cbd26ba1d28d48de824f0e94586655 +0 -0
  94. data/test/dummy/tmp/cache/assets/D59/B50/sprockets%2Fb8fd46bec7506cf847c5a9594e2f7663 +0 -0
  95. data/test/dummy/tmp/cache/assets/D5A/EA0/sprockets%2Fd771ace226fc8215a3572e0aa35bb0d6 +0 -0
  96. data/test/dummy/tmp/cache/assets/D5F/1F0/sprockets%2Ff035ba11a32430823c5c8ff96abd72ce +0 -0
  97. data/test/dummy/tmp/cache/assets/D64/E20/sprockets%2Fafd22930313b91b2a139f7caead4d939 +0 -0
  98. data/test/dummy/tmp/cache/assets/D71/D80/sprockets%2F5afdec623b4a5a33df858830de6832b7 +0 -0
  99. data/test/dummy/tmp/cache/assets/D74/0F0/sprockets%2F458ea608cac57e3099bc67e209bec5e0 +0 -0
  100. data/test/dummy/tmp/cache/assets/D7C/310/sprockets%2F76dddefdbf5096c2d585e7c268104c28 +0 -0
  101. data/test/dummy/tmp/cache/assets/D94/B20/sprockets%2F1f2888ce23a9d0c24cba73e2ed2152de +0 -0
  102. data/test/dummy/tmp/cache/assets/DA0/FB0/sprockets%2F24add0e994f1f584e303468d31fbbfdc +0 -0
  103. data/test/dummy/tmp/cache/assets/DA9/260/sprockets%2F49cac72ca7ef9039c4a70ec05ed4877f +0 -0
  104. data/test/dummy/tmp/cache/assets/DAF/020/sprockets%2F6c6c9dafe9ab965e8e119a18def04365 +0 -0
  105. data/test/dummy/tmp/cache/assets/DB7/080/sprockets%2F9a176a8883e2f7fddb5d549cd8b6ba59 +0 -0
  106. data/test/dummy/tmp/cache/assets/DC0/0F0/sprockets%2Fa92c36f3dfe420130eadd06fcb928eb1 +0 -0
  107. data/test/dummy/tmp/cache/assets/DC3/BF0/sprockets%2F5272feae2c50ff7b44cf2300ca3f4f4f +0 -0
  108. data/test/dummy/tmp/cache/assets/DD1/B00/sprockets%2F6e7fcc6186dc0fb184ef1bd62edb2492 +0 -0
  109. data/test/dummy/tmp/cache/assets/DD6/3F0/sprockets%2F29851c22d63cdeebd6abb93892a76efc +0 -0
  110. data/test/dummy/tmp/cache/assets/DD8/540/sprockets%2F939b54cec0b9462f3da3bf0de95ff57b +0 -0
  111. data/test/dummy/tmp/cache/assets/DDC/400/sprockets%2Fcffd775d018f68ce5dba1ee0d951a994 +0 -0
  112. data/test/dummy/tmp/cache/assets/DE7/B50/sprockets%2Fbec0bb2a9a10227d101fe6cfd4f6ad38 +0 -0
  113. data/test/dummy/tmp/cache/assets/DEC/CF0/sprockets%2F62cfa362b64bf70b3db8d27cd1aa5bc4 +0 -0
  114. data/test/dummy/tmp/cache/assets/E04/890/sprockets%2F2f5173deea6c795b8fdde723bb4b63af +0 -0
  115. data/test/dummy/tmp/cache/assets/E0C/710/sprockets%2Febadee730bcde3be0798f0c88d68908d +0 -0
  116. data/test/dummy/tmp/cache/assets/E35/320/sprockets%2F673e47df2da9eaec80fc3fdb0f662ed4 +0 -0
  117. data/test/dummy/tmp/cache/assets/E8C/050/sprockets%2Fcaceba04f165a4b7fa69aedb8c49f4cf +0 -0
  118. data/test/dummy/tmp/pids/server.pid +1 -0
  119. data/test/fixtures/atom_smasher/feeds.yml +7 -0
  120. data/test/fixtures/atom_smasher/posts.yml +11 -0
  121. data/test/functional/atom_smasher/feeds_controller_test.rb +11 -0
  122. data/test/integration/navigation_test.rb +10 -0
  123. data/test/test_helper.rb +15 -0
  124. data/test/unit/atom_smasher/feed_test.rb +9 -0
  125. data/test/unit/atom_smasher/post_test.rb +9 -0
  126. data/test/unit/helpers/atom_smasher/feeds_helper_test.rb +6 -0
  127. metadata +380 -0
@@ -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 "foundation"
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,5 @@
1
+ module AtomSmasher
2
+ class ApplicationController < ActionController::Base
3
+ layout 'atom_smasher/application'
4
+ end
5
+ end
@@ -0,0 +1,35 @@
1
+ require_dependency "atom_smasher/application_controller"
2
+ require 'open-uri'
3
+
4
+ module AtomSmasher
5
+ class FeedsController < ApplicationController
6
+ def index
7
+ @feeds = Feed.all
8
+ end
9
+ def show
10
+ @feeds = Feed.all
11
+ @feed = Feed.find(params[:id])
12
+ end
13
+
14
+ def new
15
+ @feed = Feed.new
16
+ respond_to do |format|
17
+ format.html # new.html.erb
18
+ format.json { render json: @feed }
19
+ end
20
+ end
21
+
22
+ def create
23
+ @feed = Feed.new(params[:feed])
24
+ respond_to do |format|
25
+ if @feed.save
26
+ format.html { redirect_to feeds_path, notice: 'Experiment was successfully created.' }
27
+ format.json { render json: @feed, status: :created, location: @feed }
28
+ else
29
+ format.html { render action: "new" }
30
+ format.json { render json: @feed.errors, status: :unprocessable_entity }
31
+ end
32
+ end
33
+ end
34
+ end
35
+ end
@@ -0,0 +1,4 @@
1
+ module AtomSmasher
2
+ module ApplicationHelper
3
+ end
4
+ end
@@ -0,0 +1,4 @@
1
+ module AtomSmasher
2
+ module FeedsHelper
3
+ end
4
+ end
@@ -0,0 +1,36 @@
1
+ module AtomSmasher
2
+ class Feed < ActiveRecord::Base
3
+ has_many :posts, dependent: :destroy
4
+ attr_accessible :url
5
+ attr_reader :title
6
+ after_find :get_info_from_stream
7
+
8
+
9
+ private
10
+ def get_info_from_stream
11
+ get_attributes_from_feed
12
+ get_new_posts_from_feed
13
+ end
14
+
15
+ def get_attributes_from_feed
16
+ @rss = SimpleRSS.parse(open(url))
17
+ @title = @rss.title
18
+ end
19
+
20
+ def get_new_posts_from_feed
21
+ recent_items = @rss.items
22
+ recent_item = recent_items.shift
23
+ recent_post = posts.where(link: URI::encode(recent_item.link.strip)).first
24
+ until recent_post || !recent_item
25
+ post = posts.build
26
+ post.link = URI::encode(recent_item.link.strip)
27
+ post.title = recent_item.title
28
+ source = open(URI::encode(recent_item.link.strip)).read
29
+ post.content = Readability::Document.new(source, tags: %w[], attributes: %w[]).content
30
+ recent_item = recent_items.shift
31
+ recent_post = posts.where(link: recent_item.link).first if recent_item
32
+ end
33
+ save
34
+ end
35
+ end
36
+ end
@@ -0,0 +1,6 @@
1
+ module AtomSmasher
2
+ class Post < ActiveRecord::Base
3
+ attr_accessible :content, :feed_id, :title
4
+ belongs_to :feed
5
+ end
6
+ end
@@ -0,0 +1,13 @@
1
+ = form_for @feed do |f|
2
+ -if @feed.errors.any?
3
+ #error_explanation
4
+ %h2= "#{pluralize(@feed.errors.count, "error")} prohibited this sentence from being saved:"
5
+ %ul
6
+ - @feed.errors.full_messages.each do |msg|
7
+ %li= msg
8
+
9
+ .field
10
+ = f.label :url
11
+ = f.text_field :url
12
+ .actions
13
+ = f.submit 'Save'
@@ -0,0 +1 @@
1
+ .large-9.push-3.columns
@@ -0,0 +1,5 @@
1
+ %h1 New feed
2
+
3
+ = render 'form'
4
+
5
+ = link_to 'Back', feeds_path
@@ -0,0 +1,15 @@
1
+ .large-9.push-3.columns
2
+
3
+ %h2= @feed.title
4
+
5
+ .section-container.accordion{data: {section: "accordion"}}
6
+ - @feed.posts.each do |post|
7
+ %section.section
8
+ %p.title= link_to post.title, "#"
9
+ .content
10
+ %p
11
+ = post.content
12
+
13
+
14
+
15
+
@@ -0,0 +1,18 @@
1
+ %head
2
+ %title AtomSmasher
3
+ = stylesheet_link_tag "application", :media => "all"
4
+ = javascript_include_tag "application"
5
+ = csrf_meta_tags
6
+ %body
7
+ .row
8
+ = yield
9
+ - if @feeds
10
+ .large-3.pull-9.columns
11
+ %ul.side-nav
12
+ - @feeds.each do |feed|
13
+ %li
14
+ = link_to feed.title, feed
15
+ %li= link_to "subscribe", new_feed_path
16
+
17
+ %script
18
+ $(document).foundation();
data/config/routes.rb ADDED
@@ -0,0 +1,4 @@
1
+ AtomSmasher::Engine.routes.draw do
2
+ resources :feeds
3
+
4
+ end
@@ -0,0 +1,9 @@
1
+ class CreateAtomSmasherFeeds < ActiveRecord::Migration
2
+ def change
3
+ create_table :atom_smasher_feeds do |t|
4
+ t.string :url
5
+
6
+ t.timestamps
7
+ end
8
+ end
9
+ end
@@ -0,0 +1,11 @@
1
+ class CreateAtomSmasherPosts < ActiveRecord::Migration
2
+ def change
3
+ create_table :atom_smasher_posts do |t|
4
+ t.integer :feed_id
5
+ t.text :content
6
+ t.string :title
7
+
8
+ t.timestamps
9
+ end
10
+ end
11
+ end
@@ -0,0 +1,5 @@
1
+ class AddLinkToAtomSmasherPosts < ActiveRecord::Migration
2
+ def change
3
+ add_column :atom_smasher_posts, :link, :string
4
+ end
5
+ end
@@ -0,0 +1,5 @@
1
+ require "atom_smasher/engine"
2
+ require "zurb-foundation"
3
+
4
+ module AtomSmasher
5
+ end
@@ -0,0 +1,5 @@
1
+ module AtomSmasher
2
+ class Engine < ::Rails::Engine
3
+ isolate_namespace AtomSmasher
4
+ end
5
+ end
@@ -0,0 +1,3 @@
1
+ module AtomSmasher
2
+ VERSION = "0.0.2"
3
+ end
@@ -0,0 +1,4 @@
1
+ # desc "Explaining what the task does"
2
+ # task :atom_smasher do
3
+ # # Task goes here
4
+ # end
@@ -0,0 +1,7 @@
1
+ require 'test_helper'
2
+
3
+ class MetaphorssTest < ActiveSupport::TestCase
4
+ test "truth" do
5
+ assert_kind_of Module, AtomSmasher
6
+ end
7
+ 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.