data_migrate 3.3.1 → 3.4.0

data/Changelog.md

@@ -1,7 +1,9 @@
 Changelog
 =========
 
-## 3.3.1 
+## 3.4.0
+`rake data:migrate:status` to return result in chronological order
+## 3.3.1
 Regression fix, thanks to [subakva](https://github.com/subakva)
 
 ## 3.3.0

data/README.md

@@ -141,6 +141,9 @@ Tasks work as they would with the 'vanilla' db version. The 'with_data' addition
 With 'up' and 'down', you can specify the option 'BOTH', which defaults to false. Using true, will migrate both the data and schema (in the desired direction) if they both match the version provided.  Again, going up, schema is given precedence. Down its data.
 
 `rake db:migrate:status:with_data` provides and additional column to indicate which type of migration.
+### Configuration
+
+`data_migrate` respects `ActiveRecord::Base.dump_schema_after_migration`. If it is set to `false`, data schema file will not be generated
 
 ## Capistrano Support
 

data/data_migrate.gemspec

@@ -24,6 +24,8 @@ Gem::Specification.new do |s|
   s.add_development_dependency "rb-readline"
   s.add_development_dependency "sqlite3"
   s.add_development_dependency "timecop"
+  s.add_development_dependency "rubocop"
+  s.add_development_dependency "overcommit"
 
 
   s.files         = `git ls-files`.split("\n")

data/lib/data_migrate.rb

@@ -6,6 +6,7 @@ require File.join(File.dirname(__FILE__), "data_migrate",
 require File.join(File.dirname(__FILE__), "data_migrate", "data_schema")
 require File.join(File.dirname(__FILE__), "data_migrate", "database_tasks")
 require File.join(File.dirname(__FILE__), "data_migrate", "schema_dumper")
+require File.join(File.dirname(__FILE__), "data_migrate", "status_service")
 if Rails::VERSION::MAJOR >= 5
   require File.join(File.dirname(__FILE__), "data_migrate", "migration_five")
 else

data/lib/data_migrate/status_service.rb

@@ -0,0 +1,65 @@
+module DataMigrate
+  class StatusService
+    class << self
+      def dump(connection = ActiveRecord::Base.connection, stream = STDOUT)
+        new(connection).dump(stream)
+        stream
+      end
+    end
+
+    def initialize(connection)
+      @connection = connection
+    end
+
+    def root_folder
+      Rails.root
+    end
+
+    def dump(stream)
+      unless @connection.table_exists?(table_name)
+        stream.puts "Data migrations table does not exist yet."
+        return
+      end
+      sql = "SELECT version FROM #{DataMigrate::DataMigrator.schema_migrations_table_name}"
+      db_list = ActiveRecord::Base.connection.select_values(sql)
+      output(stream, db_list)
+    end
+
+    private
+
+    def table_name
+      DataMigrate::DataMigrator.schema_migrations_table_name
+    end
+
+    def output(stream, db_list)
+      stream.puts "#{"Status".center(8)}  #{"Migration ID".ljust(14)}  Migration Name"
+      stream.puts "-" * 50
+      list =  migration_files(db_list) + migration_list(db_list)
+      list.sort! {|line1, line2| line1[1] <=> line2[1]}
+      list.each do |file|
+        stream.puts "#{file[0].center(8)}  #{file[1].ljust(14)}  #{file[2]}"
+      end
+      stream.puts
+    end
+
+    def migration_list(db_list)
+      list = []
+      db_list.each do |version|
+        list << ["up", version, "*** NO FILE ***"]
+      end
+      list
+    end
+
+    def migration_files(db_list)
+      file_list = []
+      Dir.foreach(File.join(root_folder, "db", "data")) do |file|
+        # only files matching "20091231235959_some_name.rb" pattern
+        if match_data = DataMigrate::DataMigrator.match(file)
+          status = db_list.delete(match_data[1]) ? "up" : "down"
+          file_list << [status, match_data[1], match_data[2].humanize]
+        end
+      end
+      file_list
+    end
+  end
+end

data/lib/data_migrate/version.rb

@@ -1,3 +1,3 @@
 module DataMigrate
-  VERSION = '3.3.1'.freeze
+  VERSION = '3.4.0'.freeze
 end

data/spec/data_migrate/status_service_spec.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+describe DataMigrate::StatusService do
+  let(:subject) { DataMigrate::SchemaDumper }
+  let(:db_config) do
+    {
+      adapter: "sqlite3",
+      database: "spec/db/test.db"
+    }
+  end
+  let(:service) { DataMigrate::StatusService }
+
+  describe :dump do
+    before do
+      ActiveRecord::Base.establish_connection(db_config)
+    end
+
+    describe "table does not exist" do
+      it "table doesn't exist" do
+        expect_any_instance_of(service).to receive(:table_name) { "bogus"}
+        stream = StringIO.new
+        service.dump(ActiveRecord::Base.connection, stream)
+        stream.rewind
+
+        expected = "Data migrations table does not exist"
+        expect(stream.read).to include expected
+      end
+    end
+  end
+
+  describe :dump do
+    context "table exists"
+    let(:fixture_file_timestamps) do
+      %w[20091231235959 20101231235959 20111231235959]
+    end
+
+    before do
+      expect(DataMigrate::DataMigrator).
+        to receive(:db_config) { db_config }.at_least(:once)
+      ActiveRecord::Base.establish_connection(db_config)
+
+      ActiveRecord::Base.connection.initialize_schema_migrations_table
+      DataMigrate::DataMigrator.assure_data_schema_table
+
+      ActiveRecord::Base.connection.execute <<-SQL
+        INSERT INTO #{DataMigrate::DataMigrator.schema_migrations_table_name}
+        VALUES #{fixture_file_timestamps.map { |t| "(#{t})" }.join(', ')}
+      SQL
+
+      expect_any_instance_of(service).to receive(:root_folder) { "spec" }
+    end
+
+    after do
+      ActiveRecord::Migration.drop_table("data_migrations")
+    end
+
+    it "shows successfully executed migration" do
+      stream = StringIO.new
+      service.dump(ActiveRecord::Base.connection, stream)
+      stream.rewind
+
+      expected = "   up     20091231235959  Some name"
+      expect(stream.read).to include expected
+    end
+
+    it "shows missing file migration" do
+      stream = StringIO.new
+      service.dump(ActiveRecord::Base.connection, stream)
+      stream.rewind
+
+      expected = "   up     20101231235959  *** NO FILE ***"
+      s = stream.read
+      expect(s).to include expected
+    end
+
+    it "shows migration that has not run yet" do
+      stream = StringIO.new
+      service.dump(ActiveRecord::Base.connection, stream)
+      stream.rewind
+
+      expected = "  down    20171231235959  Super update"
+      s = stream.read
+      expect(s).to include expected
+    end
+
+    it "outputs migrations in chronological order" do
+      stream = StringIO.new
+      service.dump(ActiveRecord::Base.connection, stream)
+      stream.rewind
+      s = stream.read
+      expect(s.index("20091231235959")).to be < s.index("20111231235959")
+    end
+  end
+end

data/tasks/databases.rake

@@ -286,30 +286,9 @@ namespace :data do
     task :status => :environment do
       config = ActiveRecord::Base.configurations[Rails.env || 'development']
       ActiveRecord::Base.establish_connection(config)
-      unless ActiveRecord::Base.connection.table_exists?(DataMigrate::DataMigrator.schema_migrations_table_name)
-        puts 'Data migrations table does not exist yet.'
-        next  # means "return" for rake task
-      end
-      db_list = ActiveRecord::Base.connection.select_values("SELECT version FROM #{DataMigrate::DataMigrator.schema_migrations_table_name}")
-      file_list = []
-      Dir.foreach(File.join(Rails.root, 'db', 'data')) do |file|
-        # only files matching "20091231235959_some_name.rb" pattern
-        if match_data = DataMigrate::DataMigrator.match(file)
-          status = db_list.delete(match_data[1]) ? 'up' : 'down'
-          file_list << [status, match_data[1], match_data[2]]
-        end
-      end
-      # output
+      connection = ActiveRecord::Base.connection
       puts "\ndatabase: #{config['database']}\n\n"
-      puts "#{"Status".center(8)}  #{"Migration ID".ljust(14)}  Migration Name"
-      puts "-" * 50
-      file_list.each do |file|
-        puts "#{file[0].center(8)}  #{file[1].ljust(14)}  #{file[2].humanize}"
-      end
-      db_list.each do |version|
-        puts "#{'up'.center(8)}  #{version.ljust(14)}  *** NO FILE ***"
-      end
-      puts
+      DataMigrate::StatusService.dump(connection)
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: data_migrate
 version: !ruby/object:Gem::Version
-  version: 3.3.1
+  version: 3.4.0
 platform: ruby
 authors:
 - Andrew J Vargo
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-21 00:00:00.000000000 Z
+date: 2018-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -137,6 +137,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: overcommit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Rake tasks to migrate data alongside schema changes.
 email:
 - ajvargo@computer.org
@@ -146,7 +174,11 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".hound.yml"
+- ".overcommit.yml"
 - ".rspec"
+- ".rubocop.yml"
+- ".ruby-style.yml"
 - ".travis.yml"
 - Appraisals
 - Changelog.md
@@ -173,6 +205,7 @@ files:
 - lib/data_migrate/migration_five.rb
 - lib/data_migrate/railtie.rb
 - lib/data_migrate/schema_dumper.rb
+- lib/data_migrate/status_service.rb
 - lib/data_migrate/version.rb
 - lib/generators/data_migrate.rb
 - lib/generators/data_migration/data_migration_generator.rb
@@ -185,6 +218,9 @@ files:
 - spec/data_migrate/database_tasks_spec.rb
 - spec/data_migrate/migration.rb
 - spec/data_migrate/schema_dumper_spec.rb
+- spec/data_migrate/status_service_spec.rb
+- spec/db/data/20091231235959_some_name.rb
+- spec/db/data/20171231235959_super_update.rb
 - spec/generators/data_migration/data_migration_generator_spec.rb
 - spec/spec_helper.rb
 - tasks/.gitkeep
@@ -212,7 +248,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: data_migrate
-rubygems_version: 2.5.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Rake tasks to migrate data alongside schema changes.
@@ -223,5 +259,8 @@ test_files:
 - spec/data_migrate/database_tasks_spec.rb
 - spec/data_migrate/migration.rb
 - spec/data_migrate/schema_dumper_spec.rb
+- spec/data_migrate/status_service_spec.rb
+- spec/db/data/20091231235959_some_name.rb
+- spec/db/data/20171231235959_super_update.rb
 - spec/generators/data_migration/data_migration_generator_spec.rb
 - spec/spec_helper.rb