mvz-live_ast 1.3.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b18e5a7959690642e875e7b776078be049ae2dba272c3baa1a6facc3e742fe3e
-  data.tar.gz: '09b7a8ee5dff78a77429a0cd20bf380906ce7aeb588719356b15c13aa1952bf6'
+  metadata.gz: c77dc5f539e5e56367987217f1a7389f37806f2da4ec1c3f55fb9b53d03c2172
+  data.tar.gz: 75a943f11e62f41dd4cfcd2984b8d7fd972d180d7e8b551e8f13282d55eba95c
 SHA512:
-  metadata.gz: 2d294134feb237eb588715cbf816fed1a1ff7bac1ebe00b22cf0ed379b2815f92b7f8cbfb646ba12cb14bdfea0ca5c6732aae8c1882fcef8f8e4e97f3ed4d2d5
-  data.tar.gz: 0ac2c1d2c64c0c079dca1f8003cb1a21946449da0cb9c47e977c269627081698da6d1366e765c7347906af3a36c9c752c0aaf88f77506188a3080377115f1923
+  metadata.gz: 0e4a9b8778a9ba187553712fcfb20611df3ed73e6cbf441dea5e2505c3f345d5644acc2a5f8c69977d8ad4fb9fdad6045304b853841f94446d2c99887ab64c40
+  data.tar.gz: c45e2c0739d6c2da44c696779eb61bb69fb47c2f5a9612c949f2cab86ca9378fd4f4e371c3dcebcbd2cdaafdf57cd2461af827048e7db225484c0361178d9b9f

data/CHANGES.rdoc

@@ -1,6 +1,26 @@
-
 = live_ast Changes
 
+== Version 2.1.0
+
+* Add support for Ruby 3.1
+* Add `live_ast/replace_caller` similar to `replace_raise`
+
+== Version 2.0.0
+
+* Breaking change: Use bindings gem instead of binding_of_caller.
+  If you've been using the full integration mode, you will have to replace
+  binding_of_caller with bindings.
+* Add support for Ruby 3.0
+* Drop support for Ruby 2.3, 2.4 and 2.5
+
+== Version 1.3.2
+
+* Add support for Ruby 2.6
+
+== Version 1.3.1
+
+* Loosen dependency on ruby_parser
+
 == Version 1.3.0
 
 * Drop support for Rubies below 2.3

data/README.rdoc

@@ -129,8 +129,8 @@ semantics as +eval+ except that the binding argument is required.
 == Full Integration
 
 In order for LiveAST to be transparent to the user, +eval+ must be
-replaced. This is accomplished with the help of the +binding_of_caller+ gem
-(https://github.com/banister/binding_of_caller).
+replaced. This is accomplished with the help of the +bindings+ gem
+(https://github.com/shreeve/bindings).
 
 To replace +eval+,
 
@@ -149,7 +149,7 @@ below for details).
   # => s(:iter, s(:call, nil, :lambda), 0, s(:str, "dynamic1"))
 
 Since LiveAST itself is pure ruby, any platforms supported by
-+binding_of_caller+ should work with <code>live_ast/full</code>.
++bindings+ should work with <code>live_ast/full</code>.
 
 == Limitations
 
@@ -224,6 +224,20 @@ code. An exception from within a native method will likely still
 contain the token in its backtrace (e.g., in MRI the exception raised
 by <code>1/0</code> comes from C).
 
+Similarly to replace_raise, there is a replace_caller for libraries that
+use the output of Kernel.caller directly to identify files.  This has the 
+same caveats as replace_raise.
+  
+  require 'live_ast'
+
+  f = ast_eval %{ lambda { caller.first } }, binding
+  f.call
+  => "(irb)|ast@o:7:in `irb_binding'"
+
+  require 'live_ast/replace_caller'
+  f.call
+  => "(irb):7:in `block in irb_binding'"
+
 == Replacing the Parser
 
 Despite its name, LiveAST knows nothing about ASTs. It merely reports

data/lib/live_ast/ast_eval.rb

@@ -1,4 +1,6 @@
-require 'live_ast/base'
+# frozen_string_literal: true
+
+require "live_ast/base"
 
 module Kernel
   private

data/lib/live_ast/ast_load.rb

@@ -1,4 +1,6 @@
-require 'live_ast/base'
+# frozen_string_literal: true
+
+require "live_ast/base"
 
 module Kernel
   private

data/lib/live_ast/base.rb

@@ -1,24 +1,25 @@
-require 'thread'
+# frozen_string_literal: true
 
-require 'live_ast/common'
-require 'live_ast/reader'
-require 'live_ast/evaler'
-require 'live_ast/linker'
-require 'live_ast/loader'
-require 'live_ast/error'
-require 'live_ast/irb_spy' if defined?(IRB)
+require "live_ast/common"
+require "live_ast/reader"
+require "live_ast/evaler"
+require "live_ast/linker"
+require "live_ast/loader"
+require "live_ast/error"
+require "live_ast/irb_spy" if defined?(IRB)
 
 module LiveAST
-  NATIVE_EVAL = Kernel.method(:eval) #:nodoc:
+  NATIVE_EVAL = Kernel.method(:eval) # :nodoc:
 
   class << self
-    attr_writer :parser #:nodoc:
+    attr_writer :parser # :nodoc:
 
-    def parser #:nodoc:
-      @parser ||= begin
-        require 'live_ast/ruby_parser'
-        LiveAST::RubyParser
-      end
+    def parser # :nodoc:
+      @parser ||=
+        begin
+          require "live_ast/ruby_parser"
+          LiveAST::RubyParser
+        end
     end
 
     #
@@ -26,7 +27,7 @@ module LiveAST
     #
     # Equivalent to <code>obj.to_ast</code>.
     #
-    def ast(obj) #:nodoc:
+    def ast(obj) # :nodoc:
       case obj
       when Method, UnboundMethod
         Linker.find_method_ast(obj.owner, obj.name, *obj.source_location)
@@ -50,7 +51,7 @@ module LiveAST
     #
     # Equivalent to <code>Kernel#ast_eval</code>.
     #
-    def eval(*args) #:nodoc:
+    def eval(*args) # :nodoc:
       Evaler.eval(args[0], *args)
     end
 
@@ -59,14 +60,14 @@ module LiveAST
     #
     # Equivalent to <code>Kernel#ast_load</code>.
     #
-    def load(file, wrap = false) #:nodoc:
+    def load(file, wrap = false) # :nodoc:
       Loader.load(file, wrap)
     end
 
     #
     # strip the revision token from a string
     #
-    def strip_token(file) #:nodoc:
+    def strip_token(file) # :nodoc:
       file.sub(/#{Regexp.quote Linker::REVISION_TOKEN}[a-z]+/, "")
     end
   end

data/lib/live_ast/common.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 module LiveAST
   module Common
@@ -12,6 +13,15 @@ module LiveAST
       raise TypeError, message
     end
 
+    def arg_to_str2(arg)
+      arg.to_str
+    rescue NameError
+      thing = arg.nil? ? nil : arg.class
+
+      message = "wrong argument type #{thing.inspect} (expected String)"
+      raise TypeError, message
+    end
+
     def check_arity(args, range)
       return if range.include? args.size
 
@@ -34,7 +44,7 @@ module LiveAST
       if bind
         case location.size
         when 0
-          NATIVE_EVAL.call("[__FILE__, __LINE__]", bind)
+          bind.source_location
         when 1
           [location.first, 1]
         else

data/lib/live_ast/error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module LiveAST
   class MultipleDefinitionsOnSameLineError < RuntimeError
     def message

data/lib/live_ast/evaler.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module LiveAST
   module Evaler
     class << self
@@ -13,9 +15,9 @@ module LiveAST
 
         begin
           NATIVE_EVAL.call(evaler_source, bind, key, line)
-        rescue Exception => ex
-          ex.backtrace.map! { |s| LiveAST.strip_token s }
-          raise ex
+        rescue Exception => e
+          e.backtrace.map! { |s| LiveAST.strip_token s }
+          raise e
         end
       end
 

data/lib/live_ast/full.rb

@@ -1,2 +1,4 @@
-require 'live_ast'
-require 'live_ast/replace_eval'
+# frozen_string_literal: true
+
+require "live_ast"
+require "live_ast/replace_eval"

data/lib/live_ast/irb_spy.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 module LiveAST
   @history = nil
@@ -7,9 +8,9 @@ module LiveAST
       attr_writer :history
 
       def code_at(line)
-        code = ""
-        checked_history[line..-1].each do |code_line|
-          code << code_line << "\n"
+        code = +""
+        checked_history[line..].each do |code_line|
+          code += "#{code_line}\n"
           return code if can_parse code
         end
       end
@@ -22,8 +23,9 @@ module LiveAST
 
       def checked_history
         return @history if @history
+
         raise NotImplementedError,
-          "LiveAST cannot access history for this IRB input method"
+              "LiveAST cannot access history for this IRB input method"
       end
     end
   end
@@ -31,7 +33,7 @@ end
 
 [
   defined?(IRB::StdioInputMethod) ? IRB::StdioInputMethod : nil,
-  defined?(IRB::ReadlineInputMethod) ? IRB::ReadlineInputMethod : nil,
+  defined?(IRB::ReadlineInputMethod) ? IRB::ReadlineInputMethod : nil
 ].compact.each do |klass|
   klass.module_eval do
     alias_method :live_ast_original_gets, :gets

data/lib/live_ast/linker.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module LiveAST
   class Cache
     def initialize(*args)
@@ -39,10 +41,10 @@ module LiveAST
   end
 
   module Linker
-    REVISION_TOKEN = "|ast@".freeze
+    REVISION_TOKEN = "|ast@"
 
     @caches = {}
-    @counter = "a"
+    @counter = +"a"
     @mutex = Mutex.new
 
     class << self
@@ -71,8 +73,10 @@ module LiveAST
       def find_ast(*location)
         raise ASTNotFoundError unless location.size == 2
         raise RawEvalError if location.first == "(eval)"
+
         ast = fetch_from_cache(*location)
         raise MultipleDefinitionsOnSameLineError if ast == :multiple
+
         ast
       end
 

data/lib/live_ast/loader.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module LiveAST
   module Loader
     class << self
@@ -8,7 +10,7 @@ module LiveAST
         header, footer, warnings_ok = header_footer(wrap)
 
         parser_src = Reader.read(file)
-        evaler_src = header << parser_src << footer
+        evaler_src = +"" << header << parser_src << footer
 
         run = lambda do
           Evaler.eval(parser_src, evaler_src, TOPLEVEL_BINDING, file, 1)
@@ -19,6 +21,7 @@ module LiveAST
 
       def header_footer(wrap)
         return "class << Object.new;", ";end", true if wrap
+
         locals = NATIVE_EVAL.call("local_variables", TOPLEVEL_BINDING)
 
         params = locals.empty? ? "" : ("|;" + locals.join(",") + "|")
@@ -40,14 +43,16 @@ module LiveAST
         if file.index Linker::REVISION_TOKEN
           raise "refusing to load file with revision token: `#{file}'"
         end
+
         search_paths(file) or
           raise LoadError, "cannot load such file -- #{file}"
       end
 
       def search_paths(file)
         return file if File.file? file
+
         $LOAD_PATH.each do |path|
-          target = path + "/" + file
+          target = File.join(path, file)
           return target if File.file? target
         end
         nil

data/lib/live_ast/reader.rb

@@ -1,9 +1,10 @@
 # encoding: us-ascii
+# frozen_string_literal: true
 
 module LiveAST
   module Reader
-    UTF8_BOM = /\A\xef\xbb\xbf/
-    MAGIC_COMMENT = /\A(?:#!.*?\n)?\s*\#.*(?:en)?coding\s*[:=]\s*([^\s;]+)/
+    UTF8_BOM = /\A\xef\xbb\xbf/.freeze
+    MAGIC_COMMENT = /\A(?:#!.*?\n)?\s*\#.*(?:en)?coding\s*[:=]\s*([^\s;]+)/.freeze
 
     def self.read(file)
       contents = File.read(file, encoding: "BINARY")
@@ -17,7 +18,7 @@ module LiveAST
     end
 
     def self.strip_special(encoding)
-      if encoding =~ /\Autf8-mac\Z/i
+      if /\Autf8-mac\Z/i.match?(encoding)
         "UTF8-MAC"
       else
         encoding.sub(/-(unix|dos|mac)\Z/i, "")

data/lib/live_ast/replace_caller.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "live_ast/base"
+
+module Kernel
+  private
+
+  alias live_ast_original_caller caller
+  def caller(*args)
+    c = live_ast_original_caller(*args)
+    c.shift
+    c.map { |line| LiveAST.strip_token line }
+  end
+end

data/lib/live_ast/replace_eval.rb

@@ -1,5 +1,7 @@
-require 'live_ast/base'
-require 'binding_of_caller'
+# frozen_string_literal: true
+
+require "live_ast/base"
+require "bindings"
 
 module LiveAST
   module ReplaceEval
@@ -34,7 +36,7 @@ module LiveAST
       def handle_args(args)
         LiveAST::Common.check_arity(args, 1..3)
         args[0] = Common.arg_to_str(args[0])
-        args[1] = Common.arg_to_str(args[1]) if args.length > 1
+        args[1] = Common.arg_to_str2(args[1]) if args.length > 1
       end
     end
   end
@@ -55,9 +57,8 @@ module Kernel
     LiveAST::Common.check_arity(args, 1..4)
     LiveAST.eval(
       args[0],
-      args[1] || binding.of_caller(1),
-      *LiveAST::Common.location_for_eval(*args[1..3])
-    )
+      args[1] || Binding.of_caller(1),
+      *LiveAST::Common.location_for_eval(*args[1..3]))
   end
 end
 
@@ -66,7 +67,7 @@ class Binding
   alias live_ast_original_binding_eval eval
 
   def eval(*args)
-    LiveAST.eval(args[0], self, *args[1..-1])
+    LiveAST.eval(args[0], self, *args[1..])
   end
 end
 
@@ -78,11 +79,11 @@ class BasicObject
     if block
       live_ast_original_instance_eval(*args, &block)
     else
-      ::LiveAST::ReplaceEval.
-        module_or_instance_eval(:instance,
-                                self,
-                                ::Kernel.binding.of_caller(1),
-                                args)
+      ::LiveAST::ReplaceEval
+        .module_or_instance_eval(:instance,
+                                 self,
+                                 ::Binding.of_caller(1),
+                                 args)
     end
   end
 end
@@ -95,8 +96,8 @@ class Module
     if block
       live_ast_original_module_eval(*args, &block)
     else
-      LiveAST::ReplaceEval.
-        module_or_instance_eval(:module, self, binding.of_caller(1), args)
+      LiveAST::ReplaceEval
+        .module_or_instance_eval(:module, self, Binding.of_caller(1), args)
     end
   end
 

data/lib/live_ast/replace_load.rb

@@ -1,4 +1,6 @@
-require 'live_ast/base'
+# frozen_string_literal: true
+
+require "live_ast/base"
 
 module Kernel
   alias live_ast_original_load load

data/lib/live_ast/replace_raise.rb

@@ -1,4 +1,6 @@
-require 'live_ast/base'
+# frozen_string_literal: true
+
+require "live_ast/base"
 
 module Kernel
   private
@@ -8,8 +10,8 @@ module Kernel
   def raise(*args)
     ex = begin
            live_ast_original_raise(*args)
-         rescue Exception => t
-           t
+         rescue Exception => e
+           e
          end
     ex.backtrace.reject! { |line| line.index __FILE__ }
     ex.backtrace.map! { |line| LiveAST.strip_token line }

data/lib/live_ast/ruby_parser/test.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 #
 # Used by the LiveAST test suite.
@@ -149,6 +150,18 @@ module LiveAST
           s(:call, s(:lvar, :x), op, s(:lvar, :y)))
       end
 
+      #
+      # binop_lambda(:+) returns the ast of
+      #
+      #   lambda { |x, y| x + y }
+      #
+      def binop_lambda(op)
+        s(:iter,
+          s(:lambda),
+          s(:args, :x, :y),
+          s(:call, s(:lvar, :x), op, s(:lvar, :y)))
+      end
+
       #
       # binop_proc_new(:*) returns the ast of
       #

data/lib/live_ast/ruby_parser/unparser.rb

@@ -1,4 +1,6 @@
-require 'ruby2ruby'
+# frozen_string_literal: true
+
+require "ruby2ruby"
 
 #
 # Used by +to_ruby+ in LiveAST.

data/lib/live_ast/ruby_parser.rb

@@ -1,5 +1,7 @@
-require 'ruby_parser'
-require 'live_ast/base'
+# frozen_string_literal: true
+
+require "ruby_parser"
+require "live_ast/base"
 
 module LiveAST
   class RubyParser
@@ -31,7 +33,7 @@ module LiveAST
   end
 end
 
-LiveAST::RubyParser.autoload :Unparser, 'live_ast/ruby_parser/unparser'
-LiveAST::RubyParser.autoload :Test, 'live_ast/ruby_parser/test'
+LiveAST::RubyParser.autoload :Unparser, "live_ast/ruby_parser/unparser"
+LiveAST::RubyParser.autoload :Test, "live_ast/ruby_parser/test"
 
 LiveAST.parser = LiveAST::RubyParser

data/lib/live_ast/to_ast.rb

@@ -1,26 +1,23 @@
-require 'live_ast/base'
+# frozen_string_literal: true
 
-[Method, UnboundMethod].each do |klass|
-  klass.class_eval do
-    def to_ast #:nodoc:
+require "live_ast/base"
+
+module LiveAST
+  module MethodToAST
+    # Extract the AST of this object.
+    def to_ast
       LiveAST::Linker.find_method_ast(owner, name, *source_location)
     end
   end
-end
 
-class Proc
-  # Extract the AST of this object.
-  def to_ast
-    LiveAST::Linker.find_proc_ast(self)
+  module ProcToAST
+    # Extract the AST of this object.
+    def to_ast
+      LiveAST::Linker.find_proc_ast(self)
+    end
   end
 end
 
-class Method
-  # :method: to_ast
-  # Extract the AST of this object.
-end
-
-class UnboundMethod
-  # :method: to_ast
-  # Extract the AST of this object.
-end
+Method.include LiveAST::MethodToAST
+UnboundMethod.include LiveAST::MethodToAST
+Proc.include LiveAST::ProcToAST

data/lib/live_ast/to_ruby.rb

@@ -1,24 +1,16 @@
-require 'live_ast/base'
+# frozen_string_literal: true
 
-[Method, UnboundMethod, Proc].each do |klass|
-  klass.class_eval do
-    def to_ruby #:nodoc:
+require "live_ast/base"
+
+module LiveAST
+  module CallableToRuby
+    # Generate ruby code which reflects the AST of this object.
+    def to_ruby
       LiveAST.parser::Unparser.unparse(LiveAST.ast(self))
     end
   end
 end
 
-class Method
-  # :method: to_ruby
-  # Generate ruby code which reflects the AST of this object.
-end
-
-class UnboundMethod
-  # :method: to_ruby
-  # Generate ruby code which reflects the AST of this object.
-end
-
-class Proc
-  # :method: to_ruby
-  # Generate ruby code which reflects the AST of this object.
-end
+Method.include LiveAST::CallableToRuby
+UnboundMethod.include LiveAST::CallableToRuby
+Proc.include LiveAST::CallableToRuby

data/lib/live_ast/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module LiveAST
-  VERSION = "1.3.0".freeze
+  VERSION = "2.1.0"
 end

data/lib/live_ast.rb

@@ -1,4 +1,6 @@
-require 'live_ast/base'
-require 'live_ast/to_ast'
-require 'live_ast/ast_eval'
-require 'live_ast/replace_load'
+# frozen_string_literal: true
+
+require "live_ast/base"
+require "live_ast/to_ast"
+require "live_ast/ast_eval"
+require "live_ast/replace_load"