bs5 0.0.5 → 0.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f4eeed7da6108bdb379e711c57a906f8cd5bc66730e0a79485f941b5a1a29651
-  data.tar.gz: 6b2819922250d5b3449def44bcde45703115fdd234697dbfd8476827d485fe0c
+  metadata.gz: ecb9af880ad8e465272d743689c0c470af8c322affb3e77be49bdb360f8b0022
+  data.tar.gz: 3b1517ef64015fa58510b9123cd625735d79e2e7fbbccda4eb161f1f4671e038
 SHA512:
-  metadata.gz: 9e034c5d510d1d5518bf505f7c40566db8898e2daedfd051e85312c3ab21b772604f9142cce65bf571564631b0832d6c7510f681bbdc5e1bce31fbe14c533588
-  data.tar.gz: 4c54522c6bb42cf7485a174ec6675e122211beb3b6e329507576237f15be6bfef0acd795cd76eebc969c9883a9cbd4f69b45067873d8d05b6703093473ad1ce0
+  metadata.gz: b638dd6760619921caaa399a585a53040501cdb796712c5bf118cc281f5ba65f16637dde70df784adff66839c2b71b91488c64bcd46a0045cc949e82cf8ba995
+  data.tar.gz: f5b36b7a285aad9a6eb2e803d182d5e4126398ae410c9cb2a6dd66674de9474da84ba1db4f6c2202730a6f0b255a3df71762074fb8315c74711f457d3a9331a2

data/README.md

@@ -2,7 +2,7 @@
 
 This is a Ruby on Rails engine to include [Bootstrap 5](https://v5.getbootstrap.com/).
 
-[![Gem Version](https://badge.fury.io/rb/bs5.svg)](https://badge.fury.io/rb/bs5)
+[![Gem Version](https://badge.fury.io/rb/bs5.svg)](https://badge.fury.io/rb/bs5) [![Build Status](https://travis-ci.org/bazzel/bs5.svg?branch=main)](https://travis-ci.org/bazzel/bs5) [![Ruby Style Guide](https://img.shields.io/badge/code_style-community-brightgreen.svg)](https://rubystyle.guide)
 
 ## Usage
 
@@ -34,117 +34,6 @@ Run the following command to setup your project to use Bootstrap 5.
 
     $ rails generate bs5:install
 
-## Components
-
-- [Accordion](#accordion) ✅
-- [Alert](#alert) ✅
-- [Badge](#badge) ✅
-- Breadcrumb
-- Buttons
-- Button group
-- Card
-- Carousel
-- [Close button](#close-button) ✅
-- Collapse
-- Dropdowns
-- List group
-- Modal
-- Nav & tabs
-- Navbar
-- Pagination
-- Popovers
-- Progress
-- Scrollspy
-- Spinners
-- Toasts
-- Tooltips
-
-
-### [Accordion](https://v5.getbootstrap.com/docs/5.0/components/accordion/)
-
-```
-<%= bs5_accordion do |accordion| %>
-  <% accordion.slot(:item, title: 'Accordion Item #1', collapsed: false) do %>
-    <strong>This is the first item's accordion body.</strong> It is hidden by default, until the collapse plugin adds the appropriate classes that we use to style each element. These classes control the overall appearance, as well as the showing and hiding via CSS transitions. You can modify any of this with custom CSS or overriding our default variables. It's also worth noting that just about any HTML can go within the <code>.accordion-body</code>, though the transition does limit overflow.
-  <% end %>
-  <% accordion.slot(:item, title: 'Accordion Item #2') do %>
-    <strong>This is the second item's accordion body.</strong> It is hidden by default, until the collapse plugin adds the appropriate classes that we use to style each element. These classes control the overall appearance, as well as the showing and hiding via CSS transitions. You can modify any of this with custom CSS or overriding our default variables. It's also worth noting that just about any HTML can go within the <code>.accordion-body</code>, though the transition does limit overflow.
-  <% end %>
-  <% accordion.slot(:item, title: 'Accordion Item #3') do %>
-    <strong>This is the third item's accordion body.</strong> It is hidden by default, until the collapse plugin adds the appropriate classes that we use to style each element. These classes control the overall appearance, as well as the showing and hiding via CSS transitions. You can modify any of this with custom CSS or overriding our default variables. It's also worth noting that just about any HTML can go within the <code>.accordion-body</code>, though the transition does limit overflow.
-  <% end %>
-<%- end %>
-```
-
-```
-<%= bs5_accordion(flush: true) do |accordion| %>
-  <% accordion.slot(:item, title: 'Accordion Item #1') do %>
-    Anim pariatur cliche reprehenderit, enim eiusmod high life accusamus terry richardson ad squid. 3 wolf moon officia aute, non cupidatat skateboard dolor brunch. Food truck quinoa nesciunt laborum eiusmod. Brunch 3 wolf moon tempor, sunt aliqua put a bird on it squid single-origin coffee nulla assumenda shoreditch et. Nihil anim keffiyeh helvetica, craft beer labore wes anderson cred nesciunt sapiente ea proident. Ad vegan excepteur butcher vice lomo. Leggings occaecat craft beer farm-to-table, raw denim aesthetic synth nesciunt you probably haven't heard of them accusamus labore sustainable VHS.
-  <% end %>
-  <% accordion.slot(:item, title: 'Accordion Item #2') do %>
-    Anim pariatur cliche reprehenderit, enim eiusmod high life accusamus terry richardson ad squid. 3 wolf moon officia aute, non cupidatat skateboard dolor brunch. Food truck quinoa nesciunt laborum eiusmod. Brunch 3 wolf moon tempor, sunt aliqua put a bird on it squid single-origin coffee nulla assumenda shoreditch et. Nihil anim keffiyeh helvetica, craft beer labore wes anderson cred nesciunt sapiente ea proident. Ad vegan excepteur butcher vice lomo. Leggings occaecat craft beer farm-to-table, raw denim aesthetic synth nesciunt you probably haven't heard of them accusamus labore sustainable VHS.
-  <% end %>
-  <% accordion.slot(:item, title: 'Accordion Item #3') do %>
-    Anim pariatur cliche reprehenderit, enim eiusmod high life accusamus terry richardson ad squid. 3 wolf moon officia aute, non cupidatat skateboard dolor brunch. Food truck quinoa nesciunt laborum eiusmod. Brunch 3 wolf moon tempor, sunt aliqua put a bird on it squid single-origin coffee nulla assumenda shoreditch et. Nihil anim keffiyeh helvetica, craft beer labore wes anderson cred nesciunt sapiente ea proident. Ad vegan excepteur butcher vice lomo. Leggings occaecat craft beer farm-to-table, raw denim aesthetic synth nesciunt you probably haven't heard of them accusamus labore sustainable VHS.
-  <% end %>
-<%- end %>
-```
-
-### [Alert](https://v5.getbootstrap.com/docs/5.0/components/alerts/)
-
-```
-<%= bs5_alert do %>
-  A simple primary alert—check it out!
-<%- end %>
-```
-
-```
-<%= bs5_alert(style: :warning, is_dismissable: true) do %>
-  <strong>Holy guacamole!</strong> You should check in on some of those fields below.
-<%- end %>
-```
-
-### [Badge](https://v5.getbootstrap.com/docs/5.0/components/badge/)
-
-```
-<%= bs5_badge(text: 'New') %>
-```
-
-```
-<%= bs5_badge(text: 'Warning', style: :warning) %>
-```
-
-```
-<%= bs5_badge(text: 'Danger', style: :danger, pill: true) %>
-```
-
-
-### [Breadcrumb](https://v5.getbootstrap.com/docs/5.0/components/breadcrumb/)
-
-### [Button](https://v5.getbootstrap.com/docs/5.0/components/buttons/)
-
-### [Close button](https://v5.getbootstrap.com/docs/5.0/components/close-button/)
-
-```
-<%= bs5_close_button %>
-```
-
-```
-<%= bs5_close_button(disabled: true) %>
-```
-
-```
-<%= bs5_close_button(white: true) %>
-```
-
-```
-<%= bs5_close_button(data: { controller: 'hello', action: "click->hello#greet }) %>
-```
-
-## Previewing components
-
-- http://localhost:3000/rails/view_components
-
 ## Contributing
 
 Contribution directions go here.

data/app/components/bs5/alert_component.rb

@@ -2,6 +2,8 @@
 
 module Bs5
   class AlertComponent < ViewComponent::Base
+    STYLES = %i[primary secondary success danger warning info light dark].freeze
+
     attr_reader :style, :is_dismissable
 
     include ActiveModel::Validations

data/app/components/bs5/badge_component.rb

@@ -2,6 +2,8 @@
 
 module Bs5
   class BadgeComponent < ViewComponent::Base
+    STYLES = %i[primary secondary success danger warning info light dark].freeze
+
     attr_reader :text, :style
 
     include ActiveModel::Validations

data/app/components/bs5/breadcrumb_component.html.erb

@@ -0,0 +1,9 @@
+<% if items.any? %>
+  <nav aria-label="breadcrumb">
+    <ol class="breadcrumb">
+      <% items.each do |item| %>
+        <li class="breadcrumb-item <%= item == items.last ? 'active' : '' %>" <%= item == items.last ? 'aria-current=page' : '' %>><%= item.content %></li>
+      <% end %>
+    </ol>
+  </nav>
+<% end %>

data/app/components/bs5/breadcrumb_component.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Bs5
+  class BreadcrumbComponent < ViewComponent::Base
+    include ViewComponent::Slotable
+
+    with_slot :item, collection: true, class_name: 'Item'
+
+    class Item < ViewComponent::Slot
+    end
+  end
+end

data/app/components/bs5/button_tag_component.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+module Bs5
+  class ButtonTagComponent < ViewComponent::Base
+    STYLES = %i[primary secondary success danger warning info light dark link].freeze
+    DEFAULT_STYLE = :primary
+    SIZES = { small: :sm, large: :lg }.freeze
+    CLASS_PREFIX = 'btn'
+
+    attr_reader :content_or_options, :size
+
+    include ActiveModel::Validations
+    validates :style, style: true
+    validates :size, inclusion: { in: SIZES.keys, valid_sizes: SIZES.keys.to_sentence, allow_nil: true }
+
+    def initialize(content_or_options = nil, options = nil)
+      if content_or_options.is_a? Hash
+        self.options = content_or_options
+      else
+        @content_or_options = content_or_options
+        self.options = options
+      end
+
+      extract_custom_options
+      merge_default_options
+    end
+
+    def before_render
+      raise errors.full_messages.to_sentence if invalid?
+    end
+
+    def call
+      if content
+        button_tag(content_or_options, options) { content }
+      else
+        button_tag(content_or_options, options)
+      end
+    end
+
+    private
+
+    def options=(value)
+      @options = Hash(value).symbolize_keys!
+    end
+
+    def options
+      @options.empty? ? nil : @options
+    end
+
+    def extract_custom_options
+      extract_style
+      extract_outline
+      extract_size
+    end
+
+    def extract_style
+      @style = @options.delete(:style)
+    end
+
+    def extract_outline
+      @outline = @options.delete(:outline)
+    end
+
+    def extract_size
+      @size = @options.delete(:size)
+    end
+
+    def merge_default_options
+      @options.deep_merge!(default_options) do |_key, this_val, other_val|
+        [this_val, other_val].join(' ').strip
+      end
+    end
+
+    def default_options
+      { class: button_class }
+    end
+
+    def button_class
+      [CLASS_PREFIX, contextual_class, size_class].compact.join(' ')
+    end
+
+    def contextual_class
+      [CLASS_PREFIX, outline? ? 'outline' : nil, style].compact.join('-')
+    end
+
+    def size_class
+      return unless size?
+
+      [CLASS_PREFIX, SIZES[size]].join('-')
+    end
+
+    def style
+      (@style || DEFAULT_STYLE).to_sym
+    end
+
+    def outline?
+      !!@outline
+    end
+
+    def size?
+      !!size
+    end
+  end
+end

data/app/components/bs5/example_component.html.erb

@@ -0,0 +1,8 @@
+<div class="mt-4 mb-3">
+  <div class="border rounded-2 p-4">
+    <%= render template: snippet %>
+  </div>
+  <div class="highlight p-4">
+    <pre class='mb-0'><code><%= highlight %></code></pre>
+  </div>
+</div>

data/app/components/bs5/example_component.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'rouge'
+
+module Bs5
+  class ExampleComponent < ViewComponent::Base
+    include ComponentsHelper
+
+    attr_reader :snippet
+
+    def initialize(snippet:)
+      @snippet = snippet
+      @path = snippet.split('/')
+      @basename = @path.pop
+    end
+
+    def highlight
+      formatter = Rouge::Formatters::HTML.new
+      lexer = Rouge::Lexer.find(language)
+      formatter.format(lexer.lex(file_content)).html_safe # rubocop:disable Rails/OutputSafety
+    end
+
+    private
+
+    def file_content
+      @file_content ||= file.read
+    end
+
+    def file
+      @file ||= examples_path
+                .join(*@path)
+                .children
+                .find { |ch| ch.basename.to_s.start_with?(@basename) }
+    end
+
+    def examples_path
+      Engine.root.join('app', 'views', 'bs5', 'examples')
+    end
+
+    def language
+      file.extname.delete('.')
+    end
+  end
+end

data/app/controllers/bs5/application_controller.rb

@@ -1,5 +1,14 @@
+# frozen_string_literal: true
+
 module Bs5
   class ApplicationController < ActionController::Base
     protect_from_forgery with: :exception
+    before_action :set_views_path
+
+    private
+
+    def set_views_path
+      append_view_path Engine.root.join('app', 'views', 'bs5', 'examples')
+    end
   end
 end

data/app/controllers/bs5/examples_controller.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_dependency 'bs5/application_controller'
+
+module Bs5
+  class ExamplesController < ApplicationController
+    def index; end
+  end
+end

data/app/helpers/bs5/application_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bs5
   module ApplicationHelper
   end

data/app/helpers/bs5/components_helper.rb

@@ -2,24 +2,21 @@
 
 module Bs5
   module ComponentsHelper
-    def bs5_accordion(*args)
-      render AccordionComponent.new(*args) do |accordion|
-        yield accordion if block_given?
-      end
-    end
+    COMPONENTS = %w[accordion alert badge close_button breadcrumb button_tag].freeze
 
-    def bs5_alert(*args)
-      render AlertComponent.new(*args) do
-        yield if block_given?
+    COMPONENTS.each do |name|
+      define_method("bs5_#{name}") do |*args, &block|
+        clazz = "Bs5::#{name.classify}Component".constantize
+        render_component(clazz, *args, &block)
       end
     end
 
-    def bs5_badge(*args)
-      render BadgeComponent.new(*args)
-    end
+    private
 
-    def bs5_close_button(*args)
-      render CloseButtonComponent.new(*args)
+    def render_component(component_clazz, *args)
+      render component_clazz.new(*args) do |c|
+        yield c if block_given?
+      end
     end
   end
 end

data/app/helpers/bs5/examples_helper.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Bs5
+  module ExamplesHelper
+    def bs5_example(*args)
+      render ExampleComponent.new(*args)
+    end
+  end
+end

data/app/models/bs5/application_record.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bs5
   class ApplicationRecord < ActiveRecord::Base
     self.abstract_class = true

data/app/validators/style_validator.rb

@@ -1,11 +1,9 @@
 # frozen_string_literal: true
 
 class StyleValidator < ActiveModel::EachValidator
-  STYLES = %i[primary secondary success danger warning info light dark].freeze
-
   def validate_each(record, attribute, value)
-    return if value.in?(STYLES)
+    return if value.in?(valid_styles = record.class::STYLES)
 
-    record.errors.add(attribute, :inclusion, valid_styles: STYLES.to_sentence)
+    record.errors.add(attribute, :inclusion, valid_styles: valid_styles.to_sentence)
   end
 end

data/app/views/bs5/examples/_accordion.html.erb

@@ -0,0 +1,3 @@
+<h2>Accordion</h2>
+<%= render 'bs5/examples/accordion/default/example' %>
+<%= render 'bs5/examples/accordion/flush/example' %>