call_me_ruby 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2450b371428529143af4c2cdf9d0fa8058b101d8
+  data.tar.gz: 0760e245a0193e08e837718988390231bada6c99
+SHA512:
+  metadata.gz: 95bf4940ac97c77cb529fa6faaa46f948b6a2694e651873c732a653f9c96c47a7d0f052f7ed01eea015e44e5791a6bee08e28730b68a8549ce433805147eb2a5
+  data.tar.gz: c44856fd6ae64c43697b499f098d8d427b4d0cccc97f13fc353ca57e6e07b0dc0115dfbccb29078db96c385b52f83d4554ca9ac71a1e7b18d2a6ab421b9e0e39

data/README.md

@@ -0,0 +1,76 @@
+# Call Me Ruby! [![Build Status](https://travis-ci.org/nathankleyn/call_me_ruby.svg?branch=master)](https://travis-ci.org/nathankleyn/call_me_ruby) [![Coverage Status](https://coveralls.io/repos/nathankleyn/call_me_ruby/badge.png?branch=master)](https://coveralls.io/r/nathankleyn/call_me_ruby?branch=master)
+
+Simple, declarative, ActiveModel style callbacks (aka hooks or events) in Ruby!
+
+## Installing
+
+You can install this gem via RubyGems:
+
+```sh
+gem install call_me_ruby
+```
+
+## Using
+
+Include the mixin in your class and you're away!
+
+Here's how to subscribe to events:
+
+```ruby
+require 'call_me_ruby'
+
+class MyAmazingClass
+  include CallMeRuby
+
+  # When you do subscribe at the class level like this, it's shared between all instances of this class...
+  subscribe :some_event, :will_succeed
+
+  def initialize
+    # But if you do subscribe at the instance level like this, it'll only add the callback to this one instance.
+    subscribe :some_event, :will_fail
+  end
+
+  def will_succeed
+    puts 'foo'
+    # If a callback returns a "truthy" value, than it's considered to have succeeded. However...
+    true
+  end
+
+  def bar
+    # If a callback returns a "falsy" value, then no more callbacks will be called and publish will return false. If
+    # all callbacks succeed, then publish will return true. Use this to make things fail fast as you need.
+    false
+  end
+end
+```
+
+And now you can trigger them:
+
+```ruby
+my_amazing_class = MyAmazingClass.new
+my_amazing_class.publish(:some_event)
+```
+
+## License
+
+The MIT License (MIT)
+
+Copyright (c) 2015 Nathan Kleyn
+
+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/lib/call_me_ruby.rb

@@ -0,0 +1,47 @@
+# A mixin to implement publish/subscribe style callbacks in the class that
+# includes this.
+module CallMeRuby
+  # The self.included idiom. This is described in great detail in a
+  # fantastic blog post here:
+  #
+  # http://www.railstips.org/blog/archives/2009/05/15/include-vs-extend-in-ruby/
+  #
+  # Basically, this idiom allows us to add both instance *and* class methods
+  # to the class that is mixing this module into itself without forcing them
+  # to call extend and include for this mixin. You'll see this idiom everywhere
+  # in the Ruby/Rails world, so we use it too.
+  def self.included(cls)
+    cls.extend(ClassMethods)
+  end
+
+  # Common methods inherited by all classes
+  module ClassMethods
+    def class_callbacks
+      @class_callbacks ||= Hash.new { |h, k| h[k] = [] }
+    end
+
+    def subscribe(*names, sym)
+      names.each do |name|
+        class_callbacks[name] << sym
+      end
+    end
+  end
+
+  def callbacks
+    @callbacks ||= Hash.new { |h, k| h[k] = [] }
+  end
+
+  def subscribe(*names, sym)
+    names.each do |name|
+      callbacks[name] << sym
+    end
+  end
+
+  def publish(name, *args)
+    class_callback_methods = self.class.class_callbacks[name]
+    callback_methods = callbacks[name]
+
+    (class_callback_methods + callback_methods).each { |method| return false unless send(method, *args) }
+    true
+  end
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: call_me_ruby
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Nathan Kleyn
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: filewatcher
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.28'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.28'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: See https://github.com/nathankleyn/call_me_ruby for more information!
+email:
+- nathan@nathankleyn.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/call_me_ruby.rb
+homepage: https://github.com/nathankleyn/call_me_ruby
+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.5
+signing_key: 
+specification_version: 4
+summary: Simple, declarative, ActiveModel style callbacks (aka hooks or events) in
+  Ruby!
+test_files: []