metaractor 0.5.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +9 -0
- data/.rspec +2 -0
- data/Dockerfile +48 -0
- data/Gemfile +3 -0
- data/LICENSE +201 -0
- data/README.md +58 -0
- data/Rakefile +2 -0
- data/docker-entrypoint.sh +12 -0
- data/lib/metaractor/context_validity.rb +17 -0
- data/lib/metaractor/errors.rb +39 -0
- data/lib/metaractor/parameters.rb +134 -0
- data/lib/metaractor/run_with_context.rb +18 -0
- data/lib/metaractor/version.rb +3 -0
- data/lib/metaractor.rb +50 -0
- data/metaractor.gemspec +26 -0
- metadata +115 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 8bdc777077d09ca35ca998b494ce9b74e56883e3
|
4
|
+
data.tar.gz: 1d1645bd315927baf24ccbf66a7bc8ee18ff5aed
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 0309b7ea31e0629a4f3c076ad489a74e3be15e5ff5252f48743371c0ff55f9de1bacff22bd96c8c9d954749000ebbc525077a518bb7e8b963ddfb9755fb9bf1d
|
7
|
+
data.tar.gz: 80c63031ecbc6553f5e121b7a6eddffbb5051d39b336661c0978a006e2cb628adee35b83324bb427dee68cd6d9a4698322a364682fa6236ff9859f71ebebf3a1
|
data/.gitignore
ADDED
data/.rspec
ADDED
data/Dockerfile
ADDED
@@ -0,0 +1,48 @@
|
|
1
|
+
FROM ruby:2.3.1-alpine
|
2
|
+
MAINTAINER Ryan Schlesinger <ryan@outstand.com>
|
3
|
+
|
4
|
+
RUN addgroup metaractor && \
|
5
|
+
adduser -S -G metaractor metaractor
|
6
|
+
|
7
|
+
ENV GOSU_VERSION 1.9
|
8
|
+
ENV DUMB_INIT_VERSION 1.0.3
|
9
|
+
|
10
|
+
RUN apk add --no-cache ca-certificates gnupg && \
|
11
|
+
mkdir -p /tmp/build && \
|
12
|
+
cd /tmp/build && \
|
13
|
+
gpg --keyserver pool.sks-keyservers.net --recv-keys B42F6819007F00F88E364FD4036A9C25BF357DD4 && \
|
14
|
+
curl -o gosu -SL "https://github.com/tianon/gosu/releases/download/${GOSU_VERSION}/gosu-amd64" && \
|
15
|
+
curl -o gosu.asc -SL "https://github.com/tianon/gosu/releases/download/${GOSU_VERSION}/gosu-amd64.asc" && \
|
16
|
+
gpg --verify gosu.asc && \
|
17
|
+
chmod +x gosu && \
|
18
|
+
cp gosu /bin/gosu && \
|
19
|
+
wget https://github.com/Yelp/dumb-init/releases/download/v${DUMB_INIT_VERSION}/dumb-init_${DUMB_INIT_VERSION}_amd64 && \
|
20
|
+
wget https://github.com/Yelp/dumb-init/releases/download/v${DUMB_INIT_VERSION}/sha256sums && \
|
21
|
+
grep dumb-init_${DUMB_INIT_VERSION}_amd64$ sha256sums | sha256sum -c && \
|
22
|
+
chmod +x dumb-init_${DUMB_INIT_VERSION}_amd64 && \
|
23
|
+
cp dumb-init_${DUMB_INIT_VERSION}_amd64 /bin/dumb-init && \
|
24
|
+
cd /tmp && \
|
25
|
+
rm -rf /tmp/build && \
|
26
|
+
apk del gnupg && \
|
27
|
+
rm -rf /root/.gnupg
|
28
|
+
|
29
|
+
RUN apk add --no-cache \
|
30
|
+
build-base \
|
31
|
+
git \
|
32
|
+
openssh
|
33
|
+
|
34
|
+
COPY Gemfile metaractor.gemspec /metaractor/
|
35
|
+
COPY lib/metaractor/version.rb /metaractor/lib/metaractor/
|
36
|
+
RUN cd /metaractor \
|
37
|
+
&& bundle install \
|
38
|
+
&& git config --global push.default simple
|
39
|
+
COPY . /metaractor/
|
40
|
+
RUN chown -R metaractor:metaractor /metaractor
|
41
|
+
|
42
|
+
WORKDIR /metaractor
|
43
|
+
|
44
|
+
COPY docker-entrypoint.sh /docker-entrypoint.sh
|
45
|
+
|
46
|
+
ENV DUMB_INIT_SETSID 0
|
47
|
+
ENTRYPOINT ["/docker-entrypoint.sh"]
|
48
|
+
CMD ["rspec", "spec"]
|
data/Gemfile
ADDED
data/LICENSE
ADDED
@@ -0,0 +1,201 @@
|
|
1
|
+
Apache License
|
2
|
+
Version 2.0, January 2004
|
3
|
+
http://www.apache.org/licenses/
|
4
|
+
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
6
|
+
|
7
|
+
1. Definitions.
|
8
|
+
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
11
|
+
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
13
|
+
the copyright owner that is granting the License.
|
14
|
+
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
16
|
+
other entities that control, are controlled by, or are under common
|
17
|
+
control with that entity. For the purposes of this definition,
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
19
|
+
direction or management of such entity, whether by contract or
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
22
|
+
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
24
|
+
exercising permissions granted by this License.
|
25
|
+
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
27
|
+
including but not limited to software source code, documentation
|
28
|
+
source, and configuration files.
|
29
|
+
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
31
|
+
transformation or translation of a Source form, including but
|
32
|
+
not limited to compiled object code, generated documentation,
|
33
|
+
and conversions to other media types.
|
34
|
+
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
36
|
+
Object form, made available under the License, as indicated by a
|
37
|
+
copyright notice that is included in or attached to the work
|
38
|
+
(an example is provided in the Appendix below).
|
39
|
+
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
46
|
+
the Work and Derivative Works thereof.
|
47
|
+
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
49
|
+
the original version of the Work and any modifications or additions
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
61
|
+
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
64
|
+
subsequently incorporated within the Work.
|
65
|
+
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
72
|
+
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
78
|
+
where such license applies only to those patent claims licensable
|
79
|
+
by such Contributor that are necessarily infringed by their
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
82
|
+
institute patent litigation against any entity (including a
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
85
|
+
or contributory patent infringement, then any patent licenses
|
86
|
+
granted to You under this License for that Work shall terminate
|
87
|
+
as of the date such litigation is filed.
|
88
|
+
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
91
|
+
modifications, and in Source or Object form, provided that You
|
92
|
+
meet the following conditions:
|
93
|
+
|
94
|
+
(a) You must give any other recipients of the Work or
|
95
|
+
Derivative Works a copy of this License; and
|
96
|
+
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
98
|
+
stating that You changed the files; and
|
99
|
+
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
102
|
+
attribution notices from the Source form of the Work,
|
103
|
+
excluding those notices that do not pertain to any part of
|
104
|
+
the Derivative Works; and
|
105
|
+
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
108
|
+
include a readable copy of the attribution notices contained
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
111
|
+
of the following places: within a NOTICE text file distributed
|
112
|
+
as part of the Derivative Works; within the Source form or
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
114
|
+
within a display generated by the Derivative Works, if and
|
115
|
+
wherever such third-party notices normally appear. The contents
|
116
|
+
of the NOTICE file are for informational purposes only and
|
117
|
+
do not modify the License. You may add Your own attribution
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
120
|
+
that such additional attribution notices cannot be construed
|
121
|
+
as modifying the License.
|
122
|
+
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
124
|
+
may provide additional or different license terms and conditions
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
128
|
+
the conditions stated in this License.
|
129
|
+
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
133
|
+
this License, without any additional terms or conditions.
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
135
|
+
the terms of any separate license agreement you may have executed
|
136
|
+
with Licensor regarding such Contributions.
|
137
|
+
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
140
|
+
except as required for reasonable and customary use in describing the
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
142
|
+
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
152
|
+
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
158
|
+
incidental, or consequential damages of any character arising as a
|
159
|
+
result of this License or out of the use or inability to use the
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
162
|
+
other commercial damages or losses), even if such Contributor
|
163
|
+
has been advised of the possibility of such damages.
|
164
|
+
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
168
|
+
or other liability obligations and/or rights consistent with this
|
169
|
+
License. However, in accepting such obligations, You may act only
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
174
|
+
of your accepting any such warranty or additional liability.
|
175
|
+
|
176
|
+
END OF TERMS AND CONDITIONS
|
177
|
+
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
179
|
+
|
180
|
+
To apply the Apache License to your work, attach the following
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "{}"
|
182
|
+
replaced with your own identifying information. (Don't include
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
184
|
+
comment syntax for the file format. We also recommend that a
|
185
|
+
file or class name and description of purpose be included on the
|
186
|
+
same "printed page" as the copyright notice for easier
|
187
|
+
identification within third-party archives.
|
188
|
+
|
189
|
+
Copyright {yyyy} {name of copyright owner}
|
190
|
+
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
192
|
+
you may not use this file except in compliance with the License.
|
193
|
+
You may obtain a copy of the License at
|
194
|
+
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
196
|
+
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
200
|
+
See the License for the specific language governing permissions and
|
201
|
+
limitations under the License.
|
data/README.md
ADDED
@@ -0,0 +1,58 @@
|
|
1
|
+
# Metaractor
|
2
|
+
Adds parameter validation and error control to [interactor](https://github.com/collectiveidea/interactor).
|
3
|
+
|
4
|
+
## Installation
|
5
|
+
|
6
|
+
Add this line to your application's Gemfile:
|
7
|
+
|
8
|
+
```ruby
|
9
|
+
gem 'metaractor'
|
10
|
+
```
|
11
|
+
|
12
|
+
And then execute:
|
13
|
+
|
14
|
+
$ bundle
|
15
|
+
|
16
|
+
Or install it yourself as:
|
17
|
+
|
18
|
+
$ gem install metaractor
|
19
|
+
|
20
|
+
## Usage
|
21
|
+
```ruby
|
22
|
+
class HighFiveUser
|
23
|
+
include Metaractor
|
24
|
+
|
25
|
+
required or: [:user_id, :user]
|
26
|
+
|
27
|
+
before do
|
28
|
+
context.user ||= User.find(context.user_id)
|
29
|
+
context.user_id ||= context.user.id
|
30
|
+
end
|
31
|
+
|
32
|
+
def call
|
33
|
+
context.user.update_attributes!(high_five: true)
|
34
|
+
# If using rails, you can add private delegates for required parameters.
|
35
|
+
# user.update_attributes!(high_five: true)
|
36
|
+
end
|
37
|
+
|
38
|
+
# private
|
39
|
+
# delegate :user, to: context
|
40
|
+
end
|
41
|
+
```
|
42
|
+
|
43
|
+
See Interactor's [README](https://github.com/collectiveidea/interactor/blob/master/README.md) for more information.
|
44
|
+
|
45
|
+
## Development
|
46
|
+
|
47
|
+
- `docker build -t outstand/metaractor .`
|
48
|
+
- `docker run -it --rm -v $(pwd):/metaractor outstand/metaractor` to run specs
|
49
|
+
|
50
|
+
To release a new version:
|
51
|
+
- Update the version number in `version.rb` and commit the result.
|
52
|
+
- `docker build -t outstand/metaractor .`
|
53
|
+
- `docker run -it --rm -v ~/.gitconfig:/root/.gitconfig -v ~/.gitconfig.user:/root/.gitconfig.user -v ~/.ssh/id_rsa:/root/.ssh/id_rsa -v ~/.gem:/root/.gem outstand/metaractor rake release`
|
54
|
+
|
55
|
+
## Contributing
|
56
|
+
|
57
|
+
Bug reports and pull requests are welcome on GitHub at https://github.com/outstand/metaractor.
|
58
|
+
|
data/Rakefile
ADDED
@@ -0,0 +1,17 @@
|
|
1
|
+
module Metaractor
|
2
|
+
module ContextValidity
|
3
|
+
def valid?
|
4
|
+
!invalid?
|
5
|
+
end
|
6
|
+
|
7
|
+
def invalid?
|
8
|
+
@invalid || false
|
9
|
+
end
|
10
|
+
|
11
|
+
def invalidate!
|
12
|
+
@invalid = true
|
13
|
+
end
|
14
|
+
end
|
15
|
+
end
|
16
|
+
|
17
|
+
Interactor::Context.send(:include, Metaractor::ContextValidity)
|
@@ -0,0 +1,39 @@
|
|
1
|
+
module Metaractor
|
2
|
+
class Error < StandardError; end
|
3
|
+
class InvalidError < Error; end
|
4
|
+
|
5
|
+
module Errors
|
6
|
+
def self.included(base)
|
7
|
+
base.class_eval do
|
8
|
+
before :initialize_errors_array
|
9
|
+
end
|
10
|
+
end
|
11
|
+
|
12
|
+
def initialize_errors_array
|
13
|
+
context.errors ||= []
|
14
|
+
end
|
15
|
+
|
16
|
+
def fail_with_error!(message:)
|
17
|
+
add_error(message: message)
|
18
|
+
context.fail!
|
19
|
+
end
|
20
|
+
|
21
|
+
def fail_with_errors!(messages:)
|
22
|
+
add_errors(messages: messages)
|
23
|
+
context.fail!
|
24
|
+
end
|
25
|
+
|
26
|
+
def add_error(message:)
|
27
|
+
add_errors(messages: Array(message))
|
28
|
+
end
|
29
|
+
|
30
|
+
def add_errors(messages:)
|
31
|
+
context.errors ||= []
|
32
|
+
context.errors += messages
|
33
|
+
end
|
34
|
+
|
35
|
+
def error_messages
|
36
|
+
context.errors.join("\n")
|
37
|
+
end
|
38
|
+
end
|
39
|
+
end
|
@@ -0,0 +1,134 @@
|
|
1
|
+
module Metaractor
|
2
|
+
module Parameters
|
3
|
+
def self.included(base)
|
4
|
+
base.extend ClassMethods
|
5
|
+
base.class_eval do
|
6
|
+
include Metaractor::Errors
|
7
|
+
|
8
|
+
class << self
|
9
|
+
attr_writer :_required_parameters
|
10
|
+
attr_writer :_optional_parameters
|
11
|
+
end
|
12
|
+
|
13
|
+
before :remove_blank_values
|
14
|
+
before :validate_required_parameters
|
15
|
+
end
|
16
|
+
end
|
17
|
+
|
18
|
+
module ClassMethods
|
19
|
+
def _required_parameters
|
20
|
+
@_required_parameters ||= []
|
21
|
+
end
|
22
|
+
|
23
|
+
def required(*params)
|
24
|
+
self._required_parameters += params
|
25
|
+
end
|
26
|
+
alias_method :required_parameters, :required
|
27
|
+
|
28
|
+
def _optional_parameters
|
29
|
+
@_optional_parameters ||= []
|
30
|
+
end
|
31
|
+
|
32
|
+
def optional(*params)
|
33
|
+
self._optional_parameters += params
|
34
|
+
end
|
35
|
+
|
36
|
+
def validate_parameters(*hooks, &block)
|
37
|
+
hooks << block if block
|
38
|
+
hooks.each {|hook| validate_hooks.push(hook) }
|
39
|
+
end
|
40
|
+
|
41
|
+
def validate_hooks
|
42
|
+
@validate_hooks ||= []
|
43
|
+
end
|
44
|
+
end
|
45
|
+
|
46
|
+
def remove_blank_values
|
47
|
+
to_delete = []
|
48
|
+
context.each_pair do |k,v|
|
49
|
+
# The following regex is borrowed from Rails' String#blank?
|
50
|
+
to_delete << k if (v.is_a?(String) && /\A[[:space:]]*\z/ === v) || v.nil?
|
51
|
+
end
|
52
|
+
to_delete.each do |k|
|
53
|
+
context.delete_field k
|
54
|
+
end
|
55
|
+
end
|
56
|
+
|
57
|
+
def validate_required_parameters
|
58
|
+
context.errors ||= []
|
59
|
+
|
60
|
+
self.class._required_parameters.each do |param|
|
61
|
+
require_parameter param
|
62
|
+
end
|
63
|
+
|
64
|
+
run_validate_hooks
|
65
|
+
|
66
|
+
context.fail! unless context.errors.empty?
|
67
|
+
end
|
68
|
+
|
69
|
+
def require_parameter(param, message: nil)
|
70
|
+
message_override = message
|
71
|
+
valid, message = parameter_valid? param
|
72
|
+
|
73
|
+
if !valid
|
74
|
+
if message_override != nil
|
75
|
+
add_parameter_error(param: param, message: message_override)
|
76
|
+
else
|
77
|
+
add_parameter_error(message: "Required parameters: #{message}")
|
78
|
+
end
|
79
|
+
end
|
80
|
+
end
|
81
|
+
|
82
|
+
def parameter_valid?(param)
|
83
|
+
# implements a depth-first post-order traversal
|
84
|
+
if param.respond_to?(:to_h)
|
85
|
+
param = param.to_h
|
86
|
+
raise "invalid required parameter #{param.inspect}" unless param.keys.size == 1
|
87
|
+
raise "invalid required parameter #{param.inspect}" unless param.values.first.respond_to?(:to_a)
|
88
|
+
|
89
|
+
operator = param.keys.first
|
90
|
+
params = param.values.first.to_a
|
91
|
+
|
92
|
+
valids = []
|
93
|
+
messages = []
|
94
|
+
params.each do |key|
|
95
|
+
valid, message = parameter_valid?(key)
|
96
|
+
valids << valid
|
97
|
+
messages << message
|
98
|
+
end
|
99
|
+
|
100
|
+
case operator
|
101
|
+
when :or
|
102
|
+
# We can't test for #one? here as that breaks interactors with the same setup sharing a context.
|
103
|
+
# This happens in almost all of our organizers.
|
104
|
+
return valids.any?, "(#{messages.join(' or ')})"
|
105
|
+
when :xor
|
106
|
+
return valids.one?, "(#{messages.join(' xor ')})"
|
107
|
+
when :and
|
108
|
+
return valids.all?, "(#{messages.join(' and ')})"
|
109
|
+
else
|
110
|
+
raise "invalid required parameter #{param.inspect}"
|
111
|
+
end
|
112
|
+
else
|
113
|
+
return context[param] != nil, param.to_s
|
114
|
+
end
|
115
|
+
end
|
116
|
+
|
117
|
+
def require_parameter!(param, message: nil)
|
118
|
+
require_parameter param, message: message
|
119
|
+
context.fail! unless context.errors.empty?
|
120
|
+
end
|
121
|
+
|
122
|
+
def run_validate_hooks
|
123
|
+
run_hooks(self.class.validate_hooks)
|
124
|
+
end
|
125
|
+
|
126
|
+
def add_parameter_error(param: nil, message:)
|
127
|
+
add_error(
|
128
|
+
message: "#{param} #{message}".lstrip
|
129
|
+
)
|
130
|
+
|
131
|
+
context.invalidate!
|
132
|
+
end
|
133
|
+
end
|
134
|
+
end
|
@@ -0,0 +1,18 @@
|
|
1
|
+
module Metaractor
|
2
|
+
module RunWithContext
|
3
|
+
# Grab context at run and set things up.
|
4
|
+
def run(context = {})
|
5
|
+
_build_context context
|
6
|
+
super()
|
7
|
+
end
|
8
|
+
|
9
|
+
def run!(context = {})
|
10
|
+
_build_context context
|
11
|
+
super()
|
12
|
+
end
|
13
|
+
|
14
|
+
def _build_context(context = {})
|
15
|
+
@context = Interactor::Context.build(context) unless context.empty?
|
16
|
+
end
|
17
|
+
end
|
18
|
+
end
|
data/lib/metaractor.rb
ADDED
@@ -0,0 +1,50 @@
|
|
1
|
+
require 'metaractor/version'
|
2
|
+
require 'interactor'
|
3
|
+
require 'metaractor/errors'
|
4
|
+
require 'metaractor/parameters'
|
5
|
+
require 'metaractor/run_with_context'
|
6
|
+
require 'metaractor/context_validity'
|
7
|
+
|
8
|
+
module Metaractor
|
9
|
+
def self.included(base)
|
10
|
+
base.class_eval do
|
11
|
+
include Interactor
|
12
|
+
Metaractor.modules.each do |hsh|
|
13
|
+
case hsh[:method]
|
14
|
+
when :include
|
15
|
+
include hsh[:module]
|
16
|
+
when :prepend
|
17
|
+
prepend hsh[:module]
|
18
|
+
end
|
19
|
+
end
|
20
|
+
end
|
21
|
+
end
|
22
|
+
|
23
|
+
def self.configure
|
24
|
+
yield self
|
25
|
+
end
|
26
|
+
|
27
|
+
def self.modules
|
28
|
+
@modules ||= default_modules
|
29
|
+
end
|
30
|
+
|
31
|
+
def self.modules=(mods)
|
32
|
+
@modules = mods
|
33
|
+
end
|
34
|
+
|
35
|
+
def self.default_modules
|
36
|
+
[
|
37
|
+
{ module: Metaractor::Errors, method: :include },
|
38
|
+
{ module: Metaractor::Parameters, method: :include },
|
39
|
+
{ module: Metaractor::RunWithContext, method: :include }
|
40
|
+
]
|
41
|
+
end
|
42
|
+
|
43
|
+
def self.include_module(mod)
|
44
|
+
modules << { module: mod, method: :include }
|
45
|
+
end
|
46
|
+
|
47
|
+
def self.prepend_module(mod)
|
48
|
+
modules << { module: mod, method: :prepend }
|
49
|
+
end
|
50
|
+
end
|
data/metaractor.gemspec
ADDED
@@ -0,0 +1,26 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require 'metaractor/version'
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = 'metaractor'
|
8
|
+
spec.version = Metaractor::VERSION
|
9
|
+
spec.license = 'Apache-2.0'
|
10
|
+
spec.authors = ['Ryan Schlesinger']
|
11
|
+
spec.email = ['ryan@outstand.com']
|
12
|
+
|
13
|
+
spec.summary = %q{Adds parameter validation and error control to interactor}
|
14
|
+
spec.homepage = 'https://github.com/outstand/metaractor'
|
15
|
+
|
16
|
+
spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
|
17
|
+
spec.bindir = 'exe'
|
18
|
+
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
|
19
|
+
spec.require_paths = ['lib']
|
20
|
+
|
21
|
+
spec.add_runtime_dependency 'interactor', '~> 3.1'
|
22
|
+
|
23
|
+
spec.add_development_dependency 'bundler', '~> 1.12'
|
24
|
+
spec.add_development_dependency 'rake', '~> 10.0'
|
25
|
+
spec.add_development_dependency 'rspec', '~> 3.4'
|
26
|
+
end
|
metadata
ADDED
@@ -0,0 +1,115 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: metaractor
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.5.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Ryan Schlesinger
|
8
|
+
autorequire:
|
9
|
+
bindir: exe
|
10
|
+
cert_chain: []
|
11
|
+
date: 2016-06-04 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: interactor
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - "~>"
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '3.1'
|
20
|
+
type: :runtime
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - "~>"
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '3.1'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: bundler
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - "~>"
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '1.12'
|
34
|
+
type: :development
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - "~>"
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '1.12'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: rake
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - "~>"
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '10.0'
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - "~>"
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '10.0'
|
55
|
+
- !ruby/object:Gem::Dependency
|
56
|
+
name: rspec
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
58
|
+
requirements:
|
59
|
+
- - "~>"
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: '3.4'
|
62
|
+
type: :development
|
63
|
+
prerelease: false
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - "~>"
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: '3.4'
|
69
|
+
description:
|
70
|
+
email:
|
71
|
+
- ryan@outstand.com
|
72
|
+
executables: []
|
73
|
+
extensions: []
|
74
|
+
extra_rdoc_files: []
|
75
|
+
files:
|
76
|
+
- ".gitignore"
|
77
|
+
- ".rspec"
|
78
|
+
- Dockerfile
|
79
|
+
- Gemfile
|
80
|
+
- LICENSE
|
81
|
+
- README.md
|
82
|
+
- Rakefile
|
83
|
+
- docker-entrypoint.sh
|
84
|
+
- lib/metaractor.rb
|
85
|
+
- lib/metaractor/context_validity.rb
|
86
|
+
- lib/metaractor/errors.rb
|
87
|
+
- lib/metaractor/parameters.rb
|
88
|
+
- lib/metaractor/run_with_context.rb
|
89
|
+
- lib/metaractor/version.rb
|
90
|
+
- metaractor.gemspec
|
91
|
+
homepage: https://github.com/outstand/metaractor
|
92
|
+
licenses:
|
93
|
+
- Apache-2.0
|
94
|
+
metadata: {}
|
95
|
+
post_install_message:
|
96
|
+
rdoc_options: []
|
97
|
+
require_paths:
|
98
|
+
- lib
|
99
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
100
|
+
requirements:
|
101
|
+
- - ">="
|
102
|
+
- !ruby/object:Gem::Version
|
103
|
+
version: '0'
|
104
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
105
|
+
requirements:
|
106
|
+
- - ">="
|
107
|
+
- !ruby/object:Gem::Version
|
108
|
+
version: '0'
|
109
|
+
requirements: []
|
110
|
+
rubyforge_project:
|
111
|
+
rubygems_version: 2.6.4
|
112
|
+
signing_key:
|
113
|
+
specification_version: 4
|
114
|
+
summary: Adds parameter validation and error control to interactor
|
115
|
+
test_files: []
|