summaryrefslogtreecommitdiff
path: root/spec/ruby/optional/capi/proc_spec.rb
blob: 8b94432f3e28a702b4c1e6a125317e1cd561280a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
require_relative 'spec_helper'
require_relative 'fixtures/proc'

load_extension("proc")

describe "C-API Proc function" do
  before :each do
    @p = CApiProcSpecs.new
    @prc = @p.rb_proc_new
    @prc2 = @p.rb_proc_new_argv_n
    @prc3 = @p.rb_proc_new_argc
  end

  describe "rb_proc_new" do
    it "returns a new valid Proc" do
      @prc.kind_of?(Proc).should == true
    end

    it "calls the C function wrapped by the Proc instance when sent #call" do
      @p.rb_proc_new_arg.call().should == nil
      @prc.call(:foo_bar).should == ":foo_bar"
      @prc.call([:foo, :bar]).should == "[:foo, :bar]"
    end

    it "calls the C function wrapped by the Proc instance when sent #[]" do
      @prc[:foo_bar].should == ":foo_bar"
      @prc[[:foo, :bar]].should == "[:foo, :bar]"
    end

    it "calls the C function with the arg count in argc" do
      @prc3.call().should == 0
      @prc3.call(:foo).should == 1
      @prc3.call(:foo, :bar).should == 2
    end

    it "calls the C function with arguments in argv" do
      @prc2.call(1, :foo).should == :foo
      @prc2.call(2, :foo, :bar).should == :bar
      -> { @prc2.call(3, :foo, :bar) }.should raise_error(ArgumentError)
    end

    it "calls the C function with the block passed in blockarg" do
      a_block = :foo.to_proc
      @p.rb_proc_new_blockarg.call(&a_block).should == a_block
      @p.rb_proc_new_blockarg.call().should == nil
    end

    it "calls the C function and yields to the block passed in blockarg" do
      @p.rb_proc_new_block_given_p.call() do
      end.should == false
      @p.rb_proc_new_block_given_p.call().should == false
    end

    it "returns a Proc instance correctly described in #inspect without source location" do
      @prc.inspect.should =~ /^#<Proc:([^ :@]*?)>$/
    end

    it "returns a Proc instance with #arity == -1" do
      @prc.arity.should == -1
    end

    it "shouldn't be equal to another one" do
      @prc.should_not == @p.rb_proc_new
    end

    it "returns a Proc instance with #source_location == nil" do
      @prc.source_location.should == nil
    end
  end

  describe "rb_proc_arity" do
    it "returns the correct arity" do
      prc = Proc.new {|a,b,c|}
      @p.rb_proc_arity(prc).should == 3
    end
  end

  describe "rb_proc_call" do
    it "calls the Proc" do
      prc = Proc.new {|a,b| a * b }
      @p.rb_proc_call(prc, [6, 7]).should == 42
    end
  end

  describe "rb_proc_call_kw" do
    it "passes keyword arguments to the proc" do
      prc = proc { |*args, **kw| [args, kw] }

      @p.rb_proc_call_kw(prc, [{}]).should == [[], {}]
      @p.rb_proc_call_kw(prc, [{a: 1}]).should == [[], {a: 1}]
      @p.rb_proc_call_kw(prc, [{b: 2}, {a: 1}]).should == [[{b: 2}], {a: 1}]
      @p.rb_proc_call_kw(prc, [{b: 2}, {}]).should == [[{b: 2}], {}]
    end

    it "raises TypeError if the last argument is not a Hash" do
      -> {
        @p.rb_proc_call_kw(proc {}, [42])
      }.should raise_error(TypeError, 'no implicit conversion of Integer into Hash')
    end
  end

  describe "rb_proc_call_with_block" do
    it "calls the Proc and passes arguments and a block" do
      prc = Proc.new { |a, b, &block| block.call(a * b) }
      @p.rb_proc_call_with_block(prc, [6, 7], proc { |n| n * 2 }).should == 6 * 7 * 2
    end

    it "calls the Proc and passes arguments when a block is nil" do
      prc = Proc.new { |a, b| a * b }
      @p.rb_proc_call_with_block(prc, [6, 7], nil).should == 6 * 7
    end
  end

  describe "rb_proc_call_with_block_kw" do
    it "passes keyword arguments and a block to the proc" do
      prc = proc { |*args, **kw, &block| [args, kw, block.call(42)] }
      block = proc { |n| n }

      @p.rb_proc_call_with_block_kw(prc, [{}], block).should == [[], {}, 42]
      @p.rb_proc_call_with_block_kw(prc, [{a: 1}], block).should == [[], {a: 1}, 42]
      @p.rb_proc_call_with_block_kw(prc, [{b: 2}, {a: 1}], block).should == [[{b: 2}], {a: 1}, 42]
      @p.rb_proc_call_with_block_kw(prc, [{b: 2}, {}], block).should == [[{b: 2}], {}, 42]
    end

    it "raises TypeError if the last argument is not a Hash" do
      -> {
        @p.rb_proc_call_with_block_kw(proc {}, [42], proc {})
      }.should raise_error(TypeError, 'no implicit conversion of Integer into Hash')
    end

    it "passes keyword arguments to the proc when a block is nil" do
      prc = proc { |*args, **kw| [args, kw] }

      @p.rb_proc_call_with_block_kw(prc, [{}], nil).should == [[], {}]
    end
  end

  describe "rb_obj_is_proc" do
    it "returns true for Proc" do
      prc = Proc.new {|a,b| a * b }
      @p.rb_obj_is_proc(prc).should be_true
    end

    it "returns true for subclass of Proc" do
      prc = Class.new(Proc).new {}
      @p.rb_obj_is_proc(prc).should be_true
    end

    it "returns false for non Proc instances" do
      @p.rb_obj_is_proc("aoeui").should be_false
      @p.rb_obj_is_proc(123).should be_false
      @p.rb_obj_is_proc(true).should be_false
      @p.rb_obj_is_proc([]).should be_false
    end
  end
end

describe "C-API when calling Proc.new from a C function" do
  before :each do
    @p = CApiProcSpecs.new
  end

  # In the scenarios below: X -> Y means execution context X called to Y.
  # For example: Ruby -> C means a Ruby code called a C function.
  #
  # X -> Y <- X -> Z means execution context X called Y which returned to X,
  # then X called Z.
  # For example: C -> Ruby <- C -> Ruby means a C function called into Ruby
  # code which returned to C, then C called into Ruby code again.

  # Ruby -> C -> Ruby -> Proc.new
  it "raises an ArgumentError when the C function calls a Ruby method that calls Proc.new" do
    -> {
      @p.rb_Proc_new(2) { :called }
    }.should raise_error(ArgumentError)
  end

  # Ruby -> C -> Ruby -> C -> rb_funcall(Proc.new)
  it "raises an ArgumentError when the C function calls a Ruby method and that method calls a C function that calls Proc.new" do
    def @p.redispatch() rb_Proc_new(0) end
    -> { @p.rb_Proc_new(3) { :called } }.should raise_error(ArgumentError)
  end

  # Ruby -> C -> Ruby -> block_given?
  it "returns false from block_given? in a Ruby method called by the C function" do
    @p.rb_Proc_new(6).should be_false
  end
end