spray_vent 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9cebd3fc39cdcc5279ffcf9510357f90a4bb509e
+  data.tar.gz: 711b031778657fcd7c5c4a53393c3ed70a74d62e
+SHA512:
+  metadata.gz: c544f24ea297c4236502c58b941e8bc77d07172075065efd4ad63eae9735dc33f2a7fe4d84c6e96036cadaee4d3128698782b2cb8e4d7387713e9cfe482870f0
+  data.tar.gz: 648e3af25a0946814b125bdd541ed6f0042b6bfa6d3c19d94a128e12e2fd516b73e1086eaeda487c5c390ef0668b94880bfee5b164acd8fa8bfdf0af7462a571

data/lib/spray_vent.rb

@@ -0,0 +1,27 @@
+# @author Charles Sprayberry
+# @copyright Copyright (c) 2013 Charles Sprayberry
+# @license OSI MIT
+
+Dir[File.dirname(__FILE__) + "/**/*.rb"].each {|f| require f}
+
+# The module that exposes the primary API that allows any object to easily handle events being added and triggered on it
+#
+# Please note that we are using prefixes on instance variables ON PURPOSE; please do not remove the instance prefixes
+module SprayVent
+
+  # Sets up the event mediator that will be used to manage the instances events
+  #
+  # @return void
+  def event_init
+    @eventable_events = Mediator.new(self)
+  end
+
+  # Returns the event mediator attached to the instance that handles the adding and triggering of events
+  #
+  # @return Eventable::Mediator
+  def events
+    event_init if @eventable_events.nil?
+    @eventable_events
+  end
+
+end

data/lib/spray_vent/errors/invalid_handler_error.rb

@@ -0,0 +1,10 @@
+#
+# @author Charles Sprayberry
+# @copyright Copyright (c) 2013 Charles Sprayberry
+# @license OSI MIT
+
+module SprayVent
+  class InvalidHandlerError < ::RuntimeError
+  end
+end
+

data/lib/spray_vent/event.rb

@@ -0,0 +1,29 @@
+#
+# @author Charles Sprayberry
+# @copyright Copyright (c) 2013 Charles Sprayberry
+# @license OSI MIT
+
+module SprayVent
+  class Event
+
+    attr_reader :target, :name, :args
+    @cancel = false
+
+    def initialize(name, target, args = nil)
+      @name = name
+      @target = target
+      args ||= []
+      @args = args
+    end
+
+    def cancel
+      @cancel = true
+    end
+
+    def cancel?
+      @cancel
+    end
+
+  end
+end
+

data/lib/spray_vent/mediator.rb

@@ -0,0 +1,72 @@
+# @author Charles Sprayberry
+# @copyright Copyright (c) 2013 Charles Sprayberry, Dyana Sprayberry
+# @license OSI MIT
+
+module SprayVent
+
+  # Object responsible for storing and triggering handlers associated to particular events.
+  #
+  # This is the primarily used object when working Eventable.
+  class Mediator
+
+    # Ensures that a collection of events is ready.
+    def initialize(target)
+      @events = {}
+      @target = target
+    end
+
+    # Adds an event handler attached to the event associated to name symbol.
+    #
+    # Although this implementation allows passing multiple parameters only the 2nd parameter
+    # passed will be used and that value MUST respond_to :call.
+    #
+    # @param name [String] the name of the event you want to invoke when
+    # @param args [Array] an array of arguments passed to the method
+    # @raises [Eventable::InvalidHandlerError]
+    def method_missing(name, *args)
+      handler = block_given? ? Proc.new : args[0]
+      raise invalid_handler if !handler.respond_to? :call
+
+      name = name.to_sym
+      @events[name] = [] if @events[name].nil?
+      @events[name] << handler
+    end
+
+    # Retrieves a collection of event handlers associated to the event_name passed.
+    #
+    # @param event_name [String] the name of the event collection you are wanting to retrieve
+    # @param event_name [Symbol] the name of the event collection you are wanting to retrieve
+    # @return [Array]
+    def [](event_name)
+      @events[event_name.to_sym]
+    end
+
+    # Will create an Eventable::Event associated to event_name and invoke all handlers associated to that
+    # event_name.
+    #
+    # @param event_name [String] handlers associated to event name passed
+    # @param event_name [Symbol] handlers associated to event name passed
+    # @return [Eventable::Event]
+    def trigger(event_name, *args)
+      name = event_name.to_sym
+      # we are creating this outside of the unless block because we want to return the event every time
+      event = SprayVent::Event.new name, @target, args
+      unless @events[name].nil?
+        @events[name].each do |handler|
+          break if event.cancel?
+          handler.call event
+        end
+      end
+    end
+
+    private
+
+      def invalid_handler
+        InvalidHandlerError.new 'An object that responds to :call must be provided to Eventable::Mediator when adding event handlers'
+      end
+
+  end
+
+end
+
+

metadata

@@ -0,0 +1,48 @@
+--- !ruby/object:Gem::Specification
+name: spray_vent
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Charles Sprayberry
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-19 00:00:00.000000000 Z
+dependencies: []
+description: A library that allows you to easily mixin spray_vent behavior on a variety
+  of objects
+email: cspray+spray_vent-ruby@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/spray_vent.rb
+- lib/spray_vent/errors/invalid_handler_error.rb
+- lib/spray_vent/event.rb
+- lib/spray_vent/mediator.rb
+homepage: https://github.com/cspray/spray_vent
+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.2.1
+signing_key: 
+specification_version: 4
+summary: spray_vent
+test_files: []