summaryrefslogtreecommitdiff
path: root/spec/models/concerns/where_composite_spec.rb
blob: fb23e6bfe1d2eb7ef15ce6c9fae7ec0ad70e6506 (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
# frozen_string_literal: true

require 'spec_helper'

RSpec.describe WhereComposite do
  describe '.where_composite' do
    let_it_be(:test_table_name) { "test_table_#{SecureRandom.hex(10)}" }

    let(:model) do
      tbl_name = test_table_name
      Class.new(ActiveRecord::Base) do
        self.table_name = tbl_name

        include WhereComposite
      end
    end

    def connection
      ActiveRecord::Base.connection
    end

    before_all do
      connection.create_table(test_table_name) do |t|
        t.integer :foo
        t.integer :bar
        t.string  :wibble
      end
    end

    it 'requires at least one permitted key' do
      expect { model.where_composite([], nil) }
        .to raise_error(ArgumentError)
    end

    it 'requires all arguments to match the permitted_keys' do
      expect { model.where_composite([:foo], [{ foo: 1 }, { bar: 2 }]) }
        .to raise_error(ArgumentError)
    end

    it 'attaches a key error as cause if a key is missing' do
      expect { model.where_composite([:foo], [{ foo: 1 }, { bar: 2 }]) }
        .to raise_error(have_attributes(cause: KeyError))
    end

    it 'returns an empty relation if there are no arguments' do
      expect(model.where_composite([:foo, :bar], nil))
        .to be_empty

      expect(model.where_composite([:foo, :bar], []))
        .to be_empty
    end

    it 'permits extra arguments' do
      a = model.where_composite([:foo, :bar], { foo: 1, bar: 2 })
      b = model.where_composite([:foo, :bar], { foo: 1, bar: 2, baz: 3 })

      expect(a.to_sql).to eq(b.to_sql)
    end

    it 'can handle multiple fields' do
      fields = [:foo, :bar, :wibble]
      args = { foo: 1, bar: 2, wibble: 'wobble' }
      pattern = %r{
        WHERE \s+
          \(?
             \s* "#{test_table_name}"\."foo" \s* = \s* 1
             \s+ AND
             \s+ "#{test_table_name}"\."bar" \s* = \s* 2
             \s+ AND
             \s+ "#{test_table_name}"\."wibble" \s* = \s* 'wobble'
             \s*
          \)?
      }x

      expect(model.where_composite(fields, args).to_sql).to match(pattern)
    end

    it 'is equivalent to ids.map { |attrs| model.find_by(attrs) }' do
      10.times do |i|
        10.times do |j|
          model.create!(foo: i, bar: j, wibble: generate(:filename))
        end
      end

      ids = [{ foo: 1, bar: 9 }, { foo: 9, bar: 1 }]

      found = model.where_composite(%i[foo bar], ids)

      expect(found).to match_array(ids.map { |attrs| model.find_by!(attrs) })
    end

    it 'constructs (A&B) for one argument' do
      fields = [:foo, :bar]
      args = [
        { foo: 1, bar: 2 }
      ]
      pattern = %r{
        WHERE \s+
          \(?
             \s* "#{test_table_name}"\."foo" \s* = \s* 1
             \s+ AND
             \s+ "#{test_table_name}"\."bar" \s* = \s* 2
             \s*
          \)?
      }x

      expect(model.where_composite(fields, args).to_sql).to match(pattern)
      expect(model.where_composite(fields, args[0]).to_sql).to match(pattern)
    end

    it 'constructs (A&B) OR (C&D) for two arguments' do
      args = [
        { foo: 1, bar: 2 },
        { foo: 3, bar: 4 }
      ]
      pattern = %r{
        WHERE \s+
          \( \s* "#{test_table_name}"\."foo" \s* = \s* 1
             \s+ AND
             \s+ "#{test_table_name}"\."bar" \s* = \s* 2
             \s* \)?
          \s* OR \s*
          \(? \s* "#{test_table_name}"\."foo" \s* = \s* 3
              \s+ AND
              \s+ "#{test_table_name}"\."bar" \s* = \s* 4
              \s* \)
      }x

      q = model.where_composite([:foo, :bar], args)

      expect(q.to_sql).to match(pattern)
    end

    it 'constructs (A&B) OR (C&D) OR (E&F) for three arguments' do
      args = [
        { foo: 1, bar: 2 },
        { foo: 3, bar: 4 },
        { foo: 5, bar: 6 }
      ]
      pattern = %r{
        WHERE \s+
          \({2}
             \s* "#{test_table_name}"\."foo" \s* = \s* 1
             \s+ AND
             \s+ "#{test_table_name}"\."bar" \s* = \s* 2
             \s* \)?
          \s* OR \s*
          \(? \s* "#{test_table_name}"\."foo" \s* = \s* 3
              \s+ AND
              \s+ "#{test_table_name}"\."bar" \s* = \s* 4
              \s* \)?
          \s* OR \s*
          \(? \s* "#{test_table_name}"\."foo" \s* = \s* 5
              \s+ AND
              \s+ "#{test_table_name}"\."bar" \s* = \s* 6
              \s* \)
      }x

      q = model.where_composite([:foo, :bar], args)

      expect(q.to_sql).to match(pattern)
    end

    describe 'large sets of IDs' do
      def query(size)
        args = (0..).lazy.take(size).map { |n| { foo: n, bar: n * n, wibble: 'x' * n } }.to_a
        model.where_composite([:foo, :bar, :wibble], args)
      end

      it 'constructs correct trees of constraints' do
        n = described_class::TooManyIds::LIMIT
        q = query(n)
        sql = q.to_sql

        expect(sql.scan(/OR/).count).to eq(n - 1)
        expect(sql.scan(/AND/).count).to eq(2 * n)
      end

      it 'raises errors if too many IDs are passed' do
        expect { query(described_class::TooManyIds::LIMIT + 1) }.to raise_error(described_class::TooManyIds)
      end
    end
  end
end