bsvc 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2856d5ea8ea38c3ca3a4a0d550bc8dbe67d078998e6a07d614ea677dea89b49a
+  data.tar.gz: 7d0173c3461403d830628ce47a85d8f609a91485d64b2e55dd97169a49a09249
+SHA512:
+  metadata.gz: d361e0170595f59b984bd654e1ef07e333d3e8730236fa4a984580b9523a1dce172b4cd4e6c6d8bae8faa66d8fc9f96804ff4e19c5d4175bb7526b3b9c316fa2
+  data.tar.gz: ab225fd11a3841c4818fff35a61c24512634c765b083888e7f93585ad6dca8c1c68561920b2adaee22afa8e087cb95c13c754d800e8580b1feeb75d09e72592a

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 1.17.2

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in bsvc.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 nmcneany
+
+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,59 @@
+# Bootstrap ViewComponents (BSVC)
+
+Bootstrap ViewComponents is a component library built on [Bootstrap](https://github.com/twbs/bootstrap) and [VeiwComponent](https://github.com/viewcomponent/view_component).
+
+BSVC offers a component based development workflow similar to React or Vue by neatly packaging Bootstrap into components to make your Rails UI development faster, easier and more fun!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bsvc'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bsvc
+
+## Usage
+
+TODO: Examples for using components coming soon.
+
+## Customizing Components
+
+If you need to customize components you can copy them into your application.
+
+### All Components
+
+To copy all compoents into your app run:
+
+```ruby
+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/`.
+
+### 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/`
+
+## Roadmap
+- Continue building out components
+- Continue creating usage doc
+- Continue add to README.md
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com//Nickiam7/bsvc. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/app/components/card/card_component.html.erb

@@ -0,0 +1,11 @@
+<div class="card <%= @classes %>" style="<%= @styles %>">
+  <% if header? %>
+    <%= header %>
+  <% end %>
+  <div class="card-body">
+    <%= content %>
+  </div>
+  <% if footer? %>
+    <%= footer %>
+  <% end %>
+</div>

data/app/components/card/card_component.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Card
+  def default_plus_passed_classes(defaults, classes)
+    "#{defaults} #{classes}".strip
+  end
+
+  module_function :default_plus_passed_classes
+
+  class CardComponent < ViewComponent::Base
+    renders_one :header, 'HeaderComponent'
+    renders_one :footer, 'FooterComponent'
+
+    def initialize(**options)
+      @classes = options[:classes]
+      @styles = options[:styles]
+    end
+
+    class HeaderComponent < ViewComponent::Base
+
+      def initialize(**options)
+        @tag = options[:tag] || :h2
+        @classes = options[:classes]
+        @styles = options[:styles]
+
+        @default_classses = 'card-header'
+      end
+
+      def call
+        content_tag(@tag,
+          content,
+          class: Card.default_plus_passed_classes(
+            @default_classses,
+            @classes
+          ),
+          style: @styles
+        )
+      end
+    end
+
+    class FooterComponent < ViewComponent::Base
+
+      def initialize(**options)
+        @tag = options[:tag] || :div
+        @classes = options[:classes]
+        @styles = options[:styles]
+
+        @default_classses = 'card-footer text-muted'
+      end
+
+      def call
+        content_tag(@tag,
+          content,
+          class: Card.default_plus_passed_classes(
+            @default_classses,
+            @classes
+          ),
+          style: @styles
+        )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Grid
+  module Columns
+    class ColumnsComponent < ViewComponent::Base
+      BREAK_POINTS = [:xs, :sm, :md, :lg, :xl, :xxl]
+
+      def initialize(**options)
+        @columns = options[:col]
+        @offsets = options[:offset]
+        @classes = options[:classes]
+        @styles = options[:styles]
+      end
+
+      def call
+        content_tag(:div,
+          content,
+          class: column_class_builder,
+          style: @styles,
+        )
+      end
+
+      private
+
+      def column_class_builder
+        "#{column_breakpoint} #{column_offset} #{@classes}"
+      end
+
+      def class_parser(option, klass)
+        option.map do |key, value|
+          if BREAK_POINTS.include?(key)
+            "#{klass}-#{key}-#{value} "
+          end
+        end.join('').strip
+      end
+
+      def column_breakpoint
+        class_parser(@columns, 'col')
+      end
+
+      def column_offset
+        class_parser(@offsets, 'offset')
+      end
+    end
+  end
+end

data/app/components/grid/container/container_component.html.erb

@@ -0,0 +1,3 @@
+<div class="<%= container_class %> <%= @classes %>">
+  <%= content %>
+</div>

data/app/components/grid/container/container_component.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Grid
+  module Container
+    class ContainerComponent < ViewComponent::Base
+      def initialize(**options)
+        @container = options[:container]
+        @classes = options[:classes]
+
+        @container_class = container_class
+      end
+
+      private
+
+      def container_class
+        @container.present? ? @container : 'container'
+      end
+    end
+  end
+end

data/app/components/grid/row/row_component.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Grid
+  module Row
+    class RowComponent < ViewComponent::Base
+      renders_many :columns, Columns::ColumnsComponent
+
+      def initialize(**options)
+        @classes = options[:classes]
+        @styles = options[:styles]
+      end
+
+      def call
+        content_tag(:div,
+          content,
+          class: default_plus_passed_classes,
+          style: @styles
+        )
+      end
+
+      private
+
+      def default_plus_passed_classes
+        "row #{@classes}".strip
+      end
+    end
+  end
+end

data/app/components/heading/h_component.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Heading
+  class HComponent < ViewComponent::Base
+    def initialize(**options)
+      @text = options[:text]
+      @tag = options[:tag]
+      @classes = options[:classes]
+      @styles = options[:styles]
+    end
+
+    def call
+      content_tag(@tag,
+        content || @text,
+        class: @classes,
+        style: @styles
+      )
+    end
+  end
+end

data/app/helpers/card/card_helper.rb

@@ -0,0 +1,11 @@
+# frozen_strin_literal: true
+
+module Card
+  module CardHelper
+    def card(**options)
+      render(Card::CardComponent.new(**options)) do |c|
+        yield(c)
+      end
+    end
+  end
+end

data/app/helpers/grid/container_helper.rb

@@ -0,0 +1,9 @@
+module Grid
+  module ContainerHelper
+    def container(**options)
+      render(Container::ContainerComponent.new(**options)) do
+        yield
+      end
+    end
+  end
+end

data/app/helpers/grid/row_helper.rb

@@ -0,0 +1,9 @@
+module Grid
+  module RowHelper
+    def row(**options)
+      render(Row::RowComponent.new(**options)) do |c|
+        yield(c)
+      end
+    end
+  end
+end

data/app/helpers/heading/heading_helper.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal :true
+
+module Heading
+  module HeadingHelper
+    def h(**options)
+      if block_given?
+        render(Heading::HComponent.new(**options)) do
+          yield
+        end
+      else
+        render(Heading::HComponent.new(**options))
+      end
+    end
+  end
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "bsvc"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bsvc.gemspec

@@ -0,0 +1,36 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "bsvc/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "bsvc"
+  spec.version       = Bsvc::VERSION
+  spec.authors       = ["Nick McNeany"]
+  spec.email         = ["nmcneany@gmail.com"]
+
+  spec.summary       = %q{A Bootstrap and ViewComponent library for Rails views.}
+  spec.description   = %q{A Bootstrap and ViewComponent library for Rails views.}
+  spec.homepage      = "https://github.com/Nickiam7/bsvc"
+  spec.license       = "MIT"
+
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  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
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_dependency "view_component", "~> 2.75"
+end

data/lib/bsvc/engine.rb

@@ -0,0 +1,9 @@
+module Bsvc
+  class Engine < ::Rails::Engine
+    initializer('bsvc.load_helpers') do
+      ActiveSupport.on_load(:action_controller) do
+        helper(Bsvc::Engine.helpers)
+      end
+    end
+  end
+end

data/lib/bsvc/version.rb

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

data/lib/bsvc.rb

@@ -0,0 +1,3 @@
+require "bsvc/version"
+require "bsvc/engine"
+require "view_component"

data/lib/generators/bsvc/component_generator.rb

@@ -0,0 +1,16 @@
+require "rails/generators"
+
+module Bsvc
+  module Generators
+    class ComponentGenerator < Rails::Generators::Base
+      source_root(File.expand_path("../../../../", __FILE__))
+
+      class_option :name, type: :string, default: ''
+
+      def copy_single_component
+        directory("app/components/#{@options[:name]}", "app/components/#{@options[:name]}")
+        directory("app/helpers/#{@options[:name]}", "app/helpers/#{@options[:name]}")
+      end
+    end
+  end
+end

data/lib/generators/bsvc/components_generator.rb

@@ -0,0 +1,14 @@
+require "rails/generators"
+
+module Bsvc
+  module Generators
+    class ComponentsGenerator < Rails::Generators::Base
+      source_root(File.expand_path("../../../../", __FILE__))
+
+      def copy_components
+        directory('app/components', 'app/components')
+        directory('app/helpers', 'app/helpers')
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: bsvc
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nick McNeany
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-01-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: view_component
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.75'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.75'
+description: A Bootstrap and ViewComponent library for Rails views.
+email:
+- nmcneany@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/components/card/card_component.html.erb
+- app/components/card/card_component.rb
+- app/components/grid/columns/columns_component.rb
+- app/components/grid/container/container_component.html.erb
+- app/components/grid/container/container_component.rb
+- app/components/grid/row/row_component.rb
+- app/components/heading/h_component.rb
+- app/helpers/card/card_helper.rb
+- app/helpers/grid/container_helper.rb
+- app/helpers/grid/row_helper.rb
+- app/helpers/heading/heading_helper.rb
+- bin/console
+- bin/setup
+- bsvc.gemspec
+- lib/bsvc.rb
+- lib/bsvc/engine.rb
+- lib/bsvc/version.rb
+- lib/generators/bsvc/component_generator.rb
+- lib/generators/bsvc/components_generator.rb
+homepage: https://github.com/Nickiam7/bsvc
+licenses:
+- MIT
+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: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A Bootstrap and ViewComponent library for Rails views.
+test_files: []