multi_ar 4.1.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 34e048d2d4906e2af853ade40a158107495f140e
-  data.tar.gz: 44a38ed6cd16746d8e70565d61e22524fe2fcc9c
+SHA256:
+  metadata.gz: e703260ff0896138cefe607320db98e5c020bbe0233117a518e833ae5afb0408
+  data.tar.gz: 2a2d097579ffb99fd8735b4fe5c53aef110d5edabc47761375b0edcbc4f59174
 SHA512:
-  metadata.gz: b8c98f946f3546b27e0eed21f396760df13e90f53a74fd8ac66e222a245b4762240c58126049a947e23febe7d1e650ea5fa9f97ee7dcc8687eaff62486c297ce
-  data.tar.gz: b4e6afd293a028585492fefa6637b8771042533e22c8d8f232637edc86934b1b3e532fd5d3594ebe50a591955a71019c2a0db12bed9428cce1016e6f5d2cbfe4
+  metadata.gz: 1c8c633fbdc59cd7d7bf4e01429956a602776f26bb726d2b26ef55985786c98e8cebfd960040dd540e5255d4405a227b805a5ed20859c10723d29cbaf81095d0
+  data.tar.gz: 665b59f332f12c9c6ee82629fb07a7e06fb3e56dc3425433c1e6801672ad1db8b178465450c446168a4e6f8ad639f4717ccf620efa2c6a7383f5338c5cc8cd87

data/lib/multi_ar/database.rb

@@ -31,8 +31,8 @@ module MultiAR
 
     # @return real connection name, nil in case connection is not available
     def self.connection_name base_name
-      raise "#{base_name} is not in databases configuration variable." unless MultiAR.app.databases.include? base_name
-      return nil unless MultiAR.app.databases.include? base_name
+      raise "#{base_name} is not in databases configuration variable." unless MultiAR::databases.include? base_name
+      return nil unless MultiAR::databases.include? base_name
       "#{base_name}_#{MultiAR.app.environment}"
     end
 

data/lib/multi_ar/interface.rb

@@ -20,8 +20,7 @@ module MultiAR
     # - dry           # boolean
     # - environment   # `true` or `String`
     # - verbose       # boolean
-    # - databases     # `false` or `Array`, by default asks for databases
-    # - migration_dir # String
+    # - databases     # false, `Array` or `Hash`.
     #
     # If value is `true`, an option will be added to CLI interface. If the value is something else, the option will be populated by this value instead.
     #
@@ -79,7 +78,7 @@ module MultiAR
         # TODO: not implemented currently, do we really need this?
         #p.opt "list_databases",     "Lists databases that contains migrations in the gem",                      type: :flag
         # TODO: should we do migration_dirs here too instead?
-        p.opt "migration_dir",      "The directory where migrations for databases are read from",               type: :string,  default: "db/migrate"
+        #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
@@ -136,14 +135,31 @@ module MultiAR
     def init_multi_ar
       opts = {}
       opts[:db_config] = @opts["db_config"] unless @opts["db_config"].nil?
-      opts[:migration_dirs] = [ @opts["migration_dir"] ]
+      #opts[:migration_dirs] = [ @opts["migration_dir"] ]
       opts[:config] = @opts["config"] unless @opts["config"].nil?
-      opts[:databases] = @opts["databases"]
+      opts[:databases] = parse_databases_input(@opts["databases"])
       opts[:environment] = @opts["environment"]
       opts[:verbose] = @opts["verbose"]
+      opts[:migration_framework] = @migration_framework
       @multi_ar = MultiAR.new opts
     end
 
+    def parse_databases_input databases
+      raise "You did not give proper databases. Please see --help for instructions." unless databases.respond_to? :each
+
+      out = {}
+      databases.each do |database|
+        if database.include? ":"
+          splitted = database.split(":")
+          out[splitted[0]] = splitted[1]
+        else
+          out[database] = "db/migrate/#{database}"
+        end
+      end
+
+      out
+    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
       raise "--databases must be given when bootstrapping." unless opts["databases"]
@@ -171,7 +187,12 @@ module MultiAR
 
     def bootstrap_db_config opts
       str = ""
-      opts["databases"].each do |db|
+      databases = parse_databases_input(opts["databases"])
+      databases.each do |db, migration_path|
+        # This is a bit misleading place to create the migration dir, but it needs to be done somewhere.
+        FileUtils.mkdir_p(migration_path)
+
+        # Create the config file
         [ "development", "production", "test"].each do |env|
           full_name = "#{db}_#{env}"
           str << <<-EOS.gsub(/^ {10}/, "")
@@ -241,11 +262,14 @@ module MultiAR
     def bootstrap_config opts
       settings_file = "config/settings.yaml"
       return if File.exist? settings_file
-      str = <<-EOF
-databases:
+      str = <<~EOF
+      databases:
       EOF
-      opts["databases"].each do |database|
-        str << "    - #{database}"
+      databases = parse_databases_input(opts["databases"])
+      databases.each do |database, path|
+        str << "-\n"
+        str << "    database: #{database}\n"
+        str << "    migration_path: #{path}\n"
       end
 
       File.open settings_file, "w" do |f|

data/lib/multi_ar/rake/migration_generator.rb

@@ -10,9 +10,7 @@ module ActiveRecordMigrations
       source_root ::ActiveRecord::Generators::MigrationGenerator.source_root
 
       def db_migrate_path
-        dir = ::ActiveRecord::Tasks::DatabaseTasks.migrations_paths.first
-        db_dir = ::ActiveRecord::Tasks::DatabaseTasks.sub_db_dir
-        "#{dir}/#{db_dir}"
+        databases = MultiAR::MultiAR::databases.first[1]
       end
     end
   end

data/lib/multi_ar/rake/tasks.rb

@@ -78,7 +78,9 @@ module Rake
           name = args[:name] || ENV["name"]
           options = args[:options] || ENV["options"]
 
-          raise "You need to specify exactly one database for migration generation. See --databases. Given databases: #{databases.inspect}" if databases.size != 1
+          if MultiAR::MultiAR::databases.size != 1
+            raise "You need to specify exactly one database for migration generation. See --databases. Given databases: #{MultiAR::MultiAR::databases.inspect}"
+          end
 
           unless name
             generator = Rails::Generators.find_by_namespace "migration"
@@ -100,7 +102,7 @@ module Rake
       multiple_databases_task "migrate", "db" do |database_name|
         establish_connection database_name
 
-        context = ActiveRecord::MigrationContext.new MultiAR::MultiAR.migration_dirs
+        context = ActiveRecord::MigrationContext.new(MultiAR::MultiAR.databases[database_name])
         context.migrate
 
         #MultiAR::MultiAR.migration_dirs.each do |dir|
@@ -118,11 +120,59 @@ module Rake
       multiple_databases_task "rollback", "db" do |database_name|
         establish_connection database_name
         step = ENV['STEP'] ? ENV['STEP'].to_i : 1
-        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
+
+        context = ActiveRecord::MigrationContext.new(MultiAR::MultiAR.databases[database_name])
+        context.rollback step
+      end
+
+      multiple_databases_task "forward", "db" do |database_name|
+        establish_connection database_name
+        step = ENV['STEP'] ? ENV['STEP'].to_i : 1
+
+        context = ActiveRecord::MigrationContext.new(MultiAR::MultiAR.databases[database_name])
+        context.forward step
+      end
+
+      multiple_databases_task "down", "db:migrate" do |database_name|
+        establish_connection database_name
+        raise "db:down is used to go back to certain version. Use db:rollback if you want to go back n migrations." unless ENV["VERSION"]
+        version = ENV["VERSION"]
+
+        context = ActiveRecord::MigrationContext.new(MultiAR::MultiAR.databases[database_name])
+        context.down version
+      end
+
+      multiple_databases_task "up", "db:migrate" do |database_name|
+        establish_connection database_name
+        raise "db:up is used to go to certain version. Use db:forward if you want to go up n migrations." unless ENV["VERSION"]
+        version = ENV["VERSION"]
+
+        context = ActiveRecord::MigrationContext.new(MultiAR::MultiAR.databases[database_name])
+        context.up version
+      end
+
+      multiple_databases_task "status", "db:migrate" do |database_name|
+        establish_connection database_name
+
+        unless ActiveRecord::SchemaMigration.table_exists?
+          abort "Schema migrations table does not exist yet."
         end
+
+        #raise "db:up is used to go to certain version. Use db:forward if you want to go up n migrations." unless ENV["VERSION"]
+        #version = ENV["VERSION"]
+
+        #context = ActiveRecord::MigrationContext.new(MultiAR::MultiAR.databases[database_name])
+        #context.up version
+
+        # output
+        puts "\ndatabase: #{ActiveRecord::Base.connection_config[:database]}\n\n"
+        puts "#{'Status'.center(8)}  #{'Migration ID'.ljust(14)}  Migration Name"
+        puts "-" * 50
+        ActiveRecord::Base.connection.migration_context.migrations_status.each do |status, version, name|
+          puts "#{status.center(8)}  #{version.ljust(14)}  #{name}"
+        end
+        puts
+
       end
 
       multiple_databases_task "drop", "db" do |database_name|
@@ -146,14 +196,16 @@ module Rake
       name = (namespace && name) || "#{namespace}:#{name_without_namespace}"
       old_comment = rename_task name, namespace
 
+      databases = MultiAR::MultiAR::databases
+
       DSL.desc "Runs task #{name} for all selected databases"
       DSL.task name.to_sym do
-        databases.each do |database_name|
+        databases.each do |database_name, migration_path|
           ::Rake::Task["#{name}:#{database_name}"].invoke
         end
       end
 
-      databases.each do |database_name|
+      databases.each do |database_name, migration_path|
         DSL.desc old_comment
         DSL.task :"#{name}:#{database_name}" do
           yield database_name

data/lib/multi_ar/version.rb

@@ -1,4 +1,4 @@
 
 module MultiAR
-  VERSION = "4.1.0"
+    VERSION = "5.0.0"
 end

data/lib/multi_ar.rb

@@ -12,13 +12,12 @@ module MultiAR
   # 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
 
     # @api private
     # This will always be overridden, when MultiAR is initialized. Don’t try to do any funny logic with this.
-    #@@migration_dirs = []
+    @@__databases = {}
 
     class << self
       # Instance of MultiAR::MultiAR, automatically assigned by MultiAR::MultiAR#new.
@@ -28,7 +27,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/settings.yaml", db_config: "config/database.yaml", migration_dirs: [], verbose: false
+    def initialize databases:, environment: "development", config: "config/settings.yaml", db_config: "config/database.yaml", verbose: false, migration_framework: true
 
       # first load config
       if not config.nil? and File.exist? config
@@ -36,6 +35,13 @@ module MultiAR
         config = Psych.load_file config
         b = binding
         config.each do |key, value|
+          if key == "databases"
+            out = {}
+            value.each do |database|
+              out[database["database"]] = database["migration_path"]
+            end
+            value = out
+          end
           b.local_variable_set key.to_sym, value
         end
       end
@@ -44,23 +50,26 @@ module MultiAR
       raise "#{db_config} is not valid path to a file. Try specifying --db-config <path> or configuring it in the configuration file." if db_config.nil? or !File.exist?(db_config)
       raise "databases is not responding to :each. Try passing passing --databases <database> or configuring it in the configuration file." unless databases.respond_to? :each
 
-      @databases = databases
+      parse_databases_input databases
+
+      #@databases = databases
       @db_config = db_config
       @environment = environment
+      @migration_framework = migration_framework
       #@@migration_dirs = migration_dirs unless migration_dirs.empty? # This takes care of that it will only be overridden if there is any given values, making default configs work
-      ActiveRecord::Tasks::DatabaseTasks.migrations_paths = migration_dirs
+      #ActiveRecord::Tasks::DatabaseTasks.migrations_paths = migration_dirs
 
       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
+      #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.init
       ::Rake::TaskManager.record_task_metadata = true
 
-      Rake::Tasks.databases = databases
+      #Rake::Tasks.databases = databases
       Rake::Tasks.environment = environment
       Rake::Tasks.define
 
@@ -69,19 +78,39 @@ module MultiAR
       MultiAR.app = self
     end
 
+    # A helper method to add migrations for multiple databases that reside in same location.
+    #
+    # Expects the given directory contain subdirectories that contain the actual migrations.
+    # For example, `db/migrate/_db_name_`, where `db/migrate` is dir given as an argument to this
+    # method and `_db_name_` is name of the database.
+    def self.add_migration_dir dir
+      raise "Directory #{dir} does not exist." unless Dir.exist? dir
+
+      Dir.chdir dir do
+        dbs = Dir.glob "*/"
+        dbs.each do |database|
+          add_database database, "#{dir}/#{database.chop}"
+        end
+      end
+    end
+
     # Array of paths to directories where migrations resides.
-    # @see add_migration_dir
+    # @see add_database
     def self.migration_dirs
       ActiveRecord::Tasks::DatabaseTasks.migrations_paths
     end
 
+    def self.migration_dir_for database_name
+      ActiveRecord::Tasks::DatabaseTasks.migrations_paths
+    end
+
     # Outputs contents if verbose flag has been passed.
     def self.verb str
       return unless @@verbose
       puts str
     end
 
-    # Add a path to a directory where migrations resides. For standard Rails setup, this would be “db/migrate”.
+    # Add a database and its migration path. For standard Rails setup, this would be "customdbname", “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.
@@ -90,9 +119,12 @@ module MultiAR
     # 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
-      ActiveRecord::Tasks::DatabaseTasks.migrations_paths << path
+    def self.add_database database_name, migration_path
+      if @migration_framework
+        raise "Migration dir #{migration_path} does not exist." unless Dir.exist? migration_path
+        ActiveRecord::Tasks::DatabaseTasks.migrations_paths << migration_path
+      end
+      @@__databases[database_name] = migration_path
     end
 
     # @todo this shows rake in start of the command, we want to show multi_ar instead.
@@ -107,9 +139,26 @@ module MultiAR
     def rake_task task_name
       @rake.invoke_task task_name
     end
-  end
-end
 
-# For convenience, it may make shorter namespace.
-Mar = MultiAR # TODO: there is Mar gem, maybe we should avoid this to avoid conflicts?
-MultiAr = MultiAR
+    def self.databases
+      @@__databases
+    end
+
+    private
+
+    def parse_databases_input dbs
+      if dbs.kind_of? Array
+        dbs.each do |database|
+          ::MultiAR::MultiAR::add_database database, "db/migrate/#{database}"
+        end
+        return
+      end
+
+      raise "input databases needs to be either Hash or Array" unless dbs.kind_of? Hash
+
+      dbs.each do |database, migration_path|
+        ::MultiAR::MultiAR::add_database database, migration_path
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: multi_ar
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 5.0.0
 platform: ruby
 authors:
 - Samu Voutilainen
@@ -29,7 +29,7 @@ cert_chain:
   w7Q+3AEK9ifd9ywHO2Ott0JdJEadxhU4N0cI6bQg+uJiSYmdBK0vEJN4lhNg1w37
   C6hgCMQL3/D3kq732F4KGypqykYwx1wRDGHLxDTBHY26sy/TXfHcj4zPuKA=
   -----END CERTIFICATE-----
-date: 2018-06-04 00:00:00.000000000 Z
+date: 2018-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: trollop
@@ -195,7 +195,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Multi database feature set for ActiveRecord