data-migration 1.2.0 → 2.0.0

data/Gemfile.lock

@@ -1,246 +0,0 @@
-PATH
-  remote: .
-  specs:
-    data-migration (1.2.0)
-      activejob (> 5)
-      activerecord (> 5)
-      activesupport (> 5)
-      rails (> 5)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    actioncable (8.0.0)
-      actionpack (= 8.0.0)
-      activesupport (= 8.0.0)
-      nio4r (~> 2.0)
-      websocket-driver (>= 0.6.1)
-      zeitwerk (~> 2.6)
-    actionmailbox (8.0.0)
-      actionpack (= 8.0.0)
-      activejob (= 8.0.0)
-      activerecord (= 8.0.0)
-      activestorage (= 8.0.0)
-      activesupport (= 8.0.0)
-      mail (>= 2.8.0)
-    actionmailer (8.0.0)
-      actionpack (= 8.0.0)
-      actionview (= 8.0.0)
-      activejob (= 8.0.0)
-      activesupport (= 8.0.0)
-      mail (>= 2.8.0)
-      rails-dom-testing (~> 2.2)
-    actionpack (8.0.0)
-      actionview (= 8.0.0)
-      activesupport (= 8.0.0)
-      nokogiri (>= 1.8.5)
-      rack (>= 2.2.4)
-      rack-session (>= 1.0.1)
-      rack-test (>= 0.6.3)
-      rails-dom-testing (~> 2.2)
-      rails-html-sanitizer (~> 1.6)
-      useragent (~> 0.16)
-    actiontext (8.0.0)
-      actionpack (= 8.0.0)
-      activerecord (= 8.0.0)
-      activestorage (= 8.0.0)
-      activesupport (= 8.0.0)
-      globalid (>= 0.6.0)
-      nokogiri (>= 1.8.5)
-    actionview (8.0.0)
-      activesupport (= 8.0.0)
-      builder (~> 3.1)
-      erubi (~> 1.11)
-      rails-dom-testing (~> 2.2)
-      rails-html-sanitizer (~> 1.6)
-    activejob (8.0.0)
-      activesupport (= 8.0.0)
-      globalid (>= 0.3.6)
-    activemodel (8.0.0)
-      activesupport (= 8.0.0)
-    activerecord (8.0.0)
-      activemodel (= 8.0.0)
-      activesupport (= 8.0.0)
-      timeout (>= 0.4.0)
-    activestorage (8.0.0)
-      actionpack (= 8.0.0)
-      activejob (= 8.0.0)
-      activerecord (= 8.0.0)
-      activesupport (= 8.0.0)
-      marcel (~> 1.0)
-    activesupport (8.0.0)
-      base64
-      benchmark (>= 0.3)
-      bigdecimal
-      concurrent-ruby (~> 1.0, >= 1.3.1)
-      connection_pool (>= 2.2.5)
-      drb
-      i18n (>= 1.6, < 2)
-      logger (>= 1.4.2)
-      minitest (>= 5.1)
-      securerandom (>= 0.3)
-      tzinfo (~> 2.0, >= 2.0.5)
-      uri (>= 0.13.1)
-    base64 (0.2.0)
-    benchmark (0.4.0)
-    bigdecimal (3.1.8)
-    bigdecimal (3.1.8-java)
-    builder (3.3.0)
-    concurrent-ruby (1.3.4)
-    connection_pool (2.4.1)
-    crass (1.0.6)
-    date (3.4.1)
-    date (3.4.1-java)
-    diff-lcs (1.5.1)
-    docile (1.4.1)
-    drb (2.2.1)
-    erubi (1.13.0)
-    globalid (1.2.1)
-      activesupport (>= 6.1)
-    i18n (1.14.6)
-      concurrent-ruby (~> 1.0)
-    io-console (0.8.0)
-    io-console (0.8.0-java)
-    irb (1.14.1)
-      rdoc (>= 4.0.0)
-      reline (>= 0.4.2)
-    jar-dependencies (0.5.0)
-    logger (1.6.2)
-    loofah (2.23.1)
-      crass (~> 1.0.2)
-      nokogiri (>= 1.12.0)
-    mail (2.8.1)
-      mini_mime (>= 0.1.1)
-      net-imap
-      net-pop
-      net-smtp
-    marcel (1.0.4)
-    mini_mime (1.1.5)
-    mini_portile2 (2.8.8)
-    minitest (5.25.4)
-    net-imap (0.5.1)
-      date
-      net-protocol
-    net-pop (0.1.2)
-      net-protocol
-    net-protocol (0.2.2)
-      timeout
-    net-smtp (0.5.0)
-      net-protocol
-    nio4r (2.7.4)
-    nio4r (2.7.4-java)
-    nokogiri (1.16.8-arm64-darwin)
-      racc (~> 1.4)
-    nokogiri (1.16.8-java)
-      racc (~> 1.4)
-    nokogiri (1.16.8-x86_64-linux)
-      racc (~> 1.4)
-    psych (5.2.1)
-      date
-      stringio
-    psych (5.2.1-java)
-      date
-      jar-dependencies (>= 0.1.7)
-    racc (1.8.1)
-    racc (1.8.1-java)
-    rack (3.1.8)
-    rack-session (2.0.0)
-      rack (>= 3.0.0)
-    rack-test (2.1.0)
-      rack (>= 1.3)
-    rackup (2.2.1)
-      rack (>= 3)
-    rails (8.0.0)
-      actioncable (= 8.0.0)
-      actionmailbox (= 8.0.0)
-      actionmailer (= 8.0.0)
-      actionpack (= 8.0.0)
-      actiontext (= 8.0.0)
-      actionview (= 8.0.0)
-      activejob (= 8.0.0)
-      activemodel (= 8.0.0)
-      activerecord (= 8.0.0)
-      activestorage (= 8.0.0)
-      activesupport (= 8.0.0)
-      bundler (>= 1.15.0)
-      railties (= 8.0.0)
-    rails-dom-testing (2.2.0)
-      activesupport (>= 5.0.0)
-      minitest
-      nokogiri (>= 1.6)
-    rails-html-sanitizer (1.6.1)
-      loofah (~> 2.21)
-      nokogiri (>= 1.15.7, != 1.16.7, != 1.16.6, != 1.16.5, != 1.16.4, != 1.16.3, != 1.16.2, != 1.16.1, != 1.16.0.rc1, != 1.16.0)
-    railties (8.0.0)
-      actionpack (= 8.0.0)
-      activesupport (= 8.0.0)
-      irb (~> 1.13)
-      rackup (>= 1.0.0)
-      rake (>= 12.2)
-      thor (~> 1.0, >= 1.2.2)
-      zeitwerk (~> 2.6)
-    rake (13.2.1)
-    rdoc (6.8.1)
-      psych (>= 4.0.0)
-    reline (0.5.12)
-      io-console (~> 0.5)
-    rexml (3.3.9)
-    rspec (3.13.0)
-      rspec-core (~> 3.13.0)
-      rspec-expectations (~> 3.13.0)
-      rspec-mocks (~> 3.13.0)
-    rspec-core (3.13.2)
-      rspec-support (~> 3.13.0)
-    rspec-expectations (3.13.3)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.13.0)
-    rspec-support (3.13.2)
-    rspec_junit_formatter (0.6.0)
-      rspec-core (>= 2, < 4, != 2.12.0)
-    securerandom (0.4.0)
-    simplecov (0.22.0)
-      docile (~> 1.1)
-      simplecov-html (~> 0.11)
-      simplecov_json_formatter (~> 0.1)
-    simplecov-cobertura (2.1.0)
-      rexml
-      simplecov (~> 0.19)
-    simplecov-html (0.13.1)
-    simplecov_json_formatter (0.1.4)
-    sqlite3 (2.4.0)
-      mini_portile2 (~> 2.8.0)
-    sqlite3 (2.4.0-arm64-darwin)
-    sqlite3 (2.4.0-x86_64-linux-gnu)
-    stringio (3.1.2)
-    thor (1.3.2)
-    timeout (0.4.2)
-    tzinfo (2.0.6)
-      concurrent-ruby (~> 1.0)
-    uri (1.0.2)
-    useragent (0.16.11)
-    websocket-driver (0.7.6)
-      websocket-extensions (>= 0.1.0)
-    websocket-driver (0.7.6-java)
-      websocket-extensions (>= 0.1.0)
-    websocket-extensions (0.1.5)
-    zeitwerk (2.7.1)
-
-PLATFORMS
-  arm64-darwin
-  universal-java-11
-  x86_64-linux
-
-DEPENDENCIES
-  bundler (~> 2)
-  data-migration!
-  rspec (~> 3)
-  rspec_junit_formatter (~> 0.6)
-  simplecov (~> 0.21)
-  simplecov-cobertura (~> 2)
-  sqlite3 (~> 2.4)
-
-BUNDLED WITH
-   2.5.20

data/lib/generators/install_generator.rb

@@ -1,17 +0,0 @@
-require "rails/generators"
-require "rails/generators/active_record"
-require "rails/generators/active_record/migration/migration_generator"
-
-class InstallGenerator < ActiveRecord::Generators::MigrationGenerator
-  source_root File.expand_path("../templates", __FILE__)
-
-  def create_migration_file
-    set_local_assigns!
-    validate_file_name!
-    migration_template "install_#{name}.rb", "#{DataMigration.config.schema_migrations_path}/#{file_name}.rb"
-  end
-
-  def migration_parent
-    "ActiveRecord::Migration[#{ActiveRecord::Migration.current_version}]"
-  end
-end

data/spec/data_migration/config_spec.rb

@@ -1,116 +0,0 @@
-require "spec_helper"
-
-describe DataMigration::Config do
-  subject(:config) { described_class.new }
-
-  let(:current_user) do
-    User.new(id: 1)
-  end
-  let(:action_reporter) do
-    Class.new do
-      def current_user
-        User.new(id: 3)
-      end
-
-      def context(**kwargs)
-        kwargs
-      end
-    end.new
-  end
-  let(:audited) do
-    Class.new do
-      def store
-        { audited_user: User.new(id: 4) }
-      end
-    end.new
-  end
-  let(:logger) do
-    Class.new do
-      def info(message)
-        puts message
-      end
-    end.new
-  end
-  let(:other_user) do
-    User.new(id: 2)
-  end
-  let(:migration) do
-    DataMigration::Task.new(id: 1, name: "test", operator: other_user)
-  end
-
-  before do
-    allow(Rails).to receive(:root).and_return(rails_root)
-    allow(Rails).to receive(:logger).and_return(logger)
-  end
-
-  it "has default schema migrations path" do
-    expect(config.schema_migrations_path).to eq "db/migrate"
-  end
-
-  it "has default data migrations path" do
-    expect(config.data_migrations_path).to eq "db/data_migrations"
-  end
-
-  it "has default data migrations full path" do
-    expect(config.data_migrations_full_path).to eq Rails.root.join("db/data_migrations")
-  end
-
-  it "has default data migrations path glob" do
-    expect(config.data_migrations_path_glob).to eq Rails.root.join("db/data_migrations/*.rb").to_s
-  end
-
-  it "has default generate spec" do
-    expect(config.generate_spec?).to be true
-  end
-
-  it "has default task class" do
-    expect(config.task_class).to eq DataMigration::Task
-  end
-
-  it "has default job class" do
-    expect(config.job_class).to eq DataMigration::Job
-  end
-
-  it "has default job queue name" do
-    expect(config.job_queue_name).to eq :default
-  end
-
-  it "has default default jobs limit" do
-    expect(config.default_jobs_limit).to eq 10
-  end
-
-  it "has default monitoring context" do
-    expect(config.monitoring_context).to be_a Proc
-
-    expect(Rails.logger).to receive(:info).with("Data migration context: {:data_migration_name=>\"test\", :data_migration_id=>1, :data_migration_operator_id=>2}")
-    expect { config.monitoring_context.call(migration) }.not_to raise_error
-  end
-
-  context "when ActionReporter is defined" do
-    before do
-      stub_const("ActionReporter", action_reporter)
-    end
-
-    it "sets monitoring context" do
-      expect(ActionReporter).to receive(:context).with(
-        data_migration_name: "test",
-        data_migration_id: 1,
-        data_migration_operator_id: 2
-      )
-      expect(ActionReporter).to receive(:current_user).and_return(nil)
-      expect(ActionReporter).to receive(:current_user=).with(other_user)
-      expect { config.monitoring_context.call(migration) }.not_to raise_error
-    end
-  end
-
-  context "when Audited is defined" do
-    before do
-      stub_const("Audited", audited)
-    end
-
-    it "sets monitoring context" do
-      expect(Audited).to receive(:store).and_return(audited_user: User.new(id: 5))
-      expect { config.monitoring_context.call(migration) }.not_to raise_error
-    end
-  end
-end

data/spec/data_migration/job_spec.rb

@@ -1,96 +0,0 @@
-require "spec_helper"
-
-describe DataMigration::Job do
-  subject(:job) { DataMigration::Job.new }
-
-  let(:operator) { User.create!(email: "test@example.com") }
-  let(:task) { DataMigration::Task.create!(name: migration_name, operator: operator) }
-
-  let(:migration_name) { "20241206200111_create_users" }
-  let(:data_migrations_full_path) { File.expand_path("../fixtures/data_migrations", __dir__) }
-
-  before do
-    allow(Rails).to receive(:env).and_return(rails_env)
-    allow(Rails).to receive(:logger).and_return(rails_logger)
-    allow(DataMigration.config).to receive(:data_migrations_full_path).and_return(data_migrations_full_path)
-  end
-
-  it "runs rspec spec/fixtures/data_migrations/20241206200111_create_users.rb" do
-    output = `RUN_MIGRATION_TESTS=1 rspec #{data_migrations_full_path}/#{migration_name}.rb`
-    expect(output).to include("1 example, 0 failures")
-  end
-
-  describe "#perform" do
-    subject(:perform) { job.perform(task.id, **job_kwargs) }
-
-    let(:job_kwargs) { {} }
-
-    it "updates the task status to completed" do
-      expect { perform }.to change { task.reload.status }.to("completed")
-    end
-
-    context "when migration file is not found" do
-      before do
-        task
-        allow_any_instance_of(DataMigration::Task).to receive(:file_exists?).and_return(false)
-      end
-
-      it "updates the task status to failed" do
-        expect(DataMigration).to receive(:notify).with("#{migration_name} not found")
-        expect { perform }.not_to raise_error
-      end
-    end
-
-    context "when migration class is not found" do
-      let(:migration_name) { "20241206200112_create_bad_users" }
-
-      it "raises an error" do
-        expect { perform }.to raise_error("Data migration class #{migration_name.gsub(/^[0-9_]+/, "").camelize} not found")
-      end
-    end
-
-    context "when migration class does not implement perform method" do
-      let(:migration_name) { "20241206200113_change_users" }
-
-      it "raises an error" do
-        expect { perform }.to raise_error("Data migration class #{migration_name.gsub(/^[0-9_]+/, "").camelize} must implement `perform` method")
-      end
-    end
-
-    context "when there is an enqueue call" do
-      let(:migration_name) { "20241206200114_create_batch_users" }
-
-      it "runs the migration in foreground" do
-        expect { perform }.to change { User.count }.by(3)
-        expect(task.reload.current_jobs.count).to eq(0)
-        expect(task.status).to eq("completed")
-        expect(User.pluck(:email)).to match_array(["test@example.com", "test_1@example.com", "test_2@example.com"])
-      end
-
-      context "when background is true" do
-        let(:job_kwargs) { { background: true } }
-
-        before do
-          operator
-        end
-
-        it "runs the migration in background" do
-          expect { perform }.to change(User, :count).by(1)
-          expect(task.reload.status).to eq("performing")
-          expect(task.current_jobs.count).to eq(0)
-          expect(task.kwargs).to eq({})
-
-          expect { job.perform(task.id, index: 2, background: true) }.to change(User, :count).by(1)
-          expect(task.reload.status).to eq("performing")
-          expect(task.reload.current_jobs.count).to eq(0)
-          expect(task.kwargs).to eq({})
-
-          expect { job.perform(task.id, index: 3, background: true) }.to change(User, :count).by(0)
-          expect(task.reload.status).to eq("completed")
-          expect(task.reload.current_jobs.count).to eq(0)
-          expect(task.kwargs).to eq({})
-        end
-      end
-    end
-  end
-end

data/spec/data_migration/task_spec.rb

@@ -1,152 +0,0 @@
-require "spec_helper"
-
-describe DataMigration::Task do
-  subject(:task) { DataMigration::Task.create!(name: migration_name) }
-
-  let(:migration_name) { "20241206200111_create_users" }
-  let(:data_migrations_full_path) { File.expand_path("../fixtures/data_migrations", __dir__) }
-
-  before do
-    # allow(Rails).to receive(:root).and_return(rails_root)
-    # allow(Rails).to receive(:logger).and_return(rails_logger)
-    allow(DataMigration.config).to receive(:data_migrations_full_path).and_return(data_migrations_full_path)
-  end
-
-  describe "#file_path" do
-    it "returns the full path to the migration file" do
-      expect(task.file_path).to eq("#{data_migrations_full_path}/#{migration_name}.rb")
-    end
-  end
-
-  describe "#file_exists?" do
-    it "returns true if the file exists" do
-      expect(task.file_exists?).to be(true)
-      expect(task.valid?).to be(true)
-    end
-
-    context "when the file does not exist" do
-      let(:migration_name) { "20241206200111_create_something_else" }
-      let(:task) { DataMigration::Task.new(name: migration_name) }
-
-      it "returns false" do
-        expect(task.file_exists?).to be(false)
-        expect(task.valid?).to be(false)
-      end
-    end
-  end
-
-  describe "#requires_pause?" do
-    before do
-      task.status = :started
-      task.pause_minutes = 10
-    end
-
-    it "returns true if pause_minutes is positive and status is not paused" do
-      expect(task.requires_pause?).to be(true)
-    end
-
-    context "when pause_minutes is 0" do
-      before do
-        task.pause_minutes = 0
-      end
-
-      it "returns false" do
-        expect(task.requires_pause?).to be(false)
-      end
-    end
-
-    context "when status is paused" do
-      before do
-        task.status = :paused
-      end
-
-      it "returns false" do
-        expect(task.requires_pause?).to be(false)
-      end
-    end
-  end
-
-  describe "#perform_now" do
-    it "calls the job class with the task and arguments" do
-      kwargs = { foo: "bar" }
-      expect(DataMigration::Job).to receive(:perform_now).with(task.id, **kwargs)
-      task.perform_now(**kwargs)
-    end
-  end
-
-  describe "#perform_later" do
-    it "calls the job class with the task and arguments" do
-      kwargs = { foo: "bar" }
-      expect(DataMigration::Job).to receive(:perform_later).with(task.id, **kwargs)
-      task.perform_later(**kwargs)
-    end
-  end
-
-  describe "#prepare" do
-    subject(:task) { DataMigration::Task.prepare(migration_name, pause_minutes: 10, jobs_limit: 5) }
-
-    it "creates a new task with the given name, pause, and jobs_limit" do
-      expect { task }.to change(DataMigration::Task, :count).by(1)
-      expect(task.name).to eq(migration_name)
-      expect(task.status).to be_nil
-      expect(task.pause_minutes).to eq(10)
-      expect(task.jobs_limit).to eq(5)
-    end
-
-    context "when chained with perform_now" do
-      it "calls the job class with the task and arguments" do
-        perform_args = { "foo" => "bar" }
-        expect(DataMigration::Job).to receive(:perform_now).with(task.id, **perform_args)
-        task.perform_now(**perform_args)
-        expect(task.kwargs).to eq(perform_args)
-      end
-    end
-  end
-
-  describe "#job_check_in!" do
-    subject(:job_check_in!) { task.job_check_in!(job_id, job_args: ["foo"], job_kwargs: { bar: "baz" }) }
-
-    let(:job_id) { "123" }
-
-    it "adds the job to the current_jobs hash" do
-      expect { job_check_in! }.to change { task.current_jobs.size }.by(1)
-    end
-
-    context "when there is a job with the same id" do
-      before do
-        task.job_check_in!(job_id, job_args: ["foo"], job_kwargs: { bar: "baz" })
-      end
-
-      it "raises a JobConflictError" do
-        expect { job_check_in! }.to raise_error(DataMigration::JobConflictError)
-      end
-    end
-
-    context "when default_jobs_limit is 1 and there are jobs" do
-      before do
-        DataMigration.config.default_jobs_limit = 1
-        task.job_check_in!("321", job_args: ["foo"], job_kwargs: { bar: "baz" })
-      end
-
-      it "raises a JobConcurrencyLimitError" do
-        expect { job_check_in! }.to raise_error(DataMigration::JobConcurrencyLimitError)
-      end
-    end
-  end
-
-  describe "#job_check_out!" do
-    subject(:job_check_out!) { task.job_check_out!(job_id) }
-
-    let(:job_id) { "123" }
-
-    before do
-      task.save!
-      task.job_check_in!(job_id, job_args: ["foo"], job_kwargs: { bar: "baz" })
-    end
-
-    it "removes the job from the current_jobs hash" do
-      expect { job_check_out! }.to change { task.current_jobs.size }.by(-1)
-      expect(task.current_jobs).not_to have_key(job_id)
-    end
-  end
-end

data/spec/data_migration_spec.rb

@@ -1,65 +0,0 @@
-require "spec_helper"
-
-describe DataMigration do
-  let(:gem_specification) { Gem::Specification.load(File.expand_path("../../data-migration.gemspec", __FILE__)) }
-
-  it "has a version number" do
-    expect(described_class::VERSION).to eq gem_specification.version.to_s
-  end
-
-  let(:changelog_file) { File.expand_path("../../CHANGELOG.md", __FILE__) }
-  it "has changelog for the version" do
-    expect(File.exist?(changelog_file)).to be true
-    expect(File.read(changelog_file)).to include("# #{gem_specification.version}")
-  end
-
-  let(:license_file) { File.expand_path("../../LICENSE.md", __FILE__) }
-  it "has license" do
-    expect(File.exist?(license_file)).to be true
-  end
-
-  let(:readme_file) { File.expand_path("../../README.md", __FILE__) }
-  it "has readme" do
-    expect(File.exist?(readme_file)).to be true
-  end
-
-  describe ".notify" do
-    subject(:notify) { DataMigration.notify("test") }
-    let(:action_reporter) { Class.new }
-    before do
-      stub_const("ActionReporter", action_reporter)
-    end
-
-    it "sends message to ActionReporter" do
-      expect(action_reporter).to receive(:notify).with("test", context: {})
-      expect { notify }.not_to raise_error
-    end
-  end
-
-  describe ".perform_now" do
-    subject(:perform_now) { DataMigration.perform_now("test_perform_now") }
-
-    it "delegates to DataMigration::Task.perform_now" do
-      expect(DataMigration::Task).to receive(:perform_now).with("test_perform_now")
-      expect { perform_now }.not_to raise_error
-    end
-  end
-
-  describe ".perform_later" do
-    subject(:perform_later) { DataMigration.perform_later("test_perform_later") }
-
-    it "delegates to DataMigration::Task.perform_later" do
-      expect(DataMigration::Task).to receive(:perform_later).with("test_perform_later")
-      expect { perform_later }.not_to raise_error
-    end
-  end
-
-  describe ".prepare" do
-    subject(:prepare) { DataMigration.prepare("test_prepare") }
-
-    it "delegates to DataMigration::Task.prepare" do
-      expect(DataMigration::Task).to receive(:prepare).with("test_prepare")
-      expect { prepare }.not_to raise_error
-    end
-  end
-end

data/spec/fixtures/data_migrations/20241206200111_create_users.rb

@@ -1,17 +0,0 @@
-class CreateUsers
-  def perform(**kwargs)
-    User.find_or_create_by(email: "test@example.com")
-  end
-end
-
-if ENV["RUN_MIGRATION_TESTS"] && Object.const_defined?(:RSpec)
-  require "rails_helper"
-
-  RSpec.describe CreateUsers, type: :data_migration do
-    subject(:perform) { described_class.new.perform }
-
-    it do
-      expect { perform }.not_to raise_error
-    end
-  end
-end