photein 0.2.0 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 362d9c0535398b17f736549119b3079e52fdc7c22451014d8039b1ff7172914f
-  data.tar.gz: f2a87140f5c536f5bc36663bf7d40c42314199ec3a3247d88a2b619507a360c6
+  metadata.gz: 786766a470966476665ebc0ef22d7cbd939c7b78eb184f0af98037dd1b24f20d
+  data.tar.gz: b70c2a242e2ede4206460e2f99c0b612709531baf80edfaa58c5f6e7f6df7376
 SHA512:
-  metadata.gz: 93814ee95d41d740892978276ed15863daa8832a4c6d4dcc62cbda22d114781e910d74fdbacbb508a78dce9cbbd1e14c5f9c131215b680c3c11865863dc11d18
-  data.tar.gz: 31384d711c87386c22b52439985ce4aec5d4d413ab8271e184f0b32cd4dad1f2628d0d88bf74f27e0a248beb304b45d0b33f20961e33b72e343cbe8affdcc7e7
+  metadata.gz: cbf4010ed2ed511a248072ce94a7c558203d4b24df56d8c7809c23be55613523543d631cf4c13b4c6be03443e6d3cfb8c42139b02e272d5464eb236c56c9847a
+  data.tar.gz: 45c7f373992b3b4a36f0c7d89e041fbf22beef6140dc8ec48b046e318ded6eb85d1529cf3f767129bab45e74979c1a3681778cdde5102d5eab5bada0ba7d7253

data/lib/photein/config.rb

@@ -1,15 +1,12 @@
 # frozen_string_literal: true
 
 require 'json'
-require 'singleton'
 require 'optparse'
 
 require 'tzinfo'
 
 module Photein
   class Config
-    include Singleton
-
     OPTIONS = [
       ['-v',             '--verbose',                 'print verbose output'],
       ['-s SOURCE',      '--source=SOURCE',           'path to the source directory'],
@@ -38,11 +35,75 @@ module Photein
       .then(&JSON.method(:parse))
       .freeze
 
-    @params = {}
+    def initialize(params = {})
+      @params = params
+    end
+
+    def validate_params!
+      @params[:verbose] ||= @params[:'dry-run']
+
+      if @params.key?(:'shift-timestamp') && !@params[:'shift-timestamp'].match?(/^-?\d+$/)
+        raise "invalid --shift-timestamp option (must be integer)"
+      end
+
+      if @params.key?(:'local-tz')
+        if !TZInfo::Timezone.all_identifiers.include?(@params[:'local-tz'])
+          raise 'invalid --local-tz option (must be from IANA tz database)'
+        end
+
+        if tz_coordinates.nil?
+          raise 'invalid --local-tz option (must reference a location)'
+        end
+      end
+
+      @params.freeze
+
+      (%i[library-master library-desktop library-web] & @params.keys)
+        .then { |dest_dirs| raise "no destination directory given" if dest_dirs.empty? }
+    end
+
+    def method_missing(m, *args, &blk)
+      case m = m.to_s.tr('_', '-').to_sym
+      when *OPTION_NAMES
+        @params[m]
+      when *OPTION_NAMES.map { |opt| "#{opt}=" }.map(&:to_sym)
+        @params[m.sub(/=$/, '')] = args.shift
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(m, *args)
+      OPTION_NAMES.include?(m.to_s.tr('_', '-').sub(/=$/, '').to_sym) || super
+    end
+
+    def source
+      @source ||= Pathname(@params[:source])
+    end
+
+    def destinations
+      @destinations ||= {
+        master:  @params[:'library-master'],
+        desktop: @params[:'library-desktop'],
+        web:     @params[:'library-web']
+      }.compact.transform_values(&Pathname.method(:new))
+    end
+
+    def timestamp_delta
+      @timestamp_delta ||= @params[:'shift-timestamp'].to_i * SECONDS_PER_HOUR
+    end
+
+    def local_tz
+      @local_tz ||= @params[:'local-tz']&.then(&TZInfo::Timezone.method(:get))
+    end
+
+    def tz_coordinates
+      @tz_coordinates ||= TZ_GEOCOORDS[@params[:'local-tz']]
+    end
 
     class << self
-      def set(**params)
-        @params.replace(params)
+      def base_config
+        @base_config ||= Photein::Config.new
       end
 
       def parse_opts!
@@ -53,72 +114,40 @@ module Photein
           BANNER
 
           OPTIONS.each { |opt| opts.on(*opt) }
-        end.tap { |p| p.parse!(into: @params) }
-
-        @params[:verbose] ||= @params[:'dry-run']
+        end.tap { |p| p.parse!(into: base_config.instance_variable_get('@params')) }
 
-        raise "invalid --shift-timestamp option (must be integer)" if @params.key?(:'shift-timestamp') && !@params[:'shift-timestamp'].match?(/^-?\d+$/)
-
-        if @params.key?(:'local-tz')
-          if !TZInfo::Timezone.all_identifiers.include?(@params[:'local-tz'])
-            raise 'invalid --local-tz option (must be from IANA tz database)'
-          end
-
-          if tz_coordinates.nil?
-            raise 'invalid --local-tz option (must reference a location)'
-          end
+        # This param is only required on the base config
+        if !base_config.instance_variable_get('@params').key?(:source)
+          raise "no source directory given"
         end
 
-        @params.freeze
-
-        raise "no source directory given" if !@params.key?(:source)
-        (%i[library-master library-desktop library-web] & @params.keys)
-          .then { |dest_dirs| raise "no destination directory given" if dest_dirs.empty? }
+        base_config.validate_params!
       rescue => e
         warn("#{parser.program_name}: #{e.message}")
         warn(parser.help) if e.is_a?(OptionParser::ParseError)
         exit 1
       end
 
-      def [](key)
-        @params[key]
-      end
-
-      def method_missing(m, *args, &blk)
-        m.to_s.tr('_', '-').to_sym
-          .then { |key| OPTION_NAMES.include?(key) ? self[key] : super }
-      end
-
-      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:  @params[:'library-master'],
-          desktop: @params[:'library-desktop'],
-          web:     @params[:'library-web']
-        }.compact.transform_values(&Pathname.method(:new))
+      # Do not remove! Used in https://github.com/rlue/xferase
+      def set(**params)
+        base_config.instance_variable_get('@params').replace(params)
       end
 
-      def timestamp_delta
-        @timestamp_delta ||= @params[:'shift-timestamp'].to_i * SECONDS_PER_HOUR
+      def with(opts)
+        opts.transform_keys { |k| k.to_s.tr('_', '-').to_sym }
+          .then(&base_config.instance_variable_get('@params').method(:merge))
+          .then(&Photein::Config.method(:new))
+          .tap(&:validate_params!)
       end
 
-      def local_tz
-        return @local_tz if defined? @local_tz
+      def method_missing(m, *args, &blk)
+        return super unless m.to_s.tr('_', '-').sub(/=$/, '').to_sym
 
-        @local_tz = @params.key?(:'local-tz') ? TZInfo::Timezone.get(@params[:'local-tz']) : nil
+        base_config.send(m, *args)
       end
 
-      def tz_coordinates
-        return @tz_coordinates if defined? @tz_coordinates
-
-        @tz_coordinates = @params.key?(:'local-tz') ? TZ_GEOCOORDS[@params[:'local-tz']] : nil
+      def respond_to_missing?(m, *args)
+        base_config.respond_to?(m) || super
       end
     end
   end

data/lib/photein/image.rb

@@ -39,12 +39,12 @@ module Photein
           convert.resize("#{MAX_RES_WEB}@>")
           convert.sampling_factor('4:2:0')
           convert << tempfile
-        end unless Photein::Config.dry_run
+        end unless config.dry_run
       when '.png'
-        FileUtils.cp(path, tempfile, noop: Photein::Config.dry_run)
+        FileUtils.cp(path, tempfile, noop: config.dry_run)
         Photein.logger.info "optimizing #{path}"
         begin
-          Optipng.optimize(tempfile, level: 4) unless Photein::Config.dry_run
+          Optipng.optimize(tempfile, level: 4) unless config.dry_run
         rescue Errno::ENOENT
           Photein.logger.error('optipng is required to compress PNG images')
           raise
@@ -102,16 +102,16 @@ module Photein
     end
 
     def update_exif_tags(path)
-      return if Photein::Config.timestamp_delta.zero? && Photein::Config.local_tz.nil?
+      return if config.timestamp_delta.zero? && config.local_tz.nil?
 
       file = MiniExiftool.new(path)
-      file.all_dates = new_timestamp.strftime('%Y:%m:%d %H:%M:%S') if Photein::Config.timestamp_delta != 0
+      file.all_dates = new_timestamp.strftime('%Y:%m:%d %H:%M:%S') if config.timestamp_delta != 0
 
-      if !Photein::Config.local_tz.nil?
+      if !config.local_tz.nil?
         new_timestamp.to_s                                           # "2020-02-14 22:55:30 -0800"
           .split.tap(&:pop).join(' ').then { |time| time + ' UTC' }  # "2020-02-14 22:55:30 UTC"
           .then(&Time.method(:parse))                                # 2020-02-14 22:55:30 UTC
-          .then(&Photein::Config.local_tz.method(:to_local))         # 2020-02-14 22:55:30 +0800
+          .then(&config.local_tz.method(:to_local))                  # 2020-02-14 22:55:30 +0800
           .strftime('%z').insert(3, ':')                             # "+08:00"
           .tap { |offset| file.offset_time = offset }
           .tap { |offset| file.offset_time_digitized = offset }

data/lib/photein/media_file.rb

@@ -13,18 +13,20 @@ module Photein
       '.jpeg' => '.jpg'
     }.freeze
 
+    attr_reader :config
     attr_reader :path
 
-    def initialize(path)
+    def initialize(path, opts: {})
       @path = Pathname(path)
+      @config = Photein::Config.with(opts)
     end
 
     def import
       return if corrupted?
-      return if Photein::Config.interactive && denied_by_user?
-      return if Photein::Config.safe && in_use?
+      return if config.interactive && denied_by_user?
+      return if config.safe && in_use?
 
-      Photein::Config.destinations.map do |lib_type, lib_path|
+      config.destinations.map do |lib_type, lib_path|
         next if non_optimizable_format?(lib_type)
 
         Thread.new do
@@ -41,23 +43,23 @@ module Photein
           optimize(tempfile: tempfile, lib_type: lib_type)
 
           Photein.logger.info(<<~MSG.chomp)
-            #{Photein::Config.keep ? 'copying' : 'moving'} #{path.basename} to #{dest_path}
+            #{config.keep ? 'copying' : 'moving'} #{path.basename} to #{dest_path}
           MSG
 
-          FileUtils.mkdir_p(dest_path.dirname, noop: Photein::Config.dry_run)
+          FileUtils.mkdir_p(dest_path.dirname, noop: config.dry_run)
 
           if File.exist?(tempfile)
-            FileUtils.mv(tempfile, dest_path, noop: Photein::Config.dry_run)
+            FileUtils.mv(tempfile, dest_path, noop: config.dry_run)
           else
-            FileUtils.cp(path, dest_path, noop: Photein::Config.dry_run)
-            FileUtils.chmod('-x', dest_path, noop: Photein::Config.dry_run)
+            FileUtils.cp(path, dest_path, noop: config.dry_run)
+            FileUtils.chmod('-x', dest_path, noop: config.dry_run)
           end
 
-          update_exif_tags(dest_path.realdirpath.to_s) if !Photein::Config.dry_run
+          update_exif_tags(dest_path.realdirpath.to_s) if !config.dry_run
         end
       end.compact.map(&:join).then do |threads|
         # e.g.: with --library-web only, .dngs are skipped, so DON'T DELETE!
-        FileUtils.rm(path, noop: threads.empty? || Photein::Config.dry_run || Photein::Config.keep)
+        FileUtils.rm(path, noop: threads.empty? || config.dry_run || config.keep)
       end
     end
 
@@ -93,7 +95,7 @@ module Photein
         timestamp_from_metadata ||
         timestamp_from_filename ||
         timestamp_from_filesystem
-      ) + Photein::Config.timestamp_delta
+      ) + config.timestamp_delta
     end
 
     def timestamp_from_metadata
@@ -143,13 +145,13 @@ module Photein
     end
 
     class << self
-      def for(file)
+      def for(file, opts: {})
         file = Pathname(file)
         raise Errno::ENOENT, "#{file}" unless file.exist?
 
         [Image, Video].find { |type| type::SUPPORTED_FORMATS.include?(file.extname.downcase) }
                       .tap { |type| raise ArgumentError, "#{file}: Invalid media file" if type.nil? }
-                      .then { |type| type.new(file) }
+                      .then { |type| type.new(file, opts: opts) }
       end
     end
   end

data/lib/photein/version.rb

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

data/lib/photein/video.rb

@@ -44,7 +44,7 @@ module Photein
       return if video.bitrate < BITRATE_THRESHOLD[lib_type]
 
       Photein.logger.info("transcoding #{tempfile}")
-      return if Photein::Config.dry_run
+      return if config.dry_run
 
       video.transcode(
         tempfile.to_s,
@@ -110,7 +110,7 @@ module Photein
     def local_tz
       @local_tz ||= ActiveSupport::TimeZone[
         MiniExiftool.new(path).then(&method(:gps_coords))&.then(&method(:coords_to_tz)) ||
-        Photein::Config.local_tz ||
+        config.local_tz ||
         Time.now.gmt_offset
       ]
     end
@@ -144,12 +144,12 @@ module Photein
     end
 
     def update_exif_tags(path)
-      return if Photein::Config.timestamp_delta.zero? && Photein::Config.local_tz.nil?
+      return if config.timestamp_delta.zero? && config.local_tz.nil?
 
       args = []
-      args.push("-AllDates=#{new_timestamp.strftime('%Y:%m:%d\\ %H:%M:%S')}") if Photein::Config.timestamp_delta != 0
+      args.push("-AllDates=#{new_timestamp.strftime('%Y:%m:%d\\ %H:%M:%S')}") if config.timestamp_delta != 0
 
-      if (lat, lon = Photein::Config.tz_coordinates)
+      if (lat, lon = config.tz_coordinates)
         args.push("-xmp:GPSLatitude=#{lat}")
         args.push("-xmp:GPSLongitude=#{lon}")
       end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: photein
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.6
 platform: ruby
 authors:
 - Ryan Lue
 bindir: bin
 cert_chain: []
-date: 2024-12-31 00:00:00.000000000 Z
+date: 2025-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -57,14 +57,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.10'
+        version: '2.14'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.10'
+        version: '2.14'
 - !ruby/object:Gem::Dependency
   name: mini_magick
   requirement: !ruby/object:Gem::Requirement