rails_server_hotkeys 1.1.1 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dcf7eece0e781456e10984440dacaa89d63f1c8a2d5e253b3e46edbb8777bd36
-  data.tar.gz: 25f0dc57f124910142dfef2d37789e772faf26b04ea00c564bb3adfaa2e84072
+  metadata.gz: f8e336ec5e54b395fb44b4767fb7d650b49bca4fe38ff53914cd2fc46def2c21
+  data.tar.gz: 3d5d3d0a15856c3bbd6c3da17dbd7d3107ced472ac0d3465ef7a4ecabdc759e2
 SHA512:
-  metadata.gz: bbd24268025046933f74dc66a92a6359c79253cb39b33dbf3eac561ec91619c0b5931fe90e36a17f11a9d393313610395a33b30af37600101ec5cfd88680ddf4
-  data.tar.gz: 8c259bab6875bdbeb776e5ee0e5ec89c46abd65ca6843d4bbeece9c4513cba5687e00bfec2d55451b78b9af90728f158f0b756f01c492467ecba2845090e9163
+  metadata.gz: e1fccacb084b745b9a172005bb92b448b69c317dfee788b03d3ea7a5b2f21193927ffdc80122a0e56a306bfc2f65a0e6bc485b9793dcecc36f9e85d75d848e9c
+  data.tar.gz: 044a1c4f63752edcb3a77f7e63fa0d42cdcb9685efed0b3e3a0e6fbdece1a7a0859e90207ef4db2004b2cc4c9c05f94b3a4dc5719da4c97f195f050e8cd38b94

data/CHANGELOG.md

@@ -6,6 +6,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/).
 
 ## [Unreleased]
 
+## [1.1.2] - 2026-11-01
+
+### Fixed
+- With Puma 5, the banner was printed before Puma's boot log instead of after `Use Ctrl-C to stop`.
+
 ## [1.1.1] - 2026-10-31
 
 ### Changed
@@ -22,6 +27,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/).
 - `o` opens the port the server is actually listening on.
 - Banner shown after Puma's "Use Ctrl-C to stop".
 
-[Unreleased]: https://github.com/samuelpismel/rails_server_hotkeys/compare/v1.1.1...HEAD
+[Unreleased]: https://github.com/samuelpismel/rails_server_hotkeys/compare/v1.1.2...HEAD
+[1.1.2]: https://github.com/samuelpismel/rails_server_hotkeys/compare/v1.1.1...v1.1.2
 [1.1.1]: https://github.com/samuelpismel/rails_server_hotkeys/compare/v1.1.0...v1.1.1
 [1.1.0]: https://github.com/samuelpismel/rails_server_hotkeys/releases/tag/v1.1.0

data/README.md

@@ -1,6 +1,8 @@
 # rails_server_hotkeys
 
-Expo-style keyboard shortcuts for `bin/rails server`. Press `r` to restart the server — no more `touch tmp/restart.txt` in another terminal.
+Keyboard shortcuts for `bin/rails server`.
+
+Press `r` to restart the server. No more `touch tmp/restart.txt` in another terminal.
 
 ```
 => Booting Puma
@@ -71,6 +73,7 @@ Only for `rails server`, in the `development` environment, when stdin is a termi
 
 ## Caveats
 
+- **Your `config.ru` must call `Rails.application.load_server`.** Rails has generated it since 6.1; apps created on older versions may lack it, and then the gem does nothing. Add it after `run Rails.application`.
 - **Restart needs Puma's `tmp_restart` plugin.** It's in the `config/puma.rb` generated by Rails; if yours lacks it, add `plugin :tmp_restart`.
 - **`bin/dev` (foreman) doesn't forward stdin**, so hotkeys can't work there. Run `bin/rails s` directly, or use overmind and `overmind connect web`.
 - **Unix/macOS only** (uses `stty`). On Windows the gem does nothing.
@@ -82,6 +85,17 @@ bundle install
 bundle exec rake test
 ```
 
+### Rails and Puma versions
+
+`rake test:matrix` boots a real `bin/rails server` in a pseudo-terminal for each Rails/Puma combination in `gemfiles/` and checks the banner, `r` and `q`:
+
+```sh
+bundle exec rake test:matrix
+bundle exec rake test:matrix GEMFILES=rails_8.1   # only matching gemfiles
+```
+
+The first run installs each bundle, so it takes a while. To add a combination, copy one of the files in `gemfiles/`.
+
 ### Trying it in a dummy app
 
 The unit tests run without Rails, but hotkeys only show up for real under `rails server` in a terminal. To try your changes by hand, create a throwaway app next to the gem:
@@ -93,7 +107,7 @@ rails new hotkeys-dummy --minimal --skip-git
 cd hotkeys-dummy
 
 # Point the app at your local copy of the gem
-echo 'gem "rails_hotkeys", path: "../restart-rails-hotkeys", group: :development' >> Gemfile
+echo 'gem "rails_server_hotkeys", path: "../restart-rails-hotkeys", group: :development' >> Gemfile
 bundle install
 
 bin/rails s
@@ -101,7 +115,7 @@ bin/rails s
 
 Adjust the `path:` if your clone has a different folder name.
 
-You should see this in light blue, right after Puma's `Use Ctrl-C to stop`:
+You should see this in green, right after Puma's `Use Ctrl-C to stop`:
 
 ```
 › Press r to restart, h for help
@@ -117,6 +131,14 @@ Things to check:
 
 Because the gem is loaded through `path:`, edits to it take effect on the next restart: press `r` instead of stopping the server. You don't need to run `bundle install` again unless you change the gemspec.
 
+## Acknowledgments
+
+Inspired by the keyboard shortcuts in [Expo CLI](https://docs.expo.dev/more/expo-cli/).
+
+## A note to the Rails team
+
+If you find this useful, feel free to bring the idea into Rails itself.
+
 ## License
 
 MIT

data/lib/rails_server_hotkeys/boot_hook.rb

@@ -18,9 +18,12 @@ module RailsServerHotkeys
     end
 
     # When Rails runs server blocks, the Puma handler is chosen but
-    # Puma::Events isn't required yet.
+    # Puma::Events isn't required yet. Puma 5's handler only defines
+    # Rack::Handler::Puma, so ::Puma itself may not exist yet either.
     def self.load_puma_events
-      require "puma/events" if defined?(Puma) && !defined?(Puma::Events)
+      return if defined?(::Puma::Events)
+
+      require "puma/events" if defined?(::Puma) || defined?(::Rack::Handler::Puma)
     rescue LoadError
       nil
     end

data/lib/rails_server_hotkeys/version.rb

@@ -1,3 +1,3 @@
 module RailsServerHotkeys
-  VERSION = "1.1.1"
+  VERSION = "1.1.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_server_hotkeys
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.2
 platform: ruby
 authors:
 - Samuel Gavassi Pismel