summaryrefslogtreecommitdiff
path: root/spec/ruby/language/keyword_arguments_spec.rb
blob: 8771c5806c0c36b57c239a2a34520709f41a047c (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
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
require_relative '../spec_helper'

ruby_version_is "3.0" do
  describe "Keyword arguments" do
    def target(*args, **kwargs)
      [args, kwargs]
    end

    it "are separated from positional arguments" do
      def m(*args, **kwargs)
        [args, kwargs]
      end

      empty = {}
      m(**empty).should == [[], {}]
      m(empty).should == [[{}], {}]

      m(a: 1).should == [[], {a: 1}]
      m({a: 1}).should == [[{a: 1}], {}]
    end

    it "when the receiving method has not keyword parameters it treats kwargs as positional" do
      def m(*a)
        a
      end

      m(a: 1).should == [{a: 1}]
      m({a: 1}).should == [{a: 1}]
    end

    context "empty kwargs are treated as if they were not passed" do
      it "when calling a method" do
        def m(*a)
          a
        end

        empty = {}
        m(**empty).should == []
        m(empty).should == [{}]
      end

      it "when yielding to a block" do
        def y(*args, **kwargs)
          yield(*args, **kwargs)
        end

        empty = {}
        y(**empty) { |*a| a }.should == []
        y(empty) { |*a| a }.should == [{}]
      end
    end

    it "extra keywords are not allowed without **kwrest" do
      def m(*a, kw:)
        a
      end

      m(kw: 1).should == []
      -> { m(kw: 1, kw2: 2) }.should raise_error(ArgumentError, 'unknown keyword: :kw2')
      -> { m(kw: 1, true => false) }.should raise_error(ArgumentError, 'unknown keyword: true')
      -> { m(kw: 1, a: 1, b: 2, c: 3) }.should raise_error(ArgumentError, 'unknown keywords: :a, :b, :c')
    end

    it "raises ArgumentError exception when required keyword argument is not passed" do
      def m(a:, b:, c:)
        [a, b, c]
      end

      -> { m(a: 1, b: 2) }.should raise_error(ArgumentError, /missing keyword: :c/)
      -> { m() }.should raise_error(ArgumentError, /missing keywords: :a, :b, :c/)
    end

    it "raises ArgumentError for missing keyword arguments even if there are extra ones" do
      def m(a:)
        a
      end

      -> { m(b: 1) }.should raise_error(ArgumentError, /missing keyword: :a/)
    end

    it "handle * and ** at the same call site" do
      def m(*a)
        a
      end

      m(*[], **{}).should == []
      m(*[], 42, **{}).should == [42]
    end

    context "**" do
      it "does not copy a non-empty Hash for a method taking (*args)" do
        def m(*args)
          args[0]
        end

        h = {a: 1}
        m(**h).should.equal?(h)
      end

      it "copies the given Hash for a method taking (**kwargs)" do
        def m(**kw)
          kw
        end

        empty = {}
        m(**empty).should == empty
        m(**empty).should_not.equal?(empty)

        h = {a: 1}
        m(**h).should == h
        m(**h).should_not.equal?(h)
      end
    end

    context "delegation" do
      it "works with (*args, **kwargs)" do
        def m(*args, **kwargs)
          target(*args, **kwargs)
        end

        empty = {}
        m(**empty).should == [[], {}]
        m(empty).should == [[{}], {}]

        m(a: 1).should == [[], {a: 1}]
        m({a: 1}).should == [[{a: 1}], {}]
      end

      it "works with proc { |*args, **kwargs| }" do
        m = proc do |*args, **kwargs|
          target(*args, **kwargs)
        end

        empty = {}
        m.(**empty).should == [[], {}]
        m.(empty).should == [[{}], {}]

        m.(a: 1).should == [[], {a: 1}]
        m.({a: 1}).should == [[{a: 1}], {}]

        # no autosplatting for |*args, **kwargs|
        m.([1, 2]).should == [[[1, 2]], {}]
      end

      it "works with -> (*args, **kwargs) {}" do
        m = -> *args, **kwargs do
          target(*args, **kwargs)
        end

        empty = {}
        m.(**empty).should == [[], {}]
        m.(empty).should == [[{}], {}]

        m.(a: 1).should == [[], {a: 1}]
        m.({a: 1}).should == [[{a: 1}], {}]
      end

      it "works with (...)" do
        instance_eval <<~DEF
        def m(...)
          target(...)
        end
        DEF

        empty = {}
        m(**empty).should == [[], {}]
        m(empty).should == [[{}], {}]

        m(a: 1).should == [[], {a: 1}]
        m({a: 1}).should == [[{a: 1}], {}]
      end

      it "works with call(*ruby2_keyword_args)" do
        class << self
          ruby2_keywords def m(*args)
            target(*args)
          end
        end

        empty = {}
        m(**empty).should == [[], {}]
        Hash.ruby2_keywords_hash?(empty).should == false
        m(empty).should == [[{}], {}]
        Hash.ruby2_keywords_hash?(empty).should == false

        m(a: 1).should == [[], {a: 1}]
        m({a: 1}).should == [[{a: 1}], {}]

        kw = {a: 1}

        m(**kw).should == [[], {a: 1}]
        m(**kw)[1].should == kw
        m(**kw)[1].should_not.equal?(kw)
        Hash.ruby2_keywords_hash?(kw).should == false
        Hash.ruby2_keywords_hash?(m(**kw)[1]).should == false

        m(kw).should == [[{a: 1}], {}]
        m(kw)[0][0].should.equal?(kw)
        Hash.ruby2_keywords_hash?(kw).should == false
      end

      it "works with super(*ruby2_keyword_args)" do
        parent = Class.new do
          def m(*args, **kwargs)
            [args, kwargs]
          end
        end

        child = Class.new(parent) do
          ruby2_keywords def m(*args)
            super(*args)
          end
        end

        obj = child.new

        empty = {}
        obj.m(**empty).should == [[], {}]
        Hash.ruby2_keywords_hash?(empty).should == false
        obj.m(empty).should == [[{}], {}]
        Hash.ruby2_keywords_hash?(empty).should == false

        obj.m(a: 1).should == [[], {a: 1}]
        obj.m({a: 1}).should == [[{a: 1}], {}]

        kw = {a: 1}

        obj.m(**kw).should == [[], {a: 1}]
        obj.m(**kw)[1].should == kw
        obj.m(**kw)[1].should_not.equal?(kw)
        Hash.ruby2_keywords_hash?(kw).should == false
        Hash.ruby2_keywords_hash?(obj.m(**kw)[1]).should == false

        obj.m(kw).should == [[{a: 1}], {}]
        obj.m(kw)[0][0].should.equal?(kw)
        Hash.ruby2_keywords_hash?(kw).should == false
      end

      it "works with zsuper" do
        parent = Class.new do
          def m(*args, **kwargs)
            [args, kwargs]
          end
        end

        child = Class.new(parent) do
          ruby2_keywords def m(*args)
            super
          end
        end

        obj = child.new

        empty = {}
        obj.m(**empty).should == [[], {}]
        Hash.ruby2_keywords_hash?(empty).should == false
        obj.m(empty).should == [[{}], {}]
        Hash.ruby2_keywords_hash?(empty).should == false

        obj.m(a: 1).should == [[], {a: 1}]
        obj.m({a: 1}).should == [[{a: 1}], {}]

        kw = {a: 1}

        obj.m(**kw).should == [[], {a: 1}]
        obj.m(**kw)[1].should == kw
        obj.m(**kw)[1].should_not.equal?(kw)
        Hash.ruby2_keywords_hash?(kw).should == false
        Hash.ruby2_keywords_hash?(obj.m(**kw)[1]).should == false

        obj.m(kw).should == [[{a: 1}], {}]
        obj.m(kw)[0][0].should.equal?(kw)
        Hash.ruby2_keywords_hash?(kw).should == false
      end

      it "works with yield(*ruby2_keyword_args)" do
        class << self
          def y(args)
            yield(*args)
          end

          ruby2_keywords def m(*outer_args)
            y(outer_args, &-> *args, **kwargs { target(*args, **kwargs) })
          end
        end

        empty = {}
        m(**empty).should == [[], {}]
        Hash.ruby2_keywords_hash?(empty).should == false
        m(empty).should == [[{}], {}]
        Hash.ruby2_keywords_hash?(empty).should == false

        m(a: 1).should == [[], {a: 1}]
        m({a: 1}).should == [[{a: 1}], {}]

        kw = {a: 1}

        m(**kw).should == [[], {a: 1}]
        m(**kw)[1].should == kw
        m(**kw)[1].should_not.equal?(kw)
        Hash.ruby2_keywords_hash?(kw).should == false
        Hash.ruby2_keywords_hash?(m(**kw)[1]).should == false

        m(kw).should == [[{a: 1}], {}]
        m(kw)[0][0].should.equal?(kw)
        Hash.ruby2_keywords_hash?(kw).should == false
      end

      it "does not work with (*args)" do
        class << self
          def m(*args)
            target(*args)
          end
        end

        empty = {}
        m(**empty).should == [[], {}]
        m(empty).should == [[{}], {}]

        m(a: 1).should == [[{a: 1}], {}]
        m({a: 1}).should == [[{a: 1}], {}]
      end

      ruby_version_is "3.2" do
        it "does not work with call(*ruby2_keyword_args) with missing ruby2_keywords in between" do
          class << self
            def n(*args) # Note the missing ruby2_keywords here
              target(*args)
            end

            ruby2_keywords def m(*args)
              n(*args)
            end
          end

          empty = {}
          m(**empty).should == [[], {}]
          m(empty).should == [[{}], {}]

          m(a: 1).should == [[{a: 1}], {}]
          m({a: 1}).should == [[{a: 1}], {}]
        end
      end

      ruby_version_is ""..."3.2" do
        # https://bugs.ruby-lang.org/issues/18625
        it "works with call(*ruby2_keyword_args) with missing ruby2_keywords in between due to CRuby bug #18625" do
          class << self
            def n(*args) # Note the missing ruby2_keywords here
              target(*args)
            end

            ruby2_keywords def m(*args)
              n(*args)
            end
          end

          empty = {}
          m(**empty).should == [[], {}]
          Hash.ruby2_keywords_hash?(empty).should == false
          m(empty).should == [[{}], {}]
          Hash.ruby2_keywords_hash?(empty).should == false

          m(a: 1).should == [[], {a: 1}]
          m({a: 1}).should == [[{a: 1}], {}]

          kw = {a: 1}

          m(**kw).should == [[], {a: 1}]
          m(**kw)[1].should == kw
          m(**kw)[1].should_not.equal?(kw)
          Hash.ruby2_keywords_hash?(kw).should == false
          Hash.ruby2_keywords_hash?(m(**kw)[1]).should == false

          m(kw).should == [[{a: 1}], {}]
          m(kw)[0][0].should.equal?(kw)
          Hash.ruby2_keywords_hash?(kw).should == false
        end
      end
    end
  end
end