Permalink
Browse files

Added getting_started code, updated guide with link to rails github r…

…epo and path to code
  • Loading branch information...
1 parent 4bcacc8 commit d7154d483269fc25d771d5b8b7b8a2c889e4b3f5 @jrgifford jrgifford committed Sep 12, 2011
Showing with 1,417 additions and 0 deletions.
  1. +32 −0 railties/guides/code/getting_started/Gemfile
  2. +261 −0 railties/guides/code/getting_started/README
  3. +7 −0 railties/guides/code/getting_started/Rakefile
  4. BIN railties/guides/code/getting_started/app/assets/images/rails.png
  5. +9 −0 railties/guides/code/getting_started/app/assets/javascripts/application.js
  6. +3 −0 railties/guides/code/getting_started/app/assets/javascripts/comments.js.coffee
  7. +3 −0 railties/guides/code/getting_started/app/assets/javascripts/home.js.coffee
  8. +3 −0 railties/guides/code/getting_started/app/assets/javascripts/posts.js.coffee
  9. +7 −0 railties/guides/code/getting_started/app/assets/stylesheets/application.css
  10. +3 −0 railties/guides/code/getting_started/app/assets/stylesheets/comments.css.scss
  11. +3 −0 railties/guides/code/getting_started/app/assets/stylesheets/home.css.scss
  12. +3 −0 railties/guides/code/getting_started/app/assets/stylesheets/posts.css.scss
  13. +56 −0 railties/guides/code/getting_started/app/assets/stylesheets/scaffolds.css.scss
  14. +3 −0 railties/guides/code/getting_started/app/controllers/application_controller.rb
  15. +16 −0 railties/guides/code/getting_started/app/controllers/comments_controller.rb
  16. +5 −0 railties/guides/code/getting_started/app/controllers/home_controller.rb
  17. +84 −0 railties/guides/code/getting_started/app/controllers/posts_controller.rb
  18. +2 −0 railties/guides/code/getting_started/app/helpers/application_helper.rb
  19. +2 −0 railties/guides/code/getting_started/app/helpers/comments_helper.rb
  20. +2 −0 railties/guides/code/getting_started/app/helpers/home_helper.rb
  21. +5 −0 railties/guides/code/getting_started/app/helpers/posts_helper.rb
  22. 0 railties/guides/code/getting_started/app/mailers/.gitkeep
  23. 0 railties/guides/code/getting_started/app/models/.gitkeep
  24. +3 −0 railties/guides/code/getting_started/app/models/comment.rb
  25. +11 −0 railties/guides/code/getting_started/app/models/post.rb
  26. +3 −0 railties/guides/code/getting_started/app/models/tag.rb
  27. +15 −0 railties/guides/code/getting_started/app/views/comments/_comment.html.erb
  28. +13 −0 railties/guides/code/getting_started/app/views/comments/_form.html.erb
  29. +2 −0 railties/guides/code/getting_started/app/views/home/index.html.erb
  30. +2 −0 railties/guides/code/getting_started/app/views/home/index.html.erb~
  31. +14 −0 railties/guides/code/getting_started/app/views/layouts/application.html.erb
  32. +32 −0 railties/guides/code/getting_started/app/views/posts/_form.html.erb
  33. +6 −0 railties/guides/code/getting_started/app/views/posts/edit.html.erb
  34. +27 −0 railties/guides/code/getting_started/app/views/posts/index.html.erb
  35. +5 −0 railties/guides/code/getting_started/app/views/posts/new.html.erb
  36. +31 −0 railties/guides/code/getting_started/app/views/posts/show.html.erb
  37. +12 −0 railties/guides/code/getting_started/app/views/tags/_form.html.erb
  38. +4 −0 railties/guides/code/getting_started/config.ru
  39. +48 −0 railties/guides/code/getting_started/config/application.rb
  40. +6 −0 railties/guides/code/getting_started/config/boot.rb
  41. +25 −0 railties/guides/code/getting_started/config/database.yml
  42. +5 −0 railties/guides/code/getting_started/config/environment.rb
  43. +30 −0 railties/guides/code/getting_started/config/environments/development.rb
  44. +60 −0 railties/guides/code/getting_started/config/environments/production.rb
  45. +42 −0 railties/guides/code/getting_started/config/environments/test.rb
  46. +7 −0 railties/guides/code/getting_started/config/initializers/backtrace_silencers.rb
  47. +10 −0 railties/guides/code/getting_started/config/initializers/inflections.rb
  48. +5 −0 railties/guides/code/getting_started/config/initializers/mime_types.rb
  49. +7 −0 railties/guides/code/getting_started/config/initializers/secret_token.rb
  50. +8 −0 railties/guides/code/getting_started/config/initializers/session_store.rb
  51. +14 −0 railties/guides/code/getting_started/config/initializers/wrap_parameters.rb
  52. +5 −0 railties/guides/code/getting_started/config/locales/en.yml
  53. +64 −0 railties/guides/code/getting_started/config/routes.rb
  54. +60 −0 railties/guides/code/getting_started/config/routes.rb~
  55. +11 −0 railties/guides/code/getting_started/db/migrate/20110901012504_create_posts.rb
  56. +12 −0 railties/guides/code/getting_started/db/migrate/20110901012815_create_comments.rb
  57. +11 −0 railties/guides/code/getting_started/db/migrate/20110901013701_create_tags.rb
  58. +43 −0 railties/guides/code/getting_started/db/schema.rb
  59. +7 −0 railties/guides/code/getting_started/db/seeds.rb
  60. +2 −0 railties/guides/code/getting_started/doc/README_FOR_APP
  61. 0 railties/guides/code/getting_started/lib/assets/.gitkeep
  62. 0 railties/guides/code/getting_started/lib/tasks/.gitkeep
  63. +26 −0 railties/guides/code/getting_started/public/404.html
  64. +26 −0 railties/guides/code/getting_started/public/422.html
  65. +26 −0 railties/guides/code/getting_started/public/500.html
  66. 0 railties/guides/code/getting_started/public/favicon.ico
  67. +5 −0 railties/guides/code/getting_started/public/robots.txt
  68. +6 −0 railties/guides/code/getting_started/script/rails
  69. 0 railties/guides/code/getting_started/test/fixtures/.gitkeep
  70. +11 −0 railties/guides/code/getting_started/test/fixtures/comments.yml
  71. +11 −0 railties/guides/code/getting_started/test/fixtures/posts.yml
  72. +9 −0 railties/guides/code/getting_started/test/fixtures/tags.yml
  73. 0 railties/guides/code/getting_started/test/functional/.gitkeep
  74. +7 −0 railties/guides/code/getting_started/test/functional/comments_controller_test.rb
  75. +9 −0 railties/guides/code/getting_started/test/functional/home_controller_test.rb
  76. +49 −0 railties/guides/code/getting_started/test/functional/posts_controller_test.rb
  77. 0 railties/guides/code/getting_started/test/integration/.gitkeep
  78. +12 −0 railties/guides/code/getting_started/test/performance/browsing_test.rb
  79. +13 −0 railties/guides/code/getting_started/test/test_helper.rb
  80. 0 railties/guides/code/getting_started/test/unit/.gitkeep
  81. +7 −0 railties/guides/code/getting_started/test/unit/comment_test.rb
  82. +4 −0 railties/guides/code/getting_started/test/unit/helpers/comments_helper_test.rb
  83. +4 −0 railties/guides/code/getting_started/test/unit/helpers/home_helper_test.rb
  84. +4 −0 railties/guides/code/getting_started/test/unit/helpers/posts_helper_test.rb
  85. +7 −0 railties/guides/code/getting_started/test/unit/post_test.rb
  86. +7 −0 railties/guides/code/getting_started/test/unit/tag_test.rb
  87. 0 railties/guides/code/getting_started/vendor/assets/stylesheets/.gitkeep
  88. 0 railties/guides/code/getting_started/vendor/plugins/.gitkeep
  89. +3 −0 railties/guides/source/getting_started.textile
@@ -0,0 +1,32 @@
+source 'http://rubygems.org'
+
+gem 'rails', '3.1.0'
+# Bundle edge Rails instead:
+# gem 'rails', :git => 'git://github.com/rails/rails.git'
+
+gem 'sqlite3'
+
+
+# Gems used only for assets and not required
+# in production environments by default.
+group :assets do
+ gem 'sass-rails', " ~> 3.1.0"
+ gem 'coffee-rails', "~> 3.1.0"
+ gem 'uglifier'
+end
+
+gem 'jquery-rails'
+
+# Use unicorn as the web server
+# gem 'unicorn'
+
+# Deploy with Capistrano
+# gem 'capistrano'
+
+# To use debugger
+# gem 'ruby-debug19', :require => 'ruby-debug'
+
+group :test do
+ # Pretty printed test output
+ gem 'turn', :require => false
+end
@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+ <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+ <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+ "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+ class WeblogController < ActionController::Base
+ def destroy
+ @weblog = Weblog.find(params[:id])
+ @weblog.destroy
+ logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+ end
+ end
+
+The result will be a message in your log file along the lines of:
+
+ Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+ class WeblogController < ActionController::Base
+ def index
+ @posts = Post.all
+ debugger
+ end
+ end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+ >> @posts.inspect
+ => "[#<Post:0x14a6be8
+ @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+ #<Post:0x14a6620
+ @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+ >> @posts.first.title = "hello from a debugger"
+ => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+ >> f = @posts.first
+ => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+ >> f.
+ Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+ made to the database.
+* Passing an environment name as an argument will load the corresponding
+ environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+ |-- app
+ | |-- assets
+ | |-- images
+ | |-- javascripts
+ | `-- stylesheets
+ | |-- controllers
+ | |-- helpers
+ | |-- mailers
+ | |-- models
+ | `-- views
+ | `-- layouts
+ |-- config
+ | |-- environments
+ | |-- initializers
+ | `-- locales
+ |-- db
+ |-- doc
+ |-- lib
+ | `-- tasks
+ |-- log
+ |-- public
+ |-- script
+ |-- test
+ | |-- fixtures
+ | |-- functional
+ | |-- integration
+ | |-- performance
+ | `-- unit
+ |-- tmp
+ | |-- cache
+ | |-- pids
+ | |-- sessions
+ | `-- sockets
+ `-- vendor
+ |-- assets
+ `-- stylesheets
+ `-- plugins
+
+app
+ Holds all the code that's specific to this particular application.
+
+app/assets
+ Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+ Holds controllers that should be named like weblogs_controller.rb for
+ automated URL mapping. All controllers should descend from
+ ApplicationController which itself descends from ActionController::Base.
+
+app/models
+ Holds models that should be named like post.rb. Models descend from
+ ActiveRecord::Base by default.
+
+app/views
+ Holds the template files for the view that should be named like
+ weblogs/index.html.erb for the WeblogsController#index action. All views use
+ eRuby syntax by default.
+
+app/views/layouts
+ Holds the template files for layouts to be used with views. This models the
+ common header/footer method of wrapping views. In your views, define a layout
+ using the <tt>layout :default</tt> and create a file named default.html.erb.
+ Inside default.html.erb, call <% yield %> to render the view using this
+ layout.
+
+app/helpers
+ Holds view helpers that should be named like weblogs_helper.rb. These are
+ generated for you automatically when using generators for controllers.
+ Helpers can be used to wrap functionality for your views into methods.
+
+config
+ Configuration files for the Rails environment, the routing map, the database,
+ and other dependencies.
+
+db
+ Contains the database schema in schema.rb. db/migrate contains all the
+ sequence of Migrations for your schema.
+
+doc
+ This directory is where your application documentation will be stored when
+ generated using <tt>rake doc:app</tt>
+
+lib
+ Application specific libraries. Basically, any kind of custom code that
+ doesn't belong under controllers, models, or helpers. This directory is in
+ the load path.
+
+public
+ The directory available for the web server. Also contains the dispatchers and the
+ default HTML files. This should be set as the DOCUMENT_ROOT of your web
+ server.
+
+script
+ Helper scripts for automation and generation.
+
+test
+ Unit and functional tests along with fixtures. When using the rails generate
+ command, template test files will be generated for you and placed in this
+ directory.
+
+vendor
+ External libraries that the application depends on. Also includes the plugins
+ subdirectory. If the app has frozen rails, those gems also go here, under
+ vendor/rails/. This directory is in the load path.
@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Blog::Application.load_tasks
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
@@ -0,0 +1,9 @@
+// This is a manifest file that'll be compiled into including all the files listed below.
+// Add new JavaScript/Coffee code in separate files in this directory and they'll automatically
+// be included in the compiled file accessible from http://example.com/assets/application.js
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .
@@ -0,0 +1,3 @@
+# Place all the behaviors and hooks related to the matching controller here.
+# All this logic will automatically be available in application.js.
+# You can use CoffeeScript in this file: http://jashkenas.github.com/coffee-script/
@@ -0,0 +1,3 @@
+# Place all the behaviors and hooks related to the matching controller here.
+# All this logic will automatically be available in application.js.
+# You can use CoffeeScript in this file: http://jashkenas.github.com/coffee-script/
@@ -0,0 +1,3 @@
+# Place all the behaviors and hooks related to the matching controller here.
+# All this logic will automatically be available in application.js.
+# You can use CoffeeScript in this file: http://jashkenas.github.com/coffee-script/
@@ -0,0 +1,7 @@
+/*
+ * This is a manifest file that'll automatically include all the stylesheets available in this directory
+ * and any sub-directories. You're free to add application-wide styles to this file and they'll appear at
+ * the top of the compiled file, but it's generally better to create a new file per style scope.
+ *= require_self
+ *= require_tree .
+*/
@@ -0,0 +1,3 @@
+// Place all the styles related to the Comments controller here.
+// They will automatically be included in application.css.
+// You can use Sass (SCSS) here: http://sass-lang.com/
@@ -0,0 +1,3 @@
+// Place all the styles related to the home controller here.
+// They will automatically be included in application.css.
+// You can use Sass (SCSS) here: http://sass-lang.com/
@@ -0,0 +1,3 @@
+// Place all the styles related to the Posts controller here.
+// They will automatically be included in application.css.
+// You can use Sass (SCSS) here: http://sass-lang.com/
Oops, something went wrong. Retry.

0 comments on commit d7154d4

Please sign in to comment.