summaryrefslogtreecommitdiff
path: root/spec/lib/declarative_enum_spec.rb
blob: 66cda9fc3a8c2c939d45ac051fe0714e2f9b5cde (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
# frozen_string_literal: true

require 'spec_helper'

RSpec.describe DeclarativeEnum do
  let(:enum_module) do
    Module.new do
      extend DeclarativeEnum

      key :my_enum
      name 'MyEnumName'

      description "Enum description"

      define do
        foo value: 0, description: 'description of foo'
        bar value: 1, description: 'description of bar'
      end
    end
  end

  let(:original_definition) do
    {
      foo: { description: 'description of foo', value: 0 },
      bar: { description: 'description of bar', value: 1 }
    }
  end

  describe '.key' do
    subject(:key) { enum_module.key(new_key) }

    context 'when the argument is set' do
      let(:new_key) { :new_enum_key }

      it 'changes the key' do
        expect { key }.to change { enum_module.key }.from(:my_enum).to(:new_enum_key)
      end
    end

    context 'when the argument is `nil`' do
      let(:new_key) { nil }

      it { is_expected.to eq(:my_enum) }
    end
  end

  describe '.name' do
    subject(:name) { enum_module.name(new_name) }

    context 'when the argument is set' do
      let(:new_name) { 'NewMyEnumName' }

      it 'changes the name' do
        expect { name }.to change { enum_module.name }.from('MyEnumName').to('NewMyEnumName')
      end
    end

    context 'when the argument is `nil`' do
      let(:new_name) { nil }

      it { is_expected.to eq('MyEnumName') }
    end
  end

  describe '.description' do
    subject(:description) { enum_module.description(new_description) }

    context 'when the argument is set' do
      let(:new_description) { 'New enum description' }

      it 'changes the description' do
        expect { description }.to change { enum_module.description }.from('Enum description').to('New enum description')
      end
    end

    context 'when the argument is `nil`' do
      let(:new_description) { nil }

      it { is_expected.to eq('Enum description') }
    end
  end

  describe '.define' do
    subject(:define) { enum_module.define(&block) }

    context 'when there is a block given' do
      context 'when the given block tries to register the same key' do
        let(:block) do
          proc do
            foo value: 2, description: 'description of foo'
          end
        end

        it 'raises a `KeyCollisionError`' do
          expect { define }.to raise_error(DeclarativeEnum::Builder::KeyCollisionError)
        end
      end

      context 'when the given block does not try to register the same key' do
        let(:expected_new_definition) { original_definition.merge(zoo: { description: 'description of zoo', value: 0 }) }
        let(:block) do
          proc do
            zoo value: 0, description: 'description of zoo'
          end
        end

        it 'appends the new definition' do
          expect { define }.to change { enum_module.definition }.from(original_definition).to(expected_new_definition)
        end
      end
    end

    context 'when there is no block given' do
      let(:block) { nil }

      it 'raises a LocalJumpError' do
        expect { define }.to raise_error(LocalJumpError)
      end
    end
  end

  describe '.definition' do
    subject { enum_module.definition }

    it { is_expected.to eq(original_definition) }
  end

  describe 'extending the enum module' do
    let(:extended_definition) { original_definition.merge(zoo: { value: 2, description: 'description of zoo' }) }
    let(:new_enum_module) do
      Module.new do
        extend DeclarativeEnum

        define do
          zoo value: 2, description: 'description of zoo'
        end
      end
    end

    subject(:prepend_new_enum_module) { enum_module.prepend(new_enum_module) }

    it 'extends the values of the base enum module' do
      expect { prepend_new_enum_module }.to change { enum_module.definition }.from(original_definition)
                                                                             .to(extended_definition)
    end
  end
end