seed_migration 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 78f4daf16c4c6c80bcd1774606a1873b860eedf0
-  data.tar.gz: 36d0c48eb0420bcb7ceba3cf287384eab7e71977
+  metadata.gz: 5d535ca4398f774e12467c56e174923aca1c20d5
+  data.tar.gz: 7de4bf9f1f32a8c199a83e43e204b20f578e4f19
 SHA512:
-  metadata.gz: 40d9f2546b0eb5fe9fc65a9375a41a0d6a5abbbb56ea32eea845bb83dacad0ee3165d3c77908cf19a407344d8998ee0640ddcb8d72ae13ee600008696be05b3a
-  data.tar.gz: b15825df57b3c3a5a6793446a473f1a13e5d4af0ccbe79835b125a5129f8fb6f57e5483a28123019062d621d792ea914572aed3a267eecbcd8eeab01a65f4bbc
+  metadata.gz: ca7c584a9a4b42c8d6f38d145a4d1b320ac311779c3dac98223415be2ff4439d5350b5db3a8a20e44b1885e18eb4ca201984c9abe4544d7e79493f3888d6b1ce
+  data.tar.gz: 900252bf1b87a11f1530e5976f95bd906c8a398277e86f7b6661a52857187603cae1eafc41b34ed18a200bea614c727d017cf393842e6ca0de4fd3938b4f5777

data/README.md

@@ -1,4 +1,4 @@
-[![Build Status](https://travis-ci.org/harrystech/seed_migration.svg?branch=master)](https://travis-ci.org/harrystech/seed_migration) [![Gem Version](https://badge.fury.io/rb/seed_migration.svg)](http://badge.fury.io/rb/seed_migration)
+[![Build Status](https://travis-ci.org/harrystech/seed_migration.svg?branch=master)](https://travis-ci.org/harrystech/seed_migration) [![Gem Version](https://badge.fury.io/rb/seed_migration.svg)](http://badge.fury.io/rb/seed_migration) [![Code Climate](https://codeclimate.com/repos/565d2ab865f101004800136a/badges/22e9c1da0befd44cac82/gpa.svg)](https://codeclimate.com/repos/565d2ab865f101004800136a/feed) [![Test Coverage](https://codeclimate.com/repos/565d2ab865f101004800136a/badges/22e9c1da0befd44cac82/coverage.svg)](https://codeclimate.com/repos/565d2ab865f101004800136a/coverage)
 
 # SeedMigration
 
@@ -21,7 +21,7 @@ gem 'seed_migration'
 
 ### Install and run the internal migrations
 
-```ruby
+```
 rake seed_migration:install:migrations
 rake db:migrate
 ```
@@ -32,7 +32,7 @@ That will create the table to keep track of data migrations.
 
 You can use the generator :
 
-```ruby
+```
 rails g seed_migration AddFoo
 ```
 A new file will be created under `db/data/` using rails migration convention:
@@ -47,13 +47,13 @@ You'll need to implement the `#up` method and if you need to be able to rollback
 
 To run all pending migrations, simply use
 
-```ruby
+```
 rake seed:migrate
 ```
 
 If needed, you can run a specific migration:
 
-```ruby
+```
 rake seed:migrate MIGRATION=20140407162007_add_foo.rb
 ```
 
@@ -61,22 +61,42 @@ rake seed:migrate MIGRATION=20140407162007_add_foo.rb
 
 Rolling back the last migration is as simple as:
 
-```ruby
+```
 rake seed:rollback
 ```
 
 You can rollback more than one migration at the same time:
 
-```ruby
+```
 rake seed:rollback STEP=3 # rollback last 3 migrations
 ```
 
 Or rollback a specific migration:
 
-```ruby
+```
 rake seed:rollback MIGRATION=20140407162007_add_foo.rb
 ```
 
+### Status
+
+See the status of your migrations:
+
+```
+rake seed:migrate:status
+```
+
+Example output:
+
+```
+database: seed-migrationdevelopment
+
+ Status   Migration ID    Migration Name
+--------------------------------------------------
+   up     20160114153832  Add users
+  down    20160114153843  Add more users
+  down    20160114153851  Add even more users
+```
+
 ### Registering models
 
 By default no models are registered, so running seed migrations won't update the seeds file.
@@ -124,6 +144,17 @@ SeedMigration::Migrator.bootstrap(20140404193326)
 
 Note that `seeds.rb` is only generated in development mode.  Production data will not be dumped in this process.
 
+### Checking for pending migrations
+
+Check for pending data migrations:
+
+```ruby
+SeedMigration::Migrator.check_pending!
+```
+
+If there are pending migrations, this will raise
+`SeedMigration::Migrator::PendingMigrationError`.
+
 ### Adding seed_migrations to an existing app
 
 If your app already contains seeds, using this gem could cause some issues.
@@ -207,7 +238,7 @@ SeedMigration.register Product
 
 At the moment, we rely by default on
 
-```
+```ruby
 ActiveRecord::Base.connection.reset_pk_sequence!
 ```
 which is `pg` only.
@@ -218,7 +249,7 @@ If you need to use this gem with another database, use the `ignore_ids` configur
 ## Runnings tests
 
 
-```ruby
+```
 RAILS_ENV=test bundle exec rake app:db:reset
 bundle exec rspec spec
 ```

data/lib/seed_migration.rb

@@ -14,7 +14,7 @@ module SeedMigration
     def register(model, &block)
       unregister model
       entry = RegisterEntry.new(model)
-      entry.instance_eval &block if block_given?
+      entry.instance_eval(&block) if block_given?
 
       self.registrar << entry
     end

data/lib/seed_migration/engine.rb

@@ -2,23 +2,23 @@ require 'rails'
 
 module SeedMigration
 
-  class << self
-    mattr_accessor :extend_native_migration_task
-    mattr_accessor :migration_table_name
-    mattr_accessor :ignore_ids
-    mattr_accessor :update_seeds_file
-    mattr_accessor :migrations_path
-    mattr_accessor :use_strict_create
-
-    self.migration_table_name = 'seed_migration_data_migrations' # Hardcoded, evil!
-    self.extend_native_migration_task = false
-    self.ignore_ids = false
-    self.update_seeds_file = true
-    self.migrations_path = 'data'
-    self.use_strict_create = false
-  end
-
-  def self.config(&block)
+  DEFAULT_TABLE_NAME = 'seed_migration_data_migrations'
+
+  mattr_accessor :extend_native_migration_task
+  mattr_accessor :migration_table_name
+  mattr_accessor :ignore_ids
+  mattr_accessor :update_seeds_file
+  mattr_accessor :migrations_path
+  mattr_accessor :use_strict_create
+
+  self.migration_table_name = DEFAULT_TABLE_NAME
+  self.extend_native_migration_task = false
+  self.ignore_ids = false
+  self.update_seeds_file = true
+  self.migrations_path = 'data'
+  self.use_strict_create = false
+
+  def self.config
     yield self
     after_config
   end

data/lib/seed_migration/migrator.rb

@@ -14,7 +14,7 @@ module SeedMigration
 
     def initialize(migration_path)
       @path = Pathname.new(migration_path)
-      raise "Can't find migration at #{@path.to_s}." if !@path.exist?
+      raise "Can't find migration at #{@path}." if !@path.exist?
     end
 
     def up
@@ -37,7 +37,7 @@ module SeedMigration
         migration.migrated_on = DateTime.now
         begin
           migration.save!
-        rescue Exception => e
+        rescue StandardError => e
           puts e
         end
         announce("#{klass}: migrated (#{runtime}s)")
@@ -68,6 +68,12 @@ module SeedMigration
       end
     end
 
+    def self.check_pending!
+      if get_new_migrations.any?
+        raise SeedMigration::Migrator::PendingMigrationError
+      end
+    end
+
     # Rake methods
     def self.run_new_migrations
       # TODO : Add warning about empty registered_models
@@ -105,13 +111,25 @@ module SeedMigration
       create_seed_file
     end
 
+    def self.display_migrations_status
+      puts "\ndatabase: #{ActiveRecord::Base.connection_config[:database]}\n\n"
+      puts "#{'Status'.center(8)}  #{'Migration ID'.ljust(14)}  Migration Name"
+      puts "-" * 50
+
+      up_versions = get_all_migration_versions
+      get_migration_files.each do |file|
+        version, name = parse_migration_filename(file)
+        status = up_versions.include?(version) ? "up" : "down"
+        puts "#{status.center(8)}  #{version.ljust(14)}  #{name}"
+      end
+    end
+
     def self.bootstrap(last_timestamp = nil)
       # replace with logger ?
-      p "Assume migrated up to #{last_timestamp}"
+      p "Assume seed data migrated up to #{last_timestamp}"
       files = get_migration_files(last_timestamp.to_s)
       files.each do |file|
-        name = file.split('/').last
-        version = name.split('_').first
+        _, version = parse_migration_filename(file)
         migration = SeedMigration::DataMigration.new
         migration.version = version
         migration.runtime = 0
@@ -145,7 +163,7 @@ module SeedMigration
         return files
       end
 
-      all_migration_versions = SeedMigration::DataMigration.all.map(&:version)
+      all_migration_versions = get_all_migration_versions
 
       files.each do |file|
         filename = file.split('/').last
@@ -197,6 +215,17 @@ module SeedMigration
       files.sort!
     end
 
+    def self.get_all_migration_versions
+      SeedMigration::DataMigration.all.map(&:version)
+    end
+
+    def self.parse_migration_filename(filename)
+      basename = File.basename(filename, '.rb')
+      _, version, underscored_name = basename.match(/(\d+)_(.*)/).to_a
+      name = underscored_name.gsub("_", " ").capitalize
+      [version, name]
+    end
+
     def self.create_seed_file
       if !SeedMigration.update_seeds_file || !Rails.env.development?
         return
@@ -247,9 +276,9 @@ SeedMigration::Migrator.bootstrap(#{last_migration})
       end
 
       if Rails::VERSION::MAJOR == 3 || defined?(ActiveModel::MassAssignmentSecurity)
-        model_creation_string = "#{instance.class}.#{create_method}(#{JSON.parse(sorted_attributes.to_json).to_s}, :without_protection => true)"
+        model_creation_string = "#{instance.class}.#{create_method}(#{JSON.parse(sorted_attributes.to_json)}, :without_protection => true)"
       elsif Rails::VERSION::MAJOR == 4
-        model_creation_string = "#{instance.class}.#{create_method}(#{JSON.parse(sorted_attributes.to_json).to_s})"
+        model_creation_string = "#{instance.class}.#{create_method}(#{JSON.parse(sorted_attributes.to_json)})"
       end
 
       # With pretty indents, please.
@@ -262,5 +291,12 @@ SeedMigration::Migrator.bootstrap(#{last_migration})
     def self.create_method
       SeedMigration.use_strict_create? ? 'create!' : 'create'
     end
+
+    class PendingMigrationError < StandardError
+      def initialize
+        super("Data migrations are pending. To resolve this issue, "\
+          "run the following:\n\n\trake seed:migrate\n")
+      end
+    end
   end
 end

data/lib/seed_migration/version.rb

@@ -1,3 +1,3 @@
 module SeedMigration
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

data/lib/tasks/seed_migration_tasks.rake

@@ -12,4 +12,13 @@ namespace :seed do
       SeedMigration::Migrator.rollback_migrations(ENV["MIGRATION"], ENV["STEP"] || ENV["STEPS"] || 1)
     end
   end
+
+  namespace :migrate do
+    if !Rake::Task.task_defined?("seed:migrate:status")
+      desc "Display status of data migrations."
+      task :status => :environment do
+        SeedMigration::Migrator.display_migrations_status
+      end
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: seed_migration
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Andy O'Neill
@@ -11,10 +11,10 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-30 00:00:00.000000000 Z
+date: 2016-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -28,21 +28,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pg
+  name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.14.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.14.2
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rspec-mocks
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -56,21 +56,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec-rails
+  name: test-unit
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.14.2
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.14.2
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: rspec-mocks
+  name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -83,20 +83,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: test-unit
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
 description: Rails gem for Data Migrations
 email:
 - aoneill@harrys.com
@@ -142,7 +128,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Rails Data Migration