dsl_evaluator 0.1.2 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38416a5462223f8c1b87c303e81c02d7410e76c371fde03eb03de37a9f455a90
-  data.tar.gz: 264bb6cc47c4c02a047dea7812810b741be48eca5f6298bce98510a568b3be26
+  metadata.gz: 5d712162a49ab0151d9acb686bc7613b11f242a0187f95628b5617a2fe88de58
+  data.tar.gz: 481d6aea0a1800ad8efc46af97771b99925d69bc81231ff4673c02f01d3e0d52
 SHA512:
-  metadata.gz: 76d9c1b745ce57961e5d8458e0037c16709617e821f43ce6ee6b4072b54cae60e117ea6a9540ee1fde97fca86276b7498a184a77fefc5cab9b8a603103e80042
-  data.tar.gz: bc0e3ec881d84a2ef80b16b05dbbed1c3f63877a394e9027bb409372501a557af5c08b352631ece2d49e262cde1733f7b69637bb2ca1fefce29291626501b84c
+  metadata.gz: '0854ffb84d518b498c2c32ddc16cfa0f6306645be452574cf22e878a002959be6792bd4f7dd0ef4e1af20460ea5443f74164bdf5cbef58a8f0a6fd48429d0062'
+  data.tar.gz: d66dd8eaf3d9317e74227d9fef78cdfae27f6db990587b7c80a0be29ab1b2f47c2f87c83a408fccb9b59728ca55887121798473ffcefef92af2bffead1df6e38

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.2.1] - 2022-02-25
+- [#4](https://github.com/tongueroo/dsl_evaluator/pull/4) add config.select_pattern option
+
+## [0.2.0] - 2022-02-24
+- [#3](https://github.com/tongueroo/dsl_evaluator/pull/3) major improvements: configure ability
+
+## [0.1.3]
+- #2 fix current line number printed
+
 ## [0.1.2]
 - #1 get line info from error message also
 

data/README.md

@@ -4,14 +4,22 @@ Small module to help with DSL evaluation. Notably, it produces a human-friendly
 
 ## Usage
 
+Example usage:
+
 ```ruby
-require "dsl_evaluator"
-DslEvaluator.backtrace_reject = "lib/my_gem" # optional
+DslEvaluator.configure do |config|
+  config.backtrace.reject_pattern = "/lib/lono"
+  config.logger = Lono.logger
+  config.on_exception = :exit
+  config.root = Lono.root
+end
+
 
-class DslBuilder
+class Dsl
+  include DslEvaluator
   def build
     path = "/path/to/user/provided/dsl/file.rb"
-    evaluate_file(path)
+    evaluate_file(path) # from DslEvaluator module
   end
 end
 ```

data/dsl_evaluator.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Tung Nguyen"]
   spec.email         = ["tongueroo@gmail.com"]
 
-  spec.summary       = "Small module to help with DSL evaluation. It produces a human-friendly backtrace error"
+  spec.summary       = "DSL evaluation library. It produces a human-friendly backtrace error"
   spec.homepage      = "https://github.com/tongueroo/dsl_evaluator"
   spec.license       = "MIT"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
@@ -22,5 +22,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "activesupport"
+  spec.add_dependency "memoist"
   spec.add_dependency "rainbow"
 end

data/lib/dsl_evaluator/app.rb

@@ -0,0 +1,38 @@
+module DslEvaluator
+  class App
+    extend Memoist
+    include Singleton
+
+    attr_reader :config
+    def initialize
+      @config = defaults
+    end
+
+    def defaults
+      config = ActiveSupport::OrderedOptions.new
+
+      config.logger = default_logger
+      config.logger.formatter = Logger::Formatter.new
+      config.logger.level = ENV['DSL_EVALUATOR_LOG_LEVEL'] || :info
+
+      config.on_exception = :raise
+
+      config.root = Dir.pwd
+
+      config.backtrace = ActiveSupport::OrderedOptions.new
+      config.backtrace.reject_pattern = nil # dont use .reject. Seems its used internally by ActiveSupport::OrderedOptions
+      config.backtrace.select_pattern = nil
+
+      config
+    end
+
+    def default_logger
+      Logger.new(ENV['DSL_EVALUATOR_LOG_PATH'] || $stderr)
+    end
+    memoize :default_logger
+
+    def configure
+      yield(@config)
+    end
+  end
+end

data/lib/dsl_evaluator/autoloader.rb

@@ -0,0 +1,20 @@
+module DslEvaluator
+  class Autoloader
+    class Inflector < Zeitwerk::Inflector
+      def camelize(basename, _abspath)
+        map = { cli: "CLI", version: "VERSION" }
+        map[basename.to_sym] || super
+      end
+    end
+
+    class << self
+      def setup
+        loader = Zeitwerk::Loader.new
+        loader.inflector = Inflector.new
+        loader.push_dir(File.dirname(__dir__)) # lib
+        loader.log! if ENV["DSL_EVALUATOR_AUTOLOAD_LOG"]
+        loader.setup
+      end
+    end
+  end
+end

data/lib/dsl_evaluator/logger.rb

@@ -0,0 +1,30 @@
+module DslEvaluator
+  class Logger < ::Logger
+    def initialize(*args)
+      super
+      self.formatter = Formatter.new
+      self.level = ENV['DSL_EVALUATOR_LOG_LEVEL'] || :info # note: only respected when config.logger not set in config/app.rb
+    end
+
+    def format_message(severity, datetime, progname, msg)
+      line = if @logdev.dev == $stdout || @logdev.dev == $stderr || @logdev.dev.is_a?(StringIO)
+        msg # super simple format if stdout
+      else
+        super # use the configured formatter
+      end
+      line =~ /\n$/ ? line : "#{line}\n"
+    end
+
+    # Used to allow output to always go to stdout
+    def stdout(msg, newline: true)
+      if newline
+        puts msg
+      else
+        print msg
+      end
+    end
+
+    public :print
+    public :printf
+  end
+end

data/lib/dsl_evaluator/printer.rb

@@ -4,16 +4,33 @@ module DslEvaluator
       @error = error
     end
 
-    def message
-      @error.message
-    end
-
     # Prints out a user friendly task_definition error message
     def print
-      print_source(info)
+      info = error_info
+      path = info[:path]
+      line_number = info[:line_number].to_i
+
+      logger.error "Error evaluating #{pretty_path(path)}".color(:red)
+      logger.error "Here's the line with the error:\n\n"
+
+      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 info
+    def error_info
       @error.message.include?("syntax") ? info_from_message : info_from_backtrace
     end
 
@@ -23,39 +40,76 @@ module DslEvaluator
       {path: path, line_number: line_number}
     end
 
+    # Grab info so can print out user friendly error message
+    #
+    # Backtrace lines are different for OSes:
+    #
+    #   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>'"
+    #
     def info_from_backtrace
       lines = @error.backtrace
+      if ENV['FULL_BACKTRACE']
+        logger.error @error.message.color(:red)
+        logger.error lines.join("\n")
+      end
 
-      backtrace_reject = DslEvaluator.backtrace_reject
-      lines = lines.reject { |l| l.include?(backtrace_reject) } if backtrace_reject
-      lines = lines.reject { |l| l.include?("lib/dsl_evaluator") } # ignore internal lib/dsl_evaluator backtrace lines
+      lines = reject(lines)
+      lines = select(lines)
 
       error_info = lines.first
-      path, line_number, _ = error_info.split(':')
+      parts = error_info.split(':')
+      windows = error_info.match(/^[a-zA-Z]:/)
+      path = windows ? parts[1] : parts[0]
+      line_number = windows ? parts[2] : parts[1]
+      line_number = line_number.to_i
+
       {path: path, line_number: line_number}
     end
 
-    def print_source(info={})
-      path = info[:path]
-      line_number = info[:line_number].to_i
+    def reject(lines)
+      # Keep DslEvaluator.backtrace_reject for backwards compatibility
+      pattern = config.backtrace.reject_pattern || DslEvaluator.backtrace_reject
+      return lines unless pattern
 
-      puts "Error evaluating #{path}:".color(:red)
-      puts @error.message
-      puts "Here's the line in #{path} with the error:\n\n"
+      lines.reject! do |l|
+        if pattern.is_a?(String)
+          l.include?(pattern)
+        else
+          l.match(pattern)
+        end
+      end
+      # Always ignore internal lib/dsl_evaluator backtrace lines
+      lines.reject { |l| l.include?("lib/dsl_evaluator") }
+    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), line_number, line_content)
+    def select(lines)
+      pattern = config.backtrace.select_pattern
+      return unless pattern
+
+      lines.select do |l|
+        if pattern.is_a?(String)
+          l.include?(pattern)
         else
-          printf("%#{lpad}d %s\n", line_number, line_content)
+          l.match(pattern)
         end
       end
     end
+
+    def pretty_path(path)
+      path.sub("#{config.root}/",'')
+    end
+
+    def logger
+      config.logger
+    end
+
+    def config
+      DslEvaluator.config
+    end
+
+    def message
+      @error.message
+    end
   end
 end

data/lib/dsl_evaluator/version.rb

@@ -1,3 +1,3 @@
 module DslEvaluator
-  VERSION = "0.1.2"
+  VERSION = "0.2.1"
 end

data/lib/dsl_evaluator.rb

@@ -1,8 +1,16 @@
-require "dsl_evaluator/version"
-require "rainbow/ext/string"
+require 'active_support'
+require 'active_support/core_ext/class'
+require 'active_support/core_ext/hash'
+require 'active_support/core_ext/string'
+require 'dsl_evaluator/version'
+require 'memoist'
+require 'rainbow/ext/string'
+
+require "dsl_evaluator/autoloader"
+DslEvaluator::Autoloader.setup
 
 module DslEvaluator
-  autoload :Printer, "dsl_evaluator/printer"
+  extend Memoist
 
   class Error < StandardError; end
 
@@ -11,18 +19,30 @@ module DslEvaluator
     instance_eval(IO.read(path), path)
   rescue Exception => e
     Printer.new(e).print
-    puts "\nFull error:"
-    raise
+    case config.on_exception
+    when :rescue
+      # do nothing
+    when :exit
+      exit 1
+    else # :raise
+      raise
+    end
+  end
+
+  mattr_accessor :backtrace_reject
+
+  def logger
+    config.logger
   end
 
-  @@backtrace_reject = nil
-  def backtrace_reject
-    @@backtrace_reject
+  def configure(&block)
+    App.instance.configure(&block)
   end
 
-  def backtrace_reject=(v)
-    @@backtrace_reject = v
+  def config
+    App.instance.config
   end
+  memoize :config
 
   extend self
 end

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: dsl_evaluator
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.1
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-30 00:00:00.000000000 Z
+date: 2022-02-25 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: memoist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rainbow
   requirement: !ruby/object:Gem::Requirement
@@ -43,6 +71,9 @@ files:
 - bin/setup
 - dsl_evaluator.gemspec
 - lib/dsl_evaluator.rb
+- lib/dsl_evaluator/app.rb
+- lib/dsl_evaluator/autoloader.rb
+- lib/dsl_evaluator/logger.rb
 - lib/dsl_evaluator/printer.rb
 - lib/dsl_evaluator/version.rb
 homepage: https://github.com/tongueroo/dsl_evaluator
@@ -65,9 +96,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.32
 signing_key: 
 specification_version: 4
-summary: Small module to help with DSL evaluation. It produces a human-friendly backtrace
-  error
+summary: DSL evaluation library. It produces a human-friendly backtrace error
 test_files: []