svg_hearts_you 0.0.1

data/fixtures/middleman-svg_hearts_you-config-style/source/circle.svg

@@ -0,0 +1,7 @@
+<?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 version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0" y="0" width="100" height="100" viewBox="0, 0, 100, 100">
+  <g id="Layer_1">
+    <path d="M50,100 C22.386,100 0,77.614 0,50 C0,22.386 22.386,0 50,-0 C77.614,-0 100,22.386 100,50 C100,77.614 77.614,100 50,100 z" fill="#4B5A65"/>
+  </g>
+</svg>

data/fixtures/middleman-svg_hearts_you-config-style/source/index.html.erb

@@ -0,0 +1,2 @@
+<h1>Test</h1>
+<%= svg_inline 'circle.svg' %>

data/lib/svg_hearts_you.rb

@@ -0,0 +1,11 @@
+begin
+  require "pry"
+rescue LoadError
+end
+
+require 'svg_hearts_you/configuration'
+require 'svg_hearts_you/module'
+require 'svg_hearts_you/helpers'
+
+require 'svg_hearts_you/railtie' if defined?(Rails)
+require 'svg_hearts_you/middleman_extension' if defined?(Middleman)

data/lib/svg_hearts_you/configuration.rb

@@ -0,0 +1,23 @@
+module SvgHeartsYou
+  class Configuration
+    attr_accessor :svg_paths
+
+    def initialize
+      @svg_paths = []
+    end
+
+    # Include asset paths / image_paths with rails / middleman
+    def all_svg_paths
+      if defined?(Rails)
+        @svg_paths + rails_paths
+      else
+        @svg_paths
+      end
+    end
+
+    private
+    def rails_paths
+      Rails.application.config.assets.paths
+    end
+  end
+end

data/lib/svg_hearts_you/helpers.rb

@@ -0,0 +1,165 @@
+require 'nokogiri'
+
+module SvgHeartsYou
+
+  def self.find_svg_file(filename)
+    configuration.all_svg_paths.each do |path|
+      file_path = File.join path, filename
+      if File.exists?(file_path)
+        return File.read file_path
+      end
+    end
+
+    # if not found, raise error
+    raise "File #{filename} not found"
+  end
+
+  def self.svgs_for_folder(folder_name)
+    configuration.all_svg_paths.each do |path|
+      folder_path = File.join path, folder_name
+      if File.exists?(folder_path) && File.directory?(folder_path)
+        Dir.chdir(folder_path)
+        return Dir.glob("*.svg*").map do |filename|
+          file_path = File.join folder_path, filename
+          { file: File.read(file_path), filename: filename }
+          # File.join(folder_name, filename)
+        end
+      end
+    end
+
+    # if not found, raise error
+    raise "Folder #{folder_name} not found"
+  end
+
+
+  module Helpers
+
+    def svg_inline(filename, options={})
+      svg_file = SvgHeartsYou::find_svg_file(filename)
+
+      doc = Nokogiri::HTML::DocumentFragment.parse(svg_file)
+      svg = doc.at_css 'svg'
+
+      # Attributes are added after
+      options.each do |key, value|
+        svg[key.to_s] = value
+      end
+
+      stringify(svg)
+    end
+
+    def svg_symbol(filename, options={})
+      folder_mode = options.delete(:folder)
+
+      if folder_mode
+        folders = [*filename]
+        read_files = []
+
+        folders.each do |folder_name|
+          read_files += SvgHeartsYou::svgs_for_folder(folder_name)
+        end
+
+        symbols = read_files.map do |file|
+          doc = Nokogiri::HTML::DocumentFragment.parse(file[:file])
+          { node: doc.at_css('svg'), filename: file[:filename] }
+        end
+      else
+        files = [*filename]
+        symbols = files.map do |file|
+          svg_file = SvgHeartsYou::find_svg_file(file)
+          doc = Nokogiri::HTML::DocumentFragment.parse(svg_file)
+          { node: doc.at_css('svg'), filename: file }
+        end
+      end
+
+      doc = Nokogiri::HTML::DocumentFragment.parse('')
+      wrapper_svg = Nokogiri::XML::Node.new 'svg', doc
+
+      wrapper_svg['version'] = '1.1'
+      wrapper_svg['xmlns'] = 'http://www.w3.org/2000/svg'
+      wrapper_svg['style'] = 'display: none;'
+
+      symbols.each do |symbol|
+        node = symbol[:node]
+
+        # Convert
+        node.name = 'symbol'
+        node['id'] = symbol[:filename].chomp('.svg')
+
+        # add `each` items here
+        if options[:each]
+          options[:each].each do |key, value|
+            node[key.to_s] = value
+          end
+        end
+
+        %w(version xmlns xmlns:xlink).each do |attr|
+          node.delete attr
+        end
+
+        if block_given?
+          attributes = {}
+          node.entries.each do |item|
+            attributes[item[0].to_sym] = item[1]
+          end
+
+          # Allow each symbol to be configured if block given
+          yield(attributes)
+
+          attributes.each do |key, value|
+            node[key.to_s] = value
+          end
+        end
+
+        wrapper_svg.add_child(node)
+      end
+
+      options.delete(:each)
+
+      # Put remaining options on parent svg tag
+      options.each do |key, value|
+        wrapper_svg[key.to_s] = value
+      end
+
+      stringify(wrapper_svg)
+    end
+
+    def svg_use(id, options={})
+      # Strip .svg extension if necessary
+      id.gsub!(/\.svg\z/, '')
+
+      # Add hash symbol to beginning if necessary
+      id = '#' + id unless id.include?('#')
+
+      doc = Nokogiri::HTML::DocumentFragment.parse <<-YAYUSE
+      <svg version="1.1" xmlns="http://www.w3.org/2000/svg">
+        <use xlink:href="#{id}">
+      </svg>
+      YAYUSE
+
+      svg = doc.at_css 'svg'
+
+      # TODO allow for the title and desc stuff
+      options.delete :title
+      options.delete :desc
+
+      options.each do |key, value|
+        svg[key.to_s] = value
+      end
+
+      stringify(svg)
+    end
+
+    private
+    def stringify(node)
+      str = node.to_html
+      str = str.html_safe if str.respond_to? :html_safe
+      str
+    end
+  end
+
+  # Add helpers as class methods on the SvgHeartsYou module
+  class << self
+    include Helpers
+  end
+end

data/lib/svg_hearts_you/middleman_extension.rb

@@ -0,0 +1,31 @@
+module SvgHeartsYou
+  module Extensions
+    class MiddlemanExtension < Middleman::Extension
+      option :svg_paths, [], 'Used to set custom search path for SvgHeartsYou gem'
+
+      def initialize(app, options_hash={}, &block)
+        super
+
+        # Configure gem if svg_paths option is set via middleman
+        if options_hash.key?(:svg_paths)
+          SvgHeartsYou.configure do |config|
+            config.svg_paths << options_hash[:svg_paths]
+          end
+        end
+      end
+
+      helpers do
+        include SvgHeartsYou::Helpers
+      end
+
+      def after_configuration
+        # Add middleman app's images_dir by default
+        SvgHeartsYou.configure do |config|
+          config.svg_paths << File.join(Dir.pwd, app.settings.source, app.settings.images_dir)
+        end
+      end
+    end
+  end
+end
+
+::Middleman::Extensions.register(:svg_hearts_you, SvgHeartsYou::Extensions::MiddlemanExtension)

data/lib/svg_hearts_you/module.rb

@@ -0,0 +1,19 @@
+module SvgHeartsYou
+  class << self
+    attr_accessor :configuration
+  end
+
+  # Allow a persistent configuration object to be set on the module
+  def self.configure
+    yield(configuration)
+  end
+
+  private
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.reset
+    @configuration = Configuration.new
+  end
+end

data/lib/svg_hearts_you/railtie.rb

@@ -0,0 +1,9 @@
+module SvgHeartsYou
+  module Extensions
+    class Railtie < ::Rails::Railtie
+      initializer 'SvgHeartsYou.add_helpers' do
+        ActionView::Base.send :include, SvgHeartsYou::Helpers
+      end
+    end
+  end
+end

data/lib/svg_hearts_you/version.rb

@@ -0,0 +1,3 @@
+module SvgHeartsYou
+  VERSION = "0.0.1"
+end

data/spec/module/configuration_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+module SvgHeartsYou
+  describe Configuration do
+    describe '#svg_path' do
+
+      it 'has a default value of nil' do
+        expect(Configuration.new.svg_paths).to eq([])
+      end
+
+      it 'can set the svg_path' do
+        config = Configuration.new
+        config.svg_paths << '/some/path';
+        expect(config.svg_paths).to eq(['/some/path'])
+      end
+    end
+  end
+end

data/spec/module/svg_hearts_you_spec.rb

@@ -0,0 +1,192 @@
+require 'spec_helper'
+
+RSpec.describe SvgHeartsYou do
+
+  let(:test_svg_path)          { File.join File.dirname(__FILE__), 'svgs' }
+  let!(:svg_file)              { 'sapphire.svg' }
+  let!(:svg_file2)             { 'circle.svg' }
+  let!(:svg_folder)            { 'shapes' }
+  let!(:svg_folder2)           { 'logos' }
+  let!(:nonexistent_svg_file)  { 'nope-nope.svg' }
+
+  let!(:unconfigured_message)  { "File #{svg_file} not found" }
+  let!(:missing_file_message)  { "File #{nonexistent_svg_file} not found" }
+
+
+  # Singleton module is messy for random order tests, so wipe state after each
+  after(:each) do
+    SvgHeartsYou.reset
+  end
+
+  # Generically tests methods (passed as symbol) that are
+  # expected to throw runtime errors
+  shared_examples 'methods that throw error on file not found' do |method|
+    it 'throws a RuntimeError when not file not found' do
+      expect{subject.send(method, svg_file)}.to raise_error(RuntimeError, unconfigured_message)
+    end
+  end
+
+  # Examples for methods that may throw error when files are missing
+  shared_examples 'method using file' do |method|
+    it 'throws a RuntimeError when file is not found' do
+      expect{subject.send(method, nonexistent_svg_file)}.to raise_error(RuntimeError, missing_file_message)
+    end
+  end
+
+  # Tests that are used in both unconfigured and configured contexts
+  shared_examples 'svg use' do
+    it 'returns SVG use statement' do
+      svg_content = subject.svg_use '#id'
+      expect(svg_content).to include '<use xlink:href="#id">'
+    end
+
+    it 'adds hash at beginning if not given or external link' do
+      svg_content = subject.svg_use 'id'
+      expect(svg_content).to include '<use xlink:href="#id">'
+    end
+
+    it 'adds classes and ids to svg tag' do
+      svg_content = subject.svg_use '#id', id: 'hearts', class: 'love'
+      expect(svg_content).to have_tag('svg', with: { id: 'hearts', class: 'love' })
+    end
+
+    it 'adds any attribute to svg tag' do
+      attributes = { width: '64px', height: '48px', viewport: '0, 0, 12, 24' }
+      svg_content = subject.svg_use '#id', attributes
+      expect(svg_content).to have_tag('svg', with: attributes)
+    end
+
+    it 'strips .svg extension if necessary' do
+      svg_content = subject.svg_use '#circle.svg'
+      expect(svg_content).to include '<use xlink:href="#circle">'
+      expect(svg_content).to_not include '<use xlink:href="#circle.svg">'
+    end
+  end
+
+
+  describe 'without configuration' do
+    describe 'self.configuration' do
+      it 'defaults attributes to nil' do
+        expect(SvgHeartsYou.configuration.svg_paths).to eq([])
+      end
+    end
+
+    describe '#svg_inline' do
+      it_behaves_like 'methods that throw error on file not found', :svg_inline
+    end
+
+    describe '#svg_use' do
+      include_examples 'svg use'
+    end
+
+    describe '#svg_symbol' do
+      it_behaves_like 'methods that throw error on file not found', :svg_symbol
+    end
+  end
+
+  describe 'with configuration' do
+    before do
+      SvgHeartsYou.configure do |config|
+        config.svg_paths << test_svg_path
+      end
+    end
+
+    describe 'self.configuration' do
+      it 'is configured to the the current directory' do
+        expect(SvgHeartsYou.configuration.svg_paths).to eq([test_svg_path])
+      end
+    end
+
+    describe '#svg_inline' do
+      it_behaves_like 'method using file', :svg_inline
+
+      it 'returns contents of SVG file without XML headers' do
+        svg_content = subject.svg_inline 'sapphire.svg'
+
+        expect(svg_content).to have_tag('svg')
+        expect(svg_content).not_to include('<xml')
+        expect(svg_content).not_to include('DOCTYPE')
+      end
+    end
+
+    describe '#svg_use' do
+      include_examples 'svg use'
+    end
+
+    describe '#svg_symbol' do
+      let(:sapphire_svg_attributes) {{
+        x: '0',
+        y: '0',
+        width: '64',
+        height: '52',
+        viewbox: '0, 0, 64, 52'
+        }}
+
+      it_behaves_like 'method using file', :svg_symbol
+
+      it 'returns the SVG contents in a symbol' do
+        svg_content = subject.svg_symbol svg_file
+
+        expect(svg_content).not_to have_tag('svg', with: sapphire_svg_attributes)
+        expect(svg_content).to have_tag('svg>symbol', with: sapphire_svg_attributes)
+        expect(svg_content).to have_tag('svg>symbol', with: { id: 'sapphire' })
+        expect(svg_content).not_to have_tag('svg>*:not(symbol)')
+        expect(svg_content).to have_tag('svg>symbol>*')
+      end
+
+      it 'applies extra attributes to top level svg' do
+        new_id = 'hey-there'
+
+        svg_content = subject.svg_symbol svg_file, id: new_id
+        expect(svg_content).to have_tag('svg', with: {id: new_id})
+      end
+
+      it 'applies or replaces attributes on each symbol with the `each` parameter' do
+        new_viewbox = '0, 0, 100, 100'
+        new_class = 'shape'
+
+        updated_attributes = sapphire_svg_attributes.clone
+        updated_attributes[:viewbox] = new_viewbox
+        updated_attributes[:class] = new_class
+
+        svg_content = subject.svg_symbol svg_file, each: { viewbox: new_viewbox, class: new_class }
+        expect(svg_content).to have_tag('svg>symbol', with: updated_attributes)
+      end
+
+      it 'pulls in multiple files' do
+        svg_content = subject.svg_symbol [svg_file, svg_file2]
+        expect(svg_content).to have_tag('svg>symbol', count: 2)
+      end
+
+      it 'pulls in a given folder with `folder` parameter' do
+        svg_content = subject.svg_symbol svg_folder, folder: true
+        expect(svg_content).to have_tag('svg>symbol', with: { id: 'polygon' })
+        expect(svg_content).to have_tag('svg>symbol', with: { id: 'star' })
+        expect(svg_content).to have_tag('svg>symbol', with: { id: 'triangle' })
+      end
+
+      it 'pulls in multiple folders with `folder` parameter' do
+        svg_content = subject.svg_symbol [svg_folder, svg_folder2], folder: true
+        expect(svg_content).to have_tag('svg>symbol', count: 8)
+      end
+
+      it 'takes a block that can modify each symbol' do
+        new_class = 'shape'
+
+        svg_content = subject.svg_symbol svg_folder, folder: true do |attributes|
+          attributes[:id] = attributes[:id] + '-extra'
+          attributes[:class] = 'shape'
+        end
+
+        expect(svg_content).to have_tag('svg>symbol', with: { id: 'polygon-extra',  class: new_class })
+        expect(svg_content).to have_tag('svg>symbol', with: { id: 'star-extra',     class: new_class })
+        expect(svg_content).to have_tag('svg>symbol', with: { id: 'triangle-extra', class: new_class })
+      end
+    end
+  end
+
+  # Meta test to make sure state is wiped
+  it 'correctly resets configuration at end of tests' do
+    expect(SvgHeartsYou.configuration.svg_paths).to eq([])
+  end
+end