heroicon 0.2.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d84d48fe0bd5ee18ae0a8ff4fcb18700b44415bdb6c834b2d606b334635990c
-  data.tar.gz: e34a0b8f7f67ae51c8d0712b28c9592c5a6a40bb1b91a790a2a025f9b18856e8
+  metadata.gz: 4b1da2f6a254f8d75998ee51b23dae5e795f1b020c2a4558aa765f99b5b0c290
+  data.tar.gz: df21e11c2767a743614d7ee5a01f95bd32aec73ea3445a409ed8462166f9cd6a
 SHA512:
-  metadata.gz: 3b5ad7a7dd7e3636840d551f75c449ab16da0f43e868abe9e3d5304abefd99fb3dce2651c93d15c1efde4d87a09c9475c28b3c7f6fa1edbb7dc02596f0d0f98c
-  data.tar.gz: 66f0d51350a460c9b23518e3a6f9982a2ac3890ea97e0f3b2c3fb4fc5ee5a2d1afc97e391d34a378fe97662bdc5e86ba4f195abf981c25ad7551141828f455a2
+  metadata.gz: 0525f055760da3fb88e91f688ac16511cc9d15a434f46708e8134b95fd9e0b1727684ed5e11f7ac567a7b144d1e2feffe363b623af4e495ceb368688d43b193c
+  data.tar.gz: bf4faf542d32e2b246d2bfae07fd71fb99adaa01d06b7eed63f2904e3502ebd113b77c7a1205a1ac3c2cbc99764ee2880df47923ce780b6ddc17f12ba38e238e

data/README.md

@@ -1,16 +1,20 @@
 # Heroicon
+
 [![Build Status](https://github.com/bharget/heroicon/workflows/CI/badge.svg)](https://github.com/bharget/heroicon/actions)
 [![Ruby Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://github.com/testdouble/standard)
 
-Ruby on Rails view helpers for the beautiful hand-crafted SVG icons, Heroicons. This gem has no official affiliation with Tailwind CSS or the Heroicon team.
+Ruby on Rails view helpers for the beautiful hand-crafted SVG icons, Heroicons.
+
+Used in production at [Morning Brew ☕](https://www.morningbrew.com/?utm_source=bharget_github)
 
-Check out their sites:
+This gem has no official affiliation with Tailwind CSS or the Heroicon team (yet!). Check out their sites:
 
 - [Tailwind CSS](https://tailwindcss.com/?utm_source=bharget_github)
 - [Tailwind UI](https://tailwindui.com/?utm_source=bharget_github)
 - [Heroicons](https://heroicons.com/?utm_source=bharget_github)
 
 ## Installation
+
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -18,11 +22,13 @@ gem "heroicon"
 ```
 
 And then execute:
+
 ```bash
 $ bundle
 ```
 
 Run the installer
+
 ```bash
 $ rails g heroicon:install
 ```
@@ -35,19 +41,47 @@ To use a icon in your views, simply use the provided view helper with the name o
 <%= heroicon "search" %>
 ```
 
-Heroicon comes with two variants, `:outline` and `:solid`. By default it uses the variant provided in the configuration file that was generated during installation. To overwrite this in the view, use
+Heroicon comes with two variants, `:outline` and `:solid`. The default variant is `:solid`. This can be changed in `config/initializers/heroicon.rb`, which is generated during installation (See [Configuration](#configuration)). To overwrite this in the view, use
 
 ```rb
 <%= heroicon "search", variant: :outline %>
 ```
 
-You can also pass a class to use on the icon.
+You can also pass HTML options directly to the icon.
 
 ```rb
 <%= heroicon "search", options: { class: "text-primary-500" } %>
 ```
 
-Heroicon currently supports icons up to `Version 0.4.1`. If there is a icon that is missing, feel free to contribute by following our contributing guide below.
+Heroicon currently supports icons up to [`Version 1.0.1`](https://github.com/tailwindlabs/heroicons/releases/tag/v1.0.1). If there is a icon that is missing, feel free to contribute by following our contributing guide below.
+
+# Configuration
+
+After running `rails g heroicon:install` in the installation step, a configuration file will be created at `config/initializers/heroicon.rb`.
+
+Currently there are two configuration options:
+
+- `variant`: The default variant to use if no variant is specified in the view.
+  - You can set this to either `:outline` or `:solid`. Defaults to `:solid`.
+- `default_class`: A default class that gets applied to every icon.
+  - This accepts either a String to apply to every icon, or a Hash, which applies the class based on the variant of the icon (see the example below).
+  - You can disable this on a per-icon basis by passing `disable_default_class: true` in the options hash within the view.
+  - _Note: If you use the `default_class` option with PurgeCSS (or something similar), make sure you add the classes you want to use to the generated CSS file. For PurgeCSS, you may want to add `config/intializers/heroicon.rb` to the list of purged paths._
+
+An example configuration looks like this:
+
+```ruby
+Heroicon.configure do |config|
+  config.variant = :solid
+  config.default_class = {solid: "h-5 w-5", outline: "h-6 w-6"}
+end
+```
+
+Disabling the default class in the view:
+
+```rb
+<%= heroicon "search", options: { class: "custom-class" disable_default_class: true } %>
+```
 
 ## Contributing
 
@@ -68,4 +102,5 @@ bundle exec rake test
 ```
 
 ## License
+
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/app/assets/images/heroicon/outline/academic-cap.svg

@@ -1,5 +1,5 @@
 <svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor">
-  <path fill="#fff" d="M12 14l9-5-9-5-9 5 9 5z"/>
-  <path fill="#fff" d="M12 14l6.16-3.422a12.083 12.083 0 01.665 6.479A11.952 11.952 0 0012 20.055a11.952 11.952 0 00-6.824-2.998 12.078 12.078 0 01.665-6.479L12 14z"/>
+  <path d="M12 14l9-5-9-5-9 5 9 5z"/>
+  <path d="M12 14l6.16-3.422a12.083 12.083 0 01.665 6.479A11.952 11.952 0 0012 20.055a11.952 11.952 0 00-6.824-2.998 12.078 12.078 0 01.665-6.479L12 14z"/>
   <path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M12 14l9-5-9-5-9 5 9 5zm0 0l6.16-3.422a12.083 12.083 0 01.665 6.479A11.952 11.952 0 0012 20.055a11.952 11.952 0 00-6.824-2.998 12.078 12.078 0 01.665-6.479L12 14zm-4 6v-7.5l4-2.222"/>
 </svg>

data/app/assets/images/heroicon/outline/arrow-sm-down.svg

@@ -0,0 +1,3 @@
+<svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor">
+  <path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M17 13l-5 5m0 0l-5-5m5 5V6"/>
+</svg>

data/app/assets/images/heroicon/outline/arrow-sm-left.svg

@@ -0,0 +1,3 @@
+<svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor">
+  <path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M11 17l-5-5m0 0l5-5m-5 5h12"/>
+</svg>

data/app/assets/images/heroicon/outline/arrow-sm-right.svg

@@ -0,0 +1,3 @@
+<svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor">
+  <path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M13 7l5 5m0 0l-5 5m5-5H6"/>
+</svg>

data/app/assets/images/heroicon/outline/arrow-sm-up.svg

@@ -0,0 +1,3 @@
+<svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor">
+  <path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M7 11l5-5m0 0l5 5m-5-5v12"/>
+</svg>

data/app/assets/images/heroicon/outline/truck.svg

@@ -1,4 +1,4 @@
 <svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor">
-  <path fill="#fff" d="M9 17a2 2 0 11-4 0 2 2 0 014 0zM19 17a2 2 0 11-4 0 2 2 0 014 0z"/>
+  <path d="M9 17a2 2 0 11-4 0 2 2 0 014 0zM19 17a2 2 0 11-4 0 2 2 0 014 0z"/>
   <path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M13 16V6a1 1 0 00-1-1H4a1 1 0 00-1 1v10a1 1 0 001 1h1m8-1a1 1 0 01-1 1H9m4-1V8a1 1 0 011-1h2.586a1 1 0 01.707.293l3.414 3.414a1 1 0 01.293.707V16a1 1 0 01-1 1h-1m-6-1a1 1 0 001 1h1M5 17a2 2 0 104 0m-4 0a2 2 0 114 0m6 0a2 2 0 104 0m-4 0a2 2 0 114 0"/>
 </svg>

data/app/assets/images/heroicon/solid/arrow-sm-down.svg

@@ -0,0 +1,3 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 20 20" fill="currentColor">
+  <path fill-rule="evenodd" d="M14.707 10.293a1 1 0 010 1.414l-4 4a1 1 0 01-1.414 0l-4-4a1 1 0 111.414-1.414L9 12.586V5a1 1 0 012 0v7.586l2.293-2.293a1 1 0 011.414 0z" clip-rule="evenodd"/>
+</svg>

data/app/assets/images/heroicon/solid/arrow-sm-left.svg

@@ -0,0 +1,3 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 20 20" fill="currentColor">
+  <path fill-rule="evenodd" d="M9.707 14.707a1 1 0 01-1.414 0l-4-4a1 1 0 010-1.414l4-4a1 1 0 011.414 1.414L7.414 9H15a1 1 0 110 2H7.414l2.293 2.293a1 1 0 010 1.414z" clip-rule="evenodd"/>
+</svg>

data/app/assets/images/heroicon/solid/arrow-sm-right.svg

@@ -0,0 +1,3 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 20 20" fill="currentColor">
+  <path fill-rule="evenodd" d="M10.293 5.293a1 1 0 011.414 0l4 4a1 1 0 010 1.414l-4 4a1 1 0 01-1.414-1.414L12.586 11H5a1 1 0 110-2h7.586l-2.293-2.293a1 1 0 010-1.414z" clip-rule="evenodd"/>
+</svg>

data/app/assets/images/heroicon/solid/arrow-sm-up.svg

@@ -0,0 +1,3 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 20 20" fill="currentColor">
+  <path fill-rule="evenodd" d="M5.293 9.707a1 1 0 010-1.414l4-4a1 1 0 011.414 0l4 4a1 1 0 01-1.414 1.414L11 7.414V15a1 1 0 11-2 0V7.414L6.707 9.707a1 1 0 01-1.414 0z" clip-rule="evenodd"/>
+</svg>

data/app/helpers/heroicon/application_helper.rb

@@ -2,8 +2,13 @@
 
 module Heroicon
   module ApplicationHelper
-    def heroicon(name, variant: Heroicon.configuration.variant, options: {})
-      raw Heroicon::Icon.render(name: name, variant: variant, options: options)
+    def heroicon(name, variant: Heroicon.configuration.variant, options: {}, path_options: {})
+      raw Heroicon::Icon.render(
+        name: name,
+        variant: variant,
+        options: options,
+        path_options: path_options
+      )
     end
   end
 end

data/lib/generators/heroicon/templates/heroicon.rb.tt

@@ -2,4 +2,9 @@
 
 Heroicon.configure do |config|
   config.variant = :solid # Options are :solid and :outline
+
+  ##
+  # You can set a default class, which will get applied to every icon with
+  # the given variant. To do so, un-comment the line below.
+  # config.default_class = {solid: "h-5 w-5", outline: "h-6 w-6"}
 end

data/lib/heroicon.rb

@@ -5,4 +5,7 @@ require "heroicon/icon"
 require "heroicon/configuration"
 
 module Heroicon
+  def self.root
+    File.dirname(__dir__)
+  end
 end

data/lib/heroicon/configuration.rb

@@ -2,10 +2,13 @@
 
 module Heroicon
   class Configuration
+    DEFAULT_VARIANT = :solid
+
     attr_accessor :variant
+    attr_accessor :default_class
 
     def initialize
-      @variant = :solid
+      @variant = DEFAULT_VARIANT
     end
   end
 

data/lib/heroicon/icon.rb

@@ -2,12 +2,13 @@
 
 module Heroicon
   class Icon
-    attr_reader :name, :variant, :options
+    attr_reader :name, :variant, :options, :path_options
 
-    def initialize(name:, variant:, options:)
+    def initialize(name:, variant:, options:, path_options:)
       @name = name
       @variant = safe_variant(variant)
       @options = options
+      @path_options = path_options
     end
 
     def render
@@ -15,13 +16,53 @@ module Heroicon
 
       doc = Nokogiri::HTML::DocumentFragment.parse(file)
       svg = doc.at_css "svg"
-      svg["class"] = options[:class] if options[:class].present?
+
+      path_options.each do |key, value|
+        attribute = key.to_s.dasherize
+        svg.css("path[#{attribute}]").each do |item|
+          item[attribute] = value.to_s
+        end
+      end
+
+      prepend_default_class_name
+
+      options.each do |key, value|
+        svg[key.to_s] = value
+      end
 
       doc
     end
 
     private
 
+    ##
+    # Prepends the default CSS class name for an icon. You can provide a String, which will apply
+    # to all icons, or a Hash, which will apply to the specified variant.
+    #
+    # @example
+    #   Heroicon.configure do |config|
+    #     config.default_class = { solid: "h-5 w-5", outline: "h-6 w-6" }
+    #   end
+    #
+    #   #=> <svg class="h-5 w-5">...</svg>
+    def prepend_default_class_name
+      return if disable_default_class?
+
+      default_class_config = Heroicon.configuration.default_class
+
+      default_class = if default_class_config.is_a?(String)
+        default_class_config
+      elsif default_class_config.is_a?(Hash)
+        default_class_config[variant]
+      end
+
+      options[:class] = "#{default_class} #{options[:class]}".strip if default_class.present?
+    end
+
+    def disable_default_class?
+      @disable_default_class ||= !!options.delete(:disable_default_class)
+    end
+
     def safe_variant(provided_variant)
       if %i[solid outline].include?(provided_variant.to_sym)
         provided_variant
@@ -31,26 +72,32 @@ module Heroicon
     end
 
     def file
-      @file ||= Rails.application.assets_manifest.find_sources("heroicon/#{variant}/#{name}.svg").first.force_encoding("UTF-8")
+      @file ||= File.read(file_path).force_encoding("UTF-8")
     rescue
       nil
     end
 
+    def file_path
+      File.join(Heroicon.root, "app/assets/images/heroicon/#{variant}/#{name}.svg")
+    end
+
     def warning
       return unless Rails.env.development?
 
-      <<-HTML
+      script = <<-HTML
       <script type="text/javascript">
       //<![CDATA[
       console.warn("Heroicon: Failed to find heroicon: #{name}")
       //]]>
       </script>
       HTML
+
+      script.strip
     end
 
     class << self
-      def render(*args)
-        new(*args).render
+      def render(**kwargs)
+        new(**kwargs).render
       end
     end
   end

data/lib/heroicon/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Heroicon
-  VERSION = "0.2.1"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: heroicon
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Benjamin Hargett
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-15 00:00:00.000000000 Z
+date: 2021-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -94,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  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'
 description: Ruby on Rails view helpers for the beautiful hand-crafted SVG icons,
   Heroicons.
 email:
@@ -120,6 +134,10 @@ files:
 - app/assets/images/heroicon/outline/arrow-narrow-right.svg
 - app/assets/images/heroicon/outline/arrow-narrow-up.svg
 - app/assets/images/heroicon/outline/arrow-right.svg
+- app/assets/images/heroicon/outline/arrow-sm-down.svg
+- app/assets/images/heroicon/outline/arrow-sm-left.svg
+- app/assets/images/heroicon/outline/arrow-sm-right.svg
+- app/assets/images/heroicon/outline/arrow-sm-up.svg
 - app/assets/images/heroicon/outline/arrow-up.svg
 - app/assets/images/heroicon/outline/arrows-expand.svg
 - app/assets/images/heroicon/outline/at-symbol.svg
@@ -346,6 +364,10 @@ files:
 - app/assets/images/heroicon/solid/arrow-narrow-right.svg
 - app/assets/images/heroicon/solid/arrow-narrow-up.svg
 - app/assets/images/heroicon/solid/arrow-right.svg
+- app/assets/images/heroicon/solid/arrow-sm-down.svg
+- app/assets/images/heroicon/solid/arrow-sm-left.svg
+- app/assets/images/heroicon/solid/arrow-sm-right.svg
+- app/assets/images/heroicon/solid/arrow-sm-up.svg
 - app/assets/images/heroicon/solid/arrow-up.svg
 - app/assets/images/heroicon/solid/arrows-expand.svg
 - app/assets/images/heroicon/solid/at-symbol.svg