openskies 0.0.1

data/guides/source/plugins.textile

@@ -0,0 +1,464 @@
+h2. The Basics of Creating Rails Plugins
+
+A Rails plugin is either an extension or a modification of the core framework. Plugins provide:
+
+* a way for developers to share bleeding-edge ideas without hurting the stable code base
+* a segmented architecture so that units of code can be fixed or updated on their own release schedule
+* an outlet for the core developers so that they don’t have to include every cool new feature under the sun
+
+After reading this guide you should be familiar with:
+
+* Creating a plugin from scratch
+* Writing and running tests for the plugin
+
+This guide describes how to build a test-driven plugin that will:
+
+* Extend core ruby classes like Hash and String
+* Add methods to ActiveRecord::Base in the tradition of the 'acts_as' plugins
+* Give you information about where to put generators in your plugin.
+
+For the purpose of this guide pretend for a moment that you are an avid bird watcher.
+Your favorite bird is the Yaffle, and you want to create a plugin that allows other developers to share in the Yaffle
+goodness.
+
+endprologue.
+
+h3. Setup
+
+Before you continue, take a moment to decide if your new plugin will be potentially shared across different Rails applications.
+
+* If your plugin is specific to your application, your new plugin will be a _vendored plugin_.
+* If you think your plugin may be used across applications, build it as a _gemified plugin_.
+
+h4. Either generate a vendored plugin...
+
+Use the +rails generate plugin+ command in your Rails root directory
+ to create a new plugin that will live in the +vendor/plugins+
+ directory. See usage and options by asking for help:
+
+<shell>
+$ rails generate plugin --help
+</shell>
+
+h4. Or generate a gemified plugin.
+
+Writing your Rails plugin as a gem, rather than as a vendored plugin,
+ lets you share your plugin across different rails applications using
+ RubyGems and Bundler.
+
+Rails 3.1 ships with a +rails plugin new+ command which creates a
+ skeleton for developing any kind of Rails extension with the ability
+ to run integration tests using a dummy Rails application. See usage
+ and options by asking for help:
+
+<shell>
+$ rails plugin --help
+</shell>
+
+h3. Testing your newly generated plugin
+
+You can navigate to the directory that contains the plugin, run the +bundle install+ command
+ and run the one generated test using the +rake+ command.
+
+You should see:
+
+<shell>
+	2 tests, 2 assertions, 0 failures, 0 errors, 0 skips
+</shell>
+
+This will tell you that everything got generated properly and you are ready to start adding functionality.
+
+h3. Extending Core Classes
+
+This section will explain how to add a method to String that will be available anywhere in your rails application.
+
+In this example you will add a method to String named +to_squawk+. To begin, create a new test file with a few assertions:
+
+<ruby>
+# yaffle/test/core_ext_test.rb
+
+require 'test_helper'
+
+class CoreExtTest < Test::Unit::TestCase
+  def test_to_squawk_prepends_the_word_squawk
+    assert_equal "squawk! Hello World", "Hello World".to_squawk
+  end
+end
+</ruby>
+
+Run +rake+ to run the test. This test should fail because we haven't implemented the +to_squawk+ method:
+
+<shell>
+	  1) Error:
+	test_to_squawk_prepends_the_word_squawk(CoreExtTest):
+	NoMethodError: undefined method `to_squawk' for "Hello World":String
+	    test/core_ext_test.rb:5:in `test_to_squawk_prepends_the_word_squawk'
+</shell>
+
+Great - now you are ready to start development.
+
+Then in +lib/yaffle.rb+ require +lib/core_ext+:
+
+<ruby>
+# yaffle/lib/yaffle.rb
+
+require "yaffle/core_ext"
+
+module Yaffle
+end
+</ruby>
+
+Finally, create the +core_ext.rb+ file and add the +to_squawk+ method:
+
+<ruby>
+# yaffle/lib/yaffle/core_ext.rb
+
+String.class_eval do
+  def to_squawk
+    "squawk! #{self}".strip
+  end
+end
+</ruby>
+
+To test that your method does what it says it does, run the unit tests with +rake+ from your plugin directory.
+
+<shell>
+	3 tests, 3 assertions, 0 failures, 0 errors, 0 skips
+</shell>
+
+To see this in action, change to the test/dummy directory, fire up a console and start squawking:
+
+<shell>
+$ rails console
+>> "Hello World".to_squawk
+=> "squawk! Hello World"
+</shell>
+
+h3. Add an "acts_as" Method to Active Record
+
+A common pattern in plugins is to add a method called 'acts_as_something' to models. In this case, you
+want to write a method called 'acts_as_yaffle' that adds a 'squawk' method to your Active Record models.
+
+To begin, set up your files so that you have:
+
+<ruby>
+# yaffle/test/acts_as_yaffle_test.rb
+
+require 'test_helper'
+
+class ActsAsYaffleTest < Test::Unit::TestCase
+end
+</ruby>
+
+<ruby>
+# yaffle/lib/yaffle.rb
+
+require "yaffle/core_ext"
+require 'yaffle/acts_as_yaffle'
+
+module Yaffle
+end
+</ruby>
+
+<ruby>
+# yaffle/lib/yaffle/acts_as_yaffle.rb
+
+module Yaffle
+  module ActsAsYaffle
+    # your code will go here
+  end
+end
+</ruby>
+
+h4. Add a Class Method
+
+This plugin will expect that you've added a method to your model named 'last_squawk'. However, the
+plugin users might have already defined a method on their model named 'last_squawk' that they use
+for something else. This plugin will allow the name to be changed by adding a class method called 'yaffle_text_field'.
+
+To start out, write a failing test that shows the behavior you'd like:
+
+<ruby>
+# yaffle/test/acts_as_yaffle_test.rb
+
+require 'test_helper'
+
+class ActsAsYaffleTest < Test::Unit::TestCase
+
+  def test_a_hickwalls_yaffle_text_field_should_be_last_squawk
+    assert_equal "last_squawk", Hickwall.yaffle_text_field
+  end
+
+  def test_a_wickwalls_yaffle_text_field_should_be_last_tweet
+    assert_equal "last_tweet", Wickwall.yaffle_text_field
+  end
+
+end
+</ruby>
+
+When you run +rake+, you should see the following:
+
+<shell>
+	  1) Error:
+	test_a_hickwalls_yaffle_text_field_should_be_last_squawk(ActsAsYaffleTest):
+	NameError: uninitialized constant ActsAsYaffleTest::Hickwall
+	    test/acts_as_yaffle_test.rb:6:in `test_a_hickwalls_yaffle_text_field_should_be_last_squawk'
+
+	  2) Error:
+	test_a_wickwalls_yaffle_text_field_should_be_last_tweet(ActsAsYaffleTest):
+	NameError: uninitialized constant ActsAsYaffleTest::Wickwall
+	    test/acts_as_yaffle_test.rb:10:in `test_a_wickwalls_yaffle_text_field_should_be_last_tweet'
+
+	5 tests, 3 assertions, 0 failures, 2 errors, 0 skips
+</shell>
+
+This tells us that we don't have the necessary models (Hickwall and Wickwall) that we are trying to test.
+We can easily generate these models in our "dummy" Rails application by running the following commands from the
+test/dummy directory:
+
+<shell>
+$ cd test/dummy
+$ rails generate model Hickwall last_squawk:string
+$ rails generate model Wickwall last_squawk:string last_tweet:string
+</shell>
+
+Now you can create the necessary database tables in your testing database by navigating to your dummy app
+and migrating the database. First
+
+<shell>
+$ cd test/dummy
+$ rake db:migrate
+$ rake db:test:prepare
+</shell>
+
+While you are here, change the Hickwall and Wickwall models so that they know that they are supposed to act
+like yaffles.
+
+<ruby>
+# test/dummy/app/models/hickwall.rb
+
+class Hickwall < ActiveRecord::Base
+  acts_as_yaffle
+end
+
+# test/dummy/app/models/wickwall.rb
+
+class Wickwall < ActiveRecord::Base
+  acts_as_yaffle :yaffle_text_field => :last_tweet
+end
+
+</ruby>
+
+We will also add code to define the acts_as_yaffle method.
+
+<ruby>
+# yaffle/lib/yaffle/acts_as_yaffle.rb
+module Yaffle
+  module ActsAsYaffle
+    extend ActiveSupport::Concern
+
+    included do
+    end
+
+    module ClassMethods
+      def acts_as_yaffle(options = {})
+        # your code will go here
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send :include, Yaffle::ActsAsYaffle
+</ruby>
+
+You can then return to the root directory (+cd ../..+) of your plugin and rerun the tests using +rake+.
+
+<shell>
+	  1) Error:
+	test_a_hickwalls_yaffle_text_field_should_be_last_squawk(ActsAsYaffleTest):
+	NoMethodError: undefined method `yaffle_text_field' for #<Class:0x000001016661b8>
+	    /Users/xxx/.rvm/gems/ruby-1.9.2-p136@xxx/gems/activerecord-3.0.3/lib/active_record/base.rb:1008:in `method_missing'
+	    test/acts_as_yaffle_test.rb:5:in `test_a_hickwalls_yaffle_text_field_should_be_last_squawk'
+
+	  2) Error:
+	test_a_wickwalls_yaffle_text_field_should_be_last_tweet(ActsAsYaffleTest):
+	NoMethodError: undefined method `yaffle_text_field' for #<Class:0x00000101653748>
+	    Users/xxx/.rvm/gems/ruby-1.9.2-p136@xxx/gems/activerecord-3.0.3/lib/active_record/base.rb:1008:in `method_missing'
+	    test/acts_as_yaffle_test.rb:9:in `test_a_wickwalls_yaffle_text_field_should_be_last_tweet'
+
+	5 tests, 3 assertions, 0 failures, 2 errors, 0 skips
+
+</shell>
+
+Getting closer... Now we will implement the code of the acts_as_yaffle method to make the tests pass.
+
+<ruby>
+# yaffle/lib/yaffle/acts_as_yaffle.rb
+
+module Yaffle
+  module ActsAsYaffle
+   extend ActiveSupport::Concern
+
+    included do
+    end
+
+    module ClassMethods
+      def acts_as_yaffle(options = {})
+        cattr_accessor :yaffle_text_field
+        self.yaffle_text_field = (options[:yaffle_text_field] || :last_squawk).to_s
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send :include, Yaffle::ActsAsYaffle
+</ruby>
+
+When you run +rake+ you should see the tests all pass:
+
+<shell>
+	5 tests, 5 assertions, 0 failures, 0 errors, 0 skips
+</shell>
+
+h4. Add an Instance Method
+
+This plugin will add a method named 'squawk' to any Active Record object that calls 'acts_as_yaffle'. The 'squawk'
+method will simply set the value of one of the fields in the database.
+
+To start out, write a failing test that shows the behavior you'd like:
+
+<ruby>
+# yaffle/test/acts_as_yaffle_test.rb
+require 'test_helper'
+
+class ActsAsYaffleTest < Test::Unit::TestCase
+
+  def test_a_hickwalls_yaffle_text_field_should_be_last_squawk
+    assert_equal "last_squawk", Hickwall.yaffle_text_field
+  end
+
+  def test_a_wickwalls_yaffle_text_field_should_be_last_tweet
+    assert_equal "last_tweet", Wickwall.yaffle_text_field
+  end
+
+  def test_hickwalls_squawk_should_populate_last_squawk
+    hickwall = Hickwall.new
+    hickwall.squawk("Hello World")
+    assert_equal "squawk! Hello World", hickwall.last_squawk
+  end
+
+  def test_wickwalls_squawk_should_populate_last_tweet
+    wickwall = Wickwall.new
+    wickwall.squawk("Hello World")
+    assert_equal "squawk! Hello World", wickwall.last_tweet
+  end
+end
+</ruby>
+
+Run the test to make sure the last two tests fail with an error that contains "NoMethodError: undefined method `squawk'",
+then update 'acts_as_yaffle.rb' to look like this:
+
+<ruby>
+# yaffle/lib/yaffle/acts_as_yaffle.rb	
+
+module Yaffle
+  module ActsAsYaffle
+    extend ActiveSupport::Concern
+
+    included do
+    end
+
+    module ClassMethods
+      def acts_as_yaffle(options = {})
+        cattr_accessor :yaffle_text_field
+        self.yaffle_text_field = (options[:yaffle_text_field] || :last_squawk).to_s
+      end
+    end
+
+    def squawk(string)
+      write_attribute(self.class.yaffle_text_field, string.to_squawk)
+    end
+
+  end
+end
+
+ActiveRecord::Base.send :include, Yaffle::ActsAsYaffle
+</ruby>
+
+Run +rake+ one final time and you should see:
+
+<shell>
+	7 tests, 7 assertions, 0 failures, 0 errors, 0 skips
+</shell>
+
+NOTE: The use of +write_attribute+ to write to the field in model is just one example of how a plugin can interact with the model, and will not always be the right method to use. For example, you could also use <tt>send("#{self.class.yaffle_text_field}=", string.to_squawk)</tt>.
+
+h3. Generators
+
+Generators can be included in your gem simply by creating them in a lib/generators directory of your plugin. More information about
+the creation of generators can be found in the "Generators Guide":generators.html
+
+h3. Publishing your Gem
+
+Gem plugins currently in development can easily be shared from any Git repository. To share the Yaffle gem with others, simply
+commit the code to a Git repository (like Github) and add a line to the Gemfile of the application in question:
+
+<ruby>
+gem 'yaffle', :git => 'git://github.com/yaffle_watcher/yaffle.git'
+</ruby>
+
+After running +bundle install+, your gem functionality will be available to the application.
+
+When the gem is ready to be shared as a formal release, it can be published to "RubyGems":http://www.rubygems.org.
+For more information about publishing gems to RubyGems, see: "http://blog.thepete.net/2010/11/creating-and-publishing-your-first-ruby.html":http://blog.thepete.net/2010/11/creating-and-publishing-your-first-ruby.html
+
+h3. Non-Gem Plugins
+
+Non-gem plugins are useful for functionality that won't be shared with another project. Keeping your custom functionality in the
+vendor/plugins directory un-clutters the rest of the application.
+
+Move the directory that you created for the gem based plugin into the vendor/plugins directory of a generated Rails application, create a vendor/plugins/yaffle/init.rb file that contains "require 'yaffle'" and everything will still work.
+
+<ruby>
+# yaffle/init.rb
+
+require 'yaffle'
+</ruby>
+
+You can test this by changing to the Rails application that you added the plugin to and starting a rails console. Once in the
+console we can check to see if the String has an instance method to_squawk:
+
+<shell>
+$ cd my_app
+$ rails console
+$ "Rails plugins are easy!".to_squawk
+</shell>
+
+You can also remove the .gemspec, Gemfile and Gemfile.lock files as they will no longer be needed.
+
+h3. RDoc Documentation
+
+Once your plugin is stable and you are ready to deploy do everyone else a favor and document it! Luckily, writing documentation for your plugin is easy.
+
+The first step is to update the README file with detailed information about how to use your plugin. A few key things to include are:
+
+* Your name
+* How to install
+* How to add the functionality to the app (several examples of common use cases)
+* Warnings, gotchas or tips that might help users and save them time
+
+Once your README is solid, go through and add rdoc comments to all of the methods that developers will use. It's also customary to add '#:nodoc:' comments to those parts of the code that are not included in the public api.
+
+Once your comments are good to go, navigate to your plugin directory and run:
+
+<shell>
+$ rake rdoc
+</shell>
+
+h4. References
+
+* "Developing a RubyGem using Bundler":https://github.com/radar/guides/blob/master/gem-development.md
+* "Using Gemspecs As Intended":http://yehudakatz.com/2010/04/02/using-gemspecs-as-intended/
+* "Gemspec Reference":http://docs.rubygems.org/read/chapter/20
+* "GemPlugins":http://www.mbleigh.com/2008/06/11/gemplugins-a-brief-introduction-to-the-future-of-rails-plugins
+* "Keeping init.rb thin":http://daddy.platte.name/2007/05/rails-plugins-keep-initrb-thin.html

data/guides/source/rails_application_templates.textile

@@ -0,0 +1,240 @@
+h2. Rails Application Templates
+
+Application templates are simple Ruby files containing DSL for adding plugins/gems/initializers etc. to your freshly created Rails project or an existing Rails project.
+
+By referring to this guide, you will be able to:
+
+* Use templates to generate/customize Rails applications
+* Write your own reusable application templates using the Rails template API
+
+endprologue.
+
+h3. Usage
+
+To apply a template, you need to provide the Rails generator with the location of the template you wish to apply, using -m option. This can either be path to a file or a URL.
+
+<shell>
+$ rails new blog -m ~/template.rb
+$ rails new blog -m http://example.com/template.rb
+</shell>
+
+You can use the rake task +rails:template+ to apply templates to an existing Rails application. The location of the template needs to be passed in to an environment variable named LOCATION. Again, this can either be path to a file or a URL.
+
+<shell>
+$ rake rails:template LOCATION=~/template.rb
+$ rake rails:template LOCATION=http://example.com/template.rb
+</shell>
+
+h3. Template API
+
+Rails templates API is very self explanatory and easy to understand. Here's an example of a typical Rails template:
+
+<ruby>
+# template.rb
+run "rm public/index.html"
+generate(:scaffold, "person name:string")
+route "root :to => 'people#index'"
+rake("db:migrate")
+
+git :init
+git :add => "."
+git :commit => "-a -m 'Initial commit'"
+</ruby>
+
+The following sections outlines the primary methods provided by the API:
+
+h4. gem(name, options = {})
+
+Adds a +gem+ entry for the supplied gem to the generated application’s +Gemfile+.
+
+For example, if your application depends on the gems +bj+ and +nokogiri+:
+
+<ruby>
+gem "bj"
+gem "nokogiri"
+</ruby>
+
+Please note that this will NOT install the gems for you and you will have to run +bundle install+ to do that.
+
+<ruby>
+bundle install
+</ruby>
+
+h4. gem_group(*names, &block)
+
+Wraps gem entries inside a group.
+
+For example, if you want to load +rspec-rails+ only in +development+ and +test+ group:
+
+<ruby>
+gem_group :development, :test do
+  gem "rspec-rails"
+end
+</ruby>
+
+h4. add_source(source, options = {})
+
+Adds the given source to the generated application's +Gemfile+.
+
+For example, if you need to source a gem from "http://code.whytheluckystiff.net":
+
+<ruby>
+add_source "http://code.whytheluckystiff.net"
+</ruby>
+
+h4. plugin(name, options = {})
+
+Installs a plugin to the generated application.
+
+Plugin can be installed from Git:
+
+<ruby>
+plugin 'authentication', :git => 'git://github.com/foor/bar.git'
+</ruby>
+
+You can even install plugins as git submodules:
+
+<ruby>
+plugin 'authentication', :git => 'git://github.com/foor/bar.git',
+                         :submodule => true
+</ruby>
+
+Please note that you need to +git :init+ before you can install a plugin as a submodule.
+
+Or use plain old SVN:
+
+<ruby>
+plugin 'usingsvn', :svn => 'svn://example.com/usingsvn/trunk'
+</ruby>
+
+h4. vendor/lib/file/initializer(filename, data = nil, &block)
+
+Adds an initializer to the generated application’s +config/initializers+ directory.
+
+Lets say you like using +Object#not_nil?+ and +Object#not_blank?+:
+
+<ruby>
+initializer 'bloatlol.rb', <<-CODE
+class Object
+  def not_nil?
+    !nil?
+  end
+
+  def not_blank?
+    !blank?
+  end
+end
+CODE
+</ruby>
+
+Similarly +lib()+ creates a file in the +lib/+ directory and +vendor()+ creates a file in the +vendor/+ directory.
+
+There is even +file()+, which accepts a relative path from +Rails.root+ and creates all the directories/file needed:
+
+<ruby>
+file 'app/components/foo.rb', <<-CODE
+class Foo
+end
+CODE
+</ruby>
+
+That’ll create +app/components+ directory and put +foo.rb+ in there.
+
+h4. rakefile(filename, data = nil, &block)
+
+Creates a new rake file under +lib/tasks+ with the supplied tasks:
+
+<ruby>
+rakefile("bootstrap.rake") do
+  <<-TASK
+    namespace :boot do
+      task :strap do
+        puts "i like boots!"
+      end
+    end
+  TASK
+end
+</ruby>
+
+The above creates +lib/tasks/bootstrap.rake+ with a +boot:strap+ rake task.
+
+h4. generate(what, args)
+
+Runs the supplied rails generator with given arguments.
+
+<ruby>
+generate(:scaffold, "person", "name:string", "address:text", "age:number")
+</ruby>
+
+h4. run(command)
+
+Executes an arbitrary command. Just like the backticks. Let's say you want to remove the +public/index.html+ file:
+
+<ruby>
+run "rm public/index.html"
+</ruby>
+
+h4. rake(command, options = {})
+
+Runs the supplied rake tasks in the Rails application. Let's say you want to migrate the database:
+
+<ruby>
+rake "db:migrate"
+</ruby>
+
+You can also run rake tasks with a different Rails environment:
+
+<ruby>
+rake "db:migrate", :env => 'production'
+</ruby>
+
+h4. route(routing_code)
+
+This adds a routing entry to the +config/routes.rb+ file. In above steps, we generated a person scaffold and also removed +public/index.html+. Now to make +PeopleController#index+ as the default page for the application:
+
+<ruby>
+route "root :to => 'person#index'"
+</ruby>
+
+h4. inside(dir)
+
+Enables you to run a command from the given directory. For example, if you have a copy of edge rails that you wish to symlink from your new apps, you can do this:
+
+<ruby>
+inside('vendor') do
+  run "ln -s ~/commit-rails/rails rails"
+end
+</ruby>
+
+h4. ask(question)
+
++ask()+ gives you a chance to get some feedback from the user and use it in your templates. Lets say you want your user to name the new shiny library you’re adding:
+
+<ruby>
+lib_name = ask("What do you want to call the shiny library ?")
+lib_name << ".rb" unless lib_name.index(".rb")
+
+lib lib_name, <<-CODE
+class Shiny
+end
+CODE
+</ruby>
+
+h4. yes?(question) or no?(question)
+
+These methods let you ask questions from templates and decide the flow based on the user’s answer. Lets say you want to freeze rails only if the user want to:
+
+<ruby>
+rake("rails:freeze:gems") if yes?("Freeze rails gems ?")
+no?(question) acts just the opposite.
+</ruby>
+
+h4. git(:command)
+
+Rails templates let you run any git command:
+
+<ruby>
+git :init
+git :add => "."
+git :commit => "-a -m 'Initial commit'"
+</ruby>