rsqip 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f38434f30d936a77fa64cd8cb8779fcd0d77f78c
+  data.tar.gz: 640b40ebe94daf1e385aa0bcff9854d76a42c51b
+SHA512:
+  metadata.gz: b6c0707a0f90c3538ead49f4327466f08d1cf338c687ebd1a0548a3b0825908c9a8e3d614dff80701b298220cc0681822fd2f8ffbd3b216b2d52b5751c3dcd14
+  data.tar.gz: a7f39a6b1b4b2d05e5a8828a4789bcb93100e9c3aaf3606dddbf3843a3139b59bd6bf5162d033a0c82b7fcc0d1184f77f9cae0fb20f8df05cd7c5d70918722ea

data/README.md

@@ -0,0 +1,39 @@
+RSQIP - SVG-Based Image Placeholder... in ruby
+====================
+## Overview
+
+Ruby port of npm's [sqip](https://github.com/technopagan/sqip) wrapping primitive and svgo
+
+
+## Requirements
+* Primitive (https://github.com/fogleman/primitive)
+* SVGO https://github.com/svg/svgo
+
+## Installation
+
+**TODO**
+
+```bash
+npm install -g svgo
+go get -u github.com/fogleman/primitive
+
+```
+
+## Examples
+
+**TODO**
+
+```ruby
+rsqip = Rsqip.new(filename).run
+width, height = rsqip.img_dimensions
+style = "background-size: cover; background-image: url(data:image/svg+xml;base64,${rsqip.svg_base64encoded});"
+html = %(<img width="#{width}" height="#{height}" src="#{filename}" style="#{style}" alt="Add descriptive alt text">)
+```
+
+## CLI Examples
+
+just use npm
+
+## Licence
+
+This is free and unencumbered software released into the public domain.

data/UNLICENSE.txt

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
+For more information, please refer to <http://unlicense.org/>

data/lib/rsqip/version.rb

@@ -0,0 +1,3 @@
+module Rsqip
+  VERSION = '0.0.1'.freeze
+end

data/lib/rsqip.rb

@@ -0,0 +1,113 @@
+require 'tempfile'
+require 'base64'
+require 'dimensions'
+
+class Rsqip
+  # Example:
+  #   >> Rsqip.new('/tmp/picture.png').run.final_svg
+  #   => <svg ...
+  #
+  #   >> Rsqip.new('/tmp/picture.png').run.svg_base64encoded
+  #   => PHN2ZyB4bWxucz0ia ...
+  #
+  #   >> Rsqip.new('/tmp/picture.png').run.as_hash
+  #   => { img_dimensions: [300, 100],
+  #        final_svg: '<?xml version="1.0"?><svg ...',
+  #        svg_base64encoded: 'PHN2ZyB4bWxucz0ia ...' }
+  #
+  def initialize(input_filename, number_of_primitives: 8)
+    @input_filename = input_filename
+    @number_of_primitives = number_of_primitives
+
+    unless system('type', 'primitive')
+      raise 'Please ensure that Primitive (https://github.com/fogleman/primitive, written in Golang) is installed and globally available'
+    end
+
+    unless system('type', 'svgo')
+      raise 'Please ensure that Svgo (https://github.com/svg/svgo, written in Nodejs) is installed and globally available'
+    end
+  end
+
+  def run
+    @primitive_output_filename = new_tmpname(@input_filename) + '.svg'
+    run_primitive(@input_filename,
+                  @primitive_output_filename,
+                  @number_of_primitives,
+                  geometry_of(*img_dimensions))
+
+    @svgo_output_filename = new_tmpname(@input_filename) + '.svg'
+    run_svgo(@primitive_output_filename, @svgo_output_filename)
+
+    self
+  end
+
+  def img_dimensions
+    @img_dimensions ||= Dimensions.dimensions(@input_filename)
+  end
+
+  def final_svg
+    @final_svg ||= replace_attrs(File.read(@svgo_output_filename), *img_dimensions)
+  end
+
+  def svg_base64encoded
+    @svg_base64encoded ||= Base64.encode64(@final_svg).delete("\n")
+  end
+
+  def as_hash
+    { img_dimensions: img_dimensions,
+      final_svg: final_svg,
+      svg_base64encoded: svg_base64encoded }
+  end
+
+  # filenames and picture size
+  # utilities
+  #
+  def new_tmpname(filename)
+    Dir::Tmpname.make_tmpname(*split_basename_extension(filename))
+  end
+
+  def split_basename_extension(filename)
+    fparts = filename.split('/').last.split('.')
+    [fparts[0..-2].join('.'), fparts.last]
+  end
+
+  def geometry_of(width, height)
+    width > height ? width : height
+  end
+
+  # binary interfaces
+  # to primitive and svgo
+  #
+  def run_primitive(input, output, number_of_primitives, size)
+    system('primitive',
+           '-i', input,
+           '-o', output,
+           '-n', number_of_primitives.to_s,
+           '-m', '0',
+           '-s', size.to_s)
+  end
+
+  def run_svgo(input, ouput)
+    system('svgo',
+           input,
+           '--multipass',
+           '-p', '1',
+           '-o', ouput)
+  end
+
+  # Add viewbox and preserveAspectRatio attributes
+  # as well as a Gaussian Blur filter to the SVG
+  #
+  # original comment:
+  # We initially worked with a proper DOM parser to
+  # manipulate the SVG's XML, but it was very opinionated
+  # about SVG syntax and kept introducing unwanted tags.
+  # So we had to resort to RegEx replacements
+  def replace_attrs(svg, width, height)
+    ratio = '<svg xmlns="http://www.w3.org/2000/svg"' +
+            %(viewBox="0 0 #{width} #{height}">)
+    blur = '<filter id="b"><feGaussianBlur stdDeviation="12" /></filter>'
+    svg.sub(/(<svg)(.*?)(>)/, ratio + blur)
+       .gsub(/(<g)/, '<g filter="url(#b)"')
+  end
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: rsqip
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Guilhem Augendre
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-11-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dimensions
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+description: Ruby port of SVG LQIP
+email: guilhem@augendre.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- UNLICENSE.txt
+- lib/rsqip.rb
+- lib/rsqip/version.rb
+homepage: http://rubygems.org/gems/rsqip
+licenses:
+- UNLICENSE
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: ruby sqip
+test_files: []