pngcheck 0.2.4 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 77f6b0b4cde175efe7c530fb62150a710ba5bd7cd168154eb4831099bbca2266
-  data.tar.gz: 3d23346db77e440df57b7d549ddd212572e5a579c1f48091d9d81f1fce1e1ae0
+  metadata.gz: 8538794c331c3eefe5a4aff7c853db22e20aaebcc042a27842faaf1b885756f7
+  data.tar.gz: f94d9281e7c0a4f473a58cba444fe99b4a2504e93525fc36d958e890d50f2d5e
 SHA512:
-  metadata.gz: 1cf14b05a1d79ecc94a1eb797469f77ef1a240990cb1b3e85064dda1681e6991f214642d7c5c43c95ca760a6bc3c41a0ce958b9bff14caece3f3a5d559e7e053
-  data.tar.gz: e346ce0c089ed7d560670ad9556cd6fd954fce00ff750bfeaab84cb40c1b1c3ea92e8e22888f103d13c7ce251a0d4c3e01600ad7c1fe5d4edbc2bbf6bfddf001
+  metadata.gz: 4bed6f839abd1c4a0a597d451fb4d3271019b29b13200c394a0fb820175afe3b154d8b27db95d48f19cb2ec35f051616b87c286b10d9193de13b4bb01e7e5e37
+  data.tar.gz: 2a479f9dafab807d5581f1511f4cfc578932c49c8f9dd4789a8065032b94fdc74c48928f3fccb7fa088256b5f0181d23b48ab1520735e936581b4bd54233fab6

data/README.adoc

@@ -53,7 +53,7 @@ $ gem install pngcheck
 
 === Usage
 
-==== PngCeck status codes
+==== PngCheck status codes
 
 [source,ruby]
 ----
@@ -84,7 +84,7 @@ valid = PngCheck.check_file("spec/examples/correct.png")
 Where:
 
 * `valid` is `true` if the file is correct
-* otherwise an exception of type `PngCheck::CorruptPngError` is raised
+* otherwise an exception is raised. Possible exception types are `PngCheck::EmptyPngError`, `PngCheck::CorruptPngError`
 
 
 ==== Memory buffer processing
@@ -110,8 +110,8 @@ valid = PngCheck.check_buffer(data)
 
 Where:
 
-* `valid` is `true` if the file is correct
-* otherwise an exception of type `PngCheck::CorruptPngError` is raised
+* `valid` is `true` if the buffer is correct image
+* otherwise an exception is raised. Possible exception types are `PngCheck::EmptyPngError`, `PngCheck::CorruptPngError`
 
 
 ==== Pre-validation with libpng-ruby

data/lib/pngcheck/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PngCheck
-  VERSION = "0.2.4"
+  VERSION = "0.2.5"
 end

data/lib/pngcheck.rb

@@ -5,8 +5,16 @@ require "tempfile"
 require_relative "pngcheck/version"
 
 module PngCheck
+  EMPTY_IMAGE = "Image is empty"
+
   class CorruptPngError < StandardError; end
 
+  class EmptyPngError < StandardError
+    def initialize(msg = EMPTY_IMAGE)
+      super
+    end
+  end
+
   STATUS_OK = 0
   STATUS_WARNING = 1        # an error in some circumstances but not in all
   STATUS_MINOR_ERROR = 3    # minor spec errors (e.g., out-of-range values)
@@ -37,25 +45,49 @@ module PngCheck
 
   class << self
     def analyze_file(path)
-      Tempfile.open("captured-stream-") do |captured_stream|
-        extra_msg = FFI::Buffer.alloc_out(EXTRA_MESSAGE_SIZE, 1, false)
-        @@semaphore.lock
-        status = pngcheck_file(path, captured_stream.path, extra_msg)
-        @@semaphore.unlock
-        # we assume that pngcheck_file returns either captured_stream
-        # or extra message but not both
-        [status, captured_stream.read + extra_msg.get_string(16)]
-      end
+      return [STATUS_CRITICAL_ERROR, EMPTY_IMAGE] if File.zero? path
+
+      do_analyze_file(path)
     end
 
     def check_file(path)
       status, info = analyze_file(path)
+      raise EmptyPngError.new if info.eql? EMPTY_IMAGE
       raise CorruptPngError.new info unless status == STATUS_OK
 
       true
     end
 
     def analyze_buffer(data)
+      return [STATUS_CRITICAL_ERROR, EMPTY_IMAGE] if data.empty?
+
+      do_analyze_buffer(data)
+    end
+
+    def check_buffer(data)
+      status, info = analyze_buffer(data)
+      raise EmptyPngError.new if info.eql? EMPTY_IMAGE
+      raise CorruptPngError.new info unless status == STATUS_OK
+
+      true
+    end
+
+    private
+
+    def do_analyze_file(path)
+      Tempfile.open("captured-stream-") do |captured_stream|
+        extra_msg = FFI::Buffer.alloc_out(EXTRA_MESSAGE_SIZE, 1, false)
+        @@semaphore.lock
+        status = pngcheck_file(path, captured_stream.path, extra_msg)
+        @@semaphore.unlock
+        # we assume that pngcheck_file returns either captured_stream
+        # or extra message but not both
+
+        [status, captured_stream.read + extra_msg.get_string(0)]
+      end
+    end
+
+    def do_analyze_buffer(data)
       Tempfile.open("captured-stream-") do |captured_stream|
         extra_msg = FFI::Buffer.alloc_out(EXTRA_MESSAGE_SIZE, 1, false)
         mem_buf = FFI::MemoryPointer.new(:char, data.bytesize)
@@ -64,15 +96,8 @@ module PngCheck
         status = pngcheck_buffer(mem_buf, data.bytesize, captured_stream.path,
                                  extra_msg)
         @@semaphore.unlock
-        [status, captured_stream.read + extra_msg.get_string(16)]
+        [status, captured_stream.read + extra_msg.get_string(0)]
       end
     end
-
-    def check_buffer(data)
-      status, info = analyze_buffer(data)
-      raise CorruptPngError.new info unless status == STATUS_OK
-
-      true
-    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pngcheck
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.5
 platform: ruby
 authors:
 - Ribose Inc.
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-09-08 00:00:00.000000000 Z
+date: 2022-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -94,7 +94,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.4'
-description:
+description: 
 email:
 - open.source@ribose.com
 executables:
@@ -127,7 +127,7 @@ metadata:
   homepage_uri: https://github.com/metanorma/pngcheck-ruby
   source_code_uri: https://github.com/metanorma/pngcheck-ruby
   changelog_uri: https://github.com/metanorma/pngcheck-ruby
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -142,8 +142,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key:
+rubygems_version: 3.1.6
+signing_key: 
 specification_version: 4
 summary: Ruby interface to pngcheck.
 test_files: []