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

require_relative 'spec_helper'
require "stringio"

load_extension("globals")

describe "CApiGlobalSpecs" do
  before :each do
    @f = CApiGlobalSpecs.new
  end

  it "correctly gets global values" do
    suppress_warning { @f.sb_gv_get("$BLAH") }.should == nil
    @f.sb_gv_get("$\\").should == nil
    @f.sb_gv_get("\\").should == nil # rb_gv_get should change \ to $\
  end

  it "returns $~" do
    'a' =~ /a/
    @f.sb_gv_get("$~").to_a.should == ['a']
    @f.sb_gv_get("~").to_a.should == ['a']
  end

  it "correctly sets global values" do
    suppress_warning { @f.sb_gv_get("$BLAH") }.should == nil
    @f.sb_gv_set("$BLAH", 10)
    begin
      @f.sb_gv_get("$BLAH").should == 10
    ensure
      @f.sb_gv_set("$BLAH", nil)
    end
  end

  it "lists all global variables" do
    @f.rb_f_global_variables.should == Kernel.global_variables
  end

  it "rb_define_variable should define a new global variable" do
    @f.rb_define_variable("my_gvar", "ABC")
    $my_gvar.should == "ABC"
    $my_gvar = "XYZ"
    @f.sb_get_global_value.should == "XYZ"
  end

  it "rb_define_readonly_variable should define a new readonly global variable" do
    # Check the gvar doesn't exist and ensure rb_gv_get doesn't implicitly declare the gvar,
    # otherwise the rb_define_readonly_variable call will conflict.
    suppress_warning { @f.sb_gv_get("ro_gvar") } .should == nil

    @f.rb_define_readonly_variable("ro_gvar", 15)
    $ro_gvar.should == 15
    -> { $ro_gvar = 10 }.should raise_error(NameError)
  end

  it "rb_define_hooked_variable should define a C hooked global variable" do
    @f.rb_define_hooked_variable_2x("$hooked_gvar")
    $hooked_gvar = 2
    $hooked_gvar.should == 4
  end

  it "rb_define_hooked_variable should use default accessors if NULL ones are supplied" do
    @f.rb_define_hooked_variable_default_accessors("$hooked_gvar_default_accessors")
    $hooked_gvar_default_accessors = 10
    $hooked_gvar_default_accessors.should == 10
  end

  it "rb_define_hooked_variable with default accessors should return nil for NULL variables" do
    @f.rb_define_hooked_variable_null_var("$hooked_gvar_null_value")
    $hooked_gvar_null_value.should == nil
  end

  describe "rb_define_virtual_variable" do
    describe "with default accessors" do
      before :all do
        @f.rb_define_virtual_variable_default_accessors("$virtual_variable_default_accessors")
      end

      it "is read-only" do
        -> { $virtual_variable_default_accessors = 10 }.should raise_error(NameError, /read-only/)
      end

      it "returns false with the default getter" do
        $virtual_variable_default_accessors.should == false
        $virtual_variable_default_accessors.should == false
      end
    end

    describe "with supplied accessors" do
      before :all do
        @f.rb_define_virtual_variable_incrementing_accessors("$virtual_variable_incrementing_accessors")
      end

      it "returns a dynamically changing value" do
        $virtual_variable_incrementing_accessors = 20
        $virtual_variable_incrementing_accessors.should == 20
        $virtual_variable_incrementing_accessors.should == 21
        $virtual_variable_incrementing_accessors.should == 22

        $virtual_variable_incrementing_accessors = 100
        $virtual_variable_incrementing_accessors.should == 100
        $virtual_variable_incrementing_accessors.should == 101
        $virtual_variable_incrementing_accessors.should == 102
      end
    end
  end

  describe "rb_fs" do
    before :each do
      @field_separator = $;
    end

    after :each do
      suppress_warning { $; = @field_separator }
    end

    it "returns nil by default" do
      @f.rb_fs.should == nil
    end

    it "returns the value of $;" do
      suppress_warning { $; = "foo" }
      @f.rb_fs.should == "foo"
    end
  end

  describe "rb_rs" do
    before :each do
      @dollar_slash = $/
    end

    after :each do
      suppress_warning { $/ = @dollar_slash }
    end

    it "returns \\n by default" do
      @f.rb_rs.should == "\n"
    end

    it "returns the value of $/" do
      suppress_warning { $/ = "foo" }
      @f.rb_rs.should == "foo"
    end
  end

  context "rb_std streams" do
    before :each do
      @name = tmp("rb_std_streams")
      @stream = new_io @name
    end

    after :each do
      @stream.close
      rm_r @name
    end

    describe "rb_stdin" do
      after :each do
        $stdin = STDIN
      end

      it "returns $stdin" do
        $stdin = @stream
        @f.rb_stdin.should equal($stdin)
      end
    end

    describe "rb_stdout" do
      after :each do
        $stdout = STDOUT
      end

      it "returns $stdout" do
        $stdout = @stream
        @f.rb_stdout.should equal($stdout)
      end
    end

    describe "rb_stderr" do
      after :each do
        $stderr = STDERR
      end

      it "returns $stderr" do
        $stderr = @stream
        @f.rb_stderr.should equal($stderr)
      end
    end

    describe "rb_defout" do
      after :each do
        $stdout = STDOUT
      end

      it "is an alias of rb_stdout" do
        $stdout = @stream
        @f.rb_defout.should equal($stdout)
      end
    end
  end

  describe "rb_default_rs" do
    it "returns \\n" do
      @f.rb_default_rs.should == "\n"
    end
  end

  describe "rb_output_rs" do
    before :each do
      @dollar_backslash = $\
    end

    after :each do
      suppress_warning {$\ = @dollar_backslash}
    end

    it "returns nil by default" do
      @f.rb_output_rs.should be_nil
    end

    it "returns the value of $\\" do
      suppress_warning {$\ = "foo"}
      @f.rb_output_rs.should == "foo"
    end
  end

  describe "rb_output_fs" do
    before :each do
      @dollar_comma = $,
    end

    after :each do
      suppress_warning {$, = @dollar_comma}
    end

    it "returns nil by default" do
      @f.rb_output_fs.should be_nil
    end

    it "returns the value of $\\" do
      suppress_warning {$, = "foo"}
      @f.rb_output_fs.should == "foo"
    end
  end

  describe "rb_lastline_set" do
    it "sets the value of $_" do
      @f.rb_lastline_set("last line")
      $_.should == "last line"
    end

    it "sets a Thread-local value" do
      $_ = nil
      running = false

      thr = Thread.new do
        @f.rb_lastline_set("last line")
        $_.should == "last line"
        running = true
      end

      Thread.pass while thr.status and !running
      $_.should be_nil

      thr.join
    end
  end

  describe "rb_lastline_get" do
    before do
      @io = StringIO.new("last line")
    end

    it "gets the value of $_" do
      @io.gets
      @f.rb_lastline_get.should == "last line"
    end

    it "gets a Thread-local value" do
      $_ = nil
      running = false

      thr = Thread.new do
        @io.gets
        @f.rb_lastline_get.should == "last line"
        running = true
      end

      Thread.pass while thr.status and !running
      $_.should be_nil

      thr.join
    end
  end
end