File: choice_test.rb

package info (click to toggle)
ruby-bindata 2.4.14-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 600 kB
  • sloc: ruby: 8,566; makefile: 4
file content (255 lines) | stat: -rwxr-xr-x 5,604 bytes parent folder | download
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
#!/usr/bin/env ruby

require File.expand_path(File.join(File.dirname(__FILE__), "test_helper"))

class Chooser
  attr_accessor :choice
end

class BinData::Choice
  def set_chooser(chooser)
    @chooser = chooser
  end
  def choice=(s)
    @chooser.choice = s
  end
end

def create_choice(choices, options = {})
  chooser = Chooser.new
  params = {choices: choices, selection: -> { chooser.choice } }.merge(options)
  choice = BinData::Choice.new(params)
  choice.set_chooser(chooser)
  choice
end

describe BinData::Choice, "when instantiating" do
  it "ensures mandatory parameters are supplied" do
    args = {}
    _ { BinData::Choice.new(args) }.must_raise ArgumentError

    args = {selection: 1}
    _ { BinData::Choice.new(args) }.must_raise ArgumentError

    args = {choices: []}
    _ { BinData::Choice.new(args) }.must_raise ArgumentError
  end

  it "fails when a given type is unknown" do
    args = {choices: [:does_not_exist], selection: 0}
    _ { BinData::Choice.new(args) }.must_raise BinData::UnRegisteredTypeError
  end

  it "fails when a given type is unknown" do
    args = {choices: {0 => :does_not_exist}, selection: 0}
    _ { BinData::Choice.new(args) }.must_raise BinData::UnRegisteredTypeError
  end

  it "fails when :choices Hash has a symbol as key" do
    args = {choices: {a: :uint8}, selection: 0}
    _ { BinData::Choice.new(args) }.must_raise ArgumentError
  end

  it "fails when :choices Hash has a nil key" do
    args = {choices: {nil => :uint8}, selection: 0}
    _ { BinData::Choice.new(args) }.must_raise ArgumentError
  end
end

module ChoiceInitializedWithArrayOrHash
  def test_can_select_the_choice
    obj.choice = 3
    _(obj).must_equal 30
  end

  def test_shows_the_current_selection
    obj.choice = 3
    _(obj.selection).must_equal 3
  end

  def test_forwards_snapshot
    obj.choice = 3
    _(obj.snapshot).must_equal 30
  end

  def test_can_change_the_choice
    obj.choice = 3

    obj.choice = 7
    _(obj).must_equal 70
  end

  def test_fails_if_no_choice_has_been_set
    _ { obj.to_s }.must_raise IndexError
  end

  def test_wont_select_an_invalid_choice
    obj.choice = 99
    _ { obj.to_s }.must_raise IndexError
  end

  def test_wont_select_a_nil_choice
    obj.choice = 1
    _ { obj.to_s }.must_raise IndexError
  end

  def test_handles_missing_methods_correctly
    obj.choice = 3

    _(obj).must_respond_to :value
    _(obj).wont_respond_to :does_not_exist
    _ { obj.does_not_exist }.must_raise NoMethodError
  end

  def test_delegates_methods_to_the_selected_single_choice
    obj.choice = 5
    _(obj.num_bytes).must_equal 1
  end
end

describe BinData::Choice, "with sparse choices array" do
  include ChoiceInitializedWithArrayOrHash

  let(:obj) {
    choices = [nil, nil, nil,
               [:uint8, {value: 30}], nil,
               [:uint8, {value: 50}], nil,
               [:uint8, {value: 70}]]
    create_choice(choices)
  }
end

describe BinData::Choice, "with choices hash" do
  include ChoiceInitializedWithArrayOrHash

  let(:obj) {
    choices = {3 => [:uint8, {value: 30}],
               5 => [:uint8, {value: 50}],
               7 => [:uint8, {value: 70}]}
    create_choice(choices)
  }
end

describe BinData::Choice, "with single values" do
  let(:obj) {
    create_choice({3 => :uint8, 5 => :uint8, 7 => :uint8})
  }

  it "assigns raw values" do
    obj.choice = 3
    obj.assign(254)
    _(obj).must_equal 254
  end

  it "assigns BinData values" do
    data = BinData::Uint8.new(11)

    obj.choice = 3
    obj.assign(data)
    _(obj).must_equal 11
  end

  it "clears" do
    obj.choice = 3
    obj.assign(254)

    obj.clear
    _(obj).must_equal 0
  end

  it "clears all possible choices" do
    obj.choice = 3
    obj.assign(10)
    obj.choice = 5
    obj.assign(11)

    obj.clear

    obj.choice = 3
    _(obj).must_equal 0
  end

  it "is clear on initialisation" do
    obj.choice = 3

    assert obj.clear?
  end

  it "is not clear after assignment" do
    obj.choice = 3
    obj.assign(254)

    refute obj.clear?
  end

  it "does not copy value when changing selection" do
    obj.choice = 3
    obj.assign(254)

    obj.choice = 7
    _(obj).wont_equal 254
  end

  it "behaves as value" do
    obj.choice = 3
    obj.assign(5)

    _((obj + 1)).must_equal 6
    _((1 + obj)).must_equal 6
  end
end

describe BinData::Choice, "with copy_on_change => true" do
  let(:obj) {
    choices = {3 => :uint8, 5 => :uint8, 7 => :uint8}
    create_choice(choices, copy_on_change: true)
  }

  it "copies value when changing selection" do
    obj.choice = 3
    obj.assign(254)

    obj.choice = 7
    _(obj).must_equal 254
  end
end

describe BinData::Choice, "with :default" do
  let(:choices) { { "a" => :int8, default: :int16be } }

  it "selects for existing case" do
    obj = BinData::Choice.new(selection: "a", choices: choices)
    _(obj.num_bytes).must_equal 1
  end

  it "selects for default case" do
    obj = BinData::Choice.new(selection: "other", choices: choices)
    _(obj.num_bytes).must_equal 2
  end
end

describe BinData::Choice, "subclassed with default parameters" do
  class DerivedChoice < BinData::Choice
    endian :big
    default_parameter selection: 'a'

    uint16 'a'
    uint32 'b'
    uint64 :default
  end

  it "sets initial selection" do
    obj = DerivedChoice.new
    _(obj.num_bytes).must_equal 2
  end

  it "overides default parameter" do
    obj = DerivedChoice.new(selection: 'b')
    _(obj.num_bytes).must_equal 4
  end

  it "selects default selection" do
    obj = DerivedChoice.new(selection: 'z')
    _(obj.num_bytes).must_equal 8
  end
end