callback-collection 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 78150ace9b1f03ae373409b70582aab42fded3b8ca7cf7268c9e15fcc8eba8a6
+  data.tar.gz: 98fa5ae6f33bc0116f4510d58f698c5e493fd17582843f6b067888d9cf5d82db
+SHA512:
+  metadata.gz: 9473879ba7b4f83ce62116855eff9b7dac6ea4923ed4cd43610490be669792bea01ed6ec273c8de58351b127a33efd36ecf0670da0a681d6116d6ebbc6fa9db4
+  data.tar.gz: f4decc447ab5a9b79a6531fdaf40d0cadec9ecfca4f0f460d85ac8c629df1ae7f4d39aaa83b8bf23f822a7d7558133a4ac99cfb278bbe8364e4a6b2aa348bf4d

data/README.md

@@ -0,0 +1,79 @@
+# Callback Collection
+
+[![Build Status](https://github.com/nicolasva/callback-collection/actions/workflows/ci.yml/badge.svg)](https://github.com/nicolasva/callback-collection/actions/workflows/ci.yml)
+[![Code Climate](https://codeclimate.com/github/nicolasva/callback-collection.svg)](https://codeclimate.com/github/nicolasva/callback-collection)
+[![Gem Version](https://badge.fury.io/rb/callback-collection.svg)](https://badge.fury.io/rb/callback-collection)
+[![Documentation Status](https://img.shields.io/badge/docs-RubyDoc.info-blue.svg)](https://www.rubydoc.info/gems/callback-collection)
+[![Downloads](https://img.shields.io/gem/dt/callback-collection.svg?style=flat)](https://rubygems.org/gems/callback-collection)
+
+Une petite gem Ruby permettant de définir une collection immuable de callbacks
+nommés.
+
+## Installation
+
+Installez la gem depuis RubyGems :
+
+```sh
+gem install callback-collection
+```
+
+Avec Bundler, ajoutez-la au `Gemfile` :
+
+```ruby
+gem "callback-collection"
+```
+
+## Utilisation
+
+```ruby
+require "callback_collection"
+
+callbacks = CallbackCollection.new do |collection|
+  collection.success { |name| "Bienvenue, #{name} !" }
+  collection.failure { |error| "Erreur : #{error.message}" }
+end
+
+callbacks.respond_with(:success, "Ruby")
+# => "Bienvenue, Ruby !"
+```
+
+La collection est figée à la fin de son initialisation. Toute tentative
+d'ajouter ensuite un callback lève une `FrozenError`.
+
+## Développement
+
+```sh
+bundle install
+bundle exec rake
+```
+
+La tâche par défaut exécute la suite Minitest et construit la gem dans `pkg/`.
+L'intégration continue GitHub Actions vérifie le projet avec Ruby 2.7 à 3.4,
+ainsi qu'avec la dernière version stable, Ruby 4.0.
+
+## Publication
+
+La publication sur RubyGems utilise
+[Trusted Publishing](https://guides.rubygems.org/trusted-publishing/) et ne
+nécessite aucune clé API dans les secrets GitHub.
+
+Avant la première publication, créez un *Pending Trusted Publisher* dans votre
+profil RubyGems avec les paramètres suivants :
+
+- gem : `callback-collection`
+- propriétaire du dépôt : `nicolasva`
+- dépôt : `callback-collection`
+- workflow : `release.yml`
+- environnement GitHub : `release`
+
+Publiez ensuite une version en poussant le tag correspondant à
+`CallbackCollection::VERSION` :
+
+```sh
+git tag v0.1.0
+git push origin v0.1.0
+```
+
+GitHub Actions construit et publie alors la gem. RubyDoc génère
+automatiquement sa documentation, et les badges de version et de
+téléchargements deviennent actifs après la première publication.

data/lib/callback_collection/version.rb

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

data/lib/callback_collection.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require_relative "callback_collection/version"
+
+# Stores named callbacks during initialization, then exposes thread-safe reads.
+#
+# @example
+#   callbacks = CallbackCollection.new do |collection|
+#     collection.success { |value| "Received #{value}" }
+#   end
+#
+#   callbacks.respond_with(:success, "data")
+#   # => "Received data"
+class CallbackCollection
+  def initialize
+    callbacks
+    yield(self) if block_given?
+    callbacks.freeze
+  end
+
+  def respond_with(callback, *args, **kwargs, &block)
+    handler = callbacks.fetch(callback) do
+      raise NoMethodError, "No callback '#{callback}' is defined."
+    end
+
+    return handler.call(*args, &block) if kwargs.empty?
+
+    handler.call(*args, **kwargs, &block)
+  end
+
+  def method_missing(method_name, *args, &block)
+    if block
+      raise FrozenError, "Cannot define a callback after initialization." if callbacks.frozen?
+
+      callbacks[method_name] = block
+      self
+    else
+      super
+    end
+  end
+
+  def respond_to_missing?(method_name, include_private = false)
+    callbacks.key?(method_name) || super
+  end
+
+  protected
+
+  def callbacks
+    @callbacks ||= {}
+  end
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: callback-collection
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nicolas Vandenbogaerde
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+- !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'
+description: Define an immutable collection of named callbacks and invoke them with
+  arguments.
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/callback_collection.rb
+- lib/callback_collection/version.rb
+homepage: https://github.com/nicolasva/callback-collection
+licenses: []
+metadata:
+  rubygems_mfa_required: 'true'
+  documentation_uri: https://www.rubydoc.info/gems/callback-collection/0.1.0
+  source_code_uri: https://github.com/nicolasva/callback-collection
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.20
+specification_version: 4
+summary: A small callback collection with a concise Ruby DSL
+test_files: []