swf_fu 1.3.3 → 2.0.0

data/README.rdoc

@@ -6,48 +6,21 @@ With the +swf_fu+ plugin, rails treats your swf files like any other asset (imag
 SWFObject 2 is such a nice library that Adobe now uses it as the official way to embed swf!
 SWFObject's project can be found at http://code.google.com/p/swfobject
 
-+swf_fu+ has been tested with rails v2.0 up to v3.0b and has decent test coverage so <tt>rake test:plugins</tt> should reveal any incompatibility. Comments and pull requests welcome: http://github.com/marcandre/swf_fu
+Version 2 of +swf_fu+ is an engine for Rails 3.1+ and Ruby 1.8.7+. Use version 1.x for previous versions of Rails.
 
-== Install
-
-Assuming you have git[http://git-scm.com/] installed (check with <q>git version</q>), it is easy to install from your applications directory
-
-As a plugin:
-
-  # rails 3
-  rails plugin install git://github.com/marcandre/swf_fu.git
-
-  # rails 2 (starting at 2.0.2)
-  script/plugin install git://github.com/marcandre/swf_fu.git
-
-As a gem:
-
-  [sudo] gem install swf_fu
-
-In rails:
+Comments and pull requests welcome: http://github.com/marcandre/swf_fu
 
-  # Using bundler (Rails 3.0 or 2.3.x)
-  gem 'swf_fu', ‘>=1.3.2', :require => “swf_fu”
-
-  # Rails 2.3.x
-  config.gem 'swf_fu', :lib => 'swf_fu', :version => '>=1.3.2', :source => 'http://gemcutter.org/‘
-
-Because gems don't have install/uninstall hooks like plugins, there is some additional setup:
-
-  # Rakefile add
-  require 'swf_fu/tasks'
+== Install
 
-Install/uninstall swf_fu assets:
+Add to your +Gemfile+:
 
-  rake swf:install    # Install swf_fu assets into your rails application
-  rake swf:uninstall  # Uninstall swf_fu assets from your rails application
+  gem "swf_fu", "~> 2.0"
 
-For older versions of +rails+ or without +git+, you can always download
-+swf_fu+ from github[http://github.com/marcandre/swf_fu/archives/master] and then install it manually:
+Then run `bundle install`.
 
-  rails plugin install ~/Download/swf_fu    # rails 3
+You also need to require some javascripts, so in your `app/assets/javascripts/application.js` you want to append:
 
-  script/plugin install ~/Downloads/swf_fu  # rails 2.x
+  \\= require swf_fu
 
 == Usage
 
@@ -57,10 +30,10 @@ To embed a swf file, use +swf_tag+:
   <%= swf_tag "i_like_flashing" %>
 
 Exactly like images and javascripts, +swf_tag+ will use +swf_path+
-to determine the path of the swf file; it will assume it is in <tt>/public/swfs/</tt>
+to determine the path of the swf file; it will assume it is in <tt>/assets/swfs/</tt> or in <tt>/public/swfs/</tt>
 unless specified otherwise and it will add the ".swf" extension automatically.
 
-You can specify alternate content either with the options <q>:alt => "Get Flash!"</q> or you can use +swf_tag+ as a block:
+You can specify alternate content either with the options <tt>:alt => "Get Flash!"</tt> or you can use +swf_tag+ as a block:
 
   <% swf_tag "i_like_flashing" do %>
     Get Flash
@@ -74,37 +47,44 @@ You can specify alternate content either with the options <q>:alt => "Get Flash!
 * <tt>:mode</tt> - Either :dynamic (default) or :static. Refer to SWFObject's doc[http://code.google.com/p/swfobject/wiki/documentation#Should_I_use_the_static_or_dynamic_publishing_method?]
 * <tt>:flashvars</tt> - a Hash of variables that are passed to the swf. Can also be a string like <tt>"foo=bar&hello=world"</tt>. Defaults to <tt>{:id => the DOM id}</tt>
 * <tt>:parameters</tt> - a Hash of configuration parameters for the swf. See Adobe's doc[http://kb.adobe.com/selfservice/viewContent.do?externalId=tn_12701#optional]
+* <tt>:html_options</tt> - a Hash of extra html options for the <tt>object</tt> tag.
 * <tt>:alt</tt> - HTML text that is displayed when the Flash player is not available. Defaults to a "Get Flash" image pointing to Adobe Flash's installation page. This can also be specified as a block (see embedding section). In Rails 3, this text is _assumed_ to be HTML, so there is no need to call +html_safe+ on it.
 * <tt>:flash_version</tt> - the version of the Flash player that is required (e.g. "7" (default) or "8.1.0")
 * <tt>:auto_install</tt> - a swf file that will upgrade flash player if needed (defaults to "expressInstall" which was installed by +swf_fu+)
-* <tt>:javascript_class</tt> - specify a javascript class (e.g. "MyFlash") for your flash object. If it exists, the initialize method will be called.
+* <tt>:javascript_class</tt> - specify a javascript class (e.g. "MyFlash") for your flash object. If it exists, the +initialize+ method will be called. See the 'dummy' example in the test folder
 * <tt>:initialize</tt> - arguments to pass to the initialization method of your javascript class.
-* <tt>:div_id</tt> - the DOM +id+ of the containing div itself. Defaults to <tt>"#{option[:id]}"_div</tt>
+* <tt>:div_id</tt> - the DOM +id+ of the containing div itself. Defaults to <tt>"#{option[:id]}_div"</tt>
 * <tt>:switch_off_auto_hide_show</tt> - switch off SWFObject's default hide/show behavior. SWFObject temporarily hides your SWF or alternative content until the library has decided which content to display. Defaults to nil.
 
 You can override these default options with a global setting:
 
   ActionView::Base.swf_default_options = {:mode => :static}   # All swf_tag will use the static mode by default
 
-=== Javascript
+In your config files, you can write this as:
+
+  config.action_view.swf_default_options = {:mode => :static}   # All swf_tag will use the static mode by default
+
+Any of these options can be a +Proc+, in which case it will be called each time swf_tag is called.
+
+For example, the following will generate unique IDs:
 
-+swf_fu+ will add 'swfobject' to the list of default javascript files. If you don't include
-the default javascripts, a simple <tt>javascript_include "swfobject"</tt> is needed.
+  my_swf_counter = 0
+  config.action_view.swf_default_options[:id] = Proc.new{"swf_unique_id_#{my_swf_counter+=1}"}
 
 === swf_path
 
 +swf_tag+ implements and relies on +swf_path+ which behaves in a similar fashion to +image_path+, +javascript_path+, etc...:
 
-  swf_path("example")                            => /swfs/example.swf
-  swf_path("example.swf")                        => /swfs/example.swf
-  swf_path("fonts/optima")                       => /swfs/fonts/optima.swf
-  swf_path("/fonts/optima")                      => /fonts/optima.swf
-  swf_path("http://www.example.com/game.swf")    => http://www.example.com/game.swf
+  swf_path("example")                            => "/swfs/example.swf"
+  swf_path("example.swf")                        => "/swfs/example.swf"
+  swf_path("fonts/optima")                       => "/swfs/fonts/optima.swf"
+  swf_path("/fonts/optima")                      => "/fonts/optima.swf"
+  swf_path("http://www.example.com/game.swf")    => "http://www.example.com/game.swf"
 
 It takes into account the global setting +asset_host+, like any other asset:
 
   ActionController::Base.asset_host = "http://assets.example.com"
-  image_path("logo.jpg")                         => http://assets.example.com/images/logo.jpg
-  swf_path("fonts/optima")                       => http://assets.example.com/swfs/fonts/optima.swf
+  image_path("logo.jpg")                         => "http://assets.example.com/images/logo.jpg"
+  swf_path("fonts/optima")                       => "http://assets.example.com/swfs/fonts/optima.swf"
 
-Copyright (c) 2010 Marc-André Lafortune, released under the BSD license
+Copyright (c) 2010-2012 Marc-André Lafortune, released under the BSD license

data/Rakefile

@@ -0,0 +1,38 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Swf Fu'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/app/assets/javascripts/swf_fu.js.coffee

@@ -0,0 +1,7 @@
+#= require_tree .
+
+@SwfFu =
+  setup: (object, klass, init_args) ->
+    object extends klass.prototype
+    object.initialize?(init_args...)
+    null

data/app/helpers/swf_fu_helper.rb

@@ -0,0 +1,51 @@
+module SwfFuHelper
+  # Returns a set of tags that display a Flash object within an
+  # HTML page.
+  #
+  # Options:
+  # * <tt>:id</tt> - the DOM +id+ of the flash +object+ element that is used to contain the Flash object; defaults to the name of the swf in +source+
+  # * <tt>:width, :height</tt> - the width & height of the Flash object. Defaults to "100%". These could also specified using :size
+  # * <tt>:size</tt> - the size of the Flash object, in the form "400x300".
+  # * <tt>:mode</tt> - Either :dynamic (default) or :static. Refer to SWFObject's doc[http://code.google.com/p/swfobject/wiki/documentation#Should_I_use_the_static_or_dynamic_publishing_method?]
+  # * <tt>:flashvars</tt> - a Hash of variables that are passed to the swf. Can also be a string like <tt>"foo=bar&hello=world"</tt>
+  # * <tt>:parameters</tt> - a Hash of configuration parameters for the swf. See Adobe's doc[http://kb.adobe.com/selfservice/viewContent.do?externalId=tn_12701#optional]
+  # * <tt>:alt</tt> - HTML text that is displayed when the Flash player is not available. Defaults to a "Get Flash" image pointing to Adobe Flash's installation page.
+  # * <tt>:flash_version</tt> - the version of the Flash player that is required (e.g. "7" (default) or "8.1.0")
+  # * <tt>:auto_install</tt> - a swf file that will upgrade flash player if needed (defaults to "expressInstall" which was installed by swf_fu)
+  # * <tt>:javascript_class</tt> - specify a javascript class (e.g. "MyFlash") for your flash object. The initialize method will be called when the flash object is ready.
+  # * <tt>:initialize</tt> - arguments to pass to the initialization method of your javascript class.
+  # * <tt>:div_id</tt> - the DOM +id+ of the containing div itself. Defaults to <tt>"#{option[:id]}"_div</tt>
+  #
+  def swf_tag(source, options={}, &block)
+    ::SwfFu::Generator.new(source, options, self).generate(&block)
+  end
+
+
+  # Computes the path to an swf asset in the public 'swfs' directory.
+  # Full paths from the document root will be passed through.
+  # Used internally by +swf_tag+ to build the swf path.
+  #
+  # ==== Examples
+  #     swf_path("example")                            # => /swfs/example.swf
+  #     swf_path("example.swf")                        # => /swfs/example.swf
+  #     swf_path("fonts/optima")                       # => /swfs/fonts/optima.swf
+  #     swf_path("/fonts/optima")                      # => /fonts/optima.swf
+  #     swf_path("http://www.example.com/game.swf")    # => http://www.example.com/game.swf
+  #   
+  # It takes into account the global setting +asset_host+, like any other asset:
+  #   
+  #     ActionController::Base.asset_host = "http://assets.example.com"
+  #     image_path("logo.jpg")                         # => http://assets.example.com/images/logo.jpg
+  #     swf_path("fonts/optima")                       # => http://assets.example.com/swfs/fonts/optima.swf
+  def swf_path(source)
+    asset_paths.compute_public_path(source, 'swfs', :ext => 'swf')
+  end
+  alias_method :path_to_swf, :swf_path # aliased to avoid conflicts with an image_path named route
+
+  # Computes the full URL to a swf asset in the public swf directory.
+  # This will use +swf_path+ internally, so most of their behaviors will be the same.
+  def swf_url(source)
+    URI.join(current_host, path_to_swf(source)).to_s
+  end
+  alias_method :url_to_swf, :swf_url # aliased to avoid conflicts with an swf_url named route
+end

data/app/models/swf_fu/generator.rb

@@ -0,0 +1,139 @@
+module SwfFu
+  DEFAULTS = {
+    :width            => "100%",
+    :height           => "100%",
+    :flash_version    => 7,
+    :mode             => :dynamic,
+    :auto_install     => "expressInstall",
+    :alt    => <<-"EOS".squeeze(" ").strip.freeze
+      <a href="http://www.adobe.com/go/getflashplayer">
+        <img src="http://www.adobe.com/images/shared/download_buttons/get_flash_player.gif" alt="Get Adobe Flash player" />
+      </a>
+    EOS
+  }.freeze
+  
+  class Generator # :nodoc:
+    VALID_MODES = [:static, :dynamic]
+    def initialize(source, options, view)
+      @view = view
+      @source = view.swf_path(source)
+      options = ActionView::Base.swf_default_options.merge(options)
+      options.each do |key, value|
+        options[key] = value.call(source) if value.respond_to?(:call)
+      end
+      [:html_options, :parameters, :flashvars].each do |k|
+        options[k] = convert_to_hash(options[k]).reverse_merge convert_to_hash(ActionView::Base.swf_default_options[k])
+      end
+      options.reverse_merge!(DEFAULTS)
+      options[:id] ||= source.gsub(/^.*\//, '').gsub(/\.swf$/,'')
+      options[:id] = force_to_valid_id(options[:id])
+      options[:div_id] ||= options[:id]+"_div"
+      options[:div_id] = force_to_valid_id(options[:div_id])
+      options[:width], options[:height] = options[:size].scan(/^(\d*%?)x(\d*%?)$/).first if options[:size]
+      options[:auto_install] &&= @view.swf_path(options[:auto_install])
+      options[:flashvars][:id] ||= options[:id]
+      @mode = options.delete(:mode)
+      @options = options
+      unless VALID_MODES.include? @mode
+        raise ArgumentError, "options[:mode] should be either #{VALID_MODES.join(' or ')}"
+      end
+    end
+
+    def force_to_valid_id(id)
+      id = id.gsub /[^A-Za-z0-9\-_]/, "_" # HTML id can only contain these characters
+      id = "swf_" + id unless id =~ /^[A-Z]/i # HTML id must start with alpha
+      id
+    end
+
+    def generate(&block)
+      @options[:alt] = @view.capture(&block) if block_given?
+      send(@mode)
+    end
+    
+  private
+    def convert_to_hash(s)
+      case s
+        when Hash
+          s
+        when nil
+          {}
+        when String
+          s.split("&").inject({}) do |h, kvp|
+            key, value = kvp.split("=")
+            h[key.to_sym] = CGI::unescape(value)
+            h
+          end
+        else
+          raise ArgumentError, "#{s} should be a Hash, a String or nil"
+      end
+    end
+  
+    def convert_to_string(h)
+      h.map do |key_value|
+        key_value.map{|val| CGI::escape(val.to_s)}.join("=")
+      end.join("&")
+    end
+    
+    def static
+      param_list = @options[:parameters].map{|k,v| %(<param name="#{k}" value="#{v}"/>) }.join("\n")
+      param_list += %(\n<param name="flashvars" value="#{convert_to_string(@options[:flashvars])}"/>) unless @options[:flashvars].empty?
+      html_options = @options[:html_options].map{|k,v| %(#{k}="#{v}")}.join(" ")
+      r = @view.javascript_tag(
+        %(swfobject.registerObject("#{@options[:id]}_container", "#{@options[:flash_version]}", #{convert_to_escaped_arguments(@options[:auto_install])});)
+      )
+      r << <<-"EOS".strip.html_safe
+        <div id="#{@options[:div_id]}"><object classid="clsid:D27CDB6E-AE6D-11cf-96B8-444553540000" width="#{@options[:width]}" height="#{@options[:height]}" id="#{@options[:id]}_container" #{html_options}>
+          <param name="movie" value="#{@source}" />
+          #{param_list}
+          <!--[if !IE]>-->
+          <object type="application/x-shockwave-flash" data="#{@source}" width="#{@options[:width]}" height="#{@options[:height]}" id="#{@options[:id]}">
+          #{param_list}
+          <!--<![endif]-->
+            #{@options[:alt]}
+          <!--[if !IE]>-->
+          </object>
+          <!--<![endif]-->
+        </object></div>
+      EOS
+      r << @view.javascript_tag(extend_js) if @options[:javascript_class]
+      r << library_check
+      r
+    end
+  
+    def dynamic
+      @options[:html_options] = @options[:html_options].merge(:id => @options[:id])
+      @options[:parameters] = @options[:parameters].dup # don't modify the original parameters
+      args = convert_to_escaped_arguments(@source,
+                                          *@options.values_at(:div_id,:width,:height,:flash_version).map(&:to_s), 
+                                          *@options.values_at(:auto_install,:flashvars,:parameters,:html_options)
+                                          )
+
+      preambule = @options[:switch_off_auto_hide_show] ? "swfobject.switchOffAutoHideShow();" : ""
+      r = @view.javascript_tag(preambule + "swfobject.embedSWF(#{args})") 
+      r << @view.content_tag("div", @options[:alt].html_safe, :id => @options[:div_id])
+      r << @view.javascript_tag("swfobject.addDomLoadEvent(function(){#{extend_js}})") if @options[:javascript_class]
+      r << library_check
+      r
+    end
+
+    def convert_to_escaped_arguments(*values)
+      # Note: Rails used to escape <>& but it's now a setting
+      values.map(&:to_json).join(",").gsub('>', '\u003E').gsub('<', '\u003C').gsub('&', '\u0026')
+    end
+
+    def extend_js
+      args = @options[:initialize]
+      args = [args] unless args.is_a?(Array)
+      "SwfFu.setup($('##{@options[:id]}')[0], #{@options[:javascript_class]}, [#{convert_to_escaped_arguments(*args)}])"
+    end
+  
+    def library_check
+      return "" unless 'development' == ENV['RAILS_ENV']
+      @view.javascript_tag(<<-"EOS")
+        if (typeof swfobject == 'undefined') {
+          document.getElementById('#{@options[:div_id]}').innerHTML = '<strong>Warning:</strong> SWFObject.js was not loaded properly. Make sure you require "swfobject" in your main javascript file.';
+        }
+      EOS
+    end
+  end #class Generator
+end

data/lib/swf_fu.rb

@@ -1,2 +1,15 @@
-require File.join(File.dirname(__FILE__), '/action_view/helpers/swf_fu_helper')
-require File.join(File.dirname(__FILE__), '/action_view/helpers/asset_tag_helper/swf_asset')
+module SwfFu
+  class Engine < Rails::Engine
+    # Thanks to http://robots.thoughtbot.com/post/159805560/tips-for-writing-your-own-rails-engine for:
+    config.to_prepare do
+      ActionView::Helpers.class_eval  { include SwfFuHelper }
+    end
+    # Thanks to http://jonswope.com/2010/07/25/rails-3-engines-plugins-and-static-assets/ for:
+    initializer "static assets" do |app|
+      app.middleware.use ::ActionDispatch::Static, "#{root}/public"
+    end
+  end
+
+  ::ActionView::Base.cattr_accessor :swf_default_options
+  ::ActionView::Base.swf_default_options = {}
+end

data/lib/swf_fu/version.rb

@@ -0,0 +1,3 @@
+module SwfFu
+  VERSION = '2.0.0'
+end

data/lib/tasks/swf_fu_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :swf_fu do
+#   # Task goes here
+# end

data/test/dummy/README.rdoc

@@ -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.