redmineflux_icon_compat 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 272232d401404eec7346af84c3fe7352c41f904b4292967462fab4f29daf7a89
-  data.tar.gz: b0775447faafc0ad28d5365a4190355fb79956e7c82bec3a114a4c04c2f4f718
+  metadata.gz: e13f0604cfb7cd9b8a19058158bd81fb61bba6ca32fc84e0044b9481dae0faaf
+  data.tar.gz: 61704c9b1b47ea9030ed3752638b2de9f7e16dc219d962c5d1849971108dedfe
 SHA512:
-  metadata.gz: d4e9e4a3dfde1fa90da197690a5456b52f4ae8ad17fa2e0cfb5cd9fe25b96fe0773ff7c47a6912f1b0e042beab14c9a990f3718046deabcfbc88726f0c9ab55c
-  data.tar.gz: e50cf452bdc430577ddc4b7bdc579439912dcbfd214dfdbace58d68fceea42e8883d38bd92fd5970e4d79e9b600dabbb301742a87bd51c3ddf1ec932cb6d4893
+  metadata.gz: dc75480b32b6ff1a82a2f0a128ac23f6277b43f875e99aca71fe36c0c254c83db4eb422ab74755c1b45a98ba197f9fde9f933506126688f0224ec2d5d22fdc05
+  data.tar.gz: d542b29d7b96acbb9b80c7df35e70aaa3b1b1571724d5bf88f16c931ece299047bf7984427e6fdad76abe173011c3a29fd0fd6ef19a9c756edc62fdfb54e2671

data/CHANGELOG.md

@@ -0,0 +1,26 @@
+# Changelog
+
+All notable changes to `redmineflux_icon_compat` will be documented in this file.
+
+## [0.1.1] - 2026-04-16
+
+### Added
+- Added comprehensive README usage guide for plugin integration.
+- Added gem publishing documentation for RubyGems.
+- Added test suite for icon helper behavior across fallback modes.
+- Added YARD-style API comments for key helper methods.
+- Added `CHANGELOG.md` to packaged gem files.
+
+### Changed
+- Improved icon rendering detection to rely on helper availability, not Redmine major version constants.
+- Added fallback rendering path through `ApplicationController.helpers.sprite_icon` when local helper context does not expose `sprite_icon`.
+
+### Fixed
+- Prevented incorrect fallback to legacy icon classes in Redmine 6 hook/view contexts.
+
+## [0.1.0] - 2026-04-16
+
+### Added
+- Initial release.
+- Introduced `rf_icon_link` helper for Redmine 5/6 icon compatibility.
+- Added Railtie-based automatic helper inclusion for views/controllers.

data/README.md

@@ -6,26 +6,76 @@ 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
+## Use This Gem In A Redmine Plugin
 
-1. Add to plugin Gemfile:
+### 1) Add gem declaration in your plugin Gemfile
+
+Create or update `plugins/<your_plugin>/Gemfile`.
+
+For local development:
 
 ```ruby
 gem 'redmineflux_icon_compat', path: '../redmineflux_icon_compat'
 ```
 
-2. Include helper where needed:
+For published usage from RubyGems:
+
+```ruby
+gem 'redmineflux_icon_compat', '~> 0.1.0'
+```
+
+### 2) Install dependencies
+
+From Redmine root:
+
+```bash
+bundle install
+```
+
+### 3) Load gem in plugin init file
+
+In `plugins/<your_plugin>/init.rb`:
 
 ```ruby
-include RedminefluxIconCompat::Helper
+require 'redmineflux_icon_compat'
 ```
 
-3. Use in views/helpers:
+### 4) Include helper in plugin helpers (optional but recommended)
+
+Example:
 
 ```ruby
-rf_icon_link(:add, 'Add', '#')
+module MyPluginHelper
+  include RedminefluxIconCompat::Helper
+end
+```
+
+### 5) Use `rf_icon_link` in views or helpers
+
+Example in ERB:
+
+```erb
+<%= rf_icon_link(:add, 'Add Checklist', '#', class: 'add-checklist-btn') %>
 ```
 
+Example in helper:
+
+```ruby
+rf_icon_link(:edit, l(:button_edit), edit_path(record))
+```
+
+### 6) Restart Redmine server
+
+After gem or helper changes, restart app server so Rails reloads plugin code.
+
+## Troubleshooting
+
+If you still see old icons:
+- run `rm -rf tmp/cache/*`
+- run `bundle install` again
+- restart Redmine
+- hard refresh browser (`Ctrl+Shift+R`)
+
 ## Run Tests
 
 From Redmine root:
@@ -41,7 +91,7 @@ cd plugins/redmineflux_icon_compat
 ruby test/helper_test.rb
 ```
 
-## Release Workflow (RubyGems)
+## Publish To RubyGems
 
 1. Create RubyGems account: https://rubygems.org/sign_up
 2. Login from terminal:
@@ -72,9 +122,10 @@ gem build redmineflux_icon_compat.gemspec
 gem push redmineflux_icon_compat-<VERSION>.gem
 ```
 
-7. Verify:
+7. Verify publication:
 - Open `https://rubygems.org/gems/redmineflux_icon_compat`
-- Install test:
+- Check docs page after indexing: `https://www.rubydoc.info/gems/redmineflux_icon_compat`
+- Install smoke test:
 
 ```bash
 gem install redmineflux_icon_compat
@@ -89,17 +140,3 @@ 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

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 module RedminefluxIconCompat
+  # View helper methods for rendering icon links that work on both
+  # Redmine 5 (legacy CSS icons) and Redmine 6 (SVG sprite icons).
   module Helper
     RF_ICON_MAP = {
       delete: { legacy: 'del', sprite: 'del' },
@@ -10,7 +12,13 @@ module RedminefluxIconCompat
       save:   { legacy: 'save', sprite: 'save' }
     }.freeze
 
-    # Centralized icon-link renderer for Redmine 5/6 compatibility.
+    # Builds a link with icon markup compatible with Redmine 5/6.
+    #
+    # @param icon [Symbol, String] icon key (for example: :add, :edit, :delete)
+    # @param label [String] human readable label text
+    # @param href [String] target URL
+    # @param html_options [Hash] HTML options passed to +link_to+
+    # @return [String] HTML link markup
     def rf_icon_link(icon, label, href = '#', html_options = {})
       icon_names = rf_icon_names(icon)
       options = (html_options || {}).dup
@@ -26,7 +34,9 @@ module RedminefluxIconCompat
       link_to(content, href, options)
     end
 
-    # Redmine 6+ provides sprite icons through IconsHelper#sprite_icon.
+    # Detects whether SVG sprite rendering is currently available.
+    #
+    # @return [Boolean]
     def rf_sprite_icons_available?
       respond_to?(:sprite_icon, true) || rf_global_sprite_helper_available?
     end

data/lib/redmineflux_icon_compat/version.rb

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

data/lib/redmineflux_icon_compat.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+# Entry point for the redmineflux_icon_compat gem.
 require_relative 'redmineflux_icon_compat/version'
 require_relative 'redmineflux_icon_compat/helper'
 require_relative 'redmineflux_icon_compat/railtie' if defined?(Rails::Railtie)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redmineflux_icon_compat
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Redmineflux
@@ -46,6 +46,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - LICENSE.txt
 - README.md
 - lib/redmineflux_icon_compat.rb