grim 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 75e501e9b8b7daf4549a07bf29f3e34baa5099f1
-  data.tar.gz: 1a96dc37be69e9474305329c74b4a556b20d2a1d
+  metadata.gz: 351b803d58cd1849dbe87c987f23fe3bff91bdc1
+  data.tar.gz: 79a712dd44dee6e7f9e7dcb562242ed4b26d0652
 SHA512:
-  metadata.gz: 82ee2f6442b015ccd7716467ac18d8f0081e6741e72a36fb3ee48032287b9915785dbae78ff4e74a182bc0b801b55228f462f2898839a45d9b6f73683b9b8f3a
-  data.tar.gz: 54356b62ff9d386dedf2107d70efbba276d4be24c7168c190b8f9bddcf04b0dcc9b36186de49e3804e53ae0fa0832eed26cc4cbe48b103837f50dbed00211ecf
+  metadata.gz: b0eb570ca92b151dd08c0cc27481a7e8e56d87c65dcfd29d10ead8ec8b29b42f36568091bb6e781024c6ee14c14a0154591e55968582b112eca943d8e2c20a48
+  data.tar.gz: 3620c88137845bb798e4874a41ecc537d41982b988298fad9cd2c4caa4e5d9ce0ce0887a967fede7577acf229197321aeb3038ea5c381aa9bfd03d68cc35bf18

data/README.md

@@ -86,6 +86,19 @@ pdf[0].save('/path/to/image.png', {
 })
 ```
 
+Grim has limited logging abilities. The default logger is `Grim::NullLogger` but you can also set your own logger.
+
+```ruby
+require "logger"
+Grim.logger = Logger.new($stdout).tap { |logger| logger.progname = 'Grim' }
+Grim.processor = Grim::ImageMagickProcessor.new({:ghostscript_path => "/path/to/bin/gs"})
+pdf = Grim.reap("/path/to/pdf")
+pdf[3].save('/path/to/image.png')
+# D, [2016-06-09T22:43:07.046532 #69344] DEBUG -- grim: Running imagemagick command
+# D, [2016-06-09T22:43:07.046626 #69344] DEBUG -- grim: PATH=/path/to/bin:/usr/local/bin:/usr/bin
+# D, [2016-06-09T22:43:07.046787 #69344] DEBUG -- grim: convert -resize 1024 -antialias -render -quality 90 -colorspace RGB -interlace none -density 300 /path/to/pdf /path/to/image.png
+```
+
 ## Reference
 
 * [jonmagic.com: Grim](http://jonmagic.com/blog/archives/2011/09/06/grim/)

data/lib/grim.rb

@@ -50,11 +50,26 @@ module Grim
   def self.reap(path)
     Grim::Pdf.new(path)
   end
+
+  # Set a Logger compatible logger for Grim.
+  #
+  # logger - Object with same interface as Logger.new
+  def self.logger=(logger)
+    @logger = logger
+  end
+
+  # Logger to use internally. Defaults to Grim::NullLogger.
+  #
+  # Returns a Logger compatible logger.
+  def self.logger
+    @logger ||= Grim::NullLogger.new
+  end
 end
 
 require 'grim/pdf'
 require 'grim/page'
 require 'grim/image_magick_processor'
 require 'grim/multi_processor'
+require 'grim/null_logger'
 
-Grim.processor = Grim::ImageMagickProcessor.new
+Grim.processor = Grim::ImageMagickProcessor.new

data/lib/grim/image_magick_processor.rb

@@ -1,3 +1,5 @@
+require 'open3'
+
 module Grim
   class ImageMagickProcessor
 
@@ -40,11 +42,21 @@ module Grim
       command << "#{Shellwords.shellescape(pdf.path)}[#{index}]"
       command << path
 
-      command.unshift("PATH=#{File.dirname(@ghostscript_path)}:#{ENV['PATH']}") if @ghostscript_path && @ghostscript_path != DefaultGhostScriptPath
+      command_env = {}
 
-      result = `#{command.join(' ')}`
+      if @ghostscript_path && @ghostscript_path != DefaultGhostScriptPath
+        command_env['PATH'] = "#{File.dirname(@ghostscript_path)}#{File::PATH_SEPARATOR}#{ENV['PATH']}"
+      end
+
+      Grim.logger.debug { "Running imagemagick command" }
+      if command_env.any?
+        Grim.logger.debug { command_env.map {|k,v| "#{k}=#{v}" }.join(" ") }
+      end
+      Grim.logger.debug { command.join(" ") }
+
+      result, status = Open3.capture2e(command_env, command.join(" "))
 
-      $? == 0 || raise(UnprocessablePage, result)
+      status.success? || raise(UnprocessablePage, result)
     end
   end
 end

data/lib/grim/null_logger.rb

@@ -0,0 +1,9 @@
+require "logger"
+
+module Grim
+  class NullLogger
+    def initialize(*args); end
+    def debug(*args); end
+    def info(*args); end
+  end
+end

data/lib/grim/page.rb

@@ -50,7 +50,10 @@ module Grim
     # Returns a String.
     #
     def text
-      `#{[@pdftotext_path, "-enc", "UTF-8", "-f", @number, "-l", @number, Shellwords.escape(@pdf.path), "-"].join(' ')}`
+      command = [@pdftotext_path, "-enc", "UTF-8", "-f", @number, "-l", @number, Shellwords.escape(@pdf.path), "-"].join(' ')
+      Grim.logger.debug { "Running pdftotext command" }
+      Grim.logger.debug { command }
+      `#{command}`
     end
   end
 end

data/lib/grim/version.rb

@@ -1,4 +1,4 @@
 # encoding: UTF-8
 module Grim
-  VERSION = "1.2.0" unless defined?(::Grim::VERSION)
+  VERSION = "1.3.0" unless defined?(::Grim::VERSION)
 end

data/spec/lib/grim/null_logger_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+require "stringio"
+
+describe Grim::NullLogger do
+  it "acts like Logger but doesn't log anything" do
+    io = StringIO.new
+    logger = Grim::NullLogger.new(io)
+    logger.debug "hello world"
+    expect(io.string).to eq("")
+  end
+end

data/spec/lib/grim_spec.rb

@@ -26,9 +26,27 @@ describe Grim do
     expect(Grim::COLORSPACE).to eq('RGB')
   end
 
-  describe "#reap" do
+  describe ".reap" do
     it "should return an instance of Grim::Pdf" do
       expect(Grim.reap(fixture_path("smoker.pdf")).class).to eq(Grim::Pdf)
     end
   end
+
+  describe ".logger=" do
+    it "sets Grim.logger" do
+      original_logger = Grim.logger
+      begin
+        Grim.logger = "foo"
+        expect(Grim.logger).to eq("foo")
+      ensure
+        Grim.logger = original_logger
+      end
+    end
+  end
+
+  describe ".logger" do
+    it "returns a Grim::NullLogger by default" do
+      expect(Grim.logger).to be_instance_of(Grim::NullLogger)
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grim
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Jonathan Hoyt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-19 00:00:00.000000000 Z
+date: 2016-06-14 00:00:00.000000000 Z
 dependencies: []
 description: Grim is a simple gem for extracting a page from a pdf and converting
   it to an image as well as extract the text from the page as a string. It basically
@@ -29,6 +29,7 @@ files:
 - lib/grim.rb
 - lib/grim/image_magick_processor.rb
 - lib/grim/multi_processor.rb
+- lib/grim/null_logger.rb
 - lib/grim/page.rb
 - lib/grim/pdf.rb
 - lib/grim/version.rb
@@ -38,6 +39,7 @@ files:
 - spec/fixtures/unprocessable.pdf
 - spec/lib/grim/image_magick_processor_spec.rb
 - spec/lib/grim/multi_processor_spec.rb
+- spec/lib/grim/null_logger_spec.rb
 - spec/lib/grim/page_spec.rb
 - spec/lib/grim/pdf_spec.rb
 - spec/lib/grim_spec.rb
@@ -61,7 +63,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: grim
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Extract slides and text from a PDF.
@@ -71,6 +73,7 @@ test_files:
 - spec/fixtures/unprocessable.pdf
 - spec/lib/grim/image_magick_processor_spec.rb
 - spec/lib/grim/multi_processor_spec.rb
+- spec/lib/grim/null_logger_spec.rb
 - spec/lib/grim/page_spec.rb
 - spec/lib/grim/pdf_spec.rb
 - spec/lib/grim_spec.rb