rails_live_reload 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a12bfdd549b010582467b39ea3f897cd1576b6e85f9595893482cc6d9738a8bf
+  data.tar.gz: 0e1340b8b309f291c4e0eeae134ba70409c26bd483316c512670c815e056f738
+SHA512:
+  metadata.gz: 64ccc99a6ae7c6e858bc6b623aa38b2f52000b2aa4131e01e2f54438dd186913a625a8e6bc9a45ae80e72012d25ce4be3a701f5bd1df59eb8585ccccbd0ac8d1
+  data.tar.gz: dff2d37006b4316bcd4d5dcfd2fd97f5f116c300fe1fb2313082abe226b6f5443f883477338bc08ca19da795a4ef61c96849b20e4be3981903ebecf704956818

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2022 
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,84 @@
+# Rails Live Reload
+
+This is the simplest and probably the most robust way to add a support for a live reload to your Rails app.
+
+Just add the gem and thats all - congratulation, now you have a live reload.
+
+Works with:
+
+- views (EBR/HAML/SLIM) (reloading page only if you editing views which were rendered)
+- partials
+- CSS/JS
+- helpers, locales (if you configure)
+- on a "crash" page, so once you made a fix page it will be reloaded
+
+Page is reloaded with `window.location.reload()` so it's the most robust way to reload the page because of CSS/JS/etc.
+
+## Usage
+
+Just add this gem to the Gemfile (in development environment) and start the `rails s`.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+group :development do
+  gem "rails_live_reload"
+end
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+## Configuration
+
+Default configuration `config/initializers/rails_live_reload.rb`:
+
+
+```ruby
+RailsLiveReload.setup do |config|
+  config.url     = "/rails/live/reload"
+  config.timeout = 100
+
+  # Watched folders & files
+  config.watch %r{app/views/.+\.(erb|haml|slim)$}
+  config.watch %r{(app|vendor)/(assets|javascript)/\w+/(.+\.(css|js|html|png|jpg|ts|jsx)).*}, reload: :always
+  
+  # More examples:
+  # config.watch %r{app/helpers/.+\.rb}, reload: :always
+  # config.watch %r{config/locales/.+\.yml}, reload: :always
+end
+```
+
+## How it works
+
+There are 3 main pieces how it works:
+
+1) listener for file changes using `listen` gem
+2) collector of rendered views (see rails instrumentation)
+3) middleware which is responding to setInterval JS calls
+
+## Contributing
+
+You are welcome to contribute. See list of `TODO's` below.
+
+## TODO
+
+- reload CSS without reloading the whole page?
+- smarter reload if there is a change in helper (check methods from rendered views?)
+- generator for initializer
+- check how it works with webpacker/importmaps/etc
+- maybe complex rules, e.g. if "user.rb" file is changed - automatically reload all "users" views
+- check with older Rails versions
+- tests or specs
+- CI (github actions)
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+[<img src="https://github.com/igorkasyanchuk/rails_time_travel/blob/main/docs/more_gems.png?raw=true"
+/>](https://www.railsjazz.com/?utm_source=github&utm_medium=bottom&utm_campaign=rails_live_reload)

data/Rakefile

@@ -0,0 +1,3 @@
+require "bundler/setup"
+
+require "bundler/gem_tasks"

data/lib/rails_live_reload/checker.rb

@@ -0,0 +1,36 @@
+module RailsLiveReload
+  class Checker
+
+    def self.scan(dt, rendered_files)
+      temp = []
+
+      # all changed files
+      RailsLiveReload.files.each do |file, fdt|
+        temp << file if fdt && fdt > dt
+      end
+
+     # ::Rails.logger.info "Changed: #{temp}"
+
+      result = []
+
+      temp.each do |file|
+       # ::Rails.logger.info "Checking: #{file}"
+        RailsLiveReload.patterns.each do |pattern, rule|
+          #puts "pattern = #{pattern} & rule = #{rule}"
+          # 1. CSS, JS, yaml, helper .rb
+          # 2. checking if rendered file
+          rule_1 = file.match(pattern) && rule == :always
+          rule_2 = file.match(pattern) && rendered_files.include?(file)
+
+          if rule_1 || rule_2
+            result << file
+            break
+          end
+        end
+      end
+
+      result
+    end
+
+  end
+end

data/lib/rails_live_reload/client.rb

@@ -0,0 +1,35 @@
+module RailsLiveReload
+  class Client
+
+    def Client.js_code
+      %Q{
+        <script>
+          const files = #{CurrentRequest.current.data.to_a.to_json};
+          setInterval(
+            () => {
+              const formData = new FormData();
+              formData.append('dt', #{Time.now.to_i})
+              formData.append('files', JSON.stringify(files))
+
+              fetch(
+                "#{RailsLiveReload.url}", 
+                {
+                  method: "post",
+                  headers: { 'Accept': 'application/json', },
+                  body: formData
+                }
+              )
+                .then(response => response.json())
+                .then(data => {
+                  if(data['command'] === 'RELOAD') {
+                    window.location.reload()
+                  }
+                })
+            }, #{RailsLiveReload.timeout}
+          )
+        </script>
+        }.html_safe
+    end
+
+  end
+end

data/lib/rails_live_reload/command.rb

@@ -0,0 +1,21 @@
+module RailsLiveReload
+  class Command
+    attr_reader :dt, :files
+
+    def initialize(params)
+      @dt    = params["dt"].to_i
+      @files = JSON.parse(params["files"])
+    end
+
+    def command
+      changes = RailsLiveReload::Checker.scan(dt, files)
+
+      if changes.size == 0
+        { command: "NO_CHANGES" }
+      else
+        { command: "RELOAD" }
+      end
+    end
+
+  end
+end

data/lib/rails_live_reload/engine.rb

@@ -0,0 +1,26 @@
+module RailsLiveReload
+  class Railtie < ::Rails::Engine
+
+    initializer "rails_live_reload.middleware" do |app|
+      if ::Rails::VERSION::MAJOR.to_i >= 5
+        app.middleware.insert_after ActionDispatch::Executor, RailsLiveReload::Rails::Middleware
+      else
+        begin
+          app.middleware.insert_after ActionDispatch::Static, RailsLiveReload::Rails::Middleware
+        rescue
+          app.middleware.insert_after Rack::SendFile, RailsLiveReload::Rails::Middleware
+        end
+      end
+
+      RailsLiveReload::Watcher.init
+    end
+
+    initializer :configure_metrics, after: :initialize_logger do
+      ActiveSupport::Notifications.subscribe(
+        /\.action_view/,
+        RailsLiveReload::Instrument::MetricsCollector.new
+      )
+    end
+
+  end
+end

data/lib/rails_live_reload/instrument/metrics_collector.rb

@@ -0,0 +1,29 @@
+module RailsLiveReload
+  module Instrument
+    class MetricsCollector
+      def call(event_name, started, finished, event_id, payload)
+        CurrentRequest.current.data.add(payload[:identifier])
+      end
+    end
+  end
+end
+
+# render_template.action_view
+# {
+#   identifier: "/Users/adam/projects/notifications/app/views/posts/index.html.erb",
+#   layout: "layouts/application"
+# }
+# render_partial.action_view
+# {
+#   identifier: "/Users/adam/projects/notifications/app/views/posts/_form.html.erb"
+# }
+# render_collection.action_view
+# {
+#   identifier: "/Users/adam/projects/notifications/app/views/posts/_post.html.erb",
+#   count: 3,
+#   cache_hits: 0
+# }
+# render_layout.action_view
+# {
+#   identifier: "/Users/adam/projects/notifications/app/views/layouts/application.html.erb"
+# }

data/lib/rails_live_reload/rails/middleware.rb

@@ -0,0 +1,54 @@
+module RailsLiveReload
+  module Rails
+    class Middleware
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        dup.call!(env)
+      end
+
+      def call!(env)
+        request = Rack::Request.new(env)
+
+        if env["REQUEST_PATH"] == RailsLiveReload.url
+          rails_live_response(request)
+        else
+          @status, @headers, @response = @app.call(env)
+
+          if html? && @response.respond_to?(:[]) && (@status == 500 || (@status.to_s =~ /20./ && request.get?))
+            new_response = make_new_response(@response[0])
+            @headers['Content-Length'] = new_response.bytesize.to_s
+            @response = [new_response]
+          end
+
+          [@status, @headers, @response]
+        end
+      rescue Exception => ex
+        puts ex.message
+        puts ex.backtrace.take(10)
+        raise ex
+      end
+
+      private
+
+      def rails_live_response(request)
+        [
+          200,
+          { 'Content-Type' => 'application/json' },
+          [ RailsLiveReload::Command.new(request.params).command.to_json ]
+        ]
+      end
+
+      def make_new_response(body)
+        body.sub("</head>", "</head>#{RailsLiveReload::Client.js_code}")
+      end
+
+      def html?
+        @headers["Content-Type"].include?("text/html")
+      end
+
+    end
+  end
+end

data/lib/rails_live_reload/thread/current_request.rb

@@ -0,0 +1,23 @@
+module RailsLiveReload
+  class CurrentRequest
+    attr_accessor :data, :record
+    attr_reader :request_id
+
+    def CurrentRequest.init
+      Thread.current[:rc_current_request] ||= CurrentRequest.new(SecureRandom.hex(16))
+    end
+
+    def CurrentRequest.current
+      CurrentRequest.init
+    end
+
+    def CurrentRequest.cleanup
+      Thread.current[:rc_current_request] = nil
+    end
+
+    def initialize(request_id)
+      @request_id = request_id
+      @data       = Set.new
+    end
+  end
+end

data/lib/rails_live_reload/version.rb

@@ -0,0 +1,3 @@
+module RailsLiveReload
+  VERSION = "0.0.1"
+end

data/lib/rails_live_reload/watcher.rb

@@ -0,0 +1,38 @@
+module RailsLiveReload
+  class Watcher
+    attr_reader :root
+
+    def Watcher.init
+      watcher = new
+      RailsLiveReload.watcher = watcher
+    end
+
+    def initialize
+      @root = ::Rails.application.root
+      puts "Watching: #{root}"
+      RailsLiveReload.patterns.each do |pattern, rule|
+        puts "  #{pattern} => #{rule}" 
+      end
+      self.build_tree
+      self.start_listener
+    end
+
+    def start_listener
+      Thread.new do
+        listener = Listen.to(root) do |modified, added, removed|
+          all = modified + added + removed
+          all.each do |file|
+            RailsLiveReload.files[file] = File.mtime(file).to_i rescue nil
+          end
+        end
+        listener.start
+      end
+    end
+
+    def build_tree
+      Dir.glob(File.join(root, '**', '*')).select{|file| File.file?(file)}.each do |file|
+        RailsLiveReload.files[file] = File.mtime(file).to_i rescue nil
+      end
+    end
+  end
+end

data/lib/rails_live_reload.rb

@@ -0,0 +1,41 @@
+require "listen"
+require "rails_live_reload/version"
+require "rails_live_reload/client"
+require "rails_live_reload/watcher"
+require "rails_live_reload/rails/middleware"
+require "rails_live_reload/instrument/metrics_collector"
+require "rails_live_reload/thread/current_request"
+require "rails_live_reload/checker"
+require "rails_live_reload/command"
+require "rails_live_reload/engine"
+
+module RailsLiveReload
+  mattr_accessor :files
+  @@files = {}
+
+  mattr_accessor :watcher
+  @@watcher = nil
+
+  mattr_accessor :url
+  @@url = "/rails/live/reload"
+
+  mattr_accessor :patterns
+  @@patterns = {}
+
+  mattr_accessor :timeout
+  @@timeout = 100
+
+  def self.setup
+    yield(self)
+  end
+
+  def self.watch(pattern, reload: :on_change)
+    RailsLiveReload.patterns[pattern] = reload
+  end
+end
+
+# default watch settings
+RailsLiveReload.setup do |config|
+  config.watch %r{app/views/.+\.(erb|haml|slim)$}
+  config.watch %r{(app|vendor)/(assets|javascript)/\w+/(.+\.(css|js|html|png|jpg|ts|jsx)).*}, reload: :always
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: rails_live_reload
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Igor Kasyanchuk
+- Liubomyr Manastyretskyi
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-05-29 00:00:00.000000000 Z
+dependencies:
+- !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: 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: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sprockets-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: wrapped_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby on Rails Live Reload with just a single line of code - just add
+  the gem to Gemfile.
+email:
+- igorkasyanchuk@gmail.com
+- manastyretskyi@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/rails_live_reload.rb
+- lib/rails_live_reload/checker.rb
+- lib/rails_live_reload/client.rb
+- lib/rails_live_reload/command.rb
+- lib/rails_live_reload/engine.rb
+- lib/rails_live_reload/instrument/metrics_collector.rb
+- lib/rails_live_reload/rails/middleware.rb
+- lib/rails_live_reload/thread/current_request.rb
+- lib/rails_live_reload/version.rb
+- lib/rails_live_reload/watcher.rb
+homepage: https://github.com/railsjazz/rails_live_reload
+licenses:
+- MIT
+metadata: {}
+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.3.3
+signing_key:
+specification_version: 4
+summary: Ruby on Rails Live Reload
+test_files: []