twitter-bootstrap-rails 5.3.0 → 5.4.0

data/lib/generators/bootstrap/badge/badge_generator.rb

@@ -0,0 +1,13 @@
+require 'generators/bootstrap/snippets/snippet_base'
+
+module Bootstrap
+  module Generators
+    # Badges from https://getbootstrap.com/docs/5.3/examples/badges/
+    class BadgeGenerator < SnippetBase
+      snippet_category "badges"
+
+      desc "Copies a Bootstrap badges snippet into your views. " \
+           "Run with --list to see the variants."
+    end
+  end
+end

data/lib/generators/bootstrap/breadcrumb/breadcrumb_generator.rb

@@ -0,0 +1,13 @@
+require 'generators/bootstrap/snippets/snippet_base'
+
+module Bootstrap
+  module Generators
+    # Breadcrumbs from https://getbootstrap.com/docs/5.3/examples/breadcrumbs/
+    class BreadcrumbGenerator < SnippetBase
+      snippet_category "breadcrumbs"
+
+      desc "Copies a Bootstrap breadcrumbs snippet into your views. " \
+           "Run with --list to see the variants."
+    end
+  end
+end

data/lib/generators/bootstrap/button/button_generator.rb

@@ -0,0 +1,13 @@
+require 'generators/bootstrap/snippets/snippet_base'
+
+module Bootstrap
+  module Generators
+    # Buttons from https://getbootstrap.com/docs/5.3/examples/buttons/
+    class ButtonGenerator < SnippetBase
+      snippet_category "buttons"
+
+      desc "Copies a Bootstrap buttons snippet into your views. " \
+           "Run with --list to see the variants."
+    end
+  end
+end

data/lib/generators/bootstrap/cdn/cdn_generator.rb

@@ -0,0 +1,39 @@
+require 'rails/generators'
+require 'twitter/bootstrap/rails/version'
+require 'generators/bootstrap/cdn_tags'
+
+module Bootstrap
+  module Generators
+    # Prints the jsDelivr tags for pasting into a layout the user already owns.
+    # Writes nothing to disk.
+    class CdnGenerator < ::Rails::Generators::Base
+      include CdnTags
+
+      desc "Prints the Bootstrap #{Twitter::Bootstrap::Rails::BOOTSTRAP_VERSION} CDN tags"
+
+      class_option :css, :type => :boolean, :default => false,
+                   :desc => 'Print only the stylesheet link'
+      class_option :js, :type => :boolean, :default => false,
+                   :desc => 'Print only the JavaScript bundle script'
+      class_option :'separate-popper', :type => :boolean, :default => false,
+                   :desc => 'Print Popper and bootstrap.js as separate tags instead of the bundle'
+
+      def print_tags
+        say tags.join("\n")
+      end
+
+      private
+
+      def tags
+        return [css_tag] if options[:css] && !options[:js]
+        return [javascript_tags] if options[:js] && !options[:css]
+
+        [css_tag, javascript_tags]
+      end
+
+      def javascript_tags
+        options[:'separate-popper'] ? separate_popper_tags : bundle_tag
+      end
+    end
+  end
+end

data/lib/generators/bootstrap/cdn_tags.rb

@@ -0,0 +1,43 @@
+require "twitter/bootstrap/rails/version"
+
+module Bootstrap
+  module Generators
+    # Renders the jsDelivr tags from the Introduction page, built from the
+    # constants in Twitter::Bootstrap::Rails so no template hardcodes a version
+    # or an integrity hash.
+    module CdnTags
+      def css_tag
+        entry = cdn(:css)
+        %{<link href="#{entry[:url]}" rel="stylesheet" integrity="#{entry[:integrity]}" crossorigin="anonymous">}
+      end
+
+      def bundle_tag
+        script_tag(:bundle)
+      end
+
+      def js_tag
+        script_tag(:js)
+      end
+
+      def popper_tag
+        script_tag(:popper)
+      end
+
+      # Popper and bootstrap.js as the separate pair, in the docs' order.
+      def separate_popper_tags
+        [popper_tag, js_tag].join("\n")
+      end
+
+      private
+
+      def script_tag(key)
+        entry = cdn(key)
+        %{<script src="#{entry[:url]}" integrity="#{entry[:integrity]}" crossorigin="anonymous"></script>}
+      end
+
+      def cdn(key)
+        Twitter::Bootstrap::Rails::BOOTSTRAP_CDN.fetch(key)
+      end
+    end
+  end
+end

data/lib/generators/bootstrap/dropdown/dropdown_generator.rb

@@ -0,0 +1,13 @@
+require 'generators/bootstrap/snippets/snippet_base'
+
+module Bootstrap
+  module Generators
+    # Dropdowns from https://getbootstrap.com/docs/5.3/examples/dropdowns/
+    class DropdownGenerator < SnippetBase
+      snippet_category "dropdowns"
+
+      desc "Copies a Bootstrap dropdowns snippet into your views. " \
+           "Run with --list to see the variants."
+    end
+  end
+end

data/lib/generators/bootstrap/features/features_generator.rb

@@ -0,0 +1,13 @@
+require 'generators/bootstrap/snippets/snippet_base'
+
+module Bootstrap
+  module Generators
+    # Features from https://getbootstrap.com/docs/5.3/examples/features/
+    class FeaturesGenerator < SnippetBase
+      snippet_category "features"
+
+      desc "Copies a Bootstrap features snippet into your views. " \
+           "Run with --list to see the variants."
+    end
+  end
+end

data/lib/generators/bootstrap/footer/footer_generator.rb

@@ -0,0 +1,13 @@
+require 'generators/bootstrap/snippets/snippet_base'
+
+module Bootstrap
+  module Generators
+    # Footers from https://getbootstrap.com/docs/5.3/examples/footers/
+    class FooterGenerator < SnippetBase
+      snippet_category "footers"
+
+      desc "Copies a Bootstrap footers snippet into your views. " \
+           "Run with --list to see the variants."
+    end
+  end
+end

data/lib/generators/bootstrap/header/header_generator.rb

@@ -0,0 +1,13 @@
+require 'generators/bootstrap/snippets/snippet_base'
+
+module Bootstrap
+  module Generators
+    # Headers from https://getbootstrap.com/docs/5.3/examples/headers/
+    class HeaderGenerator < SnippetBase
+      snippet_category "headers"
+
+      desc "Copies a Bootstrap headers snippet into your views. " \
+           "Run with --list to see the variants."
+    end
+  end
+end

data/lib/generators/bootstrap/hero/hero_generator.rb

@@ -0,0 +1,13 @@
+require 'generators/bootstrap/snippets/snippet_base'
+
+module Bootstrap
+  module Generators
+    # Heroes from https://getbootstrap.com/docs/5.3/examples/heroes/
+    class HeroGenerator < SnippetBase
+      snippet_category "heroes"
+
+      desc "Copies a Bootstrap heroes snippet into your views. " \
+           "Run with --list to see the variants."
+    end
+  end
+end

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

@@ -1,104 +1,163 @@
 require 'rails/generators'
 require 'fileutils'
+require 'twitter/bootstrap/rails/version'
 
 module Bootstrap
   module Generators
     class InstallGenerator < ::Rails::Generators::Base
 
+      # Raised when a dist file that should ship with the gem is missing, rather
+      # than silently installing nothing.
+      class MissingAssetError < StandardError; end
+
       source_root File.expand_path("../templates", __FILE__)
-      desc "This generator installs Bootstrap to Asset Pipeline"
-      argument :stylesheets_type, :type => :string, :default => 'static', :banner => '*less or static'
-      class_option :'no-coffeescript', :type => :boolean, :default => false, :desc => 'Skips coffeescript replacement into app generators'
+      desc "This generator installs Bootstrap #{Twitter::Bootstrap::Rails::BOOTSTRAP_VERSION} to the Asset Pipeline"
+      argument :asset_mode, :type => :string, :default => 'static',
+               :banner => 'static or cdn',
+               :desc => 'static vendors Bootstrap into the app; cdn links to jsDelivr instead'
+
+      VENDORED_ASSETS = [
+        ['vendor/assets/stylesheets/twitter/bootstrap/bootstrap.min.css',
+         'app/assets/stylesheets/twitter/bootstrap/bootstrap.min.css'],
+        ['vendor/assets/javascripts/twitter/bootstrap/bootstrap.bundle.min.js',
+         'app/assets/javascripts/twitter/bootstrap/bootstrap.bundle.min.js']
+      ].freeze
+
+      def validate_asset_mode
+        return if %w[static cdn].include?(asset_mode)
+
+        raise ::Rails::Generators::Error,
+          "Unknown asset mode #{asset_mode.inspect}. Expected 'static' or 'cdn'."
+      end
 
       def add_assets
+        return if cdn?
+        # Propshaft has no require directives to add; bootstrap:layout links the
+        # vendored files explicitly instead.
+        return if propshaft?
 
         js_manifest = 'app/assets/javascripts/application.js'
 
-        if File.exist?(js_manifest)
-          insert_into_file js_manifest, "//= require twitter/bootstrap\n", :after => "application\n"
+        if exists_in_app?(js_manifest)
+          add_require(js_manifest,
+                      "//= require twitter/bootstrap/bootstrap.bundle.min\n",
+                      "application\n",
+                      'twitter/bootstrap')
         else
           copy_file "application.js", js_manifest
         end
 
         css_manifest = 'app/assets/stylesheets/application.css'
 
-        if File.exist?(css_manifest)
-          content = File.read(css_manifest)
-          unless content.include?('bootstrap')
-            style_require_block = " *= require bootstrap\n"
-            insert_into_file css_manifest, style_require_block, :after => "require_self\n"
-          end
+        if exists_in_app?(css_manifest)
+          add_require(css_manifest,
+                      " *= require bootstrap_and_overrides\n",
+                      "require_self\n",
+                      'bootstrap')
         else
-          copy_file "application.css", "app/assets/stylesheets/application.css"
+          copy_file "application.css", css_manifest
         end
-
-        copy_bootstrap_assets
-
       end
 
       def copy_bootstrap_assets
-        gem_root = File.expand_path("../../../../..", __FILE__)
-        bootstrap_css_src = "#{gem_root}/vendor/assets/stylesheets/twitter/bootstrap"
-        bootstrap_js_src = "#{gem_root}/vendor/assets/javascripts/twitter/bootstrap"
-        
-        css_dest = "app/assets/stylesheets/twitter/bootstrap"
-        js_dest = "app/assets/javascripts/twitter/bootstrap"
-        
-        FileUtils.mkdir_p(css_dest)
-        FileUtils.mkdir_p(js_dest)
-        
-        Dir.glob("#{bootstrap_css_src}/*").each do |src|
-          dest = "#{css_dest}/#{File.basename(src)}"
-          FileUtils.cp(src, dest)
-        end
-        
-        Dir.glob("#{bootstrap_js_src}/*").each do |src|
-          dest = "#{js_dest}/#{File.basename(src)}"
-          FileUtils.cp(src, dest)
+        return if cdn?
+
+        VENDORED_ASSETS.each do |relative_source, destination|
+          source = File.join(gem_root, relative_source)
+
+          unless File.file?(source)
+            raise MissingAssetError,
+              "Bootstrap #{Twitter::Bootstrap::Rails::BOOTSTRAP_VERSION} asset missing from the gem: " \
+              "#{relative_source}. The gem install looks incomplete; reinstall twitter-bootstrap-rails."
+          end
+
+          create_file destination, File.binread(source)
         end
       end
 
       def add_bootstrap
-        if use_coffeescript?
-          copy_file "bootstrap.coffee", "app/assets/javascripts/bootstrap.js.coffee"
-        else
-          copy_file "bootstrap.js", "app/assets/javascripts/bootstrap.js"
-        end
-        if use_less?
-          copy_file "bootstrap_and_overrides.less", "app/assets/stylesheets/bootstrap_and_overrides.css.less"
-        else
-          copy_file "bootstrap_and_overrides.css", "app/assets/stylesheets/bootstrap_and_overrides.css"
-        end
+        return if cdn?
+        return if propshaft?
+
+        copy_file "bootstrap.js", "app/assets/javascripts/bootstrap.js"
+        copy_file "bootstrap_and_overrides.css", "app/assets/stylesheets/bootstrap_and_overrides.css"
+      end
+
+      def add_cdn_initializer
+        return unless cdn?
+
+        create_file "config/initializers/bootstrap.rb", <<~RUBY
+          # Bootstrap's CSS and JS are loaded from jsDelivr rather than vendored into
+          # this app. `rails g bootstrap:layout` reads this to emit CDN tags by default.
+          Twitter::Bootstrap::Rails.asset_mode = :cdn
+        RUBY
       end
 
       def add_locale
-        if File.exist?("config/locales/en.bootstrap.yml")
-          localez = File.read("config/locales/en.bootstrap.yml")
-          insert_into_file "config/locales/en.bootstrap.yml", localez, :after => "en\n"
+        return if exists_in_app?("config/locales/en.bootstrap.yml")
+
+        copy_file "en.bootstrap.yml", "config/locales/en.bootstrap.yml"
+      end
+
+      def cleanup_legacy
+        return unless exists_in_app?('app/assets/stylesheets/application.css')
+
+        gsub_file("app/assets/stylesheets/application.css", %r|\s*\*=\s*twitter/bootstrap\s*\n|, "", :verbose => false)
+      end
+
+      def report
+        version = Twitter::Bootstrap::Rails::BOOTSTRAP_VERSION
+
+        if cdn?
+          say "Bootstrap #{version} will be loaded from jsDelivr. " \
+              "Run `rails g bootstrap:layout` to generate a layout with the CDN tags."
+        elsif propshaft?
+          say "Bootstrap #{version} vendored for Propshaft. " \
+              "Run `rails g bootstrap:layout` to generate a layout that links it."
         else
-          copy_file "en.bootstrap.yml", "config/locales/en.bootstrap.yml"
+          say "Bootstrap #{version} vendored into the asset pipeline."
         end
       end
 
-      def cleanup_legacy
-        gsub_file("app/assets/stylesheets/application.css", %r|\s*\*=\s*twitter/bootstrap\s*\n|, "")
-        if File.exist?('app/assets/stylesheets/bootstrap_override.css.less')
-          puts <<-EOM
-          Warning:
-            app/assets/stylesheets/bootstrap_override.css.less exists
-            It should be removed, as it has been superceded by app/assets/stylesheets/bootstrap_and_overrides.css.less
-          EOM
+      private
+
+      def cdn?
+        asset_mode == 'cdn'
+      end
+
+      def propshaft?
+        Twitter::Bootstrap::Rails.propshaft?
+      end
+
+      def gem_root
+        File.expand_path("../../../../..", __FILE__)
+      end
+
+      # Adds a Sprockets require to an existing manifest. Apps on Propshaft (the
+      # Rails 8 default) have no Sprockets directives to anchor to, so rather than
+      # letting the insert quietly fail, say what to add by hand.
+      def add_require(manifest, directive, anchor, marker)
+        content = read_from_app(manifest)
+        return if content.include?(marker)
+
+        if content.include?(anchor)
+          insert_into_file manifest, directive, :after => anchor
+        else
+          say_status :warn,
+            "#{manifest} has no `#{anchor.strip}` directive to anchor to — it is probably not a " \
+            "Sprockets manifest. Add this line yourself: #{directive.strip}",
+            :yellow
         end
       end
 
-    private
-      def use_less?
-        (defined?(Less) && (stylesheets_type!='static') ) || (stylesheets_type=='less')
+      # Paths in a generator are relative to the destination root, not the
+      # working directory, so they have to be resolved before touching the disk.
+      def exists_in_app?(relative)
+        File.exist?(File.join(destination_root, relative))
       end
 
-      def use_coffeescript?
-        return false if options[:'no-coffeescript']
-        ::Rails.configuration.app_generators.rails[:javascript_engine] == :coffee
+      def read_from_app(relative)
+        File.read(File.join(destination_root, relative))
       end
     end
   end

data/lib/generators/bootstrap/install/templates/application.js

@@ -4,5 +4,5 @@
 // It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
 // the compiled file.
 //
-//= require twitter/bootstrap
+//= require twitter/bootstrap/bootstrap.bundle.min
 //= require_tree .

data/lib/generators/bootstrap/install/templates/bootstrap.js

@@ -1,4 +1,11 @@
-jQuery(function() {
-  $("a[rel~=popover], .has-popover").popover();
-  $("a[rel~=tooltip], .has-tooltip").tooltip();
+// Bootstrap 5 has no jQuery dependency. Tooltips and popovers are opt-in, so
+// initialize the elements marked up with data-bs-toggle here.
+document.addEventListener("DOMContentLoaded", function () {
+  document.querySelectorAll('[data-bs-toggle="tooltip"]').forEach(function (el) {
+    new bootstrap.Tooltip(el);
+  });
+
+  document.querySelectorAll('[data-bs-toggle="popover"]').forEach(function (el) {
+    new bootstrap.Popover(el);
+  });
 });

data/lib/generators/bootstrap/install/templates/bootstrap_and_overrides.css

@@ -1,5 +1,5 @@
 /*
- *= require twitter-bootstrap-static/bootstrap
+ *= require twitter/bootstrap/bootstrap.min
 
-   Bootstrap 5 no longer includes Glyphicons
+   Bootstrap 5 no longer ships Glyphicons. Add your own overrides below.
 */

data/lib/generators/bootstrap/jumbotron/jumbotron_generator.rb

@@ -0,0 +1,13 @@
+require 'generators/bootstrap/snippets/snippet_base'
+
+module Bootstrap
+  module Generators
+    # Jumbotrons from https://getbootstrap.com/docs/5.3/examples/jumbotrons/
+    class JumbotronGenerator < SnippetBase
+      snippet_category "jumbotrons"
+
+      desc "Copies a Bootstrap jumbotrons snippet into your views. " \
+           "Run with --list to see the variants."
+    end
+  end
+end

data/lib/generators/bootstrap/layout/layout_generator.rb

@@ -1,20 +1,84 @@
 require 'rails/generators'
+require 'twitter/bootstrap/rails/version'
+require 'twitter/bootstrap/rails/config'
+require 'generators/bootstrap/cdn_tags'
 
 module Bootstrap
   module Generators
     class LayoutGenerator < ::Rails::Generators::Base
+      include CdnTags
+
       source_root File.expand_path("../templates", __FILE__)
-      desc "This generator generates layout file with navigation."
+      desc "This generator generates a Bootstrap #{Twitter::Bootstrap::Rails::BOOTSTRAP_VERSION} layout file with navigation."
       argument :layout_name, :type => :string, :default => "application"
 
+      class_option :cdn, :type => :boolean, :default => nil,
+                   :desc => 'Link Bootstrap from jsDelivr instead of the asset pipeline ' \
+                            '(defaults to the mode recorded by bootstrap:install)'
+      class_option :'separate-popper', :type => :boolean, :default => false,
+                   :desc => 'With --cdn, emit Popper and bootstrap.js as separate tags instead of the bundle'
+
       attr_reader :app_name
 
+      def warn_about_ignored_options
+        return unless options[:'separate-popper'] && !cdn?
+
+        say_status :warn,
+          "--separate-popper only applies with --cdn; the vendored asset pipeline ships the bundle. Ignoring.",
+          :yellow
+      end
+
       def generate_layout
         app = ::Rails.application
         @app_name = app.class.to_s.split("::").first
         ext = app.config.generators.options[:rails][:template_engine] || :erb
         template "layout.html.#{ext}", "app/views/layouts/#{layout_name}.html.#{ext}"
       end
+
+      private
+
+      def cdn?
+        return options[:cdn] unless options[:cdn].nil?
+
+        Twitter::Bootstrap::Rails.cdn?
+      end
+
+      def separate_popper?
+        options[:'separate-popper'] && cdn?
+      end
+
+      # The end-of-body CDN script tag(s): one bundle, or the Popper pair.
+      def script_tags
+        separate_popper? ? separate_popper_tags : bundle_tag
+      end
+
+      # Under Sprockets the manifests carry `require` directives, so linking
+      # "application" is enough. Propshaft has no directives, so the vendored
+      # Bootstrap files have to be named explicitly or they never load.
+      def propshaft?
+        Twitter::Bootstrap::Rails.propshaft?
+      end
+
+      def stylesheet_arguments
+        propshaft? ? '"twitter/bootstrap/bootstrap.min", "application"' : '"application"'
+      end
+
+      # Propshaft apps (Rails 8) serve their own JavaScript through importmap, so
+      # there is no "application.js" asset to link — only Bootstrap's bundle.
+      def javascript_arguments
+        propshaft? ? '"twitter/bootstrap/bootstrap.bundle.min"' : '"application"'
+      end
+
+      # Raw tags indented to sit at the right depth. Haml treats a line starting
+      # with a plain character as literal text, so it needs nothing more.
+      def indent_tags(tags, indent)
+        tags.split("\n").map { |line| "#{indent}#{line}" }.join("\n")
+      end
+
+      # Slim needs each raw HTML line introduced by a `|` text marker.
+      def slim_tags(tags, indent)
+        tags.split("\n").map { |line| "#{indent}| #{line}" }.join("\n")
+      end
     end
   end
 end

data/lib/generators/bootstrap/layout/templates/layout.html.erb

@@ -1,16 +1,17 @@
-<!DOCTYPE html>
+<!doctype html>
 <html lang="en">
   <head>
     <meta charset="utf-8">
     <meta name="viewport" content="width=device-width, initial-scale=1">
     <title><%%= content_for?(:title) ? yield(:title) : "<%= app_name %>" %></title>
     <%%= csrf_meta_tags %>
+<% if cdn? -%>
 
-    <link href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.3/dist/css/bootstrap.min.css" rel="stylesheet">
+    <%= css_tag %>
+<% else -%>
 
-    <%%= stylesheet_link_tag "application", :media => "all" %>
-
-    <%%= javascript_include_tag "application" %>
+    <%%= stylesheet_link_tag <%= stylesheet_arguments %>, :media => "all" %>
+<% end -%>
   </head>
   <body>
 
@@ -21,8 +22,8 @@
           <span class="navbar-toggler-icon"></span>
         </button>
         <div class="collapse navbar-collapse" id="navbarNav">
-          <ul class="nav navbar-nav">
-            <li><%%= link_to "Home", "/" %></li>
+          <ul class="navbar-nav">
+            <li class="nav-item"><%%= link_to "Home", "/", :class => "nav-link" %></li>
           </ul>
         </div>
       </div>
@@ -33,10 +34,14 @@
       <%%= yield %>
 
       <footer class="mt-5 py-3 border-top">
-        <p class="text-muted">&copy; Company <%= Date.today.year %></p>
+        <p class="text-body-secondary">&copy; Company <%%= Time.current.year %></p>
       </footer>
     </div>
 
-    <script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.3/dist/js/bootstrap.bundle.min.js"></script>
+<% if cdn? -%>
+<%= indent_tags(script_tags, "    ") %>
+<% else -%>
+    <%%= javascript_include_tag <%= javascript_arguments %> %>
+<% end -%>
   </body>
 </html>