dsl_evaluator 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8435bd7d87d467ba317984fd74bd31c8af789524228a5ae8895d50856efb1d2
-  data.tar.gz: d8297543d1c5e02f2c3a2333c5f45417318f34bb32d6d10175a3b09d2dbada53
+  metadata.gz: '05298f76ff97b596a16a6914237d1fba17eebf8ad37f4e423ff2752074698486'
+  data.tar.gz: 8e4c020fafb16a52b8c029dbed7a097fd2c7532167484566f52657f04528dd6c
 SHA512:
-  metadata.gz: ac18d9e60a195db5cb84befd2ebb49eee7891f6de1b8faed08c686cceb9149d047322fa90eaebccfe11e9a66eb23c026c34eaa0ec988eadfcf30a8925e0a7822
-  data.tar.gz: 0c06aaffebf2bd326e86ddd5f45bc1dbd89a5d330e43e70b3371df3e93cb3f202b7b9b370a8ae3d35698e745b70dfe418a949d12fc4bebbf34bde9d25070225f
+  metadata.gz: ac666f500e2fd198cf926d54e36151105ae4972625a8672d2b0714544106fd9d8b59ab299cc2c2f4a24a6279661ba4a2daf5b8e5ec1f760d335c116445db7cf1
+  data.tar.gz: 05f41d031627862d8911b626ddfe8bdc3454e35af044eb37dc4b41b10d24381df8b002fa551baba82facf42c54e5906932fb44f08ee03a29d4f2bbd830ffef78

data/CHANGELOG.md

@@ -3,6 +3,15 @@
 All notable changes to this project will be documented in this file.
 This project *loosely tries* to adhere to [Semantic Versioning](http://semver.org/).
 
+## [0.3.0] - 2022-03-14
+- [#7](https://github.com/tongueroo/dsl_evaluator/pull/7) Print code improvements
+
+## [0.2.5] - 2022-03-06
+- [#6](https://github.com/tongueroo/dsl_evaluator/pull/6) DslEvaluator.print_code public method
+
+## [0.2.4] - 2022-03-03
+- print error message as part of trace
+
 ## [0.2.3] - 2022-02-27
 - [#5](https://github.com/tongueroo/dsl_evaluator/pull/5) add zeitwerk dependency
 

data/README.md

@@ -14,7 +14,6 @@ DslEvaluator.configure do |config|
   config.root = Lono.root
 end
 
-
 class Dsl
   include DslEvaluator
   def build
@@ -24,6 +23,27 @@ class Dsl
 end
 ```
 
+## Print Code Helper
+
+For other libraries where printing the code and context lines around the code is useful, you can use `DslEvaluator.print_code`.
+
+The `print_code` method understands "polymorphic" arguments.
+
+1. If the caller line info is part of a standard ruby backtrace line. Example of this is in ufo [helpers/ecr.rb](https://github.com/boltops-tools/ufo/blob/master/lib/ufo/task_definition/helpers/ecr.rb)
+
+```ruby
+call_line = ufo_config_call_line
+DslEvaluator.print_code(call_line)
+```
+
+2. If the caller line info is custom.  Example of this is in ufo [erb/yaml.rb](https://github.com/boltops-tools/ufo/blob/9247b77c6ad2a3a6307155a2a130308a24668333/lib/ufo/task_definition/erb/yaml.rb#L16)
+
+```ruby
+path = "replace with path to file"
+line_number = "replace with line number. usually can get the exception.message"
+DslEvaluator.print_code(path, line_number)
+```
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/dsl_evaluator/printer/concern.rb

@@ -0,0 +1,65 @@
+class DslEvaluator::Printer
+  module Concern
+    # So other libraries can use this method
+    # The `print_code` method understands "polymorphic" arguments.
+    # See README.md
+    def print_code(*args)
+      if args.size == 2 # print_code(path, line_number)
+        path, line_number = args
+      else # print_code(caller_line)
+        # IE: .ufo/config/web/dev.rb:10:in `block in evaluate_file'
+        # User passed in a "standard" ruby backtrace call line
+        #   windows: "C:/Ruby31-x64/lib/ruby/gems/3.1.0/gems/terraspace-1.1.1/lib/terraspace/builder.rb:34:in `build'"
+        #   linux: "/home/ec2-user/.rvm/gems/ruby-3.0.3/gems/terraspace-1.1.1/lib/terraspace/compiler/dsl/syntax/mod.rb:4:in `<module:Mod>'"
+        caller_line = args[0]
+        parts = caller_line.split(':')
+        is_windows = caller_line.match(/^[a-zA-Z]:/)  # windows vs linux
+        calling_file = is_windows ? parts[1] : parts[0]
+        line_number  = is_windows ? parts[2] : parts[1]
+        path = calling_file
+      end
+
+      check_line_number!(line_number)
+      line_number = line_number.to_i
+
+      logger.info "Here's the original caller line from:"
+      logger.info pretty_path(path).color(:green)
+
+      contents = IO.read(path)
+      content_lines = contents.split("\n")
+      context = 5 # lines of context
+      top, bottom = [line_number-context-1, 0].max, line_number+context-1
+      lpad = content_lines.size.to_s.size
+      content_lines[top..bottom].each_with_index do |line_content, index|
+        current_line = top+index+1
+        if current_line == line_number
+          printf("%#{lpad}d %s\n".color(:red), current_line, line_content)
+        else
+          printf("%#{lpad}d %s\n", current_line, line_content)
+        end
+      end
+
+      logger.info "Rerun with FULL_BACKTRACE=1 to see full backtrace" unless ENV['FULL_BACKTRACE']
+    end
+
+    def check_line_number!(line_number)
+      return line_number unless line_number.is_a?(String)
+      integer = line_number.to_i
+      if integer == 0
+        logger.error "ERROR: Think you accidentally passed in a String for the line_number: #{line_number}".color(:red)
+        puts caller
+        exit 1
+      end
+    end
+
+    def pretty_path(path)
+      path.sub("#{Dir.pwd}/",'').sub(/^\.\//,'')
+    end
+
+    # Replace HOME with ~ - different from the main pretty_path
+    def pretty_home(path)
+      path.sub(ENV['HOME'], '~')
+    end
+  end
+end
+

data/lib/dsl_evaluator/printer.rb

@@ -9,25 +9,14 @@ module DslEvaluator
       info = error_info
       path = info[:path]
       line_number = info[:line_number].to_i
-
+      logger.error "ERROR: #{@error.message}".color(:red)
       logger.error "Error evaluating #{pretty_path(path)}".color(:red)
       logger.error "Here's the line with the error:\n\n"
+      print_code(path, line_number)
+    end
 
-      contents = IO.read(path)
-      content_lines = contents.split("\n")
-      context = 5 # lines of context
-      top, bottom = [line_number-context-1, 0].max, line_number+context-1
-      lpad = content_lines.size.to_s.size
-      content_lines[top..bottom].each_with_index do |line_content, index|
-        current_line = top+index+1
-        if current_line == line_number
-          printf("%#{lpad}d %s\n".color(:red), current_line, line_content)
-        else
-          printf("%#{lpad}d %s\n", current_line, line_content)
-        end
-      end
-
-      logger.info "Rerun with FULL_BACKTRACE=1 to see full backtrace" unless ENV['FULL_BACKTRACE']
+    def print_code(path, line_number)
+      DslEvaluator.print_code(path, line_number)
     end
 
     def error_info

data/lib/dsl_evaluator/version.rb

@@ -1,3 +1,3 @@
 module DslEvaluator
-  VERSION = "0.2.3"
+  VERSION = "0.3.0"
 end

data/lib/dsl_evaluator.rb

@@ -11,6 +11,7 @@ DslEvaluator::Autoloader.setup
 
 module DslEvaluator
   extend Memoist
+  include Printer::Concern
 
   class Error < StandardError; end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dsl_evaluator
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-02-27 00:00:00.000000000 Z
+date: 2022-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -89,6 +89,7 @@ files:
 - lib/dsl_evaluator/autoloader.rb
 - lib/dsl_evaluator/logger.rb
 - lib/dsl_evaluator/printer.rb
+- lib/dsl_evaluator/printer/concern.rb
 - lib/dsl_evaluator/version.rb
 homepage: https://github.com/tongueroo/dsl_evaluator
 licenses: