bsvc 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2856d5ea8ea38c3ca3a4a0d550bc8dbe67d078998e6a07d614ea677dea89b49a
-  data.tar.gz: 7d0173c3461403d830628ce47a85d8f609a91485d64b2e55dd97169a49a09249
+  metadata.gz: a73813d0faff1ece3a11dbb99ab92fc0ae1b6a21b569f4e7b8098360414bd23f
+  data.tar.gz: aed5a21edf2dea1a80191fd25d091be82125bc2180f800ec87d0e513ae4c2ee0
 SHA512:
-  metadata.gz: d361e0170595f59b984bd654e1ef07e333d3e8730236fa4a984580b9523a1dce172b4cd4e6c6d8bae8faa66d8fc9f96804ff4e19c5d4175bb7526b3b9c316fa2
-  data.tar.gz: ab225fd11a3841c4818fff35a61c24512634c765b083888e7f93585ad6dca8c1c68561920b2adaee22afa8e087cb95c13c754d800e8580b1feeb75d09e72592a
+  metadata.gz: a169f4e0a2632317c578e39374375dd39572d0d7c8764d51d55b81851cd2bbdb8916ee2013e28b9ba5fb7455403a14a2c623fdcbb95807d18920704fe5df5b80
+  data.tar.gz: c9b5faa907d9ee920a650e04de3cc22e3e8c560ece596a4b9b67dd9f07711bf33b5d95c5b60f3eed0dfa287bc33f300785c050d82c6629d3c435c370649b2b27

data/.gitignore

@@ -1,3 +1,5 @@
+*.gem
+Gemfile.lock
 /.bundle/
 /.yardoc
 /_yardoc/

data/README.md

@@ -20,9 +20,53 @@ Or install it yourself as:
 
     $ gem install bsvc
 
+
+**NOTE:** BSVC does _not_ include Bootstrap for you, this is by design. BSVC will work however you include Bootstrap in your application, whether through sprockets, esbuild, import map or any other way.
+
 ## Usage
 
-TODO: Examples for using components coming soon.
+Basic four column grid that shrinks to two, double stacked columns at the 768px (md) breakpont. Each column contains a heading component.
+
+**NOTE:** The last column shows a heading component (`h`) passing content in through a block rather than the `text:` option.
+
+```ruby
+<%= container do %>
+  <%= row do |c| %>
+    <%= column(c, col: { md: 6, lg: 3 }) do %>
+      <%= h(tag: 'h2', text: 'Column 1') %>
+    <% end %>
+    <%= column(c, col: { md: 6, lg: 3 }) do %>
+      <%= h(tag: 'h2', text: 'Column 2') %>
+    <% end %>
+    <%= column(c, col: { md: 6, lg: 3 }) do %>
+      <%= h(tag: 'h2', text: 'Column 3') %>
+    <% end %>
+    <%= column(c, col: { md: 6, lg: 3 }) do %>
+      <%= h(tag: 'h2') do %>
+        <i class="bi bi-4-circle-fill"></i> Column 4
+      <% end %>
+    <% end %>
+  <% end %>
+<% end %>
+```
+
+### Compoments used:
+- Container
+  - Accepts two options, type of container (`sm, md, lg...fluid`) and any additional classes
+- Row
+  - Accepts additional classes (`row` is default) and styles.
+- Column
+  - Accepts:
+    - col (`md: 6`)
+    - offset (`md: 6`)
+    - classes
+    - styles
+- Heading (h)
+  - Accepts:
+    - text (only if no block is provided)
+    - tag (h1, h2, h3 etc)
+    - classes
+    - styles
 
 ## Customizing Components
 
@@ -36,14 +80,26 @@ To copy all compoents into your app run:
 rails g bsvc:components
 ```
 
-This will copy over all of BSVC components and helpers. It will create a `components/` directory inside of `app/`. All helpers will be placed inside `app/helpers/`.
+This will copy over all of BSVC components and helpers. It will create an `app/components/` directory in the root of app. All helpers will be placed inside `app/helpers/`.
 
 ### A Single Component
 
 ```ruby
 rails g bsvc:component --name COMPONENT_NAME
 ```
-`--name` should be the top level directory of the coponent you want in `app/components/`
+`COMPONENT_NAME` should be the top level directory of the coponent you want in `app/components/`
+
+**NOTE:** Running the `component` command on a parent component with nested child components will copy over all child components in the top level directory.
+
+### A Single Nested Child Component
+For nested child components, pass the path of the component starting with the top level directory.
+
+```ruby
+rails g bsvc:component --name grid/container
+```
+
+This will grab only the container component and helper and place them in `app/components/grid` and `app/helpers/grid`.
+
 
 ## Roadmap
 - Continue building out components

data/app/components/accordion/accordion_component.html.erb

@@ -0,0 +1,9 @@
+<div
+  <%= classes %>
+  <%= id %>
+  <%= styles %>
+>
+  <% items.each do |item| %>
+    <%= item %>
+  <% end %>
+</div>

data/app/components/accordion/accordion_component.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Accordion
+  def default_plus_passed_classes(defaults, classes)
+    "#{defaults} #{classes}".strip
+  end
+
+  module_function :default_plus_passed_classes
+
+  class AccordionComponent < ViewComponent::Base
+    renders_many :items, AccordionItemComponent
+
+    def initialize(**options)
+      @id = options[:id]
+      @classses = options[:classses]
+      @styles = options[:styles]
+
+      @default_classses = 'accordion'
+    end
+
+    private
+
+    def styles
+      @styles if @styles.present?
+    end
+
+    def id
+      "id=#{@id}" if @id
+    end
+
+    def classes
+      "class=#{Accordion.default_plus_passed_classes(
+        @default_classses,
+        @classes
+      )}"
+    end
+  end
+end

data/app/components/accordion/accordion_item_component.htm.erb

@@ -0,0 +1,24 @@
+<div class="accordion-item">
+  <h2 class="accordion-header" <%= id %>>
+    <button
+      class="<%= "accordion-button #{active_item? ? nil : 'collapsed'}".strip %>"
+      type="button"
+      data-bs-toggle="collapse"
+      data-bs-target="#<%= @target %>"
+      aria-expanded="<%= active_item? ? 'true' : 'false' %>"
+      aria-controls="<%= @target %>"
+    >
+      <%= @title %>
+    </button>
+  </h2>
+  <div
+    id="<%= @target %>"
+    class="<%= "accordion-collapse collapse #{active_item? ? 'show' : nil}".strip %>"
+    aria-labelledby="<%= @id %>"
+    data-bs-parent="<%= "##{@parent}" %>"
+  >
+    <div class="accordion-body">
+      <%= content %>
+    </div>
+  </div>
+</div>

data/app/components/accordion/accordion_item_component.rb

@@ -0,0 +1,25 @@
+# frozen_strin_literal: true
+
+module Accordion
+  class AccordionItemComponent < ViewComponent::Base
+
+    def initialize(**options)
+      @id = options[:id]
+      @title = options[:title]
+      @index = options[:index]
+      @target = options[:target]
+      @active = options[:active]
+      @parent = options[:parent]
+    end
+
+    private
+
+    def active_item?
+      @active
+    end
+
+    def id
+      "id=#{@id}" if @id
+    end
+  end
+end

data/app/components/alert/alert_component.html.erb

@@ -0,0 +1,14 @@
+<div
+  class="alert alert-<%= variant %> <%= dismissible_classes %> <%= icon_classes %>"
+  role="alert"
+>
+  <%= message %>
+  <% if dismissible? %>
+    <button
+      type="button"
+      class="btn-close"
+      data-bs-dismiss="alert"
+      aria-label="Close">
+    </button>
+  <% end %>
+</div>

data/app/components/alert/alert_component.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Alert
+  class AlertComponent < ViewComponent::Base
+    def initialize(**options)
+      @variant = options[:variant]
+      @dismiss = options[:dismiss]
+      @message = options[:message]
+      @icon = options[:icon]
+    end
+
+    private
+
+    def dismissible?
+      true unless @dismiss == false
+    end
+
+    def dismissible_classes
+      'alert-dismissible fade show' if dismissible?
+    end
+
+    def icon?
+      @icon
+    end
+
+    def icon_classes
+      'd-flex align-items-center' if icon?
+    end
+
+    def variant
+      @variant || 'primary'
+    end
+
+    def message
+      @message || content
+    end
+  end
+end

data/app/components/alpha/forms/form/form.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Forms
+  module Form
+    class FormComponent < ViewComponent::Base
+      def initialize(**options)
+        @url = options[:url]
+        @scope = options[:scope]
+      end
+    end
+  end
+end

data/app/components/alpha/forms/input/input_component.html.erb

@@ -0,0 +1,10 @@
+<% if @floating %>
+  <div class="form-floating">
+    <%= text_input %>
+    <label for="<%= floating_label_id %>"><%= @placeholder %></label>
+  </div>
+<% else %>
+  <%= text_input %>
+<% end %>
+
+<h1>DO NOT USE: Active development</h1>

data/app/components/alpha/forms/input/input_component.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Forms
+  module Input
+    class InputComponent < ViewComponent::Base
+      def initialize(**options)
+        @method = options[:method]
+        @object = options[:object]
+        @scope = options[:scope]
+        @type = options.dig(:html, :type)
+        @classes = options.dig(:html, :class)
+        @floating = options.dig(:html, :floating)
+        @placeholder = options.dig(:html, :placeholder)
+        @onchange = options.dig(:html, :onchange)
+        @html = options[:html]
+        classes_builder
+      end
+
+      private
+
+      def text_input
+        if scoped?
+          @scope.text_field(@method, @html)
+        else
+          text_field(@object, @method, @html)
+        end
+      end
+
+      def scoped?
+        @scope.present?
+      end
+
+      def floating_label_id
+        if scoped?
+          @scope.options[:html][:id]
+        else
+          "#{@object}_#{@method}"
+        end
+      end
+
+      def classes_builder
+        if @html[:class]
+          @html[:class] = "form-control #{@classes}".strip
+        end
+      end
+    end
+  end
+end

data/app/components/card/card_component.rb

@@ -19,7 +19,6 @@ module Card
     class HeaderComponent < ViewComponent::Base
 
       def initialize(**options)
-        @tag = options[:tag] || :h2
         @classes = options[:classes]
         @styles = options[:styles]
 
@@ -27,7 +26,7 @@ module Card
       end
 
       def call
-        content_tag(@tag,
+        content_tag(:div,
           content,
           class: Card.default_plus_passed_classes(
             @default_classses,
@@ -41,7 +40,6 @@ module Card
     class FooterComponent < ViewComponent::Base
 
       def initialize(**options)
-        @tag = options[:tag] || :div
         @classes = options[:classes]
         @styles = options[:styles]
 
@@ -49,7 +47,7 @@ module Card
       end
 
       def call
-        content_tag(@tag,
+        content_tag(:div,
           content,
           class: Card.default_plus_passed_classes(
             @default_classses,

data/app/components/grid/columns/columns_component.rb

@@ -23,15 +23,17 @@ module Grid
       private
 
       def column_class_builder
-        "#{column_breakpoint} #{column_offset} #{@classes}"
+        "#{column_breakpoint} #{column_offset} #{@classes}".strip
       end
 
       def class_parser(option, klass)
-        option.map do |key, value|
-          if BREAK_POINTS.include?(key)
-            "#{klass}-#{key}-#{value} "
-          end
-        end.join('').strip
+        unless option.nil?
+          option.map do |key, value|
+            if BREAK_POINTS.include?(key)
+              "#{klass}-#{key}-#{value} "
+            end
+          end.join('').strip
+        end
       end
 
       def column_breakpoint

data/app/helpers/accordion/accordion_helper.rb

@@ -0,0 +1,17 @@
+# frozen_strin_literal: true
+
+module Accordion
+  module AccordionHelper
+    def accordion(**options)
+      render(Accordion::AccordionComponent.new(**options)) do |c|
+        yield(c)
+      end
+    end
+
+    def item(c, **options)
+      c.with_item(**options) do
+        yield
+      end
+    end
+  end
+end

data/app/helpers/alert/alert_helper.rb

@@ -0,0 +1,15 @@
+#frozen_string_literal: true
+
+module Alert
+  module AlertHelper
+    def alert(**options)
+      if block_given?
+        render(Alert::AlertComponent.new(**options)) do
+          yield
+        end
+      else
+        render(Alert::AlertComponent.new(**options))
+      end
+    end
+  end
+end

data/app/helpers/alpha/forms/input_helper.rb

@@ -0,0 +1,9 @@
+module Alpha
+  module Forms
+    module InputHelper
+      def input(**options)
+        render(Input::InputComponent.new(**options))
+      end
+    end
+  end
+end

data/app/helpers/card/card_helper.rb

@@ -7,5 +7,17 @@ module Card
         yield(c)
       end
     end
+
+    def header(c, **options)
+      c.with_header(**options) do
+        yield
+      end
+    end
+
+    def footer(c, **options)
+      c.with_footer(**options) do
+        yield
+      end
+    end
   end
 end

data/app/helpers/grid/row_helper.rb

@@ -5,5 +5,11 @@ module Grid
         yield(c)
       end
     end
+
+    def column(c, **options)
+      c.with_column(**options) do
+        yield
+      end
+    end
   end
 end

data/bsvc.gemspec

@@ -19,8 +19,6 @@ Gem::Specification.new do |spec|
   spec.metadata["source_code_uri"] = spec.homepage
   spec.metadata["changelog_uri"] = spec.homepage
 
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end

data/lib/bsvc/version.rb

@@ -1,3 +1,3 @@
 module Bsvc
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/generators/bsvc/component_generator.rb

@@ -8,8 +8,22 @@ module Bsvc
       class_option :name, type: :string, default: ''
 
       def copy_single_component
+        copy_component_to_app
+        copy_helper_to_app
+      end
+
+      private
+
+      def copy_component_to_app
         directory("app/components/#{@options[:name]}", "app/components/#{@options[:name]}")
-        directory("app/helpers/#{@options[:name]}", "app/helpers/#{@options[:name]}")
+      end
+
+      def copy_helper_to_app
+        if @options[:name].include?('/')
+          copy_file("app/helpers/#{@options[:name]}_helper.rb", "app/helpers/#{@options[:name]}_helper.rb")
+        else
+          directory("app/helpers/#{@options[:name]}", "app/helpers/#{@options[:name]}")
+        end
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bsvc
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Nick McNeany
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-01-09 00:00:00.000000000 Z
+date: 2023-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,6 +80,15 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- app/components/accordion/accordion_component.html.erb
+- app/components/accordion/accordion_component.rb
+- app/components/accordion/accordion_item_component.htm.erb
+- app/components/accordion/accordion_item_component.rb
+- app/components/alert/alert_component.html.erb
+- app/components/alert/alert_component.rb
+- app/components/alpha/forms/form/form.rb
+- app/components/alpha/forms/input/input_component.html.erb
+- app/components/alpha/forms/input/input_component.rb
 - app/components/card/card_component.html.erb
 - app/components/card/card_component.rb
 - app/components/grid/columns/columns_component.rb
@@ -87,6 +96,9 @@ files:
 - app/components/grid/container/container_component.rb
 - app/components/grid/row/row_component.rb
 - app/components/heading/h_component.rb
+- app/helpers/accordion/accordion_helper.rb
+- app/helpers/alert/alert_helper.rb
+- app/helpers/alpha/forms/input_helper.rb
 - app/helpers/card/card_helper.rb
 - app/helpers/grid/container_helper.rb
 - app/helpers/grid/row_helper.rb
@@ -106,7 +118,7 @@ metadata:
   homepage_uri: https://github.com/Nickiam7/bsvc
   source_code_uri: https://github.com/Nickiam7/bsvc
   changelog_uri: https://github.com/Nickiam7/bsvc
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -121,8 +133,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.3.25
+signing_key:
 specification_version: 4
 summary: A Bootstrap and ViewComponent library for Rails views.
 test_files: []