pnm 0.3.2 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e52a4e6c563756871e2e3da51503fcaad0afda14
-  data.tar.gz: 62cc1dc3452e1fa8678c918fc12cbd9c66288d6d
+  metadata.gz: d7322d852ff78a5d37b2b0b15dcecc9780cec7ed
+  data.tar.gz: 0583fe925b357baed8eb99f57d3a202340f839fe
 SHA512:
-  metadata.gz: 331134341d9a7fe5264c5e1fb4504dc6c5886ee63cf5648cad7f4958a8a15a14b03e59a0d6fb5b2b7b176553172b2d7397536bd8d16232437cc6de85c39947a4
-  data.tar.gz: 5808baad06957ebd956fa4dbe2c58898376427598c942634a63d2ae7a25aa1b9423c1afce226db31c9b883c51968aa089200f99d81018dfa74be2ce307b272bd
+  metadata.gz: cf955fa0db64c7b42676f332a37f65b72cc6049fb28d7cba270a08fbf1c62a234508cd9ee8e01bd0bfb27d937235dd54b83c1d7b3ed9bad5f98387abde622fc2
+  data.tar.gz: b603ee0e3e53392553af4e121ff1cd62160116600fc037ad7016effbcab0c4a4c8635daf71dfb67de2840babab9005a7caf30904a71f682b941b1aaacbaa4284

data/.yardopts

@@ -0,0 +1 @@
+--no-private

data/README.md

@@ -34,6 +34,7 @@ image = PNM::Image.new(pixels, options)
 
 # retrieve some image properties
 image.info    # => "PGM 3x2 Grayscale"
+image.type    # => :pgm
 image.width   # => 3
 image.height  # => 2
 ```

data/lib/pnm.rb

@@ -40,6 +40,7 @@ require_relative 'pnm/exceptions'
 #
 #     # retrieve some image properties
 #     image.info    # => "PGM 3x2 Grayscale"
+#     image.type    # => :pgm
 #     image.width   # => 3
 #     image.height  # => 2
 #
@@ -83,28 +84,13 @@ require_relative 'pnm/exceptions'
 #
 # License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
 #
-#--
-#
-# == PNM magic numbers
-#
-#  Magic Number  Type              Encoding
-#  ------------  ----------------  -------
-#  P1            Portable bitmap   ASCII
-#  P2            Portable graymap  ASCII
-#  P3            Portable pixmap   ASCII
-#  P4            Portable bitmap   Binary
-#  P5            Portable graymap  Binary
-#  P6            Portable pixmap   Binary
-#
-#++
-#
 module PNM
 
-  LIBNAME  = 'pnm'                                                # :nodoc:
-  HOMEPAGE = 'https://github.com/stomar/pnm'                      # :nodoc:
-  TAGLINE  = 'create/read/write PNM image files (PBM, PGM, PPM)'  # :nodoc:
+  LIBNAME  = 'pnm'
+  HOMEPAGE = 'https://github.com/stomar/pnm'
+  TAGLINE  = 'create/read/write PNM image files (PBM, PGM, PPM)'
 
-  COPYRIGHT = <<-copyright.gsub(/^ +/, '')                        # :nodoc:
+  COPYRIGHT = <<-copyright.gsub(/^ +/, '')
     Copyright (C) 2013-2014 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.
@@ -162,6 +148,7 @@ module PNM
     Image.new(pixels, options)
   end
 
+  # @private
   def self.magic_number  # :nodoc:
     {
       :pbm => {:ascii => 'P1', :binary => 'P4'},

data/lib/pnm/converter.rb

@@ -1,11 +1,12 @@
 module PNM
 
+  # @private
   # Converter for pixel data. Only for internal usage.
-  class Converter
+  class Converter  # :nodoc:
 
     # Returns the number of bytes needed for one row of pixels
     # (in binary encoding).
-    def self.byte_width(type, width)  # :nodoc:
+    def self.byte_width(type, width)
       case type
       when :pbm
         (width - 1) / 8 + 1
@@ -103,7 +104,7 @@ module PNM
       data_string
     end
 
-    def self.convert_to_integers(data, type)  # :nodoc:
+    def self.convert_to_integers(data, type)
       if type == :pbm
         values_as_string = data.gsub(/[ \t\r\n]+/, '').split('')
       else
@@ -121,7 +122,7 @@ module PNM
       end
     end
 
-    def self.assert_data_size(actual, expected)  # :nodoc:
+    def self.assert_data_size(actual, expected)
       unless actual == expected
         raise PNM::DataSizeError, 'data size does not match expected size'
       end

data/lib/pnm/image.rb

@@ -113,9 +113,18 @@ module PNM
 
     alias :to_s :info
 
+    # Returns a string representation for debugging.
+    def inspect
+      if type == :pbm
+        "#<%s:0x%x %s>" % [self.class.name, object_id, info]
+      else
+        "#<%s:0x%x %s, maxgray=%d>" % [self.class.name, object_id, info, maxgray]
+      end
+    end
+
     private
 
-    def type_string  # :nodoc:
+    def type_string
       case type
       when :pbm
         'Bilevel'
@@ -126,7 +135,7 @@ module PNM
       end
     end
 
-    def detect_type(pixels, maxgray)  # :nodoc:
+    def detect_type(pixels, maxgray)
       if pixels.first.first.kind_of?(Array)
         :ppm
       elsif (maxgray && maxgray > 1) || pixels.flatten.max > 1
@@ -136,7 +145,7 @@ module PNM
       end
     end
 
-    def assert_valid_array  # :nodoc:
+    def assert_valid_array
       msg = "invalid pixel data: Array expected"
       raise PNM::ArgumentError, msg  unless Array === pixels
 
@@ -157,14 +166,14 @@ module PNM
       end
     end
 
-    def assert_valid_pixel(pixel)  # :nodoc:
+    def assert_valid_pixel(pixel)
       unless Fixnum === pixel
         msg = "invalid pixel value: Fixnum expected - #{pixel.inspect}"
         raise PNM::DataError, msg
       end
     end
 
-    def assert_valid_color_pixel(pixel)  # :nodoc:
+    def assert_valid_color_pixel(pixel)
       unless Array === pixel && pixel.map(&:class) == [Fixnum, Fixnum, Fixnum]
         msg =  "invalid pixel value: "
         msg << "Array of 3 Fixnums expected - #{pixel.inspect}"
@@ -173,33 +182,33 @@ module PNM
       end
     end
 
-    def assert_valid_type  # :nodoc:
+    def assert_valid_type
       unless [:pbm, :pgm, :ppm].include?(type)
         msg = "invalid image type - #{type.inspect}"
         raise PNM::ArgumentError, msg
       end
     end
 
-    def assert_matching_type_and_data  # :nodoc:
+    def assert_matching_type_and_data
       if Array === pixels.first.first && [:pbm, :pgm].include?(type)
         msg = "specified type does not match data - #{type.inspect}"
         raise PNM::DataError, msg
       end
     end
 
-    def assert_valid_maxgray  # :nodoc:
+    def assert_valid_maxgray
       unless Fixnum === maxgray && maxgray > 0 && maxgray <= 255
         raise PNM::ArgumentError, "invalid maxgray value - #{maxgray.inspect}"
       end
     end
 
-    def assert_valid_comment  # :nodoc:
+    def assert_valid_comment
       unless String === comment
         raise PNM::ArgumentError, "invalid comment value - #{comment.inspect}"
       end
     end
 
-    def assert_valid_pixel_values  # :nodoc:
+    def assert_valid_pixel_values
       unless pixels.flatten.max <= maxgray
         raise PNM::DataError, "invalid data: value(s) greater than maxgray"
       end
@@ -208,7 +217,7 @@ module PNM
       end
     end
 
-    def header(encoding)  # :nodoc:
+    def header(encoding)
       header =  "#{PNM.magic_number[type][encoding]}\n"
       comment_lines.each do |line|
         header << (line.empty? ? "#\n" : "# #{line}\n")
@@ -219,7 +228,7 @@ module PNM
       header
     end
 
-    def comment_lines  # :nodoc:
+    def comment_lines
       return []    unless comment
       return ['']  if comment.empty?
 
@@ -227,19 +236,19 @@ module PNM
       comment.split(/\n/, keep_trailing_null_fields)
     end
 
-    def to_ascii  # :nodoc:
+    def to_ascii
       data_string = Converter.array2ascii(pixels)
 
       header(:ascii) << data_string
     end
 
-    def to_binary  # :nodoc:
+    def to_binary
       data_string = Converter.array2binary(type, pixels)
 
       header(:binary) << data_string
     end
 
-    def gray_to_rgb(gray_value)  # :nodoc:
+    def gray_to_rgb(gray_value)
       Array.new(3, gray_value)
     end
   end

data/lib/pnm/parser.rb

@@ -1,7 +1,8 @@
 module PNM
 
+  # @private
   # Parser for PNM image files. Only for internal usage.
-  class Parser
+  class Parser  # :nodoc:
 
     # Parses PNM image data.
     #
@@ -71,7 +72,7 @@ module PNM
       result
     end
 
-    def self.token_number  # :nodoc:
+    def self.token_number
       {
         'P1' => 2,
         'P2' => 3,
@@ -82,7 +83,7 @@ module PNM
       }
     end
 
-    def self.next_token!(content)  # :nodoc:
+    def self.next_token!(content)
       delimiter = if content.start_with?('#')
                     "\n"
                   else
@@ -97,21 +98,21 @@ module PNM
       token
     end
 
-    def self.assert_valid_magic_number(magic_number)  # :nodoc:
+    def self.assert_valid_magic_number(magic_number)
       unless %w{P1 P2 P3 P4 P5 P6}.include?(magic_number)
         msg = "unknown magic number - `#{magic_number}'"
         raise PNM::ParserError, msg
       end
     end
 
-    def self.assert_integer(value_string, value_name)  # :nodoc:
+    def self.assert_integer(value_string, value_name)
       unless /\A[0-9]+\Z/ === value_string
         msg = "#{value_name} must be an integer - `#{value_string}'"
         raise PNM::ParserError, msg
       end
     end
 
-    def self.assert_value(value, name)  # :nodoc:
+    def self.assert_value(value, name)
       unless yield(value)
         msg = "invalid #{name} value - `#{value}'"
         raise PNM::ParserError, msg

data/lib/pnm/version.rb

@@ -1,4 +1,4 @@
 module PNM
-  VERSION  = '0.3.2'       # :nodoc:
-  DATE     = '2014-10-19'  # :nodoc:
+  VERSION  = '0.3.3'
+  DATE     = '2014-11-20'
 end

data/pnm.gemspec

@@ -35,6 +35,7 @@ Gem::Specification.new do |s|
       README.md
       Rakefile
       pnm.gemspec
+      .yardopts
     } +
     Dir.glob('{benchmark,lib,test}/**/*')
 

data/test/test_image.rb

@@ -162,6 +162,12 @@ describe PNM::Image do
     @color.info.must_equal 'PPM 5x3 Color'
   end
 
+  it 'can return meaningful debugging information' do
+    @bilevel.inspect.must_match   %r{^#<PNM::Image:0x\h+ PBM 5x6 Bilevel>$}
+    @grayscale.inspect.must_match %r{^#<PNM::Image:0x\h+ PGM 4x3 Grayscale, maxgray=250>$}
+    @color.inspect.must_match     %r{^#<PNM::Image:0x\h+ PPM 5x3 Color, maxgray=6>$}
+  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")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pnm
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors:
 - Marcus Stollsteimer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-19 00:00:00.000000000 Z
+date: 2014-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -32,6 +32,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".yardopts"
 - README.md
 - Rakefile
 - benchmark/bm_converter.rb
@@ -79,7 +80,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.4
 signing_key: 
 specification_version: 4
 summary: PNM - create/read/write PNM image files (PBM, PGM, PPM)
@@ -89,3 +90,4 @@ test_files:
 - test/test_parser.rb
 - test/test_converter.rb
 - test/test_pnm.rb
+has_rdoc: