rubyrep 1.0.0

data/History.txt

@@ -0,0 +1,4 @@
+== 1.0.0 2009-03-07
+
+* 1 major enhancement:
+  * Initial release

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2007 Arndt Lehmann
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Manifest.txt

@@ -0,0 +1,137 @@
+History.txt
+License.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/rubyrep
+config/hoe.rb
+config/mysql_config.rb
+config/postgres_config.rb
+config/proxied_test_config.rb
+config/redmine_config.rb
+config/rep_config.rb
+config/requirements.rb
+config/test_config.rb
+lib/rubyrep.rb
+lib/rubyrep/base_runner.rb
+lib/rubyrep/command_runner.rb
+lib/rubyrep/committers/buffered_committer.rb
+lib/rubyrep/committers/committers.rb
+lib/rubyrep/configuration.rb
+lib/rubyrep/connection_extenders/connection_extenders.rb
+lib/rubyrep/connection_extenders/jdbc_extender.rb
+lib/rubyrep/connection_extenders/mysql_extender.rb
+lib/rubyrep/connection_extenders/postgresql_extender.rb
+lib/rubyrep/database_proxy.rb
+lib/rubyrep/direct_table_scan.rb
+lib/rubyrep/generate_runner.rb
+lib/rubyrep/initializer.rb
+lib/rubyrep/logged_change.rb
+lib/rubyrep/proxied_table_scan.rb
+lib/rubyrep/proxy_block_cursor.rb
+lib/rubyrep/proxy_connection.rb
+lib/rubyrep/proxy_cursor.rb
+lib/rubyrep/proxy_row_cursor.rb
+lib/rubyrep/proxy_runner.rb
+lib/rubyrep/replication_difference.rb
+lib/rubyrep/replication_extenders/mysql_replication.rb
+lib/rubyrep/replication_extenders/postgresql_replication.rb
+lib/rubyrep/replication_extenders/replication_extenders.rb
+lib/rubyrep/replication_helper.rb
+lib/rubyrep/replication_initializer.rb
+lib/rubyrep/replication_run.rb
+lib/rubyrep/replication_runner.rb
+lib/rubyrep/replicators/replicators.rb
+lib/rubyrep/replicators/two_way_replicator.rb
+lib/rubyrep/scan_progress_printers/progress_bar.rb
+lib/rubyrep/scan_progress_printers/scan_progress_printers.rb
+lib/rubyrep/scan_report_printers/scan_detail_reporter.rb
+lib/rubyrep/scan_report_printers/scan_report_printers.rb
+lib/rubyrep/scan_report_printers/scan_summary_reporter.rb
+lib/rubyrep/scan_runner.rb
+lib/rubyrep/session.rb
+lib/rubyrep/sync_helper.rb
+lib/rubyrep/sync_runner.rb
+lib/rubyrep/syncers/syncers.rb
+lib/rubyrep/syncers/two_way_syncer.rb
+lib/rubyrep/table_scan.rb
+lib/rubyrep/table_scan_helper.rb
+lib/rubyrep/table_sorter.rb
+lib/rubyrep/table_spec_resolver.rb
+lib/rubyrep/table_sync.rb
+lib/rubyrep/trigger_mode_switcher.rb
+lib/rubyrep/type_casting_cursor.rb
+lib/rubyrep/uninstall_runner.rb
+lib/rubyrep/version.rb
+script/destroy
+script/generate
+script/txt2html
+setup.rb
+sims/performance/big_rep_spec.rb
+sims/performance/big_scan_spec.rb
+sims/performance/big_sync_spec.rb
+sims/performance/performance.rake
+sims/sim_helper.rb
+spec/base_runner_spec.rb
+spec/buffered_committer_spec.rb
+spec/command_runner_spec.rb
+spec/committers_spec.rb
+spec/configuration_spec.rb
+spec/connection_extender_interface_spec.rb
+spec/connection_extenders_registration_spec.rb
+spec/database_proxy_spec.rb
+spec/database_rake_spec.rb
+spec/db_specific_connection_extenders_spec.rb
+spec/db_specific_replication_extenders_spec.rb
+spec/direct_table_scan_spec.rb
+spec/generate_runner_spec.rb
+spec/initializer_spec.rb
+spec/logged_change_spec.rb
+spec/postgresql_replication_spec.rb
+spec/postgresql_support_spec.rb
+spec/progress_bar_spec.rb
+spec/proxied_table_scan_spec.rb
+spec/proxy_block_cursor_spec.rb
+spec/proxy_connection_spec.rb
+spec/proxy_cursor_spec.rb
+spec/proxy_row_cursor_spec.rb
+spec/proxy_runner_spec.rb
+spec/replication_difference_spec.rb
+spec/replication_extender_interface_spec.rb
+spec/replication_extenders_spec.rb
+spec/replication_helper_spec.rb
+spec/replication_initializer_spec.rb
+spec/replication_run_spec.rb
+spec/replication_runner_spec.rb
+spec/replicators_spec.rb
+spec/rubyrep_spec.rb
+spec/scan_detail_reporter_spec.rb
+spec/scan_progress_printers_spec.rb
+spec/scan_report_printers_spec.rb
+spec/scan_runner_spec.rb
+spec/scan_summary_reporter_spec.rb
+spec/session_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+spec/sync_helper_spec.rb
+spec/sync_runner_spec.rb
+spec/syncers_spec.rb
+spec/table_scan_helper_spec.rb
+spec/table_scan_spec.rb
+spec/table_sorter_spec.rb
+spec/table_spec_resolver_spec.rb
+spec/table_sync_spec.rb
+spec/trigger_mode_switcher_spec.rb
+spec/two_way_replicator_spec.rb
+spec/two_way_syncer_spec.rb
+spec/type_casting_cursor_spec.rb
+spec/uninstall_runner_spec.rb
+tasks/database.rake
+tasks/deployment.rake
+tasks/environment.rake
+tasks/java.rake
+tasks/redmine_test.rake
+tasks/rspec.rake
+tasks/rubyrep.tailor
+tasks/stats.rake
+tasks/task_helper.rb

data/README.txt

@@ -0,0 +1,37 @@
+= rubyrep
+
+== MISSION:
+
+Development of an open-source solution for asynchronous, master-master replication of relational databases that is
+* ridiculously easy to use
+* database independent
+
+
+== MORE INFORMATION:
+
+Refer to the project website at http://rubyrep.github.com
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Arndt Lehmann
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,30 @@
+require 'config/requirements'
+require 'config/hoe' if Object.const_defined? 'Hoe' # setup Hoe + all gem configuration
+
+require 'lib/rubyrep'
+require 'tasks/task_helper'
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }
+load 'sims/performance/performance.rake'
+
+desc "Creates the repository commit statistics"
+task :repostats do
+  # phase 0: create the repository tmp directory
+  system 'mkdir -p tmp'
+  # phase 1: migrate the hg repository to svn
+  tailor_path = '~/usr/tailor/tailor'
+  cmd = "#{tailor_path} --use-propset --configfile '#{File.dirname(__FILE__) + '/tasks/rubyrep.tailor'}'"
+  system cmd
+  
+  # phase 2: create the repository statistics through the statsvn library
+  jar_path = '~/usr/statsvn/statsvn.jar'
+  log_path = File.dirname(__FILE__) + '/tmp/statsvn.log'
+  checkout_path = '/tmp/rubyrep_tailor/svn'
+  svnstats_dir = File.dirname(__FILE__) + '/statsvn'
+
+  system "cd #{checkout_path}; svn update"
+  cmd = "cd #{checkout_path}; svn log -v --xml >#{log_path}"
+  system cmd
+  cmd = "java -jar #{jar_path} -output-dir #{svnstats_dir} -exclude 'setup.rb:website/**' #{log_path} #{checkout_path}"
+  system cmd
+end

data/bin/rubyrep

@@ -0,0 +1,8 @@
+#!/usr/bin/ruby
+
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
+
+require 'rubyrep'
+
+exit RR::CommandRunner.run(ARGV)
+

data/config/hoe.rb

@@ -0,0 +1,72 @@
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib/rubyrep'
+#require 'rubyrep/version'
+
+AUTHOR = 'Arndt Lehmann'  # can also be an array of Authors
+EMAIL = "mail@arndtlehman.com"
+DESCRIPTION = "Asynchronous master-master replication of relational databases."
+GEM_NAME = 'rubyrep' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'rubyrep' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "alehmann"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil 
+# UNCOMMENT IF REQUIRED: 
+# REV = `svn info`.each {|line| if line =~ /^Revision:/ then k,v = line.split(': '); break v.chomp; else next; end} rescue nil
+VERS = RR::VERSION::STRING + (REV ? ".#{REV}" : "")
+
+ENV['RDOCOPT'] = "-S -f html -T hanna"
+
+class Hoe
+  def extra_deps 
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' } 
+    @extra_deps
+  end 
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.author = AUTHOR 
+  p.description = DESCRIPTION
+  p.email = EMAIL
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+  
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\\n\\n")
+  #p.extra_deps = []     # An array of rubygem dependencies [name, version], e.g. [ ['active_support', '>= 1.3.1'] ]
+  p.extra_deps = [
+    ['activesupport', '>= 2.2.2'],
+    ['activerecord' , '>= 2.2.2']
+  ]
+  
+  #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  
+end
+
+CHANGES = hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''))

data/config/mysql_config.rb

@@ -0,0 +1,25 @@
+# Used as component of a rubyrep config file.
+# Defines connection parameters to the mysql databases.
+
+RR::Initializer::run do |config|
+  config.left = {
+    :adapter  => 'mysql',   
+    :database => 'rr_left',   
+    :username => 'root',   
+    :password => '',   
+    :host     => 'localhost',
+    :port     => 3306,
+    :encoding => 'utf8'
+  }
+
+  config.right = {
+    :adapter  => 'mysql',   
+    :database => 'rr_right',   
+    :username => 'root',   
+    :password => '',   
+    :host     => 'localhost',
+    :port     => 3306,
+    :encoding => 'utf8'
+  }
+
+end

data/config/postgres_config.rb

@@ -0,0 +1,21 @@
+# Used as component of a rubyrep config file.
+# Defines connection parameters to the postgresql databases.
+
+RR::Initializer::run do |config|
+  config.left = {
+    :adapter  => 'postgresql',   
+    :database => 'rr_left',   
+    :username => 'postgres',   
+    :password => 'password',   
+    :host     => 'localhost'
+  }
+
+  config.right = {
+    :adapter  => 'postgresql',   
+    :database => 'rr_right',   
+    :username => 'postgres',   
+    :password => 'password',   
+    :host     => 'localhost'
+  }
+
+end

data/config/proxied_test_config.rb

@@ -0,0 +1,14 @@
+# Rubyrep configuration file.
+# "Proxyfies" test_config.rb.
+
+load File.dirname(__FILE__) + '/test_config.rb'
+
+# $start_proxy_as_external_process = true
+
+RR::Initializer::run do |config|
+  config.left.merge!({
+    :proxy_host  => 'localhost',   
+    :proxy_port => '9876',   
+  })
+
+end

data/config/redmine_config.rb

@@ -0,0 +1,17 @@
+# Test configuration file for replication between two Redmine issue tracking
+# systems
+
+database = ENV['RR_TEST_DB'] ? ENV['RR_TEST_DB'] : :postgres
+
+load File.dirname(__FILE__) + "/#{database}_config.rb"
+
+RR::Initializer::run do |config|
+  config.left[:database] = 'leftmine'
+  config.right[:database] = 'rightmine'
+
+  config.include_tables(/./)
+  config.exclude_tables 'schema_migrations'
+  config.exclude_tables 'plugin_schema_infos'
+
+  config.options[:auto_key_limit] = 2
+end

data/config/rep_config.rb

@@ -0,0 +1,20 @@
+# Simple rubyrep configuration file.
+# Intendet to be used for manual tests of the rubyrep commands.
+#
+# IMPORTANT:
+# After completion of manual tests, use the 'db:test:rebuild' command to
+# recreate the test databases.
+# Otherwise the rspec tests will fail.
+
+database = ENV['RR_TEST_DB'] ? ENV['RR_TEST_DB'] : :postgres
+# $start_proxy_as_external_process = true
+
+load File.dirname(__FILE__) + "/#{database}_config.rb"
+
+RR::Initializer::run do |config|
+  config.options = {
+  }
+  config.include_tables 'scanner_left_records_only'
+  config.include_tables 'table_with_manual_key', :key => 'id'
+  config.include_tables 'extender_combined_key'
+end

data/config/requirements.rb

@@ -0,0 +1,32 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+
+# Load essential gems. Exit if not available.
+%w[rake activerecord].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end  
+end
+
+# Load gem builder / ruby-forge integration gems. Complain but continue if not available.
+%w[hoe].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    # The jruby platform is probably only used for testing. 
+    # So if on jruby, do not even complain.
+    if not RUBY_PLATFORM =~ /java/
+      puts "Without #{req_gem} rake tasks to build the gem / integrate the RubyForge will not be available."
+    end
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))
+
+require 'rubyrep'

data/config/test_config.rb

@@ -0,0 +1,20 @@
+# Simple rubyrep configuration file for use by rspec tests.
+# Can be tweaked to either use mysql or postgresql.
+#
+# IMPORTANT:
+# Due to configuration of committer :default will NOT work for manual running
+# of rubyrep commands!
+
+database = ENV['RR_TEST_DB'] ? ENV['RR_TEST_DB'] : :postgres
+# $start_proxy_as_external_process = true
+
+load File.dirname(__FILE__) + "/#{database}_config.rb"
+
+RR::Initializer::run do |config|
+  config.options = {
+    :committer => :default,
+    :sync_conflict_handling => :left_wins
+  }
+  config.include_tables 'scanner_left_records_only'
+  config.include_tables 'table_with_manual_key', :key => 'id'
+end

data/lib/rubyrep/base_runner.rb

@@ -0,0 +1,195 @@
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
+
+require 'optparse'
+
+module RR
+  # This class implements the base functionality for runners that process table
+  # specs.
+  class BaseRunner
+
+    # Default options if not overriden in command line
+    DEFAULT_OPTIONS = {
+      :table_specs => []
+    }
+
+    # Provided options. Possible values:
+    # * +:config_file+: path to config file
+    # * +:table_specs+: array of table specification strings
+    attr_accessor :options
+
+    # The class for the selected report printer
+    attr_accessor :report_printer_class
+
+    # The specified option parameter for the report printer
+    attr_accessor :report_printer_arg
+
+    # Returns the active ScanReportPrinters instance (as selected through the
+    # command line options OR if none was selected, the default one).
+    def report_printer
+      unless @report_printer
+        printer_class = report_printer_class || ScanReportPrinters::ScanSummaryReporter
+        @report_printer ||= printer_class.new(session, report_printer_arg)
+      end
+      @report_printer
+    end
+
+    # Returns the command line selected ScanProgressPrinters class
+    attr_accessor :selected_progress_printer
+
+    # Returns the active ScanProgressPrinter class (as selected through the
+    # command line options OR if none was selected, the default one).
+    def progress_printer
+      if selected_progress_printer
+        selected_progress_printer
+      else
+        printer_key = session.configuration.options[:scan_progress_printer]
+        ScanProgressPrinters.printers[printer_key][:printer_class]
+      end
+    end
+
+    # Returns the default command summary description (nothing).
+    # Should be overwritten by child classes.
+    def summary_description; ""; end
+
+    # Parses the given command line parameter array.
+    # Returns the status (as per UNIX conventions: 1 if parameters were invalid,
+    # 0 otherwise)
+    def process_options(args)
+      status = 0
+      self.options = DEFAULT_OPTIONS.clone
+
+      parser = OptionParser.new do |opts|
+        opts.banner = <<EOS
+Usage: #{$0} #{self.class.name.sub(/^.*::(.*)Runner$/, '\\1').downcase} [options] [table_spec] [table_spec] ...
+
+  #{summary_description}
+
+  table_spec can be either:
+    * a specific table name (e. g. 'users') or
+    * a pair of (specific) table names (e. g.: 'users,users_backup')
+        (In this case the first table in the 'left' database is compared
+         with the second table in the 'right' database.)
+    * a regular expression (e. g. '/^user/') [case insensitive match]
+  If no table_specs are provided via command line, the ones from the
+  configuration file are used.
+EOS
+        opts.separator ""
+        opts.separator "  Specific options:"
+
+        ScanReportPrinters.on_printer_selection(opts) do |printer_class, arg|
+          self.report_printer_class = printer_class
+          self.report_printer_arg = arg
+        end
+
+        ScanProgressPrinters.on_printer_selection(opts) do |printer|
+          self.selected_progress_printer = printer
+        end
+
+        opts.on("-c", "--config", "=CONFIG_FILE",
+          "Mandatory. Path to configuration file.") do |arg|
+          options[:config_file] = arg
+        end
+        
+        add_specific_options(opts)
+
+        opts.on_tail("--help", "Show this message") do
+          $stderr.puts opts
+          self.options = nil
+        end
+      end
+
+      begin
+        unprocessed_args = parser.parse!(args)
+        if options # this will be +nil+ if the --help option is specified
+          options[:table_specs] = unprocessed_args
+          raise("Please specify configuration file") unless options.include?(:config_file)
+        end
+      rescue Exception => e
+        $stderr.puts "Command line parsing failed: #{e}"
+        $stderr.puts parser.help
+        self.options = nil
+        status = 1
+      end
+
+      return status
+    end
+
+    # Signals scan completion to the (active) scan report printer if it supports
+    # that method.
+    def signal_scanning_completion
+      if report_printer.respond_to? :scanning_finished
+        report_printer.scanning_finished
+      end
+    end
+
+    # Creates a processor that does something with the given table.
+    # A processor needs to implement a +run+ method that yields for progress
+    # reporting purposes pairs of diff_type and row as defined under
+    # DirectTableScan#run.
+    def create_processor(left_table, right_table)
+      # not implemented in the base class
+    end
+
+    # Intended to be overwritten by derived classes that need to add additional
+    # options to the provided +OptionParser+ object.
+    def add_specific_options(opts)
+    end
+
+    # Intended to be overwritten by derived classes that need to modify the
+    # table_pairs.
+    # * table_pairs: array of table pairs as returned by TableSpecResolver#resolve
+    # Returns the new table pairs array.
+    def prepare_table_pairs(table_pairs)
+      table_pairs
+    end
+    
+    # Returns the active +Session+. 
+    # Loads config file and creates session if necessary.
+    def session
+      unless @session
+        load options[:config_file]
+        @session = Session.new Initializer.configuration
+      end
+      @session
+    end
+
+    attr_writer :session
+
+    # Returns the table pairs that should be processed.
+    # Refer to TableSpecRsolver#resolve for format of return value.
+    def table_pairs
+      prepare_table_pairs(session.configured_table_pairs(options[:table_specs]))
+    end
+
+    # Executes a run based on the established options.
+    def execute
+      session.configuration.exclude_rubyrep_tables
+      table_pairs.each do |table_pair|
+        report_printer.scan table_pair[:left], table_pair[:right] do
+          processor = create_processor \
+            table_pair[:left], table_pair[:right]
+          processor.progress_printer = progress_printer
+          processor.run do |diff_type, row|
+            report_printer.report_difference diff_type, row
+          end
+        end
+      end
+      signal_scanning_completion
+    end
+
+    # Entry points for executing a processing run.
+    # args: the array of command line options that were provided by the user.
+    def self.run(args)
+      runner = new
+
+      status = runner.process_options(args)
+      if runner.options
+        runner.execute
+      end
+      status
+    end
+
+  end
+end
+
+