postmarkdown 0.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (93) hide show
  1. data/.gitignore +5 -0
  2. data/.rspec +1 -0
  3. data/.rvmrc +1 -0
  4. data/Gemfile +3 -0
  5. data/Rakefile +24 -0
  6. data/app/controllers/application_controller.rb +2 -0
  7. data/app/controllers/posts_controller.rb +31 -0
  8. data/app/models/post.rb +149 -0
  9. data/app/views/layouts/postmarkdown.html.haml +16 -0
  10. data/app/views/posts/_feed_link.html.haml +2 -0
  11. data/app/views/posts/_post.html.haml +15 -0
  12. data/app/views/posts/feed.xml.builder +29 -0
  13. data/app/views/posts/index.html.haml +8 -0
  14. data/app/views/posts/show.html.haml +3 -0
  15. data/lib/generators/postmarkdown/install_generator.rb +19 -0
  16. data/lib/generators/postmarkdown/override_generator.rb +44 -0
  17. data/lib/generators/postmarkdown/post_generator.rb +33 -0
  18. data/lib/generators/postmarkdown/templates/example-post.markdown +67 -0
  19. data/lib/generators/postmarkdown/usage/install.txt +10 -0
  20. data/lib/generators/postmarkdown/usage/override.txt +9 -0
  21. data/lib/generators/postmarkdown/usage/post.txt +14 -0
  22. data/lib/postmarkdown.rb +5 -0
  23. data/lib/postmarkdown/config.rb +22 -0
  24. data/lib/postmarkdown/engine.rb +12 -0
  25. data/lib/postmarkdown/railtie.rb +18 -0
  26. data/lib/postmarkdown/routes.rb +29 -0
  27. data/lib/postmarkdown/util.rb +12 -0
  28. data/lib/postmarkdown/version.rb +3 -0
  29. data/postmarkdown.gemspec +35 -0
  30. data/public/stylesheets/postmarkdown/postmarkdown.css +67 -0
  31. data/readme.md +143 -0
  32. data/spec/acceptance/posts_spec.rb +167 -0
  33. data/spec/models/posts_spec.rb +72 -0
  34. data/spec/routing/posts_routing_spec.rb +80 -0
  35. data/spec/spec_helper.rb +12 -0
  36. data/spec/support/data/posts/2011-04-01-first-post.markdown +3 -0
  37. data/spec/support/data/posts/2011-04-28-image.markdown +3 -0
  38. data/spec/support/data/posts/2011-04-28-summary.markdown +8 -0
  39. data/spec/support/data/posts/2011-05-01-full-metadata.markdown +10 -0
  40. data/spec/support/data/posts/2011-05-02-md-file-extension.md +1 -0
  41. data/spec/support/data/posts/2011-05-02-mdown-file-extension.mdown +1 -0
  42. data/spec/support/data/posts/2011-05-02-mkd-file-extension.mkd +1 -0
  43. data/spec/support/data/posts/2015-02-13-custom-title.markdown +5 -0
  44. data/spec/support/data/posts/missing-date-from-filename.markdown +1 -0
  45. data/spec/support/rails_app/.gitignore +4 -0
  46. data/spec/support/rails_app/README +256 -0
  47. data/spec/support/rails_app/Rakefile +7 -0
  48. data/spec/support/rails_app/app/controllers/application_controller.rb +3 -0
  49. data/spec/support/rails_app/app/helpers/application_helper.rb +2 -0
  50. data/spec/support/rails_app/app/posts/2011-04-01-first-post.markdown +3 -0
  51. data/spec/support/rails_app/app/posts/2011-04-28-image.markdown +3 -0
  52. data/spec/support/rails_app/app/posts/2011-04-28-summary.markdown +8 -0
  53. data/spec/support/rails_app/app/posts/2011-05-01-full-metadata.markdown +13 -0
  54. data/spec/support/rails_app/app/posts/2015-02-13-custom-title.markdown +5 -0
  55. data/spec/support/rails_app/app/views/layouts/application.html.erb +14 -0
  56. data/spec/support/rails_app/config.ru +4 -0
  57. data/spec/support/rails_app/config/application.rb +42 -0
  58. data/spec/support/rails_app/config/boot.rb +10 -0
  59. data/spec/support/rails_app/config/database.yml +22 -0
  60. data/spec/support/rails_app/config/environment.rb +5 -0
  61. data/spec/support/rails_app/config/environments/development.rb +26 -0
  62. data/spec/support/rails_app/config/environments/production.rb +49 -0
  63. data/spec/support/rails_app/config/environments/test.rb +35 -0
  64. data/spec/support/rails_app/config/initializers/backtrace_silencers.rb +7 -0
  65. data/spec/support/rails_app/config/initializers/inflections.rb +10 -0
  66. data/spec/support/rails_app/config/initializers/mime_types.rb +5 -0
  67. data/spec/support/rails_app/config/initializers/secret_token.rb +7 -0
  68. data/spec/support/rails_app/config/initializers/session_store.rb +8 -0
  69. data/spec/support/rails_app/config/locales/en.yml +5 -0
  70. data/spec/support/rails_app/config/routes.rb +3 -0
  71. data/spec/support/rails_app/db/seeds.rb +7 -0
  72. data/spec/support/rails_app/doc/README_FOR_APP +2 -0
  73. data/spec/support/rails_app/lib/tasks/.gitkeep +0 -0
  74. data/spec/support/rails_app/public/404.html +26 -0
  75. data/spec/support/rails_app/public/422.html +26 -0
  76. data/spec/support/rails_app/public/500.html +26 -0
  77. data/spec/support/rails_app/public/favicon.ico +0 -0
  78. data/spec/support/rails_app/public/images/rails.png +0 -0
  79. data/spec/support/rails_app/public/index.html +239 -0
  80. data/spec/support/rails_app/public/javascripts/application.js +2 -0
  81. data/spec/support/rails_app/public/javascripts/controls.js +965 -0
  82. data/spec/support/rails_app/public/javascripts/dragdrop.js +974 -0
  83. data/spec/support/rails_app/public/javascripts/effects.js +1123 -0
  84. data/spec/support/rails_app/public/javascripts/prototype.js +6001 -0
  85. data/spec/support/rails_app/public/javascripts/rails.js +191 -0
  86. data/spec/support/rails_app/public/robots.txt +5 -0
  87. data/spec/support/rails_app/public/stylesheets/.gitkeep +0 -0
  88. data/spec/support/rails_app/script/rails +6 -0
  89. data/spec/support/rails_app/test/performance/browsing_test.rb +9 -0
  90. data/spec/support/rails_app/test/test_helper.rb +13 -0
  91. data/spec/support/rails_app/vendor/plugins/.gitkeep +0 -0
  92. data/todo.txt +25 -0
  93. metadata +315 -0
@@ -0,0 +1,72 @@
1
+ require 'spec_helper'
2
+
3
+ describe Post do
4
+ def test_post(file_name)
5
+ Post.new(File.dirname(__FILE__) + "/../support/data/posts/#{file_name}")
6
+ end
7
+
8
+ it 'should not initialise with bad filename' do
9
+ lambda { test_post 'missing-date-from-filename.markdown' }.should raise_error
10
+ end
11
+
12
+ context 'with missing file' do
13
+ subject { test_post '2000-01-01-no-such-file.markdown' }
14
+ it 'should error when trying to read content' do
15
+ lambda { subject.content }.should raise_error
16
+ end
17
+ end
18
+
19
+ context 'with first post' do
20
+ subject { test_post '2011-04-01-first-post.markdown' }
21
+ its(:slug) { should == 'first-post' }
22
+ its(:date) { should == Date.parse('2011-04-01') }
23
+ its(:title) { should == 'First Post' }
24
+ its(:content) { should =~ /\ALorem ipsum/ }
25
+ its(:content_html) { should =~ /^<p>Lorem ipsum/ }
26
+ its(:content_html) { should =~ /^<p>Duis aute irure dolor/ }
27
+ its(:content_html) { should be_html_safe }
28
+ its(:summary_html) { should =~ /^<p>Lorem ipsum/ }
29
+ its(:summary_html) { should_not =~ /^<p>Duis aute irure dolor/ }
30
+ its(:summary_html) { should be_html_safe }
31
+ end
32
+
33
+ context 'with custom title post' do
34
+ subject { test_post '2015-02-13-custom-title.markdown' }
35
+ its(:slug) { should == 'custom-title' }
36
+ its(:date) { should == Date.parse('2015-02-13') }
37
+ its(:title) { should == 'This is a custom title' }
38
+ its(:content) { should == "Content goes here.\n" }
39
+ end
40
+
41
+ context 'with author' do
42
+ subject { test_post '2011-05-01-full-metadata.markdown' }
43
+ its(:author) { should == 'John Smith' }
44
+ its(:email) { should == 'john.smith@example.com' }
45
+ end
46
+
47
+ context 'with image post' do
48
+ subject { test_post '2011-04-28-image.markdown' }
49
+ its(:summary_html) { should =~ /^<p>Image description/ }
50
+ its(:summary_html) { should be_html_safe }
51
+ end
52
+
53
+ context 'with custom summary post' do
54
+ subject { test_post '2011-04-28-summary.markdown' }
55
+ its(:summary_html) { should == '<p>This is a custom &amp; test summary.</p>' }
56
+ its(:summary_html) { should be_html_safe }
57
+ end
58
+
59
+ context 'with alternate markdown file extension' do
60
+ it 'should accept *.md files' do
61
+ lambda { test_post('2011-05-02-md-file-extension.md').content }.should_not raise_error
62
+ end
63
+
64
+ it 'should accept *.mkd files' do
65
+ lambda { test_post('2011-05-02-mkd-file-extension.mkd').content }.should_not raise_error
66
+ end
67
+
68
+ it 'should accept *.mdown files' do
69
+ lambda { test_post('2011-05-02-mdown-file-extension.mdown').content }.should_not raise_error
70
+ end
71
+ end
72
+ end
@@ -0,0 +1,80 @@
1
+ require 'spec_helper'
2
+
3
+ describe PostsController do
4
+ describe 'default routes' do
5
+ it '/posts to Posts#index' do
6
+ path = posts_path
7
+ path.should == '/posts'
8
+ { :get => path }.should route_to :controller => 'posts', :action => 'index'
9
+ end
10
+
11
+ it '/posts/2012 to Posts#index with year' do
12
+ path = posts_path(:year => '2012')
13
+ path.should == '/posts/2012'
14
+ { :get => path }.should route_to :controller => 'posts', :action => 'index', :year => '2012'
15
+ end
16
+
17
+ it '/posts/2012/01 to Posts#index with year and month' do
18
+ path = posts_path(:year => '2012', :month => '01')
19
+ path.should == '/posts/2012/01'
20
+ { :get => path }.should route_to :controller => 'posts', :action => 'index', :year => '2012', :month => '01'
21
+ end
22
+
23
+ it '/posts/2012/01/01 to Posts#index with year, month and day' do
24
+ path = posts_path(:year => '2012', :month => '01', :day => '01')
25
+ path.should == '/posts/2012/01/01'
26
+ { :get => path }.should route_to :controller => 'posts', :action => 'index', :year => '2012', :month => '01', :day => '01'
27
+ end
28
+
29
+ it '/posts/2012/01/01/test-post to Posts#show with permalink a format of day' do
30
+ path = post_path(:id => '2012/01/01/test-post')
31
+ path.should == '/posts/2012/01/01/test-post'
32
+ { :get => path }.should route_to :controller => 'posts', :action => 'show', :id => '2012/01/01/test-post'
33
+ end
34
+ end
35
+
36
+ describe 'custom routes' do
37
+ before { Rails.application.routes.clear! }
38
+ after { Rails.application.reload_routes! }
39
+
40
+ it '/blog to Posts#index' do
41
+ Rails.application.routes.draw { postmarkdown :as => :blog }
42
+
43
+ path = posts_path
44
+ path.should == '/blog'
45
+ { :get => path }.should route_to :controller => 'posts', :action => 'index'
46
+ end
47
+
48
+ it '/blog/test-post to Posts#show with a permalink format of slug' do
49
+ Rails.application.routes.draw { postmarkdown :as => :blog, :permalink_format => :slug }
50
+
51
+ path = post_path(:id => 'test-post')
52
+ path.should == '/blog/test-post'
53
+ { :get => path }.should route_to :controller => 'posts', :action => 'show', :id => 'test-post'
54
+ end
55
+
56
+ it '/blog/2012/test-post to Posts#show with a permalink format of year' do
57
+ Rails.application.routes.draw { postmarkdown :as => :blog, :permalink_format => :year }
58
+
59
+ path = post_path(:id => '2012/test-post')
60
+ path.should == '/blog/2012/test-post'
61
+ { :get => path }.should route_to :controller => 'posts', :action => 'show', :id => '2012/test-post'
62
+ end
63
+
64
+ it '/blog/2012/01/test-post to Posts#show with permalink a format of month' do
65
+ Rails.application.routes.draw { postmarkdown :as => :blog, :permalink_format => :month }
66
+
67
+ path = post_path(:id => '2012/01/test-post')
68
+ path.should == '/blog/2012/01/test-post'
69
+ { :get => path }.should route_to :controller => 'posts', :action => 'show', :id => '2012/01/test-post'
70
+ end
71
+
72
+ it '/blog/2012/01/01/test-post to Posts#show with permalink a format of day' do
73
+ Rails.application.routes.draw { postmarkdown :as => :blog, :permalink_format => :day }
74
+
75
+ path = post_path(:id => '2012/01/01/test-post')
76
+ path.should == '/blog/2012/01/01/test-post'
77
+ { :get => path }.should route_to :controller => 'posts', :action => 'show', :id => '2012/01/01/test-post'
78
+ end
79
+ end
80
+ end
@@ -0,0 +1,12 @@
1
+ ENV['RAILS_ENV'] ||= 'test'
2
+ require 'support/rails_app/config/environment'
3
+ require 'rspec/rails'
4
+ require 'capybara/rspec'
5
+ require 'delorean'
6
+
7
+ Dir[Rails.root.join('spec/support/**/*.rb')].each {|f| require f}
8
+
9
+ RSpec.configure do |config|
10
+ config.mock_with :rspec
11
+ config.include Delorean
12
+ end
@@ -0,0 +1,3 @@
1
+ Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
2
+
3
+ Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
@@ -0,0 +1,3 @@
1
+ <img src="example.png" />
2
+
3
+ Image description.
@@ -0,0 +1,8 @@
1
+ ---
2
+ title: A Test Post
3
+ summary: This is a custom & test summary.
4
+ ---
5
+
6
+ First paragraph of content.
7
+
8
+ Second paragraph of content.
@@ -0,0 +1,10 @@
1
+ ---
2
+ title: Post with full metadata
3
+ author: John Smith
4
+ email: john.smith@example.com
5
+ summary: This is another custom & test summary.
6
+ ---
7
+
8
+ First paragraph of content.
9
+
10
+ Second paragraph of content.
@@ -0,0 +1 @@
1
+ Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
@@ -0,0 +1 @@
1
+ Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
@@ -0,0 +1 @@
1
+ Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
@@ -0,0 +1,5 @@
1
+ ---
2
+ title: This is a custom title
3
+ ---
4
+
5
+ Content goes here.
@@ -0,0 +1 @@
1
+ This post is missing the date from the filename.
@@ -0,0 +1,4 @@
1
+ .bundle
2
+ db/*.sqlite3
3
+ log/*.log
4
+ tmp/
@@ -0,0 +1,256 @@
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.find(: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.com/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
+ | |-- controllers
160
+ | |-- helpers
161
+ | |-- mailers
162
+ | |-- models
163
+ | `-- views
164
+ | `-- layouts
165
+ |-- config
166
+ | |-- environments
167
+ | |-- initializers
168
+ | `-- locales
169
+ |-- db
170
+ |-- doc
171
+ |-- lib
172
+ | `-- tasks
173
+ |-- log
174
+ |-- public
175
+ | |-- images
176
+ | |-- javascripts
177
+ | `-- stylesheets
178
+ |-- script
179
+ |-- test
180
+ | |-- fixtures
181
+ | |-- functional
182
+ | |-- integration
183
+ | |-- performance
184
+ | `-- unit
185
+ |-- tmp
186
+ | |-- cache
187
+ | |-- pids
188
+ | |-- sessions
189
+ | `-- sockets
190
+ `-- vendor
191
+ `-- plugins
192
+
193
+ app
194
+ Holds all the code that's specific to this particular application.
195
+
196
+ app/controllers
197
+ Holds controllers that should be named like weblogs_controller.rb for
198
+ automated URL mapping. All controllers should descend from
199
+ ApplicationController which itself descends from ActionController::Base.
200
+
201
+ app/models
202
+ Holds models that should be named like post.rb. Models descend from
203
+ ActiveRecord::Base by default.
204
+
205
+ app/views
206
+ Holds the template files for the view that should be named like
207
+ weblogs/index.html.erb for the WeblogsController#index action. All views use
208
+ eRuby syntax by default.
209
+
210
+ app/views/layouts
211
+ Holds the template files for layouts to be used with views. This models the
212
+ common header/footer method of wrapping views. In your views, define a layout
213
+ using the <tt>layout :default</tt> and create a file named default.html.erb.
214
+ Inside default.html.erb, call <% yield %> to render the view using this
215
+ layout.
216
+
217
+ app/helpers
218
+ Holds view helpers that should be named like weblogs_helper.rb. These are
219
+ generated for you automatically when using generators for controllers.
220
+ Helpers can be used to wrap functionality for your views into methods.
221
+
222
+ config
223
+ Configuration files for the Rails environment, the routing map, the database,
224
+ and other dependencies.
225
+
226
+ db
227
+ Contains the database schema in schema.rb. db/migrate contains all the
228
+ sequence of Migrations for your schema.
229
+
230
+ doc
231
+ This directory is where your application documentation will be stored when
232
+ generated using <tt>rake doc:app</tt>
233
+
234
+ lib
235
+ Application specific libraries. Basically, any kind of custom code that
236
+ doesn't belong under controllers, models, or helpers. This directory is in
237
+ the load path.
238
+
239
+ public
240
+ The directory available for the web server. Contains subdirectories for
241
+ images, stylesheets, and javascripts. Also contains the dispatchers and the
242
+ default HTML files. This should be set as the DOCUMENT_ROOT of your web
243
+ server.
244
+
245
+ script
246
+ Helper scripts for automation and generation.
247
+
248
+ test
249
+ Unit and functional tests along with fixtures. When using the rails generate
250
+ command, template test files will be generated for you and placed in this
251
+ directory.
252
+
253
+ vendor
254
+ External libraries that the application depends on. Also includes the plugins
255
+ subdirectory. If the app has frozen rails, those gems also go here, under
256
+ vendor/rails/. This directory is in the load path.