multi_ar 1.0.0.pre.rc1 → 1.0.0.pre.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8bb5b123951c55685e13a738e7cfbf9f12a60c01
-  data.tar.gz: 9e91ce2afc46d52e33ea4f2c7e735307d978f609
+  metadata.gz: d54d942aefe519b7959ea7d8207c03b304c437f2
+  data.tar.gz: abf83b48064b3e378000ff19b05642c7986919ee
 SHA512:
-  metadata.gz: 6c685d03c1cbe001b957c946b97513f940957c8399a293d82fc1a9fcdcff8bbb2084c1ee59cf872fe324764bfba4af1871541692022224805c105892e6bed37d
-  data.tar.gz: 3e70852de5be0497a6de35a8cfddb9708b1e633a63409f3af42d537e2e2e34b4588ff4a8a1c88873b33af6ecfe8af7b34f08592db61a83bdf655d21456a3752a
+  metadata.gz: 7d4b9241137a3c3bc78f0b9c0c8b04fa13701ef08250596c5fb1b54a95063049fa950c17298ecc64f92afc81bdef7fcbe9a69108b1dac8b0f7986404b500b756
+  data.tar.gz: ea38c3fb2c44b79041ff14e94988e1c7494a57091a7f5bf3fbedf74ebd9ae62dffbe975b8e5ccee222d11a301ce05df973fbfbdfe679d937dc6cd7423e0617c5

data/bin/multi_ar

@@ -1,65 +1,13 @@
 #!/usr/bin/env ruby
 
-require "trollop"
+require_relative "../lib/multi_ar/interface"
 
-require_relative "../lib/multi_ar"
 require_relative "../lib/multi_ar/version"
-require_relative "../lib/multi_ar/helper/rake_ext"
 
-# configuration
-
-p = Trollop::Parser.new do
-  version  "multi_ar-#{MultiAR::VERSION}"
-  banner <<-EOS
-  Helper utility to executing Rake tasks for ActiveRecord migrations.
-  EOS
-  opt "all_rake_tasks",     "List all Rake tasks, not only commented ones",                 short: "A", type: :flag
-  opt "common_migrations",  "Run the migrations bundled with the gem, for common databases.",           type: :flag,    default: true
-  opt "config",             "Location to configuration file of MultiAR.",                               type: :string,  default: "config/multi_ar.yaml"
-  opt "databases",          "List of databases to perform operations",                                  type: :strings
-  opt "db_config",          "Path to database config file",                                             type: :string,  default: "config/database.yaml"
-  opt "environment",        "The environment to use. Corresponds to database config name " +
-      "(environment for foo_development is “development”).",                                            type: :string,  default: "development"
-  # TODO: not implemented currently, do we really need this?
-  #opt "list_databases",     "Lists databases that contains migrations in the gem",                      type: :flag
-  opt "migration_dir",      "The directory where migrations for databases are read from",               type: :string,  default: "db/migrate"
-  opt "task",               "Rake task to execute",                                                     type: :string
-  opt "tasks",              "List available Rake tasks",                                    short: "T", type: :flag
-  opt "verbose",            "Be more verbose",                                                          type: :flag
-end
-
-opts = Trollop::with_standard_exception_handling p do
-
-  args = ARGV.clone
-
-  # and then reparse with arguments from the config file (here so that Trollop can erase ARGV)
-  result = p.parse ARGV
-
-  # show help screen
-  raise Trollop::HelpNeeded if args.empty? # need to be different what we parse, as parser will remove used arguments
-
-  result
-end
-
-# running the task
-
-multi_ar = MultiAR::MultiAR.new common_migrations: opts["common_migrations"],
-    config: opts["config"],
-    databases: opts["databases"],
-    db_config: opts["db_config"],
-    environment: opts["environment"],
-    migration_dir: opts["migration_dir"]
-
-if opts["tasks"] || opts["all_rake_tasks"]
-  multi_ar.list_tasks all_rake_tasks: opts["all_rake_tasks"]
-  exit 1
-end
-
-if opts["task"].nil?
-  puts "Task must be specified. Check if you passed --task option."
-  exit 1
-end
-puts "Running task #{opts["task"]}" if opts["verbose"]
-multi_ar.rake_task opts["task"]
-
-#rake.top_level
+interface = MultiAR::Interface.new
+interface.version = "multi_ar-#{MultiAR::VERSION}"
+interface.description = "Multi database migration tools utilizing ActiveRecord"
+interface.migration_framework = true
+opts = interface.cli do |parser|
+  # Nya.
+end

data/lib/multi_ar/interface.rb

@@ -38,6 +38,9 @@ module MultiAR
     # Array of databases that will be used insted if none have not been passed through CLI.
     attr_accessor :databases
 
+    # If set to true, migration framework and other Rake related functionality will be enabled.
+    attr_accessor :migration_framework
+
     # Boolean of whether no arguments are needed
     attr_accessor :run_by_default
 
@@ -64,13 +67,25 @@ module MultiAR
       p.version @version if @version
       p.banner @description if @description
       p.opt "init",         "Create stub environment with configuration and database.yaml",           type: :string
-      p.opt "databases",    "Databases that will be enabled",                                         type: :strings if @options["databases"]
+      p.opt "databases",    "List of databases to perform operations",                                type: :strings if @options["databases"]
       p.opt "db_config",    "Path to database config file",                                           type: :string, default: "config/database.yaml" if @options["db_config"]
-      p.opt "config",       "Path to config file",                                                    type: :string, default: "config/settings.yaml" if @options["config"]
+      p.opt "config",       "Path to MultiAR framework config file",                                  type: :string, default: "config/settings.yaml" if @options["config"]
       p.opt "dry",          "Run the program without doing anything. Useful for debugging with -v",   type: :flag if @options["dry"]
-      p.opt "environment",  "Environment to run the alarms for",                                      type: :string, default: "development"
+      p.opt "environment",  "The environment to use. Corresponds to database config name " +
+            "(environment for foo_development is “development”).",                                    type: :string, default: "development"
       p.opt "verbose",      "Be verbose",                                                             type: :flag if @options["verbose"]
 
+      if @migration_framework == true
+        p.opt "all_rake_tasks",     "List all Rake tasks, not only commented ones",                 short: "A", type: :flag
+        # TODO: what for this is...?
+        #p.opt "common_migrations",  "Run the migrations bundled with the gem, for common databases.",           type: :flag,    default: true
+        # TODO: not implemented currently, do we really need this?
+        #p.opt "list_databases",     "Lists databases that contains migrations in the gem",                      type: :flag
+        p.opt "migration_dir",      "The directory where migrations for databases are read from",               type: :string,  default: "db/migrate"
+        p.opt "task",               "Rake task to execute",                                         short: "t", type: :string
+        p.opt "tasks",              "List available Rake tasks",                                    short: "T", type: :flag
+      end
+
       yield p if block_given?
 
       opts = Trollop::with_standard_exception_handling p do
@@ -85,16 +100,44 @@ module MultiAR
         result
       end
 
-      bootstrap opts if opts["init"]
+      bootstrap opts if opts["init"] # Bootstrap will exit after execution; in that case nothing after this will be run.
 
       raise "--config must be path to valid file" if @options["config"] and not File.exist? opts["config"]
       raise "config/database.yaml seems to be missing" if @options["db_config"] and not File.exist? opts["db_config"]
 
       @opts = opts
+
+      init_multi_ar
+
+      # Then run Rake tasks as requested
+
+      return if not @migration_framework # TODO: I think there should be much more fine grained control for this
+
+      if opts["tasks"] || opts["all_rake_tasks"]
+        @multi_ar.list_tasks all_rake_tasks: opts["all_rake_tasks"]
+        exit 1
+      end
+
+      if opts["task"].nil?
+        puts "Task must be specified. Check if you passed --task option."
+        exit 1
+      end
+
+      puts "Running task #{opts["task"]}" if opts["verbose"]
+      @multi_ar.rake_task opts["task"]
     end
 
     private
 
+    def init_multi_ar
+      @multi_ar = MultiAR::MultiAR.new common_migrations: @opts["common_migrations"],
+          config: @opts["config"],
+          databases: @opts["databases"],
+          db_config: @opts["db_config"],
+          environment: @opts["environment"],
+          migration_dir: @opts["migration_dir"]
+    end
+
     # @note This method will always quit the application or raise another exception for errors. Catch SystemExit if that’s not good for you.
     def bootstrap opts
       opts["databases"] ||= @databases

data/lib/multi_ar/{multi_ar_model.rb → model.rb}

@@ -1,6 +1,6 @@
 require "active_record"
 
-require_relative "multi_ar"
+require_relative "../multi_ar"
 
 module MultiAR
 

data/lib/multi_ar/rake/tasks.rb

@@ -9,9 +9,9 @@ require "active_record/tasks/database_tasks"
 
 require_relative "migration_generator"
 
-module MultiAR::Rake
+module Rake
 
-  # Utility that defines Rake tasks of Slam
+  # Utility that defines Rake tasks of MultiAR
   class Tasks
     #include Rake::DSL
 
@@ -24,17 +24,17 @@ module MultiAR::Rake
         unless name.kind_of?(String) || name.nil?
           raise ArgumentError, "Expected a String or Symbol for a namespace name"
         end
-        Rake.application.in_namespace(name, &block)
+        ::Rake.application.in_namespace(name, &block)
       end
 
       # Defines a Rake task’s description (see Rake’s desc() in dsl_definition.rb)
       def self.desc(description)
-        Rake.application.last_description = description
+        ::Rake.application.last_description = description
       end
 
       # Defines a Rake task (see Rake’s task() in dsl_definition.rb)
       def self.task(*args, &block)
-        Rake::Task.define_task(*args, &block)
+        ::Rake::Task.define_task(*args, &block)
       end
     end
 
@@ -42,10 +42,9 @@ module MultiAR::Rake
       attr_accessor :databases
       attr_accessor :environment
       attr_accessor :common_migrations
-      attr_accessor :migration_dir
     end
 
-    # When called, this declares Rake tasks of Slam project,
+    # When called, this declares Rake tasks of MultiAR,
     # most notably custom active record migration tasks.
     def self.define
       load "active_record/railties/databases.rake"
@@ -84,14 +83,11 @@ module MultiAR::Rake
       multiple_databases_task "migrate", "db" do |database_name|
         establish_connection database_name
 
-        if common_migrations
-          # TODO: Slam.root
-          path = "#{__dir__}/../../../db/migrate/#{database_name}"
+        MultiAR::MultiAR.migration_dirs.each do |dir|
+          path = "#{dir}/#{database_name}/"
+          # The database should be present only on one migration dir, so this will fail if there is more than one migration dir
           ActiveRecord::Migrator.migrate path if Dir.exist? path
         end
-
-        path = "#{migration_dir}/#{database_name}/"
-        ActiveRecord::Migrator.migrate path if Dir.exist? path
       end
 
       multiple_databases_task "create", "db" do |database_name|
@@ -102,8 +98,11 @@ module MultiAR::Rake
       multiple_databases_task "rollback", "db" do |database_name|
         establish_connection database_name
         step = ENV['STEP'] ? ENV['STEP'].to_i : 1
-        path = "#{migration_dir}/#{database_name}/"
-        ActiveRecord::Migrator.rollback(path, step) if Dir.exist? path
+        MultiAR::MultiAR.migration_dirs.each do |dir|
+          path = "#{dir}/#{database_name}/"
+          # The database should be present only on one migration dir, so this will fail if there is more than one migration dir
+          ActiveRecord::Migrator.rollback(path, step) if Dir.exist? path
+        end
       end
 
       multiple_databases_task "drop", "db" do |database_name|
@@ -117,9 +116,9 @@ module MultiAR::Rake
     def self.rename_task name, namespace = nil
       new_name = "old_#{name}"
       #new_name = "#{namespace}:#{new_name}" unless namespace.nil?
-      Rake::Task[name].rename(new_name)
-      old_comment = Rake::Task[new_name].comment
-      Rake::Task[new_name].clear_comments
+      ::Rake::Task[name].rename(new_name)
+      old_comment = ::Rake::Task[new_name].comment
+      ::Rake::Task[new_name].clear_comments
       old_comment
     end
 
@@ -130,7 +129,7 @@ module MultiAR::Rake
       DSL.desc "Runs task #{name} for all selected databases"
       DSL.task name.to_sym do
         databases.each do |database_name|
-          Rake::Task["#{name}:#{database_name}"].invoke
+          ::Rake::Task["#{name}:#{database_name}"].invoke
         end
       end
 

data/lib/multi_ar/version.rb

@@ -1,4 +1,4 @@
 
 module MultiAR
-  VERSION = "1.0.0-rc1"
+  VERSION = "1.0.0-rc2"
 end

data/lib/multi_ar.rb

@@ -7,15 +7,17 @@ require_relative "multi_ar/database"
 
 module MultiAR
 
-  # Base of Slam gem.
+  # Base of MultiAR gem.
   #
-  # Must be initialized before most actions works, that relies on Slam#app for getting configuration.
+  # Must be initialized before most actions works, that relies on MultiAR#app for getting configuration.
   class MultiAR
 
     attr_reader :databases
     attr_reader :db_config
     attr_reader :environment
 
+    @@migration_dirs = []
+
     class << self
       # Instance of MultiAR::MultiAR, automatically assigned by MultiAR::MultiAR#new.
       # Used internally in the gem, to access configuration and other internal parts.
@@ -24,7 +26,7 @@ module MultiAR
 
     # @param databases array of available databases
     # @todo config file is overriding parameters passed here... I think it should be other way around, but need more custom logic for that :/
-    def initialize databases:, environment: "development", config: "config/multi_ar.yaml", db_config: "config/database.yaml", common_migrations: true, migration_dir: "db/migrate"
+    def initialize databases:, environment: "development", config: "config/multi_ar.yaml", db_config: "config/database.yaml", common_migrations: true
 
       # first load config
       if File.exist? config
@@ -44,25 +46,44 @@ module MultiAR
       @db_config = db_config
       @environment = environment
 
-      Database.initialize db_config: db_config, migration_dir: migration_dir
+      Database.initialize db_config: db_config
 
       ActiveRecord::Tasks::DatabaseTasks.class_eval { attr_accessor :sub_db_dir }
       ActiveRecord::Tasks::DatabaseTasks.sub_db_dir = databases.first # TODO: I don’t think this is how it should work
 
-      @rake = Rake::Application.new
-      Rake.application = @rake
+      @rake = ::Rake::Application.new
+      ::Rake.application = @rake
       @rake.init
-      Rake::TaskManager.record_task_metadata = true
+      ::Rake::TaskManager.record_task_metadata = true
 
-      RakeTasks.databases = databases
-      RakeTasks.environment = environment
-      RakeTasks.common_migrations = common_migrations
-      RakeTasks.migration_dir = migration_dir
-      RakeTasks.define
+      Rake::Tasks.databases = databases
+      Rake::Tasks.environment = environment
+      Rake::Tasks.common_migrations = common_migrations
+      Rake::Tasks.define
 
       MultiAR.app = self
     end
 
+    # Array of paths to directories where migrations resides.
+    # @see add_migration_dir
+    def self.migration_dirs
+      return @@migration_dirs
+    end
+
+    # Add a path to a directory where migrations resides. For standard Rails setup, this would be “db/migrate”.
+    #
+    # The directory structure of how MultiAR uses the path is a bit different from traditional way: for each
+    # database, there is directory inside the migration dir.
+    #
+    # For example, if project uses database named “messy_database” and migration dir is “my/migration/dir”,
+    # migrations would be looked from path “my/migration/dir/messy_database”.
+    #
+    # @note often you want to add full path to this dir, `__dir__` is useful for this.
+    def self.add_migration_dir path
+      raise "Migration dir #{path} does not exist." unless Dir.exist? path
+      @@migration_dirs << path
+    end
+
     # @todo this shows rake in start of the command, we want to show multi_ar instead.
     def list_tasks all_rake_tasks: false
       @rake.options.show_all_tasks = true if all_rake_tasks
@@ -71,6 +92,7 @@ module MultiAR
       @rake.display_tasks_and_comments
     end
 
+    # Invokes Rake task from `task_name`
     def rake_task task_name
       @rake.invoke_task task_name
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: multi_ar
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.rc1
+  version: 1.0.0.pre.rc2
 platform: ruby
 authors:
 - Samu Voutilainen
@@ -29,7 +29,7 @@ cert_chain:
   Ws73WZ+F+DOnfopIMUaeYUzKyUG+59p17ls//xzTouiLjcC9ee5ZaC9e+TzYsp4t
   ofnwRrqEHVW+zRWs/VIwm70F2Jnl5eSc3MjyhpWIC0eGFXtBY1XYCrHeCdQ=
   -----END CERTIFICATE-----
-date: 2015-10-01 00:00:00.000000000 Z
+date: 2015-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: trollop
@@ -141,16 +141,14 @@ description: |-
 email: smar@smar.fi
 executables:
 - multi_ar
-- mar
 extensions: []
 extra_rdoc_files: []
 files:
-- bin/mar
 - bin/multi_ar
 - lib/multi_ar.rb
 - lib/multi_ar/database.rb
 - lib/multi_ar/interface.rb
-- lib/multi_ar/multi_ar_model.rb
+- lib/multi_ar/model.rb
 - lib/multi_ar/rake/ext.rb
 - lib/multi_ar/rake/migration_generator.rb
 - lib/multi_ar/rake/tasks.rb
@@ -175,7 +173,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Multi database migrations and utilities for ActiveRecord

data/bin/mar

@@ -1,4 +0,0 @@
-#!/usr/bin/env ruby
-
-# A hack to get this file work as wrapper for the real exe
-require "#{__dir__}/multi_ar"