yieldable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b3ec314bc5b85c0ce2c8a51066d428e69535eafe78a86b94e19bfc580b6140c5
+  data.tar.gz: 3b72b7259dd3e9323cef9b214d5c02dca1237082711ae08dff572cdd691bf010
+SHA512:
+  metadata.gz: 9726fcc6cc5a07221aed121af8ab7e1e47ed5157cbe57ea8935e0d2f9db6dd9af7239c86bfc57f36dc6e3894ab51cdc6bd2c10dd448dd322d2fe8bfc809d67fe
+  data.tar.gz: 630e3203ca6dd8307b60564827c10a44f643ef563ed3d6731b6a74f4f2312f8c3ef0ceb027093d25d8cc5baa58f769db8c4c0db3e031b084eb48131387add759

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 1.17.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at anton.estum@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in yieldable.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    yieldable (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    rake (13.0.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (>= 1.17)
+  rake (>= 10.0)
+  rspec (>= 3.0)
+  yieldable!
+
+BUNDLED WITH
+   2.2.15

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Anton
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,75 @@
+# Yieldable
+
+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.
+
+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:
+
+  ["1", "2", "3"].map(&SomeObject)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'yieldable'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install yieldable
+
+## Usage
+
+It is 2 different ways to use this module: +extend+ or +prepend+ it to your class.
+
+== <tt>extend Yieldable</tt>
+
+  class SomeObject
+    extend Yieldable # => singleton_class.to_proc = SomeObject.method(:call).to_proc
+  end
+
+This way defines an attribute reader +to_proc+ in a singleton class.
+It sets a proc only once for a class, so it will not generate a new +Proc+ object
+every time, like if you would use just a <tt>method(:call).to_proc</tt>.
+By default it uses the +call+ class method as a source method for a proc. You
+can change the source method name by using brackets:
+
+  class SomeObject
+    extend Yieldable[:new] # => singleton_class.to_proc = SomeObject.method(:new).to_proc
+  end
+
+It's better to ensure that a source method is defined _before_ extending a class with +Yieldable+.
+In the other way it will add the +singletone_method_added+ hook and wait. After a source method
+will be added, the hook method will be removed.
+
+You can avoid to removing the hook with an optional <tt>once: false</tt> passed into the brackets:
+
+  extend Yieldable[:new, once: false]
+
+== <tt>prepend Yieldable</tt>
+
+This way defines a +to_proc+ instance method once for a class, but a proc will be generated once for
+each object. You can also use a brackets like within an +extend+ way.
+
+
+## Development
+
+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.
+
+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).
+
+## Contributing
+
+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.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+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

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "yieldable"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/yieldable.rb

@@ -0,0 +1,166 @@
+# frozen_string_literal: true
+
+require "yieldable/version"
+
+# = Yieldable
+#
+# This 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:
+#
+#   ["1", "2", "3"].map(&SomeObject)
+#
+# It is 2 different ways to use this module: +extend+ or +prepend+ it to your class.
+#
+# == <tt>extend Yieldable</tt>
+#
+#   class SomeObject
+#     extend Yieldable # => singleton_class.to_proc = SomeObject.method(:call).to_proc
+#   end
+#
+# This way defines an attribute reader +to_proc+ in a singleton class.
+# It sets a proc only once for a class, so it will not generate a new +Proc+ object
+# every time, like if you would use just a <tt>method(:call).to_proc</tt>.
+# By default it uses the +call+ class method as a source method for a proc. You
+# can change the source method by using brackets:
+#
+#   class SomeObject
+#     extend Yieldable[:new] # => singleton_class.to_proc = SomeObject.method(:new).to_proc
+#   end
+#
+# It's better to ensure that a source method is defined _before_ extending a class with +Yieldable+.
+# In the other way it will add the +singletone_method_added+ hook and wait. After a source method
+# will be added, the hook method will be removed.
+#
+# You can avoid to removing the hook with an optional <tt>once: false</tt> passed into the brackets:
+#
+#   extend Yieldable[:new, once: false]
+#
+# == <tt>prepend Yieldable</tt>
+#
+# This way defines a +to_proc+ instance method once for a class, but a proc will be generated once for
+# each object. You can also use a brackets like within an +extend+ way.
+module Yieldable
+  # Creates configured mixin.
+  #
+  # @param method_name [Symbol] A source method's name
+  # @param once [Boolean] Will be a proc defined only once? (by default: +true+)
+  # @return [Module] the configured mixin
+  def self.[](method_name = :call, once: true)
+    Mixin.new(method_name, once: once)
+  end
+
+  # Utility to resolve method.
+  def self.resolve_class_method(base, method_name)
+    if base.respond_to?(method_name)
+      base.method(method_name)
+    else
+      base.singleton_method(method_name)
+    end
+  end
+
+  # Utility to set proc for the mixn.
+  def self.set_proc(base, mixin)
+    mixin.proc = resolve_class_method(base, mixin.method_name).to_proc
+    base.instance_variable_set(:@to_proc, mixin.proc)
+    base
+  end
+
+  module ToProcReader
+    attr_reader :to_proc
+  end
+
+  module WaitMethodDefinition
+    def singleton_method_added(id)
+      if id == YieldableMixin.method_name
+        begin
+          Yieldable.set_proc(self, YieldableMixin)
+        ensure
+          singleton_class.remove_method(:singleton_method_added) if YieldableMixin.once
+        end
+      end
+
+      super(id)
+    end
+  end
+
+  module Inheritance
+    def self.extended(base)
+      Yieldable.set_proc(base, base.const_get(:YieldableMixin))
+    end
+
+    # Overrides inheritance to set separate YieldableMixin module for a children class.
+    def inherited(subclass)
+      super
+      subclass.const_set(:YieldableMixin, subclass.superclass.const_get(:YieldableMixin).dup)
+      Yieldable.set_proc(subclass, subclass.const_get(:YieldableMixin))
+    end
+  end
+
+  module InstanceMethodsMixin
+    def to_proc
+      @to_proc ||= method(self.class.const_get(:YieldableMixin).method_name).to_proc
+    end
+  end
+
+  class Mixin < Module
+    attr_reader :method_name, :once
+    attr_accessor :proc
+
+    def initialize(method_name = :call, once: true)
+      @method_name = method_name
+      @once = once
+      @proc = nil
+      super()
+    end
+
+    ##
+    # Hook to invoke on `extend Yieldable`.
+    def extend_object(base)
+      return unless write_once_in_constant(base)
+      base.extend(ToProcReader)         unless base.singleton_class.method_defined?(:to_proc)
+      base.extend(Inheritance)          if base.singleton_class.method_defined?(@method_name)
+      base.extend(WaitMethodDefinition) if wait_method_definition?
+      super
+    end
+
+    def prepend_features(base)
+      return unless write_once_in_constant(base)
+      base.prepend InstanceMethodsMixin
+      super
+    end
+
+    def append_features(base)
+      return unless write_once_in_constant(base)
+      base.include InstanceMethodsMixin
+      super
+    end
+
+    private
+
+    def write_once_in_constant(base)
+      base.const_set(:YieldableMixin, self) unless base.const_defined?(:YieldableMixin)
+    end
+
+    def wait_method_definition?
+      @proc.nil? || !@once
+    end
+  end
+
+  CallMixin = Mixin.new(:call)
+
+  class << self
+    private
+
+    def extend_object(base)
+      CallMixin.extend_object(base)
+    end
+
+    def prepend_features(base)
+      CallMixin.prepend_features(base)
+    end
+
+    def append_features(base)
+      CallMixin.append_features(base)
+    end
+  end
+end

data/lib/yieldable/version.rb

@@ -0,0 +1,3 @@
+module Yieldable
+  VERSION = "0.1.0"
+end

data/yieldable.gemspec

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "yieldable/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "yieldable"
+  spec.version       = Yieldable::VERSION
+  spec.authors       = ["Anton Semenov"]
+  spec.email         = ["anton.estum@gmail.com"]
+
+  spec.summary       = %q{Pure-ruby meta-mixin #to_proc for classes & their instances.}
+  spec.description   = %q{Yieldable is meta-mixin on pure ruby, which makes your module, class or it's instance to respond.}
+  spec.homepage      = "https://github.com/estum/yieldable"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", ">= 1.17"
+  spec.add_development_dependency "rake", ">= 10.0"
+  spec.add_development_dependency "rspec", ">= 3.0"
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: yieldable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Anton Semenov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-03-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Yieldable is meta-mixin on pure ruby, which makes your module, class
+  or it's instance to respond.
+email:
+- anton.estum@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/yieldable.rb
+- lib/yieldable/version.rb
+- yieldable.gemspec
+homepage: https://github.com/estum/yieldable
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: 'Pure-ruby meta-mixin #to_proc for classes & their instances.'
+test_files: []