yieldable 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: b3ec314bc5b85c0ce2c8a51066d428e69535eafe78a86b94e19bfc580b6140c5
4
+ data.tar.gz: 3b72b7259dd3e9323cef9b214d5c02dca1237082711ae08dff572cdd691bf010
5
+ SHA512:
6
+ metadata.gz: 9726fcc6cc5a07221aed121af8ab7e1e47ed5157cbe57ea8935e0d2f9db6dd9af7239c86bfc57f36dc6e3894ab51cdc6bd2c10dd448dd322d2fe8bfc809d67fe
7
+ data.tar.gz: 630e3203ca6dd8307b60564827c10a44f643ef563ed3d6731b6a74f4f2312f8c3ef0ceb027093d25d8cc5baa58f769db8c4c0db3e031b084eb48131387add759
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,7 @@
1
+ ---
2
+ sudo: false
3
+ language: ruby
4
+ cache: bundler
5
+ rvm:
6
+ - 2.6.3
7
+ before_install: gem install bundler -v 1.17.2
@@ -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 anton.estum@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,6 @@
1
+ source "https://rubygems.org"
2
+
3
+ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
4
+
5
+ # Specify your gem's dependencies in yieldable.gemspec
6
+ gemspec
data/Gemfile.lock ADDED
@@ -0,0 +1,35 @@
1
+ PATH
2
+ remote: .
3
+ specs:
4
+ yieldable (0.1.0)
5
+
6
+ GEM
7
+ remote: https://rubygems.org/
8
+ specs:
9
+ diff-lcs (1.4.4)
10
+ rake (13.0.3)
11
+ rspec (3.10.0)
12
+ rspec-core (~> 3.10.0)
13
+ rspec-expectations (~> 3.10.0)
14
+ rspec-mocks (~> 3.10.0)
15
+ rspec-core (3.10.1)
16
+ rspec-support (~> 3.10.0)
17
+ rspec-expectations (3.10.1)
18
+ diff-lcs (>= 1.2.0, < 2.0)
19
+ rspec-support (~> 3.10.0)
20
+ rspec-mocks (3.10.2)
21
+ diff-lcs (>= 1.2.0, < 2.0)
22
+ rspec-support (~> 3.10.0)
23
+ rspec-support (3.10.2)
24
+
25
+ PLATFORMS
26
+ ruby
27
+
28
+ DEPENDENCIES
29
+ bundler (>= 1.17)
30
+ rake (>= 10.0)
31
+ rspec (>= 3.0)
32
+ yieldable!
33
+
34
+ BUNDLED WITH
35
+ 2.2.15
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2021 Anton
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,75 @@
1
+ # Yieldable
2
+
3
+ Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/yieldable`. To experiment with that code, run `bin/console` for an interactive prompt.
4
+
5
+ Yieldable is meta-mixin, which makes your module, class or it's instance to respond to method +to_proc+, for example, to easily build instances during iteration:
6
+
7
+ ["1", "2", "3"].map(&SomeObject)
8
+
9
+ ## Installation
10
+
11
+ Add this line to your application's Gemfile:
12
+
13
+ ```ruby
14
+ gem 'yieldable'
15
+ ```
16
+
17
+ And then execute:
18
+
19
+ $ bundle
20
+
21
+ Or install it yourself as:
22
+
23
+ $ gem install yieldable
24
+
25
+ ## Usage
26
+
27
+ It is 2 different ways to use this module: +extend+ or +prepend+ it to your class.
28
+
29
+ == <tt>extend Yieldable</tt>
30
+
31
+ class SomeObject
32
+ extend Yieldable # => singleton_class.to_proc = SomeObject.method(:call).to_proc
33
+ end
34
+
35
+ This way defines an attribute reader +to_proc+ in a singleton class.
36
+ It sets a proc only once for a class, so it will not generate a new +Proc+ object
37
+ every time, like if you would use just a <tt>method(:call).to_proc</tt>.
38
+ By default it uses the +call+ class method as a source method for a proc. You
39
+ can change the source method name by using brackets:
40
+
41
+ class SomeObject
42
+ extend Yieldable[:new] # => singleton_class.to_proc = SomeObject.method(:new).to_proc
43
+ end
44
+
45
+ It's better to ensure that a source method is defined _before_ extending a class with +Yieldable+.
46
+ In the other way it will add the +singletone_method_added+ hook and wait. After a source method
47
+ will be added, the hook method will be removed.
48
+
49
+ You can avoid to removing the hook with an optional <tt>once: false</tt> passed into the brackets:
50
+
51
+ extend Yieldable[:new, once: false]
52
+
53
+ == <tt>prepend Yieldable</tt>
54
+
55
+ This way defines a +to_proc+ instance method once for a class, but a proc will be generated once for
56
+ each object. You can also use a brackets like within an +extend+ way.
57
+
58
+
59
+ ## Development
60
+
61
+ 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.
62
+
63
+ 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).
64
+
65
+ ## Contributing
66
+
67
+ Bug reports and pull requests are welcome on GitHub at https://github.com/estum/yieldable. 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.
68
+
69
+ ## License
70
+
71
+ The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
72
+
73
+ ## Code of Conduct
74
+
75
+ Everyone interacting in the Yieldable project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/estum/yieldable/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,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "yieldable"
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
data/lib/yieldable.rb ADDED
@@ -0,0 +1,166 @@
1
+ # frozen_string_literal: true
2
+
3
+ require "yieldable/version"
4
+
5
+ # = Yieldable
6
+ #
7
+ # This is meta-mixin, which makes your module, class or it's instance to respond
8
+ # to method +to_proc+, for example, to easily build instances during iteration:
9
+ #
10
+ # ["1", "2", "3"].map(&SomeObject)
11
+ #
12
+ # It is 2 different ways to use this module: +extend+ or +prepend+ it to your class.
13
+ #
14
+ # == <tt>extend Yieldable</tt>
15
+ #
16
+ # class SomeObject
17
+ # extend Yieldable # => singleton_class.to_proc = SomeObject.method(:call).to_proc
18
+ # end
19
+ #
20
+ # This way defines an attribute reader +to_proc+ in a singleton class.
21
+ # It sets a proc only once for a class, so it will not generate a new +Proc+ object
22
+ # every time, like if you would use just a <tt>method(:call).to_proc</tt>.
23
+ # By default it uses the +call+ class method as a source method for a proc. You
24
+ # can change the source method by using brackets:
25
+ #
26
+ # class SomeObject
27
+ # extend Yieldable[:new] # => singleton_class.to_proc = SomeObject.method(:new).to_proc
28
+ # end
29
+ #
30
+ # It's better to ensure that a source method is defined _before_ extending a class with +Yieldable+.
31
+ # In the other way it will add the +singletone_method_added+ hook and wait. After a source method
32
+ # will be added, the hook method will be removed.
33
+ #
34
+ # You can avoid to removing the hook with an optional <tt>once: false</tt> passed into the brackets:
35
+ #
36
+ # extend Yieldable[:new, once: false]
37
+ #
38
+ # == <tt>prepend Yieldable</tt>
39
+ #
40
+ # This way defines a +to_proc+ instance method once for a class, but a proc will be generated once for
41
+ # each object. You can also use a brackets like within an +extend+ way.
42
+ module Yieldable
43
+ # Creates configured mixin.
44
+ #
45
+ # @param method_name [Symbol] A source method's name
46
+ # @param once [Boolean] Will be a proc defined only once? (by default: +true+)
47
+ # @return [Module] the configured mixin
48
+ def self.[](method_name = :call, once: true)
49
+ Mixin.new(method_name, once: once)
50
+ end
51
+
52
+ # Utility to resolve method.
53
+ def self.resolve_class_method(base, method_name)
54
+ if base.respond_to?(method_name)
55
+ base.method(method_name)
56
+ else
57
+ base.singleton_method(method_name)
58
+ end
59
+ end
60
+
61
+ # Utility to set proc for the mixn.
62
+ def self.set_proc(base, mixin)
63
+ mixin.proc = resolve_class_method(base, mixin.method_name).to_proc
64
+ base.instance_variable_set(:@to_proc, mixin.proc)
65
+ base
66
+ end
67
+
68
+ module ToProcReader
69
+ attr_reader :to_proc
70
+ end
71
+
72
+ module WaitMethodDefinition
73
+ def singleton_method_added(id)
74
+ if id == YieldableMixin.method_name
75
+ begin
76
+ Yieldable.set_proc(self, YieldableMixin)
77
+ ensure
78
+ singleton_class.remove_method(:singleton_method_added) if YieldableMixin.once
79
+ end
80
+ end
81
+
82
+ super(id)
83
+ end
84
+ end
85
+
86
+ module Inheritance
87
+ def self.extended(base)
88
+ Yieldable.set_proc(base, base.const_get(:YieldableMixin))
89
+ end
90
+
91
+ # Overrides inheritance to set separate YieldableMixin module for a children class.
92
+ def inherited(subclass)
93
+ super
94
+ subclass.const_set(:YieldableMixin, subclass.superclass.const_get(:YieldableMixin).dup)
95
+ Yieldable.set_proc(subclass, subclass.const_get(:YieldableMixin))
96
+ end
97
+ end
98
+
99
+ module InstanceMethodsMixin
100
+ def to_proc
101
+ @to_proc ||= method(self.class.const_get(:YieldableMixin).method_name).to_proc
102
+ end
103
+ end
104
+
105
+ class Mixin < Module
106
+ attr_reader :method_name, :once
107
+ attr_accessor :proc
108
+
109
+ def initialize(method_name = :call, once: true)
110
+ @method_name = method_name
111
+ @once = once
112
+ @proc = nil
113
+ super()
114
+ end
115
+
116
+ ##
117
+ # Hook to invoke on `extend Yieldable`.
118
+ def extend_object(base)
119
+ return unless write_once_in_constant(base)
120
+ base.extend(ToProcReader) unless base.singleton_class.method_defined?(:to_proc)
121
+ base.extend(Inheritance) if base.singleton_class.method_defined?(@method_name)
122
+ base.extend(WaitMethodDefinition) if wait_method_definition?
123
+ super
124
+ end
125
+
126
+ def prepend_features(base)
127
+ return unless write_once_in_constant(base)
128
+ base.prepend InstanceMethodsMixin
129
+ super
130
+ end
131
+
132
+ def append_features(base)
133
+ return unless write_once_in_constant(base)
134
+ base.include InstanceMethodsMixin
135
+ super
136
+ end
137
+
138
+ private
139
+
140
+ def write_once_in_constant(base)
141
+ base.const_set(:YieldableMixin, self) unless base.const_defined?(:YieldableMixin)
142
+ end
143
+
144
+ def wait_method_definition?
145
+ @proc.nil? || !@once
146
+ end
147
+ end
148
+
149
+ CallMixin = Mixin.new(:call)
150
+
151
+ class << self
152
+ private
153
+
154
+ def extend_object(base)
155
+ CallMixin.extend_object(base)
156
+ end
157
+
158
+ def prepend_features(base)
159
+ CallMixin.prepend_features(base)
160
+ end
161
+
162
+ def append_features(base)
163
+ CallMixin.append_features(base)
164
+ end
165
+ end
166
+ end
@@ -0,0 +1,3 @@
1
+ module Yieldable
2
+ VERSION = "0.1.0"
3
+ end
data/yieldable.gemspec ADDED
@@ -0,0 +1,28 @@
1
+ # frozen_string_literal: true
2
+
3
+ lib = File.expand_path("../lib", __FILE__)
4
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
5
+ require "yieldable/version"
6
+
7
+ Gem::Specification.new do |spec|
8
+ spec.name = "yieldable"
9
+ spec.version = Yieldable::VERSION
10
+ spec.authors = ["Anton Semenov"]
11
+ spec.email = ["anton.estum@gmail.com"]
12
+
13
+ spec.summary = %q{Pure-ruby meta-mixin #to_proc for classes & their instances.}
14
+ spec.description = %q{Yieldable is meta-mixin on pure ruby, which makes your module, class or it's instance to respond.}
15
+ spec.homepage = "https://github.com/estum/yieldable"
16
+ spec.license = "MIT"
17
+
18
+ # Specify which files should be added to the gem when it is released.
19
+ # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
20
+ spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
21
+ `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
22
+ end
23
+ spec.require_paths = ["lib"]
24
+
25
+ spec.add_development_dependency "bundler", ">= 1.17"
26
+ spec.add_development_dependency "rake", ">= 10.0"
27
+ spec.add_development_dependency "rspec", ">= 3.0"
28
+ end
metadata ADDED
@@ -0,0 +1,100 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: yieldable
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Anton Semenov
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2021-03-25 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.17'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - ">="
25
+ - !ruby/object:Gem::Version
26
+ version: '1.17'
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: Yieldable is meta-mixin on pure ruby, which makes your module, class
56
+ or it's instance to respond.
57
+ email:
58
+ - anton.estum@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
+ - Gemfile.lock
69
+ - LICENSE.txt
70
+ - README.md
71
+ - Rakefile
72
+ - bin/console
73
+ - bin/setup
74
+ - lib/yieldable.rb
75
+ - lib/yieldable/version.rb
76
+ - yieldable.gemspec
77
+ homepage: https://github.com/estum/yieldable
78
+ licenses:
79
+ - MIT
80
+ metadata: {}
81
+ post_install_message:
82
+ rdoc_options: []
83
+ require_paths:
84
+ - lib
85
+ required_ruby_version: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - ">="
88
+ - !ruby/object:Gem::Version
89
+ version: '0'
90
+ required_rubygems_version: !ruby/object:Gem::Requirement
91
+ requirements:
92
+ - - ">="
93
+ - !ruby/object:Gem::Version
94
+ version: '0'
95
+ requirements: []
96
+ rubygems_version: 3.0.3
97
+ signing_key:
98
+ specification_version: 4
99
+ summary: 'Pure-ruby meta-mixin #to_proc for classes & their instances.'
100
+ test_files: []