phtools 0.10.0 → 0.11.1

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

@@ -1,46 +1,34 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 # encoding: UTF-8
 # (c) ANB Andrew Bizyaev
 
-require_relative '_tag'
+require_relative '_tag_array_of_strings'
 
 module ExifTagger
   module Tag
     # MWG:Keywords, string[0,64]+, List of Strings
-    #   = IPTC:Keywords, XMP-dc:Subject
-    class Keywords < Tag
+    #   IPTC:Keywords, XMP-dc:Subject
+    # exiftool types:
+    #   Keywords = Array ["aaa", "bbb"] OR String "aaa"
+    #   Subject = Array ["aaa", "bbb"] OR String "aaa"
+
+    class Keywords < TagArrayOfStrings
       MAX_BYTESIZE = 64
-      EXIFTOOL_TAGS = %w(Keywords Subject)
+      EXIFTOOL_TAGS = %w(Keywords Subject).freeze
 
-      def initialize(value_raw = [])
-        super(Array(value_raw).flatten.map { |i| i.to_s })
-      end
+      private
 
-      def check_for_warnings(original_values: {})
+      def validate_vs_previous
         @warnings = []
         @warnings.freeze
       end
 
-      private
-
-      def validate
-        @value.each do |v|
-          bsize = v.bytesize
-          if bsize > MAX_BYTESIZE
-            @errors << %{#{tag_name}: '#{v}' } +
-                       %{is #{bsize - MAX_BYTESIZE} bytes longer than allowed #{MAX_BYTESIZE}}
-            @value_invalid << v
-          end
-        end
-        @value = @value - @value_invalid
-      end
-
       def generate_write_script_lines
-        @write_script_lines = []
-        unless @value.empty?
-          @value.each do |o|
-            @write_script_lines << %Q(-MWG:Keywords-=#{o})
-            @write_script_lines << %Q(-MWG:Keywords+=#{o})
+        @value.each do |o|
+          unless Tag.empty?(o)
+            @write_script_lines << %(-MWG:Keywords-=#{o})
+            @write_script_lines << %(-MWG:Keywords+=#{o})
           end
         end
       end

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

@@ -1,39 +1,22 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 # encoding: UTF-8
 # (c) ANB Andrew Bizyaev
 
-require_relative '_tag'
+require_relative '_tag_string'
 
 module ExifTagger
   module Tag
     # MWG:Location, String[0,32]
-    #   = IPTC:Sub-location + XMP-iptcCore:Location
-    #   + XMP-iptcExt:LocationShownSublocation
-    class Location < Tag
+    #   IPTC:Sub-location, XMP-iptcCore:Location, XMP-iptcExt:LocationShownSublocation
+    class Location < TagString
       MAX_BYTESIZE = 32
-      EXIFTOOL_TAGS = %w(Sub-location Location LocationShownSublocation)
-
-      def initialize(value_raw = [])
-        super(value_raw.to_s)
-      end
+      EXIFTOOL_TAGS = %w(Sub-location Location LocationShownSublocation).freeze
 
       private
 
-      def validate
-        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
-      end
-
       def generate_write_script_lines
-        @write_script_lines = []
-        unless @value.empty?
-          @write_script_lines << %Q(-MWG:Location=#{@value})
-        end
+        @write_script_lines << %(-MWG:Location=#{@value})
       end
     end
   end

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

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 # encoding: UTF-8
 # (c) ANB Andrew Bizyaev
 
@@ -8,18 +9,17 @@ module ExifTagger
   module Tag
     # -EXIF:ModifyDate=now
     class ModifyDate < TagDate
-      EXIFTOOL_TAGS = %w(ModifyDate)
+      MAX_BYTESIZE = 32
+      EXIFTOOL_TAGS = %w(ModifyDate).freeze
 
       private
 
       def generate_write_script_lines
-        @write_script_lines = []
-        case
-        when @value.kind_of?(String) && !@value.empty?
-          @write_script_lines << %Q(-EXIF:ModifyDate=#{@value})
-        when @value.kind_of?(DateTime) || @value.kind_of?(Time)
-          @write_script_lines << %Q(-EXIF:ModifyDate=#{@value.strftime('%F %T')})
-        end
+        @write_script_lines << if @value.is_a?(DateTime)
+                                 %(-EXIF:ModifyDate=#{@value.strftime('%F %T')})
+                               else
+                                 %(-EXIF:ModifyDate=#{@value})
+                               end
       end
     end
   end

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

@@ -1,39 +1,22 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 # encoding: UTF-8
 # (c) ANB Andrew Bizyaev
 
-require_relative '_tag'
+require_relative '_tag_string'
 
 module ExifTagger
   module Tag
     # MWG:State, String[0,32]
-    #   = IPTC:Province-State + XMP-photoshop:State
-    #   + XMP-iptcExt:LocationShownProvinceState
-    class State < Tag
+    #   IPTC:Province-State, XMP-photoshop:State, XMP-iptcExt:LocationShownProvinceState
+    class State < TagString
       MAX_BYTESIZE = 32
-      EXIFTOOL_TAGS = %w(Province-State State LocationShownProvinceState)
-
-      def initialize(value_raw = [])
-        super(value_raw.to_s)
-      end
+      EXIFTOOL_TAGS = %w(Province-State State LocationShownProvinceState).freeze
 
       private
 
-      def validate
-        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
-      end
-
       def generate_write_script_lines
-        @write_script_lines = []
-        unless @value.empty?
-          @write_script_lines << %Q(-MWG:State=#{@value})
-        end
+        @write_script_lines << %(-MWG:State=#{@value})
       end
     end
   end

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

@@ -1,37 +1,21 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 # encoding: UTF-8
 # (c) ANB Andrew Bizyaev
 
-require_relative '_tag'
+require_relative '_tag_string'
 
 module ExifTagger
   module Tag
-    # -XMP-iptcExt:LocationShownWorldRegion, String
-    class WorldRegion < Tag
+    # XMP-iptcExt:LocationShownWorldRegion, String
+    class WorldRegion < TagString
       MAX_BYTESIZE = 64 # No limit in XMP spec
-      EXIFTOOL_TAGS = %w(LocationShownWorldRegion)
-
-      def initialize(value_raw = [])
-        super(value_raw.to_s)
-      end
+      EXIFTOOL_TAGS = %w(LocationShownWorldRegion).freeze
 
       private
 
-      def validate
-        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
-      end
-
       def generate_write_script_lines
-        @write_script_lines = []
-        unless @value.empty?
-          @write_script_lines << %Q(-XMP-iptcExt:LocationShownWorldRegion=#{@value})
-        end
+        @write_script_lines << %(-XMP:LocationShownWorldRegion=#{@value})
       end
     end
   end

data/lib/phtools/exif_tagger/tags.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 # encoding: UTF-8
 # (c) ANB Andrew Bizyaev
 
@@ -7,5 +8,5 @@ Dir.glob(File.join(__dir__, 'tags', '*.rb')).each { |f| require_relative f }
 
 # ExifTagger helper methods
 module ExifTagger
-  TAGS_SUPPORTED = (Tag.constants - [:Tag, :TagDate]).map { |i| i.to_s.underscore.to_sym }
+  TAGS_SUPPORTED = (Tag.constants - [:Tag, :TagArrayOfStrings, :TagHashOfStrings, :TagString, :TagDate]).map { |i| i.to_s.underscore.to_sym }
 end

data/lib/phtools/exif_tagger.rb

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

data/lib/phtools/ph_file.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 # encoding: UTF-8
 # (c) ANB Andrew Bizyaev
 
@@ -6,14 +7,13 @@ require 'phtools/error'
 require 'date'
 require 'fileutils'
 
-# Foto tools
 module PhTools
   # media type constants
-  FILE_TYPE_IMAGE_NORMAL = %w{jpg jpeg tif tiff png}
-  FILE_TYPE_IMAGE_RAW = %w{orf arw dng}
+  FILE_TYPE_IMAGE_NORMAL = %w(jpg jpeg tif tiff png).freeze
+  FILE_TYPE_IMAGE_RAW = %w(orf arw dng).freeze
   FILE_TYPE_IMAGE = FILE_TYPE_IMAGE_NORMAL + FILE_TYPE_IMAGE_RAW
-  FILE_TYPE_VIDEO = %w{avi mp4 mpg mts dv mov mkv m2t m2ts}
-  FILE_TYPE_AUDIO = %w{wav}
+  FILE_TYPE_VIDEO = %w(avi mp4 mpg mts dv mov mkv m2t m2ts 3gp).freeze
+  FILE_TYPE_AUDIO = %w(wav).freeze
 
   # phtools file name operations
   class PhFile
@@ -26,7 +26,7 @@ module PhTools
     ZERO_DATE = DateTime.new(0)
 
     def self.validate_file!(filename, file_type)
-      fail PhTools::Error, 'does not exist'  unless
+      fail PhTools::Error, 'does not exist' unless
         filename && File.exist?(filename)
       fail PhTools::Error, 'not a file' if File.directory?(filename)
       fail PhTools::Error, 'no permission to write' unless
@@ -49,7 +49,7 @@ module PhTools
       [true, '']
     end
 
-    attr_reader :filename, :dirname, :extname, :basename, :basename_part,
+    attr_reader :filename, :dirname, :extname, :type, :basename, :basename_part,
                 :basename_clean, :date_time, :author
 
     def initialize(filename)
@@ -57,7 +57,7 @@ module PhTools
     end
 
     def to_s
-      "#{@filename}"
+      @filename.to_s
     end
 
     def <=>(other)
@@ -67,13 +67,33 @@ module PhTools
     def basename_standard(basename_clean: @basename_clean,
                           date_time: @date_time,
                           author: @author)
-      %Q{#{date_time.strftime('%Y%m%d-%H%M%S')}_#{(author.upcase + "XXXXXX")[0, NICKNAME_SIZE]} #{basename_clean}}
+      %(#{date_time.strftime('%Y%m%d-%H%M%S')}_#{(author.upcase + 'XXXXXX')[0, NICKNAME_SIZE]} #{basename_clean})
     end
 
     def basename_is_standard?
       @basename == basename_standard
     end
 
+    def image?
+      FILE_TYPE_IMAGE.include?(@type)
+    end
+
+    def image_normal?
+      FILE_TYPE_IMAGE_NORMAL.include?(@type)
+    end
+
+    def image_raw?
+      FILE_TYPE_IMAGE_RAW.include?(@type)
+    end
+
+    def video?
+      FILE_TYPE_VIDEO.include?(@type)
+    end
+
+    def audio?
+      FILE_TYPE_AUDIO.include?(@type)
+    end
+
     def standardize(dirname: @dirname, basename_clean: @basename_clean,
                     extname: @extname, date_time: @date_time,
                     author: @author)
@@ -100,7 +120,7 @@ module PhTools
     end
 
     def cleanse!(dirname: @dirname, basename_clean: @basename_clean,
-               extname: @extname)
+                 extname: @extname)
       filename = cleanse(dirname: dirname, basename_clean: basename_clean,
                          extname: extname)
       set_state(filename)
@@ -119,8 +139,8 @@ module PhTools
     def date_time_to_time
       Time.new(@date_time.year, @date_time.month, @date_time.day,
                @date_time.hour, @date_time.min, @date_time.sec)
-               # no use of @date_time.zone - assuming file's timezone always
-               # equals to photografer's computer timezone
+      # no use of @date_time.zone - assuming file's timezone always
+      # equals to photografer's computer timezone
     end
 
     private
@@ -130,6 +150,7 @@ module PhTools
       @extname = File.extname(filename)
       @basename = File.basename(filename, @extname)
       @filename = File.join(@dirname, @basename + @extname)
+      @type = @extname.empty? ? '' : @extname.slice(1..-1).downcase
       parse_basename
       @basename_clean = @basename_part[:clean]
       @date_time = reveal_date_time
@@ -166,8 +187,8 @@ module PhTools
     end
 
     def parse_basename
-      default = { prefix: '', clean: '', date: '',
-                  time: '', author: '', id: '', flags: '' }
+      default = { prefix: '', clean: '', date: '', time: '', author: '', id: '', flags: '' }
+
       case @basename
       # check YYYYmmdd-HHMMSS_AUT[ID]{FLAGS}cleanname
       when /^(?<prefix>(?<date>\d{8})-(?<time>\d{6})_(?<author>\w{#{NICKNAME_MIN_SIZE},#{NICKNAME_MAX_SIZE}})\[(?<id>.*)\]\{(?<flags>.*)\})(?<clean>.*)/

data/lib/phtools/runner.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 # encoding: UTF-8
 # (c) ANB Andrew Bizyaev
 
@@ -9,7 +10,6 @@ require 'phtools/error.rb'
 require 'phtools/ph_file.rb'
 require 'docopt'
 
-# Foto Tools
 module PhTools
   # Main class processing input stream
   class Runner
@@ -37,7 +37,7 @@ module PhTools
       exit 1
     ensure
       if PhTools.debug
-        STDERR.puts "Runner Instance Variables: "
+        STDERR.puts 'Runner Instance Variables: '
         STDERR.puts context
       end
     end
@@ -84,8 +84,8 @@ module PhTools
     end
 
     def context
-      self.instance_variables.map do |item|
-        { item => self.instance_variable_get(item) }
+      instance_variables.map do |item|
+        { item => instance_variable_get(item) }
       end
     end
   end

data/lib/phtools/utils.rb

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

data/lib/phtools/version.rb

@@ -1,4 +1,5 @@
+# frozen_string_literal: true
 
 module PhTools
-  VERSION = '0.10.0'.freeze
+  VERSION = '0.11.1'
 end

data/lib/phtools.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 # encoding: UTF-8
 # (c) ANB Andrew Bizyaev
 require 'phtools/version'
@@ -18,17 +19,18 @@ module PhTools
 phtools v#{VERSION} is a bundle of small CLI tools for arranging, renaming, tagging
 of the photo and video files. Helps to keep your photo-video assets in order.
 Please run phtools in a terminal via CLI commands:
-    phls\t(#{Phls::about}),
-    phmove\t(#{Phmove::about}),
-    phbackup\t(#{Phbackup::about}),
-    phrename\t(#{Phrename::about}),
-    phevent\t(#{Phevent::about}),
-    phfixdto\t(#{Phfixdto::about}),
-    phfixfmd\t(#{Phfixfmd::about}),
-    phgettags\t(#{Phgettags::about}),
-    phtagset\t(#{Phtagset::about}).
+    phls\t(#{Phls.about}),
+    phmove\t(#{Phmove.about}),
+    phbackup\t(#{Phbackup.about}),
+    phrename\t(#{Phrename.about}),
+    phevent\t(#{Phevent.about}),
+    phfixdto\t(#{Phfixdto.about}),
+    phfixfmd\t(#{Phfixfmd.about}),
+    phgettags\t(#{Phgettags.about}),
+    phtagset\t(#{Phtagset.about}).
 For more information run these commands with -h option.
 General info about phtools usage see at https://github.com/AndrewBiz/phtools.git
 TEXT
+    about
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: phtools
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.1
 platform: ruby
 authors:
 - Andrew Bizyaev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-28 00:00:00.000000000 Z
+date: 2017-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -252,6 +252,8 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".travis.yml"
 - Gemfile
 - Guardfile
@@ -288,7 +290,10 @@ files:
 - lib/phtools/exif_tagger/tag_writer.rb
 - lib/phtools/exif_tagger/tags.rb
 - lib/phtools/exif_tagger/tags/_tag.rb
+- lib/phtools/exif_tagger/tags/_tag_array_of_strings.rb
 - lib/phtools/exif_tagger/tags/_tag_date.rb
+- lib/phtools/exif_tagger/tags/_tag_hash_of_strings.rb
+- lib/phtools/exif_tagger/tags/_tag_string.rb
 - lib/phtools/exif_tagger/tags/city.rb
 - lib/phtools/exif_tagger/tags/coded_character_set.rb
 - lib/phtools/exif_tagger/tags/collections.rb