avm 0.73.1 → 0.74.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7982b293a654555c267bc2f3b8856a40e4e60a5ee2a9bcc08796d4814a811c15
-  data.tar.gz: 6a8ade3bc981708360d1cecdb7e9ee1461d0fad4ff3daa0ae7de1f6636e99e9d
+  metadata.gz: 69fd41323b3ec2e08b3339520c7ac89b6a0a1f8504f662033e68f9a5f8d43eed
+  data.tar.gz: 32aa288f19bcfc07f494479e1c1fe04c660d77fdc3435e63c81ff9beb1ea97b2
 SHA512:
-  metadata.gz: 32e5a58c320316929d9d954b98a284f40e4231af15b848513cdfcfc91364ad20362b95c05af1fe6c3f4822fc786a981129c8d3878d55104189f2d7af91c442f9
-  data.tar.gz: de0f2e9f63d6bd9e3aac64f36ef505f028494462e6e734b42efc1c88be62bb77041e3c2a8ff31a92293884e4d3e73872a9c95e219fc7e3909d6308de124563cc
+  metadata.gz: 9fac0d42acc16cc1cf70b6c5331c20171356354400de3473aa5341d8b2c01d7b6c6ea168778359d50a867e6637678b5ad85f0f8ccc7aa5ff44f5c126728576a1
+  data.tar.gz: 36ae852382bacaeb8918cb351d3e9a7bff8db59476bd8ca3fa1ec88fcb20dbcad5546027b5b49a5789387017d59b1cc7b0d40fedb0c20c20f2234a0a3a28cf25

data/lib/avm/data/dumper.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+require 'avm/data/performer'
+require 'avm/data/rotate'
+require 'eac_ruby_utils/core_ext'
+require 'eac_ruby_utils/fs/temp'
+
+module Avm
+  module Data
+    class Dumper < ::Avm::Data::Performer
+      DEFAULT_EXPIRE_TIME = 1.day
+
+      enable_speaker
+      enable_listable
+      lists.add_symbol :existing, :denied, :overwrite, :rotate, :rotate_expired
+      immutable_accessor :existing, :expire_time, :target_path
+
+      # @return [String, nil]
+      def cannot_perform_reason
+        return nil if !target_path.exist? ||
+                      [EXISTING_OVERWRITE, EXISTING_ROTATE].include?(existing)
+
+        if existing == EXISTING_DENIED
+          'Data exist and overwriting is denied'
+        elsif existing == EXISTING_ROTATE_EXPIRED && !target_path_expired?
+          'Data exist and yet is not expired'
+        end
+      end
+
+      # @return [Pathname]
+      def default_dump_path
+        r = data_owner.data_default_dump_path
+        include_excludes_path_suffix.if_present(r) do |v|
+          r.basename_sub('.*') { |b| "#{b}#{v}#{r.extname}" }
+        end
+      end
+
+      # @return [Boolean]
+      def target_path_expired?
+        target_path_time.if_present(false) { |v| v >= expire_time }
+      end
+
+      # @return [ActiveSupport::Duration, nil]
+      def target_path_time
+        target_path.exist? ? ::Time.now - ::File.mtime(target_path) : nil
+      end
+
+      protected
+
+      attr_reader :temp_data_path
+
+      # @return [Array<Symbol>]
+      def all_units
+        data_owner.units.keys.sort
+      end
+
+      def build_temp_data_file
+        data_owner.dump(temp_data_path, *include_excludes_arguments)
+        raise "\"#{temp_data_path}\" do not exist" unless temp_data_path.exist?
+        raise "\"#{temp_data_path}\" is not a file" unless temp_data_path.file?
+      end
+
+      # @return [Array<Symbol>]
+      def excluded_units
+        excludes.map(&:to_sym).sort
+      end
+
+      # @return [Symbol, nil]
+      def existing_set_filter(value)
+        value.nil? ? nil : self.class.lists.existing.value_validate!(value)
+      end
+
+      # @return [ActiveSupport::Duration]
+      def expire_time_get_filter(value)
+        value || DEFAULT_EXPIRE_TIME
+      end
+
+      # @return [String]
+      def include_excludes_path_suffix
+        return nil unless data_owner.respond_to?(:units)
+
+        r = included_units.any? ? included_units : all_units
+        r -= excluded_units if excluded_units.any?
+        r.any? && r != all_units ? "_#{r.join('-')}" : ''
+      end
+
+      # @return [Array<Symbol>]
+      def included_units
+        includes.map(&:to_sym).sort
+      end
+
+      # @return [self]
+      def internal_perform
+        on_temp_data_file do
+          build_temp_data_file
+          rotate
+          move_data_to_target_path
+        end
+      end
+
+      def move_data_to_target_path
+        ::FileUtils.mv(temp_data_path, target_path.assert_parent)
+      end
+
+      def on_temp_data_file
+        ::EacRubyUtils::Fs::Temp.on_file do |file|
+          @temp_data_path = file.to_pathname
+          yield
+        end
+      end
+
+      # @return [String, nil]
+      def rotate
+        return unless target_path.exist?
+        return unless existing == EXISTING_ROTATE
+
+        infom "Rotating \"#{target_path}\"..."
+        ::Avm::Data::Rotate.new(target_path).run
+      end
+
+      # @return [Pathname]
+      def target_path_get_filter(value)
+        (value || default_dump_path).to_pathname
+      end
+    end
+  end
+end

data/lib/avm/data/package/dump.rb

@@ -1,109 +1,43 @@
 # frozen_string_literal: true
 
+require 'avm/data/package/base_performer'
 require 'avm/data/package/build_directory'
-require 'avm/data/rotate'
 require 'eac_ruby_utils/core_ext'
 require 'minitar'
 
 module Avm
   module Data
     class Package
-      class Dump
-        enable_speaker
-        enable_listable
+      class Dump < ::Avm::Data::Package::BasePerformer
+        enable_method_class
         include ::Avm::Data::Package::BuildDirectory
 
-        DEFAULT_EXPIRE_TIME = 1.day
+        attr_reader :target_path
 
-        attr_reader :package, :data_file_path, :existing
-
-        lists.add_string :existing, :denied, :overwrite, :rotate, :rotate_expired
-
-        def initialize(package, data_file_path, options = {})
-          @package = package
-          @data_file_path = data_file_path
-          options = options.to_options_consumer
-          @existing, @expire_time = options.consume(:existing, :expire_time)
-          options.validate
-          self.class.lists.existing.value_validate!(@existing)
-        end
-
-        def runnable?
-          cannot_run_reason.blank?
-        end
-
-        def cannot_run_reason
-          return nil if !data_file_exist? ||
-                        [EXISTING_OVERWRITE, EXISTING_ROTATE].include?(existing)
-
-          if existing == EXISTING_DENIED
-            'Data exist and overwriting is denied'
-          elsif existing == EXISTING_ROTATE_EXPIRED && !data_file_expired?
-            'Data exist and yet is not expired'
-          end
+        def initialize(package, target_path, options = {})
+          super(package, options)
+          @target_path = target_path.to_pathname
         end
 
-        def run
-          raise "Cannot run: #{cannot_run_reason}" unless runnable?
-
-          package_file = on_build_directory do
+        # @return [void]
+        def result
+          on_build_directory do
             dump_units_to_build_directory
             create_package_file
           end
-          rotate
-          move_download_to_final_dest(package_file)
-        end
-
-        def data_file_exist?
-          ::File.exist?(data_file_path)
-        end
-
-        def data_file_time
-          data_file_exist? ? ::Time.now - ::File.mtime(data_file_path) : nil
-        end
-
-        def data_file_expired?
-          data_file_time.if_present(false) { |v| v >= expire_time }
-        end
-
-        def expire_time
-          @expire_time || DEFAULT_EXPIRE_TIME
-        end
-
-        private
-
-        def move_download_to_final_dest(download_path)
-          ::FileUtils.mkdir_p(::File.dirname(data_file_path))
-          ::FileUtils.mv(download_path, data_file_path)
-        end
-
-        def rotate
-          return unless data_file_exist?
-          return unless existing == EXISTING_ROTATE
-
-          infom "Rotating \"#{data_file_path}\"..."
-          ::Avm::Data::Rotate.new(data_file_path).run
         end
 
-        def new_build_path
-          f = ::Tempfile.new(self.class.name.parameterize + '-download')
-          path = f.path
-          f.close
-          f.unlink
-          path
-        end
+        protected
 
         def dump_units_to_build_directory
-          package.dump_units_to_directory(build_directory)
+          package.dump_units_to_directory(build_directory, selected_units)
         end
 
         def create_package_file
-          package_path = new_build_path
-          infom "Creating package \"#{package_path}\" from \"#{build_directory}\"..."
+          infom "Creating package \"#{target_path}\" from \"#{build_directory}\"..."
           ::Dir.chdir(build_directory.to_path) do
-            ::Minitar.pack('.', File.open(::File.expand_path(package_path), 'wb'))
+            ::Minitar.pack('.', ::File.open(target_path, 'wb'))
           end
-          package_path
         end
       end
     end

data/lib/avm/data/package.rb

@@ -32,17 +32,15 @@ module Avm
         DATA_FILE_EXTENSION
       end
 
-      def dump(data_path, options = {})
-        ::Avm::Data::Package::Dump.new(self, data_path, options)
-      end
-
       def load(data_path)
         ::Avm::Data::Package::Load.new(self, data_path)
       end
 
-      def dump_units_to_directory(directory)
+      def dump_units_to_directory(directory, selected_units = nil)
         run_callbacks :dump do
-          units.each { |identifier, unit| unit.dump_to_directory(directory, identifier) }
+          (selected_units || units).each do |identifier, unit|
+            unit.dump_to_directory(directory, identifier)
+          end
         end
       end
 

data/lib/avm/instances/data/package.rb

@@ -12,6 +12,11 @@ module Avm
           @instance = instance
           super options
         end
+
+        # @return [Pathname]
+        def data_default_dump_path
+          instance.data_default_dump_path.to_pathname
+        end
       end
     end
   end

data/lib/avm/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Avm
-  VERSION = '0.73.1'
+  VERSION = '0.74.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: avm
 version: !ruby/object:Gem::Version
-  version: 0.73.1
+  version: 0.74.0
 platform: ruby
 authors:
 - Eduardo H. Bogoni
@@ -233,6 +233,7 @@ files:
 - lib/avm/applications/base/stereotype.rb
 - lib/avm/data/callbacks.rb
 - lib/avm/data/clearer.rb
+- lib/avm/data/dumper.rb
 - lib/avm/data/package.rb
 - lib/avm/data/package/base_performer.rb
 - lib/avm/data/package/build_directory.rb