pics_or_it_didnt_happen 1.1.3 → 1.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6499a083ae19e977da132e5a4e3d9cfc87ebcd8f15ecfc5ca58abaa238e1e927
-  data.tar.gz: beeb9e58fed600d2eb51ef9a09ad34fa6e93106d09e585c3fa4356f8f2afdfa3
+  metadata.gz: d2372771aabe6cfcc3fe2945a37b1327e79ae63a15083a24e3d9b441e236f190
+  data.tar.gz: 876dfad3b04e2194a9e9a9a01db316e1638abb34a89e20eafcf16df90f4c043a
 SHA512:
-  metadata.gz: 88c6e124dcc03b22a851b26ba212c5e63ec831c53a998968c5379cffbc26759ead5363e7c2ddbd27012773b92d94a0131a839add5fdde97bee3be7bfeaa4dc9e
-  data.tar.gz: aab98afa1b45ca028cc70a8cbe8c1ee174f4adaed037ff89e8ee652e36e1258ab5c7557f7414b99a7497ae7adab75da92e2a75048779ecf31ebbfb5ecf18a3bb
+  metadata.gz: b55a279d23229d6cc080cc64b66a3c56b750b4167eac6d29b88fed72140f3ba6542c7d987ee1194d2b28a83dc2b90996a0e81908797420dd998cb57c6dc16f19
+  data.tar.gz: db4264c04c9dbe5ac220f459e30a407cf7a574fb6f3290bb09d714ab9ca56627b15a41229dd346f440ef7ea4f552f94c12d1639646d8fe4a9b746acc070b24de

data/lib/pics_or_it_didnt_happen.rb

@@ -1,28 +1,50 @@
 require 'base64'
 
 module PicsOrItDidntHappen
-  def self.image_to_data_url_image_tag(file_path, alt_text: nil, classes: nil)
-    raise ArgumentError, "No file was found at #{file_path}" unless File.exist?(file_path)
+  def self.image_to_data_url_image_tag(passed_image, alt_text: nil, class: nil)
+    raise ArgumentError, "passed_image must be a binary string or a file path" unless passed_image.is_a?(String)
+    # check if passed_image is a file path that exists
+    check_if_file_exists = Proc.new do |file_path| 
+      begin
+        File.exist?(file_path)
+      rescue ArgumentError => e
+        false
+      end
+    end
+    if check_if_file_exists.call(passed_image)
+      # read the file as binary
+      begin
+        file_in_binary = IO.binread(passed_image)
+      rescue ArgumentError => e
+        raise ArgumentError, "#{passed_image} could not be read as a binary string"
+      end
+    else # passed_image may be a binary string of an image
+      file_in_binary = passed_image
+    end
+    # validate the keyword arguments
     raise ArgumentError, "alt_text must be a string" unless alt_text.is_a?(String) || alt_text.nil?
-    raise ArgumentError, "classes must be a string" unless classes.is_a?(String) || classes.nil?
-    file_in_binary = IO.binread(file_path)
+    klass = binding.local_variable_get(:class)
+    raise ArgumentError, "class must be a string or an Array of strings" unless klass.is_a?(String) || (klass.is_a?(Array) && klass.all? { |c| c.is_a?(String) } ) || klass.nil?
+    # convert an array of classes to a single string separated by spaces
+    klass = klass.join(" ") if klass.is_a?(Array)
+    # encode the binary string / image as base64
     base64_encoded_image_data = [file_in_binary].pack('m0')
-    src_string = "data:#{mime_type_of(file_path)};base64,#{base64_encoded_image_data}"
-    html_string = "<img src=\"#{src_string}\""
-    html_string += " alt=\"#{alt_text}\"" if alt_text   
-    html_string += " class=\"#{classes}\"" if classes 
-    return html_string.strip + ">"
+    # build the HTML string
+    src_string = "data:#{mime_type_of(file_in_binary)};base64,#{base64_encoded_image_data}"
+    html_strings = ["src=\"#{src_string}\""]
+    html_strings << "alt=\"#{alt_text}\"" if alt_text   
+    html_strings << "class=\"#{klass}\"" if klass 
+    return "<img " + html_strings.join(" ") + "/>"
   end
 
   # this method was inspired by a Alain Beauvois's StackOverflow answer: https://stackoverflow.com/a/16635245
-  def self.mime_type_of(file_path)
-    raise ArgumentError, "No file was found at #{file_path}" unless File.exist?(file_path)
+  def self.mime_type_of(image_binary_string)
     # define some regular expressions to match the most common image file types
     png = Regexp.new("\x89PNG".force_encoding("binary"))
     jpg = Regexp.new("\xff\xd8\xff\xe0\x00\x10JFIF".force_encoding("binary"))
     jpg2 = Regexp.new("\xff\xd8\xff\xe1(.*){2}Exif".force_encoding("binary"))
     # Read the first 10 bytes of the file
-    case IO.read(file_path, 10)
+    case image_binary_string[0, 10].unpack1("A*") # unpack1("A*") converts the binary string to a regular string for regex matching
     # MIME types from this list: https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types
     when /^GIF8/
       'image/gif'

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: pics_or_it_didnt_happen
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.1.5
 platform: ruby
 authors:
 - Greg Matthew Crossley
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-09 00:00:00.000000000 Z
-dependencies: []
+date: 2023-08-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: |
   Sometimes, you might want your HTML to include a one-off image file that is just for one person. Making this file public may be undesireable for security reasons, or perhaps simply because it is not worth the overhead of multiple HTTP requests.
   This gem provides a utility method that takes a locally-saved image file, perhaps within your non-public tmp directory, encodes it as Base64, and returns an HTML <img> element with the correct data URL attributes.
@@ -43,7 +57,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.8
+rubygems_version: 3.4.14
 signing_key:
 specification_version: 4
 summary: A Ruby gem that lets you include images in HTML using data URLs (and avoid