photein 0.0.7 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d67c47b483c2b3525960fa4aa80221a2143b7b4bf92d67e74622ffe3ecbcf40f
-  data.tar.gz: 215db5531f34667eab5bd8524a51c9497697e6bb56acf8ccac51acca94aa19ce
+  metadata.gz: 0cc58c5e8f3fad9d829ef5963b0503070ffb4d91e7a766e34acbac7149ad5aeb
+  data.tar.gz: f2d8a39d9c1c4c0e63354ad273eed73ed4aa2c34b42f2a31699bbf17c90f9282
 SHA512:
-  metadata.gz: 356351ee9bdb21340d47b57c12bc11857e774f8a81741f4aa2567b60555d8adc290daad8ddaea9a3ee9d48197b0a3e923fd6e2f6eaea67ef00ca51112e5895b1
-  data.tar.gz: f24b64e2a9faafd6ba95e85b7c3e198bc526e4f8dc216fc71e1dfab9ea3e1affacac3b8ce472b880202b13899abb98eb758504c06045380aa4e0c0ceeaa0b293
+  metadata.gz: db242817983284a1dbc2a3f16dc8929197c2e51f4abee657d8bfa179ac555e7a6c8454fb44bb3622ffd97b22c366bee22ed5b688d4c95d2432369b4df7306c2e
+  data.tar.gz: 0d6a7faef4624037b2f71eee2798d72397cde98f5940727f9ef5878c5a8282b8dc6c836ec70cea59724821d0fe31f9192b3fc590357f9dfe77e942edadea10a5

data/bin/photein

@@ -5,26 +5,22 @@ require 'photein'
 require 'pathname'
 
 Photein::Config.parse_opts!
-Photein::Logger.open
+Photein.logger.open
 
 # Setup ------------------------------------------------------------------------
 
-SRC_DIR  = Pathname(Photein::Config.source)
-DEST_DIR = Pathname(Photein::Config.dest)
-
 begin
-  raise "#{Photein::Config.source}: no such directory" unless SRC_DIR.exist?
-  raise "#{Photein::Config.dest}: no such directory" unless DEST_DIR.exist?
-  raise "#{Photein::Config.source}: no photos or videos found" if Dir.empty?(SRC_DIR)
+  raise "#{Photein::Config.source}: no such directory" unless Photein::Config.source.exist?
+  raise "#{Photein::Config.source}: no photos or videos found" if Dir.empty?(Photein::Config.source)
 rescue => e
-  Photein::Logger.fatal(e.message)
+  Photein.logger.fatal(e.message)
   exit 1
 end
 
 # Cleanup ----------------------------------------------------------------------
 at_exit do
   unless Photein::Config.keep
-    Dir[SRC_DIR.join('**/')].sort
+    Dir[Photein::Config.source.join('**/')].sort
       .drop(1)
       .reverse_each { |d| Dir.rmdir(d) if Dir.empty?(d) }
   end
@@ -33,25 +29,4 @@ at_exit do
 end
 
 # Core Logic -------------------------------------------------------------------
-image_formats = Photein::Image::SUPPORTED_FORMATS
-  .zip(Photein::Image::SUPPORTED_FORMATS.map(&:upcase))
-  .flatten
-
-SRC_DIR
-  .join(Photein::Config.recursive ? '**' : '')
-  .join("*{#{image_formats.join(',')}}")
-  .then { |glob| Dir[glob].sort }
-  .map(&Photein::Image.method(:new))
-  .each(&:import)
-
-# Video compression is time-consuming, so save it for last
-video_formats = Photein::Video::SUPPORTED_FORMATS
-  .zip(Photein::Video::SUPPORTED_FORMATS.map(&:upcase))
-  .flatten
-
-SRC_DIR
-  .join(Photein::Config.recursive ? '**' : '')
-  .join("*{#{video_formats.join(',')}}")
-  .then { |glob| Dir[glob].sort }
-  .map(&Photein::Video.method(:new))
-  .each(&:import)
+Photein.run

data/lib/photein/config.rb

@@ -8,15 +8,16 @@ module Photein
     include Singleton
 
     OPTIONS = [
-      ['-v',             '--verbose',                              'print verbose output'],
-      ['-s SOURCE',      '--source=SOURCE',                        'specify the source directory'],
-      ['-d DESTINATION', '--dest=DESTINATION',                     'specify the destination directory'],
-      ['-r',             '--recursive',                            'ingest source files recursively'],
-      ['-k',             '--keep',                                 'do not delete source files'],
-      ['-i',             '--interactive',                          'ask whether to import each file found'],
-      ['-n',             '--dry-run',                              'perform a "no-op" trial run'],
-      [                  '--safe',                                 'skip files in use by other processes'],
-      [                  '--optimize-for=TARGET', %i[desktop web], 'compress images/video before importing']
+      ['-v',             '--verbose',                 'print verbose output'],
+      ['-s SOURCE',      '--source=SOURCE',           'path to the source directory'],
+      ['-m MASTER',      '--library-master=MASTER',   'path to a destination directory (master)'],
+      ['-d DESKTOP',     '--library-desktop=DESKTOP', 'path to a destination directory (desktop-optimized)'],
+      ['-w WEB',         '--library-web=WEB',         'path to a destination directory (web-optimized)'],
+      ['-r',             '--recursive',               'ingest source files recursively'],
+      ['-k',             '--keep',                    'do not delete source files'],
+      ['-i',             '--interactive',             'ask whether to import each file found'],
+      ['-n',             '--dry-run',                 'perform a "no-op" trial run'],
+      [                  '--safe',                    'skip files in use by other processes'],
     ].freeze
 
     OPTION_NAMES = OPTIONS
@@ -29,7 +30,7 @@ module Photein
 
     class << self
       def set(**params)
-        @params.replace(params).freeze
+        @params.replace(params)
       end
 
       def parse_opts!
@@ -46,7 +47,8 @@ module Photein
         @params.freeze
 
         raise "no source directory given" if !@params.key?(:source)
-        raise "no destination directory given" if !@params.key?(:dest)
+        (%i[library-master library-desktop library-web] & @params.keys)
+          .then { |dest_dirs| raise "no destination directory given" if dest_dirs.empty? }
       rescue => e
         warn("#{parser.program_name}: #{e.message}")
         warn(parser.help) if e.is_a?(OptionParser::ParseError)
@@ -65,6 +67,18 @@ module Photein
       def respond_to_missing?(m, *args)
         @params.key?(m.to_s.tr('_', '-').to_sym) || super
       end
+
+      def source
+        @source ||= Pathname(@params[:source])
+      end
+
+      def destinations
+        @destinations ||= {
+          master:  Pathname(@params[:'library-master']),
+          desktop: Pathname(@params[:'library-desktop']),
+          web:     Pathname(@params[:'library-web'])
+        }.compact
+      end
     end
   end
 end

data/lib/photein/image.rb

@@ -22,14 +22,14 @@ module Photein
     }.freeze
     MAX_RES_WEB = 2097152 # 2MP
 
-    def optimize
-      return if Photein::Config.optimize_for == :desktop
+    def optimize(tempfile:, lib_type:)
+      return unless lib_type == :web
 
       case extname
       when '.jpg', '.heic'
         return false if image.dimensions.reduce(&:*) < MAX_RES_WEB
 
-        Photein::Logger.info "optimizing #{path}"
+        Photein.logger.info "optimizing #{path}"
         MiniMagick::Tool::Convert.new do |convert|
           convert << path
           convert.colorspace('sRGB')
@@ -42,11 +42,11 @@ module Photein
         end unless Photein::Config.dry_run
       when '.png'
         FileUtils.cp(path, tempfile, noop: Photein::Config.dry_run)
-        Photein::Logger.info "optimizing #{path}"
+        Photein.logger.info "optimizing #{path}"
         begin
           Optipng.optimize(tempfile, level: 4) unless Photein::Config.dry_run
         rescue Errno::ENOENT
-          Photein::Logger.error('optipng is required to compress PNG images')
+          Photein.logger.error('optipng is required to compress PNG images')
           raise
         end
       end
@@ -57,7 +57,7 @@ module Photein
     def image
       @image ||= MiniMagick::Image.open(path)
     rescue MiniMagick::Invalid => e
-      Photein::Logger.error(<<~MSG) if e.message.match?(/You must have ImageMagick/)
+      Photein.logger.error(<<~MSG) if e.message.match?(/You must have ImageMagick/)
         ImageMagick is required to manipulate image files
       MSG
       raise
@@ -66,7 +66,7 @@ module Photein
     def metadata_stamp
       MiniExiftool.new(path.to_s).date_time_original
     rescue MiniExiftool::Error => e
-      Photein::Logger.error(<<~MSG) if e.message.match?(/exiftool: not found/)
+      Photein.logger.error(<<~MSG) if e.message.match?(/exiftool: not found/)
         exiftool is required to read timestamp metadata
       MSG
       raise
@@ -95,10 +95,8 @@ module Photein
       end
     end
 
-    def non_optimizable_format?
-      return false if !Photein::Config.optimize_for
-      return false if Photein::Config.optimize_for == :desktop
-      return true if extname == '.dng'
+    def non_optimizable_format?(lib_type)
+      return true if lib_type == :web && extname == '.dng'
 
       return false
     end

data/lib/photein/logger.rb

@@ -4,6 +4,14 @@ require 'logger'
 require 'singleton'
 
 module Photein
+  class << self
+    attr_writer :logger
+
+    def logger
+      @logger ||= Photein::Logger
+    end
+  end
+
   class Logger
     include Singleton
 

data/lib/photein/media_file.rb

@@ -23,22 +23,38 @@ module Photein
       return if corrupted?
       return if Photein::Config.interactive && denied_by_user?
       return if Photein::Config.safe && in_use?
-      return if Photein::Config.optimize_for && non_optimizable_format?
 
-      FileUtils.mkdir_p(parent_dir, noop: Photein::Config.dry_run)
-
-      optimize if Photein::Config.optimize_for
-
-      Photein::Logger.info(<<~MSG.chomp)
-        #{Photein::Config.keep ? 'copying' : 'moving'} #{path.basename} to #{dest_path}
-      MSG
-
-      if File.exist?(tempfile)
-        FileUtils.mv(tempfile, dest_path, noop: Photein::Config.dry_run)
-      else
-        FileUtils.cp(path, dest_path, noop: Photein::Config.dry_run)
-        FileUtils.chmod('-x', dest_path, noop: Photein::Config.dry_run)
-      end
+      Photein::Config.destinations.map do |lib_type, lib_path|
+        next if non_optimizable_format?(lib_type)
+
+        Thread.new do
+          dest_basename = timestamp.strftime(DATE_FORMAT)
+          dest_extname  = self.class::OPTIMIZATION_FORMAT_MAP.dig(lib_type, extname) || extname
+          dest_path     = lib_path
+                            .join(timestamp.strftime('%Y'))
+                            .join("#{dest_basename}#{dest_extname}")
+                            .then(&method(:resolve_name_collision))
+          tempfile      = Pathname(Dir.tmpdir)
+                            .join('photein').join(lib_type.to_s)
+                            .tap(&FileUtils.method(:mkdir_p))
+                            .join(dest_path.basename)
+
+          optimize(tempfile: tempfile, lib_type: lib_type)
+
+          Photein.logger.info(<<~MSG.chomp)
+            #{Photein::Config.keep ? 'copying' : 'moving'} #{path.basename} to #{dest_path}
+          MSG
+
+          FileUtils.mkdir_p(dest_path.dirname, noop: Photein::Config.dry_run)
+
+          if File.exist?(tempfile)
+            FileUtils.mv(tempfile, dest_path, noop: Photein::Config.dry_run)
+          else
+            FileUtils.cp(path, dest_path, noop: Photein::Config.dry_run)
+            FileUtils.chmod('-x', dest_path, noop: Photein::Config.dry_run)
+          end
+        end
+      end.each(&:join)
 
       FileUtils.rm(path, noop: Photein::Config.dry_run || Photein::Config.keep)
     end
@@ -47,7 +63,7 @@ module Photein
 
     def corrupted?(result = false)
       return result.tap do |r|
-        Photein::Logger.error("#{path.basename}: cannot import corrupted file") if r
+        Photein.logger.error("#{path.basename}: cannot import corrupted file") if r
       end
     end
 
@@ -61,36 +77,17 @@ module Photein
 
       if status.success? # Do open files ALWAYS return exit status 0? (I think so.)
         cmd, pid = out.lines[1]&.split&.first(2)
-        Photein::Logger.fatal("skipping #{path}: file in use by #{cmd} (PID #{pid})")
+        Photein.logger.fatal("skipping #{path}: file in use by #{cmd} (PID #{pid})")
         return true
       else
         return false
       end
     end
 
-    def non_optimizable_format? # may be overridden by subclasses
+    def non_optimizable_format?(lib_type = :master) # may be overridden by subclasses
       return false
     end
 
-    def parent_dir
-      Pathname(Photein::Config.dest).join(timestamp.strftime('%Y'))
-    end
-
-    def tempfile
-      Pathname(Dir.tmpdir).join('photein')
-        .tap(&FileUtils.method(:mkdir_p))
-        .join(dest_path.basename)
-    end
-
-    def dest_path
-      @dest_path ||= begin
-                       base_path = parent_dir.join("#{timestamp.strftime(DATE_FORMAT)}#{dest_extname}")
-                       counter   = resolve_name_collision(base_path.sub_ext("*#{dest_extname}"))
-
-                       base_path.sub_ext("#{counter}#{dest_extname}")
-                     end
-    end
-
     def timestamp
       @timestamp ||= (metadata_stamp || filename_stamp)
     end
@@ -105,29 +102,40 @@ module Photein
       end
     end
 
-    def dest_extname
-      self.class::OPTIMIZATION_FORMAT_MAP
-        .dig(Photein::Config.optimize_for, extname) || extname
-    end
-
     def extname
       @extname ||= NORMAL_EXTNAME_MAP[path.extname.downcase] || path.extname.downcase
     end
 
-    def resolve_name_collision(collision_glob)
+    def resolve_name_collision(filename)
+      raise ArgumentError, 'Invalid filename' if filename.to_s.include?('*')
+
+      collision_glob = Pathname(filename).sub_ext("*#{filename.extname}")
+
       case Dir[collision_glob].length
       when 0 # if no files found, no biggie
       when 1 # if one file found, WITH OR WITHOUT COUNTER, reset counter to a
         if Dir[collision_glob].first != collision_glob.sub('*', 'a') # don't try if it's already a lone, correctly-countered file
-          Photein::Logger.info('conflicting timestamp found; adding counter to existing file')
+          Photein.logger.info('conflicting timestamp found; adding counter to existing file')
           FileUtils.mv(Dir[collision_glob].first, collision_glob.sub('*', 'a'), noop: Photein::Config.dry_run)
         end
       else # TODO: if multiple files found, rectify them?
       end
 
-      # return the next usable counter
+      # return the next usable filename
       Dir[collision_glob].max&.slice(/.(?=#{Regexp.escape(collision_glob.extname)})/)&.next
         .tap { |counter| raise 'Unresolved timestamp conflict' unless [*Array('a'..'z'), nil].include?(counter) }
+        .then { |counter| filename.sub_ext("#{counter}#{filename.extname}") }
+    end
+
+    class << self
+      def for(file)
+        file = Pathname(file)
+        raise Errno::ENOENT, "#{file}" unless file.exist?
+
+        [Image, Video].find { |type| type::SUPPORTED_FORMATS.include?(file.extname) }
+          .tap { |type| raise ArgumentError, "#{file}: Invalid media file" if type.nil? }
+          .then { |type| type.new(file) }
+      end
     end
   end
 end

data/lib/photein/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Photein
-  VERSION = '0.0.7'
+  VERSION = '0.1.1'
 end

data/lib/photein/video.rb

@@ -33,10 +33,11 @@ module Photein
       web:     '35',
     }.freeze
 
-    def optimize
-      return if video.bitrate < BITRATE_THRESHOLD[Photein::Config.optimize_for]
+    def optimize(tempfile:, lib_type:)
+      return if lib_type == :master
+      return if video.bitrate < BITRATE_THRESHOLD[lib_type]
 
-      Photein::Logger.info("transcoding #{tempfile}")
+      Photein.logger.info("transcoding #{tempfile}")
       return if Photein::Config.dry_run
 
       video.transcode(
@@ -45,7 +46,7 @@ module Photein
           '-map_metadata', '0', # https://video.stackexchange.com/a/26076
           '-movflags',     'use_metadata_tags',
           '-c:v',          'libx264',
-          '-crf',          TARGET_CRF[Photein::Config.optimize_for],
+          '-crf',          TARGET_CRF[lib_type],
         ],
         &method(:display_progress_bar)
       )
@@ -60,7 +61,7 @@ module Photein
     def video
       @video ||= FFMPEG::Movie.new(path.to_s)
     rescue Errno::ENOENT
-      Photein::Logger.error('ffmpeg is required to manipulate video files')
+      Photein.logger.error('ffmpeg is required to manipulate video files')
       raise
     end
 
@@ -68,7 +69,7 @@ module Photein
       # video timestamps are typically UTC
       MediaInfo.from(path.to_s).general.encoded_date&.getlocal
     rescue MediaInfo::EnvironmentError
-      Photein::Logger.error('mediainfo is required to read timestamp metadata')
+      Photein.logger.error('mediainfo is required to read timestamp metadata')
       raise
     end
 

data/lib/photein.rb

@@ -8,4 +8,16 @@ require 'photein/image'
 require 'photein/video'
 
 module Photein
+  class << self
+    def run
+      [Photein::Image, Photein::Video].each do |media_type|
+        Pathname(Photein::Config.source)
+          .join(Photein::Config.recursive ? '**' : '')
+          .join("*{#{media_type::SUPPORTED_FORMATS.join(',')}}")
+          .then { |glob| Dir.glob(glob, File::FNM_CASEFOLD).sort }
+          .map(&media_type.method(:new))
+          .each(&:import)
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: photein
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.1.1
 platform: ruby
 authors:
 - Ryan Lue
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-06 00:00:00.000000000 Z
+date: 2021-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mediainfo