pnm 0.5.1 → 0.5.2

data/lib/pnm/exceptions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PNM
 
   # Base class for all PNM exceptions.

data/lib/pnm/image.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PNM
 
   # Abstract base class for +PBM+, +PGM+, and +PPM+ images.
@@ -45,11 +47,11 @@ module PNM
       type ||= detect_type(pixels, options[:maxgray])
 
       # except for type detection, the maxgray option must be ignored for PBM
-      if type == :pbm
-        maxgray = nil
-      else
-        maxgray = options[:maxgray]
-      end
+      maxgray = if type == :pbm
+                  nil
+                else
+                  options[:maxgray]
+                end
 
       image_class = case type
                     when :pbm
@@ -97,7 +99,7 @@ module PNM
                   to_binary
                 end
 
-      if file.kind_of?(String)
+      if file.is_a?(String)
         File.binwrite(file, content)
       else
         file.binmode
@@ -119,7 +121,7 @@ module PNM
       "#{type.to_s.upcase} #{width}x#{height} #{type_string}"
     end
 
-    alias :to_s :info
+    alias to_s info
 
     # Returns a string representation for debugging.
     def inspect
@@ -135,28 +137,28 @@ module PNM
       type == other.type && maxgray == other.maxgray && comment == other.comment && pixels == other.pixels
     end
 
-    private
-
     def self.assert_valid_array(pixels)  # :nodoc:
       assert_array_dimensions(pixels)
       assert_pixel_types(pixels)
     end
+    private_class_method :assert_valid_array
 
     def self.assert_array_dimensions(pixels)  # :nodoc:
       msg = "invalid pixel data: Array expected"
-      raise PNM::ArgumentError, msg  unless Array === pixels
+      raise PNM::ArgumentError, msg  unless pixels.is_a?(Array)
 
       msg = "invalid pixel array"
-
       raise PNM::DataError, msg  unless pixels.map(&:class).uniq == [Array]
+
       width = pixels.first.size
-      raise PNM::DataError, msg  if width == 0
+      raise PNM::DataError, msg  if width.zero?
       raise PNM::DataError, msg  unless pixels.map(&:size).uniq == [width]
     end
+    private_class_method :assert_array_dimensions
 
     def self.assert_pixel_types(pixels)  # :nodoc:
       pixel_values = pixels.flatten(1)
-      is_color = (Array === pixel_values.first)
+      is_color = pixel_values.first.is_a?(Array)
 
       if is_color
         pixel_values.each {|pixel| assert_valid_color_pixel(pixel) }
@@ -164,43 +166,47 @@ module PNM
         pixel_values.each {|pixel| assert_valid_pixel(pixel) }
       end
     end
+    private_class_method :assert_pixel_types
 
     def self.assert_valid_pixel(pixel)  # :nodoc:
-      unless Integer === pixel
-        msg = "invalid pixel value: Integer expected - #{pixel.inspect}"
-        raise PNM::DataError, msg
-      end
+      return  if pixel.is_a?(Integer)
+
+      msg = "invalid pixel value: Integer expected - #{pixel.inspect}"
+      raise PNM::DataError, msg
     end
+    private_class_method :assert_valid_pixel
 
     def self.assert_valid_color_pixel(pixel)  # :nodoc:
-      unless Array === pixel && pixel.map {|p| Integer === p } == [true, true, true]
-        msg =  "invalid pixel value: "
-        msg << "Array of 3 Integers expected - #{pixel.inspect}"
+      return  if pixel.is_a?(Array) && pixel.size == 3 && pixel.all? {|p| p.is_a?(Integer) }
 
-        raise PNM::DataError, msg
-      end
+      msg =  "invalid pixel value: ".dup
+      msg << "Array of 3 Integers expected - #{pixel.inspect}"
+      raise PNM::DataError, msg
     end
+    private_class_method :assert_valid_color_pixel
 
     def self.assert_valid_maxgray(maxgray)  # :nodoc:
       return  unless maxgray
+      return  if maxgray.is_a?(Integer) && maxgray > 0 && maxgray <= 255
 
-      unless Integer === maxgray && maxgray > 0 && maxgray <= 255
-        raise PNM::ArgumentError, "invalid maxgray value - #{maxgray.inspect}"
-      end
+      msg = "invalid maxgray value - #{maxgray.inspect}"
+      raise PNM::ArgumentError, msg
     end
+    private_class_method :assert_valid_maxgray
 
     def self.assert_valid_comment(comment)  # :nodoc:
       return  unless comment
+      return  if comment.is_a?(String)
 
-      unless String === comment
-        raise PNM::ArgumentError, "invalid comment value - #{comment.inspect}"
-      end
+      msg = "invalid comment value - #{comment.inspect}"
+      raise PNM::ArgumentError, msg
     end
+    private_class_method :assert_valid_comment
 
     def self.sanitize_and_assert_valid_type(type)  # :nodoc:
       return  unless type
 
-      type = type.to_sym  if type.kind_of?(String)
+      type = type.to_sym  if type.is_a?(String)
 
       unless [:pbm, :pgm, :ppm].include?(type)
         msg = "invalid image type - #{type.inspect}"
@@ -209,9 +215,10 @@ module PNM
 
       type
     end
+    private_class_method :sanitize_and_assert_valid_type
 
     def self.detect_type(pixels, maxgray)  # :nodoc:
-      if pixels.first.first.kind_of?(Array)
+      if pixels.first.first.is_a?(Array)
         :ppm
       elsif (maxgray && maxgray > 1) || pixels.flatten.max > 1
         :pgm
@@ -219,25 +226,27 @@ module PNM
         :pbm
       end
     end
+    private_class_method :detect_type
+
+    private
 
     def assert_grayscale_data  # :nodoc:
-      if color_pixels?
-        msg = "specified type does not match RGB data - #{type.inspect}"
-        raise PNM::DataError, msg
-      end
+      return  unless color_pixels?
+
+      msg = "specified type does not match RGB data - #{type.inspect}"
+      raise PNM::DataError, msg
     end
 
     def assert_pixel_value_range  # :nodoc:
-      unless pixels.flatten.max <= maxgray
-        raise PNM::DataError, "invalid data: value(s) greater than maxgray"
-      end
-      unless pixels.flatten.min >= 0
-        raise PNM::DataError, "invalid data: value(s) less than zero"
-      end
+      msg = "invalid data: value(s) greater than maxgray"
+      raise PNM::DataError, msg  unless pixels.flatten.max <= maxgray
+
+      msg = "invalid data: value(s) less than zero"
+      raise PNM::DataError, msg  unless pixels.flatten.min >= 0
     end
 
     def header_without_maxgray(encoding)  # :nodoc:
-      header =  "#{PNM.magic_number[type][encoding]}\n"
+      header = "#{PNM.magic_number[type][encoding]}\n".dup
       comment_lines.each do |line|
         header << (line.empty? ? "#\n" : "# #{line}\n")
       end
@@ -252,7 +261,7 @@ module PNM
 
     def comment_lines  # :nodoc:
       return []    unless comment
-      return ['']  if comment.empty?
+      return [""]  if comment.empty?
 
       keep_trailing_null_fields = -1  # magic value for split limit
       comment.split(/\n/, keep_trailing_null_fields)
@@ -271,11 +280,11 @@ module PNM
     end
 
     def color_pixels?  # :nodoc:
-      (pixels.first.first).kind_of?(Array)
+      pixels.first.first.is_a?(Array)
     end
 
     def inspect_string_with_maxgray  # :nodoc:
-        "#<%s:0x%x %s, maxgray=%d>" % [self.class.name, object_id, info, maxgray]
+      "#<%s:0x%x %s, maxgray=%d>" % [self.class.name, object_id, info, maxgray]
     end
 
     def inspect_string_without_maxgray  # :nodoc:

data/lib/pnm/parser.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PNM
 
   # @private
@@ -26,8 +28,8 @@ module PNM
       until magic_number
         token = next_token!(content)
 
-        if token.start_with?('#')
-          comments << token.gsub(/# */, '')
+        if token.start_with?("#")
+          comments << token.gsub(/# */, "")
         else
           magic_number = token
         end
@@ -36,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.gsub!(/\A[ \t\r\n]+/, "")
         token = next_token!(content)
 
-        if token.start_with?('#')
-          comments << token.gsub(/# */, '')
+        if token.start_with?("#")
+          comments << token.gsub(/# */, "")
         else
           tokens << token
         end
@@ -61,10 +63,10 @@ module PNM
       assert_value(maxgray, "maxgray") {|x| x > 0 && x <= 255 }  if maxgray
 
       result = {
-        :magic_number => magic_number,
-        :width        => width,
-        :height       => height,
-        :data         => content
+        magic_number: magic_number,
+        width:        width,
+        height:       height,
+        data:         content
       }
       result[:maxgray]  = maxgray   if maxgray
       result[:comments] = comments  unless comments.empty?
@@ -74,24 +76,24 @@ module PNM
 
     def self.token_number
       {
-        'P1' => 2,
-        'P2' => 3,
-        'P3' => 3,
-        'P4' => 2,
-        'P5' => 3,
-        'P6' => 3
+        "P1" => 2,
+        "P2" => 3,
+        "P3" => 3,
+        "P4" => 2,
+        "P5" => 3,
+        "P6" => 3
       }
     end
 
     def self.next_token!(content)
-      delimiter = if content.start_with?('#')
+      delimiter = if content.start_with?("#")
                     "\n"
                   else
-                    %r{[ \t\r\n]|(?=#)}
+                    /[ \t\r\n]|(?=#)/
                   end
 
       token, rest = content.split(delimiter, 2)
-      raise PNM::ParserError, 'not enough tokens in file'  unless rest
+      raise PNM::ParserError, "not enough tokens in file"  unless rest
 
       content.replace(rest)
 
@@ -99,24 +101,24 @@ module PNM
     end
 
     def self.assert_valid_magic_number(magic_number)
-      unless %w{P1 P2 P3 P4 P5 P6}.include?(magic_number)
-        msg = "unknown magic number - `#{magic_number}'"
-        raise PNM::ParserError, msg
-      end
+      return  if %w[P1 P2 P3 P4 P5 P6].include?(magic_number)
+
+      msg = "unknown magic number - `#{magic_number}'"
+      raise PNM::ParserError, msg
     end
 
     def self.assert_integer(value_string, value_name)
-      unless /\A[0-9]+\Z/ === value_string
-        msg = "#{value_name} must be an integer - `#{value_string}'"
-        raise PNM::ParserError, msg
-      end
+      return  if value_string =~ /\A[0-9]+\Z/
+
+      msg = "#{value_name} must be an integer - `#{value_string}'"
+      raise PNM::ParserError, msg
     end
 
     def self.assert_value(value, name)
-      unless yield(value)
-        msg = "invalid #{name} value - `#{value}'"
-        raise PNM::ParserError, msg
-      end
+      return  if yield(value)
+
+      msg = "invalid #{name} value - `#{value}'"
+      raise PNM::ParserError, msg
     end
   end
 end

data/lib/pnm/version.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
+
 module PNM
-  VERSION  = '0.5.1'
-  DATE     = '2016-12-26'
+  VERSION = "0.5.2"
+  DATE    = "2019-02-09"
 end

data/pnm.gemspec

@@ -1,4 +1,6 @@
-require './lib/pnm'
+# frozen_string_literal: true
+
+require "./lib/pnm"
 
 version  = PNM::VERSION
 date     = PNM::DATE
@@ -6,40 +8,41 @@ homepage = PNM::HOMEPAGE
 tagline  = PNM::TAGLINE
 
 Gem::Specification.new do |s|
-  s.name              = 'pnm'
+  s.name              = "pnm"
   s.version           = version
   s.date              = date
 
-  s.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).'
+  s.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)."
   s.summary = "PNM - #{tagline}"
 
-  s.authors = ['Marcus Stollsteimer']
-  s.email = 'sto.mar@web.de'
+  s.authors = ["Marcus Stollsteimer"]
+  s.email = "sto.mar@web.de"
   s.homepage = homepage
 
-  s.license = 'GPL-3.0'
+  s.license = "GPL-3.0"
 
-  s.required_ruby_version = '>= 1.9.3'
+  s.required_ruby_version = ">= 1.9.3"
 
-  s.add_development_dependency 'rake', '>= 10.0'
-  s.add_development_dependency 'minitest', '>= 5.0'
+  s.add_development_dependency "minitest", ">= 5.0"
+  s.add_development_dependency "rake", ">= 10.0"
 
-  s.require_paths = ['lib']
+  s.require_paths = ["lib"]
 
-  s.test_files = Dir.glob('test/**/test_*.rb')
+  s.test_files = Dir.glob("test/**/test_*.rb")
 
-  s.files = %w{
+  s.files =
+    %w[
       README.md
       Rakefile
       pnm.gemspec
       .yardopts
-    } +
-    Dir.glob('{benchmark,lib,test}/**/*')
+    ] +
+    Dir.glob("{benchmark,lib,test}/**/*")
 
-  s.extra_rdoc_files = ['README.md']
-  s.rdoc_options = ['--charset=UTF-8', '--main=README.md']
+  s.extra_rdoc_files = ["README.md"]
+  s.rdoc_options = ["--charset=UTF-8", "--main=README.md"]
 end

data/test/test_converter.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 # test_converter.rb: Unit tests for the PNM library.
 #
-# Copyright (C) 2013-2016 Marcus Stollsteimer
+# Copyright (C) 2013-2019 Marcus Stollsteimer
 
-require 'minitest/autorun'
-require 'pnm/converter'
+require "minitest/autorun"
+require "pnm/converter"
 
 
 describe PNM::Converter do
@@ -11,43 +13,44 @@ describe PNM::Converter do
   before do
     @converter = PNM::Converter
 
-    @pbm6  = {
-               :width  => 6,
-               :height => 2,
-               :array  => [[0,1,0,0,1,1], [0,0,0,1,1,1]],
-               :ascii  => "0 1 0 0 1 1\n0 0 0 1 1 1\n",
-               :binary => ['4C1C'].pack('H*')
-             }
+    @pbm6 = {
+      width:  6,
+      height: 2,
+      array:  [[0, 1, 0, 0, 1, 1], [0, 0, 0, 1, 1, 1]],
+      ascii:  "0 1 0 0 1 1\n0 0 0 1 1 1\n",
+      binary: ["4C1C"].pack("H*")
+    }
 
     @pbm14 = {
-               :width  => 14,
-               :height => 2,
-               :array  => [[0,0,1,1,1,0,0,0,1,1,0,0,1,0], [0,1,0,1,1,0,1,1,1,0,1,1,1,1]],
-               :ascii  => "0 0 1 1 1 0 0 0 1 1 0 0 1 0\n0 1 0 1 1 0 1 1 1 0 1 1 1 1\n",
-               :binary => ['38C85BBC'].pack('H*')
-             }
+      width:  14,
+      height: 2,
+      array:  [[0, 0, 1, 1, 1, 0, 0, 0, 1, 1, 0, 0, 1, 0],
+               [0, 1, 0, 1, 1, 0, 1, 1, 1, 0, 1, 1, 1, 1]],
+      ascii:  "0 0 1 1 1 0 0 0 1 1 0 0 1 0\n0 1 0 1 1 0 1 1 1 0 1 1 1 1\n",
+      binary: ["38C85BBC"].pack("H*")
+    }
 
     @pbm = @pbm14
 
-    @pgm =   {
-               :width  => 4,
-               :height => 3,
-               :array  => [[0, 85, 170, 255], [85, 170, 255, 0], [170, 255, 0, 85]],
-               :ascii  => "0 85 170 255\n85 170 255 0\n170 255 0 85\n",
-               :binary => ['0055AAFF55AAFF00AAFF0055'].pack('H*')
-             }
-
-    @ppm =   {
-               :width  => 3,
-               :height => 2,
-               :array  => [[[0,128,255], [128,255,0], [255,0,128]],
-                           [[255,128,0], [128,0,255], [0,255,128]]],
-               :ascii  => "0 128 255 128 255 0 255 0 128\n255 128 0 128 0 255 0 255 128\n",
-               :binary => ['0080FF80FF00FF0080FF80008000FF00FF80'].pack('H*')
-             }
-  end
-
-  it 'can convert from ASCII encoded PBM data' do
+    @pgm = {
+      width:  4,
+      height: 3,
+      array:  [[0, 85, 170, 255], [85, 170, 255, 0], [170, 255, 0, 85]],
+      ascii:  "0 85 170 255\n85 170 255 0\n170 255 0 85\n",
+      binary: ["0055AAFF55AAFF00AAFF0055"].pack("H*")
+    }
+
+    @ppm = {
+      width:  3,
+      height: 2,
+      array:  [[[0, 128, 255], [128, 255, 0], [255, 0, 128]],
+               [[255, 128, 0], [128, 0, 255], [0, 255, 128]]],
+      ascii:  "0 128 255 128 255 0 255 0 128\n255 128 0 128 0 255 0 255 128\n",
+      binary: ["0080FF80FF00FF0080FF80008000FF00FF80"].pack("H*")
+    }
+  end
+
+  it "can convert from ASCII encoded PBM data" do
     width    = @pbm[:width]
     height   = @pbm[:height]
     data     = @pbm[:ascii]
@@ -56,7 +59,7 @@ describe PNM::Converter do
     @converter.ascii2array(:pbm, width, height, data).must_equal expected
   end
 
-  it 'can convert from ASCII encoded PGM data' do
+  it "can convert from ASCII encoded PGM data" do
     width    = @pgm[:width]
     height   = @pgm[:height]
     data     = @pgm[:ascii]
@@ -65,7 +68,7 @@ describe PNM::Converter do
     @converter.ascii2array(:pgm, width, height, data).must_equal expected
   end
 
-  it 'can convert from ASCII encoded PPM data' do
+  it "can convert from ASCII encoded PPM data" do
     width    = @ppm[:width]
     height   = @ppm[:height]
     data     = @ppm[:ascii]
@@ -74,7 +77,7 @@ describe PNM::Converter do
     @converter.ascii2array(:ppm, width, height, data).must_equal expected
   end
 
-  it 'accepts ASCII encoded PBM data with omitted whitespace' do
+  it "accepts ASCII encoded PBM data with omitted whitespace" do
     width    = 4
     height   = 3
     data     = "  010100\n000110"
@@ -83,7 +86,7 @@ describe PNM::Converter do
     @converter.ascii2array(:pbm, width, height, data).must_equal expected
   end
 
-  it 'accepts ASCII encoded PGM data with arbitrary whitespace' do
+  it "accepts ASCII encoded PGM data with arbitrary whitespace" do
     width    = 4
     height   = 3
     data     = "  \n 10 90\t170\r250\n90 \t170   250 \t\r\n\t 10\n\n\n170\n250\n10\n90\n"
@@ -92,7 +95,7 @@ describe PNM::Converter do
     @converter.ascii2array(:pgm, width, height, data).must_equal expected
   end
 
-  it 'can convert from binary encoded PBM data (width 6)' do
+  it "can convert from binary encoded PBM data (width 6)" do
     width    = @pbm6[:width]
     height   = @pbm6[:height]
     data     = @pbm6[:binary]
@@ -101,7 +104,7 @@ describe PNM::Converter do
     @converter.binary2array(:pbm, width, height, data).must_equal expected
   end
 
-  it 'can convert from binary encoded PBM data (width 14)' do
+  it "can convert from binary encoded PBM data (width 14)" do
     width    = @pbm14[:width]
     height   = @pbm14[:height]
     data     = @pbm14[:binary]
@@ -110,7 +113,7 @@ describe PNM::Converter do
     @converter.binary2array(:pbm, width, height, data).must_equal expected
   end
 
-  it 'can convert from binary encoded PGM data' do
+  it "can convert from binary encoded PGM data" do
     width    = @pgm[:width]
     height   = @pgm[:height]
     data     = @pgm[:binary]
@@ -119,7 +122,7 @@ describe PNM::Converter do
     @converter.binary2array(:pgm, width, height, data).must_equal expected
   end
 
-  it 'can convert from binary encoded PPM data' do
+  it "can convert from binary encoded PPM data" do
     width    = @ppm[:width]
     height   = @ppm[:height]
     data     = @ppm[:binary]
@@ -128,7 +131,7 @@ describe PNM::Converter do
     @converter.binary2array(:ppm, width, height, data).must_equal expected
   end
 
-  it 'accepts an additional whitespace character for binary encoded data' do
+  it "accepts an additional whitespace character for binary encoded data" do
     width    = @pbm14[:width]
     height   = @pbm14[:height]
     data     = @pbm14[:binary] + "\t"
@@ -137,56 +140,56 @@ describe PNM::Converter do
     @converter.binary2array(:pbm, width, height, data).must_equal expected
   end
 
-  it 'can convert to ASCII encoded PBM data' do
+  it "can convert to ASCII encoded PBM data" do
     data     = @pbm[:array]
     expected = @pbm[:ascii]
 
     @converter.array2ascii(data).must_equal expected
   end
 
-  it 'can convert to ASCII encoded PGM data' do
+  it "can convert to ASCII encoded PGM data" do
     data     = @pgm[:array]
     expected = @pgm[:ascii]
 
     @converter.array2ascii(data).must_equal expected
   end
 
-  it 'can convert to ASCII encoded PPM data' do
+  it "can convert to ASCII encoded PPM data" do
     data     = @ppm[:array]
     expected = @ppm[:ascii]
 
     @converter.array2ascii(data).must_equal expected
   end
 
-  it 'can convert to binary encoded PBM data (width 6)' do
+  it "can convert to binary encoded PBM data (width 6)" do
     data     = @pbm6[:array]
     expected = @pbm6[:binary]
 
     @converter.array2binary(:pbm, data).must_equal expected
   end
 
-  it 'can convert to binary encoded PBM data (width 14)' do
+  it "can convert to binary encoded PBM data (width 14)" do
     data     = @pbm14[:array]
     expected = @pbm14[:binary]
 
     @converter.array2binary(:pbm, data).must_equal expected
   end
 
-  it 'can convert to binary encoded PGM data' do
+  it "can convert to binary encoded PGM data" do
     data     = @pgm[:array]
     expected = @pgm[:binary]
 
     @converter.array2binary(:pgm, data).must_equal expected
   end
 
-  it 'can convert to binary encoded PPM data' do
+  it "can convert to binary encoded PPM data" do
     data     = @ppm[:array]
     expected = @ppm[:binary]
 
     @converter.array2binary(:ppm, data).must_equal expected
   end
 
-  it 'can calculate correct byte widths for a PBM image' do
+  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
@@ -196,11 +199,11 @@ describe PNM::Converter do
     @converter.byte_width(:pbm, 65).must_equal 9
   end
 
-  it 'can calculate correct byte widths for a PGM image' do
+  it "can calculate correct byte widths for a PGM image" do
     @converter.byte_width(:pgm, 13).must_equal 13
   end
 
-  it 'can calculate correct byte widths for a PPM image' do
+  it "can calculate correct byte widths for a PPM image" do
     @converter.byte_width(:ppm, 13).must_equal 39
   end
 end