middleman-inline_svg 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b49a12d26d8348e8b53221b507f314679359a4df62168b4b684fba31ee1a20a7
+  data.tar.gz: 802be13e0118f08a60ded737f93855e00d886dd7200cd27f4e6dd6083dd2a113
+SHA512:
+  metadata.gz: 625460b52c1b49dbb1faabbc3d35944b4adac21beed1af786fe3f47ba34460c1e86fbec6bd4c495c0c076533d242138590027a4c0e6bdbc794c818c4d61a003d
+  data.tar.gz: 0e81268e23410e0e761816be3ba4983c23452434af31bb267628f3cfb6610e670ba40f99db6b7b003c0324a72b7f2c360ed5a3607e65da0e61630376c434d5dd

data/.circleci/config.yml

@@ -0,0 +1,36 @@
+version: 2
+jobs:
+  build:
+    docker:
+       - image: circleci/ruby:2.5.1-node
+
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+
+      - restore_cache:
+          keys:
+          - v1-dependencies-{{ checksum "Gemfile" }}
+          - v1-dependencies-
+
+      - run:
+          name: install dependencies
+          command: |
+            bundle install --path vendor/bundle
+
+      - save_cache:
+          paths:
+            - ./vendor/bundle
+          key: v1-dependencies-{{ checksum "Gemfile" }}
+
+      - run:
+          name: run tests
+          command: |
+            bundle exec rake
+
+      - store_test_results:
+          path: /tmp/test-results
+      - store_artifacts:
+          path: /tmp/test-results
+          destination: test-results

data/.gitignore

@@ -0,0 +1,5 @@
+# Ignore bundler lock file
+/Gemfile.lock
+
+# Ignore pkg folder
+/pkg

data/Gemfile

@@ -0,0 +1,16 @@
+# If you do not have OpenSSL installed, update
+# the following line to use "http://" instead
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in middleman-inline_svg.gemspec
+gemspec
+
+group :development do
+  gem "rake"
+  gem "rdoc"
+  gem "yard"
+end
+
+group :test do
+  gem "minitest"
+end

data/README.md

@@ -0,0 +1,4 @@
+# Middleman Inline SVG
+
+[![CircleCI](https://circleci.com/gh/thoughtbot/middleman-inline_svg.svg?style=svg)](https://circleci.com/gh/thoughtbot/middleman-inline_svg)
+

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler"
+Bundler::GemHelper.install_tasks
+
+require "rake/clean"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.pattern = "test/**/*_test.rb"
+end
+
+task default: :test

data/features/support/env.rb

@@ -0,0 +1,4 @@
+PROJECT_ROOT_PATH = File.dirname(File.dirname(File.dirname(__FILE__)))
+require "middleman-core"
+require "middleman-core/step_definitions"
+require File.join(PROJECT_ROOT_PATH, "lib", "middleman-inline_svg")

data/lib/middleman-inline_svg.rb

@@ -0,0 +1,5 @@
+require "middleman-core"
+require "middleman-inline_svg/inline_svg"
+require "middleman-inline_svg/middleman-inline_svg"
+
+::Middleman::Extensions.register(:inline_svg, MiddlemanInlineSVG)

data/lib/middleman-inline_svg/inline_svg.rb

@@ -0,0 +1,42 @@
+require "nokogiri"
+
+class InlineSVG
+  attr_reader :file_name, :options, :title
+
+  def initialize(file_name, options = {})
+    @file_name = file_name
+    @title = options.delete(:title)
+    @options = options
+  end
+
+  def to_html
+    doc = asset_doc(file_name)
+    svg = doc.at_css("svg")
+
+    if title
+      add_title(doc, svg, title)
+    end
+
+    options.each do |key, value|
+      svg[key.to_s.tr("_", "-")] = value
+    end
+
+    doc.to_html
+  end
+
+  private
+
+  def add_title(doc, svg, title)
+    title_node = ::Nokogiri::XML::Node.new "title", doc
+    title_node.content = title
+
+    svg.search("title").each(&:remove)
+    svg.prepend_child(title_node)
+  end
+
+  def asset_doc(file_name)
+    File.open(file_name) do |f|
+      ::Nokogiri::XML(f)
+    end
+  end
+end

data/lib/middleman-inline_svg/middleman-inline_svg.rb

@@ -0,0 +1,19 @@
+require "middleman-inline_svg/inline_svg"
+
+class MiddlemanInlineSVG < ::Middleman::Extension
+  expose_to_template :inline_svg
+
+  def initialize(app, options_hash = {}, &block)
+    super
+  end
+
+  def inline_svg(file_name, options = {})
+    InlineSVG.new(asset_file(file_name), options).to_html
+  end
+
+  private
+
+  def asset_file(file_name)
+    File.join(app.config[:source], app.config[:images_dir], file_name)
+  end
+end

data/middleman-inline_svg.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+
+$:.push File.expand_path("lib", __dir__)
+
+Gem::Specification.new do |s|
+  s.name        = "middleman-inline_svg"
+  s.version     = "0.1.0"
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Daniel Barber", "Tyson Gach"]
+  s.email       = ["github@danbarber.me", "tyson@thoughtbot.com"]
+  # s.homepage    = "http://example.com"
+  s.summary     = "Inline your SVG's"
+  s.description = "Inline your SVG's and style them with CSS."
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map do |f|
+    File.basename(f)
+  end
+  s.require_paths = ["lib"]
+
+  # The version of middleman-core your extension depends on
+  s.add_runtime_dependency("middleman-core", [">= 3.4.1"])
+
+  # Additional dependencies
+  s.add_runtime_dependency("nokogiri", [">= 1.8"])
+end

data/test/fixtures/circle.svg

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg width="64px" height="64px" viewBox="0 0 64 64" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
+  <circle id="Oval" fill="#000000" cx="32" cy="32" r="30"></circle>
+</svg>

data/test/middleman-inline_svg/inline_svg_test.rb

@@ -0,0 +1,67 @@
+require "minitest/autorun"
+
+require_relative "../../lib/middleman-inline_svg/inline_svg"
+
+class TestInlineSVG < Minitest::Test
+  def test_it_adds_a_title
+    new_svg = InlineSVG.new(
+      "test/fixtures/circle.svg",
+      title: "Circle",
+    ).to_html
+
+    expected_svg = <<~SVG
+      <svg xmlns=\"http://www.w3.org/2000/svg\" xmlns:xlink=\"http://www.w3.org/1999/xlink\" width=\"64px\" height=\"64px\" viewBox=\"0 0 64 64\" version=\"1.1\"><title>Circle</title>
+        <circle id="Oval" fill="#000000" cx="32" cy="32" r="30"></circle>
+      </svg>
+    SVG
+
+    assert_equal new_svg, expected_svg
+  end
+
+  def test_it_adds_a_class
+    new_svg = InlineSVG.new(
+      "test/fixtures/circle.svg",
+      class: "circle",
+    ).to_html
+
+    expected_svg = <<~SVG
+      <svg xmlns=\"http://www.w3.org/2000/svg\" xmlns:xlink=\"http://www.w3.org/1999/xlink\" width=\"64px\" height=\"64px\" viewBox=\"0 0 64 64\" version=\"1.1\" class="circle">
+        <circle id="Oval" fill="#000000" cx="32" cy="32" r="30"></circle>
+      </svg>
+    SVG
+
+    assert_equal new_svg, expected_svg
+  end
+
+  def test_it_adds_multiple_attributes
+    new_svg = InlineSVG.new(
+      "test/fixtures/circle.svg",
+      class: "circle",
+      role: "img",
+      id: "circle",
+    ).to_html
+
+    expected_svg = <<~SVG
+      <svg xmlns=\"http://www.w3.org/2000/svg\" xmlns:xlink=\"http://www.w3.org/1999/xlink\" width=\"64px\" height=\"64px\" viewBox=\"0 0 64 64\" version=\"1.1\" class="circle" role="img" id="circle">
+        <circle id="Oval" fill="#000000" cx="32" cy="32" r="30"></circle>
+      </svg>
+    SVG
+
+    assert_equal new_svg, expected_svg
+  end
+
+  def test_it_transforms_attribute_names
+    new_svg = InlineSVG.new(
+      "test/fixtures/circle.svg",
+      aria_hidden: true,
+    ).to_html
+
+    expected_svg = <<~SVG
+      <svg xmlns=\"http://www.w3.org/2000/svg\" xmlns:xlink=\"http://www.w3.org/1999/xlink\" width=\"64px\" height=\"64px\" viewBox=\"0 0 64 64\" version=\"1.1\" aria-hidden="true">
+        <circle id="Oval" fill="#000000" cx="32" cy="32" r="30"></circle>
+      </svg>
+    SVG
+
+    assert_equal new_svg, expected_svg
+  end
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: middleman-inline_svg
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Daniel Barber
+- Tyson Gach
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-04-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: middleman-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.1
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.8'
+description: Inline your SVG's and style them with CSS.
+email:
+- github@danbarber.me
+- tyson@thoughtbot.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- features/support/env.rb
+- lib/middleman-inline_svg.rb
+- lib/middleman-inline_svg/inline_svg.rb
+- lib/middleman-inline_svg/middleman-inline_svg.rb
+- middleman-inline_svg.gemspec
+- test/fixtures/circle.svg
+- test/middleman-inline_svg/inline_svg_test.rb
+homepage: 
+licenses: []
+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.7.3
+signing_key: 
+specification_version: 4
+summary: Inline your SVG's
+test_files:
+- features/support/env.rb
+- test/fixtures/circle.svg
+- test/middleman-inline_svg/inline_svg_test.rb