rails_async_migrations 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d3950f1a87294b305b11d6b4f72fe89140ac5ca037b0d63634b93883efac2226
-  data.tar.gz: bc23163e9ec84a71472a786388372461d3437316c56286d03c8f231462fd9770
+  metadata.gz: 4253ed996632677655f41d68a099fa59f1140d8e6d45e5082ac67d5ae240fb52
+  data.tar.gz: 4a7fe84133fe9a0e9361c0d47cef3fc48045a6031bf0f3a0cfcfc99e648fc12f
 SHA512:
-  metadata.gz: f197bd6a02bca2bc548c5a68a8ac29145461d97dc88217e399aa1183c329a476d4658f610460106261ef2e3b89f792f25de1a084d259079c64288443edc626d5
-  data.tar.gz: fc3b0b75a80a3840c8bd9f2b488f5cebd4cc30ed2d011d65a6e88571cc4ce05949f4e97b5f2058519bbc0879d6169669d1f362150a9c5b55f32e0bb2026ce184
+  metadata.gz: 76ae01899644674ef8f62a4718d263e261f0322d33617c85483dee36debfb5bdd209e58296080d77e8fef4c832994e0dc0cfa9990dc2ce7281cc87a827243dc0
+  data.tar.gz: 94efe3c86bca71bcfb78c4630fed9fffbcaaa5b6d4258d1a46e29052dec5bd5f4468f56d13689a03bbe286ff254e8a81f4351f4282d7642a3af49c31b0f58608

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rails_async_migrations (1.0.3)
+    rails_async_migrations (1.0.4)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -15,6 +15,19 @@ Most people turn heavy data changes into `rake tasks` or split workers; there ar
 
 Turning data changes into a `rake task` can be a good idea, and it's ideal to test it out too, but sometimes you need this **fat ass loop** of **>1,000,000 records** which will be run **once, and only once** to be run fast and without locking down the deployment process itself; making a `rake task` for that is overkill. After all, it will only be used once and within a specific structure / data context. This gem is here to answer this need.
 
+## Requirements
+
+You can use this library through different background processing technologies
+
+| Type             | Version | Documentation                                 | Default |
+| ---------------- | ------- | --------------------------------------------- | ------- |
+| **Sidekiq**      | 5.2.3   | https://github.com/mperham/sidekiq            | YES     |
+| **Delayed::Job** | 4.1.3   | https://github.com/collectiveidea/delayed_job | NO      |
+
+Please install and configure one of those before to use this gem. If you use other libraries to setup your workers, please hit me up and I'll create additional adapters for you.
+
+This gem has been tested and is working with `ActiveRecord 5.2.2`, if you notice abnormal behavior with other versions or want it compatible with earlier versions, please hit me up.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -119,24 +132,11 @@ You can also manually launch the queue check and fire by using:
 If your migration crashes, and blocks the rest of your queue but you want to execute them anyway, you can use multiple strategies to do so:
 
 - Change the code of the migration file and push it again so it passes
-- Remove the matching row in the `async_schema_migrations` table
-- Update the matching row with `state = done`
+- Remove the matching row in the `async_schema_migrations` table. In this case, if you `rollback` your migration and run them again, it'll be newly added to the rows
+- Update the matching row with `async_schema_migrations.state = done`. It'll be considered processed and won't ever be tried again.
 
 To find the matching migration, be aware the `version` value is always the same as the classic migrations ones, so it's pretty easy to find things around.
 
-## Compatibility
-
-You can use this library through different adapters
-
-| Type             | Version | Documentation                                 |
-| ---------------- | ------- | --------------------------------------------- |
-| **Sidekiq**      | 5.2.3   | https://github.com/mperham/sidekiq            |
-| **Delayed::Job** | 4.1.3   | https://github.com/collectiveidea/delayed_job |
-
-If you use other technologies to setup your workers, please hit me up and I'll create additional adapters for you.
-
-The gem has been tested and is working with `ActiveRecord 5.2.2`, if you notice abnormal behavior with other versions or want it compatible with earlier versions, please hit me up.
-
 ## Development
 
 I created this library as my company was struggling in its deployment process. It lacks functionalities but this is a good starting point; everything is easily extendable so don't hesitate to add your own needed methods to it.

data/lib/rails_async_migrations/{mutators.rb → class_mutators.rb}

@@ -6,19 +6,21 @@ require 'rails_async_migrations/mutators/trigger_callback'
 # the `self` represents the class being ran so we have to be careful as not to conflict
 # with the original ActiveRecord names
 module RailsAsyncMigrations
-  module Mutators
-    private
-
+  module ClassMutators
     def turn_async
-      TurnAsync.new(self).perform
+      Mutators::TurnAsync.new(self).perform
     end
+  end
+end
 
-    # # the following methods are internal mechanics
-    # # do not overwrite those methods if you don't know
-    # # exactly what you're doing
+    # def self.descendants
+    #   ObjectSpace.each_object(Class).select do
+    #     |current| current < self
+    #   end
+    # end
+      # descendants = self.class.descendants
+      # descendants.delete_at descendants.index(ActiveRecord::Migration::Current)
+      # real_self = descendants.last
 
-    def trigger_callback(method)
-      TriggerCallback.new(self, method).perform
-    end
-  end
-end
+      # puts "REAL SELF IS #{real_self}"
+      # 

data/lib/rails_async_migrations/instance_mutators.rb

@@ -0,0 +1,11 @@
+require 'rails_async_migrations/mutators/base'
+require 'rails_async_migrations/mutators/turn_async'
+require 'rails_async_migrations/mutators/trigger_callback'
+
+module RailsAsyncMigrations
+  module InstanceMutators
+    def trigger_callback(method)
+      Mutators::TriggerCallback.new(self, method).perform
+    end
+  end
+end

data/lib/rails_async_migrations/migration/fire_migration.rb

@@ -34,7 +34,7 @@ module RailsAsyncMigrations
       def done?
         if migration.state == 'done'
           Tracer.new.verbose "Migration #{migration.id} is already `done`, cancelling fire"
-          return
+          return true
         end
       end
 

data/lib/rails_async_migrations/mutators/base.rb

@@ -1,21 +1,9 @@
 module RailsAsyncMigrations
   module Mutators
     class Base
-      # in some context we have to guess it from the file and current connection
-      # for instance when we use class methods such as `turn_async`
-      def migration_class
-        fetch_from_file || instance.class
-      end
-
-      def fetch_from_file
-        return unless current_migration
-        require current_migration.filename
-        current_migration.name.constantize
-      end
-
-      def current_migration
-        @current_migration ||= Connection::ActiveRecord.new(:up).current_migration
-      end
+      # def migration_class
+      #   instance.class
+      # end
     end
   end
 end

data/lib/rails_async_migrations/mutators/turn_async.rb

@@ -1,10 +1,10 @@
 module RailsAsyncMigrations
   module Mutators
     class TurnAsync < Base
-      attr_reader :instance
+      attr_reader :migration_class
 
-      def initialize(instance)
-        @instance = instance
+      def initialize(migration_class)
+        @migration_class = migration_class
       end
 
       def perform

data/lib/rails_async_migrations/version.rb

@@ -1,3 +1,3 @@
 module RailsAsyncMigrations
-  VERSION = "1.0.3"
+  VERSION = "1.0.4"
 end

data/lib/rails_async_migrations.rb

@@ -11,7 +11,8 @@ end
 require 'rails_async_migrations/connection/active_record'
 require 'rails_async_migrations/config'
 require 'rails_async_migrations/migration'
-require 'rails_async_migrations/mutators'
+require 'rails_async_migrations/class_mutators'
+require 'rails_async_migrations/instance_mutators'
 require 'rails_async_migrations/tracer'
 require 'rails_async_migrations/version'
 require 'rails_async_migrations/railtie' if defined?(Rails)
@@ -38,5 +39,6 @@ module RailsAsyncMigrations
 end
 
 ActiveSupport.on_load(:active_record) do
-  ActiveRecord::Migration.prepend RailsAsyncMigrations::Mutators
+  ActiveRecord::Migration.extend RailsAsyncMigrations::ClassMutators
+  ActiveRecord::Migration.include RailsAsyncMigrations::InstanceMutators
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_async_migrations
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - Laurent Schaffner
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-03 00:00:00.000000000 Z
+date: 2019-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -143,8 +143,10 @@ files:
 - lib/generators/rails_async_migrations/install_generator.rb
 - lib/generators/rails_async_migrations/templates/create_async_schema_migrations.rb
 - lib/rails_async_migrations.rb
+- lib/rails_async_migrations/class_mutators.rb
 - lib/rails_async_migrations/config.rb
 - lib/rails_async_migrations/connection/active_record.rb
+- lib/rails_async_migrations/instance_mutators.rb
 - lib/rails_async_migrations/migration.rb
 - lib/rails_async_migrations/migration/check_queue.rb
 - lib/rails_async_migrations/migration/fire_migration.rb
@@ -154,7 +156,6 @@ files:
 - lib/rails_async_migrations/migration/run.rb
 - lib/rails_async_migrations/migration/unlock.rb
 - lib/rails_async_migrations/models/async_schema_migration.rb
-- lib/rails_async_migrations/mutators.rb
 - lib/rails_async_migrations/mutators/base.rb
 - lib/rails_async_migrations/mutators/trigger_callback.rb
 - lib/rails_async_migrations/mutators/turn_async.rb