grim 0.2.1 → 0.2.2

data/lib/grim.rb

@@ -6,10 +6,10 @@ module Grim
   WIDTH = 1024
 
   # Default image quality, 1 to 100
-  QUALITY = 90
+  QUALITY = 75
 
   # Default density, any positive integer
-  DENSITY = 300
+  DENSITY = 150
 
   # Default exception class for Grim.
   class Exception < ::StandardError
@@ -23,6 +23,10 @@ module Grim
   class PageNotFound < Grim::Exception
   end
 
+  # Exception that is raised if an empty path is passed to Grim::Page#save
+  class PathMissing < Grim::Exception
+  end
+
   # Creates and returns a new instance of Grim::Pdf
   #
   # path - a path string or object

data/lib/grim/page.rb

@@ -19,6 +19,8 @@ module Grim
     # Tested on png and jpeg.
     #
     # path - String of the path to save to
+    # options - Hash of options to customize the saving of the image
+    #           (ie: width, density, and quality)
     #
     # For example:
     #
@@ -27,11 +29,18 @@ module Grim
     #
     # Returns a File.
     #
-    def save(path)
-      SafeShell.execute("convert", "-resize", Grim::WIDTH, "-antialias", "-render",
-                        "-quality", Grim::QUALITY, "-colorspace", "RGB",
-                        "-interlace", "none", "-density", Grim::DENSITY,
+    def save(path, options={})
+      raise PathMissing if path.nil? || path !~ /\S/
+
+      width   = options.fetch(:width,   Grim::WIDTH)
+      density = options.fetch(:density, Grim::DENSITY)
+      quality = options.fetch(:quality, Grim::QUALITY)
+
+      SafeShell.execute("convert", "-resize", width, "-antialias", "-render",
+                        "-quality", quality, "-colorspace", "RGB",
+                        "-interlace", "none", "-density", density,
                         "#{@pdf.path}[#{@index}]", path)
+
       File.exists?(path)
     end
 

data/lib/grim/version.rb

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

data/spec/lib/grim/page_spec.rb

@@ -13,20 +13,78 @@ describe Grim::Page do
 
   describe "#save" do
     before(:all) do
-      pdf = Grim::Pdf.new(fixture_path("smoker.pdf"))
-      pdf[0].save(tmp_path("to_png_spec.png"))
-      @file = File.open(tmp_path("to_png_spec.png"))
+      @path = tmp_path("to_png_spec.png")
+      pdf   = Grim::Pdf.new(fixture_path("smoker.pdf"))
+
+      pdf[0].save(@path)
     end
 
     it "should create the file" do
-      File.exist?(tmp_path("to_png_spec.png")).should be_true
+      File.exist?(@path).should be_true
+    end
+
+    it "should use default width of 1024" do
+      width, height = dimensions_for_path(@path)
+      width.should == 1024
+    end
+  end
+
+  describe "#save with empty path" do
+    before(:each) do
+      @path = tmp_path("to_png_spec.png")
+      @pdf  = Grim::Pdf.new(fixture_path("smoker.pdf"))
+    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)
+    end
+  end
+
+  describe "#save with width option" do
+    before(:each) do
+      @path = tmp_path("to_png_spec.png")
+      pdf   = Grim::Pdf.new(fixture_path("smoker.pdf"))
+
+      pdf[0].save(@path, :width => 20)
     end
 
-    it "should have the right file size" do
-      @file.stat.size.should == 188515
+    it "should set width" do
+      width, height = dimensions_for_path(@path)
+      width.should == 20
     end
   end
 
+  describe "#save with quality option" do
+    before(:each) do
+      @path = tmp_path("to_png_spec.jpg")
+      @pdf  = Grim::Pdf.new(fixture_path("smoker.pdf"))
+    end
+
+    it "should use quality" do
+      @pdf[0].save(@path, :quality => 20)
+      lower_size = File.size(@path)
+
+      @pdf[0].save(@path, :quality => 90)
+      higher_size = File.size(@path)
+
+      (lower_size < higher_size).should be_true
+    end
+  end
+
+  describe "#save with density option" do
+    before(:each) do
+      @path = tmp_path("to_png_spec.jpg")
+      @pdf  = Grim::Pdf.new(fixture_path("smoker.pdf"))
+    end
+
+    it "should use density" do
+      lower_time  = Benchmark.realtime { @pdf[0].save(@path, :density => 20) }
+      higher_time = Benchmark.realtime { @pdf[0].save(@path, :density => 300) }
+
+      (lower_time < higher_time).should be_true
+    end
+  end
 
   describe "#text" do
     it "should return the text from the selected page" do

data/spec/lib/grim_spec.rb

@@ -11,11 +11,11 @@ describe Grim do
   end
 
   it "should have QUALITY constant set to 90" do
-    Grim::QUALITY.should == 90
+    Grim::QUALITY.should == 75
   end
 
   it "should have DENSITY constant set to 300" do
-    Grim::DENSITY.should == 300
+    Grim::DENSITY.should == 150
   end
 
   describe "#new" do

data/spec/spec_helper.rb

@@ -1,10 +1,15 @@
 # encoding: UTF-8
+require 'benchmark'
 require 'rubygems'
 require 'bundler/setup'
 
 require 'grim'
 
-RSpec.configure do |config|
+module FileHelpers
+  def dimensions_for_path(path)
+    width, height = `identify -format '%wx%h' #{path}`.strip.split('x').map(&:to_f)
+  end
+
   def fixture_path(name)
     path = File.expand_path("./spec/fixtures/")
     File.join(path, name)
@@ -19,4 +24,8 @@ RSpec.configure do |config|
   def tmp_path(name)
     File.join(tmp_dir, name)
   end
+end
+
+RSpec.configure do |config|
+  config.include(FileHelpers)
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: grim
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: 
   segments: 
   - 0
   - 2
-  - 1
-  version: 0.2.1
+  - 2
+  version: 0.2.2
 platform: ruby
 authors: 
 - Jonathan Hoyt