bard-tag_field 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 99c36b23ef302095ac7b0c3994ac82027cc28df8efb1426097d67a639f735003
+  data.tar.gz: badb540eb22db036f7ee1d6930e440cffec862ca008c06e8b57aebb01b86cf50
+SHA512:
+  metadata.gz: a0bdc6d674b71f7097dd8c6fa6f556f8a95dacd31560bcba2aed2dbb64a7cd94a22c71063e432b4d9f2e2e07b1b38fe2760fcced79a90cd7d9fb1c2935a9d123
+  data.tar.gz: 85891e20dbc60abf1292f2d091e93ef28cdc824d1110d18d54cec747ad7e54747a8ef52a9991f31c84d5f09b5ce3c42261edf42915d12a50905028d6b0e6f928

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Appraisals

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+appraise "rails-7.1" do
+  gem "rails", "~> 7.1.0"
+end
+
+appraise "rails-7.2" do
+  gem "rails", "~> 7.2.0"
+end
+
+appraise "rails-8.0" do
+  gem "rails", "~> 8.0.0"
+end

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Micah Geisel
+
+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,230 @@
+# Bard::TagField
+
+[![CI Status](https://github.com/botandrose/bard-tag_field/workflows/CI/badge.svg)](https://github.com/botandrose/bard-tag_field/actions)
+[![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.
+
+Perfect for adding tag functionality to your Rails forms with a clean, modern interface that works seamlessly with your existing Rails form helpers.
+
+## Features
+
+- 🏷️ **Interactive tag input** - Users can add/remove tags dynamically
+- 🔧 **Rails integration** - Works like any other Rails form helper (`form.select`, `form.text_field`, etc.)
+- 🎨 **Customizable** - Supports all standard HTML options (class, id, data attributes)
+- 🛡️ **Secure** - Automatic HTML escaping prevents XSS attacks
+- 🧪 **Well-tested** - Comprehensive test suite
+- ⚡ **Modern** - Built with custom web elements
+- 🔄 **Compatible** - Supports Ruby 3.2+ and Rails 7.1+
+
+## Usage
+
+### Basic Usage
+
+After installing and requiring the gem, Use `bard_tag_field` in your Rails forms just like any other form helper:
+
+```erb
+<%= form_with model: @post do |form| %>
+  <%= form.bard_tag_field :tags %>
+<% end %>
+```
+
+This generates an interactive tag field that binds to your model's `tags` attribute.
+
+### With HTML Options
+
+Add CSS classes, data attributes, and other HTML options:
+
+```erb
+<%= form.bard_tag_field :tags,
+    class: "form-control",
+    id: "post-tags",
+    data: { placeholder: "Add tags..." } %>
+```
+
+### With Existing Tags
+
+The field automatically displays existing tags from your model:
+
+```ruby
+# In your controller
+@post.tags = ["rails", "ruby", "web-development"]
+```
+
+```erb
+<!-- Tags will be pre-populated in the form -->
+<%= form.bard_tag_field :tags %>
+```
+
+### With Predefined Choices (Rails select-style)
+
+Like `form.select`, you can provide predefined choices for users to select from:
+
+```erb
+<%= form.bard_tag_field :tags, ["ruby", "rails", "javascript", "css"] %>
+```
+
+Or use nested arrays for display vs submit values:
+
+```erb
+<%= form.bard_tag_field :categories, [
+  ["Web Development", "web-dev"],
+  ["Machine Learning", "ml"],
+  ["Database Design", "db"]
+] %>
+```
+
+This creates a datalist with available options while still showing current object values as selected tags.
+
+### Custom Content with Blocks
+
+Use blocks for custom tag rendering:
+
+```erb
+<%= form.bard_tag_field :tags do |options| %>
+  <% @post.tags.each do |tag| %>
+    <tag-option value="<%= tag %>" class="custom-tag"><%= tag %></tag-option>
+  <% end %>
+<% end %>
+```
+
+## Model Setup
+
+Your model should handle tags as an array. Here are common approaches:
+
+### With Array Attribute (Rails 5+)
+
+```ruby
+class Post < ApplicationRecord
+  # In migration: add_column :posts, :tags, :text, array: true, default: []
+  # Or use JSON column: add_column :posts, :tags, :json, default: []
+end
+```
+
+### With Serialization
+
+```ruby
+class Post < ApplicationRecord
+  serialize :tags, Array
+end
+```
+
+### With ActsAsTaggable
+
+```ruby
+class Post < ApplicationRecord
+  acts_as_taggable_on :tags
+
+  # Helper method for form binding
+  def tags_array
+    tag_list.to_a
+  end
+
+  def tags_array=(values)
+    self.tag_list = values
+  end
+end
+```
+
+```erb
+<%= form.bard_tag_field :tags_array %>
+```
+
+## Generated HTML
+
+The gem generates semantic HTML using custom elements:
+
+```html
+<!-- With current object values -->
+<input-tag name="post[tags]" id="post_tags">
+  <tag-option value="rails">rails</tag-option>
+  <tag-option value="ruby">ruby</tag-option>
+</input-tag>
+
+<!-- With choices parameter -->
+<input-tag name="post[tags]" id="post_tags" list="post_tags_datalist">
+  <tag-option value="rails">rails</tag-option>
+</input-tag>
+<datalist id="post_tags_datalist">
+  <option value="ruby">ruby</option>
+  <option value="javascript">javascript</option>
+  <option value="css">css</option>
+</datalist>
+```
+
+## 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:
+
+```javascript
+// In your application.js or wherever you manage JS
+import '@botandrose/input-tag'
+```
+
+Or include the precompiled asset (automatically added by this gem):
+
+```javascript
+//= require input-tag
+```
+
+## Browser Support
+
+- Modern browsers that support custom elements
+- Graceful degradation for older browsers
+- Supports Ruby 3.2+ and Rails 7.1+ (including Rails 8.0)
+
+## API Reference
+
+### `bard_tag_field(method, choices = nil, options = {}, html_options = {}, &block)`
+
+**Parameters:**
+- `method` - The attribute name (symbol)
+- `choices` - Optional array of predefined choices (like `form.select`)
+- `options` - Hash of Rails form options
+- `html_options` - Hash of HTML attributes (class, id, data, etc.)
+- `&block` - Optional block for custom content rendering
+
+**Returns:** HTML-safe string containing the tag input element
+
+**Examples:**
+```ruby
+# Basic usage
+form.bard_tag_field :tags
+
+# With choices
+form.bard_tag_field :tags, ["ruby", "rails", "javascript"]
+
+# With nested choices (display vs value)
+form.bard_tag_field :categories, [["Web Dev", "web"], ["ML", "ml"]]
+
+# With HTML options
+form.bard_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" }
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rspec` to run the tests.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/botandrose/bard-tag_field.
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Credits
+
+Created by [Micah Geisel](https://github.com/micahgeisel) at [Bot & Rose](https://github.com/botandrose).

data/Rakefile

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+
+desc "Build JavaScript assets"
+task :build_js do
+  sh "cd bard-tag && npm run build"
+end
+
+desc "Install npm dependencies"
+task :install_deps do
+  sh "cd bard-tag && npm install"
+end