pnm 0.5.3 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a3dd7ccd09f9d5a2f16212910e8aba16f25c78648e965c42847a86bc057632e
-  data.tar.gz: 7f22c53142d2317692fa2e840a6b12758e39990123c1d297d9624abc26a71c4b
+  metadata.gz: b5d51775ecf00c43299084927b3ce8e0fb182127accb347f25806a840e7389a4
+  data.tar.gz: 0ac3e779bb1af09853cf6429fdb0fe5ec1a6d5e951eaf0f227e97e7c81b9f053
 SHA512:
-  metadata.gz: c7ca3afc52aac295f564ecb5222c1339ce9ae623db0213ee7c878d05591396d735a76e0a19d62acce0cb095802352ebd1f1442ea4a803c32aa2bc4d8bf169289
-  data.tar.gz: '08e3653dd113aabd4333c789a4077b95733a18f3422db4e6006e7f534692f365f35474791dfb6d8c66716bb5c6e16ced1f07e2fbf7b36e6ba2842a09911c00b1'
+  metadata.gz: aa8584a19eb7f6aad9513cc379a1700dfe9e1f5b9e58feaba2ae80e18c670050f9ba3fbd39f7528f3bad2bd59eb31ba491ae0f8673669454cbae92b4f996c416
+  data.tar.gz: 87e0d5751baa549e9f2f14be763d6b77a40bde876c23f9ee44df5ef8b1ec642024091e6d06e32172aef09e33323bca2cf5f1945e8cecf7e7aa9945629f448811

data/README.md

@@ -26,11 +26,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 +50,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) }
@@ -99,9 +99,8 @@ Requirements
 - PNM has been tested with
 
   - Ruby 2.7
-  - Ruby 2.6, 2.5, 2.4, 2.3, 2.2, 2.1, 2.0.0, 1.9.3,
-  - JRuby 9.2.9.0,
-  - Rubinius 2.5.2.
+  - Ruby 2.6, 2.5, 2.4, 2.3, 2.2, 2.1, 2.0.0,
+  - JRuby 9.2.13.0.
 
 Documentation
 -------------

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) }
@@ -143,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,
@@ -162,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
@@ -180,8 +179,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

data/lib/pnm/image.rb

@@ -38,19 +38,19 @@ 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]
+                  maxgray
                 end
 
       image_class = case type
@@ -62,7 +62,7 @@ module PNM
                       PPMImage
                     end
 
-      image_class.new(pixels, maxgray, options[:comment])
+      image_class.new(pixels, maxgray, comment)
     end
 
     class << self
@@ -87,12 +87,17 @@ 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)
+    def write(file, add_extension: false, encoding: :binary)
       content = if encoding == :ascii
                   to_ascii
                 elsif encoding == :binary
@@ -100,22 +105,14 @@ module PNM
                 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}"

data/lib/pnm/version.rb

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

data/pnm.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |s|
 
   s.license = "GPL-3.0"
 
-  s.required_ruby_version = ">= 1.9.3"
+  s.required_ruby_version = ">= 2.0.0"
 
   s.add_development_dependency "minitest", ">= 5.0"
   s.add_development_dependency "rake", ">= 10.0"

data/test/test_image.rb

@@ -132,61 +132,61 @@ describe PNM::Image do
   end
 
   it "can write a bilevel image to an ASCII encoded file" do
-    @bilevel.write(@temp_path, :ascii)
+    @bilevel.write(@temp_path, encoding: :ascii)
     _(File.binread(@temp_path)).must_equal File.binread("#{@srcpath}/bilevel_ascii.pbm")
     File.delete(@temp_path)
   end
 
   it "can write a bilevel image (width 5) to a binary encoded file" do
-    @bilevel.write(@temp_path, :binary)
+    @bilevel.write(@temp_path, encoding: :binary)
     _(File.binread(@temp_path)).must_equal File.binread("#{@srcpath}/bilevel_binary.pbm")
     File.delete(@temp_path)
   end
 
   it "can write a bilevel image (width 16) to a binary encoded file" do
-    @bilevel2.write(@temp_path, :binary)
+    @bilevel2.write(@temp_path, encoding: :binary)
     _(File.binread(@temp_path)).must_equal File.binread("#{@srcpath}/bilevel_2_binary.pbm")
     File.delete(@temp_path)
   end
 
   it "can write a grayscale image to an ASCII encoded file" do
-    @grayscale.write(@temp_path, :ascii)
+    @grayscale.write(@temp_path, encoding: :ascii)
     _(File.binread(@temp_path)).must_equal File.binread("#{@srcpath}/grayscale_ascii.pgm")
     File.delete(@temp_path)
   end
 
   it "can write a grayscale image to a binary encoded file" do
-    @grayscale.write(@temp_path, :binary)
+    @grayscale.write(@temp_path, encoding: :binary)
     _(File.binread(@temp_path)).must_equal File.binread("#{@srcpath}/grayscale_binary.pgm")
     File.delete(@temp_path)
   end
 
   it "can write a color image to an ASCII encoded file" do
-    @color.write(@temp_path, :ascii)
+    @color.write(@temp_path, encoding: :ascii)
     _(File.binread(@temp_path)).must_equal File.binread("#{@srcpath}/color_ascii.ppm")
     File.delete(@temp_path)
   end
 
   it "can write a color image to a binary encoded file" do
-    @color.write(@temp_path, :binary)
+    @color.write(@temp_path, encoding: :binary)
     _(File.binread(@temp_path)).must_equal File.binread("#{@srcpath}/color_binary.ppm")
     File.delete(@temp_path)
   end
 
   it "can write a bilevel image to a file, adding the extension" do
-    @bilevel.write_with_extension(@temp_path)
+    @bilevel.write(@temp_path, add_extension: true)
     _(File.binread("#{@temp_path}.pbm")).must_equal File.binread("#{@srcpath}/bilevel_binary.pbm")
     File.delete("#{@temp_path}.pbm")
   end
 
   it "can write a grayscale image to a file, adding the extension" do
-    @grayscale.write_with_extension(@temp_path, :ascii)
+    @grayscale.write(@temp_path, add_extension: true, encoding: :ascii)
     _(File.binread("#{@temp_path}.pgm")).must_equal File.binread("#{@srcpath}/grayscale_ascii.pgm")
     File.delete("#{@temp_path}.pgm")
   end
 
   it "can write a color image to a file, adding the extension" do
-    @color.write_with_extension(@temp_path, :binary)
+    @color.write(@temp_path, add_extension: true, encoding: :binary)
     _(File.binread("#{@temp_path}.ppm")).must_equal File.binread("#{@srcpath}/color_binary.ppm")
     File.delete("#{@temp_path}.ppm")
   end
@@ -204,27 +204,27 @@ describe PNM::Image do
   end
 
   it "can write binary data containing CRLF" do
-    @grayscale_crlf.write(@temp_path, :binary)
+    @grayscale_crlf.write(@temp_path, encoding: :binary)
     _(File.binread(@temp_path)).must_equal File.binread("#{@srcpath}/grayscale_binary_crlf.pgm")
     File.delete(@temp_path)
   end
 
   it "can write binary data containing CRLF to an I/O stream" do
-    File.open(@temp_path, "w") {|f| @grayscale_crlf.write(f, :binary) }
+    File.open(@temp_path, "w") {|f| @grayscale_crlf.write(f, encoding: :binary) }
     _(File.binread(@temp_path)).must_equal File.binread("#{@srcpath}/grayscale_binary_crlf.pgm")
     File.delete(@temp_path)
   end
 
   it "can write zero-length comments" do
     comment = ""
-    PNM.create([[0, 0]], comment: comment).write(@temp_path, :ascii)
+    PNM.create([[0, 0]], comment: comment).write(@temp_path, encoding: :ascii)
     _(File.binread(@temp_path)).must_equal "P1\n#\n2 1\n0 0\n"
     File.delete(@temp_path)
   end
 
   it "can write comments with trailing zero-length line" do
     comment = "An empty line:\n"
-    PNM.create([[0, 0]], comment: comment).write(@temp_path, :ascii)
+    PNM.create([[0, 0]], comment: comment).write(@temp_path, encoding: :ascii)
     _(File.binread(@temp_path)).must_equal "P1\n# An empty line:\n#\n2 1\n0 0\n"
     File.delete(@temp_path)
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pnm
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.6.0
 platform: ruby
 authors:
 - Marcus Stollsteimer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-19 00:00:00.000000000 Z
+date: 2020-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -89,7 +89,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="