fontawesome_cdn 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f0227d9efe942dd8a799b7f22bf81e8e90ac47d3f9b2ffe86b1fe71ff2bb80c5
+  data.tar.gz: 26af6254b9978d1a289ec4c2de04db8b997e895cf2589aa3f69a3133d6596dbb
+SHA512:
+  metadata.gz: 341e6dfd4d3ce75275d8a7b8ada5e53705776feb01ac925c680c9fdcca2c2909a28cc242050b3c75e1596922489edaa122eb4b64c3b983c2709a08fddefdac7c
+  data.tar.gz: 64c3662608445300d8b8c0840af73fee0a246ccab95b94794c8574b9d740e07e608b682ad054fddbd908675c52e2053210f6b98788df462c41bb06ee3769427c

data/CHANGELOG.md

@@ -0,0 +1,18 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+This project follows [Semantic Versioning](https://semver.org).
+
+---
+
+## 0.1.0
+
+### Added
+- Initial release
+- Rails helper to load Font Awesome from cdnjs with SRI integrity
+- Explicit Font Awesome version selection
+- `icon` helper to render Font Awesome icons in Rails views
+- Support for Font Awesome 7
+- Compatibility with Rails 7 and Rails 8
+

data/CONTRIBUTING.md

@@ -0,0 +1,76 @@
+# Contributing to FontawesomeCdn
+
+Thank you for your interest in contributing! 🎉  
+This project aims to stay **simple, explicit, and focused**.
+
+---
+
+## ✅ Philosophy
+
+Before opening a pull request, please keep in mind:
+
+- The gem must remain **small**
+- No asset pipeline integration
+- No JavaScript
+- No configuration complexity
+- CDN-based usage only
+
+If a change adds complexity without clear value, it will likely be declined.
+
+---
+
+## 🛠 Development setup
+
+Clone the repository and install dependencies:
+
+```bash
+bundle install
+```
+
+Run the test suite:
+
+```bash
+bundle exec rspec
+```
+
+Run the linter:
+
+```bash
+bundle exec rubocop
+```
+
+All checks **must be green** before submitting a pull request.
+
+---
+
+## ✅ Tests
+
+- New features must include tests
+- Bug fixes should include a regression test
+- RSpec is used for testing
+- RuboCop must pass with no offenses
+
+---
+
+## 📦 Supported versions
+
+- Ruby: **3.0+**
+- Rails: **7.x and 8.x**
+- Font Awesome: supported versions listed in the README
+
+---
+
+## 🚀 Pull requests
+
+When submitting a pull request:
+
+1. Keep changes small and focused
+2. Explain the **why**, not just the **what**
+3. Ensure CI passes
+4. Update documentation if needed
+
+---
+
+## 🧾 License
+
+By contributing, you agree that your contributions will be licensed under the MIT License.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 OpenCodeForge
+
+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,65 @@
+# 🎨 FontawesomeCdn
+
+[![CI](https://github.com/OpenCodeForge/fontawesome_cdn/actions/workflows/ci.yml/badge.svg)](https://github.com/OpenCodeForge/fontawesome_cdn/actions/workflows/ci.yml)
+
+Simple Rails helpers to load **Font Awesome via CDN** and render icons in views.
+
+✅ Compatible with **Font Awesome 7**  
+✅ Compatible with **Rails 8**  
+✅ No asset pipeline  
+✅ No JavaScript
+
+
+---
+
+## 📦 Installation
+
+```ruby
+gem "fontawesome_cdn"
+```
+
+```bash
+bundle install
+```
+
+---
+
+## 🚀 Usage
+
+### Load Font Awesome (layout)
+
+Place this helper in your layout, inside `<head>`.
+
+```erb
+<%= fontawesome_cdn_stylesheet_tag "7.0.1" %>
+```
+
+---
+
+### Render icons (views)
+
+Use this helper anywhere in your views or partials.
+
+```erb
+<%= icon "fa-solid", "user" %>
+<%= icon "fa-regular", "bell", class: "fa-2x" %>
+<%= icon "fa-brands", "font-awesome", "Font Awesome" %>
+```
+
+---
+
+## ✅ Supported Font Awesome versions
+
+Font Awesome is loaded directly from **cdnjs**.
+
+**Supported versions** (with verified SRI):
+
+- ✅ **7.0.1**
+- ✅ **7.0.0**
+- ✅ **6.7.2**
+
+---
+
+## 📄 License
+
+MIT

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/fontawesome_cdn/helpers.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module FontawesomeCdn
+  BASE_URL = "https://cdnjs.cloudflare.com/ajax/libs/font-awesome"
+
+  # Font Awesome versions supported by the gem
+  # SRI hashes provided by cdnjs for all.min.css
+  INTEGRITY_MAP = {
+    "7.0.1" => "sha512-2SwdPD6INVrV/lHTZbO2nodKhrnDdJK9/kg2XD1r9uGqPo1cUbujc+IYdlYdEErWNu69gVcYgdxlmVmzTWnetw==",
+    "7.0.0" => "sha512-DxV+EoADOkOygM4IR9yXP8Sb2qwgidEmeqAEmDKIOfPRQZOWbXCzLC6vjbZyy0vPisbH2SyW27+ddLVCN+OMzQ==",
+    "6.7.2" => "sha512-Evv84Mr4kqVGRNSgIGL/F/aIDqQb7xQ2vcrdIwxfjThSH8CSR7PBEakCr51Ck+w+/U6swU2Im1vVX0SVk9ABhg=="
+  }.freeze
+
+  SUPPORTED_VERSIONS = INTEGRITY_MAP.keys.freeze
+
+  # Helpers exposed to Rails views.
+  #
+  # Provides:
+  # - fontawesome_cdn_stylesheet_tag(version)
+  # - icon(style, name, text = nil, html_options = {})
+  module Helpers
+    # Stylesheet helper for loading Font Awesome via CDN
+    #
+    # Usage:
+    #
+    #   <%= fontawesome_cdn_stylesheet_tag "7.0.1" %>
+    #
+    # Raises ArgumentError if version is not supported.
+    #
+    def fontawesome_cdn_stylesheet_tag(version = nil, **options)
+      validate_fontawesome_version!(version)
+
+      href = "#{FontawesomeCdn::BASE_URL}/#{version}/css/all.min.css"
+
+      attrs = {
+        rel: "stylesheet",
+        href: href,
+        integrity: FontawesomeCdn::INTEGRITY_MAP[version],
+        crossorigin: "anonymous",
+        referrerpolicy: "no-referrer"
+      }
+
+      tag.link(**attrs, **options)
+    end
+
+    # Main helper for displaying an icon
+    #
+    #   <%= icon "fa-solid", "user" %>
+    #   <%= icon "fa-regular", "bell", class: "fa-2x fa-shake" %>
+    #   <%= icon "fa-brands", "font-awesome", "Font Awesome" %>
+    #   <%= icon "fa-solid", "check", "aria-hidden": false %>
+    #
+    def icon(style, name, text = nil, html_options = {})
+      if text.is_a?(Hash)
+        html_options = text
+        text = nil
+      end
+
+      classes = [style, "fa-#{name}", html_options[:class]].compact
+      html_options[:class] = classes.join(" ")
+      html_options["aria-hidden"] ||= true
+
+      icon_tag = tag.i(nil, **html_options)
+
+      text.blank? ? icon_tag : safe_join([icon_tag, " ", text.to_s])
+    end
+
+    private
+
+    def validate_fontawesome_version!(version)
+      raise_version_required_error if version.nil?
+      raise_version_type_error(version) unless version.is_a?(String)
+      raise_version_not_supported_error(version) unless FontawesomeCdn::SUPPORTED_VERSIONS.include?(version)
+    end
+
+    def raise_version_required_error
+      raise ArgumentError, <<~MSG
+        fontawesome_cdn: Font Awesome version is required.
+        Usage: <%= fontawesome_cdn_stylesheet_tag "7.x.x" %>
+      MSG
+    end
+
+    def raise_version_type_error(version)
+      raise ArgumentError, <<~MSG
+        fontawesome_cdn: version must be a String, got #{version.class}
+      MSG
+    end
+
+    def raise_version_not_supported_error(version)
+      raise ArgumentError, <<~MSG
+        fontawesome_cdn: Font Awesome version #{version.inspect} is not supported.
+        Supported versions: #{FontawesomeCdn::SUPPORTED_VERSIONS.join(", ")}
+      MSG
+    end
+  end
+end

data/lib/fontawesome_cdn/railtie.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "rails/railtie"
+require "fontawesome_cdn/helpers"
+
+module FontawesomeCdn
+  # Railtie for loading FontawesomeCdn helpers into Rails.
+  class Railtie < ::Rails::Railtie
+    initializer "fontawesome_cdn.view_helpers" do
+      ActiveSupport.on_load(:action_view) do
+        include FontawesomeCdn::Helpers
+      end
+    end
+  end
+end

data/lib/fontawesome_cdn/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+# Current version of the FontawesomeCdn gem.
+module FontawesomeCdn
+  VERSION = "0.1.0"
+end

data/lib/fontawesome_cdn.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative "fontawesome_cdn/version"
+
+require "fontawesome_cdn/railtie" if defined?(Rails)
+
+# Rails helpers for loading Font Awesome via CDN.
+module FontawesomeCdn
+end

data/sig/fontawesome_cdn.rbs

@@ -0,0 +1,4 @@
+module FontawesomeCdn
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: fontawesome_cdn
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- OpenCodeForge
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+description: |
+  Tiny Rails helpers to load Font Awesome via CDN and render icons.
+  No asset pipeline integration, no JavaScript, no magic.
+email:
+- contact@opencodeforge.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTING.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/fontawesome_cdn.rb
+- lib/fontawesome_cdn/helpers.rb
+- lib/fontawesome_cdn/railtie.rb
+- lib/fontawesome_cdn/version.rb
+- sig/fontawesome_cdn.rbs
+homepage: https://github.com/OpenCodeForge/fontawesome_cdn
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/OpenCodeForge/fontawesome_cdn
+  source_code_uri: https://github.com/OpenCodeForge/fontawesome_cdn
+  bug_tracker_uri: https://github.com/OpenCodeForge/fontawesome_cdn/issues
+  changelog_uri: https://github.com/OpenCodeForge/fontawesome_cdn/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.7.2
+specification_version: 4
+summary: Simple Rails helpers to load Font Awesome from a CDN.
+test_files: []