summaryrefslogtreecommitdiff
path: root/spec/ruby/shared/queue/deque.rb
blob: 0abba5301e027286b3f3c9c263349f1382da8617 (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
describe :queue_deq, shared: true do
  it "removes an item from the queue" do
    q = @object.call
    q << Object.new
    q.size.should == 1
    q.send @method
    q.size.should == 0
  end

  it "returns items in the order they were added" do
    q = @object.call
    q << 1
    q << 2
    q.send(@method).should == 1
    q.send(@method).should == 2
  end

  it "blocks the thread until there are items in the queue" do
    q = @object.call
    v = 0

    th = Thread.new do
      q.send(@method)
      v = 1
    end

    v.should == 0
    q << Object.new
    th.join
    v.should == 1
  end

  it "removes an item from a closed queue" do
    q = @object.call
    q << 1
    q.close
    q.send(@method).should == 1
  end

  it "converts false-ish for non_blocking to boolean" do
    q = @object.call
    q << 1
    q << 2

    q.send(@method, false).should == 1
    q.send(@method, nil).should == 2
  end

  it "returns nil for a closed empty queue" do
    q = @object.call
    q.close
    q.send(@method).should == nil
  end

  it "returns nil for an empty queue that becomes closed" do
    q = @object.call

    t = Thread.new {
      q.send(@method).should == nil
    }

    Thread.pass until t.status == "sleep" && q.num_waiting == 1
    q.close
    t.join
  end

  describe "with a timeout" do
    ruby_version_is "3.2" do
      it "returns an item if one is available in time" do
        q = @object.call

        t = Thread.new {
          q.send(@method, timeout: TIME_TOLERANCE).should == 1
        }
        Thread.pass until t.status == "sleep" && q.num_waiting == 1
        q << 1
        t.join
      end

      it "returns nil if no item is available in time" do
        q = @object.call

        Thread.new {
          q.send(@method, timeout: 0.001).should == nil
        }.join
      end

      it "does nothing if the timeout is nil" do
        q = @object.call
        t = Thread.new {
          q.send(@method, timeout: nil).should == 1
        }
        Thread.pass until t.status == "sleep" && q.num_waiting == 1
        q << 1
        t.join
      end

      it "immediately returns nil if no item is available and the timeout is 0" do
        q = @object.call
        q << 1
        q.send(@method, timeout: 0).should == 1
        q.send(@method, timeout: 0).should == nil
      end

      it "raise TypeError if timeout is not a valid numeric" do
        q = @object.call
        -> {
          q.send(@method, timeout: "1")
        }.should raise_error(TypeError, "no implicit conversion to float from string")

        -> {
          q.send(@method, timeout: false)
        }.should raise_error(TypeError, "no implicit conversion to float from false")
      end

      it "raise ArgumentError if non_block = true is passed too" do
        q = @object.call
        -> {
          q.send(@method, true, timeout: 1)
        }.should raise_error(ArgumentError, "can't set a timeout if non_block is enabled")
      end

      it "returns nil for a closed empty queue" do
        q = @object.call
        q.close
        q.send(@method, timeout: 0).should == nil
      end
    end
  end

  describe "in non-blocking mode" do
    it "removes an item from the queue" do
      q = @object.call
      q << Object.new
      q.size.should == 1
      q.send(@method, true)
      q.size.should == 0
    end

    it "raises a ThreadError if the queue is empty" do
      q = @object.call
      -> { q.send(@method, true) }.should raise_error(ThreadError)
    end

    it "removes an item from a closed queue" do
      q = @object.call
      q << 1
      q.close
      q.send(@method, true).should == 1
    end

    it "raises a ThreadError for a closed empty queue" do
      q = @object.call
      q.close
      -> { q.send(@method, true) }.should raise_error(ThreadError)
    end

    it "converts true-ish non_blocking argument to true" do
      q = @object.call

      -> { q.send(@method, true) }.should raise_error(ThreadError)
      -> { q.send(@method, 1) }.should raise_error(ThreadError)
      -> { q.send(@method, "") }.should raise_error(ThreadError)
    end
  end
end