Skip to content

Latest commit

 

History

History
73 lines (46 loc) · 2.82 KB

README.md

File metadata and controls

73 lines (46 loc) · 2.82 KB
Raw

Svg Inline File Extractor

Build Status Test Coverage Code Climate

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. 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.

See the SVG Inline Image Extraction and Replacement With Ruby blog post for more details.

Roadmap

  • 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.3.x, 2.2.x and 2.1.x

Add this line to your application's Gemfile:

gem 'svg-inline-file-extractor'

And then execute:

$ bundle

Or install it yourself as:

$ gem install svg-inline-file-extractor

Usage

Example

from bin/console

require 'svg_inline_file_extractor'

# open a file
# set path to an SVG file (example file in the gem under spec/fixtures)
# 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

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/boie0025/svg_inline_file_extractor. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.