middleman-svg 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f75c7508eeb8091388a6d0a5750f3fbc99f4bcb9
+  data.tar.gz: 99e5f0b678180819ce60c8e61b3f48b9960bf7cb
+SHA512:
+  metadata.gz: fb03d634937ca902f894c58e0c4137730ddfd741aaf701a8213907efc6b8b902197d53e210fc258bbe41214e4dd0355df1d2be36f2efed15ba23b66e1db43d25
+  data.tar.gz: 9b44f0013e1b41c2702ab6094916a2a8db60b483b58934e053f3e9d98ca1fe89c04541f9e4fcef52506108510a5ba5d5b53a470782987c0fc0d1201e97f3a98d

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at giacomello.damiano@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in middleman-test.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Damiano Giacomello
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+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 OR COPYRIGHT HOLDERS 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.

data/README.md

@@ -0,0 +1,79 @@
+# Middleman::Svg
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'middleman-svg'
+```
+
+And then execute:
+
+    $ bundle install
+
+Add this line to your config.rb:
+
+```ruby
+activate :inline_svg
+```
+
+## Usage
+
+Styling a SVG document with CSS for use on the web is most reliably achieved by adding classes to the document and embedding it inline in the HTML.
+This gem adds a Middleman helper method (inline_svg) that reads an SVG document, applies a CSS class attribute to the root of the document and then embeds it into a view.
+
+```ruby
+inline_svg "file.svg", class: "some-class"
+```
+
+## Options
+
+key                     | description
+:---------------------- | :----------
+`id`                    | set a ID attribute on the SVG
+`class`                 | set a CSS class attribute on the SVG
+`style`                 | set a CSS style attribute on the SVG
+`data`                  | add data attributes to the SVG (supply as a hash)
+`size`                  | set width and height attributes on the SVG <br/> Can also be set using `height` and/or `width` attributes, which take precedence over `size` <br/> Supplied as "{Width} * {Height}" or "{Number}", so "30px\*45px" becomes `width="30px"` and `height="45px"`, and "50%" becomes `width="50%"` and `height="50%"`
+`title`                 | add a \<title\> node inside the top level of the SVG document
+`desc`                  | add a \<desc\> node inside the top level of the SVG document
+`nocomment`             | remove comment tags from the SVG document
+`preserve_aspect_ratio` | adds a `preserveAspectRatio` attribute to the SVG
+`aria`                  | adds common accessibility attributes to the SVG
+`aria_hidden`           | adds the `aria-hidden=true` attribute to the SVG
+
+Example:
+
+```ruby
+inline_svg(
+  "some-document.svg",
+  id: 'some-id',
+  class: 'some-class',
+  data: {some: "value"},
+  size: '30% * 20%',
+  title: 'Some Title',
+  desc: 'Some description',
+  nocomment: true,
+	no_defs: true,
+  preserve_aspect_ratio: 'xMaxYMax meet',
+  aria: true,
+  aria_hidden: true
+)
+```
+
+## 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](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/middleman-svg. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "middleman/svg"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/middleman-svg.rb

@@ -0,0 +1,4 @@
+require 'middleman-core'
+require 'middleman/svg'
+
+Middleman::Extensions.register(:inline_svg, Middleman::Svg::Extension)

data/lib/middleman/svg.rb

@@ -0,0 +1,13 @@
+require 'middleman/svg/version'
+require 'middleman/svg/extension'
+
+require "middleman/svg/asset_file"
+require "middleman/svg/transform_pipeline"
+require "middleman/svg/io_resource"
+
+require 'nokogiri'
+
+module Middleman
+  module Svg
+  end
+end

data/lib/middleman/svg/asset_file.rb

@@ -0,0 +1,14 @@
+module Middleman::Svg
+  class AssetFile
+    class FileNotFound < IOError; end
+    UNREADABLE_PATH = ''
+
+    def self.named(filename)
+      root = Middleman::Application.root
+      source_path = File.join(root, 'source')
+      File.read(File.join(source_path, 'images', source) || File.join(source_path, 'fonts/svg', source) || UNREADABLE_PATH)
+    rescue Errno::ENOENT
+      raise FileNotFound.new("Asset not found: #{asset_path}")
+    end
+  end
+end

data/lib/middleman/svg/extension.rb

@@ -0,0 +1,66 @@
+require 'middleman-core'
+
+module Middleman
+  module Svg
+    class Extension < ::Middleman::Extension
+      expose_to_template :inline_svg
+
+      def initialize( app, options_hash={}, &block)
+        super
+
+        require 'active_support/core_ext/string'
+      end
+
+      def inline_svg(filename, transform_params={})
+        begin
+          svg_file = Middleman::Svg::Extension.read_svg(filename)
+        rescue Middleman::Svg::AssetFile::FileNotFound
+          return Middleman::Svg::Extension.placeholder(filename) unless transform_params[:fallback].present?
+
+          if transform_params[:fallback].present?
+            begin
+              svg_file = Middleman::Svg::Extension.read_svg(transform_params[:fallback])
+            rescue Middleman::Svg::AssetFile::FileNotFound
+              Middleman::Svg::Extension.placeholder(filename)
+            end
+          end
+        end
+
+        Middleman::Svg::TransformPipeline.generate_html_from(svg_file, transform_params).html_safe
+      end
+
+      def self.read_svg(filename)
+        if Middleman::Svg::IOResource === filename
+          Middleman::Svg::IOResource.read filename
+        else
+          Middleman::Svg::Extension.asset_path(filename)
+        end
+      end
+
+      def self.asset_path(source)
+        root = Middleman::Application.root
+        source_path = File.join(root, 'source')
+        if File.exists?(File.join(source_path, 'images', source))
+          File.read(File.join(source_path, 'images', source))
+        elsif File.exists?(File.join(source_path, 'fonts/svg', source))
+          File.read(File.join(source_path, 'fonts/svg', source))
+        end
+      end
+
+      def self.placeholder(filename)
+        css_class = Middleman::Svg.configuration.svg_not_found_css_class
+        not_found_message = "'#{filename}' #{Middleman::Svg::Extension.extension_hint(filename)}"
+
+        if css_class.nil?
+          return "<svg><!-- SVG file not found: #{not_found_message}--></svg>".html_safe
+        else
+          return "<svg class='#{css_class}'><!-- SVG file not found: #{not_found_message}--></svg>".html_safe
+        end
+      end
+
+      def self.extension_hint(filename)
+        filename.ends_with?(".svg") ? "" : "(Try adding .svg to your filename) "
+      end
+    end
+  end
+end

data/lib/middleman/svg/id_generator.rb

@@ -0,0 +1,17 @@
+module Middleman
+  module Svg
+    class IdGenerator
+      class Randomness
+        require "securerandom"
+        def self.call
+          SecureRandom.hex(10)
+        end
+      end
+
+      def self.generate(base, salt, randomness: Randomness)
+        bytes = Digest::SHA1.digest("#{base}-#{salt}-#{randomness.call}")
+        Digest.hexencode(bytes).to_i(16).to_s(36)
+      end
+    end
+  end
+end

data/lib/middleman/svg/io_resource.rb

@@ -0,0 +1,23 @@
+module Middleman
+  module Svg
+    module IOResource
+      def self.===(object)
+        object.is_a?(IO) || object.is_a?(StringIO)
+      end
+
+      def self.default_for(object)
+        case object
+          when StringIO then ''
+          when IO then 1
+        end
+      end
+
+      def self.read(object)
+        start = object.pos
+        str = object.read
+        object.seek start
+        str
+      end
+    end
+  end
+end

data/lib/middleman/svg/transform_pipeline.rb

@@ -0,0 +1,12 @@
+module Middleman::Svg::TransformPipeline
+  def self.generate_html_from(svg_file, transform_params)
+    document = Nokogiri::XML::Document.parse(svg_file)
+    Transformations.lookup(transform_params).reduce(document) do |doc, transformer|
+      transformer.transform(doc)
+    end.to_html
+  end
+end
+
+require 'nokogiri'
+require 'middleman/svg/id_generator'
+require 'middleman/svg/transform_pipeline/transformations'

data/lib/middleman/svg/transform_pipeline/transformations.rb

@@ -0,0 +1,77 @@
+module Middleman::Svg::TransformPipeline::Transformations
+  # Transformations are run in priority order, lowest number first:
+  def self.built_in_transformations
+    {
+      id: { transform: IdAttribute, priority: 1 },
+      desc: { transform: Description, priority: 2 },
+      title: { transform: Title, priority: 3 },
+      aria: { transform: AriaAttributes },
+      aria_hidden: { transform: AriaHiddenAttribute },
+      class: { transform: ClassAttribute },
+      style: { transform: StyleAttribute },
+      data: { transform: DataAttributes },
+      height: { transform: Height },
+      nocomment: { transform: NoComment },
+      no_defs: { transform: NoDefs },
+      preserve_aspect_ratio: { transform: PreserveAspectRatio },
+      size: { transform: Size },
+      width: { transform: Width },
+    }
+  end
+
+  def self.magnify_priorities(transforms)
+    transforms.inject({}) do |output, (name, definition)|
+      priority = definition.fetch(:priority, built_in_transformations.size)
+
+      output[name] = definition.merge( { priority: magnify(priority) } )
+      output
+    end
+  end
+
+  def self.magnify(priority=0)
+    (priority + 1) * built_in_transformations.size
+  end
+
+  def self.all_transformations
+    in_priority_order(built_in_transformations)
+  end
+
+  def self.lookup(transform_params)
+    all_transformations.map { |name, definition|
+      value = params_with_defaults(transform_params)[name]
+      definition.fetch(:transform, no_transform).create_with_value(value) if value
+    }.compact
+  end
+
+  def self.in_priority_order(transforms)
+    transforms.sort_by { |_, options| options.fetch(:priority, transforms.size) }
+  end
+
+  def self.params_with_defaults(params)
+    without_empty_values(params)
+  end
+
+  def self.without_empty_values(params)
+    params.reject {|key, value| value.nil?}
+  end
+
+  def self.no_transform
+    Middleman::Svg::TransformPipeline::Transformations::NullTransformation
+  end
+end
+
+require 'middleman/svg/transform_pipeline/transformations/transformation'
+require 'middleman/svg/transform_pipeline/transformations/no_defs'
+require 'middleman/svg/transform_pipeline/transformations/no_comment'
+require 'middleman/svg/transform_pipeline/transformations/class_attribute'
+require 'middleman/svg/transform_pipeline/transformations/style_attribute'
+require 'middleman/svg/transform_pipeline/transformations/title'
+require 'middleman/svg/transform_pipeline/transformations/description'
+require 'middleman/svg/transform_pipeline/transformations/size'
+require 'middleman/svg/transform_pipeline/transformations/height'
+require 'middleman/svg/transform_pipeline/transformations/width'
+require 'middleman/svg/transform_pipeline/transformations/id_attribute'
+require 'middleman/svg/transform_pipeline/transformations/data_attributes'
+require 'middleman/svg/transform_pipeline/transformations/preserve_aspect_ratio'
+require 'middleman/svg/transform_pipeline/transformations/aria_attributes'
+require "middleman/svg/transform_pipeline/transformations/aria_hidden_attribute"

data/lib/middleman/svg/transform_pipeline/transformations/aria_attributes.rb

@@ -0,0 +1,32 @@
+module Middleman::Svg::TransformPipeline::Transformations
+  class AriaAttributes < Transformation
+    def transform(doc)
+      with_svg(doc) do |svg|
+        # Add role
+        svg["role"] = "img"
+
+        # Build aria-labelledby string
+        aria_elements = []
+        svg.search("title").each do |element|
+          aria_elements << element["id"] = element_id_for("title", element)
+        end
+
+        svg.search("desc").each do |element|
+          aria_elements << element["id"] = element_id_for("desc", element)
+        end
+
+        if aria_elements.any?
+          svg["aria-labelledby"] = aria_elements.join(" ")
+        end
+      end
+    end
+
+    def element_id_for(base, element)
+      if element["id"].nil?
+        Middleman::Svg::IdGenerator.generate(base, element.text)
+      else
+        Middleman::Svg::IdGenerator.generate(element["id"], element.text)
+      end
+    end
+  end
+end

data/lib/middleman/svg/transform_pipeline/transformations/aria_hidden.rb

@@ -0,0 +1,9 @@
+module Middleman::Svg::TransformPipeline::Transformations
+  class AriaHidden < Transformation
+    def transform(doc)
+      with_svg(doc) do |svg|
+        svg["aria-hidden"] = self.value
+      end
+    end
+  end
+end

data/lib/middleman/svg/transform_pipeline/transformations/aria_hidden_attribute.rb

@@ -0,0 +1,9 @@
+module Middleman::Svg::TransformPipeline::Transformations
+  class AriaHiddenAttribute < Transformation
+    def transform(doc)
+      with_svg(doc) do |svg|
+        svg["aria-hidden"] = self.value
+      end
+    end
+  end
+end

data/lib/middleman/svg/transform_pipeline/transformations/class_attribute.rb

@@ -0,0 +1,11 @@
+module Middleman::Svg::TransformPipeline::Transformations
+  class ClassAttribute < Transformation
+    def transform(doc)
+      with_svg(doc) do |svg|
+        classes = (svg["class"] || "").split(" ")
+        classes << value
+        svg["class"] = classes.join(" ")
+      end
+    end
+  end
+end

data/lib/middleman/svg/transform_pipeline/transformations/data_attributes.rb

@@ -0,0 +1,21 @@
+module Middleman::Svg::TransformPipeline::Transformations
+  class DataAttributes < Transformation
+    def transform(doc)
+      with_svg(doc) do |svg|
+        with_valid_hash_from(self.value).each_pair do |name, data|
+          svg["data-#{dasherize(name)}"] = data
+        end
+      end
+    end
+
+    private
+
+    def with_valid_hash_from(hash)
+      Hash.try_convert(hash) || {}
+    end
+
+    def dasherize(string)
+      string.to_s.gsub(/_/, "-")
+    end
+  end
+end

data/lib/middleman/svg/transform_pipeline/transformations/description.rb

@@ -0,0 +1,13 @@
+module Middleman::Svg::TransformPipeline::Transformations
+  class Description < Transformation
+    def transform(doc)
+      with_svg(doc) do |svg|
+        node = Nokogiri::XML::Node.new("desc", doc)
+        node.content = value
+
+        svg.search("desc").each { |node| node.remove }
+        svg.prepend_child(node)
+      end
+    end
+  end
+end

data/lib/middleman/svg/transform_pipeline/transformations/height.rb

@@ -0,0 +1,9 @@
+module Middleman::Svg::TransformPipeline::Transformations
+  class Height < Transformation
+    def transform(doc)
+      with_svg(doc) do |svg|
+        svg["height"] = self.value
+      end
+    end
+  end
+end

data/lib/middleman/svg/transform_pipeline/transformations/id_attribute.rb

@@ -0,0 +1,9 @@
+module Middleman::Svg::TransformPipeline::Transformations
+  class IdAttribute < Transformation
+    def transform(doc)
+      with_svg(doc) do |svg|
+        svg["id"] = self.value
+      end
+    end
+  end
+end

data/lib/middleman/svg/transform_pipeline/transformations/no_comment.rb

@@ -0,0 +1,13 @@
+module Middleman::Svg::TransformPipeline
+  module Transformations
+    class NoComment < Transformation
+      def transform(doc)
+        with_svg(doc) do |svg|
+          svg.xpath("//comment()").each do |comment|
+            comment.remove
+          end
+        end
+      end
+    end
+  end
+end

data/lib/middleman/svg/transform_pipeline/transformations/no_defs.rb

@@ -0,0 +1,11 @@
+module Middleman::Svg::TransformPipeline
+  module Transformations
+    class NoDefs < Transformation
+      def transform(doc)
+        with_svg(doc) do |svg|
+          svg.at_css("defs").remove if !svg.at_css("defs").blank?
+        end
+      end
+    end
+  end
+end

data/lib/middleman/svg/transform_pipeline/transformations/preserve_aspect_ratio.rb

@@ -0,0 +1,9 @@
+module Middleman::Svg::TransformPipeline::Transformations
+  class PreserveAspectRatio < Transformation
+    def transform(doc)
+      with_svg(doc) do |svg|
+        svg["preserveAspectRatio"] = self.value
+      end
+    end
+  end
+end

data/lib/middleman/svg/transform_pipeline/transformations/size.rb

@@ -0,0 +1,18 @@
+module Middleman::Svg::TransformPipeline::Transformations
+  class Size < Transformation
+    def transform(doc)
+      with_svg(doc) do |svg|
+        svg["width"] = width_of(self.value)
+        svg["height"] = height_of(self.value)
+      end
+    end
+
+    def width_of(value)
+      value.split(/\*/).map(&:strip)[0]
+    end
+
+    def height_of(value)
+      value.split(/\*/).map(&:strip)[1] || width_of(value)
+    end
+  end
+end

data/lib/middleman/svg/transform_pipeline/transformations/style_attribute.rb

@@ -0,0 +1,11 @@
+module Middleman::Svg::TransformPipeline::Transformations
+  class StyleAttribute < Transformation
+    def transform(doc)
+      with_svg(doc) do |svg|
+        styles = svg["style"].to_s.split(";")
+        styles << value
+        svg["style"] = styles.join(";")
+      end
+    end
+  end
+end

data/lib/middleman/svg/transform_pipeline/transformations/title.rb

@@ -0,0 +1,13 @@
+module Middleman::Svg::TransformPipeline::Transformations
+  class Title < Transformation
+    def transform(doc)
+      with_svg(doc) do |svg|
+        node = Nokogiri::XML::Node.new("title", doc)
+        node.content = value
+
+        svg.search("title").each { |node| node.remove }
+        svg.prepend_child(node)
+      end
+    end
+  end
+end

data/lib/middleman/svg/transform_pipeline/transformations/transformation.rb

@@ -0,0 +1,42 @@
+module Middleman
+  module Svg
+    module TransformPipeline
+      module Transformations
+        class Transformation
+          def self.create_with_value(value)
+            self.new(value)
+          end
+
+          attr_reader :value
+
+          def initialize(value)
+            @value = value
+          end
+
+          def transform(*)
+            raise "#transform should be implemented by subclasses of Transformation"
+          end
+
+          # Parses a document and yields the contained SVG nodeset to the given block
+          # if it exists.
+          #
+          # Returns a Nokogiri::XML::Document.
+          def with_svg(doc)
+            doc = Nokogiri::XML::Document.parse(
+              doc.to_html(encoding: "UTF-8"), nil, "UTF-8"
+            )
+            svg = doc.at_css("svg")
+            yield svg if svg && block_given?
+            doc
+          end
+        end
+
+        class NullTransformation < Transformation
+          def transform(doc)
+            doc
+          end
+        end
+      end
+    end
+  end
+end

data/lib/middleman/svg/transform_pipeline/transformations/width.rb

@@ -0,0 +1,9 @@
+module Middleman::Svg::TransformPipeline::Transformations
+  class Width < Transformation
+    def transform(doc)
+      with_svg(doc) do |svg|
+        svg["width"] = self.value
+      end
+    end
+  end
+end

data/lib/middleman/svg/version.rb

@@ -0,0 +1,5 @@
+module Middleman
+  module Svg
+    VERSION = "0.1.0"
+  end
+end

data/middleman-svg.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'middleman/svg/version'
+
+Gem::Specification.new do |spec|
+  spec.platform      = Gem::Platform::RUBY
+  spec.name          = "middleman-svg"
+  spec.version       = Middleman::Svg::VERSION
+  spec.authors       = ["Damiano Giacomello"]
+  spec.email         = ["giacomello.damiano@gmail.com"]
+
+  spec.summary       = "A simple helper to generate inline SVG with Middleman"
+  spec.description   = "A simple helper to generate inline SVG content with Middleman"
+  spec.homepage      = "https://github.com/cantierecreativo/middleman-svg"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_runtime_dependency "middleman-core", ">= 4.0.0"
+  spec.add_runtime_dependency "activesupport", ">= 3.0"
+  spec.add_runtime_dependency "nokogiri", ">= 1.6"
+end

data/source/images/example.svg

@@ -0,0 +1,3 @@
+<svg xmlns="http://www.w3.org/2000/svg"
+     xml:lang="en"
+     role="presentation"><!-- This is a test comment --></svg>

data/source/images/known-document-two.svg

@@ -0,0 +1 @@
+<svg>other interesting content</svg>

data/source/images/known-document.svg

@@ -0,0 +1 @@
+<svg>Another known document</svg>

data/source/images/other-document.svg

@@ -0,0 +1,3 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
+<svg>Other document</svg>

data/source/images/some-document.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24"><path d="M3.273 7.151l-2.917-2.916c-.23.665-.356 1.361-.356 2.057 0 1.608.624 3.216 1.851 4.442 1.35 1.351 3.163 1.957 4.928 1.821.933-.072 1.851.268 2.513.93l9.646 9.646c.58.579 1.338.869 2.097.869 1.636 0 2.965-1.326 2.965-2.965 0-.759-.29-1.518-.868-2.097l-9.647-9.646c-.661-.662-1.002-1.581-.93-2.514.136-1.766-.47-3.578-1.821-4.928-.372-.372-.778-.686-1.209-.945l-6.252 6.246zm18.727 13.849c0 .552-.448 1-1 1s-1-.448-1-1 .448-1 1-1 1 .447 1 1zm-12.153-13.396l-3.061 3.061-2.566-2.567 3.062-3.061 2.565 2.567zm-.933.096l-.762.761-1.705-1.705.762-.762 1.705 1.706zm-2.991-.42l-.761.762 1.706 1.705.762-.762-1.707-1.705zm2.484-6.903l-2.893 2.893-2.412-2.412c.953-.556 2.044-.858 3.165-.858.707 0 1.425.12 2.128.373l.012.004z"/></svg>

data/source/images/some-file.txt

@@ -0,0 +1 @@
+Some file contents.

metadata

@@ -0,0 +1,170 @@
+--- !ruby/object:Gem::Specification
+name: middleman-svg
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Damiano Giacomello
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-01-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: middleman-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.6'
+description: A simple helper to generate inline SVG content with Middleman
+email:
+- giacomello.damiano@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/middleman-svg.rb
+- lib/middleman/svg.rb
+- lib/middleman/svg/asset_file.rb
+- lib/middleman/svg/extension.rb
+- lib/middleman/svg/id_generator.rb
+- lib/middleman/svg/io_resource.rb
+- lib/middleman/svg/transform_pipeline.rb
+- lib/middleman/svg/transform_pipeline/transformations.rb
+- lib/middleman/svg/transform_pipeline/transformations/aria_attributes.rb
+- lib/middleman/svg/transform_pipeline/transformations/aria_hidden.rb
+- lib/middleman/svg/transform_pipeline/transformations/aria_hidden_attribute.rb
+- lib/middleman/svg/transform_pipeline/transformations/class_attribute.rb
+- lib/middleman/svg/transform_pipeline/transformations/data_attributes.rb
+- lib/middleman/svg/transform_pipeline/transformations/description.rb
+- lib/middleman/svg/transform_pipeline/transformations/height.rb
+- lib/middleman/svg/transform_pipeline/transformations/id_attribute.rb
+- lib/middleman/svg/transform_pipeline/transformations/no_comment.rb
+- lib/middleman/svg/transform_pipeline/transformations/no_defs.rb
+- lib/middleman/svg/transform_pipeline/transformations/preserve_aspect_ratio.rb
+- lib/middleman/svg/transform_pipeline/transformations/size.rb
+- lib/middleman/svg/transform_pipeline/transformations/style_attribute.rb
+- lib/middleman/svg/transform_pipeline/transformations/title.rb
+- lib/middleman/svg/transform_pipeline/transformations/transformation.rb
+- lib/middleman/svg/transform_pipeline/transformations/width.rb
+- lib/middleman/svg/version.rb
+- middleman-svg.gemspec
+- source/images/example.svg
+- source/images/known-document-two.svg
+- source/images/known-document.svg
+- source/images/other-document.svg
+- source/images/some-document.svg
+- source/images/some-file.txt
+homepage: https://github.com/cantierecreativo/middleman-svg
+licenses:
+- MIT
+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.12
+signing_key: 
+specification_version: 4
+summary: A simple helper to generate inline SVG with Middleman
+test_files: []