dsl_evaluator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6fee21bf08bd6a94ed3d044698e91023831ed75ca9e126cf9f676c13752e515e
+  data.tar.gz: 2c5c7a7889dc51f0dafeadc91f16f453028e87e1311e861bfa68a27ae7e3c4c8
+SHA512:
+  metadata.gz: '0951a83f5c7ad782475f54dcf51ed459b07d5915b87429800572ac34ff9f102911ae8d09e4735a5ce94af025366e8a6cbcce138ea63b81c57ecdf2568e19c152'
+  data.tar.gz: 633b4714c4e8ffc16997f0c590f16385c79426424486a2f45c5019203e0d8bc62c151630d9141ff606c6db022cbc7ecc7ae492c20214d2bb421caf2aa7e4276f

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.0
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in dsl_evaluator.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Tung Nguyen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,41 @@
+# DslEvaluator
+
+Small module to help with DSL evaluation. Notably, it produces a human-friendly backtrace error showing the original user-provided source code if there's a syntax error.
+
+## Usage
+
+```ruby
+require "dsl_evaluator"
+DslEvaluator.backtrace_reject = "lib/my_gem" # optional
+
+class DslBuilder
+  def build
+    path = "/path/to/user/provided/dsl/file.rb"
+    evaluate_file(path)
+  end
+end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dsl_evaluator'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install dsl_evaluator
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/tongueroo/dsl_evaluator.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "dsl_evaluator"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/dsl_evaluator.gemspec

@@ -0,0 +1,24 @@
+require_relative 'lib/dsl_evaluator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dsl_evaluator"
+  spec.version       = DslEvaluator::VERSION
+  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.homepage      = "https://github.com/tongueroo/dsl_evaluator"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

data/lib/dsl_evaluator/version.rb

@@ -0,0 +1,3 @@
+module DslEvaluator
+  VERSION = "0.1.0"
+end

data/lib/dsl_evaluator.rb

@@ -0,0 +1,49 @@
+require "dsl_evaluator/version"
+
+module DslEvaluator
+  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
+  end
+
+  @@backtrace_reject = nil
+  def backtrace_reject
+    @@backtrace_reject
+  end
+
+  def backtrace_reject=(v)
+    @@backtrace_reject = v
+  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
+  end
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: dsl_evaluator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tung Nguyen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-05-12 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- tongueroo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- dsl_evaluator.gemspec
+- lib/dsl_evaluator.rb
+- lib/dsl_evaluator/version.rb
+homepage: https://github.com/tongueroo/dsl_evaluator
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/tongueroo/dsl_evaluator
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Small module to help with DSL evaluation. It produces a human-friendly backtrace
+  error
+test_files: []