manioc 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 +10 -0
- data/.rspec +2 -0
- data/.travis.yml +5 -0
- data/CODE_OF_CONDUCT.md +49 -0
- data/Gemfile +5 -0
- data/LICENSE.txt +21 -0
- data/README.md +61 -0
- data/Rakefile +6 -0
- data/bin/console +14 -0
- data/bin/setup +8 -0
- data/gestalt.gemspec +26 -0
- data/lib/gestalt.rb +6 -0
- data/lib/manioc/container.rb +52 -0
- data/lib/manioc/struct.rb +63 -0
- data/lib/manioc/version.rb +3 -0
- metadata +115 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 8c87de94592cf22d22b312453ed5509cd6630527
|
4
|
+
data.tar.gz: a7f630aa43f8ec8ddf5aaa9ab2f1e9d9bfd3c061
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 4afa74e1dd0cb3ae9637cb63888ffa57a711d650fe0a623f48560d1d7c27c03a81d9e41a88fcbcfcffca170b5555a903d33cb29b287e0622356de2c5cb416220
|
7
|
+
data.tar.gz: 5e1f678bbebd20d78a982c101697e6fa03eacf97f200a67c954f10cfc0e439a172e75ec733dd2a4d2ed39d29cb850c094b6d1036d956f54b676c3add5653cbb5
|
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 jamesdabbs@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 James Dabbs
|
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,61 @@
|
|
1
|
+
# Manioc
|
2
|
+
|
3
|
+
Manioc exposes two main utility classes: `Struct` and `Container`.
|
4
|
+
|
5
|
+
A struct is a simple stateless object with transparently inverted dependencies:
|
6
|
+
|
7
|
+
```ruby
|
8
|
+
class Service < Manioc[:http, :logger]
|
9
|
+
def call url
|
10
|
+
response = http.get url
|
11
|
+
logger.info "#{url}: #{response}"
|
12
|
+
end
|
13
|
+
end
|
14
|
+
|
15
|
+
real = Service.new(http: HTTP::Client.new, logger: Logger.new)
|
16
|
+
fake = Service.new(http: double('http'), logger: double('logger'))
|
17
|
+
|
18
|
+
[real, fake].sample.call('http://google.com')
|
19
|
+
```
|
20
|
+
|
21
|
+
A container makes it easy to declare and customize the interdependencies between various structs:
|
22
|
+
|
23
|
+
```ruby
|
24
|
+
dev = Manioc::Container.new do
|
25
|
+
http { HTTP::Client.new }
|
26
|
+
logger { Logger.new STDOUT }
|
27
|
+
error_handler { ->(e) { logger.error e } }
|
28
|
+
end
|
29
|
+
|
30
|
+
test = dev.with do
|
31
|
+
http { instance_double HTTP::Client }
|
32
|
+
end
|
33
|
+
|
34
|
+
prod = dev.with do
|
35
|
+
error_handler { ->(e) { Rollbar.error e } }
|
36
|
+
end
|
37
|
+
```
|
38
|
+
|
39
|
+
## Installation
|
40
|
+
|
41
|
+
Add this line to your application's Gemfile:
|
42
|
+
|
43
|
+
```ruby
|
44
|
+
gem 'manioc'
|
45
|
+
```
|
46
|
+
|
47
|
+
## Development
|
48
|
+
|
49
|
+
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
|
50
|
+
|
51
|
+
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).
|
52
|
+
|
53
|
+
## Contributing
|
54
|
+
|
55
|
+
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/manioc. 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.
|
56
|
+
|
57
|
+
|
58
|
+
## License
|
59
|
+
|
60
|
+
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
|
61
|
+
|
data/Rakefile
ADDED
data/bin/console
ADDED
@@ -0,0 +1,14 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
|
3
|
+
require "bundler/setup"
|
4
|
+
require "manioc"
|
5
|
+
|
6
|
+
# You can add fixtures and/or initialization code here to make experimenting
|
7
|
+
# with your gem easier. You can also use a different console, if you like.
|
8
|
+
|
9
|
+
# (If you use this, don't forget to add pry to your Gemfile!)
|
10
|
+
# require "pry"
|
11
|
+
# Pry.start
|
12
|
+
|
13
|
+
require "irb"
|
14
|
+
IRB.start
|
data/bin/setup
ADDED
data/gestalt.gemspec
ADDED
@@ -0,0 +1,26 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require 'manioc/version'
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = "manioc"
|
8
|
+
spec.version = Manioc::VERSION
|
9
|
+
spec.authors = ["James Dabbs"]
|
10
|
+
spec.email = ["jamesdabbs@gmail.com"]
|
11
|
+
|
12
|
+
spec.summary = "Quick-and-dirty functional service objects"
|
13
|
+
spec.description = spec.summary
|
14
|
+
spec.homepage = "https://github.com/jamesdabbs/manioc"
|
15
|
+
spec.license = "MIT"
|
16
|
+
|
17
|
+
spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
|
18
|
+
spec.bindir = "exe"
|
19
|
+
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
|
20
|
+
spec.require_paths = ["lib"]
|
21
|
+
|
22
|
+
spec.add_development_dependency "bundler", "~> 1.12"
|
23
|
+
spec.add_development_dependency "rake", "~> 11.0"
|
24
|
+
spec.add_development_dependency "rspec", "~> 3.0"
|
25
|
+
spec.add_development_dependency "rspec-coverage", "~> 0.1"
|
26
|
+
end
|
data/lib/gestalt.rb
ADDED
@@ -0,0 +1,52 @@
|
|
1
|
+
module Manioc
|
2
|
+
class Container
|
3
|
+
class DSL
|
4
|
+
def initialize &block
|
5
|
+
@fields = {}
|
6
|
+
instance_exec(&block)
|
7
|
+
end
|
8
|
+
|
9
|
+
def to_h
|
10
|
+
@fields
|
11
|
+
end
|
12
|
+
|
13
|
+
def method_missing name, *args, &block
|
14
|
+
return super if args.any?
|
15
|
+
@fields[name] = block
|
16
|
+
end
|
17
|
+
end
|
18
|
+
|
19
|
+
def initialize **constructors, &block
|
20
|
+
@constructors, @instances = constructors, {}
|
21
|
+
|
22
|
+
register(&block) if block
|
23
|
+
finalize
|
24
|
+
end
|
25
|
+
|
26
|
+
def with &block
|
27
|
+
self.class.new @constructors.dup, &block
|
28
|
+
end
|
29
|
+
|
30
|
+
def reset key=nil
|
31
|
+
keys = key ? [key] : @instances.keys
|
32
|
+
keys.each { |k| @instances.delete k }
|
33
|
+
end
|
34
|
+
|
35
|
+
private
|
36
|
+
|
37
|
+
def register &block
|
38
|
+
@constructors.merge! DSL.new(&block).to_h
|
39
|
+
end
|
40
|
+
|
41
|
+
def resolve key
|
42
|
+
@instances[key] ||= instance_exec(&@constructors[key])
|
43
|
+
end
|
44
|
+
|
45
|
+
def finalize
|
46
|
+
@constructors.freeze
|
47
|
+
@constructors.each do |key,_|
|
48
|
+
define_singleton_method(key) { resolve key }
|
49
|
+
end
|
50
|
+
end
|
51
|
+
end
|
52
|
+
end
|
@@ -0,0 +1,63 @@
|
|
1
|
+
module Manioc
|
2
|
+
class << self
|
3
|
+
def [] *fields, **defaults
|
4
|
+
fields = (fields + defaults.keys).uniq
|
5
|
+
|
6
|
+
Class.new Struct do
|
7
|
+
define_singleton_method(:fields ) { fields }
|
8
|
+
define_singleton_method(:defaults) { defaults }
|
9
|
+
|
10
|
+
fields.each do |field|
|
11
|
+
attr_reader field
|
12
|
+
end
|
13
|
+
end
|
14
|
+
end
|
15
|
+
|
16
|
+
def frozen= val
|
17
|
+
@frozen = val
|
18
|
+
end
|
19
|
+
def frozen?
|
20
|
+
@frozen
|
21
|
+
end
|
22
|
+
end
|
23
|
+
self.frozen = true
|
24
|
+
|
25
|
+
class Struct
|
26
|
+
def initialize **fields
|
27
|
+
fields = self.class.defaults.merge fields
|
28
|
+
_validate fields
|
29
|
+
_assign fields
|
30
|
+
freeze if Manioc.frozen?
|
31
|
+
end
|
32
|
+
|
33
|
+
def == other
|
34
|
+
super || to_h == other.to_h
|
35
|
+
end
|
36
|
+
|
37
|
+
def with **fields
|
38
|
+
self.class.new to_h.merge fields
|
39
|
+
end
|
40
|
+
|
41
|
+
def to_h
|
42
|
+
self.class.fields.each_with_object({}) { |field,h| h[field] = public_send field }
|
43
|
+
end
|
44
|
+
|
45
|
+
private
|
46
|
+
|
47
|
+
def _validate fields
|
48
|
+
missing = self.class.fields - fields.keys
|
49
|
+
if missing.any?
|
50
|
+
raise KeyError, "#{self}(#{self.class}) missing fields #{missing}"
|
51
|
+
end
|
52
|
+
|
53
|
+
extra = fields.keys - self.class.fields
|
54
|
+
if extra.any?
|
55
|
+
raise KeyError, "#{self}(#{self.class}) passed extra fields #{extra}"
|
56
|
+
end
|
57
|
+
end
|
58
|
+
|
59
|
+
def _assign fields
|
60
|
+
fields.each { |k,v| instance_variable_set :"@#{k}", v }
|
61
|
+
end
|
62
|
+
end
|
63
|
+
end
|
metadata
ADDED
@@ -0,0 +1,115 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: manioc
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- James Dabbs
|
8
|
+
autorequire:
|
9
|
+
bindir: exe
|
10
|
+
cert_chain: []
|
11
|
+
date: 2017-08-04 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.12'
|
20
|
+
type: :development
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - "~>"
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '1.12'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: rake
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - "~>"
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '11.0'
|
34
|
+
type: :development
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - "~>"
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '11.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: rspec-coverage
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
58
|
+
requirements:
|
59
|
+
- - "~>"
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: '0.1'
|
62
|
+
type: :development
|
63
|
+
prerelease: false
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - "~>"
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: '0.1'
|
69
|
+
description: Quick-and-dirty functional service objects
|
70
|
+
email:
|
71
|
+
- jamesdabbs@gmail.com
|
72
|
+
executables: []
|
73
|
+
extensions: []
|
74
|
+
extra_rdoc_files: []
|
75
|
+
files:
|
76
|
+
- ".gitignore"
|
77
|
+
- ".rspec"
|
78
|
+
- ".travis.yml"
|
79
|
+
- CODE_OF_CONDUCT.md
|
80
|
+
- Gemfile
|
81
|
+
- LICENSE.txt
|
82
|
+
- README.md
|
83
|
+
- Rakefile
|
84
|
+
- bin/console
|
85
|
+
- bin/setup
|
86
|
+
- gestalt.gemspec
|
87
|
+
- lib/gestalt.rb
|
88
|
+
- lib/manioc/container.rb
|
89
|
+
- lib/manioc/struct.rb
|
90
|
+
- lib/manioc/version.rb
|
91
|
+
homepage: https://github.com/jamesdabbs/manioc
|
92
|
+
licenses:
|
93
|
+
- MIT
|
94
|
+
metadata: {}
|
95
|
+
post_install_message:
|
96
|
+
rdoc_options: []
|
97
|
+
require_paths:
|
98
|
+
- lib
|
99
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
100
|
+
requirements:
|
101
|
+
- - ">="
|
102
|
+
- !ruby/object:Gem::Version
|
103
|
+
version: '0'
|
104
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
105
|
+
requirements:
|
106
|
+
- - ">="
|
107
|
+
- !ruby/object:Gem::Version
|
108
|
+
version: '0'
|
109
|
+
requirements: []
|
110
|
+
rubyforge_project:
|
111
|
+
rubygems_version: 2.6.8
|
112
|
+
signing_key:
|
113
|
+
specification_version: 4
|
114
|
+
summary: Quick-and-dirty functional service objects
|
115
|
+
test_files: []
|