qpdf_ruby 0.1.1 → 0.3.0

data/sig/qpdf_ruby.rbs

@@ -1,4 +1,85 @@
 module QpdfRuby
   VERSION: String
-  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+
+  ENCRYPTION_REVISION_AES_128: Integer
+  ENCRYPTION_REVISION_AES_256: Integer
+  ENCRYPTION_REVISION_AES_256U: Integer
+  PRINT_FULL: Integer
+  PRINT_LOW: Integer
+  PRINT_NONE: Integer
+
+  class Error < RuntimeError
+  end
+
+  class Document
+    type untagged_counts = {
+      paths: Integer,
+      texts: Integer,
+      xobjects: Integer,
+      shadings: Integer,
+      inline_images: Integer,
+      total: Integer
+    }
+
+    type pdfua_report = {
+      decorations: Integer,
+      artifacts: untagged_counts,
+      links: Integer,
+      list_bodies: Integer,
+      roles: Integer,
+      figure_groups: Integer,
+      figures_without_alt: Integer,
+      identified: bool,
+      unidentified_reason: String?
+    }
+
+    type document_info_result = { changed: bool, xmp_error: String? }
+
+    type link = { page: Integer, uri: String?, contents: String? }
+
+    def self.from_memory: (String data, ?String? password) -> Document
+
+    def initialize: (String filename, ?String? password) -> void
+
+    def write: (String filename) -> nil
+    def to_memory: () -> String
+
+    def show_structure: () -> String
+    def ensure_bbox: () -> nil
+
+    def apply_pdfua_fixes: (?link_texts: Hash[untyped, untyped]?, ?title: String?) -> pdfua_report
+    def mark_untagged_content_as_artifacts: () -> untagged_counts
+    # deprecated: use #mark_untagged_content_as_artifacts
+    def mark_paths_as_artifacts: () -> untagged_counts
+    def untagged_content: () -> untagged_counts
+    def describe_links: (?Hash[untyped, untyped]? texts) -> Integer
+    def artifact_tagged_decorations: () -> Integer
+    def wrap_list_bodies: () -> Integer
+    def parent_tree_mismatches: () -> Integer
+    def map_nonstandard_roles: () -> Integer
+    def retag_grouping_figures: () -> Integer
+    def figures_without_alt: () -> Integer
+    def add_pdfua_identification: (?title: String?) -> bool
+    def set_document_info: (?creator: String?, ?producer: String?) -> document_info_result
+
+    def links: () -> Array[link]
+    def metadata: () -> String?
+    def document_info: () -> Hash[String, String]
+    def role_map: () -> Hash[String, String]
+
+    def encrypt: (
+      ?user_pw: String,
+      ?owner_pw: String,
+      ?encryption_revision: Integer,
+      ?allow_print: Integer,
+      ?allow_modify: boolish,
+      ?allow_extract: boolish,
+      ?accessibility: boolish,
+      ?assemble: boolish,
+      ?annotate_and_form: boolish,
+      ?form_filling: boolish,
+      ?encrypt_metadata: boolish,
+      ?use_aes: boolish
+    ) -> nil
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: qpdf_ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Dieter S.
@@ -130,36 +130,35 @@ extensions:
 - ext/qpdf_ruby/extconf.rb
 extra_rdoc_files: []
 files:
-- ".clang-format"
-- ".rspec"
-- ".rubocop.yml"
-- ".ruby-gemset"
-- ".ruby-version"
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
-- Rakefile
-- cliff.toml
-- docker/Dockerfile
 - exe/qpdf_ruby
 - ext/qpdf_ruby/array_node.cpp
 - ext/qpdf_ruby/document_handle.cpp
 - ext/qpdf_ruby/document_handle.hpp
 - ext/qpdf_ruby/extconf.rb
 - ext/qpdf_ruby/figure_node.cpp
+- ext/qpdf_ruby/mcid_bounds.cpp
+- ext/qpdf_ruby/mcid_bounds.hpp
 - ext/qpdf_ruby/mcid_node.cpp
 - ext/qpdf_ruby/mcr_node.cpp
-- ext/qpdf_ruby/pdf_image_mapper.cpp
-- ext/qpdf_ruby/pdf_image_mapper.hpp
 - ext/qpdf_ruby/pdf_struct_walker.cpp
 - ext/qpdf_ruby/pdf_struct_walker.hpp
+- ext/qpdf_ruby/pdfua.cpp
+- ext/qpdf_ruby/pdfua.hpp
 - ext/qpdf_ruby/qpdf_ruby.cpp
 - ext/qpdf_ruby/qpdf_ruby.hpp
+- ext/qpdf_ruby/ruby_guard.hpp
 - ext/qpdf_ruby/stream_node.cpp
+- ext/qpdf_ruby/stroke_bounds.cpp
+- ext/qpdf_ruby/stroke_bounds.hpp
 - ext/qpdf_ruby/struct_elem_node.cpp
 - ext/qpdf_ruby/struct_node.cpp
 - ext/qpdf_ruby/struct_node.hpp
 - ext/qpdf_ruby/unknown_node.cpp
+- ext/qpdf_ruby/xmp_scan.cpp
+- ext/qpdf_ruby/xmp_scan.hpp
 - lib/qpdf_ruby.rb
 - lib/qpdf_ruby/version.rb
 - sig/qpdf_ruby.rbs
@@ -186,7 +185,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.8
+rubygems_version: 4.0.20
 specification_version: 4
 summary: A Ruby interface .
 test_files: []

data/.clang-format

@@ -1,4 +0,0 @@
-BasedOnStyle: Google
-SortIncludes: false
-IndentWidth: 2
-ColumnLimit: 120

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper

data/.rubocop.yml

@@ -1,88 +0,0 @@
-AllCops:
-  NewCops: enable
-  TargetRubyVersion: 3.3
-  Exclude:
-    - 'ext/qpdf_ruby/extconf.rb'
-    - 'tmp/**/*'
-    - 'vendor/**/*'
-
-Style/StringLiterals:
-  EnforcedStyle: double_quotes
-
-Style/StringLiteralsInInterpolation:
-  EnforcedStyle: double_quotes
-
-Style/Documentation:
-  Enabled: false
-
-RSpec/SubjectStub:
-  Enabled: false
-
-RSpec/ExampleLength:
-  Enabled: false
-
-Layout/MultilineMethodCallIndentation:
-  Enabled: false
-
-Layout/FirstArgumentIndentation:
-  Enabled: false
-
-Layout/ClosingParenthesisIndentation:
-  Enabled: false
-
-Layout/FirstHashElementIndentation:
-  EnforcedStyle: consistent
-
-Layout/FirstArrayElementIndentation:
-  Enabled: false
-
-Layout/MultilineOperationIndentation:
-  Enabled: false
-
-Layout/BeginEndAlignment:
-  Enabled: false
-
-Layout/ArrayAlignment:
-  Enabled: false
-
-Layout/LineLength:
-  Enabled: false
-
-Layout/LineEndStringConcatenationIndentation:
-  Enabled: false
-
-RSpec/MultipleMemoizedHelpers:
-  Max: 10
-
-Metrics/MethodLength:
-  Enabled: false
-
-Metrics/ClassLength:
-  Enabled: false
-
-Metrics/ParameterLists:
-  Max: 10
-
-
-Gemspec/DevelopmentDependencies:
-  EnforcedStyle: gemspec
-
-RSpec/InstanceVariable:
-  Enabled: false
-
-RSpec/BeforeAfterAll:
-  Enabled: false
-
-RSpec/SpecFilePathFormat:
-  Enabled: true
-  Exclude:
-    - 'spec/acceptance/**/*_spec.rb'
-
-RSpec/DescribeClass:
-  Enabled: true
-  Exclude:
-    - 'spec/acceptance/**/*_spec.rb'
-
-plugins:
-  - rubocop-rake
-  - rubocop-rspec

data/.ruby-gemset

@@ -1 +0,0 @@
-qpdf_ruby

data/.ruby-version

@@ -1 +0,0 @@
-ruby-3.3.4

data/Rakefile

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-require "rubocop/rake_task"
-
-RuboCop::RakeTask.new
-
-require "rake/extensiontask"
-
-desc "Build the gem including native extensions"
-task build: :compile
-
-GEMSPEC = Gem::Specification.load("qpdf_ruby.gemspec")
-
-Rake::ExtensionTask.new("qpdf_ruby", GEMSPEC) do |ext|
-  ext.lib_dir = "lib/qpdf_ruby"
-end
-
-Dir.glob("tasks/*.rake").each { |r| load r }
-
-task default: %i[clobber compile spec rubocop]

data/cliff.toml

@@ -1,138 +0,0 @@
-# git-cliff ~ configuration file
-# https://git-cliff.org/docs/configuration
-
-[changelog]
-# template for the changelog header
-header = """
-<!-- generated by git-cliff start -->
-# Changelog\n
-All notable changes to this project will be documented in this file.
-
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).\n
-"""
-# template for the changelog body
-# https://keats.github.io/tera/docs/#introduction
-body = """
-{%- macro remote_url() -%}
-  https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }}
-{%- endmacro -%}
-
-{% if version -%}
-    ## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
-{% else -%}
-    ## [Unreleased]
-{% endif -%}
-
-{% for group, commits in commits | group_by(attribute="group") %}
-    ### {{ group | upper_first }}
-    {%- for commit in commits %}
-        - {{ commit.message | split(pat="\n") | first | upper_first | trim }}\
-            {% if commit.remote.username %} by @{{ commit.remote.username }}{%- endif -%}
-            {% if commit.remote.pr_number %} in \
-            [#{{ commit.remote.pr_number }}]({{ self::remote_url() }}/pull/{{ commit.remote.pr_number }}) \
-            {%- endif -%}
-    {% endfor %}
-{% endfor %}
-
-{%- if github.contributors | filter(attribute="is_first_time", value=true) | length != 0 %}
-  ## New Contributors
-{%- endif -%}
-
-{% for contributor in github.contributors | filter(attribute="is_first_time", value=true) %}
-  * @{{ contributor.username }} made their first contribution
-    {%- if contributor.pr_number %} in \
-      [#{{ contributor.pr_number }}]({{ self::remote_url() }}/pull/{{ contributor.pr_number }}) \
-    {%- endif %}
-{%- endfor %}\n
-"""
-# template for the changelog footer
-footer = """
-{%- macro remote_url() -%}
-  https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }}
-{%- endmacro -%}
-
-{% for release in releases -%}
-    {% if release.version -%}
-        {% if release.previous.version -%}
-            [{{ release.version | trim_start_matches(pat="v") }}]: \
-                {{ self::remote_url() }}/compare/{{ release.previous.version }}..{{ release.version }}
-        {% endif -%}
-    {% else -%}
-        [unreleased]: {{ self::remote_url() }}/compare/{{ release.previous.version }}..HEAD
-    {% endif -%}
-{% endfor %}
-<!-- generated by git-cliff end -->
-"""
-# remove the leading and trailing whitespace from the templates
-trim = true
-
-[git]
-# parse the commits based on https://www.conventionalcommits.org
-conventional_commits = true
-# filter out the commits that are not conventional
-filter_unconventional = false
-# regex for preprocessing the commit messages
-commit_preprocessors = [
-    # remove issue numbers from commits
-    { pattern = '\((\w+\s)?#([0-9]+)\)', replace = "" },
-]
-# regex for parsing and grouping commits
-commit_parsers = [
-    # ✅ Features (additions)
-    { message = "^feat(?:\\([^)]+\\))?!?:", group = "🚀 Added" },
-    { message = "^[aA]dd", group = "🚀 Added" },
-    { message = "^[sS]upport", group = "🚀 Added" },
-
-    # ❌ Removals
-    { message = "^[rR]emove", group = "🗑️ Removed" },
-    { message = "^[dD]elete", group = "🗑️ Removed" },
-
-    # 🐛 Fixes
-    { message = "^fix(?:\\([^)]+\\))?!?:", group = "🐛 Fixed" },
-    { message = "^[tT]est", group = "🐛 Fixed" },
-    { message = "^[fF]ix", group = "🐛 Fixed" },
-
-    # 🎨 Refactors
-    { message = "^refactor(?:\\([^)]+\\))?!?:", group = "🎨 Refactored" },
-
-    # ⚡️ Performance
-    { message = "^perf(?:\\([^)]+\\))?!?:", group = "⚡️ Performance" },
-
-    # 📝 Docs
-    { message = "^docs(?:\\([^)]+\\))?!?:", group = "📝 Docs" },
-
-    # 💄 Style (formatting, whitespace, etc.)
-    { message = "^style(?:\\([^)]+\\))?!?:", group = "💄 Style" },
-
-    # 🧪 Tests
-    { message = "^test(?:\\([^)]+\\))?!?:", group = "🧪 Tests" },
-
-    # 🔧 Build
-    { message = "^build(?:\\([^)]+\\))?!?:", group = "🔧 Build" },
-
-    # 🛠️ CI
-    { message = "^ci(?:\\([^)]+\\))?!?:", skip = true },
-
-    # 🧹 Chores (skip)
-    { message = "^chore\\(release\\): prepare for", skip = true },
-    { message = "^chore\\(deps.*\\)", skip = true },
-    { message = "^chore\\(pr\\)", skip = true },
-    { message = "^chore\\(pull\\)", skip = true },
-    { message = "^chore(?:\\([^)]+\\))?!?:", skip = true },
-    { message = "^\\s*chore", skip = true },
-
-    # ⏪ Reverts
-    { message = "^revert(?:\\([^)]+\\))?!?:", group = "⏪ Reverted" },
-
-    # 🌀 Catch-all (only if nothing else matched)
-    { message = "^.*", group = "🔄 Changed" }
-]
-
-
-# filter out the commits that are not matched by commit parsers
-filter_commits = false
-# sort the tags topologically
-topo_order = false
-# sort the commits inside sections by oldest/newest order
-sort_commits = "newest"

data/docker/Dockerfile

@@ -1,46 +0,0 @@
-FROM ruby:3.3
-
-ENV DEBIAN_FRONTEND=noninteractive
-
-RUN set -eux; \
-    echo "deb http://deb.debian.org/debian testing main"   >  /etc/apt/sources.list.d/extra.list; \
-    echo "deb http://deb.debian.org/debian unstable main" >> /etc/apt/sources.list.d/extra.list; \
-    \
-    printf "Package: *\nPin: release a=testing\nPin-Priority: 100\n\n"   >  /etc/apt/preferences.d/99-pin-testing; \
-    printf "Package: *\nPin: release a=unstable\nPin-Priority: 100\n"  >> /etc/apt/preferences.d/99-pin-testing; \
-    \
-    apt-get update; \
-    apt-get -y --no-install-recommends install qpdf libqpdf-dev -t testing; \
-    apt-mark hold qpdf libqpdf-dev; \
-    \
-    apt-get clean; rm -rf /var/lib/apt/lists/*;
-
-# Smoke‑test (shown in build log)
-RUN qpdf --version  # should print "qpdf version 12.x"
-
-
-COPY ./pkg/qpdf_ruby-*.gem ./
-COPY ./spec/fixtures/example_accessibility.pdf /tmp/dummy.pdf
-
-RUN gem install  ./qpdf_ruby-*.gem -- --with-qpdf-include=/usr/local/include/qpdf --with-qpdf-lib=/usr/local/lib
-
-RUN ruby -r qpdf_ruby -e 'puts "QpdfRuby version: #{QpdfRuby::VERSION}";doc = QpdfRuby::Document.new "/tmp/dummy.pdf"; puts doc.show_structure'
-
-# Create a non-root user
-RUN set -eux; \
-    groupadd -r appuser && useradd -r -g appuser -m -d /home/appuser appuser
-
-
-RUN set -eux; \
-    mkdir -p /workspace
-
-# Set working directory
-WORKDIR /workspace
-
-RUN chown -R appuser:appuser /workspace
-
-# Switch to non-root user
-USER appuser
-
-CMD ["/usr/bin/bash"]
-