pdfshaver 0.0.1.alpha

data/test/page_set_spec.rb

@@ -0,0 +1,62 @@
+require File.expand_path(File.join(File.dirname(__FILE__),'spec_helper'))
+
+describe PDFShaver::PageSet do
+
+  before do
+    path              = File.join(FIXTURES, 'uncharter.pdf')
+    @document         = PDFShaver::Document.new(path)
+    @first_half_range = Range.new(1, @document.length/2)
+    @last_half_range  = Range.new(@document.length/2, @document.length)
+  end
+  
+  it "should be an enumerable collection of pages" do
+    pages = PDFShaver::PageSet.new(@document)
+    pages.must_be_instance_of PDFShaver::PageSet
+    pages.must_respond_to(:each)
+  end
+  
+  it "should iterate all pages by default" do
+    counter = 0
+    PDFShaver::PageSet.new(@document).each{ |page| counter += 1 }
+    counter.must_equal @document.length
+  end
+  
+  it "should iterate through a specified list of pages" do
+    counter = 0
+    PDFShaver::PageSet.new(@document, @first_half_range).each{ |page| counter += 1 }
+    counter.must_equal @document.length/2
+  end
+  
+  it "should provide a number of ways to express page lists" do
+    { 1           => 1,
+      [1,2,3,5,8] => 5,
+      5..10       => 6,
+      [1, 5..10]  => 7
+    }.each do |list, count| 
+      #puts list.inspect
+      PDFShaver::PageSet.new(@document, list).size.must_equal count
+    end
+  end
+  
+  it "should reject any page value that's out of bounds" do
+    [5000, -1, 5..-5, 10..8].each do|input| 
+      Proc.new{ PDFShaver::PageSet.new(@document, input) }.must_raise ArgumentError
+    end
+  end
+  
+  it "should provide an accessor, #first and #last to specify the set" do
+    pages = PDFShaver::PageSet.new(@document, @last_half_range)
+    pages.first.must_equal PDFShaver::Page.new(@document, @last_half_range.first)
+    pages.last.must_equal  PDFShaver::Page.new(@document, @last_half_range.last)
+    pages[1].must_equal    PDFShaver::Page.new(@document, @last_half_range.first+1)
+  end
+  
+  describe "Document PageSet Interface" do
+    it { @document.pages.must_be_instance_of PDFShaver::PageSet }
+    
+    it "should have accessors to specific pages" do
+      @document.pages[0].must_equal PDFShaver::Page.new(@document, 1)
+      @document.pages[@document.length-1].must_equal PDFShaver::Page.new(@document, @document.length)
+    end
+  end
+end

data/test/page_spec.rb

@@ -0,0 +1,133 @@
+require File.expand_path(File.join(File.dirname(__FILE__),'spec_helper'))
+
+describe PDFShaver::Page do
+  before do
+    path = File.join(FIXTURES, 'uncharter.pdf')
+    @document = PDFShaver::Document.new(path)
+  end
+  
+  it "should be instantiated" do
+    PDFShaver::Page.new(@document, 1).must_be_instance_of PDFShaver::Page
+  end
+  
+  it "should throw an error if initialized without a document" do
+    Proc.new{ PDFShaver::Page.new("lol", 1) }.must_raise ArgumentError
+  end
+  
+  it "should only instantiate pages with a valid page number" do
+    Proc.new{ PDFShaver::Page.new(@document) }.must_raise ArgumentError
+    Proc.new{ PDFShaver::Page.new(@document, -12) }.must_raise ArgumentError
+    Proc.new{ PDFShaver::Page.new(@document, 0) }.must_raise ArgumentError
+    Proc.new{ PDFShaver::Page.new(@document, @document.length+1) }.must_raise ArgumentError
+
+    PDFShaver::Page.new(@document, 1).must_be_instance_of PDFShaver::Page
+    PDFShaver::Page.new(@document, @document.length).must_be_instance_of PDFShaver::Page
+  end
+  
+  describe "instance methods" do
+    before do
+      @page = PDFShaver::Page.new(@document, 1)
+      @output_path = File.join OUTPUT, 'image_render_test.gif'
+    end
+    
+    it "should have the right width, height and aspect ratio" do
+      @page.width.must_be_kind_of Integer
+      @page.height.must_be_kind_of Integer
+      @page.aspect.must_be_kind_of Float
+      @page.document.must_be_same_as @document
+    end
+    
+    it "should have a comparator and know which order pages go in" do
+      p1 = PDFShaver::Page.new(@document, 1)
+      p2 = PDFShaver::Page.new(@document, 2)
+      p3 = PDFShaver::Page.new(@document, 3)
+      
+      (p2 <=> p1).must_equal 1
+      (p2 <=> p2).must_equal 0
+      (p2 <=> p3).must_equal -1
+      
+      Proc.new{ p2 <=> :lol }.must_raise ArgumentError
+    end
+    
+    it { @page.must_equal @page }
+    it { @page.must_equal PDFShaver::Page.new(@document,@page.number) }
+    
+    it "shouldn't be equal to a page with the same number from another document" do 
+      other_document = PDFShaver::Document.new(File.join(FIXTURES, 'letter-to-canadians-from-jack-layton.pdf'))
+      (@page.document).wont_equal other_document
+      @page.wont_equal PDFShaver::Page.new(other_document, @page.number)
+    end
+    
+    it "should render an image and write it out to disk" do
+      @page.render(@output_path).must_equal true
+      File.exists?(@output_path).must_equal true
+    end
+    
+    it "should throw an error when saving to an unrecognized file type" do
+      fail_path = File.join(OUTPUT, "this_will_never_be.a_valid_filetype")
+      Proc.new{ @page.render(fail_path) }.must_raise ArgumentError
+      File.exists?(fail_path).must_equal false
+    end
+    
+    it "should raise an error if output path is missing" do
+      Proc.new{ @page.render }.must_raise ArgumentError
+    end
+    
+    it "should use default page size if dimensions aren't specified" do
+      @page.render @output_path
+      FastImage.size(@output_path).zip([@page.width, @page.height]).each do |actual, expected|
+        actual.must_equal expected
+      end
+    end
+    
+    it "should scale image when height is specified" do
+      target_height = 1000
+      @page.render @output_path, height:target_height, width:nil
+      width, height = FastImage.size @output_path
+      height.must_equal target_height
+    end
+
+    it "should scale image when width is specified" do
+      target_width = 1000
+      @page.render @output_path, height:nil, width:target_width
+      width, height = FastImage.size @output_path
+      width.must_equal target_width
+    end
+    
+    it "should scale image when height and width are specified" do
+      target_height = target_width = 1000
+      @page.render @output_path, height:target_height, width:target_width
+      width, height = FastImage.size @output_path
+      width.must_equal target_width
+      height.must_equal target_height
+    end
+    
+    it "should preserve aspect ratio when scaling" do
+      @page.render @output_path, height:1000, width:nil
+      width, height = FastImage.size @output_path
+      (width.to_f / height).must_be_within_delta @page.aspect, 0.001
+    end
+  end
+  
+  describe "GC" do
+    it "won't segfault if when a document is GCed" do
+      doc = PDFShaver::Document.new(File.join(FIXTURES,'uncharter.pdf'))
+      doc = nil
+      GC.start
+    end
+    
+    it "won't segfault if when an invalid document is GCed" do
+      Proc.new{ PDFShaver::Document.new("suede shoes") }.must_raise ArgumentError
+      GC.start
+    end
+    
+    it "won't segfault if document falls out of scope before pages" do
+      doc = PDFShaver::Document.new(File.join(FIXTURES,'uncharter.pdf'))
+      p1 = PDFShaver::Page.new(doc, 1)
+      doc = nil
+      GC.start
+      p1 = nil
+      GC.start
+    end
+  end
+end

data/test/spec_helper.rb

@@ -0,0 +1,13 @@
+require "minitest/autorun"
+require 'fastimage'
+require 'fileutils'
+
+HERE = File.expand_path File.dirname(__FILE__)
+FIXTURES = File.join(HERE, 'fixtures')
+OUTPUT = File.join(HERE, 'output')
+FileUtils.mkdir_p OUTPUT
+
+MiniTest::Unit.after_tests { FileUtils.rm_r(OUTPUT) if File.exists?(OUTPUT) and not ENV["DEBUG"] }
+
+require File.join(HERE, '..', 'lib', 'pdfshaver')
+

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: pdfshaver
+version: !ruby/object:Gem::Version
+  version: 0.0.1.alpha
+platform: ruby
+authors:
+- Ted Han
+- Nathan Stitt
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fastimage
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email: opensource@documentcloud.org
+executables: []
+extensions:
+- ext/pdfium_ruby/extconf.rb
+extra_rdoc_files: []
+files:
+- Gemfile
+- Rakefile
+- Readme.md
+- ext/pdfium_ruby/document.cpp
+- ext/pdfium_ruby/document.h
+- ext/pdfium_ruby/extconf.rb
+- ext/pdfium_ruby/page.cpp
+- ext/pdfium_ruby/page.h
+- ext/pdfium_ruby/pdfium_ruby.cpp
+- ext/pdfium_ruby/pdfium_ruby.h
+- lib/pdfshaver.rb
+- lib/pdfshaver/document.rb
+- lib/pdfshaver/page.rb
+- lib/pdfshaver/page_set.rb
+- lib/pdfshaver/version.rb
+- pdfshaver.gemspec
+- test/document_spec.rb
+- test/fixtures/completely_encrypted.pdf
+- test/fixtures/encrypted.pdf
+- test/fixtures/letter-to-canadians-from-jack-layton.pdf
+- test/fixtures/uncharter.pdf
+- test/gm_compatability_spec.rb
+- test/page_set_spec.rb
+- test/page_spec.rb
+- test/spec_helper.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Shave pages off of PDFs as images
+test_files: []