pdftoimage 0.1.6 → 0.1.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: eebf9a790b95c556d3b47ba87bd69998ccd15529
+  data.tar.gz: bc3a5653ae433aee369c98325f0358c1fec53d47
+SHA512:
+  metadata.gz: 7d13c5805d512c7bceba7f9da7bab1f74fcc9e5fbbca9f1c951abc08614818ce97835b44b8f5cf33eddb903fc1b7ee042d453cc7cbb9742943425616504bc634
+  data.tar.gz: b4c38f9539b6050e52c4b5cca7971bfb78f5357dae0b17807be779832e3706f062b7a6bf65dd740648c1ac9b7e951b516ef6f6da1d7985409685792a17a0f157

data/lib/pdftoimage.rb

@@ -1,117 +1,115 @@
-require 'tmpdir'
 require 'pdftoimage/version'
 require 'pdftoimage/image'
+
+require 'tmpdir'
 require 'iconv'
 
 module PDFToImage
-  class PDFError < RuntimeError; end
+    class PDFError < RuntimeError; end
 end
 
 module PDFToImage
-  # A class variable for storing the location of our temp folder
-  @@pdf_temp_dir = File.join(Dir.tmpdir())
-
-  begin
-    tmp = `pdftoppm -v 2>&1`
-    raise(PDFToImage::PDFError, "poppler_utils not installed") unless tmp.index('Poppler')
-  rescue Errno::ENOENT
-    raise PDFToImage::PDFError, "poppler_utils not installed"
-  end
-
-  begin
-    tmp = `identify -version 2>&1`
-    raise(PDFToImage::PDFError, "ImageMagick not installed") unless tmp.index('ImageMagick')
-  rescue Errno::ENOENT
-    raise PDFToImage::PDFError, "ImageMagick not installed"
-  end
-
-  class << self
+    # A class variable for storing the location of our temp folder
+    @@pdf_temp_dir = File.join(Dir.tmpdir())
+
+    begin
+        tmp = `pdftoppm -v 2>&1`
+        raise(PDFToImage::PDFError, "poppler_utils not installed") unless tmp.index('Poppler')
+    rescue Errno::ENOENT
+        raise PDFToImage::PDFError, "poppler_utils not installed"
+    end
 
-    # Opens a PDF document and prepares it for splitting into images.
-    #
-    # @param [filename] The filename of the PDF to open
-    # @return [Array] An array of images
-    def open(filename, &block)
-      if not File.exists?(filename)
-        raise PDFError, "File '#{filename}' not found."
-      end
+    begin
+        tmp = `identify -version 2>&1`
+        raise(PDFToImage::PDFError, "ImageMagick not installed") unless tmp.index('ImageMagick')
+    rescue Errno::ENOENT
+        raise PDFToImage::PDFError, "ImageMagick not installed"
+    end
 
-      pages = page_count(filename)
+    class << self
+        # Opens a PDF document and prepares it for splitting into images.
+        #
+        # @param filename [String] The filename of the PDF to open
+        #
+        # @return [Array] An array of images
+        def open(filename, &block)
+            if not File.exists?(filename)
+                raise PDFError, "File '#{filename}' not found."
+            end
 
-      # Array of images
-      images = []
+            pages = page_count(filename)
 
-      1.upto(pages) { |n|
-        dimensions = page_size(filename, n)
-        image = Image.new(filename, random_filename, n, dimensions, pages)
-        images << image
-      }
+            # Array of images
+            images = []
 
-      images.each(&block) if block_given?
+            1.upto(pages) { |n|
+                dimensions = page_size(filename, n)
+                image = Image.new(filename, random_filename, n, dimensions, pages)
+                images << image
+            }
 
-      return images
+            images.each(&block) if block_given?
 
-    end
-
-    # Executes the specified command, returning the output.
-    #
-    # @param [cmd] The command to run
-    # @return [String] The output of the command
-    def exec(cmd, error = nil)
-      output = `#{cmd}`
-      if $? != 0
-        if error == nil
-          raise PDFError, "Error executing command: #{cmd}"
-        else
-          raise PDFError, error
+            return images
         end
-      end
 
-      return output
-    end
+        # Executes the specified command, returning the output.
+        #
+        # @param cmd [String] The command to run
+        # @return [String] The output of the command
+        def exec(cmd, error = nil)
+            output = `#{cmd}`
+            if $? != 0
+                if error == nil
+                    raise PDFError, "Error executing command: #{cmd}"
+                else
+                    raise PDFError, error
+                end
+            end
+
+            return output
+        end
 
-    private
+        private
 
-    def page_size(filename, page)
-      cmd = "pdfinfo -f #{page} -l #{page} #{filename} | grep Page"
-      output = exec(cmd)
+        def page_size(filename, page)
+            cmd = "pdfinfo -f #{page} -l #{page} #{filename} | grep Page"
+            output = exec(cmd)
 
-      matches = /^Page.*?size:.*?(\d+).*?(\d+)/.match(output)
-      if matches.nil?
-        raise PDFError, "Unable to determine page size."
-      end
+            matches = /^Page.*?size:.*?(\d+).*?(\d+)/.match(output)
+            if matches.nil?
+                raise PDFError, "Unable to determine page size."
+            end
 
-      scale = 2.08333333333333333
-      dimension = {
-        :width => (matches[1].to_i * scale).to_i,
-        :height => (matches[2].to_i * scale).to_i
-      }
+            scale = 2.08333333333333333
+            dimension = {
+                width: (matches[1].to_i * scale).to_i,
+                height: (matches[2].to_i * scale).to_i
+            }
 
-      dimension
-    end
+            dimension
+        end
 
-    def page_count(filename)
-      cmd = "pdfinfo #{filename} | grep Pages"
-      output = exec(cmd)
-      matches = /^Pages:.*?(\d+)$/.match(output)
-      if matches.nil?
-        raise PDFError, "Error determining page count."
-      end
+        def page_count(filename)
+            cmd = "pdfinfo #{filename} | grep Pages"
+            output = exec(cmd)
+            matches = /^Pages:.*?(\d+)$/.match(output)
+            if matches.nil?
+                raise PDFError, "Error determining page count."
+            end
 
-      return matches[1].to_i
-    end
+            return matches[1].to_i
+        end
 
-    # Generate a random file name in the system's tmp folder
-    def random_filename
-      File.join(@@pdf_temp_dir, random_name)
-    end
+        # Generate a random file name in the system's tmp folder
+        def random_filename
+            File.join(@@pdf_temp_dir, random_name)
+        end
 
-    # Generate a random name of {#length} characters.
-    def random_name(length = 15)
-      @@chars ||= ("a".."z").to_a + ("A".."Z").to_a + ("1".."9").to_a
-      return 'pdftoimage-' + Array.new(length, '').collect{@@chars[rand(@@chars.size)]}.join
+        # Generate a random name of {#length} characters.
+        def random_name(length = 15)
+            @@chars ||= ("a".."z").to_a + ("A".."Z").to_a + ("1".."9").to_a
+            return 'pdftoimage-' + Array.new(length, '').collect { @@chars[rand(@@chars.size)] }.join
+        end
     end
-
-  end
-
 end

data/lib/pdftoimage/image.rb

@@ -1,115 +1,116 @@
 module PDFToImage
-
-  # A class which is instantiated by PDFToImage when a PDF document
-  # is opened.
-  class Image
-    attr_reader :pdf_name
-    attr_reader :filename
-    attr_reader :width
-    attr_reader :height
-    attr_reader :page
-    attr_reader :args
-    attr_reader :opened
-
-    # ImageMagick methods that we currently support.
-    CUSTOM_IMAGE_METHODS = [
-      "resize",
-      "quality"
-    ]
-
-    CUSTOM_IMAGE_METHODS.each do |method|
-      define_method(method.to_sym) do |*args|
-        @args << "-#{method} #{args.join(' ')}"
-
-        self
-      end
-    end
-
-    # Image constructor
-    #
-    # @param [filename] The name of the image file to open
-    def initialize(pdf_name, filename, page, page_size, page_count)
-      @args = []
-
-      @pdf_name = pdf_name
-      @filename = filename
-      @opened = false
-      @width = page_size[:width]
-      @height = page_size[:height]
-      @page_count = page_count
-
-      @page = page
-    end
-
-    # Saves the converted image to the specified location
-    #
-    # @param [outname] The output filename of the image
-    #
-    def save(outname)
-
-      generate_temp_file
-
-      cmd = "convert "
-
-      if not @args.empty?
-        cmd += "#{@args.join(' ')} "
-      end
-      
-      cmd += "#{@filename} #{outname}"
-
-      PDFToImage::exec(cmd)
-
-      return true
-    end
-
-    def <=>(img)
-      if @page == img.page
-        return 0
-      elsif @page < img.page
-        return -1
-      else
-        return 1
-      end
+    # A class which is instantiated by PDFToImage when a PDF document
+    # is opened.
+    class Image
+        attr_reader :pdf_name
+        attr_reader :filename
+        attr_reader :width
+        attr_reader :height
+        attr_reader :page
+        attr_reader :args
+        attr_reader :opened
+
+        # ImageMagick methods that we currently support.
+        CUSTOM_IMAGE_METHODS = [
+            "resize",
+            "quality"
+        ]
+
+        CUSTOM_IMAGE_METHODS.each do |method|
+            define_method(method.to_sym) do |*args|
+                @args << "-#{method} #{args.join(' ')}"
+
+                self
+            end
+        end
+
+        # Image constructor
+        #
+        # @param pdf_name [String] The name of the PDF
+        # @param filename [String] The name of the image for the specified page
+        # @param page [Integer] The page number of the PDF
+        # @param page_size [Hash] Hash containing width and height dimensions of the page
+        # @param page_count [integer] The number of pages in the PDF
+        #
+        def initialize(pdf_name, filename, page, page_size, page_count)
+            @args = []
+
+            @pdf_name = pdf_name
+            @filename = filename
+            @opened = false
+            @width = page_size[:width]
+            @height = page_size[:height]
+            @page_count = page_count
+
+            @page = page
+        end
+
+        # Saves the converted image to the specified location
+        #
+        # @param outname [String] The output filename of the image
+        #
+        def save(outname)
+            generate_temp_file
+
+            cmd = "convert "
+
+            if not @args.empty?
+                cmd += "#{@args.join(' ')} "
+            end
+
+            cmd += "#{@filename} #{outname}"
+
+            PDFToImage.exec(cmd)
+
+            return true
+        end
+
+        def <=>(img)
+            if @page == img.page
+                return 0
+            elsif @page < img.page
+                return -1
+            else
+                return 1
+            end
+        end
+
+      private
+
+        def generate_temp_file
+            if @opened == false
+                cmd = "pdftoppm -png -f #{@page} -l #{@page} #{@pdf_name} #{@filename}"
+                PDFToImage.exec(cmd)
+                @filename = "#{@filename}-#{page_suffix}.png"
+                @opened = true
+            end
+
+            return true
+        end
+
+        def page_suffix
+            cur_page_len = @page.to_s.length
+            total_page_len = @page_count.to_s.length
+
+            num_zeroes = total_page_len - cur_page_len
+
+            # This is really weird. Basically, poppler_utils does not
+            # prepend a '0' to the page count when the total number of
+            # pages is 10, 100, 1000, 10000, etc. I hate putting this here,
+            # but whatever...
+
+            # TODO: Keep an eye on this. This suddenly started causing problems.
+            # Did poppler_utils change?
+            #      if @page_count.to_s.reverse.to_i == 1 && num_zeroes > 0
+            #       num_zeroes = num_zeroes - 1
+            #      end
+
+            if cur_page_len == total_page_len
+                @page
+            end
+
+            padded = '0' * num_zeroes + @page.to_s
+            padded
+        end
     end
-
-    private
-
-    def generate_temp_file
-      if @opened == false
-        cmd = "pdftoppm -png -f #{@page} -l #{@page} #{@pdf_name} #{@filename}"
-        PDFToImage::exec(cmd)
-        @filename = "#{@filename}-#{page_suffix}.png"
-        @opened = true
-      end
-
-      return true
-    end
-
-    def page_suffix
-      cur_page_len = @page.to_s.length
-      total_page_len = @page_count.to_s.length
-
-      num_zeroes = total_page_len - cur_page_len
-
-      # This is really weird. Basically, poppler_utils does not
-      # prepend a '0' to the page count when the total number of
-      # pages is 10, 100, 1000, 10000, etc. I hate putting this here,
-      # but whatever...
-
-# TODO: Keep an eye on this. This suddenly started causing problems.
-# Did poppler_utils change?
-#      if @page_count.to_s.reverse.to_i == 1 && num_zeroes > 0
-#       num_zeroes = num_zeroes - 1
-#      end
-
-      if cur_page_len == total_page_len
-        @page
-      end
-
-      padded = '0' * num_zeroes + @page.to_s
-      padded
-    end
-
-  end
-
 end

data/lib/pdftoimage/version.rb

@@ -1,4 +1,4 @@
 module PDFToImage
-  # pdftoimage version
-  VERSION = "0.1.6"
+    # pdftoimage version
+    VERSION = "0.1.7"
 end

metadata

@@ -1,99 +1,66 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: pdftoimage
-version: !ruby/object:Gem::Version 
-  prerelease: 
-  version: 0.1.6
+version: !ruby/object:Gem::Version
+  version: 0.1.7
 platform: ruby
-authors: 
+authors:
 - Rob Flynn
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-07-13 00:00:00 -04:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: bundler
+date: 2018-05-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: iconv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
   prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        version: 1.0.0
-  type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: yard
-  prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        version: 0.6.0
-  type: :development
-  version_requirements: *id002
-description: A ruby gem for converting PDF documents into a series of images. This module is based off poppler_utils and ImageMagick.
-email: 
-- rob@thingerly.com
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: A ruby gem for converting PDF documents into a series of images. This
+  module is based off poppler_utils and ImageMagick.
+email: rob@thingerly.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
-- README.rdoc
-- ChangeLog.rdoc
-- LICENSE.txt
-files: 
-- .bundle/config
-- .document
-- .rspec
-- .yardopts
+extra_rdoc_files: []
+files:
 - ChangeLog.rdoc
-- Gemfile
-- Gemfile.lock
-- LICENSE.txt
+- LICENSE
 - README.rdoc
-- Rakefile
-- gemspec.yml
 - lib/pdftoimage.rb
 - lib/pdftoimage/image.rb
 - lib/pdftoimage/version.rb
-- pdftoimage.gemspec
-- spec/10pages.pdf
-- spec/11pages.pdf
-- spec/3pages.pdf
-- spec/pdftoimage_spec.rb
-- spec/spec_helper.rb
-has_rdoc: yard
 homepage: https://github.com/robflynn/pdftoimage
-licenses: 
+licenses:
 - MIT
+metadata:
+  changelog_uri: https://github.com/robflynn/pdftoimage/blob/master/ChangeLog.rdoc
+  source_code_uri: https://github.com/robflynn/pdftoimage/
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      version: 1.3.6
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: pdftoimage
-rubygems_version: 1.6.2
+rubyforge_project: 
+rubygems_version: 2.6.14.1
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A ruby gem for converting PDF documents into a series of images.
-test_files: 
-- spec/pdftoimage_spec.rb
+test_files: []

data/.bundle/config

@@ -1,2 +0,0 @@
---- {}
-

data/.document

@@ -1,3 +0,0 @@
-- 
-ChangeLog.*
-LICENSE.txt

data/.rspec

@@ -1 +0,0 @@
---colour --format documentation

data/.yardopts

@@ -1 +0,0 @@
---markup rdoc --title "pdftoimage Documentation" --protected

data/Gemfile

@@ -1,12 +0,0 @@
-source :rubygems
-
-gemspec
-
-group :development do
-  gem 'rake',     '~> 0.8.7'
-  gem 'ore-core',  '~> 0.1.0'
-  gem 'rspec', '>= 2.1.0'
-  gem 'yard', '~> 0.6.0'
-  gem 'autotest'
-  gem 'spork'
-end

data/Gemfile.lock

@@ -1,35 +0,0 @@
-PATH
-  remote: .
-  specs:
-    pdftoimage (0.1.6)
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    autotest (4.4.4)
-    diff-lcs (1.1.2)
-    ore-core (0.1.5)
-    rake (0.8.7)
-    rspec (2.1.0)
-      rspec-core (~> 2.1.0)
-      rspec-expectations (~> 2.1.0)
-      rspec-mocks (~> 2.1.0)
-    rspec-core (2.1.0)
-    rspec-expectations (2.1.0)
-      diff-lcs (~> 1.1.2)
-    rspec-mocks (2.1.0)
-    spork (0.8.4)
-    yard (0.6.2)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  autotest
-  bundler (~> 1.0.0)
-  ore-core (~> 0.1.0)
-  pdftoimage!
-  rake (~> 0.8.7)
-  rspec (>= 2.1.0)
-  spork
-  yard (~> 0.6.0)

data/Rakefile

@@ -1,26 +0,0 @@
-require 'rubygems'
-
-begin
-  require 'bundler'
-rescue LoadError => e
-  STDERR.puts e.message
-  STDERR.puts "Run `gem install bundler` to install Bundler."
-  exit e.status_code
-end
-
-begin
-  Bundler.setup(:development)
-rescue Bundler::BundlerError => e
-  STDERR.puts e.message
-  STDERR.puts "Run `bundle install` to install missing gems."
-  exit e.status_code
-end
-
-require 'rake'
-
-require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new
-task :default => :spec
-
-require 'yard'
-YARD::Rake::YardocTask.new  

data/gemspec.yml

@@ -1,13 +0,0 @@
-name: pdftoimage
-summary: "A ruby gem for converting PDF documents into a series of images."
-description: "A ruby gem for converting PDF documents into a series of images. This module is based off poppler_utils and ImageMagick."
-license: MIT
-authors: Rob Flynn
-homepage: https://github.com/robflynn/pdftoimage
-email: rob@thingerly.com
-has_yard: true
-
-development_dependencies:
-  bundler: ~> 1.0.0
-  yard: ~> 0.6.0
-

data/pdftoimage.gemspec

@@ -1,15 +0,0 @@
-# -*- encoding: utf-8 -*-
-
-begin
-  Ore::Specification.new do |gemspec|
-    # custom logic here
-  end
-rescue NameError
-  begin
-    require 'ore/specification'
-    retry
-  rescue LoadError
-    STDERR.puts "The 'my-project.gemspec' file requires Ore."
-    STDERR.puts "Run `gem install ore-core` to install Ore."
-  end
-end

data/spec/pdftoimage_spec.rb

@@ -1,83 +0,0 @@
-require 'spec_helper'
-require 'pdftoimage'
-
-describe PDFToImage do
-  it "should have a VERSION constant" do
-    PDFToImage.const_get('VERSION').should_not be_empty
-  end
-
-#  I will find a better solution for having this commented out. I do not
-#  have permission to release the document that I used for this test case.
-#  I will generate a sufficiently buggy version.  Basically, buggy PDF software
-#  sometimes corrupts CreationDate and/or ModDate such as discussed here: http://www.linuxquestions.org/questions/solaris-opensolaris-20/converting-utf-16-files-to-another-encoding-such-as-utf-8-a-630588/
-#  I also need to come upw ith a better solution 
-
-#  describe "edge cases" do
-#    it "should handle invalid utf-8 in headers without crashing" do
-#    	@pages = PDFToImage.open('spec/weird_utf8.pdf')
-#	@pages.size.should equal 1
-#	@pages[0].resize('50%').save('spec/tmp1.jpg')
-#	File.exists?('spec/tmp1.jpg').should equal true
-#	File.unlink('spec/tmp1.jpg')
-#    end
-#  end
-
-  describe "3pages.pdf" do
-    it "should have three pages" do
-    @pages = PDFToImage.open('spec/3pages.pdf')
-      @pages.size.should equal 3
-    end
-
-    it "should allow saving" do
-      @pages = PDFToImage.open('spec/3pages.pdf')
-      @pages.each do |page|
-        page.save('spec/tmp.jpg')
-        File.exists?('spec/tmp.jpg').should equal true
-        File.unlink('spec/tmp.jpg')
-      end
-    end
-
-    it "should allow resizing and quality control" do
-      @pages = PDFToImage.open('spec/3pages.pdf')
-      @pages[0].resize('50%').quality('80%').save('spec/tmp2.jpg')
-      File.exists?('spec/tmp2.jpg').should equal true
-      File.unlink('spec/tmp2.jpg')
-    end
-
-    it "should work with blocks" do
-      counter = 0
-      PDFToImage.open("spec/3pages.pdf") do |page|
-        counter = counter + 1
-      end
-      counter.should equal 3
-    end
-  end
-
-  describe "multi page documents" do
-    it "should parse 10 page documents properly" do
-      counter = 0
-      PDFToImage.open('spec/10pages.pdf') do |page|
-        result = page.save("spec/10pg-#{page.page}.jpg")
-        File.exists?("spec/10pg-#{page.page}.jpg").should equal true
-        File.unlink("spec/10pg-#{page.page}.jpg")
-        counter = counter + 1
-      end
-
-      counter.should equal 10
-    end
-
-    it "should parse 11 page counts" do
-      counter = 0
-      PDFToImage.open('spec/11pages.pdf') do |page|
-        result = page.save("spec/11pg-#{page.page}.jpg")
-        File.exists?("spec/11pg-#{page.page}.jpg").should equal true
-        File.unlink("spec/11pg-#{page.page}.jpg")
-        counter = counter + 1
-      end
-
-      counter.should equal 11
-    end
-
-
-  end
-end

data/spec/spec_helper.rb

@@ -1,13 +0,0 @@
-require 'rubygems'
-require 'spork'
-
-Spork.prefork do
-  require 'rspec'
-  require 'pdftoimage/version'
-
-  include PDFToImage
-end
-
-Spork.each_run do
-end
-