bootstrap5-rails-extensions 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d474e088c4e028c5086730e93991c25b52559a7851469d5b27ef648c569418b4
+  data.tar.gz: 7e376d17ad4dbadba15b41cfb7010575d69dabfee2f494f6f3fb1df2ed9e5770
+SHA512:
+  metadata.gz: a4d051ba8ca01298ae82f600974f3021ac1786f5ff50dd64546fe18bcbd2549ecdf2c6f56210b6b84f7521cb84203c801a759a14cbe85ac39d8d5350f3feb954
+  data.tar.gz: c6a9ba17cea83be96fecb56e2a04b1074132117c46b6daaad85a602552c26e0d67abbfbd6ebb5194a485a0951f9a30ef971d9b8219f281c53ceff2e8c327f061

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# エージェント運用ドキュメント（ローカル環境用）
+AGENTS.md
+CLAUDE.md

data/Gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+gem "rake", "~> 13.0"

data/Gemfile.lock

@@ -0,0 +1,221 @@
+PATH
+  remote: .
+  specs:
+    bootstrap5-rails-extensions (0.1.0)
+      rails (>= 8.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (8.0.3)
+      actionpack (= 8.0.3)
+      activesupport (= 8.0.3)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+      zeitwerk (~> 2.6)
+    actionmailbox (8.0.3)
+      actionpack (= 8.0.3)
+      activejob (= 8.0.3)
+      activerecord (= 8.0.3)
+      activestorage (= 8.0.3)
+      activesupport (= 8.0.3)
+      mail (>= 2.8.0)
+    actionmailer (8.0.3)
+      actionpack (= 8.0.3)
+      actionview (= 8.0.3)
+      activejob (= 8.0.3)
+      activesupport (= 8.0.3)
+      mail (>= 2.8.0)
+      rails-dom-testing (~> 2.2)
+    actionpack (8.0.3)
+      actionview (= 8.0.3)
+      activesupport (= 8.0.3)
+      nokogiri (>= 1.8.5)
+      rack (>= 2.2.4)
+      rack-session (>= 1.0.1)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+      useragent (~> 0.16)
+    actiontext (8.0.3)
+      actionpack (= 8.0.3)
+      activerecord (= 8.0.3)
+      activestorage (= 8.0.3)
+      activesupport (= 8.0.3)
+      globalid (>= 0.6.0)
+      nokogiri (>= 1.8.5)
+    actionview (8.0.3)
+      activesupport (= 8.0.3)
+      builder (~> 3.1)
+      erubi (~> 1.11)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    activejob (8.0.3)
+      activesupport (= 8.0.3)
+      globalid (>= 0.3.6)
+    activemodel (8.0.3)
+      activesupport (= 8.0.3)
+    activerecord (8.0.3)
+      activemodel (= 8.0.3)
+      activesupport (= 8.0.3)
+      timeout (>= 0.4.0)
+    activestorage (8.0.3)
+      actionpack (= 8.0.3)
+      activejob (= 8.0.3)
+      activerecord (= 8.0.3)
+      activesupport (= 8.0.3)
+      marcel (~> 1.0)
+    activesupport (8.0.3)
+      base64
+      benchmark (>= 0.3)
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.3.1)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      logger (>= 1.4.2)
+      minitest (>= 5.1)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+      uri (>= 0.13.1)
+    base64 (0.3.0)
+    benchmark (0.4.1)
+    bigdecimal (3.2.3)
+    builder (3.3.0)
+    concurrent-ruby (1.3.5)
+    connection_pool (2.5.4)
+    crass (1.0.6)
+    date (3.4.1)
+    drb (2.2.3)
+    erb (5.0.2)
+    erubi (1.13.1)
+    globalid (1.3.0)
+      activesupport (>= 6.1)
+    i18n (1.14.7)
+      concurrent-ruby (~> 1.0)
+    io-console (0.8.1)
+    irb (1.15.2)
+      pp (>= 0.6.0)
+      rdoc (>= 4.0.0)
+      reline (>= 0.4.2)
+    logger (1.7.0)
+    loofah (2.24.1)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    mail (2.8.1)
+      mini_mime (>= 0.1.1)
+      net-imap
+      net-pop
+      net-smtp
+    marcel (1.1.0)
+    mini_mime (1.1.5)
+    minitest (5.25.5)
+    net-imap (0.5.11)
+      date
+      net-protocol
+    net-pop (0.1.2)
+      net-protocol
+    net-protocol (0.2.2)
+      timeout
+    net-smtp (0.5.1)
+      net-protocol
+    nio4r (2.7.4)
+    nokogiri (1.18.10-aarch64-linux-gnu)
+      racc (~> 1.4)
+    nokogiri (1.18.10-aarch64-linux-musl)
+      racc (~> 1.4)
+    nokogiri (1.18.10-arm-linux-gnu)
+      racc (~> 1.4)
+    nokogiri (1.18.10-arm-linux-musl)
+      racc (~> 1.4)
+    nokogiri (1.18.10-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.18.10-x86_64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.18.10-x86_64-linux-gnu)
+      racc (~> 1.4)
+    nokogiri (1.18.10-x86_64-linux-musl)
+      racc (~> 1.4)
+    pp (0.6.2)
+      prettyprint
+    prettyprint (0.2.0)
+    psych (5.2.6)
+      date
+      stringio
+    racc (1.8.1)
+    rack (3.2.1)
+    rack-session (2.1.1)
+      base64 (>= 0.1.0)
+      rack (>= 3.0.0)
+    rack-test (2.2.0)
+      rack (>= 1.3)
+    rackup (2.2.1)
+      rack (>= 3)
+    rails (8.0.3)
+      actioncable (= 8.0.3)
+      actionmailbox (= 8.0.3)
+      actionmailer (= 8.0.3)
+      actionpack (= 8.0.3)
+      actiontext (= 8.0.3)
+      actionview (= 8.0.3)
+      activejob (= 8.0.3)
+      activemodel (= 8.0.3)
+      activerecord (= 8.0.3)
+      activestorage (= 8.0.3)
+      activesupport (= 8.0.3)
+      bundler (>= 1.15.0)
+      railties (= 8.0.3)
+    rails-dom-testing (2.3.0)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.6.2)
+      loofah (~> 2.21)
+      nokogiri (>= 1.15.7, != 1.16.7, != 1.16.6, != 1.16.5, != 1.16.4, != 1.16.3, != 1.16.2, != 1.16.1, != 1.16.0.rc1, != 1.16.0)
+    railties (8.0.3)
+      actionpack (= 8.0.3)
+      activesupport (= 8.0.3)
+      irb (~> 1.13)
+      rackup (>= 1.0.0)
+      rake (>= 12.2)
+      thor (~> 1.0, >= 1.2.2)
+      tsort (>= 0.2)
+      zeitwerk (~> 2.6)
+    rake (13.3.0)
+    rdoc (6.15.0)
+      erb
+      psych (>= 4.0.0)
+      tsort
+    reline (0.6.2)
+      io-console (~> 0.5)
+    securerandom (0.4.1)
+    stringio (3.1.7)
+    thor (1.4.0)
+    timeout (0.4.3)
+    tsort (0.2.0)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    uri (1.0.3)
+    useragent (0.16.11)
+    websocket-driver (0.8.0)
+      base64
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.7.3)
+
+PLATFORMS
+  aarch64-linux-gnu
+  aarch64-linux-musl
+  arm-linux-gnu
+  arm-linux-musl
+  arm64-darwin
+  x86_64-darwin
+  x86_64-linux-gnu
+  x86_64-linux-musl
+
+DEPENDENCIES
+  bootstrap5-rails-extensions!
+  rake (~> 13.0)
+
+BUNDLED WITH
+   2.7.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Dreaw Inc.
+
+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,192 @@
+# Bootstrap5 Rails Extensions（Rails Engine）
+
+RailsアプリケーションでBootstrap 5をTurbo/Stimulusと併用しやすくするための拡張を提供します。モーダルやオフキャンバス、カード、テーブル、トースト向けのDSLヘルパーと、対応するStimulusコントローラを同梱しています。
+
+## インストール
+
+Gemfile（ホストアプリ）:
+
+```ruby
+gem "bootstrap5-rails-extensions"
+```
+
+`bundle install` を実行してください。
+
+## セットアップ
+
+### Stimulusコントローラの登録
+
+Importmapをご利用の場合は、エンジンが提供するコントローラ群をpinしてください。
+
+```ruby
+# config/importmap.rb
+pin_all_from "bootstrap5_rails_extensions", under: "bootstrap5_rails_extensions"
+```
+
+Stimulusアプリケーションへの登録例です。
+
+```javascript
+// app/javascript/controllers/index.js
+import { application } from "./application"
+
+import ModalController from "bootstrap5_rails_extensions/modal_controller"
+import OffcanvasController from "bootstrap5_rails_extensions/offcanvas_controller"
+import ToastController from "bootstrap5_rails_extensions/toast_controller"
+
+application.register("modal", ModalController)
+application.register("offcanvas", OffcanvasController)
+application.register("toast", ToastController)
+```
+
+ESBuildやViteなどを利用している場合も、同様にコントローラをインポートして登録してください。
+
+### トースト用コンテナの設置
+
+レイアウトなど、常に描画されるテンプレートに以下を追加しておくと、Turbo Stream経由でトーストを流し込めます。
+
+```erb
+<%= render_toast %>
+```
+
+フラッシュメッセージを初期表示したい場合は `render_toast(flash_messages: flash)` のように渡してください。
+
+## ビューヘルパー
+
+### render_modal
+
+Stripeダッシュボード風のモーダルDSLです。`render_modal` にIDとタイトルを渡し、ブロックで本文・フッターを組み立てます。
+
+```erb
+<%= render_modal id: "settingsModal", title: "設定", dialog: { size: :lg, centered: true } do |modal| %>
+  <% modal.body do %>
+    <turbo-frame id="modal-settings-frame">
+      <div class="text-center text-muted py-4">読み込み中...</div>
+    </turbo-frame>
+  <% end %>
+<% end %>
+```
+
+フォームを扱う場合は `form:` に `form_with` のオプションをそのまま渡してください。`modal.body` / `modal.footer` のブロックにはフォームビルダーが渡されます。
+
+```erb
+<%= render_modal id: "userModal", title: "ユーザー追加", form: { model: User.new, url: users_path } do |modal| %>
+  <% modal.body do |f| %>
+    <%= f.text_field :name, class: "form-control" %>
+  <% end %>
+  <% modal.footer do |f| %>
+    <%= f.submit "保存", class: "btn btn-primary" %>
+  <% end %>
+<% end %>
+```
+
+モーダルを開くトリガー要素には、Stimulusコントローラが参照する属性を付与します。
+
+```erb
+<%= link_to settings_path,
+      class: "btn btn-primary btn-sm",
+      data: { modal_target: "#settingsModal", turbo_frame: "modal-settings-frame" } do %>
+  設定を開く
+<% end %>
+```
+
+主なオプションです。
+
+- `dialog: { size: :sm|:lg|:xl|:fullscreen, centered: true, scrollable: true }`
+- `form:` `form_with` に渡すHash。指定時はブロックにフォームビルダーが渡されます。
+- `data:` モーダル要素に付与するdata属性（`controller: "modal"` は自動付与されます）。
+
+### render_offcanvas
+
+Bootstrap 5.3のオフキャンバスをDSLで構築します。タイトルは第1引数またはキーワード引数で指定できます。
+
+```erb
+<%= render_offcanvas id: "previewOffcanvas", title: "プレビュー", placement: :end do %>
+  <turbo-frame id="offcanvas-form-template-preview">
+    読み込み中...
+  </turbo-frame>
+<% end %>
+```
+
+トリガー例:
+
+```erb
+<%= link_to preview_path,
+      class: "btn btn-outline-primary btn-sm",
+      data: { offcanvas_target: "#previewOffcanvas", turbo_frame: "offcanvas-form-template-preview" } do %>
+  プレビュー
+<% end %>
+```
+
+- `placement:` は `:start|:end|:top|:bottom` を受け付けます（既定は`:end`）。
+- `footer:` に文字列またはブロックを渡すと、フッター領域を描画します。
+- `data:` で追加のdata属性を渡せます（`controller: "offcanvas"` を自動付与します）。
+
+### render_card
+
+カードを簡潔に定義できるDSLです。ヘッダー、本文、フッターを1度ずつ定義できます。
+
+```erb
+<%= render_card class: "mb-4" do |card| %>
+  <% card.header class: "d-flex align-items-center" do %>
+    設定
+  <% end %>
+  <% card.body class: "p-4" do %>
+    本文...
+  <% end %>
+  <% card.footer class: "text-end" do %>
+    <%= link_to "閉じる", "#", class: "btn btn-outline-secondary" %>
+  <% end %>
+<% end %>
+```
+
+`data:` オプションで親要素にdata属性を追加できます。
+
+### render_table
+
+`table-responsive` ラッパー付きでBootstrapのテーブルを出力します。
+
+```erb
+<%= render_table class: "table-striped" do |table| %>
+  <% table.thead class: "table-light" do %>
+    <tr><th>名前</th><th>状態</th></tr>
+  <% end %>
+  <% table.tbody do %>
+    <% @users.each do |user| %>
+      <tr>
+        <td><%= user.name %></td>
+        <td><%= user.status %></td>
+      </tr>
+    <% end %>
+  <% end %>
+<% end %>
+```
+
+`wrapper_class` や `wrapper_html` を渡すことでラッパー要素のカスタマイズも可能です。
+
+### render_toast
+
+トーストコンテナを描画し、フラッシュメッセージを初期表示できます。
+
+```erb
+<%= render_toast id: "toast-root", position: "top-0 end-0", flash_messages: flash %>
+```
+
+`position:` にはBootstrapのユーティリティクラスをそのまま渡してください。
+
+## Turbo Streams拡張
+
+`Turbo::Streams::TagBuilder` を拡張し、`turbo_stream.toast` を利用できるようにしています。トーストコンテナ（既定ID: `toast-root`）にメッセージを積み上げます。
+
+```ruby
+# コントローラまたはビュー
+render turbo_stream: turbo_stream.toast(:notice, "保存しました")
+
+# 追加オプション
+render turbo_stream: turbo_stream.toast(:alert, @user, target: "custom-toast", autohide: false, delay: 8000)
+```
+
+`message_or_record` にActiveModelを渡すと、エラー内容をリスト表示します。
+
+---
+
+ご不明点があればIssueやPull Requestでお気軽にお知らせください。

data/Rakefile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+
+# gem作成時の基本タスクのみ提供
+task default: :build

data/app/helpers/bootstrap5_rails_extensions/card_helper.rb

@@ -0,0 +1,143 @@
+# frozen_string_literal: true
+
+module Bootstrap5RailsExtensions
+  module CardHelper
+    # Bootstrapのcardコンポーネントを簡潔に記述できるDSL。
+    #
+    # 使い方:
+    #   <%= render_card class: "mb-4" do |card| %>
+    #     <% card.header class: "d-flex align-items-center" do %>
+    #       タイトル
+    #     <% end %>
+    #     <% card.body class: "p-4" do %>
+    #       本文...
+    #     <% end %>
+    #     <% card.footer class: "text-end" do %>
+    #       フッター
+    #     <% end %>
+    #   <% end %>
+    #
+    # オプション:
+    #   class: 親要素に追加するクラス
+    #   data:  親要素に付与するdata属性
+    def render_card(data: {}, **html_options)
+      raise ArgumentError, "カードは本文を定義する必要があります" unless block_given?
+
+      builder = CardBuilder.new(self)
+      yield(builder)
+
+      html_options[:class] = class_names("card", html_options[:class])
+
+      if data.present?
+        html_options[:data] = (html_options[:data] || {}).merge(data)
+      end
+
+      content_tag(:div, **html_options) do
+        builder.render
+      end
+    end
+
+    class CardBuilder
+      def initialize(view_context)
+        @view = view_context
+        @header_html = nil
+        @header_options = {}
+        @body_fragments = []
+        @body_options = {}
+        @footer_html = nil
+        @footer_options = {}
+      end
+
+      def header(content = nil, **options, &block)
+        raise ArgumentError, "カードヘッダーは一度だけ定義できます" if @header_html
+
+        @header_html = extract_content(content, &block)
+        css_class = extract_css_class!(options)
+        @header_options[:class] = css_class if css_class.present?
+        self
+      end
+
+      def body(content = nil, **options, &block)
+        html = extract_content(content, &block)
+        raise ArgumentError, "カード本文が空です" if blank_html?(html)
+
+        @body_fragments << html
+        css_class = extract_css_class!(options)
+        if css_class.present?
+          if @body_options[:class].present? && @body_options[:class] != css_class
+            raise ArgumentError, "カード本文のクラス指定は一度だけ行ってください"
+          end
+          @body_options[:class] = css_class
+        end
+        self
+      end
+
+      def footer(content = nil, **options, &block)
+        raise ArgumentError, "カードフッターは一度だけ定義できます" if @footer_html
+
+        html = extract_content(content, &block)
+        @footer_html = html unless blank_html?(html)
+        css_class = extract_css_class!(options)
+        @footer_options[:class] = css_class if css_class.present?
+        self
+      end
+
+      def render
+        raise ArgumentError, "カード本文を定義してください" if @body_fragments.empty?
+
+        fragments = []
+        fragments << wrap_section(@header_html, default_header_class, @header_options[:class]) if @header_html
+        fragments << wrap_section(@view.safe_join(@body_fragments), default_body_class, @body_options[:class])
+        fragments << wrap_section(@footer_html, default_footer_class, @footer_options[:class]) if @footer_html
+        @view.safe_join(fragments.compact)
+      end
+
+      private
+
+      def extract_content(content, &block)
+        if block_given?
+          @view.capture(&block)
+        else
+          content
+        end
+      end
+
+      def extract_css_class!(options)
+        return nil if options.nil? || options.empty?
+
+        css_class = options.delete(:class)
+        raise ArgumentError, "サポートされていないオプションです: #{options.keys.join(', ')}" if options.present?
+
+        css_class
+      end
+
+      def wrap_section(content, wrapper_class, extra_class = nil)
+        return if blank_html?(content)
+        if wrapper_class == false && extra_class.blank?
+          return content
+        end
+
+        combined_class = [wrapper_class == false ? nil : wrapper_class, extra_class.presence].compact.join(" ")
+        return content if combined_class.blank?
+
+        @view.content_tag(:div, content, class: combined_class)
+      end
+
+      def default_header_class
+        "card-header"
+      end
+
+      def default_body_class
+        "card-body"
+      end
+
+      def default_footer_class
+        "card-footer"
+      end
+
+      def blank_html?(html)
+        html.respond_to?(:blank?) ? html.blank? : html.to_s.strip.empty?
+      end
+    end
+  end
+end