pnm 0.4.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c8d01685f2bc40a0f3f6a862f25e2c6001d8f6a3
-  data.tar.gz: 2817af37b0e92b2daa766334fa9363c8ca953315
+SHA256:
+  metadata.gz: b5d51775ecf00c43299084927b3ce8e0fb182127accb347f25806a840e7389a4
+  data.tar.gz: 0ac3e779bb1af09853cf6429fdb0fe5ec1a6d5e951eaf0f227e97e7c81b9f053
 SHA512:
-  metadata.gz: 1dd632513336784b890a6d7c2c81717bcabf12f511f0cdff8b9d93ee38bfbf3ffd1e5cd29463830ea4e190973d147bddc5d9bd297c6aec7dec4ffef670efbea9
-  data.tar.gz: 9051a2ec9005e3100f56b2363c311d4fef8626458b1d0a99c0cd0d3c3c22b1417725ec3cbe34a7f802118f5665582c594deae2b3c4194d6da4fb124eb59a8c98
+  metadata.gz: aa8584a19eb7f6aad9513cc379a1700dfe9e1f5b9e58feaba2ae80e18c670050f9ba3fbd39f7528f3bad2bd59eb31ba491ae0f8673669454cbae92b4f996c416
+  data.tar.gz: 87e0d5751baa549e9f2f14be763d6b77a40bde876c23f9ee44df5ef8b1ec642024091e6d06e32172aef09e33323bca2cf5f1945e8cecf7e7aa9945629f448811

data/README.md

@@ -20,17 +20,17 @@ Examples
 Create a PGM grayscale image from a two-dimensional array of gray values:
 
 ``` ruby
-require 'pnm'
+require "pnm"
 
 # pixel data
 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"
@@ -49,19 +49,20 @@ and available options.
 Write an image to a file:
 
 ``` ruby
-image.write('test.pgm')
+image.write("test.pgm")
+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) }
+File.open("test.pgm", "w") {|f| image.write(f) }
 ```
 
 Read an image from a file (returns a PNM::Image object):
 
 ``` ruby
-image = PNM.read('test.pgm')
+image = PNM.read("test.pgm")
 image.comment  # => "Test Image"
 image.maxgray  # => 30
 image.pixels   # => [[0, 10, 20], [10, 20, 30]]
@@ -70,8 +71,14 @@ image.pixels   # => [[0, 10, 20], [10, 20, 30]]
 Force an image type:
 
 ``` ruby
-image = PNM.create([[0, 1],[1, 0]], :type => :ppm)
-image.info  # => "PPM 2x2 Color"
+color_image = PNM.create([[0, 1],[1, 0]], type: :ppm)
+color_image.info  # => "PPM 2x2 Color"
+```
+
+Check equality of two images:
+
+``` ruby
+color_image == image  # => false
 ```
 
 Installation
@@ -91,17 +98,15 @@ Requirements
 
 - PNM has been tested with
 
-  - Ruby 2.2,
-  - Ruby 2.1,
-  - Ruby 2.0.0,
-  - Ruby 1.9.3,
-  - JRuby 1.7.18,
-  - Rubinius 2.2.10.
+  - Ruby 2.7
+  - Ruby 2.6, 2.5, 2.4, 2.3, 2.2, 2.1, 2.0.0,
+  - JRuby 9.2.13.0.
 
 Documentation
 -------------
 
-Documentation should be available via `ri PNM`.
+Documentation should be available via `ri PNM` or can be found at
+[www.rubydoc.info/gems/pnm/](http://www.rubydoc.info/gems/pnm/).
 
 Reporting bugs
 --------------
@@ -111,7 +116,7 @@ Report bugs on the PNM home page: <https://github.com/stomar/pnm/>
 License
 -------
 
-Copyright &copy; 2013-2015 Marcus Stollsteimer
+Copyright &copy; 2013-2020 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,34 +1,35 @@
+# frozen_string_literal: true
+
 # rakefile for the PNM library.
 #
-# Copyright (C) 2013-2015 Marcus Stollsteimer
+# Copyright (C) 2013-2020 Marcus Stollsteimer
 
-require 'rake/testtask'
+require "rake/testtask"
 
-require_relative 'lib/pnm'
+require_relative "lib/pnm"
 
 
 def gemspec_file
-  'pnm.gemspec'
+  "pnm.gemspec"
 end
 
 
-task :default => [:test]
+task default: :test
 
 Rake::TestTask.new do |t|
-  t.pattern = 'test/**/test_*.rb'
-  t.ruby_opts << '-rubygems'
+  t.pattern = "test/**/test_*.rb"
   t.verbose = true
   t.warning = true
 end
 
 
-desc 'Run benchmarks'
+desc "Run benchmarks"
 task :benchmark do
-  Dir['benchmark/**/bm_*.rb'].each {|f| require_relative f }
+  Dir["benchmark/**/bm_*.rb"].each {|f| require_relative f }
 end
 
 
-desc 'Build gem'
+desc "Build gem"
 task :build do
   sh "gem build #{gemspec_file}"
 end

data/benchmark/bm_converter.rb

@@ -1,11 +1,14 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
 # bm_converter.rb: Benchmarks for the PNM library.
 #
-# Copyright (C) 2013-2015 Marcus Stollsteimer
+# Copyright (C) 2013-2020 Marcus Stollsteimer
 
-require 'benchmark'
-require_relative '../lib/pnm'
+require "benchmark"
+require_relative "../lib/pnm"
 
+# Benchmarks for PNM::Converter.
 class ConverterBenchmark
 
   def initialize
@@ -14,7 +17,7 @@ class ConverterBenchmark
 
     @srcpath = File.dirname(__FILE__)
 
-    print 'Initializing test data...'
+    print "Initializing test data..."
     @pbm_image = PNM.read(File.expand_path("#{@srcpath}/random_image.pbm"))
     @pgm_image = PNM.read(File.expand_path("#{@srcpath}/random_image.pgm"))
     @ppm_image = PNM.read(File.expand_path("#{@srcpath}/random_image.ppm"))
@@ -32,7 +35,7 @@ class ConverterBenchmark
     run_benchmark(@pgm_image)
     run_benchmark(@ppm_image)
 
-    puts "\nTotal:               " <<
+    puts "\nTotal:               ".dup <<
          @user.round(2).to_s.ljust(11) <<
          @system.round(2).to_s.ljust(11) <<
          @total.round(2).to_s
@@ -40,43 +43,44 @@ class ConverterBenchmark
 
   def run_benchmark(image)
     type   = image.type
-    type_string = type.upcase
     width  = image.width
     height = image.height
     array  = image.pixels
     ascii  = PNM::Converter.array2ascii(array)
     binary = PNM::Converter.array2binary(type, array)
+    type_string = type.upcase
 
     puts
 
     Benchmark.bm(18) do |bm|
-      bm.report("#{type_string} / ascii2array") {
+
+      bm.report("#{type_string} / ascii2array") do
         @repetitions.times do
           PNM::Converter.ascii2array(type, width, height, ascii)
         end
-      }
+      end
 
-      bm.report("#{type_string} / array2ascii") {
+      bm.report("#{type_string} / array2ascii") do
         @repetitions.times do
           PNM::Converter.array2ascii(array)
         end
-      }
+      end
 
-      bm.report("#{type_string} / binary2array") {
+      bm.report("#{type_string} / binary2array") do
         @repetitions.times do
           PNM::Converter.binary2array(type, width, height, binary)
         end
-      }
+      end
 
-      bm.report("#{type_string} / array2binary") {
+      bm.report("#{type_string} / array2binary") do
         @repetitions.times do
           PNM::Converter.array2binary(type, array)
         end
-      }
+      end
 
-      @user   += bm.list.map {|tms| tms.utime }.reduce(:+)
-      @system += bm.list.map {|tms| tms.stime }.reduce(:+)
-      @total  += bm.list.map {|tms| tms.total }.reduce(:+)
+      @user   += bm.list.map(&:utime).reduce(:+)
+      @system += bm.list.map(&:stime).reduce(:+)
+      @total  += bm.list.map(&:total).reduce(:+)
     end
   end
 end

data/lib/pnm.rb

@@ -1,12 +1,14 @@
+# frozen_string_literal: true
+
 # = pnm.rb - create/read/write PNM image files (PBM, PGM, PPM)
 #
 # See PNM module for documentation.
 
-require_relative 'pnm/version'
-require_relative 'pnm/image'
-require_relative 'pnm/parser'
-require_relative 'pnm/converter'
-require_relative 'pnm/exceptions'
+require_relative "pnm/version"
+require_relative "pnm/image"
+require_relative "pnm/parser"
+require_relative "pnm/converter"
+require_relative "pnm/exceptions"
 
 
 # PNM is a pure Ruby library for creating, reading,
@@ -26,17 +28,17 @@ require_relative 'pnm/exceptions'
 #
 # Create a PGM grayscale image from a two-dimensional array of gray values:
 #
-#     require 'pnm'
+#     require "pnm"
 #
 #     # pixel data
 #     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"
@@ -53,25 +55,30 @@ require_relative 'pnm/exceptions'
 #
 # Write an image to a file:
 #
-#     image.write('test.pgm')
+#     image.write("test.pgm")
+#     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) }
+#     File.open("test.pgm", "w") {|f| image.write(f) }
 #
 # Read an image from a file (returns a PNM::Image object):
 #
-#     image = PNM.read('test.pgm')
+#     image = PNM.read("test.pgm")
 #     image.comment  # => "Test Image"
 #     image.maxgray  # => 30
 #     image.pixels   # => [[0, 10, 20], [10, 20, 30]]
 #
 # Force an image type:
 #
-#     image = PNM.create([[0, 1],[1, 0]], :type => :ppm)
-#     image.info  # => "PPM 2x2 Color"
+#     color_image = PNM.create([[0, 1],[1, 0]], type: :ppm)
+#     color_image.info  # => "PPM 2x2 Color"
+#
+# Check equality of two images:
+#
+#     color_image == image  # => false
 #
 # == See also
 #
@@ -80,28 +87,28 @@ require_relative 'pnm/exceptions'
 #
 # == Author
 #
-# Copyright (C) 2013-2015 Marcus Stollsteimer
+# Copyright (C) 2013-2020 Marcus Stollsteimer
 #
 # License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
 #
 module PNM
 
-  LIBNAME  = 'pnm'
-  HOMEPAGE = 'https://github.com/stomar/pnm'
-  TAGLINE  = 'create/read/write PNM image files (PBM, PGM, PPM)'
+  LIBNAME  = "pnm"
+  HOMEPAGE = "https://github.com/stomar/pnm"
+  TAGLINE  = "create/read/write PNM image files (PBM, PGM, PPM)"
 
-  COPYRIGHT = <<-copyright.gsub(/^ +/, '')
-    Copyright (C) 2013-2015 Marcus Stollsteimer.
+  COPYRIGHT = <<-TEXT.gsub(/^ +/, "")
+    Copyright (C) 2013-2020 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.
-  copyright
+  TEXT
 
   # Reads an image from +file+ (a filename or an IO object).
   #
   # Returns a PNM::Image object.
   def self.read(file)
-    if file.kind_of?(String)
+    if file.is_a?(String)
       raw_data = File.binread(file)
     elsif file.respond_to?(:binmode)
       file.binmode
@@ -112,26 +119,20 @@ module PNM
 
     content = Parser.parse(raw_data)
 
-    case content[:magic_number]
-    when 'P1'
-      type = :pbm
-      encoding = :ascii
-    when 'P2'
-      type = :pgm
-      encoding = :ascii
-    when 'P3'
-      type = :ppm
-      encoding = :ascii
-    when 'P4'
-      type = :pbm
-      encoding = :binary
-    when 'P5'
-      type = :pgm
-      encoding = :binary
-    when 'P6'
-      type = :ppm
-      encoding = :binary
-    end
+    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
 
     width   = content[:width]
     height  = content[:height]
@@ -142,10 +143,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,
@@ -161,7 +161,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
@@ -179,16 +179,16 @@ 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
   def self.magic_number  # :nodoc:
     {
-      :pbm => {:ascii => 'P1', :binary => 'P4'},
-      :pgm => {:ascii => 'P2', :binary => 'P5'},
-      :ppm => {:ascii => 'P3', :binary => 'P6'}
+      pbm: { ascii: "P1", binary: "P4" },
+      pgm: { ascii: "P2", binary: "P5" },
+      ppm: { ascii: "P3", binary: "P6" }
     }
   end
 end

data/lib/pnm/converter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PNM
 
   # @private
@@ -30,12 +32,12 @@ module PNM
       values = convert_to_integers(data, type)
       assert_data_size(values.size, values_per_row * height)
 
-      case type
-      when :pbm, :pgm
-        pixel_matrix = values.each_slice(width).to_a
-      when :ppm
-        pixel_matrix = values.each_slice(3 * width).map {|row| row.each_slice(3).to_a }
-      end
+      pixel_matrix = case type
+                     when :pbm, :pgm
+                       values.each_slice(width).to_a
+                     when :ppm
+                       values.each_slice(3 * width).map {|row| row.each_slice(3).to_a }
+                     end
 
       pixel_matrix
     end
@@ -49,22 +51,21 @@ module PNM
     # Returns a two-dimensional array of bilevel, gray, or RGB values.
     def self.binary2array(type, width, height, data)
       bytes_per_row = byte_width(type, width)
+      expected_size = bytes_per_row * height
 
-      if data.size == bytes_per_row * height + 1 && data[-1] =~ /[ \t\r\n]/
-        data.slice!(-1)
-      end
+      data.slice!(-1)  if data.size == expected_size + 1 && data[-1] =~ /[ \t\r\n]/
 
-      assert_data_size(data.size, bytes_per_row * height)
+      assert_data_size(data.size, expected_size)
 
-      case type
-      when :pbm
-        rows = data.scan(/.{#{bytes_per_row}}/m)
-        pixel_matrix = rows.map {|row| row.unpack('B*').first[0, width].each_char.map {|char| char.to_i } }
-      when :pgm
-        pixel_matrix = data.each_byte.each_slice(bytes_per_row).to_a
-      when :ppm
-        pixel_matrix = data.each_byte.each_slice(bytes_per_row).map {|row| row.each_slice(3).to_a }
-      end
+      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) }
+                     when :pgm
+                       data.each_byte.each_slice(bytes_per_row).to_a
+                     when :ppm
+                       data.each_byte.each_slice(bytes_per_row).map {|row| row.each_slice(3).to_a }
+                     end
 
       pixel_matrix
     end
@@ -75,12 +76,12 @@ module PNM
     #
     # Returns a string containing the pixel data in ASCII format.
     def self.array2ascii(data)
-      case data.first.first
-      when Array
-        data_string = data.map {|row| row.flatten.join(' ') }.join("\n")
-      else
-        data_string = data.map {|row| row.join(' ') }.join("\n")
-      end
+      data_string = case data.first.first
+                    when Array
+                      data.map {|row| row.flatten.join(" ") }.join("\n")
+                    else
+                      data.map {|row| row.join(" ") }.join("\n")
+                    end
 
       data_string << "\n"
     end
@@ -94,38 +95,34 @@ module PNM
     def self.array2binary(type, data)
       height = data.size
 
-      if type == :pbm
-        binary_rows = data.map {|row| row.join }
-        data_string = binary_rows.pack('B*' * height)
-      else
-        data_string = data.flatten.pack('C*')
-      end
+      data_string = if type == :pbm
+                      binary_rows = data.map(&:join)
+                      binary_rows.pack("B*" * height)
+                    else
+                      data.flatten.pack("C*")
+                    end
 
       data_string
     end
 
     def self.convert_to_integers(data, type)
-      if type == :pbm
-        values_as_string = data.gsub(/[ \t\r\n]+/, '').split('')
-      else
-        values_as_string = data.gsub(/\A[ \t\r\n]+/, '').split(/[ \t\r\n]+/)
-      end
+      values_as_string = if type == :pbm
+                           data.gsub(/[ \t\r\n]+/, "").split("")
+                         else
+                           data.gsub(/\A[ \t\r\n]+/, "").split(/[ \t\r\n]+/)
+                         end
 
-      values_as_string.map do |value|
-        Integer(value)
-      end
+      values_as_string.map {|value| Integer(value) }
     rescue ::ArgumentError => e
-      if e.message.start_with?('invalid value for Integer')
-        raise PNM::DataError, "invalid pixel value: Integer expected"
-      else
-        raise
-      end
+      raise  unless e.message.start_with?("invalid value for Integer")
+
+      raise PNM::DataError, "invalid pixel value: Integer expected"
     end
 
     def self.assert_data_size(actual, expected)
-      unless actual == expected
-        raise PNM::DataSizeError, 'data size does not match expected size'
-      end
+      return  if actual == expected
+
+      raise PNM::DataSizeError, "data size does not match expected size"
     end
   end
 end