pnm 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ef19db0d86c0c55bca6a6b6c3f9a5d4eaaac62f6
-  data.tar.gz: ffa665ee3688f90f201045230818b97dd5c11b22
+  metadata.gz: 41d0847dab61302cfee794dd2547bc4a2f05df11
+  data.tar.gz: 76a61a9dbeea6ade821e0a1beeb45207b74fa673
 SHA512:
-  metadata.gz: b8ff711e119c0950b4d249c9171735b0baf8e5c9401e10e8160e047def08df4d53f1db203be41a7220bd5e6a09945e56e308141fa23877b059b4242097916be7
-  data.tar.gz: 18d891b4969653b32f4d7d5c253a673479c14fcc3b53ea918b282528737a108714463538150552886d39ee61ae777f99c9950a23333869564262c26ca3e43212
+  metadata.gz: b19271212932a8f0e0a6ee573076cd119468fb885bd481f10c45eb9ad15f7ceee75ad0f81be925aec05ab7366ef6a3e87267489a55402673c1b4703744122939
+  data.tar.gz: 473810c88249b863763ff8f7e8733e0352c24765ff5d07b5372ffb8fbb136c6a05c79093193f4f983fc39cf08f5764ec37e2f05f5d68324a1933c194f9aaca4b

data/README.md

@@ -8,6 +8,12 @@ and writing of `PNM` image files (Portable Anymap):
 - `PGM` (Portable Graymap), and
 - `PPM` (Portable Pixmap).
 
+It is a portable and lightweight utility for exporting or importing
+of raw pixel data to or from an image file format that can be processed
+by most image manipulation programs.
+
+PNM comes without any dependencies on other gems or native libraries.
+
 Examples
 --------
 
@@ -32,6 +38,10 @@ image.width   # => 3
 image.height  # => 2
 ```
 
+Note that for PBM bilevel images a pixel value of 0 signifies white
+(and 1 signifies black), whereas for PGM and PPM images a value of 0
+signifies black.
+
 See PNM::Image.new for a more detailed description of pixel data formats
 and available options.
 
@@ -80,11 +90,11 @@ Requirements
 
 - PNM has been tested with
 
-  - Ruby 2.1.0,
+  - Ruby 2.1.3,
   - Ruby 2.0.0 on Linux and on Windows,
   - Ruby 1.9.3,
-  - JRuby 1.7.10,
-  - Rubinius 2.2.4.
+  - JRuby 1.7.16,
+  - Rubinius 2.2.10.
 
 Documentation
 -------------

data/lib/pnm.rb

@@ -16,6 +16,12 @@ require_relative 'pnm/exceptions'
 # - +PGM+ (Portable Graymap), and
 # - +PPM+ (Portable Pixmap).
 #
+# It is a portable and lightweight utility for exporting or importing
+# of raw pixel data to or from an image file format that can be processed
+# by most image manipulation programs.
+#
+# PNM comes without any dependencies on other gems or native libraries.
+#
 # == Examples
 #
 # Create a PGM grayscale image from a two-dimensional array of gray values:
@@ -37,6 +43,10 @@ require_relative 'pnm/exceptions'
 #     image.width   # => 3
 #     image.height  # => 2
 #
+# Note that for PBM bilevel images a pixel value of 0 signifies white
+# (and 1 signifies black), whereas for PGM and PPM images a value of 0
+# signifies black.
+#
 # See PNM::Image.new for a more detailed description of pixel data formats
 # and available options.
 #

data/lib/pnm/image.rb

@@ -35,12 +35,11 @@ module PNM
     #
     # +pixels+::  The pixel data, given as a two-dimensional array of
     #
-    #             * for PBM: bilevel values (0 or 1),
-    #             * for PGM: gray values between 0 and +maxgray+,
+    #             * for PBM: bilevel values of 0 (white) or 1 (black),
+    #             * for PGM: gray values between 0 (black) and +maxgray+ (white),
     #             * for PPM: an array of 3 values between 0 and +maxgray+,
-    #               corresponding to red, green, and blue (RGB).
-    #
-    #             A value of 0 means that the color is turned off.
+    #               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:
     #
@@ -51,8 +50,9 @@ module PNM
     # +maxgray+:: The maximum gray or color value.
     #             For PGM and PPM, +maxgray+ must be less or equal 255
     #             (the default value).
-    #             For PBM pixel data, setting +maxgray+ implies a conversion
-    #             to +:pgm+. If +type+ is explicitly set to +:pbm+,
+    #             For bilevel pixel data, setting +maxgray+ to a value
+    #             greater than 1 implies a type of +:pgm+.
+    #             When +type+ is explicitly set to +:pbm+,
     #             the +maxgray+ setting is disregarded.
     # +comment+:: A multiline comment string.
     def initialize(pixels, options = {})
@@ -129,7 +129,7 @@ module PNM
     def detect_type(pixels, maxgray)  # :nodoc:
       if pixels.first.first.kind_of?(Array)
         :ppm
-      elsif maxgray || pixels.flatten.max > 1
+      elsif (maxgray && maxgray > 1) || pixels.flatten.max > 1
         :pgm
       else
         :pbm

data/lib/pnm/version.rb

@@ -1,4 +1,4 @@
 module PNM
-  VERSION  = '0.3.0'       # :nodoc:
-  DATE     = '2014-02-08'  # :nodoc:
+  VERSION  = '0.3.1'       # :nodoc:
+  DATE     = '2014-10-10'  # :nodoc:
 end

data/test/test_image.rb

@@ -63,7 +63,13 @@ describe PNM::Image do
     image.maxgray.must_equal 255
   end
 
-  it 'ignores maxgray for bilevel images and sets it to 1' do
+  it 'accepts setting of maxgray to 1 for bilevel images' do
+    image = PNM::Image.new([[0,1,0], [1,0,1]], {:maxgray => 1})
+    image.type.must_equal :pbm
+    image.maxgray.must_equal 1
+  end
+
+  it 'ignores invalid maxgray for bilevel images and sets it to 1' do
     image = PNM::Image.new([[0,1,0], [1,0,1]], {:type => :pbm, :maxgray => 255})
     image.type.must_equal :pbm
     image.maxgray.must_equal 1
@@ -77,10 +83,10 @@ describe PNM::Image do
   end
 
   it 'can create a grayscale image from bilevel values (using maxgray)' do
-    image = PNM::Image.new([[0,1,0], [1,0,1]], {:maxgray => 1})
+    image = PNM::Image.new([[0,1,0], [1,0,1]], {:maxgray => 2})
     image.type.must_equal :pgm
     image.pixels.must_equal [[0,1,0], [1,0,1]]
-    image.maxgray.must_equal 1
+    image.maxgray.must_equal 2
   end
 
   it 'can create a color image from bilevel values' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pnm
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Marcus Stollsteimer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-08 00:00:00.000000000 Z
+date: 2014-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -79,7 +79,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: PNM - create/read/write PNM image files (PBM, PGM, PPM)