callbacks_attachable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a97fe4afa9fe03a90e7b5194914e27c8e0c8a25f
+  data.tar.gz: 70b01c27f7d5a7f4136e98d27021ac244ce02e6a
+SHA512:
+  metadata.gz: c7560a2ed1d41cdd5b6e80916bb77b31ae52eaa05257117f6245df012205cea3ab8f6e1fbe3b6f353fcead414a8ea21304dbe6ca4ab15005320aa470390882c8
+  data.tar.gz: 4ed4f18aba606945c81c9886efce2d54052378027e6f56b57bf12f7cde0184163699f6544a19fade0a5c51aa03146c60cfae88b35713f147aec7b6605124d214

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.0

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Christopher Aue
+
+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,125 @@
+# CallbacksAttachable
+
+Attach callbacks to every ruby object including this mixin. Trigger all
+callbacks attached under the same namespace and detach callback when you no
+longer need them.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'callbacks_attachable'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install callbacks_attachable
+
+## Usage
+
+```ruby
+require 'callbacks_attachable'
+
+class CallbacksHolder
+    include CallbacksAttachable
+end
+```
+
+### Callbacks attached to the class
+
+Attach callbacks to the class:
+
+```ruby
+callback = CallbacksHolder.on(:event) do |method|
+    puts self.__send__(method)
+end
+```
+
+Callbacks attached to the class are executed in the context of it, i.e. `self`
+points to the class.
+
+Trigger all `:event` callbacks with:
+
+```ruby
+CallbacksHolder.trigger(:event, :name) # => puts 'CallbacksHolder'
+```
+
+The second and further arguments given to `.trigger` are passed down to the
+callback.
+
+Callbacks can be executed in the context of a different context by passing the
+`context` option to `.trigger`:
+
+```ruby
+object = Object.new
+CallbacksHolder.trigger(:event, :__id__, context: object)
+# => puts the result of object.__id__
+```
+
+To detach a callback call `.off` with the event namespace and the callback
+handle returned by `.on`:
+
+```ruby
+CallbacksHolder.off(:event, callback)
+CallbacksHolder.trigger(:event, :name)  # => nothing will happen
+```
+
+If you want to execute a callback just a single time attach it with `.once_on`:
+
+```ruby
+CallbacksHolder.once_on(:singularity) { puts 'callback called!' }
+CallbacksHolder.trigger(:singularity) # => puts 'callback called!' and immediately
+                                      #    detaches the callback
+CallbacksHolder.trigger(:singularity) # => does nothing
+```
+
+To detach a callback when a condition is met use `.until_true_on`. The callback
+will be detached if it has a truthy (!) return value.
+
+```ruby
+counter = 0
+CallbacksHolder.until_true_on(:count_to_two) do
+    puts counter
+    counter >= 2
+end
+
+CallbacksHolder.trigger(:count_to_two) # => puts 0
+CallbacksHolder.trigger(:count_to_two) # => puts 1
+CallbacksHolder.trigger(:count_to_two) # => puts 2 and detaches the callback
+CallbacksHolder.trigger(:count_to_two) # => does nothing
+```
+
+### Callbacks attached to an instance
+
+All above mentioned methods on the class level also exist for each instance of
+the class. Callbacks are executed if the instance they are attached to or their
+class calls `#trigger`.
+
+Callbacks are called in their lexical scope. So, `self` inside and outside
+the callback is the same object. The context of a callback cannot be changed
+with the `context` option of the `#trigger` method as it is possible for
+class callbacks.
+
+```ruby
+callbacks_holder1 = CallbacksHolder.new
+callbacks_holder2 = CallbacksHolder.new
+
+callback1 = callbacks_holder1.on(:event) { puts 'This is #1!' }
+callback2 = callbacks_holder2.on(:event) { puts 'This is #2!' }
+
+callbacks_holder1.trigger(:event) # => puts 'This is #1!'
+callbacks_holder2.trigger(:event) # => puts 'This is #2!'
+
+CallbacksHolder.trigger(:event) # => puts 'This is #1!' and 'This is #2!'
+
+callbacks_holder1.off(:event, callback)
+callbacks_holder2.off(:event, callback)
+```
+
+The two methods `#once_on` and `#until_true_on` are available for instances,
+too, and work as you'd expect.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/callbacks_attachable.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'callbacks_attachable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "callbacks_attachable"
+  spec.version       = CallbacksAttachable::VERSION
+  spec.authors       = ["Christopher Aue"]
+  spec.email         = ["mail@christopheraue.net"]
+
+  spec.summary       = %q{Attach callbacks to ruby objects. Then, trigger and detach them.}
+  spec.homepage      = "https://github.com/christopheraue/ruby-callbacks_attachable"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/callbacks_attachable/version.rb

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

data/lib/callbacks_attachable.rb

@@ -0,0 +1,87 @@
+require "callbacks_attachable/version"
+
+module CallbacksAttachable
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  module ClassMethods
+    def on(event, &callback)
+      callbacks[event] ||= []
+      callbacks[event] << callback
+      callback
+    end
+
+    def once_on(event, &callback)
+      klass = self
+      registered_callback = on(event) do |*args|
+        klass.off(event, registered_callback)
+        instance_exec(*args, &callback)
+      end
+    end
+
+    def until_true_on(event, &callback)
+      klass = self
+      registered_callback = on(event) do |*args|
+        klass.off(event, registered_callback) if instance_exec(*args, &callback)
+      end
+    end
+
+    def trigger(event, *args, context: self)
+      return true unless callbacks[event]
+
+      # dup the callback list so that removing callbacks while iterating does
+      # still call all callbacks during map.
+      callbacks[event].dup.map do |callback|
+        context.instance_exec(*args, &callback)
+      end.all?
+    end
+
+    def off(event, callback)
+      if callbacks[event]
+        callbacks[event].delete(callback)
+        callbacks.delete(event) if callbacks[event].empty?
+      end
+      true
+    end
+
+    private
+
+    def callbacks
+      @callbacks ||= {}
+    end
+  end
+
+  def on(event, &block)
+    if_self(:on, event, &block)
+  end
+
+  def once_on(event, &block)
+    if_self(:until_true_on, event) do |*args|
+      block.call(*args)
+      true
+    end
+  end
+
+  def until_true_on(event, &block)
+    if_self(:until_true_on, event, &block)
+  end
+
+  def trigger(event, *args)
+    self.class.trigger(event, *args, context: self)
+  end
+
+  def off(event, callback)
+    self.class.off(event, callback)
+  end
+
+  private
+
+  def if_self(method, event, &block)
+    instance = self
+    self.class.__send__(method, event) do |*args|
+      next false if instance != self
+      block.call(*args)
+    end
+  end
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: callbacks_attachable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Christopher Aue
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !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'
+description: 
+email:
+- mail@christopheraue.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- callbacks_attachable.gemspec
+- lib/callbacks_attachable.rb
+- lib/callbacks_attachable/version.rb
+homepage: https://github.com/christopheraue/ruby-callbacks_attachable
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Attach callbacks to ruby objects. Then, trigger and detach them.
+test_files: []