openproject-octicons 19.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e3e6ad82bfb63428f4640dbc2f8840e0b5e6dc76150a21e0b3a30e018f8b64ac
+  data.tar.gz: d062d7494a785370d24eff3b2f9b51089a934fdda0ce4fe24c0fbd5abcefc090
+SHA512:
+  metadata.gz: 292197e9ae1dde0bab169cc4d0cc531f46f8dfbd10b0a4f68b1849d7b0cb5347fcd81842e04c0087a90a47c0a54c163ed64af34f1fff3ce3bef97222e11fc4d1
+  data.tar.gz: a51fb17d2c0274db7e4a6befe710ffd84b96ca4cadba9985064badd5b31bd01df695cd91c8ed90a39f7fad80829400d55e50bde1fe371d86a841681973dbb67f

data/LICENSE

@@ -0,0 +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.

data/README.md

@@ -0,0 +1,103 @@
+# octicons 
+
+[![Gem version](https://img.shields.io/gem/v/octicons.svg)](https://rubygems.org/gems/octicons)
+
+## Install
+
+Add this to your `Gemfile`
+
+```rb
+gem 'octicons'
+```
+
+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 'octicons'
+icon = Octicons::Octicon.new("x")
+icon.to_svg
+# <svg class="octicon octicon-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 `Octicon` 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 octicon 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 = Octicons::Octicon.new("x")
+icon.symbol
+# "x"
+```
+
+#### `path`
+
+Path returns the string representation of the path of the icon.
+
+```rb
+icon = Octicons::Octicon.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 = Octicons::Octicon.new("x")
+icon.options
+# {:class=>"octicon octicon-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 = Octicons::Octicon.new("x")
+icon.keywords
+# ["remove", "close", "delete"]
+```
+
+### Methods
+
+#### `to_svg`
+
+Returns a string of the svg tag
+
+```rb
+icon = Octicons::Octicon.new("x")
+icon.to_svg
+# <svg class="octicon octicon-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/octicons/octicon.rb

@@ -0,0 +1,107 @@
+module Octicons
+  class Octicon
+    DEFAULT_HEIGHT = 16
+
+    attr_reader :path, :options, :width, :height, :symbol, :keywords
+
+    def initialize(symbol, options = {})
+      @symbol = symbol.to_s
+      if octicon = get_octicon(@symbol, options)
+        @path = octicon["path"]
+        @width = octicon["width"]
+        @height = octicon["height"]
+        @keywords = octicon["keywords"]
+        @options = options.dup
+        @options.merge!({
+          class:   classes,
+          viewBox: viewbox,
+          version: "1.1"
+        })
+        @options.merge!(size)
+        @options.merge!(a11y)
+      else
+        raise "Couldn't find octicon 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 octicon class
+    def classes
+      "octicon octicon-#{@symbol} #{@options[:class]} ".strip
+    end
+
+    def viewbox
+      "0 0 #{@width} #{@height}"
+    end
+
+    # determine the height and width of the octicon 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_octicon(symbol, options = {})
+      if octicon = Octicons::OCTICON_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(octicon["heights"].keys, height)
+        return {
+          "name" => octicon["name"],
+          "keywords" => octicon["keywords"],
+          "width" => octicon["heights"][natural_height.to_s]["width"].to_i,
+          "height" => natural_height,
+          "path" => octicon["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/octicons/version.rb

@@ -0,0 +1,3 @@
+module Octicons
+  VERSION = "19.4.0".freeze
+end

data/lib/octicons.rb

@@ -0,0 +1,8 @@
+require "octicons/version"
+require "octicons/octicon"
+require "json"
+
+module Octicons
+  file_data = File.read(File.join(File.dirname(__FILE__), "./build/data.json"))
+  OCTICON_SYMBOLS = JSON.parse(file_data).freeze
+end

metadata

@@ -0,0 +1,50 @@
+--- !ruby/object:Gem::Specification
+name: openproject-octicons
+version: !ruby/object:Gem::Version
+  version: 19.4.0
+platform: ruby
+authors:
+- GitHub Inc.
+- OpenProject GmbH
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-07-17 00:00:00.000000000 Z
+dependencies: []
+description: A package that distributes Octicons in a gem
+email:
+- support@openproject.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/octicons.rb
+- lib/octicons/octicon.rb
+- lib/octicons/version.rb
+homepage: https://github.com/opf/openproject-octicons
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'false'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key: 
+specification_version: 4
+summary: GitHub's octicons gem
+test_files: []