teckel 0.0.1 → 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.github/workflows/ci.yml +67 -0
- data/.github/workflows/pages.yml +50 -0
- data/.gitignore +2 -0
- data/.rubocop.yml +12 -0
- data/.ruby-version +1 -0
- data/.yardopts +5 -0
- data/CHANGELOG.md +0 -0
- data/DEVELOPMENT.md +28 -0
- data/Gemfile +3 -1
- data/Gemfile.lock +71 -0
- data/LICENSE +201 -0
- data/README.md +62 -6
- data/Rakefile +25 -1
- data/bin/console +1 -0
- data/bin/rake +29 -0
- data/bin/rspec +29 -0
- data/bin/rubocop +18 -0
- data/lib/teckel/chain.rb +186 -0
- data/lib/teckel/config.rb +69 -0
- data/lib/teckel/operation/results.rb +71 -0
- data/lib/teckel/operation.rb +340 -0
- data/lib/teckel/result.rb +63 -0
- data/lib/teckel/version.rb +3 -1
- data/lib/teckel.rb +8 -1
- data/teckel.gemspec +9 -4
- metadata +72 -7
- data/.travis.yml +0 -7
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 3f8117e6d304e571ccfd26db58af5122330494e3df8b2597cfa5f8e11ad19b12
|
|
4
|
+
data.tar.gz: 9aeecbf92e87d3fa0610defed63f0e3f1048925348c43af00d83aab68ffb1265
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 7b6eef841002932cad55e8bd4a7121d173624633962de203e0eda72602bbf36afa947126100bd7795ab078540b4b7210a32fc0d51eea117c558943d418026526
|
|
7
|
+
data.tar.gz: 60c090f9fd1ec11deb535dcd0e9838146401f361754f15469a80104b69ec58d68a64c5d32399b29d1fb0264538e418e3cf1c3188df6f3fac1af6c87f2fca631b
|
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
name: CI
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
paths:
|
|
6
|
+
- .github/workflows/ci.yml
|
|
7
|
+
- lib/**
|
|
8
|
+
- spec/**
|
|
9
|
+
- Gemfile
|
|
10
|
+
- "*.gemspec"
|
|
11
|
+
- ".rubocop.yml"
|
|
12
|
+
|
|
13
|
+
jobs:
|
|
14
|
+
rubocop:
|
|
15
|
+
runs-on: ubuntu-latest
|
|
16
|
+
steps:
|
|
17
|
+
- uses: actions/checkout@v1
|
|
18
|
+
- name: Set up Ruby
|
|
19
|
+
uses: actions/setup-ruby@v1
|
|
20
|
+
with:
|
|
21
|
+
ruby-version: 2.4.x
|
|
22
|
+
- name: Install bundler
|
|
23
|
+
run: gem install bundler
|
|
24
|
+
- name: Run rubocop
|
|
25
|
+
run: bin/rubocop -ESD
|
|
26
|
+
|
|
27
|
+
cruby:
|
|
28
|
+
runs-on: ubuntu-latest
|
|
29
|
+
strategy:
|
|
30
|
+
fail-fast: false
|
|
31
|
+
matrix:
|
|
32
|
+
ruby: ["2.6.x", "2.5.x", "2.4.x"]
|
|
33
|
+
|
|
34
|
+
steps:
|
|
35
|
+
- uses: actions/checkout@v1
|
|
36
|
+
- name: Set up Ruby
|
|
37
|
+
uses: actions/setup-ruby@v1
|
|
38
|
+
with:
|
|
39
|
+
ruby-version: ${{matrix.ruby}}
|
|
40
|
+
- name: Bundle install
|
|
41
|
+
run: |
|
|
42
|
+
gem install bundler
|
|
43
|
+
bundle install --jobs 4 --retry 3 --without tools docs benchmarks
|
|
44
|
+
- name: Run all tests
|
|
45
|
+
run: bundle exec rake
|
|
46
|
+
|
|
47
|
+
other-ruby:
|
|
48
|
+
runs-on: ubuntu-latest
|
|
49
|
+
strategy:
|
|
50
|
+
fail-fast: false
|
|
51
|
+
matrix:
|
|
52
|
+
image: ["jruby:9.2.9", "ruby:2.7"]
|
|
53
|
+
container:
|
|
54
|
+
image: ${{matrix.image}}
|
|
55
|
+
|
|
56
|
+
steps:
|
|
57
|
+
- uses: actions/checkout@v1
|
|
58
|
+
- name: Install git
|
|
59
|
+
run: |
|
|
60
|
+
apt-get update
|
|
61
|
+
apt-get install -y --no-install-recommends git
|
|
62
|
+
- name: Bundle install
|
|
63
|
+
run: |
|
|
64
|
+
gem install bundler
|
|
65
|
+
bundle install --jobs 4 --retry 3 --without tools docs benchmarks
|
|
66
|
+
- name: Run all tests
|
|
67
|
+
run: bundle exec rake
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
name: pages
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
branches:
|
|
6
|
+
- master
|
|
7
|
+
paths:
|
|
8
|
+
- .github/workflows/pages.yml
|
|
9
|
+
- lib/**
|
|
10
|
+
- README.md
|
|
11
|
+
- .yardopts
|
|
12
|
+
- Rakefile
|
|
13
|
+
|
|
14
|
+
jobs:
|
|
15
|
+
build-docs:
|
|
16
|
+
runs-on: ubuntu-latest
|
|
17
|
+
steps:
|
|
18
|
+
- uses: actions/checkout@v2
|
|
19
|
+
- name: Set up Ruby
|
|
20
|
+
uses: actions/setup-ruby@v1
|
|
21
|
+
with:
|
|
22
|
+
ruby-version: 2.6.x
|
|
23
|
+
- name: Bundle install
|
|
24
|
+
run: |
|
|
25
|
+
gem install bundler
|
|
26
|
+
bundle install --jobs 4 --retry 3 --without tools docs benchmarks
|
|
27
|
+
- name: Build docs
|
|
28
|
+
run: 'bin/rake docs:yard'
|
|
29
|
+
- name: config git
|
|
30
|
+
run: |
|
|
31
|
+
git config --local user.email "action@github.com"
|
|
32
|
+
git config --local user.name "GitHub Action"
|
|
33
|
+
- name: Checkout Pages
|
|
34
|
+
run: 'git fetch origin gh-pages && git checkout gh-pages'
|
|
35
|
+
- name: Replace and commit docs
|
|
36
|
+
run: |
|
|
37
|
+
rm -rf doc && mv _yardoc doc
|
|
38
|
+
git add -A doc
|
|
39
|
+
git commit -m"Update API docs"
|
|
40
|
+
- name: Replace index
|
|
41
|
+
run: |
|
|
42
|
+
git checkout master README.md
|
|
43
|
+
mv -f README.md index.md
|
|
44
|
+
if [ ! -z "$(git diff --name-only -- index.md)" ]; then
|
|
45
|
+
git commit index.md -m"update index"
|
|
46
|
+
fi
|
|
47
|
+
- name: Push
|
|
48
|
+
env:
|
|
49
|
+
INPUT_GITHUB_TOKEN: "${{ secrets.DEPLOY_TOKEN }}"
|
|
50
|
+
run: git push https://git:${INPUT_GITHUB_TOKEN}@github.com/fnordfish/teckel.git gh-pages
|
data/.gitignore
CHANGED
data/.rubocop.yml
ADDED
data/.ruby-version
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
ruby-2.6.5
|
data/.yardopts
ADDED
data/CHANGELOG.md
ADDED
|
File without changes
|
data/DEVELOPMENT.md
ADDED
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# Development Guidelines
|
|
2
|
+
|
|
3
|
+
- Keep is simple.
|
|
4
|
+
- Favor easy debug-ability over clever solutions.
|
|
5
|
+
- Aim to be a 0-dependency lib (at runtime)
|
|
6
|
+
|
|
7
|
+
## Roadmap
|
|
8
|
+
|
|
9
|
+
- Add "Settings" for Operations and Chains
|
|
10
|
+
|
|
11
|
+
```
|
|
12
|
+
MyOp.with(foo: "bar").call("input")
|
|
13
|
+
|
|
14
|
+
class MyOp
|
|
15
|
+
settings Types::Hash.schema(foo: Types::String)
|
|
16
|
+
|
|
17
|
+
def call(input)
|
|
18
|
+
input == "input"
|
|
19
|
+
settings.foo == "bar"
|
|
20
|
+
end
|
|
21
|
+
end
|
|
22
|
+
|
|
23
|
+
MyCain.with(:step1) { { foo: "bar" } }.with(:stepX) { { another: :setting} }.call(params)
|
|
24
|
+
```
|
|
25
|
+
- Add support for around hooks in Chains (for db transactions etc.)
|
|
26
|
+
- Add a dry-monads mixin to wrap Operations and Chains result/error into a Result Monad
|
|
27
|
+
- ...
|
|
28
|
+
|
data/Gemfile
CHANGED
|
@@ -1,6 +1,8 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
1
3
|
source "https://rubygems.org"
|
|
2
4
|
|
|
3
|
-
git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
|
|
5
|
+
git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
|
|
4
6
|
|
|
5
7
|
# Specify your gem's dependencies in teckel.gemspec
|
|
6
8
|
gemspec
|
data/Gemfile.lock
ADDED
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
PATH
|
|
2
|
+
remote: .
|
|
3
|
+
specs:
|
|
4
|
+
teckel (0.1.0)
|
|
5
|
+
|
|
6
|
+
GEM
|
|
7
|
+
remote: https://rubygems.org/
|
|
8
|
+
specs:
|
|
9
|
+
concurrent-ruby (1.1.5)
|
|
10
|
+
diff-lcs (1.3)
|
|
11
|
+
dry-configurable (0.9.0)
|
|
12
|
+
concurrent-ruby (~> 1.0)
|
|
13
|
+
dry-core (~> 0.4, >= 0.4.7)
|
|
14
|
+
dry-container (0.7.2)
|
|
15
|
+
concurrent-ruby (~> 1.0)
|
|
16
|
+
dry-configurable (~> 0.1, >= 0.1.3)
|
|
17
|
+
dry-core (0.4.9)
|
|
18
|
+
concurrent-ruby (~> 1.0)
|
|
19
|
+
dry-equalizer (0.3.0)
|
|
20
|
+
dry-inflector (0.2.0)
|
|
21
|
+
dry-logic (1.0.5)
|
|
22
|
+
concurrent-ruby (~> 1.0)
|
|
23
|
+
dry-core (~> 0.2)
|
|
24
|
+
dry-equalizer (~> 0.2)
|
|
25
|
+
dry-struct (1.2.0)
|
|
26
|
+
dry-core (~> 0.4, >= 0.4.3)
|
|
27
|
+
dry-equalizer (~> 0.3)
|
|
28
|
+
dry-types (~> 1.0)
|
|
29
|
+
ice_nine (~> 0.11)
|
|
30
|
+
dry-types (1.2.2)
|
|
31
|
+
concurrent-ruby (~> 1.0)
|
|
32
|
+
dry-container (~> 0.3)
|
|
33
|
+
dry-core (~> 0.4, >= 0.4.4)
|
|
34
|
+
dry-equalizer (~> 0.3)
|
|
35
|
+
dry-inflector (~> 0.1, >= 0.1.2)
|
|
36
|
+
dry-logic (~> 1.0, >= 1.0.2)
|
|
37
|
+
ice_nine (0.11.2)
|
|
38
|
+
minitest (5.13.0)
|
|
39
|
+
rake (13.0.1)
|
|
40
|
+
rspec (3.9.0)
|
|
41
|
+
rspec-core (~> 3.9.0)
|
|
42
|
+
rspec-expectations (~> 3.9.0)
|
|
43
|
+
rspec-mocks (~> 3.9.0)
|
|
44
|
+
rspec-core (3.9.1)
|
|
45
|
+
rspec-support (~> 3.9.1)
|
|
46
|
+
rspec-expectations (3.9.0)
|
|
47
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
|
48
|
+
rspec-support (~> 3.9.0)
|
|
49
|
+
rspec-mocks (3.9.1)
|
|
50
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
|
51
|
+
rspec-support (~> 3.9.0)
|
|
52
|
+
rspec-support (3.9.2)
|
|
53
|
+
yard (0.9.22)
|
|
54
|
+
yard-doctest (0.1.17)
|
|
55
|
+
minitest
|
|
56
|
+
yard
|
|
57
|
+
|
|
58
|
+
PLATFORMS
|
|
59
|
+
ruby
|
|
60
|
+
|
|
61
|
+
DEPENDENCIES
|
|
62
|
+
bundler (~> 2.0)
|
|
63
|
+
dry-struct (>= 1.1.1, < 2)
|
|
64
|
+
rake (>= 10.0)
|
|
65
|
+
rspec (~> 3.0)
|
|
66
|
+
teckel!
|
|
67
|
+
yard
|
|
68
|
+
yard-doctest
|
|
69
|
+
|
|
70
|
+
BUNDLED WITH
|
|
71
|
+
2.1.2
|
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 2019 Robert Schulze <robert@dotless.de>
|
|
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
CHANGED
|
@@ -1,8 +1,11 @@
|
|
|
1
1
|
# Teckel
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Ruby service classes with enforced<sup name="footnote-1-source">[1](#footnote-1)</sup> input, output and error data structure definition.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
[][gem]
|
|
6
|
+
[][ci]
|
|
7
|
+
[](https://codeclimate.com/github/fnordfish/teckel/maintainability)
|
|
8
|
+
[][inch]
|
|
6
9
|
|
|
7
10
|
## Installation
|
|
8
11
|
|
|
@@ -20,16 +23,69 @@ Or install it yourself as:
|
|
|
20
23
|
|
|
21
24
|
$ gem install teckel
|
|
22
25
|
|
|
26
|
+
## Motivation
|
|
27
|
+
|
|
28
|
+
Working with [Interactor](https://github.com/collectiveidea/interactor), [Trailblazer's Operation](http://trailblazer.to/gems/operation) and [Dry-rb's Transaction](https://dry-rb.org/gems/dry-transaction) and probably a hand full of inconsistent "service objects", I missed a system that:
|
|
29
|
+
|
|
30
|
+
1. provides and enforces well defined input, output and error structures
|
|
31
|
+
2. makes chaining multiple operation easy and reliable
|
|
32
|
+
3. is easy to debug
|
|
33
|
+
|
|
23
34
|
## Usage
|
|
24
35
|
|
|
25
|
-
|
|
36
|
+
For a full overview please see the [Api Docs](https://fnordfish.github.io/teckel/doc/)
|
|
37
|
+
|
|
38
|
+
This example uses [Dry::Types](https://dry-rb.org/gems/dry-types/) to illustrate the flexibility. There's no dependency on dry-rb, choose what you like.
|
|
39
|
+
|
|
40
|
+
```ruby
|
|
41
|
+
class CreateUser
|
|
42
|
+
include Teckel::Operation
|
|
43
|
+
|
|
44
|
+
# DSL style declaration
|
|
45
|
+
input Types::Hash.schema(name: Types::String, age: Types::Coercible::Integer)
|
|
46
|
+
|
|
47
|
+
# Constant style declaration
|
|
48
|
+
Output = Types.Instance(User)
|
|
49
|
+
|
|
50
|
+
# Well, also Constant style, but using classic `class` notation
|
|
51
|
+
class Error < Dry::Struct
|
|
52
|
+
attribute :message, Types::String
|
|
53
|
+
attribute :status_code, Types::Integer
|
|
54
|
+
attribute :meta, Types::Hash.optional
|
|
55
|
+
end
|
|
56
|
+
|
|
57
|
+
def call(input)
|
|
58
|
+
user = User.create(input)
|
|
59
|
+
if user.safe
|
|
60
|
+
success!(user)
|
|
61
|
+
else
|
|
62
|
+
fail!(
|
|
63
|
+
message: "Could not create User",
|
|
64
|
+
status_code: 400,
|
|
65
|
+
meta: { validation: user.errors }
|
|
66
|
+
)
|
|
67
|
+
end
|
|
68
|
+
end
|
|
69
|
+
end
|
|
70
|
+
|
|
71
|
+
result = CreateUser.call(name: "Bob", age: 23)
|
|
72
|
+
```
|
|
26
73
|
|
|
27
74
|
## Development
|
|
28
75
|
|
|
29
76
|
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
|
|
30
77
|
|
|
31
|
-
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
|
|
32
|
-
|
|
33
78
|
## Contributing
|
|
34
79
|
|
|
35
|
-
Bug reports and pull requests are welcome on GitHub at https://github.com/
|
|
80
|
+
Bug reports and pull requests are welcome on GitHub at https://github.com/fnordfish/teckel.
|
|
81
|
+
Feature requests should provide a detailed explanation of the missing or changed behavior, if possible including some sample code.
|
|
82
|
+
|
|
83
|
+
Please also see [DEVELOPMENT.md](DEVELOPMENT.md) for planned features and general guidelines.
|
|
84
|
+
|
|
85
|
+
## Footnotes
|
|
86
|
+
|
|
87
|
+
- <a name="footnote-1">1</a>: Obviously, it's still Ruby and you can cheat. Don’t! [↩](#footnote-1-source)
|
|
88
|
+
|
|
89
|
+
[gem]: https://rubygems.org/gems/teckel
|
|
90
|
+
[ci]: https://github.com/fnordfish/teckel/actions?query=workflow%3ACI
|
|
91
|
+
[inch]: http://inch-ci.org/github/fnordfish/teckel
|
data/Rakefile
CHANGED
|
@@ -1,6 +1,30 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
1
3
|
require "bundler/gem_tasks"
|
|
2
4
|
require "rspec/core/rake_task"
|
|
5
|
+
require "yard"
|
|
6
|
+
require "yard/doctest/rake"
|
|
3
7
|
|
|
4
8
|
RSpec::Core::RakeTask.new(:spec)
|
|
5
9
|
|
|
6
|
-
|
|
10
|
+
namespace :docs do
|
|
11
|
+
YARD::Rake::YardocTask.new do |t|
|
|
12
|
+
t.files = ['lib/**/*.rb']
|
|
13
|
+
t.options = []
|
|
14
|
+
t.stats_options = ['--list-undoc']
|
|
15
|
+
end
|
|
16
|
+
|
|
17
|
+
task :fswatch do
|
|
18
|
+
sh 'fswatch -0 lib | while read -d "" e; do rake docs:yard; done'
|
|
19
|
+
end
|
|
20
|
+
|
|
21
|
+
YARD::Doctest::RakeTask.new do |task|
|
|
22
|
+
task.doctest_opts = %w[-v]
|
|
23
|
+
task.pattern = Dir.glob('lib/**/*.rb')
|
|
24
|
+
end
|
|
25
|
+
end
|
|
26
|
+
|
|
27
|
+
task :default do
|
|
28
|
+
Rake::Task["spec"].invoke
|
|
29
|
+
Rake::Task["docs:yard:doctest"].invoke
|
|
30
|
+
end
|
data/bin/console
CHANGED
data/bin/rake
ADDED
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
#!/usr/bin/env ruby
|
|
2
|
+
# frozen_string_literal: true
|
|
3
|
+
|
|
4
|
+
#
|
|
5
|
+
# This file was generated by Bundler.
|
|
6
|
+
#
|
|
7
|
+
# The application 'rake' is installed as part of a gem, and
|
|
8
|
+
# this file is here to facilitate running it.
|
|
9
|
+
#
|
|
10
|
+
|
|
11
|
+
require "pathname"
|
|
12
|
+
ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
|
|
13
|
+
Pathname.new(__FILE__).realpath)
|
|
14
|
+
|
|
15
|
+
bundle_binstub = File.expand_path('bundle', __dir__)
|
|
16
|
+
|
|
17
|
+
if File.file?(bundle_binstub)
|
|
18
|
+
if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
|
|
19
|
+
load(bundle_binstub)
|
|
20
|
+
else
|
|
21
|
+
abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
|
|
22
|
+
Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
|
|
23
|
+
end
|
|
24
|
+
end
|
|
25
|
+
|
|
26
|
+
require "rubygems"
|
|
27
|
+
require "bundler/setup"
|
|
28
|
+
|
|
29
|
+
load Gem.bin_path("rake", "rake")
|
data/bin/rspec
ADDED
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
#!/usr/bin/env ruby
|
|
2
|
+
# frozen_string_literal: true
|
|
3
|
+
|
|
4
|
+
#
|
|
5
|
+
# This file was generated by Bundler.
|
|
6
|
+
#
|
|
7
|
+
# The application 'rspec' is installed as part of a gem, and
|
|
8
|
+
# this file is here to facilitate running it.
|
|
9
|
+
#
|
|
10
|
+
|
|
11
|
+
require "pathname"
|
|
12
|
+
ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
|
|
13
|
+
Pathname.new(__FILE__).realpath)
|
|
14
|
+
|
|
15
|
+
bundle_binstub = File.expand_path('bundle', __dir__)
|
|
16
|
+
|
|
17
|
+
if File.file?(bundle_binstub)
|
|
18
|
+
if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
|
|
19
|
+
load(bundle_binstub)
|
|
20
|
+
else
|
|
21
|
+
abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
|
|
22
|
+
Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
|
|
23
|
+
end
|
|
24
|
+
end
|
|
25
|
+
|
|
26
|
+
require "rubygems"
|
|
27
|
+
require "bundler/setup"
|
|
28
|
+
|
|
29
|
+
load Gem.bin_path("rspec-core", "rspec")
|