ruby-live-reload 0.2.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d9145bba59fc4b7d871e48c6c2c5b6e8d2d66f991a267540c9f74867ad3c5728
+  data.tar.gz: 87908f936203b08cf1e03408da428bc73f01bc5a880612d525eebcf169dfc835
+SHA512:
+  metadata.gz: 53d12a050bcf33fa115496e1176a39f1d4bac46b1426d9dd7184b7da7e2226ebf9f337b2402452d006c9ee1f8f27592e36a5d9a7d806489b81d971693121a48a
+  data.tar.gz: 41c6fc10519d6d69792619fba889edb6edec12a2b9ef1d1a8fe3a8b77372ce7e81feee6f7eac1db8bdc1c516494a401995ef00236170a5497cbf62f71c066825

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 James
+
+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,3 @@
+# ✨ Ruby Live Reload ✨
+
+A Ruby live server for web development

data/bin/rlr

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+# Alias for bin/ruby-live-reload
+load File.expand_path("../ruby-live-reload", __FILE__)

data/bin/ruby-live-reload

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+require "ruby_live_reload.rb"

data/lib/ruby_live_reload/options.rb

@@ -0,0 +1,70 @@
+module RubyLiveReload
+  class Options
+
+    private
+
+    attr_writer :host, :port, :directory, :proxy, :message
+
+    def initialize
+      @host = "127.0.0.1"
+      @port = 8080
+      @directory = Dir.pwd
+      @proxy = nil
+      @message = nil
+    end
+
+    public 
+
+    attr_reader :host, :port, :directory, :proxy, :message
+
+    def self.parse(args)
+
+      unless [String, Array].include? args.class 
+        raise <<~ERROR.strip
+          Provide an array or a space-separated string of arguments: ["-p", 9090, "--host", "198.168.0.42"] or "-p 9090 --host 192.168.0.42"
+        ERROR
+      end
+
+      args = args.split " " if args.is_a? String
+
+      instance = Options.new
+
+      OptionParser.new do |options|
+        options.banner = "Usage: rlr [instance]"
+        options.release = VERSION
+
+        options.on("-b HOST", "--bind HOST", "Hostname") do |host|
+          instance.send :host=, host
+        end
+
+        options.on("-p PORT", "--port PORT", "Port") do |port|
+          instance.send :port=, port
+        end
+
+        options.on("--proxy URL", "Url of the proxied app") do |proxy|
+          instance.send :proxy=,  proxy
+        end
+
+        options.on("-d PATH", "--directory PATH", "Path") do |path|
+          directory = if path.start_with?("/")
+            path
+          else
+            File.join(Dir.pwd, path)
+          end
+
+          # TODO Validate path is a directory
+
+          instance.send :directory=, directory
+        end
+
+        options.on("-v", "--version", "Version") do
+          instance.send :message=, VERSION
+        end
+
+      end.parse(args)
+
+      return instance
+    end
+  end
+
+end

data/lib/ruby_live_reload/version.rb

@@ -0,0 +1,3 @@
+module RubyLiveReload
+    VERSION = "0.2.7"
+end

data/lib/ruby_live_reload.rb

@@ -0,0 +1,212 @@
+require "optparse"
+require "sinatra/base"
+require "filewatcher"
+require "faraday"
+
+require_relative "ruby_live_reload/version.rb"
+require_relative "ruby_live_reload/options.rb"
+
+# https://blog.appsignal.com/2024/11/27/server-sent-events-and-websockets-in-rack-for-ruby.html
+
+module RubyLiveReload
+
+  class Server < Sinatra::Base
+
+    set :quiet, true
+    set :server_settings, { max_threads: 256, Silent: true }
+
+    set :clients, Set.new
+    
+    on_start do
+      puts <<~_
+        Ruby Live Reload running with #{settings.threads} threads!
+        Watching #{settings.directory}
+
+        http://#{settings.bind}:#{settings.port}
+
+        Ctrl-c to stop
+      _
+
+
+      @filewatcher_thread = Thread.new do
+        @filewatcher = Filewatcher.new File.join(settings.directory, "**", "*.*")
+
+        @filewatcher.watch do |changes| 
+          settings.clients.each do |client|
+            client << "data: " + changes.to_s + "\n\n"
+          rescue 
+            client.close
+            settings.clients.delete client
+          end
+        end
+
+        settings.clients.each do |client|
+          client.close
+        end
+
+        rescue
+          exit # Watcher thread crash
+      end
+    end
+
+    on_stop do
+      @filewatcher&.stop()
+      @filewatcher_thread&.join
+    end
+
+    get "/ruby-live-reload-sse", provides: "text/event-stream" do
+      stream :keep_open do |client|
+        if settings.clients.add? client
+          client.callback do # on connection closed
+            settings.clients.delete client
+          end
+        end
+
+        # Throttle Sinatra scheduler since Filewatcher is used to trigger SSE
+        sleep 1
+
+        # Heartbeat will detect disconnected client and free the thread
+        client << "event: heartbeat\n\n"
+      rescue
+        settings.clients.delete client
+        client.close
+      end
+    end
+
+    # Tweak to remove 404 if favicon is missing
+    get "/favicon.ico" do
+      path = File.join(settings.directory, "favicon.ico")
+
+      if File.exist? path
+        send_file path
+      end
+
+      204
+    end
+
+    get "*" do
+      headers \
+        "Cache-Control" => "max-age=0, no-cache, no-store, must-revalidate",
+        "Expires"=> "Thu, 01 Jan 1970 00:00:00 GMT",
+        "Pragma" => "no-cache"
+
+      splat = File.join params["splat"]
+      path = File.join(settings.directory, splat)
+      is_asset = !([".html", ".htm", ".xhtml"].include? File.extname(path))
+
+      if File.directory?(path) && !path.end_with?("/")
+        # Add / to the end of URL so browser correctly handles relative paths
+        redirect "#{splat}/"
+      elsif File.file?(path) && is_asset
+        send_file path
+      end
+
+      response = if settings.proxy
+        # TODO Handle response other than HTML
+        #      --wrap to enclose arbitrary text within HTML to allow snippet injection?
+        #      What about arbitrary files? Images, CSS, etc?
+        Faraday.get(File.join(settings.proxy + splat)).body
+      elsif File.file? path
+        File.read path
+      elsif File.file? File.join(path, "index.html")
+        File.read File.join(path, "index.html")
+      elsif File.directory?(path) && !response
+        children = Dir.glob("*", base: path).sort_by { |s| [File.directory?(s).to_s, s.downcase] }
+        links = children.map do |child| 
+          <<-LI
+            <li>
+              <a href="#{child}">
+                #{child + (File.directory?(child) ? "/" : "")}
+              </a>
+            </li>
+          LI
+        end.join
+
+        <<-LISTING
+          <!DOCTYPE html>
+          <html lang="en">
+          <head>
+            <meta charset="UTF-8">
+            <title>RLR Directory Listing</title>
+          </head>
+          <body>
+            <h1>Ruby Live Reload</h1>
+
+            <p>#{path}</p>
+            <ul>
+                #{links}
+            </ul>
+          </body>
+          </html>
+        LISTING
+      elsif !response
+        status 404
+
+        <<-NOT_FOUND
+          <!DOCTYPE html>
+          <html lang="en">
+          <head>
+            <meta charset="UTF-8">
+            <title></title>
+          </head>
+          <body>
+            <h1>File Not Found</h1>
+
+            <p>#{path}</p>
+          </body>
+          </html>
+        NOT_FOUND
+      end
+
+      client_js = <<-JS
+        <script defer>
+            const source = new EventSource('/ruby-live-reload-sse')
+
+            source.onmessage = (m) => {
+              location.reload()
+            }
+
+            source.onerror = (m) => {
+              console.group('Ruby Live Reload')
+                console.warn('Cannot reach server, reconnecting...')
+              console.groupEnd()
+            }
+
+            addEventListener("beforeunload", (event) => {
+              source.close()
+
+              return false // Do not show confirm dialog
+            })
+        </script>
+      JS
+
+      head_inject = response.sub!(/<\/head>/, "#{client_js}</head>")
+      body_inject = unless head_inject
+        response.sub!(/<body(.*)>/, "<body#{$+}>#{client_js}")
+      end
+
+      if head_inject || body_inject
+        content_type :html
+      end
+
+      response
+    end
+
+  end
+
+
+  options = Options.parse(ARGV)
+
+  if message = options.message
+    puts message
+  else 
+    Server.run!({
+      bind: options.host,
+      port: options.port,
+      directory: options.directory,
+      proxy: options.proxy,
+      threads: 16,
+    })
+  end
+
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: ruby-live-reload
+version: !ruby/object:Gem::Version
+  version: 0.2.7
+platform: ruby
+authors:
+- James Hoffman
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.2.0
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.1
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.5.0
+- !ruby/object:Gem::Dependency
+  name: rackup
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+- !ruby/object:Gem::Dependency
+  name: filewatcher
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+description: Serve a web app and enable page refresh when files change
+email: james@jhoffman.ca
+executables:
+- rlr
+- ruby-live-reload
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/rlr
+- bin/ruby-live-reload
+- lib/ruby_live_reload.rb
+- lib/ruby_live_reload/options.rb
+- lib/ruby_live_reload/version.rb
+homepage: https://github.com/thecodingjames/ruby-live-reload
+licenses:
+- MIT
+metadata: {}
+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.6.9
+specification_version: 4
+summary: A Ruby live server for web development
+test_files: []