active-record-binder 1.1.0 → 1.2.0

data/README.md

@@ -0,0 +1,217 @@
+[ActiveRecordBinder](https://rubygems.org/gems/active-record-binder)
+============
+```
+arb -v
+# => 1.2.0
+
+arb --changelog
+# V 1.2.0 : Bug fixes, refactoring and introduction of the new command-line-tool : `arb`
+# V 1.1.0 : Introducing delegation for ActiveRecord::Base relation methods.
+# V 1.0.1 : Minor fixes and Documentation creation.
+# V 1.0.0 : Release
+#
+```
+A Ruby library for an easier interfacing with ActiveRecord. And an easier way to create elegant migrations.
+
+# Installation
+`gem install active-record-binder`
+
+# Why Binder ? What the frak is this ?
+I needed a tool to ease the creation of little Plugs and Adapters for ActiveRecord.
+
+The idea is that you Bind a class to ActiveRecord by subclassing it with Binder::AR.
+You can specify your own methods and delegate to ActiveRecord whenever you need.
+
+It's kind of a Proxy on steroids, that will do a lot for you.
+
+## Show me !
+You want to create a Plug for your sqlite database :
+
+```ruby
+  class SqlitePlug < Binder::AR
+  end
+```
+
+Those lines will create a new `MySqlPlug`, and it will connect to the database specified by your `ENV['APP_DB']`.
+Also, the database adapter defaults to `:sqlite3`.
+
+Now. All this is fine. But you want more :
+* You want to select a precise database without using `ENV['APP_DB']`;
+* Your application uses MySQL.
+
+```ruby
+  class MySqlPlug < Binder::AR
+    database :db
+    adapter :mysql
+    connect_with user: 'Foo', password: 'Bar', host: 'localhost'
+  end
+```
+
+As you can see : you can specify a database or an adapter by passing a `Symbol` or a `String` to both the
+* `database()` and the
+* `adapter()` methods.
+
+The `connect_with()` method can be used to pass a `Hash` of options to the `ActiveRecord::Base.establish_connexion()` call.
+
+_Please notice that all your instances of MySqlPlug will use those values once defined this way._
+
+## How do we use this ?
+
+```ruby
+  class MySqlPlug < Binder::AR
+    database :db
+    adapter :mysql
+    connect_with user: 'Foo', password: 'Bar', host: 'localhost'
+
+    def find args
+      # But you could use a delegator
+      table.find args
+    end
+  end
+
+  # A Model
+  class Foo
+    def initialize
+      # Will bind this instance of the MySqlPlug to the `foos` table
+      @plug = MySqlPlug.new :foo
+    end
+
+    def find
+      # But you could use a delegator
+      @plug.find
+    end
+  end
+```
+
+**Note :** You can use the `table` method on any instance of your Plug to get the table class (An ActiveRecord Class Object).
+
+```ruby
+  @plug = MySqlPlug.new :foo
+  table = @plug.table
+  # => MySqlPlug::Foo
+  table.find # ActiveRecord method call.
+  # => [<FooObject#1>, <FooObject#2, ...]
+```
+
+Notice how neatly namespaced is the ActiveRecord table class. This way we won't step over our `Foo` model.
+
+# Relations
+If it pleases you, you can create your relations directly in the Binder class. Those methods call are delegated to the underlying table model when initiated.
+
+```ruby
+  class FooBinder < Binder::AR
+    has_one :bar
+  end
+  class BarBinder < Binder::AR
+    belongs_to :foo
+  end
+
+  # And (if the table are accordingly populated, see "The Migration System", below) :
+  foo = FooBinder.new(:foo).table
+  foo.first.bar # => <BarObject>
+```
+
+Delegated methods are the following : `has_many`, `has_one`, `has_and_belongs_to_many`, `belongs_to`.
+
+# The Migration System
+
+I've always found the ActiveRecord::Migration system a bit of a pain to use.
+
+Therefore, I took the liberty of using pieces of [`_Why's Camping Web Framework's`](https://github.com/camping/camping/) migration system.
+You can now create your migrations this way :
+
+```ruby
+   class CreateFooTable < MySqlPlug::Version 1.0
+     def self.up
+       create_table :foos do |t|
+         t.string :name
+         t.timestamps
+       end
+     end
+
+     def self.down
+       drop_table :foos
+     end
+   end
+
+   class CreateBarTable < MySqlPlug::Version 1.1
+     def self.up
+       create_table :bars do |t|
+         t.string :title
+         t.timestamps
+       end
+     end
+
+     def self.down
+       drop_table :bars
+     end
+   end
+
+  # You can get the migration version for a pecular migration class.
+  CreateFooTable.version # => 1.0
+  CreateBarTable.version # => 1.1
+```
+
+Isn't it neat ?.
+
+Now, boy : just use the `migrate` method to execute your migrations.
+
+```ruby
+  MySqlPlug.migrate
+  # => 1.1
+```
+This executes everything up to the latest migration.
+But `migrate()` can also take a version number as an argument.
+
+```ruby
+  MySqlPlug.migrate 0
+  # => 0.0
+```
+This, will migrate everything down, reverting the changes as specified in each reverted migration `self.down` method.
+```ruby
+  MySqlPlug.migrate 1.0
+  # => 1.0
+```
+And finally, this will migrate up until it hits 1.0.
+
+# The Command Line Tool
+Active Record Binder ships with a neat little CLI : `arb`
+
+ARB is a small easily extandable Command Line Interface. And it's pretty. Beautiful colors everywhere. Awesome. Seriously.
+To use it :
+```
+$ arb version
+# => Binder::AR::Version => 1.2.0
+```
+
+You can display the help using `arb help` or `arb -h`
+
+But, the most intersting part of this CLI is the migrate command. You can easily run your migrations for a specific plug :
+```
+$ arb migrate --version 1.1 --directory migrations/ --adapter MySqlitePlug
+```
+Will migrate to 1.1, using the migrations found in the `migrations/` directory and calling `MySqlitePlug.migrate`.
+
+You can specify multiples options, and there is an alternative syntax :
+```
+# => You can specify multiple directories through `--directory` or `--d`
+$ arb migrate -v 0 -d migrations/foo/ migrations/bar -a MySqlitePlug
+
+# => You can load directories recursively with `-r` or `--recursive`
+$ arb migrate -v 0 --recursive migrations/ --plug MySqlitePlug
+
+# => You can can also load files using `-f` or `--file`
+$ arb migrate -v 1.0 -f migrations/foo/create_foo_table.rb --adapter MySqlitePlug
+```
+
+<img src="https://raw.github.com/gabriel-dehan/ActiveRecordBinder/master/extras/cli_help.png" alt="Command Line Interface screenshot"/>
+
+# Want to know more ?
+[Checkout the documentation !](http://rubydoc.info/gems/active-record-binder/1.0.1/frames)
+Or dive in, the code is pretty straightforward and well documented. And there is a lot of tests.
+
+# Want to contribute ?
+Please, do fork and pull request !
+
+## Road map:
+* Maybe create other Binder, like MongoDB, Datamapper, like `Binder::Mongo`, `Binder::DataMapper`. But the gem's name would have to change.

data/bin/arb

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.dirname(__FILE__) + '/../lib'
+
+require 'cli/commands/commands'
+
+begin
+  Binder::Command.new ARGV
+rescue CommandParser::ParseError => ex
+  STDERR.puts "/!\\ #{ex.message}".colorize(:red)
+  puts ">> use " + "`#{File.basename($0)} --help` ".colorize(:green) + "for more details."
+  exit 1
+end

data/doc/Binder.html

@@ -0,0 +1,150 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>
+  Module: Binder
+  
+    &mdash; Documentation by YARD 0.8.4.1
+  
+</title>
+
+  <link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
+
+  <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
+
+<script type="text/javascript" charset="utf-8">
+  hasFrames = window.top.frames.main ? true : false;
+  relpath = '';
+  framesUrl = "frames.html#!" + escape(window.location.href);
+</script>
+
+
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+
+
+  </head>
+  <body>
+    <div id="header">
+      <div id="menu">
+  
+    <a href="_index.html">Index (B)</a> &raquo;
+    
+    
+    <span class="title">Binder</span>
+  
+
+  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+
+      <div id="search">
+  
+    <a class="full_list_link" id="class_list_link"
+        href="class_list.html">
+      Class List
+    </a>
+  
+    <a class="full_list_link" id="method_list_link"
+        href="method_list.html">
+      Method List
+    </a>
+  
+    <a class="full_list_link" id="file_list_link"
+        href="file_list.html">
+      File List
+    </a>
+  
+</div>
+      <div class="clear"></div>
+    </div>
+
+    <iframe id="search_frame"></iframe>
+
+    <div id="content"><h1>Module: Binder
+  
+  
+  
+</h1>
+
+<dl class="box">
+  
+  
+    
+  
+    
+  
+  
+  
+    <dt class="r1 last">Defined in:</dt>
+    <dd class="r1 last">lib/active_record_binder.rb<span class="defines">,<br />
+  lib/cli/command.rb,<br /> lib/cli/commands/help.rb,<br /> lib/cli/commands/migrate.rb,<br /> lib/cli/commands/version.rb,<br /> lib/version.rb</span>
+</dd>
+  
+</dl>
+<div class="clear"></div>
+
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    
+<p>Namespace containing classes to create binder to. A binder is simply a tool
+to use for Databases plugs or adaptors building.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div><h2>Defined Under Namespace</h2>
+<p class="children">
+  
+    
+  
+    
+      <strong class="classes">Classes:</strong> <span class='object_link'><a href="Binder/AR.html" title="Binder::AR (class)">AR</a></span>, <span class='object_link'><a href="Binder/Command.html" title="Binder::Command (class)">Command</a></span>, <span class='object_link'><a href="Binder/Help.html" title="Binder::Help (class)">Help</a></span>, <span class='object_link'><a href="Binder/Migrate.html" title="Binder::Migrate (class)">Migrate</a></span>, <span class='object_link'><a href="Binder/Strategy.html" title="Binder::Strategy (class)">Strategy</a></span>, <span class='object_link'><a href="Binder/Version.html" title="Binder::Version (class)">Version</a></span>
+    
+  
+</p>
+
+  <h2>Constant Summary</h2>
+  
+    <dl class="constants">
+      
+        <dt id="VERSION-constant" class="">VERSION =
+          <div class="docstring">
+  <div class="discussion">
+    
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div>
+        </dt>
+        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>1.2.0</span><span class='tstring_end'>&quot;</span></span></pre></dd>
+      
+    </dl>
+  
+
+
+
+
+
+
+
+
+
+</div>
+
+    <div id="footer">
+  Generated on Thu Feb 21 02:06:16 2013 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.8.4.1 (ruby-1.9.3).
+</div>
+
+  </body>
+</html>

data/doc/Binder/AR.html

@@ -0,0 +1,1880 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>
+  Class: Binder::AR
+  
+    &mdash; Documentation by YARD 0.8.4.1
+  
+</title>
+
+  <link rel="stylesheet" href="../css/style.css" type="text/css" media="screen" charset="utf-8" />
+
+  <link rel="stylesheet" href="../css/common.css" type="text/css" media="screen" charset="utf-8" />
+
+<script type="text/javascript" charset="utf-8">
+  hasFrames = window.top.frames.main ? true : false;
+  relpath = '../';
+  framesUrl = "../frames.html#!" + escape(window.location.href);
+</script>
+
+
+  <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
+
+  <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
+
+
+  </head>
+  <body>
+    <div id="header">
+      <div id="menu">
+  
+    <a href="../_index.html">Index (A)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../Binder.html" title="Binder (module)">Binder</a></span></span>
+     &raquo; 
+    <span class="title">AR</span>
+  
+
+  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+
+      <div id="search">
+  
+    <a class="full_list_link" id="class_list_link"
+        href="../class_list.html">
+      Class List
+    </a>
+  
+    <a class="full_list_link" id="method_list_link"
+        href="../method_list.html">
+      Method List
+    </a>
+  
+    <a class="full_list_link" id="file_list_link"
+        href="../file_list.html">
+      File List
+    </a>
+  
+</div>
+      <div class="clear"></div>
+    </div>
+
+    <iframe id="search_frame"></iframe>
+
+    <div id="content"><h1>Class: Binder::AR
+  
+  
+  
+</h1>
+
+<dl class="box">
+  
+    <dt class="r1">Inherits:</dt>
+    <dd class="r1">
+      <span class="inheritName">Object</span>
+      
+        <ul class="fullTree">
+          <li>Object</li>
+          
+            <li class="next">Binder::AR</li>
+          
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      
+      </dd>
+    
+  
+  
+    
+      <dt class="r2">Extended by:</dt>
+      <dd class="r2"><span class='object_link'><a href="../DeferedDelegator.html" title="DeferedDelegator (module)">DeferedDelegator</a></span></dd>
+      
+    
+  
+    
+  
+  
+  
+    <dt class="r1 last">Defined in:</dt>
+    <dd class="r1 last">lib/active_record_binder.rb</dd>
+  
+</dl>
+<div class="clear"></div>
+
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    
+<p>Active Record Binder class. You need to inherit from it to create your Plug
+or Adaptor.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+  <div class="examples">
+    <p class="tag_title">Examples:</p>
+    
+      
+      <pre class="example code"><code>class ARSqlitePlug &lt; Binder::AR
+  database 'db.sqlite3'
+  adapter :sqlite3</code></pre>
+    
+      
+      <pre class="example code"><code># Your methods
+end
+#
+# Or
+class ARMySqlPlug &lt; Binder::AR
+  database 'db'
+  adapter :mysql
+  connect_with user: 'Foo', password: 'Bar', host: 'localhost'</code></pre>
+    
+      
+      <pre class="example code"><code># Your methods
+end</code></pre>
+    
+      
+      <pre class="example code"><code><span class='comment'># You need to initialize the plug by passing it a table to handle
+</span><span class='id identifier rubyid_plug'>plug</span> <span class='op'>=</span> <span class='const'>ARSqlitePlug</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='symbol'>:table_for_foo</span>
+<span class='id identifier rubyid_foo'>foo</span> <span class='op'>=</span> <span class='id identifier rubyid_plug'>plug</span><span class='period'>.</span><span class='id identifier rubyid_table'>table</span> <span class='comment'># =&gt; the TableForFoo class, which inherit from ActiveRecord::Base.
+</span><span class='comment'># Foo is an active record object linked to a table, you can use it as you would usually.
+</span><span class='id identifier rubyid_foo'>foo</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span></code></pre>
+    
+      
+      <pre class="example code"><code><span class='comment'># Furthermore, the Binder::AR class, has some interesting class methods :
+</span><span class='comment'>#
+</span><span class='const'>Binder</span><span class='op'>::</span><span class='const'>AR</span><span class='op'>::</span><span class='id identifier rubyid_default_database'>default_database</span> <span class='comment'># =&gt; ENV['APP_DB'] # This value would be used if no database had been set during the plus creation.
+</span><span class='const'>Binder</span><span class='op'>::</span><span class='const'>AR</span><span class='op'>::</span><span class='id identifier rubyid_database'>database</span> <span class='comment'># =&gt; Returns the current database used by the Binder in general (Would default to ENV['APP_DB'] if not specified)
+</span><span class='const'>ARSqlitePlug</span><span class='op'>::</span><span class='id identifier rubyid_database'>database</span> <span class='comment'># =&gt; :db (Works the same and returns this Plug Class's database parameters)
+</span><span class='comment'>#
+</span><span class='comment'># The same goes for the adapters :
+</span><span class='const'>Binder</span><span class='op'>::</span><span class='const'>AR</span><span class='op'>::</span><span class='id identifier rubyid_default_adapter'>default_adapter</span> <span class='comment'># =&gt; :sqlite3
+</span><span class='const'>ARMySqlPlug</span><span class='op'>::</span><span class='id identifier rubyid_adapter'>adapter</span> <span class='comment'># =&gt; :mysql
+</span><span class='comment'>#
+</span><span class='comment'># And connection parameters
+</span><span class='const'>Binder</span><span class='op'>::</span><span class='const'>AR</span><span class='op'>::</span><span class='id identifier rubyid_connection'>connection</span> <span class='comment'># =&gt; {}
+</span><span class='const'>ARMySqlPlug</span><span class='op'>::</span><span class='id identifier rubyid_connection'>connection</span> <span class='comment'># =&gt; { :user =&gt; 'Foo', :password =&gt; 'Bar', :host =&gt; 'localhost' }</span></code></pre>
+    
+  </div>
+
+
+</div>
+
+
+
+  <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
+  <ul class="summary">
+    
+      <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#table-instance_method" title="#table (instance method)">- (Object) <strong>table</strong> </a>
+    
+
+    
+  </span>
+  
+  
+  
+    
+      <span class="note title readonly">readonly</span>
+    
+    
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'></div></span>
+  
+</li>
+
+    
+      <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#table_name-instance_method" title="#table_name (instance method)">- (Object) <strong>table_name</strong> </a>
+    
+
+    
+  </span>
+  
+  
+  
+    
+      <span class="note title readonly">readonly</span>
+    
+    
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'></div></span>
+  
+</li>
+
+    
+  </ul>
+
+
+
+
+  
+    <h2>
+      Class Method Summary
+      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
+    </h2>
+
+    <ul class="summary">
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#__check_migration_version-class_method" title="__check_migration_version (class method)">+ (Object) <strong>__check_migration_version</strong>(version) </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Private : checks the migration version number.</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#__create_meta_data_table_for-class_method" title="__create_meta_data_table_for (class method)">+ (Object) <strong>__create_meta_data_table_for</strong>(schema) </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Private : Create a table for the current meta schema.</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#__create_meta_schema_class-class_method" title="__create_meta_schema_class (class method)">+ (Object) <strong>__create_meta_schema_class</strong>(klass) </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Private: Creates the meta schema class, and binds it to the current
+Namespace.</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#adapter-class_method" title="adapter (class method)">+ (Object) <strong>adapter</strong>(adpt = default_adapter) </a>
+    
+
+    
+      (also: adaptor)
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Set the current adapter.</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#connection-class_method" title="connection (class method)">+ (Object) <strong>connection</strong>(opts = {}) </a>
+    
+
+    
+      (also: connect_with)
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Set the current connection parameters.</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#connection_data-class_method" title="connection_data (class method)">+ (Object) <strong>connection_data</strong> </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Retrieves a clean set of connection data to establish a connection.</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#database-class_method" title="database (class method)">+ (Object) <strong>database</strong>(db = default_database) </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Set the current database.</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#default_adapter-class_method" title="default_adapter (class method)">+ (Object) <strong>default_adapter</strong> </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Retrieves de default database.</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#default_database-class_method" title="default_database (class method)">+ ('APP_DB'\) <strong>default_database</strong> </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Retrieves de default database.</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#meta_schema-class_method" title="meta_schema (class method)">+ (Object) <strong>meta_schema</strong> </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Private: Get the Class holding the current migration metadatas.</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#migrate-class_method" title="migrate (class method)">+ (Object) <strong>migrate</strong>(version = nil) </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Executes a migration.</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#Version-class_method" title="Version (class method)">+ (Object) <strong>Version</strong>(n) </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Creates a new migration version through subclassing.</p>
+</div></span>
+  
+</li>
+
+      
+    </ul>
+  
+    <h2>
+      Instance Method Summary
+      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
+    </h2>
+
+    <ul class="summary">
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#initialize-instance_method" title="#initialize (instance method)">- (Object) <strong>initialize</strong>(table_name) </a>
+    
+
+    
+  </span>
+  
+  
+    <span class="note title constructor">constructor</span>
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Returns a new instance of the binder's class.</p>
+</div></span>
+  
+</li>
+
+      
+    </ul>
+  
+
+
+  
+  
+  
+  
+  
+  
+  
+  
+  <h3 class="inherited">Methods included from <span class='object_link'><a href="../DeferedDelegator.html" title="DeferedDelegator (module)">DeferedDelegator</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="../DeferedDelegator.html#delegate_to-instance_method" title="DeferedDelegator#delegate_to (method)">delegate_to</a></span>, <span class='object_link'><a href="../DeferedDelegator.html#register_delegators-instance_method" title="DeferedDelegator#register_delegators (method)">register_delegators</a></span></p>
+<div id="constructor_details" class="method_details_list">
+  <h2>Constructor Details</h2>
+  
+    <div class="method_details first">
+  <h3 class="signature first" id="initialize-instance_method">
+  
+    - (<tt>Object</tt>) <strong>initialize</strong>(table_name) 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Returns a new instance of the binder's class. It also automaticaly
+establish a connection with the database throught the specified adapter,
+but prevents trying to reconnect if the connection is already established.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+  <div class="examples">
+    <p class="tag_title">Examples:</p>
+    
+      
+      <pre class="example code"><code><span class='kw'>class</span> <span class='const'>Plug</span> <span class='op'>&lt;</span> <span class='const'>Binder</span><span class='op'>::</span><span class='const'>AR</span><span class='semicolon'>;</span> <span class='kw'>end</span>
+<span class='id identifier rubyid_plug'>plug</span> <span class='op'>=</span> <span class='const'>Plug</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='symbol'>:articles</span>
+<span class='id identifier rubyid_plug'>plug</span><span class='period'>.</span><span class='id identifier rubyid_table'>table</span><span class='period'>.</span><span class='id identifier rubyid_find'>find</span> <span class='comment'># [&lt;Article#1&gt;, &lt;Article#2&gt;] # Works, the connection has been established.</span></code></pre>
+    
+  </div>
+<p class="tag_title">Parameters:</p>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>table_name</span>
+      
+      
+        <span class='type'></span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>A String or Symbol representing the table to which we want to be bound.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+70
+71
+72
+73
+74
+75
+76
+77
+78
+79
+80
+81</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/active_record_binder.rb', line 70</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span> <span class='id identifier rubyid_table_name'>table_name</span>
+  <span class='ivar'>@table_name</span> <span class='op'>=</span> <span class='id identifier rubyid_table_name'>table_name</span>
+
+  <span class='comment'># Retrieves or Create the ActiveRecord::Base subclass that will match the table.
+</span>  <span class='id identifier rubyid_table'>table</span> <span class='op'>=</span> <span class='id identifier rubyid_meta_def_ar_class'>meta_def_ar_class</span>
+
+  <span class='comment'># Handle ActiveRecord::Base delegation, to ensure painless associations
+</span>  <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_delegate_to'>delegate_to</span> <span class='id identifier rubyid_table'>table</span>
+
+  <span class='comment'># Establishes a connection to the database
+</span>  <span class='id identifier rubyid_table'>table</span><span class='period'>.</span><span class='id identifier rubyid_connect'>connect</span> <span class='kw'>unless</span> <span class='id identifier rubyid_table'>table</span><span class='period'>.</span><span class='id identifier rubyid_connected?'>connected?</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+  
+</div>
+
+  <div id="instance_attr_details" class="attr_details">
+    <h2>Instance Attribute Details</h2>
+    
+      
+      <span id=""></span>
+      <div class="method_details first">
+  <h3 class="signature first" id="table-instance_method">
+  
+    - (<tt>Object</tt>) <strong>table</strong>  <span class="extras">(readonly)</span>
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+54
+55
+56</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/active_record_binder.rb', line 54</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_table'>table</span>
+  <span class='ivar'>@table</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      
+      <span id=""></span>
+      <div class="method_details ">
+  <h3 class="signature " id="table_name-instance_method">
+  
+    - (<tt>Object</tt>) <strong>table_name</strong>  <span class="extras">(readonly)</span>
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+54
+55
+56</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/active_record_binder.rb', line 54</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_table_name'>table_name</span>
+  <span class='ivar'>@table_name</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+  </div>
+
+
+  <div id="class_method_details" class="method_details_list">
+    <h2>Class Method Details</h2>
+
+    
+      <div class="method_details first">
+  <h3 class="signature first" id="__check_migration_version-class_method">
+  
+    + (<tt>Object</tt>) <strong>__check_migration_version</strong>(version) 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Private : checks the migration version number</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'></span>
+      
+      
+      
+        
+        <div class='inline'>
+<p>the version as a Float.</p>
+</div>
+      
+    </li>
+  
+</ul>
+<p class="tag_title">Raises:</p>
+<ul class="raise">
+  
+    <li>
+      
+      
+        <span class='type'></span>
+      
+      
+      
+        
+        <div class='inline'>
+<p>MigrationVersionError if the required version does not exist.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+328
+329
+330
+331</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/active_record_binder.rb', line 328</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid___check_migration_version'>__check_migration_version</span> <span class='id identifier rubyid_version'>version</span>
+  <span class='id identifier rubyid_raise'>raise</span> <span class='const'>MigrationVersionError</span> <span class='kw'>if</span> <span class='kw'>not</span> <span class='id identifier rubyid_version'>version</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='kw'>and</span> <span class='ivar'>@last_version</span> <span class='op'>&lt;</span> <span class='id identifier rubyid_version'>version</span>
+  <span class='id identifier rubyid_version'>version</span> <span class='op'>||=</span> <span class='ivar'>@last_version</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="__create_meta_data_table_for-class_method">
+  
+    + (<tt>Object</tt>) <strong>__create_meta_data_table_for</strong>(schema) 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Private : Create a table for the current meta schema.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+  <div class="examples">
+    <p class="tag_title">Examples:</p>
+    
+      
+      <pre class="example code"><code><span class='id identifier rubyid___create_meta_data_table_for'>__create_meta_data_table_for</span> <span class='const'>MyPlug</span> <span class='comment'># Will create a my_plug_meta_schemas table.</span></code></pre>
+    
+  </div>
+<p class="tag_title">Parameters:</p>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>schema</span>
+      
+      
+        <span class='type'></span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>The schema Class for which we want to create the table.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'></span>
+      
+      
+      
+        
+        <div class='inline'>
+<p>Nothing.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+308
+309
+310
+311
+312
+313
+314
+315
+316
+317
+318
+319
+320
+321</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/active_record_binder.rb', line 308</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid___create_meta_data_table_for'>__create_meta_data_table_for</span> <span class='id identifier rubyid_schema'>schema</span>
+  <span class='const'>ActiveRecord</span><span class='op'>::</span><span class='const'>Base</span><span class='period'>.</span><span class='id identifier rubyid_establish_connection'>establish_connection</span><span class='lparen'>(</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_connection_data'>connection_data</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id identifier rubyid_schema'>schema</span><span class='period'>.</span><span class='id identifier rubyid_connected?'>connected?</span>
+
+  <span class='comment'># Clears the table cache for the schema (remove TableDoesNotExists if a table actually exists)
+</span>  <span class='id identifier rubyid_schema'>schema</span><span class='period'>.</span><span class='id identifier rubyid_clear_cache!'>clear_cache!</span>
+
+  <span class='kw'>unless</span> <span class='id identifier rubyid_schema'>schema</span><span class='period'>.</span><span class='id identifier rubyid_table_exists?'>table_exists?</span>
+    <span class='const'>ActiveRecord</span><span class='op'>::</span><span class='const'>Schema</span><span class='period'>.</span><span class='id identifier rubyid_define'>define</span> <span class='kw'>do</span>
+      <span class='id identifier rubyid_create_table'>create_table</span> <span class='id identifier rubyid_schema'>schema</span><span class='period'>.</span><span class='id identifier rubyid_table_name'>table_name</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_t'>t</span><span class='op'>|</span>
+        <span class='id identifier rubyid_t'>t</span><span class='period'>.</span><span class='id identifier rubyid_column'>column</span> <span class='symbol'>:version</span><span class='comma'>,</span> <span class='symbol'>:float</span>
+      <span class='kw'>end</span>
+    <span class='kw'>end</span>
+  <span class='kw'>end</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="__create_meta_schema_class-class_method">
+  
+    + (<tt>Object</tt>) <strong>__create_meta_schema_class</strong>(klass) 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Private: Creates the meta schema class, and binds it to the current
+Namespace.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+  <div class="examples">
+    <p class="tag_title">Examples:</p>
+    
+      
+      <pre class="example code"><code><span class='kw'>class</span> <span class='const'>Plug</span> <span class='op'>&lt;</span> <span class='const'>Binder</span><span class='op'>::</span><span class='const'>AR</span><span class='semicolon'>;</span> <span class='kw'>end</span>
+<span class='id identifier rubyid___create_meta_schema_class'>__create_meta_schema_class</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>MetaSchema</span><span class='tstring_end'>&quot;</span></span>
+<span class='comment'># =&gt; Plug::MetaSchema</span></code></pre>
+    
+  </div>
+
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'></span>
+      
+      
+      
+        
+        <div class='inline'>
+<p>a new Class inheriting from ActiveRecord::Base.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+342
+343
+344
+345
+346
+347
+348
+349
+350</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/active_record_binder.rb', line 342</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid___create_meta_schema_class'>__create_meta_schema_class</span> <span class='id identifier rubyid_klass'>klass</span>
+  <span class='id identifier rubyid_binder'>binder</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span>
+  <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_const_set'>const_set</span><span class='lparen'>(</span><span class='id identifier rubyid_klass'>klass</span><span class='comma'>,</span>
+    <span class='const'>Class</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='const'>ActiveRecord</span><span class='op'>::</span><span class='const'>Base</span><span class='rparen'>)</span> <span class='kw'>do</span>                                <span class='comment'># class MetaSchema &lt; ActiveRecord::Base
+</span>      <span class='id identifier rubyid_singleton_class'>singleton_class</span><span class='period'>.</span><span class='id identifier rubyid_send'>send</span><span class='lparen'>(</span><span class='symbol'>:define_method</span><span class='comma'>,</span> <span class='symbol'>:table_name_prefix</span><span class='rparen'>)</span> <span class='kw'>do</span>   <span class='comment'>#   def self.table_name_prefix
+</span>        <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_binder'>binder</span><span class='period'>.</span><span class='id identifier rubyid_underscore'>underscore</span><span class='rbrace'>}</span><span class='tstring_content'>_</span><span class='tstring_end'>&quot;</span></span>                                   <span class='comment'>#     &quot;foo_binder&quot; # If we have a class FooBinder &lt; Binder::AR
+</span>      <span class='kw'>end</span>                                                           <span class='comment'>#   end
+</span>    <span class='kw'>end</span><span class='rparen'>)</span>                                                            <span class='comment'># end
+</span><span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="adapter-class_method">
+  
+    + (<tt>Object</tt>) <strong>adapter</strong>(adpt = default_adapter) 
+  
+
+  
+    <span class="aliases">Also known as:
+    <span class="names"><span id='adaptor-class_method'>adaptor</span></span>
+    </span>
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Set the current adapter</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+  <div class="examples">
+    <p class="tag_title">Examples:</p>
+    
+      
+      <pre class="example code"><code><span class='kw'>class</span> <span class='const'>Plug</span> <span class='op'>&lt;</span> <span class='const'>Binder</span><span class='op'>::</span><span class='const'>AR</span>
+  <span class='id identifier rubyid_adapter'>adapter</span> <span class='symbol'>:foobar</span>
+<span class='kw'>end</span></code></pre>
+    
+  </div>
+<p class="tag_title">Parameters:</p>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>adpt</span>
+      
+      
+        <span class='type'></span>
+      
+      
+        <em class="default">(defaults to: <tt>default_adapter</tt>)</em>
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>the adapter, as a String or Symbol. (default: Binder::AR.default_adapter)</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'></span>
+      
+      
+      
+        
+        <div class='inline'>
+<p>the current database.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+139
+140
+141
+142
+143
+144
+145</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/active_record_binder.rb', line 139</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_adapter'>adapter</span> <span class='id identifier rubyid_adpt'>adpt</span> <span class='op'>=</span> <span class='id identifier rubyid_default_adapter'>default_adapter</span>
+  <span class='kw'>if</span> <span class='id identifier rubyid_adpt'>adpt</span> <span class='op'>==</span> <span class='id identifier rubyid_default_adapter'>default_adapter</span>
+    <span class='ivar'>@adapter</span> <span class='op'>||=</span> <span class='id identifier rubyid_adpt'>adpt</span>
+  <span class='kw'>else</span>
+    <span class='ivar'>@adapter</span> <span class='op'>=</span> <span class='id identifier rubyid_adpt'>adpt</span>
+  <span class='kw'>end</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="connection-class_method">
+  
+    + (<tt>Object</tt>) <strong>connection</strong>(opts = {}) 
+  
+
+  
+    <span class="aliases">Also known as:
+    <span class="names"><span id='connect_with-class_method'>connect_with</span></span>
+    </span>
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Set the current connection parameters</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+  <div class="examples">
+    <p class="tag_title">Examples:</p>
+    
+      
+      <pre class="example code"><code><span class='kw'>class</span> <span class='const'>Plug</span> <span class='op'>&lt;</span> <span class='const'>Binder</span><span class='op'>::</span><span class='const'>AR</span>
+  <span class='id identifier rubyid_adapter'>adapter</span> <span class='symbol'>:foobar</span>
+<span class='kw'>end</span></code></pre>
+    
+  </div>
+<p class="tag_title">Parameters:</p>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>opts</span>
+      
+      
+        <span class='type'></span>
+      
+      
+        <em class="default">(defaults to: <tt>{}</tt>)</em>
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>A Hash, containing options to pass to the
+ActiveRecord::Base.establish_connection call (default: {}) user - A user
+name as a String. password - A password as a String. host - A host String.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'></span>
+      
+      
+      
+        
+        <div class='inline'>
+<p>the current database.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+162
+163
+164</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/active_record_binder.rb', line 162</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_connection'>connection</span> <span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
+  <span class='ivar'>@connection</span> <span class='op'>||=</span> <span class='id identifier rubyid_opts'>opts</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="connection_data-class_method">
+  
+    + (<tt>Object</tt>) <strong>connection_data</strong> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Retrieves a clean set of connection data to establish a connection</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'></span>
+      
+      
+      
+        
+        <div class='inline'>
+<p>a Hash.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+170
+171
+172
+173
+174
+175
+176
+177</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/active_record_binder.rb', line 170</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_connection_data'>connection_data</span>
+  <span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='label'>database:</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_database'>database</span><span class='comma'>,</span> <span class='label'>adapter:</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_adapter'>adapter</span> <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_connection'>connection</span><span class='rparen'>)</span>
+<span class='comment'># We ensure we have a string for the adapter
+</span>  <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:adapter</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:adapter</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>
+  <span class='comment'># If we have a symbol for the database and the adapter is sqlite3, we create a string and add '.sqlite3' to the end
+</span>  <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:database</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:database</span><span class='rbracket'>]</span><span class='rbrace'>}</span><span class='tstring_content'>.sqlite3</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:adapter</span><span class='rbracket'>]</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>sqlite3</span><span class='tstring_end'>'</span></span> <span class='kw'>and</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:database</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span> <span class='op'>==</span> <span class='const'>Symbol</span>
+  <span class='id identifier rubyid_opts'>opts</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="database-class_method">
+  
+    + (<tt>Object</tt>) <strong>database</strong>(db = default_database) 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Set the current database</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+  <div class="examples">
+    <p class="tag_title">Examples:</p>
+    
+      
+      <pre class="example code"><code><span class='kw'>class</span> <span class='const'>Plug</span> <span class='op'>&lt;</span> <span class='const'>Binder</span><span class='op'>::</span><span class='const'>AR</span>
+  <span class='id identifier rubyid_database'>database</span> <span class='symbol'>:foobar</span>
+<span class='kw'>end</span></code></pre>
+    
+  </div>
+<p class="tag_title">Parameters:</p>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>db</span>
+      
+      
+        <span class='type'></span>
+      
+      
+        <em class="default">(defaults to: <tt>default_database</tt>)</em>
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>the database, as a String or Symbol. (default: Binder::AR.default_database)</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'></span>
+      
+      
+      
+        
+        <div class='inline'>
+<p>the current database.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+120
+121
+122
+123
+124
+125
+126</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/active_record_binder.rb', line 120</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_database'>database</span> <span class='id identifier rubyid_db'>db</span> <span class='op'>=</span> <span class='id identifier rubyid_default_database'>default_database</span>
+  <span class='kw'>if</span> <span class='id identifier rubyid_db'>db</span> <span class='op'>==</span> <span class='id identifier rubyid_default_database'>default_database</span>
+    <span class='ivar'>@database</span> <span class='op'>||=</span> <span class='id identifier rubyid_db'>db</span>
+  <span class='kw'>else</span>
+    <span class='ivar'>@database</span> <span class='op'>=</span> <span class='id identifier rubyid_db'>db</span>
+  <span class='kw'>end</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="default_adapter-class_method">
+  
+    + (<tt>Object</tt>) <strong>default_adapter</strong> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Retrieves de default database</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'></span>
+      
+      
+      
+        
+        <div class='inline'>
+<p>a the content of :sqlite3, as a Symbol.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+187</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/active_record_binder.rb', line 187</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_default_adapter'>default_adapter</span><span class='semicolon'>;</span>  <span class='symbol'>:sqlite3</span> <span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="default_database-class_method">
+  
+    + (<tt>'APP_DB'\</tt>) <strong>default_database</strong> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Retrieves de default database</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>'APP_DB'\</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>Returns a the content of ENV'APP_DB'.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+182</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/active_record_binder.rb', line 182</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_default_database'>default_database</span><span class='semicolon'>;</span> <span class='const'>ENV</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>APP_DB</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span> <span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="meta_schema-class_method">
+  
+    + (<tt>Object</tt>) <strong>meta_schema</strong> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Private: Get the Class holding the current migration metadatas.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'></span>
+      
+      
+      
+        
+        <div class='inline'>
+<p>an ActiveRecord::Base subclass.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+287
+288
+289
+290
+291
+292
+293
+294
+295</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/active_record_binder.rb', line 287</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_meta_schema'>meta_schema</span>
+  <span class='id identifier rubyid_klass'>klass</span> <span class='op'>=</span> <span class='symbol'>:MetaSchema</span>
+  <span class='ivar'>@meta_schema</span> <span class='op'>||=</span>
+    <span class='kw'>if</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_const_defined?'>const_defined?</span><span class='lparen'>(</span><span class='id identifier rubyid_klass'>klass</span><span class='rparen'>)</span>
+      <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_const_get'>const_get</span><span class='lparen'>(</span><span class='id identifier rubyid_klass'>klass</span><span class='rparen'>)</span>
+    <span class='kw'>else</span>
+      <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid___create_meta_schema_class'>__create_meta_schema_class</span><span class='lparen'>(</span><span class='id identifier rubyid_klass'>klass</span><span class='rparen'>)</span>
+    <span class='kw'>end</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="migrate-class_method">
+  
+    + (<tt>Object</tt>) <strong>migrate</strong>(version = nil) 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Executes a migration.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+  <div class="examples">
+    <p class="tag_title">Examples:</p>
+    
+      
+      <pre class="example code"><code><span class='comment'># (See the Binder::AR::Version examples for the classes definition.)
+</span><span class='const'>Plug</span><span class='period'>.</span><span class='id identifier rubyid_migrate'>migrate</span> <span class='float'>1.0</span> <span class='comment'># Creates table bars.
+</span><span class='comment'># =&gt; 1.0
+</span><span class='const'>Plug</span><span class='period'>.</span><span class='id identifier rubyid_migrate'>migrate</span> <span class='int'>0</span>   <span class='comment'># Drop the table bars.
+</span><span class='comment'># =&gt; 0.0
+</span><span class='const'>Plug</span><span class='period'>.</span><span class='id identifier rubyid_migrate'>migrate</span>     <span class='comment'># Creates tables bars and foos.
+</span><span class='comment'># =&gt; 1.1</span></code></pre>
+    
+  </div>
+<p class="tag_title">Parameters:</p>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>version</span>
+      
+      
+        <span class='type'></span>
+      
+      
+        <em class="default">(defaults to: <tt>nil</tt>)</em>
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>A Float or Numeric indicating the number towards which execute the
+migration. If none specified it will migrate to the latest migration.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'></span>
+      
+      
+      
+        
+        <div class='inline'>
+<p>the version we migrated to as a Float.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+260
+261
+262
+263
+264
+265
+266
+267
+268
+269
+270
+271
+272
+273
+274
+275
+276
+277
+278
+279
+280
+281
+282</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/active_record_binder.rb', line 260</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_migrate'>migrate</span> <span class='id identifier rubyid_version'>version</span> <span class='op'>=</span> <span class='kw'>nil</span>
+  <span class='kw'>if</span> <span class='ivar'>@migrations</span>
+    <span class='id identifier rubyid_schema'>schema</span>  <span class='op'>=</span> <span class='id identifier rubyid_meta_schema'>meta_schema</span>
+    <span class='id identifier rubyid_version'>version</span> <span class='op'>=</span> <span class='id identifier rubyid___check_migration_version'>__check_migration_version</span><span class='lparen'>(</span><span class='id identifier rubyid_version'>version</span><span class='rparen'>)</span>
+    <span class='id identifier rubyid___create_meta_data_table_for'>__create_meta_data_table_for</span><span class='lparen'>(</span><span class='id identifier rubyid_schema'>schema</span><span class='rparen'>)</span>
+
+    <span class='id identifier rubyid_s'>s</span> <span class='op'>=</span> <span class='id identifier rubyid_schema'>schema</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span> <span class='op'>||</span> <span class='id identifier rubyid_schema'>schema</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='label'>version:</span> <span class='int'>0</span><span class='rparen'>)</span>
+    <span class='kw'>unless</span> <span class='id identifier rubyid_s'>s</span><span class='period'>.</span><span class='id identifier rubyid_version'>version</span> <span class='op'>==</span> <span class='id identifier rubyid_version'>version</span>
+      <span class='ivar'>@migrations</span><span class='period'>.</span><span class='id identifier rubyid_sort_by'>sort_by</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_migration'>migration</span><span class='op'>|</span> <span class='id identifier rubyid_migration'>migration</span><span class='period'>.</span><span class='id identifier rubyid_version'>version</span> <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_m'>m</span><span class='op'>|</span>
+        <span class='id identifier rubyid_m'>m</span><span class='period'>.</span><span class='id identifier rubyid_migrate'>migrate</span><span class='lparen'>(</span><span class='symbol'>:up</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_s'>s</span><span class='period'>.</span><span class='id identifier rubyid_version'>version</span> <span class='op'>&lt;</span> <span class='id identifier rubyid_m'>m</span><span class='period'>.</span><span class='id identifier rubyid_version'>version</span> <span class='kw'>and</span> <span class='id identifier rubyid_m'>m</span><span class='period'>.</span><span class='id identifier rubyid_version'>version</span> <span class='op'>&lt;=</span> <span class='id identifier rubyid_version'>version</span>
+
+        <span class='kw'>if</span> <span class='id identifier rubyid_s'>s</span><span class='period'>.</span><span class='id identifier rubyid_version'>version</span> <span class='op'>&gt;=</span> <span class='id identifier rubyid_m'>m</span><span class='period'>.</span><span class='id identifier rubyid_version'>version</span> <span class='kw'>and</span> <span class='id identifier rubyid_m'>m</span><span class='period'>.</span><span class='id identifier rubyid_version'>version</span> <span class='op'>&gt;</span> <span class='id identifier rubyid_version'>version</span>
+          <span class='id identifier rubyid_m'>m</span><span class='period'>.</span><span class='id identifier rubyid_migrate'>migrate</span><span class='lparen'>(</span><span class='symbol'>:down</span><span class='rparen'>)</span>
+        <span class='kw'>else</span> <span class='comment'># Handle migrate(0)
+</span>          <span class='id identifier rubyid_m'>m</span><span class='period'>.</span><span class='id identifier rubyid_migrate'>migrate</span><span class='lparen'>(</span><span class='symbol'>:down</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_s'>s</span><span class='period'>.</span><span class='id identifier rubyid_version'>version</span> <span class='op'>&gt;=</span> <span class='id identifier rubyid_m'>m</span><span class='period'>.</span><span class='id identifier rubyid_version'>version</span> <span class='kw'>and</span> <span class='id identifier rubyid_version'>version</span><span class='period'>.</span><span class='id identifier rubyid_zero?'>zero?</span>
+        <span class='kw'>end</span>
+      <span class='kw'>end</span>
+      <span class='id identifier rubyid_s'>s</span><span class='period'>.</span><span class='id identifier rubyid_update_attribute'>update_attribute</span> <span class='symbol'>:version</span><span class='comma'>,</span> <span class='id identifier rubyid_version'>version</span>
+    <span class='kw'>end</span>
+    <span class='id identifier rubyid_version'>version</span> <span class='op'>=</span> <span class='id identifier rubyid_s'>s</span><span class='period'>.</span><span class='id identifier rubyid_version'>version</span>
+  <span class='kw'>end</span>
+  <span class='id identifier rubyid_version'>version</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="Version-class_method">
+  
+    + (<tt>Object</tt>) <strong>Version</strong>(n) 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Creates a new migration version through subclassing.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+  <div class="examples">
+    <p class="tag_title">Examples:</p>
+    
+      
+      <pre class="example code"><code><span class='kw'>class</span> <span class='const'>Plug</span> <span class='op'>&lt;</span> <span class='const'>Binder</span><span class='op'>::</span><span class='const'>AR</span><span class='semicolon'>;</span> <span class='kw'>end</span></code></pre>
+    
+      
+      <pre class="example code"><code>class CreateFooTable &lt; Plug::Version 1.0
+  def self.up
+    create_table :foos do |t|
+      t.string :name
+      t.timestamps
+    end
+  end</code></pre>
+    
+      
+      <pre class="example code"><code>def self.down
+    drop_table :foos
+  end
+end</code></pre>
+    
+      
+      <pre class="example code"><code>class CreateBarTable &lt; Plug::Version 1.1
+  def self.up
+    create_table :bars do |t|
+      t.string :title
+      t.timestamps
+    end
+  end</code></pre>
+    
+      
+      <pre class="example code"><code>def self.down
+    drop_table :bars
+  end
+end</code></pre>
+    
+      
+      <pre class="example code"><code><span class='comment'># You can get the migration version for a pecular migration class.
+</span><span class='const'>CreateFooTable</span><span class='period'>.</span><span class='id identifier rubyid_version'>version</span> <span class='comment'># =&gt; 1.0
+</span><span class='const'>CreateBarTable</span><span class='period'>.</span><span class='id identifier rubyid_version'>version</span> <span class='comment'># =&gt; 1.1</span></code></pre>
+    
+  </div>
+<p class="tag_title">Parameters:</p>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>n</span>
+      
+      
+        <span class='type'></span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>A migration version number as Float.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'></span>
+      
+      
+      
+        
+        <div class='inline'>
+<p>a new Class, subclassing ActiveRecord::Migration.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+228
+229
+230
+231
+232
+233
+234
+235
+236
+237
+238
+239
+240
+241
+242</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/active_record_binder.rb', line 228</span>
+
+<span class='kw'>def</span> <span class='const'>Version</span> <span class='id identifier rubyid_n'>n</span>
+  <span class='ivar'>@last_version</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='id identifier rubyid_n'>n</span><span class='comma'>,</span> <span class='ivar'>@last_version</span><span class='period'>.</span><span class='id identifier rubyid_to_f'>to_f</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_max'>max</span> <span class='comment'># Assign or retrieves the last migration version number
+</span>  <span class='comment'># migrations is a pointer to the instance variable
+</span>  <span class='id identifier rubyid_migrations'>migrations</span> <span class='op'>=</span> <span class='lparen'>(</span><span class='ivar'>@migrations</span> <span class='op'>||=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span><span class='rparen'>)</span>
+  <span class='const'>Class</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='const'>ActiveRecord</span><span class='op'>::</span><span class='const'>Migration</span><span class='rparen'>)</span> <span class='kw'>do</span>
+    <span class='id identifier rubyid_singleton_class'>singleton_class</span><span class='period'>.</span><span class='id identifier rubyid_send'>send</span><span class='lparen'>(</span><span class='symbol'>:define_method</span><span class='comma'>,</span> <span class='symbol'>:version</span><span class='rparen'>)</span> <span class='kw'>do</span>   <span class='comment'>#  def self.version
+</span>      <span class='id identifier rubyid_n'>n</span>                                                 <span class='comment'>#    n
+</span>    <span class='kw'>end</span>                                                 <span class='comment'>#  end
+</span>
+    <span class='comment'># Callback invoked whenever a subclass of the current class is created
+</span>    <span class='id identifier rubyid_singleton_class'>singleton_class</span><span class='period'>.</span><span class='id identifier rubyid_send'>send</span><span class='lparen'>(</span><span class='symbol'>:define_method</span><span class='comma'>,</span> <span class='symbol'>:inherited</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_s'>s</span><span class='op'>|</span>  <span class='comment'># def self.inherited subclass
+</span>      <span class='id identifier rubyid_migrations'>migrations</span> <span class='op'>&lt;&lt;</span> <span class='id identifier rubyid_s'>s</span>                                        <span class='comment'>#     migrations &lt;&lt; subclass
+</span>    <span class='kw'>end</span>                                                      <span class='comment'># end
+</span>  <span class='kw'>end</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+  </div>
+
+</div>
+
+    <div id="footer">
+  Generated on Thu Feb 21 02:06:17 2013 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.8.4.1 (ruby-1.9.3).
+</div>
+
+  </body>
+</html>