lab42_basic_constraints 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: c88af59f506668cbc7c56fffc54c3430f31a0ebf5ad7d697dd3aadebf6ef5192
4
+ data.tar.gz: 84bedc52d927607fbdbc5d108d56d23ab02d8931fb939567a06ece934c9903a5
5
+ SHA512:
6
+ metadata.gz: 27926e413ebcf7801f572816d6fe5d23ad340d972526ca4d25246e927d118e7073d789b6f167c61c569067097c0bf761b1a707d151320d30400bbb19558e3113
7
+ data.tar.gz: f49c25cdf9c96bc9e0da08d7e7783774dd0c511a814a0431360bdb88a208c836cf15d6b35beb3469558ed93a5674377d56993b1b509e4cb9fe13260f65a20632
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.
@@ -0,0 +1,122 @@
1
+
2
+ [![Gem Version](https://badge.fury.io/rb/lab42_basic_constraints.svg)](http://badge.fury.io/rb/lab42_basic_constraints)
3
+
4
+
5
+ # Lab42::BasicConstraints
6
+
7
+ **N.B.** All these code examples are verified with [the speculate_about gem](https://rubygems.org/gems/speculate_about/)
8
+
9
+
10
+ A collection of constraints
11
+
12
+ ## Context A Quick Overview
13
+
14
+ Given That we alias `Lab42::BasicConstraints` to `BC`
15
+
16
+ ```ruby
17
+ require "lab42/basic_constraints/alias"
18
+ ```
19
+
20
+ Then All Basic Constraints can be listed by means of `BC.all_constraints`
21
+
22
+ ```ruby
23
+ all_basic_constraints = %i[
24
+ all_digits_string alphanumeric_string
25
+ bool
26
+ date date_time day
27
+ hour
28
+ lowercase_string
29
+ minute month
30
+ non_empty_string non_negative_float non_negative_int non_negative_number
31
+ positive_float positive_int positive_number
32
+ second
33
+ time
34
+ uppercase_string
35
+ year
36
+ ]
37
+
38
+ expect( BC.all_constraints ).to eq(all_basic_constraints)
39
+ ```
40
+
41
+ ## So we got the ball, now use it!
42
+
43
+ The ball, BTW, is a `Lab42::Result` see [lab42_result gem](https://rubygems.org/gems/lab42_result/) for more info
44
+
45
+ Given the `non_negative_int` constraint
46
+
47
+ ```ruby
48
+ let(:non_neg_int) {BC.non_negative_int}
49
+ ```
50
+
51
+ Then we can just call it
52
+
53
+ ```ruby
54
+ non_neg_int.(0) in [:ok, nil]
55
+ non_neg_int.(-1) in [error, message]
56
+ expect(error).to eq(BC::ConstraintError)
57
+ expect(message).to eq("-1 is not a legal non_negative_int")
58
+ ```
59
+
60
+ Example: Get a constraint by symbol
61
+
62
+ ```ruby
63
+ pn = BC.from_symbol(:positive_number)
64
+ pn.(1) in [:ok, nil]
65
+ ```
66
+
67
+ Example: Constraints with and without defaults
68
+
69
+ ```ruby
70
+ expect {BC.from_symbol(:positive_number).default}
71
+ .to raise_error(Lab42::BasicConstraints::MissingDefaultError, "Constraint positive_number has no predefined default")
72
+
73
+ expect( BC.non_negative_int.default ).to eq(0)
74
+
75
+ ```
76
+
77
+ A detailed description of all constraints can be found
78
+ [here](speculations/constraints.md)
79
+
80
+ ## Context We are still in Beta and therefor
81
+
82
+ Example: Some constraints are not yet implemented
83
+
84
+ ```ruby
85
+ expect{ BC.all_digits_string }.to raise_error(NotImplementedError)
86
+ ```
87
+
88
+ ## Context Time's a Sticky Wicket
89
+
90
+ ... but as defaults are defined for runtime that shall really help us with that
91
+
92
+ Given that we have timecop
93
+
94
+ ```ruby
95
+ require "timecop"
96
+ let(:d) {BC.date}
97
+ let(:error) {Lab42::BasicConstraints::ConstraintError}
98
+ ```
99
+ Then we can show that the year's default value will not be at compile time but at runtime:
100
+
101
+ ```ruby
102
+ year = BC.year
103
+ Timecop.freeze(Time.utc(1905)) do
104
+ expect( year.default ).to eq(1905)
105
+ end
106
+ ```
107
+
108
+ Of course a check for legality is performed
109
+
110
+ Example: Illegal Dates
111
+
112
+ ```ruby
113
+ d.("2020-00-01") in [raised, message ]
114
+ expect( raised ).to eq(error)
115
+ expect( message ).to eq("2020-00-01 is not a legal date")
116
+ ```
117
+
118
+ # LICENSE
119
+
120
+ Copyright 2020 Robert Dober robert.dober@gmail.com
121
+
122
+ Apache-2.0 [c.f LICENSE](LICENSE)
@@ -0,0 +1,59 @@
1
+ require_relative "basic_constraints/implementation.rb"
2
+ module Lab42
3
+ module BasicConstraints extend self
4
+ Constraints = {
5
+ all_digits_string: :not_yet_implemented,
6
+ alphanumeric_string: :not_yet_implemented,
7
+
8
+ bool: ->(x){[false, true].include? x},
9
+
10
+ date: :date,
11
+ date_time: :not_yet_implemented,
12
+ day: :not_yet_implemented,
13
+
14
+ hour: :not_yet_implemented,
15
+
16
+ lowercase_string: :not_yet_implemented,
17
+
18
+ minute: :not_yet_implemented,
19
+ month: :not_yet_implemented,
20
+
21
+ non_empty_string: :not_yet_implemented,
22
+ non_negative_float: :not_yet_implemented,
23
+ non_negative_int: :non_negative_int,
24
+
25
+ non_negative_number: :not_yet_implemented,
26
+
27
+ positive_float: :not_yet_implemented,
28
+ positive_int: :not_yet_implemented,
29
+ positive_number: :positive_number,
30
+
31
+ second: :not_yet_implemented,
32
+
33
+ time: :not_yet_implemented,
34
+
35
+ uppercase_string: :not_yet_implemented,
36
+
37
+ year: :year
38
+ }
39
+ def all_constraints
40
+ Constraints.keys
41
+ end
42
+
43
+ def from_symbol name, *args, **kwds, &blk
44
+ cons = Constraints.fetch(name, &blk)
45
+ case cons
46
+ # when Constraint
47
+ # cons
48
+ when Proc
49
+ Constraint.new(name, &cons)
50
+ when Symbol
51
+ Implementation.send(cons, *args, **kwds)
52
+ end
53
+ end
54
+
55
+ def method_missing(name, *args, **kwds)
56
+ from_symbol(name, *args, **kwds) {super}
57
+ end
58
+ end
59
+ end
@@ -0,0 +1,2 @@
1
+ require_relative "../basic_constraints"
2
+ BC = Lab42::BasicConstraints
@@ -0,0 +1,50 @@
1
+ require "lab42/result"
2
+ Result = Lab42::Result
3
+ module Lab42
4
+ module BasicConstraints
5
+ ConstraintError = Class.new RuntimeError
6
+ MissingDefaultError = Class.new RuntimeError
7
+ class Constraint
8
+
9
+ def call value
10
+ return Result.ok if @constraint.(value)
11
+ Result.error("#{_show value} is not a legal #{@name}", error: Lab42::BasicConstraints::ConstraintError)
12
+ end
13
+
14
+ def default
15
+ case @default
16
+ when Proc
17
+ @default.()
18
+ else
19
+ @default
20
+ end
21
+ end
22
+
23
+ def set_default value=nil, &blk
24
+ @default =
25
+ if value
26
+ value
27
+ else
28
+ blk
29
+ end
30
+ self
31
+ end
32
+
33
+ private
34
+ def _show value
35
+ case value
36
+ when NilClass
37
+ "nil"
38
+ else
39
+ value
40
+ end
41
+ end
42
+
43
+ def initialize name, &blk
44
+ @constraint = blk
45
+ @default = -> {raise Lab42::BasicConstraints::MissingDefaultError, "Constraint #{name} has no predefined default"}
46
+ @name = name
47
+ end
48
+ end
49
+ end
50
+ end
@@ -0,0 +1,45 @@
1
+ require_relative "constraint"
2
+ module Lab42
3
+ module BasicConstraints
4
+
5
+ module Implementation extend self
6
+
7
+ def date default: nil
8
+ require "date"
9
+ Constraint.new(:date) do |value|
10
+ Date.parse(value) rescue false
11
+ end
12
+ .set_default default do
13
+ Date.today.iso8601
14
+ end
15
+ end
16
+
17
+ def non_negative_int
18
+ Constraint.new :non_negative_int do |value|
19
+ Integer === value && value >= 0
20
+ end
21
+ .set_default(0)
22
+ end
23
+
24
+ def positive_number
25
+ Constraint.new :positive_number do |value|
26
+ Integer === value && value > 0 ||
27
+ Float === value && value > 0.0
28
+ end
29
+ end
30
+
31
+ def not_yet_implemented
32
+ raise NotImplementedError
33
+ end
34
+
35
+ def year
36
+ Constraint.new(:year) do |value|
37
+ Integer === value
38
+ end
39
+ .set_default do
40
+ Time.now.utc.year
41
+ end
42
+ end
43
+ end
44
+ end
45
+ end
@@ -0,0 +1,5 @@
1
+ module Lab42
2
+ module BasicConstraints
3
+ VERSION = "0.1.1"
4
+ end
5
+ end
metadata ADDED
@@ -0,0 +1,119 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: lab42_basic_constraints
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.1
5
+ platform: ruby
6
+ authors:
7
+ - Robert Dober
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2020-11-18 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: lab42_result
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '0.1'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '0.1'
27
+ - !ruby/object:Gem::Dependency
28
+ name: pry
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '0.10'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '0.10'
41
+ - !ruby/object:Gem::Dependency
42
+ name: pry-byebug
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '3.9'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '3.9'
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.10'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '3.10'
69
+ - !ruby/object:Gem::Dependency
70
+ name: timecop
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - "~>"
74
+ - !ruby/object:Gem::Version
75
+ version: 0.9.2
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - "~>"
81
+ - !ruby/object:Gem::Version
82
+ version: 0.9.2
83
+ description: Constraints like :positive_int, :non_empty_string, ...
84
+ email: robert.dober@gmail.com
85
+ executables: []
86
+ extensions: []
87
+ extra_rdoc_files: []
88
+ files:
89
+ - LICENSE
90
+ - README.md
91
+ - lib/lab42/basic_constraints.rb
92
+ - lib/lab42/basic_constraints/alias.rb
93
+ - lib/lab42/basic_constraints/constraint.rb
94
+ - lib/lab42/basic_constraints/implementation.rb
95
+ - lib/lab42/basic_constraints/version.rb
96
+ homepage: https://bitbucket.org/robertdober/lab42_basic_constraints
97
+ licenses:
98
+ - Apache-2.0
99
+ metadata: {}
100
+ post_install_message:
101
+ rdoc_options: []
102
+ require_paths:
103
+ - lib
104
+ required_ruby_version: !ruby/object:Gem::Requirement
105
+ requirements:
106
+ - - ">="
107
+ - !ruby/object:Gem::Version
108
+ version: 2.7.0
109
+ required_rubygems_version: !ruby/object:Gem::Requirement
110
+ requirements:
111
+ - - ">="
112
+ - !ruby/object:Gem::Version
113
+ version: '0'
114
+ requirements: []
115
+ rubygems_version: 3.1.2
116
+ signing_key:
117
+ specification_version: 4
118
+ summary: Basic, useful and recurring constraints
119
+ test_files: []