sexp_processor 4.3.0 → 4.4.0

data/History.txt

@@ -1,3 +1,9 @@
+=== 4.4.0 / 2013-10-18
+
+* 1 minor enhancement:
+
+  * Added MethodBasedSexpProcessor, extracted from Flog.
+
 === 4.3.0 / 2013-08-19
 
 * 1 minor enhancement:

data/lib/sexp_processor.rb

@@ -33,7 +33,7 @@ require 'sexp'
 
 class SexpProcessor
 
-  VERSION = "4.3.0"
+  VERSION = "4.4.0"
 
   ##
   # Automatically shifts off the Sexp type before handing the
@@ -404,6 +404,205 @@ class SexpInterpreter < SexpProcessor
   end
 end
 
+##
+# A simple subclass of SexpProcessor that tracks method and class
+# stacks for you. Use #method_name, #klass_name, or #signature to
+# refer to where you're at in processing. If you have to subclass
+# process_(class|module|defn|defs) you _must_ call super.
+
+class MethodBasedSexpProcessor < SexpProcessor
+  @@no_class  = :main
+  @@no_method = :none
+
+  attr_reader :class_stack, :method_stack, :sclass, :method_locations
+
+  def initialize
+    super
+    @sclass              = []
+    @class_stack         = []
+    @method_stack        = []
+    @method_locations    = {}
+    self.require_empty   = false
+  end
+
+  ##
+  # Adds name to the class stack, for the duration of the block
+
+  def in_klass name
+    if Sexp === name then
+      name = case name.first
+             when :colon2 then
+               name = name.flatten
+               name.delete :const
+               name.delete :colon2
+               name.join("::")
+             when :colon3 then
+               name.last.to_s
+             else
+               raise "unknown type #{name.inspect}"
+             end
+    end
+
+    @class_stack.unshift name
+    yield
+  ensure
+    @class_stack.shift
+  end
+
+  ##
+  # Adds name to the method stack, for the duration of the block
+
+  def in_method(name, file, line)
+    method_name = Regexp === name ? name.inspect : name.to_s
+    @method_stack.unshift method_name
+    @method_locations[signature] = "#{file}:#{line}"
+    yield
+  ensure
+    @method_stack.shift
+  end
+
+  ##
+  # Tracks whether we're in a singleton class or not. Doesn't track
+  # actual receiver.
+
+  def in_sklass
+    @sclass.push true
+    yield
+  ensure
+    @sclass.pop
+  end
+
+  ##
+  # Returns the first class in the list, or @@no_class if there are
+  # none.
+
+  def klass_name
+    name = @class_stack.first
+
+    if Sexp === name then
+      raise "you shouldn't see me"
+    elsif @class_stack.any?
+      @class_stack.reverse.join("::").sub(/\([^\)]+\)$/, '')
+    else
+      @@no_class
+    end
+  end
+
+  ##
+  # Returns the first method in the list, or "#none" if there are
+  # none.
+
+  def method_name
+    m = @method_stack.first || @@no_method
+    m = "##{m}" unless m =~ /::/
+    m
+  end
+
+  ##
+  # Process a class node until empty. Tracks all nesting. If you have
+  # to subclass and override this method, you can clall super with a
+  # block.
+
+  def process_class(exp)
+    exp.shift unless auto_shift_type # node type
+    in_klass exp.shift do
+      if block_given? then
+        yield
+      else
+        process_until_empty exp
+      end
+    end
+    s()
+  end
+
+  ##
+  # Process a method node until empty. Tracks your location. If you
+  # have to subclass and override this method, you can clall super
+  # with a block.
+
+  def process_defn(exp)
+    exp.shift unless auto_shift_type # node type
+    name = @sclass.empty? ? exp.shift : "::#{exp.shift}"
+    in_method name, exp.file, exp.line do
+      if block_given? then
+        yield
+      else
+        process_until_empty exp
+      end
+    end
+    s()
+  end
+
+  ##
+  # Process a singleton method node until empty. Tracks your location.
+  # If you have to subclass and override this method, you can clall
+  # super with a block.
+
+  def process_defs(exp)
+    exp.shift unless auto_shift_type # node type
+    process exp.shift # recv
+    in_method "::#{exp.shift}", exp.file, exp.line do
+      if block_given? then
+        yield
+      else
+        process_until_empty exp
+      end
+    end
+    s()
+  end
+
+  ##
+  # Process a module node until empty. Tracks all nesting. If you have
+  # to subclass and override this method, you can clall super with a
+  # block.
+
+  def process_module(exp)
+    exp.shift unless auto_shift_type # node type
+    in_klass exp.shift do
+      if block_given? then
+        yield
+      else
+        process_until_empty exp
+      end
+    end
+    s()
+  end
+
+  ##
+  # Process a singleton class node until empty. Tracks all nesting. If
+  # you have to subclass and override this method, you can clall super
+  # with a block.
+
+  def process_sclass(exp)
+    exp.shift unless auto_shift_type # node type
+    in_sklass do
+      if block_given? then
+        yield
+      else
+        process_until_empty exp
+      end
+    end
+    s()
+  end
+
+  ##
+  # Process each element of #exp in turn.
+
+  def process_until_empty exp
+    until exp.empty?
+      sexp = exp.shift
+      process sexp if Sexp === sexp
+    end
+  end
+
+  ##
+  # Returns the method signature for the current method.
+
+  def signature
+    "#{klass_name}#{method_name}"
+  end
+end
+
 class Object
 
   ##

data/test/test_sexp_processor.rb

@@ -295,3 +295,78 @@ class TestSexpProcessor < Minitest::Test
   def test_warn_on_default=; skip; end
 
 end
+
+class TestMethodBasedSexpProcessor < Minitest::Test
+  attr_accessor :processor
+
+  def setup
+    self.processor = MethodBasedSexpProcessor.new
+  end
+
+  def test_in_klass
+    assert_empty processor.class_stack
+
+    processor.in_klass "xxx::yyy" do
+      assert_equal ["xxx::yyy"], processor.class_stack
+    end
+
+    assert_empty processor.class_stack
+  end
+
+  def test_in_method
+    assert_empty processor.method_stack
+
+    processor.in_method "xxx", "file.rb", 42 do
+      assert_equal ["xxx"], processor.method_stack
+    end
+
+    assert_empty processor.method_stack
+
+    expected = {"main#xxx" => "file.rb:42"}
+    assert_equal expected, processor.method_locations
+  end
+
+  def test_klass_name
+    assert_equal :main, processor.klass_name
+
+    processor.class_stack << "whatevs" << "flog"
+    assert_equal "flog::whatevs", processor.klass_name
+  end
+
+  def test_klass_name_sexp
+    processor.in_klass s(:colon2, s(:const, :X), :Y) do
+      assert_equal "X::Y", processor.klass_name
+    end
+
+    processor.in_klass s(:colon3, :Y) do
+      assert_equal "Y", processor.klass_name
+    end
+  end
+
+  def test_method_name
+    assert_equal "#none", processor.method_name
+
+    processor.method_stack << "whatevs"
+    assert_equal "#whatevs", processor.method_name
+  end
+
+  def test_method_name_cls
+    assert_equal "#none", processor.method_name
+
+    processor.method_stack << "::whatevs"
+    assert_equal "::whatevs", processor.method_name
+  end
+
+  def test_signature
+    assert_equal "main#none", processor.signature
+
+    processor.class_stack << "X"
+    assert_equal "X#none", processor.signature
+
+    processor.method_stack << "y"
+    assert_equal "X#y", processor.signature
+
+    processor.class_stack.shift
+    assert_equal "main#y", processor.signature
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sexp_processor
 version: !ruby/object:Gem::Version 
-  hash: 51
+  hash: 47
   prerelease: 
   segments: 
   - 4
-  - 3
+  - 4
   - 0
-  version: 4.3.0
+  version: 4.4.0
 platform: ruby
 authors: 
 - Ryan Davis
@@ -16,9 +16,9 @@ bindir: bin
 cert_chain: 
 - |
   -----BEGIN CERTIFICATE-----
-  MIIDPjCCAiagAwIBAgIBADANBgkqhkiG9w0BAQUFADBFMRMwEQYDVQQDDApyeWFu
+  MIIDPjCCAiagAwIBAgIBATANBgkqhkiG9w0BAQUFADBFMRMwEQYDVQQDDApyeWFu
   ZC1ydWJ5MRkwFwYKCZImiZPyLGQBGRYJemVuc3BpZGVyMRMwEQYKCZImiZPyLGQB
-  GRYDY29tMB4XDTA5MDMwNjE4NTMxNVoXDTEwMDMwNjE4NTMxNVowRTETMBEGA1UE
+  GRYDY29tMB4XDTEzMDkxNjIzMDQxMloXDTE0MDkxNjIzMDQxMlowRTETMBEGA1UE
   AwwKcnlhbmQtcnVieTEZMBcGCgmSJomT8ixkARkWCXplbnNwaWRlcjETMBEGCgmS
   JomT8ixkARkWA2NvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBALda
   b9DCgK+627gPJkB6XfjZ1itoOQvpqH1EXScSaba9/S2VF22VYQbXU1xQXL/WzCkx
@@ -28,15 +28,15 @@ cert_chain:
   qhtV7HJxNKuPj/JFH0D2cswvzznE/a5FOYO68g+YCuFi5L8wZuuM8zzdwjrWHqSV
   gBEfoTEGr7Zii72cx+sCAwEAAaM5MDcwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAw
   HQYDVR0OBBYEFEfFe9md/r/tj/Wmwpy+MI8d9k/hMA0GCSqGSIb3DQEBBQUAA4IB
-  AQAY59gYvDxqSqgC92nAP9P8dnGgfZgLxP237xS6XxFGJSghdz/nI6pusfCWKM8m
-  vzjjH2wUMSSf3tNudQ3rCGLf2epkcU13/rguI88wO6MrE0wi4ZqLQX+eZQFskJb/
-  w6x9W1ur8eR01s397LSMexySDBrJOh34cm2AlfKr/jokKCTwcM0OvVZnAutaovC0
-  l1SVZ0ecg88bsWHA0Yhh7NFxK1utWoIhtB6AFC/+trM0FQEB/jZkIS8SaNzn96Rl
-  n0sZEf77FLf5peR8TP/PtmIg7Cyqz23sLM4mCOoTGIy5OcZ8TdyiyINUHtb5ej/T
-  FBHgymkyj/AOSqKRIpXPhjC6
+  AQCFZ7JTzoy1gcG4d8A6dmOJy7ygtO5MFpRIz8HuKCF5566nOvpy7aHhDDzFmQuu
+  FX3zDU6ghx5cQIueDhf2SGOncyBmmJRRYawm3wI0o1MeN6LZJ/3cRaOTjSFy6+S6
+  zqDmHBp8fVA2TGJtO0BLNkbGVrBJjh0UPmSoGzWlRhEVnYC33TpDAbNA+u39UrQI
+  ynwhNN7YbnmSR7+JU2cUjBFv2iPBO+TGuWC+9L2zn3NHjuc6tnmSYipA9y8Hv+As
+  Y4evBVezr3SjXz08vPqRO5YRdO3zfeMT8gBjRqZjWJGMZ2lD4XNfrs7eky74CyZw
+  xx3n58i0lQkBE1EpKE0lFu/y
   -----END CERTIFICATE-----
 
-date: 2013-08-19 00:00:00 Z
+date: 2013-10-18 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: minitest