zombie-killer 0.3 → 0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0c386e33153b7b34e0563e9359b3aa5262ee316a
-  data.tar.gz: 68e8158e89c4e04778126ef089dc47ee9db2b3f4
+SHA256:
+  metadata.gz: 3e180c7784f993ba500fad7e16198be9e6478ba85d7c6817e701fa7b2ba85e7e
+  data.tar.gz: cabad90fad0492478d2ded00b62b1d45435cbc5750fcc1010a36483bac314710
 SHA512:
-  metadata.gz: 6feac8928e83b35f14a31a1f355386a823f5472ceab730b3e60fd8c1aa9fac198a6a548e4e2ae5a5d119c580f2aef973a7c9ed1cfaf99156c6606c8142b4208d
-  data.tar.gz: b5feb7a3335c43a141b620db9fb2c1ba647ab11a836b2022b9f9338d3e79e7fdd0562c188601baf16a27f1f7a43bc5f61fb7dbbce8cdf3eac48cd58ecd94db58
+  metadata.gz: c27fc0f8f743e91a93dc3c0edd041538c5933015f0c30ede75e537267e3baadce783c8e3d2491f063dad3b1c9d782e8045851e5371344b15e52e3bb4ef6b41d5
+  data.tar.gz: 61a29a2baee22c6190718405e436cc7889c3315cfcb1831864091ead8ae5d551637cc783a42b649167e7f314b926389e559aa00a1490a11f772a5d8715e222bf

data/NEWS.md

@@ -0,0 +1,18 @@
+# News
+
+## unreleased
+
+## 0.4, 2018-11-02
+
+- Added zk -e, EagerRewriter (don't care about niceness, replace all)
+- Recover from parse errors by reverting to the original file
+- Fixed reporting unhandled node types
+- Handle keyword arguments, regex match
+
+## 0.3, 2014-12-02
+
+- bin/count_method_calls added
+
+## 0.2, 2014-11-28
+
+- first release as a gem

data/bin/zk

@@ -12,6 +12,7 @@ Usage: zk [options] [FILES...]
 Arguments:
   FILES  Files to operate on, patterns allowed [default: **/*.rb]
 Options:
+  -e, --eager                Translate all zombies regardless of niceness.
   -u, --unsafe               Translate even constructs not known to be safe.
   -s, --stats                Also print statistics about node types.
   -v, --version              Print version information and exit.
@@ -21,7 +22,7 @@ EOT
 begin
   options = Docopt.docopt(doc, help: true, version: ZombieKiller::VERSION)
 
-  killer = ZombieKiller.new
+  killer = ZombieKiller.new(eager: options["--eager"])
 
   files = options["FILES"]
   files << "**/*.rb" if files.empty?

data/lib/zombie_killer/eager_rewriter.rb

@@ -0,0 +1,56 @@
+require "unparser"
+require "set"
+
+# Rewrite Zombies with their idiomatic replacements
+class EagerRewriter < Parser::TreeRewriter
+  OPS = Parser::AST::Node.new(:const, [nil, :Ops])
+
+  INFIX = {
+    add: :+,
+    subtract: :-,
+    multiply: :*,
+    divide: :/,
+    modulo: :%,
+    bitwise_and: :&,
+    bitwise_or: :|,
+    bitwise_xor: :^,
+
+    less_than: :<,
+    less_or_equal: :<=,
+    greater_than: :>,
+    greater_or_equal: :>=
+  }.freeze
+
+  def s(name, *children)
+    Parser::AST::Node.new(name, children)
+  end
+
+  def replace_node(old_node, new_node)
+    source_range = old_node.loc.expression
+    replace(source_range, Unparser.unparse(new_node))
+  end
+
+  def on_send(node)
+    super
+    receiver, name, *args = *node
+    replacement = INFIX[name]
+    if receiver == OPS && replacement && args.size == 2
+      replace_node(node, s(:send, args[0], replacement, args[1]))
+    end
+  end
+
+  AS_OPS = Set.new [:+, :-]
+  def on_lvasgn(node)
+    super
+    vname1, value = *node
+    return unless value && value.type == :send
+    receiver, oname, *args = *value
+    if vname1 == lvar_vname2(receiver) && AS_OPS.include?(oname)
+      replace_node(node, s(:op_asgn, s(:lvasgn, vname1), oname, args[0]))
+    end
+  end
+
+  def lvar_vname2(receiver)
+    receiver.children.first if receiver && receiver.type == :lvar
+  end
+end

data/lib/zombie_killer/killer.rb

@@ -1,17 +1,34 @@
 require "parser"
 require "parser/current"
 
+require_relative "eager_rewriter"
 require_relative "rewriter"
 
+# The main class called from the CLI
 class ZombieKiller
+  # @return [Boolean] use the EagerRewriter
+  attr_reader :eager
+
+  def initialize(eager: false)
+    @eager = eager
+  end
+
+  # @param code [String]
+  # @param filename [String]
   # @returns new string
   def kill_string(code, filename = "(inline code)", unsafe: false)
     fixed_point(code) do |c|
       parser   = Parser::CurrentRuby.new
-      rewriter = ZombieKillerRewriter.new(unsafe: unsafe)
+      rewriter = eager ? EagerRewriter.new : ZombieKillerRewriter.new(unsafe: unsafe)
       buffer   = Parser::Source::Buffer.new(filename)
       buffer.source = c
-      rewriter.rewrite(buffer, parser.parse(buffer))
+      ast = parser.parse(buffer)
+      if ast
+        rewriter.rewrite(buffer, ast)
+      else
+        puts "Parse error for '#{filename}', returning it unchanged"
+        return code
+      end
     end
   end
   alias_method :kill, :kill_string
@@ -21,6 +38,9 @@ class ZombieKiller
     new_string = kill_string(File.read(filename), filename, unsafe: unsafe)
 
     File.write(new_filename, new_string)
+  rescue
+    puts "While processing #{filename}"
+    raise
   end
 
   private

data/lib/zombie_killer/rewriter.rb

@@ -8,9 +8,20 @@ require_relative "variable_scope"
 
 # We have encountered code that does satisfy our simplifying assumptions,
 # translating it would not be correct.
-class TooComplexToTranslateError < Exception
+class TooComplexToTranslateError < RuntimeError
 end
 
+# An error related to a node
+class NodeError < RuntimeError
+  attr_reader :node
+
+  def initialize(message, node)
+    @node = node
+    super(message)
+  end
+end
+
+# The main rewriter
 class ZombieKillerRewriter < Parser::Rewriter
   include Niceness
 
@@ -63,10 +74,14 @@ class ZombieKillerRewriter < Parser::Rewriter
     :if,                        # If and Unless
     :ivar,                      # Instance variable value
     :ivasgn,                    # Instance variable assignment
+    :kwarg,                     # Keyword argument, def m(a:)
     :kwbegin,                   # A variant of begin; for rescue and while_post
     :kwoptarg,                  # Keyword optional argument, def m(a: 1)
+    :kwrestarg,                 # Rest of keyword arguments, def m(**kwargs)
+    :kwsplat,                   # Hash **splatting
     :lvar,                      # Local variable value
     :lvasgn,                    # Local variable assignment
+    :match_with_lvasgn,         # /regex/ =~ value
     :masgn,                     # Multiple assigment: a, b = c, d
     :mlhs,                      # Left-hand side of a multiple assigment: a, b = c, d
     :module,                    # Module body
@@ -101,8 +116,8 @@ class ZombieKillerRewriter < Parser::Rewriter
 
   def process(node)
     return if node.nil?
-    if ! @unsafe
-      oops(node, RuntimeError.new("Unknown node type #{node.type}")) unless
+    unless @unsafe
+      raise NodeError.new("Unknown node type #{node.type}", node) unless
         HANDLED_NODE_TYPES.include? node.type
     end
     super
@@ -117,8 +132,10 @@ class ZombieKillerRewriter < Parser::Rewriter
     scopes.with_new do
       block.call
     end
-  rescue => e
-    oops(node, e)
+  rescue NodeError => e
+    puts e
+    puts "Node exception @ #{e.node.loc.expression}"
+    puts "Offending node: #{e.node.inspect}"
   end
 
   def on_def(node)
@@ -276,12 +293,6 @@ class ZombieKillerRewriter < Parser::Rewriter
 
   private
 
-  def oops(node, exception)
-    puts "Node exception @ #{node.loc.expression}"
-    puts "Offending node: #{node.inspect}"
-    raise exception
-  end
-
   def is_call(node, namespace, message)
     n_receiver, n_message = *node
     n_receiver && n_receiver.type == :const &&

data/lib/zombie_killer/version.rb

@@ -1,3 +1,3 @@
 class ZombieKiller
-  VERSION = "0.3"
+  VERSION = "0.4".freeze
 end

data/spec/spec_helper.rb

@@ -1,7 +1,25 @@
-$:.unshift File.expand_path("../../lib", __FILE__)
+if ENV["COVERAGE"]
+  require "simplecov"
+  SimpleCov.start
+
+  top_location = File.expand_path("../../", __FILE__)
+  # track all ruby files under lib
+  SimpleCov.track_files("#{top_location}/lib/**/*.rb")
+
+  # use coveralls for on-line code coverage reporting at Travis CI
+  if ENV["TRAVIS"]
+    require "coveralls"
+    SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new [
+      SimpleCov::Formatter::HTMLFormatter,
+      Coveralls::SimpleCov::Formatter
+    ]
+  end
+end
+
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
 require "zombie_killer"
 
 def cleanup(s)
   s.split("\n").reject { |l| l =~ /^\s*$/ }.first =~ /^(\s*)/
-  s.gsub(Regexp.new("^#{$1}"), "")[0..-2]
+  s.gsub(Regexp.new("^#{Regexp.last_match(1)}"), "")[0..-2]
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zombie-killer
 version: !ruby/object:Gem::Version
-  version: '0.3'
+  version: '0.4'
 platform: ruby
 authors:
 - Martin Vidner
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-02 00:00:00.000000000 Z
+date: 2018-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docopt
@@ -29,9 +29,9 @@ dependencies:
   name: parser
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.2.0.pre.5
+        version: 2.2.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '3'
@@ -39,9 +39,9 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.2.0.pre.5
+        version: 2.2.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '3'
@@ -59,6 +59,40 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '999'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '999'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -93,6 +127,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: Translate YCP-like library calls (Ops.*, Builtins.*) to idiomatic Ruby
 email:
 - martin@vidner.net
@@ -104,11 +152,13 @@ extensions: []
 extra_rdoc_files: []
 files:
 - LICENSE
+- NEWS.md
 - README.md
 - bin/count_method_calls
 - bin/zk
 - lib/zombie_killer.rb
 - lib/zombie_killer/code_histogram.rb
+- lib/zombie_killer/eager_rewriter.rb
 - lib/zombie_killer/killer.rb
 - lib/zombie_killer/niceness.rb
 - lib/zombie_killer/node_type_counter.rb
@@ -139,9 +189,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Resocialize YCP Zombies
 test_files: []
-has_rdoc: