Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix windows compatibility #114

Merged
merged 1 commit into from
Nov 12, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
## HEAD (unreleased)

- Fix windows filename detection (https://github.com/zombocom/dead_end/pull/114)
- Update links on readme and code of conduct (https://github.com/zombocom/dead_end/pull/107)

## 3.0.1
Expand Down
27 changes: 16 additions & 11 deletions lib/dead_end.rb
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,14 @@ class Error < StandardError; end
TIMEOUT_DEFAULT = ENV.fetch("DEAD_END_TIMEOUT", 1).to_i

def self.handle_error(e)
filename = e.message.split(":").first
file = PathnameFromMessage.new(e.message).call.name
raise e unless file

$stderr.sync = true

call(
source: Pathname(filename).read,
filename: filename
source: file.read,
filename: file
)

raise e
Expand Down Expand Up @@ -139,21 +141,24 @@ def self.valid?(source)
end
end

require_relative "dead_end/code_line"
require_relative "dead_end/code_block"
# Integration
require_relative "dead_end/cli"
require_relative "dead_end/auto"

# Core logic
require_relative "dead_end/code_search"
require_relative "dead_end/code_frontier"
require_relative "dead_end/explain_syntax"
require_relative "dead_end/clean_document"

# Helpers
require_relative "dead_end/lex_all"
require_relative "dead_end/code_line"
require_relative "dead_end/code_block"
require_relative "dead_end/block_expand"
require_relative "dead_end/ripper_errors"
require_relative "dead_end/insertion_sort"
require_relative "dead_end/around_block_scan"
require_relative "dead_end/ripper_errors"
require_relative "dead_end/pathname_from_message"
require_relative "dead_end/display_invalid_blocks"
require_relative "dead_end/parse_blocks_from_indent_line"

require_relative "dead_end/explain_syntax"

require_relative "dead_end/auto"
require_relative "dead_end/cli"
47 changes: 47 additions & 0 deletions lib/dead_end/pathname_from_message.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# frozen_string_literal: true

module DeadEnd
# Converts a SyntaxError message to a path
#
# Handles the case where the filename has a colon in it
# such as on a windows file system: https://github.com/zombocom/dead_end/issues/111
#
# Example:
#
# message = "/tmp/scratch:2:in `require_relative': /private/tmp/bad.rb:1: syntax error, unexpected `end' (SyntaxError)"
# puts PathnameFromMessage.new(message).call.name
# # => "/tmp/scratch.rb"
#
class PathnameFromMessage
attr_reader :name

def initialize(message, io: $stderr)
@line = message.lines.first
@parts = @line.split(":")
@guess = []
@name = nil
@io = io
end

def call
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
end

self
end

def stop?
return true if @parts.empty?
return false if @guess.empty?

@name&.exist?
end
end
end
35 changes: 35 additions & 0 deletions spec/unit/pathname_from_message_spec.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# frozen_string_literal: true

require_relative "../spec_helper"

module DeadEnd
RSpec.describe "PathnameFromMessage" do
it "handles filenames with colons in them" do
Dir.mktmpdir do |dir|
dir = Pathname(dir)

file = dir.join("scr:atch.rb").tap { |p| FileUtils.touch(p) }

message = "#{file}:2:in `require_relative': /private/tmp/bad.rb:1: syntax error, unexpected `end' (SyntaxError)"
file = PathnameFromMessage.new(message).call.name

expect(file).to be_truthy
end
end

it "checks if the file exists" do
Dir.mktmpdir do |dir|
dir = Pathname(dir)

file = dir.join("scratch.rb")

message = "#{file}:2:in `require_relative': /private/tmp/bad.rb:1: syntax error, unexpected `end' (SyntaxError)"
io = StringIO.new
file = PathnameFromMessage.new(message, io: io).call.name

expect(io.string).to include(file.to_s)
expect(file).to be_falsey
end
end
end
end