serf 0.5.0 → 0.6.0

data/README.md

@@ -200,16 +200,21 @@ Example
         @logger.info "RegExp Matched #{message.inspect}"
         nil
       end
+
+      def call(message={})
+        @logger.info "A message matched an empty action part in the target"
+        nil
+      end
     end
 
     # my_lib/routes.rb
     ROUTES = {
       # Declare a matcher and a list of routes to endpoints.
       'my_message' => [{
-        # Declares which handler to use. This is the tableized
-        # name of the class. It will be constantized by the serf code.
-        handler: 'my_handler',
-        action: :submit_my_message,
+        # Declares which handler and action (method) of the handler
+        # to call. The handler part is the name of the handler used
+        # to register an actual handler object.
+        target: 'my_handler#submit_my_message',
 
         # Define a parser that will build up a message object.
         # Default: nil, no parsing done.
@@ -220,17 +225,19 @@ Example
         #background: false
       }],
       'other_message' => [{
-        handler: 'my_handler',
-        action: :submit_other_message,
+        target: 'my_handler#submit_other_message',
         background: true
       }, {
-        handler: 'my_handler',
-        action: :raises_error,
+        target: 'my_handler#raises_error',
         background: true
-      }],
+      },
+        # This is just a string route defining the target, nothing else.
+        # The handler is 'my_handler' and an empty (or missing) action
+        # part defaults to the 'call' method of the handler.
+        'my_handler'
+      ],
       /^events\/.*$/ => [{
-        handler: 'my_handler',
-        action: :regexp_matched,
+        target: 'my_handler#regexp_matched',
         background: true
       }]
     }
@@ -279,8 +286,9 @@ Example
         logger.info "In Tick, MyMessage Results: #{results.inspect}"
 
         # This will submit 'other_message' to be handled in foreground
-        # Because we declared the 'other_message' kind to be handled async, we
-        # should get a MessageAcceptedEvent as the results.
+        # Because we declared the 'other_message' kind to be handled async
+        # in each route config, we should get a MessageAcceptedEvent as
+        # the results.
         results = app.call('kind' => 'other_message')
         logger.info "In Tick, OtherMessage Results: #{results.inspect}"
 

data/lib/serf/builder.rb

@@ -35,7 +35,12 @@ module Serf
       @route_maps = []
       @handlers = {}
       @message_parsers = {}
-      @not_found = app
+      @not_found = app || proc do
+        raise ArgumentError, 'Handler Not Found'
+      end
+
+      # Default option in route_configs for background is 'false'
+      @background = false
 
       # Factories to build objects that wire our Serf App together.
       # Note that these default implementing classes are also factories
@@ -79,6 +84,10 @@ module Serf
       @not_found = app
     end
 
+    def background(run_in_background)
+      @background = run_in_background
+    end
+
     def serfer_factory(serfer_factory)
       @serfer_factory = serfer_factory
     end
@@ -114,28 +123,33 @@ module Serf
       @route_maps.each do |route_map|
         route_map.each do |matcher, route_configs|
           route_configs.each do |route_config|
+            # If the passed in route_config was a String, then we place
+            # it in an route config as the 'target' field and leave all
+            # other options as default.
+            config = (route_config.is_a?(String) ?
+              { target: route_config } :
+              route_config)
+
             # Get the required handler.
             # Raises error if handler wasn't declared in config.
+            target = config.fetch :target
+            handler_name, action = handler_and_action target
+
             # Raises error if handler wasn't registered with builder.
-            handler_name = route_config.fetch :handler
             handler = @handlers.fetch handler_name
 
-            # Get the required action/method of the handler.
-            # Raises error if route_config doesn't have it.
-            action = route_config.fetch :action
-
             # Lookup the parser if it was defined.
             # The Parser MAY be either an object or string.
             # If String, then we're going to look up in parser map.
             # Raises an error if a parser (string) was declared, but not
             # registered with the builder.
-            parser = route_config[:message_parser]
+            parser = config[:message_parser]
             parser = @message_parsers.fetch(parser) if parser.is_a?(String)
 
             # We have the handler, action and parser.
             # Now we're going to add that route to either the background
             # or foreground route_set.
-            background = route_config.fetch(:background) { false }
+            background = config.fetch(:background) { @background }
             (background ? bg_route_set : fg_route_set).add_route(
               matcher: matcher,
               handler: handler,
@@ -183,6 +197,28 @@ module Serf
 
       return app
     end
+
+    private
+
+    ##
+    # Extracts the handler_name and action from the 'target' using
+    # the shortcut convention similar to Rails routing.
+    #
+    #   'my_handler#my_method' => # my_method action.
+    #   'my_handler#' => # action defaults to 'call' method.
+    #   'my_handler'  => # action defaults to 'call' method.
+    #   '#my_method'  => # some registered handler name with empty string.
+    #
+    # @param [String] target the handler and action description.
+    # @return the splat handler and action.
+    #
+    def handler_and_action(target)
+      handler, action = target.split '#', 2
+      handler = handler.to_s.strip
+      action = action.to_s.strip
+      action = :call if action.size == 0
+      return handler, action
+    end
   end
 
 end

data/lib/serf/version.rb

@@ -2,7 +2,7 @@ module Serf
 
   module Version
     MAJOR = 0
-    MINOR = 5
+    MINOR = 6
     PATCH = 0
     BUILD = nil
     STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join '.'

data/serf.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "serf"
-  s.version = "0.5.0"
+  s.version = "0.6.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Benjamin Yu"]
-  s.date = "2012-01-26"
+  s.date = "2012-02-09"
   s.description = "Event-Driven SOA with CQRS"
   s.email = "benjaminlyu@gmail.com"
   s.extra_rdoc_files = [
@@ -49,7 +49,7 @@ Gem::Specification.new do |s|
   s.homepage = "http://github.com/byu/serf"
   s.licenses = ["Apache 2.0"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.10"
+  s.rubygems_version = "1.8.15"
   s.summary = "Event-Driven SOA with CQRS"
 
   if s.respond_to? :specification_version then

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: serf
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-26 00:00:00.000000000Z
+date: 2012-02-09 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70145106081500 !ruby/object:Gem::Requirement
+  requirement: &70232356582940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 3.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *70145106081500
+  version_requirements: *70232356582940
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &70145106073960 !ruby/object:Gem::Requirement
+  requirement: &70232356582140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 0.6.0
   type: :runtime
   prerelease: false
-  version_requirements: *70145106073960
+  version_requirements: *70232356582140
 - !ruby/object:Gem::Dependency
   name: uuidtools
-  requirement: &70145106072920 !ruby/object:Gem::Requirement
+  requirement: &70232356581500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: 2.1.2
   type: :runtime
   prerelease: false
-  version_requirements: *70145106072920
+  version_requirements: *70232356581500
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70145106071740 !ruby/object:Gem::Requirement
+  requirement: &70232356580820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 2.3.0
   type: :development
   prerelease: false
-  version_requirements: *70145106071740
+  version_requirements: *70232356580820
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70145106070620 !ruby/object:Gem::Requirement
+  requirement: &70232356580140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 0.6.0
   type: :development
   prerelease: false
-  version_requirements: *70145106070620
+  version_requirements: *70232356580140
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70145106069640 !ruby/object:Gem::Requirement
+  requirement: &70232356579500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +76,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *70145106069640
+  version_requirements: *70232356579500
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70145106068740 !ruby/object:Gem::Requirement
+  requirement: &70232356578860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,10 +87,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *70145106068740
+  version_requirements: *70232356578860
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70145106067300 !ruby/object:Gem::Requirement
+  requirement: &70232356578380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70145106067300
+  version_requirements: *70232356578380
 - !ruby/object:Gem::Dependency
   name: msgpack
-  requirement: &70145106053600 !ruby/object:Gem::Requirement
+  requirement: &70232356577820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,10 +109,10 @@ dependencies:
         version: 0.4.6
   type: :development
   prerelease: false
-  version_requirements: *70145106053600
+  version_requirements: *70232356577820
 - !ruby/object:Gem::Dependency
   name: eventmachine
-  requirement: &70145106052540 !ruby/object:Gem::Requirement
+  requirement: &70232356577300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -120,7 +120,7 @@ dependencies:
         version: 0.12.10
   type: :development
   prerelease: false
-  version_requirements: *70145106052540
+  version_requirements: *70232356577300
 description: Event-Driven SOA with CQRS
 email: benjaminlyu@gmail.com
 executables: []
@@ -172,7 +172,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -650473328553199241
+      hash: -296744974966677810
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -181,7 +181,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: Event-Driven SOA with CQRS