mirrors 0.0.1

data/lib/mirrors/visitors/yasmdata.rb

@@ -0,0 +1,212 @@
+# -*-ruby-*-
+#
+
+class VM
+  class InstructionSequence
+    class Instruction
+      InsnID2NO = {
+        nop: 0,
+        getlocal: 1,
+        setlocal: 2,
+        getspecial: 3,
+        setspecial: 4,
+        getinstancevariable: 5,
+        setinstancevariable: 6,
+        getclassvariable: 7,
+        setclassvariable: 8,
+        getconstant: 9,
+        setconstant: 10,
+        getglobal: 11,
+        setglobal: 12,
+        putnil: 13,
+        putself: 14,
+        putobject: 15,
+        putspecialobject: 16,
+        putiseq: 17,
+        putstring: 18,
+        concatstrings: 19,
+        tostring: 20,
+        freezestring: 21,
+        toregexp: 22,
+        newarray: 23,
+        duparray: 24,
+        expandarray: 25,
+        concatarray: 26,
+        splatarray: 27,
+        newhash: 28,
+        newrange: 29,
+        pop: 30,
+        dup: 31,
+        dupn: 32,
+        swap: 33,
+        reverse: 34,
+        reput: 35,
+        topn: 36,
+        setn: 37,
+        adjuststack: 38,
+        defined: 39,
+        checkmatch: 40,
+        checkkeyword: 41,
+        trace: 42,
+        defineclass: 43,
+        send: 44,
+        opt_str_freeze: 45,
+        opt_newarray_max: 46,
+        opt_newarray_min: 47,
+        opt_send_without_block: 48,
+        invokesuper: 49,
+        invokeblock: 50,
+        leave: 51,
+        throw: 52,
+        jump: 53,
+        branchif: 54,
+        branchunless: 55,
+        branchnil: 56,
+        getinlinecache: 57,
+        setinlinecache: 58,
+        once: 59,
+        opt_case_dispatch: 60,
+        opt_plus: 61,
+        opt_minus: 62,
+        opt_mult: 63,
+        opt_div: 64,
+        opt_mod: 65,
+        opt_eq: 66,
+        opt_neq: 67,
+        opt_lt: 68,
+        opt_le: 69,
+        opt_gt: 70,
+        opt_ge: 71,
+        opt_ltlt: 72,
+        opt_aref: 73,
+        opt_aset: 74,
+        opt_aset_with: 75,
+        opt_aref_with: 76,
+        opt_length: 77,
+        opt_size: 78,
+        opt_empty_p: 79,
+        opt_succ: 80,
+        opt_not: 81,
+        opt_regexpmatch1: 82,
+        opt_regexpmatch2: 83,
+        opt_call_c_function: 84,
+        bitblt: 85,
+        answer: 86,
+        getlocal_OP__WC__0: 87,
+        getlocal_OP__WC__1: 88,
+        setlocal_OP__WC__0: 89,
+        setlocal_OP__WC__1: 90,
+        putobject_OP_INT2FIX_O_0_C_: 91,
+        putobject_OP_INT2FIX_O_1_C_: 92,
+
+      }
+
+      def self.id2insn_no(id)
+        if InsnID2NO.key? id
+          InsnID2NO[id]
+        end
+      end
+
+      InsnNO2Size = [
+        1, # nop => 0
+        3, # getlocal => 1
+        3, # setlocal => 2
+        3, # getspecial => 3
+        2, # setspecial => 4
+        3, # getinstancevariable => 5
+        3, # setinstancevariable => 6
+        2, # getclassvariable => 7
+        2, # setclassvariable => 8
+        2, # getconstant => 9
+        2, # setconstant => 10
+        2, # getglobal => 11
+        2, # setglobal => 12
+        1, # putnil => 13
+        1, # putself => 14
+        2, # putobject => 15
+        2, # putspecialobject => 16
+        2, # putiseq => 17
+        2, # putstring => 18
+        2, # concatstrings => 19
+        1, # tostring => 20
+        2, # freezestring => 21
+        3, # toregexp => 22
+        2, # newarray => 23
+        2, # duparray => 24
+        3, # expandarray => 25
+        1, # concatarray => 26
+        2, # splatarray => 27
+        2, # newhash => 28
+        2, # newrange => 29
+        1, # pop => 30
+        1, # dup => 31
+        2, # dupn => 32
+        1, # swap => 33
+        2, # reverse => 34
+        1, # reput => 35
+        2, # topn => 36
+        2, # setn => 37
+        2, # adjuststack => 38
+        4, # defined => 39
+        2, # checkmatch => 40
+        3, # checkkeyword => 41
+        2, # trace => 42
+        4, # defineclass => 43
+        4, # send => 44
+        2, # opt_str_freeze => 45
+        2, # opt_newarray_max => 46
+        2, # opt_newarray_min => 47
+        3, # opt_send_without_block => 48
+        4, # invokesuper => 49
+        2, # invokeblock => 50
+        1, # leave => 51
+        2, # throw => 52
+        2, # jump => 53
+        2, # branchif => 54
+        2, # branchunless => 55
+        2, # branchnil => 56
+        3, # getinlinecache => 57
+        2, # setinlinecache => 58
+        3, # once => 59
+        3, # opt_case_dispatch => 60
+        3, # opt_plus => 61
+        3, # opt_minus => 62
+        3, # opt_mult => 63
+        3, # opt_div => 64
+        3, # opt_mod => 65
+        3, # opt_eq => 66
+        5, # opt_neq => 67
+        3, # opt_lt => 68
+        3, # opt_le => 69
+        3, # opt_gt => 70
+        3, # opt_ge => 71
+        3, # opt_ltlt => 72
+        3, # opt_aref => 73
+        3, # opt_aset => 74
+        4, # opt_aset_with => 75
+        4, # opt_aref_with => 76
+        3, # opt_length => 77
+        3, # opt_size => 78
+        3, # opt_empty_p => 79
+        3, # opt_succ => 80
+        3, # opt_not => 81
+        2, # opt_regexpmatch1 => 82
+        3, # opt_regexpmatch2 => 83
+        2, # opt_call_c_function => 84
+        1, # bitblt => 85
+        1, # answer => 86
+        2, # getlocal_OP__WC__0 => 87
+        2, # getlocal_OP__WC__1 => 88
+        2, # setlocal_OP__WC__0 => 89
+        2, # setlocal_OP__WC__1 => 90
+        1, # putobject_OP_INT2FIX_O_0_C_ => 91
+        1, # putobject_OP_INT2FIX_O_1_C_ => 92
+
+      ]
+
+      def self.insn_no2size(ins_no)
+        InsnNO2Size[ins_no]
+      end
+    end
+  end
+end

data/lol.rb

@@ -0,0 +1,35 @@
+require 'mirrors'
+require 'byebug'
+
+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
+
+@m = Mirrors.reflect(ClassFixture)
+puts "Foo" == @m.constant("Foo").name

data/mirrors.gemspec

@@ -0,0 +1,19 @@
+Gem::Specification.new do |s|
+  s.name          = 'mirrors'
+  s.version       = '0.0.1'
+  s.platform      = Gem::Platform::RUBY
+  s.licenses      = ['MIT']
+  s.authors       = ['Burke Libbey']
+  s.email         = ['burke.libbey@shopify.com']
+  s.homepage      = 'https://github.com/Shopify/mirrors'
+  s.summary       = 'Mirror API for Ruby'
+  s.description   = 'Provides a number of specs and classes that document a mirror API for Ruby.'
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- spec/*`.split("\n")
+  s.require_paths = ['lib']
+
+  s.add_development_dependency 'minitest', '~> 5.0'
+  s.add_development_dependency 'byebug', '~> 9.0.6'
+
+  s.add_runtime_dependency 'method_source', '~> 0.8'
+end

data/test/fixtures/class.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/test/fixtures/field.rb

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

data/test/fixtures/method.rb

@@ -0,0 +1,15 @@
+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/test/fixtures/object.rb

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

data/test/fixtures/reflect.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/test/mirrors/class_mirror_test.rb

@@ -0,0 +1,87 @@
+require 'test_helper'
+
+module Mirrors
+  class ClassMirrorTest < MiniTest::Test
+    def setup
+      @m = Mirrors.reflect(ClassFixture)
+      super
+    end
+
+    def test_name
+      assert_equal(ClassFixture.name, @m.name)
+    end
+
+    def test_class_variables
+      names = @m.class_variables.collect(&:name)
+      assert_includes(names, "@@cva")
+    end
+
+    def test_class_instance_variables
+      names = @m.class_instance_variables.collect(&:name)
+      assert_includes(names, "@civa")
+    end
+
+    def test_constants
+      names = @m.constants.collect(&:name)
+      assert_includes(names, "Foo")
+    end
+
+    def test_constant
+      assert_equal("Foo", @m.constant("Foo").name)
+    end
+
+    def test_nested_constant
+      cname = ClassFixture::ClassFixtureNested::ClassFixtureNestedNested.name
+      ct = @m.constant(cname)
+      assert_equal("ClassFixtureNestedNested", ct.name)
+      assert_equal(cname, ct.value.name)
+    end
+
+    def test_nested_classes
+      assert_equal(ClassFixture::ClassFixtureNested.name, @m.nested_classes.first.name)
+    end
+
+    def test_instance_methods
+      assert_equal(ClassFixture.instance_methods(false).size, @m.methods.size)
+    end
+
+    def test_instance_method
+      n = ClassFixture.instance_methods.first
+      assert(@m.method(n).mirrors?(ClassFixture.instance_method(n)))
+    end
+
+    def test_ancestors
+      act = @m.ancestors.map(&:name)
+      exp = ClassFixture.ancestors.map(&:name)
+      exp.each do |name|
+        assert_includes(act, name)
+      end
+    end
+
+    def test_superclass
+      assert_equal(ClassFixture.superclass.name, @m.superclass.name)
+    end
+
+    def test_subclasses
+      assert_equal(1, @m.subclasses.size)
+    end
+
+    def test_mixins
+      assert_equal(ClassFixtureModule.name, @m.mixins.first.name)
+    end
+
+    def test_nesting
+      m = Mirrors.reflect(ClassFixture::ClassFixtureNested)
+      nesting = m.nesting
+      assert_equal([ClassFixture::ClassFixtureNested, ClassFixture], nesting)
+    end
+
+    def test_source_locations
+      assert(@m.source_files.any? { |l| l.include?('fixtures/class.rb') })
+    end
+
+    def test_constant_value
+      assert_equal("Bar", @m.constant("Foo").value.name)
+    end
+  end
+end

data/test/mirrors/field_mirror_test.rb

@@ -0,0 +1,125 @@
+require 'test_helper'
+
+module Mirrors
+  class FieldMirrorTest < MiniTest::Test
+    module FieldMirrorTests
+      def test_name
+        assert_equal(@nom, @m.name)
+      end
+
+      def test_value
+        assert_equal(@nom.sub(/@@?/, ''), @m.value.name)
+      end
+
+      def test_set_value
+        old_value = @o.send(:"#{@class_side}_variable_get", @nom)
+        @m.value = "changed"
+        assert_equal("changed", @o.send(:"#{@class_side}_variable_get", @nom))
+        assert_equal("changed", @m.value.name)
+        @m.value = old_value
+      end
+
+      def test_reports_vars_as_private
+        assert(@m.private?)
+        refute(@m.protected?)
+        refute(@m.public?)
+      end
+    end
+
+    class InstanceVariableMirrorTest < MiniTest::Test
+      def setup
+        @o = FieldFixture.new
+        @om = Mirrors.reflect(@o)
+        @m = @om.variables.first
+        @nom = "@ivar"
+        @class_side = "instance"
+        super
+      end
+
+      include FieldMirrorTests
+    end
+
+    class ClassInstanceVariableMirrorTest < MiniTest::Test
+      def setup
+        @o = FieldFixture
+        @om = Mirrors.reflect(@o)
+        @m = @om.variables.first
+        @nom = "@civar"
+        @class_side = "instance"
+        super
+      end
+
+      include FieldMirrorTests
+    end
+
+    class ClassVariableMirrorTest < MiniTest::Test
+      def setup
+        @o = FieldFixture
+        @om = Mirrors.reflect(@o)
+        @m = @om.class_variables.first
+        @nom = "@@cvar"
+        @class_side = "class"
+        super
+      end
+
+      include FieldMirrorTests
+    end
+  end
+
+  class ConstantMirrorTest < MiniTest::Test
+    def setup
+      @o = FieldFixture
+      @om = Mirrors.reflect(@o)
+      @m = @om.constants.first
+      @name = "CONSTANT"
+      super
+    end
+
+    def test_name
+      assert_equal(@name, @m.name)
+    end
+
+    def test_value
+      assert_equal(@name.downcase, @m.value.name)
+    end
+
+    def test_set_value
+      silence do
+        old_value = @m.value.reflectee
+        @m.value = "changed"
+        assert_equal("changed", @o.const_get(@name))
+        assert_equal("changed", @m.value.name)
+        @m.value = old_value
+      end
+    end
+
+    def test_public
+      refute(@m.private?)
+      refute(@m.protected?)
+      assert(@m.public?)
+    end
+
+    def test_delete
+      @m.delete
+      refute_includes(@om.constants, @m)
+      @m = @om.reflectee.const_set(@m.name, @name)
+      silence do
+        @om.constant(@name).value = "constant"
+      end
+    end
+
+    def test_add
+      cst = @om.constant("MyNewlyAddedConstant")
+      refute_includes(@om.constants.map(&:name), "MyNewlyAddedConstant")
+      cst.value = "MyNewlyAddedConstant"
+      assert_includes(@om.constants.map(&:name), "MyNewlyAddedConstant")
+      cst.delete
+    end
+
+    private
+
+    def silence(&block)
+      capture_subprocess_io(&block)
+    end
+  end
+end