ridgepole 0.2.7 → 0.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b195dc41a13b87e24223916ac26701adc7cc4cb2
-  data.tar.gz: 4d3ffa051d81f4f5b3366afe3106b4f3b592bb3c
+  metadata.gz: 493879d39cd654fb10b76891dd5800b33c6b6f32
+  data.tar.gz: 8afa5e085f0866ad5edc4777162e0e18cb394943
 SHA512:
-  metadata.gz: a77bd763ef07424ae3db9870732029ed4a167d336f8517e02e7a7ef99c2a6ab0e306c80fc698837bd27c3d5602f3be5fd57a961e96518713bbc71de88b5d1383
-  data.tar.gz: ded7b3fd166e9b64d03e860d2b712ebade9d7bef5fa8eafebc873aafcca047c1ea03f5a5119032e758fa203b81998eda277ad3328c133471c1f248e843e6a82c
+  metadata.gz: 449d9189b3b6e5e4bb1c9f72136379f19ad623527295dd75ab431028d13ab5dc2400e2766dbe7179e0bbd7bde9321c118f35c10256ccca4e2f1cec6e2d25cd8c
+  data.tar.gz: 04883048e57550f4d0bbc93ed4caed8aa7583cff0124706914890becbc4a28db942aebfee6b38d9e12a72688c8599066a1bb33ac19571642e4d3de8f325c1c94

data/README.md

@@ -94,6 +94,8 @@ $ ridgepole -c config.yml --apply --dry-run
 Apply `Schemafile` (dry-run)
 add_column("articles", "author", :text, {:after=>"text"})
 
+# ALTER TABLE `articles` ADD `author` text AFTER `text`
+
 $ ridgepole -c config.yml --apply
 Apply `Schemafile`
 -- add_column("articles", "author", :text, {:after=>"text"})

data/bin/ridgepole

@@ -31,6 +31,14 @@ set_mode = proc do |m|
   mode = m
 end
 
+def noop_migrate(delta)
+  puts <<-EOS
+#{delta.script}
+
+#{delta.migrate(:noop => true).each_line.map {|i| "# #{i}"}.join}
+  EOS
+end
+
 ARGV.options do |opt|
   begin
     opt.on('-c', '--config CONF_OR_FILE')         {|v| config = v                                           }
@@ -84,6 +92,8 @@ begin
     client = Ridgepole::Client.new(config, options)
   end
 
+  ActiveRecord::Base.logger = logger
+
   case mode
   when :export
     if split
@@ -138,7 +148,9 @@ begin
     delta = client.diff(dsl, :path => file)
 
     if options[:dry_run]
-      puts delta.script if delta.differ?
+      if delta.differ?
+        noop_migrate(delta)
+      end
     else
       logger.verbose_info('# Update schema')
       delta.migrate
@@ -168,7 +180,7 @@ begin
         logger.info('No change')
       end
     elsif delta.differ?
-      puts delta.script
+      noop_migrate(delta)
       exit_code = 1
     end
   end

data/lib/ridgepole.rb

@@ -12,6 +12,7 @@ require 'ridgepole/delta'
 require 'ridgepole/diff'
 require 'ridgepole/dsl_parser'
 require 'ridgepole/dumper'
+require 'ridgepole/execute_expander'
 require 'ridgepole/logger'
 require 'ridgepole/migration_ext'
 require 'ridgepole/schema_dumper_ext'

data/lib/ridgepole/client.rb

@@ -2,7 +2,7 @@ class Ridgepole::Client
   def initialize(conn_spec, options = {})
     @options = options
     ActiveRecord::Base.establish_connection(conn_spec)
-
+    Ridgepole::ExecuteExpander.expand_execute(ActiveRecord::Base.connection)
     @dumper = Ridgepole::Dumper.new(@options)
     @parser = Ridgepole::DSLParser.new(@options)
     @diff = Ridgepole::Diff.new(@options)

data/lib/ridgepole/delta.rb

@@ -4,15 +4,15 @@ class Ridgepole::Delta
     @options = options
   end
 
-  def migrate
+  def migrate(options = {})
     if log_file = @options[:log_file]
       result = ActiveRecord::Migration.record_time do
-        migrate0
+        migrate0(options)
       end
 
       open(log_file, 'wb') {|f| f.puts JSON.pretty_generate(result) }
     else
-      migrate0
+      migrate0(options)
     end
   end
 
@@ -44,10 +44,32 @@ class Ridgepole::Delta
 
   private
 
-  def migrate0
-    ActiveRecord::Schema.new.instance_eval(script)
+  def migrate0(options = {})
+    if options[:noop]
+      disable_logging_orig = ActiveRecord::Migration.disable_logging
+
+      begin
+        ActiveRecord::Migration.disable_logging = true
+        buf = StringIO.new
+
+        callback = proc do |sql, name|
+          buf.puts sql if sql =~ /\A(CREATE|ALTER)\b/i
+        end
+
+        Ridgepole::ExecuteExpander.without_operation(callback) do
+          ActiveRecord::Schema.new.instance_eval(script)
+        end
+
+        buf.string.strip
+      ensure
+        ActiveRecord::Migration.disable_logging = disable_logging_orig
+      end
+    else
+      ActiveRecord::Schema.new.instance_eval(script)
+    end
   end
 
+
   def append_create_table(table_name, attrs, buf)
     options = attrs[:options] || {}
     definition = attrs[:definition] || {}

data/lib/ridgepole/execute_expander.rb

@@ -0,0 +1,42 @@
+class Ridgepole::ExecuteExpander
+  class Stub
+    def method_missing(method_name, *args, &block)
+      # Nothing to do
+    end
+  end
+
+  cattr_accessor :noop,     :instance_writer => false, :instance_reader => false
+  cattr_accessor :callback, :instance_writer => false, :instance_reader => false
+
+  class << self
+    def without_operation(callback = nil)
+      begin
+        self.noop = true
+        self.callback = callback
+        yield
+      ensure
+        self.noop = false
+        self.callback = nil
+      end
+    end
+
+    def expand_execute(connection)
+      return if connection.respond_to?(:execute_with_noop)
+
+      class << connection
+        def execute_with_noop(sql, name = nil)
+          if Ridgepole::ExecuteExpander.noop
+            if (callback = Ridgepole::ExecuteExpander.callback)
+              callback.call(sql, name)
+            end
+
+            Stub.new
+          else
+            execute_without_noop(sql, name)
+          end
+        end
+        alias_method_chain :execute, :noop
+      end
+    end
+  end # of class methods
+end

data/lib/ridgepole/migration_ext.rb

@@ -2,10 +2,11 @@ require 'active_record/migration'
 
 class ActiveRecord::Migration
   cattr_accessor :time_recorder
+  cattr_accessor :disable_logging
 
   def write_with_logging(text = '')
     logger = Ridgepole::Logger.instance
-    logger.info(text)
+    logger.info(text) unless self.disable_logging
     parse_text(text)
   end
   alias_method_chain :write, :logging

data/lib/ridgepole/version.rb

@@ -1,3 +1,3 @@
 module Ridgepole
-  VERSION = '0.2.7'
+  VERSION = '0.2.8'
 end

data/spec/migrate/migrate_noop_spec.rb

@@ -0,0 +1,104 @@
+describe 'Ridgepole::Client#diff -> migrate' do
+  context 'when database is empty' do
+    let(:actual_dsl) { '' }
+    let(:expected_dsl) {
+      <<-RUBY
+        create_table "clubs", force: true do |t|
+          t.string "name", default: "", null: false
+        end
+
+        add_index "clubs", ["name"], name: "idx_name", unique: true, using: :btree
+
+        create_table "departments", primary_key: "dept_no", force: true do |t|
+          t.string "dept_name", limit: 40, null: false
+        end
+
+        add_index "departments", ["dept_name"], name: "dept_name", unique: true, using: :btree
+
+        create_table "dept_emp", id: false, force: true do |t|
+          t.integer "emp_no",              null: false
+          t.string  "dept_no",   limit: 4, null: false
+          t.date    "from_date",           null: false
+          t.date    "to_date",             null: false
+        end
+
+        add_index "dept_emp", ["dept_no"], name: "dept_no", using: :btree
+        add_index "dept_emp", ["emp_no"], name: "emp_no", using: :btree
+
+        create_table "dept_manager", id: false, force: true do |t|
+          t.string  "dept_no",   limit: 4, null: false
+          t.integer "emp_no",              null: false
+          t.date    "from_date",           null: false
+          t.date    "to_date",             null: false
+        end
+
+        add_index "dept_manager", ["dept_no"], name: "dept_no", using: :btree
+        add_index "dept_manager", ["emp_no"], name: "emp_no", using: :btree
+
+        create_table "employee_clubs", force: true do |t|
+          t.integer "emp_no",  unsigned: true, null: false
+          t.integer "club_id", unsigned: true, null: false
+        end
+
+        add_index "employee_clubs", ["emp_no", "club_id"], name: "idx_emp_no_club_id", using: :btree
+
+        create_table "employees", primary_key: "emp_no", force: true do |t|
+          t.date   "birth_date",            null: false
+          t.string "first_name", limit: 14, null: false
+          t.string "last_name",  limit: 16, null: false
+          t.string "gender",     limit: 1,  null: false
+          t.date   "hire_date",             null: false
+        end
+
+        create_table "salaries", id: false, force: true do |t|
+          t.integer "emp_no",    null: false
+          t.integer "salary",    null: false
+          t.date    "from_date", null: false
+          t.date    "to_date",   null: false
+        end
+
+        add_index "salaries", ["emp_no"], name: "emp_no", using: :btree
+
+        create_table "titles", id: false, force: true do |t|
+          t.integer "emp_no",               null: false
+          t.string  "title",     limit: 50, null: false
+          t.date    "from_date",            null: false
+          t.date    "to_date"
+        end
+
+        add_index "titles", ["emp_no"], name: "emp_no", using: :btree
+      RUBY
+    }
+
+    subject { client }
+
+    it {
+      delta = subject.diff(expected_dsl)
+      expect(delta.differ?).to be_truthy
+      sql = delta.migrate(:noop => true)
+      expect(subject.dump).to eq actual_dsl
+
+      sql = sql.each_line.map {|i| i.strip }.join("\n")
+
+      expect(sql).to eq <<-SQL.strip_heredoc.strip
+        CREATE TABLE `clubs` (`id` int(10) unsigned DEFAULT NULL auto_increment PRIMARY KEY, `name` varchar(255) DEFAULT '' NOT NULL) ENGINE=InnoDB
+        CREATE UNIQUE INDEX `idx_name` USING btree ON `clubs` (`name`)
+        CREATE TABLE `departments` (`dept_no` int(10) unsigned DEFAULT NULL auto_increment PRIMARY KEY, `dept_name` varchar(40) NOT NULL) ENGINE=InnoDB
+        CREATE UNIQUE INDEX `dept_name` USING btree ON `departments` (`dept_name`)
+        CREATE TABLE `dept_emp` (`emp_no` int(10) NOT NULL, `dept_no` varchar(4) NOT NULL, `from_date` date NOT NULL, `to_date` date NOT NULL) ENGINE=InnoDB
+        CREATE  INDEX `dept_no` USING btree ON `dept_emp` (`dept_no`)
+        CREATE  INDEX `emp_no` USING btree ON `dept_emp` (`emp_no`)
+        CREATE TABLE `dept_manager` (`dept_no` varchar(4) NOT NULL, `emp_no` int(10) NOT NULL, `from_date` date NOT NULL, `to_date` date NOT NULL) ENGINE=InnoDB
+        CREATE  INDEX `dept_no` USING btree ON `dept_manager` (`dept_no`)
+        CREATE  INDEX `emp_no` USING btree ON `dept_manager` (`emp_no`)
+        CREATE TABLE `employee_clubs` (`id` int(10) unsigned DEFAULT NULL auto_increment PRIMARY KEY, `emp_no` int(10) unsigned NOT NULL, `club_id` int(10) unsigned NOT NULL) ENGINE=InnoDB
+        CREATE  INDEX `idx_emp_no_club_id` USING btree ON `employee_clubs` (`emp_no`, `club_id`)
+        CREATE TABLE `employees` (`emp_no` int(10) unsigned DEFAULT NULL auto_increment PRIMARY KEY, `birth_date` date NOT NULL, `first_name` varchar(14) NOT NULL, `last_name` varchar(16) NOT NULL, `gender` varchar(1) NOT NULL, `hire_date` date NOT NULL) ENGINE=InnoDB
+        CREATE TABLE `salaries` (`emp_no` int(10) NOT NULL, `salary` int(10) NOT NULL, `from_date` date NOT NULL, `to_date` date NOT NULL) ENGINE=InnoDB
+        CREATE  INDEX `emp_no` USING btree ON `salaries` (`emp_no`)
+        CREATE TABLE `titles` (`emp_no` int(10) NOT NULL, `title` varchar(50) NOT NULL, `from_date` date NOT NULL, `to_date` date) ENGINE=InnoDB
+        CREATE  INDEX `emp_no` USING btree ON `titles` (`emp_no`)
+      SQL
+    }
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ridgepole
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.2.8
 platform: ruby
 authors:
 - Genki Sugawara
@@ -117,6 +117,7 @@ files:
 - lib/ridgepole/diff.rb
 - lib/ridgepole/dsl_parser.rb
 - lib/ridgepole/dumper.rb
+- lib/ridgepole/execute_expander.rb
 - lib/ridgepole/logger.rb
 - lib/ridgepole/migration_ext.rb
 - lib/ridgepole/schema_dumper_ext.rb
@@ -140,6 +141,7 @@ files:
 - spec/migrate/migrate_duplicate_table_spec.rb
 - spec/migrate/migrate_empty_spec.rb
 - spec/migrate/migrate_merge_mode_spec.rb
+- spec/migrate/migrate_noop_spec.rb
 - spec/migrate/migrate_rename_column_spec.rb
 - spec/migrate/migrate_rename_table_spec.rb
 - spec/migrate/migrate_same_default_null_spec.rb
@@ -196,6 +198,7 @@ test_files:
 - spec/migrate/migrate_duplicate_table_spec.rb
 - spec/migrate/migrate_empty_spec.rb
 - spec/migrate/migrate_merge_mode_spec.rb
+- spec/migrate/migrate_noop_spec.rb
 - spec/migrate/migrate_rename_column_spec.rb
 - spec/migrate/migrate_rename_table_spec.rb
 - spec/migrate/migrate_same_default_null_spec.rb