libis-format 1.3.3 → 1.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e8f7ecb168b9a5db9a47b91035c1f8988c8a079963ad0764e23ad00b2bde61b1
-  data.tar.gz: 2fecf5a7eb4f0a74573d8182111dac6bb4abc05e9c8d22c248b79cc6533a93ef
+  metadata.gz: 5fb1b156976a67b10d6885880a0611ba8361671c24da8014e7e11d7840be6318
+  data.tar.gz: 1f5e6e9b1cd84031a5a1ae986a2d0de018bb021bb48d47d6d83c9feea1e8db59
 SHA512:
-  metadata.gz: 4ea0eced4ca98790237cbb936cd347964693a0b5d627e9564fb184621d018868d69e6208c5afc2cbaf78db096e5a7342fa42af9604921bf411b3b2c70c4e8722
-  data.tar.gz: 339f5f89b61747862d2f005ede140300f09ae8ab9aee4693d0214edac3bfba52b8f8b2eaa04b9e1e499debdee805403f1e8434c3ef7907d4ea0ae86e54bdc01f
+  metadata.gz: 364036443664fc6597d36456c554e25074926515c2b95c7475a93499a27389bc0a2d8749ba86f5cb29e47b50c41902780518b780abde202f0d69f2e3a550cf24
+  data.tar.gz: b7d5823c3da6b25a71b2d7c3a2b05a9b15042e562985775b357490ccadabc457e0784136c1e269030f7211c94e3926a2000857efa03472cb9ca05f013f25128c

data/lib/libis/format/converter/image_converter.rb

@@ -9,10 +9,6 @@ require 'fileutils'
 MiniMagick.logger.level = ::Logger::UNKNOWN
 
 MiniMagick.configure do |config|
-  # config.cli = :graphicsmagick
-  config.validate_on_create = false
-  config.validate_on_write = false
-  config.whiny = false
   config.tmpdir = Libis::Format::Config[:tempdir] || Dir.tmpdir
 end
 
@@ -90,20 +86,15 @@ module Libis
 
         # Create or use a watermark image.
         #
-        # The watermark options are:
-        #     - file: watermark image to use
+        # The watermark options are (use symbols):
         #     - text: text to create a watermark from
-        #     - rotation: rotation of the watermark text (counter clockwise in degrees; integer number) - default 30
-        #     - tiles: number of tiles of the watermark - default 4
-        #       - 0: no tiling, so only 1 watermark will be placed with the original size
-        #       - 1: 1 tile, so the watermark will be scaled up to fill the image
-        #       - n > 1: minimum n tiles in both directions
-        #       - n < 0: tile without scaling the watermark
-        #     - size: same as tiles - for backwards compatibility
-        #     - resize: fraction 0.0 - 1.0
-        #     - gap: size of the gap between watermark instances. Fractions as percentage of widht/height. - default 0.2
-        #     - opacity: opacity of the watermark (fraction 0.0 - 1.0) - default 0.1
-        #     - gravity: center point of the overlay - default 'center'
+        #     - file: watermark image to use
+        #     - image: same as above
+        #     - rotation: rotation of the watermark text (in degrees; integer number)
+        #     - size: font size of the watermark text
+        #     - opacity: opacity of the watermark (fraction 0.0 - 1.0)
+        #     - gap: size of the gap between watermark instances. Integer value is absolute size in points (1/72 inch).
+        #            Fractions are percentage of widht/height.
         # If both options are given, the file will be used as-is if it exists and is a valid image file. Otherwise the
         # file will be created or overwritten with a newly created watermark image.
         #
@@ -111,44 +102,95 @@ module Libis
         # slanted by 30 degrees counter-clockwise.
         #
         # @param [Hash] options Hash of options for watermark creation.
+
         def watermark(options = {})
-          text = options[:text] || '© LIBIS'
-          @wm_tiles = (options[:tiles] || '4').to_i
-          @wm_tiles ||= (options[:size] || '4').to_i
-          @wm_resize = ((options[:resize]).to_f * 100).to_i if options[:resize]
-          @wm_opacity = ((options[:opacity] || 0.1).to_f * 100).to_i
-          @wm_composition = options[:composition] || 'modulate'
-          @wm_gravity = options[:gravity] || 'center'
-          @wm_gap = ((options[:gap] || 0.2).to_f * 100).to_i
-          rotation = 360 - (options[:rotation] || 30).to_i
-          @wm_image = MiniMagick::Image.new(options[:file]) if options[:file]
-          return if @wm_image&.valid?
-
-          image = options[:file] || (Dir::Tmpname.create(%w[wm_image .png]) { |_| })
-          # noinspection RubyResolve
-          MiniMagick::Tool::Convert.new do |convert|
-            # noinspection RubyLiteralArrayInspection
-            convert.quiet
-            convert.background 'transparent'
-            convert.size('2000x2000')
-            convert.gravity 'Center'
-            convert.font('Helvetica').fill('black').pointsize(72) # .stroke('black').strokewidth(1)
-            convert << "label:#{text}"
-            convert.rotate rotation
-            convert.trim.repage.+ # rubocop:disable Lint/Void
-            convert << image
-          end
-          if options[:file]
-            @wm_image = MiniMagick::Image.new(image)
-          else
-            @wm_image = MiniMagick::Image.open(image)
-            File.delete(image)
+          options.key_strings_to_symbols!
+          if options[:file] || options[:image]
+            watermark_image(options)
+          elsif options[:text]
+            watermark_text(options)
+          elsif options[:banner]
+            watermark_banner(options)
           end
-          # noinspection RubyResolve
-          return if @wm_image.valid?
+        end
 
-          error "Problem creating watermark image '#{image}'."
-          @wm_image = nil
+        # Use an image as watermark
+        #
+        # Next to the :file or :image option, this enables the following options:
+        # - tiles: number of tiles of the watermark - default 4
+        #     0: no tiling, so only 1 watermark will be placed with the original size
+        #     1: 1 tile, so the watermark will be scaled up to fill the image
+        #     n > 1: minimum n tiles in both directions
+        #     n < 0: tile without scaling the watermark
+        # - size: same as tiles - for backwards compatibility
+        # - resize: fraction 0.0 - 1.0
+        # - gap: size of the gap between watermark instances. Fractions as percentage of widht/height. - default 0.2
+        # - opacity: opacity of the watermark (fraction 0.0 - 1.0) - default 0.1
+        # - gravity: center point of the overlay - default 'center'
+        # - composition: algorithm to use to compose both images - default modulate
+        def watermark_image(options = {})
+          options.key_strings_to_symbols!
+          @options[:watermark] = {command: 'image'}
+          @options[:watermark][:data] = options[:file] || options[:image]
+          @options[:watermark][:tiles] = (options[:tiles] || options[:size] || 4).to_i
+          @options[:watermark][:resize] = ((options[:resize]).to_f * 100).to_i if options[:resize]
+          @options[:watermark][:gap] = ((options[:gap] || 0.2).to_f * 100).to_i
+          @options[:watermark][:opacity] = ((options[:opacity] || 0.1).to_f * 100).to_i
+          @options[:watermark][:gravity] = options[:gravity] || 'center'
+          @options[:watermark][:composition] = options[:composition] || 'modulate'
+          @options[:watermark][:rotation] = 360 - (options[:rotation] || 30).to_i
+        end
+
+        # Use text as watermark
+        #
+        # Next to the :text option, this enables the following options:
+        # - tiles: number of tiles of the watermark - default 4
+        #     0: no tiling, so only 1 watermark will be placed with the original size
+        #     1: 1 tile, so the watermark will be scaled up to fill the image
+        #     n > 1: minimum n tiles in both directions
+        #     n < 0: tile without scaling the watermark
+        # - size: same as tiles - for backwards compatibility
+        # - resize: fraction 0.0 - 1.0
+        # - gap: size of the gap between watermark instances. Fractions as percentage of widht/height. - default 0.2
+        # - opacity: opacity of the watermark (fraction 0.0 - 1.0) - default 0.1
+        # - gravity: center point of the overlay - default 'center'
+        # - composition: algorithm to use to compose both images - default modulate
+        # - rotation: rotation of the text
+        def watermark_text(options = {})
+          options.key_strings_to_symbols!
+          @options[:watermark] = {command: 'text'}
+          @options[:watermark][:data] = options[:text] || '© LIBIS'
+          @options[:watermark][:tiles] = (options[:tiles] || options[:size] || 4).to_i
+          @options[:watermark][:resize] = ((options[:resize]).to_f * 100).to_i if options[:resize]
+          @options[:watermark][:gap] = ((options[:gap] || 0.2).to_f * 100).to_i
+          @options[:watermark][:opacity] = ((options[:opacity] || 0.1).to_f * 100).to_i
+          @options[:watermark][:gravity] = options[:gravity] || 'center'
+          @options[:watermark][:composition] = options[:composition] || 'modulate'
+          @options[:watermark][:rotation] = 360 - (options[:rotation] || 30).to_i
+        end
+
+        # Create a vertical banner to the right side of each page
+        #
+        # The banner options are:
+        # - banner: text to put in the banner
+        # - add_filename: append filename to the text (use any value to enable)
+        # - fontsize: size of the font (in points) (default: autoscale)
+        # - width: width of the banner (default: 3% of image height). Not including a border of 30% of the banner width
+        # - background_color_(red|green|blue): color components of background (default: rgb(84,190,233))
+        # - text_color_(red|green|blue): color components of background (default: rgb(255,255,255))
+        def watermark_banner(options = {})
+          options.key_strings_to_symbols!
+          @options[:watermark] = {command: 'banner'}
+          @options[:watermark][:data] = options[:banner] || '© LIBIS'
+          @options[:watermark][:add_filename] = !!options[:add_filename]
+          @options[:watermark][:size] = options[:fontsize] if options[:fontsize]
+          @options[:watermark][:width] = options[:width] if options[:width]
+          @options[:watermark][:background_red] = options[:background_color_red] || 84
+          @options[:watermark][:background_green] = options[:background_color_green] || 190
+          @options[:watermark][:background_blue] = options[:background_color_blue] || 233
+          @options[:watermark][:text_red] = options[:text_color_red] || 255
+          @options[:watermark][:text_green] = options[:text_color_green] || 255
+          @options[:watermark][:text_blue] = options[:text_color_blue] || 255
         end
 
         def convert(source, target, format, opts = {})
@@ -195,7 +237,7 @@ module Libis
             convert_image(path, converted.path, format)
             list << converted
           end
-          MiniMagick::Tool::Convert.new do |b|
+          MiniMagick.convert do |b|
             b.append unless self.class.multipage?(format)
             converted_pages.each { |page| b << page.path }
             b << target
@@ -210,34 +252,84 @@ module Libis
 
         def convert_image(source, target, format)
           image_info = nil
-          image_info = MiniMagick::Image::Info.new(source) { |b| b.quiet } if @wm_image # rubocop:disable Style/SymbolProc
 
-          MiniMagick::Tool::Convert.new do |convert|
+          MiniMagick.convert do |convert|
+            # Make converter silent
             convert.quiet if @quiet
-            if @wm_image
-              convert << @wm_image.path
-              convert.bordercolor('transparent').border("#{@wm_gap}%") if @wm_gap.positive?
-              convert.filter('Lagrange')
-              convert.resize("#{image_info['width'] / @wm_tiles}x#{image_info['height'] / @wm_tiles}") if @wm_tiles.positive?
-              convert.resize("#{@wm_resize}%") if @wm_resize
+
+            # Build watermark image in buffer
+            wm = @options.delete(:watermark)
+            if wm
+              image_info = MiniMagick::Image::Info.new(source) { |b| b.quiet }
+              case wm[:command]
+              when 'text'
+                convert.background 'transparent'
+                convert.size('2000x2000')
+                convert.gravity 'Center'
+                convert.font('Helvetica').fill('black').pointsize(72) # .stroke('black').strokewidth(1)
+                convert << "label:#{wm[:data]}"
+                convert.rotate wm[:rotation]
+                convert.trim.repage.+ # rubocop:disable Lint/Void
+                convert.bordercolor('transparent').border("#{wm[:gap]}%") if wm[:gap].positive?
+                convert.filter('Lagrange')
+                convert.resize("#{image_info['width'] / wm[:tiles]}x#{image_info['height'] / wm[:tiles]}") if wm[:tiles].positive?
+                convert.resize("#{wm[:resize]}%") if wm[:resize]
+              when 'image'
+                convert << wm[:data]
+                convert.background 'transparent'
+                convert.bordercolor('transparent').border("#{wm[:gap]}%") if wm[:gap].positive?
+                convert.rotate wm[:rotation]
+                convert.filter('Lagrange')
+                convert.resize("#{image_info['width'] / wm[:tiles]}x#{image_info['height'] / wm[:tiles]}") if wm[:tiles].positive?
+                convert.resize("#{wm[:resize]}%") if wm[:resize]
+              when 'banner'
+                banner_width = wm[:width] || [0.03 * image_info['height'], 20].max.round(0)
+                banner_border = banner_width / 3
+                convert.background "rgb(#{wm[:background_red]},#{wm[:background_green]},#{wm[:background_blue]})"
+                convert.size("#{image_info['height']}x#{banner_width}")
+                convert.bordercolor "rgb(#{wm[:background_red]},#{wm[:background_green]},#{wm[:background_blue]})"
+                convert.border "0x#{banner_border}"
+                convert.fill "rgb(#{wm[:text_red]},#{wm[:text_green]},#{wm[:text_blue]})"
+                convert.font "Liberation-Sans"
+                convert.pointsize wm[:size] if wm[:size]
+                convert.gravity 'Center'
+                convert << "label:#{wm[:data]}#{wm[:add_filename] ? File.basename(source, '.*') : ''}"
+              end
+
+              # Save watermark image to buffer
               convert.write('mpr:watermark').delete.+
             end
 
-            convert.quiet if @quiet
+            # load source image
             convert << source
+
+            # force flatten image if necessary
             convert.flatten if @options[:flatten].nil? && format == :JPG
-            if @wm_image
-              if (@wm_tiles >= 0) && (@wm_tiles <= 1)
+
+            # add watermark image
+            if wm
+              if wm[:command] == 'banner'
+                convert.rotate '-90'
                 convert << 'mpr:watermark'
+                convert.rotate '180'
+                convert.append
+                convert.rotate '-90'
               else
-                convert.stack do |stack|
-                  stack.size("#{image_info['width']}x#{image_info['height']}")
-                  stack << 'xc:transparent'
-                  stack.tile('mpr:watermark')
-                  stack.draw "rectangle 0,0,#{image_info['width']},#{image_info['height']}"
+                if (0..1).include? wm[:tiles]
+                  convert << 'mpr:watermark'
+                else
+                  convert.stack do |stack|
+                    stack.size("#{image_info['width']}x#{image_info['height']}")
+                    stack << 'xc:transparent'
+                    stack.tile('mpr:watermark')
+                    stack.draw "rectangle 0,0,#{image_info['width']},#{image_info['height']}"
+                  end
+                  convert.compose(wm[:composition])
+                  convert.gravity(wm[:gravity])
+                  convert.define("compose:args=#{wm[:opacity]}%")
+                  convert.composite
                 end
               end
-              convert.compose(@wm_composition).gravity(@wm_gravity).define("compose:args=#{@wm_opacity}%").composite
             end
 
             @flags.each { |f, v| v.is_a?(TrueClass) ? convert.send(f).+ : convert.send(f) }

data/lib/libis/format/version.rb

@@ -2,6 +2,6 @@
 
 module Libis
   module Format
-    VERSION = '1.3.3'
+    VERSION = '1.3.4'
   end
 end

data/libis-format.gemspec

@@ -29,7 +29,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'deep_dive', '~> 0.3'
   spec.add_runtime_dependency 'libis-mapi', '~> 0.3'
   spec.add_runtime_dependency 'libis-tools', '~> 1.1'
-  spec.add_runtime_dependency 'mini_magick', '~> 4.12'
+  spec.add_runtime_dependency 'mini_magick', '~> 5.0.1'
   spec.add_runtime_dependency 'naturally', '~> 2.2'
   spec.add_runtime_dependency 'new_rfc_2047', '~> 1.0'
   spec.add_runtime_dependency 'os', '~> 1.1'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: libis-format
 version: !ruby/object:Gem::Version
-  version: 1.3.3
+  version: 1.3.4
 platform: ruby
 authors:
 - Kris Dekeyser
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-07 00:00:00.000000000 Z
+date: 2024-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chromaprint
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.12'
+        version: 5.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.12'
+        version: 5.0.1
 - !ruby/object:Gem::Dependency
   name: naturally
   requirement: !ruby/object:Gem::Requirement
@@ -352,7 +352,7 @@ homepage: ''
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -368,7 +368,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.5.18
-signing_key: 
+signing_key:
 specification_version: 4
 summary: LIBIS File format format services.
 test_files: []