redmineflux_icon_compat 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 272232d401404eec7346af84c3fe7352c41f904b4292967462fab4f29daf7a89
+  data.tar.gz: b0775447faafc0ad28d5365a4190355fb79956e7c82bec3a114a4c04c2f4f718
+SHA512:
+  metadata.gz: d4e9e4a3dfde1fa90da197690a5456b52f4ae8ad17fa2e0cfb5cd9fe25b96fe0773ff7c47a6912f1b0e042beab14c9a990f3718046deabcfbc88726f0c9ab55c
+  data.tar.gz: e50cf452bdc430577ddc4b7bdc579439912dcbfd214dfdbace58d68fceea42e8883d38bd92fd5970e4d79e9b600dabbb301742a87bd51c3ddf1ec932cb6d4893

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Redmineflux
+
+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,105 @@
+# Redmineflux Icon Compat
+
+Compatibility helper gem for Redmine plugin icons.
+
+This gem gives one helper API (`rf_icon_link`) that works in both:
+- Redmine 5 style icons (`icon icon-*` classes)
+- Redmine 6 SVG sprite icons (`sprite_icon`)
+
+## Usage in a Redmine plugin
+
+1. Add to plugin Gemfile:
+
+```ruby
+gem 'redmineflux_icon_compat', path: '../redmineflux_icon_compat'
+```
+
+2. Include helper where needed:
+
+```ruby
+include RedminefluxIconCompat::Helper
+```
+
+3. Use in views/helpers:
+
+```ruby
+rf_icon_link(:add, 'Add', '#')
+```
+
+## Run Tests
+
+From Redmine root:
+
+```bash
+ruby plugins/redmineflux_icon_compat/test/helper_test.rb
+```
+
+Or from gem directory:
+
+```bash
+cd plugins/redmineflux_icon_compat
+ruby test/helper_test.rb
+```
+
+## Release Workflow (RubyGems)
+
+1. Create RubyGems account: https://rubygems.org/sign_up
+2. Login from terminal:
+
+```bash
+gem signin
+```
+
+3. Bump version in:
+- `plugins/redmineflux_icon_compat/lib/redmineflux_icon_compat/version.rb`
+
+4. Run tests:
+
+```bash
+ruby plugins/redmineflux_icon_compat/test/helper_test.rb
+```
+
+5. Build the gem:
+
+```bash
+cd plugins/redmineflux_icon_compat
+gem build redmineflux_icon_compat.gemspec
+```
+
+6. Push to RubyGems:
+
+```bash
+gem push redmineflux_icon_compat-<VERSION>.gem
+```
+
+7. Verify:
+- Open `https://rubygems.org/gems/redmineflux_icon_compat`
+- Install test:
+
+```bash
+gem install redmineflux_icon_compat
+```
+
+## Ownership and Security (Recommended)
+
+Add backup owners:
+
+```bash
+gem owner redmineflux_icon_compat --add teammate@example.com
+```
+
+Require MFA on RubyGems account for push/yank.
+
+## Consume Published Gem
+
+In plugin `Gemfile`:
+
+```ruby
+gem 'redmineflux_icon_compat', '~> 0.1.0'
+```
+
+Then:
+
+```bash
+bundle install
+```

data/lib/redmineflux_icon_compat/helper.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module RedminefluxIconCompat
+  module Helper
+    RF_ICON_MAP = {
+      delete: { legacy: 'del', sprite: 'del' },
+      add:    { legacy: 'add', sprite: 'add' },
+      edit:   { legacy: 'edit', sprite: 'edit' },
+      copy:   { legacy: 'copy', sprite: 'copy' },
+      save:   { legacy: 'save', sprite: 'save' }
+    }.freeze
+
+    # Centralized icon-link renderer for Redmine 5/6 compatibility.
+    def rf_icon_link(icon, label, href = '#', html_options = {})
+      icon_names = rf_icon_names(icon)
+      options = (html_options || {}).dup
+      use_sprite = rf_sprite_icons_available?
+      options[:class] = rf_icon_classes(options[:class], icon_names[:legacy], use_sprite)
+
+      content = if use_sprite
+                  rf_sprite_icon_markup(icon_names[:sprite], label)
+                else
+                  label
+                end
+
+      link_to(content, href, options)
+    end
+
+    # Redmine 6+ provides sprite icons through IconsHelper#sprite_icon.
+    def rf_sprite_icons_available?
+      respond_to?(:sprite_icon, true) || rf_global_sprite_helper_available?
+    end
+
+    private
+
+    def rf_sprite_icon_markup(icon_name, label)
+      if respond_to?(:sprite_icon, true)
+        sprite_icon(icon_name, label)
+      elsif rf_global_sprite_helper_available?
+        ApplicationController.helpers.sprite_icon(icon_name, label)
+      else
+        label
+      end
+    end
+
+    def rf_global_sprite_helper_available?
+      defined?(ApplicationController) &&
+        ApplicationController.respond_to?(:helpers) &&
+        ApplicationController.helpers.respond_to?(:sprite_icon)
+    end
+
+    def rf_icon_names(icon)
+      key = icon.to_sym
+      RF_ICON_MAP.fetch(key) do
+        name = key.to_s.tr('_', '-')
+        { legacy: name, sprite: name }
+      end
+    end
+
+    def rf_icon_classes(existing_classes, legacy_icon_name, use_sprite)
+      classes = ['rf-icon-link', 'icon']
+      if use_sprite
+        classes << 'rf-icon-sprite'
+      else
+        classes << "icon-#{legacy_icon_name}"
+      end
+      classes.concat(existing_classes.to_s.split(/\s+/)) if existing_classes.respond_to?(:present?) ? existing_classes.present? : !existing_classes.to_s.empty?
+      classes.uniq.join(' ')
+    end
+  end
+end

data/lib/redmineflux_icon_compat/railtie.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module RedminefluxIconCompat
+  class Railtie < Rails::Railtie
+    config.to_prepare do
+      helper_mod = RedminefluxIconCompat::Helper
+
+      if defined?(ApplicationHelper) && !ApplicationHelper.included_modules.include?(helper_mod)
+        ApplicationHelper.send(:include, helper_mod)
+      end
+
+      if defined?(ActionController::Base)
+        ActionController::Base.helper helper_mod
+      end
+
+      if defined?(ActionView::Base) && !ActionView::Base.included_modules.include?(helper_mod)
+        ActionView::Base.send(:include, helper_mod)
+      end
+    end
+  end
+end

data/lib/redmineflux_icon_compat/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RedminefluxIconCompat
+  VERSION = '0.1.0'
+end

data/lib/redmineflux_icon_compat.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require_relative 'redmineflux_icon_compat/version'
+require_relative 'redmineflux_icon_compat/helper'
+require_relative 'redmineflux_icon_compat/railtie' if defined?(Rails::Railtie)

data/test/helper_test.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require_relative 'test_helper'
+
+class RedminefluxIconCompatHelperTest < Minitest::Test
+  class DummyView
+    include RedminefluxIconCompat::Helper
+
+    def link_to(content, href, options = {})
+      css = options[:class].to_s
+      %(<a class="#{css}" href="#{href}">#{content}</a>)
+    end
+  end
+
+  class SpriteView < DummyView
+    def sprite_icon(icon_name, label)
+      %(<svg class="icon-svg" data-icon="#{icon_name}"></svg><span class="icon-label">#{label}</span>)
+    end
+  end
+
+  def teardown
+    if Object.const_defined?(:ApplicationController)
+      Object.send(:remove_const, :ApplicationController)
+    end
+  end
+
+  def test_legacy_mode_uses_icon_classes_when_sprite_not_available
+    view = DummyView.new
+
+    html = view.rf_icon_link(:add, 'Add', '/path')
+
+    assert_includes html, 'icon-add'
+    refute_includes html, 'rf-icon-sprite'
+    refute_includes html, 'icon-svg'
+  end
+
+  def test_local_sprite_icon_is_used_when_available
+    view = SpriteView.new
+
+    html = view.rf_icon_link(:edit, 'Edit', '/edit')
+
+    assert_includes html, 'rf-icon-sprite'
+    assert_includes html, 'icon-svg'
+    refute_includes html, 'icon-edit'
+  end
+
+  def test_global_sprite_helper_is_used_when_local_helper_missing
+    app_helpers = Object.new
+    def app_helpers.sprite_icon(icon_name, label)
+      %(<svg class="icon-svg" data-icon="#{icon_name}"></svg><span class="icon-label">#{label}</span>)
+    end
+
+    app_controller = Class.new do
+      define_singleton_method(:helpers) { app_helpers }
+    end
+
+    Object.const_set(:ApplicationController, app_controller)
+
+    view = DummyView.new
+    html = view.rf_icon_link(:delete, 'Delete', '/delete')
+
+    assert_includes html, 'rf-icon-sprite'
+    assert_includes html, 'icon-svg'
+    refute_includes html, 'icon-del'
+  end
+
+  def test_unknown_icon_uses_dashed_fallback_name
+    view = DummyView.new
+
+    html = view.rf_icon_link(:calendar_today, 'Calendar', '/calendar')
+
+    assert_includes html, 'icon-calendar-today'
+  end
+
+  def test_existing_classes_are_preserved
+    view = DummyView.new
+
+    html = view.rf_icon_link(:add, 'Add', '/path', class: 'btn btn-primary')
+
+    assert_includes html, 'btn'
+    assert_includes html, 'btn-primary'
+    assert_includes html, 'rf-icon-link'
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'minitest/autorun'
+require 'ostruct'
+require_relative '../lib/redmineflux_icon_compat'

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: redmineflux_icon_compat
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Redmineflux
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-04-16 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !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'
+description: Provides helper methods to render icon links compatible with Redmine
+  5 legacy icon classes and Redmine 6 sprite icons.
+email:
+- support@redmineflux.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/redmineflux_icon_compat.rb
+- lib/redmineflux_icon_compat/helper.rb
+- lib/redmineflux_icon_compat/railtie.rb
+- lib/redmineflux_icon_compat/version.rb
+- test/helper_test.rb
+- test/test_helper.rb
+homepage: https://www.redmineflux.com
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+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.4.20
+signing_key:
+specification_version: 4
+summary: Icon compatibility helpers for Redmine 5 and 6 plugins
+test_files: []