dead_end 3.0.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 72373898d38363c0ea0c3cec7fe2747399724ce55dae4eca1ce57b8f59dfc767
-  data.tar.gz: 9e99a5fddb8a054b839aef4fe1c2b87792bc9b4161bf5a6689156f2999dca935
+  metadata.gz: c232ccfce002bd3a79d6a5508ea46b27684a9a0ae2bb5d6f843d49e5ba59c0ac
+  data.tar.gz: 745847314c5c3ff09cb85b525a5d583f89c1c597e1f5b785ed54e01299bb72c4
 SHA512:
-  metadata.gz: 7312a010846453f222bbb8717738831f9a2e23572eace345ed7738f00429c126d1a4760548ad9e7552237aee057b5c5bae90b7a0fe197144c3a9dc9d3db2ab0b
-  data.tar.gz: 0db2b356ab237f01eda6dc5ebeac0156c317d94535c2b59d099f766e1716d5d6f6b429edcc65bf439dea1bc15e1866f4d66a41cd28d927a29a666f54f54ee804
+  metadata.gz: c49f5b58a7a2f222606a01efc3256a2a0eceade66ff6e46f7c15172cf972a48aa4b6d55212eb714ad69dde1b6d80e91cf8589a9b7026ad2b3e9baafabb8c2e6c
+  data.tar.gz: f70fc9947a92d8de2d8f05e08ab803a791c9fc396f03a0bed812b0a88bdb74af33658b23ebdf148adbc716cc41870bee8fabe57c3ae62bd6c9e9b063717f0bbc

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## HEAD (unreleased)
 
+## 3.0.1
+
+- Fix CLI parsing when flags come before filename (https://github.com/zombocom/dead_end/pull/102)
+
 ## 3.0.0
 
 - [Breaking] Remove previously deprecated `require "dead_end/fyi"` interface (https://github.com/zombocom/dead_end/pull/94)

data/Gemfile

@@ -9,3 +9,4 @@ gem "rake", "~> 12.0"
 gem "rspec", "~> 3.0"
 gem "stackprof"
 gem "standard"
+gem "ruby-prof"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    dead_end (3.0.0)
+    dead_end (3.0.1)
 
 GEM
   remote: https://rubygems.org/
@@ -42,6 +42,7 @@ GEM
     rubocop-performance (1.11.5)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
+    ruby-prof (1.4.3)
     ruby-progressbar (1.11.0)
     stackprof (0.2.16)
     standard (1.3.0)
@@ -56,8 +57,9 @@ DEPENDENCIES
   dead_end!
   rake (~> 12.0)
   rspec (~> 3.0)
+  ruby-prof
   stackprof
   standard
 
 BUNDLED WITH
-   2.2.29
+   2.2.30

data/README.md

@@ -170,7 +170,27 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 You can see changes to output against a variety of invalid code by running specs and using the `DEBUG_DISPLAY=1` environment variable. For example:
 
 ```
-$ DEBUG_DISPLAY=1 be rspec spec/ --format=failures
+$ DEBUG_DISPLAY=1 bundle exec rspec spec/ --format=failures
+```
+
+### Run profiler
+
+You can output profiler data to the `tmp` directory by running:
+
+```
+$ DEBUG_PERF=1 bundle exec rspec spec/integration/dead_end_spec.rb
+```
+
+Some outputs are in text format, some are html, the raw marshaled data is available in `raw.rb.marshal`. See https://ruby-prof.github.io/#reports for more info. One interesting one, is the "kcachegrind" interface. To view this on mac:
+
+```
+$ brew install qcachegrind
+```
+
+Open:
+
+```
+$ qcachegrind tmp/last/profile.callgrind.out.<numbers>
 ```
 
 ## Contributing

data/lib/dead_end/clean_document.rb

@@ -85,17 +85,16 @@ module DeadEnd
   #
   class CleanDocument
     def initialize(source:)
-      @source = source
+      @source = clean_sweep(source: source)
       @document = CodeLine.from_source(@source)
     end
 
     # Call all of the document "cleaners"
     # and return self
     def call
-      clean_sweep
-        .join_trailing_slash!
-        .join_consecutive!
-        .join_heredoc!
+      join_trailing_slash!
+      join_consecutive!
+      join_heredoc!
 
       self
     end
@@ -122,17 +121,15 @@ module DeadEnd
     #       puts "world"
     #     EOM
     #
-    #     lines = CleanDocument.new(source: source).clean_sweep.lines
+    #     lines = CleanDocument.new(source: source).lines
     #     expect(lines[0].to_s).to eq("\n")
     #     expect(lines[1].to_s).to eq("puts "hello")
     #     expect(lines[2].to_s).to eq("\n")
     #     expect(lines[3].to_s).to eq("puts "world")
     #
-    # WARNING:
-    # If you run this after any of the "join" commands, they
-    # will be un-joined.
+    # Important: This must be done before lexing.
     #
-    # After this change is made, we re-lex the document because
+    # After this change is made, we lex the document because
     # removing comments can change how the doc is parsed.
     #
     # For example:
@@ -142,7 +139,9 @@ module DeadEnd
     #         # comment
     #         where(name: 'schneems')
     #     EOM
-    #     expect(values.count {|v| v.type == :on_ignored_nl}).to eq(1)
+    #     expect(
+    #       values.count {|v| v.type == :on_ignored_nl}
+    #     ).to eq(1)
     #
     # After the comment is removed:
     #
@@ -151,26 +150,18 @@ module DeadEnd
     #
     #         where(name: 'schneems')
     #     EOM
-    #     expect(values.count {|v| v.type == :on_ignored_nl}).to eq(2)
+    #     expect(
+    #      values.count {|v| v.type == :on_ignored_nl}
+    #    ).to eq(2)
     #
-    def clean_sweep
-      source = @document.map do |code_line|
-        # Clean trailing whitespace on empty line
-        if code_line.line.strip.empty?
-          next CodeLine.new(line: "\n", index: code_line.index, lex: [])
+    def clean_sweep(source:)
+      source.lines.map do |line|
+        if line.match?(/^\s*(#[^{].*)?$/) # https://rubular.com/r/LLE10D8HKMkJvs
+          $/
+        else
+          line
         end
-
-        # Remove comments
-        if code_line.lex.detect { |lex| lex.type != :on_sp }&.type == :on_comment
-          next CodeLine.new(line: "\n", index: code_line.index, lex: [])
-        end
-
-        code_line
       end.join
-
-      @source = source
-      @document = CodeLine.from_source(source)
-      self
     end
 
     # Smushes all heredoc lines into one line

data/lib/dead_end/cli.rb

@@ -12,7 +12,7 @@ module DeadEnd
   #   Cli.new(argv: ["<path/to/file>.rb", "--terminal"]).call
   #
   class Cli
-    attr_accessor :options, :file_name
+    attr_accessor :options
 
     # ARGV is Everything passed to the executable, does not include executable name
     #
@@ -26,22 +26,33 @@ module DeadEnd
 
       @io = io
       @argv = argv
-      @file_name = argv[0]
       @exit_obj = exit_obj
     end
 
     def call
-      if file_name.nil? || file_name.empty?
+      if @argv.empty?
         # Display help if raw command
         parser.parse! %w[--help]
+        return
       else
+        # Mutates @argv
         parse
+        return if options[:exit]
       end
 
-      # Needed for testing since we fake exit
-      return if options[:exit]
+      file_name = @argv.first
+      if file_name.nil?
+        @io.puts "No file given"
+        @exit_obj.exit(1)
+        return
+      end
 
       file = Pathname(file_name)
+      if !file.exist?
+        @io.puts "file not found: #{file.expand_path} "
+        @exit_obj.exit(1)
+        return
+      end
 
       @io.puts "Record dir: #{options[:record_dir]}" if options[:record_dir]
 

data/lib/dead_end/code_frontier.rb

@@ -52,14 +52,14 @@ module DeadEnd
   class CodeFrontier
     def initialize(code_lines:)
       @code_lines = code_lines
-      @frontier = []
+      @frontier = InsertionSort.new
       @unvisited_lines = @code_lines.sort_by(&:indent_index)
       @has_run = false
       @check_next = true
     end
 
     def count
-      @frontier.count
+      @frontier.to_a.length
     end
 
     # Performance optimization
@@ -89,7 +89,7 @@ module DeadEnd
     def holds_all_syntax_errors?(block_array = @frontier, can_cache: true)
       return false if can_cache && can_skip_check?
 
-      without_lines = block_array.flat_map do |block|
+      without_lines = block_array.to_a.flat_map do |block|
         block.lines
       end
 
@@ -101,7 +101,7 @@ module DeadEnd
 
     # Returns a code block with the largest indentation possible
     def pop
-      @frontier.pop
+      @frontier.to_a.pop
     end
 
     def next_indent_line
@@ -109,15 +109,15 @@ module DeadEnd
     end
 
     def expand?
-      return false if @frontier.empty?
-      return true if @unvisited_lines.empty?
+      return false if @frontier.to_a.empty?
+      return true if @unvisited_lines.to_a.empty?
 
-      frontier_indent = @frontier.last.current_indent
+      frontier_indent = @frontier.to_a.last.current_indent
       unvisited_indent = next_indent_line.indent
 
       if ENV["DEBUG"]
         puts "```"
-        puts @frontier.last.to_s
+        puts @frontier.to_a.last.to_s
         puts "```"
         puts "  @frontier indent:  #{frontier_indent}"
         puts "  @unvisited indent: #{unvisited_indent}"
@@ -141,13 +141,13 @@ module DeadEnd
       register_indent_block(block)
 
       # Make sure we don't double expand, if a code block fully engulfs another code block, keep the bigger one
-      @frontier.reject! { |b|
+      @frontier.to_a.reject! { |b|
         b.starts_at >= block.starts_at && b.ends_at <= block.ends_at
       }
 
       @check_next = true if block.invalid?
       @frontier << block
-      @frontier.sort!
+      # @frontier.sort!
 
       self
     end
@@ -167,7 +167,7 @@ module DeadEnd
     # Given that we know our syntax error exists somewhere in our frontier, we want to find
     # the smallest possible set of blocks that contain all the syntax errors
     def detect_invalid_blocks
-      self.class.combination(@frontier.select(&:invalid?)).detect do |block_array|
+      self.class.combination(@frontier.to_a.select(&:invalid?)).detect do |block_array|
         holds_all_syntax_errors?(block_array, can_cache: false)
       end || []
     end

data/lib/dead_end/code_search.rb

@@ -43,8 +43,7 @@ module DeadEnd
 
     def initialize(source, record_dir: ENV["DEAD_END_RECORD_DIR"] || ENV["DEBUG"] ? "tmp" : nil)
       if record_dir
-        @time = Time.now.strftime("%Y-%m-%d-%H-%M-%s-%N")
-        @record_dir = Pathname(record_dir).join(@time).tap { |p| p.mkpath }
+        @record_dir = DeadEnd.record_dir(record_dir)
         @write_count = 0
       end
 

data/lib/dead_end/insertion_sort.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module DeadEnd
+  # Sort elements on insert
+  #
+  # Instead of constantly calling `sort!`, put
+  # the element where it belongs the first time
+  # around
+  #
+  # Example:
+  #
+  #   sorted = InsertionSort.new
+  #   sorted << 33
+  #   sorted << 44
+  #   sorted << 1
+  #   puts sorted.to_a
+  #   # => [1, 44, 33]
+  #
+  class InsertionSort
+    def initialize
+      @array = []
+    end
+
+    def <<(value)
+      insert_in = @array.length
+      @array.each.with_index do |existing, index|
+        case value <=> existing
+        when -1
+          insert_in = index
+          break
+        when 0
+          insert_in = index
+          break
+        when 1
+          # Keep going
+        end
+      end
+
+      @array.insert(insert_in, value)
+    end
+
+    def to_a
+      @array
+    end
+  end
+end

data/lib/dead_end/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DeadEnd
-  VERSION = "3.0.0"
+  VERSION = "3.0.1"
 end

data/lib/dead_end.rb

@@ -28,6 +28,16 @@ module DeadEnd
     raise e
   end
 
+  def self.record_dir(dir)
+    time = Time.now.strftime("%Y-%m-%d-%H-%M-%s-%N")
+    dir = Pathname(dir)
+    symlink = dir.join("last").tap { |path| path.delete if path.exist? }
+    dir.join(time).tap { |path|
+      path.mkpath
+      FileUtils.symlink(path.basename, symlink)
+    }
+  end
+
   def self.call(source:, filename: DEFAULT_VALUE, terminal: DEFAULT_VALUE, record_dir: nil, timeout: TIMEOUT_DEFAULT, io: $stderr)
     search = nil
     filename = nil if filename == DEFAULT_VALUE
@@ -137,6 +147,7 @@ require_relative "dead_end/clean_document"
 
 require_relative "dead_end/lex_all"
 require_relative "dead_end/block_expand"
+require_relative "dead_end/insertion_sort"
 require_relative "dead_end/around_block_scan"
 require_relative "dead_end/ripper_errors"
 require_relative "dead_end/display_invalid_blocks"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dead_end
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.1
 platform: ruby
 authors:
 - schneems
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-11-03 00:00:00.000000000 Z
+date: 2021-11-04 00:00:00.000000000 Z
 dependencies: []
 description: When you get an "unexpected end" in your syntax this gem helps you find
   it
@@ -49,6 +49,7 @@ files:
 - lib/dead_end/display_code_with_line_numbers.rb
 - lib/dead_end/display_invalid_blocks.rb
 - lib/dead_end/explain_syntax.rb
+- lib/dead_end/insertion_sort.rb
 - lib/dead_end/left_right_lex_count.rb
 - lib/dead_end/lex_all.rb
 - lib/dead_end/lex_value.rb