seh 0.0.3 → 0.1.0

data/.gitignore

@@ -3,3 +3,5 @@
 Gemfile.lock
 pkg/*
 *~
+.yardoc/*
+doc/*

data/.yardopts

@@ -0,0 +1,3 @@
+--no-private
+--markup="markdown"
+--main README.md

data/Gemfile

@@ -4,5 +4,4 @@ group :development, :test do
   gem 'rspec'
 end
 
-# Specify your gem's dependencies in seh.gemspec
 gemspec

data/README.md

@@ -0,0 +1,13 @@
+
+# seh: structured event handler
+
+## Roadmap
+* documentation
+* unit tests (my bad)
+* examples
+
+## v0.1.0
+seh API is fully implemented :)
+
+## Contact
+Please send (welcome) feedback and bug reports to ryan.berckmans@gmail.com.

data/lib/seh.rb

@@ -5,17 +5,17 @@ require "seh/event"
 
 module Seh
   class << self
-    # alias for Seh::EventType::And
+    # @note alias of {EventType::And}
     def and( *types )
       EventType::And.new *types
     end
 
-    # alias for Seh::EventType::Or
+    # @note alias of {EventType::Or}
     def or( *types )
       EventType::Or.new *types
     end
 
-    # alias for Seh::EventType::Not
+    # @note alias of {EventType::Not}
     def not( type )
       EventType::Not.new type
     end

data/lib/seh/event.rb

@@ -1,7 +1,8 @@
 require 'ostruct'
 
 module Seh
-  module Private # :nodoc: all
+  # @private
+  module Private
     START = 0
     BEFORE = 100
 
@@ -18,10 +19,11 @@ module Seh
     FINISH = 1000
 
     class EventData
-      attr_accessor :types, :target, :time, :staged_handlers, :success
+      attr_accessor :types, :type_map, :target, :time, :staged_handlers, :success
 
       def initialize
         @types = []
+        @type_map = {}
         @target = nil
         @time = Time.now
         @success = true
@@ -35,6 +37,26 @@ module Seh
       class << self
         def type( data, t )
           data.types << t
+          apply_type_map data
+        end
+
+        def type_map( data, map = {} )
+          map.each_pair do |type, implied_types|
+            data.type_map[type] ||= []
+            data.type_map[type].concat implied_types
+            data.type_map[type].uniq!
+          end
+          apply_type_map data
+        end
+
+        private
+        def apply_type_map( data )
+          while true
+            original_size = data.types.size
+            data.type_map.each_pair { |type, implied_types| data.types.concat implied_types if data.types.include? type }
+            data.types.uniq!
+            break if original_size = data.types.size
+          end
         end
       end
     end
@@ -66,7 +88,7 @@ module Seh
     end
 
     def dispatch
-      raise "Event may only be dispatched once" unless @state == Private::EventStateReady
+      raise "Event#dispatch may only be called once" unless @state == Private::EventStateReady
       @state = Private::EventStateInflight
       collect_targets.each { |t| t.each_bind { |bind| bind.block.call self if bind.event_type.match @data.types } }
       @data.staged_handlers.each_key.sort.each { |stage| @data.staged_handlers[stage].each { |block| block.call self } }
@@ -79,6 +101,12 @@ module Seh
 
     def type( event_type )
       @state.type @data, event_type
+      nil
+    end
+
+    def type_map( map )
+      @state.type_map @data, map
+      nil
     end
 
     def match_type( event_type )

data/lib/seh/event_target.rb

@@ -21,7 +21,8 @@ module Seh
     end
   end
 
-  module Private # :nodoc: all
+  # @private
+  module Private
     class EventBind
       attr_reader :event_type, :block
 

data/lib/seh/version.rb

@@ -1,3 +1,4 @@
 module Seh
-  VERSION = "0.0.3" # :nodoc:
+  # @private
+  VERSION = "0.1.0"
 end

data/seh.gemspec

@@ -8,16 +8,8 @@ Gem::Specification.new do |s|
   s.authors     = ["Ryan Berckmans"]
   s.email       = ["ryan.berckmans@gmail.com"]
   s.homepage    = "https://github.com/ryanberckmans/seh"
-  s.summary     = "pure ruby event handling similar to w3c dom events; pre-alpha wip"
-  s.description = "Pure ruby event handling similar to w3c dom events. Lots of bells and whistles to support complex event handling as required by stuff like video games.
-+ event handling in a synchronous specific order
-+ event targets can have multiple parents and common ancestors; event propagation does a breadth first search traversal over a directed acyclic event target graph
-+ staged callbacks: event.before { .. }; event.after { .. }
-+ staged callbacks allow for an ancestor to influence affect of event on a descendant: ancestor.before { |event| event.x = 5 }; descendant.after { |event| puts event.x }
-+ events can have multiple types, and types can inherit from other types
-+ bind callbacks using event type filtering: node.bind(overcast AND (rain OR snow)) { |event| callback! }
-+ optional event failure: event.success { yay! }; event.failure { oops! }
-+ events on stack don't care about other events above/below - event A, currently executing, can create/dispatch/finish another event B"
+  s.summary     = "Structured event handler. Pure ruby event handling similar to w3c dom events; alpha wip."
+  s.description = "#{s.summary} Lots of bells and whistles to support complex event handling as required by stuff like video games. Event handling in a synchronous specific order. Events 'bubble', and event targets can have multiple parents and common ancestors. Staged event callbacks: event.before { 'the united states of' }; event.after { 'america' }. Staged callbacks allow an ancestor to influence affect of event on a descendant: ancestor.before { |event| event.damage *= 2 }; descendant.after { |event| player.health -= event.damage }. Events use 'tag-style' types: event.type :hostile ; event.type :spell. Handle only events which pass a filter: player.bind( Seh::and :hostile, Seh::not( :spell ) ) { |event| 'Hostile non-spell!!' }. Optional event failure: event.fail; event.success { 'yay!' }; event.failure { 'oops!' }. Event inherits from OpenStruct for dynamic properties: event.omgs = 'omgs a dynamic attribute'"
 
   s.rubyforge_project = "seh"
 
@@ -25,9 +17,4 @@ Gem::Specification.new do |s|
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
-
-  s.has_rdoc = true
-  s.rdoc_options << '--title' << 'Seh - Structured Event Handling' \
-                 << '--main'  << 'README.org'
-  s.extra_rdoc_files = ['README.org']
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: seh
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,42 +9,32 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-06-17 00:00:00.000000000Z
+date: 2011-06-19 00:00:00.000000000Z
 dependencies: []
-description: ! 'Pure ruby event handling similar to w3c dom events. Lots of bells
-  and whistles to support complex event handling as required by stuff like video games.
-
-  + event handling in a synchronous specific order
-
-  + event targets can have multiple parents and common ancestors; event propagation
-  does a breadth first search traversal over a directed acyclic event target graph
-
-  + staged callbacks: event.before { .. }; event.after { .. }
-
-  + staged callbacks allow for an ancestor to influence affect of event on a descendant:
-  ancestor.before { |event| event.x = 5 }; descendant.after { |event| puts event.x
-  }
-
-  + events can have multiple types, and types can inherit from other types
-
-  + bind callbacks using event type filtering: node.bind(overcast AND (rain OR snow))
-  { |event| callback! }
-
-  + optional event failure: event.success { yay! }; event.failure { oops! }
-
-  + events on stack don''t care about other events above/below - event A, currently
-  executing, can create/dispatch/finish another event B'
+description: ! 'Structured event handler. Pure ruby event handling similar to w3c
+  dom events; alpha wip. Lots of bells and whistles to support complex event handling
+  as required by stuff like video games. Event handling in a synchronous specific
+  order. Events ''bubble'', and event targets can have multiple parents and common
+  ancestors. Staged event callbacks: event.before { ''the united states of'' }; event.after
+  { ''america'' }. Staged callbacks allow an ancestor to influence affect of event
+  on a descendant: ancestor.before { |event| event.damage *= 2 }; descendant.after
+  { |event| player.health -= event.damage }. Events use ''tag-style'' types: event.type
+  :hostile ; event.type :spell. Handle only events which pass a filter: player.bind(
+  Seh::and :hostile, Seh::not( :spell ) ) { |event| ''Hostile non-spell!!'' }. Optional
+  event failure: event.fail; event.success { ''yay!'' }; event.failure { ''oops!''
+  }. Event inherits from OpenStruct for dynamic properties: event.omgs = ''omgs a
+  dynamic attribute'''
 email:
 - ryan.berckmans@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files:
-- README.org
+extra_rdoc_files: []
 files:
 - .gitignore
 - .rvmrc
+- .yardopts
 - Gemfile
-- README.org
+- README.md
 - Rakefile
 - lib/seh.rb
 - lib/seh/event.rb
@@ -56,11 +46,7 @@ files:
 homepage: https://github.com/ryanberckmans/seh
 licenses: []
 post_install_message: 
-rdoc_options:
-- --title
-- Seh - Structured Event Handling
-- --main
-- README.org
+rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
@@ -80,5 +66,6 @@ rubyforge_project: seh
 rubygems_version: 1.8.5
 signing_key: 
 specification_version: 3
-summary: pure ruby event handling similar to w3c dom events; pre-alpha wip
+summary: Structured event handler. Pure ruby event handling similar to w3c dom events;
+  alpha wip.
 test_files: []

data/README.org

@@ -1,4 +0,0 @@
-
-* seh: structured event handler
-
-