jsong 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 99c467f0e6a1c61b775db7cc78d7f2032c54422b
-  data.tar.gz: d92ccc25ac55046d376d34a8ac932f1071ad2fc6
+  metadata.gz: 3592f6188a4001c04af10edd196d7c5c8750147a
+  data.tar.gz: 5bab8f79b616229038f7e35ec4e0cc5390806827
 SHA512:
-  metadata.gz: f74f1a134cb4f435b6269b6503ea9a20f5af656d18e7ef910fe76c9d7fa567e700e9bc6755fc893cc263b77f8dcc62d1b20e5bf24ae233a7ded37bc2ac0e1568
-  data.tar.gz: 06f7684bab0f24b4a075da57d4c25419ff979adc214d3b44f02ecd7fd09e35b745f59faa1a35c5cf47cc9d5a03c4e2ff2bddbc31f24183a91cc834561d171321
+  metadata.gz: 9cf528efedd553acaeff61dd140dbaf6c9e45f5bd2ca12ae8a1d02e562aa497823c3aee0addecdc2e772d23839e62cd6e3c58d5c5b843d3befe592cd6bd815b3
+  data.tar.gz: c41f0904c64a9c9151114bc60977b679fb22306152d4548bbd55ed8f9d3b3e59a9ceef4f18d53be7c17f02bec7783b77e2011a0966ca37f06c5068342958b11b

data/lib/jsong/version.rb

@@ -1,3 +1,3 @@
 module Jsong
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/lib/jsong.rb

@@ -19,7 +19,14 @@ module Jsong
     }]
   }.freeze
 
-  def Jsong.to_jsong(file_name, comment = nil, yaml = false)
+  # Converts a PNG image to JSON-G or YAML-G.
+  #
+  # @param comment [String] Optional global comment string.
+  # @param pixel_comment [String] Optional comment string for every pixel.
+  # @param yaml [true, false] Set to true if you need YAML-G.
+  #
+  # @return [String] JSON-G or YAML-G data.
+  def Jsong.to_jsong(file_name, comment: nil, pixel_comment: nil, yaml: false)
     image = ChunkyPNG::Image.from_file file_name
 
     if comment.nil? && image.metadata['Title']
@@ -42,7 +49,7 @@ module Jsong
             y: y
           },
           color: Jsong.rrggbbaa_to_jsong(pixel),
-          comment: 'A pixel'
+          comment: pixel_comment || 'A pixel'
         }
       end
     end
@@ -54,7 +61,14 @@ module Jsong
     end
   end
 
-  def Jsong.from_jsong(text, file_name, yaml = false)
+  # Converts JSON-G or YAML-G data to an image.
+  #
+  # @param text [String] Raw JSON-G or YAML-G data.
+  # @param file_name [String] Target file name.
+  # @param yaml [true, false] Set to true if the data is in YAML-G.
+  #
+  # @return [nil]
+  def Jsong.from_jsong(text, file_name, yaml: false)
     text = text.read if text.respond_to? :read
     data = if yaml; YAML.load text; else; JSON.parse text; end
     default_color = Jsong.encode_pixel data['layers'][-1]['default_color']
@@ -74,6 +88,11 @@ module Jsong
     png.save(file_name, :interlace => true)
   end
 
+  # Converts a single pixel hash to a chunky png pixel.
+  #
+  # @param px [Hash<String => Integer>] Hash containing red, green, blue and alpha values.
+  #
+  # @return [ChunkyPNG::Color]
   def Jsong.encode_pixel(px)
     r, g = px['red'],  px['green']
     b, a = px['blue'], px['alpha']
@@ -81,6 +100,11 @@ module Jsong
     ChunkyPNG::Color.rgba(r, g, b, a)
   end
 
+  # Converts an integer to JSON-G hash.
+  #
+  # @param i [Integer] Base 10 colour value in hex format RRGGBBAA.
+  #
+  # @return [Hash<String => Integer>] Hash with red, green, blue and alpha values
   def Jsong.rrggbbaa_to_jsong(i)
     {
       red: (i / 16777216).floor,

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jsong
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Illia K.