portrayal 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 9d9235eae25e3e88f554e43a68d163d24e7213bfb8830b256ffd6a12968ca7e2
4
+ data.tar.gz: 930a8eeaa04ce976cf1b387abf9b3c6775af9abf90b7b59ec8ff74af68fe7ff2
5
+ SHA512:
6
+ metadata.gz: e5ef351e415ba810039a9f4cb2a77f29dd088a8bd98322123fc3f534d16004faf2c9fbefd51fe8799949c91045fd3494c7dccf64c0e90f4b9cf617fb1e9e2f90
7
+ data.tar.gz: 36583d990b87b84d5fc8b2f7f149f047a7f1c2b1e11c9b651a91ca240266a9af11c3c36331d9eaebd9a4f2acbd0800f77a478d729275d62b585c09cd3211eca7
data/.gitignore ADDED
@@ -0,0 +1,11 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /_yardoc/
4
+ /coverage/
5
+ /doc/
6
+ /pkg/
7
+ /spec/reports/
8
+ /tmp/
9
+
10
+ # rspec failure tracking
11
+ .rspec_status
data/.rspec ADDED
@@ -0,0 +1,3 @@
1
+ --format documentation
2
+ --color
3
+ --require spec_helper
data/.travis.yml ADDED
@@ -0,0 +1,10 @@
1
+ ---
2
+ sudo: false
3
+ language: ruby
4
+ cache: bundler
5
+ rvm:
6
+ - 2.3
7
+ - 2.4
8
+ - 2.5
9
+ - 2.6
10
+ before_install: gem install bundler -v 2.0.1
@@ -0,0 +1,74 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ In the interest of fostering an open and welcoming environment, we as
6
+ contributors and maintainers pledge to making participation in our project and
7
+ our community a harassment-free experience for everyone, regardless of age, body
8
+ size, disability, ethnicity, gender identity and expression, level of experience,
9
+ nationality, personal appearance, race, religion, or sexual identity and
10
+ orientation.
11
+
12
+ ## Our Standards
13
+
14
+ Examples of behavior that contributes to creating a positive environment
15
+ include:
16
+
17
+ * Using welcoming and inclusive language
18
+ * Being respectful of differing viewpoints and experiences
19
+ * Gracefully accepting constructive criticism
20
+ * Focusing on what is best for the community
21
+ * Showing empathy towards other community members
22
+
23
+ Examples of unacceptable behavior by participants include:
24
+
25
+ * The use of sexualized language or imagery and unwelcome sexual attention or
26
+ advances
27
+ * Trolling, insulting/derogatory comments, and personal or political attacks
28
+ * Public or private harassment
29
+ * Publishing others' private information, such as a physical or electronic
30
+ address, without explicit permission
31
+ * Other conduct which could reasonably be considered inappropriate in a
32
+ professional setting
33
+
34
+ ## Our Responsibilities
35
+
36
+ Project maintainers are responsible for clarifying the standards of acceptable
37
+ behavior and are expected to take appropriate and fair corrective action in
38
+ response to any instances of unacceptable behavior.
39
+
40
+ Project maintainers have the right and responsibility to remove, edit, or
41
+ reject comments, commits, code, wiki edits, issues, and other contributions
42
+ that are not aligned to this Code of Conduct, or to ban temporarily or
43
+ permanently any contributor for other behaviors that they deem inappropriate,
44
+ threatening, offensive, or harmful.
45
+
46
+ ## Scope
47
+
48
+ This Code of Conduct applies both within project spaces and in public spaces
49
+ when an individual is representing the project or its community. Examples of
50
+ representing a project or community include using an official project e-mail
51
+ address, posting via an official social media account, or acting as an appointed
52
+ representative at an online or offline event. Representation of a project may be
53
+ further defined and clarified by project maintainers.
54
+
55
+ ## Enforcement
56
+
57
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
58
+ reported by contacting the project team at madfancier@gmail.com. All
59
+ complaints will be reviewed and investigated and will result in a response that
60
+ is deemed necessary and appropriate to the circumstances. The project team is
61
+ obligated to maintain confidentiality with regard to the reporter of an incident.
62
+ Further details of specific enforcement policies may be posted separately.
63
+
64
+ Project maintainers who do not follow or enforce the Code of Conduct in good
65
+ faith may face temporary or permanent repercussions as determined by other
66
+ members of the project's leadership.
67
+
68
+ ## Attribution
69
+
70
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71
+ available at [http://contributor-covenant.org/version/1/4][version]
72
+
73
+ [homepage]: http://contributor-covenant.org
74
+ [version]: http://contributor-covenant.org/version/1/4/
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in portrayal.gemspec
4
+ gemspec
data/Gemfile.lock ADDED
@@ -0,0 +1,41 @@
1
+ PATH
2
+ remote: .
3
+ specs:
4
+ portrayal (0.1.0)
5
+
6
+ GEM
7
+ remote: https://rubygems.org/
8
+ specs:
9
+ coderay (1.1.2)
10
+ diff-lcs (1.3)
11
+ method_source (0.9.2)
12
+ pry (0.12.2)
13
+ coderay (~> 1.1.0)
14
+ method_source (~> 0.9.0)
15
+ rake (10.5.0)
16
+ rspec (3.8.0)
17
+ rspec-core (~> 3.8.0)
18
+ rspec-expectations (~> 3.8.0)
19
+ rspec-mocks (~> 3.8.0)
20
+ rspec-core (3.8.0)
21
+ rspec-support (~> 3.8.0)
22
+ rspec-expectations (3.8.3)
23
+ diff-lcs (>= 1.2.0, < 2.0)
24
+ rspec-support (~> 3.8.0)
25
+ rspec-mocks (3.8.0)
26
+ diff-lcs (>= 1.2.0, < 2.0)
27
+ rspec-support (~> 3.8.0)
28
+ rspec-support (3.8.0)
29
+
30
+ PLATFORMS
31
+ ruby
32
+
33
+ DEPENDENCIES
34
+ bundler (~> 2.0)
35
+ portrayal!
36
+ pry (~> 0.12)
37
+ rake (~> 10.0)
38
+ rspec (~> 3.0)
39
+
40
+ BUNDLED WITH
41
+ 2.0.1
data/LICENSE.txt ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
data/README.md ADDED
@@ -0,0 +1,258 @@
1
+ # Portrayal
2
+
3
+ Inspired by:
4
+
5
+ - Andrew Kozin's [dry-initializer](https://github.com/dry-rb/dry-initializer)
6
+ - Piotr Solnica's [virtus](https://github.com/solnic/virtus)
7
+ - Everything [Michel Martens](https://github.com/soveran)
8
+
9
+ Portrayal is a minimalist gem (~120 loc, no dependencies) for building struct-like classes. It provides a small yet powerful step up from plain ruby with its one and only `keyword` method.
10
+
11
+ ```ruby
12
+ class Person < MySuperClass
13
+ extend Portrayal
14
+
15
+ keyword :name
16
+ keyword :age, optional: true
17
+ keyword :favorite_fruit, default: -> { 'feijoa' }
18
+
19
+ keyword :address do
20
+ keyword :street
21
+ keyword :city
22
+
23
+ def text
24
+ "#{street}, #{city}"
25
+ end
26
+ end
27
+ end
28
+ ```
29
+
30
+ When you call `keyword`:
31
+
32
+ * It defines an `attr_reader`
33
+ * It defines `initialize`
34
+ * It defines `==` and `eql?`
35
+ * It creates a nested class when you supply a block
36
+ * It inherits parent's superclass when creating a nested class
37
+
38
+ The code above produces almost exactly the following ruby. There's a lot of boilerplate here we didn't have to type.
39
+
40
+ ```ruby
41
+ class Person < MySuperClass
42
+ attr_reader :name, :age, :favorite_fruit, :address
43
+
44
+ def initialize(name:, age: nil, favorite_fruit: -> { 'feijoa' }.call, address:)
45
+ @name = name
46
+ @age = age
47
+ @favorite_fruit = favorite_fruit
48
+ @address = address
49
+ end
50
+
51
+ def ==(other)
52
+ self.class == other.class &&
53
+ { name: name, age: age, favorite_fruit: favorite_fruit, address: address } ==
54
+ { name: other.name, age: other.age, favorite_fruit: other.favorite_fruit, address: other.address }
55
+ end
56
+
57
+ alias eql? ==
58
+
59
+ class Address < MySuperClass
60
+ attr_reader :street, :city
61
+
62
+ def initialize(street:, city:)
63
+ @street = street
64
+ @city = city
65
+ end
66
+
67
+ def text
68
+ "#{street}, #{city}"
69
+ end
70
+
71
+ def ==(other)
72
+ self.class == other.class &&
73
+ { street: street, city: city } == { street: other.street, city: other.city }
74
+ end
75
+
76
+ alias eql? ==
77
+ end
78
+ end
79
+ ```
80
+
81
+ ## Installation
82
+
83
+ Add this line to your application's Gemfile:
84
+
85
+ ```ruby
86
+ gem 'portrayal'
87
+ ```
88
+
89
+ And then execute:
90
+
91
+ $ bundle
92
+
93
+ Or install it yourself as:
94
+
95
+ $ gem install portrayal
96
+
97
+ ## Usage
98
+
99
+ The recommended way of using this gem is to build your own superclass extended with Portrayal. For example, if you're in Rails, you could do something like this:
100
+
101
+ ```ruby
102
+ class ApplicationStruct
103
+ include ActiveModel::Model
104
+ extend Portrayal
105
+ end
106
+ ```
107
+
108
+ Now you can inherit it when building domain objects.
109
+
110
+ ```ruby
111
+ class Address < ApplicationStruct
112
+ keyword :street
113
+ keyword :city
114
+ keyword :postcode
115
+ keyword :country, optional: true
116
+ end
117
+ ```
118
+
119
+ Possible use cases for these objects include, but are not limited to:
120
+
121
+ - Decorator/presenter objects
122
+ - Tableless models
123
+ - Objects serializable for 3rd party APIs
124
+ - Objects serializable for React components
125
+
126
+ ### Schema
127
+
128
+ Every class that has at least one keyword defined in it automatically receives a class method called `portrayal`. This method is a schema of your object with some additional helpers.
129
+
130
+ #### `portrayal.keywords`
131
+
132
+ Get all keyword names.
133
+
134
+ ```ruby
135
+ Address.portrayal.keywords # => [:street, :city, :postcode, :country]
136
+ ```
137
+
138
+ #### `portrayal.attributes`
139
+
140
+ Get all names + values as a hash.
141
+
142
+ ```ruby
143
+ address = Address.new(street: '34th st', city: 'NYC', postcode: '10001', country: 'USA')
144
+ Address.portrayal.attributes(address) # => {street: '34th st', city: 'NYC', postcode: '10001', country: 'USA'}
145
+ ```
146
+
147
+ #### `portrayal.schema`
148
+
149
+ Get everything portrayal knows about your keywords in one hash.
150
+
151
+ ```ruby
152
+ Address.portrayal.schema # => {:street=>{:optional=>false, :default=>nil}, :city=>{:optional=>false, :default=>nil}, :postcode=>{:optional=>false, :default=>nil}, :country=>{:optional=>true, :default=>#<Proc>}}
153
+ ```
154
+
155
+ ## Philosophy
156
+
157
+ Portrayal steps back from things like type enforcement, coercion, and writer methods in favor of read-only structs, and good old constructors.
158
+
159
+ #### Good Constructors
160
+
161
+ The fact that we keep these portrayal structs read-only (nothing stops you from adding writers, but I will personally frown upon you), all of the responsibility of building them shifts into constructors. This is a good thing, because good constructors clearly define their dependencies, as well as giving us ample room for performing coercion.
162
+
163
+ ```ruby
164
+ class Address < ApplicationStruct
165
+ class << self
166
+ def from_form(params)
167
+ new \
168
+ street: params[:street].to_s,
169
+ city: params[:city].to_s,
170
+ postcode: params[:postcode].to_i,
171
+ country: params[:country] || 'USA'
172
+ end
173
+
174
+ def from_some_service_api_object(object)
175
+ new \
176
+ street: "#{object.houseNumber} #{object.streetName}",
177
+ city: object.city,
178
+ postcode: object.zipCode,
179
+ counry: object.countryName != '' ? object.countryName : 'USA'
180
+ end
181
+ end
182
+
183
+ keyword :street
184
+ keyword :city
185
+ keyword :postcode
186
+ keyword :country, optional: true
187
+ end
188
+ ```
189
+
190
+ Good constructors can also depend on one another to successively break down dependnecies into essential parts. This is similar to how in functional languages one can use recursion and pattern matching.
191
+
192
+ ```ruby
193
+ class Email < ApplicationStruct
194
+ class << self
195
+ def from_publishing_service_json(json)
196
+ subject, header, body, footer = *JSON.parse(json)
197
+ from_parts(subject: subject, header: header, body: body, footer: footer)
198
+ end
199
+
200
+ def from_parts(subject:, header:, body:, footer:)
201
+ new(subject: subject, body: "#{header}#{body}#{footer}")
202
+ end
203
+ end
204
+
205
+ keyword :subject
206
+ keyword :body
207
+ end
208
+ ```
209
+
210
+ If these contructors need more space to grow in complexity, they can be extracted into their own files.
211
+
212
+ ```
213
+ address/
214
+ from_form_constructor.rb
215
+ address.rb
216
+ ```
217
+
218
+ ```ruby
219
+ class Address < ApplicationStruct
220
+ class << self
221
+ def from_form(params)
222
+ self::FromFormConstructor.new(params).call
223
+ end
224
+ end
225
+
226
+ keyword :street
227
+ keyword :city
228
+ keyword :postcode
229
+ keyword :country, optional: true
230
+ end
231
+ ```
232
+
233
+ #### No Reinventing The Wheel
234
+
235
+ Portrayal leans on Ruby to take care of enforcing required keyword arguments, and setting keyword argument defaults. It actually generates standard ruby keyword arguments for you behind the scenes. You can even see the code by checking `YourClass.portrayal.definition_of_initialize`.
236
+
237
+ ```irb
238
+ Address.portrayal.definition_of_initialize
239
+ => "def initialize(street:,city:,postcode:,country: self.class.portrayal.call_default(:country)); @street = street; @city = city; @postcode = postcode; @country = country end"
240
+ ```
241
+
242
+ ## Development
243
+
244
+ After checking out the repo, run `bin/setup` to install dependencies. Then, run `rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
245
+
246
+ 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).
247
+
248
+ ## Contributing
249
+
250
+ Bug reports and pull requests are welcome on GitHub at https://github.com/scottscheapflights/portrayal. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
251
+
252
+ ## License
253
+
254
+ The gem is available as open source under the terms of the [Apache License Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.txt).
255
+
256
+ ## Code of Conduct
257
+
258
+ Everyone interacting in the Portrayal project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/scottscheapflights/portrayal/blob/master/CODE_OF_CONDUCT.md).
data/Rakefile ADDED
@@ -0,0 +1,6 @@
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task :default => :spec
data/bin/console ADDED
@@ -0,0 +1,6 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require 'bundler/setup'
4
+ require 'portrayal'
5
+ require 'pry'
6
+ Pry.start
data/bin/setup ADDED
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
data/lib/portrayal.rb ADDED
@@ -0,0 +1,27 @@
1
+ require 'portrayal/version'
2
+ require 'portrayal/schema'
3
+
4
+ module Portrayal
5
+ def keyword(name, optional: Schema::NULL, default: Schema::NULL, &block)
6
+ unless respond_to?(:portrayal)
7
+ class << self; attr_reader :portrayal end
8
+ @portrayal = Schema.new
9
+ end
10
+
11
+ attr_reader name
12
+
13
+ portrayal.add_keyword(name, optional, default)
14
+ class_eval(portrayal.definition_of_initialize)
15
+
16
+ unless portrayal.equality_defined?
17
+ class_eval(portrayal.definition_of_equality)
18
+ portrayal.mark_equality_defined
19
+ end
20
+
21
+ if block_given?
22
+ keyword_class = Class.new(superclass) { extend Portrayal }
23
+ keyword_class.class_eval(&block)
24
+ const_set(portrayal.camelcase(name), keyword_class)
25
+ end
26
+ end
27
+ end
@@ -0,0 +1,90 @@
1
+ module Portrayal
2
+ class Schema
3
+ NULL = :_portrayal_value_not_set
4
+
5
+ attr_reader :schema
6
+
7
+ def initialize
8
+ @schema = {}
9
+ @equality_defined = false
10
+ end
11
+
12
+ def [](name)
13
+ @schema[name]
14
+ end
15
+
16
+ def keywords
17
+ @schema.keys
18
+ end
19
+
20
+ def attributes(object)
21
+ Hash[
22
+ object.class.portrayal.keywords.map { |key| [key, object.send(key)] }
23
+ ]
24
+ end
25
+
26
+ def add_keyword(name, optional, default)
27
+ optional, default =
28
+ if optional == NULL && default == NULL
29
+ [false, nil]
30
+ elsif optional != NULL && default == NULL
31
+ [optional, optional ? -> { nil } : nil]
32
+ elsif optional == NULL && default != NULL
33
+ [true, default]
34
+ else
35
+ [optional, optional ? default : nil]
36
+ end
37
+
38
+ @schema[name.to_sym] = { optional: optional, default: default }
39
+ end
40
+
41
+ def camelcase(string)
42
+ string.to_s.gsub(/(?:^|_+)([^_])/) { $1.upcase }
43
+ end
44
+
45
+ def call_default(name)
46
+ @schema[name][:default].call
47
+ end
48
+
49
+ def definition_of_initialize
50
+ init_args =
51
+ @schema
52
+ .map { |name, config|
53
+ if config[:optional]
54
+ "#{name}: self.class.portrayal.call_default(:#{name})"
55
+ else
56
+ "#{name}:"
57
+ end
58
+ }
59
+ .join(',')
60
+
61
+ init_assignments =
62
+ @schema
63
+ .keys
64
+ .map { |name| "@#{name} = #{name}" }
65
+ .join('; ')
66
+
67
+ "def initialize(#{init_args}); #{init_assignments} end"
68
+ end
69
+
70
+ def definition_of_equality
71
+ <<-RUBY
72
+ def ==(other)
73
+ self.class == other.class &&
74
+ self.class.portrayal.attributes(self) ==
75
+ self.class.portrayal.attributes(other)
76
+ end
77
+
78
+ alias eql? ==
79
+ RUBY
80
+ end
81
+
82
+ def equality_defined?
83
+ @equality_defined
84
+ end
85
+
86
+ def mark_equality_defined
87
+ @equality_defined = true
88
+ end
89
+ end
90
+ end
@@ -0,0 +1,3 @@
1
+ module Portrayal
2
+ VERSION = "0.1.0"
3
+ end
data/portrayal.gemspec ADDED
@@ -0,0 +1,25 @@
1
+ lib = File.expand_path('../lib', __FILE__)
2
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
3
+ require 'portrayal/version'
4
+
5
+ Gem::Specification.new do |spec|
6
+ spec.name = 'portrayal'
7
+ spec.version = Portrayal::VERSION
8
+ spec.authors = ['Maxim Chernyak']
9
+ spec.email = ['madfancier@gmail.com']
10
+
11
+ spec.summary = 'A minimal builder for struct-like classes'
12
+ spec.description = 'Inspired by dry-initializer and virtus, portrayal is a minimalist gem (~120 loc, no dependencies) that takes a somewhat different approach to building struct-like classes. It steps away from types, coersion, and writer methods in favor of encouraging well-designed constructors. Read more in the Philosophy section of the README.'
13
+ spec.homepage = 'https://github.com/scottscheapflights/portrayal'
14
+ spec.license = 'Apache-2.0'
15
+
16
+ spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
17
+ `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^spec/}) }
18
+ end
19
+ spec.require_paths = ['lib']
20
+
21
+ spec.add_development_dependency 'bundler', '~> 2.0'
22
+ spec.add_development_dependency 'rake', '~> 10.0'
23
+ spec.add_development_dependency 'rspec', '~> 3.0'
24
+ spec.add_development_dependency 'pry', '~> 0.12'
25
+ end
metadata ADDED
@@ -0,0 +1,118 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: portrayal
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Maxim Chernyak
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2019-06-08 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '2.0'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '2.0'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '10.0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '10.0'
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.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '3.0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: pry
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '0.12'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '0.12'
69
+ description: Inspired by dry-initializer and virtus, portrayal is a minimalist gem
70
+ (~120 loc, no dependencies) that takes a somewhat different approach to building
71
+ struct-like classes. It steps away from types, coersion, and writer methods in favor
72
+ of encouraging well-designed constructors. Read more in the Philosophy section of
73
+ the README.
74
+ email:
75
+ - madfancier@gmail.com
76
+ executables: []
77
+ extensions: []
78
+ extra_rdoc_files: []
79
+ files:
80
+ - ".gitignore"
81
+ - ".rspec"
82
+ - ".travis.yml"
83
+ - CODE_OF_CONDUCT.md
84
+ - Gemfile
85
+ - Gemfile.lock
86
+ - LICENSE.txt
87
+ - README.md
88
+ - Rakefile
89
+ - bin/console
90
+ - bin/setup
91
+ - lib/portrayal.rb
92
+ - lib/portrayal/schema.rb
93
+ - lib/portrayal/version.rb
94
+ - portrayal.gemspec
95
+ homepage: https://github.com/scottscheapflights/portrayal
96
+ licenses:
97
+ - Apache-2.0
98
+ metadata: {}
99
+ post_install_message:
100
+ rdoc_options: []
101
+ require_paths:
102
+ - lib
103
+ required_ruby_version: !ruby/object:Gem::Requirement
104
+ requirements:
105
+ - - ">="
106
+ - !ruby/object:Gem::Version
107
+ version: '0'
108
+ required_rubygems_version: !ruby/object:Gem::Requirement
109
+ requirements:
110
+ - - ">="
111
+ - !ruby/object:Gem::Version
112
+ version: '0'
113
+ requirements: []
114
+ rubygems_version: 3.0.3
115
+ signing_key:
116
+ specification_version: 4
117
+ summary: A minimal builder for struct-like classes
118
+ test_files: []