rails_iowaicon 1.0.4

data/lib/rails_iowaicon/errors.rb

@@ -0,0 +1,19 @@
+module RailsIowaicon
+  class UndefinedVariant < StandardError
+    def initialize(msg = "", exception_type = "custom")
+      msg = msg.empty? ? "Variant should be one of #{RailsIowaicon::VARIANTS.join(", ")}" : msg
+      @exception_type = exception_type
+
+      super(msg)
+    end
+  end
+
+  class UndefinedIcon < StandardError
+    def initialize(icon = "", exception_type = "custom")
+      msg = "Couldn't find icon for #{icon}"
+      @exception_type = exception_type
+
+      super(msg)
+    end
+  end
+end

data/lib/rails_iowaicon/helper.rb

@@ -0,0 +1,42 @@
+require "action_view"
+
+module RailsIowaicon
+  module Helper
+    # To add a iowaicon, call <tt><%= iowaicon "icon_name" %></tt> on your erb template.
+    # Head over to https://brand.uiowa.edu/graphic-elements to view all the icons.
+    #
+    # == Options
+    # The helper method accepts mutiple arguments such as:
+    #
+    # === Variant
+    # There are two types of variants: 'outline' and 'solid', the default being the 'outline'.
+    # To specify the solid variant, call <tt><%= iowaicon "icon_name", variant: "solid" %></tt>
+    #
+    # === HTML attributes
+    # Any <tt>html</tt> attribute is supported, for eg:
+    #
+    # <tt><%= iowaicon "icon_name", class: "text-gray-500", data: { controller: "icon" } %></tt>
+    #
+    # === Handling the icon size
+    # Normally, if you're just using vanilla iowaicons with tailwindcss, you'd set <tt>w-5 h-5</tt> as class attributes
+    # on the svg. With this helper, you just need to set the <tt>size</tt> attribute on the icon.
+    #
+    # <tt><%= iowaicon "icon_name", size: 20 %></tt>
+    #
+    # This will set the <tt>height</tt> and <tt>width</tt> attribute on the svg.
+    #
+    # If the variant is set as <tt>outline</tt>, size automatically defaults to 24, and if the variant is set as
+    # <tt>solid</tt>, size automatically defaults to 20. However, this can be over-written with the <tt>size</tt>
+    # attribute.
+    #
+    # == Accessibility
+    # The helper method automatically sets <tt>aria-hidden=true</tt> if <tt>aria-label</tt> is not set, and
+    # if <tt>aria-label</tt> is set, then <tt>role=img</tt> is set automatically.
+    def iowaicon(symbol, title: nil, **options)
+      icon = RailsIowaicon.new(symbol, **options)
+
+      title_tag = content_tag(:title, title) if title
+      content_tag(:svg, title_tag.to_s.html_safe + icon.svg_path.html_safe, icon.options)
+    end
+  end
+end

data/lib/rails_iowaicon/rails_iowaicon.rb

@@ -0,0 +1,71 @@
+require_relative "errors"
+
+module RailsIowaicon
+  class RailsIowaicon
+    VARIANTS = %w[outline solid].freeze
+
+    attr_reader :options
+
+    def initialize(icon, variant: "outline", size: nil, **options)
+      raise UndefinedVariant unless VARIANTS.include?(variant.to_s)
+
+      @icon = icon.to_s
+      @variant = variant.to_s
+      @options = options
+      @size = icon_size_with(size)
+
+      @options.merge!(a11y)
+      @options.merge!({color: "#FFcd00"}) if solid?
+      @options.merge!({
+        viewBox: "0 0 50 50",
+        height: @size,
+        width: @size,
+        version: "1.1",
+        fill: outline? ? "none" : "currentColor",
+        stroke: solid? ? "none" : "currentColor"
+      })
+    end
+
+    # Finds the svg icon with respect to variant.
+    def svg_path
+      icon = ICONS.dig(@variant, @icon)
+      raise UndefinedIcon, @icon unless icon
+
+      icon
+    end
+
+    private
+
+    def a11y
+      accessible = {}
+
+      if @options[:"aria-label"].nil? && @options["aria-label"].nil? && @options.dig(:aria, :label).nil?
+        accessible[:"aria-hidden"] = "true"
+      else
+        accessible[:role] = "img"
+      end
+
+      accessible
+    end
+
+    # If the user has explicitly stated the size attribute, then use that. If size attribute is not passed
+    # then default to 24 if variant is outline, else default to 20 if variant is solid.
+    def icon_size_with(size)
+      if outline? && size.nil?
+        24
+      elsif solid? && size.nil?
+        20
+      else
+        size
+      end
+    end
+
+    def outline?
+      @variant == "outline"
+    end
+
+    def solid?
+      @variant == "solid"
+    end
+  end
+end

data/lib/rails_iowaicon/railtie.rb

@@ -0,0 +1,9 @@
+require_relative "helper"
+
+module RailsIowaicon
+  class Railtie < Rails::Railtie
+    initializer "rails_iowaicon.helper" do
+      ActionView::Base.send :include, Helper # rubocop:disable Lint/SendWithMixinArgument
+    end
+  end
+end

data/lib/rails_iowaicon/version.rb

@@ -0,0 +1,3 @@
+module RailsIowaicon
+  VERSION = "1.0.4".freeze
+end

data/lib/rails_iowaicon.rb

@@ -0,0 +1,9 @@
+require "json"
+require_relative "rails_iowaicon/version"
+require_relative "rails_iowaicon/rails_iowaicon"
+require_relative "rails_iowaicon/railtie" if defined? Rails
+
+module RailsIowaicon
+  ICON_PATH = File.join(File.dirname(__FILE__), "../compressed/icons.json")
+  ICONS = JSON.parse(File.read(ICON_PATH)).freeze
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: rails_iowaicon
+version: !ruby/object:Gem::Version
+  version: 1.0.4
+platform: ruby
+authors:
+- chrisortman
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-04-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  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:
+email:
+- chris-ortman@uiowa.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- compressed/icons.json
+- lib/rails_iowaicon.rb
+- lib/rails_iowaicon/errors.rb
+- lib/rails_iowaicon/helper.rb
+- lib/rails_iowaicon/rails_iowaicon.rb
+- lib/rails_iowaicon/railtie.rb
+- lib/rails_iowaicon/version.rb
+homepage: https://git.uiowa.edu/cortman/rails-iowaicons
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://git.uiowa.edu/cortman/rails-iowaicons
+  source_code_uri: https://git.uiowa.edu/cortman/rails-iowaicons
+  changelog_uri: https://git.uiowa.edu/cortman/rails-iowaicon/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.6
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.32
+signing_key:
+specification_version: 4
+summary: Ruby on Rails view helpers for Iowa brand icons
+test_files: []