ruby--ruby/spec/ruby/optional/capi/symbol_spec.rb

# -*- encoding: utf-8 -*-
require_relative 'spec_helper'

load_extension('symbol')

describe "C-API Symbol function" do
  before :each do
    @s = CApiSymbolSpecs.new
  end

  describe "SYMBOL_P" do
    it "returns true for a Symbol" do
      @s.SYMBOL_P(:foo).should == true
    end

    it "returns false for non-Symbols" do
      @s.SYMBOL_P('bar').should == false
    end
  end

  describe "rb_intern" do
    it "converts a string to a symbol, uniquely" do
      @s.rb_intern("test_symbol").should == :test_symbol
      @s.rb_intern_c_compare("test_symbol", :test_symbol).should == true
    end
  end

  describe "rb_intern2" do
    it "converts a string to a symbol, uniquely, for a string of given length" do
      @s.rb_intern2("test_symbol", 4).should == :test
      @s.rb_intern2_c_compare("test_symbol", 4, :test).should == true
    end
  end

  describe "rb_intern3" do
    it "converts a multibyte symbol with the encoding" do
      sym = @s.rb_intern3("Ω", 2, Encoding::UTF_8)
      sym.encoding.should == Encoding::UTF_8
      sym.should == :Ω
      @s.rb_intern3_c_compare("Ω", 2, Encoding::UTF_8, :Ω).should == true
    end

    it "converts an ascii compatible symbol with the ascii encoding" do
      sym = @s.rb_intern3("foo", 3, Encoding::UTF_8)
      sym.encoding.should == Encoding::US_ASCII
      sym.should == :foo
    end

    it "should respect the symbol encoding via rb_intern3" do
      :Ω.to_s.encoding.should == Encoding::UTF_8
    end
  end

  describe "rb_intern_const" do
    it "converts a string to a Symbol" do
      @s.rb_intern_const("test").should == :test
    end
  end

  describe "rb_id2name" do
    it "converts a symbol to a C char array" do
      @s.rb_id2name(:test_symbol).should == "test_symbol"
    end

    it "returns (char*) NULL for (ID) 0" do
      @s.rb_id2name_id_zero.should == nil
    end
  end

  describe "rb_id2str" do
    it "converts a symbol to a Ruby string" do
      @s.rb_id2str(:test_symbol).should == "test_symbol"
    end

    it "creates a string with the same encoding as the symbol" do
      str = "test_symbol".encode(Encoding::UTF_16LE)
      @s.rb_id2str(str.to_sym).encoding.should == Encoding::UTF_16LE
    end

    it "returns (VALUE) 0 = Qfalse for (ID) 0" do
      @s.rb_id2str_id_zero.should == false
    end
  end

  describe "rb_intern_str" do
    it "converts a Ruby String to a Symbol" do
      str = "test_symbol"
      @s.rb_intern_str(str).should == :test_symbol
    end
  end

  describe "rb_check_symbol_cstr" do
    it "returns a Symbol if a Symbol already exists for the given C string" do
      sym = :test_symbol
      @s.rb_check_symbol_cstr('test_symbol').should == sym
    end

    it "returns nil if the Symbol does not exist yet and does not create it" do
      str = "symbol_does_not_exist_#{Object.new.object_id}_#{rand}"
      @s.rb_check_symbol_cstr(str).should == nil # does not create the Symbol
      @s.rb_check_symbol_cstr(str).should == nil
    end
  end

  describe "rb_is_const_id" do
    it "returns true given a const-like symbol" do
      @s.rb_is_const_id(:Foo).should == true
    end

    it "returns false given an ivar-like symbol" do
      @s.rb_is_const_id(:@foo).should == false
    end

    it "returns false given a cvar-like symbol" do
      @s.rb_is_const_id(:@@foo).should == false
    end

    it "returns false given an undecorated symbol" do
      @s.rb_is_const_id(:foo).should == false
    end
  end

  describe "rb_is_instance_id" do
    it "returns false given a const-like symbol" do
      @s.rb_is_instance_id(:Foo).should == false
    end

    it "returns true given an ivar-like symbol" do
      @s.rb_is_instance_id(:@foo).should == true
    end

    it "returns false given a cvar-like symbol" do
      @s.rb_is_instance_id(:@@foo).should == false
    end

    it "returns false given an undecorated symbol" do
      @s.rb_is_instance_id(:foo).should == false
    end
  end

  describe "rb_is_class_id" do
    it "returns false given a const-like symbol" do
      @s.rb_is_class_id(:Foo).should == false
    end

    it "returns false given an ivar-like symbol" do
      @s.rb_is_class_id(:@foo).should == false
    end

    it "returns true given a cvar-like symbol" do
      @s.rb_is_class_id(:@@foo).should == true
    end

    it "returns false given an undecorated symbol" do
      @s.rb_is_class_id(:foo).should == false
    end
  end

  describe "rb_sym2str" do
    it "converts a Symbol to a String" do
      @s.rb_sym2str(:bacon).should == "bacon"
    end
  end

  describe "rb_to_symbol" do
    it "returns a Symbol for a Symbol" do
      @s.rb_to_symbol(:foo).should == :foo
    end

    it "returns a Symbol for a String" do
      @s.rb_to_symbol("foo").should == :foo
    end

    it "coerces to Symbol using to_str" do
      o = mock('o')
      o.should_receive(:to_str).and_return("foo")
      @s.rb_to_symbol(o).should == :foo
    end
  end
end