apple_png 0.0.1 → 0.0.2

data/ext/apple_png/apple_png.c

@@ -195,7 +195,13 @@ static int readPngChunks(VALUE self, const char *oldPNG, size_t oldPngLength, dy
     return APPLE_PNG_OK;
 }
 
-/* convert an apple png data string to a standard png data string */
+/*
+@!visibility protected
+Convert an Apple PNG data string to a standard PNG data string
+@note This sets #width and #height on the ApplePng instance as a side effect
+@param data [String] Binary string containing Apple PNG data
+@return [String] Binary string containing standard PNG data
+*/
 static VALUE ApplePng_convert_apple_png(VALUE self, VALUE data) {
     int error;
     VALUE ret;
@@ -229,7 +235,12 @@ static VALUE ApplePng_convert_apple_png(VALUE self, VALUE data) {
     return ret;
 }
 
-/* this is a quick way to get the width and height from png data without converting the file */
+/*
+@!visibility protected
+Get the width and height from PNG data without actually converting it.
+@note This sets #width and #height on the ApplePng instance.
+@param data [String] Binary string containing Apple PNG data
+*/
 static VALUE ApplePng_get_dimensions(VALUE self, VALUE data) {
     const char *oldPNG = StringValuePtr(data);
     size_t oldPNG_length = RSTRING_LEN(data);
@@ -260,6 +271,6 @@ static VALUE ApplePng_get_dimensions(VALUE self, VALUE data) {
 
 void Init_apple_png(void) {
   VALUE klass = rb_define_class("ApplePng", rb_cObject);
-  rb_define_method(klass, "convert_apple_png", ApplePng_convert_apple_png, 1);
-  rb_define_method(klass, "get_dimensions", ApplePng_get_dimensions, 1);
+  rb_define_protected_method(klass, "convert_apple_png", ApplePng_convert_apple_png, 1);
+  rb_define_protected_method(klass, "get_dimensions", ApplePng_get_dimensions, 1);
 }

data/lib/apple_png.rb

@@ -3,14 +3,19 @@ require 'apple_png/apple_png'
 class ApplePng
   attr_accessor :width, :height
 
+  # Create a new ApplePng instance from Apple PNG data in a string
+  # @param apple_png_data [String] Binary string containing Apple PNG data, probably read from a file
   def initialize(apple_png_data)
     self.get_dimensions(apple_png_data)
     @raw_data = apple_png_data
   end
 
+  # Get the PNG data as string. The conversion from Apple PNG data to standard PNG data will be performed when this method is first called.
+  # @return [String] Binary string containing standard PNG data
   def data
     if @data.nil?
       @data = self.convert_apple_png(@raw_data)
+      @raw_data = nil
     end
     return @data
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apple_png
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -47,3 +47,4 @@ signing_key:
 specification_version: 3
 summary: Converts the Apple PNG format to standard PNG
 test_files: []
+has_rdoc: