ruby-xz 1.0.0 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 820fac81115af7c562998d1c80cce241d045c210
-  data.tar.gz: 31823023e5de3c452f8d0b82b643732ff0294658
+SHA256:
+  metadata.gz: efe7c4ed9a4c30ce23e8328060b458e36a29b7b31d17528a4acb842c461a6b11
+  data.tar.gz: f8c55ee6bf356b87d8511ff45bfcc481b17bc8475477a7dd9df56b69c7185a6b
 SHA512:
-  metadata.gz: 35aa3ebe08c3e82b4cc81339c23af1d78073ffb4d174f56079808f482ae60061c329aeed2fcbec56eb34e81102ed30bb3f32240f85436d5b99142df48e925f29
-  data.tar.gz: a83b6fc3ca7b397af5695877fde63ff8642fa60a689d36b505cbf08717ea2b4c22b182e484bd55aa66a49f90fb132da17e7cd7a2caf1250175590127fb7f0565
+  metadata.gz: b61b2e26837ce216cdc03286e3c52d4fd38a01f95d158556d0ed9ed4f347d289e575f6bdd5da236265ba4a37ee9c779f98db37f663edce2308a874e6cedd9a16
+  data.tar.gz: a93055f9f309a7adf464b392cd9e5ac2bce97ae9f97bf37fec16d5f537ac2cd6d590d88a9ab6e6786be586eed841137bba29946de90bbf601124c695556af003

data/AUTHORS

@@ -2,5 +2,6 @@
 
 All the people who worked on this project, in alphabetical order.
 
-* Marvin Gülker (Quintus) <m-guelker@phoenixmail.de>
-* Christoph Plank (chrisistuff)
+* Marvin Gülker (github.com/Quintus) <m-guelker@phoenixmail.de>
+* Alex Gittemeier (github.com/win93) <me@a.lexg.dev>
+* Christoph Plank (github.com/chrisistuff)

data/HISTORY.rdoc

@@ -1,5 +1,20 @@
 = Version history
 
+== 1.0.3 (2022-03-28)
+* *Fix* a number of memory leaks by freeing allocated liblzma data structures
+  (Issue Quintus#20 reported by xTRiM, PR win93#7 by Alex Gittemeier)
+
+== 1.0.2 (2021-11-28)
+* *Fix* a deprecation warning and some other gemspec concerns
+  (Issue win93#5, PR win93#6 by Alex Gittemeier)
+
+== 1.0.1 (2021-11-13)
+* *Fix* a buffer overflow error in XZ::Stream (PR Quintus#17 by genail)
+* *Fix* an issue with transcode_options that was introduced by Ruby 3
+  (PR win93#1 by Alex Gittemeier)
+* Update project README, gemspec, and other metadata to reflect a change in
+  maintainership. All prior releases were released by Marvin Gülker.
+
 == 1.0.0 (2018-05-20)
 
 * *BreakingChange* The XZ module's methods now take any parameters
@@ -10,7 +25,7 @@
   returning BINARY-tagged strings.
 * *BreakingChange* Remove deprecated API on stream reader/writer
   class and instead sync the API with Ruby's zlib library
-  (Ticket #12 by me).
+  (Ticket Quintus#12 by Quintus).
 * *BreakingChange* StreamWriter.new and StreamReader.new do not accept
   a block anymore. This is part of syncing with Ruby's zlib API.
 * *BreakingChange* StreamReader.open and StreamWriter.open always
@@ -40,9 +55,9 @@
 * *Dependency* Remove dependency on ffi. ruby-xz now uses fiddle from
   the stdlib instead.
 * *Dependency* Remove dependency on io-like. ruby-xz now implements
-  all the IO mechanics itself. (Ticket #10 by me)
+  all the IO mechanics itself. (Ticket Quintus#10 by Quintus)
 * *Dependency* Bump required Ruby version to 2.3.0.
-* *Fix* libzlma.dylib not being found on OS X (Ticket #15 by
+* *Fix* libzlma.dylib not being found on OS X (Ticket Quintus#15 by
   s0nspark).
 
 == 0.2.3 (2015-12-29)
@@ -60,7 +75,7 @@
 * *Deprecate* use of XZ::StreamWriter.new with a filename argument
 * *Deprecate* nonautomatic IO close in XZ::StreamReader#close
 * *Deprecate* nonautomatic IO close in XZ::StreamWriter#close
-* *Fix* incompatibility with Resolv.getaddress() in Ruby 2.2 (Ticket #13
+* *Fix* incompatibility with Resolv.getaddress() in Ruby 2.2 (Ticket Quintus#13
   by Ken Simon)
 * Goal of these deprecations is to sync the API with Ruby’s own
   Zlib::GzipWriter and Zlib::GzipReader mostly.
@@ -71,12 +86,12 @@
 
 == 0.2.1 (2014-02-08)
 
-* Build the gem properly on Ruby 2.0+ (PR #8 by Nana Sakisaka (saki7))
-* Release the GIL when interfacing with liblzma (PR #7 by Lars Christensen (larsch))
+* Build the gem properly on Ruby 2.0+ (PR Quintus#8 by Nana Sakisaka (saki7))
+* Release the GIL when interfacing with liblzma (PR Quintus#7 by Lars Christensen (larsch))
 
 == 0.2.0 (2013-06-23)
 
-* Fix #6 (errors on JRuby) by Ben Nagy
+* Fix Quintus#6 (errors on JRuby) by Ben Nagy
 * <b>Remove 1.8 compatibility</b>
 
 == 0.1.0 (2013-02-17)

data/README.md

@@ -1,64 +1,62 @@
-ruby-xz
-=======
+# ruby-xz
 
-**ruby-xz** is a basic binding to the famous [liblzma library][1],
-best known for the extreme compression-ratio it's native *XZ* format
-achieves. ruby-xz gives you the possibility of creating and extracting
-XZ archives on any platform where liblzma is installed. No compilation
-is needed, because ruby-xz is written on top of Ruby's “fiddle” library
-(part of the standard libary). ruby-xz does not have any dependencies
-other than Ruby itself.
+**ruby-xz** is a basic binding to the famous [liblzma] library,
+best known for the extreme compression-ratio it's native *XZ* format achieves.
+ruby-xz gives you the possibility of creating and extracting XZ archives on any
+platform where liblzma is installed.
+No compilation is needed, because ruby-xz is written on top of Ruby's [fiddle]
+library (part of the standard library).
+ruby-xz does not have any dependencies other than Ruby itself.
 
-ruby-xz supports both “intuitive” (de)compression by providing methods to
-directly operate on strings and files, but also allows you to operate
-directly on IO streams (see the various methods of the XZ module). On top
-of that, ruby-xz offers an advanced interface that allows you to treat
-XZ-compressed data as IO streams, both for reading and for writing. See the
-XZ::StreamReader and XZ::StreamWriter classes for more information on this.
+rubv-xz supports compression and decompression via methods that operate on
+strings and files, and it also supports compression and decompression on IO
+streams.
+the XZ::StreamReader and XZ::StreamWriter offer advanced interfaces that allow
+you to treat XZ-compressed data as IO streams, both for reading and for writing.
+<!-- TODO: link to relevant parts of the source code and/or documentation  -->
 
-**Note**: Version 1.0.0 breaks the API quite heavily. Refer to
-HISTORY.rdoc for details.
+**Note**: Version 1.0.0 breaks the API quite heavily.
+Refer to HISTORY.rdoc for details.
 
-Installation
-------------
+## Installation
 
-Install it the way you install all your gems.
+Install with `gem` from your Ruby installation:
 
-```
-$ gem install ruby-xz
+```sh
+gem install ruby-xz
 ```
 
-Alternatively, you can clone the repository and build the most recent
-code yourself:
+Alternatively, add it to your Gemfile via:
 
-```
-$ git clone git://git.guelker.eu/ruby-xz.git
-$ cd ruby-xz
-$ rake gem
-$ gem install pkg/ruby-xz-*.gem
+```sh
+bundle add ruby-xz
 ```
 
-Usage
------
+If you want to be on the bleeding edge, you can clone the repository and build
+the most recent code yourself:
 
-The documentation of the XZ module is well and you should be able to find
-everything you need to use ruby-xz. As said, it's not big, but powerful:
-You can create and extract whole archive files, compress or decompress
-streams of data or just plain strings.
+```sh
+git clone https://github.com/win93/ruby-xz.git
+cd ruby-xz
+rake gem
+gem install pkg/ruby-xz-*.gem
+```
 
-You can read the documentation on your local gemserver, or browse it [online][2].
+## Usage
 
-### Require ###
+You should be able to find everything you need to use ruby-xz in the
+documentation.
+It's small but powerful: You can create and extract whole archive files,
+compress or decompress whole files, strings, or streams of data.
 
-You have to require the “xz.rb” file:
+You can read the documentation on your local gemserver, or browse it [online][rubydoc].
+ <!-- TODO how do I read the docs on my local gemserver? -->
 
-``` ruby
-require "xz"
-```
-
-### Examples ###
+### Examples
 
 ``` ruby
+require 'xz'
+
 # Compress a file
 XZ.compress_file("myfile.txt", "myfile.txt.xz")
 # Decompress it
@@ -74,16 +72,17 @@ comp = XZ.compress("Mydata")
 data = XZ.decompress(comp)
 ```
 
-Have a look at the XZ module's documentation for an in-depth description of
-what is possible.
+Have a look at the XZ module's documentation for an in-depth description of what
+is possible.
+<!-- TODO link to such documentation -->
 
-### Usage with the minitar gem ###
+### Usage with the minitar gem
 
-ruby-xz can be used together with the [minitar][3] library (formerly
-“archive-tar-minitar”) to create XZ-compressed tarballs. This works by
-employing the IO-like classes XZ::StreamReader and XZ::StreamWriter
-analogous to how one would use Ruby's “zlib” library together with
-“minitar”. Example:
+ruby-xz can be used together with the [minitar] library (formerly
+“archive-tar-minitar”) to create XZ-compressed tarballs.
+This works by employing the IO-like classes XZ::StreamReader and
+XZ::StreamWriter analogous to how one would use Ruby's “zlib” library together
+with “minitar”:
 
 ``` ruby
 require "xz"
@@ -100,19 +99,41 @@ XZ::StreamReader.open("tarball.tar.xz") do |txz|
 end
 ```
 
-Links
------
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies.
 
-* Website: https://mg.guelker.eu/projects/ruby-xz/
-* Online documentation: https://mg.guelker.eu/projects/ruby-xz/doc
-* Code repository: https://git.guelker.eu/?p=ruby-xz.git;a=summary
-* Issue tracker: https://github.com/Quintus/ruby-xz/issues
+To install this gem onto your local machine, run `rake install`.
 
-License
--------
+To release a new version:
+
+- Switch to the `development` branch.
+- Bump `lib/xz/version.rb`, run `bundle install`, then commit the result.
+- Switch to the `stable` branch.
+- Run `git merge development`
+- Run `rake release`, which will create/push a git tag and publish the `.gem`
+  file to [rubygems.org].
+
+[rubygems.org]: https://rubygems.org
+
+## Links
+
+* Online documentation: <https://rubydoc.info/gems/ruby-xz>
+* Code repository: <https://github.com/win93/ruby-xz>
+* Issue tracker: <https://github.com/win93/ruby-xz/issues>
+
+## License
 
 MIT license; see LICENSE for the full license text.
 
-[1]: https://tukaani.org/xz/
-[2]: https://mg.guelker.eu/projects/ruby-xz/doc
-[3]: https://github.com/halostatue/minitar
+## Acknowledgements
+
+On November 2021, I volunteered to take over maintenance of this project, which
+was forked from <https://github.com/Quintus/ruby-xz>.
+@Quintus maintained this project until 1.0.0, see HISTORY.rdoc for more details.
+
+
+[fiddle]: https://github.com/ruby/fiddle
+[liblzma]: https://tukaani.org/xz/
+[rubydoc]: https://www.rubydoc.info/gems/ruby-xz
+[minitar]: https://github.com/halostatue/minitar

data/lib/xz/stream.rb

@@ -118,7 +118,7 @@ class XZ::Stream
       pos = 0
       until pos > str.bytesize # Do not use >=, that conflicts with #lzma_finish
         substr = str[pos, XZ::CHUNK_SIZE]
-        @input_buffer_p[0, str.bytesize] = substr
+        @input_buffer_p[0, substr.bytesize] = substr
         pos += XZ::CHUNK_SIZE
 
         @lzma_stream.next_in  = @input_buffer_p
@@ -155,9 +155,9 @@ class XZ::Stream
     # Reset internal state
     @pos = @lineno = 0
     @finished = false
-
-    # Allocate a new lzma stream (subclasses will configure it).
     @lzma_stream = XZ::LibLZMA::LZMAStream.malloc
+    @input_buffer_p  = Fiddle::Pointer.malloc(XZ::CHUNK_SIZE)
+    @output_buffer_p = Fiddle::Pointer.malloc(XZ::CHUNK_SIZE)
     XZ::LibLZMA::LZMA_STREAM_INIT(@lzma_stream)
 
     0 # Mimic IO#rewind's return value
@@ -211,6 +211,9 @@ class XZ::Stream
     # Clean up the lzma_stream structure's internal memory.
     # This would belong into a destructor if Ruby had that.
     XZ::LibLZMA.lzma_end(@lzma_stream)
+    Fiddle.free @lzma_stream.to_ptr
+    Fiddle.free @input_buffer_p
+    Fiddle.free @output_buffer_p
     @finished = true
 
     @delegate_io

data/lib/xz/stream_reader.rb

@@ -250,7 +250,7 @@ class XZ::StreamReader < XZ::Stream
       # Now, transcode it to the internal encoding if that was requested.
       # Otherwise return it with the external encoding as-is.
       if @internal_encoding
-        @readbuf.encode!(@internal_encoding, @transcode_options)
+        @readbuf.encode!(@internal_encoding, **@transcode_options)
         outbuf.force_encoding(@internal_encoding)
       else
         outbuf.force_encoding(@external_encoding)

data/lib/xz/version.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # -*- coding: utf-8 -*-
 #--
 # Basic liblzma-bindings for Ruby.
@@ -26,8 +27,6 @@
 #++
 
 module XZ
-
   # The version of this library.
-  VERSION = "1.0.0".freeze
-
+  VERSION = '1.0.3'
 end

data/lib/xz.rb

@@ -218,8 +218,10 @@ module XZ
       end
 
       LibLZMA.lzma_end(stream.to_ptr)
+      res = stream.total_out if block_given?
 
-      block_given? ? stream.total_out : res
+      Fiddle.free stream.to_ptr
+      res
     end
     alias decode_stream decompress_stream
 
@@ -317,8 +319,10 @@ module XZ
       end
 
       LibLZMA.lzma_end(stream.to_ptr)
+      res = stream.total_out if block_given?
 
-      block_given? ? stream.total_out : res
+      Fiddle.free stream.to_ptr
+      res
     end
     alias encode_stream compress_stream
 
@@ -458,8 +462,8 @@ module XZ
     # time--this is needed to allow (de-)compressing of very large
     # files that can't be loaded fully into memory.
     def lzma_code(io, stream)
-      input_buffer_p  = Fiddle::Pointer.malloc(CHUNK_SIZE) # automatically freed by fiddle on GC
-      output_buffer_p = Fiddle::Pointer.malloc(CHUNK_SIZE) # automatically freed by fiddle on GC
+      input_buffer_p  = Fiddle::Pointer.malloc(CHUNK_SIZE)
+      output_buffer_p = Fiddle::Pointer.malloc(CHUNK_SIZE)
 
       while str = io.read(CHUNK_SIZE)
         input_buffer_p[0, str.bytesize] = str
@@ -502,6 +506,9 @@ module XZ
           break unless stream.avail_out == 0
         end #loop
       end #while
+
+      Fiddle.free input_buffer_p
+      Fiddle.free output_buffer_p
     end #lzma_code
 
     # Checks for errors and warnings that can be derived from the

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: ruby-xz
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.3
 platform: ruby
 authors:
 - Marvin Gülker
-autorequire: 
+- Alex Gittemeier
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-05-20 00:00:00.000000000 Z
+date: 2022-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitar
@@ -24,13 +25,41 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
 description: |
   These are simple Ruby bindings for the liblzma library
   (http://tukaani.org/xz/), which is best known for the
   extreme compression ratio its native XZ format achieves.
   Since fiddle is used to implement the bindings, no compilation
   is needed.
-email: m-guelker@phoenixmail.de
+email: me@a.lexg.dev
 executables: []
 extensions: []
 extra_rdoc_files:
@@ -50,10 +79,16 @@ files:
 - lib/xz/stream_reader.rb
 - lib/xz/stream_writer.rb
 - lib/xz/version.rb
-homepage: https://mg.guelker.eu/projects/ruby-xz/
+homepage: https://github.com/win93/ruby-xz
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/win93/ruby-xz
+  source_code_uri: https://github.com/win93/ruby-xz/tree/stable
+  documentation_uri: https://www.rubydoc.info/gems/ruby-xz
+  bug_tracker_uri: https://github.com/win93/ruby-xz/issues
+  changelog_uri: https://github.com/win93/ruby-xz/blob/stable/HISTORY.rdoc
+  rubygems_mfa_required: 'true'
 post_install_message: Version 1.0.0 of ruby-xz breaks the API. Read HISTORY.rdoc and
   adapt your code to the new API.
 rdoc_options:
@@ -74,9 +109,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2.1
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: XZ compression via liblzma for Ruby, using fiddle.
 test_files: []