dead_end 3.1.2 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f35aa207ae1ff3904d39f5c0ddca5b8a0f68ae157f5c0a999cd3f2f1530e461b
-  data.tar.gz: b08307eb152fc12b84493409bfd8a9b8f23905180ad5ed9168a58d152913bc6e
+  metadata.gz: 655326e21a4ad4ae77a34020b69ce404f2405b2695b2e2e977c685352fcc0e79
+  data.tar.gz: 4a85b498c7d039a1ab016dae09775cb7a0a456c02a234ce83c5ac5776af97f0f
 SHA512:
-  metadata.gz: 02b4ec64732eea9dbb55594c130d2fade4838a855bf3366408a5846683c3d2866e21844c7d3a2797adc865e177e7edf3bffaad0b87f555627f75fcac3d2aa219
-  data.tar.gz: '029add7304c46c97a8a04b564f5798a2e5d43afe24472ae51268226e2dd5e71c56b9c48bf889232d4c3f2759b6edb7ea4c4f332688d6995ddaac0f7ec8ae5803'
+  metadata.gz: 409e22fe3a76ca5cc64a1886f58aaf8bcccc9b1f8564e580f8f1d70a63ba8a32216b6c2e9ac1e0c670b26e06a4a4b977d98562e4b9d2ea28a8bc30c3b096342f
+  data.tar.gz: 379bda579f643647303c39d409c4a675711e5c9679da123961b81b30b86d5b4133e8ea8636cf24eab757b4b262a2f8e93e977360b9a7ba68a5dfaa029e02fba2

data/.circleci/config.yml

@@ -47,23 +47,25 @@ jobs:
 
   "ruby-3-1":
     docker:
-      - image: 'cimg/base:stable'
+      - image: 'cimg/ruby:3.1'
     steps:
       - checkout
-      - ruby/install:
-          version: '3.1.2'
-      - run: ruby -v
       - ruby/install-deps
       - <<: *unit
 
   "ruby-3-2":
     docker:
-      - image: 'cimg/base:stable'
+      - image: 'ruby:3.2.0-preview1'
     steps:
       - checkout
-      - ruby/install:
-          version: '3.2.0-preview1'
-      - run: ruby -v
+      - ruby/install-deps
+      - <<: *unit
+  "ruby-3-2-yjit":
+    docker:
+      - image: 'ruby:3.2.0-preview1'
+    steps:
+      - run: echo "export RUBY_YJIT_ENABLE=1" >> $BASH_ENV
+      - checkout
       - ruby/install-deps
       - <<: *unit
 
@@ -85,4 +87,5 @@ workflows:
       - "ruby-3-0"
       - "ruby-3-1"
       - "ruby-3-2"
+      - "ruby-3-2-yjit"
       - "lint"

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## HEAD (unreleased)
 
+## 4.0.0
+
+- Code that does not have an associated file (eval and streamed) no longer produce a warning saying that the file could not be found. To produce a warning with these code types run with DEBUG=1 environment variable. (https://github.com/zombocom/dead_end/pull/143)
+- [Breaking] Lazy load DeadEnd internals only if there is a Syntax error. Use `require "dead_end"; require "dead_end/api"` to load eagerly all internals. Otherwise `require "dead_end"` will set up an autoload for the first time the DeadEnd module is used in code. This should only happen on a syntax error. (https://github.com/zombocom/dead_end/pull/142)
+- Monkeypatch `SyntaxError#detailed_message` in Ruby 3.2+ instead of `require`, `load`, and `require_relative` (https://github.com/zombocom/dead_end/pull/139)
+
 ## 3.1.2
 
 - Fixed internal class AroundBlockScan, minor changes in outputs (https://github.com/zombocom/dead_end/pull/131)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    dead_end (3.1.2)
+    dead_end (4.0.0)
 
 GEM
   remote: https://rubygems.org/

data/dead_end.gemspec

@@ -8,7 +8,7 @@ end
 
 Gem::Specification.new do |spec|
   spec.name = "dead_end"
-  spec.version = DeadEnd::VERSION
+  spec.version = UnloadedDeadEnd::VERSION
   spec.authors = ["schneems"]
   spec.email = ["richard.schneeman+foo@gmail.com"]
 

data/exe/dead_end

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-require_relative "../lib/dead_end"
+require_relative "../lib/dead_end/api"
 
 DeadEnd::Cli.new(
   argv: ARGV

data/lib/dead_end/api.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative "version"
 
 require "tmpdir"
@@ -7,6 +9,8 @@ require "ripper"
 require "timeout"
 
 module DeadEnd
+  VERSION = UnloadedDeadEnd::VERSION
+
   # Used to indicate a default value that cannot
   # be confused with another input.
   DEFAULT_VALUE = Object.new.freeze
@@ -16,7 +20,7 @@ module DeadEnd
 
   # DeadEnd.handle_error [Public]
   #
-  # Takes a `SyntaxError`` exception, uses the
+  # Takes a `SyntaxError` exception, uses the
   # error message to locate the file. Then the file
   # will be analyzed to find the location of the syntax
   # error and emit that location to stderr.

data/lib/dead_end/core_ext.rb

@@ -1,35 +1,88 @@
 # frozen_string_literal: true
 
-# Monkey patch kernel to ensure that all `require` calls call the same
-# method
-module Kernel
-  module_function
-
-  alias_method :dead_end_original_require, :require
-  alias_method :dead_end_original_require_relative, :require_relative
-  alias_method :dead_end_original_load, :load
-
-  def load(file, wrap = false)
-    dead_end_original_load(file)
-  rescue SyntaxError => e
-    DeadEnd.handle_error(e)
-  end
+# Allow lazy loading, only load code if/when there's a syntax error
+autoload :DeadEnd, "dead_end/api"
+
+# Ruby 3.2+ has a cleaner way to hook into Ruby that doesn't use `require`
+if SyntaxError.new.respond_to?(:detailed_message)
+  module DeadEndUnloaded
+    class MiniStringIO
+      def initialize(isatty: $stderr.isatty)
+        @string = +""
+        @isatty = isatty
+      end
 
-  def require(file)
-    dead_end_original_require(file)
-  rescue SyntaxError => e
-    DeadEnd.handle_error(e)
+      attr_reader :isatty
+      def puts(value = $/, **)
+        @string << value
+      end
+
+      attr_reader :string
+    end
   end
 
-  def require_relative(file)
-    if Pathname.new(file).absolute?
-      dead_end_original_require file
-    else
-      relative_from = caller_locations(1..1).first
-      relative_from_path = relative_from.absolute_path || relative_from.path
-      dead_end_original_require File.expand_path("../#{file}", relative_from_path)
+  SyntaxError.prepend Module.new {
+    def detailed_message(highlight: nil, **)
+      message = super
+      file = DeadEnd::PathnameFromMessage.new(message).call.name
+      io = DeadEndUnloaded::MiniStringIO.new
+
+      if file
+        DeadEnd.call(
+          io: io,
+          source: file.read,
+          filename: file
+        )
+        annotation = io.string
+
+        annotation + message
+      else
+        message
+      end
+    rescue => e
+      if ENV["DEBUG"]
+        $stderr.warn(e.message)
+        $stderr.warn(e.backtrace)
+      end
+
+      # Ignore internal errors
+      message
+    end
+  }
+else
+  autoload :Pathname, "pathname"
+
+  # Monkey patch kernel to ensure that all `require` calls call the same
+  # method
+  module Kernel
+    module_function
+
+    alias_method :dead_end_original_require, :require
+    alias_method :dead_end_original_require_relative, :require_relative
+    alias_method :dead_end_original_load, :load
+
+    def load(file, wrap = false)
+      dead_end_original_load(file)
+    rescue SyntaxError => e
+      DeadEnd.handle_error(e)
+    end
+
+    def require(file)
+      dead_end_original_require(file)
+    rescue SyntaxError => e
+      DeadEnd.handle_error(e)
+    end
+
+    def require_relative(file)
+      if Pathname.new(file).absolute?
+        dead_end_original_require file
+      else
+        relative_from = caller_locations(1..1).first
+        relative_from_path = relative_from.absolute_path || relative_from.path
+        dead_end_original_require File.expand_path("../#{file}", relative_from_path)
+      end
+    rescue SyntaxError => e
+      DeadEnd.handle_error(e)
     end
-  rescue SyntaxError => e
-    DeadEnd.handle_error(e)
   end
 end

data/lib/dead_end/pathname_from_message.rb

@@ -13,6 +13,8 @@ module DeadEnd
   #    # => "/tmp/scratch.rb"
   #
   class PathnameFromMessage
+    EVAL_RE = /^\(eval\):\d+/
+    STREAMING_RE = /^-:\d+/
     attr_reader :name
 
     def initialize(message, io: $stderr)
@@ -24,14 +26,20 @@ module DeadEnd
     end
 
     def call
-      until stop?
-        @guess << @parts.shift
-        @name = Pathname(@guess.join(":"))
-      end
+      if skip_missing_file_name?
+        if ENV["DEBUG"]
+          @io.puts "DeadEnd: Could not find filename from #{@line.inspect}"
+        end
+      else
+        until stop?
+          @guess << @parts.shift
+          @name = Pathname(@guess.join(":"))
+        end
 
-      if @parts.empty?
-        @io.puts "DeadEnd: Could not find filename from #{@line.inspect}"
-        @name = nil
+        if @parts.empty?
+          @io.puts "DeadEnd: Could not find filename from #{@line.inspect}"
+          @name = nil
+        end
       end
 
       self
@@ -43,5 +51,9 @@ module DeadEnd
 
       @name&.exist?
     end
+
+    def skip_missing_file_name?
+      @line.match?(EVAL_RE) || @line.match?(STREAMING_RE)
+    end
   end
 end

data/lib/dead_end/version.rb

@@ -1,5 +1,9 @@
 # frozen_string_literal: true
 
-module DeadEnd
-  VERSION = "3.1.2"
+# Calling `DeadEnd::VERSION` forces an eager load due to
+# an `autoload` on the `DeadEnd` constant.
+#
+# This is used for gemspec access in tests
+module UnloadedDeadEnd
+  VERSION = "4.0.0"
 end

data/lib/dead_end.rb

@@ -1,4 +1,3 @@
 # frozen_string_literal: true
 
-require_relative "dead_end/api"
 require_relative "dead_end/core_ext"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dead_end
 version: !ruby/object:Gem::Version
-  version: 3.1.2
+  version: 4.0.0
 platform: ruby
 authors:
 - schneems
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-18 00:00:00.000000000 Z
+date: 2022-06-02 00:00:00.000000000 Z
 dependencies: []
 description: When you get an "unexpected end" in your syntax this gem helps you find
   it
@@ -82,7 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.14
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Find syntax errors in your source in a snap