static-site-builder 0.1.3 → 1.0.0

data/lib/static_site_builder/dev_server.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+require 'listen'
+require 'pathname'
+require 'static_site_builder/websocket_server'
+
+begin
+  require 'webrick'
+rescue LoadError
+  # webrick may not be available in all environments
+end
+
+module StaticSiteBuilder
+  # Development server with file watching and live reload
+  #
+  # Watches for file changes using the listen gem, rebuilds the site automatically,
+  # and provides live reload via WebSocket server.
+  class DevServer
+    def initialize(root: Dir.pwd, port: nil, ws_port: nil)
+      @root = Pathname.new(root)
+      @port = port || ENV['PORT']&.to_i || DEFAULT_PORT
+      @ws_port = ws_port || ENV['WS_PORT']&.to_i || DEFAULT_WS_PORT
+      @dist_dir = @root.join('dist')
+      @reload_file = @root.join('.reload')
+      @listener = nil
+      @ws_server = nil
+      @http_server = nil
+      @running = false
+    end
+
+    # Start the development server
+    #
+    # Builds the site initially, starts file watcher, WebSocket server, and HTTP server
+    def start
+      puts 'Building site...'
+      build_site
+
+      puts "\nStarting development server..."
+      puts "  HTTP server: http://localhost:#{@port}"
+      puts "  WebSocket server: ws://localhost:#{@ws_port}"
+      puts "  Watching for changes... (Ctrl+C to stop)\n"
+
+      start_websocket_server
+      start_file_watcher
+      start_http_server
+    end
+
+    # Stop the development server
+    def stop
+      @running = false
+      @listener&.stop
+      @ws_server&.stop
+      @http_server&.shutdown if @http_server
+      puts "\nShutting down..."
+    end
+
+    private
+
+    def build_site
+      ENV['LIVE_RELOAD'] = 'true'
+      ENV['WS_PORT'] = @ws_port.to_s
+      
+      begin
+        require 'rake'
+        Rake::Task['build:html'].invoke
+      rescue LoadError, RuntimeError
+        # If Rakefile not loaded or task not found, build directly
+        require 'static_site_builder'
+        builder = Builder.new(root: @root.to_s)
+        builder.build
+      end
+    end
+
+    def start_websocket_server
+      @ws_server = WebSocketServer.new(port: @ws_port, reload_file: @reload_file)
+      @ws_server.start
+    end
+
+    def start_file_watcher
+      @running = true
+      watched_dirs = ['app', 'config'].select { |dir| @root.join(dir).exist? }
+      return if watched_dirs.empty?
+
+      @listener = Listen.to(*watched_dirs.map { |dir| @root.join(dir).to_s }) do |modified, added, removed|
+        next if modified.empty? && added.empty? && removed.empty?
+
+        files_changed = (modified + added + removed).select do |file|
+          file.end_with?('.erb', '.rb', '.js')
+        end
+
+        if files_changed.any?
+          puts "\nFiles changed, rebuilding..."
+          build_site
+          puts 'Rebuild complete'
+        end
+      end
+
+      @listener.start
+    end
+
+    def start_http_server
+      unless defined?(WEBrick)
+        raise 'webrick gem is required for the development server. Add "gem \'webrick\'" to your Gemfile.'
+      end
+
+      @http_server = WEBrick::HTTPServer.new(
+        Port: @port,
+        DocumentRoot: @dist_dir.to_s,
+        BindAddress: '127.0.0.1'
+      )
+
+      trap('INT') { stop }
+      trap('TERM') { stop }
+
+      @http_server.start
+    end
+  end
+end
+

data/lib/static_site_builder/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module StaticSiteBuilder
-  VERSION = "0.1.3"
+  VERSION = "1.0.0"
 end

data/lib/static_site_builder/websocket_server.rb

@@ -6,66 +6,126 @@ require "digest/sha1"
 require "pathname"
 
 module StaticSiteBuilder
-  # Simple WebSocket server for live reload
+  # WebSocket server for live reload functionality during development.
+  #
+  # Watches for rebuild notifications via a reload file and broadcasts reload
+  # messages to connected browser clients, enabling automatic page refresh.
   class WebSocketServer
-    def initialize(port: 3001, reload_file: nil)
+    # Sleep intervals for thread operations (in seconds)
+    ACCEPT_RETRY_INTERVAL = 0.1  # Retry delay when accepting connections fails
+    WATCH_POLL_INTERVAL = 0.3     # How often to check for rebuild notifications
+    CLIENT_KEEPALIVE_INTERVAL = 1 # Keep-alive check interval for client connections
+
+    # Initializes a new WebSocket server instance.
+    #
+    # @param port [Integer] Port number for the WebSocket server (default: 3001)
+    # @param reload_file [Pathname, nil] Path to the reload notification file. If nil, defaults to .reload in current directory.
+    def initialize(port: StaticSiteBuilder::DEFAULT_WS_PORT, reload_file: nil)
       @port = port
       @reload_file = reload_file || Pathname.new(Dir.pwd).join(".reload")
       @clients = []
       @running = false
     end
 
+    # Starts the WebSocket server and begins watching for rebuild notifications.
+    #
+    # Spawns two background threads: one for accepting client connections and
+    # one for watching the reload file for changes. Returns immediately after
+    # starting the threads.
+    #
+    # @return [void]
     def start
       @running = true
       @server = TCPServer.new("127.0.0.1", @port)
 
-      # Initialize reload file
-      File.write(@reload_file, Time.now.to_f.to_s) unless @reload_file.exist?
+      # Initialize reload file if it doesn't exist
+      File.write(@reload_file, Time.current.to_f.to_s) unless @reload_file.exist?
       @last_mtime = @reload_file.mtime
 
-      # Accept connections in background
+      # Accept client connections in background thread
       @accept_thread = Thread.new do
         while @running
           begin
             client = @server.accept
             Thread.new { handle_client(client) }
-          rescue => e
-            sleep 0.1
+          rescue IOError, Errno::EBADF, Errno::ECONNABORTED
+            # Connection errors are expected during shutdown or network issues
+            # Retry accepting connections unless server is stopping
+            sleep ACCEPT_RETRY_INTERVAL
             break unless @running
           end
         end
       end
 
-      # Watch for rebuilds
+      # Watch for rebuild notifications in background thread
       @watch_thread = Thread.new do
         while @running
           begin
-            sleep 0.3
+            sleep WATCH_POLL_INTERVAL
             if @reload_file.exist? && @reload_file.mtime > @last_mtime
               @last_mtime = @reload_file.mtime
               broadcast("reload")
             end
-          rescue => e
-            sleep 0.3
+          rescue Errno::ENOENT, Errno::EACCES, SystemCallError
+            # File system errors during watch are non-fatal
+            # Continue watching unless server is stopping
+            sleep WATCH_POLL_INTERVAL
             break unless @running
           end
         end
       end
     end
 
+    # Stops the WebSocket server gracefully.
+    #
+    # Closes all client connections, stops accepting new connections, stops
+    # watching for rebuilds, and closes the server socket.
+    #
+    # @return [void]
     def stop
       @running = false
-      @clients.each { |c| c.close rescue nil }
-      @server.close rescue nil
-      @accept_thread.kill rescue nil
-      @watch_thread.kill rescue nil
+      @clients.each { |client| safe_close(client) }
+      safe_close(@server) if @server
+      safe_kill_thread(@accept_thread)
+      safe_kill_thread(@watch_thread)
     end
 
     private
 
+    # Safely closes a socket or connection, ignoring common connection errors.
+    #
+    # Used to handle cases where connections may already be closed or reset,
+    # preventing exceptions during cleanup.
+    #
+    # @param io [IO] The IO object to close
+    def safe_close(io)
+      return if io.nil? || io.closed?
+
+      io.close
+    rescue IOError, Errno::EPIPE, Errno::ECONNRESET, Errno::EBADF
+      # Connection already closed or reset - this is expected during shutdown
+    end
+
+    # Safely terminates a thread, ignoring errors if the thread is already dead.
+    #
+    # @param thread [Thread, nil] The thread to kill
+    def safe_kill_thread(thread)
+      return unless thread&.alive?
+
+      thread.kill
+    rescue ThreadError
+      # Thread already dead - this is expected during shutdown
+    end
+
+    # Handles a new client connection, performing WebSocket handshake.
+    #
+    # Reads the HTTP upgrade request, validates it's a WebSocket request, performs
+    # the handshake, and keeps the connection alive for receiving reload messages.
+    #
+    # @param client [TCPSocket] The client socket connection
     def handle_client(client)
       begin
-        # Read handshake
+        # Read HTTP upgrade request headers
         request = client.gets
         headers = {}
         while (line = client.gets.chomp) != ""
@@ -74,6 +134,7 @@ module StaticSiteBuilder
         end
 
         if headers["Upgrade"]&.downcase == "websocket"
+          # Perform WebSocket handshake
           key = headers["Sec-WebSocket-Key"]
           accept = Base64.strict_encode64(Digest::SHA1.digest(key + "258EAFA5-E914-47DA-95CA-C5AB0DC85B11"))
 
@@ -84,32 +145,47 @@ module StaticSiteBuilder
 
           @clients << client
 
-          # Keep connection alive - just wait
+          # Keep connection alive, waiting for reload messages
           loop do
-            sleep 1
+            sleep CLIENT_KEEPALIVE_INTERVAL
             break unless @running
             break if client.closed?
           end
         else
+          # Not a WebSocket request - close connection
           client.close
         end
-      rescue => e
+      rescue IOError, Errno::EPIPE, Errno::ECONNRESET, Errno::ECONNABORTED
+        # Client connection errors are expected (e.g., browser tab closed)
+        # Clean up and continue accepting other connections
         @clients.delete(client)
-        client.close rescue nil
+        safe_close(client)
       end
     end
 
+    # Broadcasts a reload message to all connected clients.
+    #
+    # @param message [String] The message to broadcast (typically "reload")
     def broadcast(message)
       frame = create_frame(message)
       @clients.dup.each do |client|
         begin
           client.write(frame) unless client.closed?
-        rescue => e
+        rescue IOError, Errno::EPIPE, Errno::ECONNRESET, Errno::ECONNABORTED
+          # Broadcast errors are expected when clients disconnect
+          # Remove failed client and continue broadcasting to others
           @clients.delete(client)
         end
       end
     end
 
+    # Creates a WebSocket frame for the given message.
+    #
+    # Implements WebSocket frame encoding according to RFC 6455, supporting
+    # messages up to 2^32 bytes in length.
+    #
+    # @param message [String] The message to encode
+    # @return [String] Binary WebSocket frame data
     def create_frame(message)
       data = message.dup.force_encoding("BINARY")
       length = data.bytesize

data/lib/static_site_builder.rb

@@ -1,10 +1,23 @@
 # frozen_string_literal: true
 
-require_relative "static_site_builder/version"
-require_relative "static_site_builder/builder"
-require_relative "static_site_builder/websocket_server"
-require_relative "generator"
+require 'active_support'
+require 'active_support/core_ext'
 
 module StaticSiteBuilder
   # Main module for the static site builder gem
+
+  # Default WebSocket port for live reload server
+  DEFAULT_WS_PORT = 3001
+
+  # Default HTTP port for development server
+  DEFAULT_PORT = 3000
+
+  # Default layout name
+  DEFAULT_LAYOUT_NAME = 'application'
 end
+
+require_relative "static_site_builder/version"
+require_relative "static_site_builder/builder"
+require_relative "static_site_builder/dev_server"
+require_relative "static_site_builder/websocket_server"
+require_relative "generator"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: static-site-builder
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 1.0.0
 platform: ruby
 authors:
 - Lukasz Czapiewski
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '8.0'
+        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '8.0'
+        version: '7.1'
 - !ruby/object:Gem::Dependency
   name: base64
   requirement: !ruby/object:Gem::Requirement
@@ -38,33 +38,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.1'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: listen
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '3.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '3.8'
 - !ruby/object:Gem::Dependency
-  name: tty-prompt
+  name: meta-tags
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.23'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.23'
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: websocket
   requirement: !ruby/object:Gem::Requirement
@@ -93,10 +107,10 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: 'A Ruby gem for building static HTML sites. Includes generator for creating
-  projects and builder for compiling ERB/Phlex templates to static HTML. Choose your
-  stack: ERB or Phlex, Importmap or ESBuild/Webpack/Vite, TailwindCSS or shadcn, Stimulus
-  or React/Vue/Alpine.'
+description: A Ruby gem for building static HTML sites. Uses ActionView to render
+  partials, layouts, and helpers using ERB. Compiles to static HTML with JavaScript
+  support. Simple and flexible - add your own JavaScript bundling and CSS processing
+  as needed. No backend required.
 email:
 - luke@mmtm.io
 executables:
@@ -104,7 +118,6 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ARCHITECTURE.md
 - CHANGELOG.md
 - LICENSE
 - README.md
@@ -113,6 +126,7 @@ files:
 - lib/generator.rb
 - lib/static_site_builder.rb
 - lib/static_site_builder/builder.rb
+- lib/static_site_builder/dev_server.rb
 - lib/static_site_builder/version.rb
 - lib/static_site_builder/websocket_server.rb
 homepage: https://github.com/Ancez/static-site-builder
@@ -128,14 +142,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.0
 specification_version: 4
-summary: Build static HTML sites with working JavaScript
+summary: Build static HTML sites from ERB with working JavaScript
 test_files: []

data/ARCHITECTURE.md

@@ -1,61 +0,0 @@
-# Architecture
-
-This project is a **generator tool**, similar to `rails new`. It creates static site projects that use standard Ruby gems.
-
-## Structure
-
-```
-static-site-generator/
-├── lib/
-│   └── generator.rb          # Main generator logic
-├── bin/
-│   └── generate              # CLI entry point
-├── exe/
-│   └── static-site-generator # Gem executable
-└── templates/                # Template files (future)
-```
-
-## How It Works
-
-1. **Generator** (`static-site-generator` gem)
-   - Creates project structure
-   - Generates Gemfile with dependencies
-   - Creates config files
-   - Sets up build tasks
-
-2. **Builder Gem** (`static-site-builder` gem) - **Separate gem**
-   - Handles ERB/Phlex compilation
-   - Manages asset copying
-   - Generates importmap JSON
-   - Outputs static HTML
-
-3. **Standard Gems** - Used by generated sites
-   - `importmap-rails` - Importmap support
-   - `phlex-rails` - Phlex components
-   - `static-site-builder` - Core builder functionality
-
-## Generated Site Structure
-
-```
-my-site/
-├── Gemfile              # Dependencies
-├── package.json         # JS dependencies (if needed)
-├── Rakefile            # Build tasks
-├── config/
-│   └── importmap.rb    # Importmap config
-├── app/
-│   ├── views/
-│   ├── javascript/
-│   └── assets/
-└── lib/
-    └── site_builder.rb  # Thin wrapper using static-site-builder gem
-```
-
-## Separation of Concerns
-
-- **Generator** - Creates projects (this repo)
-- **Builder** - Compiles sites (`static-site-builder` gem)
-- **Standard Gems** - Provide functionality (importmap-rails, etc.)
-
-This keeps the generator lightweight and maintainable.
-