forticons 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 79a59826e00fecb1797a7d45728b744f963ff5d14f1e55563d0173e9b85b6636
-  data.tar.gz: 1da920e31762df27e254b5c11ea7dd491a2e8382b459780d88a729cceac4b826
+  metadata.gz: 77b60bc441307613bc40a5fe23d0ba56fa22c6dbd5007f2a3d210cd6bebac87c
+  data.tar.gz: c22f5342d5e871bc8dc0f1e0769ba360d9f6b507dbeecc2d1465032588bfa0ff
 SHA512:
-  metadata.gz: b42e4147527e1da5c333b17790e913e0808e95caf9a7665d948583e6a908a8f3f6036daca59b7a5afe368cf12995ff9d83adb864661662e02fa3a9c46dbd2bb4
-  data.tar.gz: 596d3b3b7624e2dcb128b94d3201a01401f7c625993a0ceb1d127264f3b41910a3677ab2f8110af1acc519c2509ee5bf6ef0a751522cff5230dc2cb658442563
+  metadata.gz: d2a1ad75460301064b6f36d2123b23531e2d5c18a9ba099e272e334418b842876aefdbacff812a021179b404328ba0047d6a5ff45d27ac087c8b731e48e87fb7
+  data.tar.gz: 3cbbd257e5208c68212c6e9b2f7dc4b8d5d85e3d59c0aec942f1f64694e40c2a1571c5e4d7a680eef7f9eb14d29dd9b949a9d5c447f756a1351be2c06e8761a2

data/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2023 GitHub Inc.
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2023 GitHub Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -1,103 +1,103 @@
-# forticons 
-
-[![Gem version](https://img.shields.io/gem/v/forticons.svg)](https://rubygems.org/gems/forticons)
-
-## Install
-
-Add this to your `Gemfile`
-
-```rb
-gem 'forticons'
-```
-
-Then `bundle install`.
-
-If using a framework like Rails, please follow the [installation instructions](https://primer.style/view-components/#installation) in the [Primer ViewComponents](https://primer.style/view-components) documentation. 
-
-## Usage
-
-```rb
-require 'forticons'
-icon = Forticons::Forticon.new("x")
-icon.to_svg
-# <svg class="forticon forticon-x" viewBox="0 0 16 16" width="16" height="16" version="1.1" "aria-hidden"="true"><path d="M7.48 8l3.75 3.75-1.48 1.48L6 9.48l-3.75 3.75-1.48-1.48L4.52 8 .77 4.25l1.48-1.48L6 6.52l3.75-3.75 1.48 1.48z"></path></svg>
-```
-
-## Documentation
-
-The `Forticon` class takes two arguments. The first is the symbol of the icon, and the second is a hash of arguments representing html attributes
-
-### `symbol` _(required)_
-
-This is the name of the forticon you want to use. For example `alert`. [Full list of icons](/)
-
-### Options
-
-* `:height` - When setting the height to a number, the icon will scale to that size. For example, passing `32`, 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 `32`, will calculate the width based on the icon's natural size.
-
-If both `:width, :height` are passed into the options hash, then the icon will be sized exactly at those dimensions.
-
-### Attributes
-
-Once initialized, you can read a few properties from the icon.
-
-#### `symbol`
-
-Returns the string of the symbol name
-
-```rb
-icon = Forticons::Forticon.new("x")
-icon.symbol
-# "x"
-```
-
-#### `path`
-
-Path returns the string representation of the path of the icon.
-
-```rb
-icon = Forticons::Forticon.new("x")
-icon.path
-# <path d="M7.48 8l3.75 3.75-1.48 1.48L6 9.48l-3.75 3.75-1.48-1.48L4.52 8 .77 4.25l1.48-1.48L6 6.52l3.75-3.75 1.48 1.48z"></path>
-```
-
-#### `options`
-
-This is a hash of all the `options` that will be added to the output tag.
-
-```rb
-icon = Forticons::Forticon.new("x")
-icon.options
-# {:class=>"forticon forticon-x", :viewBox=>"0 0 12 16", :version=>"1.1", :width=>12, :height=>16, :"aria-hidden"=>"true"}
-```
-
-#### `width`
-
-Width is the icon's true width. Based on the svg view box width. _Note, this doesn't change if you scale it up with size options, it only is the natural width of the icon_
-
-#### `height`
-
-Height is the icon's true height. Based on the svg view box height. _Note, this doesn't change if you scale it up with size options, it only is the natural height of the icon_
-
-#### `keywords`
-
-Returns an array of keywords for the icon. The data comes from the [data file in lib](../data.json). Consider contributing more aliases for the icons.
-
-```rb
-icon = Forticons::Forticon.new("x")
-icon.keywords
-# ["remove", "close", "delete"]
-```
-
-### Methods
-
-#### `to_svg`
-
-Returns a string of the svg tag
-
-```rb
-icon = Forticons::Forticon.new("x")
-icon.to_svg
-# <svg class="forticon forticon-x" viewBox="0 0 16 16" width="16" height="16" version="1.1" "aria-hidden"="true"><path d="M7.48 8l3.75 3.75-1.48 1.48L6 9.48l-3.75 3.75-1.48-1.48L4.52 8 .77 4.25l1.48-1.48L6 6.52l3.75-3.75 1.48 1.48z"></path></svg>
-```
+# forticons 
+
+[![Gem version](https://img.shields.io/gem/v/forticons.svg)](https://rubygems.org/gems/forticons)
+
+## Install
+
+Add this to your `Gemfile`
+
+```rb
+gem 'forticons'
+```
+
+Then `bundle install`.
+
+If using a framework like Rails, please follow the [installation instructions](https://primer.style/view-components/#installation) in the [Primer ViewComponents](https://primer.style/view-components) documentation. 
+
+## Usage
+
+```rb
+require 'forticons'
+icon = Forticons::Forticon.new("x")
+icon.to_svg
+# <svg class="forticon forticon-x" viewBox="0 0 16 16" width="16" height="16" version="1.1" "aria-hidden"="true"><path d="M7.48 8l3.75 3.75-1.48 1.48L6 9.48l-3.75 3.75-1.48-1.48L4.52 8 .77 4.25l1.48-1.48L6 6.52l3.75-3.75 1.48 1.48z"></path></svg>
+```
+
+## Documentation
+
+The `Forticon` class takes two arguments. The first is the symbol of the icon, and the second is a hash of arguments representing html attributes
+
+### `symbol` _(required)_
+
+This is the name of the forticon you want to use. For example `alert`. [Full list of icons](/)
+
+### Options
+
+* `:height` - When setting the height to a number, the icon will scale to that size. For example, passing `32`, 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 `32`, will calculate the width based on the icon's natural size.
+
+If both `:width, :height` are passed into the options hash, then the icon will be sized exactly at those dimensions.
+
+### Attributes
+
+Once initialized, you can read a few properties from the icon.
+
+#### `symbol`
+
+Returns the string of the symbol name
+
+```rb
+icon = Forticons::Forticon.new("x")
+icon.symbol
+# "x"
+```
+
+#### `path`
+
+Path returns the string representation of the path of the icon.
+
+```rb
+icon = Forticons::Forticon.new("x")
+icon.path
+# <path d="M7.48 8l3.75 3.75-1.48 1.48L6 9.48l-3.75 3.75-1.48-1.48L4.52 8 .77 4.25l1.48-1.48L6 6.52l3.75-3.75 1.48 1.48z"></path>
+```
+
+#### `options`
+
+This is a hash of all the `options` that will be added to the output tag.
+
+```rb
+icon = Forticons::Forticon.new("x")
+icon.options
+# {:class=>"forticon forticon-x", :viewBox=>"0 0 12 16", :version=>"1.1", :width=>12, :height=>16, :"aria-hidden"=>"true"}
+```
+
+#### `width`
+
+Width is the icon's true width. Based on the svg view box width. _Note, this doesn't change if you scale it up with size options, it only is the natural width of the icon_
+
+#### `height`
+
+Height is the icon's true height. Based on the svg view box height. _Note, this doesn't change if you scale it up with size options, it only is the natural height of the icon_
+
+#### `keywords`
+
+Returns an array of keywords for the icon. The data comes from the [data file in lib](../data.json). Consider contributing more aliases for the icons.
+
+```rb
+icon = Forticons::Forticon.new("x")
+icon.keywords
+# ["remove", "close", "delete"]
+```
+
+### Methods
+
+#### `to_svg`
+
+Returns a string of the svg tag
+
+```rb
+icon = Forticons::Forticon.new("x")
+icon.to_svg
+# <svg class="forticon forticon-x" viewBox="0 0 16 16" width="16" height="16" version="1.1" "aria-hidden"="true"><path d="M7.48 8l3.75 3.75-1.48 1.48L6 9.48l-3.75 3.75-1.48-1.48L4.52 8 .77 4.25l1.48-1.48L6 6.52l3.75-3.75 1.48 1.48z"></path></svg>
+```

data/lib/forticons/forticon.rb

@@ -1,107 +1,107 @@
-module Forticons
-  class Forticon
-    DEFAULT_HEIGHT = 16
-
-    attr_reader :path, :options, :width, :height, :symbol, :keywords
-
-    def initialize(symbol, options = {})
-      @symbol = symbol.to_s
-      if forticon = get_forticon(@symbol, options)
-        @path = forticon["path"]
-        @width = forticon["width"]
-        @height = forticon["height"]
-        @keywords = forticon["keywords"]
-        @options = options.dup
-        @options.merge!({
-          class:   classes,
-          viewBox: viewbox,
-          version: "1.1"
-        })
-        @options.merge!(size)
-        @options.merge!(a11y)
-      else
-        raise "Couldn't find forticon symbol for #{@symbol.inspect}"
-      end
-    end
-
-    # Returns an string representing a <svg> tag
-    def to_svg
-      "<svg #{html_attributes}>#{@path}</svg>"
-    end
-
-    private
-
-    def html_attributes
-      attrs = ""
-      @options.each { |attr, value| attrs += "#{attr}=\"#{value}\" " }
-      attrs.strip
-    end
-
-    # add some accessibility features to svg
-    def a11y
-      accessible = {}
-
-      if @options[:"aria-label"].nil? && @options["aria-label"].nil?
-        accessible[:"aria-hidden"] = "true"
-      else
-        accessible[:role] = "img"
-      end
-
-      accessible
-    end
-
-    # prepare the forticon class
-    def classes
-      "forticon forticon-#{@symbol} #{@options[:class]} ".strip
-    end
-
-    def viewbox
-      "0 0 #{@width} #{@height}"
-    end
-
-    # determine the height and width of the forticon based on :size option
-    def size
-      size = {
-        width:  @width,
-        height: @height
-      }
-
-      # Specific size
-      unless @options[:width].nil? && @options[:height].nil?
-        size[:width]  = @options[:width].nil?  ? calculate_width(@options[:height]) : @options[:width]
-        size[:height] = @options[:height].nil? ? calculate_height(@options[:width]) : @options[:height]
-      end
-
-      size
-    end
-
-    def calculate_width(height)
-      (height.to_i * @width) / @height
-    end
-
-    def calculate_height(width)
-      (width.to_i * @height) / @width
-    end
-
-    def get_forticon(symbol, options = {})
-      if forticon = Forticons::FORTICON_SYMBOLS[symbol]
-        # We're using width as an approximation for height if the height option is not passed in
-        height = options[:height] || options[:width] || DEFAULT_HEIGHT
-        natural_height = closest_natural_height(forticon["heights"].keys, height)
-        return {
-          "name" => forticon["name"],
-          "keywords" => forticon["keywords"],
-          "width" => forticon["heights"][natural_height.to_s]["width"].to_i,
-          "height" => natural_height,
-          "path" => forticon["heights"][natural_height.to_s]["path"]
-        }
-      end
-    end
-
-    def closest_natural_height(natural_heights, height)
-      return 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
+module Forticons
+  class Forticon
+    DEFAULT_HEIGHT = 16
+
+    attr_reader :path, :options, :width, :height, :symbol, :keywords
+
+    def initialize(symbol, options = {})
+      @symbol = symbol.to_s
+      if forticon = get_forticon(@symbol, options)
+        @path = forticon["path"]
+        @width = forticon["width"]
+        @height = forticon["height"]
+        @keywords = forticon["keywords"]
+        @options = options.dup
+        @options.merge!({
+          class:   classes,
+          viewBox: viewbox,
+          version: "1.1"
+        })
+        @options.merge!(size)
+        @options.merge!(a11y)
+      else
+        raise "Couldn't find forticon symbol for #{@symbol.inspect}"
+      end
+    end
+
+    # Returns an string representing a <svg> tag
+    def to_svg
+      "<svg #{html_attributes}>#{@path}</svg>"
+    end
+
+    private
+
+    def html_attributes
+      attrs = ""
+      @options.each { |attr, value| attrs += "#{attr}=\"#{value}\" " }
+      attrs.strip
+    end
+
+    # add some accessibility features to svg
+    def a11y
+      accessible = {}
+
+      if @options[:"aria-label"].nil? && @options["aria-label"].nil?
+        accessible[:"aria-hidden"] = "true"
+      else
+        accessible[:role] = "img"
+      end
+
+      accessible
+    end
+
+    # prepare the forticon class
+    def classes
+      "forticon forticon-#{@symbol} #{@options[:class]} ".strip
+    end
+
+    def viewbox
+      "0 0 #{@width} #{@height}"
+    end
+
+    # determine the height and width of the forticon based on :size option
+    def size
+      size = {
+        width:  @width,
+        height: @height
+      }
+
+      # Specific size
+      unless @options[:width].nil? && @options[:height].nil?
+        size[:width]  = @options[:width].nil?  ? calculate_width(@options[:height]) : @options[:width]
+        size[:height] = @options[:height].nil? ? calculate_height(@options[:width]) : @options[:height]
+      end
+
+      size
+    end
+
+    def calculate_width(height)
+      (height.to_i * @width) / @height
+    end
+
+    def calculate_height(width)
+      (width.to_i * @height) / @width
+    end
+
+    def get_forticon(symbol, options = {})
+      if forticon = Forticons::FORTICON_SYMBOLS[symbol]
+        # We're using width as an approximation for height if the height option is not passed in
+        height = options[:height] || options[:width] || DEFAULT_HEIGHT
+        natural_height = closest_natural_height(forticon["heights"].keys, height)
+        return {
+          "name" => forticon["name"],
+          "keywords" => forticon["keywords"],
+          "width" => forticon["heights"][natural_height.to_s]["width"].to_i,
+          "height" => natural_height,
+          "path" => forticon["heights"][natural_height.to_s]["path"]
+        }
+      end
+    end
+
+    def closest_natural_height(natural_heights, height)
+      return 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/forticons/version.rb

@@ -1,3 +1,3 @@
-module Forticons
-  VERSION = "0.0.3".freeze
-end
+module Forticons
+  VERSION = "0.0.4".freeze
+end

data/lib/forticons.rb

@@ -1,8 +1,8 @@
-require "forticons/version"
-require "forticons/forticon"
-require "json"
-
-module Forticons
-  file_data = File.read(File.join(File.dirname(__FILE__), "./build/data.json"))
-  FORTICON_SYMBOLS = JSON.parse(file_data).freeze
-end
+require "forticons/version"
+require "forticons/forticon"
+require "json"
+
+module Forticons
+  file_data = File.read(File.join(File.dirname(__FILE__), "./build/data.json"))
+  FORTICON_SYMBOLS = JSON.parse(file_data).freeze
+end

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: forticons
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - anosim114
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
 date: 2023-12-02 00:00:00.000000000 Z
@@ -27,7 +27,7 @@ homepage: https://github.com/anosim114/forticons
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -43,7 +43,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.4.10
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Octicons like FontAwesome icon library
 test_files: []