mupdf 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad445c502c69e3143bf400a94e9c3e1935dce191e58f7585aa8fdd164ac8e744
-  data.tar.gz: 84f2f037ab19c276d719bcc85b9dbc13dba28c4107e11b71702e55b31af3f788
+  metadata.gz: 025aace876d1fc5f6ba89c7e94fb7a618b645c5011d1eb7d3923252ca1643693
+  data.tar.gz: 9cc27d161818550e2b3290933652be4c1b8474f550f7c6f71a59eda5af4f02cc
 SHA512:
-  metadata.gz: d5d322ac79969df1cbb4a454a9d0df8298a632727caf82b4b4d93515f650b53162e3031bfd0be30dbd93dd97e1b50ed15cf844f360c216916af6d7245456db7f
-  data.tar.gz: 043c241a4c8cac55ac0597ccc46a9fb940bc8b62f5461d6fd6c66d9ebe8c6095300c2780ef8b52a00882b07ab87c26415739157ce4d597204f3ba2515dfb4d5c
+  metadata.gz: baf0ad502de63e12d938481d8944a96091a74f85e5d42189bcac9b7b0afb5b262f133e70eae434ac3f129349105262ececeff6e3feadbc037f4be14fd7127502
+  data.tar.gz: 90a9bedd5984280f820b76bbbcab596bea290bdb79c6e699cf029898569cc006e23e7c26ea1877a95d8406a025e2dd70f2faec675f8aab0af2b143d9fa76352f

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

@@ -1 +1,32 @@
 # MuPDF
+
+[![LICENSE](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/ksylvest/mupdf/blob/main/LICENSE)
+[![RubyGems](https://img.shields.io/gem/v/mupdf)](https://rubygems.org/gems/mupdf)
+[![GitHub](https://img.shields.io/badge/github-repo-blue.svg)](https://github.com/ksylvest/mupdf)
+[![Yard](https://img.shields.io/badge/docs-site-blue.svg)](https://mupdf.ksylvest.com)
+[![CircleCI](https://img.shields.io/circleci/build/github/ksylvest/mupdf)](https://circleci.com/gh/ksylvest/mupdf)
+
+## Installation
+
+```bash
+gem install mupdf
+```
+
+## Usage
+
+### Document
+
+A `MuPDF::Document` wraps for a file:
+
+```ruby
+document = MuPDF::Document.new('./file.pdf')
+```
+
+#### Info
+
+The `info` command displays information about a document such as the number of pages:
+
+```ruby
+info = document.info
+info.pages # e.g. 2
+```

data/lib/mupdf/command_error.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module MuPDF
+  # An error raised when an mutool command errors.
+  class CommandError < StandardError
+    # @param cmd [String]
+    # @param result [String]
+    # @param status [Process::Status]
+    def initialize(cmd:, result:, status:)
+      super("cmd=#{cmd.inspect} result=#{result.inspect} status=#{status.inspect}")
+      @cmd = cmd
+      @result = result
+      @status = status
+    end
+  end
+end

data/lib/mupdf/document.rb

@@ -0,0 +1,21 @@
+# 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
+
+    # @raise [MuPDF::CommandError]
+    #
+    # @return [MuPDF::Info]
+    def info
+      @info ||= begin
+        result = MuPDF.mutool('info', String(@pathname))
+        MuPDF::Info.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/version.rb

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

data/lib/mupdf.rb

@@ -1,11 +1,27 @@
 # frozen_string_literal: true
 
+require 'open3'
 require 'zeitwerk'
 
 loader = Zeitwerk::Loader.for_gem
 loader.inflector.inflect 'mupdf' => 'MuPDF'
 loader.setup
 
+# An interface to [MuPDF](https://mupdf.com/) for managing PDFs.
 module MuPDF
   class Error < StandardError; end
+
+  # @usage
+  #   MuPDF.mutool('info', 'file.pdf')
+  #
+  # @param cmd [Array<String>] e.g. ['info', 'file.pdf']
+  # @raise [ToolError]
+  #
+  # @return [String]
+  def self.mutool(*cmd)
+    result, status = Open3.capture2e('mutool', *cmd)
+    raise CommandError.new(cmd:, result:, status:) unless status.success?
+
+    result
+  end
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: mupdf
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Kevin Sylvestre
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
 date: 2025-01-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: open3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
@@ -36,6 +50,9 @@ files:
 - bin/console
 - bin/setup
 - lib/mupdf.rb
+- lib/mupdf/command_error.rb
+- lib/mupdf/document.rb
+- lib/mupdf/info.rb
 - lib/mupdf/version.rb
 homepage: https://github.com/ksylvest/mupdf
 licenses:
@@ -43,10 +60,10 @@ licenses:
 metadata:
   rubygems_mfa_required: 'true'
   homepage_uri: https://github.com/ksylvest/mupdf
-  source_code_uri: https://github.com/ksylvest/mupdf/tree/v0.1.0
-  changelog_uri: https://github.com/ksylvest/mupdf/releases/tag/v0.1.0
+  source_code_uri: https://github.com/ksylvest/mupdf/tree/v0.3.0
+  changelog_uri: https://github.com/ksylvest/mupdf/releases/tag/v0.3.0
   documentation_uri: https://mupdf.ksylvest.com/
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -61,8 +78,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key:
+rubygems_version: 3.5.23
+signing_key: 
 specification_version: 4
 summary: A library for interacting with MuPDF.
 test_files: []