rails_heroicon 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 036e43862972296490064dff1eb9597b6854243121730bb870746dafb1e9a2ae
-  data.tar.gz: 25c509f874ee1ff535ecbf64b9dbc0f6f2b13393f0635ab0017457ae4757f553
+  metadata.gz: 2aed94b6ddf272cc5af1926db6db5b8e03395c5d258fc56ec232f28aa1cf4c9b
+  data.tar.gz: 0f20b6f8f11abeaebfe16fae67a2c46e9964019519e475c7036b1e5167f527d9
 SHA512:
-  metadata.gz: 4591fb73a8d70483b0a30b88cdfdb78625f2a5aacbff89fad35763090e971c13252d6bf2fc4d68a7b38f052f6796fa4eb47dd426e525d557cee615115c09c300
-  data.tar.gz: c6a5df14bd328ef13c49334b198ec79975f55f064120e524c3cee98dd66ba3f87765e338b654cf2bddbbe99661a5372ee6720ec3fdb627454588c238d6a0f717
+  metadata.gz: 2ceaf42df7a6a8735e9ec20d8de3899c8b956a9553cf57be0c81649c3b8473a285855135b219e8a9a22acc4f420e2477bfd9a8b1f9a26f80c29f881810da01fa
+  data.tar.gz: d9386e51465ef3025ffae99f21fc61b8496a20df54cc0b40f40c89afc2e4adba7cb57a096d23ba5c6e04082672321413c8b42dd1cc6b3afd76df4c70eab037b2

data/.github/workflows/ci.yml

@@ -0,0 +1,25 @@
+name: CI
+on: [pull_request]
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [2.7, 3.0]
+    steps:
+      - name: Checkout
+        uses: actions/checkout@main
+
+      - name: Setup Ruby
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+
+      - name: Install Dependencies
+        run: |
+          gem update --system
+          gem install bundler
+          bundle install --jobs 4 --retry 3
+
+      - name: Tests
+        run: bundle exec rake

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 0.1.1
+
+- Add `rdoc` documentation
+- Add documentation for core methods
+
 ## 0.1.0
 
 - Release gem

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rails_heroicon (0.1.0.alpha)
+    rails_heroicon (0.1.0)
       nokogiri (>= 1.11.1)
 
 GEM
@@ -56,4 +56,4 @@ DEPENDENCIES
   rubocop (~> 1.7)
 
 BUNDLED WITH
-   2.2.7
+   2.2.11

data/README.md

@@ -1,6 +1,6 @@
-# RailsHeroicon
+# Rails Heroicon ![ci](https://github.com/abeidahmed/rails-heroicon/actions/workflows/ci.yml/badge.svg)
 
-A set of free MIT-licensed high-quality SVG icons for your rails app. To view
+Ruby on Rails `view helpers` for the awesome Heroicons by Steve Schoger. To view
 all the icons visit [heroicons](https://heroicons.com/).
 
 > This gem has no official affiliation with Tailwind labs yet.

data/lib/rails_heroicon/helper.rb

@@ -2,6 +2,36 @@ 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.
+    #
+    # == 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.
+    #
+    # === HTML attributes
+    # Any <tt>html</tt> attribute is supported, for eg:
+    #
+    # <tt><%= heroicon "icon_name", class: "text-gray-500", data: { controller: "icon" } %></tt>
+    #
+    # === Handling the icon size
+    # Normally, if you're just using vanilla heroicons with tailwindcss, you'd set <tt>w-5 h-5</tt> as class attributes
+    # on the svg. With this helper, you just need to set the <tt>size</tt> attribute on the icon.
+    #
+    # <tt><%= heroicon "icon_name", size: 20 %></tt>
+    #
+    # This will set the <tt>height</tt> and <tt>width</tt> attribute on the svg.
+    #
+    # 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.
     def heroicon(symbol, **options)
       icon = RailsHeroicon.new(symbol, **options)
       content_tag(:svg, icon.svg_path.html_safe, icon.options)

data/lib/rails_heroicon/rails_heroicon.rb

@@ -26,6 +26,7 @@ module RailsHeroicon
       })
     end
 
+    # Finds the svg icon with respect to variant.
     def svg_path
       file_path = if solid?
                     "#{SOLID_ICON_PATH}/#{@icon}.svg"
@@ -56,6 +57,8 @@ module RailsHeroicon
       accessible
     end
 
+    # If the user has explicitly stated the size attribute, then use that. If size attribute is not passed
+    # then default to 24 if variant is outline, else default to 20 if variant is solid.
     def icon_size_with(size)
       if size
         size

data/lib/rails_heroicon/version.rb

@@ -1,3 +1,3 @@
 module RailsHeroicon
-  VERSION = "0.1.0".freeze
+  VERSION = "0.1.1".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_heroicon
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - abeidahmed
@@ -31,6 +31,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -502,7 +503,6 @@ files:
 - lib/rails_heroicon/errors.rb
 - lib/rails_heroicon/helper.rb
 - lib/rails_heroicon/rails_heroicon.rb
-- lib/rails_heroicon/rails_heroicon_helper.rb
 - lib/rails_heroicon/railtie.rb
 - lib/rails_heroicon/version.rb
 - rails_heroicon.gemspec
@@ -528,7 +528,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Ruby on Rails view helpers for the awesome Heroicons by Steve Schoger.

data/lib/rails_heroicon/rails_heroicon_helper.rb

@@ -1,10 +0,0 @@
-require "action_view"
-
-module RailsHeroicon
-  module Helper
-    def heroicon(symbol, **options)
-      icon = RailsHeroicon.new(symbol, **options)
-      content_tag(:svg, icon.svg_path.html_safe, icon.options)
-    end
-  end
-end