rails_heroicon 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7962d49162a4a2e11eb96158d6363ed6f45ce5fb5ee6e29a8bfe08c518a2c6c2
-  data.tar.gz: 6f912e56bb2ee5fe3efb51cb1dbc9abe0ea811a39e3d37501b7c2af00a07ee43
+  metadata.gz: f5e0f72c562dcbd500cdb50251dcf61ec36ee26bed0008f00a4cd553dc8aa4ec
+  data.tar.gz: 4317fb7b258de8d052ffb8f324a624c5ab4c087556923b1110c4275018c90f4c
 SHA512:
-  metadata.gz: 6a5a85703660c00ad56a0f653ca3264dd9b7b34ad213dbad2b2752513f04af757f10cf2e820f385548d8c73e419fb9e7c0f63d89a8a8d5f1058ec921495aa2b5
-  data.tar.gz: 355dd0bc2a6b3abaea93c0660ea16947db5e39e051a29025604730a031e12016b9efa02b921bf71a47b3984559bb2be87354fb351c5b3ae956d38d907dbef940
+  metadata.gz: 051710b0b52d03faea89b00372227a1fdddc2bd8b30e176ec067c1c7ee13d6f83369e6f6661e9718942e69da8458b20d93e74054c6199e64baf4003fe11b788e
+  data.tar.gz: b14ef4a431a485f73df7e9d9c7410d055def37c9c217d836aea7def8eca10cea23f2df0f56662ba5b01fed027ad6d3d220d5219ae946d107a4bc17ec841dc3ec

data/README.md

@@ -1,8 +1,10 @@
 # Rails Heroicon ![ci](https://github.com/abeidahmed/rails-heroicon/actions/workflows/ci.yml/badge.svg)
 
-Ruby on Rails `view helpers` for the awesome heroicons by Steve Schoger. To view
+Ruby on Rails views helper for the awesome heroicons by Steve Schoger. To see
 all the icons visit [heroicons](https://heroicons.com/).
 
+All icons are included upto heroicons v0.4.2
+
 > This gem has no official affiliation with [Tailwind Labs](https://github.com/tailwindlabs),
 > yet.
 
@@ -16,19 +18,20 @@ gem "rails_heroicon"
 
 And then execute:
 
-    $ bundle install
+```bash
+bundle install
+```
 
 Or install it yourself as:
 
-    $ gem install rails_heroicon
+```bash
+gem install rails_heroicon
+```
 
 ## Usage
 
-After installing the gem, using it is as simple as
-
-```erb
-<%= heroicon "user" %>
-```
+After installing the gem, call `<%= heroicon "user" %>` on your `erb` template.
+The first argument is the icon name. All the icons are listed [here](https://heroicons.com/).
 
 This will generate the following html:
 
@@ -39,6 +42,7 @@ This will generate the following html:
   viewBox="0 0 24 24"
   fill="none"
   stroke="currentColor"
+  version="1.1"
 >
   <path
     d="M16 7C16 9.20914 14.2091 11 12 11C9.79086 11 8 9.20914 8 7C8 4.79086 9.79086 3 12 3C14.2091 3 16 4.79086 16 7Z"
@@ -62,17 +66,12 @@ the default.
 
 To change the variant `<%= heroicon "user", variant: "solid" %>`.
 
-### Accessibility
-
-`rails_heroicon` automatically sets `aria-hidden="true"` if `aria-label` is not
-set, and if `aria-label` is set, then `role="img"` is set.
-
 ### HTML attributes
 
-Any `html` attribute is supported, for eg:
+Any `html` and `eruby` attribute is supported, for eg:
 
 ```erb
-<%= heroicon "user", class: "text-gray-500", data: { controller: "icon" } %>
+<%= heroicon "user", class: "text-gray-500", aria: { label: "user-icon" } %>
 ```
 
 ### Handling the size of the icon
@@ -89,6 +88,11 @@ If the `variant` is set as `outline`, `size` automatically defaults to `24`,
 and if the `variant` is set as `solid`, `size` automatically defaults to `20`.
 However, this can be over-written with the `size` attribute.
 
+### Accessibility
+
+`rails_heroicon` automatically sets `aria-hidden="true"` if `aria-label` is not
+set, and if `aria-label` is set, then `role="img"` is set.
+
 ## Development
 
 - Clone the repo

data/lib/rails_heroicon/helper.rb

@@ -3,18 +3,14 @@ require "action_view"
 module RailsHeroicon
   module Helper
     # To add a heroicon, call <tt><%= heroicon "icon_name" %></tt> on your erb template.
-    # Head over to https://heroicons.com/ to view all the icons.
+    # Head over to https://heroicons.com to view all the icons.
     #
     # == Options
     # The helper method accepts mutiple arguments such as:
     #
     # === Variant
     # There are two types of variants: 'outline' and 'solid', the default being the 'outline'.
-    # To specify the solid variant, call <tt><%= heroicon "icon_name", variant: :solid %></tt>
-    #
-    # === Accessibility
-    # The helper method automatically sets <tt>aria-hidden=true</tt> if <tt>aria-label</tt> is not set, and
-    # if <tt>aria-label</tt> is set, then <tt>role=img</tt> is set automatically.
+    # To specify the solid variant, call <tt><%= heroicon "icon_name", variant: "solid" %></tt>
     #
     # === HTML attributes
     # Any <tt>html</tt> attribute is supported, for eg:
@@ -32,6 +28,10 @@ module RailsHeroicon
     # If the variant is set as <tt>outline</tt>, size automatically defaults to 24, and if the variant is set as
     # <tt>solid</tt>, size automatically defaults to 20. However, this can be over-written with the <tt>size</tt>
     # attribute.
+    #
+    # == Accessibility
+    # The helper method automatically sets <tt>aria-hidden=true</tt> if <tt>aria-label</tt> is not set, and
+    # if <tt>aria-label</tt> is set, then <tt>role=img</tt> is set automatically.
     def heroicon(symbol, **options)
       icon = RailsHeroicon.new(symbol, **options)
       content_tag(:svg, icon.svg_path.html_safe, icon.options)

data/lib/rails_heroicon/version.rb

@@ -1,3 +1,3 @@
 module RailsHeroicon
-  VERSION = "1.0.0".freeze
+  VERSION = "1.0.1".freeze
 end

metadata

@@ -1,91 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: rails_heroicon
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - abeidahmed
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-24 00:00:00.000000000 Z
+date: 2021-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '11.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 11.1.3
-  type: :development
+        version: '0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '11.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 11.1.3
-- !ruby/object:Gem::Dependency
-  name: nokogiri
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.11.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.11.1
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.7'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
 description: 
 email:
 - abeidahmed92@gmail.com
@@ -93,7 +31,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- CHANGELOG.md
 - LICENSE.txt
 - README.md
 - compressed/outline/academic-cap.svg
@@ -576,7 +513,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: Ruby on Rails view helpers for the awesome Heroicons by Steve Schoger.

data/CHANGELOG.md

@@ -1,19 +0,0 @@
-# Changelog
-
-## 1.0.0
-
-- Compress svg icons for performance
-- Make lib production ready
-
-## 0.2.0
-
-- Support ruby >= 2.6.6
-
-## 0.1.1
-
-- Add `rdoc` documentation
-- Add documentation for core methods
-
-## 0.1.0
-
-- Release gem