twitter-bootstrap-rails 5.3.1 → 5.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 91f5452759739c85c9a83fb03127e22cd959aa4f0818a42cd4991fa1b101af9d
-  data.tar.gz: 4ffcbb99b350e7733cb7275f67b494df9195229a4a8114e5168850a67bfdf199
+  metadata.gz: c179497e697969f22082029863a8961ef3bc5c662c7b62a108238dd14b72a9ac
+  data.tar.gz: 2500bd3b9f13b5a44d3a7403e9ab48b0d995ac9ede9605a21ffcf7257cd67dc2
 SHA512:
-  metadata.gz: b10358a115e431626ad9d0ef2b59088db059f8ecb654ea46639fd944363b21ef773bb1e966df5b40f102dea2cd76e59262343a848afcc38a7ad58d36b93d24bc
-  data.tar.gz: 56b8e90b7a75b0060acd5d47c08837f719a2161445b7f9445d16995c78224784684d0998e14a18da7af59c0465aa48cba0ec5d27b878fbce9f840d5ae4df5cc0
+  metadata.gz: b394fbf43caa16b0288e3357ec3c47745e1dc10c19149f18040a463165c0ca9a2e2843108db50c821941b01f800eb97f449e918056127ae90473cd39f466c8e7
+  data.tar.gz: 1c51ce6849e58c49b9017ac95d7b58bff2c44bb6b23eff6137120f43450cf645a9328d9218ec83c842c99885ae51b5f8453a2c96aa33cd90ab2f6bfba942b578

data/CHANGELOG.md

@@ -1,3 +1,82 @@
+## 5.4.0
+
+Bootstrap **5.3.8**. The gem version no longer tracks the Bootstrap version;
+`Twitter::Bootstrap::Rails::BOOTSTRAP_VERSION` is the authoritative statement of
+which Bootstrap ships.
+
+### Breaking changes
+
+- **Less is gone.** The `rails g bootstrap:install less` argument, the
+  `bootstrap_and_overrides.less` template, the Bootstrap 3 Less sources under
+  `vendor/toolkit` and `vendor/static-source`, and the `less-rails` and `execjs`
+  dependencies have all been removed. Bootstrap 5 has no Less build.
+- **Glyphicons are gone.** `GlyphHelper#glyph` and the
+  `glyphicons-halflings-regular` font files have been removed. Bootstrap dropped
+  Glyphicons in v4; the helper emitted markup for icons that no longer resolve.
+- **CoffeeScript support removed**, along with the `--no-coffeescript` option and
+  the `bootstrap.coffee` template.
+- `rails g bootstrap:install` now takes `static` (default) or `cdn`.
+
+### Fixed
+
+- `vendor/assets/stylesheets/twitter-bootstrap-static/bootstrap.css.erb` was
+  **Bootstrap 3.1.1** while occupying the same logical asset path as the
+  Bootstrap 5 file in `app/assets`. Whichever the asset pipeline resolved first
+  won. The stale Bootstrap 3 copy has been deleted.
+- `bootstrap:install` checked `File.exist?` on paths relative to the working
+  directory rather than the destination root, so an app's existing
+  `application.js` / `application.css` were never detected and were overwritten
+  with the gem's template instead of having a require line inserted.
+- `bootstrap:install` now raises a clear error when a vendored dist file is
+  missing from the gem, instead of creating empty directories and copying nothing.
+- **`bootstrap:install static` shipped no Bootstrap at all on Rails 8.** Propshaft
+  (the Rails 8 default) has no Sprockets directives — a `//= require` line in a
+  manifest is an inert comment, served verbatim to the browser. The documented
+  default flow produced a completely unstyled app. `bootstrap:install` now detects
+  the pipeline: on Propshaft it vendors the dist files and skips the meaningless
+  manifests, and `bootstrap:layout` links them explicitly with
+  `stylesheet_link_tag "twitter/bootstrap/bootstrap.min"` /
+  `javascript_include_tag "twitter/bootstrap/bootstrap.bundle.min"`. Sprockets
+  apps keep the manifest `require` behaviour.
+- On Sprockets apps whose `application.css` has no `require_self` directive to
+  anchor to, the require insertion silently did nothing. The generator now
+  prints the line to add by hand.
+- `add_locale` re-inserted the locale file's own contents into itself when
+  `config/locales/en.bootstrap.yml` already existed.
+- The generated layout loaded Bootstrap twice — a hardcoded CDN link *and*
+  `stylesheet_link_tag "application"`. It now emits one or the other.
+- The `bootstrap.js` template called jQuery `.tooltip()` / `.popover()`, which
+  has not worked since Bootstrap 4. It now uses the Bootstrap 5 JS API.
+- The Haml and Slim layouts still emitted Bootstrap 3 markup (`navbar-default`,
+  `.well`, `.icon-bar`) and an IE6-8 html5shiv. Both now match the ERB layout.
+
+### Added
+
+- **Snippet generators.** Every snippet published at
+  [getbootstrap.com/docs/5.3/examples](https://getbootstrap.com/docs/5.3/examples/)
+  — 62 variants across 12 categories — is now a command that writes an `.html.erb`
+  partial: `bootstrap:header`, `bootstrap:hero`, `bootstrap:features`,
+  `bootstrap:sidebar`, `bootstrap:footer`, `bootstrap:dropdown`,
+  `bootstrap:list_group`, `bootstrap:modal`, `bootstrap:badge`,
+  `bootstrap:breadcrumb`, `bootstrap:button`, and `bootstrap:jumbotron`.
+  Each takes a variant name (`rails g bootstrap:header dark_search`), defaults to
+  the first variant on the docs page, and supports `--list`, `--as`, `--path`,
+  and `--no-icons`. Variant order matches the docs page order.
+- Snippets that reference placeholder images from the Bootstrap docs site (which
+  404 in a generated app) now warn at generate time instead of failing silently.
+- The Bootstrap Icons sprite used by 36 of those snippets ships as
+  `_bootstrap_icons.html.erb`, installed automatically alongside any snippet that
+  needs it. Render it once in your layout.
+- `rails g bootstrap:starter` — writes the starter template from the Bootstrap
+  docs to `public/bootstrap-starter.html` (`--path` to override).
+- `rails g bootstrap:cdn` — prints the CDN tags for pasting into your own layout.
+  `--css`, `--js`, `--separate-popper`.
+- `rails g bootstrap:layout --cdn` — link Bootstrap from jsDelivr with Subresource
+  Integrity instead of the asset pipeline. `--separate-popper` emits the Popper +
+  `bootstrap.js` pair instead of the bundle.
+- `rails g bootstrap:install cdn` — records CDN mode in
+  `config/initializers/bootstrap.rb`, which `bootstrap:layout` then defaults to.
+
 <ul>
   <li>Version 5.3.1 - Documentation and packaging updates only; no library code changes since 5.3.0</li>
   <li>Version 5.3.0 - Bootstrap 5.3 assets, new generators, static asset fixes, requires Ruby >= 3.0, less-rails ~> 4.0</li>

data/README.md

@@ -5,7 +5,7 @@
 [![GitHub forks](https://img.shields.io/github/forks/seyhunak/twitter-bootstrap-rails.svg)](https://github.com/seyhunak/twitter-bootstrap-rails/network)
 [![GitHub issues](https://img.shields.io/github/issues/seyhunak/twitter-bootstrap-rails.svg)](https://github.com/seyhunak/twitter-bootstrap-rails/issues)
 
-Integrates Bootstrap 5 into Rails Asset Pipeline. Supports Rails 8, 7, 6, 5.
+Integrates Bootstrap 5.3.8 into Rails Asset Pipeline. Supports Rails 8, 7, 6, 5.
 
 ## Install
 
@@ -21,19 +21,121 @@ rails generate bootstrap:install static
 
 ## Generators
 
+Every code snippet on the
+[Bootstrap 5.3 Introduction page](https://getbootstrap.com/docs/5.3/getting-started/introduction/)
+is reproducible from a command:
+
+| Docs snippet | Command |
+|---|---|
+| Starter template | `rails g bootstrap:starter` |
+| CDN CSS `<link>` | `rails g bootstrap:cdn --css` |
+| CDN JS bundle `<script>` | `rails g bootstrap:cdn --js` |
+| Popper + `bootstrap.js` separately | `rails g bootstrap:cdn --separate-popper` |
+| Important globals (doctype, `lang`, viewport) | baked into every generated layout and the starter template |
+
 ```bash
-# Install Bootstrap assets
+# Install Bootstrap assets into the asset pipeline
 rails g bootstrap:install static
 
-# Generate Bootstrap layout
+# ...or load Bootstrap from the jsDelivr CDN instead
+rails g bootstrap:install cdn
+
+# Generate a Bootstrap layout
 rails g bootstrap:layout application
 
+# ...linking Bootstrap from the CDN, with Subresource Integrity
+rails g bootstrap:layout application --cdn
+
+# ...using Popper and bootstrap.js separately rather than the bundle
+rails g bootstrap:layout application --cdn --separate-popper
+
+# Write the starter template from the Bootstrap docs
+rails g bootstrap:starter                    # -> public/bootstrap-starter.html
+rails g bootstrap:starter --path=public/demo.html
+
+# Print CDN tags to paste into a layout you already own (writes nothing)
+rails g bootstrap:cdn
+
 # Generate themed views for scaffold
 rails g scaffold Task title:string done:boolean
 rails db:migrate
 rails g bootstrap:themed Tasks
 ```
 
+`bootstrap:install cdn` records the choice in `config/initializers/bootstrap.rb`,
+so `bootstrap:layout` emits CDN tags by default afterwards. Pass `--cdn` or
+`--no-cdn` to override it per run.
+
+Both asset pipelines are supported. On **Sprockets**, `static` adds `require`
+directives to your manifests. On **Propshaft** (the Rails 8 default) there are no
+directives to add, so the generated layout links the vendored files directly —
+run `rails g bootstrap:layout` after `bootstrap:install static` either way.
+
+The Bootstrap version and its CDN URLs and integrity hashes live in one place,
+`Twitter::Bootstrap::Rails::BOOTSTRAP_CDN`. No template hardcodes them.
+
+## Snippets
+
+Every snippet published at
+[getbootstrap.com/docs/5.3/examples](https://getbootstrap.com/docs/5.3/examples/)
+— 62 of them across 12 categories — is a command. Each writes an `.html.erb`
+partial into `app/views/shared/`:
+
+```bash
+rails g bootstrap:header               # the first variant, "centered"
+rails g bootstrap:header dark_search   # a specific variant
+rails g bootstrap:header --list        # what's available, with descriptions
+```
+
+| Command | Variants |
+|---|---|
+| `rails g bootstrap:header` | `centered`, `nav_pills`, `with_auth_buttons`, `dark_search`, `light_search`, `grid_dropdown`, `double`, `dark_double` |
+| `rails g bootstrap:hero` | `centered`, `centered_screenshot`, `with_image`, `signup_form`, `cropped_image`, `dark` |
+| `rails g bootstrap:features` | `columns_with_icons`, `hanging_icons`, `custom_cards`, `icon_grid`, `with_title` |
+| `rails g bootstrap:sidebar` | `dark`, `light`, `icon_only`, `collapsible`, `list_group` |
+| `rails g bootstrap:footer` | `simple`, `with_brand`, `with_nav`, `columns`, `with_newsletter` |
+| `rails g bootstrap:dropdown` | `simple`, `with_search`, `with_icons`, `calendar`, `mega_menu` |
+| `rails g bootstrap:list_group` | `with_avatars`, `checkboxes`, `checkboxes_expanded`, `checkable`, `radios` |
+| `rails g bootstrap:modal` | `sheet`, `confirm`, `whats_new`, `signup` |
+| `rails g bootstrap:badge` | `pills`, `subtle`, `subtle_bordered`, `with_avatar`, `with_icons`, `with_avatar_divider` |
+| `rails g bootstrap:breadcrumb` | `basic`, `with_icons`, `chevron`, `custom` |
+| `rails g bootstrap:button` | `pills`, `grid`, `with_icons`, `loading`, `circle` |
+| `rails g bootstrap:jumbotron` | `with_icon`, `placeholder`, `full_width`, `basic` |
+
+Variants are listed in the order they appear on the docs page, so the first one
+in each row is the first example Bootstrap shows.
+
+Options, on every snippet command:
+
+| Option | Effect |
+|---|---|
+| `--list` | Print the variants with descriptions and exit, writing nothing |
+| `--as=NAME` | Partial name to write (default: the generator name) |
+| `--path=DIR` | Where to write it (default: `app/views/shared`) |
+| `--no-icons` | Skip installing the shared icon sprite |
+
+```bash
+rails g bootstrap:footer columns --as=site_footer --path=app/views/layouts
+# -> app/views/layouts/_site_footer.html.erb
+```
+
+### Placeholder images
+
+Five snippets (`hero centered`, `hero centered_screenshot`, `hero with_image`,
+`hero cropped_image`, `features custom_cards`) reference placeholder images that
+only exist on Bootstrap's docs site, so they 404 until you point them at your own
+assets. The generator warns you when you pick one.
+
+### Icons
+
+36 of the 62 snippets use Bootstrap Icons through an SVG sprite. Those commands
+also write `_bootstrap_icons.html.erb` next to the partial. Render it **once**,
+near the top of `<body>` in your layout, or those icons come out as empty boxes:
+
+```erb
+<%= render "shared/bootstrap_icons" %>
+```
+
 ## Quick Start
 
 ```bash
@@ -49,6 +151,50 @@ rails generate bootstrap:layout application
 rails server
 ```
 
+Run `bootstrap:layout` even if you already have a layout — that step is what puts
+Bootstrap's CSS and JS on the page.
+
+## Upgrading to 5.4.0
+
+5.4.0 is a breaking release:
+
+- **Less is gone.** `rails g bootstrap:install less` no longer exists; the
+  argument is now `static` (default) or `cdn`. Bootstrap 5 has no Less build, and
+  the `less-rails` and `execjs` dependencies have been dropped.
+- **Glyphicons are gone**, including the `glyph` helper. Bootstrap dropped them in
+  v4. The snippet generators ship Bootstrap Icons instead.
+- **CoffeeScript support is gone**, along with `--no-coffeescript`.
+- The gem version no longer tracks the Bootstrap version.
+  `Twitter::Bootstrap::Rails::BOOTSTRAP_VERSION` says which Bootstrap ships.
+
+If you are on Rails 8, note that `bootstrap:install static` previously left
+Propshaft apps with no Bootstrap at all — that is fixed here. See the
+[CHANGELOG](CHANGELOG.md) for the full list.
+
+## Buy me a Coffee
+## ☕ Support the Project
+
+[![Buy Me A Coffee](https://img.shields.io/badge/Buy%20Me%20a%20Coffee-FFDD00?style=for-the-badge&logo=buymeacoffee&logoColor=000000)](https://www.buymeacoffee.com/seyhunak)
+
+## Contributors
+
+Thanks to all contributors who are helping to make better.
+
+<a href="https://github.com/seyhunak/twitter-bootstrap-rails/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=seyhunak/twitter-bootstrap-rails" />
+</a>
+
+### Star History
+
+<a href="https://www.star-history.com/#seyhunak/twitter-bootstrap-rails&Date">
+ <picture>
+   <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=seyhunak/twitter-bootstrap-rails&type=Date&theme=dark" />
+   <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=seyhunak/twitter-bootstrap-rails&type=Date" />
+   <img alt="Star history of seyhunak/twitter-bootstrap-rails over time" src="https://api.star-history.com/svg?repos=seyhunak/twitter-bootstrap-rails&type=Date" />
+ </picture>
+</a>
+
+
 ## License
 
 MIT