redmineflux_icon_compat 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 272232d401404eec7346af84c3fe7352c41f904b4292967462fab4f29daf7a89
-  data.tar.gz: b0775447faafc0ad28d5365a4190355fb79956e7c82bec3a114a4c04c2f4f718
+  metadata.gz: 6086040e39bd5cf0e82f22f90afdc29853117f6ec8fffbc3ae76cfc5ab1a8b57
+  data.tar.gz: 207d95b7aece44166ec87a713bac13fbca6aef984ad9c9f0e576d6f96c2184c5
 SHA512:
-  metadata.gz: d4e9e4a3dfde1fa90da197690a5456b52f4ae8ad17fa2e0cfb5cd9fe25b96fe0773ff7c47a6912f1b0e042beab14c9a990f3718046deabcfbc88726f0c9ab55c
-  data.tar.gz: e50cf452bdc430577ddc4b7bdc579439912dcbfd214dfdbace58d68fceea42e8883d38bd92fd5970e4d79e9b600dabbb301742a87bd51c3ddf1ec932cb6d4893
+  metadata.gz: 1cda2877c0643b538626171e024e3046e68b6f74cc3fa314cc5b0e3988fb81e810a53e5ad6e7c54bb448f849e99e03539f3d2dba657d4660fb049e1ed506d9a8
+  data.tar.gz: 8c4995d5b73663acd7919ebd3fe02bf1f1b113a6a0d2bd342f1eb916bb97204a47a5572495228f5baad72b0fa9e7c8a71ae9ce00f0661ecb6bfd2cb2e17562cc

data/CHANGELOG.md

@@ -0,0 +1,32 @@
+# Changelog
+
+All notable changes to `redmineflux_icon_compat` will be documented in this file.
+
+## [0.1.2] - 2026-04-17
+
+### Changed
+- Updated README wording and usage clarity.
+- Updated RubyGems dependency example to `~> 0.1.2`.
+
+## [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

@@ -1,105 +1,89 @@
 # Redmineflux Icon Compat
 
-Compatibility helper gem for Redmine plugin icons.
+`redmineflux_icon_compat` provides one helper API for plugin links that works in both:
+- Redmine 5 legacy icon classes (`icon icon-*`)
+- Redmine 6 sprite icons (`sprite_icon`)
 
-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`)
+Use `rf_icon_link` to keep one code path across Redmine versions.
 
-## Usage in a Redmine plugin
+## Install In A Redmine Plugin
 
-1. Add to plugin Gemfile:
+### 1) Add the gem to your plugin Gemfile
 
-```ruby
-gem 'redmineflux_icon_compat', path: '../redmineflux_icon_compat'
-```
+Create or update `plugins/<your_plugin>/Gemfile`.
 
-2. Include helper where needed:
+Local development:
 
 ```ruby
-include RedminefluxIconCompat::Helper
+gem 'redmineflux_icon_compat', path: '../redmineflux_icon_compat'
 ```
 
-3. Use in views/helpers:
+From RubyGems:
 
 ```ruby
-rf_icon_link(:add, 'Add', '#')
+gem 'redmineflux_icon_compat', '~> 0.1.2'
 ```
 
-## Run Tests
+### 2) Install dependencies
 
 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
+bundle install
 ```
 
-## Release Workflow (RubyGems)
+### 3) Require the gem in plugin init
 
-1. Create RubyGems account: https://rubygems.org/sign_up
-2. Login from terminal:
+In `plugins/<your_plugin>/init.rb`:
 
-```bash
-gem signin
+```ruby
+require 'redmineflux_icon_compat'
 ```
 
-3. Bump version in:
-- `plugins/redmineflux_icon_compat/lib/redmineflux_icon_compat/version.rb`
-
-4. Run tests:
+### 4) Include the helper (recommended)
 
-```bash
-ruby plugins/redmineflux_icon_compat/test/helper_test.rb
+```ruby
+module MyPluginHelper
+  include RedminefluxIconCompat::Helper
+end
 ```
 
-5. Build the gem:
-
-```bash
-cd plugins/redmineflux_icon_compat
-gem build redmineflux_icon_compat.gemspec
-```
+### 5) Use `rf_icon_link` in views/helpers
 
-6. Push to RubyGems:
+ERB example:
 
-```bash
-gem push redmineflux_icon_compat-<VERSION>.gem
+```erb
+<%= rf_icon_link(:add, 'Add Checklist', '#', class: 'add-checklist-btn') %>
 ```
 
-7. Verify:
-- Open `https://rubygems.org/gems/redmineflux_icon_compat`
-- Install test:
+Helper example:
 
-```bash
-gem install redmineflux_icon_compat
+```ruby
+rf_icon_link(:edit, l(:button_edit), edit_path(record))
 ```
 
-## Ownership and Security (Recommended)
+### 6) Restart Redmine
 
-Add backup owners:
+Restart the app server after gem/helper changes so code reload is clean.
 
-```bash
-gem owner redmineflux_icon_compat --add teammate@example.com
-```
+## Troubleshooting
 
-Require MFA on RubyGems account for push/yank.
+If you still see old icons:
+- clear cache: `rm -rf tmp/cache/*`
+- reinstall dependencies: `bundle install`
+- restart Redmine
+- hard refresh browser (`Ctrl+Shift+R`)
 
-## Consume Published Gem
+## Run Tests
 
-In plugin `Gemfile`:
+From Redmine root:
 
-```ruby
-gem 'redmineflux_icon_compat', '~> 0.1.0'
+```bash
+ruby plugins/redmineflux_icon_compat/test/helper_test.rb
 ```
 
-Then:
+From this gem directory:
 
 ```bash
-bundle install
+ruby test/helper_test.rb
 ```

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.2'
 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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redmineflux_icon_compat
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Redmineflux
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-04-16 00:00:00.000000000 Z
+date: 2026-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionview
@@ -46,6 +46,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - LICENSE.txt
 - README.md
 - lib/redmineflux_icon_compat.rb