heroicons_helper 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 668ee3c4c63423a55043c27767e157662c42eae1b79dd983f2112482eee0f661
+  data.tar.gz: a73d673d85a739017cf0b98b383629418a6c8730b1dc98fd9367cb34b574e01f
+SHA512:
+  metadata.gz: 43c906d2e65a78ce00fc56c164788930d7e4a6c0c12edaf7c416357a927a5e50e2c8edb8ba210b6f033717761f3ddf6aa4fafb171158a4b81ee893c4971e2d40
+  data.tar.gz: 19adfe1de1ee6e9ca95cf225afd6d69b9ff9667e2307fb8080b5ca4b7547026800fcab3dbf374a231e9475e5e97aeebfefe61f5216755e0cd56313c1078e67a6

data/.rubocop.yml

@@ -0,0 +1,4 @@
+inherit_gem:
+  rubocop-standard:
+    - config/default.yml
+    - config/minitest.yml

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-06-08
+
+- Initial release

data/Gemfile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in heroicons_helper.gemspec
+gemspec
+
+group :development, :test do
+  gem "rake", "~> 13.0"
+  gem "rubocop-standard", "~> 7.0"
+end
+
+group :test do
+  gem "minitest", "~> 5.15"
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Garen J. Torikian
+
+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,52 @@
+# HeroiconsHelper
+
+This gem helps you use Heroicons in your Ruby projects. It's inspired by [heroicons-ruby](https://github.com/chunlea/heroicons-ruby) and [octicons](https://github.com/primer/octicons).
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add heroicons_helper
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install heroicons_helper
+
+## Usage
+
+This gem is super simple! Require the gem, and include the module:
+
+```ruby
+require "heroicons_helper"
+
+include HeroiconsHelper
+```
+
+You'll have a brand new method called `heroicons` whose signature looks like this:
+
+```ruby
+heroicons(symbol, variant, attributes: {})
+```
+
+where
+
+* `symbol` is the heroicons name
+* `variant` is the type of Heroicons (eg., `outline` or `solid`)
+* `attributes` are any additional HTML attributes to add on to the resulting `svg` element
+
+This one method call returns an object that represents the Heroicon, and you should call `to_svg` to get the resulting SVG string:
+
+```ruby
+outline_icon = heroicons("x", "outline")
+puts outline_icon.to_svg
+```
+```
+=> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"><path stroke-linecap="round" stroke-linejoin="round" d="M6 18L18 6M6 6l12 12"></path></svg>
+```
+
+## Development
+
+To update the Heroicons set:
+
+1. Run `npm install`
+2. Run `script/update_heroicons`

data/Rakefile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new

data/heroicons_helper.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative "lib/heroicons_helper/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "heroicons_helper"
+  spec.version = HeroiconsHelper::VERSION
+  spec.authors = ["Garen J. Torikian"]
+  spec.email = ["gjtorikian@users.noreply.github.com"]
+
+  spec.summary       = "Heroicons port for Ruby"
+  spec.description   = "A package that distributes Heroicons as a gem, for easy inclusion in Ruby projects."
+  spec.homepage      = "https://github.com/gjtorikian/heroicons_helper"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.7.0", "< 4.0.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    %x(git ls-files -z).split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end