hanami-reloader 0.3.0 → 1.0.0.beta3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7982adc5226a56d2d965c0ea68f74dc6b5b8939b8433cf1ea67fe356f2c97464
-  data.tar.gz: a2538faf2cc0f993c4a00db2cb992b6b0a59d27c7a07d7892fbc9f85cd4b68bb
+  metadata.gz: 99be1699345c5f4febac46c7fd5cc26c49d24604b98a049dadb0f3f2290db2a3
+  data.tar.gz: 9a53a2b068b64a9398b915180ab91b524fcd41a0b4cd7e0a583305ee33244dbf
 SHA512:
-  metadata.gz: 5d297b5099d806c23234014f81f743e2245f3d9c6a7fe1aa39c34c5f879587dc54771e5b26f2bc6fb64f885dd3b34cc5e8410ada60e65a8649e6c5bd9eaff471
-  data.tar.gz: cbdba6f6d284b02d1e37c414fc26fa15a046e64920b3dae937f3c8dedc0bf53774a53c78d8202928796d0fee229ece714be5adc4674b299a1f13dae858c6ae86
+  metadata.gz: f71bc7d05997a92cb9a7131da09d96c3045b9a3ba54d4400223a90ec7c5e6823775f747106b43fdea3867b5ca7a158fe08537efcdfe25bed4c48fc642846bae9
+  data.tar.gz: f4175e6c9448942649ae0d29011f4c4d2e5ea36b709d2b30caf8a0b6ba21f647686c17703469a38101b8f3970a4be8a959d0ffafdbee4ace3b0566ed0f6681d9

data/CHANGELOG.md

@@ -1,21 +1,55 @@
 # Hanami::Reloader
-Code reloading for Hanami
+
+Code reloading for Hanami 2
+
+## v1.0.0.beta3 - 2022-09-21
+
+### Added
+
+- [Luca Guidi] Support for Hanami 2.0
+- [Luca Guidi] Official support for Ruby 3.0 and 3.1
+
+### Changed
+
+- [Luca Guidi] Drop support for Ruby: MRI 2.5, 2.6, and 2.7.
+
+## v1.0.0.alpha1 - 2019-01-30
+
+### Added
+
+- [Luca Guidi] Added support for `hanami server --no-code-reloading` to skip code reloading.
+- [Luca Guidi] Added `hanami server --guardfile` option to specify the path to `Guardfile`. It defaults to `Guardfile` at the root of the project.
+- [Luca Guidi] Added support for `hanami generate reloader --puma` to generate Puma specific configuration.
+
+### Changed
+
+- [Luca Guidi] Drop support for Ruby: MRI 2.3, and 2.4.
+- [Luca Guidi] `hanami generate reloader` generates `Guardfile` (instead of `.hanami.server.guardfile`), with the Guard `:server` group.
+- [Luca Guidi] `hanami server` will look for `Guardfile` at the root of the project instead of `.hanami.server.guardfile`.
 
 ## v0.3.0 - 2020-02-10
+
 ### Added
+
 - [Luca Guidi] Official support for Ruby 2.7.0
 - [Luca Guidi] Official support for Ruby 2.6.0
 - [Luca Guidi] Support for `bundler` 2.0+
 
 ## v0.2.1 - 2018-01-23
+
 ### Fixed
+
 - [Luca Guidi] Avoid Guard prompt when shutting down the server
 
 ## v0.2.0 - 2017-11-24
+
 ### Changed
+
 - [Marcello Rocha] Use `.hanami.server.guardfile` instead of `Guardfile` to avoid conflicts with other `guard` plugins.
 
 ## v0.1.0 - 2017-11-01
+
 ### Added
+
 - [Luca Guidi] Added Hanami command `hanami generate reloader`
 - [Luca Guidi] Code reloading based on `guard`

data/README.md

@@ -1,73 +1,64 @@
 # Hanami::Reloader
 
-**Experimental** code reloading for Hanami.
+Reloader and testing support for [full-stack Hanami applications](`https://github.com/hanami/hanami`).
 
-## Usage
-
-### 1. Setup Hanami project
+## Status
 
-```shell
-gem install hanami
-hanami new bookshelf && cd bookshelf
-```
+[![Gem Version](https://badge.fury.io/rb/hanami-reloader.svg)](https://badge.fury.io/rb/hanami-rspec)
+[![CI](https://github.com/hanami/reloader/workflows/ci/badge.svg?branch=main)](https://github.com/hanami/rspec/actions?query=workflow%3Aci+branch%3Amain)
+[![Depfu](https://badges.depfu.com/badges/a8545fb67cf32a2c75b6227bc0821027/overview.svg)](https://depfu.com/github/hanami/reloader?project=Bundler)
 
-### 2. Prepare Gemfile
+## Version
 
-Edit `Gemfile`
+Versioning of this gem follows Reloader.
 
-  1. Remove `shotgun`
-  2. Add the following lines
+## Contact
 
-```ruby
-group :plugins do
-  gem "hanami-reloader", "~> 0.3"
-end
-```
-
-### 3. Setup hanami-reloader
-
-```shell
-bundle
-bundle exec hanami generate reloader
-```
+- Home page: http://hanamirb.org
+- Mailing List: http://hanamirb.org/mailing-list
+- Bugs/Issues: https://github.com/hanami/reloader/issues
+- Support: http://stackoverflow.com/questions/tagged/hanami
+- Chat: http://chat.hanamirb.org
 
-Now you can start the server via `bundle exec hanami server`.
+## Rubies
 
-## Upgrade Nodes
+**Hanami::Reloader** supports Ruby (MRI) 3.0+
 
-If you're upgrading from `v0.1.0` to `v0.2.0`, use `.hanami.server.guardfile` instead of `Guardfile`.
+## Installation
 
-## Puma usage
-
-If you're using `puma`, I **strongly** suggest to use `guard-puma` **alongside** with `hanami-reloader`.
-
-Add `guard-puma` to your `Gemfile`:
+Add this line to your application's Gemfile:
 
 ```ruby
-group :development do
-  gem "guard-puma"
+group :cli, :development do
+  gem "hanami-reloader"
 end
 ```
 
-Then change the group name in `.hanami.server.guardfile` from `"rack"` to `"puma"`:
+And then execute:
 
-```diff
--guard "rack", port: ENV["HANAMI_PORT"] || 2300 do
-+guard "puma", port: ENV["HANAMI_PORT"] || 2300 do
-```
+    $ bundle install
+    $ bundle exec hanami setup
 
-Now start the server as usual: `bundle exec hanami server`
+## Usage
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/jodosha/hanami-reloader.
+Bug reports and pull requests are welcome on GitHub at https://github.com/hanami/reloader. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/hanami/rspec/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the `Hanami::Reloader` project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/hanami/reloader/blob/main/CODE_OF_CONDUCT.md).
 
 ## Copyright
 
-Copyright © 2017-2018 Luca Guidi – Released under MIT License
+Copyright © 2014-2022 Hanami Team – Released under MIT License

data/hanami-reloader.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "hanami/reloader/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "hanami-reloader"
+  spec.version       = Hanami::Reloader::VERSION
+  spec.authors       = ["Luca Guidi"]
+  spec.email         = ["me@lucaguidi.com"]
+
+  spec.summary       = "Hanami reloader"
+  spec.description   = "Code reloading for Hanami"
+  spec.homepage      = "http://hanamirb.org"
+  spec.license       = "MIT"
+
+  spec.required_ruby_version = ">= 3.0"
+
+  spec.files         = `git ls-files -- lib/* CHANGELOG.md LICENSE.md README.md hanami-reloader.gemspec`.split($INPUT_RECORD_SEPARATOR) # rubocop:disable Layout/LineLength
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  spec.add_dependency "hanami-cli", "~> 2.0.beta"
+
+  spec.add_development_dependency "bundler", ">= 1.6", "< 3"
+  spec.add_development_dependency "rake",    "~> 13.0"
+  spec.add_development_dependency "rspec",   "~> 3.7"
+  spec.add_development_dependency "rubocop", "~> 1.11"
+end

data/lib/hanami/reloader/commands.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+require "hanami/cli"
+require "hanami/cli/command"
+require "hanami/cli/commands"
+require "hanami/cli/commands/app/server"
+
+module Hanami
+  module Reloader
+    module Commands
+      # Guardfile
+      module Guardfile
+        def self.group
+          "server"
+        end
+
+        def self.default_path
+          path("Guardfile")
+        end
+
+        def self.path(value)
+          value
+        end
+      end
+
+      # Generate hanami-reloader configuration
+      class Install < Hanami::CLI::Command
+        desc "Generate configuration for code reloading"
+
+        def call(*, **)
+          generate_configuration(Guardfile.default_path)
+          bundle_gems
+        end
+
+        private
+
+        def generate_configuration(path)
+          fs.write path, <<~CODE
+            # frozen_string_literal: true
+
+            group :#{Guardfile.group} do
+              guard "puma", port: ENV["HANAMI_PORT"] || 2300 do
+                watch(%r{config/*})
+                watch(%r{lib/*})
+                watch(%r{app/*})
+                watch(%r{slices/*})
+              end
+            end
+          CODE
+        end
+
+        def bundle_gems
+          fs.touch("Gemfile")
+          gemfile = fs.read("Gemfile")
+          return if gemfile.include?("guard-puma")
+
+          if gemfile.include?("group :development do")
+            fs.inject_line_at_block_bottom "Gemfile", "group :development do", <<~CODE
+              gem "guard-puma"
+            CODE
+          else
+            fs.append "Gemfile", <<~CODE
+
+              group :development do
+                gem "guard-puma"
+              end
+            CODE
+          end
+        end
+      end
+
+      # Override `hanami server` command
+      class Server < Hanami::CLI::Commands::App::Server
+        option :guardfile,      type: :string,  desc: "Path to Guardfile", default: Guardfile.default_path.to_s
+        option :code_reloading, type: :boolean, desc: "Code reloading",    default: true
+
+        example [
+          "--no-code-reloading # Disable code reloading"
+        ]
+
+        def call(**args)
+          code_reloading = args.fetch(:code_reloading)
+
+          if code_reloading
+            path = Guardfile.path(args.fetch(:guardfile))
+            exec "bundle exec guard -n f -i -g #{Guardfile.group} -G #{path}"
+          else
+            super
+          end
+        end
+      end
+    end
+  end
+end
+
+if Hanami::CLI.within_hanami_app?
+  Hanami::CLI.after "install", Hanami::Reloader::Commands::Install
+  Hanami::CLI.register "server", Hanami::Reloader::Commands::Server
+end

data/lib/hanami/reloader/version.rb

@@ -2,6 +2,6 @@
 
 module Hanami
   module Reloader
-    VERSION = "0.3.0"
+    VERSION = "1.0.0.beta3"
   end
 end

data/lib/hanami/reloader.rb

@@ -1,20 +1,9 @@
 # frozen_string_literal: true
 
-require "hanami/cli/commands"
-require "hanami/utils"
-
 module Hanami
-  module Utils # rubocop:disable Style/Documentation
-    # Monkey-patch `Hanami::Utils.reload!` to disable Ruby based code-reloading
-    def self.reload!(directory)
-      require!(directory)
-      warn "Requiring #{directory}"
-    end
-  end
-
-  # Hanami::Reloader
+  # Hanami reloader
   module Reloader
-    require "hanami/reloader/version"
-    require "hanami/reloader/cli"
+    require_relative "reloader/version"
+    require_relative "reloader/commands"
   end
 end

metadata

@@ -1,43 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: hanami-reloader
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.0.beta3
 platform: ruby
 authors:
 - Luca Guidi
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-02-10 00:00:00.000000000 Z
+date: 2022-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: hanami
+  name: hanami-cli
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 2.0.beta
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
-- !ruby/object:Gem::Dependency
-  name: guard-rack
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.2'
+        version: 2.0.beta
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -64,14 +50,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -86,6 +72,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
 description: Code reloading for Hanami
 email:
 - me@lucaguidi.com
@@ -96,16 +96,18 @@ files:
 - CHANGELOG.md
 - LICENSE.md
 - README.md
+- hanami-reloader.gemspec
 - lib/hanami-reloader.rb
 - lib/hanami/reloader.rb
-- lib/hanami/reloader/cli.rb
+- lib/hanami/reloader/commands.rb
 - lib/hanami/reloader/version.rb
 homepage: http://hanamirb.org
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -113,15 +115,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.3.3
+signing_key:
 specification_version: 4
 summary: Hanami reloader
 test_files: []

data/lib/hanami/reloader/cli.rb

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-module Hanami
-  module Reloader
-    module CLI
-      # Generate hanami-reloader configuration
-      class Generate < Hanami::CLI::Commands::Command
-        requires "environment"
-
-        desc "Generate configuration for code reloading"
-
-        def call(*)
-          path = Hanami.root.join(".hanami.server.guardfile")
-
-          files.touch(path)
-          files.append path, <<~CODE
-            guard "rack", port: ENV["HANAMI_PORT"] || 2300 do
-              watch(%r{config/*})
-              watch(%r{lib/*})
-              watch(%r{apps/*})
-            end
-CODE
-        end
-      end
-
-      # Override `hanami server` command
-      class Server < Hanami::CLI::Commands::Command
-        desc "Starts the server with code reloading (only development) reloader"
-
-        def call(*)
-          exec "bundle exec guard -n f -i -G .hanami.server.guardfile"
-        end
-      end
-    end
-  end
-end
-
-Hanami::CLI.register "generate reloader", Hanami::Reloader::CLI::Generate
-Hanami::CLI.register "server",            Hanami::Reloader::CLI::Server