iconify-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b13d5388ff61d0a4f97bb15cf98a14e28a6f1dd758d83ca4a04d8f6a6d21f353
+  data.tar.gz: 1789c4d741a0ca3f1cdd47492bff872f0dfa9fcf4ab7b097180ec4b844617637
+SHA512:
+  metadata.gz: c8a2d05f5a4b52e5b21d7b216fc98f4b9f1de10a63c76fbf72a89136451ddb45c1eaf6de69f1915987d11e7672e9ad6ef19c2c5b64320c443fb918b13da848c1
+  data.tar.gz: ff2a0f976b6049a8dbe1592fd91ed382402de90a5c8c51969a06dd6e86b26d101741108ac37755f6376e1940ef695452c0f18a86494b4aab980397b624c9bbc4

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright Ethan Kircher
+
+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,40 @@
+# Easy to use Icons for Rails
+
+This gem provides an easy integration with the icons from [iconify](https://github.com/iconify/icon-sets/tree/master).
+
+Take any of the icons from their [json icon sets](https://github.com/iconify/icon-sets/tree/master/json).
+
+They can be previewed at [iconify.design](https://iconify.design)
+
+## Installation
+
+Grab a json file from [iconify](https://github.com/iconify/icon-sets/tree/master/json).
+
+```bash
+./bin/bundle add iconify-rails
+```
+
+```bash
+./bin/rails iconify:install
+```
+
+Now setup the location of the json, and the preferred variant if there is one.
+
+```rb
+Iconify.configure do |config|
+  config.file = "vendor/icons/heroicons.json"
+  config.suffix = :suffix
+end
+```
+
+## Usage
+
+In any view just use ye olde `icon` helper.
+
+```erb
+<%= icon(:house, class: 'size-6') %>
+```
+
+## License
+
+`iconify-rails` is released under the [MIT License](https://opensource.org/licenses/MIT).

data/lib/iconify/engine.rb

@@ -0,0 +1,8 @@
+require "iconify/helpers"
+
+class Iconify::Engine < ::Rails::Engine
+  initializer "iconify.engine" do |app|
+    Iconify.start
+    ActionView::Base.send :include, Iconify::Helpers
+  end
+end

data/lib/iconify/helpers.rb

@@ -0,0 +1,28 @@
+module Iconify::Helpers
+  def icon(name, suffix: Iconify.configuration.default_suffix, **attrs)
+    suffix = suffix.to_s
+    icon_name = name.to_s.dasherize
+    icon_name = "#{icon_name}-#{suffix}" if suffix.present?
+
+    icon = Iconify::ICON_DATA["icons"][icon_name]
+
+    tag.span { "#{icon_name} missing" } if icon.nil?
+
+    viewbox = read_view_box(icon)
+
+    tag.svg(xlmns: "http://www.w3.org/2000/svg", viewBox: viewbox, **attrs) do
+      raw(icon["body"])
+    end
+  end
+
+  private
+
+  def read_view_box(icon)
+    left = icon["left"] || Iconify::ICON_DATA["left"] || 0
+    right = icon["right"] || Iconify::ICON_DATA["right"] || 0
+    width = icon["width"] || Iconify::ICON_DATA["width"] || 16
+    height = icon["height"] || Iconify::ICON_DATA["height"] || 16
+
+    "#{left} #{right} #{width} #{height}"
+  end
+end

data/lib/iconify/version.rb

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

data/lib/iconify-rails.rb

@@ -0,0 +1,33 @@
+module Iconify
+  class Configuration
+    attr_accessor :file, :default_suffix
+
+    def initialize
+      @file = "vendor/icons/heroicons.json"
+      @default_suffix = nil
+    end
+  end
+
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield configuration
+    end
+
+    def start
+      path = Rails.root.join(configuration.file)
+      raw = File.read(path)
+      parsed = JSON.parse(raw)
+      raw_suffixes = parsed.delete("suffixes")
+
+      self.const_set("ICON_DATA", parsed.freeze)
+      self.const_set("SUFFIXES", raw_suffixes&.keys.freeze)
+    end
+  end
+end
+
+require "iconify/version"
+require "iconify/engine"

data/lib/install/iconify.rb

@@ -0,0 +1,4 @@
+Iconify.configure do |config|
+  config.file = "vendor/icons/heroicons.json"
+  config.default_suffix = :solid
+end

data/lib/install.rb

@@ -0,0 +1,2 @@
+say "Setup initializer"
+copy_file "#{__dir__}/install/iconify.rb", "config/initializers/iconify.rb"

data/lib/tasks/iconify/install.rake

@@ -0,0 +1,6 @@
+namespace :iconify do
+  desc "Install and setup Iconify JSON"
+  task :install do
+    system "#{RbConfig.ruby} ./bin/rails app:template LOCATION=#{File.expand_path("../../install.rb", __dir__)}"
+  end
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: iconify-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ethan Kircher
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-07-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+description: 
+email:
+- ethanmichaelk@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- lib/iconify-rails.rb
+- lib/iconify/engine.rb
+- lib/iconify/helpers.rb
+- lib/iconify/version.rb
+- lib/install.rb
+- lib/install/iconify.rb
+- lib/tasks/iconify/install.rake
+homepage: https://github.com/rails/jsbundling-rails
+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: []
+rubygems_version: 3.5.9
+signing_key: 
+specification_version: 4
+summary: Use @iconify/json icon sets with Rails for inline SVGs
+test_files: []