RubyGems - openskies - Versions diffs - 0.0.1 - Mend

openskies 0.0.1

Files changed (494) hide show

data/guides/source/ajax_on_rails.textile ADDED Viewed

@@ -0,0 +1,267 @@
+h2. AJAX on Rails
+This guide covers the built-in Ajax/JavaScript functionality of Rails (and more); it will enable you to create rich and dynamic AJAX applications with ease! We will cover the following topics:
+* Quick introduction to AJAX and related technologies
+* Unobtrusive JavaScript helpers with drivers for Prototype, jQuery etc
+* Testing JavaScript functionality
+endprologue.
+h3. Hello AJAX - a Quick Intro
+You'll need the basics of DOM, HTTP requests and other topics discussed here to really understand Ajax on Rails.
+h4. Asynchronous JavaScript + XML
+Basic terminology, new style of creating web apps
+h4. The DOM
+basics of the DOM, how is it built, properties, features, why is it central to AJAX
+h4. Standard HTML communication vs AJAX
+How do 'standard' and AJAX requests differ, why does this matter for understanding AJAX on Rails (tie in for *_remote helpers, the next section)
+h3. Built-in Rails Helpers
+Rails 3.1 ships with "jQuery":http://jquery.com as the default JavaScript library. The Gemfile contains <tt>gem 'jquery-rails'</tt> which makes the jQuery files available to the application automatically. This can be accessed as:
+<ruby>
+javascript_include_tag :defaults
+</ruby>
+h4. Examples
+All the remote_method helpers has been removed. To make them working with AJAX, simply pass the <tt>:remote => true</tt> option to the original non-remote method.
+<ruby>
+button_to "New", :action => "new", :form_class => "new-thing"
+</ruby>
+will produce
+<html>
+<form method="post" action="/controller/new" class="new-thing">
+  <div><input value="New" type="submit" /></div>
+</form>
+</html>
+<ruby>
+button_to "Create", :action => "create", :remote => true, :form => { "data-type" => "json" }
+</ruby>
+will produce
+<html>
+<form method="post" action="/images/create" class="button_to" data-remote="true" data-type="json">
+  <div><input value="Create" type="submit" /></div>
+</form>
+</html>
+<ruby>
+button_to "Delete Image", { :action => "delete", :id => @image.id },
+             :confirm => "Are you sure?", :method => :delete
+</ruby>
+will produce
+<html>
+<form method="post" action="/images/delete/1" class="button_to">
+  <div>
+    <input type="hidden" name="_method" value="delete" />
+    <input data-confirm='Are you sure?' value="Delete" type="submit" />
+ </div>
+</form>
+</html>
+<ruby>
+button_to('Destroy', 'http://www.example.com', :confirm => 'Are you sure?',
+          :method => "delete", :remote => true, :disable_with => 'loading...')
+</ruby>
+will produce
+<html>
+<form class='button_to' method='post' action='http://www.example.com' data-remote='true'>
+  <div>
+    <input name='_method' value='delete' type='hidden' />
+    <input value='Destroy' type='submit' disable_with='loading...' data-confirm='Are you sure?' />
+  </div>
+</form>
+</html>
+You can also choose to use Prototype instead of jQuery and specify the option using +-j+ switch while generating the application.
+<shell>
+rails new app_name -j prototype
+</shell>
+You are ready to add some AJAX love to your Rails app!
+h4. The Quintessential AJAX Rails Helper: link_to_remote
+Let's start with what is probably the most often used helper: +link_to_remote+. It has an interesting feature from the documentation point of view: the options supplied to +link_to_remote+ are shared by all other AJAX helpers, so learning the mechanics and options of +link_to_remote+ is a great help when using other helpers.
+The signature of +link_to_remote+ function is the same as that of the standard +link_to+ helper:
+<ruby>
+def link_to_remote(name, options = {}, html_options = nil)
+</ruby>
+And here is a simple example of link_to_remote in action:
+<ruby>
+link_to_remote "Add to cart",
+  :url => add_to_cart_url(product.id),
+  :update => "cart"
+</ruby>
+* The very first parameter, a string, is the text of the link which appears on the page.
+* The second parameter, the +options+ hash is the most interesting part as it has the AJAX specific stuff:
+** *:url* This is the only parameter that is always required to generate the simplest remote link (technically speaking, it is not required, you can pass an empty +options+ hash to +link_to_remote+ - but in this case the URL used for the POST request will be equal to your current URL which is probably not your intention). This URL points to your AJAX action handler. The URL is typically specified by Rails REST view helpers, but you can use the +url_for+ format too.
+** *:update* Specifying a DOM id of the element we would like to update. The above example demonstrates the simplest way of accomplishing this - however, we are in trouble if the server responds with an error message because that will be injected into the page too! However, Rails has a solution for this situation:
+<ruby>
+link_to_remote "Add to cart",
+  :url => add_to_cart_url(product),
+  :update => { :success => "cart", :failure => "error" }
+</ruby>
+If the server returns 200, the output of the above example is equivalent to our first, simple one. However, in case of error, the element with the DOM id +error+ is updated rather than the +cart+ element.
+** *position* By default (i.e. when not specifying this option, like in the examples before) the response is injected into the element with the specified DOM id, replacing the original content of the element (if there was any). You might want to alter this behavior by keeping the original content - the only question is where to place the new content? This can specified by the +position+ parameter, with four possibilities:
+*** +:before+ Inserts the response text just before the target element. More precisely, it creates a text node from the response and inserts it as the left sibling of the target element.
+*** +:after+ Similar behavior to +:before+, but in this case the response is inserted after the target element.
+*** +:top+ Inserts the text into the target element, before it's original content. If the target element was empty, this is equivalent with not specifying +:position+ at all.
+*** +:bottom+ The counterpart of +:top+: the response is inserted after the target element's original content.
+A typical example of using +:bottom+ is inserting a new &lt;li&gt; element into an existing list:
+<ruby>
+link_to_remote "Add new item",
+  :url => items_url,
+  :update => 'item_list',
+  :position => :bottom
+</ruby>
+** *:method* Most typically you want to use a POST request when adding a remote link to your view so this is the default behavior. However, sometimes you'll want to update (PUT) or delete/destroy (DELETE) something and you can specify this with the +:method+ option. Let's see an example for a typical AJAX link for deleting an item from a list:
+<ruby>
+link_to_remote "Delete the item",
+  :url => item_url(item),
+  :method => :delete
+</ruby>
+Note that if we wouldn't override the default behavior (POST), the above snippet would route to the create action rather than destroy.
+** *JavaScript filters* You can customize the remote call further by wrapping it with some JavaScript code. Let's say in the previous example, when deleting a link, you'd like to ask for a confirmation by showing a simple modal text box to the user. This is a typical example what you can accomplish with these options - let's see them one by one:
+*** +:confirm+ =&gt; +msg+ Pops up a JavaScript confirmation dialog, displaying +msg+. If the user chooses 'OK', the request is launched, otherwise canceled.
+*** +:condition+ =&gt; +code+ Evaluates +code+ (which should evaluate to a boolean) and proceeds if it's true, cancels the request otherwise.
+*** +:before+ =&gt; +code+ Evaluates the +code+ just before launching the request. The output of the code has no influence on the execution. Typically used show a progress indicator (see this in action in the next example).
+*** +:after+ =&gt; +code+ Evaluates the +code+ after launching the request. Note that this is different from the +:success+ or +:complete+ callback (covered in the next section) since those are triggered after the request is completed, while the code snippet passed to +:after+ is evaluated after the remote call is made. A common example is to disable elements on the page or otherwise prevent further action while the request is completed.
+*** +:submit+ =&gt; +dom_id+ This option does not make sense for +link_to_remote+, but we'll cover it for the sake of completeness. By default, the parent element of the form elements the user is going to submit is the current form - use this option if you want to change the default behavior. By specifying this option you can change the parent element to the element specified by the DOM id +dom_id+.
+*** +:with+ &gt; +code+ The JavaScript code snippet in +code+ is evaluated and added to the request URL as a parameter (or set of parameters). Therefore, +code+ should return a valid URL query string (like "item_type=8" or "item_type=8&sort=true"). Usually you want to obtain some value(s) from the page - let's see an example:
+<ruby>
+link_to_remote "Update record",
+  :url => record_url(record),
+  :method => :put,
+  :with => "'status=' <plus> 'encodeURIComponent($('status').value) <plus> '&completed=' <plus> $('completed')"
+</ruby>
+This generates a remote link which adds 2 parameters to the standard URL generated by Rails, taken from the page (contained in the elements matched by the 'status' and 'completed' DOM id).
+** *Callbacks* Since an AJAX call is typically asynchronous, as it's name suggests (this is not a rule, and you can fire a synchronous request - see the last option, +:type+) your only way of communicating with a request once it is fired is via specifying callbacks. There are six options at your disposal (in fact 508, counting all possible response types, but these six are the most frequent and therefore specified by a constant):
+*** +:loading:+ =&gt; +code+ The request is in the process of receiving the data, but the transfer is not completed yet.
+*** +:loaded:+ =&gt; +code+ The transfer is completed, but the data is not processed and returned yet
+*** +:interactive:+ =&gt; +code+ One step after +:loaded+: The data is fully received and being processed
+*** +:success:+ =&gt; +code+ The data is fully received, parsed and the server responded with "200 OK"
+*** +:failure:+ =&gt; +code+ The data is fully received, parsed and the server responded with *anything* but "200 OK" (typically 404 or 500, but in general with any status code ranging from 100 to 509)
+*** +:complete:+ =&gt; +code+ The combination of the previous two: The request has finished receiving and parsing the data, and returned a status code (which can be anything).
+*** Any other status code ranging from 100 to 509: Additionally you might want to check for other HTTP status codes, such as 404. In this case simply use the status code as a number:
+<ruby>
+link_to_remote "Add new item",
+  :url => items_url,
+  :update => "item_list",
+  404 => "alert('Item not found!')"
+</ruby>
+Let's see a typical example for the most frequent callbacks, +:success+, +:failure+ and +:complete+ in action:
+<ruby>
+link_to_remote "Add new item",
+  :url => items_url,
+  :update => "item_list",
+  :before => "$('progress').show()",
+  :complete => "$('progress').hide()",
+  :success => "display_item_added(request)",
+  :failure => "display_error(request)"
+</ruby>
+** *:type* If you want to fire a synchronous request for some obscure reason (blocking the browser while the request is processed and doesn't return a status code), you can use the +:type+ option with the value of +:synchronous+.
+* Finally, using the +html_options+ parameter you can add HTML attributes to the generated tag. It works like the same parameter of the +link_to+ helper. There are interesting side effects for the +href+ and +onclick+ parameters though:
+** If you specify the +href+ parameter, the AJAX link will degrade gracefully, i.e. the link will point to the URL even if JavaScript is disabled in the client browser
+** +link_to_remote+ gains it's AJAX behavior by specifying the remote call in the onclick handler of the link. If you supply +html_options[:onclick]+ you override the default behavior, so use this with care!
+We are finished with +link_to_remote+. I know this is quite a lot to digest for one helper function, but remember, these options are common for all the rest of the Rails view helpers, so we will take a look at the differences / additional parameters in the next sections.
+h4. AJAX Forms
+There are three different ways of adding AJAX forms to your view using Rails Prototype helpers. They are slightly different, but striving for the same goal: instead of submitting the form using the standard HTTP request/response cycle, it is submitted asynchronously, thus not reloading the page. These methods are the following:
+* +remote_form_for+ (and it's alias +form_remote_for+) is tied to Rails most tightly of the three since it takes a resource, model or array of resources (in case of a nested resource) as a parameter.
+* +form_remote_tag+ AJAXifies the form by serializing and sending it's data in the background
+* +submit_to_remote+ and +button_to_remote+ is more rarely used than the previous two. Rather than creating an AJAX form, you add a button/input
+Let's see them in action one by one!
+h5. +remote_form_for+
+h5. +form_remote_tag+
+h5. +submit_to_remote+
+h4. Observing Elements
+h5. +observe_field+
+h5. +observe_form+
+h4. Calling a Function Periodically
+h5. +periodically_call_remote+
+h4. Miscellaneous Functionality
+h5. +remote_function+
+h5. +update_page+
+h4. Serving JavaScript
+First we'll check out how to send JavaScript to the server manually. You are practically never going to need this, but it's interesting to understand what's going on under the hood.
+<ruby>
+def javascript_test
+  render :text => "alert('Hello, world!')",
+         :content_type => "text/javascript"
+end
+</ruby>
+(Note: if you want to test the above method, create a +link_to_remote+ with a single parameter - +:url+, pointing to the +javascript_test+ action)
+What happens here is that by specifying the Content-Type header variable, we instruct the browser to evaluate the text we are sending over (rather than displaying it as plain text, which is the default behavior).
+h3. Testing JavaScript
+JavaScript testing reminds me the definition of the world 'classic' by Mark Twain: "A classic is something that everybody wants to have read and nobody wants to read." It's similar with JavaScript testing: everyone would like to have it, yet it's not done by too much developers as it is tedious, complicated, there is a proliferation of tools and no consensus/accepted best practices, but we will nevertheless take a stab at it:
+* (Fire)Watir
+* Selenium
+* Celerity/Culerity
+* Cucumber+Webrat
+* Mention stuff like screw.unit/jsSpec
+Note to self: check out the RailsConf JS testing video

data/guides/source/api_documentation_guidelines.textile ADDED Viewed

@@ -0,0 +1,185 @@
+h2. API Documentation Guidelines
+This guide documents the Ruby on Rails API documentation guidelines.
+endprologue.
+h3. RDoc
+The Rails API documentation is generated with RDoc 2.5. Please consult the documentation for help with the "markup":http://rdoc.rubyforge.org/RDoc/Markup.html, and take into account also these "additional directives":http://rdoc.rubyforge.org/RDoc/Parser/Ruby.html.
+h3. Wording
+Write simple, declarative sentences. Brevity is a plus: get to the point.
+Write in present tense: "Returns a hash that...", rather than "Returned a hash that..." or "Will return a hash that...".
+Start comments in upper case, follow regular punctuation rules:
+<ruby>
+# Declares an attribute reader backed by an internally-named instance variable.
+def attr_internal_reader(*attrs)
+  ...
+end
+</ruby>
+Communicate to the reader the current way of doing things, both explicitly and implicitly. Use the recommended idioms in edge, reorder sections to emphasize favored approaches if needed, etc. The documentation should be a model for best practices and canonical, modern Rails usage.
+Documentation has to be concise but comprehensive. Explore and document edge cases. What happens if a module is anonymous? What if a collection is empty? What if an argument is nil?
+The proper names of Rails components have a space in between the words, like "Active Support". +ActiveRecord+ is a Ruby module, whereas Active Record is an ORM. All Rails documentation should consistently refer to Rails components by their proper name, and if in your next blog post or presentation you remember this tidbit and take it into account that'd be phenomenal.
+Spell names correctly: Arel, Test::Unit, RSpec, HTML, MySQL, JavaScript, ERB. When in doubt, please have a look at some authoritative source like their official documentation.
+Use the article "an" for "SQL", as in "an SQL statement". Also "an SQLite database".
+h3. English
+Please use American English (<em>color</em>, <em>center</em>, <em>modularize</em>, etc.). See "a list of American and British English spelling differences here":http://en.wikipedia.org/wiki/American_and_British_English_spelling_differences.
+h3. Example Code
+Choose meaningful examples that depict and cover the basics as well as interesting points or gotchas.
+Use two spaces to indent chunks of code--that is two spaces with respect to the left margin; the examples
+themselves should use "Rails coding conventions":contributing_to_ruby_on_rails.html#follow-the-coding-conventions.
+Short docs do not need an explicit "Examples" label to introduce snippets, they just follow paragraphs:
+<ruby>
+# Converts a collection of elements into a formatted string by calling
+# <tt>to_s</tt> on all elements and joining them.
+#
+#   Blog.all.to_formatted_s # => "First PostSecond PostThird Post"
+</ruby>
+On the other hand, big chunks of structured documentation may have a separate "Examples" section:
+<ruby>
+# ==== Examples
+#
+#   Person.exists?(5)
+#   Person.exists?('5')
+#   Person.exists?(:name => "David")
+#   Person.exists?(['name LIKE ?', "%#{query}%"])
+</ruby>
+The result of expressions follow them and are introduced by "# => ", vertically aligned:
+<ruby>
+# For checking if a fixnum is even or odd.
+#
+#   1.even? # => false
+#   1.odd?  # => true
+#   2.even? # => true
+#   2.odd?  # => false
+</ruby>
+If a line is too long, the comment may be placed on the next line:
+<ruby>
+#   label(:post, :title)
+#   # => <label for="post_title">Title</label>
+#
+#   label(:post, :title, "A short title")
+#   # => <label for="post_title">A short title</label>
+#
+#   label(:post, :title, "A short title", :class => "title_label")
+#   # => <label for="post_title" class="title_label">A short title</label>
+</ruby>
+Avoid using any printing methods like +puts+ or +p+ for that purpose.
+On the other hand, regular comments do not use an arrow:
+<ruby>
+#   polymorphic_url(record)  # same as comment_url(record)
+</ruby>
+h3. Filenames
+As a rule of thumb use filenames relative to the application root:
+<plain>
+config/routes.rb            # YES
+routes.rb                   # NO
+RAILS_ROOT/config/routes.rb # NO
+</plain>
+h3. Fonts
+h4. Fixed-width Font
+Use fixed-width fonts for:
+* constants, in particular class and module names
+* method names
+* literals like +nil+, +false+, +true+, +self+
+* symbols
+* method parameters
+* file names
+<ruby>
+class Array
+  # Calls <tt>to_param</tt> on all its elements and joins the result with
+  # slashes. This is used by <tt>url_for</tt> in Action Pack.
+  def to_param
+    collect { |e| e.to_param }.join '/'
+  end
+end
+</ruby>
+WARNING: Using a pair of +&#43;...&#43;+ for fixed-width font only works with *words*; that is: anything matching <tt>\A\w&#43;\z</tt>. For anything else  use +&lt;tt&gt;...&lt;/tt&gt;+, notably symbols, setters, inline snippets, etc:
+h4. Regular Font
+When "true" and "false" are English words rather than Ruby keywords use a regular font:
+<ruby>
+# If <tt>reload_plugins?</tt> is false, add this to your plugin's <tt>init.rb</tt>
+# to make it reloadable:
+#
+#   Dependencies.load_once_paths.delete lib_path
+</ruby>
+h3. Description Lists
+In lists of options, parameters, etc. use a hyphen between the item and its description (reads better than a colon because normally options are symbols):
+<ruby>
+# * <tt>:allow_nil</tt> - Skip validation if attribute is <tt>nil</tt>.
+</ruby>
+The description starts in upper case and ends with a full stop—it's standard English.
+h3. Dynamically Generated Methods
+Methods created with +(module|class)_eval(STRING)+ have a comment by their side with an instance of the generated code. That comment is 2 spaces apart from the template:
+<ruby>
+for severity in Severity.constants
+  class_eval <<-EOT, __FILE__, __LINE__
+    def #{severity.downcase}(message = nil, progname = nil, &block)  # def debug(message = nil, progname = nil, &block)
+      add(#{severity}, message, progname, &block)                    #   add(DEBUG, message, progname, &block)
+    end                                                              # end
+                                                                     #
+    def #{severity.downcase}?                                        # def debug?
+      #{severity} >= @level                                          #   DEBUG >= @level
+    end                                                              # end
+  EOT
+end
+</ruby>
+If the resulting lines are too wide, say 200 columns or more, we put the comment above the call:
+<ruby>
+# def self.find_by_login_and_activated(*args)
+#   options = args.extract_options!
+#   ...
+# end
+self.class_eval %{
+  def self.#{method_id}(*args)
+    options = args.extract_options!
+    ...
+  end
+}
+</ruby>