trailblazer 1.1.2 → 2.0.0.beta1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.travis.yml +10 -7
- data/CHANGES.md +108 -0
- data/COMM-LICENSE +91 -0
- data/Gemfile +18 -4
- data/LICENSE.txt +7 -20
- data/README.md +55 -15
- data/Rakefile +21 -2
- data/draft-1.2.rb +7 -0
- data/lib/trailblazer.rb +17 -4
- data/lib/trailblazer/dsl.rb +47 -0
- data/lib/trailblazer/operation/auto_inject.rb +47 -0
- data/lib/trailblazer/operation/builder.rb +18 -18
- data/lib/trailblazer/operation/callback.rb +31 -38
- data/lib/trailblazer/operation/contract.rb +46 -0
- data/lib/trailblazer/operation/controller.rb +45 -27
- data/lib/trailblazer/operation/guard.rb +24 -0
- data/lib/trailblazer/operation/model.rb +41 -33
- data/lib/trailblazer/operation/nested.rb +43 -0
- data/lib/trailblazer/operation/params.rb +13 -0
- data/lib/trailblazer/operation/persist.rb +13 -0
- data/lib/trailblazer/operation/policy.rb +26 -72
- data/lib/trailblazer/operation/present.rb +19 -0
- data/lib/trailblazer/operation/procedural/contract.rb +15 -0
- data/lib/trailblazer/operation/procedural/validate.rb +22 -0
- data/lib/trailblazer/operation/pundit.rb +42 -0
- data/lib/trailblazer/operation/representer.rb +25 -92
- data/lib/trailblazer/operation/rescue.rb +23 -0
- data/lib/trailblazer/operation/resolver.rb +18 -24
- data/lib/trailblazer/operation/validate.rb +50 -0
- data/lib/trailblazer/operation/wrap.rb +37 -0
- data/lib/trailblazer/version.rb +1 -1
- data/test/{operation/controller_test.rb → controller_test.rb} +8 -4
- data/test/docs/auto_inject_test.rb +30 -0
- data/test/docs/contract_test.rb +429 -0
- data/test/docs/dry_test.rb +31 -0
- data/test/docs/guard_test.rb +143 -0
- data/test/docs/nested_test.rb +117 -0
- data/test/docs/policy_test.rb +2 -0
- data/test/docs/pundit_test.rb +109 -0
- data/test/docs/representer_test.rb +268 -0
- data/test/docs/rescue_test.rb +153 -0
- data/test/docs/wrap_test.rb +174 -0
- data/test/gemfiles/Gemfile.ruby-1.9 +3 -0
- data/test/gemfiles/Gemfile.ruby-2.0 +12 -0
- data/test/gemfiles/Gemfile.ruby-2.3 +12 -0
- data/test/module_test.rb +22 -15
- data/test/operation/builder_test.rb +66 -18
- data/test/operation/callback_test.rb +70 -0
- data/test/operation/contract_test.rb +385 -15
- data/test/operation/dsl/callback_test.rb +18 -30
- data/test/operation/dsl/contract_test.rb +209 -19
- data/test/operation/dsl/representer_test.rb +42 -15
- data/test/operation/guard_test.rb +1 -147
- data/test/operation/model_test.rb +105 -0
- data/test/operation/params_test.rb +36 -0
- data/test/operation/persist_test.rb +44 -0
- data/test/operation/pipedream_test.rb +59 -0
- data/test/operation/pipetree_test.rb +104 -0
- data/test/operation/present_test.rb +24 -0
- data/test/operation/pundit_test.rb +104 -0
- data/test/{representer_test.rb → operation/representer_test.rb} +58 -42
- data/test/operation/resolver_test.rb +34 -70
- data/test/operation_test.rb +57 -189
- data/test/test_helper.rb +23 -3
- data/trailblazer.gemspec +8 -7
- metadata +91 -59
- data/gemfiles/Gemfile.rails.lock +0 -130
- data/gemfiles/Gemfile.reform-2.0 +0 -6
- data/gemfiles/Gemfile.reform-2.1 +0 -7
- data/lib/trailblazer/autoloading.rb +0 -15
- data/lib/trailblazer/endpoint.rb +0 -31
- data/lib/trailblazer/operation.rb +0 -175
- data/lib/trailblazer/operation/collection.rb +0 -6
- data/lib/trailblazer/operation/dispatch.rb +0 -3
- data/lib/trailblazer/operation/model/dsl.rb +0 -29
- data/lib/trailblazer/operation/model/external.rb +0 -34
- data/lib/trailblazer/operation/policy/guard.rb +0 -35
- data/lib/trailblazer/operation/uploaded_file.rb +0 -77
- data/test/callback_test.rb +0 -104
- data/test/collection_test.rb +0 -57
- data/test/model_test.rb +0 -148
- data/test/operation/external_model_test.rb +0 -71
- data/test/operation/policy_test.rb +0 -97
- data/test/operation/reject_test.rb +0 -34
- data/test/rollback_test.rb +0 -47
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 796e342235352bda7ad6efbfbb4917f016846ff5
|
4
|
+
data.tar.gz: b7f53417cf1b74c08f8177a92f536e2990675dca
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: e8a5e6fbdb459b89c6dbf7c97d1771691d4b0ca0e259a27fb6318b977de11ba557b38db00f8816e0d671975ba9a5b58a180771e9d2ecad0d7a6d0d69e0f6bf5a
|
7
|
+
data.tar.gz: f801d455bae0cafa1746c362d435e6ee39b23430836577c908b15904178abc42ba4a3af550ec763ae74328c7042f0bc4ac281bf5d2cf3e16d88ca43978d06bb9
|
data/.travis.yml
CHANGED
@@ -1,10 +1,13 @@
|
|
1
1
|
language: ruby
|
2
|
-
rvm:
|
3
|
-
- 2.2
|
4
|
-
- 2.1
|
5
|
-
- 2.0
|
6
|
-
gemfiles:
|
7
|
-
- gemfiles/Gemfile.reform-2.0
|
8
|
-
- gemfiles/Gemfile.reform-2.1
|
9
2
|
before_install:
|
10
3
|
- gem install bundler
|
4
|
+
matrix:
|
5
|
+
include:
|
6
|
+
# - rvm: 2.0.0
|
7
|
+
# gemfile: "test/gemfiles/Gemfile.ruby-2.0"
|
8
|
+
- rvm: 2.1
|
9
|
+
gemfile: Gemfile
|
10
|
+
- rvm: 2.2
|
11
|
+
gemfile: Gemfile
|
12
|
+
- rvm: 2.3.1
|
13
|
+
gemfile: Gemfile
|
data/CHANGES.md
CHANGED
@@ -1,3 +1,111 @@
|
|
1
|
+
|
2
|
+
# 2.0.0
|
3
|
+
|
4
|
+
## Operation API change:
|
5
|
+
|
6
|
+
* You can now have any number of contracts, `contract [:name], constant/block`.
|
7
|
+
|
8
|
+
`Contract`, Setup, Model
|
9
|
+
expose via `result[:_invocations] = _invocations`
|
10
|
+
|
11
|
+
* Changed `Operation#validate`: the signature now is `validate(params, model=self.model, options={}, contract_class)`.
|
12
|
+
* Changed `Operation#contract`: the signature now is `contract(model=self.model, options={}, contract_class)`.
|
13
|
+
|
14
|
+
Both changes simplify injecting additional dependencies into the contract, or making use of `Composition` contracts. Read more [here](http://trailblazer.to/gems/operation/contract.html). Note that in 1.2, there are deprecation mechanics to handle old code.
|
15
|
+
|
16
|
+
* Added `Trailblazer::Builder` for a builder-and-call mechanism decoupled from the operation.
|
17
|
+
* Finally removed `Operation::[]`. Be careful, this is now replaced and will return the specified competence.
|
18
|
+
|
19
|
+
TRB 1.1
|
20
|
+
build_operation(params).run
|
21
|
+
process(@params)
|
22
|
+
TRB 1.2
|
23
|
+
build_operation(params, *).call(params)
|
24
|
+
|
25
|
+
* Removed `Operation::reject`. This is available in `trailblazer-compat`.
|
26
|
+
* `Operation#invalid!` is now an optional module `Trailblazer::Operation::Invalid`.
|
27
|
+
* `Operation::present` is now optional. Include `Present`.
|
28
|
+
|
29
|
+
# CHANGES:
|
30
|
+
# * Removed `Operation::[]` in favor of `Operation::()`.
|
31
|
+
# * `Operation#invalid!` doesn't accept a result anymore.
|
32
|
+
# * Removed `Operation#valid?` in favor of the result object.
|
33
|
+
#
|
34
|
+
|
35
|
+
## Model
|
36
|
+
|
37
|
+
* The `model` method doesn't exist anymore, use `self["model"]` or write your own.
|
38
|
+
* `find_by` diverts to left track.
|
39
|
+
* `:create` is `:new` now.
|
40
|
+
|
41
|
+
## DI
|
42
|
+
|
43
|
+
You can now inject the following objects via `::call`:
|
44
|
+
|
45
|
+
* `"contract.default.class"`
|
46
|
+
* `"contract"`: The contract instance.
|
47
|
+
* `"model.class"`
|
48
|
+
|
49
|
+
* Removed `Operation::run` as it was a bad decision. Raising an exception on invalid is a very test-specific scenario and shouldn't have been handled in the core doce.
|
50
|
+
* Removed `Operation::present`, since you can simply call `Operation::new` (without builders) or `Operation::build_operation` (with builders).
|
51
|
+
* Removed `Operation::valid?`. This is in the result object via `result[:valid]`.
|
52
|
+
* Removed `Operation#errors`. This is in the result object via `result[:errors]` if the operation was invalid.
|
53
|
+
* Removed the private option `:raise_on_invalid`. Use `Contract::Raise` instead, if you need it in tests.
|
54
|
+
|
55
|
+
* Removed `Operation::contract` (without args). Please use `Operation::["contract.default.class"]`.
|
56
|
+
* Removed `Operation::callbacks` (without args). Please use `Operation::["callback.<name>.class"]`.
|
57
|
+
* Removed `Operation::contract_class`. Please use `Operation::["contract.default.class"]`.
|
58
|
+
* Removed `Operation::contract_class=`. Please use `Operation::["contract.default.class"]=`. Doesn't inherit.
|
59
|
+
|
60
|
+
## Builder
|
61
|
+
|
62
|
+
* It's `include Builder` now, not `extend Builder`.
|
63
|
+
* `builds` now receives one options hash.
|
64
|
+
|
65
|
+
## Policy
|
66
|
+
|
67
|
+
* No exception anymore, but `Operation#["policy.result"]`.
|
68
|
+
* Access the current user via `self["current_user"]` now.
|
69
|
+
* `Policy` is `Policy::Pundit` now as `Policy` is Trailblazer's authorization style.
|
70
|
+
|
71
|
+
## Representer
|
72
|
+
|
73
|
+
* Removed `Operation::representer_class`. Please use `Operation::["representer.class"]`.
|
74
|
+
* Removed `Operation::representer_class=`. Please use `Operation::["representer.class"]=`.
|
75
|
+
* You can now have any number of named representers: `Operation.representer :parser, ParsingRepresenter`.
|
76
|
+
* Automatic infering of the representer from a `contract` is not so automatic anymore. This feature was barely used and is now available via `include Representer::InferFromContract`.
|
77
|
+
* Reform 2.0 is not supported in `Representer` anymore, meaning you can't automatically infer representers from 2.0 contracts. Reform 2.0 works with all remaining components.
|
78
|
+
* Removed `Operation::contract_class`. Please use `Operation::["contract.default.class"]`.
|
79
|
+
* Removed `Operation::contract_class=`. Please use `Operation::["contract.default.class"]=`. Doesn't inherit.
|
80
|
+
|
81
|
+
## Callback
|
82
|
+
|
83
|
+
* Removed `Operation::Dispatch`, it's called `Operation::Callback`.
|
84
|
+
|
85
|
+
## #call
|
86
|
+
* You can return whatever you want now by overriding `Op::call`.
|
87
|
+
* Removed `Op.call().contract`, you now have to do `Op.call()[:operation].contract`.
|
88
|
+
|
89
|
+
|
90
|
+
* Removed the deprecation for `validate`, signature is `(params[, model, options, contract_class])`.
|
91
|
+
* Removed the deprecation for `contract`, signature is `([model, options, contract_class])`.
|
92
|
+
|
93
|
+
## Collection
|
94
|
+
|
95
|
+
* Removed `Operation::Collection`. Please use `Operation::present`.
|
96
|
+
|
97
|
+
## Controller
|
98
|
+
|
99
|
+
* Removed `Controller#params!`, no one was using it.
|
100
|
+
|
101
|
+
## Contract
|
102
|
+
|
103
|
+
* You can't call `Create.().contract` anymore. The contract instance(s) are available through the `Result` object.
|
104
|
+
|
105
|
+
# 2.0.0.beta1
|
106
|
+
|
107
|
+
* Still undefined `self.~`.
|
108
|
+
|
1
109
|
# 1.1.2
|
2
110
|
|
3
111
|
* Stricter `uber` dependency.
|
data/COMM-LICENSE
ADDED
@@ -0,0 +1,91 @@
|
|
1
|
+
END-USER LICENSE AGREEMENT
|
2
|
+
|
3
|
+
------------------------------------------------------------------------------
|
4
|
+
|
5
|
+
IMPORTANT: THIS SOFTWARE END-USER LICENSE AGREEMENT ("EULA") IS A LEGAL AGREEMENT (“Agreement”) BETWEEN YOU (THE CUSTOMER, EITHER AS AN INDIVIDUAL OR, IF PURCHASED OR OTHERWISE ACQUIRED BY OR FOR AN ENTITY, AS AN ENTITY) AND SYNERGY SOFTWARE SOLUTIONS. READ IT CAREFULLY BEFORE COMPLETING THE INSTALLATION PROCESS AND USING TRAILBLAZER ENTERPRISE AND RELATED SOFTWARE COMPONENTS (“SOFTWARE”). IT PROVIDES A LICENSE TO USE THE SOFTWARE AND CONTAINS WARRANTY INFORMATION AND LIABILITY DISCLAIMERS. BY INSTALLING AND USING THE SOFTWARE, YOU ARE CONFIRMING YOUR ACCEPTANCE OF THE SOFTWARE AND AGREEING TO BECOME BOUND BY THE TERMS OF THIS AGREEMENT.
|
6
|
+
|
7
|
+
------------------------------------------------------------------------------
|
8
|
+
|
9
|
+
In order to use the Software under this Agreement, you must receive a “Source URL” at the time of purchase, in accordance with the scope of use and other terms specified for each type of Software and as set forth in this Section 1 of this Agreement.
|
10
|
+
|
11
|
+
1. License Grant
|
12
|
+
|
13
|
+
1.1 General Use. This Agreement grants you a non-exclusive, non-transferable, limited license to the use rights for the Software, without the right to grant sublicenses, subject to the terms and conditions in this Agreement. The Software is licensed, not sold.
|
14
|
+
|
15
|
+
1.3 Limited Organization License. If you purchased an Organization License (included with the Trailblazer Enterprise Software), you may install the Software on an unlimited number of Hosts. “Host” means any physical or virtual machine which is controlled by you.
|
16
|
+
|
17
|
+
1.4 Appliance License. If you purchased an Appliance License, you may distribute the Software in any applications, frameworks, or elements (collectively referred to as an “Application” or “Applications”) that you develop using the Software in accordance with this EULA, provided that such distribution does not violate the restrictions set forth in section 3 of this EULA. You must not remove, obscure or interfere with any copyright, acknowledgment, attribution, trademark, warning or disclaimer statement affixed to, incorporated in or otherwise applied in connection with the Software. You are required to ensure that the Software is not reused by or with any applications other than those with which you distribute it as permitted herein. For example, if You install the Software on a customer’s server, that customer is not permitted to use the Software independently of your Application. You must inform Synergy Software Solutions of your knowledge of any infringing use of the Software by any of your customers. You are liable for compliance by those third parties with the terms and conditions of this EULA. You will not owe Synergy Software Solutions any royalties for your distribution of the Software in accordance with this EULA.
|
18
|
+
|
19
|
+
1.5 Archive Copies. You are entitled to make a reasonable amount of copies of the Software for archival purposes. Each copy must reproduce all copyright and other proprietary rights notices on or in the Software Product.
|
20
|
+
|
21
|
+
1.6 Electronic Delivery. All Software and license documentation shall be delivered by electronic means unless otherwise specified on the applicable invoice or at the time of purchase. Software shall be deemed delivered when it is made available for download by you (“Delivery”).
|
22
|
+
|
23
|
+
2. Modifications. Synergy Software Solutions shall provide you with source code so that you can create Modifications of the original software. “Modification” means: (a) any addition to or deletion from the contents of a file included in the original Software or previous Modifications created by You, or (b) any new file that contains any part of the original Software or previous Modifications. While you retain all rights to any original work authored by you as part of the Modifications, We continue to own all copyright and other intellectual property rights in the Software.
|
24
|
+
|
25
|
+
3. Restricted Uses.
|
26
|
+
|
27
|
+
3.1 You shall not (and shall not allow any third party to): (a) decompile, disassemble, or otherwise reverse engineer the Software or attempt to reconstruct or discover any source code, underlying ideas, algorithms, file formats or programming interfaces of the Software by any means whatsoever (except and only to the extent that applicable law prohibits or restricts reverse engineering restrictions); (b) distribute, sell, sublicense, rent, lease or use the Software for time sharing, hosting, service provider or like purposes, except as expressly permitted under this Agreement; (c) redistribute the Software or Modifications other than by including the Software or a portion thereof within your own product, which must have substantially different functionality than the Software or Modifications and must not allow any third party to use the Software or Modifications, or any portions thereof, for software development or application development purposes; (d) redistribute the Software as part of a product, "appliance" or "virtual server"; (e) redistribute the Software on any server which is not directly under your control; (f) remove any product identification, proprietary, copyright or other notices contained in the Software; (g) modify any part of the Software, create a derivative work of any part of the Software (except as permitted in Section 4), or incorporate the Software, except to the extent expressly authorized in writing by Synergy Software Solutions; (h) publicly disseminate performance information or analysis (including, without limitation, benchmarks) from any source relating to the Software; (i) utilize any equipment, device, software, or other means designed to circumvent or remove any form of Source URL or copy protection used by Synergy Software Solutions in connection with the Software, or use the Software together with any authorization code, Source URL, serial number, or other copy protection device not supplied by Synergy Software Solutions; (j) use the Software to develop a product which is competitive with any Synergy Software Solutions product offerings; or (k) use unauthorized Source URLS or keycode(s) or distribute or publish Source URLs or keycode(s), except as may be expressly permitted by Synergy Software Solutions in writing. If your unique Source URL is ever published, Synergy Software Solutions reserves the right to terminate your access without notice.
|
28
|
+
|
29
|
+
3.2 UNDER NO CIRCUMSTANCES MAY YOU USE THE SOFTWARE AS PART OF A PRODUCT OR SERVICE THAT PROVIDES SIMILAR FUNCTIONALITY TO THE SOFTWARE ITSELF.
|
30
|
+
|
31
|
+
The Open Source version of the Software (“LGPL Version”) is licensed
|
32
|
+
under the terms of the GNU Lesser General Public License versions 3.0
|
33
|
+
(“LGPL”) and not under this EULA.
|
34
|
+
|
35
|
+
4. Ownership. Notwithstanding anything to the contrary contained herein, except for the limited license rights expressly provided herein, Synergy Software Solutions and its suppliers have and will retain all rights, title and interest (including, without limitation, all patent, copyright, trademark, trade secret and other intellectual property rights) in and to the Software and all copies, modifications and derivative works thereof (including any changes which incorporate any of your ideas, feedback or suggestions). You acknowledge that you are obtaining only a limited license right to the Software, and that irrespective of any use of the words “purchase”, “sale” or like terms hereunder no ownership rights are being conveyed to you under this Agreement or otherwise.
|
36
|
+
|
37
|
+
5. Fees and Payment. The Software license fees will be due and payable in full as set forth in the applicable invoice or at the time of purchase. If the Software does not function properly within two weeks of purchase, please contact us within those two weeks for a refund. You shall be responsible for all taxes, withholdings, duties and levies arising from the order (excluding taxes based on the net income of Synergy Software Solutions).
|
38
|
+
|
39
|
+
6. Support, Maintenance and Services. Subject to the terms and conditions of this Agreement, as set forth in your invoice, and as set forth on the Trailblazer Enterprise support page (http://enterprise.trailblazer.to), support and maintenance services may be included with the purchase of your license subscription.
|
40
|
+
|
41
|
+
7. Term of Agreement.
|
42
|
+
|
43
|
+
7.1 Term. This Agreement is effective as of the Delivery of the Software and expires at such time as all license and service subscriptions hereunder have expired in accordance with their own terms (the “Term”). For clarification, the term of your license under this Agreement may be perpetual, limited for Evaluation Version, or designated as a fixed-term license in the Invoice, and shall be specified at your time of purchase. Either party may terminate this Agreement (including all related Invoices) if the other party: (a) fails to cure any material breach of this Agreement within thirty (30) days after written notice of such breach, provided that Synergy Software Solutions may terminate this Agreement immediately upon any breach of Section 3 or if you exceed any other restrictions contained in Section 1, unless otherwise specified in this agreement; (b) ceases operation without a successor; or (c) seeks protection under any bankruptcy, receivership, trust deed, creditors arrangement, composition or comparable proceeding, or if any such proceeding is instituted against such party (and not dismissed within sixty (60) days)). Termination is not an exclusive remedy and the exercise by either party of any remedy under this Agreement will be without prejudice to any other remedies it may have under this Agreement, by law, or otherwise.
|
44
|
+
|
45
|
+
7.2 Termination. Upon any termination of this Agreement, you shall cease any and all use of any Software and destroy all copies thereof.
|
46
|
+
|
47
|
+
7.3 Expiration of License. Upon the expiration of any term under this Agreement, (a) all Software updates and services pursuant to the license shall cease, (b) you may only continue to run existing installations of the Software, (c) you may not install the Software on any additional Hosts, and (d) any new installation of the Software shall require the purchase of a new license subscription from Synergy Software Solutions.
|
48
|
+
|
49
|
+
8. Disclaimer of Warranties. The Software is provided "as is," with all faults, defects and errors, and without warranty of any kind. Synergy Software Solutions does not warrant that the Software will be free of bugs, errors, viruses or other defects, and Synergy Software Solutions shall have no liability of any kind for the use of or inability to use the Software, the Software content or any associated service, and you acknowledge that it is not technically practicable for Synergy Software Solutions to do so.
|
50
|
+
To the maximum extent permitted by applicable law, Synergy Software Solutions disclaims all warranties, express, implied, arising by law or otherwise, regarding the Software, the Software content and their respective performance or suitability for your intended use, including without limitation any implied warranty of merchantability, fitness for a particular purpose.
|
51
|
+
|
52
|
+
9. Limitation of Liability.
|
53
|
+
|
54
|
+
In no event will Synergy Software Solutions be liable for any direct, indirect, consequential, incidental, special, exemplary, or punitive damages or liabilities whatsoever arising from or relating to the Software, the Software content or this Agreement, whether based on contract, tort (including negligence), strict liability or other theory, even if Synergy Software Solutions has been advised of the possibility of such damages.
|
55
|
+
|
56
|
+
In no event will Synergy Software Solutions' liability exceed the Software license price as indicated in the invoice. The existence of more than one claim will not enlarge or extend this limit.
|
57
|
+
|
58
|
+
10. Remedies. Your exclusive remedy and Synergy Software Solutions’ entire liability for breach of this Agreement shall be limited, at Synergy Software Solutions’ sole and exclusive discretion, to (a) replacement of any defective software or documentation; or (b) refund of the license fee paid to Synergy Software Solutions, payable in accordance with Synergy Software Solutions' refund policy.
|
59
|
+
|
60
|
+
11. Acknowledgements.
|
61
|
+
|
62
|
+
11.1 Consent to the Use of Data. You agree that Synergy Software Solutions and its affiliates may collect and use technical information gathered as part of the product support services. Synergy Software Solutions may use this information solely to improve products and services and will not disclose this information in a form that personally identifies you.
|
63
|
+
|
64
|
+
11.3 Government End Users. If the Software and related documentation are supplied to or purchased by or on behalf of the United States Government, then the Software is deemed to be "commercial software" as that term is used in the Federal Acquisition Regulation system. Rights of the United States shall not exceed the minimum rights set forth in FAR 52.227-19 for "restricted computer software". All other terms and conditions of this Agreement apply.
|
65
|
+
|
66
|
+
12. Third Party Software. Examples included in Software may provide links to third party libraries or code (collectively “Third Party Software”) to implement various functions. Third Party Software does not comprise part of the Software. In some cases, access to Third Party Software may be included along with the Software delivery as a convenience for demonstration purposes. Such source code and libraries may be included in the “…/examples” source tree delivered with the Software and do not comprise the Software. Licensee acknowledges (1) that some part of Third Party Software may require additional licensing of copyright and patents from the owners of such, and (2) that distribution of any of the Software referencing or including any portion of a Third Party Software may require appropriate licensing from such third parties.
|
67
|
+
|
68
|
+
|
69
|
+
13. Miscellaneous
|
70
|
+
|
71
|
+
13.1 Entire Agreement. This Agreement sets forth our entire agreement with respect to the Software and the subject matter hereof and supersedes all prior and contemporaneous understandings and agreements whether written or oral.
|
72
|
+
|
73
|
+
13.2 Amendment. Synergy Software Solutions reserves the right, in its sole discretion, to amend this Agreement from time. Amendments to this Agreement can be located at: https://github.com/trailblazer/trailblazer/blob/master/COMM-LICENSE.
|
74
|
+
|
75
|
+
13.3 Assignment. You may not assign this Agreement or any of its rights under this Agreement without the prior written consent of Synergy Software Solutions and any attempted assignment without such consent shall be void.
|
76
|
+
|
77
|
+
13.4 Export Compliance. You agree to comply with all applicable laws and regulations, including laws, regulations, orders or other restrictions on export, re-export or redistribution of software.
|
78
|
+
|
79
|
+
13.5 Indemnification. You agree to defend, indemnify, and hold harmless Synergy Software Solutions from and against any lawsuits, claims, losses, damages, fines and expenses (including attorneys' fees and costs) arising out of your use of the Software or breach of this Agreement.
|
80
|
+
|
81
|
+
13.6 Governing Law. This Agreement is governed by the laws of the State of Oregon and the United States without regard to conflicts of laws provisions thereof, and without regard to the United Nations Convention on the International Sale of Goods or the Uniform Computer Information Transactions Act, as currently enacted by any jurisdiction or as may be codified or amended from time to time by any jurisdiction. The jurisdiction and venue for actions related to the subject matter hereof shall be the state of Oregon and United States federal courts located in Portland, Oregon, and both parties hereby submit to the personal jurisdiction of such courts.
|
82
|
+
|
83
|
+
13.7 Attorneys’ Fees and Costs. The prevailing party in any action to enforce this Agreement will be entitled to recover its attorneys’ fees and costs in connection with such action.
|
84
|
+
|
85
|
+
13.8 Severability. If any provision of this Agreement is held by a court of competent jurisdiction to be invalid, illegal, or unenforceable, the remainder of this Agreement will remain in full force and effect.
|
86
|
+
|
87
|
+
13.9 Waiver. Failure or neglect by either party to enforce at any time any of the provisions of this licence Agreement shall not be construed or deemed to be a waiver of that party's rights under this Agreement.
|
88
|
+
|
89
|
+
13.10 Headings. The headings of sections and paragraphs of this Agreement are for convenience of reference only and are not intended to restrict, affect or be of any weight in the interpretation or construction of the provisions of such sections or paragraphs.
|
90
|
+
|
91
|
+
14. Contact Information. If you have any questions about this EULA, or if you want to contact Synergy Software Solutions for any reason, please direct correspondence to info@trailblazer.to.
|
data/Gemfile
CHANGED
@@ -5,10 +5,24 @@ gemspec
|
|
5
5
|
|
6
6
|
# gem "representable", path: "../representable"
|
7
7
|
# gem "disposable", path: "../disposable"
|
8
|
-
gem "
|
9
|
-
gem "reform"
|
8
|
+
# gem "reform", github: "apotonick/reform"
|
9
|
+
gem "reform-rails"
|
10
|
+
gem "activesupport", "~> 4.2.0"
|
11
|
+
|
10
12
|
gem "roar", github: "apotonick/roar"
|
11
13
|
# gem "reform", "~> 2.0.0"
|
12
|
-
|
14
|
+
gem "reform"#, path: "../reform"
|
13
15
|
# gem "roar", path: "../roar"
|
14
|
-
gem "multi_json"
|
16
|
+
gem "multi_json"
|
17
|
+
|
18
|
+
gem "dry-auto_inject"
|
19
|
+
gem "dry-matcher"
|
20
|
+
gem "dry-validation"
|
21
|
+
|
22
|
+
|
23
|
+
# gem "trailblazer-operation", path: "../operation"
|
24
|
+
gem "pipetree"#, path: "../pipetree"
|
25
|
+
|
26
|
+
gem "minitest-line"
|
27
|
+
|
28
|
+
# gem "uber", path: "../uber"
|
data/LICENSE.txt
CHANGED
@@ -1,22 +1,9 @@
|
|
1
|
-
Copyright (c)
|
1
|
+
Copyright (c) Nick Sutterer
|
2
2
|
|
3
|
-
|
3
|
+
Trailblazer is an Open Source project licensed under the terms of
|
4
|
+
the LGPLv3 license. Please see <http://www.gnu.org/licenses/lgpl-3.0.html>
|
5
|
+
for license text.
|
4
6
|
|
5
|
-
|
6
|
-
|
7
|
-
|
8
|
-
without limitation the rights to use, copy, modify, merge, publish,
|
9
|
-
distribute, sublicense, and/or sell copies of the Software, and to
|
10
|
-
permit persons to whom the Software is furnished to do so, subject to
|
11
|
-
the following conditions:
|
12
|
-
|
13
|
-
The above copyright notice and this permission notice shall be
|
14
|
-
included in all copies or substantial portions of the Software.
|
15
|
-
|
16
|
-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
17
|
-
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
18
|
-
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
19
|
-
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
20
|
-
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
21
|
-
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
22
|
-
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
7
|
+
Trailblazer Enterprise has a commercial-friendly license allowing private forks
|
8
|
+
and modifications of Trailblazer. Please see http://trailblazer.to/enterprise/ for
|
9
|
+
more detail. You can find the commercial license terms in COMM-LICENSE.
|
data/README.md
CHANGED
@@ -6,11 +6,12 @@ _Trailblazer is a thin layer on top of Rails. It gently enforces encapsulation,
|
|
6
6
|
[![TRB Newsletter](https://img.shields.io/badge/TRB-newsletter-lightgrey.svg)](http://trailblazer.to/newsletter/)
|
7
7
|
[![Gem Version](https://badge.fury.io/rb/trailblazer.svg)](http://badge.fury.io/rb/trailblazer)
|
8
8
|
|
9
|
+
**This document discusses Trailblazer 2.0. The [1.x documentation is here](http://trailblazer.to/gems/operation/1.1/).**
|
9
10
|
|
10
11
|
## Trailblazer In A Nutshell
|
11
12
|
|
12
13
|
1. All business logic is encapsulated in [operations](#operation) (service objects).
|
13
|
-
*
|
14
|
+
* Optional [validation objects](#validation) (Reform and/or Dry-validation) in the operation deserialize and validate input. The form object can also be used for rendering.
|
14
15
|
* An optional [policy](#policies) object blocks unauthorized users from running the operation.
|
15
16
|
* Optional [callback](#callbacks) objects allow declaring post-processing logic.
|
16
17
|
3. [Controllers](#controllers) instantly delegate to an operation. No business code in controllers, only HTTP-specific logic.
|
@@ -19,7 +20,7 @@ _Trailblazer is a thin layer on top of Rails. It gently enforces encapsulation,
|
|
19
20
|
|
20
21
|
Trailblazer is designed to handle different contexts like user roles by applying [inheritance](#inheritance) between and [composing](#composing) of operations, form objects, policies, representers and callbacks.
|
21
22
|
|
22
|
-
|
23
|
+
Want code? Jump [right here](#controllers)!
|
23
24
|
|
24
25
|
## Mission
|
25
26
|
|
@@ -42,25 +43,37 @@ Since Trailblazer decouples the High-Level Stack from the framework, it runs wit
|
|
42
43
|
* Trailblazer with Grape - coming _very_ soon!
|
43
44
|
|
44
45
|
|
45
|
-
##
|
46
|
+
## Concepts over Technology
|
46
47
|
|
47
|
-
Trailblazer offers you a new, more intuitive file layout in
|
48
|
+
Trailblazer offers you a new, more intuitive file layout in applications.
|
48
49
|
|
49
50
|
```
|
50
51
|
app
|
51
52
|
├── concepts
|
52
53
|
│ ├── comment
|
53
|
-
│ │ ├──
|
54
|
-
│ │ ├──
|
54
|
+
│ │ ├── operation
|
55
|
+
│ │ │ ├── create.rb
|
56
|
+
│ │ │ ├── update.rb
|
57
|
+
│ │ ├── contract
|
58
|
+
│ │ │ ├── create.rb
|
59
|
+
│ │ │ ├── update.rb
|
60
|
+
│ │ ├── cell
|
61
|
+
│ │ │ ├── show.rb
|
62
|
+
│ │ │ ├── index.rb
|
63
|
+
│ │ ├── view
|
55
64
|
│ │ │ ├── show.haml
|
56
|
-
│ │ │ ├──
|
57
|
-
│ │ ├── assets
|
65
|
+
│ │ │ ├── index.rb
|
58
66
|
│ │ │ ├── comment.css.sass
|
59
|
-
│ │ ├── operation.rb
|
60
|
-
│ │ ├── twin.rb
|
61
67
|
```
|
62
68
|
|
63
|
-
|
69
|
+
Instead of grouping by technology, classes and views are structured by *concept*, and then by technology. A concept can relate to a model, or can be a completely abstract concern such as `invoicing`.
|
70
|
+
|
71
|
+
Within a concept, you can have any level of nesting. For example, `invoicing/pdf/` could be one.
|
72
|
+
|
73
|
+
The file structure is implemented by the [`trailblazer-loader` gem](https://github.com/trailblazer/trailblazer-loader).
|
74
|
+
|
75
|
+
[Learn more.](http://trailblazer.to/gems/trailblazer/loader.html)
|
76
|
+
|
64
77
|
|
65
78
|
## Architecture
|
66
79
|
|
@@ -89,6 +102,7 @@ class CommentsController < ApplicationController
|
|
89
102
|
def create
|
90
103
|
run Comment::Create # Comment::Create is an operation class.
|
91
104
|
end
|
105
|
+
end
|
92
106
|
```
|
93
107
|
|
94
108
|
The `#run` method invokes the operation. It allows you to run a conditional block of logic if the operation was successful.
|
@@ -102,6 +116,7 @@ class CommentsController < ApplicationController
|
|
102
116
|
|
103
117
|
render :new # invalid. re-render form.
|
104
118
|
end
|
119
|
+
end
|
105
120
|
```
|
106
121
|
|
107
122
|
Again, the controller only dispatchs to the operation and handles successful/invalid processing on the HTTP level. For instance by redirecting, setting flash messages, or signing in a user.
|
@@ -112,9 +127,11 @@ Again, the controller only dispatchs to the operation and handles successful/inv
|
|
112
127
|
|
113
128
|
Operations encapsulate business logic and are the heart of a Trailblazer architecture.
|
114
129
|
|
115
|
-
|
130
|
+
The bare bones operation without any Trailblazery is implemented in [the `trailblazer-operation` gem[(https://github.com/trailblazer/trailblazer-operation) and can be used without our stack.
|
116
131
|
|
117
|
-
|
132
|
+
Operations don't know about HTTP or the environment. You could use an operation in Rails, Hanami, or Roda, it wouldn't know.
|
133
|
+
|
134
|
+
An operation is not just a monolithic replacement for your business code. It's a simple orchestrator between the form objects, models, your business code and all other layers needed to get the job done.
|
118
135
|
|
119
136
|
```ruby
|
120
137
|
class Comment::Create < Trailblazer::Operation
|
@@ -124,14 +141,26 @@ class Comment::Create < Trailblazer::Operation
|
|
124
141
|
end
|
125
142
|
```
|
126
143
|
|
127
|
-
Operations only need to implement `#process` which receives the
|
144
|
+
Operations only need to implement `#process` which receives the arguments from the caller.
|
145
|
+
|
146
|
+
You cannot instantiate them per design. The only way to invoke them is `call`.
|
147
|
+
|
148
|
+
```ruby
|
149
|
+
Comment::Create.call(whatever: "goes", in: "here")
|
150
|
+
# same as
|
151
|
+
Comment::Create.(whatever: "goes", in: "here")
|
152
|
+
```
|
153
|
+
|
154
|
+
Their high degree of encapsulation makes them a [replacement for test factories](#test), too.
|
128
155
|
|
129
156
|
[Learn more.](http://trailblazer.to/gems/operation)
|
130
157
|
|
131
|
-
##
|
158
|
+
## Validation
|
132
159
|
|
133
160
|
In Trailblazer, an operation (usually) has a form object which is simply a `Reform::Form` class. All the [API documented in Reform](https://github.com/apotonick/reform) can be applied and used.
|
134
161
|
|
162
|
+
Validations can also be implemented in pure Dry-validation.
|
163
|
+
|
135
164
|
The operation makes use of the form object using the `#validate` method.
|
136
165
|
|
137
166
|
```ruby
|
@@ -169,6 +198,7 @@ class Comment::Create < Trailblazer::Operation
|
|
169
198
|
callback(:after_save) do
|
170
199
|
on_change :markdownize_body! # this is only run when the form object has changed.
|
171
200
|
end
|
201
|
+
end
|
172
202
|
```
|
173
203
|
|
174
204
|
Callbacks are never triggered automatically, you have to invoke them! This is called _Imperative Callback_.
|
@@ -232,12 +262,19 @@ class Comment::Create < Trailblazer::Operation
|
|
232
262
|
include Policy
|
233
263
|
|
234
264
|
policy Comment::Policy, :create?
|
265
|
+
end
|
235
266
|
```
|
236
267
|
|
237
268
|
The policy is evaluated in `#setup!`, raises an exception if `false` and suppresses running `#process`.
|
238
269
|
|
239
270
|
[Learn more.](http://trailblazer.to/gems/operation/policy.html)
|
240
271
|
|
272
|
+
## Pipetree
|
273
|
+
|
274
|
+
The operation code is not supposed to be procedural, but in form of a function pipeline. You can still write procedural code with stacked methods calls where ever you want, e.g. in `process`.
|
275
|
+
|
276
|
+
However, a much smarter way to chain logic is to use the *pipetree*.
|
277
|
+
|
241
278
|
## Views
|
242
279
|
|
243
280
|
View rendering can happen using the controller as known from Rails. This is absolutely fine for simple views.
|
@@ -251,6 +288,7 @@ class CommentsController < ApplicationController
|
|
251
288
|
def new
|
252
289
|
form Comment::Create # will assign the form object to @form.
|
253
290
|
end
|
291
|
+
end
|
254
292
|
```
|
255
293
|
|
256
294
|
Since Reform objects can be passed to form builders, you can use the operation to render and process the form!
|
@@ -275,6 +313,7 @@ class Comment::Create < Trailblazer::Operation
|
|
275
313
|
|
276
314
|
link(:self) { comment_path(represented.id) }
|
277
315
|
end
|
316
|
+
end
|
278
317
|
```
|
279
318
|
|
280
319
|
The operation can then parse incoming JSON documents in `validate` and render a document via `to_json`.
|
@@ -290,6 +329,7 @@ Operations completely replace the need for leaky factories.
|
|
290
329
|
```ruby
|
291
330
|
describe Comment::Update do
|
292
331
|
let(:comment) { Comment::Create.(comment: {body: "[That](http://trailblazer.to)!"}) }
|
332
|
+
end
|
293
333
|
```
|
294
334
|
|
295
335
|
## More
|