callable-mixin 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 963cf5da4e14188c462b46f0f7a9cfc546cc189d4b464f5d265f2f6806a9b0d1
+  data.tar.gz: 1610376b0f5f392f3f6dd2bc87a926eae0baf3c8c1f6a6751380857f7957250a
+SHA512:
+  metadata.gz: 258cb27a1405b6cdefca5c17e132864d54f0d895a8e73a6138cc2ba9b0bad92545e2cab8f17a52b214040d910fd34497e6046425fe4217cf405ccf8cffa42377
+  data.tar.gz: 32e8483f9145fb9660243276d5406a86cd41215df09ef90df59763420111d3a7f0227b85fca11cde468428bc851c11c924467043ff9c0ee66c287045584da5a1

data/README.md

@@ -0,0 +1,95 @@
+# Callable
+
+Callable is a minimal Ruby mix-in that provides your classes with a simple `.call` class method. It allows you to instantiate and immediately invoke an instance method (`call`) without boilerplate or additional dependencies. Perfect for clean, readable, and concise service objects.
+
+## Features
+
+- Provides a `.call` class method to any Ruby class.
+- Transparently forwards positional arguments, keyword arguments, and blocks.
+- Handles argument errors gracefully, raising clear exceptions.
+- Zero external runtime dependencies.
+- Compatible with MRI Ruby 2.3 through Ruby 3.x.
+
+## Installation
+
+Add this to your application's Gemfile:
+
+```ruby
+gem 'callable-mixin'
+```
+
+Then execute:
+
+```bash
+bundle install
+```
+
+Or install directly:
+
+```bash
+gem install callable-mixin
+```
+
+## Usage
+
+### In a Bundler-based app (Rails, Hanami, etc.)
+
+Simply include `Callable` in your class and implement an instance method named `call`:
+
+```ruby
+class SendNotification
+  include Callable
+
+  def initialize(user, message)
+    @user = user
+    @message = message
+  end
+
+  def call
+    NotificationMailer.notify(@user, @message).deliver_now
+  end
+end
+```
+
+### In a plain Ruby script
+
+Require `'callable'`, include `Callable` in your class and implement an instance method named `call`:
+
+```ruby
+require 'callable'
+
+class SendNotification
+  include Callable
+
+  def initialize(user, message)
+    @user = user
+    @message = message
+  end
+
+  def call
+    NotificationMailer.notify(@user, @message).deliver_now
+  end
+end
+```
+
+Then run your class using the `.call` class method:
+
+```ruby
+SendNotification.call(current_user, "Hello from Callable!")
+
+# or use .() (syntactic sugar for .call)
+SendNotification.(current_user, "Hello from Callable!")
+```
+
+
+## Development
+
+After cloning the repo, install dependencies with `bundle install`, then run tests with `bundle exec rspec`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/dbongo/callable-mixin.
+
+## License
+
+The gem is available under the MIT License.

data/lib/callable/mixin.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Callable
+  # Raised when .new fails due to arity / keyword mismatch
+  class ConstructionError < ArgumentError; end
+
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  module ClassMethods
+    ##
+    # Instantiate and immediately invoke #call
+    # @param args [Array] positional arguments for initialize
+    # @param kwargs [Hash] keyword arguments for initialize
+    # @yield [*] optional configuration/result block
+    # @return [Object] whatever the instance #call returns
+    # @raise  [ConstructionError] when instantiation fails
+    def call(*args, **kwargs, &block)
+      inst = begin
+        # avoids Ruby 2.0–2.6 quirk
+        if kwargs.empty?
+          new(*args, &block)
+        else
+          new(*args, **kwargs, &block)
+        end
+      end
+
+      if block_given? && inst.method(:call).arity.zero?
+        inst.call(&block)
+      else
+        inst.call
+      end
+    rescue ArgumentError => error
+      raise ConstructionError,
+            "Failed to construct #{name}.new with the supplied arguments: #{error.message}",
+            error.backtrace
+    end
+  end
+end

data/lib/callable/version.rb

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

data/lib/callable-mixin.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative 'callable'

data/lib/callable.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'callable/version'
+require 'callable/mixin'

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: callable-mixin
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michael Crowther
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.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: Callable provides Ruby classes with a convenient `.call` method, simplifying
+  instantiation and method invocation.
+email:
+- crow404@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/callable-mixin.rb
+- lib/callable.rb
+- lib/callable/mixin.rb
+- lib/callable/version.rb
+homepage: https://github.com/dbongo/callable-mixin
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/dbongo/callable-mixin
+  source_code_uri: https://github.com/dbongo/callable-mixin
+  changelog_uri: https://github.com/dbongo/callable-mixin/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.7
+specification_version: 4
+summary: Lightweight .call mix-in for service objects
+test_files: []