imageparser 0.0.1 → 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b253dac11ff248c2027a133b165cf0ea8d81c8cd
+  data.tar.gz: d7e1294443bc68d552a039da11210d75afd1ac79
+SHA512:
+  metadata.gz: 3261ca8d0f8745404d7f834ac0b5c797b9d6cd4a019d57fd94ad9d82cff0ba47c7a6f7e5dab8e97b84112dfd1ca60635d2ec93221b1efbb9fe59c77c3cacabe4
+  data.tar.gz: 4ed825dbe16e819e534f39cd5b3bdba3bea9c1e2d41b2c59db9cb67deb88c4f2706089c6e602dbd88f78d9a10fb1483a96b56764f34ea9dfd732bcc2b6410123

data/lib/imageparser.rb

@@ -1,14 +1,26 @@
 # Image Parser
+#
 # Supports PPM and PTF file formats.
 class ImageParser
+	# File descriptor reading accessor
 	attr_accessor :con
+
+	# Initialize the file
+	#
+        # Can be nil, but then it won't create
+        # the file descriptor.
 	def initialize(file=nil)
 		@con = File.read(file, mode: 'rb') if file
 	end
 	
 	# Parse a PPM file.
+	#
 	# Add parsed results into the hash `info`.
 	# These results are, the header, the width, the height, the RGB max value, the raster and the raster grid.
+	# Example: parse_ppm(hash)
+	# => hash[:header] = "P6", hash[:width] = 4, hash[:height] = 4, hash[:rgb] = 255,
+	# => hash[:raster] = [255, 42, 55, ..], hash[:raster_grid] = [[34, 43, 55], ..]
+
 	def parse_ppm(info)
 		info[:header] = @con.split(" ")[0] if @con.split(" ")[0] == "P6"
 		info[:width] = @con.split(" ")[1].to_i if @con.split(" ")[1].to_i > 0 
@@ -19,8 +31,11 @@ class ImageParser
 	end
 
 	# Parse a PTF file.
+	#
 	# Add parsed results into hash `info`.
 	# These results are, the header and the color information.
+	# Example: parse_ptf(hash)
+	# hash[:header] = "PTF1", hash[:color_info] = [3, 2, 33, 3]
 	def parse_ptf(info)
 		info[:header] = @con.split(" ")[0] if @con.split(" ")[0] == "PTF1"
 		info[:color_info] = @con.split(",")[1..-1].map {|s| s.delete ' '}

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: imageparser
 version: !ruby/object:Gem::Version
-  version: 0.0.1
-  prerelease: 
+  version: 0.0.2
 platform: ruby
 authors:
 - Chris Himpon
@@ -11,7 +10,7 @@ bindir: bin
 cert_chain: []
 date: 2015-03-06 00:00:00.000000000 Z
 dependencies: []
-description: Image Parsing Gem
+description: Image Parsing Gem for PPM and PTF files.
 email: synattack@hotmail.com
 executables: []
 extensions: []
@@ -21,26 +20,25 @@ files:
 homepage: http://rubygems.org/gems/imageparser
 licenses:
 - GPLv2
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.4.6
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Image Parsing
 test_files: []