heroicons 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 491537fc33ff5d213109589f4c853e0124f67ba73eefcdd695d1a6cadb55e992
-  data.tar.gz: fa27111e5fe4b4e7c94533779d07a81dad0866f7350b6a1b3c65183d0fef6272
+  metadata.gz: dd27d54b96525162b5e3289313babb3a3e9c83574254e3e466530a68d943eb80
+  data.tar.gz: 3b7e621252747612725362f47a5cee6b350a0f2df0117bec7392e3ab6ad7fdab
 SHA512:
-  metadata.gz: 2e6484562e3cfba85f4cac67f85e90417fdd0a35b296f633370ef81f4c4ae295e1e129996d9b6636ccdd07363ad94ccccf9e8c42b6f7a7ae68e58456758aa6cd
-  data.tar.gz: d2186663283012862d250bb0027c17ee1cf1583f05280a674cec9368ffaf5ec0bc3de68fc2b8ddd9f6e86972d364faa7a1d3affb7a6fbe8cf4c9a479669616d7
+  metadata.gz: 5c06374fa1d94093b0176e948f1c82fd14009e05cf43761cf34696d79dbbcaaf7741438041acdf6284348e679f41261752890c8f98f928b4088647035bc4f1b1
+  data.tar.gz: 38a6762334ed12c68d63d1a57fb1d90255c2490bc10c7cf876f37c46300a2ef3fc82f6381d078ad3b2430faf4d696e72aae8ec285ada6988790309973a3cdc44

data/README.md

@@ -1,11 +1,11 @@
-# Heroicon
+# Heroicons
 
 [![Gem Version](https://badge.fury.io/rb/heroicons.svg)](https://rubygems.org/gems/heroicons)
 [![Build Status](https://github.com/jclusso/heroicons/workflows/CI/badge.svg)](https://github.com/jclusso/heroicons/actions)
 
 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. Check out their sites:
+This gem has no official affiliation with Tailwind CSS or the Heroicons team. Check out their sites:
 
 - [Tailwind CSS](https://tailwindcss.com/?utm_source=jclusso_heroicons_github)
 - [Tailwind UI](https://tailwindui.com/?utm_source=jclusso_heroicons_github)
@@ -28,7 +28,7 @@ $ bundle
 Run the installer
 
 ```bash
-$ rails g heroicon:install
+$ rails g heroicons:install
 ```
 
 ## Usage
@@ -39,7 +39,7 @@ To use a icon in your views, simply use the provided view helper with the name o
 <%= heroicon "magnifying-glass" %>
 ```
 
-Heroicon comes with 4 variants, `:outline`, `:solid`, `:mini`, and `:micro`. 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
+Heroicons comes with 4 variants, `:outline`, `:solid`, `:mini`, and `:micro`. The default variant is `:solid`. This can be changed in `config/initializers/heroicons.rb`, which is generated during installation (See [Configuration](#configuration)). To overwrite this in the view, use
 
 ```rb
 <%= heroicon "magnifying-glass", variant: :outline %>
@@ -51,21 +51,21 @@ You can also pass HTML options directly to the icon.
 <%= heroicon "magnifying-glass", options: { class: "text-primary-500" } %>
 ```
 
-Heroicon currently supports icons matching [`Version 2.1.1`](https://github.com/tailwindlabs/heroicons/releases/tag/v2.1.1). If there is an icon that is missing or a new version released, feel free to contribute by following our contributing guide below.
+Heroicons currently supports icons matching [`Version 2.1.3`](https://github.com/tailwindlabs/heroicons/releases/tag/v2.1.3). If there is an icon that is missing or a new version released, 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`.
+After running `rails g heroicons:install` in the installation step, a configuration file will be created at `config/initializers/heroicons.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`.
+  - You can set this to either `:outline`, `:solid`, `:mini`, or `:micro`. 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 enable the `default_class` config, make sure to include `config/intializers/heroicon.rb` in the list of purged paths. For TailwindCSS 3.0+, you should have something like this in your `tailwind.config.js`:
+**Note:** If you enable the `default_class` config, make sure to include `config/initializers/heroicons.rb` in the list of purged paths. For TailwindCSS 3.0+, you should have something like this in your `tailwind.config.js`:
 
 ```js
 module.exports = {
@@ -74,7 +74,7 @@ module.exports = {
     './app/helpers/**/*.rb',
     './app/javascript/**/*.js',
     './app/views/**/*',
-    './config/initializers/heroicon.rb', // 👈
+    './config/initializers/heroicons.rb', // 👈
   ],
   //...
 }
@@ -83,9 +83,14 @@ module.exports = {
 An example configuration looks like this:
 
 ```ruby
-Heroicon.configure do |config|
+Heroicons.configure do |config|
   config.variant = :solid
-  config.default_class = {solid: "h-6 w-6", outline: "h-6 w-6", mini: "h-5 w-5"}
+  config.default_class = {
+    solid: "size-6",
+    outline: "size-6",
+    mini: "size-5",
+    micro: "size-4",
+  }
 end
 ```
 
@@ -108,7 +113,7 @@ To get started with development:
 
 ```
 git clone https://github.com/jclusso/heroicons.git
-cd heroicon
+cd heroicons
 bundle install
 bundle exec rake test
 ```

data/Rakefile

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 require "bundler/gem_tasks"
 
 task default: %i[lint test]
@@ -21,11 +19,5 @@ task :test do
 end
 
 task :lint do
-  sh "bin/standardrb --no-fix"
-end
-
-namespace :changelog do
-  task :refresh do
-    sh "bin/refresh_changelog"
-  end
+  sh "bin/rubocop"
 end

data/lib/generators/heroicons/install_generator.rb

@@ -0,0 +1,11 @@
+module Heroicons
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.join(__dir__, "templates")
+
+      def copy_config
+        template "heroicons.rb", "config/initializers/heroicons.rb"
+      end
+    end
+  end
+end

data/lib/generators/{heroicon/templates/heroicon.rb.tt → heroicons/templates/heroicons.rb.tt}

@@ -1,10 +1,13 @@
-# frozen_string_literal: true
-
-Heroicon.configure do |config|
+Heroicons.configure do |config|
   config.variant = :solid # Options are :solid, :outline, :mini, and :micro
 
   ##
   # 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", mini: "h-4 w-4", micro: "h-4 w-4"}
+  # config.default_class = {
+  #   solid: "size-5",
+  #   outline: "size-6",
+  #   mini: "size-4",
+  #   micro: "size-4"
+  # }
 end

data/lib/{heroicon → heroicons}/configuration.rb

@@ -1,6 +1,4 @@
-# frozen_string_literal: true
-
-module Heroicon
+module Heroicons
   class Configuration
     DEFAULT_VARIANT = :solid
 

data/lib/heroicons/engine.rb

@@ -0,0 +1,17 @@
+module Heroicons
+  class Engine < ::Rails::Engine
+    isolate_namespace Heroicons
+    initializer "heroicons.include_view_helpers" do |app|
+      ActiveSupport.on_load :action_view do
+        def heroicon(name, variant: Heroicons.configuration.variant, options: {}, path_options: {})
+          raw Heroicons::Icon.render(
+            name: name,
+            variant: variant,
+            options: options,
+            path_options: path_options
+          )
+        end
+      end
+    end
+  end
+end

data/lib/{heroicon → heroicons}/icon.rb

@@ -1,6 +1,4 @@
-# frozen_string_literal: true
-
-module Heroicon
+module Heroicons
   class Icon
     attr_reader :name, :variant, :options, :path_options
 
@@ -40,11 +38,11 @@ module Heroicon
     # 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", mini: "h-4 w-4" }
+    #   Heroicons.configure do |config|
+    #     config.default_class = { solid: "size-5", outline: "size-6", mini: "size-4", micro: "size-4" }
     #   end
     #
-    #   #=> <svg class="h-5 w-5">...</svg>
+    #   #=> <svg class="size-5">...</svg>
     def prepend_default_class_name
       return if disable_default_class?
 
@@ -74,7 +72,7 @@ module Heroicon
     end
 
     def default_class_config
-      @default_class_config ||= Heroicon.configuration.default_class
+      @default_class_config ||= Heroicons.configuration.default_class
     end
 
     def disable_default_class?
@@ -96,7 +94,7 @@ module Heroicon
     end
 
     def file_path
-      File.join(Heroicon.root, "app/assets/images/heroicon/#{variant}/#{name}.svg")
+      File.join(Heroicons.root, "app/assets/images/heroicons/#{variant}/#{name}.svg")
     end
 
     def warning
@@ -105,7 +103,7 @@ module Heroicon
       script = <<-HTML
       <script type="text/javascript">
       //<![CDATA[
-      console.warn("Heroicon: Failed to find heroicon: #{name}")
+      console.warn("Heroicons: Failed to find heroicon: #{name}")
       //]]>
       </script>
       HTML

data/lib/heroicons/version.rb

@@ -0,0 +1,3 @@
+module Heroicons
+  VERSION = "2.0.0"
+end

data/lib/heroicons.rb

@@ -0,0 +1,9 @@
+require "heroicons/engine"
+require "heroicons/icon"
+require "heroicons/configuration"
+
+module Heroicons
+  def self.root
+    File.dirname(__dir__)
+  end
+end