poleica 0.9.8 → 0.9.9

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    N2JkOTZiMjQ2MmQ3Y2MyYmI3OTI2N2I2MWUzNDI5ZTM5YTE2MmZhOA==
+    ZTkyNGUxMWEyYWRkNGQ1Y2Y2OTVhNDg2ZDEwNTM3MjQ2MTIxNGVmYg==
   data.tar.gz: !binary |-
-    MzdmZDljYWRmMGFiNWJjNDZmMGJlMjE4NWE4YjljY2I5YTJiYjdlMA==
+    ZTBmZjcyYTYwMjFjMzhmZThhZjZmODE5MmY0MGE4Yjg2OWY2OGUzYw==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    MmNhMTE3YjQ3MjE4OTdhMjFlOTBiYjQyN2Y0ZmJhM2Y0YzU1ZDhiMDNlZjA1
-    MjNlZDEwNmFjM2RkMWY4OTRiNmI0OGE2Y2FmZThkMzdhY2ZkMDEzMDNjZGY2
-    MDIzZTNhOTM0NTU5MGYzZDgwNGFiNDQzODA1NjA3YmUzMTFjYjc=
+    NTQ3ZTgwMDA4MzAwMGNkNDE2MTdhZGM5ODQxMDM1YjM1OTc0YmVhNzhmZWRi
+    YmJkMjQ3OGUwZDI0MTZkYjcyOWY4Nzg4YjdkNTc5NTlmMTEzYWE0YzdkNGVh
+    NGYwMTA3NDY3ZGIyOWE4ZDkwYzFlODFmMjY0ZDFlNzFjOWQzNWU=
   data.tar.gz: !binary |-
-    YzBkMGJmNjgxMmJiZTNhNDNiMWM0MGQwOTIwYTczODdmMTRiNGFhMjY5ZTZm
-    MDk2ZWMzNDU5Y2E4MjMwMGQ1YjFmM2M0NGUwMjU1N2FiODQ4NmYyMDk0ZWY0
-    OWM0MjYyMjNhNzY3MmQ5MTlkOWMxNWZmMTEyNTNhNWYwMTlmYTM=
+    OTVkMTc4YjU5YWFkYWQ4NGEwYTdkNTg4OWQzNzk4YjVlYWUzZmM1YTg4ODg5
+    OTAwYzMyNzllMTUwZDRjZjVjYWJlMzZiODQ1MmMwNzZiNmNjMjE0OWYwOTFk
+    NDFmZjk3Zjk2ZGNjYmI3NjE3ZDgzZDMzZmViYWQ4MzQ4Yzk5MmU=

data/.travis.yml

@@ -7,8 +7,19 @@ rvm:
   - jruby-19mode
 before_script:
   - sudo apt-get update -qq
-  - sudo apt-get install -qq graphicsmagick libreoffice
+  - sudo apt-get install -qq libreoffice
+  - wget http://78.108.103.11/MIRROR/ftp/GraphicsMagick/1.3/GraphicsMagick-1.3.18.tar.gz
+  - tar -xvf GraphicsMagick-1.3.18.tar.gz
+  - cd GraphicsMagick-1.3.18
+  - ./configure
+  - make
+  - sudo make install
+  - sudo ln -s /usr/local/bin/gm /usr/bin/gm
 script:
   - rake
+matrix:
+  allow_failures:
+    - rvm: jruby-19mode
+    - rvm: rbx-19mode
 notifications:
   email: false

data/CHANGELOG.md

@@ -1,3 +1,5 @@
+# Poleica 0.9.9 (6 August 2013)
+* Add configure method to Poleica, with timeout option
 # Poleica 0.9.8 (5 August 2013)
 * Add timeout (2 mins) on LibreOffice and GraphicsMagick execution 
 # Poleica 0.9.7 (4 August 2013)

data/README.md

@@ -11,15 +11,15 @@
 
 __Ubuntu__ :
 
-```
-apt-get install graphicsmagick libreoffice
-```
+Look at .travis.yml file
 
 __MacOS__ :
 
 ```
 brew install ghostscript graphicsmagick
 ```
+Download [LibreOffice](http://www.libreoffice.org/download) and install it.
+
 
 __Then__ :
 
@@ -33,7 +33,6 @@ or in __Gemfile__ :
 gem 'poleica'
 ```
 
-Then download [LibreOffice](http://www.libreoffice.org/download) and install it.
 ## Concept
 
 _ -> PDF -> Image
@@ -58,7 +57,7 @@ Poleica.new(file_path).to_png(width: 400, weight: 400)
 
 ## Dependencies
 
-- GraphicsMagick (gm) >= 1.3.11
+- GraphicsMagick (gm) >= 1.3.18 (for auto-rotate)
 - LibreOffice 
 
 ## Requirements

data/lib/poleica/configuration.rb

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+module Poleica
+  # Configuration class
+  class Configuration
+    attr_accessor :timeout
+
+    def initialize
+      self.timeout = 120
+    end
+  end
+
+  def self.configure
+    yield(configuration) if block_given?
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+end # module Poleica

data/lib/poleica/converters/coercive.rb

@@ -5,6 +5,10 @@ module Poleica
     class Coercive
       include Poleica::Converters::Utils
 
+      COMPATIBLE_TYPES = [
+        Types::All
+      ]
+
       # TODO Think about another way of declare return types
       TYPE_RETURNED_BY_METHOD = {
         to_pdf: Types::PDF,
@@ -58,8 +62,7 @@ module Poleica
         polei.compatible_convert_methods.map do |m|
           ret_type = TYPE_RETURNED_BY_METHOD[m.to_sym]
           next unless ret_type
-          convs = Poleica::Convertible.
-            compatible_converters_by_type(ret_type)
+          convs = Poleica::Convertible.compatible_converters_by_type(ret_type)
           convs.map { |conv| { m.to_sym => conv } }
         end.compact.flatten(1)
       end

data/lib/poleica/converters/convertible.rb

@@ -3,14 +3,13 @@ module Poleica
   # Conversion Logic, given a type it can search for compatible converters
   module Convertible
 
-    CONVERTERS = [
-      Converters::GraphicsMagick,
-      Converters::LibreOffice
-    ]
+    CONVERTERS = Poleica::Converters
+      .constants.map { |c| Poleica::Converters.const_get(c) } -
+        [Poleica::Converters::Utils]
 
     def method_missing(method, *args, &block)
-      extension, options = Converters::Utils
-        .extract_extension_and_options(method, args)
+      extension, options =
+        Converters::Utils.extract_extension_and_options(method, args)
       return convert_to_extension(extension, options) if extension
       super
     end
@@ -20,7 +19,7 @@ module Poleica
       converter.send("to_#{extension}".to_sym, options)
     end
 
-    def converter_to_extension(extension, filter = :mimetype)
+    def converter_to_extension(extension)
       compatible_converter = compatible_converters.find do |converter|
         converter.method_defined?(:"to_#{extension}")
       end
@@ -55,6 +54,5 @@ module Poleica
     def methods_for_converter(converter)
       converter.instance_methods(false).map(&:to_s)
     end
-
   end # module Convertible
 end # module Poleica

data/lib/poleica/converters/general.rb

@@ -1,9 +1,14 @@
 # -*- encoding: utf-8 -*-
 module Poleica
   module Converters
-    # The General converter, it handles any file type.
+    # The General converter, it handles any file type and return null for
+    # unknown conversion
     class General
 
+      COMPATIBLE_TYPES = [
+        Types::All
+      ]
+
       attr_reader :polei
 
       def initialize(polei)
@@ -13,6 +18,10 @@ module Poleica
       def to_bin(options = {})
         File.binread(polei.path)
       end
+
+      def method_missing(method, *args, &block)
+        super unless method =~ /^to_/
+      end
     end # class General
   end # module Converters
-end # module Poleica
+end # module Poleica

data/lib/poleica/converters/utils.rb

@@ -9,8 +9,6 @@ module Poleica
     module Utils
       HOST_OS ||= (defined?('RbConfig') ? RbConfig : Config)::CONFIG['host_os']
 
-      DEFAULT_TIMEOUT = 120
-
       def windows?
         !!HOST_OS.match(/mswin|windows|cygwin/i)
       end
@@ -48,12 +46,15 @@ module Poleica
         Shellwords.shellescape(string)
       end
 
-      def exec_with_timeout(cmd, timeout = DEFAULT_TIMEOUT, no_stdout = true)
+      def exec_with_timeout(cmd,
+                            timeout   = Poleica.configuration.timeout,
+                            no_stdout = true)
         cmd << ' >/dev/null' if no_stdout
         pid = Process.spawn(cmd)
         Timeout.timeout(timeout) { Process.wait(pid) }
-      rescue Timeout::Error
-        Process.kill('TERM', pid)
+      rescue Timeout::Error => e
+        Process.kill('KILL', pid)
+        raise e
       end
     end # module Utils
   end # module Converters

data/lib/poleica/types/all.rb

@@ -0,0 +1,8 @@
+# -*- encoding: utf-8 -*-
+module Poleica
+  # rubocop:disable all
+  module Types
+    All = Poleica::Types.constants.map { |c| Poleica::Types.const_get(c) }
+  end # module Types
+  # rubocop:enable all
+end # module Poleica

data/lib/poleica/types/{null.rb → general.rb}

@@ -3,10 +3,14 @@ module Poleica
   module Types
     # Null Object Pattern Type, this is the type returned if no compatible
     # types are found
-    class Null
+    class General
+
+      COMPATIBLE_MIMETYPES  = []
+      COMPATIBLE_EXTENSIONS = []
+
       def initialize(file_path)
 
       end
-    end # class Null
+    end # class General
   end # module Types
-end # module Poleica
+end # module Poleica

data/lib/poleica/types/typeable.rb

@@ -14,19 +14,13 @@ module Poleica
     def file_type
       @file_type ||= (detect_type_with_extension ||
                       detect_type_with_mimetype  ||
-                      Types::Null).new(path)
+                      Types::General).new(path)
     end
 
     private
 
     MIMETYPE_EXTRACT_REGEX = /([^;:]+)/
 
-    TYPES = [
-      Types::Image,
-      Types::Document,
-      Types::PDF
-    ]
-
     def extract_mimetype
       `file -b --mime '#{path}'`.strip[MIMETYPE_EXTRACT_REGEX] || ''
     end
@@ -36,13 +30,13 @@ module Poleica
     end
 
     def detect_type_with_extension
-      TYPES.find do |type|
+      Types::All.find do |type|
         type::COMPATIBLE_EXTENSIONS.include?(file_extension)
       end
     end
 
     def detect_type_with_mimetype
-      TYPES.find do |type|
+      Types::All.find do |type|
         type::COMPATIBLE_MIMETYPES.include?(file_mimetype)
       end
     end

data/lib/poleica/version.rb

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

data/lib/poleica.rb

@@ -7,16 +7,17 @@ module Poleica
 end # module Poleica
 
 require 'poleica/version'
+require 'poleica/configuration'
 
 require 'poleica/types/pdf'
-require 'poleica/types/null'
 require 'poleica/types/image'
 require 'poleica/types/document'
 require 'poleica/types/typeable'
+require 'poleica/types/general'
+require 'poleica/types/all'
 
 require 'poleica/converters/utils'
 require 'poleica/converters/general'
-require 'poleica/converters/null'
 require 'poleica/converters/coercive'
 require 'poleica/converters/graphics_magick'
 require 'poleica/converters/libre_office'

data/test/poleica/configuration_test.rb

@@ -0,0 +1,14 @@
+# -*- encoding: utf-8 -*-
+require 'test_helper'
+# Test the Configuration Converter Module
+class ConfigurationTest < Minitest::Test
+  def test_timeout_configuration
+    start_time = Time.now
+    Poleica.configure { |config| config.timeout = 1 }
+    Poleica::Converters::Utils.exec_with_timeout('sleep 2') rescue nil
+    duration = Time.now - start_time
+    assert(duration < 2)
+  ensure
+    Poleica.configure { |config| config.timeout = 120 }
+  end
+end

data/test/poleica/converters/general_test.rb

@@ -8,4 +8,18 @@ class GeneralTest < Minitest::Test
     gif_polei = Poleica::Polei.new(gif_path)
     assert_equal(gif_data, gif_polei.to_bin)
   end
-end # class GeneralTest
+
+  def test_it_returns_nil_on_to_method
+    method_name = :to_random
+    file        = Minitest::Mock.new
+    converter   = Poleica::Converters::General.new(file)
+    assert_nil(converter.send(method_name))
+  end
+
+  def test_it_raise_no_method_error_on_other_calls
+    method_name = :random
+    file        = Minitest::Mock.new
+    converter   = Poleica::Converters::General.new(file)
+    assert_raises(NoMethodError) { converter.send(method_name) }
+  end
+end # class GeneralTest

data/test/poleica/converters/utils_test.rb

@@ -2,10 +2,16 @@
 require 'test_helper'
 # Test the Utils Converter Module
 class UtilsTest < Minitest::Test
-  def test_exect_with_timeout
+  def test_exec_with_timeout
     start_time = Time.now
-    Poleica::Converters::Utils.exec_with_timeout('sleep 2', 1)
+    Poleica::Converters::Utils.exec_with_timeout('sleep 2', 0.1) rescue nil
     duration = Time.now - start_time
     assert(duration < 2)
   end
+
+  def test_exec_with_timeout_exception
+    assert_raises(Timeout::Error) do
+      Poleica::Converters::Utils.exec_with_timeout('sleep 2', 0.1)
+    end
+  end
 end

data/test/poleica/types/typeable_test.rb

@@ -26,7 +26,7 @@ class TypeableTest < Minitest::Test
   def test_that_it_extracts_a_type_object
     expected_classes = [
                          Poleica::Types::Document,
-                         Poleica::Types::Null,
+                         Poleica::Types::General,
                          Poleica::Types::Document,
                          Poleica::Types::Image
                        ]
@@ -39,7 +39,7 @@ class TypeableTest < Minitest::Test
   def test_that_it_returns_null_type_by_default
     mp3_path = "#{Support.support_path}/files/example.mp3"
     type_class = Poleica::Polei.new(mp3_path).file_type.class
-    assert_equal(type_class, Poleica::Types::Null)
+    assert_equal(type_class, Poleica::Types::General)
   end
 
   ## Helpers

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: poleica
 version: !ruby/object:Gem::Version
-  version: 0.9.8
+  version: 0.9.9
 platform: ruby
 authors:
 - Antoine Lyset
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-05 00:00:00.000000000 Z
+date: 2013-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -55,29 +55,30 @@ files:
 - README.md
 - Rakefile
 - lib/poleica.rb
+- lib/poleica/configuration.rb
 - lib/poleica/converters/coercive.rb
 - lib/poleica/converters/convertible.rb
 - lib/poleica/converters/general.rb
 - lib/poleica/converters/graphics_magick.rb
 - lib/poleica/converters/libre_office.rb
-- lib/poleica/converters/null.rb
 - lib/poleica/converters/utils.rb
 - lib/poleica/pathable.rb
 - lib/poleica/polei.rb
+- lib/poleica/types/all.rb
 - lib/poleica/types/archive.rb
 - lib/poleica/types/document.rb
+- lib/poleica/types/general.rb
 - lib/poleica/types/image.rb
-- lib/poleica/types/null.rb
 - lib/poleica/types/pdf.rb
 - lib/poleica/types/typeable.rb
 - lib/poleica/version.rb
 - poleica.gemspec
+- test/poleica/configuration_test.rb
 - test/poleica/converters/coercive_test.rb
 - test/poleica/converters/convertible_test.rb
 - test/poleica/converters/general_test.rb
 - test/poleica/converters/graphics_magick_test.rb
 - test/poleica/converters/libre_office_test.rb
-- test/poleica/converters/null_test.rb
 - test/poleica/converters/utils_test.rb
 - test/poleica/pathable_test.rb
 - test/poleica/polei_test.rb
@@ -114,12 +115,12 @@ signing_key:
 specification_version: 4
 summary: A general converter and thumbnail creator
 test_files:
+- test/poleica/configuration_test.rb
 - test/poleica/converters/coercive_test.rb
 - test/poleica/converters/convertible_test.rb
 - test/poleica/converters/general_test.rb
 - test/poleica/converters/graphics_magick_test.rb
 - test/poleica/converters/libre_office_test.rb
-- test/poleica/converters/null_test.rb
 - test/poleica/converters/utils_test.rb
 - test/poleica/pathable_test.rb
 - test/poleica/polei_test.rb

data/lib/poleica/converters/null.rb

@@ -1,17 +0,0 @@
-# -*- encoding: utf-8 -*-
-module Poleica
-  module Converters
-    # Null Object Pattern, this is the converter returned if no compatible
-    # converters are found
-    class Null
-      attr_reader :polei
-      def initialize(polei)
-        @polei = polei
-      end
-
-      def method_missing(method, *args, &block)
-        super unless method =~ /^to_/
-      end
-    end # class Null
-  end # module Converters
-end # module Poleica

data/test/poleica/converters/null_test.rb

@@ -1,18 +0,0 @@
-# -*- encoding: utf-8 -*-
-require 'test_helper'
-# Test the Null Converter Module
-class NullTest < Minitest::Test
-  def test_it_returns_nil_on_to_method
-    method_name = :to_random
-    file        = Minitest::Mock.new
-    converter   = Poleica::Converters::Null.new(file)
-    assert_nil(converter.send(method_name))
-  end
-
-  def test_it_raise_no_method_error_on_other_calls
-    method_name = :random
-    file        = Minitest::Mock.new
-    converter   = Poleica::Converters::Null.new(file)
-    assert_raises(NoMethodError) { converter.send(method_name) }
-  end
-end # class NullTest