lab42_curry 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 9a551847324f71962eb05cec99769fc9a945b68d31b65a3ce94bd338e4f88b72
4
+ data.tar.gz: 6bb0044d5af9008de8ff78d00f4b5a7e1d79c9c341f2e78f1f0012a909670160
5
+ SHA512:
6
+ metadata.gz: f0028228fd18f8cc4ec1b4a865ad64e3b57ea99a2ded385cfbea0527fb61744c03d2bf35163ea4a5698bdc85c67e9e469b7ea213c7a25781f9b9e365387a02a1
7
+ data.tar.gz: f9ed56c17f25fe649f2507cae0cc2a55f4a6170b7901b3096235742f155aa34e80f592ab219f1d2a9a1665239e62e71e7a0d5db80e27d1f880b563d9e9a92f0e
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,102 @@
1
+ [![Gem Version](https://badge.fury.io/rb/lab42_curry.svg)](http://badge.fury.io/rb/lab42_curry)
2
+
3
+
4
+ # Lab42::Curry
5
+
6
+ Name says it all..
7
+
8
+ Curry functions and methods at will, reorder, define placeholders anywhere, positional and named args
9
+
10
+ **N.B.** All these code examples are verified with [the speculate_about gem](https://rubygems.org/gems/speculate_about/)
11
+
12
+ ## So what does it do?
13
+
14
+ ### Context Positional Parameters
15
+
16
+ The simplest and classical way to curry a function (I include _methods_ when I say function) is by providing the first
17
+ `n` parameters to a function needing `m` parameters and thusly defining a function that needs now `m - n` parameters.
18
+
19
+ Given such a simple funcion
20
+ ```ruby
21
+ def adder(a, b, c); a + 10*b + 100*c end
22
+ let(:add_to_1) {curry(:adder, 1)}
23
+ ```
24
+ **N.B.** that `Lab42::Curry` has been included into Examples **and** ExampleGroups in `spec/spec_helper.rb`
25
+
26
+ Then very unsurprisingly:
27
+ ```ruby
28
+ expect(add_to_1.(2, 3)).to eq(321)
29
+ ```
30
+
31
+ We call the arguments passed into `curry` the _compiletime arguments_, and the arguments passed into the
32
+ invocation of the _curried function_, which has been returned by the invocation of `curry`, the _runtime arguments_.
33
+
34
+ In our case the _compiletime arguments_ were `[1]` and the _runtime arguments_ were `[2, 3]`
35
+
36
+ ### Reordering
37
+
38
+ There are several methods of reordering arguments, the simplest is probably using _placeholders_.
39
+
40
+ When a placeholder is provided (`Lab42::Curry.runtime_arg` aliased as `rt_arg` )
41
+ ```ruby
42
+ let(:add_to_30) { curry(:adder, rt_arg, 3) }
43
+ ```
44
+ Then we see that
45
+ ```ruby
46
+ expect( add_to_30.(1, 5) ).to eq(531)
47
+ ```
48
+ #### Total control over argument order...
49
+
50
+ ... can be achieved by passing the index of the positional argument to be used into `Lab42::Curry.runtime_arg`
51
+
52
+ Given the total reorder form
53
+ ```ruby
54
+ let(:mul_decrement) { curry(:adder, runtime_arg(2), runtime_arg(0), 1) } # now first argument is c (index 2) and second a (index 0) and b = 1
55
+ ```
56
+ Then we have
57
+ ```ruby
58
+ expect( mul_decrement.(2, 3) ).to eq(213)
59
+ ```
60
+
61
+ #### Picking a positon for a compiletime argument
62
+
63
+ It might be cumbersome to write things like: `curry(..., rt_arg, rt_arg, ..., rt_arg, 42)`
64
+
65
+ Therefore we can express the same much more concisely with `Lab42::Curry.compiletime_args`, and its alias `ct_args`
66
+
67
+ Given
68
+ ```ruby
69
+ let(:doubler) { curry(:adder, ct_args(2 => 2)) } # same as curry(:adder, rt_arg, rt_arg, 2)
70
+ ```
71
+ Then we get
72
+ ```ruby
73
+ expect( doubler.(4, 3) ).to eq(234)
74
+ ```
75
+
76
+ **N.B.** that we could have defined `add_to_30` as `curry(:adder, rt_arg, 3, rt_arg)` of course
77
+
78
+
79
+ #### Error Handling
80
+
81
+ When you indicate values for the same position multiple times
82
+ Then the `ArgumentCompiler` saves you:
83
+ ```ruby
84
+ expect{ curry(:adder, 1, ct_args(0 => 1)).() }.to raise_error(Lab42::Curry::DuplicatePositionSpecification)
85
+ ```
86
+
87
+ ### Context With proc like objects
88
+
89
+ Given a lambda
90
+ ```ruby
91
+ let(:sub) { ->{ _1 - _2} }
92
+ let(:inverse) { curry(sub, rt_arg(1), rt_arg) }
93
+ ```
94
+ Then we will get the negative value
95
+ ```ruby
96
+ expect( inverse.(2, 1) ).to eq(-1)
97
+ ```
98
+ # LICENSE
99
+
100
+ Copyright 2020,1 Robert Dober robert.dober@gmail.com
101
+
102
+ Apache-2.0 [c.f LICENSE](LICENSE)
@@ -0,0 +1,23 @@
1
+ require_relative "curry/data"
2
+ require_relative "curry/runtime_arg"
3
+ require_relative "curry/compiletime_args"
4
+
5
+ module Lab42
6
+ module Curry
7
+ def curry(method_or_name, *curry_time_args, &blk)
8
+ curry_data = Data.new(self, method_or_name, *curry_time_args, &blk)
9
+ curry_data.curried
10
+ end
11
+
12
+ def compiletime_args(positions)
13
+ CompiletimeArgs.new(positions)
14
+ end
15
+ alias_method :ct_args, :compiletime_args
16
+
17
+ def runtime_arg(*args)
18
+ RuntimeArg.new(*args)
19
+ end
20
+ alias_method :rt_arg, :runtime_arg
21
+ end
22
+ end
23
+
@@ -0,0 +1,78 @@
1
+ require_relative 'runtime_arg'
2
+ require_relative 'compiletime_args'
3
+ require_relative 'errors'
4
+
5
+ module Lab42
6
+ module Curry
7
+ class ArgCompiler
8
+ attr_reader :ct_args, :rt_args
9
+
10
+ def compile_args
11
+ _init
12
+ ct_args.each(&method(:_set_ct_arg))
13
+ rt_args.each(&method(:_set_rt_arg))
14
+ @final.map.sort_by(&:first).map(&:last)
15
+ end
16
+
17
+ private
18
+ def initialize(ct_args:, rt_args:)
19
+ @ct_args = ct_args
20
+ @rt_args = rt_args
21
+ end
22
+
23
+ def _init
24
+ @pos = 0
25
+ @final = {}
26
+ end
27
+
28
+ def _set_compiletime_arg ct_arg
29
+ _store_into_next(ct_arg)
30
+ end
31
+
32
+ def _set_ct_arg ct_arg
33
+ case ct_arg
34
+ when RuntimeArg
35
+ _set_runtime_arg! ct_arg # changes @rt_args, I know, I know, TODO: make this w/o side effect
36
+ when CompiletimeArgs
37
+ _set_positions ct_arg
38
+ else
39
+ _set_compiletime_arg ct_arg
40
+ end
41
+ end
42
+
43
+ def _set_position((pos, val))
44
+ _store_at! val, pos
45
+ end
46
+
47
+ def _set_positions ct_arg
48
+ ct_arg.each(&method(:_set_position))
49
+ end
50
+
51
+ def _set_rt_arg rt_arg
52
+ _store_into_next(rt_arg)
53
+ end
54
+
55
+ def _set_runtime_arg! ct_arg
56
+ if ct_arg.position
57
+ _store_at! rt_args.shift, ct_arg.position # This is the culprit
58
+ else
59
+ _store_into_next(rt_args.shift) # Oops I did it again
60
+ end
61
+ end
62
+
63
+ def _store_at!(value, pos=nil)
64
+ pos ||= @pos
65
+ raise DuplicatePositionSpecification, "There is already a curried value #{@final[pos].inspect} at position #{pos}, attempting to override with #{value.inspect}" if
66
+ @final.has_key?(pos)
67
+ @final[pos] = value
68
+ end
69
+
70
+ def _store_into_next(value)
71
+ while @final.has_key?(@pos)
72
+ @pos += 1
73
+ end
74
+ _store_at! value
75
+ end
76
+ end
77
+ end
78
+ end
@@ -0,0 +1,18 @@
1
+ module Lab42
2
+ module Curry
3
+ class CompiletimeArgs
4
+ include Enumerable
5
+
6
+ attr_reader :positions
7
+
8
+ def each
9
+ positions.each { yield _1 }
10
+ end
11
+
12
+ private
13
+ def initialize positions
14
+ @positions = positions
15
+ end
16
+ end
17
+ end
18
+ end
@@ -0,0 +1,33 @@
1
+ require_relative 'arg_compiler'
2
+
3
+ module Lab42
4
+ module Curry
5
+ class Data
6
+ attr_reader :context, :ct_args, :curried
7
+
8
+ private
9
+ def initialize(ctxt, method_or_name, *curry_time_args, &blk)
10
+ @context = ctxt
11
+ @ct_args = curry_time_args
12
+
13
+ @mthd =
14
+ case method_or_name
15
+ when Symbol
16
+ context.method(method_or_name)
17
+ else
18
+ method_or_name
19
+ end
20
+ _curry(&blk)
21
+ end
22
+
23
+ def _compile_final_args(rt_args)
24
+ arg_compiler = ArgCompiler.new(ct_args: ct_args, rt_args: rt_args)
25
+ arg_compiler.compile_args
26
+ end
27
+
28
+ def _curry(&blk)
29
+ @curried = ->(*rt_args) { @mthd.(*_compile_final_args(rt_args)) }
30
+ end
31
+ end
32
+ end
33
+ end
@@ -0,0 +1,5 @@
1
+ module Lab42
2
+ module Curry
3
+ DuplicatePositionSpecification = Class.new RuntimeError
4
+ end
5
+ end
@@ -0,0 +1,12 @@
1
+ module Lab42
2
+ module Curry
3
+ class RuntimeArg
4
+ attr_reader :position
5
+
6
+ private
7
+ def initialize(position = nil)
8
+ @position = position
9
+ end
10
+ end
11
+ end
12
+ end
@@ -0,0 +1,5 @@
1
+ module Lab42
2
+ module Curry
3
+ VERSION = "0.1.0"
4
+ end
5
+ end
metadata ADDED
@@ -0,0 +1,94 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: lab42_curry
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Robert Dober
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2020-12-26 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: pry
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: 0.13.1
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: 0.13.1
27
+ - !ruby/object:Gem::Dependency
28
+ name: pry-byebug
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '3.9'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '3.9'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rspec
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '3.10'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '3.10'
55
+ description: Curry functions and methods at will, reorder, define placeholders anywhere,
56
+ positional and named args
57
+ email: robert.dober@gmail.com
58
+ executables: []
59
+ extensions: []
60
+ extra_rdoc_files: []
61
+ files:
62
+ - LICENSE
63
+ - README.md
64
+ - lib/lab42/curry.rb
65
+ - lib/lab42/curry/arg_compiler.rb
66
+ - lib/lab42/curry/compiletime_args.rb
67
+ - lib/lab42/curry/data.rb
68
+ - lib/lab42/curry/errors.rb
69
+ - lib/lab42/curry/runtime_arg.rb
70
+ - lib/lab42/curry/version.rb
71
+ homepage: https://github.com/robertdober/lab42_curry
72
+ licenses:
73
+ - Apache-2.0
74
+ metadata: {}
75
+ post_install_message:
76
+ rdoc_options: []
77
+ require_paths:
78
+ - lib
79
+ required_ruby_version: !ruby/object:Gem::Requirement
80
+ requirements:
81
+ - - ">="
82
+ - !ruby/object:Gem::Version
83
+ version: 3.0.0
84
+ required_rubygems_version: !ruby/object:Gem::Requirement
85
+ requirements:
86
+ - - ">="
87
+ - !ruby/object:Gem::Version
88
+ version: '0'
89
+ requirements: []
90
+ rubygems_version: 3.2.3
91
+ signing_key:
92
+ specification_version: 4
93
+ summary: Name says it all, curry at will
94
+ test_files: []