mupdf 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fcb2e83601972892c61f01d0a91ad66f53c1d1a1df766c45c469c19eb00de40f
-  data.tar.gz: aad84a0df2ba34f3b30d6a9d8972ac8d82ecdc676178921e14cd08056c16b462
+  metadata.gz: b7668e9689741bc823e304c97df7c135f9ed31453fedbed2d5f06e19a8be3f43
+  data.tar.gz: ee5b8c0c417dee4b2e80a063b06fb2699753e1857e9c6c11e0d50d7448815e81
 SHA512:
-  metadata.gz: acab8e6d850da0af08debf29efce668cec344eea8f107d5a907c39852503d18a5605724af28aed3bdb4bfa7966866f9ca7cdb02101eafcb82c5945f74308121b
-  data.tar.gz: '08bbc69726f80f47888c5dc5dcfc76282f6b70f23199bacc2f3600103264cb011e46344e0f8ffa53877cd528f11f0e5a9d36947381c5c76a3fe6a22f6f338131'
+  metadata.gz: 2b85d9364a453fabcce166ef780a6340a885d88022765488de11a09c080ff6e4770d9c92609b1a531bea062b6ceb08d1ea46035a4d8db119065d6302f49b5326
+  data.tar.gz: a315ed8e2f213ed39a5cfe45cd742d80d73d65c8fa37bdbf3e16d96a433a34a9490ac3ec454e2efcf9e86a6dfac0abc30c9dae2406f9a18e82fa8e92cbfc94df

data/Gemfile

@@ -10,4 +10,5 @@ gem 'rspec_junit_formatter'
 gem 'rubocop'
 gem 'rubocop-rake'
 gem 'rubocop-rspec'
+gem 'simplecov'
 gem 'yard'

data/README.md

@@ -14,6 +14,33 @@ gem install mupdf
 
 ## Usage
 
+### Document
+
+A `MuPDF::Document` wraps a PDF file:
+
+```ruby
+document = MuPDF::Document.new('./file.pdf')
+```
+
+#### Info
+
+The `info` command displays information about the document such as the number of pages:
+
+```ruby
+info = document.info
+info.pages # e.g. 2
+```
+
+#### Pages
+
+The `pages` command finds sizing information about the pages within a document:
+
 ```ruby
-MuPDF.mutool('info', 'file.pdf')
+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
 ```

data/lib/mupdf/box.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module MuPDF
+  # A bounding box for a PDF (e.g. media / crop / bleed / trim).
+  class Box
+    REGEX = /l="(?<l>\d+)" b="(?<b>\d+)" r="(?<r>\d+)" t="(?<t>\d+)"/
+
+    # @!attribute l
+    #   @return [String] The left coordinate.
+    attr_reader :l
+
+    # @!attribute b
+    #   @return [String] The bottom coordinate.
+    attr_reader :b
+
+    # @!attribute r
+    #   @return [String] The right coordinate.
+    attr_reader :r
+
+    # @!attribute t
+    #   @return [String] The top coordinate.
+    attr_reader :t
+
+    # @!attribute kind
+    #   @return [Symbol] The kind of box.
+    attr_reader :kind
+
+    # @param text [String]
+    # @param kind [Symbol]
+    #
+    # @return [MuPDF::Box]
+    def self.parse(text, kind:)
+      match = text.match(REGEX)
+
+      new(
+        l: Integer(match[:l]),
+        b: Integer(match[:b]),
+        r: Integer(match[:r]),
+        t: Integer(match[:t]),
+        kind:
+      )
+    end
+
+    # @param l [Integer]
+    # @param b [Integer]
+    # @param r [Integer]
+    # @param t [Integer]
+    # @param kind [Symbol] optional
+    def initialize(l:, b:, r:, t:, kind: nil)
+      @l = l
+      @b = b
+      @r = r
+      @t = t
+      @kind = kind
+    end
+
+    # @return [String]
+    def inspect
+      "#<#{self.class.name} l=#{l} b=#{b} r=#{r} t=#{t} kind=#{kind}>"
+    end
+
+    # @return [Integer]
+    def width
+      @r - @l
+    end
+
+    # @return [Integer]
+    def height
+      @t - @b
+    end
+  end
+end

data/lib/mupdf/document.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module MuPDF
+  # A wrapper for a PDF document allowing for MuPDF APIs.
+  class Document
+    # @param pathname [Pathname]
+    def initialize(pathname)
+      @pathname = pathname
+    end
+
+    # @return [String]
+    def inspect
+      "#<#{self.class.name} pathname=#{@pathname}>"
+    end
+
+    # @raise [MuPDF::CommandError]
+    #
+    # @return [MuPDF::Info]
+    def info
+      @info ||= begin
+        result = MuPDF.mutool('info', String(@pathname))
+        MuPDF::Info.parse(result)
+      end
+    end
+
+    # @raise [MuPDF::CommandError]
+    #
+    # @return [Array<MuPDF::Page>]
+    def pages
+      @pages ||= begin
+        result = MuPDF.mutool('pages', String(@pathname))
+        MuPDF::Page.parse(result)
+      end
+    end
+  end
+end

data/lib/mupdf/info.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module MuPDF
+  # A wrapper for the result of a `mutool info ...` command.
+  class Info
+    PARSE_REGEX = /^Pages: (?<pages>\d+)$/
+
+    # @!attribute description
+    #   @return [String] The description of the task.
+    attr_reader :pages
+
+    # @param text [String]
+    #
+    # @return [MuPDF::Info]
+    def self.parse(text)
+      match = text.match(PARSE_REGEX)
+      new(pages: Integer(match[:pages]))
+    end
+
+    # @param pages [Integer]
+    def initialize(pages:)
+      @pages = pages
+    end
+  end
+end

data/lib/mupdf/page.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+module MuPDF
+  # A wrapper for a PDF page within a PDF document.
+  class Page
+    REGEX = %r{<page pagenum="(?<pagenum>\d+)">(?<content>.*?)</page>}m
+    MEDIA_BOX_REGEX = %r{<MediaBox (?<content>.*?) />}
+    CROP_BOX_REGEX = %r{<CropBox (?<content>.*?) />}
+    ART_BOX_REGEX = %r{<ArtBox (?<content>.*?) />}
+    BLEED_BOX_REGEX = %r{<BleedBox (?<content>.*?) />}
+    TRIM_BOX_REGEX = %r{<TrimBox (?<content>.*?) />}
+
+    # @param text [String]
+    #
+    # @return [Array<MuPDF::Page>]
+    def self.parse(text)
+      text.scan(REGEX).map do |pagenum, 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)
+        )
+      end
+    end
+
+    # @param text [String]
+    #
+    # @return [MuPDF::Box]
+    def self.parse_media_box(text)
+      match = MEDIA_BOX_REGEX.match(text)
+      MuPDF::Box.parse(match[:content], kind: :media)
+    end
+
+    # @param text [String]
+    #
+    # @return [MuPDF::Box]
+    def self.parse_crop_box(text)
+      match = CROP_BOX_REGEX.match(text)
+      MuPDF::Box.parse(match[:content], kind: :crop)
+    end
+
+    # @param text [String]
+    #
+    # @return [MuPDF::Box]
+    def self.parse_art_box(text)
+      match = ART_BOX_REGEX.match(text)
+      MuPDF::Box.parse(match[:content], kind: :art)
+    end
+
+    # @param text [String]
+    #
+    # @return [MuPDF::Box]
+    def self.parse_bleed_box(text)
+      match = BLEED_BOX_REGEX.match(text)
+      MuPDF::Box.parse(match[:content], kind: :bleed)
+    end
+
+    # @param text [String]
+    #
+    # @return [MuPDF::Box]
+    def self.parse_trim_box(text)
+      match = TRIM_BOX_REGEX.match(text)
+      MuPDF::Box.parse(match[:content], kind: :trim)
+    end
+
+    # @!attribute media_box
+    #   @return [MuPDFBox]
+    attr_accessor :media_box
+
+    # @!attribute crop_box
+    #   @return [MuPDFBox]
+    attr_accessor :crop_box
+
+    # @!attribute art_box
+    #   @return [MuPDFBox]
+    attr_accessor :art_box
+
+    # @!attribute bleed_box
+    #   @return [MuPDFBox]
+    attr_accessor :bleed_box
+
+    # @!attribute trim_box
+    #   @return [MuPDFBox]
+    attr_accessor :trim_box
+
+    # @!attribute pagenum
+    #   @return [Integer]
+    attr_accessor :pagenum
+
+    # @param media_box [MuPDF::Box]
+    # @param crop_box [MuPDF::Box]
+    # @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:)
+      @media_box = media_box
+      @crop_box = crop_box
+      @art_box = art_box
+      @bleed_box = bleed_box
+      @trim_box = trim_box
+      @pagenum = pagenum
+    end
+
+    # @return [String]
+    def inspect
+      "#<#{self.class.name} pagenum=#{pagenum}>"
+    end
+  end
+end

data/lib/mupdf/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mupdf
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Kevin Sylvestre
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-01-02 00:00:00.000000000 Z
+date: 2025-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: open3
@@ -50,7 +50,11 @@ files:
 - bin/console
 - bin/setup
 - lib/mupdf.rb
+- lib/mupdf/box.rb
 - lib/mupdf/command_error.rb
+- lib/mupdf/document.rb
+- lib/mupdf/info.rb
+- lib/mupdf/page.rb
 - lib/mupdf/version.rb
 homepage: https://github.com/ksylvest/mupdf
 licenses:
@@ -58,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.2.0
-  changelog_uri: https://github.com/ksylvest/mupdf/releases/tag/v0.2.0
+  source_code_uri: https://github.com/ksylvest/mupdf/tree/v0.4.0
+  changelog_uri: https://github.com/ksylvest/mupdf/releases/tag/v0.4.0
   documentation_uri: https://mupdf.ksylvest.com/
 post_install_message: 
 rdoc_options: []