rails_hotreload 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1b8d3ad2ecb83d63ffe91f99a7cd7d7029390557372a3f3c24499b24b22a1346
+  data.tar.gz: 06cb7737098ce18004281217a912ae6715c71970c5e288c6cde8ffc12437f1b5
+SHA512:
+  metadata.gz: 9307bf9a5ce9e303b3c967f6aa17eb378da34fc44885a4ff50592a0d3d78bd22919a246b3286bd376d9774c19eee824de9dbbe69c5241459af0fe16f78981a04
+  data.tar.gz: 505f5fedba775e09c811c3a1997146b236622b1879706b0b67d2abaa4d3bab3aa1dcfed48f3fde00fbb8fbc6a91df50edb20fcffe896bfca967d7491d08f9338

data/README.md

@@ -0,0 +1,56 @@
+# RailsHotreload
+
+This gem adds hot reloading feature to Rails applications that contains hotwire. The application is automatically reloaded when:
+- Any file has changed (added, updated or deleted) in `app/assets/builds`
+- Any app view was changed (added, updated or deleted) in `app/views`
+
+## Dependencies
+- This Gem depends on (turbo-rails)[https://github.com/hotwired/turbo-rails] to automatically stream reload message when file changes were detected
+- This Gem depends on (listen)[https://github.com/guard/listen] to detect file changes
+
+## Installation
+- Add this line to your application's Gemfile:
+```ruby
+group :development, :test do
+  gem "rails_hotreload"
+end
+```
+- And then execute:
+```bash
+$ bundle
+```
+- Include this template in your layout
+```ruby
+= render '/rails_hotreload/stream'
+```
+
+- Start the file watcher
+```
+bin/rails rails_hotreload:start
+```
+Note: If your project is using Procfile.dev (Foreman), then you can add:
+```
+rails_hotreload: bin/rails rails_hotreload:start
+```
+- Start your rails application and 
+
+## Configuration
+- This gem by default is watching changes in: `app/assets/builds,app/views/`. This can be customized as the following: 
+```
+bin/rails rails_hotreload:start app/javascripts,app/stylesheets,app/views/
+```
+- The hot reloader UI can be customized as the following:
+```
+= render '/rails_hotreload/stream', custom_style: 'right: 20px; top: 20px;'
+```
+
+## Contributing
+Bug reports and pull requests are welcome on GitHub at https://github.com/owen2345/pub_sub_model_sync. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.    
+You can run the tests with: `docker-compose run test bash`
+
+## 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 PubSubModelSync project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/pub_sub_model_sync/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+
+require 'bundler/gem_tasks'

data/lib/rails_hotreload/railtie.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'rails'
+module RailsHotreload
+  class Railtie < ::Rails::Railtie
+    railtie_name :rails_hotreload
+
+    rake_tasks do
+      load 'rails_hotreload/lib/tasks/rails_hotreload_tasks.rake'
+    end
+
+    config.before_initialize do |app|
+      app.config.paths['app/views'].unshift(File.join(__dir__, 'views').to_s)
+    end
+  end
+end

data/lib/rails_hotreload/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RailsHotreload
+  VERSION = '0.1.0'
+end

data/lib/rails_hotreload/views/rails_hotreload/_stream.html.erb

@@ -0,0 +1,13 @@
+<div id="rails_hotreload" style="position: fixed; bottom: 0; left: 0; background: red; padding: 3px; font-size: 10px; <%= local_assigns[:custom_style] %>">
+  <%= turbo_stream_from 'rails_hotreload' %>
+  <span>Hot-reloading: <input type="checkbox" style="vertical-align: middle;" checked></span>
+  <script type="text/javascript">
+    window.addEventListener('DOMContentLoaded', function() {
+      const panel = document.getElementById('rails_hotreload');
+      panel.addEventListener('DOMNodeInserted', () => {
+        const enabled = panel.querySelector('input').checked;
+        if (enabled) window.location.reload();
+      });
+    });
+  </script>
+</div>

data/lib/rails_hotreload.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'rails_hotreload/version'
+require 'rails_hotreload/railtie'
+
+require 'listen'
+require 'turbo-rails'
+
+module RailsHotreload
+  class Checker
+    attr_reader :paths
+
+    def initialize(paths)
+      @paths = paths
+    end
+
+    def call
+      puts "Listening for changes in #{paths}"
+      listener = Listen.to(*paths, {}) { stream_reload }
+      listener.start
+      sleep
+    end
+
+    private
+
+    def stream_reload
+      puts 'Changes detected, reloading...'
+      klass = Turbo::StreamsChannel
+      klass.broadcast_append_to('rails_hotreload', target: 'rails_hotreload', content: '<span />')
+    end
+  end
+end

data/lib/tasks/rails_hotreload_tasks.rake

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+$stdout.sync = true
+require 'listen'
+namespace :rails_hotreload do
+  desc 'Start watching file changes. Sample: bin/rails rails_hotreload:start app/assets/builds'
+  task start: :environment do
+    paths = (ARGV[0] || 'app/assets/builds,app/views/').to_s.split(',')
+    paths = paths.map { |p| Rails.root.join(p).to_s }
+    RailsHotreload::Checker.new(paths).call
+  end
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: rails_hotreload
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Owen Peredo Diaz
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-02-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: turbo-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Auto reloads Rails 7+ applications when assets or views have changed
+email:
+- owenperedo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/rails_hotreload.rb
+- lib/rails_hotreload/railtie.rb
+- lib/rails_hotreload/version.rb
+- lib/rails_hotreload/views/rails_hotreload/_stream.html.erb
+- lib/tasks/rails_hotreload_tasks.rake
+homepage: https://github.com/owen2345/rails-hotreload
+licenses: []
+metadata:
+  homepage_uri: https://github.com/owen2345/rails-hotreload
+  source_code_uri: https://github.com/owen2345/rails-hotreload
+  changelog_uri: https://github.com/owen2345/rails-hotreload
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Auto reloads Rails 7+ applications when assets or views have changed
+test_files: []