pnm 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b5d51775ecf00c43299084927b3ce8e0fb182127accb347f25806a840e7389a4
-  data.tar.gz: 0ac3e779bb1af09853cf6429fdb0fe5ec1a6d5e951eaf0f227e97e7c81b9f053
+  metadata.gz: ef6f55635bbaa23976ceb49f1547b92cf78e2ad04d51363054ac12dbfe6943e0
+  data.tar.gz: 4b7c8730c80b28b6a98a4b27fc3a000a4e28eb11be34bf5c2717da188f833d9a
 SHA512:
-  metadata.gz: aa8584a19eb7f6aad9513cc379a1700dfe9e1f5b9e58feaba2ae80e18c670050f9ba3fbd39f7528f3bad2bd59eb31ba491ae0f8673669454cbae92b4f996c416
-  data.tar.gz: 87e0d5751baa549e9f2f14be763d6b77a40bde876c23f9ee44df5ef8b1ec642024091e6d06e32172aef09e33323bca2cf5f1945e8cecf7e7aa9945629f448811
+  metadata.gz: f3b07074daa3fd1601d8d0c4f05dc2764c1c2434b24368d0e69c4752ecc9af1153751f14f1af679d2319d46b20b74cff4c9e10e50341eb12fbb82abc97ca69d5
+  data.tar.gz: 5356021622e4656db38f8f7c7b918c5e3bbffc63670e4b39b851ca542f55f5a51b7748b2384540426d7e154ebb3b151c4d106cd1adee00c526d6e249753e54c6

data/README.md

@@ -1,6 +1,8 @@
 PNM - A Ruby library for PNM image files (PBM, PGM, PPM)
 ========================================================
 
+![CI](https://github.com/stomar/pnm/actions/workflows/ci.yml/badge.svg)
+
 PNM is a pure [Ruby][Ruby] library for creating, reading,
 and writing of `PNM` image files (Portable Anymap):
 
@@ -96,11 +98,11 @@ Requirements
 
 - No additional Ruby gems or native libraries are needed.
 
-- PNM has been tested with
+- PNM's current version has been tested with
 
-  - Ruby 2.7
-  - Ruby 2.6, 2.5, 2.4, 2.3, 2.2, 2.1, 2.0.0,
-  - JRuby 9.2.13.0.
+  - Ruby 3.3, 3.2, 3.1, 3.0,
+  - Ruby 2.7, 2.6,
+  - JRuby 9.4.5.0.
 
 Documentation
 -------------
@@ -116,7 +118,7 @@ Report bugs on the PNM home page: <https://github.com/stomar/pnm/>
 License
 -------
 
-Copyright &copy; 2013-2020 Marcus Stollsteimer
+Copyright &copy; 2013-2024 Marcus Stollsteimer
 
 `PNM` is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License version 3 or later (GPLv3+),

data/Rakefile

@@ -1,9 +1,5 @@
 # frozen_string_literal: true
 
-# rakefile for the PNM library.
-#
-# Copyright (C) 2013-2020 Marcus Stollsteimer
-
 require "rake/testtask"
 
 require_relative "lib/pnm"
@@ -25,7 +21,7 @@ end
 
 desc "Run benchmarks"
 task :benchmark do
-  Dir["benchmark/**/bm_*.rb"].each {|f| require_relative f }
+  Dir["benchmark/**/bm_*.rb"].sort.each {|f| require_relative f }
 end
 
 

data/benchmark/bm_converter.rb

@@ -1,10 +1,6 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-# bm_converter.rb: Benchmarks for the PNM library.
-#
-# Copyright (C) 2013-2020 Marcus Stollsteimer
-
 require "benchmark"
 require_relative "../lib/pnm"
 
@@ -12,8 +8,8 @@ require_relative "../lib/pnm"
 class ConverterBenchmark
 
   def initialize
-    @repetitions = ARGV[0].to_i  if ARGV[0] =~ /[0-9]+/
-    @repetitions ||= 10
+    @repetitions = ENV.fetch("BM_RUNS", "")
+    @repetitions = @repetitions.match?(/\A[0-9]+\z/) ? @repetitions.to_i : 10
 
     @srcpath = File.dirname(__FILE__)
 

data/lib/pnm/converter.rb

@@ -11,7 +11,7 @@ module PNM
     def self.byte_width(type, width)
       case type
       when :pbm
-        (width - 1) / 8 + 1
+        ((width - 1) / 8) + 1
       when :pgm
         width
       when :ppm
@@ -53,14 +53,14 @@ module PNM
       bytes_per_row = byte_width(type, width)
       expected_size = bytes_per_row * height
 
-      data.slice!(-1)  if data.size == expected_size + 1 && data[-1] =~ /[ \t\r\n]/
+      data.slice!(-1)  if data.size == expected_size + 1 && data[-1].match?(/[ \t\r\n]/)
 
       assert_data_size(data.size, expected_size)
 
       pixel_matrix = case type
                      when :pbm
                        rows = data.scan(/.{#{bytes_per_row}}/m)
-                       rows.map {|row| row.unpack("B*").first[0, width].each_char.map(&:to_i) }
+                       rows.map {|row| row.unpack1("B*")[0, width].each_char.map(&:to_i) }
                      when :pgm
                        data.each_byte.each_slice(bytes_per_row).to_a
                      when :ppm
@@ -107,9 +107,9 @@ module PNM
 
     def self.convert_to_integers(data, type)
       values_as_string = if type == :pbm
-                           data.gsub(/[ \t\r\n]+/, "").split("")
+                           data.gsub(/[ \t\r\n]+/, "").chars
                          else
-                           data.gsub(/\A[ \t\r\n]+/, "").split(/[ \t\r\n]+/)
+                           data.sub(/\A[ \t\r\n]+/, "").split(/[ \t\r\n]+/)
                          end
 
       values_as_string.map {|value| Integer(value) }

data/lib/pnm/image.rb

@@ -47,11 +47,7 @@ module PNM
       type ||= detect_type(pixels, maxgray)
 
       # except for type detection, the maxgray option must be ignored for PBM
-      maxgray = if type == :pbm
-                  nil
-                else
-                  maxgray
-                end
+      maxgray = nil  if type == :pbm
 
       image_class = case type
                     when :pbm
@@ -98,9 +94,10 @@ module PNM
     #
     # Returns the number of bytes written.
     def write(file, add_extension: false, encoding: :binary)
-      content = if encoding == :ascii
+      content = case encoding
+                when :ascii
                   to_ascii
-                elsif encoding == :binary
+                when :binary
                   to_binary
                 end
 
@@ -184,7 +181,7 @@ module PNM
 
     def self.assert_valid_maxgray(maxgray)  # :nodoc:
       return  unless maxgray
-      return  if maxgray.is_a?(Integer) && maxgray > 0 && maxgray <= 255
+      return  if maxgray.is_a?(Integer) && maxgray.positive? && maxgray <= 255
 
       msg = "invalid maxgray value - #{maxgray.inspect}"
       raise PNM::ArgumentError, msg
@@ -205,7 +202,7 @@ module PNM
 
       type = type.to_sym  if type.is_a?(String)
 
-      unless [:pbm, :pgm, :ppm].include?(type)
+      unless %i[pbm pgm ppm].include?(type)
         msg = "invalid image type - #{type.inspect}"
         raise PNM::ArgumentError, msg
       end
@@ -261,7 +258,7 @@ module PNM
       return [""]  if comment.empty?
 
       keep_trailing_null_fields = -1  # magic value for split limit
-      comment.split(/\n/, keep_trailing_null_fields)
+      comment.split("\n", keep_trailing_null_fields)
     end
 
     def to_ascii  # :nodoc:
@@ -289,7 +286,6 @@ module PNM
     end
   end
 
-
   # Class for +PBM+ images. See the Image class for documentation.
   class PBMImage < Image
 
@@ -320,7 +316,6 @@ module PNM
     end
   end
 
-
   # Class for +PGM+ images. See the Image class for documentation.
   class PGMImage < Image
 
@@ -351,7 +346,6 @@ module PNM
     end
   end
 
-
   # Class for +PPM+ images. See the Image class for documentation.
   class PPMImage < Image
 

data/lib/pnm/parser.rb

@@ -29,7 +29,7 @@ module PNM
         token = next_token!(content)
 
         if token.start_with?("#")
-          comments << token.gsub(/# */, "")
+          comments << strip_comment_prefix(token)
         else
           magic_number = token
         end
@@ -38,11 +38,11 @@ module PNM
       assert_valid_magic_number(magic_number)
 
       while tokens.size < token_number[magic_number]
-        content.gsub!(/\A[ \t\r\n]+/, "")
+        content.sub!(/\A[ \t\r\n]+/, "")
         token = next_token!(content)
 
         if token.start_with?("#")
-          comments << token.gsub(/# */, "")
+          comments << strip_comment_prefix(token)
         else
           tokens << token
         end
@@ -100,6 +100,10 @@ module PNM
       token
     end
 
+    def self.strip_comment_prefix(comment)
+      comment.sub(/\A# */, "")
+    end
+
     def self.assert_valid_magic_number(magic_number)
       return  if %w[P1 P2 P3 P4 P5 P6].include?(magic_number)
 
@@ -108,21 +112,21 @@ module PNM
     end
 
     def self.assert_integer(value_string, value_name)
-      return  if value_string =~ /\A[0-9]+\Z/
+      return  if value_string.match?(/\A[0-9]+\z/)
 
       msg = "#{value_name} must be an integer - `#{value_string}'"
       raise PNM::ParserError, msg
     end
 
     def self.assert_positive(value, name)
-      return  if value > 0
+      return  if value.positive?
 
       msg = "#{name} must be greater than 0 - `#{value}'"
       raise PNM::ParserError, msg
     end
 
     def self.assert_in_maxgray_range(value)
-      return  if value > 0 && value <= 255
+      return  if value.positive? && value <= 255
 
       msg = "invalid maxgray value - `#{value}'"
       raise PNM::ParserError, msg

data/lib/pnm/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module PNM
-  VERSION = "0.6.0"
-  DATE    = "2020-09-23"
+  VERSION = "0.7.0"
+  DATE    = "2024-01-05"
 end

data/lib/pnm.rb

@@ -87,7 +87,7 @@ require_relative "pnm/exceptions"
 #
 # == Author
 #
-# Copyright (C) 2013-2020 Marcus Stollsteimer
+# Copyright (C) 2013-2024 Marcus Stollsteimer
 #
 # License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
 #
@@ -97,8 +97,8 @@ module PNM
   HOMEPAGE = "https://github.com/stomar/pnm"
   TAGLINE  = "create/read/write PNM image files (PBM, PGM, PPM)"
 
-  COPYRIGHT = <<-TEXT.gsub(/^ +/, "")
-    Copyright (C) 2013-2020 Marcus Stollsteimer.
+  COPYRIGHT = <<~TEXT
+    Copyright (C) 2013-2024 Marcus Stollsteimer.
     License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>.
     This is free software: you are free to change and redistribute it.
     There is NO WARRANTY, to the extent permitted by law.
@@ -119,20 +119,7 @@ module PNM
 
     content = Parser.parse(raw_data)
 
-    type, encoding = case content[:magic_number]
-                     when "P1"
-                       [:pbm, :ascii]
-                     when "P2"
-                       [:pgm, :ascii]
-                     when "P3"
-                       [:ppm, :ascii]
-                     when "P4"
-                       [:pbm, :binary]
-                     when "P5"
-                       [:pgm, :binary]
-                     when "P6"
-                       [:ppm, :binary]
-                     end
+    type, encoding = type_and_encoding[content[:magic_number]]
 
     width   = content[:width]
     height  = content[:height]
@@ -191,4 +178,16 @@ module PNM
       ppm: { ascii: "P3", binary: "P6" }
     }
   end
+
+  # @private
+  def self.type_and_encoding  # :nodoc:
+    {
+      "P1" => %i[pbm ascii],
+      "P2" => %i[pgm ascii],
+      "P3" => %i[ppm ascii],
+      "P4" => %i[pbm binary],
+      "P5" => %i[pgm binary],
+      "P6" => %i[ppm binary]
+    }
+  end
 end

data/pnm.gemspec

@@ -25,10 +25,7 @@ Gem::Specification.new do |s|
 
   s.license = "GPL-3.0"
 
-  s.required_ruby_version = ">= 2.0.0"
-
-  s.add_development_dependency "minitest", ">= 5.0"
-  s.add_development_dependency "rake", ">= 10.0"
+  s.required_ruby_version = ">= 2.6.0"
 
   s.require_paths = ["lib"]
 

data/test/test_converter.rb

@@ -1,14 +1,8 @@
 # frozen_string_literal: true
 
-# test_converter.rb: Unit tests for the PNM library.
-#
-# Copyright (C) 2013-2020 Marcus Stollsteimer
-
 require "minitest/autorun"
 require "pnm/converter"
 
-require_relative "backports"
-
 
 describe PNM::Converter do
 
@@ -136,9 +130,10 @@ describe PNM::Converter do
   it "accepts an additional whitespace character for binary encoded data" do
     width    = @pbm14[:width]
     height   = @pbm14[:height]
-    data     = @pbm14[:binary] + "\t"
+    data     = @pbm14[:binary].dup << "\t"
     expected = @pbm14[:array]
 
+    refute_equal data, @pbm14[:binary]
     _(@converter.binary2array(:pbm, width, height, data)).must_equal expected
   end
 

data/test/test_exceptions.rb

@@ -1,15 +1,9 @@
 # frozen_string_literal: true
 
-# test_exceptions.rb: Unit tests for the PNM library.
-#
-# Copyright (C) 2013-2020 Marcus Stollsteimer
-
 require "minitest/autorun"
 require "stringio"
 require "pnm"
 
-require_relative "backports"
-
 
 describe "PNM.create" do
 

data/test/test_image.rb

@@ -1,14 +1,8 @@
 # frozen_string_literal: true
 
-# test_image.rb: Unit tests for the PNM library.
-#
-# Copyright (C) 2013-2020 Marcus Stollsteimer
-
 require "minitest/autorun"
 require "pnm"
 
-require_relative "backports"
-
 
 describe PNM::Image do
 

data/test/test_parser.rb

@@ -1,14 +1,8 @@
 # frozen_string_literal: true
 
-# test_parser.rb: Unit tests for the PNM library.
-#
-# Copyright (C) 2013-2020 Marcus Stollsteimer
-
 require "minitest/autorun"
 require "pnm/parser"
 
-require_relative "backports"
-
 
 describe PNM::Parser do
 
@@ -17,7 +11,7 @@ describe PNM::Parser do
   end
 
   it "can parse ASCII encoded PBM data" do
-    content = <<-PBM.chomp.gsub(/^ */, "")
+    content = <<~PBM.chomp
       P1 6 2
       0 1 0 0 1 1
       0 0 0 1 1 1
@@ -33,7 +27,7 @@ describe PNM::Parser do
   end
 
   it "can parse ASCII encoded PGM data" do
-    content = <<-PGM.chomp.gsub(/^ */, "")
+    content = <<~PGM.chomp
       P2 4 2 100
       10 20 30 40
       50 60 70 80
@@ -98,7 +92,7 @@ describe PNM::Parser do
   end
 
   it "can parse comments" do
-    content = <<-PBM.chomp.gsub(/^ */, "")
+    content = <<~PBM.chomp
       # Comment 1
       P1  # Comment 2
       6# Comment 3
@@ -119,4 +113,25 @@ describe PNM::Parser do
 
     _(@parser.parse(content)).must_equal expected
   end
+
+  it "can parse a comment containing a # character" do
+    content = <<~PBM.chomp
+      # Comment 1 with # character
+      P1
+      # Comment 2: '#   foo' is a comment
+      3
+      2
+      0 1 0
+      1 0 1
+    PBM
+    expected = {
+      magic_number: "P1",
+      width:        3,
+      height:       2,
+      comments:     ["Comment 1 with # character", "Comment 2: '#   foo' is a comment"],
+      data:         "0 1 0\n1 0 1"
+    }
+
+    _(@parser.parse(content)).must_equal expected
+  end
 end

data/test/test_pnm.rb

@@ -1,14 +1,8 @@
 # frozen_string_literal: true
 
-# test_pnm.rb: Unit tests for the PNM library.
-#
-# Copyright (C) 2013-2020 Marcus Stollsteimer
-
 require "minitest/autorun"
 require "pnm"
 
-require_relative "backports"
-
 
 describe PNM do
 

metadata

@@ -1,43 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: pnm
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Marcus Stollsteimer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-23 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '5.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '5.0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '10.0'
+date: 2024-01-05 00:00:00.000000000 Z
+dependencies: []
 description: 'PNM is a pure Ruby library for creating, reading, and writing of PNM
   image files (Portable Anymap): PBM (Portable Bitmap), PGM (Portable Graymap), and
   PPM (Portable Pixmap).'
@@ -61,7 +33,6 @@ files:
 - lib/pnm/parser.rb
 - lib/pnm/version.rb
 - pnm.gemspec
-- test/backports.rb
 - test/bilevel_2_binary.pbm
 - test/bilevel_ascii.pbm
 - test/bilevel_binary.pbm
@@ -89,20 +60,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.5.3
 signing_key: 
 specification_version: 4
 summary: PNM - create/read/write PNM image files (PBM, PGM, PPM)
 test_files:
-- test/test_exceptions.rb
 - test/test_converter.rb
-- test/test_pnm.rb
+- test/test_exceptions.rb
 - test/test_image.rb
 - test/test_parser.rb
+- test/test_pnm.rb

data/test/backports.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-module PNM
-  module Backports  # :nodoc:
-    module Minitest  # :nodoc:
-
-      # Provides workaround for missing value wrappers in minitest < 5.6.0.
-      def _(value = nil, &block)
-        block || value
-      end
-    end
-  end
-end
-
-
-if Gem.loaded_specs["minitest"].version < Gem::Version.new("5.6.0")
-  warn "Using workaround for missing value wrappers in minitest < 5.6.0."
-  include PNM::Backports::Minitest
-end