abstriker 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9084bf87aeeb1ffa9f9ec57310d709c57f30ad039154c384720793eea694c632
-  data.tar.gz: 6ee676d5a9a1229d38ed3a4ae2b7a4e1fe07cd3f5b1100954e0f42cdd1cb9e66
+  metadata.gz: d17bb11d7fe2be3f6fe021b859d935b7e7b8a0e45b9b33a7d01f89bef970bc97
+  data.tar.gz: 9c09e42b619315dc52f7bb17fb4a204018587dbfeff01188476854306a7db97a
 SHA512:
-  metadata.gz: 01d1026f053c0fe15266eeeba49e0795f87537e6393a0c326e8ccb6e26756792e087705a0a121c442494d46253b4eb985a668e7408077620b19faa999af30673
-  data.tar.gz: a5f838cca75e71629eb62645a78ae851962c361290d448ec5d14bec066a6dfc2d45be57e4cbf917920ce800ae6e9f6cb77e9fa511ded96793ef86c263281fb8e
+  metadata.gz: cded67dbc8f8034e071627891f2feea0a15232617ba0844ec35914bf5daaa49a7a769d9dbfc85bff39f47dcffd672402c27bfb4ce09f45c30c78dfd33cb1682d
+  data.tar.gz: 1a532f0dad983bea20245c3d640c37f80327a649a31a718666394f9288c43176aa809471bc0723cd62050b3a0f2124c2279f549346f03c7f341c2b0ba319c960

data/README.md

@@ -7,6 +7,9 @@ This gem adds `abstract` syntax. that is similar to Java's one.
 If subclass does not implement `abstract` method, raise `Abstriker::NotImplementedError`.
 `Abstriker::NotImplementedError` is curently subclass of `::NotImplementedError`.
 
+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:
@@ -49,48 +52,40 @@ end # => raise
 If you want to disable Abstriker, write `Abstriker.disable = true` at first line.
 If Abstriker is disabled, TracePoint never runs, and so there is no overhead of VM instruction.
 
-### Caution
-
-Must not call `include` or `extend` abstracted module outer class definition.
+### Examples
 
-ex.
+#### include module
 
 ```ruby
-module A1
+module B1
   extend Abstriker
 
   abstract def foo
   end
 end
 
-class A2;
-end
+class B2
+  include B1
+end # => raise
 
-A2.include(A1) # => Don't do this
+Module.new do
+  include B1
+end # => raise
 ```
 
-This case leaves enabled TracePoint.
-It is very high overhead.
-
-### Examples
-
-#### include module
-
+#### include module outer class definition
 ```ruby
-module B1
+module A1
   extend Abstriker
 
   abstract def foo
   end
 end
 
-class B2
-  include B1
-end # => raise
+class A2;
+end
 
-Module.new do
-  include B1
-end # => raise
+A2.include(A1) # => raise
 ```
 
 #### extend module

data/lib/abstriker.rb

@@ -1,5 +1,6 @@
 require "abstriker/version"
 require "set"
+require "ripper"
 
 module Abstriker
   class NotImplementedError < NotImplementedError
@@ -12,6 +13,35 @@ module Abstriker
     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)
@@ -30,6 +60,10 @@ module Abstriker
     @abstract_methods ||= {}
   end
 
+  def self.sexps
+    @sexps ||= {}
+  end
+
   def self.extended(base)
     base.extend(SyntaxMethods)
     base.singleton_class.extend(SyntaxMethods)
@@ -51,49 +85,42 @@ module Abstriker
   module HookBase
     private
 
-    def detect_event_type
-      callers = caller_locations(2, 3)
-      if callers[0].label == "inherited"
-        caller_info = callers[2]
-        if caller_info.label.match?(/initialize/) || caller_info.label.match?(/new/)
-          [:c_return, :b_call, :b_return, :raise]
-        else
-          [:end, :raise]
-        end
-      elsif callers[0].label == "included" || callers[0].label
-        caller_info = callers[2]
-        if caller_info.label.match?(/<class/) || caller_info.label.match?(/<module/)
-          [:end, :raise]
-        else
-          [:c_return, :b_call, :b_return, :raise]
-        end
-      else
-        raise "Not detect event_type"
-      end
-    end
-
-    def check_abstract_methods(klass, block_count_offset = 0)
+    def check_abstract_methods(klass)
       return if Abstriker.disabled?
 
-      event_type = detect_event_type
-
       unless klass.instance_variable_get("@__abstract_trace_point")
-        block_count = block_count_offset
-
-        tp = TracePoint.trace(*event_type) do |t|
+        tp = TracePoint.trace(:end, :c_return, :raise) do |t|
           if t.event == :raise
             tp.disable
             next
           end
 
-          block_count += 1 if t.event == :b_call
-          block_count -= 1 if t.event == :b_return
-
           t_self = t.self
+
+          target_outer_include = false
+          if t.event == :c_return && t_self == klass && t.method_id == :include
+            traverser = SexpTraverser.new(Abstriker.sexps[t.path])
+            traverser.traverse do |n, parent|
+              if n[0] == :@ident && n[1] == "include" && n[2][0] == t.lineno
+                if parent[0] == :command || parent[0] == :fcall
+                  # include Mod
+                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.include Mod
+                  else
+                    # unknown case
+                    target_outer_include = true
+                  end
+                else
+                  target_outer_include = true
+                end
+              end
+            end
+          end
+
           target_end_event = t_self == klass && t.event == :end
-          target_b_return_event = t_self == klass && t.event == :b_return && block_count.zero?
-          target_c_return_event = t_self == Class && t.event == :c_return && t.method_id == :new
-          if target_end_event || target_b_return_event || target_c_return_event
+          target_c_return_event = (t_self == Class || t_self == Module) && t.event == :c_return && t.method_id == :new
+          if target_end_event || target_c_return_event || target_outer_include
             klass.ancestors.drop(1).each do |mod|
               Abstriker.abstract_methods[mod]&.each do |fmeth_name|
                 meth = klass.instance_method(fmeth_name)
@@ -112,28 +139,43 @@ module Abstriker
       end
     end
 
-    def check_abstract_singleton_methods(klass, block_count_offset = 0)
+    def check_abstract_singleton_methods(klass)
       return if Abstriker.disabled?
 
-      event_type = detect_event_type
-
       unless klass.instance_variable_get("@__abstract_singleton_trace_point")
-        block_count = block_count_offset
 
-        tp = TracePoint.trace(*event_type) do |t|
+        tp = TracePoint.trace(:end, :c_return, :raise) do |t|
           if t.event == :raise
             tp.disable
             next
           end
 
-          block_count += 1 if t.event == :b_call
-          block_count -= 1 if t.event == :b_return
-
           t_self = t.self
+
+          target_outer_extend = false
+          if t.event == :c_return && t_self == klass && t.method_id == :extend
+            traverser = SexpTraverser.new(Abstriker.sexps[t.path])
+            traverser.traverse do |n, parent|
+              if n[0] == :@ident && n[1] == "extend" && n[2][0] == t.lineno
+                if parent[0] == :command || parent[0] == :fcall
+                  # extend Mod
+                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.extend Mod
+                  else
+                    # unknown case
+                    target_outer_extend = true
+                  end
+                else
+                  target_outer_extend = true
+                end
+              end
+            end
+          end
+
           target_end_event = t_self == klass && t.event == :end
-          target_b_return_event = t_self == klass && t.event == :b_return && block_count.zero?
-          target_c_return_event = t_self == Class && t.event == :c_return && t.method_id == :new
-          if target_end_event || target_b_return_event || target_c_return_event
+          target_c_return_event = (t_self == Class || t_self == Module) && t.event == :c_return && t.method_id == :new
+          if target_end_event || target_c_return_event || target_outer_extend
             klass.singleton_class.ancestors.drop(1).each do |mod|
               Abstriker.abstract_methods[mod]&.each do |fmeth_name|
                 meth = klass.singleton_class.instance_method(fmeth_name)
@@ -170,11 +212,27 @@ module Abstriker
     private
 
     def included(base)
-      check_abstract_methods(base, 1)
+      super
+      return if Abstriker.disabled?
+
+      caller_info = caller_locations(1, 1)[0]
+
+      unless Abstriker.sexps[caller_info.absolute_path]
+        Abstriker.sexps[caller_info.absolute_path] ||= Ripper.sexp(File.read(caller_info.absolute_path))
+      end
+      check_abstract_methods(base)
     end
 
     def extended(base)
-      check_abstract_singleton_methods(base, 1)
+      super
+      return if Abstriker.disabled?
+
+      caller_info = caller_locations(1, 1)[0]
+
+      unless Abstriker.sexps[caller_info.absolute_path]
+        Abstriker.sexps[caller_info.absolute_path] ||= Ripper.sexp(File.read(caller_info.absolute_path))
+      end
+      check_abstract_singleton_methods(base)
     end
   end
 end

data/lib/abstriker/version.rb

@@ -1,3 +1,3 @@
 module Abstriker
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

metadata

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