openproject-octicons_helper 19.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fdd6bd29e6e97ec86c576300a930b3d9e30cf47106695025c8e9cbc1ce412f41
+  data.tar.gz: 8b951e155cacd45f974889dcfdfa6936056e5f567a359ebfc18cf4e1e1523201
+SHA512:
+  metadata.gz: ac7eec64201f05b38b229ebb0d9e331a14a9a61e3f16c11e344431fcf26b8fe6342d5c33d456d3ba3925fd4ce861f023e17dcf93bd14b21f62d647fc737fce1d
+  data.tar.gz: 7cb978def130a41ed3e1bc16a3585edd3c9a006030b80daaff953a3179c66726e7b66c1166e2f06bc93cdd7d63ddad40b78226eed19628937c6a2ca14ec6686b

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,21 @@
+# octicons_helper
+
+[![Gem version](https://img.shields.io/gem/v/octicons_helper.svg)](https://rubygems.org/gems/octicons_helper)
+
+
+This rails helper lets you easily include svg octicons in your rails apps.
+
+## Install
+
+1. Add this to your `Gemfile`
+
+    ```rb
+    gem 'octicons_helper'
+    ```
+
+3. Use this tag in your erbs
+
+    ```rb
+    <%= octicon "alert", :height => 32,  :class => "right left", :"aria-label" => "hi" %>
+    ```
+We recommend including the CSS in the [`@primer/octicons`](/packages/javascript) npm module. You can also npm install that package and include `build/build.css` in your styles.

data/lib/octicons_helper/helper.rb

@@ -0,0 +1,24 @@
+require "octicons"
+require "action_view"
+
+module OcticonsHelper
+  include ActionView::Helpers::TagHelper
+
+  mattr_accessor :octicons_helper_cache, default: {}
+
+  def octicon(symbol, options = {})
+    return "" if symbol.nil?
+
+    cache_key = [symbol, options]
+
+    if tag = octicons_helper_cache[cache_key]
+      tag
+    else
+      icon = Octicons::Octicon.new(symbol, options)
+
+      tag = content_tag(:svg, icon.path.html_safe, icon.options).freeze # rubocop:disable Rails/OutputSafety
+      octicons_helper_cache[cache_key] = tag
+      tag
+    end
+  end
+end

data/lib/octicons_helper/railtie.rb

@@ -0,0 +1,9 @@
+require "rails"
+
+module OcticonsHelper
+  class Railtie < Rails::Railtie
+    initializer "octicons_helper.helper" do
+      ActionView::Base.send :include, OcticonsHelper
+    end
+  end
+end

data/lib/octicons_helper/version.rb

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

data/lib/octicons_helper.rb

@@ -0,0 +1,3 @@
+require "octicons_helper/version"
+require "octicons_helper/helper"
+require "octicons_helper/railtie" if defined?(Rails)

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: openproject-octicons_helper
+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:
+- !ruby/object:Gem::Dependency
+  name: openproject-octicons
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 19.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 19.4.0
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: actionview
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A rails helper that makes including svg Octicons simple.
+email:
+- support@openproject.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/octicons_helper.rb
+- lib/octicons_helper/helper.rb
+- lib/octicons_helper/railtie.rb
+- lib/octicons_helper/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: Octicons rails helper
+test_files: []