mupdf 0.4.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7668e9689741bc823e304c97df7c135f9ed31453fedbed2d5f06e19a8be3f43
-  data.tar.gz: ee5b8c0c417dee4b2e80a063b06fb2699753e1857e9c6c11e0d50d7448815e81
+  metadata.gz: 75c0956dd50c089d4cea76952bdc5c4244a946c674d4e648edc71d749bd1faca
+  data.tar.gz: c5fe14cf7c06739d4e03480c894ab938c4e0fa68b897bdcf4b49e0f078f33bf5
 SHA512:
-  metadata.gz: 2b85d9364a453fabcce166ef780a6340a885d88022765488de11a09c080ff6e4770d9c92609b1a531bea062b6ceb08d1ea46035a4d8db119065d6302f49b5326
-  data.tar.gz: a315ed8e2f213ed39a5cfe45cd742d80d73d65c8fa37bdbf3e16d96a433a34a9490ac3ec454e2efcf9e86a6dfac0abc30c9dae2406f9a18e82fa8e92cbfc94df
+  metadata.gz: 842db6317559209c6f2a6b0205adc8e2792c395be8fc61c0b5b23a6d750d86daf8a9642b656661efea26981cbbe6e8b64c83cd9448b470941bedc7c8011df04c
+  data.tar.gz: e3e79b6054b2f4f32947d62b64ca421d71efe1c949d544e99e0464503a22dde8472d4cb5da7e8cf9770d464dd7bd0f8e5b2a95d8351ab7c9347edd88405b32b9

data/Gemfile

@@ -11,4 +11,5 @@ gem 'rubocop'
 gem 'rubocop-rake'
 gem 'rubocop-rspec'
 gem 'simplecov'
+gem 'tempfile'
 gem 'yard'

data/README.md

@@ -12,6 +12,24 @@
 gem install mupdf
 ```
 
+_This project requires `mutool` be installed on your system. To verify ensure the following works:_
+
+```bash
+mutool
+```
+
+To install `mutool` on MacOS use:
+
+```bash
+brew install mupdf
+```
+
+To install `mutool` on Ubuntu use:
+
+```bash
+apt-get install mupdf
+```
+
 ## Usage
 
 ### Document
@@ -38,9 +56,19 @@ The `pages` command finds sizing information about the pages within a document:
 ```ruby
 pages = document.pages
 pages.count # e.g. 2
-page = pages[0]
-page.pagenum # 1
-box = page.media_box # page.crop_box / page.bleed_box / page.trim_box / page.art_box
-box.width # 612
-box.height # 792
+pages.each do |page|
+  page.number # e.g. 1, 2, ...
+  page.width # 612
+  page.height # 792
+end
+```
+
+#### Draw
+
+The `draw` command is useful for converting a document between formats:
+
+```ruby
+document.pages.each do |page|
+  document.draw(page: page.number, format: "png", path: "./file-#{page.number}.png")
+end
 ```

data/lib/mupdf/document.rb

@@ -13,6 +13,9 @@ module MuPDF
       "#<#{self.class.name} pathname=#{@pathname}>"
     end
 
+    # @usage
+    #   document.info #=> #<MuPDF::Info ...>
+    #
     # @raise [MuPDF::CommandError]
     #
     # @return [MuPDF::Info]
@@ -23,6 +26,14 @@ module MuPDF
       end
     end
 
+    # @usage
+    #   pages = document.pages #=> [#<MuPDF::Page ...>, ...]
+    #   pages.each do |page|
+    #     puts page.number # e.g. 1, 2, 3, ...
+    #     puts page.width # e.g. 612
+    #     puts page.height # e.g. 792
+    #   end
+    #
     # @raise [MuPDF::CommandError]
     #
     # @return [Array<MuPDF::Page>]
@@ -32,5 +43,28 @@ module MuPDF
         MuPDF::Page.parse(result)
       end
     end
+
+    # @usage
+    #   Tempfile.open(['mupdf', '.png']) do |tempfile|
+    #     document.draw(path: tempfile.path, page: 2, format: 'png')
+    #   end
+    #
+    # @param path [String] the path where the conversion is saved
+    # @param format [String] "png", "svg", "txt", etc
+    # @param page [Integer] the page
+    # @param resultion [Integer] optional (default: 72)
+    # @param width [Integer] optional
+    # @param height [Integer] optional
+    #
+    # @raise [MuPDF::CommandError]
+    def draw(path:, page:, format: 'png', width: nil, height: nil, resolution: nil)
+      args = ['draw', '-o', path, '-F', format, String(@pathname), String(page)]
+
+      args << '-w' << width if width
+      args << '-h' << height if height
+      args << '-r' << resolution if resolution
+
+      MuPDF.mutool(*args)
+    end
   end
 end

data/lib/mupdf/page.rb

@@ -14,14 +14,14 @@ module MuPDF
     #
     # @return [Array<MuPDF::Page>]
     def self.parse(text)
-      text.scan(REGEX).map do |pagenum, content|
+      text.scan(REGEX).map do |number, content|
         new(
           media_box: parse_media_box(content),
           crop_box: parse_crop_box(content),
           art_box: parse_art_box(content),
           bleed_box: parse_bleed_box(content),
           trim_box: parse_trim_box(content),
-          pagenum: Integer(pagenum)
+          number: Integer(number)
         )
       end
     end
@@ -95,19 +95,29 @@ module MuPDF
     # @param art_box [MuPDF::Box]
     # @param bleed_box [MuPDF::Box]
     # @param trim_box [MuPDF::Box]
-    # @param pagenum [Integer]
-    def initialize(media_box:, crop_box:, art_box:, bleed_box:, trim_box:, pagenum:)
+    # @param number [Integer]
+    def initialize(media_box:, crop_box:, art_box:, bleed_box:, trim_box:, number:)
       @media_box = media_box
       @crop_box = crop_box
       @art_box = art_box
       @bleed_box = bleed_box
       @trim_box = trim_box
-      @pagenum = pagenum
+      @number = number
     end
 
     # @return [String]
     def inspect
-      "#<#{self.class.name} pagenum=#{pagenum}>"
+      "#<#{self.class.name} number=#{@number}>"
+    end
+
+    # @return [Integer]
+    def width
+      @media_box.width
+    end
+
+    # @return [Integer]
+    def height
+      @media_box.height
     end
   end
 end

data/lib/mupdf/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MuPDF
-  VERSION = '0.4.0'
+  VERSION = '1.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mupdf
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Kevin Sylvestre
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-01-03 00:00:00.000000000 Z
+date: 2025-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: open3
@@ -62,8 +62,8 @@ licenses:
 metadata:
   rubygems_mfa_required: 'true'
   homepage_uri: https://github.com/ksylvest/mupdf
-  source_code_uri: https://github.com/ksylvest/mupdf/tree/v0.4.0
-  changelog_uri: https://github.com/ksylvest/mupdf/releases/tag/v0.4.0
+  source_code_uri: https://github.com/ksylvest/mupdf/tree/v1.0.0
+  changelog_uri: https://github.com/ksylvest/mupdf/releases/tag/v1.0.0
   documentation_uri: https://mupdf.ksylvest.com/
 post_install_message: 
 rdoc_options: []