wires 0.3.1 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8ba5a18e82d8030466a788523b4cf1a35444a7ee
-  data.tar.gz: 358f486714e9b7b2d91103966a08c6591d6b4b88
+  metadata.gz: 5fdeb24aaafdf868235513ef33e917af84f0b592
+  data.tar.gz: cbc000d9911fd5e6cb76210468a7ff5e685e3f2a
 SHA512:
-  metadata.gz: d04c8d15e06683af78f41167c30443209063ff38561229006ad2d35e94cfb924c570daee44344092e95b81dc9515399f10509fdfdaea5d00dc3ea1375ed4a564
-  data.tar.gz: ee87a782456ba1f9cd1572edda652cde60e7e4d66e1721e59e21fe8eb660b043f5f2bdd0f90c8bf1b3f68665196c3271906528d55715bc07c563b73892f0f87e
+  metadata.gz: 32ffa931974f65688b1d3fad28f9b6700f0fea89db796a476148e9f30962c617fcc9954e7971f7cc8247da544edc281401071e4c7b5c56aa5b2c2b40af6daf0f
+  data.tar.gz: c7ae3f0a167d127928ecce570c4f069c735f497f3803de97dde13e15ec8e8f4502190a2df58e65565ff51940d4e156fd385099cf10458264dada31bba0631455

data/lib/wires/channel.rb

@@ -1,28 +1,4 @@
 
-module Wires
-  module Convenience
-    
-    def on(events, channels='*', &codeblock)
-      channels = [channels] unless channels.is_a? Array
-      for channel in channels
-        Wires::Channel.new(channel).register(events, codeblock)
-      end
-    nil end
-    
-    def fire(event, channel='*') 
-      Wires::Channel.new(channel).fire(event, blocking:false)
-    nil end
-    
-    def fire_and_wait(event, channel='*') 
-      Wires::Channel.new(channel).fire(event, blocking:true)
-    nil end
-    
-    def Channel(*args) Wires::Channel.new(*args) end
-    
-  end
-end
-
-
 module Wires
   
   class Channel
@@ -40,25 +16,20 @@ module Wires
     # Don't redefine this instance method!
     def hub; self.class.hub; end
     
-    # Channel registry hash and star channel reference are values
-    # In this Hash with the key being the reference to the Hub
-    @@channel_hash = Hash.new
-    @@channel_star = Hash.new
-    
     # Give out references to the star channel
-    def self.channel_star; @@channel_star[self.hub]; end
-    def      channel_star; @@channel_star[self.hub]; end
+    def self.channel_star; @@channel_star; end
+    def      channel_star; @@channel_star; end
     
     # Ensure that there is only one instance of Channel per name
     @@new_lock = Mutex.new
     def self.new(*args, &block)
       (args.include? :recursion_guard) ?
         (args.delete :recursion_guard) :
-        (@@channel_star[self.hub] ||= self.new('*', :recursion_guard))
+        (@@channel_star ||= self.new('*', :recursion_guard))
       
       @@new_lock.synchronize do
-        @@channel_hash[self.hub] ||= Hash.new
-        @@channel_hash[self.hub][args[0]] ||= super(*args, &block)
+        @@channel_hash ||= Hash.new
+        @@channel_hash[args[0]] ||= super(*args, &block)
       end
     end
     
@@ -77,13 +48,42 @@ module Wires
       @target_list << [events, proc]
     nil end
     
+    # Register hook to execute before fire - can call multiple times
+    def self.before_fire(retain=false, &block)
+      @before_fires ||= []
+      @before_fires << [block, retain]
+    nil end
+    
+    # Register hook to execute after fire - can call multiple times
+    def self.after_fire(retain=false, &block)
+      @after_fires ||= []
+      @after_fires << [block, retain]
+    nil end
+    
+    def self.run_hooks(hooks_sym, *exc_args)
+      hooks = self.instance_variable_get(hooks_sym.to_sym)
+      for hook in hooks
+        proc, retain = hook
+        proc.call(*exc_args)
+      end if hooks
+    nil end
+    
+    def self.clear_hooks(hooks_sym, force=false)
+      hooks = self.instance_variable_get(hooks_sym.to_sym)
+      self.instance_variable_set(hooks_sym.to_sym,
+        (force ? [] : hooks.select{|h| h[1]})) if hooks
+    nil end
+    
     # Fire an event on this channel
     def fire(event, blocking:false)
+      
       backtrace = caller
       
       # Create an instance object from one of several acceptable input forms
       event = Event.new_from event
       
+      self.class.run_hooks(:@before_fires, event, self)
+      
       # Fire to each relevant target on each channel
       for chan in relevant_channels()
         for target in chan.target_list
@@ -91,10 +91,12 @@ module Wires
             self.class.hub.spawn(event, string, *target[1], blocking, backtrace)
       end end end
       
+      self.class.run_hooks(:@after_fires, event, self)
+      
     nil end
     
     def relevant_channels
-      return @@channel_hash[hub].values if self==channel_star
+      return @@channel_hash.values if self==channel_star
         
       relevant = [channel_star]
       my_names = (self.name.is_a? Array) ? self.name : [self.name]
@@ -107,7 +109,7 @@ module Wires
           "Cannot fire on Regexp channel: #{self.name}."\
           "  Regexp channels can only used in event handlers." end
         
-        for other_chan in @@channel_hash[hub].values
+        for other_chan in @@channel_hash.values
           
           other_name = other_chan.name
           other_name = (other_name.respond_to? :channel_name) ? \
@@ -127,6 +129,16 @@ module Wires
       return relevant.uniq
     end
     
+    # Compare matching with another Channel
+    def =~(other)
+      (other.is_a? Channel) ? (other.relevant_channels.include? self) : super
+    end
+    
+    hub.before_kill(true) do
+      self.clear_hooks(:@before_fires)
+      self.clear_hooks(:@after_fires)
+    end
+    
   end
   
 end

data/lib/wires/convenience.rb

@@ -0,0 +1,48 @@
+
+module Wires
+
+  module Convenience
+    
+    def on(events, channels='*', &codeblock)
+      channels = [channels] unless channels.is_a? Array
+      for channel in channels
+        Channel.new(channel).register(events, codeblock)
+      end
+    nil end
+    
+    def fire(event, channel='*') 
+      Channel.new(channel).fire(event, blocking:false)
+    nil end
+    
+    def fire_and_wait(event, channel='*') 
+      Channel.new(channel).fire(event, blocking:true)
+    nil end
+    
+    def fire_every(interval, event, channel='*', **kwargs)
+      Wires::TimeScheduler << \
+        Wires::TimeSchedulerItem.new(self, event, channel, **kwargs)
+    end
+    
+    def Channel(*args) Channel.new(*args) end
+    
+    class << self
+      def prefix_methods(prefix)
+        
+        return unless prefix
+        prefix = prefix.to_s
+        
+        instance_methods.each do |thing|
+          thing = thing.to_s
+          f2 = (prefix+'_'+thing)
+          f2 = (thing[0]=~/[[:lower:]]/) ? f2.underscore : f2.camelcase
+          f2 = f2.to_sym; thing = thing.to_sym
+          alias_method f2, thing
+          remove_method thing
+        end
+        
+      end
+    end
+    
+  end
+
+end

data/lib/wires/event.rb

@@ -1,30 +1,27 @@
 
 module Wires
-  # Store a list of all Event classes that get loaded.
-  class EventRegistry
-    @@registry = []
-    
-    def self.<<(cls)
-      @@registry << cls
-      @@registry.uniq!
-    end
-    
-    def self.list
-      @@registry
+  
+  class Event
+    class << self
+      def event_registry_create
+        @@registry = []
+        event_registry_register
+      end
+      def event_registry_register(cls=self)
+        @@registry << cls
+        @@registry.uniq!
+      end
     end
+    event_registry_create
   end
   
   # All Event classes should inherit from this one
-  class Event < Object # explicit for the sake of Event.ancestry
-    
-    # Register with the EventRegistry and make subclasses do the same
-    EventRegistry << self
+  class Event
     
     # Operate on the metaclass as a type of singleton pattern
     class << self
       
       def inherited(subcls)
-        
         # Be sure codestring doesn't conflict
         existing = _from_codestring(subcls.codestring)
         if existing then raise NameError, \
@@ -32,10 +29,9 @@ module Wires
           " existing Event subclass '#{existing}'."\
           " The generated codestring '#{subcls.codestring}'"\
           " must be unique for each Event subclass." end
-          
-        # Register, then call super
-        EventRegistry << subcls
+        
         super
+        event_registry_register(subcls)
       end
       
       # List of class inheritance lineage back to but excluding Object
@@ -60,8 +56,7 @@ module Wires
       # Pull class from registry by codestring 
       # (more reliable than crafting a reverse regexp)
       def _from_codestring(str)
-        return EventRegistry.list
-        .select{|e| e.codestring==str}[0]
+        return @@registry.select{|e| e.codestring==str}[0]
       end; private :_from_codestring
       
       def from_codestring(str)
@@ -84,7 +79,7 @@ module Wires
           when Event
             input
           when Class
-            input.new(*args) if input < Event
+            input.new(*args) if input <= Event
           else
             Event.from_codestring(input.to_s).new(*args)
         end
@@ -96,9 +91,9 @@ module Wires
       def new(*args, &block)
         obj = super
         
-        kwargs = args[-1].is_a?(Hash) ? args.pop : Hash.new
-        kwargs[:kwargs] = kwargs.clone.freeze
-        kwargs[:args] = args
+        kwargs = args[-1].is_a?(Hash) ? args.pop.dup : Hash.new
+        kwargs[:kwargs] = kwargs.dup.freeze
+        kwargs[:args]   =   args.dup.freeze
         kwargs[:codeblock] = block if block
         for key in kwargs.keys
           att = key.to_s
@@ -114,15 +109,24 @@ module Wires
     
     # Calling super in new with *args will complain if this isn't here
     def initialize(*args, &block) end
+    
   end
   
-  
   #
   # Comparison support for Events and Symbols/Strings
   #
   
   # Reopen Event and add comparison functions
   class Event
+    
+    def =~(other)
+      (other.is_a? Event) ? 
+        ((self.class >= other.class) \
+          and (not self.kwargs.each_pair.detect{|k,v| other.kwargs[k]!=v}) \
+          and (not self.args.each_with_index.detect{|a,i| other.args[i]!=a})) :
+        super
+    end
+    
     class << self
       def ==(other)
         other.is_a?(Class) ? 

data/lib/wires/hub.rb

@@ -2,7 +2,7 @@
 module Wires
   # An Event Hub. Event/proc associations come in, and the procs 
   # get called in new threads in the order received
-  class Hub
+  class self::Hub
     # Operate on the metaclass as a type of singleton pattern
     class << self
       
@@ -25,10 +25,12 @@ module Wires
         @spawning_count      = 0
         @spawning_count_lock = Monitor.new
         
-        @before_runs = Queue.new
-        @after_runs  = Queue.new
+        @before_runs  = Queue.new
+        @after_runs   = Queue.new
         @before_kills = Queue.new
         @after_kills  = Queue.new
+        @before_fires = []
+        @after_fires  = []
         
         @please_finish_all = false
         
@@ -119,7 +121,7 @@ module Wires
       
       # Spawn a task
       def spawn(*args) # :args: event, ch_string, proc, blocking, fire_bt
-
+        
         @spawning_count_lock.synchronize { @spawning_count += 1 }
         
         return neglect(*args) if dead?
@@ -240,19 +242,34 @@ module Wires
       nil end
       
       # Flush/run queue of [proc, retain]s, retaining those with retain==true
-      def run_hooks(hooks)
+      def run_hooks(hooks, *args)
         retained = Queue.new
         while not hooks.empty?
           proc, retain = hooks.shift
           retained << [proc, retain] if retain
-          proc.call
-          # flush_queue if alive?
+          proc.call(*args)
         end
         while not retained.empty?
           hooks << retained.shift
         end
       nil end
       
+      # Run queue of [proc, retain]s, retaining all
+      def run_fire_hooks(hooks, *args)
+        for hook in hooks
+          proc, retain = hook
+          proc.call(*args)
+        end
+      nil end
+      
+      # Clear queue of [proc, retain]s, retaining those with retain==true
+      def clear_fire_hooks(hooks, *args)
+        hooks.select! do |hook|
+          proc, retain = hook
+          retain
+        end
+      nil end
+      
     end
     
     
@@ -292,6 +309,8 @@ module Wires
             before { join_children if @please_finish_all }
             after  { @please_finish_all = false }
             after  { run_hooks @after_kills }
+            after  { clear_fire_hooks @before_fires }
+            after  { clear_fire_hooks @after_fires  }
           end
         end
         

data/lib/wires/time.rb

@@ -177,13 +177,13 @@ module Wires
     end
     
     # Start the main loop upon run of Hub
-    Hub.after_run(retain:true) do 
+    Hub.after_run(true) do 
       @keepgoing = true
       @thread = Thread.new { main_loop }
     end
     
     # Stop the main loop upon death of Hub
-    Hub.before_kill(retain:true) do
+    Hub.before_kill(true) do
       Thread.exclusive do
         @keepgoing=false
         @next_pass=Time.now

data/lib/wires.rb

@@ -10,4 +10,6 @@ require 'wires/hub'
 require 'wires/channel'
 require 'wires/time'
 
-include Wires::Convenience # require 'wires/clean' to uninclude Convenience
+require 'wires/convenience'
+include Wires::Convenience # require 'wires/clean' to uninclude Convenience
+

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: wires
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.3
 platform: ruby
 authors:
 - Joe McIlvain
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-23 00:00:00.000000000 Z
+date: 2013-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: activesupport-core-ext
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: wires-test
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: turn
+  name: jemc-reporter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -106,6 +106,7 @@ files:
 - lib/wires/hub.rb
 - lib/wires/expect_type.rb
 - lib/wires/clean.rb
+- lib/wires/convenience.rb
 - lib/wires/channel.rb
 - lib/wires/event.rb
 - LICENSE
@@ -130,7 +131,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.2
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: wires