snapshot_archive 0.7.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23bf48f76c366c97e8af2b6a56bdece2729eadd670f02363afd16ead08647053
-  data.tar.gz: a091e5e222475f510b419c2ed78f13f074a2f3196f722a6a394e7afa9d71ff71
+  metadata.gz: 5e7e55a13d956b69746a56a472a0bb5bf0fca87c8455622ba0486d081b84981a
+  data.tar.gz: 0cb06eb238ad6d518515847751f7c1dfdb98d0f234c47ab10c798ff7c828a5de
 SHA512:
-  metadata.gz: 27db023b81db187306af4b09c6dc381a4a6d219f20a4b05e95ebf12ba2099872d977d03d0f9de6cc40827498cf755b5c77d222954246abaf53f0e3800d3bd324
-  data.tar.gz: 21ae0dae28c890d1d9d12b33ddceff78ba5f7d79139f95652b025f6c1df21a495c0c992b68a4b1f340099a893d3a0359603d624f01167372fe5e53d9e92a4f77
+  metadata.gz: 13abb74a373a7d31f81704872a7e6d5ab312de98dff229333fbd2ccebb220c5c56a46ec5bbfe0a0035ee496ea75a2d34942f357a5dd5469f8b4cd6c8cc5415cf
+  data.tar.gz: fae50ea54d90d52261a5959cf964b4e1849d0564401c06fff92075288b8cb02a53668179afc9689e70cf8aa9cedde1c1f244f119aa4ded59241d07ab398dee34

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    snapshot_archive (0.5.0)
+    snapshot_archive (0.7.0)
       commander (~> 4.5)
 
 GEM
@@ -33,6 +33,7 @@ GEM
     unicode-display_width (2.1.0)
 
 PLATFORMS
+  aarch64-linux
   x86_64-darwin-19
   x86_64-darwin-20
 

data/README.md

@@ -6,7 +6,7 @@ snapshot and restore it later! Build your own snapshotting behavior in a
 configuration file so that you can snapshot any stateful service you use during
 development.
 
-By default will make mysql backups for any development databases for the rails 
+By default will make mysql backups for any development databases for the rails
 app in your CWD.
 
 ## Installation
@@ -113,6 +113,17 @@ SnapshotArchive.configure do |config|
   #  restore: accepts the metadata JSON data created when making the backup. No
   #    return value.
   #
+  # Stores can optionally define:
+  #
+  #  delete: accepts the metadata JSON data created when making the backup. No
+  #    return value. Invoked when the snapshot is deleted. If your backup method
+  #    stores all of its data inside the snapshot directory, then no delete
+  #    method is needed because the snapshot directory will be deleted. However,
+  #    if your backup stores data in a different directory, then this hook can
+  #    be used to cleanup that data. Eg, your method might write some data to
+  #    an external or synced directory. In that case, you probably want to save
+  #    the path to the file in the metadata, and try to delete it in this hook.
+  #
   # Stores can either be defined as objects/classes/modules or a builtin store
   # builder can be used.
 
@@ -155,5 +166,8 @@ SnapshotArchive.configure do |config|
   #   snap backup mysql:db_1,db_2
 
   config.register_store("my_backup", "mysql:db_1,db_2")
+
+  # You can also alias an array of stores:
+  config.register_store("my_backup_2", ["mysql:db_1,db_2", "other_stuff"])
 end
 ```

data/exe/snap

@@ -64,7 +64,11 @@ module SnapshotArchive
 
           stores = (
             if args.count > 0
-              args.map { |arg| SnapshotArchive::Cfg.parse_store(arg) }.to_h
+              args
+                .map { |arg| SnapshotArchive::Cfg.resolve_alias(arg) }
+                .flatten
+                .map { |arg| SnapshotArchive::Cfg.parse_store(arg) }
+                .to_h
             else
               SnapshotArchive::Cfg.stores
             end

data/lib/snapshot_archive/archives.rb

@@ -42,6 +42,27 @@ module SnapshotArchive
       end
     end
 
+    class Delete
+      def self.call(metadata)
+        new(metadata).call
+      end
+
+      attr_reader :metadata
+      def initialize(metadata)
+        @metadata = metadata
+      end
+
+      def call
+        metadata.fetch("stores").each do |store_metadata|
+          store = Cfg.instance.store(store_metadata.fetch("type"))
+          if store.respond_to?(:delete)
+            store.delete(store_metadata)
+          end
+        end
+      end
+    end
+
+
     class Presenter
       def self.call(metadata)
         new(metadata).call

data/lib/snapshot_archive/cfg.rb

@@ -4,17 +4,22 @@ require "snapshot_archive/repositories"
 module SnapshotArchive
   class StoreBuilder
     class CustomStore
-      def initialize(backup:, restore:)
+      def initialize(backup:, restore:, delete:)
         @backup = backup
         @restore = restore
+        @delete = delete
       end
 
       def backup(dir)
-        @backup.call(dir)
+        @backup&.call(dir)
       end
 
       def restore(metadata)
-        @restore.call(metadata)
+        @restore&.call(metadata)
+      end
+
+      def delete(metadata)
+        @delete&.call(metadata)
       end
     end
 
@@ -26,8 +31,12 @@ module SnapshotArchive
       @restore = block
     end
 
+    def delete(&block)
+      @delete = block
+    end
+
     def to_store
-      CustomStore.new(backup: @backup, restore: @restore)
+      CustomStore.new(backup: @backup, restore: @restore, delete: @delete)
     end
   end
 
@@ -40,6 +49,7 @@ module SnapshotArchive
       [
         :bind_backup,
         :load,
+        :resolve_alias,
         :parse_store,
         :pwd,
         :repository,
@@ -65,6 +75,14 @@ module SnapshotArchive
       Kernel.load(config_path) if File.exist?(config_path)
     end
 
+    def resolve_alias(name)
+      if store_registry[name].is_a?(Array)
+        store_registry[name]
+      else
+        name
+      end
+    end
+
     def register_store(name, klass_or_alias=nil, active_by_default: true, &block)
       store = (
         if klass_or_alias.is_a?(String)

data/lib/snapshot_archive/repositories.rb

@@ -66,10 +66,13 @@ module SnapshotArchive
       end
 
       def delete(id)
-        dir = File.join(path, id)
+        metadata = JSON.parse(File.read(File.join(path, id, "metadata.json")))
+        raise ArgumentError.new("unknown snapshot: #{id}") unless File.exist?(metadata)
 
-        raise ArgumentError.new("unknown snapshot: #{id}") unless File.exist?(dir)
+        Cfg.shell.info("Running delete hooks: #{id}")
+        Archives::Delete.call(metadata.dig("archive"))
 
+        Cfg.shell.info("Removing snapshot: #{id}")
         FileUtils.rm_rf(dir)
         Cfg.shell.info("Removed snapshot: #{id}")
       end

data/lib/snapshot_archive/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SnapshotArchive
-  VERSION = "0.7.0"
+  VERSION = "0.9.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: snapshot_archive
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Pete Kinnecom