pdftoimage 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 63b80a5a933c53e13c0928aeca1fc5592d91d2c6d93d6e1bc0712e33180469f0
-  data.tar.gz: aa20e7f2a5e45ae52ad1a40c826ba1b0bfdb5c4ead284e1332243d3ddcfd7efa
+  metadata.gz: 382ac5bc0e37e99acc44c9b7b40883ca8ca0a7b72595229e460fd4c0d4f6ee27
+  data.tar.gz: 6163c9afa9cc35a3bf6231af43eaf7ee1a5ae490c946b886f2904f63af2af9b6
 SHA512:
-  metadata.gz: 2bde807b5302cf3f0de8fac2beb888b69b6a6b557e9a8a206405feb2b31e7cdc262e51c3bf6b32887a7580c1cea31b3c9aaa329500c12be25e7a237d681fc4cd
-  data.tar.gz: e5857849b1b9a4f60a0ba07501429eceae4a1973331caee859e6d31ae43efc52a48d87e7556e7509af2f1e401724e129c1f921d785d059438f8827814e81c005
+  metadata.gz: 640b7bbd60b1a15db121c27c1d56b360dbb509c6cdce62d525ed3ea8aceeed3e67ee359eae9db350e0d031c06b178ad5723cc29990075b96f762ad075627c614
+  data.tar.gz: 76a9559c9e50853022d5ef8748f1a0733bd065e5a832e47d3cb5106f8825b9860b786d5c1d87edb495fa511f62efc55b41b089e947bae3fc39c7e3dcd6ef4599

data/CHANGELOG.md

@@ -4,6 +4,11 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com).
 
+## [0.3.1] - 2026-03-21
+
+### Added
+- `Image#crop(x, y, w, h)` for extracting a rectangular region from a PDF page
+
 ## [0.3.0] - 2026-03-20
 
 ### Added

data/README.md

@@ -0,0 +1,91 @@
+# pdftoimage
+
+A Ruby gem for converting PDF documents into images using [poppler_utils](https://poppler.freedesktop.org/) and [MiniMagick](https://github.com/minimagick/minimagick).
+
+## Installation
+
+```sh
+gem install pdftoimage
+```
+
+### Requirements
+
+- [poppler_utils](https://poppler.freedesktop.org/)
+- [ImageMagick](https://imagemagick.org/)
+
+## Usage
+
+### From a file
+
+```ruby
+require 'pdftoimage'
+
+images = PDFToImage.open('somefile.pdf')
+images.each do |page|
+  page.resize('50%').save("output/page-#{page.page}.jpg")
+end
+```
+
+### With a block
+
+```ruby
+PDFToImage.open('report.pdf') do |page|
+  page.resize('150').quality('80%').save("out/thumbnail-#{page.page}.jpg")
+end
+```
+
+### From a URL
+
+```ruby
+pages = PDFToImage.open('https://example.com/report.pdf')
+pages[0].save('first_page.png')
+```
+
+### From an IO object
+
+```ruby
+File.open('report.pdf', 'rb') do |io|
+  pages = PDFToImage.open(io)
+  pages[0].save('first_page.png')
+end
+```
+
+### From binary data
+
+```ruby
+pdf_data = download_pdf_from_s3(key)
+pages = PDFToImage.from_blob(pdf_data)
+pages[0].save('first_page.png')
+```
+
+### Saving to an IO object
+
+```ruby
+pages = PDFToImage.open('report.pdf')
+
+io = StringIO.new(''.b)
+pages[0].save(io)
+io.rewind
+```
+
+### Cropping a region
+
+```ruby
+PDFToImage.open('report.pdf') do |page|
+  page.crop(0, 300, 100, 300).save("out/cropped-#{page.page}.jpg")
+end
+```
+
+### Setting resolution
+
+```ruby
+PDFToImage.open('report.pdf') do |page|
+  page.r(350).save("out/hires-#{page.page}.jpg")
+end
+```
+
+## License
+
+Copyright (c) 2026 Rob Flynn
+
+See [LICENSE](LICENSE) for details.

data/lib/pdftoimage/image.rb

@@ -78,6 +78,12 @@ module PDFToImage
             return true
         end
 
+        def crop(x, y, w, h)
+            @pdf_args.push("-x #{x}", "-y #{y}", "-W #{w}", "-H #{h}")
+
+            self
+        end
+
         def <=>(img)
             if @page == img.page
                 return 0

data/lib/pdftoimage/version.rb

@@ -1,4 +1,4 @@
 module PDFToImage
     # pdftoimage version
-    VERSION = "0.3.0"
+    VERSION = "0.3.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pdftoimage
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Rob Flynn
@@ -46,7 +46,7 @@ extra_rdoc_files: []
 files:
 - CHANGELOG.md
 - LICENSE
-- README.rdoc
+- README.md
 - lib/pdftoimage.rb
 - lib/pdftoimage/image.rb
 - lib/pdftoimage/version.rb
@@ -54,7 +54,7 @@ homepage: https://github.com/robflynn/pdftoimage
 licenses:
 - MIT
 metadata:
-  changelog_uri: https://github.com/robflynn/pdftoimage/blob/master/CHANGELOG.md
+  changelog_uri: https://github.com/robflynn/pdftoimage/blob/main/CHANGELOG.md
   source_code_uri: https://github.com/robflynn/pdftoimage/
 rdoc_options: []
 require_paths:

data/README.rdoc

@@ -1,51 +0,0 @@
-= pdftoimage
-
-* {Homepage}[http://rubygems.org/gems/pdftoimage]
-
-== Description
-
-PDFToImage is a ruby gem which allows for conversion of a PDF document into
-images. It uses poppler_utils to first convert the document to PNG and then
-allows usage of ImageMagick to convert the image into other formats.
-
-The reasoning behind using poppler_utils is due to the fact that ghostscript
-occasionally has trouble with certain PDF documents which poppler_utils seems
-to be able to parse without error.
-
-== Examples
-
-  require 'pdftoimage'
-  images = PDFToImage.open('somefile.pdf')
-  images.each do |img|
-    img.resize('50%').save("output/page-#{img.page}.jpg")
-  end
-
-  require 'pdftoimage'
-  PDFToImage.open('anotherpdf.pdf') do |page|
-    page.resize('150').quality('80%').save('out/thumbnail-#{page.page}.jpg")
-  end
-
-  require 'pdftoimage'
-  PDFToImage.open('anotherpdf.pdf') do |page|
-    # Set the resolution to 350dpi
-    page.r(350).save('out/thumbnail-#{page.page}.jpg")
-  end
-
-
-
-== Requirements
-
-poppler_utils
-
-ImageMagick
-
-
-== Install
-
-  $ gem install pdftoimage
-
-== Copyright
-
-Copyright (c) 2023 Rob Flynn
-
-See LICENSE for details.