solid_callback 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 921e574702baf327a4d7c3f925f266ded194cac1ca8f3378a0a65a8d37665727
+  data.tar.gz: 6cb662e52538824419e3b089c0e10f8af4571bd4712c492eb28c968736694092
+SHA512:
+  metadata.gz: 1e489657dceb943f10aafbdbc05485589bda6627a3d0d2fb9fd8efc1277356aeb7606011830f6f139bbc029c4271decad67cdb8b6320d37039cf3aeb31e2ffcb
+  data.tar.gz: c378f4c32879c3194e7736f497261396b5eb6cbefea55724a30751444dd91c2f07895d6865c8f45710a10502b016d568d7b88028f74eb90be8b888c38d8ee385

data/.rspec

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

data/.ruby-gemset

@@ -0,0 +1 @@
+solid_callback_2.6.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# 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, 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 e-mail 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 pgokulmca@gmail.com. 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.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in solid_callback.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    solid_callback (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.6.0)
+    rake (13.2.1)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.3)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.2)
+    yard (0.9.37)
+
+PLATFORMS
+  x86_64-darwin-23
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  solid_callback!
+  yard (~> 0.9)
+
+BUNDLED WITH
+   2.2.33

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Gokul
+
+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,197 @@
+# SolidCallback
+
+[![Gem Version](https://badge.fury.io/rb/solid_callback.svg)](https://badge.fury.io/rb/solid_callback)
+[![Build Status](https://github.com/gklsan/solid_callback/workflows/tests/badge.svg)](https://github.com/gklsan/solid_callback/actions)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+SolidCallback adds powerful method interception capabilities to your Ruby classes with near-zero overhead. Clean, flexible, and unobtrusive.
+
+## Features
+
+- 🔄 **Method Lifecycle Hooks**: `before_call`, `after_call`, and `around_call` - intercept methods without modifying their code
+- 🧩 **Zero-coupling**: Keep your business logic and cross-cutting concerns separate
+- 🔍 **Selective targeting**: Apply callbacks to specific methods or all methods
+- ⚡ **Performance-focused**: Minimal overhead through efficient method wrapping
+- 🔒 **Thread-safe**: Safely use in concurrent applications
+- 📝 **Conditional execution**: Run callbacks only when specific conditions are met
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'solid_callback'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself:
+
+```bash
+$ gem install solid_callback
+```
+
+## Usage
+
+### Basic Example
+
+```ruby
+require 'solid_callback'
+
+class UserService
+  include SolidCallback
+  
+  before_call :authenticate
+  after_call :log_activity
+  around_call :measure_performance
+  
+  def find_user(id)
+    puts "Finding user with ID: #{id}"
+    { id: id, name: "User #{id}" }
+  end
+  
+  def update_user(id, attributes)
+    puts "Updating user #{id} with #{attributes}"
+    { id: id, updated: true }
+  end
+  
+  private
+  
+  def authenticate
+    puts "🔐 Authenticating request"
+  end
+  
+  def log_activity
+    puts "📝 Logging activity"
+  end
+  
+  def measure_performance
+    start_time = Time.now
+    result = yield  # Execute the original method
+    duration = Time.now - start_time
+    puts "⏱️ Method took #{duration} seconds"
+    result  # Return the original result
+  end
+end
+
+service = UserService.new
+service.find_user(42)
+```
+
+### Advanced Usage
+
+Apply callbacks to specific methods:
+
+```ruby
+class PaymentProcessor
+  include SolidCallback
+  
+  before_call :validate_amount, only: [:charge, :refund]
+  after_call :send_receipt, only: [:charge]
+  after_call :notify_fraud_department, only: [:flag_suspicious]
+  around_call :transaction, only: [:charge, :refund]
+  
+  # Rest of class...
+end
+```
+
+Use conditional callbacks:
+
+```ruby
+class DocumentProcessor
+  include SolidCallback
+  
+  attr_reader :document_size
+  
+  before_call :check_permissions
+  before_call :backup_document, if: :large_document?
+  around_call :with_retry, unless: :read_only?
+  
+  def process_document(doc)
+    # Implementation...
+  end
+  
+  private
+  
+  def large_document?
+    @document_size > 10_000
+  end
+  
+  def read_only?
+    # Some condition
+  end
+end
+```
+
+You can even use procs for conditions:
+
+```ruby
+before_call :notify_admin, if: -> { Rails.env.production? }
+```
+
+### Skipping Callbacks
+
+Skip callbacks for specific methods:
+
+```ruby
+class ApiService
+  include SolidCallback
+  
+  before_call :rate_limit
+  
+  skip_callbacks_for :health_check
+  
+  def get_data
+    # Implementation...
+  end
+  
+  def health_check
+    # This method won't trigger the rate_limit callback
+    { status: "ok" }
+  end
+end
+```
+
+## Callback Options
+
+Each callback method accepts the following options:
+
+| Option | Description |
+|--------|-------------|
+| `only` | Array of method names to which the callback applies |
+| `except` | Array of method names to which the callback does not apply |
+| `if` | Symbol (method name) or Proc that must return true for the callback to run |
+| `unless` | Symbol (method name) or Proc that must return false for the callback to run |
+
+## How It Works
+
+Callbacker uses Ruby's metaprogramming to wrap your methods with callback functionality:
+
+1. When included, it extends your class with callback registration methods
+2. When a callback is registered, it stores the configuration
+3. When a method is defined, it wraps the method with callback handling code
+4. When the method is called, it executes the callbacks in the proper order
+
+## 📚 Use Cases
+
+- Authentication & Authorization
+- Logging & Monitoring
+- Caching
+- Performance measurement
+- Error handling
+- Background job retries
+- Transaction management
+- Input validation
+- Data transformation
+
+## 🤝 Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/gklsan/solid_callback.
+
+## 📄 License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

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: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "solid_callback"
+
+# 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/solid_callback/core.rb

@@ -0,0 +1,98 @@
+module SolidCallback
+  module Core
+    # Get all callbacks of a specific type
+    def callbacks_for(type)
+      @_solid_callback_store ||= { before: {}, after: {}, around: {} }
+      @_solid_callback_store[type]
+    end
+
+    # Register a callback
+    def register_callback(type, callback_method, options = {})
+      # Make sure callback store exists
+      @_solid_callback_store ||= { before: {}, after: {}, around: {} }
+
+      # Normalize options
+      only = Array(options[:only] || :all)
+      except = Array(options[:except] || [])
+      if_condition = options[:if]
+      unless_condition = options[:unless]
+
+      # Store the callback information
+      @_solid_callback_store[type][callback_method] = {
+        method: callback_method,
+        only: only,
+        except: except,
+        if: if_condition,
+        unless: unless_condition
+      }
+    end
+
+    # Check if a callback should be run for a method
+    def callback_applicable?(callback, method_name, instance)
+      # Check only/except constraints
+      return false if callback[:except].include?(method_name)
+      return false unless callback[:only] == [:all] || callback[:only].include?(method_name)
+
+      # Check conditional constraints
+      if callback[:if]
+        condition = callback[:if]
+        return false unless evaluate_condition(condition, instance)
+      end
+
+      if callback[:unless]
+        condition = callback[:unless]
+        return false if evaluate_condition(condition, instance)
+      end
+
+      true
+    end
+
+    # Evaluate a condition (symbol method name, proc, or lambda)
+    def evaluate_condition(condition, instance)
+      case condition
+      when Symbol, String
+        instance.send(condition)
+      when Proc
+        instance.instance_exec(&condition)
+      else
+        true
+      end
+    end
+
+    # Handle method_added hook
+    def handle_method_added(method_name)
+      # Skip if we're in the process of defining a wrapped method
+      return if @_solid_callback_wrapping_method
+
+      # Skip special methods and private/protected methods
+      return if method_name.to_s.start_with?('_solid_callback_')
+      return if private_method_defined?(method_name) || protected_method_defined?(method_name)
+
+      wrap_method_with_callbacks(method_name)
+    end
+
+    # Wrap a method with callbacks
+    def wrap_method_with_callbacks(method_name)
+      return unless instance_methods(false).include?(method_name)
+
+      @_solid_callback_wrapping_method = true
+
+      # Create a reference to the original method
+      alias_method "_solid_callback_original_#{method_name}", method_name
+
+      # Redefine the method with callbacks
+      define_method(method_name) do |*args, &block|
+        run_callbacks(:before, method_name)
+
+        # Execute around callbacks or the original method
+        result = run_around_callbacks(method_name, args, block)
+
+        run_callbacks(:after, method_name)
+
+        result
+      end
+
+      @_solid_callback_wrapping_method = false
+    end
+  end
+end

data/lib/solid_callback/hooks.rb

@@ -0,0 +1,31 @@
+module SolidCallback
+  module Hooks
+    # Before hooks
+    def before_call(method_name, options = {})
+      register_callback(:before, method_name, options)
+    end
+
+    # After hooks
+    def after_call(method_name, options = {})
+      register_callback(:after, method_name, options)
+    end
+
+    # Around hooks
+    def around_call(method_name, options = {})
+      register_callback(:around, method_name, options)
+    end
+
+    # Register all methods that need callbacks
+    def wrap_methods(*method_names)
+      method_names.each do |method_name|
+        wrap_method_with_callbacks(method_name) if method_defined?(method_name)
+      end
+    end
+
+    # Skip callbacks for specific methods
+    def skip_callbacks_for(*method_names)
+      @_solid_callback_skip_methods ||= []
+      @_solid_callback_skip_methods.concat(method_names)
+    end
+  end
+end

data/lib/solid_callback/method_wrapper.rb

@@ -0,0 +1,55 @@
+module SolidCallback
+  module MethodWrapper
+    private
+
+    # Run callbacks of a specific type for a method
+    def run_callbacks(type, method_name)
+      callbacks = self.class.callbacks_for(type)
+      return if callbacks.nil? || callbacks.empty?
+
+      callbacks.each do |callback_method, callback_config|
+        next unless self.class.callback_applicable?(callback_config, method_name, self)
+        send(callback_method)
+      end
+    end
+
+    # Run around callbacks as a chain
+    def run_around_callbacks(method_name, args, block)
+      around_callbacks = collect_applicable_around_callbacks(method_name)
+
+      if around_callbacks.empty?
+        # No around callbacks, directly call the original method
+        send("_solid_callback_original_#{method_name}", *args, &block)
+      else
+        # Execute the chain of around callbacks
+        execute_around_chain(around_callbacks, 0, method_name, args, block)
+      end
+    end
+
+    # Collect all applicable around callbacks for a method
+    def collect_applicable_around_callbacks(method_name)
+      callbacks = self.class.callbacks_for(:around)
+      return [] if callbacks.nil? || callbacks.empty?
+
+      callbacks.select do |_, callback_config|
+        self.class.callback_applicable?(callback_config, method_name, self)
+      end.map { |callback_method, _| callback_method }
+    end
+
+    # Execute the chain of around callbacks
+    def execute_around_chain(callbacks, index, method_name, args, block)
+      if index >= callbacks.length
+        # End of the chain, call the original method
+        send("_solid_callback_original_#{method_name}", *args, &block)
+      else
+        # Call the next callback in the chain
+        callback_method = callbacks[index]
+
+        # Call the around callback with a continuation to the next callback
+        send(callback_method) do
+          execute_around_chain(callbacks, index + 1, method_name, args, block)
+        end
+      end
+    end
+  end
+end

data/lib/solid_callback/version.rb

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

data/lib/solid_callback.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "solid_callback/version"
+require "solid_callback/core"
+require "solid_callback/hooks"
+require "solid_callback/method_wrapper"
+
+module SolidCallback
+  class Error < StandardError; end
+
+  # This method is called when the module is included in a class
+  def self.included(base)
+    base.extend(SolidCallback::Core)
+    base.extend(SolidCallback::Hooks)
+    base.send(:include, SolidCallback::MethodWrapper)
+
+    # Initialize callback store on the class
+    base.instance_variable_set(:@_solid_callback_store, {
+      before: {},
+      after: {},
+      around: {}
+    })
+
+    # Setup method_added hook to handle methods defined after including SolidCallback
+    base.singleton_class.prepend(Module.new do
+      def method_added(method_name)
+        super
+        # Delegate to SolidCallback's method added handler
+        handle_method_added(method_name) if respond_to?(:handle_method_added)
+      end
+    end)
+  end
+end

data/sig/solid_callback.rbs

@@ -0,0 +1,4 @@
+module SolidCallback
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: solid_callback
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Gokul
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2025-03-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: SolidCallback adds powerful method interception capabilities to your
+  Ruby classes with near-zero overhead. Clean, flexible, and unobtrusive.
+email:
+- pgokulmca@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".ruby-gemset"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/solid_callback.rb
+- lib/solid_callback/core.rb
+- lib/solid_callback/hooks.rb
+- lib/solid_callback/method_wrapper.rb
+- lib/solid_callback/version.rb
+- sig/solid_callback.rbs
+homepage: https://github.com/gklsan/solid_callback
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/gklsan/solid_callback
+  source_code_uri: https://github.com/gklsan/solid_callback
+  changelog_uri: https://github.com/gklsan/solid_callback/releases
+  bug_tracker_uri: https://github.com/gklsan/solid_callback/issues
+  documentation_uri: https://rubydoc.info/github/gklsan/solid_callback
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3.1
+signing_key: 
+specification_version: 4
+summary: SolidCallback adds powerful method interception capabilities to your Ruby
+  classes with near-zero overhead. Clean, flexible, and unobtrusive.
+test_files: []