bridgetown-svg-inliner 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b634ed7e6fba114daf71e6f95a1211bdf4aea1cfef818062406f3369bea4408b
+  data.tar.gz: a30862bb9778ccc547dd591e6a7070b252bc3372376b32fc8561dc26ed2a3108
+SHA512:
+  metadata.gz: 9bce347b447759deff51941c8e57db560c49d0cf438751a73b240f1edab6771dae6cc9e26e0cc5c1c9408aee023608c7620e301918fcab62984c8ae07b95ee71
+  data.tar.gz: 5f0ec950b228af41d318cfdfaa94f68afee4ade6f38bcd23c51ec8ff75edc619dc30f84d1040d0332bd438f59082212db0255af8c50cb37ca19f3dd83f7d8e3e

data/.gitignore

@@ -0,0 +1,40 @@
+/vendor
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.gem
+Gemfile.lock
+.bundle
+.ruby-version
+
+# Node
+node_modules
+.npm
+.node_repl_history
+
+# Yarn
+yarn-error.log
+yarn-debug.log*
+.pnp/
+.pnp.js
+
+# Yarn Integrity file
+.yarn-integrity
+
+test/dest
+.bridgetown-metadata
+.bridgetown-cache
+.bridgetown-webpack
+
+.DS_Store

data/.rubocop.yml

@@ -0,0 +1,31 @@
+require: rubocop-bridgetown
+
+inherit_gem:
+  rubocop-bridgetown: .rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 2.6
+  Include:
+    - lib/**/*.rb
+    - test/**/*.rb
+
+  Exclude:
+    - .gitignore
+    - .rubocop.yml
+
+    - Gemfile.lock
+    - CHANGELOG.md
+    - LICENSE.md
+    - README.md
+
+    - script/**/*
+    - vendor/**/*
+
+Style/MultilineIfModifier:
+  Enabled: false
+
+Style/RescueStandardError:
+  Enabled: false
+
+Lint/AmbiguousBlockAssociation:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# main
+
+# 1.0.0 / 17-06-2021
+
+The initial release

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+gemspec
+
+gem "bridgetown", ENV["BRIDGETOWN_VERSION"] if ENV["BRIDGETOWN_VERSION"]
+
+group :test do
+  gem "minitest"
+  gem "minitest-reporters"
+  gem "shoulda"
+end

data/LICENSE.md

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2021-present Ayush Newatia
+
+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,77 @@
+# Bridgetown SVG Inliner
+
+A Bridgetown plugin that provides a liquid tag and ERB helper to inline SVG files within the HTML markup.
+
+## Installation
+
+Run this command to add this plugin to your site's Gemfile:
+
+```shell
+$ bundle add "bridgetown-svg-inliner" -g bridgetown_plugins
+```
+
+## Usage
+
+This plugin provides an `svg` tag in Liquid and an `svg` helper in ERB or other Tilt based templating langugages.
+
+```liquid
+<!-- Liquid -->
+{% svg "/assets/icons/thumbs-up.svg" %}
+```
+
+```erb
+<!-- ERB -->
+<%= svg "/assets/icons/thumbs-up.svg" %>
+```
+
+### Attributes
+
+You can pass in attributes that you'd like to include on the `svg` tag in the HTML output.
+
+```liquid
+<!-- Liquid -->
+{% svg "/assets/icons/thumbs-up.svg", class: "icon" %}
+```
+
+```erb
+<!-- ERB -->
+<%= svg "/assets/icons/thumbs-up.svg", class: "icon" %>
+```
+
+```html
+<!-- Output -->
+<svg class="icon">
+  ...
+</svg>
+```
+
+### Liquid variables
+
+You can use Liquid variables by enclosing them in double braces (`{{ }}`)
+
+```liquid
+<!-- Liquid -->
+{% assign svg_file = "thumbs-up" %}
+{% assign svg_class_list = "icon icon--small" %}
+{% svg "/assets/icons/{{ svg_file }}.svg", class: "{{ svg_class_list }}" %}
+```
+
+## Testing
+
+* Run `bundle exec rake test` to run the test suite
+* Or run `script/cibuild` to validate with Rubocop and Minitest together.
+
+## Contributing
+
+1. Fork it (https://github.com/ayushn21/bridgetown-svg-inliner/fork)
+2. Clone the fork using `git clone` to your local development machine.
+3. Create your feature branch (`git checkout -b my-new-feature`)
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create a new Pull Request
+
+## License
+
+Bridgetown SVG Inliner is released under the [MIT License](https://opensource.org/licenses/MIT).
+
+Copyright © 2021 [Ayush Newatia](https://twitter.com/ayushn21)

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+  t.warning = false
+end
+
+task :default => :test

data/bridgetown-svg-inliner.gemspec

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative "lib/bridgetown-svg-inliner/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "bridgetown-svg-inliner"
+  spec.version       = BridgetownSvgInliner::VERSION
+  spec.author        = "Ayush Newatia"
+  spec.email         = "ayush@hey.com"
+  spec.summary       = "Liquid and ERB helper for Bridgetown to inline SVG files within HTML"
+  spec.homepage      = "https://github.com/ayushn21/bridgetown-svg-inliner"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r!^(test|script)/!) }
+  spec.test_files    = spec.files.grep(%r!^test/!)
+  spec.require_paths = ["lib"]
+  spec.metadata      = {}
+
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.add_dependency "bridgetown", ">= 0.20", "< 2.0"
+  spec.add_dependency "nokogiri"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "rubocop-bridgetown", "~> 0.2"
+end

data/lib/bridgetown-svg-inliner.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "bridgetown"
+require "nokogiri"
+require "bridgetown-svg-inliner/builder"
+
+module BridgetownSvgInliner
+  autoload :LiquidAttributes, "bridgetown-svg-inliner/liquid_attributes"
+end
+
+BridgetownSvgInliner::Builder.register

data/lib/bridgetown-svg-inliner/builder.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module BridgetownSvgInliner
+  class Builder < Bridgetown::Builder
+    def build
+      liquid_tag "svg" do |attributes, tag|
+        attributes = Liquid::Template.parse(attributes).render(tag.context)
+        attributes = LiquidAttributes.new(attributes)
+
+        render attributes.path, attributes.args
+      end
+
+      helper "svg" do |path, **attributes|
+        render path, attributes
+      end
+    end
+
+    private
+
+    def render(path, html_attributes)
+      file = File.read(site.in_source_dir(path))
+      xml = Nokogiri::XML(file)
+      html_attributes&.each { |key, value| xml.root.set_attribute(key, value) }
+      xml.root.to_xml.html_safe
+    end
+  end
+end

data/lib/bridgetown-svg-inliner/liquid_attributes.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module BridgetownSvgInliner
+  class LiquidAttributes
+    attr_reader :path, :args
+
+    def initialize(attributes)
+      path, args = attributes.split(",", 2)
+
+      @path = unescape_string(path)
+      @args = args.scan(Liquid::TagAttributes).map do |arg|
+        [arg[0], unescape_string(arg[1])]
+      end.to_h if args.present?
+    end
+
+    private
+
+    def unescape_string(string)
+      string.undump
+    rescue
+      string
+    end
+  end
+end

data/lib/bridgetown-svg-inliner/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module BridgetownSvgInliner
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: bridgetown-svg-inliner
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Ayush Newatia
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-06-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bridgetown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.20'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.20'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-bridgetown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+description: 
+email: ayush@hey.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- bridgetown-svg-inliner.gemspec
+- lib/bridgetown-svg-inliner.rb
+- lib/bridgetown-svg-inliner/builder.rb
+- lib/bridgetown-svg-inliner/liquid_attributes.rb
+- lib/bridgetown-svg-inliner/version.rb
+homepage: https://github.com/ayushn21/bridgetown-svg-inliner
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Liquid and ERB helper for Bridgetown to inline SVG files within HTML
+test_files: []