simply_inline_svg 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: adba1ff0f45e5477670d37ef25f29d314e0ac3236ec92608216c237460d74483
+  data.tar.gz: 948e1538920a5fd6d09a2f02395cf5e0791795cb1707310f011451689f067f05
+SHA512:
+  metadata.gz: f925de496c66ad004e429d6f896cbd8e38ae406d7e966eb609588ee7e4a57fd09a4daef5cef394bdce974efa4cd4fed9e06c8b29a7819abe614e3ebdec258a00
+  data.tar.gz: 5bd7a03f0e959329222ebfdc316f2919332a16db57e2eb28b04b74c86b62bf7913f67f74480405733a201de57fcc361d5aa704422f2254778ca878ed4cf75350

data/.gitignore

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

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [0.1.0] - 2020-08-09
+### Added
+- Meta information about the gem.
+- Inline SVGs compiled by Sprockets or Webpacker.
+- Inline SVGs of any directories.

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 vuongpd95@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 simply_inline_svg.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,28 @@
+PATH
+  remote: .
+  specs:
+    simply_inline_svg (0.1.0)
+      libxml-ruby
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.3)
+    libxml-ruby (3.2.0)
+    method_source (0.9.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  pry (~> 0.12.2)
+  rake (~> 10.0)
+  simply_inline_svg!
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Vuong Pham
+
+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,87 @@
+# SimplyInlineSvg
+
+SimplyInlineSVG is a super simple gem to help you inline SVG icons. Seriously, it's so simple that I don't even write any tests. But, I don't guarantee it works with all Ruby & Rails version though. Use this gem at your own peril.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'simply_inline_svg'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simply_inline_svg
+
+## Usage
+
+Run `bundle exec rails generate simply_inline_svg:install` to generate an initializer file if you are using Rails. Use the initializer file to register your SVGs
+
+```
+# config/initializers/simply_inline_svg.rb
+SimpleInlineSvg.register_directory(Rails.root.join("app", "assets", "images", "svgs"))
+```
+
+Then in views, you can:
+
+```
+<%= inline_svg_tag("icon-name.svg", class: "any-class") %>
+```
+
+You can also use `register_svg` to register a single svg file. This gives you the power to decide how your svg should be referenced
+
+```
+# config/initializers/simply_inline_svg.rb
+SimpleInlineSvg.register_svg(:close_icon, Rails.root.join("app", "assets", "images", "svgs", "close.svg").to_s)
+```
+
+Then in views, you can:
+
+```
+<%= inline_svg_tag(:close_icon, class: "any-class") %>
+```
+
+If you want to inline an SVG compiled by Webpacker or Sprockets (Rails only). You don't have to register them, just use:
+
+```
+# For Sprockets
+<%= assets_svg_tag(icon_path, class: "any-class") %>
+
+# For Webpacker
+<%= pack_svg_tag(icon_path, class: "any-class") %>
+```
+
+`icon_path` of `assets_svg_tag` is similar to `icon_path` in `image_tag(icon_path)`. `icon_path` of `pack_svg_tag` is similar to `icon_path` in `assets_pack_path(icon_path)`.
+
+Examples
+
+```
+# For Sprockets
+<%= assets_svg_tag("bed.svg", class: "any-class") %> # Render app/assets/images/bed.svg
+
+# For Webpacker
+<%= pack_svg_tag("media/images/bed.svg", class: "any-class") %> # Render app/javascript/images/bed.svg
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/vuongpd95/simply_inline_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](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the SimplyInlineSvg project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/vuongpd95/simply_inline_svg/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "simply_inline_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(__FILE__)

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/generators/simply_inline_svg/install_generator.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+require 'rails/generators/base'
+
+module SimplyInlineSvg
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../templates", __FILE__)
+      desc "Creates SimplyInlineSvg initializer for your application"
+
+      def copy_initializer
+        template "simply_inline_svg_initializer.rb", "config/initializers/simply_inline_svg.rb"
+
+        puts "Install complete!"
+      end
+    end
+  end
+end

data/lib/generators/templates/simply_inline_svg_initializer.rb

@@ -0,0 +1,20 @@
+# Register all svg images under assets
+# SimplyInlineSvg::Storage.register_directory(Rails.root.join("app", "assets", "images"))
+# Example:
+#   app/assets/images/dir/bed.svg
+#   app/assets/images/bathroom.svg
+#   app/assets/images/bed.svg
+# In view templates
+#   inline_svg_tag("bed.svg")        => Render app/assets/images/bed.svg
+#   inline_svg_tag("bathroom.svg")   => Render app/assets/images/bathroom.svg
+# Only the last svg registered if there're multiple svgs with the same name. If you want to keep
+# all of them, use SimplyInlineSvg::Storage#register_svg
+#   SimplyInlineSvg::Storage.register_svg("dir/bed.svg", Rails.root.join("app", "assets", "images", "dir", "bed.svg"))
+#   SimplyInlineSvg::Storage.register_svg("bed.svg", Rails.root.join("app", "assets", "images", "bed.svg"))
+# Then, in view templates
+#   inline_svg_tag("bed.svg")        => Render app/assets/images/bed.svg
+#   inline_svg_tag("dir/bed.svg")    => Render app/assets/images/dir/bed.svg
+
+# If you want to render an svg compiled by Sprockets or Webpacker, use:
+#   assets_svg_tag("bed.svg")              => Render app/assets/images/bed.svg
+#   pack_svg_tag("media/images/bed.svg")   => Render app/javascript/images/bed.svg

data/lib/simply_inline_svg.rb

@@ -0,0 +1,9 @@
+require "simply_inline_svg/version"
+require "simply_inline_svg/svg"
+require "simply_inline_svg/storage"
+require "simply_inline_svg/railtie" if defined?(Rails)
+
+module SimplyInlineSvg
+  class Error < StandardError; end
+  class SvgNotFound < Error; end
+end

data/lib/simply_inline_svg/action_view/helpers.rb

@@ -0,0 +1,43 @@
+module SimplyInlineSvg
+  module ActionView
+    module Helpers
+      def inline_svg_tag(name, options = {})
+        SimplyInlineSvg::Storage.find!(name).render(options).html_safe
+      end
+
+      def assets_svg_tag(name, options = {})
+        asset_name = "sprockets/#{name}"
+        svg = SimplyInlineSvg::Storage.find(asset_name)
+        return svg.render(options).html_safe if svg
+        if ::Rails.application.config.assets.compile
+          SimplyInlineSvg::Storage.register_svg(asset_name, ::Rails.application.assets[name].filename)
+        else
+          ::Rails.application.assets_manifest.assets.each do |k, v|
+            next unless k[-3..-1] == 'svg'
+            SimplyInlineSvg::Storage.register_svg(
+              "sprockets/#{k}",
+              "#{::Rails.application.assets_manifest.directory}/#{v}"
+            )
+          end
+        end
+        inline_svg_tag(asset_name, options)
+      end
+
+      def pack_svg_tag(name, options = {})
+        pack_name = "webpacker/#{name}"
+        svg = SimplyInlineSvg::Storage.find(pack_name)
+        return svg.render(options).html_safe if svg
+        if Webpacker.manifest.config.compile? && !Webpacker.manifest.dev_server.running?
+          Webpacker.manifest.compiler.compile
+        end
+        pack_dir = Rails.root.join("public").to_s
+        Webpacker.manifest.refresh.each do |k, v|
+          next unless k[-3..-1] == 'svg'
+          SimplyInlineSvg::Storage.register_svg("webpacker/#{k}", pack_dir + v)
+        end
+        inline_svg_tag(asset_name, options)
+      end
+
+    end
+  end
+end

data/lib/simply_inline_svg/railtie.rb

@@ -0,0 +1,13 @@
+require 'rails/railtie'
+
+module SimplyInlineSvg
+  class Railtie < ::Rails::Railtie
+    initializer "simply_inline_svg.action_view" do |app|
+      ActiveSupport.on_load :action_view do
+        require "simply_inline_svg/action_view/helpers"
+        include SimplyInlineSvg::ActionView::Helpers
+      end
+    end
+
+  end
+end

data/lib/simply_inline_svg/storage.rb

@@ -0,0 +1,34 @@
+module SimplyInlineSvg
+  class Storage
+    class << self
+
+      attr_accessor :data
+
+      def register_directory(directory)
+        fpaths = Dir["#{directory}/**/*.svg"]
+        while fpaths.length > 0
+          fpath = fpaths.shift
+          register_svg(File.basename(fpath), fpath)
+        end
+        self.data
+      end
+
+      def register_svg(fname, fpath)
+        svg = Svg.new(File.read(fpath))
+        self.data.merge!({ fname => svg })
+      end
+
+      def find!(name)
+        raise SvgNotFound if self.data[name].nil?
+        self.data[name]
+      end
+
+      def find(name)
+        self.data[name]
+      end
+
+    end
+  end
+end
+
+SimplyInlineSvg::Storage.data = {}

data/lib/simply_inline_svg/svg.rb

@@ -0,0 +1,34 @@
+require 'xml'
+
+module SimplyInlineSvg
+  class Svg
+
+    def initialize(str_svg)
+      @doc = XML::Parser.string(str_svg).parse
+      @svg_attributes = @doc.root.attributes
+    end
+
+    def []=(attr_name, attr_value)
+      @svg_attributes[attr_name.to_s] = attr_value.to_s
+    end
+
+    def [](attr_name)
+      @svg_attributes[attr_name.to_s]
+    end
+
+    def dup
+      self.class.new(@doc.to_s)
+    end
+
+    def to_s
+      @doc.to_s
+    end
+
+    def render(options = {})
+      return self.to_s if options.empty?
+      cloned_svg = self.dup
+      options.each { |k, v| cloned_svg[k] = v }
+      cloned_svg.to_s
+    end
+  end
+end

data/lib/simply_inline_svg/version.rb

@@ -0,0 +1,3 @@
+module SimplyInlineSvg
+  VERSION = "0.1.0"
+end

data/simply_inline_svg.gemspec

@@ -0,0 +1,35 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "simply_inline_svg/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "simply_inline_svg"
+  spec.version       = SimplyInlineSvg::VERSION
+  spec.authors       = ["Vuong Pham"]
+  spec.email         = ["vuongpd95@gmail.com"]
+
+  spec.summary       = %q{SimplyInlineSVG helps you inline svg images into HTML template in a (really) simple way.}
+  spec.homepage      = "https://chilling.dev/open-source/simply-inline-svg"
+  spec.license       = "MIT"
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/vuongpd95/simply_inline_svg"
+  spec.metadata["changelog_uri"] = "https://github.com/vuongpd95/simply_inline_svg/blob/v#{SimplyInlineSvg::VERSION}/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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_runtime_dependency "libxml-ruby", ">= 2.7", "~> 3.2"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "pry", "~> 0.12.2"
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: simply_inline_svg
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Vuong Pham
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-10-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: libxml-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.7'
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.7'
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+description: 
+email:
+- vuongpd95@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/generators/simply_inline_svg/install_generator.rb
+- lib/generators/templates/simply_inline_svg_initializer.rb
+- lib/simply_inline_svg.rb
+- lib/simply_inline_svg/action_view/helpers.rb
+- lib/simply_inline_svg/railtie.rb
+- lib/simply_inline_svg/storage.rb
+- lib/simply_inline_svg/svg.rb
+- lib/simply_inline_svg/version.rb
+- simply_inline_svg.gemspec
+homepage: https://chilling.dev/open-source/simply-inline-svg
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://chilling.dev/open-source/simply-inline-svg
+  source_code_uri: https://github.com/vuongpd95/simply_inline_svg
+  changelog_uri: https://github.com/vuongpd95/simply_inline_svg/blob/v0.1.0/CHANGELOG.md
+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.7
+signing_key: 
+specification_version: 4
+summary: SimplyInlineSVG helps you inline svg images into HTML template in a (really)
+  simple way.
+test_files: []