eceval 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8eac2f4e105256977567c95878f0cdef4ad50ff89cb727de06f0abc9eed491de
+  data.tar.gz: 89526bf8ea8c2d04049d0f25db39d7f1071be0fb787280a34f3c483da64f624f
+SHA512:
+  metadata.gz: bb608743fec859e597016a9a71b253fbbc4c6826bc56423dff73fe179bfd2aa171b1ae2af47273e40c68dc3f8b66a6f2b301b3131fe3c1fd1a11d2b078382f8b
+  data.tar.gz: 6cc8a35647e048b2a27667beb302942e456910c992447bdf26a60ae7f7bea2026c4a0d1c7a437f43fe5ccd1a836905e3f7253f6de460e364fb014ff73034b63a

data/exe/eceval

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/eceval/cli'
+
+ARGV << '--help' if ARGV.empty?
+Eceval::CLI.run

data/lib/eceval.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+ECEVAL_MAIN_BINDING = binding
+
+module Eceval
+  EVAL_MARKER = "#=>"
+  EVAL_EXCEPTION_MARKER = "#=> !!!"
+  BEGIN_CODE_BLOCK = '```ruby'
+  END_CODE_BLOCK = '```'
+  NEW_SCOPE_DIRECTIVE = '# eceval: new_scope'
+
+  NoExceptionRaised = Class.new(RuntimeError)
+
+  def self.augment(io, out: $stdout, filename: "[String]", lineno: 1)
+    context = EvaluationContext.new(filename: filename, lineno: lineno)
+    loop do
+      break if io.eof?
+      line = io.gets
+      out.puts(context.process_line(line.chomp))
+    end
+  end
+
+  class EvaluationContext
+    attr_reader :filename, :lineno
+
+    def initialize(filename:, lineno: 1)
+      @filename = filename
+      @lineno = lineno
+      @lines_consumed = 0
+      @chunk = nil
+    end
+
+    def process_line(line)
+      if @chunk
+        process_code_line(line)
+      else
+        process_noncode_line(line)
+      end
+    ensure
+      @lines_consumed += 1
+    end
+
+    private
+
+      def process_noncode_line(line)
+        begin_chunk if line.strip == BEGIN_CODE_BLOCK
+        line
+      end
+
+      def begin_chunk
+        raise "Already chunkin" if @chunk
+
+        @chunk = Chunk.new(
+          filename: filename,
+          lineno: lineno + @lines_consumed + 1, # starts on next line
+        )
+      end
+
+      def process_code_line(line)
+        if line.strip == END_CODE_BLOCK
+          consume_chunk
+          line
+        elsif line.strip == NEW_SCOPE_DIRECTIVE
+          reset_scope
+          line
+        else
+          process_chunk_line(line)
+        end
+      end
+
+      def reset_scope
+      end
+
+      def process_chunk_line(line)
+        @chunk << line
+
+        if line.rstrip.end_with?(EVAL_MARKER)
+          result = consume_chunk
+          begin_chunk
+          line.rstrip + ' ' + result.inspect
+        elsif line.rstrip.end_with?(EVAL_EXCEPTION_MARKER)
+          ex = consume_chunk(rescue_exceptions: true)
+          begin_chunk
+          line.rstrip + ' ' + format_exception(ex)
+        else
+          line
+        end
+      end
+
+      def consume_chunk(rescue_exceptions: false)
+        old_chunk = @chunk
+        @chunk = nil
+
+        begin
+          old_chunk.evaluate
+        rescue Exception => ex
+          if rescue_exceptions
+            return ex
+          else
+            raise
+          end
+        end
+      end
+
+      def format_exception(ex)
+        unless ex.is_a?(Exception)
+          raise NoExceptionRaised, "Expected an exception at #{current_pos}" \
+            " but none was raised. Instead, the code evaluated to: " +
+            ex.inspect
+        end
+
+        "#{ex.class}: #{ex.message}"
+      end
+
+      def current_pos
+        "`#{filename}:#{lineno + @lines_consumed}`"
+      end
+  end
+
+  class Chunk
+    attr_reader :filename, :lineno
+
+    def initialize(filename:, lineno:)
+      @filename = filename
+      @lineno = lineno
+      @buffered_lines = []
+    end
+
+    def <<(line)
+      @buffered_lines << line
+    end
+
+    def evaluate
+      ECEVAL_MAIN_BINDING.eval(@buffered_lines.join("\n"), filename, lineno)
+    end
+  end
+end

data/lib/eceval/cli.rb

@@ -0,0 +1,43 @@
+require 'dry/cli'
+require_relative '../eceval'
+
+module Eceval::CLI
+  def self.run(argv: ARGV, out: $stdout, err: $stderr)
+    old_out = $stdout
+    old_err = $stderr
+
+    begin
+      $stdout = out
+      $stderr = err
+      Dry::CLI.new(Command).call(arguments: argv, out: out, err: err)
+    ensure
+      $stdout = old_out
+      $stderr = old_err
+    end
+  end
+
+  class Command < Dry::CLI::Command
+    desc "Outputs the given markdown file after augmenting the code blocks with the results of evaluation"
+    argument :path, type: :string, required: true, desc: "The path the to markdown file. Reads from STDIN if the path is '-'."
+    option :require, type: :array, default: [], desc: "Libraries to load using `require`"
+    option :load_path, type: :array, default: [], desc: "Paths to add to $LOAD_PATH"
+
+    example [
+      "path/to/my_file.md",
+      "--load_path=lib --require=mygem README.md  # load the gem in this repo before evaluation",
+    ]
+
+    def call(path:, require:, load_path:, **)
+      $LOAD_PATH.unshift(*load_path)
+      require.each { |lib| require lib }
+
+      if path == '-'
+        Eceval.augment($stdin, filename: "[STDIN]")
+      else
+        File.open(path) do |file|
+          Eceval.augment(file, filename: path)
+        end
+      end
+    end
+  end
+end

data/lib/eceval/version.rb

@@ -0,0 +1,3 @@
+module Eceval
+  VERSION = '0.1'
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: eceval
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Tom Dalling
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-08-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-cli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: test_bench
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: super_diff
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: gem-release
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email: tom@tomdalling.com
+executables:
+- eceval
+extensions: []
+extra_rdoc_files: []
+files:
+- exe/eceval
+- lib/eceval.rb
+- lib/eceval/cli.rb
+- lib/eceval/version.rb
+homepage: https://github.com/tomdalling/eceval
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '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: Evaluates Ruby code embedded in markdown, merging results
+test_files: []