file_pipeline 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 51b495ebce21752d34f27eef33a350539f8918076774063323e603cde82a7726
-  data.tar.gz: f6bd55e7129fe2308193af2e12630a867cca866ae6ce71dd177a9deea3e2aa00
+  metadata.gz: 3b25bf4205819b6d0df2fcbb9a879c7855fc2b0a3cb973774049f44a7d6965b8
+  data.tar.gz: 1191020063c4bb7669e9dfd88a03d539c7b081cd2f422decd87ac6bca288c86e
 SHA512:
-  metadata.gz: 47077cb546d41be57b9c662718710c815dda1c3d77b1834946800d2ddf5472abfde8ecf9e107f58b69f6eb573ea536464a316c5d60a5ae97e94a4d5deb6fbc01
-  data.tar.gz: 25b006ee9e71a989eea5f22eece86918feabe4f7579cf96425110cf64efe5f0e00ab40335b6002298d552f979894bbcd210869ce8e724c35628306d8da701e1e
+  metadata.gz: 8ccb8dabb09322d7c3b6b258c8e4e06edb3a7774e36c1fc26421794b8c53915b219a85c8c9bf07da2bf203cd949a8fc484a1db1cb8ddf6d8443a5c2ba724d4ff
+  data.tar.gz: 3e5a2ec367ab3a2d7280c9d6daaa41f6e3cadcba9b1b73bfdb891d4fef781bade2e4e5ffe970aee76e175ce43ea3ae82d967367f18b29f59dbffec180825262e

data/README.rdoc

@@ -54,7 +54,7 @@ instructions on how to create custom operations).
 ==== Basic set up with default operations
 
 To define an operation, pass the class name of the operation in underscore
-notation and without the containing module name, and any options to
+notation without the containing module name, and any options to
 {#define_operation}[rdoc-ref:FilePipeline::Pipeline#define_operation].
 
 The example below adds an instance of 
@@ -87,8 +87,9 @@ call <tt>#define_operation</tt> with the desired operations and options.
 
 When file operations are to be used that are not included in the gem, place
 the source files for the class definitions in one or more directories and
-initialize the Pipeline object with the directory paths. The directories will
-be added to the {source directories}[rdoc-ref:FilePipeline.source_directories].
+initialize the Pipeline object with the paths to those directories. The
+directories will be added to the
+{source directories}[rdoc-ref:FilePipeline.source_directories].
 
 Directories are added to the source directories in reverse order, so that
 directories added later will have precedence when searching source files. The
@@ -103,7 +104,7 @@ finally in the included default operations.
 
 The basename for source files _must_ be the class name in underscore notation
 without the containing module name. If, for example, the operation is
-<tt>FileOperations::MyOperation</tt>, the source file basename should be
+<tt>FileOperations::MyOperation</tt>, the source file basename has to be
 <tt>'my_operation.rb'</tt>
 
   my_pipeline = FilePipeline::Pipeline.new('~/custom_operations',
@@ -146,7 +147,7 @@ VersionedFile provides access to a files metadata via the
 {#metadata}[rdoc-ref:FilePipeline::VersionedFile#metadata] method of the 
 versioned file instance.
 
-Both the metadata for the original file and the current (latest) version can
+Metadata for the original file, the current (latest) or an arbitrary version can
 be accessed:
 
   image = FilePipeline::VersionedFile.new('~/image.jpg')
@@ -167,12 +168,13 @@ versions available, pass the <tt>:for_version</tt> option with the symbol
 
 Some file operations can comprise metadata; many image processing libraries
 will not preserve all _Exif_ tags and their values when converting images to
-a different format, but only write a small subset of tags to the file they
-create. In these cases, the 
+a different format, but only write a subset of tags to the file they create.
+In these cases, the 
 {ExifRestoration}[rdoc-ref:FilePipeline::FileOperations::ExifRestoration]
-operation can be used to try to restore the tags that have been discarded, but
-it can not write all tags. It will store all tags and their values that it could 
-not write back to the file and return them as captured data.
+operation can be used to try to restore the tags that have been discarded. The
+operation uses Exiftool to write tags, and Exiftool will not write all tags.
+It will store any tags and their values that it could not write back to the file
+and return them as captured data.
 
 Likewise, if the 
 {ExifRedaction}[rdoc-ref:FilePipeline::FileOperations::ExifRedaction] is applied

data/lib/file_pipeline/errors/failed_modification_error.rb

@@ -8,32 +8,64 @@ module FilePipeline
       # The file opration that caused the error.
       attr_reader :info
 
-      # FIXME: should contain original file name file name!
+      # Returns a new instance.
+      #
+      # ===== Arguments
+      #
+      # * +msg+ - error message for the exception. If none provided, the 
+      #   instance will be initialized with the #default_message.
+      #
+      # ===== Options
+      #
+      # * <tt>info</tt> - a FileOperations::Results object or an object.
+      # * <tt>file</tt> - path to the file thas was being processed.
       def initialize(msg = nil, info: nil, file: nil)
         @file = file
         @info = info
-
-        if info.respond_to?(:operation) && info.respond_to?(:log)
-          msg ||= "#{@info.operation&.name} with options"\
-                  " #{@info.operation&.options} failed on #{file}."
-          if original_error
-            msg += "\nException raised by the operation:"\
-                   " #{original_error.inspect}. Backtrace:\n"
-            msg += original_backtrace if original_backtrace
-          end
-        else
-          msg ||= 'Operation failed' unless info
-        end
+        msg ||= default_message
         super msg
       end
 
+      # Returns the backtrace of the error that caused the exception.
       def original_backtrace
         original_error&.backtrace&.join("\n")
       end
 
+      # Returns the error that caused the exception.
       def original_error
         @info.log.find { |item| item.is_a? Exception }
       end
+
+      private
+
+      # Appends the backtrace of the error that caused the exception to the 
+      # #default_message.
+      def append_backtrace(str)
+        return str + "\n" unless original_backtrace
+
+        str + " Backtrace:\n#{original_backtrace}"
+      end
+
+      # Appends the message of the error that caused the exception to the 
+      # #default_message.
+      def append_error(str)
+        return str unless original_error
+
+        str += "\nException raised by the operation:"\
+          " #{original_error.inspect}."
+        append_backtrace str
+      end
+
+      # Returns a String with the #message for +self+.
+      def default_message
+        if info&.respond_to?(:operation) && info&.respond_to?(:log)
+          msg = "#{info.operation&.name} with options"\
+            " #{info.operation&.options} failed on #{@file}."
+          append_error msg
+        else
+          'Operation failed'
+        end
+      end
     end
   end
 end

data/lib/file_pipeline/versioned_file.rb

@@ -19,6 +19,35 @@ module FilePipeline
     # by #finalize is not replacing the original.
     attr_reader :target_suffix
 
+    extend Forwardable
+
+    # Returns a two-dimesnional array, where each nested array has two items;
+    # the file operation object and data captured by the operartion (if any).
+    #
+    # <tt>[[description_object, data_or_nil], ...]</tt>
+    delegate captured_data: :history
+
+    # Returns any data captured by <tt>operation_name</tt>.
+    #
+    # If multiple instances of one operation class have modified the file,
+    # pass any +options+ the specific instance of the operation was initialized
+    # with as the optional second argument.
+    delegate captured_data_for: :history
+
+    # Returns an array with all data captured by operations with +tag+.
+    #
+    # Tags are defined in FileOperations::CapturedDataTags
+    delegate captured_data_with: :history
+
+    # Returns an array of triplets (arryas with three items each): the name of
+    # the file operation class (a string), options (a hash), and the actual log
+    # (an array).
+    delegate log: :history
+
+    # Returns an array with paths to the version files of +self+ (excluding
+    # #original).
+    delegate versions: :history
+
     # Returns a new instance with +file+ as the #original.
     #
     # ===== Arguments
@@ -41,23 +70,10 @@ module FilePipeline
 
       @original = file
       @basename = File.basename(file, '.*')
-      @history = {}
+      @history = Versions::History.new
       @directory = nil
       @target_suffix = target_suffix
-    end
-
-    # Copies the file with path _src_ to <em>/dir/filename</em>.
-    def self.copy(src, dir, filename)
-      dest = FilePipeline.path(dir, filename)
-      FileUtils.cp src, dest
-      dest
-    end
-
-    # Moves the file with path _src_ to <em>/dir/filename</em>.
-    def self.move(src, dir, filename)
-      dest = FilePipeline.path(dir, filename)
-      FileUtils.mv src, dest
-      dest
+      history[original] = nil
     end
 
     # Adds a new version to #history and returns _self_.
@@ -80,37 +96,6 @@ module FilePipeline
       raise e
     end
 
-    # Returns a two-dimesnional array, where each nested array has two items;
-    # the file operation object and data captured by the operartion (if any).
-    #
-    # <tt>[[description_object, data_or_nil], ...]</tt>
-    def captured_data
-      filter_history :data
-    end
-
-    # Returns any data captured by <tt>operation_name</tt>.
-    #
-    # If multiple instances of one operation class have modified the file,
-    # pass any +options+ the specific instance of the operation was initialized
-    # with as the optional second argument.
-    def captured_data_for(operation_name, **options)
-      raw_data = captured_data.filter do |operation, _|
-        operation.name == operation_name &&
-          options.all? { |k, v| operation.options[k] == v }
-      end
-      raw_data.map(&:last)
-    end
-
-    # Returns an array with all data captured by operations with +tag+ has.
-    #
-    # Tags are defined in FileOperations::CapturedDataTags
-    def captured_data_with(tag)
-      return unless changed?
-
-      captured_data.select { |operation, _| operation.captured_data_tag == tag }
-                   .map(&:last)
-    end
-
     # Returns +true+ if there are #versions (file has been modified).
     #
     # *Warning:* It will also return +true+ if the file has been cloned.
@@ -122,7 +107,7 @@ module FilePipeline
     # the file to history, but no FileOperations::Results.
     def clone
       filename = FilePipeline.new_basename + current_extension
-      clone_file = VersionedFile.copy(current, directory, filename)
+      clone_file = Versions.copy(current, directory, filename)
       self << clone_file
     end
 
@@ -161,19 +146,11 @@ module FilePipeline
       yield(self) if block_given?
       filename = overwrite ? replacing_trarget : preserving_taget
       FileUtils.rm original if overwrite
-      @original = VersionedFile.copy(current, original_dir, filename)
+      @original = Versions.copy(current, original_dir, filename)
     ensure
       reset
     end
 
-    # Returns an array of triplets (arryas with three items each): the name of
-    # the file operation class (a string), options (a hash), and the actual log
-    # (an array).
-    def log
-      filter_history(:log)
-        .map { |operation, info| [operation.name, operation.options, info] }
-    end
-
     # Returns the Exif metadata
     #
     # ===== Options
@@ -186,10 +163,12 @@ module FilePipeline
     #--
     # TODO: when file is not an image file, this should return other metadata
     # than exif.
-    # TODO: implement the option to return metadata for a specif version index
     #++
     def metadata(for_version: :current)
-      file = public_send for_version
+      if %i[current original].include? for_version
+        file = public_send(for_version)
+      end
+      file ||= for_version
       read_exif(file).first
     end
 
@@ -218,29 +197,15 @@ module FilePipeline
     # Returns a hash into which all captured data from file operations with the
     # FileOperations::CapturedDataTags::DROPPED_EXIF_DATA has been merged.
     def recovered_metadata
+      return unless changed?
       captured_data_with(FileOperations::CapturedDataTags::DROPPED_EXIF_DATA)
         &.reduce({}) { |recovered, data| recovered.merge data }
     end
 
-    # Returns an array with paths to the version files of +self+ (excluding
-    # #original).
-    def versions
-      history.keys
-    end
-
     alias touch clone
 
     private
 
-    # item = :data or :log
-    def filter_history(item)
-      history.inject([]) do |results, (_, info)|
-        next results unless info.respond_to?(item) && info.public_send(item)
-
-        results << [info.operation, info.public_send(item)]
-      end
-    end
-
     # Returns the filename for a target file that will not overwrite the
     # original.
     def preserving_taget
@@ -256,16 +221,18 @@ module FilePipeline
     # Deletes the work directory and resets #versions
     def reset
       FileUtils.rm_r directory, force: true
-      @history = {}
+      history.clear!
     end
 
     # Validates if file exists and has been stored in #directory.
     def validate(file)
+      return current unless file
+
       raise Errors::MissingVersionFileError, file: file unless File.exist? file
 
       return file if File.dirname(file) == directory
 
-      VersionedFile.move file, directory, File.basename(file)
+      Versions.move file, directory, File.basename(file)
     end
 
     # Creates the directory containing all version files. Directory name is

data/lib/file_pipeline/versions/history.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+module FilePipeline
+  module Versions
+    # History objects keep track of a VersionedFile instances versions names and
+    # any associated logs or data for each version.
+    class History
+      # Returns a new instance.
+      def initialize
+        @entries = {}
+      end
+
+      # Retrieves the _results_ object for the <tt>version_name</tt>.
+      def [](version_name)
+        @entries[version_name]
+      end
+
+      # Associates the +results+ with the <tt>version_name</tt>.
+      def []=(version_name, results)
+        entry = @entries.fetch version_name, []
+        entry << results
+        @entries[version_name] = entry.compact
+      end
+
+      # Returns a two-dimensional array, where each nested array has two items:
+      # * the file operation object
+      # * data captured by the operartion (if any).
+      #
+      # <tt>[[file_operation_object, data_or_nil], ...]</tt>
+      def captured_data
+        filter :data
+      end
+
+      # Returns any data captured by <tt>operation_name</tt>.
+      #
+      # If multiple instances of one operation class have modified the file,
+      # pass any +options+ the specific instance of the operation was
+      # initialized with as the optional second argument.
+      def captured_data_for(operation_name, **options)
+        return if empty?
+
+        captured_data.filter { |op, _| matches? op, operation_name, options }
+                     .map(&:last)
+      end
+
+      # Returns an array with all data captured by operations with +tag+.
+      # Returns an empty array if there is no data for +tag+.
+      #
+      # Tags are defined in FileOperations::CapturedDataTags
+      def captured_data_with(tag)
+        captured_data.filter { |op, _| op.captured_data_tag == tag }
+                     .map(&:last)
+      end
+
+      # Clears all history entries (version names and associated results).
+      def clear!
+        @entries.clear
+      end
+
+      # Returns +true+ if +self+ has no entries (version names and associated
+      # results), +true+ otherwise.
+      def empty?
+        @entries.empty?
+      end
+
+      # Returns an array of triplets (arryas with three items each):
+      #  * Name of the file operation class (String).
+      #  * Options for the file operation instance (Hash).
+      #  * The log (Array).
+      def log
+        filter(:log).map { |op, results| [op.name, op.options, results] }
+      end
+
+      # Returns a two-dimensional Array where every nested Array will consist
+      # of the version name (file path) at index +0+ and +nil+ or an Array with
+      # all _results_ objects for the version at index +1+:
+      #
+      # <tt>[version_name, [results1, ...]]</tt>
+      def to_a
+        @entries.to_a
+      end
+
+      # Returns an array with paths to the version files of +self+ (excluding
+      # #original).
+      def versions
+        @entries.keys
+      end
+
+      private
+
+      # Filters entries in self by +item+ (<tt>:log</tt> or <tt>:data</tt>).
+      def filter(item)
+        @entries.values.flatten.select(&item).map do |results|
+          [results.operation, results.public_send(item)]
+        end
+      end
+
+      # Returns +true+ if +name+ matches the _name_ attribute of +operation+ and
+      # +options+ matches the options the operation instance is initialized
+      # with.
+      def matches?(operation, name, opts)
+        operation.name == name && opts.all? { |k, v| operation.options[k] == v }
+      end
+    end
+  end
+end

data/lib/file_pipeline/versions.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative 'versions/history'
+
+module FilePipeline
+  # Module that contains classes to work with VersionedFile.
+  module Versions
+    # Copies the file with path _src_ to <em>/dir/filename</em>.
+    def self.copy(src, dir, filename)
+      dest = FilePipeline.path(dir, filename)
+      FileUtils.cp src, dest
+      dest
+    end
+
+    # Moves the file with path _src_ to <em>/dir/filename</em>.
+    def self.move(src, dir, filename)
+      dest = FilePipeline.path(dir, filename)
+      FileUtils.mv src, dest
+      dest
+    end
+  end
+end

data/lib/file_pipeline.rb

@@ -4,6 +4,7 @@ require 'securerandom'
 
 require_relative 'file_pipeline/errors'
 require_relative 'file_pipeline/file_operations'
+require_relative 'file_pipeline/versions'
 require_relative 'file_pipeline/versioned_file'
 require_relative 'file_pipeline/pipeline'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: file_pipeline
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Martin Stein
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-19 00:00:00.000000000 Z
+date: 2019-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_exiftool
@@ -38,7 +38,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.0.16
-description: The file_pipeline gem provides a framework fornondestructive application
+description: The file_pipeline gem provides a framework for nondestructive application
   of file operation batches to files.
 email: loveablelobster@fastmail.fm
 executables: []
@@ -65,6 +65,8 @@ files:
 - lib/file_pipeline/file_operations/results.rb
 - lib/file_pipeline/pipeline.rb
 - lib/file_pipeline/versioned_file.rb
+- lib/file_pipeline/versions.rb
+- lib/file_pipeline/versions/history.rb
 homepage: https://github.com/loveablelobster/file_pipeline
 licenses:
 - MIT
@@ -77,7 +79,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="