autostruct 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +9 -0
- data/.rspec +2 -0
- data/.travis.yml +4 -0
- data/CODE_OF_CONDUCT.md +49 -0
- data/Gemfile +3 -0
- data/LICENSE.txt +21 -0
- data/README.md +120 -0
- data/autostruct.gemspec +28 -0
- data/bin/setup +8 -0
- data/lib/autostruct.rb +1 -0
- data/lib/autostruct/class.rb +11 -0
- data/lib/autostruct/mixin.rb +17 -0
- data/lib/autostruct/receive.rb +17 -0
- data/lib/autostruct/version.rb +9 -0
- data/lib/autostruct/wrap.rb +18 -0
- data/rakefile.rb +6 -0
- metadata +103 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: e33a79c4b3cbf97106b89f4df550b8a015b864b1
|
4
|
+
data.tar.gz: 959b533815fd9259b76a13508c5ce82e226275e4
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: bb611220ffe8eea12a51a3741a5691c13d2697bf15f7dee36b8d86cd54b7224e16cae349c1ca64563fcfad7876c8f80d51ebc4344240316e48f47f3cd2bea4bb
|
7
|
+
data.tar.gz: f84f3c18cdcb2b8f2cc352f427da8494a81f0c78d8302c628c1159255778a136ad2dee0dca5b351f95525e5a2934d5cd114abb648c2560aefe72202e6e140153
|
data/.gitignore
ADDED
data/.rspec
ADDED
data/.travis.yml
ADDED
data/CODE_OF_CONDUCT.md
ADDED
@@ -0,0 +1,49 @@
|
|
1
|
+
# Contributor Code of Conduct
|
2
|
+
|
3
|
+
As contributors and maintainers of this project, and in the interest of
|
4
|
+
fostering an open and welcoming community, we pledge to respect all people who
|
5
|
+
contribute through reporting issues, posting feature requests, updating
|
6
|
+
documentation, submitting pull requests or patches, and other activities.
|
7
|
+
|
8
|
+
We are committed to making participation in this project a harassment-free
|
9
|
+
experience for everyone, regardless of level of experience, gender, gender
|
10
|
+
identity and expression, sexual orientation, disability, personal appearance,
|
11
|
+
body size, race, ethnicity, age, religion, or nationality.
|
12
|
+
|
13
|
+
Examples of unacceptable behavior by participants include:
|
14
|
+
|
15
|
+
* The use of sexualized language or imagery
|
16
|
+
* Personal attacks
|
17
|
+
* Trolling or insulting/derogatory comments
|
18
|
+
* Public or private harassment
|
19
|
+
* Publishing other's private information, such as physical or electronic
|
20
|
+
addresses, without explicit permission
|
21
|
+
* Other unethical or unprofessional conduct
|
22
|
+
|
23
|
+
Project maintainers have the right and responsibility to remove, edit, or
|
24
|
+
reject comments, commits, code, wiki edits, issues, and other contributions
|
25
|
+
that are not aligned to this Code of Conduct, or to ban temporarily or
|
26
|
+
permanently any contributor for other behaviors that they deem inappropriate,
|
27
|
+
threatening, offensive, or harmful.
|
28
|
+
|
29
|
+
By adopting this Code of Conduct, project maintainers commit themselves to
|
30
|
+
fairly and consistently applying these principles to every aspect of managing
|
31
|
+
this project. Project maintainers who do not follow or enforce the Code of
|
32
|
+
Conduct may be permanently removed from the project team.
|
33
|
+
|
34
|
+
This code of conduct applies both within project spaces and in public spaces
|
35
|
+
when an individual is representing the project or its community.
|
36
|
+
|
37
|
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
38
|
+
reported by contacting a project maintainer at joe.g.yates@gmail.com. All
|
39
|
+
complaints will be reviewed and investigated and will result in a response that
|
40
|
+
is deemed necessary and appropriate to the circumstances. Maintainers are
|
41
|
+
obligated to maintain confidentiality with regard to the reporter of an
|
42
|
+
incident.
|
43
|
+
|
44
|
+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
45
|
+
version 1.3.0, available at
|
46
|
+
[http://contributor-covenant.org/version/1/3/0/][version]
|
47
|
+
|
48
|
+
[homepage]: http://contributor-covenant.org
|
49
|
+
[version]: http://contributor-covenant.org/version/1/3/0/
|
data/Gemfile
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
The MIT License (MIT)
|
2
|
+
|
3
|
+
Copyright (c) 2016 Joe Yates
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
7
|
+
in the Software without restriction, including without limitation the rights
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
10
|
+
furnished to do so, subject to the following conditions:
|
11
|
+
|
12
|
+
The above copyright notice and this permission notice shall be included in
|
13
|
+
all copies or substantial portions of the Software.
|
14
|
+
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
21
|
+
THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,120 @@
|
|
1
|
+
# Autostruct
|
2
|
+
|
3
|
+
The aim is reduce the work of defining classes.
|
4
|
+
|
5
|
+
A common repetetive task is receiving parameters, assigning them
|
6
|
+
to instance variables and defining attribute accessors, like this:
|
7
|
+
|
8
|
+
```ruby
|
9
|
+
class Foo
|
10
|
+
attr_reader :bar
|
11
|
+
|
12
|
+
def initialize(bar:)
|
13
|
+
@bar = bar
|
14
|
+
end
|
15
|
+
end
|
16
|
+
|
17
|
+
foo = Foo.new(bar: "Hello")
|
18
|
+
puts foo.bar # => Hello
|
19
|
+
```
|
20
|
+
|
21
|
+
With `Autostruct` you do this:
|
22
|
+
|
23
|
+
```ruby
|
24
|
+
require "autostruct/wrap"
|
25
|
+
|
26
|
+
class Foo
|
27
|
+
def initialize(bar:)
|
28
|
+
end
|
29
|
+
|
30
|
+
include Autostruct::Wrap
|
31
|
+
end
|
32
|
+
|
33
|
+
foo = Foo.new(bar: "Hello")
|
34
|
+
puts foo.bar # => Hello
|
35
|
+
```
|
36
|
+
|
37
|
+
# Installation
|
38
|
+
|
39
|
+
Add this line to your application's Gemfile:
|
40
|
+
|
41
|
+
```ruby
|
42
|
+
gem 'autostruct'
|
43
|
+
```
|
44
|
+
|
45
|
+
And then execute:
|
46
|
+
|
47
|
+
$ bundle
|
48
|
+
|
49
|
+
Or install it yourself as:
|
50
|
+
|
51
|
+
$ gem install autostruct
|
52
|
+
|
53
|
+
# Usage
|
54
|
+
|
55
|
+
There are 3 ways of using Autostruct.
|
56
|
+
|
57
|
+
## Autostruct::Wrapper
|
58
|
+
|
59
|
+
```ruby
|
60
|
+
require "autostruct/wrap"
|
61
|
+
|
62
|
+
class Foo
|
63
|
+
def initialize(bar:, baz:)
|
64
|
+
end
|
65
|
+
|
66
|
+
include Autostruct::Wrap
|
67
|
+
end
|
68
|
+
```
|
69
|
+
|
70
|
+
Just do the `include` *after* defining `initialize`.
|
71
|
+
|
72
|
+
## Autostruct::Mixin
|
73
|
+
|
74
|
+
```ruby
|
75
|
+
require "autostruct/mixin"
|
76
|
+
|
77
|
+
class Foo
|
78
|
+
include Autostruct::Mixin
|
79
|
+
|
80
|
+
def initialize(bar:, baz:)
|
81
|
+
autostruct! binding
|
82
|
+
end
|
83
|
+
end
|
84
|
+
```
|
85
|
+
|
86
|
+
## Autostruct::Class
|
87
|
+
|
88
|
+
```ruby
|
89
|
+
require "autostruct/class"
|
90
|
+
|
91
|
+
class Foo < Autostruct::Class
|
92
|
+
def initialize(bar:, baz:)
|
93
|
+
super
|
94
|
+
end
|
95
|
+
end
|
96
|
+
```
|
97
|
+
|
98
|
+
# Development
|
99
|
+
|
100
|
+
After checking out the repo, run `bin/setup` to install dependencies.
|
101
|
+
Then, run `rake spec` to run the tests. You can also run `bin/console` for an
|
102
|
+
interactive prompt that will allow you to experiment.
|
103
|
+
|
104
|
+
To install this gem onto your local machine, run `bundle exec rake install`.
|
105
|
+
To release a new version, update the version number in `version.rb`, and then
|
106
|
+
run `bundle exec rake release`, which will create a git tag for the version,
|
107
|
+
push git commits and tags, and push the `.gem` file to
|
108
|
+
[rubygems.org](https://rubygems.org).
|
109
|
+
|
110
|
+
# Contributing
|
111
|
+
|
112
|
+
Bug reports and pull requests are welcome on GitHub at
|
113
|
+
https://github.com/joeyates/autostruct. This project is intended to be a safe,
|
114
|
+
welcoming space for collaboration, and contributors are expected to adhere to
|
115
|
+
the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
|
116
|
+
|
117
|
+
# License
|
118
|
+
|
119
|
+
The gem is available as open source under the terms of the
|
120
|
+
[MIT License](http://opensource.org/licenses/MIT).
|
data/autostruct.gemspec
ADDED
@@ -0,0 +1,28 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
lib = File.expand_path("../lib", __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require "autostruct/version"
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = "autostruct"
|
8
|
+
spec.version = Autostruct::Version::STRING
|
9
|
+
spec.authors = ["Joe Yates"]
|
10
|
+
spec.email = ["joe.g.yates@gmail.com"]
|
11
|
+
|
12
|
+
spec.summary = %q{Turn your constructor arguments into attributes}
|
13
|
+
spec.description = %q{
|
14
|
+
Classes derived from Autostruct do not need to save the arguments
|
15
|
+
to `initialize` as instance variables or set up attribute readers.
|
16
|
+
}
|
17
|
+
spec.homepage = "https://github.com/cantierecreativo/autostruct"
|
18
|
+
spec.license = "MIT"
|
19
|
+
|
20
|
+
spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec)/}) }
|
21
|
+
spec.bindir = "exe"
|
22
|
+
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
|
23
|
+
spec.require_paths = ["lib"]
|
24
|
+
|
25
|
+
spec.add_development_dependency "bundler", "~> 1.11"
|
26
|
+
spec.add_development_dependency "rake", "~> 10.0"
|
27
|
+
spec.add_development_dependency "rspec", "~> 3.0"
|
28
|
+
end
|
data/bin/setup
ADDED
data/lib/autostruct.rb
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
require "autostruct/version"
|
@@ -0,0 +1,17 @@
|
|
1
|
+
require "autostruct/receive"
|
2
|
+
|
3
|
+
module Autostruct
|
4
|
+
module Mixin
|
5
|
+
include Autostruct::Receive
|
6
|
+
|
7
|
+
def autostruct!(caller_binding)
|
8
|
+
m = eval("method(__method__)", caller_binding)
|
9
|
+
|
10
|
+
caller_parameters = m.parameters.each.with_object({}) do |(_t, name), p|
|
11
|
+
p[name.intern] = caller_binding.local_variable_get(name)
|
12
|
+
end
|
13
|
+
|
14
|
+
receive(caller_parameters)
|
15
|
+
end
|
16
|
+
end
|
17
|
+
end
|
@@ -0,0 +1,17 @@
|
|
1
|
+
module Autostruct
|
2
|
+
module Receive
|
3
|
+
def receive(parameters)
|
4
|
+
parameters.each_pair do |attr, value|
|
5
|
+
instance_variable_set("@#{attr}", value)
|
6
|
+
|
7
|
+
define_singleton_method :"#{attr}" do
|
8
|
+
instance_variable_get("@#{attr}")
|
9
|
+
end
|
10
|
+
|
11
|
+
define_singleton_method :"#{attr}=" do |new_value|
|
12
|
+
instance_variable_set("@#{attr}", new_value)
|
13
|
+
end
|
14
|
+
end
|
15
|
+
end
|
16
|
+
end
|
17
|
+
end
|
@@ -0,0 +1,18 @@
|
|
1
|
+
require "autostruct/receive"
|
2
|
+
|
3
|
+
module Autostruct
|
4
|
+
module Wrap
|
5
|
+
include Autostruct::Receive
|
6
|
+
|
7
|
+
def self.included(base)
|
8
|
+
base.send(:alias_method, :initialize_without_autostruct, :initialize)
|
9
|
+
|
10
|
+
base.class_eval do
|
11
|
+
def initialize(parameters = {})
|
12
|
+
receive(parameters)
|
13
|
+
initialize_without_autostruct(parameters)
|
14
|
+
end
|
15
|
+
end
|
16
|
+
end
|
17
|
+
end
|
18
|
+
end
|
data/rakefile.rb
ADDED
metadata
ADDED
@@ -0,0 +1,103 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: autostruct
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Joe Yates
|
8
|
+
autorequire:
|
9
|
+
bindir: exe
|
10
|
+
cert_chain: []
|
11
|
+
date: 2016-11-22 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: '1.11'
|
20
|
+
type: :development
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - "~>"
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '1.11'
|
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
|
+
description: "\n Classes derived from Autostruct do not need to save the arguments\n
|
56
|
+
\ to `initialize` as instance variables or set up attribute readers.\n "
|
57
|
+
email:
|
58
|
+
- joe.g.yates@gmail.com
|
59
|
+
executables: []
|
60
|
+
extensions: []
|
61
|
+
extra_rdoc_files: []
|
62
|
+
files:
|
63
|
+
- ".gitignore"
|
64
|
+
- ".rspec"
|
65
|
+
- ".travis.yml"
|
66
|
+
- CODE_OF_CONDUCT.md
|
67
|
+
- Gemfile
|
68
|
+
- LICENSE.txt
|
69
|
+
- README.md
|
70
|
+
- autostruct.gemspec
|
71
|
+
- bin/setup
|
72
|
+
- lib/autostruct.rb
|
73
|
+
- lib/autostruct/class.rb
|
74
|
+
- lib/autostruct/mixin.rb
|
75
|
+
- lib/autostruct/receive.rb
|
76
|
+
- lib/autostruct/version.rb
|
77
|
+
- lib/autostruct/wrap.rb
|
78
|
+
- rakefile.rb
|
79
|
+
homepage: https://github.com/cantierecreativo/autostruct
|
80
|
+
licenses:
|
81
|
+
- MIT
|
82
|
+
metadata: {}
|
83
|
+
post_install_message:
|
84
|
+
rdoc_options: []
|
85
|
+
require_paths:
|
86
|
+
- lib
|
87
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
88
|
+
requirements:
|
89
|
+
- - ">="
|
90
|
+
- !ruby/object:Gem::Version
|
91
|
+
version: '0'
|
92
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
93
|
+
requirements:
|
94
|
+
- - ">="
|
95
|
+
- !ruby/object:Gem::Version
|
96
|
+
version: '0'
|
97
|
+
requirements: []
|
98
|
+
rubyforge_project:
|
99
|
+
rubygems_version: 2.5.1
|
100
|
+
signing_key:
|
101
|
+
specification_version: 4
|
102
|
+
summary: Turn your constructor arguments into attributes
|
103
|
+
test_files: []
|