rstfilter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: acaf57f79e7bee11c42958205a4970e6c85a2de855f82513076e40eba42a5d4d
+  data.tar.gz: 540a4a20d663769298947079626f5ec8d4ff1d10d72d724d126d5a7a2f9400bd
+SHA512:
+  metadata.gz: a3371ad347e2797e051a9c9ac0621eca32022aae6b41ef859c961928e3b1159235e64e75e307901ca8dc17dba27e9e9e56d8646af02683b1eddc8eb2b68184a1
+  data.tar.gz: 7abd528a4b660261a2be171609191c16ee848348ad0e6adf7d7c5421ba3aabf4757be69657f3fb6c6b4195083c4c9102d85964a10d086189a843924a923684d2

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.3
+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 rstfilter.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "minitest", "~> 5.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Koichi Sasada
+
+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,72 @@
+# Rstfilter
+
+This tool prints a Ruby script with execution results.
+
+```
+$ cat sample.rb
+a = 1
+b = 2
+c = a + b
+puts "Hello" * c
+
+$ rstfilter sample.rb -a
+a = 1                                              #=> 1
+b = 2                                              #=> 2
+c = a + b                                          #=> 3
+puts "Hello" * c                                   #=> nil
+#out: HelloHelloHello
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rstfilter'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install rstfilter
+
+## Usage
+
+```
+Usage: rstfilter [options] SCRIPT
+    -c, --comment                    Show result only on comment
+    -o, --output                     Show output results
+    -d, --decl                       Show results on declaration
+        --no-exception               Do not show exception
+    -a, --all                        Show all results/output
+        --pp                         Use pp to represent objects
+        --comment-indent=NUM         Specify comment indent size (default: 50)
+        --verbose                    Verbose mode
+```
+
+## Implementation
+
+With parser gem, rstfilter translates the given script and run it.
+
+For example, the first example is translated to:
+
+```ruby
+(a = (1).__rst_record__(1, 5)).__rst_record__(1, 5)
+(b = (2).__rst_record__(2, 5)).__rst_record__(2, 5)
+(c = (a + b).__rst_record__(3, 9)).__rst_record__(3, 9)
+(puts "Hello" * c).__rst_record__(4, 16)
+```
+
+and `__rst_record__` method records the results. After that, rstfilter prints the script with the results.
+`--verbose` option shows the translated script and collected results.
+
+## Contribution
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ko1/rstfilter.
+
+## 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,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rstfilter"
+
+# 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/exe/rstfilter

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+begin
+  require 'rstfilter'
+rescue LoadError
+  $:.unshift File.expand_path('../lib', __dir__)
+  require 'rstfilter'
+end
+
+f = RstFilter::Exec.new
+f.optparse! ARGV
+ARGV.each{|name| f.process name}

data/lib/rstfilter/version.rb

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

data/lib/rstfilter.rb

@@ -0,0 +1,287 @@
+# require "rstfilter/version"
+
+require 'parser/current'
+require 'stringio'
+require 'optparse'
+require 'ostruct'
+require 'pp'
+
+module RstFilter
+  class RecordAll < Parser::TreeRewriter
+    def initialize opt
+      @decl = opt.show_decl || (opt.show_all_results == false)
+
+      super()
+    end
+
+    def add_record node
+      if le = node&.location&.expression
+        insert_before(le.begin, '(')
+        insert_after(le.end, ").__rst_record__(#{le.end.line}, #{le.end.column})")
+      end
+    end
+
+    def process node
+      return unless node
+      case node.type
+      when :resbody, :rescue, :begin
+        # skip
+      when :def, :class
+        add_record node if @decl
+      else
+        add_record node
+      end
+
+      super
+    end
+
+    def on_class node
+      _name, sup, body = node.children
+      process sup
+      process body
+    end
+
+    def on_def node
+      _name, args, body = node.children
+      args.children.each{|arg|
+        case arg.type
+        when :optarg
+          _name, opexpr = arg.children
+          process opexpr
+        when :kwoptarg
+          _name, kwexpr = arg.children
+          process kwexpr
+        end
+      }
+      process body
+    end
+
+    def on_send node
+    end
+  end
+
+  class Exec
+    DEFAULT_SETTING = {
+      # default setting
+      show_all_results: true,
+      show_exceptions: true,
+      show_output: false,
+      show_decl: false,
+      show_specific_line: nil,
+
+      use_pp: false,
+      comment_indent: 50,
+      comment_pattern: '#=>',
+      verbose: false,
+    }
+
+    ConfigOption = Struct.new(*DEFAULT_SETTING.keys, keyword_init: true)
+
+    def update_opt opt = {}
+      opt = @opt.to_h.merge(opt)
+      @opt = ConfigOption.new(**opt)
+    end
+    
+    def initialize
+      @opt = ConfigOption.new(**DEFAULT_SETTING)
+    end
+
+    def optparse! argv
+      opt = {}
+      o = OptionParser.new
+      o.on('-c', '--comment', 'Show result only on comment'){
+        opt[:show_all_results] = false
+      }
+      o.on('-o', '--output', 'Show output results'){
+        opt[:show_output] = true
+      }
+      o.on('-d', '--decl', 'Show results on declaration'){
+        opt[:show_decl] = true
+      }
+      o.on('--no-exception', 'Do not show exception'){
+        opt[:show_exception] = false
+      }
+      o.on('-a', '--all', 'Show all results/output'){
+        opt[:show_output]      = true
+        opt[:show_all_results] = true
+        opt[:show_exceptions]  = true
+      }
+      o.on('--pp', 'Use pp to represent objects'){
+        opt[:use_pp] = true
+      }
+      o.on('--comment-indent=NUM', "Specify comment indent size (default: #{DEFAULT_SETTING[:comment_indent]})"){|n|
+        opt[:comment_indent] = n.to_i
+      }
+      o.on('--verbose', 'Verbose mode'){
+        opt[:verbose] = true
+      }
+      o.parse!(argv)
+      update_opt opt
+    end
+
+    def capture_out
+      return yield unless @opt.show_output
+
+      begin
+        prev_out = $stdout
+        prev_err = $stderr
+
+        $captured_out = $stdout = StringIO.new
+        if false # debug
+          $captured_err = $captured_out
+        else
+          $captured_err = $stderr = StringIO.new
+        end
+
+        yield
+      ensure
+        $stdout = prev_out
+        $stderr = prev_err
+      end
+    end
+
+    def record_rescue
+      if @opt.show_exceptions
+        TracePoint.new(:raise) do |tp|
+          caller_locations.each{|loc|
+            if loc.path == @filename
+              $__rst_record[loc.lineno][0] = [tp.raised_exception, '', '']
+              break
+            end
+          }
+        end.enable do
+          yield
+        end
+      else
+        yield
+      end
+    end
+
+    class ::BasicObject
+      def __rst_record__ line, col
+        out, err = *[$captured_out, $captured_err].map{|o|
+          str = o.string
+          o.string = ''
+          str
+        } if $captured_out
+
+        # ::STDERR.puts [line, col, self, out, err].inspect
+        $__rst_record[line][col] = [self, out, err]
+
+        self
+      end
+    end
+
+    $__rst_record = Hash.new{|h, k| h[k] = []}
+
+    def process filename
+      @filename = filename
+
+      code = File.read(filename)
+
+      begin
+        ast, comments = Parser::CurrentRuby.parse_with_comments(code)
+      rescue Parser::SyntaxError => e
+        puts e
+        exit 1
+      end
+
+      end_line = ast.loc.expression.end.line
+      code = code.lines[0..end_line].join # remove __END__ and later
+
+      buffer        = Parser::Source::Buffer.new('(example)')
+      buffer.source = code
+      rewriter      = RecordAll.new @opt
+
+      mod_src = rewriter.rewrite(buffer, ast)
+      puts mod_src.lines.map.with_index{|line, i| '%4d: %s' % [i+1, line] } if @opt.verbose
+
+      begin
+        capture_out do
+          record_rescue do
+            ::TOPLEVEL_BINDING.eval(mod_src, filename)
+          end
+        end
+      rescue Exception => e
+        if @opt.verbose
+          STDERR.puts e
+          STDERR.puts e.backtrace
+        else
+          STDERR.puts "RstFilter: exit with #{e.inspect}"
+        end
+      end
+
+      replace_comments = {}
+
+      comments.each{|c|
+        next unless c.text.start_with? @opt.comment_pattern
+        e = c.loc.expression
+        line, _col = e.begin.line, e.begin.column
+        if $__rst_record.has_key? line
+          result = $__rst_record[line].last
+          replace_comments[line] = result
+        end
+      }
+
+      pp $__rst_record if @opt.verbose
+
+      code.each_line.with_index{|line, i|
+        line_result = $__rst_record[i+1]&.last
+
+        if line_result && line.match(/(.+)#{@opt.comment_pattern}.*$/)
+          prefix = $1
+          r = line_result.first
+          if @opt.use_pp
+            result_lines = PP.pp(r, '').lines
+          else
+            result_lines = r.inspect.lines
+          end
+          puts line.sub(/#{@opt.comment_pattern}.*$/, "#{@opt.comment_pattern} #{result_lines.shift.chomp}")
+          cont_comment = '#' + ' ' * @opt.comment_pattern.size
+          result_lines.each{|result_line|
+            puts ' ' * prefix.size + "#{cont_comment}#{result_line}"
+          }
+        elsif @opt.show_all_results && line_result
+          r = line_result.first
+          indent = ' ' * [@opt.comment_indent - line.chomp.length, 0].max
+          if @opt.use_pp
+            result_lines = PP.pp(r, '').lines
+          else
+            result_lines = r.inspect.lines
+          end
+          prefix = line.chomp.concat "#{indent}"
+          puts "#{prefix} #=> #{result_lines.shift}"
+          cont_comment = '#' + ' ' * @opt.comment_pattern.size
+          result_lines.each{|result_line|
+            puts ' ' * prefix.size + " #{cont_comment}#{result_line}"
+          }
+        else
+          puts line
+        end
+
+        if @opt.show_output && line_result
+          out, err = *line_result[1..2]
+          if m = line.match(/^\s+/)
+            indent = ' ' * m[0].size
+          else
+            indent = ''
+          end
+
+          {out: out, err: err}.each{|k, o|
+            o.strip!
+            o.each_line{|ol|
+              puts "#{indent}##{k}: #{ol}"
+            } unless o.empty?
+          }
+        end
+      }
+    end
+  end
+end
+
+if __FILE__ == $0
+  filter = RstFilter::Exec.new
+  filter.optparse ARGV
+  file = ARGV.shift
+  filter.process File.expand_path(file)
+end

data/rstfilter.gemspec

@@ -0,0 +1,31 @@
+require_relative 'lib/rstfilter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rstfilter"
+  spec.version       = Rstfilter::VERSION
+  spec.authors       = ["Koichi Sasada"]
+  spec.email         = ["ko1@atdot.net"]
+
+  spec.summary       = %q{Show Ruby script with execution results.}
+  spec.description   = %q{Show Ruby script with execution results.}
+  spec.homepage      = "https://github.com/ko1/rstfilter"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_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"]
+
+  spec.add_runtime_dependency 'parser'
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: rstfilter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Koichi Sasada
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-05-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: parser
+  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: Show Ruby script with execution results.
+email:
+- ko1@atdot.net
+executables:
+- rstfilter
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/rstfilter
+- lib/rstfilter.rb
+- lib/rstfilter/version.rb
+- rstfilter.gemspec
+homepage: https://github.com/ko1/rstfilter
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ko1/rstfilter
+  source_code_uri: https://github.com/ko1/rstfilter
+  changelog_uri: https://github.com/ko1/rstfilter
+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.6
+signing_key: 
+specification_version: 4
+summary: Show Ruby script with execution results.
+test_files: []