repomd_parser 0.1.5 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e96fc8459331c46c5a95a479d50c93973db28675e71f37d367300ad921c5995
-  data.tar.gz: 0bc27934593e3e22225850446f537754e0ee7e0f1d190fdb27e51019dffd3771
+  metadata.gz: 464be2962408f4592e3d06eadda7c14ac22f0e7deea9b962e246bc13e40181cb
+  data.tar.gz: 9caa45644420feea003a12f2902d02f538972c0e68b76a26b85229ffe03e1b61
 SHA512:
-  metadata.gz: 10fc061b160790a2bf8a4f440dbbbdcc3cbbfbb9c70fd40616a16be1c7270040695a440eb65ae3a493ac5b6aac791c43002f580782a2a88eb2405ee5d4dce50c
-  data.tar.gz: 5905bf2dfcce585e9ebcadf452dab17ebb17a0dcf0e5d04f010042d982a4b0484204e4b56fdd48e142dc308022d58e028ea3b5076c93af775be6cddda0a648cd
+  metadata.gz: b7e9367a0b325fd882238e38d71cf98ebf535d9fa4452ffb90dcaf9f0667081e8cca1bd8db716c35270c23d955281845da2c9a7195c656c5c4210f9bd2d1e84a
+  data.tar.gz: 6697e2943d63f684229439453c4e08ee5cded95059d3eacbd61f610bd0087f8b388780648b6ef9092cac9323d5c768ab5fc3970d89a54bb9d4bdb8851873c093

data/Gemfile

@@ -1,6 +1,6 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in repomd_parser.gemspec
 gemspec

data/README.md

@@ -1,4 +1,4 @@
-# RepomdParser [![Build Status](https://travis-ci.org/ikapelyukhin/repomd-parser.svg?branch=master)](https://travis-ci.org/ikapelyukhin/repomd-parser)
+# RepomdParser
 
 RPM repository metadata parser.
 
@@ -20,10 +20,23 @@ Alternatively, install as `gem install repomd_parser`.
 
 Parses `repomd.xml` -- the main repository metadata file, which references other metadata files.
 
-`parse` method returns an array of `RepomdParser::Reference`. 
+`parse` and `parse_file` methods return an array of `RepomdParser::Reference`.
+
+##### Using the `parse` method
 
 ```ruby
-metadata_files = RepomdParser::RepomdXmlParser.new('repomd.xml').parse
+File.open('repomd.xml') do |fh|
+  metadata_files = RepomdParser::RepomdXmlParser.new.parse(fh)
+  metadata_files.each do |metadata_file|
+    printf "type: %10s, location: %s\n", metadata_file.type, metadata_file.location
+  end
+end
+```
+
+##### Using the `parse_file` method
+
+```ruby
+metadata_files = RepomdParser::RepomdXmlParser.new.parse_file('repomd.xml')
 metadata_files.each do |metadata_file|
   printf "type: %10s, location: %s\n", metadata_file.type, metadata_file.location 
 end
@@ -33,10 +46,23 @@ end
 
 Parses `primary.xml`, which contains information about RPM packages in the repository.
 
-`parse` method returns an array of `RepomdParser::Reference`.
+`parse` and `parse_file` methods return an array of `RepomdParser::Reference`.
+
+##### Using the `parse` method
+
+```ruby
+File.open('primary.xml') do |fh|
+  rpm_packages = RepomdParser::PrimaryXmlParser.new.parse(fh)
+  rpm_packages.each do |rpm|
+    printf "arch: %8s, location: %s\n", rpm.arch, rpm.location
+  end
+end
+```
+
+##### Using the `parse_file` method
 
 ```ruby
-rpm_packages = RepomdParser::PrimaryXmlParser.new('primary.xml').parse
+rpm_packages = RepomdParser::PrimaryXmlParser.new.parse_file('primary.xml')
 rpm_packages.each do |rpm|
   printf "arch: %8s, location: %s\n", rpm.arch, rpm.location
 end
@@ -46,15 +72,54 @@ end
 
 Parses `deltainfo.xml`, which contains information about delta-RPM packages in the repository.
 
-`parse` method returns an array of `RepomdParser::Reference`.
+`parse` and `parse_file` methods return an array of `RepomdParser::Reference`.
+
+##### Using the `parse` method
+
+```ruby
+File.open('deltainfo.xml') do |fh|
+  rpm_packages = RepomdParser::DeltainfoXmlParser.new.parse(fh)
+  rpm_packages.each do |rpm|
+    printf "arch: %8s, location: %s\n", rpm.arch, rpm.location
+  end
+end
+```
+
+##### Using the `parse_file` method
 
 ```ruby
-rpm_packages = RepomdParser::DeltainfoXmlParser.new('deltainfo.xml').parse
+rpm_packages = RepomdParser::DeltainfoXmlParser.new.parse_file('deltainfo.xml')
 rpm_packages.each do |rpm|
   printf "arch: %8s, location: %s\n", rpm.arch, rpm.location
 end
 ```
 
+#### Compressed file support
+
+The gzip and Zstandard compression formats are supported. The `parse_file`
+method automatically decompresses files based on the filename, e.g.:
+
+```ruby
+rpm_packages = RepomdParser::PrimaryXmlParser.new.parse_file('primary.xml.gz')
+rpm_packages.each do |rpm|
+  printf "arch: %8s, location: %s\n", rpm.arch, rpm.location
+end
+```
+
+The `RepomdParser.decompress_io` helper is provided to handle
+decompression of IO objects for use with the `parse` method:
+
+```ruby
+filename = 'primary.xml.gz'
+io = RepomdParser.decompress_io(File.open(filename), filename)
+
+rpm_packages = RepomdParser::PrimaryXmlParser.new.parse(io)
+rpm_packages.each do |rpm|
+  printf "arch: %8s, location: %s\n", rpm.arch, rpm.location
+end
+```
+
+
 #### RepomdParser::Reference
 
 Represents a file referenced in the metadata file. Has the following accessors:
@@ -75,11 +140,12 @@ RPM and DRPM files additionally have the following attributes:
 
 ## Caveats
 
-* Relies on the file name to determine if the file is compressed (automatically decompresses `.gz` files)
+* File extension is used to determine file compression type (expected
+  extensions are `.gz` and `.zst` for gzip and Zstandard respectively)
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bundle install` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 

data/Rakefile

@@ -1,6 +1,6 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/lib/repomd_parser/base_parser.rb

@@ -19,24 +19,20 @@ require 'nokogiri'
 require 'zlib'
 
 class RepomdParser::BaseParser < Nokogiri::XML::SAX::Document
-
-  def initialize(filename)
-    @referenced_files = []
-    @filename = filename
+  def parse_file(filename)
+    io = RepomdParser.decompress_io(File.open(filename), filename)
+    parse(io)
+  ensure
+    io.close
   end
 
-  def parse
-    if (File.extname(@filename) == '.gz')
-      Zlib::GzipReader.open(@filename) do |gz|
-        Nokogiri::XML::SAX::Parser.new(self).parse(gz)
-      end
-    else
-      File.open(@filename) do |fh|
-        Nokogiri::XML::SAX::Parser.new(self).parse(fh)
-      end
-    end
+  def parse(io_object)
+    @referenced_files = []
+    Nokogiri::XML::SAX::Parser.new(self).parse(io_object)
+    ret_val = @referenced_files
+    @referenced_files = nil
 
-    @referenced_files
+    ret_val
   end
 
   protected
@@ -44,5 +40,4 @@ class RepomdParser::BaseParser < Nokogiri::XML::SAX::Document
   def get_attribute(attributes, name)
     attributes.select { |e| e[0] == name }.first[1]
   end
-
 end

data/lib/repomd_parser/deltainfo_xml_parser.rb

@@ -16,49 +16,45 @@
 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 
 class RepomdParser::DeltainfoXmlParser < RepomdParser::BaseParser
-
-  def initialize(filename)
-    super(filename)
-  end
-
   def start_element(name, attrs = [])
     @current_node = name.to_sym
-    if (name == 'newpackage')
+    case name
+    when 'newpackage'
       @package = {}
       @package[:version] = get_attribute(attrs, 'version')
       @package[:name] = get_attribute(attrs, 'name')
       @package[:arch] = get_attribute(attrs, 'arch')
-    elsif (name == 'delta')
+    when 'delta'
       @delta = {}
-    elsif (name == 'checksum')
+    when 'checksum'
       @delta[:checksum_type] = get_attribute(attrs, 'type')
     end
   end
 
   def characters(string)
-    if (@current_node == :filename)
+    case @current_node
+    when :filename
       @delta[:location] ||= ''
       @delta[:location] += string.strip
-    elsif (@current_node == :checksum)
+    when :checksum
       @delta[:checksum] ||= ''
       @delta[:checksum] += string.strip
-    elsif (@current_node == :size)
+    when :size
       @delta[:size] ||= ''
       @delta[:size] += string.strip
     end
   end
 
   def end_element(name)
-    if (name == 'delta')
-      @referenced_files << RepomdParser::Reference.new(
-        location: @delta[:location],
-        checksum_type: @delta[:checksum_type],
-        checksum: @delta[:checksum],
-        type: :drpm,
-        size: @delta[:size].to_i,
-        arch: @package[:arch],
-      )
-    end
-  end
+    return unless name == 'delta'
 
+    @referenced_files << RepomdParser::Reference.new(
+      location: @delta[:location],
+      checksum_type: @delta[:checksum_type],
+      checksum: @delta[:checksum],
+      type: :drpm,
+      size: @delta[:size].to_i,
+      arch: @package[:arch]
+    )
+  end
 end

data/lib/repomd_parser/primary_xml_parser.rb

@@ -16,54 +16,49 @@
 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 
 class RepomdParser::PrimaryXmlParser < RepomdParser::BaseParser
-
-  def initialize(filename)
-    super(filename)
-  end
-
   def start_element(name, attrs = [])
     @current_node = name.to_sym
-    if (name == 'package')
+    case name
+    when 'package'
       @package = {}
-    elsif (name == 'version')
+    when 'version'
       @package[:version] = get_attribute(attrs, 'ver')
       @package[:release] = get_attribute(attrs, 'rel')
-    elsif (name == 'location')
+    when 'location'
       @package[:location] = get_attribute(attrs, 'href')
-    elsif (name == 'checksum')
+    when 'checksum'
       @package[:checksum_type] = get_attribute(attrs, 'type')
-    elsif (name == 'size')
+    when 'size'
       @package[:size] = get_attribute(attrs, 'package').to_i
-    elsif (name == 'time')
+    when 'time'
       @package[:build_time] = get_attribute(attrs, 'build')
     end
   end
 
   def characters(string)
-    if (%i[name arch checksum summary description rpm:license].include? @current_node)
-      @package[@current_node] ||= ''
-      @package[@current_node] += string.strip
-    end
+    return unless %i[name arch checksum summary description rpm:license].include? @current_node
+
+    @package[@current_node] ||= ''
+    @package[@current_node] += string.strip
   end
 
   def end_element(name)
-    if (name == 'package')
-      @referenced_files << RepomdParser::Reference.new(
-        location: @package[:location],
-        checksum_type: @package[:checksum_type],
-        checksum: @package[:checksum],
-        type: :rpm,
-        size: @package[:size].to_i,
-        arch: @package[:arch],
-        version: @package[:version],
-        release: @package[:release],
-        name: @package[:name],
-        summary: @package[:summary],
-        description: @package[:description],
-        license: @package[:"rpm:license"],
-        build_time: Time.at(@package[:build_time].to_i).utc
-      )
-    end
-  end
+    return unless name == 'package'
 
+    @referenced_files << RepomdParser::Reference.new(
+      location: @package[:location],
+      checksum_type: @package[:checksum_type],
+      checksum: @package[:checksum],
+      type: :rpm,
+      size: @package[:size].to_i,
+      arch: @package[:arch],
+      version: @package[:version],
+      release: @package[:release],
+      name: @package[:name],
+      summary: @package[:summary],
+      description: @package[:description],
+      license: @package[:'rpm:license'],
+      build_time: Time.at(@package[:build_time].to_i).utc
+    )
+  end
 end

data/lib/repomd_parser/reference.rb

@@ -45,15 +45,15 @@ class RepomdParser::Reference
                  build_time: nil)
     local_variables.each do |local_var|
       method = "#{local_var}="
-      send(method, binding.local_variable_get(local_var)) if (respond_to?(method))
+      send(method, binding.local_variable_get(local_var)) if respond_to?(method)
     end
   end
 
   # Overloaded comparator for specs
-  def ==(obj)
+  def ==(other)
     result = true
     instance_variables.each do |instance_var|
-      result &&= (instance_variable_get(instance_var) == obj.instance_variable_get(instance_var))
+      result &&= (instance_variable_get(instance_var) == other.instance_variable_get(instance_var))
     end
     result
   end

data/lib/repomd_parser/repomd_xml_parser.rb

@@ -16,14 +16,15 @@
 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 
 class RepomdParser::RepomdXmlParser
-
-  def initialize(filename)
-    @filename = filename
+  def parse_file(filename)
+    File.open(filename) do |fh|
+      parse(fh)
+    end
   end
 
-  def parse
+  def parse(io_object)
     files = []
-    xml = Nokogiri::XML(File.open(@filename))
+    xml = Nokogiri::XML(io_object)
 
     xml.xpath('/xmlns:repomd/xmlns:data').each do |data_node|
       type = data_node.attr('type').to_sym
@@ -48,5 +49,4 @@ class RepomdParser::RepomdXmlParser
 
     files
   end
-
 end

data/lib/repomd_parser/version.rb

@@ -16,5 +16,5 @@
 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 
 module RepomdParser
-  VERSION = '0.1.5'
+  VERSION = '1.0.0'.freeze
 end

data/lib/repomd_parser/zstd_reader.rb

@@ -0,0 +1,44 @@
+# repomd_parser -- Ruby gem to parse RPM repository metadata
+# Copyright (C) 2024 Ivan Kapelyukhin
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+require 'zstd-ruby'
+
+class RepomdParser::ZstdReader
+  def initialize(io_object)
+    @io = io_object
+    @stream = Zstd::StreamingDecompress.new
+    @buffer = ''
+  end
+
+  def read(len = nil, out = nil)
+    @buffer << @stream.decompress(@io.read(len)) while @buffer.size < len && !@io.eof
+
+    if @buffer.size > len
+      out = @buffer[0..len]
+      @buffer = @buffer[len..-1]
+    else
+      out = @buffer
+      @buffer = ''
+    end
+
+    out
+  end
+
+  def close
+    @io.close
+  end
+end

data/lib/repomd_parser.rb

@@ -15,12 +15,20 @@
 # with this program; if not, write to the Free Software Foundation, Inc.,
 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 
-module RepomdParser
-end
-
 require 'repomd_parser/version'
 require 'repomd_parser/reference'
 require 'repomd_parser/base_parser'
 require 'repomd_parser/repomd_xml_parser'
 require 'repomd_parser/deltainfo_xml_parser'
 require 'repomd_parser/primary_xml_parser'
+require 'repomd_parser/zstd_reader'
+
+module RepomdParser
+  def self.decompress_io(io_object, filename)
+    case File.extname(filename)
+    when '.gz' then Zlib::GzipReader.new(io_object)
+    when '.zst' then RepomdParser::ZstdReader.new(io_object)
+    else io_object
+    end
+  end
+end

data/repomd_parser.gemspec

@@ -1,31 +1,38 @@
-
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "repomd_parser/version"
+require 'repomd_parser/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "repomd_parser"
+  spec.name          = 'repomd_parser'
   spec.version       = RepomdParser::VERSION
-  spec.authors       = ["Ivan Kapelyukhin"]
-  spec.email         = ["ikapelyukhin@suse.com"]
+  spec.authors       = ['Ivan Kapelyukhin']
+  spec.email         = ['ikapelyukhin@opensuse.org']
 
-  spec.summary       = %q{RPM repository metadata (RepoMD) parser}
-  spec.homepage      = "https://github.com/ikapelyukhin/repomd-parser"
+  spec.summary       = 'RPM repository metadata (RepoMD) parser'
+  spec.homepage      = 'https://github.com/ikapelyukhin/repomd-parser'
   spec.license       = 'GPL-2.0-or-later'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }.reject { |f| f.match(%r{^\.}) }
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }.reject { |f| f.match(/^\./) }
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 2.5'
+
+  spec.metadata = { 'rubygems_mfa_required' => 'true' }
 
-  spec.add_development_dependency "bundler", ">= 1.16"
-  spec.add_development_dependency "rake", "~> 13.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'bundler', '>= 1.16'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'simplecov', '~> 0.16.1'
 
+  # Locked because of Ruby >= 2.5 dependency
+  spec.add_development_dependency 'rubocop', '<= 1.25'
+  spec.add_development_dependency 'rubocop-ast', '<= 1.17.0'
+
   spec.add_dependency 'nokogiri', '~> 1.8'
+  spec.add_dependency 'zstd-ruby', '~> 1.3', '>= 1.3.5.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: repomd_parser
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 1.0.0
 platform: ruby
 authors:
 - Ivan Kapelyukhin
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-12-09 00:00:00.000000000 Z
+date: 2024-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.16.1
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '1.25'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '1.25'
+- !ruby/object:Gem::Dependency
+  name: rubocop-ast
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 1.17.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 1.17.0
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -80,9 +108,29 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.8'
-description: 
+- !ruby/object:Gem::Dependency
+  name: zstd-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.5.0
+description:
 email:
-- ikapelyukhin@suse.com
+- ikapelyukhin@opensuse.org
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -91,7 +139,6 @@ files:
 - Gemfile
 - README.md
 - Rakefile
-- bin/setup
 - lib/repomd_parser.rb
 - lib/repomd_parser/base_parser.rb
 - lib/repomd_parser/deltainfo_xml_parser.rb
@@ -99,12 +146,14 @@ files:
 - lib/repomd_parser/reference.rb
 - lib/repomd_parser/repomd_xml_parser.rb
 - lib/repomd_parser/version.rb
+- lib/repomd_parser/zstd_reader.rb
 - repomd_parser.gemspec
 homepage: https://github.com/ikapelyukhin/repomd-parser
 licenses:
 - GPL-2.0-or-later
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -112,16 +161,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.8
-signing_key: 
+rubygems_version: 3.3.15
+signing_key:
 specification_version: 4
 summary: RPM repository metadata (RepoMD) parser
 test_files: []

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here