xferase 0.1.4 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 445f21fea4fd88d2e7d5f2a90909837d7ad87cfaac4ab0f203d946a40baa54e2
-  data.tar.gz: daf77691cc61be839ea0a347243768c2662364d3b1f9a6585182cac1e412aa3a
+  metadata.gz: 8cfeb3a0c461ed62ea34b8e80475afb578f8106c612c4adea4d9b3ed3ccc8f8d
+  data.tar.gz: e5705058a3493f17747960340db567a72d5baa54594a5fe7584d651f3e42f954
 SHA512:
-  metadata.gz: 3bc5e2922cc0a0286c4d73c0547a7d91135e16f99e18e939c28eba2269b4a95dc3c41a49cac06a76639c552968b9dfe29bbd213b99ec00d6cec3c495481896de
-  data.tar.gz: 322c2a45cd9e233f77ffbee6807477ef7483afb9252bea8f9f828cdf6587fdeb9f7706ead6aed4cf716648f2caaf0c1d56aa183d9889896d93ed5cdddfb69170
+  metadata.gz: d04eb91e1238fe7cdeada301402ebcd2c38abef8cac5725d741dc62c887fc964679a5b44c0e84840c3d150c100fcefbfa83d1943c83d126b1ed1b62f7a384d25
+  data.tar.gz: aa4d7503e35ca5e64b0a83576e948f464196899b45eea371b5a2792c6d76c159f68df368e8c0ecfa00a299971c668c823fcc73dd5ccbd1dcc1ae512430704fdd

data/README.md

@@ -221,6 +221,33 @@ it will be automatically deleted from the other.
 > if you shoot RAW+JPEG, deleting a .jpg will cause Xferase to delete the
 > corresponding raw image file (and vice versa).
 
+#### Better yet: Using Docker Compose
+
+With [Docker Compose][], you can store your deployment parameters
+in a static configuration file:
+
+```yaml
+# docker-compose.yml
+
+version: '3.4'
+
+services:
+  xferase:
+    image: rlue/xferase:latest
+    container_name: xferase
+    user: 1000:1000
+    environment:
+      TZ: America/Los_Angeles
+      INBOX: /data/.inbox
+      LIBRARY: /data/master
+      LIBRARY_WEB: /data/web
+    volumes:
+      - $HOME/Pictures:/data
+    restart: unless-stopped
+```
+
+[Docker Compose]: https://docs.docker.com/compose/
+
 Guides
 ------
 
@@ -237,6 +264,46 @@ Guides
 
 * [🖥️🔄📱 Sync your library (back) to other devices](guides/propagate.md)
 
+Bonus Features
+--------------
+
+Whenever you’re shooting on devices that need their clocks set manually,
+the timestamps on all your stuff can end up out of whack. For instance:
+
+* I often forget to adjust the clock on my camera when DST changes,
+  or when I fly across time zones.
+  In these cases, you will want to **shift timestamps**
+  by some fixed number of hours.
+
+  To apply this change automatically during import,
+  simply place your files in a directory named `shift-timestamp:<n>h`
+  (where `<n>` is an integer number of hours to shift by; _e.g.,_ `4` or `-8`).
+
+* Video timestamps should always be in UTC,
+  while photo timestamps should always be in local time.
+  (Don’t ask me for a source on this one;
+  supposedly it’s in the EXIF and MP4/MOV specs, which I don’t have access to,
+  but this fact is repeated all over the place on the Exiftool forums.)
+
+  If your camera doesn’t have GPS capabilities
+  or any other way of knowing what time zone it’s in,
+  your video timestamps will _not_ be in UTC.
+  In these cases, you will want to **backfill the missing time zone data**.
+
+  To apply this change automatically during import,
+  simply place your files in a directory named `local-tz:<timezone>`
+  (where `<timezone>` is a [valid IANA time zone][], with colons in place of slashes;
+  _e.g.,_ `America:Argentina:Buenos_Aires` or `Asia:Calcutta`).
+
+  Xferase is smart enough to make the right adjustments when you do this:
+  metadata timestamps will be set to UTC, and filename timestamps will be set to local time.
+
+  [valid IANA time zone]: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List
+
+To apply both changes, simply nest the folders within each other.
+If multiple conflicting directories are found,
+Xferase will use the one nearest to the file being imported.
+
 License
 -------
 

data/bin/xferase

@@ -16,7 +16,7 @@ Photein.logger = Xferase.logger
 
 ENV['MEDIAINFO_XML_PARSER'] ||= 'nokogiri'
 
-FORMAT_GROUPS = [%w(.jpg .dng .heic), %w(.mov .mp4), %w(.png)]
+FORMAT_GROUPS = [%w(.jpg .dng), %w(.heic), %w(.mov .mp4), %w(.png)]
 
 # Setup ------------------------------------------------------------------------
 require 'debouncer'
@@ -45,14 +45,16 @@ def import(file)
            Pathname(file)
          end.cleanpath
 
+  opts = Xferase::Config.extract_photein_opts(file)
+
   return unless file.exist?
   return if file.basename.fnmatch?('.*')
   return if file.dirname.join(".syncthing.#{file.basename}.tmp").exist?
 
   Xferase.logger.debug("#{file.basename}: new file detected in watch directory; importing...")
 
-  Photein::MediaFile.for(file)&.import ||
-    Xferase.logger.debug("#{file.basename}: unrecognize media type")
+  Photein::MediaFile.for(file, opts: opts)&.import ||
+    Xferase.logger.debug("#{file.basename}: unrecognized media type")
 rescue => e
   warn e.message
 end

data/lib/xferase/config.rb

@@ -3,6 +3,8 @@
 require 'singleton'
 require 'optparse'
 
+require 'photein/config'
+
 module Xferase
   class Config
     include Singleton
@@ -56,6 +58,36 @@ module Xferase
       def respond_to_missing?(m, *args)
         @params.key?(m.to_s.tr('_', '-').to_sym) || super
       end
+
+      def extract_photein_opts(path)
+        path.to_s.split('/')
+          .grep(/^(shift-timestamp|local-tz):.+$/)
+          .map { |opt| opt.split(':', 2) }
+          .select(&method(:validate_photein_opt))
+          .map(&method(:normalize_photein_opt)).to_h
+      end
+
+      private
+
+      def validate_photein_opt(opt)
+        case opt.first
+        when 'shift-timestamp'
+          opt.last.match?(/^[+-]?\d+h$/)
+        when 'local-tz'
+          Photein::Config::TZ_GEOCOORDS
+            .transform_keys(&:downcase)
+            .key?(opt.last.tr(':', '/').downcase)
+        end
+      end
+
+      def normalize_photein_opt(opt)
+        case opt.first
+        when 'shift-timestamp'
+          [:shift_timestamp, opt.last.tr('+h', '')]
+        when 'local-tz'
+          [:local_tz, opt.last.tr(':', '/')]
+        end
+      end
     end
   end
 end

data/lib/xferase/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Xferase
-  VERSION = '0.1.4'
+  VERSION = '0.1.6'
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: xferase
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.6
 platform: ruby
 authors:
 - Ryan Lue
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-06 00:00:00.000000000 Z
+date: 2025-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: debouncer
@@ -30,20 +29,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.5
+        version: 0.2.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.5
+        version: 0.2.5
 - !ruby/object:Gem::Dependency
   name: rb-inotify
   requirement: !ruby/object:Gem::Requirement
@@ -104,7 +103,6 @@ licenses:
 - MIT
 metadata:
   source_code_uri: https://github.com/rlue/xferase
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -119,8 +117,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Import/rename photos & videos from one directory to another.
 test_files: []