rubymirrors 0.0.1

data/lib/ruby/reflection/stack_frame_mirror.rb

@@ -0,0 +1,49 @@
+module Ruby
+  class Reflection
+    class StackFrameMirror < Mirror
+      include AbstractReflection::StackFrameMirror
+      reflect! ThreadMirror::Frame
+
+      attr_reader :name
+      attr_reader :method
+
+      def initialize(obj)
+        super
+        @name = obj.method
+        @index = obj.index
+        @method = find_method_for(obj.file, obj.line)
+        @thread = obj.thread
+      end
+
+      def step_offset
+        @method.step_offsets.index(source_offset)
+      end
+
+      def source_offset
+        if next_frame = @thread.stack[@index - 1]
+          s = @method.send_offsets[next_frame.name]
+        end
+        s || raise(CapabilitiesExceeded)
+      end
+
+      def selector
+        @name
+      end
+
+      private
+      def find_method_for(file, line)
+        # Find all methods that are in the same file and start before
+        # or on the current line of execution
+        possible_methods = reflection.implementations_of(@name).select do |m|
+          f, l = m.send(:source_location)
+          f == file && l.to_i <= line.to_i
+        end
+
+        # Sort by source location. The last method will be the method
+        # that starts closest to the current line of execution. This
+        # should (for most purposes) be the method we're looking for
+        possible_methods.sort_by {|m| m.send(:source_location).last }.last
+      end
+    end
+  end
+end

data/lib/ruby/reflection/support/shift_reset.rb

@@ -0,0 +1,29 @@
+# -*- coding: utf-8 -*-
+# Modeled after Andrzej Filinski's article "Representing
+# Monads" at POPL'94, and a Scheme implementation of it.
+# http://citeseer.ist.psu.edu/filinski94representing.html
+#
+# Copyright 2004–2011 Christian Neukirchen
+module ShiftReset
+  @@metacont = lambda do |x|
+    raise RuntimeError, "You forgot the top-level reset..."
+  end
+
+  def reset(&block)
+    mc = @@metacont
+    callcc do |k|
+      @@metacont = lambda do |v|
+        @@metacont = mc
+        k.call v
+      end
+      x = block.call
+      @@metacont.call x
+    end
+  end
+
+  def shift(&block)
+    callcc do |k|
+      @@metacont.call block.call(lambda {|*v| reset { k.call *v } })
+    end
+  end
+end

data/lib/ruby/reflection/thread_mirror.rb

@@ -0,0 +1,47 @@
+require 'ruby/reflection/support/shift_reset'
+require 'continuation' unless defined? callcc
+
+module Ruby
+  class Reflection
+    class ThreadMirror < ObjectMirror
+      include AbstractReflection::ThreadMirror
+      include ShiftReset
+      reflect! Thread
+      Frame = Struct.new :method, :index, :file, :line, :thread
+
+      def status
+        s = @subject.status
+        if s.respond_to? :to_str
+          s.to_str
+        elsif s.nil?
+          "aborted"
+        else
+          "dead"
+        end
+      end
+
+      def run
+        @subject.run
+      end
+
+      def stack
+        if bt = @subject.backtrace
+          bt.each_with_index.collect do |str, idx|
+            file, line, method_spec = str.split(':')
+            method_spec =~ /\`([^']+)'/
+            method = $1
+            frame = Frame.new method, idx, file, line, self
+            reflection.reflect frame
+          end
+        else
+          []
+        end
+      end
+
+      def return_value
+        return nil if @subject.alive?
+        @subject.value
+      end
+    end
+  end
+end

data/rubymirrors.gemspec

@@ -0,0 +1,12 @@
+Gem::Specification.new do |s|
+  s.name          = "rubymirrors"
+  s.version       = "0.0.1"
+  s.platform      = Gem::Platform::RUBY
+  s.authors       = ["Tim Felgentreff"]
+  s.email         = ["timfelgentreff@gmail.com"]
+  s.summary       = "Mirror API for Ruby"
+  s.description   = File.read(File.expand_path("../README.md", __FILE__))
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- spec/*`.split("\n")
+  s.require_paths = ["lib"]
+end

data/spec/class_spec.rb

@@ -0,0 +1,92 @@
+require File.expand_path('../spec_helper', __FILE__)
+require 'fixtures/class_spec'
+
+describe "ClassMirror" do
+
+  before do
+    @r = reflection
+    @m = reflection.reflect(ClassFixture)
+  end
+
+  describe "queries" do
+    it "name" do
+      @m.name.should == ClassFixture.name
+    end
+
+    it "known instance variables" do
+      names = @m.instance_variables.collect(&:name)
+      names.should include("@a", "@b")
+    end
+
+    it "known class variables" do
+      names = @m.class_variables.collect(&:name)
+      names.should include "@@cva"
+    end
+
+    it "known class instance variables" do
+      names = @m.class_instance_variables.collect(&:name)
+      names.should include "@civa"
+    end
+
+    it "known constants" do
+      names = @m.constants.collect(&:name)
+      names.should include "Foo"
+    end
+
+    it "can return a mirror on a particular constant" do
+      @m.constant("Foo").name.should == "Foo"
+    end
+
+    it "can find a nested constant" do
+      cname = ClassFixture::ClassFixtureNested::ClassFixtureNestedNested.name
+      ct = @m.constant(cname)
+      ct.name.should == "ClassFixtureNestedNested"
+      ct.value.name.should == cname
+    end
+
+    it "known inner classes" do
+      @m.nested_classes.first.name.should == ClassFixture::ClassFixtureNested.name
+    end
+
+    it "known instance methods" do
+      @m.methods.size.should == ClassFixture.instance_methods(false).size
+    end
+
+    it "can return one particular method" do
+      n = ClassFixture.instance_methods.first
+      @m.method(n).mirrors?(ClassFixture.instance_method(n)).should == true
+    end
+
+    it "ancestors" do
+      ancestorsnames = [*ClassFixture.ancestors.collect(&:name)]
+      @m.ancestors.collect(&:name).should include *ancestorsnames
+    end
+
+    it "superclass" do
+      @m.superclass.name.should == ClassFixture.superclass.name
+    end
+
+    it "known subclasses" do
+      @m.subclasses.size.should == 1
+    end
+
+    it "mixins" do
+      @m.mixins.first.name.should == ClassFixtureModule.name
+    end
+
+    it "nesting" do
+      m = @r.reflect ClassFixture::ClassFixtureNested
+      nesting = m.nesting
+      nesting.should == [ClassFixture::ClassFixtureNested, ClassFixture]
+    end
+
+    it "source locations" do
+      @m.source_files.any? {|l| l =~ /spec\/class_spec.rb/ }.should.be_true
+      @m.source_files.any? {|l| l =~ /fixtures\/class_spec.rb/ }.should.be_true
+    end
+
+    it "value of a known constant" do
+      @m.constant("Foo").value.name.should == "Bar".inspect
+    end
+  end
+end

data/spec/field_spec.rb

@@ -0,0 +1,119 @@
+require File.expand_path('../spec_helper', __FILE__)
+require 'fixtures/field_spec'
+
+describe "FieldMirror" do
+  describe "variables", :shared => true do
+    it "reports the ivar name as name" do
+      @m.name.should == @nom
+    end
+
+    it "reports the var value" do
+      @m.value.name.should == @nom.sub(/@@?/, '').inspect
+    end
+
+    it "can change the value" do
+      old_value = @o.send(:"#{@class_side}_variable_get", @nom)
+      @m.value = "changed"
+      @o.send(:"#{@class_side}_variable_get", @nom).should == "changed"
+      @m.value = old_value
+    end
+
+    it "always shows the current value" do
+      @m.value.name.should == @nom.sub(/@@?/, '').inspect
+      @o.send(:"#{@class_side}_variable_set", @nom, "changed")
+      @m.value.name.should == "changed".inspect
+    end
+
+    it "reports vars as private only" do
+      @m.private?.should be_true
+      @m.protected?.should be_false
+      @m.public?.should be_false
+    end
+  end
+
+  describe "instance variables" do
+    before(:each) do
+      @o = FieldFixture.new
+      @om = reflection.reflect(@o)
+      @m = @om.variables.first
+      @nom = "@ivar"
+      @class_side = "instance"
+    end
+
+    it_behaves_like "variables", "instance variables"
+  end
+
+  describe "class instance variables" do
+    before(:each) do
+      @o = FieldFixture
+      @om = reflection.reflect(@o)
+      @m = @om.variables.first
+      @nom = "@civar"
+      @class_side = "instance"
+    end
+
+    it_behaves_like "variables", "class instance variables"
+  end
+
+  describe "class variables" do
+    before(:each) do
+      @o = FieldFixture
+      @om = reflection.reflect(@o)
+      @m = @om.class_variables.first
+      @nom = "@@cvar"
+      @class_side = "class"
+    end
+
+    it_behaves_like "variables", "class variables"
+  end
+
+  describe "constants" do
+    before(:each) do
+      @o = FieldFixture
+      @om = reflection.reflect(@o)
+      @m = @om.constants.first
+      @name = "CONSTANT"
+    end
+
+    it "reports the constant name as name" do
+      @m.name.should == @name
+    end
+
+    it "reports the ivar value" do
+      @m.value.name.should == @name.downcase.inspect
+    end
+
+    it "can change the value" do
+      old_value = @m.value.reflectee
+      @m.value = "changed"
+      @o.const_get(@name).should == "changed"
+      @m.value = old_value
+    end
+
+    it "always shows the current value" do
+      @m.value.name.should == @name.downcase.inspect
+      @o.const_set(@name, "changed")
+      @m.value.name.should == "changed".inspect
+    end
+
+    it "reports constants as public" do
+      @m.private?.should be_false
+      @m.protected?.should be_false
+      @m.public?.should be_true
+    end
+
+    it "can delete a constant" do
+      @m.delete
+      @om.constants.should_not include @m
+
+      @m = @om.reflectee.const_set(@m.name, @name)
+    end
+
+    it "can add a constant" do
+      cst = @om.constant("MyNewlyAddedConstant")
+      @om.constants.collect(&:name).should_not include("MyNewlyAddedConstant")
+      cst.value = "MyNewlyAddedConstant"
+      @om.constants.collect(&:name).should include("MyNewlyAddedConstant")
+    end
+  end
+end

data/spec/fixtures/class_spec.rb

@@ -0,0 +1,29 @@
+module ClassFixtureModule
+end
+
+class ClassFixture
+  Foo = "Bar"
+
+  class ClassFixtureNested
+    class ClassFixtureNestedNested
+    end
+  end
+  include ClassFixtureModule
+
+  attr_accessor :b
+  def a
+    @a = 1
+    @@cvb = 1
+  end
+
+  @@cva = 1
+  @civa = 1
+
+  def self.b
+    @@cvc = 1
+    @civb = 1
+  end
+end
+
+class ClassFixtureSubclass < ClassFixture; end
+class ClassFixtureSubclassSubclass < ClassFixtureSubclass; end

data/spec/fixtures/field_spec.rb

@@ -0,0 +1,9 @@
+class FieldFixture
+  attr_accessor :ivar
+  def initialize
+    @ivar = "ivar"
+  end
+  CONSTANT = "constant"
+  @@cvar = "cvar"
+  @civar = "civar"
+end

data/spec/fixtures/method_spec.rb

@@ -0,0 +1,14 @@
+class MethodSpecFixture
+  def source_location
+    [__FILE__, __LINE__, __method__.to_s, self.class]
+  end
+
+  def removeable_method
+  end
+
+  def method_p_public; end
+  def method_p_private; end
+  private :method_p_private
+  def method_p_protected; end
+  protected :method_p_protected
+end

data/spec/fixtures/object_spec.rb

@@ -0,0 +1,5 @@
+class ObjectFixture
+  def initialize
+    @ivar = "ivar"
+  end
+end

data/spec/fixtures/reflect_spec.rb

@@ -0,0 +1,14 @@
+
+class ReflectClass
+  def unique_reflect_fixture_method
+    unique_reflect_sent_method
+  end
+
+  def unique_reflect_sent_method
+  end
+end
+
+module ReflectModule
+end
+
+reflect_string = "string"

data/spec/fixtures/stack_frame_spec.rb

@@ -0,0 +1,5 @@
+class FrameFixture
+  def my_stop(argument); local = "local_value"; Thread.stop; end
+  def my_return; 2; end
+  def my_raise; raise "stop"; end
+end

data/spec/fixtures/thread_spec.rb

@@ -0,0 +1,5 @@
+class ThreadFixture
+  def stop; Thread.stop; end
+  def return; 2; end
+  def t_raise; raise "stop"; end
+end