grim 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d9b3ea24639d459434c20b2f23e417e13b811a6a
-  data.tar.gz: d25c76a9a4ead4f3a3067eb40a364ff532460911
+  metadata.gz: 75e501e9b8b7daf4549a07bf29f3e34baa5099f1
+  data.tar.gz: 1a96dc37be69e9474305329c74b4a556b20d2a1d
 SHA512:
-  metadata.gz: cb6007819bb63ba6b07c253e978bcad0b792adcfac87f96ff1ea3b11fa4e94621384bb182e8413abc08efa37f984a70f6d3f1643a2d922e7f9147b42ae98a487
-  data.tar.gz: 64c20dc98e97cf1a341ef904d7c038feffe54acdd00e21c4d2f1dded2d5a756861e8e665d7910f9b94d0f457dd8734a0951110095c0b6f1b3116ea35d7866224
+  metadata.gz: 82ee2f6442b015ccd7716467ac18d8f0081e6741e72a36fb3ee48032287b9915785dbae78ff4e74a182bc0b801b55228f462f2898839a45d9b6f73683b9b8f3a
+  data.tar.gz: 54356b62ff9d386dedf2107d70efbba276d4be24c7168c190b8f9bddcf04b0dcc9b36186de49e3804e53ae0fa0832eed26cc4cbe48b103837f50dbed00211ecf

data/Gemfile

@@ -1,4 +1,4 @@
 source "https://rubygems.org"
 gemspec
 gem "rake"
-gem "rspec"
+gem "rspec", "~> 3.2.0"

data/README.md

@@ -0,0 +1,106 @@
+```
+                    ,____
+                    |---.\
+            ___     |    `
+           / .-\  ./=)
+          |  |"|_/\/|
+          ;  |-;| /_|
+         / \_| |/ \ |
+        /      \/\( |
+        |   /  |` ) |
+        /   \ _/    |
+       /--._/  \    |
+       `/|)    |    /
+         /     |   |
+       .'      |   |
+      /         \  |
+     (_.-.__.__./  /
+```
+
+# Grim
+
+Grim is a simple gem for extracting (reaping) 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 gives you an easy to use api to ghostscript, imagemagick, and pdftotext specific to this use case.
+
+## Prerequisites
+
+You will need ghostscript, imagemagick, and poppler installed. On the Mac (OSX) I highly recommend using [Homebrew](http://mxcl.github.com/homebrew/) to get them installed.
+
+```bash
+$ brew install ghostscript imagemagick poppler
+```
+
+## Installation
+
+```bash
+$ gem install grim
+```
+
+## Usage
+
+```ruby
+pdf   = Grim.reap("/path/to/pdf")         # returns Grim::Pdf instance for pdf
+count = pdf.count                         # returns the number of pages in the pdf
+png   = pdf[3].save('/path/to/image.png') # will return true if page was saved or false if not
+text  = pdf[3].text                       # returns text as a String
+
+pdf.each do |page|
+  puts page.text
+end
+```
+
+We also support using other processors (the default is whatever version of Imagemagick/Ghostscript is in your path).
+
+```ruby
+# specifying one processor with specific ImageMagick and GhostScript paths
+Grim.processor =  Grim::ImageMagickProcessor.new({:imagemagick_path => "/path/to/convert", :ghostscript_path => "/path/to/gs"})
+
+# multiple processors with fallback if first fails, useful if you need multiple versions of convert/gs
+Grim.processor = Grim::MultiProcessor.new([
+  Grim::ImageMagickProcessor.new({:imagemagick_path => "/path/to/6.7/convert", :ghostscript_path => "/path/to/9.04/gs"}),
+  Grim::ImageMagickProcessor.new({:imagemagick_path => "/path/to/6.6/convert", :ghostscript_path => "/path/to/9.02/gs"})
+])
+
+pdf = Grim.reap('/path/to/pdf')
+```
+
+You can even specify a Windows executable :zap:
+
+```ruby
+# specifying another ghostscript executable, win64 in this example
+# the ghostscript/bin folder still has to be in the PATH for this to work
+Grim.processor =  Grim::ImageMagickProcessor.new({:ghostscript_path => "gswin64c.exe"})
+
+pdf = Grim.reap('/path/to/pdf')
+```
+
+`Grim::ImageMagickProcessor#save` supports several options as well:
+
+```ruby
+pdf = Grim.reap("/path/to/pdf")
+pdf[0].save('/path/to/image.png', {
+  :width => 600,         # defaults to 1024
+  :density => 72,        # defaults to 300
+  :quality => 60,        # defaults to 90
+  :colorspace => "CMYK", # defaults to "RGB"
+  :alpha => "Activate"   # not used when not set
+})
+```
+
+## Reference
+
+* [jonmagic.com: Grim](http://jonmagic.com/blog/archives/2011/09/06/grim/)
+* [jonmagic.com: Grim MultiProcessor](http://jonmagic.com/blog/archives/2011/10/06/grim-multiprocessor-to-the-rescue/)
+
+## Contributors
+
+* [@jonmagic](https://github.com/jonmagic)
+* [@jnunemaker](https://github.com/jnunemaker)
+* [@bryckbost](https://github.com/bryckbost)
+* [@bkeepers](https://github.com/bkeepers)
+* [@BobaFaux](https://github.com/BobaFaux)
+* [@Rubikan](https://github.com/Rubikan)
+* [@victormier](https://github.com/victormier)
+
+## License
+
+See [LICENSE](LICENSE) for details.

data/lib/grim/image_magick_processor.rb

@@ -3,32 +3,44 @@ module Grim
 
     # ghostscript prints out a warning, this regex matches it
     WarningRegex = /\*\*\*\*.*\n/
+    DefaultImagemagickPath = 'convert'
+    DefaultGhostScriptPath = 'gs'
 
     def initialize(options={})
-      @imagemagick_path = options[:imagemagick_path] || 'convert'
-      @ghostscript_path = options[:ghostscript_path]
-      @original_path        = ENV['PATH']
+      @imagemagick_path = options[:imagemagick_path] || DefaultImagemagickPath
+      @ghostscript_path = options[:ghostscript_path] || DefaultGhostScriptPath
+      @original_path    = ENV['PATH']
     end
 
     def count(path)
-      command = ["-dNODISPLAY", "-q",
+      command = [@ghostscript_path, "-dNODISPLAY", "-q",
         "-sFile=#{Shellwords.shellescape(path)}",
         File.expand_path('../../../lib/pdf_info.ps', __FILE__)]
-      @ghostscript_path ? command.unshift(@ghostscript_path) : command.unshift('gs')
       result = `#{command.join(' ')}`
       result.gsub(WarningRegex, '').to_i
     end
 
     def save(pdf, index, path, options)
-      width   = options.fetch(:width,   Grim::WIDTH)
-      density = options.fetch(:density, Grim::DENSITY)
-      quality = options.fetch(:quality, Grim::QUALITY)
+      width      = options.fetch(:width,   Grim::WIDTH)
+      density    = options.fetch(:density, Grim::DENSITY)
+      quality    = options.fetch(:quality, Grim::QUALITY)
       colorspace = options.fetch(:colorspace, Grim::COLORSPACE)
-      command = [@imagemagick_path, "-resize", width.to_s, "-antialias", "-render",
-        "-quality", quality.to_s, "-colorspace", colorspace,
-        "-interlace", "none", "-density", density.to_s,
-        "#{Shellwords.shellescape(pdf.path)}[#{index}]", path]
-      command.unshift("PATH=#{File.dirname(@ghostscript_path)}:#{ENV['PATH']}") if @ghostscript_path
+      alpha      = options[:alpha]
+
+      command = []
+      command << @imagemagick_path
+      command << "-resize #{width}"
+      command << "-alpha #{alpha}" if alpha
+      command << "-antialias"
+      command << "-render"
+      command << "-quality #{quality}"
+      command << "-colorspace #{colorspace}"
+      command << "-interlace none"
+      command << "-density #{density}"
+      command << "#{Shellwords.shellescape(pdf.path)}[#{index}]"
+      command << path
+
+      command.unshift("PATH=#{File.dirname(@ghostscript_path)}:#{ENV['PATH']}") if @ghostscript_path && @ghostscript_path != DefaultGhostScriptPath
 
       result = `#{command.join(' ')}`
 

data/lib/grim/version.rb

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

data/spec/lib/grim/image_magick_processor_spec.rb

@@ -16,7 +16,17 @@ describe Grim::ImageMagickProcessor do
     end
 
     it "should return page count" do
-      @processor.count(fixture_path("smoker.pdf")).should == 25
+      expect(@processor.count(fixture_path("smoker.pdf"))).to eq(25)
+    end
+  end
+
+  describe "#count with windows executable", :windows => true do
+    before(:each) do
+      @processor = Grim::ImageMagickProcessor.new({:ghostscript_path => "gswin64c.exe"})
+    end
+
+    it "should return page count" do
+      expect(@processor.count(fixture_path("smoker.pdf"))).to eq(25)
     end
   end
 
@@ -30,13 +40,13 @@ describe Grim::ImageMagickProcessor do
 
     it "should create the file" do
       @processor.save(@pdf, 0, @path, {})
-      File.exist?(@path).should be_true
+      expect(File.exist?(@path)).to be(true)
     end
 
     it "should use default width of 1024" do
       @processor.save(@pdf, 0, @path, {})
       width, height = dimensions_for_path(@path)
-      width.should == 1024
+      expect(width).to eq(1024)
     end
   end
 
@@ -50,7 +60,7 @@ describe Grim::ImageMagickProcessor do
 
     it "should set width" do
       width, height = dimensions_for_path(@path)
-      width.should == 20
+      expect(width).to eq(20)
     end
   end
 
@@ -67,7 +77,7 @@ describe Grim::ImageMagickProcessor do
       Grim::ImageMagickProcessor.new.save(@pdf, 0, @path, {:quality => 90})
       higher_size = File.size(@path)
 
-      (lower_size < higher_size).should be_true
+      expect(lower_size < higher_size).to be(true)
     end
   end
 
@@ -81,7 +91,7 @@ describe Grim::ImageMagickProcessor do
       lower_time  = Benchmark.realtime { Grim::ImageMagickProcessor.new.save(@pdf, 0, @path, {:density => 72}) }
       higher_time = Benchmark.realtime { Grim::ImageMagickProcessor.new.save(@pdf, 0, @path, {:density => 300}) }
 
-      (lower_time < higher_time).should be_true
+      expect(lower_time < higher_time).to be(true)
     end
   end
 
@@ -99,7 +109,23 @@ describe Grim::ImageMagickProcessor do
       file1_size = File.stat(@path1).size
       file2_size = File.stat(@path2).size
 
-      file1_size.should_not == file2_size
+      expect(file1_size).to_not eq(file2_size)
+    end
+  end
+  
+  describe "#save with alpha option" do
+    before(:each) do
+      @path1 = tmp_path("to_png_spec-1.png")
+      @path2 = tmp_path("to_png_spec-2.png")
+      @pdf  = Grim::Pdf.new(fixture_path("remove_alpha.pdf"))
+    end
+    
+    it "should use alpha" do
+      Grim::ImageMagickProcessor.new.save(@pdf, 0, @path1, {:alpha => 'Set'})
+      Grim::ImageMagickProcessor.new.save(@pdf, 0, @path2, {:alpha => 'Remove'})
+
+      expect(`convert #{@path1} -verbose info:`.include?("alpha: 8-bit")).to be(true)
+      expect(`convert #{@path2} -verbose info:`.include?("alpha: 1-bit")).to be(true)
     end
   end
-end
+end

data/spec/lib/grim/multi_processor_spec.rb

@@ -14,9 +14,9 @@ describe Grim::MultiProcessor do
 
   describe "#count" do
     it "should try processors until it succeeds" do
-      @failure.stub(:count){""}
-      @success.should_receive(:count).and_return(30)
-      @extra.should_not_receive(:count)
+      allow(@failure).to receive(:count).and_return("")
+      expect(@success).to receive(:count).and_return(30)
+      expect(@extra).to_not receive(:count)
 
       @processor.count(@path)
     end
@@ -24,19 +24,19 @@ describe Grim::MultiProcessor do
 
   describe "#save" do
     it "should try processors until it succeeds" do
-      @failure.stub(:save){false}
-      @success.should_receive(:save).and_return(true)
-      @extra.should_not_receive(:save)
+      allow(@failure).to receive(:save).and_return(false)
+      expect(@success).to receive(:save).and_return(true)
+      expect(@extra).to_not receive(:save)
 
       @processor.save(@pdf, 0, @path, {})
     end
 
     it "should raise error if all processors fail" do
-      @failure.should_receive(:save).and_return(false)
-      @success.should_receive(:save).and_return(false)
-      @extra.should_receive(:save).and_return(false)
+      expect(@failure).to receive(:save).and_return(false)
+      expect(@success).to receive(:save).and_return(false)
+      expect(@extra).to receive(:save).and_return(false)
 
-      lambda { @processor.save(@pdf, 0, @path, {}) }.should raise_error(Grim::UnprocessablePage)
+      expect { @processor.save(@pdf, 0, @path, {}) }.to raise_error(Grim::UnprocessablePage)
     end
   end
-end
+end

data/spec/lib/grim/page_spec.rb

@@ -8,7 +8,7 @@ describe Grim::Page do
   end
 
   it "should have number" do
-    Grim::Page.new(Grim::Pdf.new(fixture_path("smoker.pdf")), 1).number.should == 2
+    expect(Grim::Page.new(Grim::Pdf.new(fixture_path("smoker.pdf")), 1).number).to eq(2)
   end
 
   describe "#save" do
@@ -18,7 +18,7 @@ describe Grim::Page do
     end
 
     it "should call Grim.processor.save with pdf, index, path, and options" do
-      Grim.processor.should_receive(:save).with(@pdf, 0, @path, {})
+      expect(Grim.processor).to receive(:save).with(@pdf, 0, @path, {})
       @pdf[0].save(@path)
     end
   end
@@ -30,8 +30,8 @@ describe Grim::Page do
     end
 
     it "raises an exception" do
-      lambda { @pdf[0].save(nil) }.should raise_error(Grim::PathMissing)
-      lambda { @pdf[0].save('  ') }.should raise_error(Grim::PathMissing)
+      expect { @pdf[0].save(nil) }.to raise_error(Grim::PathMissing)
+      expect { @pdf[0].save('  ') }.to raise_error(Grim::PathMissing)
     end
   end
 
@@ -47,13 +47,15 @@ describe Grim::Page do
   describe "#text" do
     it "should return the text from the selected page" do
       pdf = Grim::Pdf.new(fixture_path("smoker.pdf"))
-      pdf[1].text.should == "Step 1: get someone to print this curve for you to scale, 72” wide\nStep 2: Get a couple 55 gallon drums\n\n\f"
+      expect(pdf[1].text).to \
+        eq("Step 1: get someone to print this curve for you to scale, 72” wide\nStep 2: Get a couple 55 gallon drums\n\n\f")
     end
 
     it "works with full path to pdftotext" do
       pdftotext_path = `which pdftotext`.chomp
       pdf = Grim::Pdf.new(fixture_path("smoker.pdf"), pdftotext_path: pdftotext_path)
-      pdf[1].text.should == "Step 1: get someone to print this curve for you to scale, 72” wide\nStep 2: Get a couple 55 gallon drums\n\n\f"
+      expect(pdf[1].text).to \
+        eq("Step 1: get someone to print this curve for you to scale, 72” wide\nStep 2: Get a couple 55 gallon drums\n\n\f")
     end
   end
 end

data/spec/lib/grim/pdf_spec.rb

@@ -4,23 +4,26 @@ require 'spec_helper'
 describe Grim::Pdf do
 
   it "should have a path" do
-    Grim::Pdf.new(fixture_path("smoker.pdf")).path.should == fixture_path("smoker.pdf")
+    pdf = Grim::Pdf.new(fixture_path("smoker.pdf"))
+    expect(pdf.path).to eq(fixture_path("smoker.pdf"))
   end
 
   describe "#initialize" do
     it "should raise an error if pdf does not exist" do
-      lambda { Grim::Pdf.new(fixture_path("booboo.pdf")) }.should raise_error(Grim::PdfNotFound)
+      expect {
+        Grim::Pdf.new(fixture_path("booboo.pdf"))
+      }.to raise_error(Grim::PdfNotFound)
     end
 
     it "should set path on pdf" do
       pdf = Grim::Pdf.new(fixture_path("smoker.pdf"))
-      pdf.path.should == fixture_path("smoker.pdf")
+      expect(pdf.path).to eq(fixture_path("smoker.pdf"))
     end
   end
 
   describe "#count" do
     it "should call Grim.processor.count with pdf path" do
-      Grim.processor.should_receive(:count).with(fixture_path("smoker.pdf"))
+      expect(Grim.processor).to receive(:count).with(fixture_path("smoker.pdf"))
       pdf = Grim::Pdf.new(fixture_path("smoker.pdf"))
       pdf.count
     end
@@ -32,19 +35,19 @@ describe Grim::Pdf do
     end
 
     it "should raise Grim::PageDoesNotExist if page doesn't exist" do
-      lambda { @pdf[25] }.should raise_error(Grim::PageNotFound)
+      expect { @pdf[25] }.to raise_error(Grim::PageNotFound)
     end
 
     it "should return an instance of Grim::Page if page exists" do
-      @pdf[24].class.should == Grim::Page
+      expect(@pdf[24].class).to eq(Grim::Page)
     end
   end
 
   describe "#each" do
     it "should be iterable" do
       pdf = Grim::Pdf.new(fixture_path("smoker.pdf"))
-      pdf.map {|p| p.number }.should == (1..25).to_a
+      expect(pdf.map {|p| p.number }).to eq((1..25).to_a)
     end
   end
 
-end
+end

data/spec/lib/grim_spec.rb

@@ -3,32 +3,32 @@ require 'spec_helper'
 
 describe Grim do
   it "should have a default processor" do
-    Grim.processor.class.should == Grim::ImageMagickProcessor
+    expect(Grim.processor.class).to eq(Grim::ImageMagickProcessor)
   end
 
   it "should have a VERSION constant" do
-    Grim.const_defined?('VERSION').should be_true
+    expect(Grim.const_defined?('VERSION')).to be(true)
   end
 
   it "should have WIDTH constant set to 1024" do
-    Grim::WIDTH.should == 1024
+    expect(Grim::WIDTH).to eq(1024)
   end
 
   it "should have QUALITY constant set to 90" do
-    Grim::QUALITY.should == 90
+    expect(Grim::QUALITY).to eq(90)
   end
 
   it "should have DENSITY constant set to 300" do
-    Grim::DENSITY.should == 300
+    expect(Grim::DENSITY).to eq(300)
   end
 
   it "should have COLORSPACE constant set to 'RGB'" do
-    Grim::COLORSPACE.should == 'RGB'
+    expect(Grim::COLORSPACE).to eq('RGB')
   end
 
   describe "#reap" do
     it "should return an instance of Grim::Pdf" do
-      Grim.reap(fixture_path("smoker.pdf")).class.should == Grim::Pdf
+      expect(Grim.reap(fixture_path("smoker.pdf")).class).to eq(Grim::Pdf)
     end
   end
-end
+end

data/spec/spec_helper.rb

@@ -2,6 +2,7 @@
 require 'benchmark'
 require 'rubygems'
 require 'bundler/setup'
+require 'rbconfig'
 
 require 'grim'
 
@@ -28,4 +29,5 @@ end
 
 RSpec.configure do |config|
   config.include(FileHelpers)
+  config.filter_run_excluding :windows => true if RbConfig::CONFIG['host_os'].match(/mswin|mingw|cygwin/) == nil
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grim
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Jonathan Hoyt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-25 00:00:00.000000000 Z
+date: 2015-02-19 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
@@ -23,7 +23,7 @@ files:
 - ".gitignore"
 - Gemfile
 - LICENSE
-- README.textile
+- README.md
 - Rakefile
 - grim.gemspec
 - lib/grim.rb
@@ -33,6 +33,7 @@ files:
 - lib/grim/pdf.rb
 - lib/grim/version.rb
 - lib/pdf_info.ps
+- spec/fixtures/remove_alpha.pdf
 - spec/fixtures/smoker.pdf
 - spec/fixtures/unprocessable.pdf
 - spec/lib/grim/image_magick_processor_spec.rb
@@ -65,6 +66,7 @@ signing_key:
 specification_version: 4
 summary: Extract slides and text from a PDF.
 test_files:
+- spec/fixtures/remove_alpha.pdf
 - spec/fixtures/smoker.pdf
 - spec/fixtures/unprocessable.pdf
 - spec/lib/grim/image_magick_processor_spec.rb

data/README.textile

@@ -1,81 +0,0 @@
-<pre>
-                    ,____
-                    |---.\
-            ___     |    `
-           / .-\  ./=)
-          |  |"|_/\/|
-          ;  |-;| /_|
-         / \_| |/ \ |
-        /      \/\( |
-        |   /  |` ) |
-        /   \ _/    |
-       /--._/  \    |
-       `/|)    |    /
-         /     |   |
-       .'      |   |
-      /         \  |
-     (_.-.__.__./  /
-</pre>
-
-h1. Grim
-
-Grim is a simple gem for extracting (reaping) 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 gives you an easy to use api to ghostscript, imagemagick, and pdftotext specific to this use case.
-
-h2. Prerequisites
-
-You will need ghostscript, imagemagick, and poppler installed. On the Mac (OSX) I highly recommend using "Homebrew":http://mxcl.github.com/homebrew/ to get them installed.
-
-<pre><code>
-  brew install ghostscript imagemagick poppler
-</code></pre>
-
-h2. Installation
-
-<pre><code>
-  gem install grim
-</code></pre>
-
-h2. Usage
-
-<pre><code>
-  pdf   = Grim.reap("/path/to/pdf")         # returns Grim::Pdf instance for pdf
-  count = pdf.count                         # returns the number of pages in the pdf
-  png   = pdf[3].save('/path/to/image.png') # will return true if page was saved or false if not
-  text  = pdf[3].text                       # returns text as a String
-
-  pdf.each do |page|
-    puts page.text
-  end
-</pre></code>
-
-We also support using other processors (the default is whatever version of Imagemagick/Ghostscript is in your path).
-
-<pre><code>
-  # specifying one processor with specific ImageMagick and GhostScript paths
-  Grim.processor =  Grim::ImageMagickProcessor.new({:imagemagick_path => "/path/to/convert", :ghostscript_path => "/path/to/gs"})
-
-  # multiple processors with fallback if first fails, useful if you need multiple versions of convert/gs
-  Grim.processor = Grim::MultiProcessor.new([
-    Grim::ImageMagickProcessor.new({:imagemagick_path => "/path/to/6.7/convert", :ghostscript_path => "/path/to/9.04/gs"}),
-    Grim::ImageMagickProcessor.new({:imagemagick_path => "/path/to/6.6/convert", :ghostscript_path => "/path/to/9.02/gs"})
-  ])
-
-  pdf = Grim.reap('/path/to/pdf)
-</code></pre>
-
-h2. Reference
-
-* "jonmagic.com: Grim":http://jonmagic.com/blog/archives/2011/09/06/grim/
-* "jonmagic.com: Grim MultiProcessor":http://jonmagic.com/blog/archives/2011/10/06/grim-multiprocessor-to-the-rescue/
-
-h2. Contributors
-
-* "@jonmagic":https://github.com/jonmagic
-* "@jnunemaker":https://github.com/jnunemaker
-* "@bryckbost":https://github.com/bryckbost
-* "@bkeepers":https://github.com/bkeepers
-* "@BobaFaux":https://github.com/BobaFaux
-
-h2. License
-
-See LICENSE for details.