pnm 0.5.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: dc9dad70777226b16da4d7039a1321372519e048
-  data.tar.gz: 0e7d6f07393f439bc0a644aa8fb54e147142ec2c
+SHA256:
+  metadata.gz: 66de49354358fed31c8299381599bb8b16d87d2143e2102ca61da00e6b8b2927
+  data.tar.gz: 2bd7e0d7491be12b5562c3a1de19ee7e538d95c3535fc9bb92723726b5e5787c
 SHA512:
-  metadata.gz: 3445e084ae5d392516e8a169e1b5f2340537447fce806969cf5e1c3ff882b9c140b0bb592a57106fd277e289e3f3bbba40b8f13868637b6cd73e3d42f39440dc
-  data.tar.gz: 051ead6ff5724ce49cc21bf66c9087cc5a60c10a94edac62907a700b29f13829f92b1d3a3413c78c8dbfc03b3e63c0deb17b20165b988ed959f2573dee384709
+  metadata.gz: bd83d15feb8b65b28b43f64cd48ab23a5e3f710a991f781c43d6d74bc9ea9a02cb905d61bae70af1fe2476c551ece310050eccd0210acb5701d87efb40d61173
+  data.tar.gz: 574e62b56e1ac1fea7a9110f1c01c805f373bfafd50210bb2145fca4086054d7d1ace113d1e46eadfe0b5c9314b3ca221168cdc2dba2e7168742615a7462e728

data/README.md

@@ -27,7 +27,7 @@ pixels = [[ 0, 10, 20],
           [10, 20, 30]]
 
 # optional settings
-options = {:maxgray => 30, :comment => "Test Image"}
+options = { maxgray: 30, comment: "Test Image" }
 
 # create the image object
 image = PNM.create(pixels, options)
@@ -71,7 +71,7 @@ image.pixels   # => [[0, 10, 20], [10, 20, 30]]
 Force an image type:
 
 ``` ruby
-color_image = PNM.create([[0, 1],[1, 0]], :type => :ppm)
+color_image = PNM.create([[0, 1],[1, 0]], type: :ppm)
 color_image.info  # => "PPM 2x2 Color"
 ```
 
@@ -98,10 +98,7 @@ Requirements
 
 - PNM has been tested with
 
-  - Ruby 2.4,
-  - Ruby 2.3,
-  - Ruby 2.2,
-  - Ruby 2.1,
+  - 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,
@@ -121,7 +118,7 @@ Report bugs on the PNM home page: <https://github.com/stomar/pnm/>
 License
 -------
 
-Copyright &copy; 2013-2016 Marcus Stollsteimer
+Copyright &copy; 2013-2019 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-2016 Marcus Stollsteimer
+# Copyright (C) 2013-2019 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-2016 Marcus Stollsteimer
+# Copyright (C) 2013-2019 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,
@@ -33,7 +35,7 @@ require_relative 'pnm/exceptions'
 #               [10, 20, 30]]
 #
 #     # optional settings
-#     options = {:maxgray => 30, :comment => "Test Image"}
+#     options = { maxgray: 30, comment: "Test Image" }
 #
 #     # create the image object
 #     image = PNM.create(pixels, options)
@@ -71,7 +73,7 @@ require_relative 'pnm/exceptions'
 #
 # Force an image type:
 #
-#     color_image = PNM.create([[0, 1],[1, 0]], :type => :ppm)
+#     color_image = PNM.create([[0, 1],[1, 0]], type: :ppm)
 #     color_image.info  # => "PPM 2x2 Color"
 #
 # Check equality of two images:
@@ -85,28 +87,28 @@ require_relative 'pnm/exceptions'
 #
 # == Author
 #
-# Copyright (C) 2013-2016 Marcus Stollsteimer
+# Copyright (C) 2013-2019 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-2016 Marcus Stollsteimer.
+  COPYRIGHT = <<-TEXT.gsub(/^ +/, "")
+    Copyright (C) 2013-2019 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
@@ -117,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]
@@ -147,7 +143,7 @@ module PNM
                Converter.binary2array(type, width, height, content[:data])
              end
 
-    options = {:type => type, :maxgray => maxgray}
+    options = { type: type, maxgray: maxgray }
     options[:comment] = content[:comments].join("\n")  if content[:comments]
 
     create(pixels, options)
@@ -191,9 +187,9 @@ module PNM
   # @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
-    rescue ::ArgumentError => e
-      if e.message.start_with?('invalid value for Integer')
-        raise PNM::DataError, "invalid pixel value: Integer expected"
-      else
-        raise
-      end
+      values_as_string.map {|value| Integer(value) }
+    rescue ::ArgumentError => error
+      raise  unless error.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