bootstrap4_rails_components 0.1.0

data/lib/bootstrap4_rails_components/bootstrap/utilities/wrappable.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Bootstrap4RailsComponents
+  module Bootstrap
+    module Utilities
+      # Allows component to swap out the main component wrapping element (ex. :div vs. :span)
+      # Pass in :as -- only unique logic at the moment
+      # is converting :link to :a for tag generation
+      module Wrappable
+        attr_accessor :as
+
+        def utility_initialize
+          self.as = options.fetch(:as, automatic_as)
+          super
+        end
+
+        private
+
+        def assistive_html_attributes
+          if as == :button
+            super.merge(type: options.fetch(:type, 'button')) # prefer type submit
+          else
+            super
+          end
+        end
+
+        def automatic_as
+          if href
+            :a
+          elsif options[:type] == 'submit'
+            :button
+          else
+            default_html_wrapper_element
+          end
+        end
+
+        # Set default_html_wrapper_element on individual components as needed
+        def default_html_wrapper_element
+          @default_html_wrapper_element ||= :span
+        end
+
+        def non_html_attribute_options
+          super.push(:as)
+        end
+      end
+    end
+  end
+end

data/lib/bootstrap4_rails_components/engine.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Bootstrap4RailsComponents
+  class Engine < ::Rails::Engine
+    isolate_namespace Bootstrap4RailsComponents
+
+    config.autoload_paths << Engine.root.join("lib")
+
+    # Ensures that the config/bootstrap4_rails_components_manifest.js file is compiled
+    # which, in turn, ensures that all of the non-autoloaded assets
+    # are pre-compiled for the host-app's consumption.
+    #
+    # If you need to add unique assets to be precompiled
+    # (new folders -- e.g.: 'font' -- within the assets directory)
+    # update / add to the "links" found on the manifest file.
+    #
+    # Font assets example:
+    # on app/assets/config/bootstrap4_rails_components_manifest.js
+    #
+    # //= link_tree '../font/bootstrap4_rails_components'
+    #
+    # See manifest here: app/assets/config/bootstrap4_rails_components_manifest.js
+    #
+    # Learn more about using the sprockets `link`ing mechanisms:
+    # https://github.com/rails/sprockets#link
+    #
+    # Utilize engine initializer method:
+    initializer 'bootstrap4_rails_components.assets.precompile' do |app|
+      app.config.assets.precompile << "#{Engine.root.join('app', 'assets', 'config')}/bootstrap4_rails_components_manifest.js"
+    end
+
+    config.to_prepare do
+      ActiveSupport.on_load :action_controller do
+        helper Bootstrap4RailsComponents::ApplicationHelper
+      end
+    end
+  end
+end

data/lib/bootstrap4_rails_components/ui/base.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Bootstrap4RailsComponents
+  module UI
+    # The base component building class for namespaced
+    # components (bootstrap vs network_for_good / nfg)
+    class Base
+      attr_accessor :view_context
+
+      def initialize(view_context)
+        self.view_context = view_context
+      end
+
+      def bootstrap(component_name = nil, *traits, **options, &block)
+        return unless render_component?(options)
+        Bootstrap4RailsComponents::UI::Bootstrap.new(view_context, component_name, *traits, **options, &block).render_component
+      end
+
+      private
+
+      # Opens up the component :options -
+      # :render_if
+      # :render_unless
+      #
+      # Pass in `render_if: your_condition?` or `render_unless: your_unless_condition?`
+      # to the component to embed the `if/unless` condition right into the component
+      # and not on yet another line of HTML.
+      #
+      # Example usage:
+      # ui.bootstrap(:button, :submit, body: 'Delete', render_if: user.admin?)
+      # ui.bootstrap(:button, :submit, body: 'Save', render_unless: user.admin?)
+      def render_component?(options)
+        return true unless options.key?(:render_if) || options.key?(:render_unless)
+        if options.key?(:render_if)
+          options[:render_if]
+        else
+          !options[:render_unless]
+        end
+      end
+    end
+  end
+end

data/lib/bootstrap4_rails_components/ui/bootstrap.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Bootstrap4RailsComponents
+  module UI
+    # The class that yields the component for the view
+    class Bootstrap
+      include Bootstrap4RailsComponents::UI::Utilities::Initializer
+
+      attr_accessor :view_context
+      # attr_reader :component_name_folder
+
+      def initialize(view_context, component_name = nil, *traits, **options, &block)
+        self.view_context = view_context
+        initializer(component_name, *traits, **options, &block)
+        # @component_name_folder = component.component_family.to_s.pluralize if component.component_family.present?
+        # raise component.send(:component_family).inspect
+      end
+
+      private
+
+      def component_name_folder
+        # component.component_family.to_s.pluralize if component.component_family.present?
+        component.component_family.to_s.pluralize
+        # ''
+      end
+
+      def group
+        'bootstrap'
+      end
+
+      def grouping_folder
+        'bootstrap'
+      end
+
+      def ancestry_string
+        "Bootstrap4RailsComponents::Bootstrap::Components::#{class_name}"
+      end
+
+      def components_within_group(*)
+        Bootstrap4RailsComponents::BOOTSTRAP_COMPONENT_NAMES
+      end
+    end
+  end
+end

data/lib/bootstrap4_rails_components/ui/utilities.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Bootstrap4RailsComponents
+  module UI
+    module Utilities
+      extend ActiveSupport::Autoload
+      autoload :Initializer
+    end
+  end
+end

data/lib/bootstrap4_rails_components/ui/utilities/initializer.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module Bootstrap4RailsComponents
+  module UI
+    module Utilities
+      # Centralizes initialization for the UI namespaces
+      module Initializer
+        attr_accessor :component,
+                      :options,
+                      :traits,
+                      :component_name,
+                      :class_name
+
+        # Protect the component from outside manipulation
+        # after initialization
+        private :component=
+
+        include ActionView::Helpers::CaptureHelper # add capture support, required for Haml
+        include Haml::Helpers # add capture_haml support
+
+        def render_component
+          component.render
+        rescue NotImplementedError
+          view_context.render partial: partial_path, locals: { component_name => component }
+        end
+
+        private
+
+        def render_if
+          options.fetch(:render_if, true)
+        end
+
+        def render_unless
+          options.fetch(:render_unless, true)
+        end
+
+        # Provides a central initialization method for Bootstrap4RailsComponents::UI::Base child classes
+        def initializer(component_name = nil, *traits, **options, &block)
+          # #init_haml_helpers is required when utilizing #capture with HAML
+          # (when outside of Rails)
+          # https://www.rubydoc.info/github/haml/haml/Haml%2FHelpers:init_haml_helpers
+          init_haml_helpers
+          @component_name = component_name
+          @class_name = component_name.to_s.camelize
+          @traits = traits
+          @options = options
+
+          options[:body] = capture(&block) if block_given?
+          options[:traits] = traits.present? ? traits : []
+
+          # self.view_context = view_context
+          self.component = ancestry_string.constantize.new(options, view_context)
+        end
+
+        def ancestry_string
+          ''
+        end
+
+        # def component_name_folder
+        #   @component_name_folder ||= ''
+        # end
+
+        def component_family
+          component.component_family.presence
+        end
+
+        def components_within_group(*)
+          []
+        end
+
+        def grouping_folder
+          ''
+        end
+
+        def group; end
+
+        def partial_path
+          [
+            'bootstrap4_rails_components',
+            grouping_folder,
+            (component_name_folder if component_name_folder.present?),
+            component_name
+          ].reject(&:nil?).join('/').chomp
+        end
+      end
+    end
+  end
+end

data/lib/bootstrap4_rails_components/version.rb

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

metadata

@@ -0,0 +1,372 @@
+--- !ruby/object:Gem::Specification
+name: bootstrap4_rails_components
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jonathan Roehm
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-06-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bootstrap
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.3.1
+- !ruby/object:Gem::Dependency
+  name: jquery-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: sass-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: autoprefixer-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 9.4.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 9.4.9
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: chromedriver-helper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: factory_bot_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.11'
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: rails-controller-testing
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.14'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+- !ruby/object:Gem::Dependency
+  name: sprockets
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: 'Implementation of view helper methods that utilize robust options and
+  traits to generate semantic Bootstrap4 HTML for Ruby on Rails. Supply themes, rails
+  helper options (such as :method and :confirm for a `link_to`). Example usage: `<%=
+  ui.bootstrap :button, :primary, :block, href: user_path(@user), method: :delete,
+  confirm: ''Are you sure?'', tooltip: ''Adds a new user'' %>` Which outputs a primary
+  button with `btn-block` that uses rails method & confirm, and automatically supplies
+  a tooltip (and there''s much more!)'
+email:
+- jonroehm@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/bootstrap4_rails_components_manifest.js
+- app/assets/javascripts/bootstrap4_rails_components/application.js
+- app/assets/javascripts/bootstrap4_rails_components/vendor/tooltips.js
+- app/assets/stylesheets/bootstrap4_rails_components/bootstrap/application.scss
+- app/controllers/bootstrap4_rails_components/application_controller.rb
+- app/helpers/bootstrap4_rails_components/application_helper.rb
+- app/models/bootstrap4_rails_components/application_record.rb
+- config/initializers/web_app_manifest.rb
+- config/locales/en.yml
+- config/routes.rb
+- config/spring.rb
+- lib/bootstrap4_rails_components.rb
+- lib/bootstrap4_rails_components/bootstrap/components/alert.rb
+- lib/bootstrap4_rails_components/bootstrap/components/badge.rb
+- lib/bootstrap4_rails_components/bootstrap/components/base.rb
+- lib/bootstrap4_rails_components/bootstrap/components/breadcrumb.rb
+- lib/bootstrap4_rails_components/bootstrap/components/breadcrumb_item.rb
+- lib/bootstrap4_rails_components/bootstrap/components/button.rb
+- lib/bootstrap4_rails_components/bootstrap/components/button_group.rb
+- lib/bootstrap4_rails_components/bootstrap/components/button_toolbar.rb
+- lib/bootstrap4_rails_components/bootstrap/components/card.rb
+- lib/bootstrap4_rails_components/bootstrap/components/card_body.rb
+- lib/bootstrap4_rails_components/bootstrap/components/card_footer.rb
+- lib/bootstrap4_rails_components/bootstrap/components/card_header.rb
+- lib/bootstrap4_rails_components/bootstrap/components/card_image.rb
+- lib/bootstrap4_rails_components/bootstrap/components/card_image_overlay.rb
+- lib/bootstrap4_rails_components/bootstrap/components/carousel.rb
+- lib/bootstrap4_rails_components/bootstrap/components/carousel_caption.rb
+- lib/bootstrap4_rails_components/bootstrap/components/carousel_control.rb
+- lib/bootstrap4_rails_components/bootstrap/components/carousel_indicators.rb
+- lib/bootstrap4_rails_components/bootstrap/components/carousel_item.rb
+- lib/bootstrap4_rails_components/bootstrap/components/collapse.rb
+- lib/bootstrap4_rails_components/bootstrap/components/dropdown.rb
+- lib/bootstrap4_rails_components/bootstrap/components/dropdown_divider.rb
+- lib/bootstrap4_rails_components/bootstrap/components/dropdown_header.rb
+- lib/bootstrap4_rails_components/bootstrap/components/dropdown_item.rb
+- lib/bootstrap4_rails_components/bootstrap/components/dropdown_menu.rb
+- lib/bootstrap4_rails_components/bootstrap/components/dropdown_toggle.rb
+- lib/bootstrap4_rails_components/bootstrap/components/embed.rb
+- lib/bootstrap4_rails_components/bootstrap/components/form.rb
+- lib/bootstrap4_rails_components/bootstrap/components/input_group.rb
+- lib/bootstrap4_rails_components/bootstrap/components/jumbotron.rb
+- lib/bootstrap4_rails_components/bootstrap/components/list_group.rb
+- lib/bootstrap4_rails_components/bootstrap/components/list_group_item.rb
+- lib/bootstrap4_rails_components/bootstrap/components/media.rb
+- lib/bootstrap4_rails_components/bootstrap/components/media_body.rb
+- lib/bootstrap4_rails_components/bootstrap/components/media_object.rb
+- lib/bootstrap4_rails_components/bootstrap/components/modal.rb
+- lib/bootstrap4_rails_components/bootstrap/components/modal_body.rb
+- lib/bootstrap4_rails_components/bootstrap/components/modal_footer.rb
+- lib/bootstrap4_rails_components/bootstrap/components/modal_header.rb
+- lib/bootstrap4_rails_components/bootstrap/components/nav.rb
+- lib/bootstrap4_rails_components/bootstrap/components/nav_item.rb
+- lib/bootstrap4_rails_components/bootstrap/components/nav_link.rb
+- lib/bootstrap4_rails_components/bootstrap/components/navbar.rb
+- lib/bootstrap4_rails_components/bootstrap/components/navbar_brand.rb
+- lib/bootstrap4_rails_components/bootstrap/components/navbar_nav.rb
+- lib/bootstrap4_rails_components/bootstrap/components/navbar_text.rb
+- lib/bootstrap4_rails_components/bootstrap/components/navbar_toggler.rb
+- lib/bootstrap4_rails_components/bootstrap/components/page_item.rb
+- lib/bootstrap4_rails_components/bootstrap/components/pagination.rb
+- lib/bootstrap4_rails_components/bootstrap/components/popover.rb
+- lib/bootstrap4_rails_components/bootstrap/components/progress.rb
+- lib/bootstrap4_rails_components/bootstrap/components/progress_bar.rb
+- lib/bootstrap4_rails_components/bootstrap/components/tab_content.rb
+- lib/bootstrap4_rails_components/bootstrap/components/tab_pane.rb
+- lib/bootstrap4_rails_components/bootstrap/components/table.rb
+- lib/bootstrap4_rails_components/bootstrap/readme.md
+- lib/bootstrap4_rails_components/bootstrap/utilities/activatable.rb
+- lib/bootstrap4_rails_components/bootstrap/utilities/alignable.rb
+- lib/bootstrap4_rails_components/bootstrap/utilities/collapse_toggleable.rb
+- lib/bootstrap4_rails_components/bootstrap/utilities/collapsible.rb
+- lib/bootstrap4_rails_components/bootstrap/utilities/disableable.rb
+- lib/bootstrap4_rails_components/bootstrap/utilities/dismissible.rb
+- lib/bootstrap4_rails_components/bootstrap/utilities/dropdown_directionable.rb
+- lib/bootstrap4_rails_components/bootstrap/utilities/headable.rb
+- lib/bootstrap4_rails_components/bootstrap/utilities/modalable.rb
+- lib/bootstrap4_rails_components/bootstrap/utilities/progressable.rb
+- lib/bootstrap4_rails_components/bootstrap/utilities/remotable.rb
+- lib/bootstrap4_rails_components/bootstrap/utilities/sizable.rb
+- lib/bootstrap4_rails_components/bootstrap/utilities/themeable.rb
+- lib/bootstrap4_rails_components/bootstrap/utilities/titleable.rb
+- lib/bootstrap4_rails_components/bootstrap/utilities/tooltipable.rb
+- lib/bootstrap4_rails_components/bootstrap/utilities/wrappable.rb
+- lib/bootstrap4_rails_components/engine.rb
+- lib/bootstrap4_rails_components/ui/base.rb
+- lib/bootstrap4_rails_components/ui/bootstrap.rb
+- lib/bootstrap4_rails_components/ui/utilities.rb
+- lib/bootstrap4_rails_components/ui/utilities/initializer.rb
+- lib/bootstrap4_rails_components/version.rb
+homepage: https://github.com/jonathanroehm/bootstrap4_rails_components
+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: Bootstrap4 view helper methods that generate semantic Bootstrap4 html components
+test_files: []