type_wrapper 1.0.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.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 3cc7a72732a8d341ebe0917de96ee0237ea2268b
4
+ data.tar.gz: 044533cae779e823129a9270e78aa7e423a1e072
5
+ SHA512:
6
+ metadata.gz: a0a8c11c5ecdcce5a871a5d8af79cc0605995ca05b2a2d67d4f95edeefa10d98ab852754a04a6c8af208182bee6aa88db5fba26337b9b666b416ae7904ec0567
7
+ data.tar.gz: bdd466147398fc896c43e49cff7253620ce6b62c22467d0c0fc932d24ec30145ae9f29d6ca58e11fe7a5c6f601ae54df079187ec486029fe205dea5032366dc3
data/.gitignore ADDED
@@ -0,0 +1,11 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
10
+ *.gem
11
+ .ruby-version
data/.travis.yml ADDED
@@ -0,0 +1,8 @@
1
+ sudo: false
2
+ language: ruby
3
+ rvm:
4
+ - 2.4.0
5
+ - 2.3.0
6
+ - 2.2.0
7
+ - 2.1.0
8
+ before_install: gem install bundler -v 1.15.0
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source "https://rubygems.org"
2
+
3
+ # Specify your gem's dependencies in type_wrapper.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2017 Ritchie Paul Buitre
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,69 @@
1
+ # TypeWrapper
2
+
3
+ Delegator pattern in Ruby without object schizophrenia. Because Object#extend at runtime is evil.
4
+
5
+ ## Installation
6
+
7
+ Add this line to your application's Gemfile:
8
+
9
+ ```ruby
10
+ gem 'type_wrapper'
11
+ ```
12
+
13
+ And then execute:
14
+
15
+ $ bundle
16
+
17
+ Or install it yourself as:
18
+
19
+ $ gem install type_wrapper
20
+
21
+ ## Usage
22
+
23
+ ```ruby
24
+ module ToArray
25
+ def to_a
26
+ [self]
27
+ end
28
+ end
29
+
30
+ module ToString
31
+ def to_s
32
+ "#{self}"
33
+ end
34
+ end
35
+
36
+ Person = Struct.new(:name)
37
+
38
+ PersonPresenter = TypeWrapper[Person, ToArray, ToString]
39
+
40
+ peter = PersonPresenter.new(Person.new('Peter'))
41
+ peter.to_a
42
+ ```
43
+
44
+ ## Pros
45
+
46
+ * Five (5) times faster than [Object#extend](https://apidock.com/ruby/Object/extend).
47
+ * Delegation without [self schizophrenia](https://en.wikipedia.org/wiki/Schizophrenia_(object-oriented_programming)).
48
+ * [Decorator Pattern](https://en.wikipedia.org/wiki/Decorator_pattern) with multiple traits.
49
+ * Allows [DCI](http://dci.github.io/) in Ruby without [blowing the method cache at run time](https://tonyarcieri.com/dci-in-ruby-is-completely-broken).
50
+
51
+ ## Cons
52
+
53
+ * Three (3) times slower than calling class method. [See benchmark.](https://github.com/RichOrElse/wrapper-based/tree/master/examples/benchmark.rb)
54
+ * [Procedural code](https://en.wikipedia.org/wiki/Procedural_programming) inside Mixin is broken, methods scoped in Mixin cannot directly call another method in the same scope of the Mixin.
55
+ * Methods applied by [Object#extend](https://apidock.com/ruby/Object/extend) takes precedence over Mixin methods.
56
+
57
+ ## Development
58
+
59
+ After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
60
+
61
+ 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).
62
+
63
+ ## Contributing
64
+
65
+ Bug reports and pull requests are welcome on GitHub at https://github.com/RichOrElse/type_wrapper.
66
+
67
+ ## License
68
+
69
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
data/Rakefile ADDED
@@ -0,0 +1,10 @@
1
+ require "bundler/gem_tasks"
2
+ require "rake/testtask"
3
+
4
+ Rake::TestTask.new(:test) do |t|
5
+ t.libs << "test"
6
+ t.libs << "lib"
7
+ t.test_files = FileList["test/**/*_test.rb"]
8
+ end
9
+
10
+ task :default => :test
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "type_wrapper"
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(__FILE__)
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
@@ -0,0 +1,27 @@
1
+ # Derived from https://tonyarcieri.com/dci-in-ruby-is-completely-broken
2
+ require 'rubygems'
3
+ require 'benchmark/ips'
4
+ require 'type_wrapper'
5
+
6
+ class ExampleClass
7
+ def foo; 42; end
8
+ end
9
+
10
+ module ExampleMixin
11
+ def foo; 43; end
12
+ end
13
+
14
+ wrapper = TypeWrapper[ExampleClass, ExampleMixin]
15
+
16
+ Benchmark.ips do |bm|
17
+ bm.report("without dci") { ExampleClass.new.foo }
18
+ bm.report("with wrapper") do
19
+ wrapper.new(ExampleClass.new).foo
20
+ end
21
+ bm.report("with extend") do
22
+ obj = ExampleClass.new
23
+ obj.extend(ExampleMixin)
24
+ obj.foo
25
+ end
26
+ bm.compare!
27
+ end
@@ -0,0 +1,3 @@
1
+ module TypeWrapper
2
+ VERSION = "1.0.0"
3
+ end
@@ -0,0 +1,32 @@
1
+ require "type_wrapper/version"
2
+ require 'delegate'
3
+
4
+ module TypeWrapper
5
+ alias_method :initialize, def __setobj__(obj)
6
+ @delegate_tw_obj = obj # change delegation object
7
+ end
8
+
9
+ alias_method :~@, def __getobj__
10
+ @delegate_tw_obj # return object we are delegating to
11
+ end
12
+
13
+ def self.[](type, *modules)
14
+ raise TypeError, "wrong argument type (expected Class)" unless Class === type
15
+ raise TypeError, "wrong argument type (expected Module(s))" unless modules.all? { |mod| mod.class == Module }
16
+ raise ArgumentError, "wrong number of arguments (given 1, expected 2+)" if modules.empty?
17
+
18
+ FOR[type, *modules]
19
+ end
20
+
21
+ FOR = -> type, *behaviors do
22
+ Class.new(Delegator) do
23
+ include TypeWrapper
24
+ const_set :Type, type
25
+ const_set :BEHAVIORS, behaviors
26
+ forwarding = behaviors.flat_map(&:public_instance_methods) - public_instance_methods
27
+ code = forwarding.uniq.map { |meth| "def %{meth}(*args, &block) __getobj__.%{meth}(*args, &block) end" % { meth: meth } }
28
+ code.unshift "using Module.new { refine(Type) { prepend *BEHAVIORS.reverse } }"
29
+ class_eval code.join('; ')
30
+ end
31
+ end
32
+ end
@@ -0,0 +1,27 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path("../lib", __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require "type_wrapper/version"
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "type_wrapper"
8
+ spec.version = TypeWrapper::VERSION
9
+ spec.authors = ["Ritchie Paul Buitre"]
10
+ spec.email = ["ritchie@richorelse.com"]
11
+
12
+ spec.summary = "Delegator pattern in Ruby without object schizophrenia. Because Object#extend at runtime is evil."
13
+ spec.homepage = "https://github.com/RichOrElse/type-wrapper/"
14
+ spec.license = "MIT"
15
+
16
+ spec.files = `git ls-files -z`.split("\x0").reject do |f|
17
+ f.match(%r{^(test|spec|features)/})
18
+ end
19
+ spec.bindir = "exe"
20
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
21
+ spec.require_paths = ["lib"]
22
+ spec.required_ruby_version = ">= 2.1.0"
23
+
24
+ spec.add_development_dependency "bundler", "~> 1.15"
25
+ spec.add_development_dependency "rake", "~> 10.0"
26
+ spec.add_development_dependency "minitest", "~> 5.0"
27
+ end
metadata ADDED
@@ -0,0 +1,99 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: type_wrapper
3
+ version: !ruby/object:Gem::Version
4
+ version: 1.0.0
5
+ platform: ruby
6
+ authors:
7
+ - Ritchie Paul Buitre
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2017-06-20 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.15'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.15'
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: minitest
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '5.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '5.0'
55
+ description:
56
+ email:
57
+ - ritchie@richorelse.com
58
+ executables: []
59
+ extensions: []
60
+ extra_rdoc_files: []
61
+ files:
62
+ - ".gitignore"
63
+ - ".travis.yml"
64
+ - Gemfile
65
+ - LICENSE.txt
66
+ - README.md
67
+ - Rakefile
68
+ - bin/console
69
+ - bin/setup
70
+ - examples/benchmark.rb
71
+ - lib/type_wrapper.rb
72
+ - lib/type_wrapper/version.rb
73
+ - type_wrapper.gemspec
74
+ homepage: https://github.com/RichOrElse/type-wrapper/
75
+ licenses:
76
+ - MIT
77
+ metadata: {}
78
+ post_install_message:
79
+ rdoc_options: []
80
+ require_paths:
81
+ - lib
82
+ required_ruby_version: !ruby/object:Gem::Requirement
83
+ requirements:
84
+ - - ">="
85
+ - !ruby/object:Gem::Version
86
+ version: 2.1.0
87
+ required_rubygems_version: !ruby/object:Gem::Requirement
88
+ requirements:
89
+ - - ">="
90
+ - !ruby/object:Gem::Version
91
+ version: '0'
92
+ requirements: []
93
+ rubyforge_project:
94
+ rubygems_version: 2.5.1
95
+ signing_key:
96
+ specification_version: 4
97
+ summary: Delegator pattern in Ruby without object schizophrenia. Because Object#extend
98
+ at runtime is evil.
99
+ test_files: []