phosphor_icons 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4df513626e0433a5543cfe4d3072e7fef44cbb7a240ba3254b6d3a923c089856
-  data.tar.gz: 63ae690f3ed7a5d7b4b36c07dfa6dfb4232683eddd63729dfa23caa02794e260
+  metadata.gz: a63df93112504f36a0bfdaeab61b8258749b83277475b92d5ea8323c844a6755
+  data.tar.gz: 155858dc2cbd7588edd502e3470e0a3fcc996bc4dbe2f97c842a52d857e08514
 SHA512:
-  metadata.gz: 40da2668ec567983f5fe147ba4255f43c94a2fa58a3bd0142ae470ec0825010b54ed8f065dc8c67125e0dc727d08efa11a3b1aac8ba50eca69a7ea53621b1240
-  data.tar.gz: 77d76be65eb64bfae8355e4216e5b6c58ce2642b1ccdc1f502f213591ecbe4dd159ce3a4a2358e7912bc9f296a4345f27af6c0cd6f4863d45749c17361df02d7
+  metadata.gz: 40782061c0446fc20d04d4015d930ec552dd4cfecfa2769b1e529159de300eaaa266551889560a676c13d2422e3b59ca1070396390d7b93f872978fefb8c9f16
+  data.tar.gz: 20d489e20f9c81024572034b6baedb0ce2263928312865b50e46b48457e76d72f9b07d0662940681c2a058b6702c09fe230be7a12c06181039bdf3907084efbd

data/README.md

@@ -4,6 +4,13 @@
 
 # Ruby Phosphor Icons
 
+<a href="https://github.com/maful/ruby-phosphor-icons/actions?query=workflow%3ACI">
+  <img src="https://github.com/maful/ruby-phosphor-icons/actions/workflows/ci.yml/badge.svg" alt="Tests">
+</a>
+<a href="https://rubygems.org/gems/phosphor_icons">
+  <img src="https://img.shields.io/gem/v/phosphor_icons" alt="Latest Stable Version">
+</a>
+
 A gem to easily include [Phosphor Icons](https://phosphoricons.com) in your Ruby and Rails apps.
 
 For a full list of available icons see [the assets directory](https://github.com/phosphor-icons/core/tree/c67d7a849f450be1bfe64fd5820471e4019e5ff0/assets) or preview them at [phosphoricons.com](https://phosphoricons.com/).
@@ -20,6 +27,12 @@ Install the gem and add to the application's Gemfile by executing:
 bundle add phosphor_icons
 ```
 
+or add this in your Gemfile
+
+```rb
+gem "phosphor_icons"
+```
+
 ## Usage
 
 ```ruby
@@ -27,13 +40,14 @@ require "phosphor_icons"
 
 icon = PhosphorIcons::Icon.new("alarm")
 icon.to_svg
-# <svg class="phosphor-icon" viewBox="0 0 256 256" xmlns="http://www.w3.org/2000/svg" fill="currentColor"><path d="M128,32a96,96,0,1,0,96,96A96.11,96.11,0,0,0,128,32Zm0,176a80,80,0,1,1,80-80A80.09,80.09,0,0,1,128,208ZM61.66,29.66l-32,32A8,8,0,0,1,18.34,50.34l32-32A8,8,0,1,1,61.66,29.66Zm176,32a8,8,0,0,1-11.32,0l-32-32a8,8,0,0,1,11.32-11.32l32,32A8,8,0,0,1,237.66,61.66ZM184,120a8,8,0,0,1,0,16H128a8,8,0,0,1-8-8V72a8,8,0,0,1,16,0v48Z"/></svg>
+# <svg class="phosphor-icon" viewBox="0 0 256 256" xmlns="http://www.w3.org/2000/svg" fill="currentColor" width="24" height="24"><path d="M128,32a96,96,0,1,0,96,96A96.11,96.11,0,0,0,128,32Zm0,176a80,80,0,1,1,80-80A80.09,80.09,0,0,1,128,208ZM61.66,29.66l-32,32A8,8,0,0,1,18.34,50.34l32-32A8,8,0,1,1,61.66,29.66Zm176,32a8,8,0,0,1-11.32,0l-32-32a8,8,0,0,1,11.32-11.32l32,32A8,8,0,0,1,237.66,61.66ZM184,120a8,8,0,0,1,0,16H128a8,8,0,0,1-8-8V72a8,8,0,0,1,16,0v48Z"/></svg>
 ```
 
 If you are using Ruby on Rails, you can use `phosphor_icon` helper in your views directly
 
 ```erb
-<%= phosphor_icon "alarm", class: "h-5 w-5 %>
+<%= phosphor_icon "alarm", class: "h-5 w-5" %>
+<%= phosphor_icon "x", height: 48 %>
 ```
 
 ## Documentation
@@ -47,6 +61,8 @@ This is the name of the Phosphor Icon you want to use. For example `alarm`. [Ful
 ### Options
 
 * `:style` - Apply a specific style to the icon. Available options are `regular` (default), `bold`, `light`, `duotone`, `fill` and `thin`.
+* `:height` - When setting the height to a number, the icon will scale to that size. For example, passing `24`, will calculate the width based on the icon's natural size.
+* `:width` - When setting the width to a number, the icon will scale to that size. For example, passing `24`, will calculate the width based on the icon's natural size.
 
 ### Attributes
 
@@ -89,7 +105,27 @@ This is a hash of all the `options` that will be added to the output tag.
 ```rb
 icon = PhosphorIcons::Icon.new("alarm")
 icon.options
-# {:class=>"phosphor-icon", :viewBox=>"0 0 256 256", :xmlns=>"http://www.w3.org/2000/svg", :fill=>"currentColor"}
+# {:class=>"phosphor-icon", :viewBox=>"0 0 256 256", :xmlns=>"http://www.w3.org/2000/svg", :fill=>"currentColor", :width=>24, :height=>24}
+```
+
+#### `width`
+
+Width is the icon's true width.
+
+```rb
+icon = PhosphorIcons::Icon.new("alarm", width: 24)
+icon.height
+# 24
+```
+
+#### `height`
+
+Height is the icon's true height.
+
+```rb
+icon = PhosphorIcons::Icon.new("alarm", height: 24)
+icon.height
+# 24
 ```
 
 ### Methods
@@ -101,7 +137,7 @@ Returns a string of the svg tag
 ```rb
 icon = PhosphorIcons::Icon.new("alarm")
 icon.to_svg
-# <svg class="phosphor-icon" viewBox="0 0 256 256" xmlns="http://www.w3.org/2000/svg" fill="currentColor"><path d="M128,32a96,96,0,1,0,96,96A96.11,96.11,0,0,0,128,32Zm0,176a80,80,0,1,1,80-80A80.09,80.09,0,0,1,128,208ZM61.66,29.66l-32,32A8,8,0,0,1,18.34,50.34l32-32A8,8,0,1,1,61.66,29.66Zm176,32a8,8,0,0,1-11.32,0l-32-32a8,8,0,0,1,11.32-11.32l32,32A8,8,0,0,1,237.66,61.66ZM184,120a8,8,0,0,1,0,16H128a8,8,0,0,1-8-8V72a8,8,0,0,1,16,0v48Z"/></svg>
+# <svg class="phosphor-icon" viewBox="0 0 256 256" xmlns="http://www.w3.org/2000/svg" fill="currentColor" width="24" height="24"><path d="M128,32a96,96,0,1,0,96,96A96.11,96.11,0,0,0,128,32Zm0,176a80,80,0,1,1,80-80A80.09,80.09,0,0,1,128,208ZM61.66,29.66l-32,32A8,8,0,0,1,18.34,50.34l32-32A8,8,0,1,1,61.66,29.66Zm176,32a8,8,0,0,1-11.32,0l-32-32a8,8,0,0,1,11.32-11.32l32,32A8,8,0,0,1,237.66,61.66ZM184,120a8,8,0,0,1,0,16H128a8,8,0,0,1-8-8V72a8,8,0,0,1,16,0v48Z"/></svg>
 ```
 
 ## Development

data/lib/phosphor_icons/icon.rb

@@ -4,19 +4,25 @@ module PhosphorIcons
   class Icon
     DEFAULT_STYLE = "regular"
     SUPPORTED_STYLES = [DEFAULT_STYLE, "bold", "light", "duotone", "fill", "thin"]
+    NATURAL_HEIGHTS = [16, 20, 24, 28, 32, 36, 40, 44, 48, 52, 56, 60, 64, 68, 72, 76, 80]
+    DEFAULT_HEIGHT = 24
 
-    attr_reader :symbol, :style, :options, :path
+    attr_reader :symbol, :style, :options, :path, :width, :height
 
     def initialize(symbol, options = {})
       @symbol = symbol.to_s
       @style = options[:style] || DEFAULT_STYLE
       if (phosphor_icon = get_phosphor_icon(@symbol, options))
         @path = phosphor_icon["path"]
+        @width = phosphor_icon["width"]
+        @height = phosphor_icon["height"]
         @options = {
           class: "phosphor-icon #{options[:class]}".strip,
           viewBox: viewbox,
           xmlns: "http://www.w3.org/2000/svg",
           fill: "currentColor",
+          width: @width,
+          height: @height,
         }
       else
         raise IconNotFoundError, "Couldn't find #{self}"
@@ -45,10 +51,14 @@ module PhosphorIcons
 
     def get_phosphor_icon(symbol, options = {})
       if (phosphor_icon = PhosphorIcons::ICON_SYMBOLS[symbol])
+        height = options[:height] || options[:width] || DEFAULT_HEIGHT
+        natural_height = closest_natural_height(height)
         style = get_style(options[:style])
 
         {
           "name" => phosphor_icon["name"],
+          "width" => natural_height,
+          "height" => natural_height,
           "path" => phosphor_icon["styles"][style.to_s]["path"],
         }
       end
@@ -59,5 +69,11 @@ module PhosphorIcons
     def get_style(style)
       SUPPORTED_STYLES.include?(style.to_s) ? style : DEFAULT_STYLE
     end
+
+    def closest_natural_height(height)
+      NATURAL_HEIGHTS.reduce(NATURAL_HEIGHTS[0].to_i) do |acc, natural_height|
+        natural_height.to_i <= height.to_i ? natural_height.to_i : acc
+      end
+    end
   end
 end

data/lib/phosphor_icons/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PhosphorIcons
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: phosphor_icons
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Maful Prayoga
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-06-22 00:00:00.000000000 Z
+date: 2023-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ox