xferase 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb45d4b708f6d607c40971f8081a4778d45887fdd3f5b6a16e4d3b7ada1b809b
-  data.tar.gz: ff1906f90f5b01b0b47c0f197444d546ac00fef6203d6225bf116fb2ff9e6187
+  metadata.gz: 5e4ee12b6ba1f07b205460d2daa0a7ff4f56b476461d2ea9a0986a0645adc475
+  data.tar.gz: 78164aaafee6b8c6815758c3d73d3344444e67076671ca9f8e10252f3237d0ce
 SHA512:
-  metadata.gz: e7c192878a8a3f13634d2b203edff06e2818cccb0dd79e1df9518ddf257e0397769a27c3f76ec6190da759cdde9b65da73c04c1c21c774056835f75eef3e4b88
-  data.tar.gz: 7c279579641f9e91866971167eb0aa75a1231dde5f983c3b474bd91d0c402fb164cd5c8f7f8053403b91764444cbdbfa45f3f617ccd00e0f3f8314aa17749767
+  metadata.gz: adb329f1d30f204f5b9c66b9cb7d26e0244a699eb13c7366a18450872d8c4b60e00eee0733fd8bf51d377965e4476679bf55733b515aa2368d3fe2faf9b905d0
+  data.tar.gz: 309f9dffbf7711fba3c921384a304a13ae2597377f46e36b6567665be728983498b1a4d075f1271012b292b55e12579e95f4719b3def5a1c4c1885cf5961a3a0

data/README.md

@@ -186,21 +186,14 @@ $ docker run -d \
     --env TZ=$(timedatectl show --property=Timezone --value) \
     --volume $HOME/Pictures:/data \
     --env INBOX=/data/.inbox \
-    --env STAGING=/data/.staging \
     --env LIBRARY=/data/master \
     rlue/xferase
 ```
 
 Any photos or videos placed in the **inbox**
-will be automatically moved to the **staging folder** for processing.
-From there, files are moved to the **library**,
+will be automatically moved to the **library**,
 with videos being compressed to save space on disk.
 
-> 🤔 **What’s with the staging folder?**
->
-> Using a temp folder makes it easier to resume from a crash,
-> especially when the `LIBRARY_WEB` env var is set.
-
 #### Option: `LIBRARY_WEB`
 
 ```sh
@@ -210,7 +203,6 @@ $ docker run -d \
     --env TZ=$(timedatectl show --property=Timezone --value) \
     --volume $HOME/Pictures:/data \
     --env INBOX=/data/.inbox \
-    --env STAGING=/data/.staging \
     --env LIBRARY=/data/master \
     --env LIBRARY_WEB=/data/web \
     rlue/xferase
@@ -229,30 +221,6 @@ 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).
 
-#### Option: `GRACE_PERIOD`
-
-```sh
-$ docker run -d \
-    --name xferase \
-    --user $(id -u) \
-    --env TZ=$(timedatectl show --property=Timezone --value) \
-    --volume $HOME/Pictures:/data \
-    --env INBOX=/data/.inbox \
-    --env STAGING=/data/.staging \
-    --env LIBRARY=/data/master \
-    --env LIBRARY_WEB=/data/web \
-    --env GRACE_PERIOD=60 \
-    rlue/xferase
-```
-
-Xferase will wait 60 seconds before initiating the import process.
-
-Why would you want this?
-Because not every picture you take belongs in your collection—maybe
-you just wanted to show a friend a weird bug you found on the sidewalk.
-With the grace period set, you can film it, send it off, and delete it
-before Xferase wastes CPU time transcoding it (twice).
-
 Guides
 ------
 

data/bin/xferase

@@ -7,15 +7,15 @@ require 'photein'
 
 Xferase::Config.parse_opts!
 Xferase.logger.open
+
+Photein::Config.set(
+  'library-desktop': Xferase::Config.library,
+  'library-web': Xferase::Config.library_web,
+)
 Photein.logger = Xferase.logger
 
 ENV['MEDIAINFO_XML_PARSER'] ||= 'nokogiri'
 
-SRC_DEST_MAP = {
-  "#{Xferase::Config.staging}/desktop" => Xferase::Config.library,
-  "#{Xferase::Config.staging}/web" => Xferase::Config.library_web,
-}.compact
-
 FORMAT_GROUPS = [%w(.jpg .dng .heic), %w(.mov .mp4), %w(.png)]
 
 # Setup ------------------------------------------------------------------------
@@ -25,7 +25,7 @@ require 'pathname'
 require 'rb-inotify'
 require 'tmpdir'
 
-%i[inbox staging library library_web]
+%i[inbox library library_web]
   .map { |dir| Xferase::Config.send(dir) }
   .compact
   .reject(&File.method(:directory?))
@@ -36,102 +36,81 @@ require 'tmpdir'
 
 Thread.abort_on_exception = true
 
-mutex = Mutex.new
-debouncer = Debouncer.new(Xferase::Config.grace_period.to_i) do |*files|
-  files = files.map(&Pathname.method(:new))
-               .select(&:exist?)
-               .reject do |file|
-                 file.dirname.join(".syncthing.#{file.basename}.tmp").exist?
-               end
-
-  SRC_DEST_MAP.keys.each { |dir| FileUtils.ln(files, dir) }
-  FileUtils.rm(files + Dir["#{Xferase::Config.staging}/web/*.DNG"]) # FIXME (ugly hack)
-
-  break if debouncer.inspect_params[:threads] > 2 # don't let threads pile up
-
-  mutex.synchronize do
-    SRC_DEST_MAP.each do |src, dest|
-      Photein::Config.set(
-        source: src,
-        dest: dest,
-        'optimize-for': Pathname(src).basename.to_sym
-      )
-
-      Photein.run
-    end
-  rescue => e
-    warn e.message
-  end
-end.reducer(:+)
+# Helper methods ---------------------------------------------------------------
+def import(file)
+  file = case file
+         when INotify::Event
+           Pathname(file.absolute_name)
+         else
+           Pathname(file)
+         end.cleanpath
+
+  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")
+rescue => e
+  warn e.message
+end
 
-# Resume from interruption/failure ---------------------------------------------
-debouncer.call unless SRC_DEST_MAP.keys.all?(&Dir.method(:empty?))
+def sync_deletions(event)
+  Xferase.logger.info("#{event.name} has disappeared!")
 
-Dir["#{Xferase::Config.inbox}/**/*"]
-  .select(&File.method(:file?))
-  .each { |path| debouncer.call(path) }
+  deleted_file   = Pathname(event.absolute_name).expand_path
 
-# Start ------------------------------------------------------------------------
-Thread.new do
-  call_debouncer = ->(event) do
-    next if event.name.start_with?('.')
+  sister_file    = if deleted_file.to_s.start_with?(File.expand_path(Xferase::Config.library))
+                    deleted_file.sub(Xferase::Config.library, Xferase::Config.library_web)
+                  else
+                    deleted_file.sub(Xferase::Config.library_web, Xferase::Config.library)
+                  end
 
-    Xferase.logger.debug("#{event.name}: new file detected in watch directory")
-    debouncer.call(event.absolute_name)
-  rescue => e
-    warn e.message
-  end
+  sister_formats = FORMAT_GROUPS.find { |group| group.include?(deleted_file.extname) }
 
-  import_notifier = INotify::Notifier.new
-  import_notifier.watch(Xferase::Config.inbox, :close_write, &call_debouncer)
+  related_files  = [deleted_file, sister_file]
+    .product(sister_formats)
+    .map { |file, ext| file.sub_ext(ext) }
+    .select(&:file?)
 
-  # NOTE: inotify is not recursive,
-  # so subdirectories must be watched separately!
-  # (Why do Syncthing folders get special treatment?
-  # Because ST works by creating hidden tempfiles and moving them upon completion)
-  stfolders, simple_subdirs = Dir["#{Xferase::Config.inbox}/**/*"]
-    .select(&File.method(:directory?))
-    .partition { |dir| Dir.children(dir).include?('.stfolder') }
+  # (Why mv to tmpdir first? Why not rm straight away?
+  # Because rm would recursively trigger this inotify callback.)
+  related_files.each { |f| Xferase.logger.info("deleting #{f.realpath}") }
+  FileUtils.mv(related_files, Dir.tmpdir)
+  FileUtils.rm(related_files.map { |f| File.join(Dir.tmpdir, f.basename) })
+end
 
-  simple_subdirs.each { |dir| import_notifier.watch(dir, :close_write, &call_debouncer) }
-  stfolders.each { |dir| import_notifier.watch(dir, :moved_to, &call_debouncer) }
+# Resume from interruption/failure ---------------------------------------------
+Dir["#{Xferase::Config.inbox}/**/*"].sort
+  .select(&File.method(:file?))
+  .each(&method(:import))
 
-  import_notifier.run
+# Start ------------------------------------------------------------------------
+Thread.new do
+  INotify::Notifier.new.tap do |import_notifier|
+    import_notifier.watch(Xferase::Config.inbox, :close_write, &method(:import))
+
+    # NOTE: inotify is not recursive,
+    # so subdirectories must be watched separately!
+    # (Why do Syncthing folders get special treatment?
+    # Because ST works by creating hidden tempfiles and moving them upon completion)
+    stfolders, simple_subdirs = Dir["#{Xferase::Config.inbox}/**/*"]
+      .select(&File.method(:directory?))
+      .partition { |dir| Dir.children(dir).include?('.stfolder') }
+
+    simple_subdirs.each { |dir| import_notifier.watch(dir, :close_write, &method(:import)) }
+    stfolders.each { |dir| import_notifier.watch(dir, :moved_to, &method(:import)) }
+  end.run
 end
 
 Thread.new do
-  sync_deletions = ->(event) do
-    Xferase.logger.info("#{event.name} has disappeared!")
-
-    deleted_file   = Pathname(event.absolute_name).expand_path
-
-    sister_file    = if deleted_file.to_s.start_with?(File.expand_path(Xferase::Config.library))
-                      deleted_file.sub(Xferase::Config.library, Xferase::Config.library_web)
-                    else
-                      deleted_file.sub(Xferase::Config.library_web, Xferase::Config.library)
-                    end
-
-    sister_formats = FORMAT_GROUPS.find { |group| group.include?(deleted_file.extname) }
-
-    related_files  = [deleted_file, sister_file]
-      .product(sister_formats)
-      .map { |file, ext| file.sub_ext(ext) }
-      .select(&:file?)
-
-    # (Why mv to tmpdir first? Why not rm straight away?
-    # Because rm would recursively trigger this inotify callback.)
-    related_files.each { |f| Xferase.logger.info("deleting #{f.realpath}") }
-    FileUtils.mv(related_files, Dir.tmpdir)
-    FileUtils.rm(related_files.map { |f| File.join(Dir.tmpdir, f.basename) })
-  end
-
-  deletion_notifier = INotify::Notifier.new
-
-  # NOTE: inotify is not recursive,
-  # so subdirectories must be watched separately!
-  (Dir["#{Xferase::Config.library}/**/*"] + Dir["#{Xferase::Config.library_web}/**/*"])
-    .select(&File.method(:directory?))
-    .each { |dir| deletion_notifier.watch(dir, :delete, &sync_deletions) }
-
-  deletion_notifier.run
+  INotify::Notifier.new.tap do |deletion_notifier|
+    # NOTE: inotify is not recursive,
+    # so subdirectories must be watched separately!
+    (Dir["#{Xferase::Config.library}/**/*"] + Dir["#{Xferase::Config.library_web}/**/*"])
+      .select(&File.method(:directory?))
+      .each { |dir| deletion_notifier.watch(dir, :delete, &method(:sync_deletions)) }
+  end.run
 end.join

data/lib/xferase/config.rb

@@ -10,10 +10,8 @@ module Xferase
     OPTIONS = [
       ['-v',              '--verbose',                 'print verbose output'],
       ['-i INBOX',        '--inbox=INBOX',             'path to the inbox (required)'],
-      ['-s STAGING',      '--staging=STAGING',         'path to the staging directory (required)'],
       ['-l LIBRARY',      '--library=LIBRARY',         'path to the master library (required)'],
       ['-w LIBRARY_WEB',  '--library-web=LIBRARY_WEB', 'path to the web-optimized library'],
-      ['-g INTERVAL',     '--grace-period=INTERVAL',   'wait n seconds for additional files before import'],
     ].freeze
 
     OPTION_NAMES = OPTIONS
@@ -38,8 +36,8 @@ module Xferase
         @params.freeze
 
         raise "no inbox directory given" if !@params.key?(:inbox)
-        raise "no staging directory given" if !@params.key?(:staging)
-        raise "no master library given" if !@params.key?(:library)
+        (%i[library library-web] & @params.keys)
+          .then { |dest_dirs| raise "no destination library given" if dest_dirs.empty? }
       rescue => e
         warn("#{parser.program_name}: #{e.message}")
         warn(parser.help) if e.is_a?(OptionParser::ParseError)

data/lib/xferase/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xferase
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Ryan Lue
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-07 00:00:00.000000000 Z
+date: 2021-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: debouncer
@@ -30,20 +30,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.0'
+        version: '0.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.9
+        version: 0.1.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.0'
+        version: '0.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.9
+        version: 0.1.2
 - !ruby/object:Gem::Dependency
   name: rb-inotify
   requirement: !ruby/object:Gem::Requirement