xmp_toolkit_ruby 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b7aee0acc492647a8dba0533d35958329a0a3778b46d57788c351de5aeadfaa6
+  data.tar.gz: 17a5b39e71708f9d4a6ce25a24e03451fe65bf929f2a46c8d57ac4c320c9c7ff
+SHA512:
+  metadata.gz: cdc48bafd443561d8e7b920dfa8a0c50b47f7704ec4e6bcf20c8a7258f65cb8329f8e66956e1aa38099646d26407369a78b18355b0af7b848885090168e67303
+  data.tar.gz: 88658e87bbae1cf9e2f2d43a4a3c73772994c44ee847c3b5523b99e8568630e1b321976d2f8e67088c557231e586ceb88ca20fa7cce88c4f9b32430bdd7a3c84

data/.idea/.gitignore

@@ -0,0 +1,8 @@
+# Default ignored files
+/shelf/
+/workspace.xml
+# Editor-based HTTP Client requests
+/httpRequests/
+# Datasource local storage ignored files
+/dataSources/
+/dataSources.local.xml

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,88 @@
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 3.3
+  Exclude:
+    - 'ext/xmp_toolkit_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

@@ -0,0 +1 @@
+xmp-toolkit-ruby

data/.ruby-version

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

data/AGENTS.md

@@ -0,0 +1,72 @@
+# Project Agents.md Guide for OpenAI Codex
+
+This Agents.md file provides comprehensive guidance for OpenAI Codex and other AI agents working with this codebase.
+
+## Project Structure for OpenAI Codex Navigation
+
+- `/ext` - C++ extension code
+- `/lib` - Ruby wrapper code
+- `/spec` - Test suite
+- `/bin` - CLI tools
+- `/docker` - Docker configuration
+
+## Coding Conventions for OpenAI Codex
+
+### Ruby Conventions
+
+- Follow standard Ruby style guidelines
+- Use meaningful variable and method names
+- Add comments for complex logic
+- Use frozen_string_literal comments
+
+### C++ Extension Conventions
+
+- Follow C++11 style guidelines
+- Properly handle memory allocation and deallocation
+- Use RAII principles for resource management
+- Add error handling for SDK operations
+
+### General Conventions for Agents.md Implementation
+
+- OpenAI Codex should follow the existing code style in each file
+- Agents.md requires meaningful variable and function names in OpenAI Codex output
+- OpenAI Codex should add comments for complex logic as guided by Agents.md
+
+## Testing Requirements for OpenAI Codex
+
+- Each test file should focus on a specific module/feature
+- Each `it` block should contain only one expectation
+- Run tests with: `bundle exec rake clobber compile spec rubocop`
+
+OpenAI Codex should run tests with the following commands:
+
+```bash
+bundle exec rake clobber compile spec rubocop
+```
+
+## Pull Request Guidelines for OpenAI Codex
+
+When OpenAI Codex helps create a PR, please ensure it:
+
+1. Includes a clear description of the changes as guided by Agents.md
+2. References any related issues that OpenAI Codex is addressing
+3. Ensures all tests pass for code generated by OpenAI Codex
+4. Includes screenshots for UI changes implemented with OpenAI Codex
+5. Keeps PRs focused on a single concern as specified in Agents.md
+6. Use conventional commit messages according to `.github/git-commit-instructions.md`.
+7. Primary Language: All commit messages, code comments, pull request descriptions, and branch names must be written in
+   English.
+
+## Programmatic Checks for OpenAI Codex
+
+Before submitting changes generated by OpenAI Codex, run:
+
+```bash
+bundle exec rake clobber 
+bundle exec rake rubocop 
+bundle exec rake compile
+bundle exec rake spec 
+```
+
+All checks must pass before OpenAI Codex generated code can be merged. Agents.md helps ensure OpenAI Codex follows these
+requirements.

data/CHANGELOG.md

@@ -0,0 +1,45 @@
+<!-- generated by git-cliff start -->
+
+# Changelog
+
+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).
+
+[unreleased]: https://github.com///compare/v0.0.1..HEAD
+
+<!-- generated by git-cliff end -->
+
+## [0.0.2] - 2025-06-06
+
+### 🐛 Fixed
+
+- Correct typo in XMP data override test
+
+### 📝 Docs
+
+- Add macOS setup instructions for XMP Toolkit
+- Document plugin path env var
+- Update AGENTS.md to specify English for commits
+- Add Agents.md for OpenAI Codex guidance
+
+### 🔄 Changed
+
+- Merge pull request #7 from dieter-medium/enhance-changelog
+- Merge pull request #6 from dieter-medium/enhance-osx-docs
+- Merge pull request #4 from dieter-medium/codex/update-readme-with-xmp_toolkit_plugins_path-usage
+- Merge pull request #1 from dieter-medium/codex/append-newline-to-.ruby-gemset
+
+### 🚀 Added
+
+- Update permissions in main.yml
+- Enhance override_xmp command functionality
+- Add Dependabot configuration for Ruby dependencies
+
+## [0.0.1] - 2025-06-05
+
+- Initial release
+
+- [unreleased](https://github.com/dieter-medium/bidi2pdf/compare/v0.0.2..HEAD)
+- [0.0.2](https://github.com/dieter-medium/bidi2pdf/compare/v0.0.1..v0.0.2) 

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Dieter S.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,287 @@
+# XmpToolkitRuby
+
+[![Gem Version](https://badge.fury.io/rb/xmp_toolkit_ruby.svg)](https://badge.fury.io/rb/xmp_toolkit_ruby)
+
+**XmpToolkitRuby** is a Ruby gem that provides fast, native bindings to
+the [Adobe XMP Toolkit](https://github.com/adobe/XMP-Toolkit-SDK), enabling Ruby applications to **read and write XMP
+metadata** in various file formats (images, PDFs, etc.).
+
+---
+
+- **Full XMP read/write support**
+- **Works with PNG, JPEG, TIFF, PDF, and more**
+- **Command-line interface & Ruby API**
+- **Works on Linux, macOS, and via Docker**
+
+---
+
+## Installation
+
+**Recommended:** Compile natively on your target system for best performance and compatibility.  
+A precompiled extension may be available for some platforms.
+
+### 1. Get the Adobe XMP Toolkit
+
+First, clone and prepare the Adobe XMP Toolkit SDK.
+
+#### Linux example (adjust paths/versions as needed)
+
+```bash
+export XMP_TOOLKIT_SDK_VERSION=2025.03
+
+# Prerequisites
+sudo apt update && sudo apt install cmake build-essential curl
+
+# Download and extract the SDK
+mkdir XMP-Toolkit-SDK
+cd XMP-Toolkit-SDK
+curl -LO https://github.com/adobe/XMP-Toolkit-SDK/archive/refs/tags/v${XMP_TOOLKIT_SDK_VERSION}.tar.gz 
+tar -xzf v${XMP_TOOLKIT_SDK_VERSION}.tar.gz --strip-components=1
+
+# Prepare required third-party libraries
+cd third-party
+
+# zlib
+cd zlib
+curl -O https://zlib.net/zlib.tar.gz
+tar --strip-components=1 -xzf zlib.tar.gz
+cd ..
+
+# expat
+cd expat
+curl -LO https://github.com/libexpat/libexpat/releases/download/R_2_5_0/expat-2.5.0.tar.gz
+tar --strip-components=1  -xzf expat-2.5.0.tar.gz
+cd ../..
+
+# Build instructions
+cd build
+# ⚠️ Patch required: Remove `${XMP_GCC_LIBPATH}/libssp.a` from `ProductConfig.cmake` (see [this issue](https://github.com/adobe/XMP-Toolkit-SDK/issues/8))
+# Optionally, disable secure settings in `shared/ToolchainGCC.cmake`:
+#   -set(XMP_ENABLE_SECURE_SETTINGS "ON")
+#   +set(XMP_ENABLE_SECURE_SETTINGS "OFF")
+make
+```
+
+#### macOS example
+
+When you copy and paste the following commands, make sure that during the paste nothing got escaped (e.g.  `{` becomes
+`\{`).
+
+```bash
+export XMP_TOOLKIT_SDK_VERSION=2025.03
+
+xcode-select --install # Ensure Xcode command line tools are selected
+
+# within a directory of your choice
+
+mkdir XMP-Toolkit-SDK
+
+cd XMP-Toolkit-SDK
+curl -LO https://github.com/adobe/XMP-Toolkit-SDK/archive/refs/tags/v${XMP_TOOLKIT_SDK_VERSION}.tar.gz 
+tar -xzf v${XMP_TOOLKIT_SDK_VERSION}.tar.gz --strip-components=1
+
+# Prepare required third-party libraries
+cd third-party
+
+# zlib
+cd zlib
+curl -O https://zlib.net/zlib.tar.gz
+tar --strip-components=1 -xzf zlib.tar.gz
+cd ..
+
+# expat
+cd expat
+curl -LO https://github.com/libexpat/libexpat/releases/download/R_2_5_0/expat-2.5.0.tar.gz
+tar --strip-components=1  -xzf expat-2.5.0.tar.gz
+cd ../..
+
+# cmake
+cd tools/cmake
+mkdir  bin
+cd bin
+curl -LO https://cmake.org/files/v3.15/cmake-3.15.5-Darwin-x86_64.tar.gz
+tar --strip-components=1  -xzf cmake-3.15.5-Darwin-x86_64.tar.gz
+cd ../../..
+
+cd build
+./GenerateXMPToolkitSDK_mac.sh
+
+# choose 3 => Generate XMPToolkitSDK Static  64
+
+
+cd xcode/static/universal/
+
+# I needed to patch SDKROOT from macOS 13.1 SDK to 15.1 SDK in two places inside the Xcode project file:
+# 
+# From:
+# SDKROOT = /Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX13.1.sdk;
+#
+# To:
+# SDKROOT = /Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX15.1.sdk;
+#
+# The following sed script replaces both occurrences in-place, backing up the original file with a .bak extension:
+#
+# Usage:
+#   sed -i.bak -E 's|(SDKROOT = /Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX)13\.1(\.sdk;)|\115.1\2|g' ./XMPToolkitSDK64.xcodeproj/project.pbxproj
+#
+# Explanation:
+# - The regex captures the prefix and suffix around "13.1" to ensure only the SDK version number is replaced.
+# - The 'g' flag ensures all matching lines (both places) are updated.
+
+
+# Build Debug configuration
+xcodebuild -scheme ALL_BUILD -configuration Debug build
+
+# Build Release configuration
+xcodebuild -scheme ALL_BUILD -configuration Release build
+
+```
+
+**See [Adobe’s docs](https://github.com/adobe/XMP-Toolkit-SDK) for details on other platforms.**
+
+---
+
+### 2. Install the Gem
+
+**Bundler:**
+
+```bash
+# for linux 
+bundle config set --local build.xmp_toolkit_ruby "--with-xmp-lib=/path/to/XMP-Toolkit-SDK/public/libraries/i80386linux_x64/debug --with-xmp-include=/path/to/XMP-Toolkit-SDK/public/include"
+# for macOS
+bundle config set --local build.xmp_toolkit_ruby "--with-xmp-lib=/path/to/XMP-Toolkit-SDK/public/libraries/macintosh/universal/Debug --with-xmp-include=/path/to/XMP-Toolkit-SDK/public/include"
+
+bundle add xmp_toolkit_ruby
+```
+
+**Or, with plain RubyGems:**
+
+```bash
+# for linux 
+gem install xmp_toolkit_ruby -- --with-xmp-lib /path/to/XMP-Toolkit-SDK/public/libraries/i80386linux_x64/debug --with-xmp-include /path/to/XMP-Toolkit-SDK/public/include
+# for macOS
+gem install xmp_toolkit_ruby -- --with-xmp-lib /path/to/XMP-Toolkit-SDK/public/libraries/macintosh/universal/Debug --with-xmp-include /path/to/XMP-Toolkit-SDK/public/include
+```
+
+_Replace paths as needed for your environment._
+
+---
+
+## Precompiled Binaries and Platform Support
+
+This gem **ships with precompiled binaries** for the native libraries `libxmpcore` and `libxmpfile` for common
+platforms.
+
+> ⚠️ **Note:**  
+> These precompiled binaries may **not work on your system**, especially if your OS, architecture, or C++ standard
+> library differs from those used to build the binaries.  
+> For maximum compatibility, **it is strongly recommended to compile the native libraries yourself** on your target
+> machine.
+
+If you encounter issues or want maximum portability, please build the SDK from source using the instructions above.
+
+**Tip:**  
+Check out [`docker/Dockerfile`](docker/Dockerfile) in this repository for a full working example of a native build
+setup, including all dependencies and configuration flags.
+
+---
+
+## Usage
+
+### In Ruby
+
+```ruby
+require "xmp_toolkit_ruby"
+
+xmp = XmpToolkitRuby.xmp_from_file("BlueSquare.png")
+
+pp xmp.keys
+puts xmp["xmp_data"]
+
+new_xmp = <<~XMP
+  <x:xmpmeta xmlns:x="adobe:ns:meta/" x:xmptk="XMP Core 6.0.0">
+    <rdf:RDF xmlns:rdf="#{XmpToolkitRuby::Namespaces::XMP_NS_RDF}">
+      <rdf:Description xmlns:xmp="#{XmpToolkitRuby::Namespaces::XMP_NS_XMP}" rdf:about="">
+        <xmp:CreateDate>2025-06-04T20:20:40+02:00</xmp:CreateDate>
+        <xmp:ModifyDate>2025-06-04T20:20:40+02:00</xmp:ModifyDate>
+      </rdf:Description>
+    </rdf:RDF>
+  </x:xmpmeta>
+XMP
+
+XmpToolkitRuby.xmp_to_file(
+  "BlueSquare.png",
+  new_xmp,
+  override: true # Set to false to upsert/merge instead of replacing
+)
+```
+
+If you built the XMP Toolkit yourself or store the plugins elsewhere,
+set the `XMP_TOOLKIT_PLUGINS_PATH` environment variable so the gem can
+locate the PDF handler:
+
+```bash
+export XMP_TOOLKIT_PLUGINS_PATH=/path/to/XMP-Toolkit-SDK/XMPFilesPlugins/PDF_Handler/<platform>
+```
+
+Run your Ruby code or CLI commands in the same shell so this variable is
+visible.
+
+---
+
+### CLI
+
+The gem ships with a `xmp_toolkit_ruby` command for basic operations:
+
+```bash
+# Print XMP metadata to stdout
+xmp_toolkit_ruby print_xmp BlueSquare.png
+
+# Print XMP metadata and save to a file
+xmp_toolkit_ruby print_xmp BlueSquare.png xmp_metadata.xml
+
+# Update XMP metadata (replace/merge)
+xmp_toolkit_ruby override_xmp --override BlueSquare.png xmp_metadata.xml 
+```
+
+---
+
+### Docker
+
+You can run the CLI tool via Docker without installing any build tools:
+
+```bash
+docker run -it --rm   -v $(pwd):/workspace   dieters877565/xmp-toolkit-ruby:main   xmp_toolkit_ruby print_xmp /workspace/BlueSquare.png
+```
+
+---
+
+## Development
+
+1. **Clone the repo**
+2. `bin/setup` to install dependencies
+3. `rake spec` to run tests
+4. `bin/console` for an interactive shell
+
+Build & install locally with:
+
+```bash
+bundle exec rake install
+```
+
+Release process:
+
+- Bump the version in `lib/xmp_toolkit_ruby/version.rb`
+- `bundle exec rake release` to tag, push, and publish to [rubygems.org](https://rubygems.org)
+
+---
+
+## Contributing
+
+Bug reports and pull requests are welcome on [GitHub](https://github.com/DieterS/xmp_toolkit_ruby).
+
+---
+
+## License
+
+This project is open source, licensed under the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,25 @@
+# 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("xmp_toolkit_ruby.gemspec")
+
+Rake::ExtensionTask.new("xmp_toolkit_ruby", GEMSPEC) do |ext|
+  ext.lib_dir = "lib/xmp_toolkit_ruby"
+end
+
+Dir.glob("tasks/*.rake").each { |r| load r }
+
+task default: %i[clobber compile spec rubocop]