archive_r_ruby 0.1.21 → 0.1.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d3a9201c0294653eaf8ee15988ef7a7a9015b0a404dc1a8d600efa5461ade522
-  data.tar.gz: '008d6102ea80a64c3aa79d5343552789b026786f09fdc347fa05d3060d0fc42d'
+  metadata.gz: bafb1f948efc655aa395aa0ee4b2dc0d6ab950185c9e41b9e8fd8136e952d74d
+  data.tar.gz: cbcd183a938ba16f17117eeafb78c0ca4492f60b23b4a12761b5be47c3eb6bb6
 SHA512:
-  metadata.gz: cda14a8907238f74b896ff1a06edcad6cda8d7e5f6079236d3a54db32ba7380885d9a928b7e207c52b6187eb3ce3941b90c6dd42fcbe7826bb9ff8e14bbd9b2c
-  data.tar.gz: e4e865062b7dfcab1a2662fd31e1048143af1b2726be3732f917160322ccefefab2adfc688ae2254834aee5cd75f98eefe11a02c8b4c5163daecb9fbd57879b0
+  metadata.gz: 1c3727a9d1a66336b5d434cc903ba79ff21214980583bd39ce72e84f558660ef6376e3b650f5df84f404d99386553d99627e57ad56580a19cf66d679b251ec7c
+  data.tar.gz: e02a6f140f3315c7570feb64ce5f3907691cf0db8318c285ccee9432607ed7f6cd5302c631363122155a17fa67ba004000f806c982c04f59ac3414ff844da797

data/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2025 archive_r Team
-
-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.
+MIT License
+
+Copyright (c) 2025 archive_r Team
+
+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/NOTICE

@@ -1,116 +1,116 @@
-archive_r Notices
-
-This file contains third-party notices and licensing information for bundled or
-linked components. It does not replace the project license.
-
-For full license texts, see the files under the LICENSES/ directory in this
-repository. Python wheels include these texts under the *.dist-info/licenses/
-directory.
-
-----------------------------------------
-Third-Party Notices
-----------------------------------------
-
-This distribution (notably the Python wheels) bundles and/or dynamically links
-against the following third-party components. Their respective license terms
-apply in addition to the MIT License.
-
-1. libarchive
-	- Purpose: core archive reading and writing functionality for the C++
-	  library and language bindings.
-	- Version (manylinux wheels): 3.7.5
-	- License: New BSD License (https://www.libarchive.org/)
-	- Full license text and notices: LICENSES/libarchive-COPYING
-
-2. pybind11
-	- Purpose: header-only binding generator for the Python extension module.
-	- License: BSD-style License (https://github.com/pybind/pybind11)
-	- Notes: used at build time; not redistributed as a runtime library.
-
-The following components are redistributed only because libarchive (bundled in
-some artifacts such as Python wheels) depends on them at runtime:
-
-3. zlib
-	- Purpose: libarchive dependency providing DEFLATE compression.
-	- License: zlib License (https://zlib.net/zlib_license.html)
-	- Notes: typically provided by the platform runtime (not bundled in wheels).
-
-4. bzip2
-	- Purpose: libarchive dependency providing bzip2 compression support; distributed with archive_r artifacts.
-	- Version (manylinux wheels): 1.0.8
-	- License: BSD-style license (https://sourceware.org/bzip2/)
-	- Full license text and notices: LICENSES/bzip2-LICENSE
-
-5. liblzma (XZ Utils)
-	- Purpose: libarchive dependency providing LZMA/XZ compression; included with archive_r packages.
-	- Version (manylinux wheels): 5.6.2
-	- License: BSD Zero Clause License (0BSD) for liblzma (https://tukaani.org/xz/)
-	- Full license texts and notices: LICENSES/xz-COPYING, LICENSES/xz-COPYING.0BSD
-
-6. libxml2
-	- Purpose: libarchive dependency used for archive formats such as xar; distributed alongside archive_r.
-	- Version (manylinux wheels): 2.13.4
-	- License: MIT-style License (http://xmlsoft.org/)
-	- Full license text and notices: LICENSES/libxml2-Copyright
-
-7. zstd
-	- Purpose: libarchive dependency providing Zstandard compression; shipped within archive_r binaries.
-	- Version (manylinux wheels): 1.5.5
-	- License: BSD License (https://github.com/facebook/zstd)
-	- Full license text and notices: LICENSES/zstd-LICENSE
-
-8. Nettle
-	- Purpose: libarchive dependency providing cryptographic support (macOS/Linux); bundled with archive_r binaries.
-	- Version (manylinux wheels): 3.9.1
-	- License: GNU LGPLv3+ or GNU GPLv2+ (https://www.lysator.liu.se/~nisse/nettle/)
-	- Full license texts and notices: LICENSES/nettle-COPYING.LESSERv3, LICENSES/nettle-COPYINGv2
-
-9. mini-gmp
-	- Purpose: Nettle dependency for arithmetic operations (macOS/Linux); bundled with archive_r binaries.
-	- License: GNU LGPLv3+ or GNU GPLv2+ (https://gmplib.org/)
-
-10. OpenSSL 3
-	- Purpose: libarchive dependency providing cryptographic support (Windows); bundled with archive_r Windows wheels.
-	- License: Apache License 2.0 with OpenSSL exception (https://www.openssl.org/source/license.html)
-
-11. lz4
-	- Purpose: libarchive dependency providing LZ4 compression; shipped with archive_r artifacts when required.
-	- Version (manylinux wheels): 1.10.0
-	- License: BSD 2-Clause (https://github.com/lz4/lz4)
-	- Full license text and notices: LICENSES/lz4-LICENSE
-
-12. libb2 (BLAKE2)
-	- Purpose: libarchive dependency providing BLAKE2 hashing; bundled when archive formats require it.
-	- Version (manylinux wheels): 0.98.1
-	- License: CC0 1.0 Universal (https://github.com/BLAKE2/libb2)
-	- Full license text and notices: LICENSES/libb2-COPYING
-
-13. libattr
-	- Purpose: libarchive dependency providing extended attribute support on POSIX platforms; included in POSIX builds only.
-	- Version (manylinux wheels): 2.5.2
-	- License: LGPL-2.1-or-later for the library (https://savannah.nongnu.org/projects/attr)
-	- Full license text and notices: LICENSES/attr-COPYING.LGPL
-
-14. libacl
-	- Purpose: libarchive dependency providing POSIX ACL support; included in POSIX builds only.
-	- Version (manylinux wheels): 2.3.2
-	- License: LGPL-2.1-or-later for the library (https://savannah.nongnu.org/projects/acl)
-	- Full license text and notices: LICENSES/acl-COPYING.LGPL
-
-15. LLVM OpenMP runtime (libomp)
-	- Purpose: runtime dependency that can be bundled into Linux wheels depending on toolchain and binary dependencies.
-	- License: Apache License 2.0 with LLVM Exceptions (https://llvm.org/)
-	- Full license text and notices: LICENSES/libomp-LICENSE.TXT
-
-----------------------------------------
-Source Availability
-----------------------------------------
-
-For the components redistributed in binary form, the corresponding source code
-can be obtained from the upstream project release pages listed above.
-
-For the manylinux wheel build, exact dependency versions are recorded in:
-	- bindings/python/tools/build-deps-manylinux.sh
-
-Full license texts copied from upstream release archives are stored under:
-	- LICENSES/
+archive_r Notices
+
+This file contains third-party notices and licensing information for bundled or
+linked components. It does not replace the project license.
+
+For full license texts, see the files under the LICENSES/ directory in this
+repository. Python wheels include these texts under the *.dist-info/licenses/
+directory.
+
+----------------------------------------
+Third-Party Notices
+----------------------------------------
+
+This distribution (notably the Python wheels) bundles and/or dynamically links
+against the following third-party components. Their respective license terms
+apply in addition to the MIT License.
+
+1. libarchive
+	- Purpose: core archive reading and writing functionality for the C++
+	  library and language bindings.
+	- Version (manylinux wheels): 3.7.5
+	- License: New BSD License (https://www.libarchive.org/)
+	- Full license text and notices: LICENSES/libarchive-COPYING
+
+2. pybind11
+	- Purpose: header-only binding generator for the Python extension module.
+	- License: BSD-style License (https://github.com/pybind/pybind11)
+	- Notes: used at build time; not redistributed as a runtime library.
+
+The following components are redistributed only because libarchive (bundled in
+some artifacts such as Python wheels) depends on them at runtime:
+
+3. zlib
+	- Purpose: libarchive dependency providing DEFLATE compression.
+	- License: zlib License (https://zlib.net/zlib_license.html)
+	- Notes: typically provided by the platform runtime (not bundled in wheels).
+
+4. bzip2
+	- Purpose: libarchive dependency providing bzip2 compression support; distributed with archive_r artifacts.
+	- Version (manylinux wheels): 1.0.8
+	- License: BSD-style license (https://sourceware.org/bzip2/)
+	- Full license text and notices: LICENSES/bzip2-LICENSE
+
+5. liblzma (XZ Utils)
+	- Purpose: libarchive dependency providing LZMA/XZ compression; included with archive_r packages.
+	- Version (manylinux wheels): 5.6.2
+	- License: BSD Zero Clause License (0BSD) for liblzma (https://tukaani.org/xz/)
+	- Full license texts and notices: LICENSES/xz-COPYING, LICENSES/xz-COPYING.0BSD
+
+6. libxml2
+	- Purpose: libarchive dependency used for archive formats such as xar; distributed alongside archive_r.
+	- Version (manylinux wheels): 2.13.4
+	- License: MIT-style License (http://xmlsoft.org/)
+	- Full license text and notices: LICENSES/libxml2-Copyright
+
+7. zstd
+	- Purpose: libarchive dependency providing Zstandard compression; shipped within archive_r binaries.
+	- Version (manylinux wheels): 1.5.5
+	- License: BSD License (https://github.com/facebook/zstd)
+	- Full license text and notices: LICENSES/zstd-LICENSE
+
+8. Nettle
+	- Purpose: libarchive dependency providing cryptographic support (macOS/Linux); bundled with archive_r binaries.
+	- Version (manylinux wheels): 3.9.1
+	- License: GNU LGPLv3+ or GNU GPLv2+ (https://www.lysator.liu.se/~nisse/nettle/)
+	- Full license texts and notices: LICENSES/nettle-COPYING.LESSERv3, LICENSES/nettle-COPYINGv2
+
+9. mini-gmp
+	- Purpose: Nettle dependency for arithmetic operations (macOS/Linux); bundled with archive_r binaries.
+	- License: GNU LGPLv3+ or GNU GPLv2+ (https://gmplib.org/)
+
+10. OpenSSL 3
+	- Purpose: libarchive dependency providing cryptographic support (Windows); bundled with archive_r Windows wheels.
+	- License: Apache License 2.0 with OpenSSL exception (https://www.openssl.org/source/license.html)
+
+11. lz4
+	- Purpose: libarchive dependency providing LZ4 compression; shipped with archive_r artifacts when required.
+	- Version (manylinux wheels): 1.10.0
+	- License: BSD 2-Clause (https://github.com/lz4/lz4)
+	- Full license text and notices: LICENSES/lz4-LICENSE
+
+12. libb2 (BLAKE2)
+	- Purpose: libarchive dependency providing BLAKE2 hashing; bundled when archive formats require it.
+	- Version (manylinux wheels): 0.98.1
+	- License: CC0 1.0 Universal (https://github.com/BLAKE2/libb2)
+	- Full license text and notices: LICENSES/libb2-COPYING
+
+13. libattr
+	- Purpose: libarchive dependency providing extended attribute support on POSIX platforms; included in POSIX builds only.
+	- Version (manylinux wheels): 2.5.2
+	- License: LGPL-2.1-or-later for the library (https://savannah.nongnu.org/projects/attr)
+	- Full license text and notices: LICENSES/attr-COPYING.LGPL
+
+14. libacl
+	- Purpose: libarchive dependency providing POSIX ACL support; included in POSIX builds only.
+	- Version (manylinux wheels): 2.3.2
+	- License: LGPL-2.1-or-later for the library (https://savannah.nongnu.org/projects/acl)
+	- Full license text and notices: LICENSES/acl-COPYING.LGPL
+
+15. LLVM OpenMP runtime (libomp)
+	- Purpose: runtime dependency that can be bundled into Linux wheels depending on toolchain and binary dependencies.
+	- License: Apache License 2.0 with LLVM Exceptions (https://llvm.org/)
+	- Full license text and notices: LICENSES/libomp-LICENSE.TXT
+
+----------------------------------------
+Source Availability
+----------------------------------------
+
+For the components redistributed in binary form, the corresponding source code
+can be obtained from the upstream project release pages listed above.
+
+For the manylinux wheel build, exact dependency versions are recorded in:
+	- bindings/python/tools/build-deps-manylinux.sh
+
+Full license texts copied from upstream release archives are stored under:
+	- LICENSES/

data/README.md

@@ -1,106 +1,106 @@
-# archive_r Ruby Binding
-
-Ruby bindings for archive_r, a libarchive-based library for processing many archive formats.
-It streams entry data directly from the source to recursively read nested archives without extracting to temporary files or loading large in-memory buffers.
-
-Ruby bindings expose the archive_r traverser API with a natural, block-friendly interface. This document consolidates the Ruby-specific instructions that previously lived in the repository root README.
-
-## Requirements
-
-- Ruby 3.2 (same toolchain as the development environment)
-- libarchive 3.x (shared library and headers)
-- Build tools: `rake`, `minitest`, a C++17 compiler, and `make`
-
-## Installing the Gem
-
-### Recommended: build.sh workflow
-
-1. From the repository root run:
-   ```bash
-   ./build.sh --with-ruby
-   ```
-   Ruby packaging is enabled by default, so the command above builds the core library, compiles the binding, and creates `build/bindings/ruby/archive_r-<version>.gem`.
-2. Install the freshly built gem into your desired GEM_HOME:
-   ```bash
-   gem install --local build/bindings/ruby/archive_r-*.gem
-   ```
-3. When developing inside this repository the tests automatically install the gem into `build/ruby_gem_home` and set `ARCHIVE_R_CORE_ROOT=build` so the native extension links against the just-built static library.
-
-### Working inside bindings/ruby
-
-If you prefer to build from the `bindings/ruby` directory:
-
-```bash
-cd bindings/ruby
-bundle install
-bundle exec rake compile   # builds ext/archive_r
-bundle exec rake test      # runs test/test_traverser.rb
-bundle exec rake build     # creates archive_r-<version>.gem locally
-```
-
-The `rake test` task compiles the extension, installs it into `lib/`, and executes the Minitest suite.
-
-## Running the repository test suite
-
-From the repository root run `./bindings/ruby/run_binding_tests.sh`. The script prepares a clean GEM_HOME (`build/ruby_gem_home`), installs the gem produced in `build/bindings/ruby`, runs `bindings/ruby/test/test_traverser.rb`, and saves the install log to `build/logs/ruby_gem_install.log`. CI invokes this script after the core tests.
-
-## Usage Example
-
-```ruby
-require 'archive_r'
-
-SAFE_FORMATS = Archive_r::STANDARD_FORMATS
-
-def search_in_entry(entry, keyword)
-  overlap = ''
-  loop do
-    chunk = entry.read(8192)
-    break if chunk.nil? || chunk.empty?
-
-    search_text = overlap + chunk
-    return true if search_text.include?(keyword)
-
-    overlap = if chunk.length >= keyword.length - 1
-      chunk[-(keyword.length - 1)..-1]
-    else
-      chunk
-    end
-  end
-  false
-end
-
-Archive_r.traverse('test.zip', formats: SAFE_FORMATS) do |entry|
-  puts "#{entry.path} (depth=#{entry.depth})"
-  next unless entry.file? && entry.path.end_with?('.txt')
-  puts "  Found keyword" if search_in_entry(entry, 'search_keyword')
-end
-
-Archive_r.traverse('protected.zip', passphrases: ['password123'], formats: SAFE_FORMATS) do |entry|
-  puts entry.path
-end
-```
-
-## Thread Safety
-
-The Ruby bindings follow the same thread-safety rules as the C++ core library:
-
-**Safe:**
-- Each thread creates and uses its own `Traverser` instance
-- Concurrent traversal of different archives from different threads
-
-**Unsafe:**
-- Sharing a single `Traverser` instance across multiple threads
-- Calling `Archive_r.register_stream_factory` or `Archive_r.on_fault` from multiple threads (these modify process-wide global state)
-
-**Summary:** Create one `Traverser` per thread. Do not call global configuration methods (`register_stream_factory`, `on_fault`) concurrently.
-
-## Environment Notes
-
-- Set `ARCHIVE_R_CORE_ROOT` to the repository `build/` directory (or another archive_r build) if the gem needs to link against a pre-built static library instead of compiling the vendored core sources.
-- When installing into a sandbox (e.g., CI), configure `GEM_HOME`/`GEM_PATH` before invoking `gem install` so that the extension picks up the correct core library.
-
-## Further Help
-
-- Issue tracker: <https://github.com/raizo-tcs/archive_r/issues>
-- Releases / changelog: <https://github.com/raizo-tcs/archive_r/releases>
-- For C++/Python usage and overall project information, see the repository root `README.md`.
+# archive_r Ruby Binding
+
+Ruby bindings for archive_r, a libarchive-based library for processing many archive formats.
+It streams entry data directly from the source to recursively read nested archives without extracting to temporary files or loading large in-memory buffers.
+
+Ruby bindings expose the archive_r traverser API with a natural, block-friendly interface. This document consolidates the Ruby-specific instructions that previously lived in the repository root README.
+
+## Requirements
+
+- Ruby 3.2 (same toolchain as the development environment)
+- libarchive 3.x (shared library and headers)
+- Build tools: `rake`, `minitest`, a C++17 compiler, and `make`
+
+## Installing the Gem
+
+### Recommended: build.sh workflow
+
+1. From the repository root run:
+   ```bash
+   ./build.sh --with-ruby
+   ```
+   Ruby packaging is enabled by default, so the command above builds the core library, compiles the binding, and creates `build/bindings/ruby/archive_r-<version>.gem`.
+2. Install the freshly built gem into your desired GEM_HOME:
+   ```bash
+   gem install --local build/bindings/ruby/archive_r-*.gem
+   ```
+3. When developing inside this repository the tests automatically install the gem into `build/ruby_gem_home` and set `ARCHIVE_R_CORE_ROOT=build` so the native extension links against the just-built static library.
+
+### Working inside bindings/ruby
+
+If you prefer to build from the `bindings/ruby` directory:
+
+```bash
+cd bindings/ruby
+bundle install
+bundle exec rake compile   # builds ext/archive_r
+bundle exec rake test      # runs test/test_traverser.rb
+bundle exec rake build     # creates archive_r-<version>.gem locally
+```
+
+The `rake test` task compiles the extension, installs it into `lib/`, and executes the Minitest suite.
+
+## Running the repository test suite
+
+From the repository root run `./bindings/ruby/run_binding_tests.sh`. The script prepares a clean GEM_HOME (`build/ruby_gem_home`), installs the gem produced in `build/bindings/ruby`, runs `bindings/ruby/test/test_traverser.rb`, and saves the install log to `build/logs/ruby_gem_install.log`. CI invokes this script after the core tests.
+
+## Usage Example
+
+```ruby
+require 'archive_r'
+
+SAFE_FORMATS = Archive_r::STANDARD_FORMATS
+
+def search_in_entry(entry, keyword)
+  overlap = ''
+  loop do
+    chunk = entry.read(8192)
+    break if chunk.nil? || chunk.empty?
+
+    search_text = overlap + chunk
+    return true if search_text.include?(keyword)
+
+    overlap = if chunk.length >= keyword.length - 1
+      chunk[-(keyword.length - 1)..-1]
+    else
+      chunk
+    end
+  end
+  false
+end
+
+Archive_r.traverse('test.zip', formats: SAFE_FORMATS) do |entry|
+  puts "#{entry.path} (depth=#{entry.depth})"
+  next unless entry.file? && entry.path.end_with?('.txt')
+  puts "  Found keyword" if search_in_entry(entry, 'search_keyword')
+end
+
+Archive_r.traverse('protected.zip', passphrases: ['password123'], formats: SAFE_FORMATS) do |entry|
+  puts entry.path
+end
+```
+
+## Thread Safety
+
+The Ruby bindings follow the same thread-safety rules as the C++ core library:
+
+**Safe:**
+- Each thread creates and uses its own `Traverser` instance
+- Concurrent traversal of different archives from different threads
+
+**Unsafe:**
+- Sharing a single `Traverser` instance across multiple threads
+- Calling `Archive_r.register_stream_factory` or `Archive_r.on_fault` from multiple threads (these modify process-wide global state)
+
+**Summary:** Create one `Traverser` per thread. Do not call global configuration methods (`register_stream_factory`, `on_fault`) concurrently.
+
+## Environment Notes
+
+- Set `ARCHIVE_R_CORE_ROOT` to the repository `build/` directory (or another archive_r build) if the gem needs to link against a pre-built static library instead of compiling the vendored core sources.
+- When installing into a sandbox (e.g., CI), configure `GEM_HOME`/`GEM_PATH` before invoking `gem install` so that the extension picks up the correct core library.
+
+## Further Help
+
+- Issue tracker: <https://github.com/raizo-tcs/archive_r/issues>
+- Releases / changelog: <https://github.com/raizo-tcs/archive_r/releases>
+- For C++/Python usage and overall project information, see the repository root `README.md`.

data/VERSION

@@ -1 +1 @@
-0.1.21
+0.1.22