file_pipeline 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 626e9aa686a528bc8bbcf08ba8a238cdfbae8d8b56918654cded4156964f831e
-  data.tar.gz: ffa0eeb52c3af6789362d0886b6f90c1ae03e647f9a94e7323bfe8b9ae71149b
+  metadata.gz: 2669b6e193cbdf383b4db7bf1fe9e16a4519cefb152b394e34310ea9690d4ed6
+  data.tar.gz: 5c07a106071954420545dfec51b1110f71027614384e77d553f4132322848faa
 SHA512:
-  metadata.gz: 577eeca6ca8df866f7521a534219290c3827208d28909c5b2cf1bab4f9dcaa33a5ac4cdd64860365eb4f49105208e95ce73951c24677b1f36563b3b9c8ef98d5
-  data.tar.gz: a5ce5a25f0be6ee92f2afde5a7b37d52de0ede4063be0b0c1cbb919ba1a3a0bf81b2cdb05dfcde50f875ba9d16afa79865cbc3f69b552df72cf2d73207a324df
+  metadata.gz: b193249acfb972b2a0bc167728a2147d9e7c39e4469a4f3808ed9ff23b3db0cdbfa06000e3477a83058918a31174bad854821a95287abfb964965e6db02421d4
+  data.tar.gz: 265d513deaf12846e01c767c71a63c481bb0f21a8bc81d7b00e7ba2ea2291afb0c3d99cd9c3830fd37715772a8c807e3455fdfb3c4f14d558e5df5cc9ba52183

data/lib/file_pipeline.rb

@@ -33,7 +33,7 @@ module FilePipeline
   def self.load(file_operation)
     const = file_operation.split('_').map(&:capitalize).join
     FilePipeline.load_file(file_operation) unless const_defined? const
-    const_get 'FileOperations::' + const
+    const_get "FileOperations::#{const}"
   rescue NameError
     # TODO: implement autogenerating module names from file_operation src path
     const_get const

data/lib/file_pipeline/errors.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative 'errors/failed_modification_error'
+require_relative 'errors/misplaced_version_file_error'
 require_relative 'errors/missing_version_file_error'
 require_relative 'errors/source_directory_error'
 require_relative 'errors/source_file_error'

data/lib/file_pipeline/errors/failed_modification_error.rb

@@ -41,9 +41,9 @@ module FilePipeline
       # Appends the backtrace of the error that caused the exception to the
       # #default_message.
       def append_backtrace(str)
-        return str + "\n" unless original_backtrace
+        return "#{str}\n" unless original_backtrace
 
-        str + " Backtrace:\n#{original_backtrace}"
+        "#{str} Backtrace:\n#{original_backtrace}"
       end
 
       # Appends the message of the error that caused the exception to the
@@ -58,7 +58,7 @@ module FilePipeline
 
       # Returns a String with the #message for +self+.
       def default_message
-        if info&.respond_to?(:operation) && info&.respond_to?(:log)
+        if info.respond_to?(:operation) && info.respond_to?(:log)
           msg = "#{info.operation&.name} with options"\
             " #{info.operation&.options} failed on #{@file}."
           append_error msg

data/lib/file_pipeline/errors/misplaced_version_file_error.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module FilePipeline
+  module Errors
+    # Error class for exceptions that are raised when a new version is added,
+    # but the file is not in the VersionedFile's working directory.
+    class MisplacedVersionFileError < StandardError
+      # Path for of the misplaced file for the version.
+      attr_reader :file
+
+      # Path for the directory where the file should have been (the
+      # VersionedFile's working directory).
+      attr_reader :directory
+
+      def initialize(msg = nil, file: nil, directory: nil)
+        @file = file
+        @directory = directory
+        msg ||= default_message
+        super msg
+      end
+
+      private
+
+      def default_message
+        "File #{File.basename @file} was expected in #{@directory},"\
+        " but was in #{File.dirname @file}."
+      end
+    end
+  end
+end

data/lib/file_pipeline/file_operations/exif_manipulable.rb

@@ -24,7 +24,7 @@ module FilePipeline
       end
 
       def self.strip_path(str) # :nodoc:
-        str.sub(%r{ - \/?(\/|[-:.]+|\w+)+\.\w+$}, '')
+        str.sub(%r{ - /?(/|[-:.]+|\w+)+\.\w+$}, '')
       end
 
       # Redacts (deletes) all <tt>tags_to_delete</tt> in <tt>out_file</tt>.

data/lib/file_pipeline/pipeline.rb

@@ -41,10 +41,7 @@ module FilePipeline
     # Adds a file operation object #file_operations. The object must implement
     # a _run_ method (see FileOperations::FileOperation#run for details).
     def <<(file_operation_instance)
-      unless file_operation_instance.respond_to? :run
-        raise TypeError, 'File operations must implement a #run method'
-      end
-
+      validate file_operation_instance
       @file_operations << file_operation_instance
     end
 
@@ -106,5 +103,15 @@ module FilePipeline
         operation.run version, directory, original
       end
     end
+
+    private
+
+    # Raises TypeError if <tt>file_operation_instance</tt> does not implement a
+    # #run method.
+    def validate(file_operation_instance)
+      return file_operation_instance if file_operation_instance.respond_to? :run
+
+      raise TypeError, 'File operations must implement a #run method'
+    end
   end
 end

data/lib/file_pipeline/versioned_file.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative 'versions/validator'
 module FilePipeline
   # VersionedFile creates a directory where it stores any versions of _file_.
   class VersionedFile
@@ -81,14 +82,10 @@ module FilePipeline
     # <tt>version_info</tt> must be a path to an existing file or an array with
     # the path and optionally a FileOperations::Results instance:
     # <tt>['path/to/file', results_object]</tt>.
-    # Will move the file to #directory if it is in another directory.
+    # Will raise MisplacedVersionFileError if it is in another directory.
     def <<(version_info)
-      file, info = version_info
-      if info&.failure
-        raise Errors::FailedModificationError.new info: info, file: original
-      end
-
-      version = validate(file)
+      version, info = Versions::Validator[version_info, self]
+      version ||= @current
       @history[version] = info
       self
     rescue StandardError => e
@@ -146,7 +143,7 @@ module FilePipeline
       yield(self) if block_given?
       return original unless changed?
 
-      filename = overwrite ? replacing_trarget : preserving_taget
+      filename = overwrite ? replacing_target : preserving_target
       FileUtils.rm original if overwrite
       @original = Versions.copy(current, original_dir, filename)
     ensure
@@ -167,10 +164,12 @@ module FilePipeline
     # than exif.
     #++
     def metadata(for_version: :current)
-      if %i[current original].include? for_version
-        file = public_send(for_version)
-      end
-      file ||= for_version
+      file = case for_version
+             when :current, :original
+               public_send for_version
+             else
+               for_version
+             end
       read_exif(file).first
     end
 
@@ -211,13 +210,13 @@ module FilePipeline
 
     # Returns the filename for a target file that will not overwrite the
     # original.
-    def preserving_taget
-      basename + '_' + target_suffix + current_extension
+    def preserving_target
+      "#{basename}_#{target_suffix}#{current_extension}"
     end
 
     # Returns the filename for a target file that will overwrite the
     # original.
-    def replacing_trarget
+    def replacing_target
       basename + current_extension
     end
 
@@ -227,27 +226,13 @@ module FilePipeline
       history.clear!
     end
 
-    # Validates if file exists and has been stored in #directory.
-    def validate(file)
-      return current unless file
-
-      unless File.exist? file
-        raise Errors::MissingVersionFileError.new file: file
-      end
-
-      return file if File.dirname(file) == directory
-
-      Versions.move file, directory, File.basename(file)
-    end
-
     # Creates the directory containing all version files. Directory name is
     # composed of the basename plus '_version'.
     #
     # Raises SystemCallError if the directory already exists.
     def workdir
-      subdir = basename + '_versions'
       filedir = File.dirname(original)
-      dirname = File.join filedir, subdir
+      dirname = File.join filedir, "#{basename}_versions"
       FileUtils.mkdir(dirname)
       File.path dirname
     end

data/lib/file_pipeline/versions/validator.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module FilePipeline
+  module Versions
+    # Validator objects verify the version file and results returned by a
+    # FileOperation.
+    #
+    # They will validate:
+    # - that the version file existst
+    # - that it is in the correct directory
+    # - that the file operation has not returned any failures
+    class Validator
+      extend Forwardable
+
+      # File for the version that resulted from a FileOperation.
+      attr_reader :file
+
+      # FileOperation::Results object.
+      attr_reader :info
+
+      # Returns a new instance.
+      #
+      # ===== Arguments
+      #
+      # * <tt>version_info</tt> - path to an existing file or an array with the
+      #   path and optionally a FileOperations::Results instance.
+      # * +directory+ - directory where the file is expected (the working
+      #   directory of a VersionedFile).
+      # * +filename+ - name of the file to be returned if the file operation was
+      #   was non-modifying (usually the VersionedFile#original).
+      def initialize(version_info, directory, filename)
+        @file, @info = [version_info].flatten
+        @directory = directory
+        @filename = filename
+      end
+
+      # Validates file, directory, and info for <tt>version_info</tt> in the
+      # context of <tt>versioned_file</tt>.
+      #
+      # ===== Arguments
+      #
+      # * <tt>version_info</tt> - path to an existing file or an array with the
+      #   path and optionally a FileOperations::Results instance.
+      # * <tt>versioned_file</tt> - an object that responds to #original and
+      # returns a file path, and #directory and returns a directory path.
+      def self.[](version_info, versioned_file)
+        new(version_info, versioned_file.directory, versioned_file.original)
+          .validate_info
+          .validate_file
+          .validate_directory
+          .then { |validator| [validator.file, validator.info] }
+      end
+
+      # Returns +true+ when there is no file for the version (result of a
+      # non-modifying file operation), +false+ otherwise.
+      def unmodified?
+        @file.nil?
+      end
+
+      # Raises MisplacedVersionFileError if #file is not in #directory.
+      def validate_directory
+        return self if unmodified? || File.dirname(@file) == @directory
+
+        raise Errors::MisplacedVersionFileError.new file: @file,
+                                                    directory: @directory
+      end
+
+      # Raises MissingVersionFileError if #file does not exist on the file
+      # system.
+      def validate_file
+        return self if unmodified? || File.exist?(@file)
+
+        raise Errors::MissingVersionFileError.new file: @file
+      end
+
+      # Raises FailedModificationError if the file operation generatint the
+      # #info failed.
+      def validate_info
+        return self unless @info&.failure
+
+        raise Errors::FailedModificationError.new info: @info, file: @filename
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: file_pipeline
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Martin Stein
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-02-26 00:00:00.000000000 Z
+date: 2021-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_exiftool
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: 0.16.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: 0.16.0
 - !ruby/object:Gem::Dependency
   name: ruby-vips
   requirement: !ruby/object:Gem::Requirement
@@ -50,6 +50,7 @@ files:
 - lib/file_pipeline.rb
 - lib/file_pipeline/errors.rb
 - lib/file_pipeline/errors/failed_modification_error.rb
+- lib/file_pipeline/errors/misplaced_version_file_error.rb
 - lib/file_pipeline/errors/missing_version_file_error.rb
 - lib/file_pipeline/errors/source_directory_error.rb
 - lib/file_pipeline/errors/source_file_error.rb
@@ -68,11 +69,12 @@ files:
 - lib/file_pipeline/versioned_file.rb
 - lib/file_pipeline/versions.rb
 - lib/file_pipeline/versions/history.rb
+- lib/file_pipeline/versions/validator.rb
 homepage: https://github.com/loveablelobster/file_pipeline
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -80,15 +82,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Nondestructive file processing with a defined batch
 test_files: []