pnm 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c8d01685f2bc40a0f3f6a862f25e2c6001d8f6a3
-  data.tar.gz: 2817af37b0e92b2daa766334fa9363c8ca953315
+  metadata.gz: 597b7231eeda234ed2c8a7446ececac07573d3dd
+  data.tar.gz: a2d45050c7c3449b024fe33834b6ade73192b1fe
 SHA512:
-  metadata.gz: 1dd632513336784b890a6d7c2c81717bcabf12f511f0cdff8b9d93ee38bfbf3ffd1e5cd29463830ea4e190973d147bddc5d9bd297c6aec7dec4ffef670efbea9
-  data.tar.gz: 9051a2ec9005e3100f56b2363c311d4fef8626458b1d0a99c0cd0d3c3c22b1417725ec3cbe34a7f802118f5665582c594deae2b3c4194d6da4fb124eb59a8c98
+  metadata.gz: d00bcb7995660c471798433176e2328d00130fc54cef1fb3aeb9971b66250a113145dc11fde15d7bd077ab36ba4193cf75e5f0c0cbd0bc44fc6f1074caf4849a
+  data.tar.gz: 2d7287bb435de4a414bb05705a273a2ddf3d0f18bb3f02f14c1a8b132d2ef98e05be27755e7f9067bdab1965270ac7e81f43db3859dd8c1bf7a0a2327dfb3fcd

data/README.md

@@ -20,14 +20,14 @@ 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'}
+options = {:maxgray => 30, :comment => "Test Image"}
 
 # create the image object
 image = PNM.create(pixels, options)
@@ -49,19 +49,20 @@ and available options.
 Write an image to a file:
 
 ``` ruby
-image.write('test.pgm')
+image.write("test.pgm")
+image.write_with_extension("test")  # adds the correct file extension
 
 # use ASCII or "plain" format (default is binary)
-image.write('test.pgm', :ascii)
+image.write("test.pgm", :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
@@ -95,13 +102,14 @@ Requirements
   - Ruby 2.1,
   - Ruby 2.0.0,
   - Ruby 1.9.3,
-  - JRuby 1.7.18,
-  - Rubinius 2.2.10.
+  - JRuby 1.7.19,
+  - Rubinius 2.5.2.
 
 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
 --------------

data/lib/pnm.rb

@@ -26,14 +26,14 @@ 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'}
+#     options = {:maxgray => 30, :comment => "Test Image"}
 #
 #     # create the image object
 #     image = PNM.create(pixels, options)
@@ -53,25 +53,30 @@ require_relative 'pnm/exceptions'
 #
 # Write an image to a file:
 #
-#     image.write('test.pgm')
+#     image.write("test.pgm")
+#     image.write_with_extension("test")  # adds the correct file extension
 #
 #     # use ASCII or "plain" format (default is binary)
-#     image.write('test.pgm', :ascii)
+#     image.write("test.pgm", :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
 #

data/lib/pnm/image.rb

@@ -80,6 +80,9 @@ module PNM
       assert_pixel_value_range
 
       post_initialize
+
+      @pixels.freeze
+      @comment.freeze
     end
 
     # Writes the image to +file+ (a filename or an IO object),
@@ -102,6 +105,15 @@ module PNM
       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}"
@@ -114,6 +126,15 @@ module PNM
       # implemented by subclasses
     end
 
+    # Equality --- Two images are considered equal if they have
+    # the same pixel values, type, maxgray, and comments.
+    def ==(other)
+      return true  if other.equal?(self)
+      return false  unless other.instance_of?(self.class)
+
+      type == other.type && maxgray == other.maxgray && comment == other.comment && pixels == other.pixels
+    end
+
     private
 
     def self.assert_valid_array(pixels)  # :nodoc:

data/lib/pnm/version.rb

@@ -1,4 +1,4 @@
 module PNM
-  VERSION  = '0.4.1'
-  DATE     = '2015-01-20'
+  VERSION  = '0.5.0'
+  DATE     = '2015-09-26'
 end

data/pnm.gemspec

@@ -40,5 +40,6 @@ Gem::Specification.new do |s|
     } +
     Dir.glob('{benchmark,lib,test}/**/*')
 
-  s.rdoc_options = ['--charset=UTF-8']
+  s.extra_rdoc_files = ['README.md']
+  s.rdoc_options = ['--charset=UTF-8', '--main=README.md']
 end

data/test/test_image.rb

@@ -44,6 +44,14 @@ describe PNM::Image do
     @color = PNM.create(pixels, {:maxgray => 6})
   end
 
+  it 'freezes pixel data' do
+    lambda { @bilevel.pixels << [1,1,0,1,1] }.must_raise RuntimeError
+  end
+
+  it 'freezes comment string' do
+    lambda { @bilevel.comment << "string" }.must_raise RuntimeError
+  end
+
   it 'sets maxgray to 1 for bilevel images' do
     image = PNM.create([[0,1,0], [1,0,1]])
     image.type.must_equal :pbm
@@ -161,6 +169,24 @@ describe PNM::Image do
     File.delete(@temp_path)
   end
 
+  it 'can write a bilevel image to a file, adding the extension' do
+    @bilevel.write_with_extension(@temp_path)
+    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)
+    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)
+    File.binread("#{@temp_path}.ppm").must_equal File.binread("#{@srcpath}/color_binary.ppm")
+    File.delete("#{@temp_path}.ppm")
+  end
+
   it 'can return image information' do
     @bilevel.info.must_equal 'PBM 5x6 Bilevel'
     @grayscale.info.must_equal 'PGM 4x3 Grayscale'
@@ -198,4 +224,50 @@ describe PNM::Image do
     File.binread(@temp_path).must_equal "P1\n# An empty line:\n#\n2 1\n0 0\n"
     File.delete(@temp_path)
   end
+
+  it 'can check equality of images (1)' do
+    pixels = [[0,1,0], [1,0,1]]
+    bilevel  = PNM.create(pixels, {:comment => "image"})
+    bilevel2 = PNM.create(pixels, {:comment => "image"})
+
+    (bilevel2 == bilevel).must_equal true
+  end
+
+  it 'can check equality of images (2)' do
+    pixels = [[0,1,0], [1,0,1]]
+    bilevel  = PNM.create(pixels, {:comment => "image"})
+    bilevel2 = PNM.create(pixels, {:comment => "other image"})
+
+    (bilevel2 == bilevel).must_equal false
+  end
+
+  it 'can check equality of images (3)' do
+    pixels = [[0,1,0], [1,0,1]]
+    bilevel  = PNM.create(pixels)
+    bilevel2 = PNM.create(pixels.reverse)
+
+    (bilevel2 == bilevel).must_equal false
+  end
+
+  it 'can check equality of images (4)' do
+    pixels = [[0,1,0], [1,0,1]]
+    bilevel   = PNM.create(pixels, {:type => :pbm})
+    graylevel = PNM.create(pixels, {:type => :pgm})
+
+    (graylevel == bilevel).must_equal false
+  end
+
+  it 'can check equality of images (5)' do
+    pixels = [[0,1,2], [3,4,5]]
+    graylevel  = PNM.create(pixels, {:maxgray => 10})
+    graylevel2 = PNM.create(pixels, {:maxgray => 255})
+
+    (graylevel2 == graylevel).must_equal false
+  end
+
+  it 'can check equality of images (6)' do
+    image = PNM.create([[0,1,2], [3,4,5]])
+
+    (image == "a string").must_equal false
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pnm
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Marcus Stollsteimer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-20 00:00:00.000000000 Z
+date: 2015-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -44,7 +44,8 @@ description: 'PNM is a pure Ruby library for creating, reading, and writing of P
 email: sto.mar@web.de
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
 files:
 - ".yardopts"
 - README.md
@@ -80,6 +81,7 @@ metadata: {}
 post_install_message: 
 rdoc_options:
 - "--charset=UTF-8"
+- "--main=README.md"
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
@@ -94,7 +96,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: PNM - create/read/write PNM image files (PBM, PGM, PPM)
@@ -104,4 +106,3 @@ test_files:
 - test/test_parser.rb
 - test/test_converter.rb
 - test/test_pnm.rb
-has_rdoc: