poleica 0.9.11 → 0.9.12

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YzM2ZTViOTU5Zjk5OWZkNDM5MjAwZGNmYzc5YTJkYTg5MjY1ZTZmMw==
+    MWJhYzFiNTA4OWRkNTIyZmQ0MDNiODc4YzVmN2I3ZDk5ODViZTE0YQ==
   data.tar.gz: !binary |-
-    ZjY1YmMzYzUyYWNkNDYyYmZkYzhkYTA5OTU0OWIzMjI2Mjk2ZTc0Zg==
+    MWZjMGQ2OWM3OTcxZjIzN2M1NGJmNWFmM2ViZWFjZmQ2ODk4NDkyYw==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    ZmJlNmNlZjAxOWZlNDVlYTg5ZWYxZTRiZWQ1NDVjNzllMzBiYTg2MTcyY2Q4
-    ZjczZWEwMWY3YzhjZDE0NDk2OTg3NzNiYmQ2YmRjNzVkOGRlMDUzNjU5ZTgz
-    YzIwZWNhNTlkNzkzZjE0MWZlZDQwNjUzZTA5NWQ2ZmI0NWJhNjQ=
+    M2FhZGE2MjI4OTA2ZGI1MzViMmZhYWVkNGJlNDRlZTY3OGZmNmE4ZTNmZjE0
+    YTNkOGM1MDYxNzdhYTE5ODVmYzkxYjViNzQ2NjQzNDJmMWRlMThkY2QzZTVm
+    YzFmY2FkMmYxNzQ2MmFmYjQ4N2IzN2QyYzQzMjYwNzVlNmIxZjM=
   data.tar.gz: !binary |-
-    OTQxMzg5NDBlNWI1YzUxM2NmMDM4MDg1MTVmN2ExZmViMTE4YmVkOTYzZDcy
-    MTQyYjY2NzM5NmM4NWJiNmNkMjgzNzAwMzJjNjIwMDAwYzk0OGI2N2ZiOThi
-    NDBmNmU5Y2UyOWYxMjA0NTg4ZWI0MGM3YzY5YWYxZGExMTdjY2M=
+    ZTg0YmU3MmJjZTg5MTllMTQ5MGRhYzdhZjgwMTc5Y2VjNmRiMTQ2NTA4NWI3
+    M2U3ODVjNzM5ODBlNWE5YjUzMjFkMzA3MjMwNDBmYWYxNmZlNzY2YmJlYzMy
+    Nzk3M2EwMmZlMjY1Mzc4NDZlN2RhMTY1YWY2NzM1OTg4ZDdhN2E=

data/Gemfile.lock

@@ -17,7 +17,7 @@ GIT
 PATH
   remote: .
   specs:
-    poleica (0.9.11)
+    poleica (0.9.12)
       childprocess
 
 GEM

data/README.md

@@ -46,6 +46,17 @@ Poleica.new(file_path).to_png
 Poleica.new(file_path).to_png(width: 400, weight: 400)
 ```
 
+## Configuration
+
+Example : 
+
+```
+Poleica.configure do |config|
+  config.timeout = 2 # time in secs
+  config.libre_office[:bin_paths][:linux] = '/usr/local/bin/gm'
+  config.graphics_magick[:bin_paths][:osx] = '/Applications/OpenOffice.app/Contents/MacOS/soffice.bin'
+```
+
 ## Options
 
 - weight       : pixels number

data/lib/poleica/configuration.rb

@@ -2,12 +2,34 @@
 module Poleica
   # Configuration class
   class Configuration
-    attr_accessor :timeout
+    attr_accessor :timeout, :libre_office, :graphics_magick
 
     def initialize
-      self.timeout = 120
+      self.timeout         = 120
+      self.libre_office    = init_libre_office_config
+      self.graphics_magick = init_graphics_magick_config
+    end
+
+    def init_graphics_magick_config
+      {
+        bin_paths:
+        {
+          linux:  '/usr/local/bin/gm',
+          osx:    '/usr/local/bin/gm'
+        }
+      }
     end
-  end
+
+    def init_libre_office_config
+      {
+        bin_paths:
+        {
+          linux:  '/usr/lib/libreoffice/program/soffice.bin',
+          osx: '/Applications/LibreOffice.app/Contents/MacOS/soffice.bin'
+        }
+      }
+    end
+  end # class Configuration
 
   def self.configure
     yield(configuration) if block_given?
@@ -16,4 +38,8 @@ module Poleica
   def self.configuration
     @configuration ||= Configuration.new
   end
+
+  def self.reset_configuration
+    @configuration = Configuration.new
+  end
 end # module Poleica

data/lib/poleica/converters/graphics_magick.rb

@@ -6,11 +6,6 @@ module Poleica
     class GraphicsMagick
       include Poleica::Converters::Utils
 
-      BIN_PATHS = {
-        linux:  '/usr/local/bin/gm',
-        osx:    '/usr/local/bin/gm'
-      }
-
      COMPATIBLE_TYPES = [
        Types::Image,
        Types::PDF

data/lib/poleica/converters/libre_office.rb

@@ -7,11 +7,6 @@ module Poleica
     class LibreOffice
       include Poleica::Converters::Utils
 
-      BIN_PATHS = {
-        linux:  '/usr/lib/libreoffice/program/soffice.bin',
-        osx: '/Applications/LibreOffice.app/Contents/MacOS/soffice.bin'
-      }
-
       COMPATIBLE_TYPES = [
         Types::Document
       ]

data/lib/poleica/converters/utils.rb

@@ -6,6 +6,7 @@ module Poleica
   module Converters
     # An Utility module for the converters needs to be include
     module Utils
+
       HOST_OS ||= (defined?('RbConfig') ? RbConfig : Config)::CONFIG['host_os']
 
       def windows?
@@ -25,13 +26,21 @@ module Poleica
       end
 
       def bin_path
-        bin_path_key = :BIN_PATHS # rubocop:disable SymbolName
-        bin_paths    = self.class.const_get(bin_path_key)
-        path         = bin_paths[host_os] || bin_paths[:linux]
+        converter     = :"#{underscorize(self.class)}"
+        configuration = Poleica.configuration.send(converter)
+        bin_paths     = configuration[:bin_paths]
+        path          = bin_paths[host_os] || bin_paths[:linux]
         raise "#{self.class} not found @ #{path}" unless File.exists?(path)
         path
       end
 
+      def underscorize(camel_cased_word)
+        word = camel_cased_word.to_s
+        word = word[((word.rindex('::') + 2) || 0)..-1]
+        word.gsub!(/([A-Z]+)/, '_\1').gsub!(/^_/, '').downcase!
+        word
+      end
+
       module_function
 
       def extract_extension_and_options(method, args = [])
@@ -41,17 +50,25 @@ module Poleica
         [extension, options]
       end
 
-      def exec_with_timeout(bin, args = [], timeout = nil, is_stdout = true)
-        args      = Array(args).map(&:to_s)
-        timeout ||= Poleica.configuration.timeout
-        null      = IO.new(IO.sysopen('/dev/null', 'w'), 'w')
-        process   = ChildProcess.build(bin, *args).start
-        process.io.stdout = process.io.stderr = null
-        process.poll_for_exit(timeout)
+      def exec_with_timeout(bin, args = [], timeout = nil, no_stdout = true)
+        args              = Array(args).map(&:to_s)
+        timeout         ||= Poleica.configuration.timeout
+        process           = ChildProcess.build(bin, *args)
+        set_process_stdout(process, no_stdout)
+        process.start
+        timeout ? process.poll_for_exit(timeout) : process.wait
       rescue ChildProcess::TimeoutError => e
-        process.stop && raise(e)
-      ensure
-        null && null.close
+        process.stop
+        raise(Poleica::TimeoutError.new(e.message))
+      end
+
+      def set_process_stdout(process, no_stdout)
+        if no_stdout
+          null              = IO.new(IO.sysopen('/dev/null', 'w'), 'w')
+          process.io.stdout = process.io.stderr = null
+        else
+          process.io.inherit!
+        end
       end
     end # module Utils
   end # module Converters

data/lib/poleica/errors.rb

@@ -0,0 +1,4 @@
+# -*- encoding: utf-8 -*-
+module Poleica
+  class TimeoutError < StandardError;  end
+end # module Poleica

data/lib/poleica/version.rb

@@ -1,4 +1,4 @@
 # -*- encoding: utf-8 -*-
 module Poleica
-  VERSION ||= '0.9.11'
+  VERSION ||= '0.9.12'
 end # module Poleica

data/lib/poleica.rb

@@ -8,6 +8,7 @@ end # module Poleica
 
 require 'poleica/version'
 require 'poleica/configuration'
+require 'poleica/errors'
 
 require 'poleica/types/pdf'
 require 'poleica/types/image'

data/test/poleica/configuration_test.rb

@@ -11,4 +11,28 @@ class ConfigurationTest < Minitest::Test
   ensure
     Poleica.configure { |config| config.timeout = 120 }
   end
-end
+
+  def test_graphics_magick_configuration
+    Poleica.configure do |config|
+      config.graphics_magick[:bin_paths] = { linux: '', osx: '' }
+    end
+    expected_message = 'Poleica::Converters::GraphicsMagick not found @ '
+    assert_raises(RuntimeError, expected_message) do
+      Poleica.new('test/support/files/example.pdf').to_png
+    end
+  ensure
+    Poleica.reset_configuration
+  end
+
+  def test_libre_office_configuration
+    Poleica.configure do |config|
+      config.libre_office[:bin_paths] = { linux: '', osx: '' }
+    end
+    expected_message = 'Poleica::Converters::LibreOffice not found @ '
+    assert_raises(RuntimeError, expected_message) do
+      Poleica.new('test/support/files/example.doc').to_pdf
+    end
+  ensure
+    Poleica.reset_configuration
+  end
+end # class ConfigurationTest

data/test/poleica/converters/utils_test.rb

@@ -9,6 +9,12 @@ class UtilsTest < Minitest::Test
     assert(duration < 2)
   end
 
+  def test_exec_with_timeout_raise_an_exception
+    assert_raises(Poleica::TimeoutError) do
+      Poleica::Converters::Utils.exec_with_timeout('sleep', 2, 0.1)
+    end
+  end
+
   def test_exec_with_timeout_kill
     assert(`ps -a | grep soffice.bin | grep -v grep`.empty?)
     Poleica.configure { |conf| conf.timeout = 0.001 }

data/test/test_helper.rb

@@ -35,4 +35,4 @@ module Support
     path_without_extension(original_file_path) +
       "-#{digest}.#{converted_extension}"
   end
-end
+end # module Support

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: poleica
 version: !ruby/object:Gem::Version
-  version: 0.9.11
+  version: 0.9.12
 platform: ruby
 authors:
 - Antoine Lyset
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-06 00:00:00.000000000 Z
+date: 2013-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -76,6 +76,7 @@ files:
 - lib/poleica/converters/graphics_magick.rb
 - lib/poleica/converters/libre_office.rb
 - lib/poleica/converters/utils.rb
+- lib/poleica/errors.rb
 - lib/poleica/pathable.rb
 - lib/poleica/polei.rb
 - lib/poleica/types/all.rb