1 files changed, 435 insertions, 0 deletions
diff --git a/spec/ruby/optional/capi/module_spec.rb b/spec/ruby/optional/capi/module_spec.rb
new file mode 100644
index 0000000000..b9c36f569f
--- /dev/null
+++ b/spec/ruby/optional/capi/module_spec.rb
@@ -0,0 +1,435 @@
+require_relative 'spec_helper'
+require_relative 'fixtures/module'
+
+load_extension('module')
+compile_extension("module_under_autoload")
+
+describe "CApiModule" do
+
+  before :each do
+    @m = CApiModuleSpecs.new
+  end
+
+  describe "rb_define_global_const" do
+    it "defines a constant on Object" do
+      @m.rb_define_global_const("CApiModuleSpecsGlobalConst", 7)
+      ::CApiModuleSpecsGlobalConst.should == 7
+      Object.send :remove_const, :CApiModuleSpecsGlobalConst
+    end
+  end
+
+  describe "rb_const_set given a symbol name and a value" do
+    it "sets a new constant on a module" do
+      @m.rb_const_set(CApiModuleSpecs::C, :W, 7)
+      CApiModuleSpecs::C::W.should == 7
+    ensure
+      CApiModuleSpecs::C.send(:remove_const, :W)
+    end
+
+    it "sets an existing constant's value" do
+      -> {
+        @m.rb_const_set(CApiModuleSpecs::C, :Z, 8)
+      }.should complain(/already initialized constant/)
+      CApiModuleSpecs::C::Z.should == 8
+    end
+
+    it "allows arbitrary names, including constant names not valid in Ruby" do
+      -> {
+        CApiModuleSpecs::C.const_set(:_INVALID, 1)
+      }.should.raise(NameError, /wrong constant name/)
+
+      suppress_warning { @m.rb_const_set(CApiModuleSpecs::C, :_INVALID, 2) }
+      @m.rb_const_get(CApiModuleSpecs::C, :_INVALID).should == 2
+
+      # Ruby-level should still not allow access
+      -> {
+        CApiModuleSpecs::C.const_get(:_INVALID)
+      }.should.raise(NameError, /wrong constant name/)
+    end
+  end
+
+  describe "rb_define_module" do
+    it "returns the module if it is already defined" do
+      mod = @m.rb_define_module("CApiModuleSpecsModuleA")
+      mod.const_get(:X).should == 1
+    end
+
+    it "raises a TypeError if the constant is not a module" do
+      ::CApiModuleSpecsGlobalConst = 7
+      -> { @m.rb_define_module("CApiModuleSpecsGlobalConst") }.should.raise(TypeError)
+      Object.send :remove_const, :CApiModuleSpecsGlobalConst
+    end
+
+    it "defines a new module at toplevel" do
+      mod = @m.rb_define_module("CApiModuleSpecsModuleB")
+      mod.should.is_a?(Module)
+      mod.name.should == "CApiModuleSpecsModuleB"
+      ::CApiModuleSpecsModuleB.should.is_a?(Module)
+      Object.send :remove_const, :CApiModuleSpecsModuleB
+    end
+  end
+
+  describe "rb_define_module_under" do
+    it "creates a new module inside the inner class" do
+      mod = @m.rb_define_module_under(CApiModuleSpecs, "ModuleSpecsModuleUnder1")
+      mod.should.is_a?(Module)
+    end
+
+    it "sets the module name" do
+      mod = @m.rb_define_module_under(CApiModuleSpecs, "ModuleSpecsModuleUnder2")
+      mod.name.should == "CApiModuleSpecs::ModuleSpecsModuleUnder2"
+    end
+  end
+
+  describe "rb_define_module_under" do
+    it "defines a module for an existing Autoload with an extension" do
+      CApiModuleSpecs::ModuleUnderAutoload.name.should == "CApiModuleSpecs::ModuleUnderAutoload"
+    end
+
+    it "defines a module for an existing Autoload with a ruby object" do
+      CApiModuleSpecs::RubyUnderAutoload.name.should == "CApiModuleSpecs::RubyUnderAutoload"
+    end
+  end
+
+  describe "rb_define_const given a String name and a value" do
+    it "defines a new constant on a module" do
+      @m.rb_define_const(CApiModuleSpecs::C, "V", 7)
+      CApiModuleSpecs::C::V.should == 7
+    ensure
+      CApiModuleSpecs::C.send(:remove_const, :V)
+    end
+
+    it "sets an existing constant's value" do
+      -> {
+        @m.rb_define_const(CApiModuleSpecs::C, "Z", 9)
+      }.should complain(/already initialized constant/)
+      CApiModuleSpecs::C::Z.should == 9
+    end
+  end
+
+  describe "rb_const_defined" do
+    # The fixture converts C boolean test to Ruby 'true' / 'false'
+    it "returns C non-zero if a constant is defined" do
+      @m.rb_const_defined(CApiModuleSpecs::A, :X).should == true
+    end
+
+    it "returns C non-zero if a constant is defined in Object" do
+      @m.rb_const_defined(CApiModuleSpecs::A, :Module).should == true
+    end
+  end
+
+  describe "rb_const_defined_at" do
+    # The fixture converts C boolean test to Ruby 'true' / 'false'
+    it "returns C non-zero if a constant is defined" do
+      @m.rb_const_defined_at(CApiModuleSpecs::A, :X).should == true
+    end
+
+    it "does not search in ancestors for the constant" do
+      @m.rb_const_defined_at(CApiModuleSpecs::B, :X).should == false
+    end
+
+    it "does not search in Object" do
+      @m.rb_const_defined_at(CApiModuleSpecs::A, :Module).should == false
+    end
+  end
+
+  describe "rb_const_get" do
+    it "returns a constant defined in the module" do
+      @m.rb_const_get(CApiModuleSpecs::A, :X).should == 1
+    end
+
+    it "returns a constant defined in the module for multiple constants" do
+      [:Q, :R, :S, :T].each { |x| @m.rb_const_get(CApiModuleSpecs::A, x).should == CApiModuleSpecs::A.const_get(x) }
+    end
+
+    it "returns a constant defined at toplevel" do
+      @m.rb_const_get(CApiModuleSpecs::A, :Integer).should == Integer
+    end
+
+    it "returns a constant defined in a superclass" do
+      @m.rb_const_get(CApiModuleSpecs::B, :X).should == 1
+    end
+
+    it "calls #const_missing if the constant is not defined in the class or ancestors" do
+      CApiModuleSpecs::A.should_receive(:const_missing).with(:CApiModuleSpecsUndefined)
+      @m.rb_const_get(CApiModuleSpecs::A, :CApiModuleSpecsUndefined)
+    end
+
+    it "resolves autoload constants in classes" do
+      @m.rb_const_get(CApiModuleSpecs::A, :D).should == 123
+    end
+
+    it "resolves autoload constants in Object" do
+      @m.rb_const_get(Object, :CApiModuleSpecsAutoload).should == 123
+    end
+
+    it "allows arbitrary names, including constant names not valid in Ruby" do
+      -> {
+        CApiModuleSpecs::A.const_get(:_INVALID)
+      }.should.raise(NameError, /wrong constant name/)
+
+      -> {
+        @m.rb_const_get(CApiModuleSpecs::A, :_INVALID)
+      }.should.raise(NameError, /uninitialized constant/)
+    end
+  end
+
+  describe "rb_const_get_from" do
+    it "returns a constant defined in the module" do
+      @m.rb_const_get_from(CApiModuleSpecs::B, :Y).should == 2
+    end
+
+    it "returns a constant defined in a superclass" do
+      @m.rb_const_get_from(CApiModuleSpecs::B, :X).should == 1
+    end
+
+    it "calls #const_missing if the constant is not defined in the class or ancestors" do
+      CApiModuleSpecs::M.should_receive(:const_missing).with(:Integer)
+      @m.rb_const_get_from(CApiModuleSpecs::M, :Integer)
+    end
+
+    it "resolves autoload constants" do
+      @m.rb_const_get_from(CApiModuleSpecs::A, :C).should == 123
+    end
+  end
+
+  describe "rb_const_get_at" do
+    it "returns a constant defined in the module" do
+      @m.rb_const_get_at(CApiModuleSpecs::B, :Y).should == 2
+    end
+
+    it "resolves autoload constants" do
+      @m.rb_const_get_at(CApiModuleSpecs::A, :B).should == 123
+    end
+
+    it "calls #const_missing if the constant is not defined in the module" do
+      CApiModuleSpecs::B.should_receive(:const_missing).with(:X)
+      @m.rb_const_get_at(CApiModuleSpecs::B, :X)
+    end
+  end
+
+  describe "rb_define_alias" do
+    it "defines an alias for an existing method" do
+      cls = Class.new do
+        def method_to_be_aliased
+          :method_to_be_aliased
+        end
+      end
+
+      @m.rb_define_alias cls, "method_alias", "method_to_be_aliased"
+      cls.new.method_alias.should == :method_to_be_aliased
+    end
+  end
+
+  describe "rb_alias" do
+    it "defines an alias for an existing method" do
+      cls = Class.new do
+        def method_to_be_aliased
+          :method_to_be_aliased
+        end
+      end
+
+      @m.rb_alias cls, :method_alias, :method_to_be_aliased
+      cls.new.method_alias.should == :method_to_be_aliased
+    end
+  end
+
+  describe "rb_define_global_function" do
+    it "defines a method on Kernel" do
+      @m.rb_define_global_function("module_specs_global_function")
+      Kernel.should.respond_to?(:module_specs_global_function)
+      module_specs_global_function.should == :test_method
+    end
+  end
+
+  describe "rb_define_method" do
+    it "defines a method on a class" do
+      cls = Class.new
+      @m.rb_define_method(cls, "test_method")
+      cls.should.method_defined?(:test_method, false)
+      cls.new.test_method.should == :test_method
+    end
+
+    it "returns the correct arity when argc of the method in class is 0" do
+      cls = Class.new
+      @m.rb_define_method(cls, "test_method")
+      cls.new.method(:test_method).arity.should == 0
+    end
+
+    it "returns the correct arity when argc of the method in class is 1" do
+      @m.rb_define_method_1required(42).should == 42
+      @m.method(:rb_define_method_1required).arity.should == 1
+    end
+
+    it "returns the correct arity when argc of the method in class is 2" do
+      @m.rb_define_method_2required(1, 2).should == 2
+      @m.method(:rb_define_method_2required).arity.should == 2
+    end
+
+    it "defines a method taking variable arguments as a C array if the argument count is -1" do
+      @m.rb_define_method_varargs_1(1, 3, 7, 4).should == [1, 3, 7, 4]
+    end
+
+    it "returns the correct arity when argc of the method in class is -1" do
+      @m.method(:rb_define_method_varargs_1).arity.should == -1
+    end
+
+    it "defines a method taking variable arguments as a Ruby array if the argument count is -2" do
+      @m.rb_define_method_varargs_2(1, 3, 7, 4).should == [1, 3, 7, 4]
+    end
+
+    it "returns the correct arity when argc of the method in class is -2" do
+      @m.method(:rb_define_method_varargs_2).arity.should == -1
+    end
+
+    it "defines a method on a module" do
+      mod = Module.new
+      @m.rb_define_method(mod, "test_method")
+      mod.should.method_defined?(:test_method, false)
+    end
+
+    it "returns the correct arity of the method in module" do
+      mod = Module.new
+      @m.rb_define_method(mod, "test_method")
+      mod.instance_method(:test_method).arity.should == 0
+    end
+  end
+
+  describe "rb_define_module_function" do
+    before :each do
+      @mod = Module.new
+      @m.rb_define_module_function @mod, "test_module_function"
+    end
+
+    it "defines a module function" do
+      @mod.test_module_function.should == :test_method
+    end
+
+    it "returns the correct arity of the module function" do
+      @mod.method(:test_module_function).arity.should == 0
+    end
+
+    it "defines a private instance method" do
+      cls = Class.new
+      cls.include(@mod)
+
+      cls.private_instance_methods(true).should.include?(:test_module_function)
+    end
+
+    it "returns the correct arity for private instance method" do
+      cls = Class.new
+      cls.include(@mod)
+
+      @mod.instance_method(:test_module_function).arity.should == 0
+    end
+  end
+
+  describe "rb_define_private_method" do
+    it "defines a private method on a class" do
+      cls = Class.new
+      @m.rb_define_private_method(cls, "test_method")
+      cls.private_instance_methods(false).should.include?(:test_method)
+      cls.new.send(:test_method).should == :test_method
+    end
+
+    it "defines a private method on a module" do
+      mod = Module.new
+      @m.rb_define_private_method(mod, "test_method")
+      mod.private_instance_methods(false).should.include?(:test_method)
+    end
+  end
+
+  describe "rb_define_protected_method" do
+    it "defines a protected method on a class" do
+      cls = Class.new
+      @m.rb_define_protected_method(cls, "test_method")
+      cls.protected_instance_methods(false).should.include?(:test_method)
+      cls.new.send(:test_method).should == :test_method
+    end
+
+    it "defines a protected method on a module" do
+      mod = Module.new
+      @m.rb_define_protected_method(mod, "test_method")
+      mod.protected_instance_methods(false).should.include?(:test_method)
+    end
+  end
+
+  describe "rb_define_singleton_method" do
+    it "defines a method on the singleton class" do
+      cls = Class.new
+      a = cls.new
+      @m.rb_define_singleton_method a, "module_specs_singleton_method"
+      a.module_specs_singleton_method.should == :test_method
+      -> { cls.new.module_specs_singleton_method }.should.raise(NoMethodError)
+    end
+  end
+
+  describe "rb_undef_method" do
+    before :each do
+      @class = Class.new do
+        def ruby_test_method
+          :ruby_test_method
+        end
+      end
+    end
+
+    it "undef'ines a method on a class" do
+      @class.new.ruby_test_method.should == :ruby_test_method
+      @m.rb_undef_method @class, "ruby_test_method"
+      @class.should_not.method_defined?(:ruby_test_method)
+    end
+
+    it "undefines private methods also" do
+      @m.rb_undef_method @class, "initialize_copy"
+      -> { @class.new.dup }.should.raise(NoMethodError)
+    end
+
+    it "does not raise exceptions when passed a missing name" do
+      -> { @m.rb_undef_method @class, "not_exist" }.should_not.raise
+    end
+
+    describe "when given a frozen Class" do
+      before :each do
+        @frozen = @class.dup.freeze
+      end
+
+      it "raises a FrozenError when passed a name" do
+        -> { @m.rb_undef_method @frozen, "ruby_test_method" }.should.raise(FrozenError)
+      end
+
+      it "raises a FrozenError when passed a missing name" do
+        -> { @m.rb_undef_method @frozen, "not_exist" }.should.raise(FrozenError)
+      end
+    end
+  end
+
+  describe "rb_undef" do
+    it "undef'ines a method on a class" do
+      cls = Class.new do
+        def ruby_test_method
+          :ruby_test_method
+        end
+      end
+
+      cls.new.ruby_test_method.should == :ruby_test_method
+      @m.rb_undef cls, :ruby_test_method
+      cls.should_not.method_defined?(:ruby_test_method)
+    end
+  end
+
+  describe "rb_class2name" do
+    it "returns the module name" do
+      @m.rb_class2name(CApiModuleSpecs::M).should == "CApiModuleSpecs::M"
+    end
+  end
+
+  describe "rb_mod_ancestors" do
+    it "returns an array of ancestors" do
+      one = Module.new
+      two = Module.new do
+        include one
+      end
+      @m.rb_mod_ancestors(two).should == [two, one]
+    end
+  end
+end