photein 0.0.2 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8358c084cdf56bab539d9f429706a606cb346b33e7832e056054b2a4ead67e08
-  data.tar.gz: c9e77f835d2ba2d39a3edb08e5fc6973a1871b82c52a823e3bf15a446c263f80
+  metadata.gz: d67c47b483c2b3525960fa4aa80221a2143b7b4bf92d67e74622ffe3ecbcf40f
+  data.tar.gz: 215db5531f34667eab5bd8524a51c9497697e6bb56acf8ccac51acca94aa19ce
 SHA512:
-  metadata.gz: '08be8726129d9b2c2ffcfe4f9ba206db82619c6b6cd1f8f50339d7390988a3c224c9ecb69da7dedc6edfee5e0c479f6ea4119551af75716039e55eda4635cdc7'
-  data.tar.gz: a91a5a3be62081f8a25333f323a1ed98f2e34421134878679d5af8f3fce674c8e7ef8e1a299d4caa3afd9364af38fbe6ef8136045bfe15ac614afd9cf4d2f9ba
+  metadata.gz: 356351ee9bdb21340d47b57c12bc11857e774f8a81741f4aa2567b60555d8adc290daad8ddaea9a3ee9d48197b0a3e923fd6e2f6eaea67ef00ca51112e5895b1
+  data.tar.gz: f24b64e2a9faafd6ba95e85b7c3e198bc526e4f8dc216fc71e1dfab9ea3e1affacac3b8ce472b880202b13899abb98eb758504c06045380aa4e0c0ceeaa0b293

data/README.md

@@ -1,16 +1,12 @@
 Ph📸tein
 ========
 
-All your photos under one roof.
+A no-nonsense way to organize your personal photo library.
 
 What does it do?
 ----------------
 
-This repo provides two related programs: `photein` and `xferase`.
-
-### Photein
-
-Photein is a CLI utility for managing your photos **at the filesystem level**.
+Photein manages your photos **at the filesystem level**.
 It won’t let you browse or edit your photos,
 but it will give them a uniform folder structure and filenames,
 no matter where they come from:
@@ -18,73 +14,53 @@ 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
+based on metadata timestamps, filename timestamps, or file creation times.
+
 > ⚠️ **Note**
 >
 > If you use a photo management app that decides
-> where and how your photos should be stored on your system (like Apple Photos), 
-> Photein is not for you.
-
-### Xferase
-
-Xferase is a background service built on top of photein.
-It watches a directory of your choosing,
-and whenever any files are placed there,
-it automatically imports them into your photo library.
-
-It creates and manages two parallel copies of your library
-(one original/hi-res, one optimized for web)
-and ensures that when you delete a photo from one,
-it is automatically removed from the other.
-
-When combined with other software,
-Xferase can be used as a self-hosted / DIY alternative
-to cloud photo services like Google Photos or iCloud.
-
-Why?
-----
-
-I could not find any existing software product that:
+> where and how your photos should be stored on disk
+> (looking at you, Apple Photos 👀), Photein is not for you.
 
-1. imports photos from many sources\* with **no mouse or keyboard interaction**
+It can also optimize photos and videos for reduced file size.
 
-   \*_e.g.,_ 📱 cell phone / 📷 digital camera / 💬 chat app download
+What _doesn’t_ it do?
+---------------------
 
-2. enforces a clean, consistent, **user-visible directory & filename scheme**
+On its own, Photein is **not** an alternative
+to cloud photo services like Google Photos or iCloud—but
+in combination with other software, it can be.
 
-   (I want to be able to access my photos from the file manager,
-   find them in an “Open...” dialog,
-   or sync them to other devices with tools like Dropbox or Syncthing.)
+If you want to:
 
-3. comes with **no recurring subscription fee**—or better yet, is FOSS
+* import photos from your phone as soon as you take them
+* import photos from a digital camera / SD card as soon as you plug it in
+* mirror a low-res copy of your entire photo library to your Android phone
 
-   (My digital photo/video library belongs to me,
-   but if I don’t control the pipeline for viewing/managing it,
-   then does it really?)
+check out Photein’s sister utility [Xferase][],
+or try the [automation guides][] below.
 
-4. works with Linux
-
-> ⚠️ **Note**
->
-> Strictly speaking, Photein does not handle requirement #1;
-> for that, use Xferase in combination with other software,
-> such as Syncthing or systemd.
+[Xferase]: https://github.com/rlue/xferase
+[automation guides]: #automation-guides
 
 Installation
 ------------
@@ -95,7 +71,7 @@ $ gem install photein
 
 ### Dependencies
 
-* Ruby 2.7+
+* Ruby 2.6+
 * [ExifTool][]
 * [MediaInfo][]
 * ImageMagick (for `--optimize-for=web` option)
@@ -108,8 +84,6 @@ $ gem install photein
 Usage
 -----
 
-### Simple import
-
 ```sh
 $ photein \
     --source /media/ricoh_gr/DCIM \ # batch-import photos from here
@@ -130,9 +104,17 @@ Use `photein --help` for a summary of all options.
 
 ### Automation guides
 
-* [📷➡️🖥️ Set up auto-import from a digital camera](doc/auto-import-digital-camera.md)
-* [📱➡️🖥️ Set up auto-import from an Android phone](doc/auto-import-android-phone.md)
-* [📱🔄🖥️ Mirror your library across multiple devices](doc/mirroring-a-library-on-multiple-devices.md)
+Using Photein + systemd, you can:
+
+* [📷➡️🖥️ Set up auto-import from a digital camera](guides/auto-import-digital-camera.md)
+
+But for more complex tasks, like:
+
+* 📱➡️🖥️ Setting up auto-import from an Android phone
+* 📱🔄🖥️ Mirroring your library across multiple devices
+
+check out the documentation for [Xferase][],
+an always-on background service based on Photein.
 
 Development
 -----------
@@ -146,8 +128,7 @@ Contributions welcome.
 > it defines expectations against the effects of `system('photein <args>')`.
 >
 > Because `Kernel#system` runs the given command in a subprocess, 
-> it prints to a different stdout than
-> native Ruby code in a normal RSpec example.
+> it prints to a different stdout than `rspec` itself.
 > This makes test failures cumbersome to debug,
 > because `puts` statements never appear in the test output,
 > and `binding.pry` will cause the test to appear to hang

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).freeze
+      end
 
+      def parse_opts!
         parser = OptionParser.new do |opts|
           opts.version = Photein::VERSION
           opts.banner  = <<~BANNER

data/lib/photein/image.rb

@@ -43,7 +43,12 @@ module Photein
       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
+        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/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?
@@ -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 }
@@ -113,7 +120,7 @@ module Photein
       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'))
+          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.2'
+  VERSION = '0.0.7'
 end

data/lib/photein/video.rb

@@ -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:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: photein
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.7
 platform: ruby
 authors:
 - Ryan Lue
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-25 00:00:00.000000000 Z
+date: 2021-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mediainfo
@@ -53,33 +53,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '4.11'
 - !ruby/object:Gem::Dependency
-  name: optipng
+  name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '1.11'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '1.11'
 - !ruby/object:Gem::Dependency
-  name: nokogiri
+  name: optipng
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: streamio-ffmpeg
   requirement: !ruby/object:Gem::Requirement
@@ -95,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