svg-inline-file-extractor 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 86bd56dfb132d0e44d1f43e90b90d3820d80bd94
-  data.tar.gz: 4b3ccf10067ce9769e6b9e77ad84865a2e284bdf
+  metadata.gz: e57054a34848ede24adfa1a96da697af6c73772e
+  data.tar.gz: 1be1f8c90e3ca2ea72ff156c9f672fb5f626a7ff
 SHA512:
-  metadata.gz: 7a393389a63bd08ce0909649d68b8ae3ef59e952df8ae86da881f09a2f005a2bb325869d77e2543490e429b9081c82747f19757d2891f03692548cd4eda02964
-  data.tar.gz: a026ad5434c85b87ea2f9a7be413acd49686bd597bf3446660e8d658509534101220fe450fb39879f9d27ed42314d3c6421661ddda19bb0f046bb6af1d991ff4
+  metadata.gz: 00fbda34a7c2e73661a6b98127e0912f20ceaaa5158d9e88ddda20fd7d52ab4dc2498f02160e9ea457ab86d7f80c80c405e316a8f8b627e24b4bc70383f00d16
+  data.tar.gz: 853e0003ecc94aecf6faa5da82c16020823f3f78bd4ac4c22da007e366f3adb44e185bb6eb2acca1b80604ac471102b32373a4942ab32a1418c4fa47b0663976

data/README.md

@@ -6,17 +6,20 @@
 
 The purpose of this gem is to extract inline SVG base64 encoded PNG images. This is based in part from ideas in https://gist.github.com/r10r/2822884
 
-This is a work in progress.
+This is a work in progress.  You should specify a specific version of this gem when
+using, as the interface is subject to wild change in this early phase of development.
 
 ## Roadmap
 
-* Add ability to replace an inline image with a URI after extraction
-* Extract svg_file image handling to a separate class
-* Work with more than just PNG files
+* ~~Add ability to replace an inline image with a URI after extraction~~ Done
+* ~~Extract svg_file image handling to a separate class~~ Done
+* ~~Work with more than just PNG files~~ Done
 * Query images for their type, possibly other meta
 
 ## Installation
 
+This gem is tested against Ruby 2.2.0 and 2.3.0
+
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -33,21 +36,27 @@ Or install it yourself as:
 
 ## Usage
 
+### Example
+
+from `bin/console`
+
 ```ruby
 require 'svg_inline_file_extractor'
 
 # open a file
 # set path to an SVG file (example file in the gem under spec/fixtures)
-# path = <PATH TO SOME SVG FILE WITH INLINE IMAGES>
-files = SvgInlineFileExtractor.binary_images(path: path)
-
-# Write FIRST image to a tempfile
-tf = Tempfile.new(['file','.png'])
-tf.write(files.first)
-tf.close
-
-#open the file
-`open #{tf.path}`
+# file = File.read(<PATH TO SOME SVG FILE WITH INLINE IMAGES>)
+files = SvgInlineFileExtractor.binary_images(file)
+
+# Open all the extracted files:
+files.each do |file|
+  tf = Tempfile.new(['file','.png'])
+  tf.write(file)
+  tf.close
+
+  #open the file with system open
+  `open #{tf.path}`
+end
 
 ```
 

data/lib/svg_inline_file_extractor.rb

@@ -1,8 +1,20 @@
 require "svg_inline_file_extractor/version"
 require "svg_inline_file_extractor/svg_file"
+require "svg_inline_file_extractor/inline_image"
 
 module SvgInlineFileExtractor
-  def self.binary_images(string)
-    SvgFile.binary_images(string)
+
+  # @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
+  def self.binary_images(xml_string)
+    SvgFile.binary_images(xml_string)
+  end
+
+  # @param [ String ] xml_string should be a full raw SVG file
+  # @return [ Array<InlineImage> ] an array of the inline images found in the document
+  # @see InlineImage
+  def self.inline_images(xml_string)
+    SvgFile.inline_images(xml_string)
   end
+  
 end

data/lib/svg_inline_file_extractor/inline_image.rb

@@ -0,0 +1,68 @@
+require 'base64'
+
+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
+
+    # @attr [ String ] href_contents The value extracted from the nokogiri_element (href).  May be binary.
+    # @attr [ Nokogiri::XML::Attr ] nokogiri_element the href node from the SVG file
+    attr_accessor :href_contents, :nokogiri_element
+
+    # @param [ Nokogiri::XML::Attr ] nokogiri_element the href node from the SVG file
+    def initialize(nokogiri_element)
+      self.nokogiri_element = nokogiri_element
+      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.
+    def declared_image_type
+      @declared_image_type ||= begin
+        if (match = href_contents.match(DATA_IMAGE_HEADER_PATTERN))
+          match[:type]
+        else
+          raise UnableToDetermineImageTypeError, "Unable to match header to #{DATA_IMAGE_HEADER_PATTERN}"
+        end
+      end
+    end
+
+    # @return [ String | nil ] the value of the id attribute in the parent element
+    def element_id
+      @element_id ||= get_attribute('id')
+    end
+
+    # @return [ String | nil ] the value of the class attribute in the parent element
+    def element_class
+      @element_class ||= get_attribute('class')
+    end
+
+    # @param [ String ] attribute an attribute to retreive from the parent element (the entity that this href came from)
+    # @return [ String | Nil ] the value in the specified attribute, or nil if not set
+    def get_attribute(attribute)
+      attribute = nokogiri_element.parent.attribute(attribute)
+      attribute.value if attribute
+    end
+
+    # Updates the contents of the href that this inline image came from
+    # @param [ String ] value the value to set the href contents to
+    def svg_href_contents=(value)
+      nokogiri_element.value = value
+    end
+
+    # @return [ String ] Base64 decoded binary image from href
+    # @note I'm not sure if memoization is the best here, let's see what happens in the wild.
+    def binary_image
+      @binary_image ||= Base64.decode64(without_header)
+    end
+
+    private
+
+    def without_header
+      @without_header ||= href_contents.gsub(DATA_IMAGE_HEADER_PATTERN, '')
+    end
+
+  end
+end

data/lib/svg_inline_file_extractor/svg_file.rb

@@ -5,21 +5,30 @@ module SvgInlineFileExtractor
   class SvgFile
 
     class << self
-      def binary_images(string)
-        new(string).binary_images
+      # @param [ String ] xml_string should be a full raw SVG file
+      def binary_images(xml_string)
+        new(xml_string).binary_images
       end
 
-      def strip_header_from(string)
-        string.gsub(/data:image\/...;base64\,/, '')
+      # @param [ String ] xml_string should be a full raw SVG file
+      def inline_images(xml_string)
+        new(xml_string).inline_images
       end
     end
 
     attr_accessor :xml_string
 
+    # @param [ String ] xml_string should be a full raw SVG file
     def initialize(xml_string)
       self.xml_string = xml_string
     end
 
+    # @return [ Array<String> ] an array of binary strings containing the images in the SVG file
+    def binary_images
+      inline_images.map(&:binary_image)
+    end
+
+    # @return [ Nokogiri::XML ] a nokogiri XML document wrapper
     def nokogiri_document
       @nokogiri_document ||= begin
         doc = Nokogiri::XML(xml_string)
@@ -28,11 +37,11 @@ module SvgInlineFileExtractor
       end
     end
 
-    def binary_images
+    # @return [ Array<InlineImage> ] an array of the inline images found in the document
+    # @see InlineImage
+    def inline_images
       image_elements.map do |element|
-        image_string = element.value
-        image_string = self.class.strip_header_from(image_string)
-        Base64.decode64(image_string)
+        InlineImage.new(element)
       end
     end
 

data/lib/svg_inline_file_extractor/version.rb

@@ -1,3 +1,3 @@
 module SvgInlineFileExtractor
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/svg_inline_file_extractor.gemspec

@@ -17,10 +17,13 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = '>= 2.2.0'
+
   spec.add_dependency "nokogiri", "~> 1.6"
 
   spec.add_development_dependency "bundler", "~> 1.11"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "pry", "~> 0"
+  spec.add_development_dependency "simplecov", "~> 0.12"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: svg-inline-file-extractor
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Nic Boie
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-21 00:00:00.000000000 Z
+date: 2016-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
 description: 
 email:
 - boie0025@gmail.com
@@ -98,6 +112,7 @@ files:
 - bin/console
 - bin/setup
 - lib/svg_inline_file_extractor.rb
+- lib/svg_inline_file_extractor/inline_image.rb
 - lib/svg_inline_file_extractor/svg_file.rb
 - lib/svg_inline_file_extractor/version.rb
 - svg_inline_file_extractor.gemspec
@@ -112,7 +127,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="