svg-inline-file-extractor 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0feae27fb66bafc1a0c95732d827ddf71b77de1b
-  data.tar.gz: 3baa5d724f218bf1306b0233eed38f92b0db94c2
+  metadata.gz: 9d00a790a3ec3da8c4479e4fe41d6dbc671dd8c4
+  data.tar.gz: 8c847625e736043a775a29d36eca99c0cfd598c7
 SHA512:
-  metadata.gz: bc98bbe216a2720b9ada047d1e55453933399668bd0c8e8dbba26d15c07b1a494d3d8d4417afda4a339da9bdc20e6c0d95cb19aa139d538339ffb7bc899cd800
-  data.tar.gz: 540f23bdea3008b93b15f9e03e497343296250f34b046a876d3183bfc188816e3b54f8eb5f3662609ad05dd610441766be42f65198e9eb67981716420f2fa4b0
+  metadata.gz: 9f7f7dd525f41ad3851b229a1fdb0c1ba98e84b4faa8a63214116daf24502ba26d2441e75a74974a298b1db0213e5bc4ee3c6ce5fbec81b79611c9481eaad7dc
+  data.tar.gz: ffd6c4b4ff0aa005f59224788266e2d6f6d50c75564d91a96735d7223a404f5655a45de055298a1362f65567e1d0192d281c0c1322972d5159a5aea312203974

data/lib/svg_inline_file_extractor.rb

@@ -3,6 +3,7 @@ require "svg_inline_file_extractor/svg_file"
 require "svg_inline_file_extractor/inline_image"
 
 module SvgInlineFileExtractor
+  class MiniMagickMissing < StandardError; end
 
   # @param [ String ] xml_string should be a full raw SVG file
   # @return [ Array<String> ] an array of binary strings containing the images in the SVG file
@@ -16,5 +17,34 @@ module SvgInlineFileExtractor
   def self.inline_images(xml_string)
     SvgFile.inline_images(xml_string)
   end
-  
+
+  # @param [ String ] uri a URI to open and identify.
+  # @return [ String | Nil ] image type determined by MiniMagick.
+  # @note will return nil if MiniMagick is not present
+  def self.identify_image(uri)
+    if use_mini_magick?
+      return with_temp_image(uri) do |temp_image|
+        MiniMagick::Image.open(temp_image).type.downcase
+      end
+    end
+  end
+
+  # @return [ Boolean ] true if MiniMagick is found, false if not.
+  def self.use_mini_magick?
+    Object.const_defined?('MiniMagick::Image')
+  end
+
+  # do something with a temporary copy of uri in a block.
+  # @param [ String ] uri - the location of the file to open into a temp file. 
+  def self.with_temp_image(uri)
+    temp = Tempfile.new
+    temp.binmode
+    puts "opening #{uri}"
+    temp.write open(uri).binmode.read
+    temp.close
+    results = yield temp.path
+    temp.delete
+    results
+  end
+
 end

data/lib/svg_inline_file_extractor/inline_image.rb

@@ -1,8 +1,8 @@
 require 'base64'
+require 'open-uri'
 
 module SvgInlineFileExtractor
   class InlineImage
-    class UnableToDetermineImageTypeError < StandardError; end
 
     # Regex pattern to match against the beginning of the href string.  the type, if found, will be the raw string, eg: jpeg, jpg, png, etc.
     DATA_IMAGE_HEADER_PATTERN = /data:image\/(?<type>.+);base64\,/.freeze
@@ -17,8 +17,7 @@ module SvgInlineFileExtractor
       self.href_contents = nokogiri_element.value
     end
 
-    # @return [ String ] The image type according to the DATA_IMAGE_HEADER_PATTERN
-    # @raise [ UnableToDetermineImageTypeError ] will raise if regex doesn't match.
+    # @return [ String|Nil ] The image type according to the DATA_IMAGE_HEADER_PATTERN, nil if pattern not matched.
     def declared_image_type
       @declared_image_type ||= begin
         if (match = href_contents.match(DATA_IMAGE_HEADER_PATTERN))
@@ -27,6 +26,7 @@ module SvgInlineFileExtractor
       end
     end
 
+    # @return [ Boolean ] true if declared_image_type is not nil
     def inline_image?
       !!declared_image_type
     end
@@ -48,9 +48,11 @@ module SvgInlineFileExtractor
       attribute.value if attribute
     end
 
-    # Updates the contents of the href that this inline image came from
+    # Updates the contents of the href that this inline image came from,
+    #  and #href_contents
     # @param [ String ] value the value to set the href contents to
-    def svg_href_contents=(value)
+    def href_contents=(value)
+      @href_contents = value
       nokogiri_element.value = value
     end
 
@@ -60,8 +62,28 @@ module SvgInlineFileExtractor
       @binary_image ||= Base64.decode64(without_header)
     end
 
+    # If the image href is set to a URI, attempt to download/open and convert to an
+    #  base64 encoded inline image
+    # @return [ Boolean ] true
+    # @raise [ SvgInlineFileExtractor::MiniMagickMissing ] if MiniMagick is not installed/required.
+    def set_binary_image_from_uri!
+      unless SvgInlineFileExtractor.use_mini_magick?
+        raise MiniMagickMissing, '#set_binary_image_from_uri! requires the MiniMagick gem to be installed.'
+      end
+      SvgInlineFileExtractor.with_temp_image(nokogiri_element.value) do |temp_image|
+        format = SvgInlineFileExtractor.identify_image(temp_image).to_s.downcase
+        nokogiri_element.value = "data:image/#{format};base64,#{encode(temp_image)}"
+        nokogiri_element.name = 'xlink:href'
+      end
+      true
+    end
+
     private
 
+    def encode(image_path)
+      Base64.encode64(File.open(image_path.to_s).binmode.read)
+    end
+
     def without_header
       @without_header ||= href_contents.gsub(DATA_IMAGE_HEADER_PATTERN, '')
     end

data/lib/svg_inline_file_extractor/svg_file.rb

@@ -37,16 +37,25 @@ module SvgInlineFileExtractor
       end
     end
 
+    # @param [ Boolean ] false returns only inline base64 encoded images, true returns all image tags
     # @return [ Array<InlineImage> ] an array of the inline images found in the document
     # @see InlineImage
-    def inline_images
+    def inline_images(all = false)
       image_elements.map do |element|
-        if (image = InlineImage.new(element)).inline_image?
+        image = InlineImage.new(element)
+        if all || image.inline_image?
           image
         end
       end.compact
     end
 
+    # @return the rendered nokogiri_document.
+    # @note text "&#10;" will be replaced with newlines to allow newlines in Base64
+    #   encoded strings.
+    def rendered_svg
+      nokogiri_document.to_s.gsub('&#10;', "\n")
+    end
+
     private
 
     def image_elements

data/lib/svg_inline_file_extractor/version.rb

@@ -1,3 +1,3 @@
 module SvgInlineFileExtractor
-  VERSION = "0.2.2"
+  VERSION = "0.2.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: svg-inline-file-extractor
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Nic Boie
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-30 00:00:00.000000000 Z
+date: 2016-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri