photein 0.0.5 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f2e520a4d9508ba94604273c88b9f0d3bb1052aae63cef56c856595e5b0b3866
-  data.tar.gz: 14633d71731ff23c3350c861bfe33d289bfb53777d6369a6245c203de93dacde
+  metadata.gz: 7b3bcb770e66b470a49fd5f486560c447e92ba8df6daa33434c45fdd3564a2e7
+  data.tar.gz: 83df115282d7cef28bfd2f32a42643a843726ea40c8eda1de5e7908f1b7f4832
 SHA512:
-  metadata.gz: cf796a670cc45ce45238b4e9b0e23641ce1dc21aa67008bb016e9507b0470bebdd4790620bfd5325eabdcbe833165588c32811b244b5f8271ff8fa05d5b2d473
-  data.tar.gz: deaea8ad0c1ad541c5e160ea927dbfef115902a7f25b96205e67c780e45477a0def030fe1dc4ba2063cc3c936fb7298ccb9f7f4dca70069e4e7ac4ec7fdd586f
+  metadata.gz: 33ceaea508cbe94cc40906364a1094c825c647e0bc7a38a1f9bdc21f1624a63a8b0c7e39351a0dcbc973afd2969af0e5e20615f3404d2b7b2af2f2cc6db1930f
+  data.tar.gz: 798e0351b09bcb1cbe0cae6875b6731cbfeeffb2cba1d2e09bc6b5e9ded21ebf009af302e2c17841e5b6cf2f025e5b1cbcd819787ce645205c3167e6afbb6ba7

data/README.md

@@ -14,21 +14,22 @@ no matter where they come from:
 ```sh
 # Before                                # After
 
-~/Pictures                              ~/Pictures
-└── _inbox                              ├── _inbox
-    ├── 1619593208911.jpeg              ├── 2020
-    ├── DCIM                            │   ├── 2020-08-01_113129.heic
-    │   └── 2021_03_26                  │   └── 2020-05-20_160209.png
-    │       ├── R0014285.MOV            └── 2021
-    │       ├── R0014286.DNG                ├── 2021-02-12_081933a.jpg
-    │       ├── R0014286.JPG                ├── 2021-02-12_081933b.jpg
-    │       ├── R0014287.DNG                ├── 2021-02-12_081939.mp4
-    │       └── R0014287.JPG                ├── 2021-03-26_161245.mp4
-    ├── IMG_20210212_081933_001.jpg         ├── 2021-03-26_161518.dng
-    ├── IMG_20210212_081933_002.jpg         ├── 2021-03-26_161518.jpg
-    ├── IMG_8953.HEIC                       ├── 2021-03-26_170304.dng
-    ├── Screenshot_20200520_160209.png      ├── 2021-03-26_170304.jpg
-    └── VID_20210212_081939.mp4             └── 2021-04-28_000008.jpg
+~                                       ~
+├── Downloads                           ├── Downloads
+│   ├── 1619593208911.jpeg              └── Pictures
+│   ├── DCIM                                ├── 2020
+│   │   └── 2021_03_26                      │   ├── 2020-08-01_113129.heic
+│   │       ├── R0014285.MOV                │   └── 2020-05-20_160209.png
+│   │       ├── R0014286.DNG                └── 2021
+│   │       ├── R0014286.JPG                    ├── 2021-02-12_081933a.jpg
+│   │       ├── R0014287.DNG                    ├── 2021-02-12_081933b.jpg
+│   │       └── R0014287.JPG                    ├── 2021-02-12_081939.mp4
+│   ├── IMG_20210212_081933_001.jpg             ├── 2021-03-26_161245.mp4
+│   ├── IMG_20210212_081933_002.jpg             ├── 2021-03-26_161518.dng
+│   ├── IMG_8953.HEIC                           ├── 2021-03-26_161518.jpg
+│   ├── Screenshot_20200520_160209.png          ├── 2021-03-26_170304.dng
+│   └── VID_20210212_081939.mp4                 ├── 2021-03-26_170304.jpg
+└── Pictures                                    └── 2021-04-28_000008.jpg
 ```
 
 Photein generates these folders & filenames
@@ -38,7 +39,7 @@ based on metadata timestamps, filename timestamps, or file creation times.
 >
 > If you use a photo management app that decides
 > where and how your photos should be stored on disk
-> (👀 looking at you, Apple Photos), Photein is not for you.
+> (looking at you, Apple Photos 👀), Photein is not for you.
 
 It can also optimize photos and videos for reduced file size.
 

data/bin/photein

@@ -5,7 +5,7 @@ require 'photein'
 require 'pathname'
 
 Photein::Config.parse_opts!
-Photein::Logger.open
+Photein.logger.open
 
 # Setup ------------------------------------------------------------------------
 
@@ -17,7 +17,7 @@ begin
   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)
 rescue => e
-  Photein::Logger.fatal(e.message)
+  Photein.logger.fatal(e.message)
   exit 1
 end
 
@@ -33,25 +33,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

@@ -25,10 +25,14 @@ module Photein
       .map { |option| option[/\w[a-z\-]+/] }
       .map(&:to_sym)
 
+    @params = {}
+
     class << self
-      def parse_opts!
-        @params = {}
+      def set(**params)
+        @params.replace(params)
+      end
 
+      def parse_opts!
         parser = OptionParser.new do |opts|
           opts.version = Photein::VERSION
           opts.banner  = <<~BANNER

data/lib/photein/image.rb

@@ -29,7 +29,7 @@ module Photein
       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,8 +42,13 @@ module Photein
         end unless Photein::Config.dry_run
       when '.png'
         FileUtils.cp(path, tempfile, noop: Photein::Config.dry_run)
-        Photein::Logger.info "optimizing #{path}"
-        Optipng.optimize(tempfile, level: 4) unless Photein::Config.dry_run
+        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')
+          raise
+        end
       end
     end
 
@@ -51,10 +56,20 @@ 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/)
+        ImageMagick is required to manipulate image files
+      MSG
+      raise
     end
 
     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/)
+        exiftool is required to read timestamp metadata
+      MSG
+      raise
     end
 
     # NOTE: This may be largely unnecessary:

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

@@ -20,6 +20,7 @@ module Photein
     end
 
     def import
+      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?
@@ -28,7 +29,7 @@ module Photein
 
       optimize if Photein::Config.optimize_for
 
-      Photein::Logger.info(<<~MSG.chomp)
+      Photein.logger.info(<<~MSG.chomp)
         #{Photein::Config.keep ? 'copying' : 'moving'} #{path.basename} to #{dest_path}
       MSG
 
@@ -44,6 +45,12 @@ module Photein
 
     private
 
+    def corrupted?(result = false)
+      return result.tap do |r|
+        Photein.logger.error("#{path.basename}: cannot import corrupted file") if r
+      end
+    end
+
     def denied_by_user?
       $stdout.printf "Import #{path}? [y/N]"
       (STDIN.getch.downcase != 'y').tap { $stdout.puts }
@@ -54,7 +61,7 @@ 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
@@ -112,8 +119,8 @@ module Photein
       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')
-          FileUtils.mv(Dir[collision_glob].first, collision_glob.sub('*', 'a'))
+          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

data/lib/photein/version.rb

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

data/lib/photein/video.rb

@@ -36,7 +36,7 @@ module Photein
     def optimize
       return if video.bitrate < BITRATE_THRESHOLD[Photein::Config.optimize_for]
 
-      Photein::Logger.info("transcoding #{tempfile}")
+      Photein.logger.info("transcoding #{tempfile}")
       return if Photein::Config.dry_run
 
       video.transcode(
@@ -53,13 +53,23 @@ module Photein
 
     private
 
+    def corrupted?
+      super(video.bitrate.nil?)
+    end
+
     def video
       @video ||= FFMPEG::Movie.new(path.to_s)
+    rescue Errno::ENOENT
+      Photein.logger.error('ffmpeg is required to manipulate video files')
+      raise
     end
 
     def metadata_stamp
       # 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')
+      raise
     end
 
     # NOTE: This may be largely unnecessary:

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,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: photein
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.9
 platform: ruby
 authors:
 - Ryan Lue
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-28 00:00:00.000000000 Z
+date: 2021-12-07 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: debouncer
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: mediainfo
   requirement: !ruby/object:Gem::Requirement
@@ -94,20 +80,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.2'
-- !ruby/object:Gem::Dependency
-  name: rb-inotify
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.10'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: streamio-ffmpeg
   requirement: !ruby/object:Gem::Requirement
@@ -123,19 +95,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: pry-remote
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '0.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement