phtools 0.8.1 → 0.10.0

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

@@ -0,0 +1,38 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+# (c) ANB Andrew Bizyaev
+
+require_relative '_tag'
+
+module ExifTagger
+  module Tag
+    # -IPTC:CodedCharacterSet, string[0,32]!
+    class CodedCharacterSet < Tag
+      MAX_BYTESIZE = 32
+      EXIFTOOL_TAGS = %w(CodedCharacterSet)
+
+      def initialize(value_raw = '')
+        super(value_raw.to_s)
+      end
+
+      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(-IPTC:CodedCharacterSet=#{@value})
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+# (c) ANB Andrew Bizyaev
+
+require_relative '_tag'
+
+module ExifTagger
+  module Tag
+    # Collections (struct+)
+    #   CollectionName
+    #   CollectionURI
+    class Collections < Tag
+      VALID_KEYS = [:collection_name, :collection_uri]
+      EXIFTOOL_TAGS = %w(CollectionName CollectionURI)
+      def initialize(value_raw = {})
+        super
+      end
+
+      private
+
+      def validate
+        unknown_keys = @value.keys - VALID_KEYS
+        unknown_keys.each do |k|
+          @errors << %{#{tag_name}: KEY '#{k}' is unknown}
+        end
+        missed_keys = VALID_KEYS - @value.keys
+        missed_keys.each do |k|
+          @errors << %{#{tag_name}: KEY '#{k}' is missed}
+        end
+        unless @errors.empty?
+          @value_invalid << @value
+          @value = {}
+        end
+      end
+
+      def generate_write_script_lines
+        @write_script_lines = []
+        unless @value.empty?
+          @write_script_lines << %Q(-XMP-mwg-coll:Collections-={CollectionName=#{@value[:collection_name]}, CollectionURI=#{@value[:collection_uri]}})
+          @write_script_lines << %Q(-XMP-mwg-coll:Collections+={CollectionName=#{@value[:collection_name]}, CollectionURI=#{@value[:collection_uri]}})
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+# (c) ANB Andrew Bizyaev
+
+require_relative '_tag'
+
+module ExifTagger
+  module Tag
+    # NMG:Copyright, string[0,128]
+    #   = EXIF:Copyright IPTC:CopyrightNotice XMP-dc:Rights
+    class Copyright < Tag
+      MAX_BYTESIZE = 128
+      EXIFTOOL_TAGS = %w(Copyright CopyrightNotice Rights)
+
+      def initialize(value_raw = '')
+        super(value_raw.to_s)
+      end
+
+      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:Copyright=#{@value})
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+# (c) ANB Andrew Bizyaev
+
+require_relative '_tag'
+
+module ExifTagger
+  module Tag
+    # MWG:Country, String[0,64]
+    #   = IPTC:Country-PrimaryLocationName XMP-photoshop:Country
+    #       XMP-iptcExt:LocationShownCountryName
+    class Country < Tag
+      MAX_BYTESIZE = 64
+      EXIFTOOL_TAGS = %w(Country-PrimaryLocationName Country LocationShownCountryName)
+
+      def initialize(value_raw = '')
+        super(value_raw.to_s)
+      end
+
+      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:Country=#{@value})
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+# (c) ANB Andrew Bizyaev
+
+require_relative '_tag'
+
+module ExifTagger
+  module Tag
+    # XMP-iptcExt:LocationShownCountryCode, String
+    class CountryCode < Tag
+      MAX_BYTESIZE = 32
+      EXIFTOOL_TAGS = %w(LocationShownCountryCode)
+
+      def initialize(value_raw = '')
+        super(value_raw.to_s)
+      end
+
+      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:LocationShownCountryCode=#{@value})
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+# (c) ANB Andrew Bizyaev
+
+require_relative '_tag_date'
+
+module ExifTagger
+  module Tag
+    # -MWG:CreateDate:
+    #    EXIF:CreateDate
+    #    EXIF:SubSecTimeDigitized
+    #    IPTC:DigitalCreationDate
+    #    IPTC:DigitalCreationTime
+    #    XMP-xmp:CreateDate
+    # creation date of the digital representation
+    class CreateDate < TagDate
+      EXIFTOOL_TAGS = %w(CreateDate SubSecTimeDigitized DigitalCreationDate DigitalCreationTime)
+
+      private
+
+      def generate_write_script_lines
+        @write_script_lines = []
+        case
+        when @value.kind_of?(String) && !@value.empty?
+          @write_script_lines << %Q(-MWG:CreateDate=#{@value})
+        when @value.kind_of?(DateTime) || @value.kind_of?(Time)
+          @write_script_lines << %Q(-MWG:CreateDate=#{@value.strftime('%F %T')})
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+# (c) ANB Andrew Bizyaev
+
+require_relative '_tag'
+
+module ExifTagger
+  module Tag
+    # MWG:Creator, string[0,32]+, List of strings
+    #   = EXIF:Artist, IPTC:By-line, XMP-dc:Creator
+    class Creator < Tag
+      MAX_BYTESIZE = 32
+      EXIFTOOL_TAGS = %w(Artist By-line Creator)
+
+      def initialize(value_raw = [])
+        super(Array(value_raw).flatten.map { |i| i.to_s })
+      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:Creator-=#{o})
+            @write_script_lines << %Q(-MWG:Creator+=#{o})
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+# (c) ANB Andrew Bizyaev
+
+require_relative '_tag_date'
+
+module ExifTagger
+  module Tag
+    # -MWG:DateTimeOriginal:
+    #    EXIF:DateTimeOriginal
+    #    EXIF:SubSecTimeOriginal
+    #    IPTC:DateCreated
+    #    IPTC:TimeCreated
+    #    XMP-photoshop:DateCreated
+    # creation date of the intellectual content being shown
+    class DateTimeOriginal < TagDate
+      EXIFTOOL_TAGS = %w(DateTimeOriginal SubSecTimeOriginal DateCreated TimeCreated)
+
+      private
+
+      def generate_write_script_lines
+        @write_script_lines = []
+        case
+        when @value.kind_of?(String) && !@value.empty?
+          @write_script_lines << %Q(-MWG:DateTimeOriginal=#{@value})
+        when @value.kind_of?(DateTime) || @value.kind_of?(Time)
+          @write_script_lines << %Q(-MWG:DateTimeOriginal=#{@value.strftime('%F %T')})
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,78 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+# (c) ANB Andrew Bizyaev
+
+require_relative '_tag'
+
+module ExifTagger
+  module Tag
+    # GPS tags are used for camera location according to MWG 2.0)
+    # GPSLatitude (rational64u[3])
+    # GPSLatitudeRef (string[2] 'N' = North, 'S' = South)
+    # GPSLongitude (rational64u[3])
+    # GPSLongitudeRef (string[2] 'E' = East, 'W' = West)
+    # GPSAltitude (rational64u)
+    # GPSAltitudeRef (int8u 0 = Above Sea Level, 1 = Below Sea Level)
+    class GpsCreated < Tag
+      VALID_KEYS = [:gps_latitude, :gps_latitude_ref, :gps_longitude,
+                    :gps_longitude_ref, :gps_altitude, :gps_altitude_ref]
+      EXIFTOOL_TAGS = %w(
+        GPSPosition
+        GPSLatitude
+        GPSLatitudeRef
+        GPSLongitude
+        GPSLongitudeRef
+        GPSAltitude
+        GPSAltitudeRef
+      )
+
+      def initialize(value_raw = {})
+        # TODO: value = value_raw.each { |k, v| value_raw[k] = v.to_s }
+        super
+      end
+
+      private
+
+      def validate
+        unknown_keys = @value.keys - VALID_KEYS
+        unknown_keys.each do |k|
+          @errors << %(#{tag_name}: KEY '#{k}' is unknown)
+        end
+        missed_keys = VALID_KEYS - @value.keys
+        missed_keys.each do |k|
+          @errors << %(#{tag_name}: KEY '#{k}' is missed)
+        end
+        if @errors.empty?
+          valid_values = ['N', 'S']
+          unless valid_values.include? @value[:gps_latitude_ref]
+            @errors << %(#{tag_name}: value of 'gps_latitude_ref' should be one of #{valid_values})
+          end
+          valid_values = ['E', 'W']
+          unless valid_values.include? @value[:gps_longitude_ref]
+            @errors << %(#{tag_name}: value of 'gps_longitude_ref' should be one of #{valid_values})
+          end
+          valid_values = ['Above Sea Level', 'Below Sea Level']
+          unless valid_values.include? @value[:gps_altitude_ref]
+            @errors << %(#{tag_name}: value of 'gps_altitude_ref' should be one of #{valid_values})
+          end
+        end
+        unless @errors.empty?
+          @value_invalid << @value
+          @value = {}
+        end
+      end
+
+      def generate_write_script_lines
+        @write_script_lines = []
+        unless @value.empty?
+          @write_script_lines << %Q(-GPSLatitude="#{@value[:gps_latitude]}")
+          @write_script_lines << %Q(-GPSLatitudeRef=#{@value[:gps_latitude_ref]})
+          @write_script_lines << %Q(-GPSLongitude="#{@value[:gps_longitude]}")
+          @write_script_lines << %Q(-GPSLongitudeRef=#{@value[:gps_longitude_ref]})
+          @write_script_lines << %Q(-GPSAltitude=#{@value[:gps_altitude]})
+          @write_script_lines << %Q(-GPSAltitudeRef=#{@value[:gps_altitude_ref]})
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+# (c) ANB Andrew Bizyaev
+
+require_relative '_tag'
+
+module ExifTagger
+  module Tag
+    # ImageUniqueID, String
+    class ImageUniqueId < Tag
+      MAX_BYTESIZE = 32 # no limit in EXIF spec
+      EXIFTOOL_TAGS = %w(ImageUniqueID)
+
+      def initialize(value_raw = [])
+        super(value_raw.to_s)
+      end
+
+      def check_for_warnings(original_values: {})
+        @warnings = []
+        v = original_values[EXIFTOOL_TAGS[0]]
+        if v =~ /(\d{8}-\S+)/
+          @warnings << "#{tag_name} has original correct value: '#{v}'"
+        end
+        @warnings.freeze
+      end
+
+      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(-ImageUniqueID=#{@value})
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,49 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+# (c) ANB Andrew Bizyaev
+
+require_relative '_tag'
+
+module ExifTagger
+  module Tag
+    # MWG:Keywords, string[0,64]+, List of Strings
+    #   = IPTC:Keywords, XMP-dc:Subject
+    class Keywords < Tag
+      MAX_BYTESIZE = 64
+      EXIFTOOL_TAGS = %w(Keywords Subject)
+
+      def initialize(value_raw = [])
+        super(Array(value_raw).flatten.map { |i| i.to_s })
+      end
+
+      def check_for_warnings(original_values: {})
+        @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})
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+# (c) ANB Andrew Bizyaev
+
+require_relative '_tag'
+
+module ExifTagger
+  module Tag
+    # MWG:Location, String[0,32]
+    #   = IPTC:Sub-location + XMP-iptcCore:Location
+    #   + XMP-iptcExt:LocationShownSublocation
+    class Location < Tag
+      MAX_BYTESIZE = 32
+      EXIFTOOL_TAGS = %w(Sub-location Location LocationShownSublocation)
+
+      def initialize(value_raw = [])
+        super(value_raw.to_s)
+      end
+
+      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
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+# (c) ANB Andrew Bizyaev
+
+require_relative '_tag_date'
+
+module ExifTagger
+  module Tag
+    # -EXIF:ModifyDate=now
+    class ModifyDate < TagDate
+      EXIFTOOL_TAGS = %w(ModifyDate)
+
+      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
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+# (c) ANB Andrew Bizyaev
+
+require_relative '_tag'
+
+module ExifTagger
+  module Tag
+    # MWG:State, String[0,32]
+    #   = IPTC:Province-State + XMP-photoshop:State
+    #   + XMP-iptcExt:LocationShownProvinceState
+    class State < Tag
+      MAX_BYTESIZE = 32
+      EXIFTOOL_TAGS = %w(Province-State State LocationShownProvinceState)
+
+      def initialize(value_raw = [])
+        super(value_raw.to_s)
+      end
+
+      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
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+# (c) ANB Andrew Bizyaev
+
+require_relative '_tag'
+
+module ExifTagger
+  module Tag
+    # -XMP-iptcExt:LocationShownWorldRegion, String
+    class WorldRegion < Tag
+      MAX_BYTESIZE = 64 # No limit in XMP spec
+      EXIFTOOL_TAGS = %w(LocationShownWorldRegion)
+
+      def initialize(value_raw = [])
+        super(value_raw.to_s)
+      end
+
+      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
+      end
+    end
+  end
+end

data/lib/phtools/exif_tagger/tags.rb

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+# (c) ANB Andrew Bizyaev
+
+require 'active_support/core_ext/string/inflections'
+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 }
+end

data/lib/phtools/exif_tagger.rb

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+# (c) ANB Andrew Bizyaev
+
+require 'phtools/exif_tagger/error'
+require 'phtools/exif_tagger/tags'
+require 'phtools/exif_tagger/tag_collection'
+require 'phtools/exif_tagger/tag_writer'

data/lib/phtools/version.rb

@@ -1,4 +1,4 @@
 
 module PhTools
-  VERSION = '0.8.1'
+  VERSION = '0.10.0'.freeze
 end