activerecord-snapshot 0.8.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df0b6d4cfd32a2749f92fa402eb4bcf3c11cadd7639eed131e4aa303339e2a6c
-  data.tar.gz: 52a7c83917b568d262fb50fd16c84815605eb7046ae3faa89cf3694343f6155d
+  metadata.gz: 2ea1b2759aa89b7300c4825dc19821b7df75a78b78911ec1ec3fd774db83ed41
+  data.tar.gz: a8a99a1053eb103fccc48bdcd70b71fbf996f394e2de5b539248bd98cdf2f4da
 SHA512:
-  metadata.gz: 42c7599a1f7addc4f89f1cbf32243fdec12a25f070c6ab66e38a829fa4259d29c510aafcf03355bf6d53a43690e36bc57a52b619b1e1ebec22d87c07c346fe9b
-  data.tar.gz: 8532fbb8a3356726abae122e0f02dc26bd8c0b3c68cfff9c29d59598cbc94b6956e7cbdf2c714ebde2262c40a88678199f8f6982a0ae233bfdf2d5556837d269
+  metadata.gz: baa534c7a96404980ec584f38516a8ba5061fafef1a0dd8a83ee56c95af9eda37226211f1912a8e5782e40c47251f803b8f6106feee36b04e00ff90e04c033b5
+  data.tar.gz: 628bedd84b304a6ea652000f2107bb12b33bc20ede5ab90c13e403bac5f24ecb0e22599c4e0e22cff29fe8082f557dd3ae4d3536da93ee65c201ee84ac4f5e1f

data/README.md

@@ -100,7 +100,8 @@ Creates a named snapshot: `[name].sql.bz2.enc` which is stored at
 ##### `db:snapshot:import`
 
 When used without arguments, it imports the latest regular snapshot from S3,
-then drops and replaces the local database.
+then imports all the tables listed in the config file. Each table imported is
+first dropped and then rebuilt from the snapshot.
 
 Can be given arguments for the version:
 
@@ -112,6 +113,16 @@ Can be given arguments for the version:
 Imports _only_ the tables given as arguments (`foo` and `bar` in this example)
 from the latest regular snapshot
 
+##### `db:snapshot:import:destructive`
+
+When used without arguments, it imports the latest regular snapshot from S3,
+then drops and replaces the local database.
+
+Can be given arguments for the version:
+
+`db:snapshot:import[12]` gets you the 12th regular snapshot
+`db:snapshot:import['foo']` gets you your snapshot named `foo`
+
 ##### `db:snapshot:reload`
 
 Reloads the current snapshot

data/Rakefile

@@ -1,33 +1,10 @@
-begin
-  require 'bundler/setup'
-rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
-end
-
-require 'rdoc/task'
-
-RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'ActiveRecord::Snapshot'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.md')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
-
-
-
-
-
-require 'bundler/gem_tasks'
-
-require 'rake/testtask'
+require "bundler/gem_tasks"
+require "rake/testtask"
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = false
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
 end
 
-
-task default: :test
+task :default => :test

data/lib/active_record/snapshot/actions/create.rb

@@ -3,8 +3,8 @@ require "active_record/snapshot/utils/logger"
 module ActiveRecord
   module Snapshot
     class Create
-      def self.call(*args)
-        new(*args).call
+      def self.call(**args)
+        new(**args).call
       end
 
       def initialize(name: nil)

data/lib/active_record/snapshot/actions/import.rb

@@ -1,11 +1,11 @@
 module ActiveRecord
   module Snapshot
     class Import
-      def self.call(*args)
-        new(*args).call
+      def self.call(**args)
+        new(**args).call
       end
 
-      def initialize(version: nil, tables: [])
+      def initialize(version: nil, tables: [], reset: false)
         @version = version
         if named_version?
           name = version
@@ -14,6 +14,7 @@ module ActiveRecord
         end
         @snapshot = Snapshot.new(name)
         @tables = tables
+        @reset = reset
       end
 
       def call
@@ -22,12 +23,18 @@ module ActiveRecord
 
       private
 
-      attr_reader :snapshot, :tables, :version
+      attr_reader :reset, :snapshot, :version
 
       def config
         ActiveRecord::Snapshot.config
       end
 
+      def tables
+        return [] if reset?
+        return @tables if @tables.compact.length > 0
+        config.tables
+      end
+
       def named_version?
         !version.blank? && version.to_i.to_s != version.to_s
       end
@@ -44,7 +51,7 @@ module ActiveRecord
           steps[:decompress] = "Decompress snapshot to #{snapshot.dump}"
         end
 
-        if tables.empty?
+        if reset?
           steps[:reset_database] = "Reset database"
         else
           steps[:filter_tables] = "Filter tables"
@@ -53,10 +60,31 @@ module ActiveRecord
         steps[:import] = "Importing the snapshot into #{config.db.database}"
         steps[:save] = "Caching the new snapshot version" unless named_version? || tables.present?
         steps[:set_env] = "Setting database environment to #{Rails.env}" if Rails::VERSION::MAJOR >= 5
+        steps[:run_tasks] = "Running post-import rake tasks" if post_import_tasks.present?
 
         steps
       end
 
+      def reset?
+        !!reset
+      end
+
+      def post_import_tasks
+        @post_import_tasks ||=
+          ActiveRecord::Snapshot.config.post_import_tasks
+      end
+
+      def run_tasks
+        post_import_tasks.each do |task_name|
+          if Rake::Task.task_defined?(task_name)
+            puts "Running: #{task_name}"
+            Rake::Task[task_name].invoke
+          else
+            puts "Warning: could not find task with name #{task_name}"
+          end
+        end
+      end
+
       def download
         snapshot.download
       end
@@ -75,6 +103,7 @@ module ActiveRecord
       def reset_database
         Rake::Task["db:drop"].invoke
         Rake::Task["db:create"].invoke
+        Rake::Task["db:schema:load"].invoke
       end
 
       def filter_tables

data/lib/active_record/snapshot/commands/filter_tables.rb

@@ -1,8 +1,8 @@
 module ActiveRecord
   module Snapshot
     class FilterTables
-      def self.call(*args)
-        new(*args).call
+      def self.call(**args)
+        new(**args).call
       end
 
       def initialize(tables:, sql_dump:)

data/lib/active_record/snapshot/commands/mysql.rb

@@ -3,19 +3,21 @@ require 'shellwords'
 module ActiveRecord
   module Snapshot
     class MySQL
-      def self.dump(*args)
-        new.dump(*args)
+      def self.dump(**args)
+        new.dump(**args)
       end
 
       def dump(tables:, output:)
-        # the --no-tablespaces and --single-transaction flags are necessary to dump a db
+        # the --no-tablespaces flag are necessary to dump a db
         # containing SQL view queries and tablespace metadata
-        dump_command("--no-data --single-transaction --no-tablespaces --set-gtid-purged=OFF #{database} > #{output}") &&
-          dump_command("--quick --single-transaction --no-tablespaces --set-gtid-purged=OFF #{database} #{tables.join(" ")} >> #{output}")
+        dump_command("--no-data --single-transaction --no-tablespaces #{build_ignore_flags} #{database} > #{output}") &&
+          dump_command(
+            "--quick --single-transaction --no-tablespaces #{build_ignore_flags} #{database} #{tables.join(' ')} >> #{output}"
+          )
       end
 
-      def self.import(*args)
-        new.import(*args)
+      def self.import(**args)
+        new.import(**args)
       end
 
       def import(input:)
@@ -34,6 +36,13 @@ module ActiveRecord
         ActiveRecord::Snapshot.config.db
       end
 
+      def build_ignore_flags
+        ActiveRecord::Snapshot
+          .config
+          .ignore_tables
+          &.reduce('') { |str, table| str + "--ignore-table=#{database}.#{table} " }
+      end
+
       def escape(value)
         Shellwords.escape(value)
       end

data/lib/active_record/snapshot/configuration.rb

@@ -57,7 +57,9 @@ module ActiveRecord
       property :s3, required: true, coerce: S3Config
       property :ssl_key, required: true
       property :tables, required: true
+      property :ignore_tables
       property :store, coerce: StoreConfig
+      property :post_import_tasks
 
       def db
         DBConfig.new(env)

data/lib/active_record/snapshot/version.rb

@@ -1,5 +1,5 @@
 module ActiveRecord
   module Snapshot
-    VERSION = '0.8.0'
+    VERSION = '1.0.0'
   end
 end

data/lib/tasks/active_record/snapshot_tasks.rake

@@ -42,6 +42,32 @@ namespace :db do
         tables = args[:tables].split(/[, ;'"]+/).reject(&:blank?)
         ActiveRecord::Snapshot::Import.call(tables: tables)
       end
+
+      desc "Import only specific tables from a named snapshot"
+      task :named_only, [:snapshot_name, :tables] => :load do |_t, args|
+        abort "Do not run in production mode!" if Rails.env.production?
+
+        snapshot_name = args.fetch(:snapshot_name, "").strip
+        tables_arg = args.fetch(:tables, "").strip
+
+        if snapshot_name.blank?
+          abort "Usage: bundle exec rake db:snapshot:import:named_only['snapshot_name','table1 table2']"
+        end
+
+        if tables_arg.blank?
+          abort "Usage: bundle exec rake db:snapshot:import:named_only['snapshot_name','table1 table2']"
+        end
+
+        tables = tables_arg.split(/[, ;'"]+/).reject(&:blank?)
+        ActiveRecord::Snapshot::Import.call(version: snapshot_name, tables: tables)
+      end
+
+      desc "Destructive import of the most recent snapshot"
+      task :destructive, [:version] => [:load] do |_t, args|
+        abort "Do not run in production mode!" if Rails.env.production?
+        version = args.fetch(:version, "").strip
+        ActiveRecord::Snapshot::Import.call(version: version, reset: true)
+      end
     end
 
     desc "Reload current snapshot version"

metadata

@@ -1,14 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-snapshot
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Bernardo Farah
-autorequire: 
+- Nathan Seither
+- Sean Mulligan
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-08 00:00:00.000000000 Z
+date: 2026-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -17,9 +19,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.1.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -27,9 +26,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.1.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: fog-aws
   requirement: !ruby/object:Gem::Requirement
@@ -82,32 +78,116 @@ dependencies:
   name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.3
+        version: 6.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.3
+        version: 6.0.1
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: mutex_m
+  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: simplecov
+  name: bigdecimal
+  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: drb
+  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: ostruct
+  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: cgi
+  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: benchmark
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -122,7 +202,7 @@ dependencies:
         version: '0'
 description: Snapshots for ActiveRecord
 email:
-- ber@bernardo.me
+- eng-admin@coverhound.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -158,7 +238,7 @@ homepage: https://github.com/coverhound/active-record-snapshot
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -166,15 +246,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
-signing_key: 
+rubygems_version: 3.4.19
+signing_key:
 specification_version: 4
 summary: Snapshots for ActiveRecord
 test_files: []