to_proc_interface 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 06b8add40ba06c051dc8c7eb71c536f04dd08c7bc4e1ddc06d32ecfb58133259
+  data.tar.gz: 65833563e06bbe50b67003440564ff39b3edece36ec48f1a189c551987215ac6
+SHA512:
+  metadata.gz: 07055e8ba776a84e0ceb20fa9c6e536de0a2c7055384e1b51eac4cc857bf5a0c8192a5239d608b01e8ef1d6053f8e2bd66aaeedc885481337919b06b17449d1e
+  data.tar.gz: 5050437d0b21224802cff557b8c4f7a081c8dd34e4c566a87ed52c456f90531b04ef93532b1a0c8c80ab70499fa5166f8bf2fb1d0c09c778d7bb66ca1021b642

data/.rspec

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders 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, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 estum
+
+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,39 @@
+# ToProcInterface
+
+The collection of mixins to make anything responsible to `#call` acts like a `Proc`.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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 the created tag, 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/to_proc_interface. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/estum/to_proc_interface/blob/main/CODE_OF_CONDUCT.md).
+
+## 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 ToProcInterface project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/estum/to_proc_interface/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: %i[spec]

data/lib/to_proc_interface/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ToProcInterface
+  VERSION = "0.1.0"
+end

data/lib/to_proc_interface.rb

@@ -0,0 +1,221 @@
+# frozen_string_literal: true
+
+require 'singleton'
+
+# @example Usage
+#   class SomeCallableClass
+#     def self.call(*args)
+#       # bla-bla
+#     end
+#
+#     extend ToProcInterface
+#   end
+module ToProcInterface
+  # @api private
+  # Mixin module with delegations to {ToProcInterface#to_proc} method to mimic {Proc} behavior.
+  module Delegations
+    class << self
+      @@proc_methods = []
+
+      # @return [Array<Symbol>]
+      def proc_methods
+        @@proc_methods
+      end
+
+      @@args_by_arity = [
+        "",
+        "arg",
+        "*args, **opts, &block"
+      ].freeze
+
+      # @!macro [new] delegate_to_proc
+      #   @!method (...)
+      #     @see Proc#
+      #
+      # @param name [Symbol, String]
+      #   method name
+      # @param arity [Integer]
+      #   method arity
+      # @return [Symbol]
+      #   delegated method name
+      #
+      # @example Customize proc-delegated methods
+      #   ToProcInterface::Delegations.delegate_to_proc :custom_proc_method, arity: 1
+      def delegate_to_proc(name, arity: nil)
+        name = name.to_sym
+        arity ||= Proc.instance_method(name).arity
+        args = @@args_by_arity[arity.clamp(-1, 1)]
+
+        class_eval(<<~RUBY, __FILE__, __LINE__ + 1).tap { proc_methods << _1 }
+          def #{name}(#{args})
+            to_proc.#{name}(#{args})
+          end
+        RUBY
+      end
+    end
+
+    delegate_to_proc :parameters, arity: 0
+    delegate_to_proc :arity, arity: 0
+    delegate_to_proc :lambda?, arity: 0
+    delegate_to_proc :binding, arity: 0
+    delegate_to_proc :curry, arity: -1
+    delegate_to_proc :yield, arity: -1
+    delegate_to_proc :[], arity: -1
+    delegate_to_proc :<<, arity: 1
+    delegate_to_proc :>>, arity: 1
+    delegate_to_proc :source_location
+    delegate_to_proc :ruby2_keywords if Proc.method_defined?(:ruby2_keywords)
+  end
+
+  # @api private
+  module Hooks
+    # @example Usage
+    #   extend ToProcInterface::Hooks::Included
+    module Included
+      # @return [void]
+      private def included(base)
+        base.extend Extended if base.is_a?(Module) && !base.is_a?(Class)
+        super if defined?(super)
+      end
+    end
+
+    # @example Usage
+    #   extend ToProcInterface::Hooks::Extended
+    module Extended
+      # Hooks an {Module#extended} callback method to mix in possible singleton class with {Inherited}.
+      # @return [void]
+      private def extended(base)
+        base.extend Inherited if base.is_a?(Class)
+        super if defined?(super)
+      end
+    end
+
+    # @example Usage
+    #   extend ToProcInterface::Hooks::Inherited
+    module Inherited
+      # Hooks an {Class#inherited} method to avoid reusing cached {#to_proc} on inherited classes.
+      # @return [void]
+      private def inherited(subclass)
+        if subclass.instance_variable_defined?(:@to_proc)
+          subclass.remove_instance_variable(:@to_proc)
+          subclass.to_proc
+        end
+        super if defined?(super)
+      end
+    end
+  end
+
+  # @api private
+  module Mixin
+    extend Hooks::Included
+    include Delegations
+
+    # @return [Proc] built from the {#call} method
+    def to_proc
+      @to_proc ||= method(:call).to_proc
+    end
+  end
+
+  include Mixin
+
+  # Interface with predefined {#call} method which delegates all the given params into class' constructor
+  # and invokes instance's {#call} method.
+  #
+  # @example Usage
+  #   extend ToProcInterface::CallingService
+  module CallingService
+    include Mixin
+
+    # @see #initialize
+    # @see #call
+    def call(*args, **opts, &block)
+      instance = new(*args, **opts, &block)
+      instance.call
+    end
+  end
+
+  # Interface with predefined {#call} method which delegates all the given params into class' constructor
+  # and invokes instance's {#call} method converting a result monad into maybe.
+  #
+  # @abstract
+  #   The instance method `#call` should return a monad-like object responsible to `#to_maybe`.
+  #
+  # @example Usage
+  #   extend ToProcInterface::CallToMaybe
+  module CallToMaybe
+    include Mixin
+
+    # @see #initialize
+    # @see #call
+    # @return [Dry::Monads::Maybe]
+    def call(*args, **opts, &block)
+      instance = new(*args, **opts, &block)
+      result = instance.call
+      result.to_maybe
+    end
+  end
+
+  # Interface with predefined {#call} method which delegates all the given params into class' constructor.
+  #
+  # @example Usage
+  #   extend ToProcInterface::Initializer
+  module Initializer
+    include Mixin
+
+    # @see #initialize
+    # @return [self]
+    def call(*args, **opts, &block)
+      new(*args, **opts, &block)
+    end
+  end
+
+  # Interface with predefined {#call} method which delegates all the given params into class' constructor
+  # and invokes instance's {#perform} method.
+  #
+  # @example Usage
+  #   extend ToProcInterface::PerformingService
+  module PerformingService
+    include Mixin
+
+    # @see #initialize
+    # @see #perform
+    def call(*args, **opts, &block)
+      new(*args, **opts, &block).perform
+    end
+  end
+
+  # Singleton variation. {#to_proc} & {#call} delegated to {ToProcInterface::Singleton::ClassMethods.instance}
+  #
+  # @example Usage
+  #   include ToProcInterface::Singleton
+  module Singleton
+    include ToProcInterface
+
+    class << self
+      # @api private
+      private def included(base)
+        if base.is_a?(Class)
+          base.include ::Singleton
+          base.extend ClassMethods
+        end
+        super if defined?(super)
+      end
+    end
+
+    # @private
+    module ClassMethods
+      # @see ToProcInterface#to_proc
+      # @return [Proc]
+      def to_proc
+        instance.to_proc
+      end
+
+      # @see #call
+      def call(*args, **opts, &block)
+        instance.call(*args, **opts, &block)
+      end
+
+      include Delegations
+    end
+  end
+end

data/sig/to_proc_interface.rbs

@@ -0,0 +1,5 @@
+module ToProcInterface
+  VERSION: String
+
+  def to_proc: -> Proc
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: to_proc_interface
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- estum
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-12-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: singleton
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.1'
+description: Collection of mixins to make anything act like a proc.
+email:
+- anton.estum@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/to_proc_interface.rb
+- lib/to_proc_interface/version.rb
+- sig/to_proc_interface.rbs
+homepage: https://github.com/estum/to_proc_interface
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/estum/to_proc_interface
+  source_code_uri: https://github.com/estum/to_proc_inteface
+  changelog_uri: https://github.com/estum/to_proc_inteface/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.17
+signing_key:
+specification_version: 4
+summary: "#to_proc mixins."
+test_files: []