RubyGems - active-record-binder - Versions diffs - 1.1.0 → 1.2.0 - Mend

active-record-binder 1.1.0 → 1.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (47) hide show

data/README.md +217 -0
data/bin/arb +13 -0
data/doc/Binder.html +150 -0
data/doc/Binder/AR.html +1880 -0
data/doc/Binder/Command.html +252 -0
data/doc/Binder/Help.html +374 -0
data/doc/Binder/Migrate.html +682 -0
data/doc/Binder/Strategy.html +550 -0
data/doc/Binder/Version.html +285 -0
data/doc/Class.html +220 -0
data/doc/CommandParser.html +268 -0
data/doc/CommandParser/ParseError.html +123 -0
data/doc/DeferedDelegator.html +414 -0
data/doc/MigrationProcessError.html +123 -0
data/doc/MigrationVersionError.html +123 -0
data/doc/String.html +245 -0
data/doc/_index.html +256 -0
data/doc/class_list.html +53 -0
data/doc/css/common.css +1 -0
data/doc/css/full_list.css +57 -0
data/doc/css/style.css +328 -0
data/doc/file.README.html +300 -0
data/doc/file_list.html +55 -0
data/doc/frames.html +28 -0
data/doc/index.html +300 -0
data/doc/js/app.js +214 -0
data/doc/js/full_list.js +173 -0
data/doc/js/jquery.js +4 -0
data/doc/method_list.html +348 -0
data/doc/top-level-namespace.html +114 -0
data/extras/cli_help.png +0 -0
data/lib/active_record_binder.rb +21 -37
data/lib/cli/command.rb +101 -0
data/lib/cli/command_parser.rb +29 -0
data/lib/cli/commands/commands.rb +4 -0
data/lib/cli/commands/help.rb +35 -0
data/lib/cli/commands/migrate.rb +77 -0
data/lib/cli/commands/version.rb +16 -0
data/lib/cli/core_ext.rb +21 -0
data/lib/defered_delegator.rb +69 -0
data/lib/version.rb +3 -0
data/test/active_record_binder_test.rb +262 -0
data/test/foo.sqlite3 +0 -0
data/test/migrations.rb +29 -0
data/test/minitest_helper.rb +15 -0
data/test/mocks.rb +24 -0
metadata +62 -5

data/doc/top-level-namespace.html ADDED

@@ -0,0 +1,114 @@
+<!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>
+  Top Level Namespace
+    &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> &raquo;
+    <span class="title">Top Level Namespace</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>Top Level Namespace
+</h1>
+<dl class="box">
+</dl>
+<div class="clear"></div>
+<h2>Defined Under Namespace</h2>
+<p class="children">
+      <strong class="modules">Modules:</strong> <span class='object_link'><a href="Binder.html" title="Binder (module)">Binder</a></span>, <span class='object_link'><a href="CommandParser.html" title="CommandParser (module)">CommandParser</a></span>, <span class='object_link'><a href="DeferedDelegator.html" title="DeferedDelegator (module)">DeferedDelegator</a></span>
+      <strong class="classes">Classes:</strong> <span class='object_link'><a href="Class.html" title="Class (class)">Class</a></span>, <span class='object_link'><a href="MigrationProcessError.html" title="MigrationProcessError (class)">MigrationProcessError</a></span>, <span class='object_link'><a href="MigrationVersionError.html" title="MigrationVersionError (class)">MigrationVersionError</a></span>, <span class='object_link'><a href="String.html" title="String (class)">String</a></span>
+</p>
+</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/extras/cli_help.png ADDED

Binary file

data/lib/active_record_binder.rb CHANGED

@@ -1,33 +1,9 @@
 require 'active_record'
 require 'active_support/core_ext/string'
-require 'forwardable'
-# Private: A simple module that delegates classes methods when needed, keeping the calls in memory.
-module DifferedDelegator
-  def register_delegators *args
-    args.each do |delegator|
-      delegator = delegator.to_s
-      module_eval %Q{
-        def self.#{delegator} *parameters
-          @delegators ||= []
-          @delegators << { name: :#{delegator}, params: parameters }
-        end
-      }
-    end
-  end
-  def delegate_to klass_or_object
-    @delegators.each do |data|
-      unless data.empty?
-        name = data[:name]
-        args = data[:params]
-        klass_or_object.send(name, *args)
-      end
-    end
-  end
-end
+require_relative './defered_delegator'
 class MigrationVersionError < Exception; end
+class MigrationProcessError < Exception; end
 # Public: Namespace containing classes to create binder to.
 # A binder is simply a tool to use for Databases plugs or adaptors building.
@@ -73,7 +49,7 @@ module Binder
   #   ARMySqlPlug::connection # => { :user => 'Foo', :password => 'Bar', :host => 'localhost' }
   #
   class AR
-    extend DifferedDelegator
+    extend DeferedDelegator
     attr_reader :table_name, :table
     register_delegators :has_many, :has_one, :has_and_belongs_to_many, :belongs_to
@@ -93,10 +69,10 @@ module Binder
     # Returns an instance of the binder's class.
     def initialize table_name
       @table_name = table_name
-      this = self.class
       # Retrieves or Create the ActiveRecord::Base subclass that will match the table.
-      table = meta_def_ar_class(this.database, this.adapter, this.connection)
+      table = meta_def_ar_class
       # Handle ActiveRecord::Base delegation, to ensure painless associations
       self.class.delegate_to table
@@ -112,7 +88,7 @@ module Binder
     # _params   - the connection parameters
     #
     # Returns the class object.
-    def meta_def_ar_class(_database, _adapter, _params)
+    def meta_def_ar_class
       klass  = table_name.to_s.classify
       binder = self.class
@@ -123,13 +99,7 @@ module Binder
           binder.const_set(klass,
           Class.new(ActiveRecord::Base) do                      # class `TableName` < ActiveRecord::Base
             singleton_class.send(:define_method, :connect) do   #   def self.connect
-              opts = { database: _database, adapter:  _adapter }.merge(_params)
-              # We ensure we have a string for the adapter
-              opts[:adapter] = opts[:adapter].to_s
-              # If we have a symbol for the database and the adapter is sqlite3, we create a string and add '.sqlite3' to the end
-              opts[:database] = "#{opts[:database]}.sqlite3" if opts[:adapter] == 'sqlite3' and opts[:database].class == Symbol
-              ActiveRecord::Base.establish_connection(opts)
+              ActiveRecord::Base.establish_connection(binder.connection_data)
             end                                                 #   end
           end)                                                  # end
         end #if
@@ -194,6 +164,18 @@ module Binder
       end
       alias :connect_with :connection
+      # Public: Retrieves a clean set of connection data to establish a connection
+      #
+      # Returns a Hash.
+      def connection_data
+        opts = { database: self.database, adapter: self.adapter }.merge(self.connection)
+      # We ensure we have a string for the adapter
+        opts[:adapter] = opts[:adapter].to_s
+        # If we have a symbol for the database and the adapter is sqlite3, we create a string and add '.sqlite3' to the end
+        opts[:database] = "#{opts[:database]}.sqlite3" if opts[:adapter] == 'sqlite3' and opts[:database].class == Symbol
+        opts
+      end
       # Public: Retrieves de default database
       #
       # Returns a the content of ENV\['APP_DB'\].
@@ -324,6 +306,8 @@ module Binder
       #
       # Returns Nothing.
       def __create_meta_data_table_for schema
+        ActiveRecord::Base.establish_connection(self.connection_data) unless schema.connected?
         # Clears the table cache for the schema (remove TableDoesNotExists if a table actually exists)
         schema.clear_cache!

data/lib/cli/command.rb ADDED

@@ -0,0 +1,101 @@
+require_relative './command_parser'
+require_relative './core_ext'
+module Binder
+  # Public: A Class to create Command Line Tool commands.
+  #
+  # Examples
+  #
+  #   Binder::Command.new ARGV
+  #   # => Will execute any command passed in ARGV
+  #   # A command is just a ruby Class, subclassing the Binder::Strategy Class.
+  #   #
+  #   # When you do :
+  #   Binder::Command.new "migrate --version 1.1"
+  #   # => The Binder::Migrate class is instanciated and it's execute method is called.
+  class Command
+    def initialize args
+      raise CommandParser::ParseError.new("No command specified.") if args.empty?
+      # ['--migrate' 'param'] => 'migrate'
+      command  = args.shift.gsub(/\-/, '')
+      strategy = Binder::const_get(command.capitalize).new
+      puts strategy.execute args
+    end
+  end
+  # Public: A Strategy is a way to declare a specific command.
+  # You need to subclass the Binder::Strategy class and declare an `execute` method and a `description` method.
+  #
+  # Examples
+  #
+  #   class Migrate < Binder::Strategy
+  #     def execute args
+  #       # Parse args and do migration stuff
+  #       "Migration Done." # <= Binder::Command.new automaticaly renders the return value of an `execute` call
+  #     end
+  #     #
+  #     # The description call is mainly used by the `help` command.
+  #     def description
+  #       "Easier Migration. Use the " + "--directory".colorize(:orange) + " option to pass in a directory to load."
+  #       # Yeah, notice the "colorize" String method that helps you write a string in a beatiful color.
+  #     end
+  #   end
+  class Strategy
+    # Public: creates an alias for the command.
+    #
+    # Examples
+    #
+    #   class Migrate < Binder::Strategy
+    #     # def execute...
+    #     # def description...
+    #     #
+    #     alias_class :M
+    #     # => This will create an alias :M class and this the existance of the corresponding "-m" command. (`arb --migrate` or `arb -m`, now)
+    #   end
+    def self.alias_class _alias
+      Binder::const_set(_alias, Class.new(self))
+    end
+    # Public: returns the String size of the biggest command or option group.
+    #
+    # Returns a Numeric.
+    def justify_size
+      if @options.nil?
+        Binder::Strategy.subclasses.map(&:to_s).group_by(&:size).max.flatten.first - "Binder".length
+      else
+        @options.group_by(&:size).max.flatten.first
+      end
+    end
+    # Public: merge options and aliases "-m, --migrate, -h, --help", etc...
+    #
+    # Uses an array of commands : ["-h" "-m", "--help", "--migrate"],
+    #
+    # and concatenate the aliases : ["-m, --migrate", "-h, --help"]
+    #
+    # Returns an Array of merged aliases.
+    def merge_options_aliases
+      commands     = Binder::Strategy.subclasses.map { |command| command.to_s.gsub!('Binder::', '').downcase }.sort
+      previous_cmd = ""
+      options      = []
+      commands.each_with_index do |cmd, i|
+        if cmd.length == 1
+          previous_cmd = cmd
+        elsif not previous_cmd.empty?
+          cmd_prefixes = [previous_cmd.length == 1 ? '-' : '--', cmd.length == 1 ? '-' : '--']
+          options << "#{cmd_prefixes.first}#{previous_cmd}, #{cmd_prefixes.last}#{cmd}"
+          previous_cmd = ""
+        end
+      end
+      @options = options
+    end
+    # Public: provides a default description if not defined.
+    #
+    # Returns a "No description found" String.
+    def description; "No description found" end
+  end
+end

data/lib/cli/command_parser.rb ADDED

@@ -0,0 +1,29 @@
+module CommandParser
+  # Public: Parse options and creates an array of hash data for each.
+  #
+  # args - An Array of options and parameters to parse.
+  #
+  # Examples
+  #
+  #   CommandParser::parse_options "--directory lib/ migrations/ --adapter MySqlPlug"
+  #   # => [{ option: 'directory', option_args: ["lib/", "migrations/"] }, { option: 'adapter', option_args: ["MySqlPlug"] }]
+  #
+  # Returns a parsed array.
+  def self.parse_options(args)
+    parsed = []
+    last_option = ""
+    args.each do |chunk|
+      if chunk[/^-*/].empty?
+        raise CommandParser::ParseError.new("Arguments given but no option has been specified.") if last_option.empty?
+        cur_cmd = parsed.last
+        cur_cmd[:options_args] ||= []
+        cur_cmd[:options_args] << chunk
+      else
+        parsed << { option: chunk.sub(/^-*/, '') } and last_option = chunk
+      end
+    end
+    parsed
+  end
+  class CommandParser::ParseError < StandardError; end
+end

data/lib/cli/commands/commands.rb ADDED

@@ -0,0 +1,4 @@
+require_relative '../command.rb'
+require_relative './migrate'
+require_relative './version'
+require_relative './help'

data/lib/cli/commands/help.rb ADDED

@@ -0,0 +1,35 @@
+require_relative './version'
+module Binder
+  # Public: [Command] Displays the help for `arb`. Used via the `arb` command.
+  class Help < Binder::Strategy
+    def execute args
+      instructions = []
+      help_topics = merge_options_aliases
+      help_topics.each do |topic|
+        binder   = Module.nesting.last
+        cmd_name = topic.split(" ").last.gsub(/^-*/, '').capitalize
+        command =  binder.const_get(cmd_name)
+        cmd_description = command.new.description
+        instructions << format_instruction(topic.to_s, cmd_description)
+      end
+      Version.new.execute(nil) + "\n" +
+      instructions.join("\n")
+    end
+    def format_instruction name, description
+      "  #{name.ljust(justify_size).colorize(:green)} - #{description}"
+    end
+    def description
+      "Displays the help"
+    end
+    alias_class :H
+  end
+end

data/lib/cli/commands/migrate.rb ADDED

@@ -0,0 +1,77 @@
+require 'active_record_binder'
+module Binder
+  # Public: [Command] Runs your migrations. Used via the `arb` command.
+  class Migrate < Binder::Strategy
+    def execute args
+      commands = CommandParser::parse_options(args)
+      commands.each do |c|
+        option = c[:option]
+        args   = c[:options_args]
+        self.send(option.to_sym, args)
+      end
+      "\nDone."
+    end
+    def version version
+      puts "Migrating toward version #{version.first.to_f.to_s.colorize(:orange)}"
+      @version ||= version.first.to_f
+    end
+    alias :v :version
+    alias :to :version
+    def plug args
+      args.each do |klass|
+        raise MigrationProcessError.new("Plug #{klass.colorize(:red)} not found.") unless Object.const_defined?(klass)
+        Object.const_get(klass).migrate @version
+      end
+    end
+    alias :a :plug
+    alias :adapter :plug
+    alias :adaptor :plug
+    def directory blobs, recursively = false
+      blobs.each do |blob|
+        blob = File::absolute_path(blob)
+        raise CommandParser::ParseError.new("Invalid argument : no such file or directory #{blob}.") unless File::exists?(blob)
+        if File::directory?(blob)
+          files = Dir.glob("#{blob}/*")
+          files.each do |file|
+            if recursively == true && File::directory?(file)
+              directory [file], true
+            end
+            # Requires the file and logs it on stdout
+            puts _require_path(file) unless File::directory?(file)
+          end
+        else
+          puts _require_path(blob)
+        end
+      end
+    end
+    def _require_path path; "Requiring #{path.colorize(:green)}: #{require(path).to_s.colorize(:orange)}" end
+    alias :d :directory
+    alias :file :directory
+    alias :f :directory
+    def recursive blobs
+      directory blobs, true
+    end
+    alias :r :recursive
+    def description
+      indent = ' ' * (justify_size * 2)
+      str = []
+      str << "Migrate to the specified version"
+      str << "#{indent}" + "-v".colorize(:rose) + ", --version".colorize(:rose) + ", --to".colorize(:rose) + "    - Version we want to migrate to"
+      str << "#{indent}" + "-d".colorize(:rose) + ", --directory".colorize(:rose) + "        - Allow to specify a set of directories holding your migrations"
+      str << "#{indent}" + "-r".colorize(:rose) + ", --recursive".colorize(:rose) + "        - Same as `--directory` but will search recursively in the directories"
+      str << "#{indent}" + "-f".colorize(:rose) + ", --file".colorize(:rose) + "             - Allow to specify a set of files holding your migrations"
+      str << "#{indent}" + "-a".colorize(:rose) + ", --adapter".colorize(:rose) + ", --plug".colorize(:rose) + "  - Specify a Binder class on which to run the migration"
+      str.join("\n")
+    end
+    alias_class :M
+  end
+end