pnm 0.1.0

data/test/test_image.rb

@@ -0,0 +1,113 @@
+# test_image.rb: Unit tests for the PNM library.
+#
+# Copyright (C) 2013 Marcus Stollsteimer
+
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'pnm/image'
+
+
+describe PNM::Image do
+
+  before do
+    @srcpath   = File.dirname(__FILE__)
+    @temp_path = File.expand_path("#{@srcpath}/temp.pnm")
+
+    pixels = [[0,0,0,0,0],
+              [0,1,1,1,0],
+              [0,0,1,0,0],
+              [0,0,1,0,0],
+              [0,0,1,0,0],
+              [0,0,0,0,0]]
+    comment = 'Bilevel'
+    @bilevel = PNM::Image.new(:pbm, pixels, {:comment => comment})
+
+    pixels = [[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
+              [0,1,1,1,0,1,1,1,1,0,1,1,1,1,1,0],
+              [0,0,1,0,0,1,0,0,1,0,1,0,1,0,1,0],
+              [0,0,1,0,0,1,0,0,1,0,1,0,1,0,1,0],
+              [0,0,1,0,0,1,1,1,1,0,1,0,1,0,1,0],
+              [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0]]
+    @bilevel_2 = PNM::Image.new(:pbm, pixels)
+
+    pixels = [[  0, 50,100,150],
+              [ 50,100,150,200],
+              [100,150,200,250]]
+    comment = "Grayscale\n(with multiline comment)"
+    @grayscale = PNM::Image.new(:pgm, pixels, {:maxgray => 250, :comment => comment})
+
+    pixels = [[65,66], [13,10], [65,66]]
+    @grayscale_crlf = PNM::Image.new(:pgm, pixels)
+
+    pixels = [[[0,6,0], [1,5,1], [2,4,2], [3,3,4], [4,2,6]],
+              [[1,5,2], [2,4,2], [3,3,2], [4,2,2], [5,1,2]],
+              [[2,4,6], [3,3,4], [4,2,2], [5,1,1], [6,0,0]]]
+    @color = PNM::Image.new(:ppm, pixels, {:maxgray => 6})
+  end
+
+  it 'can create a color image from gray values' do
+    image = PNM::Image.new(:ppm, [[0,3,6], [3,6,9]])
+    image.info.must_match %r{^PPM 3x2 Color}
+    image.pixels.must_equal [[[0,0,0], [3,3,3], [6,6,6]], [[3,3,3], [6,6,6], [9,9,9]]]
+  end
+
+  it 'can write a bilevel image to an ASCII encoded file' do
+    @bilevel.write(@temp_path, :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)
+    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
+    @bilevel_2.write(@temp_path, :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)
+    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)
+    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)
+    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)
+    File.binread(@temp_path).must_equal File.binread("#{@srcpath}/color_binary.ppm")
+    File.delete(@temp_path)
+  end
+
+  it 'can return image information' do
+    @bilevel.info.must_equal 'PBM 5x6 Bilevel'
+    @grayscale.info.must_equal 'PGM 4x3 Grayscale'
+    @color.info.must_equal 'PPM 5x3 Color'
+  end
+
+  it 'can write binary data containing CRLF' do
+    @grayscale_crlf.write(@temp_path, :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 from an I/O stream' do
+    File.open(@temp_path, 'w') {|f| @grayscale_crlf.write(f, :binary) }
+    File.binread(@temp_path).must_equal File.binread("#{@srcpath}/grayscale_binary_crlf.pgm")
+    File.delete(@temp_path)
+  end
+end

data/test/test_parser.rb

@@ -0,0 +1,119 @@
+# test_parser.rb: Unit tests for the PNM library.
+#
+# Copyright (C) 2013 Marcus Stollsteimer
+
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'pnm/parser'
+
+
+describe PNM::Parser do
+
+  before do
+    @parser = PNM::Parser
+  end
+
+  it 'can parse ASCII encoded PBM data' do
+    content =<<-EOF.chomp.gsub(/^ */, '')
+      P1 6 2
+      0 1 0 0 1 1
+      0 0 0 1 1 1
+    EOF
+    expected = {
+      :magic_number => 'P1',
+      :width        => '6',
+      :height       => '2',
+      :data         => "0 1 0 0 1 1\n0 0 0 1 1 1"
+    }
+
+    @parser.parse(content).must_equal expected
+  end
+
+  it 'can parse ASCII encoded PGM data' do
+    content =<<-EOF.chomp.gsub(/^ */, '')
+      P2 4 2 100
+      10 20 30 40
+      50 60 70 80
+    EOF
+    expected = {
+      :magic_number => 'P2',
+      :width        => '4',
+      :height       => '2',
+      :maxgray      => '100',
+      :data         => "10 20 30 40\n50 60 70 80"
+    }
+
+    @parser.parse(content).must_equal expected
+  end
+
+  it 'can parse binary encoded data' do
+    content = 'P4 8 2 ' << ['05AF'].pack('H*')
+    expected = {
+      :magic_number => 'P4',
+      :width        => '8',
+      :height       => '2',
+      :data         => ['05AF'].pack('H*')
+    }
+
+    @parser.parse(content).must_equal expected
+  end
+
+  it 'does not change the passed data' do
+    content = 'P1 3 2 0 1 0 0 1 1'
+    original_content = content.dup
+    @parser.parse(content)
+
+    content.must_equal original_content
+  end
+
+  it 'does accept multiple whitespace as delimiter' do
+    content = "P1  \n\t 3 \r \n2 0 1 0 0 1 1"
+    expected = {
+      :magic_number => 'P1',
+      :width        => '3',
+      :height       => '2',
+      :data         => '0 1 0 0 1 1'
+    }
+
+    @parser.parse(content).must_equal expected
+  end
+
+  it 'can parse binary encoded data including whitespace' do
+    @parser.parse("P4 16 4 A\nB\rC D\t")[:data].must_equal "A\nB\rC D\t"
+  end
+
+  it 'can parse binary encoded data starting with whitespace' do
+    @parser.parse("P4 8 2 \nA")[:data].must_equal "\nA"
+  end
+
+  it 'can parse binary encoded data starting with comment character' do
+    @parser.parse("P4 8 2 #A")[:data].must_equal "#A"
+  end
+
+  it 'does not chomp newlines from parsed binary encoded data' do
+    @parser.parse("P4 8 2 AB\n")[:data].must_equal "AB\n"
+  end
+
+  it 'can parse comments' do
+    content =<<-EOF.chomp.gsub(/^ */, '')
+      # Comment 1
+      P1   # Comment 2
+      6
+      #Comment 3
+      #
+      \r \t# Comment 5
+      2
+      0 1 0 0 1 1
+      0 0 0 1 1 1
+    EOF
+    expected = {
+      :magic_number => 'P1',
+      :width        => '6',
+      :height       => '2',
+      :comments     => ['Comment 1', 'Comment 2', 'Comment 3', '', 'Comment 5'],
+      :data         => "0 1 0 0 1 1\n0 0 0 1 1 1"
+    }
+
+    @parser.parse(content).must_equal expected
+  end
+end

data/test/test_pnm.rb

@@ -0,0 +1,105 @@
+# test_pnm.rb: Unit tests for the PNM library.
+#
+# Copyright (C) 2013 Marcus Stollsteimer
+
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'pnm'
+
+
+describe PNM do
+
+  before do
+    @srcpath = File.dirname(__FILE__)
+  end
+
+  it 'can read an ASCII encoded PBM file' do
+    file = File.expand_path("#{@srcpath}/bilevel_ascii.pbm")
+    image = PNM.read(file)
+
+    image.info.must_match %r{^PBM 5x6 Bilevel}
+    image.maxgray.must_equal 1
+    image.comment.must_equal 'Bilevel'
+    image.pixels.must_equal [[0,0,0,0,0],
+                             [0,1,1,1,0],
+                             [0,0,1,0,0],
+                             [0,0,1,0,0],
+                             [0,0,1,0,0],
+                             [0,0,0,0,0,]]
+  end
+
+  it 'can read an ASCII encoded PGM file' do
+    file = File.expand_path("#{@srcpath}/grayscale_ascii.pgm")
+    image = PNM.read(file)
+
+    image.info.must_match %r{^PGM 4x3 Grayscale}
+    image.maxgray.must_equal 250
+    image.comment.must_equal "Grayscale\n(with multiline comment)"
+    image.pixels.must_equal [[  0, 50,100,150],
+                             [ 50,100,150,200],
+                             [100,150,200,250]]
+  end
+
+  it 'can read an ASCII encoded PPM file' do
+    file = File.expand_path("#{@srcpath}/color_ascii.ppm")
+    image = PNM.read(file)
+
+    image.info.must_match %r{^PPM 5x3 Color}
+    image.maxgray.must_equal 6
+    image.pixels.must_equal [[[0,6,0], [1,5,1], [2,4,2], [3,3,4], [4,2,6]],
+                             [[1,5,2], [2,4,2], [3,3,2], [4,2,2], [5,1,2]],
+                             [[2,4,6], [3,3,4], [4,2,2], [5,1,1], [6,0,0]]]
+  end
+
+  it 'can read a binary encoded PBM file' do
+    file = File.expand_path("#{@srcpath}/bilevel_binary.pbm")
+    image = PNM.read(file)
+
+    image.info.must_match %r{^PBM 5x6 Bilevel}
+    image.maxgray.must_equal 1
+    image.comment.must_equal 'Bilevel'
+    image.pixels.must_equal [[0,0,0,0,0],
+                             [0,1,1,1,0],
+                             [0,0,1,0,0],
+                             [0,0,1,0,0],
+                             [0,0,1,0,0],
+                             [0,0,0,0,0,]]
+  end
+
+  it 'can read a binary encoded PGM file' do
+    file = File.expand_path("#{@srcpath}/grayscale_binary.pgm")
+    image = PNM.read(file)
+
+    image.info.must_match %r{^PGM 4x3 Grayscale}
+    image.maxgray.must_equal 250
+    image.comment.must_equal "Grayscale\n(with multiline comment)"
+    image.pixels.must_equal [[  0, 50,100,150],
+                             [ 50,100,150,200],
+                             [100,150,200,250]]
+  end
+
+  it 'can read a binary encoded PPM file' do
+    file = File.expand_path("#{@srcpath}/color_binary.ppm")
+    image = PNM.read(file)
+
+    image.info.must_match %r{^PPM 5x3 Color}
+    image.maxgray.must_equal 6
+    image.pixels.must_equal [[[0,6,0], [1,5,1], [2,4,2], [3,3,4], [4,2,6]],
+                             [[1,5,2], [2,4,2], [3,3,2], [4,2,2], [5,1,2]],
+                             [[2,4,6], [3,3,4], [4,2,2], [5,1,1], [6,0,0]]]
+  end
+
+  it 'can read binary data containing CRLF' do
+    file = File.expand_path("#{@srcpath}/grayscale_binary_crlf.pgm")
+
+    image = PNM.read(file)
+    image.pixels.must_equal [[65,66], [13,10], [65,66]]
+  end
+
+  it 'can read binary data containing CRLF from an I/O stream' do
+    file = File.expand_path("#{@srcpath}/grayscale_binary_crlf.pgm")
+
+    image = File.open(file, 'r') {|f| PNM.read(f) }
+    image.pixels.must_equal [[65,66], [13,10], [65,66]]
+  end
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: pnm
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Marcus Stollsteimer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 'PNM is a pure Ruby library for creating, reading, and writing of PNM
+  image files (Portable Anymap): PBM (Portable Bitmap), PGM (Portable Graymap), and
+  PPM (Portable Pixmap).'
+email: sto.mar@web.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- pnm.gemspec
+- benchmark/random_image.ppm
+- benchmark/bm_converter.rb
+- benchmark/random_image.pgm
+- benchmark/random_image.pbm
+- lib/pnm.rb
+- lib/pnm/image.rb
+- lib/pnm/parser.rb
+- lib/pnm/version.rb
+- lib/pnm/converter.rb
+- test/bilevel_ascii.pbm
+- test/grayscale_binary.pgm
+- test/test_image.rb
+- test/grayscale_binary_crlf.pgm
+- test/color_binary.ppm
+- test/bilevel_binary.pbm
+- test/test_parser.rb
+- test/test_converter.rb
+- test/bilevel_2_binary.pbm
+- test/color_ascii.ppm
+- test/test_pnm.rb
+- test/grayscale_ascii.pgm
+homepage: https://github.com/stomar/pnm
+licenses:
+- GPL-3
+metadata: {}
+post_install_message: 
+rdoc_options:
+- --charset=UTF-8
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.9
+signing_key: 
+specification_version: 4
+summary: PNM - create/read/write PNM image files (PBM, PGM, PPM)
+test_files:
+- test/test_image.rb
+- test/test_parser.rb
+- test/test_converter.rb
+- test/test_pnm.rb