phtools 0.10.0 → 0.11.1

data/lib/phfixfmd.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 # encoding: UTF-8
 # (c) ANB Andrew Bizyaev
 
@@ -6,9 +7,8 @@ require 'phtools/runner'
 
 module PhTools
   class Phfixfmd < Runner
-
     def self.about
-      "fixes FileModifyDate to be equal to date-time-in-the-name"
+      'fixes FileModifyDate to be equal to date-time-in-the-name'
     end
 
     private

data/lib/phgettags.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 # encoding: UTF-8
 # (c) ANB Andrew Bizyaev
 
@@ -8,9 +9,8 @@ require 'phtools/exif_tagger'
 
 module PhTools
   class Phgettags < Runner
-
     def self.about
-      "extracts the tags stored inside the file"
+      'extracts the tags stored inside the file'
     end
 
     private
@@ -29,10 +29,10 @@ module PhTools
 
       puts "******** FILE #{phfile} ********"
 
-      if not @options_cli['--full_dump']
-        puts format('%-29s %s', "FileModifyDate", "#{tags.FileModifyDate}")
+      if !@options_cli['--full_dump']
+        puts format('%-29s %s', 'FileModifyDate', tags.FileModifyDate.to_s)
         ExifTagger::TAGS_SUPPORTED.each do |tag|
-          puts "#{tag.to_s.camelize}"
+          puts tag.to_s.camelize
           ExifTagger::Tag.const_get(tag.to_s.camelize).const_get('EXIFTOOL_TAGS').each do |t|
             v = tags[t]
             v = 'EMPTY' if v.respond_to?(:empty?) && v.empty?
@@ -43,8 +43,8 @@ module PhTools
             end
           end
         end
-      else #full_dump
-        tags.to_hash.each do |t,v|
+      else # full_dump
+        tags.to_hash.each do |t, v|
           puts format('%-29s %-10s %s', t, "(#{v.class})", v)
         end
       end

data/lib/phls.rb

@@ -1,20 +1,20 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 # encoding: UTF-8
 # (c) ANB Andrew Bizyaev
 
 require 'phtools/runner'
 
 module PhTools
-  # list generation
   class Phls < Runner
     def self.about
-      %Q{generates list of phtools friendly files}
+      %(generates list of phtools friendly files)
     end
 
     def run!
       @dirs_to_scan.each do |dir|
         fmask = File.join(dir, @options_cli['--recursive'] ? '**' : '', "{#{@filemasks * ','}}")
-        Dir.glob(fmask, File::FNM_CASEFOLD).each { |f| output_file(f) if File.file?(f) }
+        Dir.glob(fmask, File::FNM_CASEFOLD).each { |f| output_file(PhFile.new(f)) if File.file?(f) }
       end
 
     rescue SignalException
@@ -37,9 +37,8 @@ module PhTools
       @filemasks = ['*.*'] if @filemasks.empty?
     end
 
-    def output_file(file)
-      ftype = File.extname(file).empty? ? '' : File.extname(file).slice(1..-1).downcase
-      @os.output(File.join(File.dirname(file), File.basename(file))) if @file_type.include?(ftype)
+    def output_file(phfile)
+      @os.output(phfile) if @file_type.include?(phfile.type)
     end
   end
 end

data/lib/phmove.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 # encoding: UTF-8
 # (c) ANB Andrew Bizyaev
 
@@ -7,13 +8,13 @@ require 'phtools/runner'
 module PhTools
   class Phmove < Runner
     def self.about
-      "moves input files to target folder"
+      'moves input files to target folder'
     end
 
     private
 
     def validate_options
-      @target_folder = @options_cli['TARGET_FOLDER']
+      @target_folder = @options_cli['TARGET_FOLDER'] || '.'
       @arrange = @options_cli['--arrange']
       if @arrange
         @raw_folder = File.join(@target_folder, 'RAW')
@@ -39,34 +40,24 @@ module PhTools
 
     def process_file(phfile)
       phfile_out = phfile.clone
-      file_type = phfile.extname.slice(1..-1).downcase
-      case
-      when FILE_TYPE_IMAGE_NORMAL.include?(file_type)
-        phfile_out.dirname = @target_folder
-      when FILE_TYPE_IMAGE_RAW.include?(file_type)
-        phfile_out.dirname = @raw_folder
-      when FILE_TYPE_VIDEO.include?(file_type)
-        phfile_out.dirname = @video_folder
-      when FILE_TYPE_AUDIO.include?(file_type)
-        phfile_out.dirname = @target_folder
-      end
+      phfile_out.dirname = @target_folder if phfile_out.image_normal?
+      phfile_out.dirname = @raw_folder if phfile_out.image_raw?
+      phfile_out.dirname = @video_folder if phfile_out.video?
+      phfile_out.dirname = @target_folder if phfile_out.audio?
 
       FileUtils.mv(phfile.filename, phfile_out.filename, verbose: PhTools.debug) unless phfile == phfile_out
       phfile_out
+
     rescue SystemCallError => e
       raise PhTools::Error, 'file moving - ' + e.message
     end
 
     def process_after
-      if @arrange
-        Dir.delete @raw_folder if (Dir.exist?(@raw_folder) and
-                                   Utils.dir_empty?(@raw_folder))
-        Dir.delete @video_folder if (Dir.exist?(@video_folder) and
-                                     Utils.dir_empty?(@video_folder))
-      end
+      return unless @arrange
+      Dir.delete @raw_folder if Dir.exist?(@raw_folder) && Utils.dir_empty?(@raw_folder)
+      Dir.delete @video_folder if Dir.exist?(@video_folder) && Utils.dir_empty?(@video_folder)
     rescue
-        raise PhTools::Error, "Unable to delete dir"
+      raise PhTools::Error, 'Unable to delete dir'
     end
-
   end
 end

data/lib/phrename.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 # encoding: UTF-8
 # (c) ANB Andrew Bizyaev
 
@@ -9,7 +10,7 @@ require 'phtools/runner'
 module PhTools
   class Phrename < Runner
     def self.about
-      "renames input files to phtools standard"
+      'renames input files to phtools standard'
     end
 
     private
@@ -35,11 +36,11 @@ module PhTools
       info_msg = ''
       case @mode
       when :rename
-        if phfile_out.basename_is_standard? and @user_tag_date.empty?
+        if phfile_out.basename_is_standard? && @user_tag_date.empty?
           # change only author, keeping date-time safe
           phfile_out.standardize!(author: @author)
-          info_msg = "'#{phfile.basename+phfile.extname}' already standard name. Keeping date-time part unchanged"
-        else #full rename
+          info_msg = "'#{phfile.basename + phfile.extname}' already standard name. Keeping date-time part unchanged"
+        else # full rename
           begin
             tags = MiniExiftool.new(phfile.filename,
                                     replace_invalid_chars: true,
@@ -94,7 +95,7 @@ module PhTools
             tag_used = "#{@user_tag_date}"
           end
           phfile_out.standardize!(date_time: dto, author: @author)
-          info_msg = "'#{phfile.basename+phfile.extname}' using tag '#{tag_used}' for date-time"
+          info_msg = "'#{phfile.basename + phfile.extname}' using tag '#{tag_used}' for date-time"
         end
 
       when :clean
@@ -102,7 +103,7 @@ module PhTools
 
       when :shift_time
         fail PhTools::Error, 'non-standard file name' unless phfile_out.basename_is_standard?
-        phfile_out.standardize!(date_time: phfile_out.date_time + @shift_seconds*(1.0/86400))
+        phfile_out.standardize!(date_time: phfile_out.date_time + @shift_seconds * (1.0 / 86_400))
       end
 
       FileUtils.mv(phfile.filename, phfile_out.filename, verbose: PhTools.debug) unless phfile == phfile_out

data/lib/phtagset.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 # encoding: UTF-8
 # (c) ANB Andrew Bizyaev
 
@@ -7,7 +8,7 @@ require 'phtools/runner'
 module PhTools
   class Phtagset < Runner
     def self.about
-      "!UNDER CONSTRUCTION!"
+      '!UNDER CONSTRUCTION!'
     end
   end
 end

data/lib/phtools/error.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 # encoding: UTF-8
 # (c) ANB Andrew Bizyaev
 
@@ -18,7 +19,7 @@ module PhTools
     e.backtrace.each do |b|
       STDERR.puts "#{prefix}: CAUSE#{level} BACKTRACE: #{b}"
     end
-    drill_down_error(e.cause, level+1, prefix)
+    drill_down_error(e.cause, level + 1, prefix)
   end
 
   def self.puts_error(msg, e = nil)

data/lib/phtools/exif_tagger/error.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 # encoding: UTF-8
 # (c) ANB Andrew Bizyaev
 

data/lib/phtools/exif_tagger/tag_collection.rb

@@ -1,7 +1,10 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 # encoding: UTF-8
 # (c) ANB Andrew Bizyaev
 
+require 'mini_exiftool'
+
 module ExifTagger
   # EXIF tags collection
   class TagCollection
@@ -10,15 +13,15 @@ module ExifTagger
     def initialize(init_values = nil)
       @collection = []
       return if init_values.nil?
-      case
-      when init_values.is_a?(Hash)
-        init_values.each do |k, v|
-          self[k] = v
-        end
-      when init_values.is_a?(ExifTagger::TagCollection)
-        init_values.each do |item|
-          self[item.tag_id] = item.value
-        end
+
+      if init_values.is_a?(Hash)
+        init_values.each { |k, v| self[k] = v }
+
+      elsif init_values.is_a?(ExifTagger::TagCollection)
+        init_values.each { |item| self[item.tag_id] = item.value }
+
+      elsif init_values.is_a?(MiniExiftool)
+        TAGS_SUPPORTED.each { |tag| self[tag] = init_values }
       end
     end
 
@@ -27,7 +30,7 @@ module ExifTagger
     end
 
     def to_s
-      str = ''
+      str = +''
       @collection.each { |i| str << i.to_s }
       str
     end
@@ -35,7 +38,7 @@ module ExifTagger
     def []=(tag, value)
       return if value.nil?
       delete(tag)
-      @collection << produce_tag(tag, value.dup)
+      @collection << produce_tag(tag, value)
     end
 
     def [](tag)
@@ -73,7 +76,7 @@ module ExifTagger
     def error_message
       str = ''
       unless valid?
-        str = "Tags are NOT VALID:\n"
+        str = +"Tags are NOT VALID:\n"
         @collection.each do |item|
           item.errors.each { |e| str << '    ' + e + "\n" }
         end
@@ -82,7 +85,7 @@ module ExifTagger
     end
 
     def warning_message
-      str = ''
+      str = +''
       if with_warnings?
         @collection.each do |item|
           item.warnings.each { |e| str << '    WARNING: ' + e + "\n" }
@@ -97,7 +100,7 @@ module ExifTagger
       tag_class = ExifTagger::Tag.const_get(tag.to_s.camelize)
       tag_class.new(value)
     rescue => e
-      raise ExifTagger::UnknownTag, "Tag #{tag} - #{e.message}"
+      raise ExifTagger::UnknownTag, "Tag #{tag.to_s.camelize}, value '#{value}' - #{e.message}"
     end
   end
 end

data/lib/phtools/exif_tagger/tag_writer.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 # encoding: UTF-8
 # (c) ANB Andrew Bizyaev
 
@@ -8,7 +9,7 @@ require 'date'
 module ExifTagger
   # batch EXIF tags setter
   class TagWriter
-    DEFAULT_OPTIONS = %w(-v0 -FileModifyDate<DateTimeOriginal -overwrite_original -ignoreMinorErrors)
+    DEFAULT_OPTIONS = %w(-v0 -FileModifyDate<DateTimeOriginal -overwrite_original -ignoreMinorErrors).freeze
     attr_reader :script_name, :added_files_count
 
     def initialize(script_name: 'exif_tagger.txt',
@@ -22,17 +23,17 @@ module ExifTagger
       @output.puts "*** Preparing exiftool script '#{@script_name}' ..."
     end
 
-    def add_to_script(phfile: '', tags: {}, options: DEFAULT_OPTIONS)
-      @script.puts "# **(#{@added_files_count + 1})** Processing file: #{phfile} *****"
+    def add_to_script(filename: '', tags: {}, options: DEFAULT_OPTIONS)
+      @script.puts "# **(#{@added_files_count + 1})** Processing file: #{filename} *****"
       # tags
       tags.each do |k|
         @script.puts tags.item(k).to_write_script
       end
       # file to be altered
-      @script.puts %Q{#{phfile}}
+      @script.puts filename
       # General options
-      options.each { |o| @script.puts "#{o}" }
-      @script.puts %Q{-execute}
+      options.each { |o| @script.puts o }
+      @script.puts %(-execute)
       @script.puts
       @added_files_count += 1
 
@@ -53,7 +54,7 @@ module ExifTagger
 
     def run!
       close_script
-      if @added_files_count > 0
+      if @added_files_count.positive?
         @output.puts "*** Running #{command} ..."
         ok = system(command, out: @output, err: @err)
         fail if ok.nil?

data/lib/phtools/exif_tagger/tags/_tag.rb

@@ -1,8 +1,10 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 # encoding: UTF-8
 # (c) ANB Andrew Bizyaev
 
 require 'active_support/core_ext'
+require 'mini_exiftool'
 
 module ExifTagger
   module Tag
@@ -10,23 +12,38 @@ module ExifTagger
     class Tag
       include Comparable
 
-      EXIFTOOL_TAGS = []
-      attr_reader :errors, :value, :value_invalid, :warnings, :write_script_lines
+      EMPTY = ''
+      EMPTY_DATE = '0000-01-01 00:00:00'
+      EXIFTOOL_TAGS = [].freeze
+      MAX_BYTESIZE = 32
+
+      attr_reader :errors, :value, :raw_values, :value_invalid, :warnings, :write_script_lines
+      attr_reader :previous
       attr_accessor :info, :force_write
 
-      def initialize(value_norm = '')
-        @value = value_norm
-        @errors = []
-        @value_invalid = []
-        @warnings = []
-        @write_script_lines = []
+      def self.empty?(value)
+        return true if value.nil?
+        return value.empty? if value.is_a?(String)
+        return value.join.empty? if value.is_a?(Array)
+        return value.values.join.empty? if value.is_a?(Hash)
+        false
+      end
+
+      def initialize(value = '', previous = nil)
+        @raw_values = {}
+        if value.class == MiniExiftool
+          init_raw_values(value)
+          @value = normalize(get_from_raw)
+        else
+          @value = normalize(value)
+        end
+        @previous = (previous.is_a?(self.class) ? previous : nil)
         @info = ''
         @force_write = false
+
         validate
-        @value.freeze
-        @errors.freeze
-        @value_invalid.freeze
-        @warnings.freeze
+        validate_vs_previous
+        freeze_values
       end
 
       def tag_id
@@ -38,14 +55,12 @@ module ExifTagger
       end
 
       def <=>(other)
-        if other.respond_to? :tag_id
-          tag_id <=> other.tag_id
-        else
-          tag_id <=> other.to_s.to_sym
-        end
+        return tag_id <=> other.tag_id if other.respond_to?(:tag_id)
+        tag_id <=> other.to_s.to_sym
       end
 
       def to_s
+        return "#{tag_id} is EMPTY" if Tag.empty?(@value)
         "#{tag_id} = #{@value}"
       end
 
@@ -53,6 +68,7 @@ module ExifTagger
         @errors.empty?
       end
 
+      # TODO: remove deprecated method
       def check_for_warnings(original_values: {})
         @warnings = []
         self.class::EXIFTOOL_TAGS.each do |tag|
@@ -72,39 +88,78 @@ module ExifTagger
       end
 
       def to_write_script
-        str = ''
-        generate_write_script_lines
+        str = +''
+        @write_script_lines = []
+        generate_write_script_lines unless Tag.empty?(@value)
         unless @write_script_lines.empty?
-          str << print_info
-          str << print_warnings
-          str << print_lines
+          str << (info.empty? ? '' : "# INFO: #{@info}\n")
+          @warnings.each do |w|
+            str << "# WARNING: #{w}\n"
+          end
+          @write_script_lines.each do |l|
+            unless @warnings.empty?
+              str << '# ' unless @force_write
+            end
+            str << "#{l}\n"
+          end
         end
         str
       end
 
       private
 
-      def print_info
-        @info.empty? ? '' : "# INFO: #{@info}\n"
+      def normalize(value)
+        return EMPTY if value.nil?
+        return EMPTY if value.is_a?(TrueClass) || value.is_a?(FalseClass)
+        if value.is_a?(String)
+          return EMPTY if value.strip.empty?
+        elsif value.is_a?(Array)
+          return value.flatten.map { |i| normalize(i.to_s) }
+        elsif value.is_a?(Hash)
+          return value.map { |k, v| [k, normalize(v.to_s)] }.to_h
+        elsif value.is_a?(DateTime)
+          return EMPTY if value.strftime('%F %T') == EMPTY_DATE
+        elsif value.is_a?(Time)
+          return normalize(value.to_datetime)
+        end
+        value
       end
 
-      def print_warnings
-        str = ''
-        @warnings.each do |w|
-          str << "# WARNING: #{w}\n"
+      def init_raw_values(raw)
+        self.class::EXIFTOOL_TAGS.each do |tag|
+          @raw_values[tag] = normalize(raw[tag])
         end
-        str
       end
 
-      def print_lines
-        str = ''
-        @write_script_lines.each do |l|
-          unless @warnings.empty?
-            str << '# ' unless @force_write
-          end
-          str << "#{l}\n"
+      def validate
+        @errors = []
+        @value_invalid = []
+        return if Tag.empty?(@value)
+        validate_type
+      end
+
+      def validate_string_size(value)
+        bsize = value.bytesize
+        return true if bsize <= self.class::MAX_BYTESIZE
+        @errors << %(#{tag_name}: '#{value}' is #{bsize - self.class::MAX_BYTESIZE} bytes longer than allowed #{self.class::MAX_BYTESIZE})
+        false
+      end
+
+      def validate_vs_previous
+        @warnings = []
+        return if @previous.nil?
+        @previous.raw_values.each do |tag, val|
+          @warnings << "#{tag_name} has original value: #{tag}='#{val}'" unless Tag.empty?(val)
         end
-        str
+        @warnings.freeze
+      end
+
+      def freeze_values
+        @value.freeze
+        @raw_values.freeze
+        @errors.freeze
+        @value_invalid.freeze
+        @warnings.freeze
       end
     end
   end

data/lib/phtools/exif_tagger/tags/_tag_array_of_strings.rb

@@ -0,0 +1,35 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+# encoding: UTF-8
+# (c) ANB Andrew Bizyaev
+
+require_relative '_tag'
+
+module ExifTagger
+  module Tag
+    class TagArrayOfStrings < Tag
+      private
+
+      def get_from_raw
+        @raw_values.each_value do |v|
+          v = v.split('; ') if v.is_a?(String)
+          return v unless Tag.empty?(v)
+        end
+        EMPTY
+      end
+
+      def validate_type
+        if @value.is_a?(Array)
+          @value.each do |val|
+            @value_invalid << val unless validate_string_size(val)
+          end
+          @value -= @value_invalid
+        else
+          @errors << %(#{tag_name}: '#{@value}' is a wrong type \(#{@value.class}\))
+          @value_invalid << @value
+          @value = EMPTY
+        end
+      end
+    end
+  end
+end

data/lib/phtools/exif_tagger/tags/_tag_date.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 # encoding: UTF-8
 # (c) ANB Andrew Bizyaev
 
@@ -8,37 +9,34 @@ require 'date'
 module ExifTagger
   module Tag
     class TagDate < Tag
-      MAX_BYTESIZE = 32 # no limit set in EXIF spec for Date
-
       private
 
-      def validate
-        case
-        when @value.kind_of?(String)
-          bsize = @value.bytesize
-          if bsize > MAX_BYTESIZE
-            @errors << %(#{tag_name}: '#{@value}' ) +
-              %(is #{bsize - MAX_BYTESIZE} bytes longer than allowed #{MAX_BYTESIZE})
-            @value_invalid << @value
-            @value = ''
-          end
-        when @value.kind_of?(DateTime)
-          if @value == DateTime.new(0)
-            @errors << %(#{tag_name}: '#{@value}' zero Date)
-            @value_invalid << @value
-            @value = ''
-          end
-        when @value.kind_of?(Time)
-          if @value == Time.new(0)
-            @errors << %(#{tag_name}: '#{@value}' zero Date)
-            @value_invalid << @value
-            @value = ''
-          end
+      def get_from_raw
+        @raw_values.each_value do |value|
+          return value unless Tag.empty?(value)
+        end
+        EMPTY
+      end
+
+      def make_date_from(tag_date = '', tag_time = '')
+        dcdt = %(#{tag_date} #{tag_time})
+        DateTime.parse(dcdt.sub(/^(\d+):(\d+):/, '\1-\2-'))
+      rescue ArgumentError
+        EMPTY
+      end
+
+      def validate_type
+        if @value.is_a?(String)
+          validate_string_size(@value)
+
+        elsif @value.is_a?(DateTime)
+
         else
-          @errors << %(#{tag_name}: '#{@value}' is of wrong type (#{@value.class}))
-          @value_invalid << @value
-          @value = ''
+          @errors << %(#{tag_name}: '#{@value}' is a wrong type \(#{@value.class}\))
         end
+        return if @errors.empty?
+        @value_invalid << @value
+        @value = EMPTY
       end
     end
   end