granite 0.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (59) hide show
  1. checksums.yaml +7 -0
  2. data/LICENSE +22 -0
  3. data/app/controllers/granite/controller.rb +44 -0
  4. data/lib/generators/USAGE +25 -0
  5. data/lib/generators/granite/install_controller_generator.rb +15 -0
  6. data/lib/generators/granite_generator.rb +32 -0
  7. data/lib/generators/templates/granite_action.rb.erb +22 -0
  8. data/lib/generators/templates/granite_action_spec.rb.erb +45 -0
  9. data/lib/generators/templates/granite_base_action.rb.erb +2 -0
  10. data/lib/generators/templates/granite_business_action.rb.erb +3 -0
  11. data/lib/granite.rb +24 -0
  12. data/lib/granite/action.rb +106 -0
  13. data/lib/granite/action/error.rb +14 -0
  14. data/lib/granite/action/performer.rb +23 -0
  15. data/lib/granite/action/performing.rb +132 -0
  16. data/lib/granite/action/policies.rb +92 -0
  17. data/lib/granite/action/policies/always_allow_strategy.rb +13 -0
  18. data/lib/granite/action/policies/any_strategy.rb +12 -0
  19. data/lib/granite/action/policies/required_performer_strategy.rb +14 -0
  20. data/lib/granite/action/preconditions.rb +107 -0
  21. data/lib/granite/action/preconditions/base_precondition.rb +25 -0
  22. data/lib/granite/action/preconditions/embedded_precondition.rb +42 -0
  23. data/lib/granite/action/projectors.rb +100 -0
  24. data/lib/granite/action/represents.rb +26 -0
  25. data/lib/granite/action/represents/attribute.rb +90 -0
  26. data/lib/granite/action/represents/reflection.rb +15 -0
  27. data/lib/granite/action/subject.rb +73 -0
  28. data/lib/granite/action/transaction.rb +40 -0
  29. data/lib/granite/action/translations.rb +39 -0
  30. data/lib/granite/action/types.rb +1 -0
  31. data/lib/granite/action/types/collection.rb +13 -0
  32. data/lib/granite/config.rb +23 -0
  33. data/lib/granite/context.rb +28 -0
  34. data/lib/granite/dispatcher.rb +64 -0
  35. data/lib/granite/error.rb +4 -0
  36. data/lib/granite/performer_proxy.rb +34 -0
  37. data/lib/granite/performer_proxy/proxy.rb +31 -0
  38. data/lib/granite/projector.rb +48 -0
  39. data/lib/granite/projector/controller_actions.rb +47 -0
  40. data/lib/granite/projector/error.rb +14 -0
  41. data/lib/granite/projector/helpers.rb +59 -0
  42. data/lib/granite/projector/translations.rb +52 -0
  43. data/lib/granite/projector/translations/helper.rb +22 -0
  44. data/lib/granite/projector/translations/view_helper.rb +12 -0
  45. data/lib/granite/rails.rb +11 -0
  46. data/lib/granite/routing.rb +4 -0
  47. data/lib/granite/routing/cache.rb +24 -0
  48. data/lib/granite/routing/caching.rb +18 -0
  49. data/lib/granite/routing/declarer.rb +25 -0
  50. data/lib/granite/routing/mapper.rb +15 -0
  51. data/lib/granite/routing/mapping.rb +23 -0
  52. data/lib/granite/routing/route.rb +29 -0
  53. data/lib/granite/rspec.rb +5 -0
  54. data/lib/granite/rspec/action_helpers.rb +8 -0
  55. data/lib/granite/rspec/have_projector.rb +24 -0
  56. data/lib/granite/rspec/projector_helpers.rb +54 -0
  57. data/lib/granite/rspec/raise_validation_error.rb +52 -0
  58. data/lib/granite/rspec/satisfy_preconditions.rb +96 -0
  59. metadata +338 -0
@@ -0,0 +1,96 @@
1
+ # @scope Business Actions
2
+ #
3
+ # Checks if business action satisfies preconditions in current state.
4
+ #
5
+ # Modifiers:
6
+ # * `with_message(message)` (and `with_messages([list, of, messages])`) --
7
+ # only for negated matchers, checks messages of preconditions not satisfied;
8
+ # * `with_message_of_kind(:message_kind)` (and `with_messages_of_kinds(:list, :of, :messages)`) --
9
+ # only for negated matchers, checks messages of preconditions not satisfied;
10
+ # * `exactly` (secondary modifier for `with_message`/`with_messages`) --
11
+ # if set, checks if only those messages are set in errors; otherwise
12
+ # those messages should present, but others could too.
13
+ #
14
+ # Examples:
15
+ #
16
+ # ```ruby
17
+ # # assuming subject is business action
18
+ # it { is_expected.to satisfy_preconditions }
19
+ # it { is_expected.not_to satisfy_preconditions.with_message('Tax form has not been signed') }
20
+ # it { is_expected.not_to satisfy_preconditions.with_message_of_kind(:relevant_portfolio_items_needed) }
21
+ # it { is_expected.not_to satisfy_preconditions.with_messages_of_kinds(:relevant_portfolio_items_needed, :relevant_education_needed) }
22
+ # ```
23
+ #
24
+ RSpec::Matchers.define :satisfy_preconditions do
25
+ chain(:with_message) do |message|
26
+ @expected_messages = [message]
27
+ end
28
+
29
+ chain(:with_messages) do |messages|
30
+ @expected_messages = messages
31
+ end
32
+
33
+ chain(:with_message_of_kind) do |kind|
34
+ @expected_kind_of_messages = [kind]
35
+ end
36
+
37
+ chain(:with_messages_of_kinds) do |*kinds|
38
+ @expected_kind_of_messages = kinds.flatten
39
+ end
40
+
41
+ chain(:exactly) do
42
+ @exactly = true
43
+ end
44
+
45
+ match do |object|
46
+ fail '"with_messages" method chain is not supported for positive matcher' if @expected_messages
47
+ object.satisfy_preconditions?
48
+ end
49
+
50
+ match_when_negated do |object|
51
+ result = !object.satisfy_preconditions?
52
+ if @expected_messages
53
+ errors = object.errors[:base]
54
+ result &&= if @exactly
55
+ errors.to_a.sort == @expected_messages.sort
56
+ else
57
+ (@expected_messages - errors).empty?
58
+ end
59
+ elsif @expected_kind_of_messages
60
+ error_kinds = object.errors.details[:base].map(&:values).flatten
61
+ result &&= (@expected_kind_of_messages - error_kinds).empty?
62
+ end
63
+
64
+ result
65
+ end
66
+
67
+ failure_message do |object|
68
+ "expected #{object} to satisfy preconditions but got following errors:\n #{object.errors[:base].inspect}"
69
+ end
70
+
71
+ failure_message_when_negated do |object|
72
+ message = "expected #{object} not to satisfy preconditions"
73
+ message + if @expected_messages
74
+ expected_messages_error(object, @exactly, @expected_messages)
75
+ elsif @expected_kind_of_messages
76
+ expected_kind_of_messages_error(object, @expected_kind_of_messages)
77
+ else
78
+ ' but preconditions were satisfied'
79
+ end.to_s
80
+ end
81
+
82
+ def expected_messages_error(object, exactly, expected_messages, message = '')
83
+ actual_errors = object.errors[:base]
84
+ message += ' exactly' if exactly
85
+ message += " with error messages #{expected_messages}"
86
+ message + " but got following error messages:\n #{actual_errors.inspect}"
87
+ end
88
+
89
+ def expected_kind_of_messages_error(object, expected_kind_of_messages, message = '')
90
+ actual_kind_of_errors = object.errors.details[:base].map(&:keys).flatten
91
+ message += " with error messages of kind #{expected_kind_of_messages}"
92
+ message + " but got following kind of error messages:\n #{actual_kind_of_errors.inspect}"
93
+ end
94
+ end
95
+
96
+ RSpec::Matchers.define_negated_matcher :fail_preconditions, :satisfy_preconditions
metadata ADDED
@@ -0,0 +1,338 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: granite
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.7.0
5
+ platform: ruby
6
+ authors:
7
+ - Arkadiy Zabazhanov & friends
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2018-02-23 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: actionpack
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '5.1'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '5.1'
27
+ - !ruby/object:Gem::Dependency
28
+ name: active_data
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: 1.1.0
34
+ type: :runtime
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: 1.1.0
41
+ - !ruby/object:Gem::Dependency
42
+ name: activesupport
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '5.1'
48
+ type: :runtime
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '5.1'
55
+ - !ruby/object:Gem::Dependency
56
+ name: memoist
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '0.16'
62
+ type: :runtime
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '0.16'
69
+ - !ruby/object:Gem::Dependency
70
+ name: activerecord
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - "~>"
74
+ - !ruby/object:Gem::Version
75
+ version: '5.0'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - "~>"
81
+ - !ruby/object:Gem::Version
82
+ version: '5.0'
83
+ - !ruby/object:Gem::Dependency
84
+ name: capybara
85
+ requirement: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - "~>"
88
+ - !ruby/object:Gem::Version
89
+ version: '2.18'
90
+ type: :development
91
+ prerelease: false
92
+ version_requirements: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - "~>"
95
+ - !ruby/object:Gem::Version
96
+ version: '2.18'
97
+ - !ruby/object:Gem::Dependency
98
+ name: fuubar
99
+ requirement: !ruby/object:Gem::Requirement
100
+ requirements:
101
+ - - "~>"
102
+ - !ruby/object:Gem::Version
103
+ version: '2.0'
104
+ type: :development
105
+ prerelease: false
106
+ version_requirements: !ruby/object:Gem::Requirement
107
+ requirements:
108
+ - - "~>"
109
+ - !ruby/object:Gem::Version
110
+ version: '2.0'
111
+ - !ruby/object:Gem::Dependency
112
+ name: pg
113
+ requirement: !ruby/object:Gem::Requirement
114
+ requirements:
115
+ - - "<"
116
+ - !ruby/object:Gem::Version
117
+ version: '1'
118
+ type: :development
119
+ prerelease: false
120
+ version_requirements: !ruby/object:Gem::Requirement
121
+ requirements:
122
+ - - "<"
123
+ - !ruby/object:Gem::Version
124
+ version: '1'
125
+ - !ruby/object:Gem::Dependency
126
+ name: rspec
127
+ requirement: !ruby/object:Gem::Requirement
128
+ requirements:
129
+ - - "~>"
130
+ - !ruby/object:Gem::Version
131
+ version: '3.6'
132
+ type: :development
133
+ prerelease: false
134
+ version_requirements: !ruby/object:Gem::Requirement
135
+ requirements:
136
+ - - "~>"
137
+ - !ruby/object:Gem::Version
138
+ version: '3.6'
139
+ - !ruby/object:Gem::Dependency
140
+ name: rspec-activemodel-mocks
141
+ requirement: !ruby/object:Gem::Requirement
142
+ requirements:
143
+ - - "~>"
144
+ - !ruby/object:Gem::Version
145
+ version: '1.0'
146
+ type: :development
147
+ prerelease: false
148
+ version_requirements: !ruby/object:Gem::Requirement
149
+ requirements:
150
+ - - "~>"
151
+ - !ruby/object:Gem::Version
152
+ version: '1.0'
153
+ - !ruby/object:Gem::Dependency
154
+ name: rspec-collection_matchers
155
+ requirement: !ruby/object:Gem::Requirement
156
+ requirements:
157
+ - - "~>"
158
+ - !ruby/object:Gem::Version
159
+ version: '1.1'
160
+ type: :development
161
+ prerelease: false
162
+ version_requirements: !ruby/object:Gem::Requirement
163
+ requirements:
164
+ - - "~>"
165
+ - !ruby/object:Gem::Version
166
+ version: '1.1'
167
+ - !ruby/object:Gem::Dependency
168
+ name: rspec-its
169
+ requirement: !ruby/object:Gem::Requirement
170
+ requirements:
171
+ - - "~>"
172
+ - !ruby/object:Gem::Version
173
+ version: '1.2'
174
+ type: :development
175
+ prerelease: false
176
+ version_requirements: !ruby/object:Gem::Requirement
177
+ requirements:
178
+ - - "~>"
179
+ - !ruby/object:Gem::Version
180
+ version: '1.2'
181
+ - !ruby/object:Gem::Dependency
182
+ name: rspec-rails
183
+ requirement: !ruby/object:Gem::Requirement
184
+ requirements:
185
+ - - "~>"
186
+ - !ruby/object:Gem::Version
187
+ version: '3.6'
188
+ type: :development
189
+ prerelease: false
190
+ version_requirements: !ruby/object:Gem::Requirement
191
+ requirements:
192
+ - - "~>"
193
+ - !ruby/object:Gem::Version
194
+ version: '3.6'
195
+ - !ruby/object:Gem::Dependency
196
+ name: rspec_junit_formatter
197
+ requirement: !ruby/object:Gem::Requirement
198
+ requirements:
199
+ - - "~>"
200
+ - !ruby/object:Gem::Version
201
+ version: '0.2'
202
+ type: :development
203
+ prerelease: false
204
+ version_requirements: !ruby/object:Gem::Requirement
205
+ requirements:
206
+ - - "~>"
207
+ - !ruby/object:Gem::Version
208
+ version: '0.2'
209
+ - !ruby/object:Gem::Dependency
210
+ name: rubocop
211
+ requirement: !ruby/object:Gem::Requirement
212
+ requirements:
213
+ - - "~>"
214
+ - !ruby/object:Gem::Version
215
+ version: '0.52'
216
+ type: :development
217
+ prerelease: false
218
+ version_requirements: !ruby/object:Gem::Requirement
219
+ requirements:
220
+ - - "~>"
221
+ - !ruby/object:Gem::Version
222
+ version: '0.52'
223
+ - !ruby/object:Gem::Dependency
224
+ name: rubocop-rspec
225
+ requirement: !ruby/object:Gem::Requirement
226
+ requirements:
227
+ - - "~>"
228
+ - !ruby/object:Gem::Version
229
+ version: '1.22'
230
+ type: :development
231
+ prerelease: false
232
+ version_requirements: !ruby/object:Gem::Requirement
233
+ requirements:
234
+ - - "~>"
235
+ - !ruby/object:Gem::Version
236
+ version: '1.22'
237
+ - !ruby/object:Gem::Dependency
238
+ name: simplecov
239
+ requirement: !ruby/object:Gem::Requirement
240
+ requirements:
241
+ - - "~>"
242
+ - !ruby/object:Gem::Version
243
+ version: '0.15'
244
+ type: :development
245
+ prerelease: false
246
+ version_requirements: !ruby/object:Gem::Requirement
247
+ requirements:
248
+ - - "~>"
249
+ - !ruby/object:Gem::Version
250
+ version: '0.15'
251
+ description:
252
+ email:
253
+ executables: []
254
+ extensions: []
255
+ extra_rdoc_files: []
256
+ files:
257
+ - LICENSE
258
+ - app/controllers/granite/controller.rb
259
+ - lib/generators/USAGE
260
+ - lib/generators/granite/install_controller_generator.rb
261
+ - lib/generators/granite_generator.rb
262
+ - lib/generators/templates/granite_action.rb.erb
263
+ - lib/generators/templates/granite_action_spec.rb.erb
264
+ - lib/generators/templates/granite_base_action.rb.erb
265
+ - lib/generators/templates/granite_business_action.rb.erb
266
+ - lib/granite.rb
267
+ - lib/granite/action.rb
268
+ - lib/granite/action/error.rb
269
+ - lib/granite/action/performer.rb
270
+ - lib/granite/action/performing.rb
271
+ - lib/granite/action/policies.rb
272
+ - lib/granite/action/policies/always_allow_strategy.rb
273
+ - lib/granite/action/policies/any_strategy.rb
274
+ - lib/granite/action/policies/required_performer_strategy.rb
275
+ - lib/granite/action/preconditions.rb
276
+ - lib/granite/action/preconditions/base_precondition.rb
277
+ - lib/granite/action/preconditions/embedded_precondition.rb
278
+ - lib/granite/action/projectors.rb
279
+ - lib/granite/action/represents.rb
280
+ - lib/granite/action/represents/attribute.rb
281
+ - lib/granite/action/represents/reflection.rb
282
+ - lib/granite/action/subject.rb
283
+ - lib/granite/action/transaction.rb
284
+ - lib/granite/action/translations.rb
285
+ - lib/granite/action/types.rb
286
+ - lib/granite/action/types/collection.rb
287
+ - lib/granite/config.rb
288
+ - lib/granite/context.rb
289
+ - lib/granite/dispatcher.rb
290
+ - lib/granite/error.rb
291
+ - lib/granite/performer_proxy.rb
292
+ - lib/granite/performer_proxy/proxy.rb
293
+ - lib/granite/projector.rb
294
+ - lib/granite/projector/controller_actions.rb
295
+ - lib/granite/projector/error.rb
296
+ - lib/granite/projector/helpers.rb
297
+ - lib/granite/projector/translations.rb
298
+ - lib/granite/projector/translations/helper.rb
299
+ - lib/granite/projector/translations/view_helper.rb
300
+ - lib/granite/rails.rb
301
+ - lib/granite/routing.rb
302
+ - lib/granite/routing/cache.rb
303
+ - lib/granite/routing/caching.rb
304
+ - lib/granite/routing/declarer.rb
305
+ - lib/granite/routing/mapper.rb
306
+ - lib/granite/routing/mapping.rb
307
+ - lib/granite/routing/route.rb
308
+ - lib/granite/rspec.rb
309
+ - lib/granite/rspec/action_helpers.rb
310
+ - lib/granite/rspec/have_projector.rb
311
+ - lib/granite/rspec/projector_helpers.rb
312
+ - lib/granite/rspec/raise_validation_error.rb
313
+ - lib/granite/rspec/satisfy_preconditions.rb
314
+ homepage: https://github.com/toptal/granite
315
+ licenses:
316
+ - MIT
317
+ metadata: {}
318
+ post_install_message:
319
+ rdoc_options: []
320
+ require_paths:
321
+ - lib
322
+ required_ruby_version: !ruby/object:Gem::Requirement
323
+ requirements:
324
+ - - ">="
325
+ - !ruby/object:Gem::Version
326
+ version: '0'
327
+ required_rubygems_version: !ruby/object:Gem::Requirement
328
+ requirements:
329
+ - - ">="
330
+ - !ruby/object:Gem::Version
331
+ version: '0'
332
+ requirements: []
333
+ rubyforge_project:
334
+ rubygems_version: 2.6.14
335
+ signing_key:
336
+ specification_version: 4
337
+ summary: Another business actions architecture for Rails apps
338
+ test_files: []