dsl_evaluator 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c93e3439b6133c0d201856d61afcfe5360d0c6f8a821a00c2eb551612553a969
-  data.tar.gz: 6d074772c6075e1aea243072fcf83e2deb1e2de69bb7d3341177f1458fe417f8
+  metadata.gz: dd75a6a48ce5a9eb6858f470264eaf01af1039d93e4be1d5f609f8bc381ba297
+  data.tar.gz: d21493fb8aa7d9c78c7e873374a8037c1c40fd3991f4002c379ac0926c0e0e45
 SHA512:
-  metadata.gz: 687b819d01e035f8c5e32048776af5048932283415e9f49c08193c98f58e058e346a39c6af1f18167fc49a0f7aaa41e06db64ffcc2a89592f9e2e667cab937e3
-  data.tar.gz: 7cf6d15da7ac2debb4a04ab0dd4ca8236f97e1670a597127bcf471554bf59d72b027ed1c03a4850f1557a831a71b473cb76926f48acfcacdd5e1078028337c6c
+  metadata.gz: fa1913f87e7c7285bf3266097742353fbbb1817dface02543513798aba3d6b284b9231a8702199d3229accf57b6480f620490e15b23d92b25c9f0c03432bf742
+  data.tar.gz: 995507941a52c9b0ad3691346268ed5a30d852fb116cc7cd8132692343760411ed213f0b9815a43f20926e35b22d502d9bc3d37d4dd1062fd7d6037d86324305

data/.gitignore

@@ -6,6 +6,7 @@
 /pkg/
 /spec/reports/
 /tmp/
+/Gemfile.lock
 
 # rspec failure tracking
 .rspec_status

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.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
+
 ## [0.1.1]
 -  make module methods availables
 

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")
@@ -21,4 +21,8 @@ Gem::Specification.new do |spec|
   spec.bindir        = "exe"
   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,37 @@
+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
+    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

@@ -0,0 +1,96 @@
+module DslEvaluator
+  class Printer
+    def initialize(error)
+      @error = error
+    end
+
+    # Prints out a user friendly task_definition error message
+    def print
+      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 error_info
+      @error.message.include?("syntax") ? info_from_message : info_from_backtrace
+    end
+
+    def info_from_message
+      error_info = @error.message
+      path, line_number, _ = error_info.split(':')
+      {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
+
+      # Keep DslEvaluator.backtrace_reject for backwards compatibility
+      backtrace_reject = config.backtrace.reject_pattern || DslEvaluator.backtrace_reject
+      if backtrace_reject
+        lines = lines.reject do |l|
+          if backtrace_reject.is_a?(String)
+            l.include?(backtrace_reject)
+          else
+            l.match(backtrace_reject)
+          end
+        end
+      end
+      lines = lines.reject { |l| l.include?("lib/dsl_evaluator") } # ignore internal lib/dsl_evaluator backtrace lines
+
+      error_info = lines.first
+      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 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.1"
+  VERSION = "0.2.0"
 end

data/lib/dsl_evaluator.rb

@@ -1,51 +1,48 @@
-require "dsl_evaluator/version"
+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
+  extend Memoist
+
   class Error < StandardError; end
 
   def evaluate_file(path)
     return unless path && File.file?(path)
     instance_eval(IO.read(path), path)
   rescue Exception => e
-    evaluation_error(e)
-    puts "\nFull error:"
-    raise
+    Printer.new(e).print
+    case config.on_exception
+    when :rescue
+      # do nothing
+    when :exit
+      exit 1
+    else # :raise
+      raise
+    end
   end
 
-  @@backtrace_reject = nil
-  def backtrace_reject
-    @@backtrace_reject
+  mattr_accessor :backtrace_reject
+
+  def logger
+    config.logger
   end
 
-  def backtrace_reject=(v)
-    @@backtrace_reject = v
+  def configure(&block)
+    App.instance.configure(&block)
   end
 
-  # Prints out a user friendly task_definition error message
-  def evaluation_error(e)
-    lines = e.backtrace
-    lines = lines.reject { |l| l.include?(backtrace_reject) } if backtrace_reject
-    error_info = lines.first
-    path, line_no, _ = error_info.split(':')
-    line_no = line_no.to_i
-    puts "Error evaluating #{path}:".color(:red)
-    puts e.message
-    puts "Here's the line in #{path} with the error:\n\n"
-
-    contents = IO.read(path)
-    content_lines = contents.split("\n")
-    context = 5 # lines of context
-    top, bottom = [line_no-context-1, 0].max, line_no+context-1
-    spacing = content_lines.size.to_s.size
-    content_lines[top..bottom].each_with_index do |line_content, index|
-      line_number = top+index+1
-      if line_number == line_no
-        printf("%#{spacing}d %s\n".color(:red), line_number, line_content)
-      else
-        printf("%#{spacing}d %s\n", line_number, line_content)
-      end
-    end
+  def config
+    App.instance.config
   end
+  memoize :config
 
   extend self
 end

metadata

@@ -1,15 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: dsl_evaluator
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-12 00:00:00.000000000 Z
-dependencies: []
+date: 2022-02-24 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
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - tongueroo@gmail.com
@@ -29,6 +71,10 @@ 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
 licenses:
@@ -50,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: []