overrider 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f5f6427ceb87b0ec35bc2cd671ee20adec487cec6d5b360194ef010700fe8b7
-  data.tar.gz: f060e48860d1e11560fefb8e7008b16d99e7c44d11389802b6004243aacd399b
+  metadata.gz: d52cf24ae854860de785dbab4e6d9c2750290482f4691c902304fb9faed1a089
+  data.tar.gz: c1fb2a74aae5d70ac65790546808ae113e82ff3912307007835d8c582fa46108
 SHA512:
-  metadata.gz: f8ed5bf14feef878b73f1be4153badae266baed307def1c95440092dc2120df56e3bbc45dd4de47fa3bb805effb67aa7998b554f5c5cd5a02318b7611079e5f7
-  data.tar.gz: 05a8c4c1dc1c2b7e91ba36a3b0f134a879dec3d688940fae35aea12e5f3e7119ff1fedfd47a60335a56a8e76da87f4b9fe55fa336fdc7669ef78c6e924725992
+  metadata.gz: 196bb7a40efa56f4a8e0de5490b175e302fdfd39edc6f48d388367580eba66434abc65cc85d8b4a02d93bacfc6b950640e97019bf8a74c6049da2bcdb250150f
+  data.tar.gz: 9b441aa900a934993379f30f21caa95241221e96cdbf0b6bb1fe8b2dc4889db831bed33076ccc7591487fa41ffe1a7e4a86282382b3f34a174f4a425b58d1a6a

data/README.md

@@ -6,6 +6,9 @@ This gem adds `override` syntax that is similar to Java's one.
 
 Unless the method has super method, this gem raise `Overrider::NoSuperMethodError`.
 
+This gem is pseudo static code analyzer by `TracePoint` and `Ripper`.
+it detect abstract violation when class(module) is defined, not runtime.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -56,31 +59,6 @@ end # => raise
 If you want to disable Overrider, write `Overrider.disable = true` at first line.
 If Overrider is disabled, TracePoint never runs, and so there is no overhead of VM instruction.
 
-### Caution
-
-Must not call `override` outer class definition.
-
-ex.
-
-```ruby
-class A1
-  def foo
-  end
-end
-
-class A2 < A1
-  extend Overrider
-
-  def foo
-  end
-end
-
-A2.send(:override, :foo)
-```
-
-This case leaves enabled TracePoint.
-It is very high overhead.
-
 ### Examples
 
 #### include module method after override method

data/lib/overrider.rb

@@ -1,5 +1,6 @@
 require "overrider/version"
-require 'set'
+require "set"
+require "ripper"
 
 module Overrider
   class NoSuperMethodError < StandardError
@@ -12,6 +13,35 @@ module Overrider
     end
   end
 
+  class SexpTraverser
+    def initialize(sexp)
+      @sexp = sexp
+    end
+
+    def traverse(current_sexp = nil, parent = nil, &block)
+      sexp = current_sexp || @sexp
+      first = sexp[0]
+      if first.is_a?(Symbol) # node
+        yield sexp, parent
+        args = Ripper::PARSER_EVENT_TABLE[first]
+        return if args.nil? || args.zero?
+
+        args.times do |i|
+          param = sexp[i + 1]
+          if param.is_a?(Array)
+            traverse(param, sexp, &block)
+          end
+        end
+      else # array
+        sexp.each do |n|
+          if n.is_a?(Array)
+            traverse(n, sexp, &block)
+          end
+        end
+      end
+    end
+  end
+
   @disable = false
 
   def self.disable=(v)
@@ -26,90 +56,130 @@ module Overrider
     !disabled?
   end
 
-  private
+  def self.sexps
+    @sexps ||= {}
+  end
 
-  using Module.new {
-    refine Module do
-      def detect_event_type
-        caller_info = caller_locations(2, 2)[0]
-        if caller_info.label.match?(/<class/) || caller_info.label.match?(/<module/)
-          [:end, :raise]
-        elsif caller_info.label.match?(/singleton class/)
-          [:end, :raise]
-        else
-          [:b_call, :b_return, :raise]
-        end
-      end
-    end
-  }
+  private
 
   def override(symbol)
     return if Overrider.disabled?
 
-    event_type = detect_event_type
+    @ensure_overrides ||= Set.new
+    @ensure_overrides.add(instance_method(symbol))
 
-    block_count = 1
-    @__overrider_trace_point ||= TracePoint.trace(*event_type) do |t|
+    caller_info = caller_locations(1, 1)[0]
+    unless Overrider.sexps[caller_info.absolute_path]
+      Overrider.sexps[caller_info.absolute_path] ||= Ripper.sexp(File.read(caller_info.absolute_path))
+    end
+
+    @__overrider_trace_point ||= TracePoint.trace(:end, :c_return, :return, :return, :raise) do |t|
       if t.event == :raise
         @__overrider_trace_point.disable
         @__overrider_trace_point = nil
         next
       end
 
-      block_count += 1 if t.event == :b_call
-      block_count -= 1 if t.event == :b_return
-
       klass = t.self
-      if klass == self && (t.event == :end || t.event == :b_return && block_count.zero?)
-        @ensure_overrides.each do |n|
-          meth = klass.instance_method(n)
+
+      target_outer_override = false
+      if t.event == :return && klass == self && t.method_id == :override
+        c = caller_locations(2, 1)[0]
+        traverser = SexpTraverser.new(Overrider.sexps[c.absolute_path])
+        traverser.traverse do |n, parent|
+          if n[0] == :@ident && n[1] == "override" && n[2][0] == c.lineno
+            if parent[0] == :command || parent[0] == :fcall
+              # override :foo
+            elsif parent[0] == :command_call || parent[0] == :call
+              if parent[1][0] == :var_ref && parent[1][1][0] == :@kw && parent[1][1][1] == "self"
+                # self.override :foo
+              else
+                # unknown case
+                target_outer_override = true
+              end
+            else
+              target_outer_override = true
+            end
+          end
+        end
+      end
+
+      target_end_event = klass == self && t.event == :end
+      target_c_return_event = (klass == Class || klass == Module) && t.event == :c_return && t.method_id == :new
+
+      if target_end_event || target_c_return_event || target_outer_override
+        @ensure_overrides.each do |meth|
           unless meth.super_method
             @__overrider_trace_point.disable
             @__overrider_trace_point = nil
-            raise NoSuperMethodError.new(klass, meth)
+            raise NoSuperMethodError.new(self, meth)
           end
         end
         @__overrider_trace_point.disable
         @__overrider_trace_point = nil
       end
     end
-    @ensure_overrides ||= Set.new
-    @ensure_overrides.add(symbol)
+
     symbol
   end
 
   def override_singleton_method(symbol)
     return if Overrider.disabled?
 
-    event_type = detect_event_type
+    @ensure_overrides ||= Set.new
+    @ensure_overrides.add(singleton_class.instance_method(symbol))
 
-    block_count = 1
-    @__overrider_singleton_trace_point ||= TracePoint.trace(*event_type) do |t|
+    caller_info = caller_locations(1, 1)[0]
+    unless Overrider.sexps[caller_info.absolute_path]
+      Overrider.sexps[caller_info.absolute_path] ||= Ripper.sexp(File.read(caller_info.absolute_path))
+    end
+
+    @__overrider_singleton_trace_point ||= TracePoint.trace(:end, :c_return, :return, :raise) do |t|
       if t.event == :raise
         @__overrider_singleton_trace_point.disable
         @__overrider_singleton_trace_point = nil
         next
       end
 
-      block_count += 1 if t.event == :b_call
-      block_count -= 1 if t.event == :b_return
-
       klass = t.self
-      if klass == self && (t.event == :end || t.event == :b_return && block_count.zero?)
-        @ensure_overrides.each do |n|
-          meth = klass.singleton_class.instance_method(n)
+
+      target_outer_override_singleton_method = false
+      if t.event == :return && klass == self && t.method_id == :override_singleton_method
+        c = caller_locations(2, 1)[0]
+        traverser = SexpTraverser.new(Overrider.sexps[c.absolute_path])
+        traverser.traverse do |n, parent|
+          if n[0] == :@ident && n[1] == "override_singleton_method" && n[2][0] == c.lineno
+            if parent[0] == :command || parent[0] == :fcall
+              # override_singleton_method :foo
+            elsif parent[0] == :command_call || parent[0] == :call
+              if parent[1][0] == :var_ref && parent[1][1][0] == :@kw && parent[1][1][1] == "self"
+                # self.override_singleton_method :foo
+              else
+                # unknown case
+                target_outer_override_singleton_method = true
+              end
+            else
+              target_outer_override_singleton_method = true
+            end
+          end
+        end
+      end
+
+      target_end_event = klass == self && t.event == :end
+      target_c_return_event = (klass == Class || klass == Module) && t.event == :c_return && t.method_id == :new
+      if target_end_event || target_c_return_event || target_outer_override_singleton_method
+        @ensure_overrides.each do |meth|
           unless meth.super_method
             @__overrider_singleton_trace_point.disable
             @__overrider_singleton_trace_point = nil
-            raise NoSuperMethodError.new(klass, meth)
+            raise NoSuperMethodError.new(self, meth)
           end
         end
         @__overrider_singleton_trace_point.disable
         @__overrider_singleton_trace_point = nil
       end
     end
-    @ensure_overrides ||= Set.new
-    @ensure_overrides.add(symbol)
+
     symbol
   end
 end

data/lib/overrider/version.rb

@@ -1,3 +1,3 @@
 module Overrider
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: overrider
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - joker1007