sandals 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 729bdd148836e2e4876915282f45c5dfb13e5ac040a45ab973a40824d4a02e09
-  data.tar.gz: b4ce94253c0bb8d5a8e7026e2c8dc5f873d748ee572756a98b240ff02e3a1f64
+  metadata.gz: 79d2b3d1395db396acd1aad4055141b75c955ca0ff0462e5fcf700db819af32e
+  data.tar.gz: 1cc17abdffbbc21540ada84f192cf9b1139c63c9422ef8152c2767ad6091473b
 SHA512:
-  metadata.gz: 1298a4d2d07e5ff4d0a09dbc446fa2f32858a043f9ea68bcd76c0be4543aceaa0292e4f469bde1048ce63d4932eee26da0eae88a715f9dffd5a7328832ec8fbf
-  data.tar.gz: e09f3194ff8c72a2c0dbab9f00f73ea7916deaca101427c617b6c5d04a307c50a95563805a2094a895288a7ae6874753f5cf45d61039b4435e216cdaabf5a9c5
+  metadata.gz: 6002d0c758974e5e797e153ebd50c0422b2a706b8329d6831cd44c7a13daabee0c9f9bd55aa49b3389e7798c00195ad92156f8f205bc74afb1fcab7395c0df90
+  data.tar.gz: 075fb63042fd98661f107e249ff3af9c3c82bf203d44f7a58c937a8bdf7ac71fc235d4ae22246972b26ecb8cde00a246f9968bb343a9ffb9306a4f509e52d32f

data/README.md

@@ -75,6 +75,28 @@ ruby hello_test.rb
 The test fills in `"Your name"` and verifies that the greeting appears. It uses
 Minitest, which is installed with Sandals.
 
+## Startup errors
+
+Sandals reports startup failures with the error type, application file, and
+line number instead of printing an internal framework backtrace:
+
+```text
+sandals: SyntaxError at app.rb:12
+app.rb:12: syntax error, unexpected end-of-input
+```
+
+Missing dependencies are reported in the same way:
+
+```text
+sandals: LoadError at app.rb:1
+cannot load such file -- sqlite3
+Add the missing dependency to the app and try again.
+```
+
+Sandals also evaluates the initial view before opening the server, so an
+exception during the first render points to the relevant line in the
+application.
+
 ## The experience
 
 An application should normally fit in a single file:

data/lib/sandals/action_error.rb

@@ -17,15 +17,7 @@ module Sandals
     end
 
     def location
-      locations = original_error.backtrace_locations || []
-      relevant_location = locations.find do |candidate|
-        !candidate.absolute_path.to_s.include?("/lib/sandals/")
-      end || locations.first
-      return "Location unavailable" unless relevant_location
-
-      path = relevant_location.absolute_path || relevant_location.path
-      path = path.delete_prefix("#{Dir.pwd}/")
-      "#{path}:#{relevant_location.lineno}"
+      ErrorDetails.for(original_error).fetch(:location)
     end
   end
 

data/lib/sandals/cli.rb

@@ -5,6 +5,16 @@ require_relative "../sandals"
 
 module Sandals
   class CLI
+    class InitialAppError < StandardError
+      attr_reader :original_error, :path
+
+      def initialize(original_error, path)
+        @original_error = original_error
+        @path = path
+        super(original_error.message)
+      end
+    end
+
     def self.start(arguments)
       new(arguments).run
     end
@@ -20,11 +30,13 @@ module Sandals
       when "new" then new_app
       else usage
       end
-    rescue Interrupt
-      0
+    rescue InitialAppError => error
+      report_initial_app_error(error)
     rescue StandardError => error
       warn "sandals: #{error.message}"
       1
+    rescue Interrupt
+      0
     end
 
     private
@@ -74,7 +86,7 @@ module Sandals
       parser.parse!(@arguments)
 
       path = resolve_app(@arguments.shift || "app")
-      application = Sandals.load(path)
+      application = load_initial_application(path)
       server = Server.new(application, port: options[:port], reload_path: path)
 
       trap("INT") { server.stop }
@@ -85,6 +97,25 @@ module Sandals
       0
     end
 
+    def load_initial_application(path)
+      application = Sandals.load(path)
+      application.render(development_reload: true)
+      application
+    rescue SyntaxError, LoadError, StandardError => error
+      raise InitialAppError.new(error, File.expand_path(path))
+    end
+
+    def report_initial_app_error(error)
+      original = error.original_error
+      details = ErrorDetails.for(original, fallback_path: error.path)
+      warn "sandals: #{details.fetch(:class)} at #{details.fetch(:location)}"
+      warn details.fetch(:message)
+      if original.is_a?(LoadError)
+        warn "Add the missing dependency to the app and try again."
+      end
+      1
+    end
+
     def resolve_app(name)
       candidates = [name]
       candidates << "#{name}.rb" unless name.end_with?(".rb")

data/lib/sandals/code_reloader.rb

@@ -2,9 +2,7 @@
 
 module Sandals
   class CodeReloader
-    ANSI_ESCAPE = /\e\[[0-9;]*m/
-
-    Result = Data.define(:version, :application, :error, :changed)
+    Result = Struct.new(:version, :application, :error, :changed)
 
     attr_reader :path
 
@@ -46,35 +44,7 @@ module Sandals
     end
 
     def error_details(error)
-      {
-        class: error.class.to_s,
-        message: clean_message(error),
-        location: error_location(error)
-      }
-    end
-
-    def error_location(error)
-      syntax_location =
-        clean_message(error).lines.first&.match(/\A(.+?):(\d+):/) if
-          error.is_a?(SyntaxError)
-      if syntax_location
-        source_path = syntax_location[1].delete_prefix("#{Dir.pwd}/")
-        return "#{source_path}:#{syntax_location[2]}"
-      end
-
-      locations = error.backtrace_locations || []
-      location = locations.find do |candidate|
-        !candidate.absolute_path.to_s.include?("/lib/sandals/")
-      end || locations.first
-      return path unless location
-
-      source_path = location.absolute_path || location.path
-      source_path = source_path.delete_prefix("#{Dir.pwd}/")
-      "#{source_path}:#{location.lineno}"
-    end
-
-    def clean_message(error)
-      error.message.gsub(ANSI_ESCAPE, "")
+      ErrorDetails.for(error, fallback_path: path)
     end
   end
 end

data/lib/sandals/error_details.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Sandals
+  class ErrorDetails
+    ANSI_ESCAPE = /\e\[[0-9;]*m/
+
+    def self.for(error, fallback_path: nil)
+      new(error, fallback_path:).to_h
+    end
+
+    def initialize(error, fallback_path:)
+      @error = error
+      @fallback_path = fallback_path
+    end
+
+    def to_h
+      {
+        class: @error.class.to_s,
+        message: clean_message,
+        location: error_location
+      }
+    end
+
+    private
+
+    def error_location
+      path, line = syntax_location || backtrace_location
+      return @fallback_path || "Location unavailable" unless path
+
+      relative_location(path, line)
+    end
+
+    def syntax_location
+      return unless @error.is_a?(SyntaxError)
+
+      line = clean_message.lines.first&.[](/:(\d+):/, 1)
+      [@error.path || @fallback_path, line] if line
+    end
+
+    def backtrace_location
+      locations = @error.backtrace_locations || []
+      location =
+        locations.find { |candidate| same_path?(candidate, @fallback_path) } ||
+        locations.find { |candidate| !sandals_path?(candidate) } ||
+        locations.first
+
+      [location&.absolute_path || location&.path, location&.lineno]
+    end
+
+    def same_path?(location, path)
+      path && File.expand_path(location.absolute_path || location.path) == File.expand_path(path)
+    end
+
+    def sandals_path?(location)
+      location.absolute_path.to_s.include?("/lib/sandals/")
+    end
+
+    def relative_location(path, line)
+      source_path = path.delete_prefix("#{Dir.pwd}/")
+      "#{source_path}:#{line}"
+    end
+
+    def clean_message
+      @error.message.gsub(ANSI_ESCAPE, "").strip
+    end
+  end
+end

data/lib/sandals/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Sandals
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/lib/sandals.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "sandals/version"
+require_relative "sandals/error_details"
 require_relative "sandals/binding_resolver"
 require_relative "sandals/action_error"
 require_relative "sandals/uploaded_file"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sandals
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Benito Serna
@@ -56,6 +56,7 @@ files:
 - lib/sandals/binding_resolver.rb
 - lib/sandals/cli.rb
 - lib/sandals/code_reloader.rb
+- lib/sandals/error_details.rb
 - lib/sandals/event_dispatcher.rb
 - lib/sandals/html_renderer.rb
 - lib/sandals/server.rb