bard-tag_field 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fbfde3758dcf03243548db95eb9901f43cbcccbe5eac3a2dc1d64ecee31aaa60
-  data.tar.gz: d7f453d7ad5f9ac62b3a41ae5d8304c8bb01d230059ad630641440b6949622a3
+  metadata.gz: 41638b348c696d0f3f95ae6c6c485c53d83c24df043c705cbfb52045410eee6f
+  data.tar.gz: 581a77505a56ee7c545ec14f1fb856a99af95346f02af98ddddb4703fbbbcf3f
 SHA512:
-  metadata.gz: c30cc6a3b8d25fc4a3c9ca0a17c548ae13c785ac437ffbdae5bddfdd3e1f96d95fee9987e2096888cf561e1c9d64ab555124118d24fc35b50afea0e549295d8b
-  data.tar.gz: f521b1e6907f65230310c1a17890a07519da7756efc9ad3b6f2f1047c5d9ec2874b597e2aaf9dc066c6bb4a77104416694593935b096d1e788a67bd5c0675083
+  metadata.gz: c7056e3b6f96f40a4f4b704e10b626012e5d6df73b8c6f91e189e9238bf3a69260f768e2bbe2cdcde18b9a9c493f036e3e6b5b9b999be35e098ab617308e8681
+  data.tar.gz: ea50ae8634d86c7f796fbf636475dd6805e4446abdb0b486ad2b4e63b5d8c20b63d0fc1db76e6fed23f2c48a75733aa18ddc62ded5698676929e5d799b4db75b

data/Appraisals

@@ -10,4 +10,8 @@ end
 
 appraise "rails-8.0" do
   gem "rails", "~> 8.0.0"
-end
+end
+
+appraise "rails-8.1" do
+  gem "rails", "~> 8.1.0"
+end

data/CLAUDE.md

@@ -0,0 +1,109 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Project Overview
+
+This is a Rails form helper gem that provides `tag_field` for creating interactive tag input fields. The gem wraps the [@botandrose/input-tag](https://github.com/botandrose/input-tag) custom element and integrates it with Rails form builders.
+
+**Key Architecture:**
+- `lib/bard/tag_field/form_builder.rb` - Rails form builder integration that handles method signature variants (like Rails' `select` helper)
+- `lib/bard/tag_field/field.rb` - Core field rendering logic, extends `ActionView::Helpers::Tags::TextField`
+- `lib/bard/tag_field.rb` - Rails Engine that auto-registers the form builder and precompiles JavaScript assets
+- `input-tag/` - JavaScript build directory using Rollup to bundle the `@botandrose/input-tag` package with Bun
+- `app/assets/javascripts/input-tag.js` - Compiled JavaScript output for Rails asset pipeline
+
+## Development Commands
+
+### Testing
+```bash
+# Run all tests
+bundle exec rspec
+
+# Run tests for specific Rails version
+bundle exec appraisal rails-7.1 rspec
+bundle exec appraisal rails-7.2 rspec
+bundle exec appraisal rails-8.0 rspec
+
+# Generate appraisal gemfiles after updating Appraisals
+bundle exec appraisal install
+```
+
+### JavaScript Assets
+```bash
+# Build JavaScript assets (required before running tests or releasing)
+cd input-tag && bun run build
+
+# Install Bun dependencies
+cd input-tag && bun install
+
+# Clean compiled assets
+cd input-tag && bun run clean
+```
+
+### Gem Management
+```bash
+# Install the gem locally for testing
+bundle exec rake install
+
+# Build gem package
+bundle exec rake build
+```
+
+## Form Builder Method Signatures
+
+The `tag_field` method supports multiple signatures to match Rails conventions:
+
+```ruby
+# Basic usage
+form.tag_field :tags
+
+# With HTML options only
+form.tag_field :tags, class: "form-control"
+
+# With choices (like form.select)
+form.tag_field :tags, ["ruby", "rails", "javascript"]
+
+# With choices and HTML options
+form.tag_field :tags, ["ruby", "rails"], {}, { class: "form-control" }
+
+# With nested choices [display, value]
+form.tag_field :categories, [["Web Dev", "web"], ["ML", "ml"]]
+
+# With block for custom rendering
+form.tag_field :tags do |options|
+  # Custom tag-option rendering
+end
+```
+
+The FormBuilder handles signature detection in lib/bard/tag_field/form_builder.rb:6-21.
+
+## Rendering Logic
+
+The Field class (lib/bard/tag_field/field.rb) handles three rendering scenarios:
+
+1. **Object values only** - Renders current object's tags as `<tag-option>` elements
+2. **With choices** - Renders object values as `<tag-option>` and choices in a nested `<datalist>`
+3. **With block** - Delegates content rendering to the provided block
+
+The `build_choice_map` method (lib/bard/tag_field/field.rb:58-74) maps choice values to display labels for proper tag rendering.
+
+## Testing
+
+Tests use RSpec with a custom HTML matcher that supports wildcards (`...`) for flexible HTML comparison. The matcher is defined in spec/spec_helper.rb:55-152 and allows testing HTML structure without exact whitespace or attribute order matching.
+
+Test setup includes a mock Rails application (TestApp) initialized in spec/spec_helper.rb:12-17.
+
+## JavaScript Build Process
+
+The gem bundles the `@botandrose/input-tag` package using Rollup with Bun:
+1. Source: `input-tag/index.js` imports from `@botandrose/input-tag`
+2. Build: `cd input-tag && bun run build` runs Rollup
+3. Output: `app/assets/javascripts/input-tag.js` for Rails asset pipeline
+4. The Engine precompiles this asset (lib/bard/tag_field.rb:11)
+
+**Important:** Always rebuild JavaScript assets after updating the `@botandrose/input-tag` dependency.
+
+## Multi-Rails Version Support
+
+Uses Appraisal gem to test against Rails 7.1, 7.2, and 8.0. Gemfiles are in `gemfiles/` directory. CI tests all combinations of Ruby 3.2/3.3/3.4 with each Rails version.

data/README.md

@@ -4,7 +4,7 @@
 [![Ruby](https://img.shields.io/badge/ruby-3.2%2B-red)](https://www.ruby-lang.org)
 [![Rails](https://img.shields.io/badge/rails-7.1%2B-red)](https://rubyonrails.org)
 
-A Rails form helper gem that adds `bard_tag_field` to your forms, creating interactive tag input fields using the [@botandrose/input-tag](https://github.com/botandrose/input-tag) custom element.
+A Rails form helper gem that adds `tag_field` to your forms, creating interactive tag input fields using the [@botandrose/input-tag](https://github.com/botandrose/input-tag) custom element.
 
 Perfect for adding tag functionality to your Rails forms with a clean, modern interface that works seamlessly with your existing Rails form helpers.
 
@@ -22,11 +22,11 @@ Perfect for adding tag functionality to your Rails forms with a clean, modern in
 
 ### Basic Usage
 
-After installing and requiring the gem, Use `bard_tag_field` in your Rails forms just like any other form helper:
+After installing and requiring the gem, Use `tag_field` in your Rails forms just like any other form helper:
 
 ```erb
 <%= form_with model: @post do |form| %>
-  <%= form.bard_tag_field :tags %>
+  <%= form.tag_field :tags %>
 <% end %>
 ```
 
@@ -37,7 +37,7 @@ This generates an interactive tag field that binds to your model's `tags` attrib
 Add CSS classes, data attributes, and other HTML options:
 
 ```erb
-<%= form.bard_tag_field :tags,
+<%= form.tag_field :tags,
     class: "form-control",
     id: "post-tags",
     data: { placeholder: "Add tags..." } %>
@@ -54,7 +54,7 @@ The field automatically displays existing tags from your model:
 
 ```erb
 <!-- Tags will be pre-populated in the form -->
-<%= form.bard_tag_field :tags %>
+<%= form.tag_field :tags %>
 ```
 
 ### With Predefined Choices (Rails select-style)
@@ -62,13 +62,13 @@ The field automatically displays existing tags from your model:
 Like `form.select`, you can provide predefined choices for users to select from:
 
 ```erb
-<%= form.bard_tag_field :tags, ["ruby", "rails", "javascript", "css"] %>
+<%= form.tag_field :tags, ["ruby", "rails", "javascript", "css"] %>
 ```
 
 Or use nested arrays for display vs submit values:
 
 ```erb
-<%= form.bard_tag_field :categories, [
+<%= form.tag_field :categories, [
   ["Web Development", "web-dev"],
   ["Machine Learning", "ml"],
   ["Database Design", "db"]
@@ -82,7 +82,7 @@ This creates a datalist with available options while still showing current objec
 Use blocks for custom tag rendering:
 
 ```erb
-<%= form.bard_tag_field :tags do |options| %>
+<%= form.tag_field :tags do |options| %>
   <% @post.tags.each do |tag| %>
     <tag-option value="<%= tag %>" class="custom-tag"><%= tag %></tag-option>
   <% end %>
@@ -128,7 +128,7 @@ end
 ```
 
 ```erb
-<%= form.bard_tag_field :tags_array %>
+<%= form.tag_field :tags_array %>
 ```
 
 ## Generated HTML
@@ -155,7 +155,7 @@ The gem generates semantic HTML using custom elements:
 
 ## JavaScript Integration
 
-This gem works with the [@botandrose/input-tag](https://github.com/botandrose/input-tag) custom element. Make sure to include it in your asset pipeline:
+This gem works with the [@botandrose/input-tag](https://github.com/botandrose/input-tag) custom element.
 
 ```javascript
 // In your application.js or wherever you manage JS
@@ -176,7 +176,7 @@ Or include the precompiled asset (automatically added by this gem):
 
 ## API Reference
 
-### `bard_tag_field(method, choices = nil, options = {}, html_options = {}, &block)`
+### `tag_field(method, choices = nil, options = {}, html_options = {}, &block)`
 
 **Parameters:**
 - `method` - The attribute name (symbol)
@@ -190,19 +190,19 @@ Or include the precompiled asset (automatically added by this gem):
 **Examples:**
 ```ruby
 # Basic usage
-form.bard_tag_field :tags
+form.tag_field :tags
 
 # With choices
-form.bard_tag_field :tags, ["ruby", "rails", "javascript"]
+form.tag_field :tags, ["ruby", "rails", "javascript"]
 
 # With nested choices (display vs value)
-form.bard_tag_field :categories, [["Web Dev", "web"], ["ML", "ml"]]
+form.tag_field :categories, [["Web Dev", "web"], ["ML", "ml"]]
 
 # With HTML options
-form.bard_tag_field :tags, class: "form-control", data: { max_tags: 5 }
+form.tag_field :tags, class: "form-control", data: { max_tags: 5 }
 
 # With choices and HTML options
-form.bard_tag_field :tags, ["ruby", "rails"], {}, { class: "form-control" }
+form.tag_field :tags, ["ruby", "rails"], {}, { class: "form-control" }
 ```
 
 ## Development

data/Rakefile

@@ -9,10 +9,10 @@ task default: :spec
 
 desc "Build JavaScript assets"
 task :build_js do
-  sh "cd bard-tag && npm run build"
+  sh "cd input-tag && bun run build"
 end
 
-desc "Install npm dependencies"
+desc "Install Bun dependencies"
 task :install_deps do
-  sh "cd bard-tag && npm install"
+  sh "cd input-tag && bun install"
 end