pnm 0.5.2 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 66de49354358fed31c8299381599bb8b16d87d2143e2102ca61da00e6b8b2927
-  data.tar.gz: 2bd7e0d7491be12b5562c3a1de19ee7e538d95c3535fc9bb92723726b5e5787c
+  metadata.gz: fdfdb7ac32419e9381856654116f77070fabb87713e2353c10230fb6ac9c79c9
+  data.tar.gz: 06042a5b1c3d26d5b4e982b3e2e4983b652d1e1ffab8987d5f8b183a017c4abb
 SHA512:
-  metadata.gz: bd83d15feb8b65b28b43f64cd48ab23a5e3f710a991f781c43d6d74bc9ea9a02cb905d61bae70af1fe2476c551ece310050eccd0210acb5701d87efb40d61173
-  data.tar.gz: 574e62b56e1ac1fea7a9110f1c01c805f373bfafd50210bb2145fca4086054d7d1ace113d1e46eadfe0b5c9314b3ca221168cdc2dba2e7168742615a7462e728
+  metadata.gz: 17970b6a53282e449e76f9225e65c914f92084e4060b5fbe3b9bbbd56cae9ae830e122fbf8ed0bbb321bf443ef1c9538d4b8a2b859759528aa8862d479375796
+  data.tar.gz: b66f7f50567bb137a5b091293c7b77206966e570e300157a0ebde66647e46f2c09d07cb093499f3527a5b6149d01a0f88baa235c5450e61d9b0ba02db2a2cb5e

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):
 
@@ -26,11 +28,11 @@ require "pnm"
 pixels = [[ 0, 10, 20],
           [10, 20, 30]]
 
-# optional settings
-options = { maxgray: 30, comment: "Test Image" }
-
 # create the image object
-image = PNM.create(pixels, options)
+image = PNM.create(pixels)
+
+# create the image with additional optional settings
+image = PNM.create(pixels, maxgray: 30, comment: "Test Image")
 
 # retrieve some image properties
 image.info    # => "PGM 3x2 Grayscale"
@@ -50,10 +52,10 @@ Write an image to a file:
 
 ``` ruby
 image.write("test.pgm")
-image.write_with_extension("test")  # adds the correct file extension
+image.write("test", add_extension: true)  # adds the appropriate file extension
 
-# use ASCII or "plain" format (default is binary)
-image.write("test.pgm", :ascii)
+# use ASCII or "plain" format (default is :binary)
+image.write("test.pgm", encoding: :ascii)
 
 # write to an I/O stream
 File.open("test.pgm", "w") {|f| image.write(f) }
@@ -98,11 +100,9 @@ Requirements
 
 - PNM has been tested with
 
-  - Ruby 2.6, 2.5, 2.4, 2.3, 2.2, 2.1,
-  - Ruby 2.0.0,
-  - Ruby 1.9.3,
-  - JRuby 1.7.19,
-  - Rubinius 2.5.2.
+  - Ruby 3.1, 3.0,
+  - Ruby 2.7, 2.6, 2.5, 2.4, 2.3, 2.2, 2.1, 2.0.0,
+  - JRuby 9.3.4.0.
 
 Documentation
 -------------
@@ -118,7 +118,7 @@ Report bugs on the PNM home page: <https://github.com/stomar/pnm/>
 License
 -------
 
-Copyright &copy; 2013-2019 Marcus Stollsteimer
+Copyright &copy; 2013-2022 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

@@ -2,7 +2,7 @@
 
 # rakefile for the PNM library.
 #
-# Copyright (C) 2013-2019 Marcus Stollsteimer
+# Copyright (C) 2013-2022 Marcus Stollsteimer
 
 require "rake/testtask"
 

data/benchmark/bm_converter.rb

@@ -3,7 +3,7 @@
 
 # bm_converter.rb: Benchmarks for the PNM library.
 #
-# Copyright (C) 2013-2019 Marcus Stollsteimer
+# Copyright (C) 2013-2022 Marcus Stollsteimer
 
 require "benchmark"
 require_relative "../lib/pnm"

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
@@ -107,14 +107,14 @@ 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]+/)
                          end
 
       values_as_string.map {|value| Integer(value) }
-    rescue ::ArgumentError => error
-      raise  unless error.message.start_with?("invalid value for Integer")
+    rescue ::ArgumentError => e
+      raise  unless e.message.start_with?("invalid value for Integer")
 
       raise PNM::DataError, "invalid pixel value: Integer expected"
     end

data/lib/pnm/image.rb

@@ -38,20 +38,16 @@ module PNM
     # This method should be called as PNM.create.
     # See there for a description of pixel data formats
     # and available options.
-    def self.create(pixels, options = {})
+    def self.create(pixels, type: nil, maxgray: nil, comment: nil)
       assert_valid_array(pixels)
-      assert_valid_maxgray(options[:maxgray])
-      assert_valid_comment(options[:comment])
+      assert_valid_maxgray(maxgray)
+      assert_valid_comment(comment)
 
-      type = sanitize_and_assert_valid_type(options[:type])
-      type ||= detect_type(pixels, options[:maxgray])
+      type = sanitize_and_assert_valid_type(type)
+      type ||= detect_type(pixels, maxgray)
 
       # except for type detection, the maxgray option must be ignored for PBM
-      maxgray = if type == :pbm
-                  nil
-                else
-                  options[:maxgray]
-                end
+      maxgray = nil  if type == :pbm
 
       image_class = case type
                     when :pbm
@@ -62,7 +58,7 @@ module PNM
                       PPMImage
                     end
 
-      image_class.new(pixels, maxgray, options[:comment])
+      image_class.new(pixels, maxgray, comment)
     end
 
     class << self
@@ -87,35 +83,33 @@ module PNM
       @comment.freeze
     end
 
-    # Writes the image to +file+ (a filename or an IO object),
-    # using the specified encoding.
-    # Valid encodings are +:binary+ (default) and +:ascii+.
+    # Writes the image to +file+ (a filename or an IO object).
+    #
+    # When +add_extension+ is set to +true+ (default: +false+)
+    # the appropriate file extension is added to the provided filename
+    # (+.pbm+, +.pgm+, or +.ppm+).
+    #
+    # The encoding can be set using the +encoding+ keyword argument,
+    # valid options are +:binary+ (default) and +:ascii+.
     #
     # Returns the number of bytes written.
-    def write(file, encoding = :binary)
-      content = if encoding == :ascii
+    def write(file, add_extension: false, encoding: :binary)
+      content = case encoding
+                when :ascii
                   to_ascii
-                elsif encoding == :binary
+                when :binary
                   to_binary
                 end
 
       if file.is_a?(String)
-        File.binwrite(file, content)
+        filename = add_extension ? "#{file}.#{type}" : file
+        File.binwrite(filename, content)
       else
         file.binmode
         file.write content
       end
     end
 
-    # Adds the appropriate file extension to +basename+
-    # (+.pbm+, +.pgm+, or +.ppm+)
-    # and writes the image to the resulting filename.
-    #
-    # Any options are passed on to #write, which is used internally.
-    def write_with_extension(basename, *args)
-      write("#{basename}.#{type}", *args)
-    end
-
     # Returns a string with a short image format description.
     def info
       "#{type.to_s.upcase} #{width}x#{height} #{type_string}"
@@ -208,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
@@ -292,7 +286,6 @@ module PNM
     end
   end
 
-
   # Class for +PBM+ images. See the Image class for documentation.
   class PBMImage < Image
 
@@ -323,7 +316,6 @@ module PNM
     end
   end
 
-
   # Class for +PGM+ images. See the Image class for documentation.
   class PGMImage < Image
 
@@ -354,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

@@ -22,7 +22,7 @@ module PNM
       content = content.dup
 
       magic_number = nil
-      tokens   = []
+      tokens = []
       comments = []
 
       until magic_number
@@ -50,17 +50,17 @@ module PNM
 
       width, height, maxgray = tokens
 
-      assert_integer(width,   "width")
-      assert_integer(height,  "height")
+      assert_integer(width, "width")
+      assert_integer(height, "height")
       assert_integer(maxgray, "maxgray")  if maxgray
 
-      width   = width.to_i
-      height  = height.to_i
+      width = width.to_i
+      height = height.to_i
       maxgray = maxgray.to_i  if maxgray
 
-      assert_value(width,   "width")   {|x| x > 0 }
-      assert_value(height,  "height")  {|x| x > 0 }
-      assert_value(maxgray, "maxgray") {|x| x > 0 && x <= 255 }  if maxgray
+      assert_positive(width, "width")
+      assert_positive(height, "height")
+      assert_in_maxgray_range(maxgray)  if maxgray
 
       result = {
         magic_number: magic_number,
@@ -114,10 +114,17 @@ module PNM
       raise PNM::ParserError, msg
     end
 
-    def self.assert_value(value, name)
-      return  if yield(value)
+    def self.assert_positive(value, name)
+      return  if value > 0
 
-      msg = "invalid #{name} value - `#{value}'"
+      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
+
+      msg = "invalid maxgray value - `#{value}'"
       raise PNM::ParserError, msg
     end
   end

data/lib/pnm/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module PNM
-  VERSION = "0.5.2"
-  DATE    = "2019-02-09"
+  VERSION = "0.6.1"
+  DATE    = "2022-05-09"
 end

data/lib/pnm.rb

@@ -34,11 +34,11 @@ require_relative "pnm/exceptions"
 #     pixels = [[ 0, 10, 20],
 #               [10, 20, 30]]
 #
-#     # optional settings
-#     options = { maxgray: 30, comment: "Test Image" }
-#
 #     # create the image object
-#     image = PNM.create(pixels, options)
+#     image = PNM.create(pixels)
+#
+#     # create the image with additional optional settings
+#     image = PNM.create(pixels, maxgray: 30, comment: "Test Image")
 #
 #     # retrieve some image properties
 #     image.info    # => "PGM 3x2 Grayscale"
@@ -56,10 +56,10 @@ require_relative "pnm/exceptions"
 # Write an image to a file:
 #
 #     image.write("test.pgm")
-#     image.write_with_extension("test")  # adds the correct file extension
+#     image.write("test", add_extension: true)  # adds the appropriate file extension
 #
-#     # use ASCII or "plain" format (default is binary)
-#     image.write("test.pgm", :ascii)
+#     # use ASCII or "plain" format (default is :binary)
+#     image.write("test.pgm", encoding: :ascii)
 #
 #     # write to an I/O stream
 #     File.open("test.pgm", "w") {|f| image.write(f) }
@@ -87,7 +87,7 @@ require_relative "pnm/exceptions"
 #
 # == Author
 #
-# Copyright (C) 2013-2019 Marcus Stollsteimer
+# Copyright (C) 2013-2022 Marcus Stollsteimer
 #
 # License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
 #
@@ -98,7 +98,7 @@ module PNM
   TAGLINE  = "create/read/write PNM image files (PBM, PGM, PPM)"
 
   COPYRIGHT = <<-TEXT.gsub(/^ +/, "")
-    Copyright (C) 2013-2019 Marcus Stollsteimer.
+    Copyright (C) 2013-2022 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]
@@ -143,10 +130,9 @@ module PNM
                Converter.binary2array(type, width, height, content[:data])
              end
 
-    options = { type: type, maxgray: maxgray }
-    options[:comment] = content[:comments].join("\n")  if content[:comments]
+    comment = content[:comments].join("\n")  if content[:comments]
 
-    create(pixels, options)
+    create(pixels, type: type, maxgray: maxgray, comment: comment)
   end
 
   # Creates an image from a two-dimensional array of bilevel,
@@ -162,7 +148,7 @@ module PNM
   #               corresponding to red, green, and blue (RGB);
   #               a value of 0 means that the color is turned off.
   #
-  # Optional settings that can be specified in the +options+ hash:
+  # Optional settings:
   #
   # +type+::    The type of the image (+:pbm+, +:pgm+, or +:ppm+).
   #             By explicitly setting +type+, PGM images can be
@@ -180,8 +166,8 @@ module PNM
   # +comment+:: A multiline comment string.
   #
   # Returns a PNM::Image object.
-  def self.create(pixels, options = {})
-    Image.create(pixels, options)
+  def self.create(pixels, type: nil, maxgray: nil, comment: nil)
+    Image.create(pixels, type: type, maxgray: maxgray, comment: comment)
   end
 
   # @private
@@ -192,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 = ">= 1.9.3"
-
-  s.add_development_dependency "minitest", ">= 5.0"
-  s.add_development_dependency "rake", ">= 10.0"
+  s.required_ruby_version = ">= 2.0.0"
 
   s.require_paths = ["lib"]
 

data/test/backports.rb

@@ -0,0 +1,19 @@
+# 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."
+  MiniTest::Spec.send(:include, PNM::Backports::Minitest)
+end

data/test/test_converter.rb

@@ -2,11 +2,13 @@
 
 # test_converter.rb: Unit tests for the PNM library.
 #
-# Copyright (C) 2013-2019 Marcus Stollsteimer
+# Copyright (C) 2013-2022 Marcus Stollsteimer
 
 require "minitest/autorun"
 require "pnm/converter"
 
+require_relative "backports"
+
 
 describe PNM::Converter do
 
@@ -56,7 +58,7 @@ describe PNM::Converter do
     data     = @pbm[:ascii]
     expected = @pbm[:array]
 
-    @converter.ascii2array(:pbm, width, height, data).must_equal expected
+    _(@converter.ascii2array(:pbm, width, height, data)).must_equal expected
   end
 
   it "can convert from ASCII encoded PGM data" do
@@ -65,7 +67,7 @@ describe PNM::Converter do
     data     = @pgm[:ascii]
     expected = @pgm[:array]
 
-    @converter.ascii2array(:pgm, width, height, data).must_equal expected
+    _(@converter.ascii2array(:pgm, width, height, data)).must_equal expected
   end
 
   it "can convert from ASCII encoded PPM data" do
@@ -74,7 +76,7 @@ describe PNM::Converter do
     data     = @ppm[:ascii]
     expected = @ppm[:array]
 
-    @converter.ascii2array(:ppm, width, height, data).must_equal expected
+    _(@converter.ascii2array(:ppm, width, height, data)).must_equal expected
   end
 
   it "accepts ASCII encoded PBM data with omitted whitespace" do
@@ -83,7 +85,7 @@ describe PNM::Converter do
     data     = "  010100\n000110"
     expected = [[0, 1, 0, 1], [0, 0, 0, 0], [0, 1, 1, 0]]
 
-    @converter.ascii2array(:pbm, width, height, data).must_equal expected
+    _(@converter.ascii2array(:pbm, width, height, data)).must_equal expected
   end
 
   it "accepts ASCII encoded PGM data with arbitrary whitespace" do
@@ -92,7 +94,7 @@ describe PNM::Converter do
     data     = "  \n 10 90\t170\r250\n90 \t170   250 \t\r\n\t 10\n\n\n170\n250\n10\n90\n"
     expected = [[10, 90, 170, 250], [90, 170, 250, 10], [170, 250, 10, 90]]
 
-    @converter.ascii2array(:pgm, width, height, data).must_equal expected
+    _(@converter.ascii2array(:pgm, width, height, data)).must_equal expected
   end
 
   it "can convert from binary encoded PBM data (width 6)" do
@@ -101,7 +103,7 @@ describe PNM::Converter do
     data     = @pbm6[:binary]
     expected = @pbm6[:array]
 
-    @converter.binary2array(:pbm, width, height, data).must_equal expected
+    _(@converter.binary2array(:pbm, width, height, data)).must_equal expected
   end
 
   it "can convert from binary encoded PBM data (width 14)" do
@@ -110,7 +112,7 @@ describe PNM::Converter do
     data     = @pbm14[:binary]
     expected = @pbm14[:array]
 
-    @converter.binary2array(:pbm, width, height, data).must_equal expected
+    _(@converter.binary2array(:pbm, width, height, data)).must_equal expected
   end
 
   it "can convert from binary encoded PGM data" do
@@ -119,7 +121,7 @@ describe PNM::Converter do
     data     = @pgm[:binary]
     expected = @pgm[:array]
 
-    @converter.binary2array(:pgm, width, height, data).must_equal expected
+    _(@converter.binary2array(:pgm, width, height, data)).must_equal expected
   end
 
   it "can convert from binary encoded PPM data" do
@@ -128,82 +130,83 @@ describe PNM::Converter do
     data     = @ppm[:binary]
     expected = @ppm[:array]
 
-    @converter.binary2array(:ppm, width, height, data).must_equal expected
+    _(@converter.binary2array(:ppm, width, height, data)).must_equal expected
   end
 
   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]
 
-    @converter.binary2array(:pbm, width, height, data).must_equal expected
+    refute_equal data, @pbm14[:binary]
+    _(@converter.binary2array(:pbm, width, height, data)).must_equal expected
   end
 
   it "can convert to ASCII encoded PBM data" do
     data     = @pbm[:array]
     expected = @pbm[:ascii]
 
-    @converter.array2ascii(data).must_equal expected
+    _(@converter.array2ascii(data)).must_equal expected
   end
 
   it "can convert to ASCII encoded PGM data" do
     data     = @pgm[:array]
     expected = @pgm[:ascii]
 
-    @converter.array2ascii(data).must_equal expected
+    _(@converter.array2ascii(data)).must_equal expected
   end
 
   it "can convert to ASCII encoded PPM data" do
     data     = @ppm[:array]
     expected = @ppm[:ascii]
 
-    @converter.array2ascii(data).must_equal expected
+    _(@converter.array2ascii(data)).must_equal expected
   end
 
   it "can convert to binary encoded PBM data (width 6)" do
     data     = @pbm6[:array]
     expected = @pbm6[:binary]
 
-    @converter.array2binary(:pbm, data).must_equal expected
+    _(@converter.array2binary(:pbm, data)).must_equal expected
   end
 
   it "can convert to binary encoded PBM data (width 14)" do
     data     = @pbm14[:array]
     expected = @pbm14[:binary]
 
-    @converter.array2binary(:pbm, data).must_equal expected
+    _(@converter.array2binary(:pbm, data)).must_equal expected
   end
 
   it "can convert to binary encoded PGM data" do
     data     = @pgm[:array]
     expected = @pgm[:binary]
 
-    @converter.array2binary(:pgm, data).must_equal expected
+    _(@converter.array2binary(:pgm, data)).must_equal expected
   end
 
   it "can convert to binary encoded PPM data" do
     data     = @ppm[:array]
     expected = @ppm[:binary]
 
-    @converter.array2binary(:ppm, data).must_equal expected
+    _(@converter.array2binary(:ppm, data)).must_equal expected
   end
 
   it "can calculate correct byte widths for a PBM image" do
-    @converter.byte_width(:pbm,  0).must_equal 0
-    @converter.byte_width(:pbm,  1).must_equal 1
-    @converter.byte_width(:pbm,  7).must_equal 1
-    @converter.byte_width(:pbm,  8).must_equal 1
-    @converter.byte_width(:pbm,  9).must_equal 2
-    @converter.byte_width(:pbm, 64).must_equal 8
-    @converter.byte_width(:pbm, 65).must_equal 9
+    _(@converter.byte_width(:pbm,  0)).must_equal 0
+    _(@converter.byte_width(:pbm,  1)).must_equal 1
+    _(@converter.byte_width(:pbm,  7)).must_equal 1
+    _(@converter.byte_width(:pbm,  8)).must_equal 1
+    _(@converter.byte_width(:pbm,  9)).must_equal 2
+    _(@converter.byte_width(:pbm, 64)).must_equal 8
+    _(@converter.byte_width(:pbm, 65)).must_equal 9
   end
 
   it "can calculate correct byte widths for a PGM image" do
-    @converter.byte_width(:pgm, 13).must_equal 13
+    _(@converter.byte_width(:pgm, 13)).must_equal 13
   end
 
   it "can calculate correct byte widths for a PPM image" do
-    @converter.byte_width(:ppm, 13).must_equal 39
+    _(@converter.byte_width(:ppm, 13)).must_equal 39
   end
 end