bun_bun_bundle 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c51a065b214293e85467dfdd10f2c84bf763f65fe27d0b549b175ea7448563bf
-  data.tar.gz: f2d86b5d3650797b617fa3ecee6d3dac119d97850749bc830172bfa12cb83dfe
+  metadata.gz: 74f92b0b7b6bf9ae9cba639bcd548cf447e89ac55d14a121b55926677a75658b
+  data.tar.gz: d50ffe4d0477df3390702c9ee1c7797a63e4d3ab32cd4e885db340f12516973f
 SHA512:
-  metadata.gz: c87530160b4f6829e32f7fc82c4f0d9180aa13b03089011fdb237d8daa4973453bd9cd074bd0402736f7fcab49e7d40c98f9b7fbb1a094aa07f718cd94ca9ac4
-  data.tar.gz: 0cbad61b7eff7af29f38cab146f09941a8f3dbd9354a1c470d36a35f94bbb36484543f7a06ef27e4810f2a1f51becb00026c7206de30e6b0049334cd224127fd
+  metadata.gz: 1b34424077d7ffb800d89c0a1790278524a5c1ea2640c38eefd5f9c6a4c2f7c7fa6e42a06ee08a4082889cb9f524b0ae7594e0da5914d9e29d7d19085c79e194
+  data.tar.gz: c7d5c0f4b24c2025c12ad3f1c33a7933f8806bc13a3a0f7e1f6d3b2c3b31fd048237ad5dbb1b07b3686f2d1e196808ddbb99fc08ae9e7552f01826bb211c7eaf

data/README.md

@@ -1,9 +1,9 @@
-# BunBunBundle
+# Bun, Bun, Bundle
 
 A self-contained asset bundler for Ruby powered by [Bun](https://bun.sh). No
-development dependencies, no complex configuration. Fast builds with CSS
-hot-reloading, fingerprinting, live reload, and a flexible plugin system. Works
-with Rails, Hanami, or any Rack app.
+development dependencies, no complex configuration. Lightning fast builds with
+CSS hot-reloading, fingerprinting, live reload, and a flexible plugin system.
+Works with Rails, Hanami, or any Rack app.
 
 ## Why use BunBunBundle?
 
@@ -28,18 +28,18 @@ browsers always fetch the right version.
 
 Development and production builds go through the exact same pipeline. The only
 differences are fingerprinting and minification being enabled in production,
-but nothing is holding you back form them in development as well.
+but nothing is holding you back from enabling them in development as well.
 
 ### Extensible plugin system
 
-Comes with built-in plugins for CSS glob imports, root aliases, and JS glob
-imports. Plugins are simple, plain JS files, so you can create your own JS/CSS
-transformers, and raw Bun plugins are supported as well.
+BunBunBundle comes with built-in plugins for CSS glob imports, root aliases,
+and JS glob imports. Plugins are simple, plain JS files, so you can create your
+own JS/CSS transformers, and raw Bun plugins are supported as well.
 
 ### Just one dependency: Bun
 
-The bundler ships with the gem. Bun is the only external requirement, so there
-are zero dev dependencies.
+The bundler ships with the gem. Bun is the only external requirement, so other
+than that, there are no dev dependencies.
 
 ## Installation
 
@@ -59,6 +59,18 @@ are zero dev dependencies.
 
 ## Usage with Rails
 
+BunBunBundle completely bypasses the Rails asset pipeline. If you're adding it
+to an existing app, you can remove Sprockets/Propshaft:
+
+- Remove `gem 'sprockets-rails'` or `gem 'propshaft'` from your `Gemfile`
+- Delete `config/initializers/assets.rb` if present
+
+For new apps, generate them without the asset pipeline:
+
+```sh
+rails new myapp --minimal --skip-asset-pipeline --skip-javascript
+```
+
 The gem auto-configures itself through a Railtie. All helpers are available in
 your views immediately:
 
@@ -81,7 +93,13 @@ stale asset caching.
 
 ## Usage with Hanami
 
-1. Require the Hanami integration:
+Hanami ships with its own esbuild-based asset pipeline. Since BunBunBundle
+replaces it entirely, you can clean up the default setup:
+
+- Remove `gem 'hanami-assets'` from your `Gemfile`
+- Delete `config/assets.js`, `package.json`, and `node_modules/`
+
+1. Set up the Hanami integration:
 
    ```ruby
    # config/app.rb
@@ -90,12 +108,15 @@ stale asset caching.
 
    module MyApp
      class App < Hanami::App
-       BunBunBundle.setup(root: root)
-       config.middleware.use BunBunBundle::DevCacheMiddleware if Hanami.env?(:development)
+       BunBunBundle.setup(root: root, hanami: config)
      end
    end
    ```
 
+   This loads the manifest, and in development automatically registers the
+   cache-busting middleware and configures the CSP to allow the live reload
+   script and WebSocket connection.
+
 2. Include the helpers in your views:
 
    ```ruby
@@ -111,7 +132,7 @@ stale asset caching.
    end
    ```
 
-4. Use them in your templates:
+3. Use them in your templates:
 
    ```erb
    <%= bun_css_tag('css/app.css') %>
@@ -132,7 +153,8 @@ BunBunBundle.asset_host = 'https://cdn.example.com'
 
 ## Helpers
 
-All helpers are prefixed with `bun_` to avoid conflicts with framework helpers:
+All helpers are prefixed with `bun_` to avoid conflicts with existing framework
+helpers:
 
 | Helper                           | Description                                      |
 | -------------------------------- | ------------------------------------------------ |
@@ -191,7 +213,7 @@ Place a `config/bun.json` in your project root:
 }
 ```
 
-All values shown above are defaults, you only need to specify what you want to
+All values shown above are defaults. You only need to specify what you want to
 override.
 
 ## Plugins
@@ -252,8 +274,8 @@ your-app/
 
 BunBunBundle was originally built for [Fluck](https://fluck.site), a
 self-hostable website builder using [Lucky
-Framework](https://luckyframework.org/). I wanted to have a fast, comprehensive
-asset bundler that would not require too much maintenance in the long term.
+Framework](https://luckyframework.org/). I wanted to have a fast and modern
+asset bundler that would require minimal maintenance in the long term.
 
 Bun was the natural choice because it does almost everything:
 
@@ -265,10 +287,10 @@ Bun was the natural choice because it does almost everything:
 - Extendability with simple plugins
 
 It's also fast and reliable. We use this setup heavily in two Lucky apps and it
-is rock solid, and it has since been adopted by Lucky as the default builder.
+is rock solid. It has since been adopted by Lucky as the default builder.
 
-I wanted to have the same setup in my Ruby apps as well, that's when this Gem
-was born. I hope you enjoy it too!
+This Gem was born because I wanted to have the same setup in my Ruby apps as
+well. I hope you enjoy it too!
 
 ## Contributing
 

data/lib/bun_bun_bundle/hanami.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'bun_bun_bundle'
+
 module BunBunBundle
   # Hanami integration for BunBunBundle.
   #
@@ -9,8 +11,7 @@ module BunBunBundle
   #
   #   module MyApp
   #     class App < Hanami::App
-  #       BunBunBundle.setup(root: root)
-  #       config.middleware.use BunBunBundle::DevCacheMiddleware if Hanami.env?(:development)
+  #       BunBunBundle.setup(root: root, hanami: config)
   #     end
   #   end
   #

data/lib/bun_bun_bundle/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BunBunBundle
-  VERSION = '0.1.2'
+  VERSION = '0.2.0'
 end

data/lib/bun_bun_bundle.rb

@@ -38,10 +38,15 @@ module BunBunBundle
 
     # Loads config and manifest. Call this from Hanami's config/app.rb or
     # any Rack app's startup.
-    def setup(root: Dir.pwd)
+    #
+    # Pass `hanami: config` from within a Hanami::App class body to
+    # automatically register middleware and configure CSP for development.
+    def setup(root: Dir.pwd, hanami: nil)
       self.config = Config.load(root: root.to_s)
       options = development? ? {} : { retries: 1, delay: 0 }
       self.manifest = Manifest.load(root: root.to_s, **options)
+
+      configure_hanami(hanami) if hanami
     end
 
     # Returns the path to the bundled JS files shipped with the gem.
@@ -56,6 +61,16 @@ module BunBunBundle
       @asset_host = nil
       @environment = nil
     end
+
+    private
+
+    def configure_hanami(hanami_config)
+      return unless development?
+
+      hanami_config.middleware.use DevCacheMiddleware
+      hanami_config.actions.content_security_policy[:script_src] += " 'unsafe-inline'"
+      hanami_config.actions.content_security_policy[:connect_src] += " #{config.dev_server.ws_url}"
+    end
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bun_bun_bundle
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Wout Fierens