libis-format 1.2.8 → 1.3.0

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

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 require 'libis-tools'
 require 'fileutils'
 require 'libis/format/config'
@@ -7,32 +8,31 @@ require_relative 'base'
 module Libis
   module Format
     module Converter
-
       class Jp2Converter < Libis::Format::Converter::Base
-
         def self.input_types
-          [:TIFF, :JPG, :PNG, :BMP, :GIF, :PDF]
+          %i[TIFF JPG PNG BMP GIF PDF]
         end
 
         def self.output_types(format = nil)
           return [] unless input_types.include?(format)
+
           [:JP2]
         end
 
         def initialize
           super
           @options = {
-              color_xform: false,
-              error_resilience: :ALL,
-              lossless: true,
-              progression_order: 'RLCP',
-              tile_size: [1024, 1024],
-              codeblock_size: [6, 6],
+            color_xform: false,
+            error_resilience: :ALL,
+            lossless: true,
+            progression_order: 'RLCP',
+            tile_size: [1024, 1024],
+            codeblock_size: [6, 6]
           }
         end
 
         def j2kdriver(_)
-          #force usage of this converter
+          # force usage of this converter
         end
 
         def color_xform(flag = true)
@@ -68,38 +68,36 @@ module Libis
 
           @options.each do |key, value|
             case key
-              when :color_xform
-                options << '--set-output-j2k-color-xform' << (value ? 'YES' : 'NO')
-              when :error_resilience
-                options << '--set-output-j2k-error-resilience' << value.to_s
-              when :lossless
-                if value
-                  options << '--set-output-j2k-xform' << 'R53' << '5' << '--set-output-j2k-ratio' << '0'
-                else
-                  options << '--set-output-j2k-xform' << 'I97' << '--set-output-j2k-psnr' << '46'
-                end
-              when :progression_order
-                options << '--set-output-j2k-progression-order' << value.to_s
-              when :tile_size
-                options << '--set-output-j2k-tile-size' << value[0].to_s << value[1].to_s
-              when :codeblock_size
-                options << '--set-output-j2k-codeblock-size' << value[0].to_s << value[1].to_s
+            when :color_xform
+              options << '--set-output-j2k-color-xform' << (value ? 'YES' : 'NO')
+            when :error_resilience
+              options << '--set-output-j2k-error-resilience' << value.to_s
+            when :lossless
+              if value
+                options << '--set-output-j2k-xform' << 'R53' << '5' << '--set-output-j2k-ratio' << '0'
               else
-                #do nothing
+                options << '--set-output-j2k-xform' << 'I97' << '--set-output-j2k-psnr' << '46'
+              end
+            when :progression_order
+              options << '--set-output-j2k-progression-order' << value.to_s
+            when :tile_size
+              options << '--set-output-j2k-tile-size' << value[0].to_s << value[1].to_s
+            when :codeblock_size
+              options << '--set-output-j2k-codeblock-size' << value[0].to_s << value[1].to_s
+            else # rubocop:disable Style/EmptyElse
+              # do nothing
             end
           end
 
-
           result = Libis::Tools::Command.run(
-              Libis::Format::Config[:j2k_cmd],
-              '--input-file-name', source,
-              '--set-output-type', 'JP2',
-              *options,
-              '--output-file-name', target,
+            Libis::Format::Config[:j2k_cmd],
+            '--input-file-name', source,
+            '--set-output-type', 'JP2',
+            *options,
+            '--output-file-name', target
           )
 
           result.merge(files: [target], converter: self.class.name)
-
         end
       end
     end

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

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require_relative 'base'
 
@@ -8,47 +8,43 @@ require 'libis/format/type_database'
 module Libis
   module Format
     module Converter
-
       class OfficeConverter < Libis::Format::Converter::Base
-
         def self.input_types
-          [
-              :TXT,
-              :RTF,
-              :HTML,
-              :MSDOC,
-              :MSDOT,
-              :MSXLS,
-              :MSPPT,
-              :MSDOCX,
-              :MSDOTX,
-              :MSXLSX,
-              :MSPPTX,
-              :WORDPERFECT,
-              :OO_WRITER,
-              :OO_IMPRESS,
-              :OO_CALC
+          %i[
+            TXT
+            RTF
+            HTML
+            MSDOC
+            MSDOT
+            MSXLS
+            MSPPT
+            MSDOCX
+            MSDOTX
+            MSXLSX
+            MSPPTX
+            WORDPERFECT
+            OO_WRITER
+            OO_IMPRESS
+            OO_CALC
           ]
         end
 
         def self.output_types(format = nil)
           return [] unless input_types.include?(format)
+
           [:PDF]
         end
 
         def office_convert(_)
-          #force usage of this converter
+          # force usage of this converter
         end
 
         def convert(source, target, format, opts = {})
           super
 
           Format::Tool::OfficeToPdf.run(source, target)
-
         end
-
       end
-
     end
   end
 end

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

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require_relative 'base'
 
@@ -11,20 +11,19 @@ require 'libis/format/tool/pdf_optimizer'
 module Libis
   module Format
     module Converter
-
       class PdfConverter < Libis::Format::Converter::Base
-
         def self.input_types
           [:PDF]
         end
 
         def self.output_types(format = nil)
           return [] unless input_types.include?(format)
-          [:PDF, :PDFA]
+
+          %i[PDF PDFA]
         end
 
         def pdf_convert(_)
-          #force usage of this converter
+          # force usage of this converter
         end
 
         # Set metadata for Pdf file
@@ -40,7 +39,8 @@ module Libis
         def metadata(values = {})
           values.key_strings_to_symbols!
           values.each do |k, v|
-            next unless [:title, :author, :creator, :keywords, :subject].include?(k)
+            next unless %i[title author creator keywords subject].include?(k)
+
             @options["md_#{k}"] = v
           end
         end
@@ -59,7 +59,8 @@ module Libis
         #     - 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.
+        #     - 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.
         #
@@ -96,7 +97,7 @@ module Libis
         #
         # @param [Integer] setting quality setting. [0-4]
         def optimize(setting = 1)
-          @options['optimize'] = %w(screen ebook default printer prepress)[setting] if (0..4) === setting
+          @options['optimize'] = %w[screen ebook default printer prepress][setting] if (0..4).include?(setting)
         end
 
         def convert(source, target, format, opts = {})
@@ -107,31 +108,29 @@ module Libis
           if (quality = @options.delete('optimize'))
             result = optimize_pdf(source, target, quality)
             return nil unless result
+
             source = result
           end
 
           unless @options.empty?
             result = convert_pdf(source, target)
             return nil unless result
+
             source = result
           end
 
-          if format == :PDFA and source
-            result = pdf_to_pdfa(source, target)
-          end
+          result = pdf_to_pdfa(source, target) if (format == :PDFA) && source
 
-          { 
+          {
             files: [result],
             converter: self.class.name
           }
-
         end
 
         def optimize_pdf(source, target, quality)
-
           using_temp(target) do |tmpname|
             result = Libis::Format::Tool::PdfOptimizer.run(source, tmpname, quality)
-            unless result[:status] == 0
+            unless (result[:status]).zero?
               error("Pdf optimization encountered errors:\n%s", (result[:err] + result[:out]).join("\n"))
               next nil
             end
@@ -140,16 +139,16 @@ module Libis
         end
 
         def convert_pdf(source, target)
-
           using_temp(target) do |tmpname|
             result = Libis::Format::Tool::PdfCopy.run(
-                source, tmpname,
-                @options.map {|k, v|
-                  if v.nil?
-                    nil
-                  else
-                    ["--#{k}", (v.is_a?(Array) ? v : v.to_s)]
-                  end}.flatten
+              source, tmpname,
+              @options.map do |k, v|
+                if v.nil?
+                  nil
+                else
+                  ["--#{k}", (v.is_a?(Array) ? v : v.to_s)]
+                end
+              end.flatten
             )
             unless result[:err].empty?
               error("Pdf conversion encountered errors:\n%s", result[:err].join(join("\n")))
@@ -157,11 +156,9 @@ module Libis
             end
             tmpname
           end
-
         end
 
         def pdf_to_pdfa(source, target)
-
           using_temp(target) do |tmpname|
             result = Libis::Format::Tool::PdfToPdfa.run source, tmpname
 
@@ -177,11 +174,8 @@ module Libis
             end
             tmpname
           end
-
         end
-
       end
-
     end
   end
 end

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

@@ -1,6 +1,5 @@
-# coding: utf-8
+# frozen_string_literal: true
 
-require 'set'
 require 'singleton'
 
 require 'libis/tools/logger'
@@ -11,7 +10,6 @@ require_relative 'chain'
 module Libis
   module Format
     module Converter
-
       class Repository
         include Singleton
         include ::Libis::Tools::Logger
@@ -24,15 +22,15 @@ module Libis
           @converters_glob = File.join(File.dirname(__FILE__), '*_converter.rb')
         end
 
-        def Repository.register(converter_class)
+        def self.register(converter_class)
           instance.converters.add? converter_class
         end
 
-        def Repository.get_converters
+        def self.get_converters # rubocop:disable Naming/AccessorMethodName
           instance.get_converters
         end
 
-        def get_converters
+        def get_converters # rubocop:disable Naming/AccessorMethodName
           if converters.empty?
             Dir.glob(converters_glob).each do |filename|
               # noinspection RubyResolve
@@ -42,12 +40,12 @@ module Libis
           converters
         end
 
-        def Repository.get_converter_chain(src_type, tgt_type, operations = {})
+        def self.get_converter_chain(src_type, tgt_type, operations = {})
           instance.get_converter_chain src_type, tgt_type, operations
         end
 
         def get_converter_chain(src_type, tgt_type, operations = {})
-          msg = "conversion from #{src_type.to_s} to #{tgt_type.to_s}"
+          msg = "conversion from #{src_type} to #{tgt_type}"
           chain_list = find_chains src_type, tgt_type, operations
           # if chain_list.length > 1
           #   warn "Found more than one conversion chain for #{msg}. Picking the first one."
@@ -70,7 +68,6 @@ module Libis
         end
 
         def build_chains(chain)
-
           found = []
           chains = [chain]
 
@@ -81,18 +78,15 @@ module Libis
               new_chains += chains.map { |c| c.append(converter) }.flatten
             end
 
-            found = new_chains.select { |c| c.valid?}
+            found = new_chains.select(&:valid?)
             return found unless found.empty?
 
             chains = new_chains
           end
 
           found
-
         end
-
       end
-
     end
   end
 end

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

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require_relative 'base'
 
@@ -8,35 +8,31 @@ require 'libis/format/type_database'
 module Libis
   module Format
     module Converter
-
       class SpreadsheetConverter < Libis::Format::Converter::Base
-
         def self.input_types
-          [
-              :MSXLS,
-              :MSXLSX,
-              :OO_CALC
+          %i[
+            MSXLS
+            MSXLSX
+            OO_CALC
           ]
         end
 
         def self.output_types(format = nil)
           return [] unless input_types.include?(format)
+
           [:OO_CALC]
         end
 
         def spreadsheet_convert(_)
-          #force usage of this converter
+          # force usage of this converter
         end
 
         def convert(source, target, format, opts = {})
           super
 
           Format::Tool::SpreadsheetToOds.run(source, target)
-
         end
-
       end
-
     end
   end
 end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'base'
 require 'libis/format/tool/ff_mpeg'
 
@@ -6,24 +8,19 @@ require 'fileutils'
 module Libis
   module Format
     module Converter
-
       class VideoConverter < Libis::Format::Converter::Base
-
         def self.input_types
-          [:WEBM, :MP4, :MPG, :MKV, :MJP2, :QTFF, :AVI, :OGGV, :WMV, :DV, :FLV, :SWF]
+          %i[WEBM MP4 MPG MKV MJP2 QTFF AVI OGGV WMV DV FLV SWF]
         end
 
         def self.output_types(format = nil)
           return [] unless input_types.include?(format)
-          [:GIF, :WEBM, :MP4, :MPG, :MKV, :MJP2, :QTFF, :AVI, :OGGV, :WMV, :DV, :FLV, :SWF]
-        end
 
-        def initialize
-          super
+          %i[GIF WEBM MP4 MPG MKV MJP2 QTFF AVI OGGV WMV DV FLV SWF]
         end
 
-        def quiet(v)
-          @flags[:quiet] = !!v
+        def quiet(value)
+          @flags[:quiet] = !!value
         end
 
         def format(format)
@@ -126,10 +123,10 @@ module Libis
 
         # @param [Boolean] value If set to true automatically selects optimal format for web viewing. Default: false
         def web_stream(value)
-          if value
-            @options[:video_codec] = 'h264'
-            @options[:audio_codec] = 'acc'
-          end
+          return unless value
+
+          @options[:video_codec] = 'h264'
+          @options[:audio_codec] = 'acc'
         end
 
         # @param [String] name name of a preset. See FFMpeg documentation for more info
@@ -170,7 +167,7 @@ module Libis
 
           elsif File.directory?(source)
 
-            sources = Dir[File.join(source, '**', '*')].reject {|p| File.directory? p}
+            sources = Dir[File.join(source, '**', '*')].reject { |p| File.directory? p }
             assemble_and_convert(sources, target)
 
           else
@@ -183,14 +180,13 @@ module Libis
             files: [target],
             converter: self.class.name
           }
-
         end
 
         def assemble_and_convert(sources, target)
-          Tempfile.create(%w(list .txt)) do |f|
-            sources.each {|src| f.puts src}
+          Tempfile.create(%w[list .txt]) do |f|
+            sources.each { |src| f.puts src }
             opts[:global] ||= []
-            opts[:global] += %w(-f concat)
+            opts[:global] += %w[-f concat]
             f.close
             target = convert_file(f.to_path, target)
           end
@@ -201,15 +197,15 @@ module Libis
 
         def convert_file(source, target)
           # FLV special: only supports aac and speex audio codecs
-          format = (@options[:format] || File.extname(target)[1..-1]).to_s.downcase
-          @options[:audio_codec] ||= 'aac' if %w'flv'.include?(format)
+          format = (@options[:format] || File.extname(target)[1..]).to_s.downcase
+          @options[:audio_codec] ||= 'aac' if %w[flv].include?(format)
 
           # SWF special: only supports mp3 audio codec
-          format = (@options[:format] || File.extname(target)[1..-1]).to_s.downcase
-          @options[:audio_codec] ||= 'mp3' if %w'swf'.include?(format)
+          format = (@options[:format] || File.extname(target)[1..]).to_s.downcase
+          @options[:audio_codec] ||= 'mp3' if %w[swf].include?(format)
 
           # Set up FFMpeg command line parameters
-          opts = {global: [], input: [], filter: [], output: []}
+          opts = { global: [], input: [], filter: [], output: [] }
           opts[:global] << '-hide_banner'
           opts[:global] << '-loglevel' << (@options[:quiet] ? 'fatal' : 'warning')
 
@@ -217,29 +213,21 @@ module Libis
           @options[:watermark_opacity] ||= 0.5
           if @options[:watermark_image]
             opts[:filter] << '-i' << @options[:watermark_image] << '-filter_complex'
-            opts[:filter] << "[1:v]format=argb,colorchannelmixer=aa=%f[wm];[0:v][wm]overlay=%s" %
-                [@options[:watermark_opacity], watermark_position_text]
+            opts[:filter] << Kernel.format('[1:v]format=argb,colorchannelmixer=aa=%f[wm];[0:v][wm]overlay=%s',
+                                           @options[:watermark_opacity], watermark_position_text)
           elsif @options[:watermark_text]
             @options[:watermark_text_size] ||= 10
             @options[:watermark_text_color] ||= 'white'
             @options[:watermark_text_shadow_color] ||= 'black'
             @options[:watermark_text_shadow_offset] ||= 1
-            filter_text = "drawtext=text='%s':%s:fontfile=%s:fontsize=%d:fontcolor=%s@%f" %
-                [
-                    @options[:watermark_text],
-                    watermark_position_text(true),
-                    Config[:watermark_font],
-                    @options[:watermark_text_size],
-                    @options[:watermark_text_color],
-                    @options[:watermark_opacity]
-                ]
-            filter_text += ':shadowcolor=%s@%f:shadowx=%d:shadowy=%d' %
-                [
-                    @options[:watermark_text_shadow_color],
-                    @options[:watermark_opacity],
-                    @options[:watermark_text_shadow_offset],
-                    @options[:watermark_text_shadow_offset]
-                ] if @options[:watermark_text_shadow_offset] > 0
+            filter_text = Kernel.format("drawtext=text='%s':%s:fontfile=%s:fontsize=%d:fontcolor=%s@%f",
+                                        @options[:watermark_text], watermark_position_text(true), Config[:watermark_font],
+                                        @options[:watermark_text_size], @options[:watermark_text_color], @options[:watermark_opacity])
+            if (@options[:watermark_text_shadow_offset]).positive?
+              filter_text += Kernel.format(':shadowcolor=%s@%f:shadowx=%d:shadowy=%d',
+                                           @options[:watermark_text_shadow_color], @options[:watermark_opacity],
+                                           @options[:watermark_text_shadow_offset], @options[:watermark_text_shadow_offset])
+            end
             opts[:filter] << '-vf' << filter_text
           end
           opts[:output] << '-ac' << @options[:audio_channels] if @options[:audio_channels]
@@ -251,7 +239,7 @@ module Libis
           opts[:output] << '-map_metadata:g' << '0:g' # Copy global metadata
           opts[:output] << '-map_metadata:s:a' << '0:s:a' # Copy audio metadata
           opts[:output] << '-map_metadata:s:v' << '0:s:v' # Copy video metadata
-          opts[:input] << '-accurate_seek' << (@options[:start].to_i < 0 ? '-sseof' : '-ss') << @options[:start] if @options[:start]
+          opts[:input] << '-accurate_seek' << (@options[:start].to_i.negative? ? '-sseof' : '-ss') << @options[:start] if @options[:start]
           opts[:input] << '-t' << @options[:duration] if @options[:duration]
           opts[:output] << '-qscale' << @options[:video_quality] if @options[:video_quality]
           opts[:output] << '-q:a' << @options[:audio_quality] if @options[:audio_quality]
@@ -277,21 +265,19 @@ module Libis
           w = for_text ? 'tw' : 'w'
           h = for_text ? 'th' : 'h'
           case @options[:watermark_position]
-            when 'bottom_left'
-              "x=#{margin}:y=H-#{h}-#{margin}"
-            when 'top_left'
-              "x=#{margin}:y=#{margin}"
-            when 'bottom_right'
-              "x=W-#{w}-#{margin}:y=H-#{h}-#{margin}"
-            when 'top_right'
-              "x=W-#{w}-#{margin}:y=#{margin}"
-            else
-              "x=#{margin}:y=H-#{h}-#{margin}"
+          when 'bottom_left'
+            "x=#{margin}:y=H-#{h}-#{margin}"
+          when 'top_left'
+            "x=#{margin}:y=#{margin}"
+          when 'bottom_right'
+            "x=W-#{w}-#{margin}:y=H-#{h}-#{margin}"
+          when 'top_right'
+            "x=W-#{w}-#{margin}:y=#{margin}"
+          else
+            "x=#{margin}:y=H-#{h}-#{margin}"
           end
         end
-
       end
-
     end
   end
-end
+end