bs5 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 37f7ba7e614cc623e4041e6caf107313059069c11915bcaaa0b00b2a95ad9810
+  data.tar.gz: 7f150ed58e6820999d63483763cf17b4f836980acd7b6d63b3a3aef272d05067
+SHA512:
+  metadata.gz: 7f7c2230879f59f7743bc0b89d4fadf09ea9bf887cb8b0bb68bd1f8a9617123dc9a47f6a5d2ee783ce57d6a11a6457d3e3b4796ce146bb09d639d6c5fd9a4c8c
+  data.tar.gz: 4a69710e2d7129473e5f0423dc27a7d359ee43982190d25f31e7da3167851f133ea3829a4151b75259b6717d29d9faa0bb1416eae31ea33813283139e5d00825

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2020 Patrick Baselier
+
+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,63 @@
+# Bs5
+
+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)
+
+## Usage
+
+How to use my plugin.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bs5'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install bs5
+```
+
+## Configuration
+
+Run the following command to setup your project to use Bootstrap 5.
+
+    $ rails generate bs5:install
+    
+## Components
+
+### Alert 🖌
+
+```
+<%= render Bs5::AlertComponent.new do %>
+  A simple primary alert—check it out!
+<%- end %>
+```
+
+```
+<%= render Bs5::AlertComponent.new(type: :warning, is_dismissable: true) do %>
+  <strong>Holy guacamole!</strong> You should check in on some of those fields below.
+<%- end %>
+```
+
+## Previewing components
+
+* http://localhost:3000/rails/view_components
+
+## Contributing
+
+Contribution directions go here.
+
+## 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,34 @@
+# frozen_string_literal: true
+
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Bs5'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path('spec/dummy/Rakefile', __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/CHANGELOG.md

@@ -0,0 +1,13 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+
+- Add generator for installing `bs5`.
+- Add ViewComponent for Alert component.

data/app/assets/config/bs5_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/bs5 .css

data/app/assets/stylesheets/bs5/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

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

@@ -0,0 +1,6 @@
+<div class="<%= component_class %>" role="alert">
+  <%= content %>
+  <%- if is_dismissable %>
+    <button type="button" class="btn-close" data-dismiss="alert" aria-label="Close"></button>
+  <%- end %>
+</div>

data/app/components/bs5/alert_component.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Bs5
+  class AlertComponent < ViewComponent::Base
+    TYPES = %i[primary secondary success danger warning info light dark].freeze
+
+    include ActiveModel::Validations
+
+    attr_reader :type, :is_dismissable
+
+    validates :type, inclusion: { in: TYPES, message: lambda do |_, data|
+      "#{data[:value].inspect} is not valid. Try #{TYPES.to_sentence(last_word_connector: ' or ')}."
+    end }
+
+    def initialize(type: :primary, is_dismissable: false)
+      @type = type.to_sym
+      @is_dismissable = is_dismissable
+    end
+
+    def before_render
+      raise errors.full_messages.to_sentence if invalid?
+    end
+
+    private
+
+    def component_class
+      class_names = ['alert', contextual_class]
+      class_names << %w[alert-dismissible fade show] if is_dismissable
+      class_names.join(' ')
+    end
+
+    def contextual_class
+      "alert-#{@type}"
+    end
+  end
+end

data/app/controllers/bs5/application_controller.rb

@@ -0,0 +1,5 @@
+module Bs5
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+  end
+end

data/app/helpers/bs5/application_helper.rb

@@ -0,0 +1,4 @@
+module Bs5
+  module ApplicationHelper
+  end
+end

data/app/jobs/bs5/application_job.rb

@@ -0,0 +1,4 @@
+module Bs5
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/bs5/application_mailer.rb

@@ -0,0 +1,6 @@
+module Bs5
+  class ApplicationMailer < ActionMailer::Base
+    default from: 'from@example.com'
+    layout 'mailer'
+  end
+end

data/app/models/bs5/application_record.rb

@@ -0,0 +1,5 @@
+module Bs5
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/views/layouts/bs5/application.html.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Bs5</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= stylesheet_link_tag    "bs5/application", media: "all" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,2 @@
+Bs5::Engine.routes.draw do
+end

data/lib/bs5.rb

@@ -0,0 +1,5 @@
+require "bs5/engine"
+
+module Bs5
+  # Your code goes here...
+end

data/lib/bs5/engine.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'view_component/engine'
+module Bs5
+  class Engine < ::Rails::Engine
+    isolate_namespace Bs5
+
+    # Previewing ViewComponents
+    config.before_configuration do |app|
+      app.config.view_component.preview_paths << "#{Bs5::Engine.root}/spec/components/previews"
+    end
+  end
+end

data/lib/bs5/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Bs5
+  VERSION = '0.0.2'
+end

data/lib/generators/bs5/install/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    rails generate install Thing
+
+    This will create:
+        what/will/it/create

data/lib/generators/bs5/install/install_generator.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+class Bs5::InstallGenerator < Rails::Generators::Base
+  def add_bootstrap
+    run 'yarn add bootstrap@next popper.js'
+
+    create_file 'app/javascript/packs/styles.scss', <<~HEREDOC
+      @import "~bootstrap/scss/bootstrap";
+    HEREDOC
+
+    inject_into_file 'app/views/layouts/application.html.erb', before: '</head>' do
+      <<~HEREDOC
+        <%= stylesheet_pack_tag 'styles', media: 'all', 'data-turbolinks-track': 'reload' %>
+      HEREDOC
+    end
+
+    append_file 'app/javascript/packs/application.js', <<~HEREDOC
+      import "bootstrap";
+    HEREDOC
+
+    gsub_file 'config/webpacker.yml', 'extract_css: false', 'extract_css: true'
+  end
+end

data/lib/tasks/bs5_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :bs5 do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: bs5
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Patrick Baselier
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-11-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.3
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.3.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.3
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.3.4
+- !ruby/object:Gem::Dependency
+  name: view_component
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.22.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.22.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.1
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.33'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.33'
+description: "[WIP] Rails engine to include Bootstrap 5."
+email:
+- patrick.baselier@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/CHANGELOG.md
+- app/assets/config/bs5_manifest.js
+- app/assets/stylesheets/bs5/application.css
+- app/components/bs5/alert_component.html.erb
+- app/components/bs5/alert_component.rb
+- app/controllers/bs5/application_controller.rb
+- app/helpers/bs5/application_helper.rb
+- app/jobs/bs5/application_job.rb
+- app/mailers/bs5/application_mailer.rb
+- app/models/bs5/application_record.rb
+- app/views/layouts/bs5/application.html.erb
+- config/routes.rb
+- lib/bs5.rb
+- lib/bs5/engine.rb
+- lib/bs5/version.rb
+- lib/generators/bs5/install/USAGE
+- lib/generators/bs5/install/install_generator.rb
+- lib/tasks/bs5_tasks.rake
+homepage: https://github.com/bazzel/bs5
+licenses:
+- MIT
+metadata: {}
+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: Bootstrap 5
+test_files: []