larva 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cbf84efda642aa79d413f133e1b7f27db278bec6
-  data.tar.gz: 88f947616c14e531fee42dc00fbd419372303bdb
+  metadata.gz: 586b2fb5174324740d8583b8b6b8c033afa44f9f
+  data.tar.gz: 9b73d51991cc7664660a85d6cacd61500f29f283
 SHA512:
-  metadata.gz: e1f4c8d39c1da9883535dc5b11f152e70a53c09906b6f4e29530514aa63dccd41c1d66f0ef540182d689a806d291c1a0b5b544be7d66d496281109043acdf795
-  data.tar.gz: 78624d5307e979b1bab7bf2d048cb14359d46a6147f2f484d6ec5c23b0146ac5fdf28b585ade020bd83feaca2969cfc575abe6f9ae48e0a82ceada5c6697c6dd
+  metadata.gz: 20c5fb5ec779e501424ab581dc30001d8043dc61f512cca4bdee8ae1e38814efe49d14c12b579af2326923bbe4a8b6c8f3e9368a82a08b11158eb982757f47f9
+  data.tar.gz: bf35e9031228e9690e0a678c964c28c6b1b30d7cf433e9f7a6ae73132963ae0aa6fc6b5c27d69028969a0a14663a67534b8850ea9bfd8bd2d80fd51a9b4a20de

data/CHANGELOG

@@ -1,3 +1,6 @@
+# 0.4.0 / 2014-02-22
+* [FEATURE] Add meta-programming-based processors.
+
 # 0.3.0 / 2014-02-22
 * [FEATURE] Add worker pool.
 

data/README.md

@@ -18,9 +18,9 @@ And then execute:
 
 ## Usage
 
-Larva provides you with listeners, processors and a worker pool to build an application that listens and responds to Propono messages. 
+Larva provides you with listeners, processors and a worker pool to quickly build an application that listens and responds to Propono messages.
 
-Here is a sample application. This forms the basis of a rake task for most Meducation daemons.
+Here is a sample application that forms the basis of a rake task for most Meducation daemons.
 
 ```ruby
 require 'larva'
@@ -28,18 +28,17 @@ require 'larva'
 # Setup Config for Filum and Propono
 
 class MyProcessor < Larva::Processor
-  def process(message)
-    if entity == "comment" && action == "created"
-      # Do something...
-    else
-      false
-    end
+  def comment_created
+    # I get called when the message is received :)
   end
 end
 
 processors = {my_topic: MyProcessor}
 Larva::WorkerPool.start(processors, "queue-suffix")
 
+# In another application...
+Propono.publish(:my_topic, {entity: "comment", action: "created", id: 8}
+
 ```
 
 ### Listeners
@@ -54,28 +53,43 @@ This will listen for messages on :my_topic and pass them to `processor.process`.
 
 ### Processors
 
-Processors are used by listeners to handle the messages that are received. You are expected to subclass `Lavar::Processor` and implement `process`. 
+Processors are used by listeners to handle the messages that are received.
 
-Processors expect you to have an `entity` and `action` fields in your messages.
+If your messages have an `entity` and `action` fields, then you can create methods named `#{entity}_#{action}, which get called when a message is received.
 
 For example:
 
 ```ruby
+class MyProcessor < Larva::Processor
+  def comment_created
+    # I get called for the first message
+  end
+end
+Larva::Listener.listen(:my_topic, MyProcessor, "")
+Propono.publish(:my_topic, {entity: "comment", action: "created", id: 8}
+```
+
+If those methods do not exist, then a method called `process` is called. This method has acccess to `message`, `action`, `entity` and `id` fields. If this returns true, then the message is considered processed, else if it returns false, an error wil be logged.
+
+For example:
+
+``` ruby
 class MyProcessor
-  def process(message)
-    if entity == "comment" && action == "created"
-      # Do something...
+  def process
+    if message[:foo] == bar
+      # Larva will consider this message processed successfully
+      true
     else
+      # An error is logged for this message
       false
     end
   end
 end
 Larva::Listener.listen(:my_topic, MyProcessor, "")
-Propono.publish(:my_topic, {entity: "comment", action: "created", id: 8}
+Propono.publish(:my_topic, {foo: "bar"} # -> Will be logged as a success
+Propono.publish(:my_topic, {foo: "meh"} # -> Will be logged as unprocessed.
 ```
 
-With this code `MyProcessor#process` will get called for each message, with extra logging around the call. Within the class you have access to `message`, `action`, `entity` and `id` methods.
-
 ### Worker Pool
 
 The worker pool creates a listener for each topic, and proxies messages to the associated processors. If any processors die, the application will die.
@@ -102,7 +116,7 @@ We'd love to have you involved. Please read our [contributing guide](https://git
 
 ### Contributors
 
-This project is managed by the [Meducation team](http://company.meducation.net/about#team). 
+This project is managed by the [Meducation team](http://company.meducation.net/about#team).
 
 These individuals have come up with the ideas and written the code that made this possible:
 

data/lib/larva/processor.rb

@@ -14,6 +14,22 @@ module Larva
 
     def process_with_logging
       Propono.config.logger.info "Processing message: #{message}"
+      meta_process || normal_process
+    end
+
+    private
+
+    def meta_process
+      meta_method = "#{entity}_#{action}"
+      if respond_to? meta_method
+        self.send(meta_method)
+        true
+      else
+        false
+      end
+    end
+
+    def normal_process
       if self.process
         Propono.config.logger.info "Message Processed: #{message}"
       else

data/lib/larva/version.rb

@@ -1,3 +1,3 @@
 module Larva
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

data/test/processor_test.rb

@@ -2,6 +2,15 @@ require File.expand_path('../test_helper', __FILE__)
 
 module Larva
   class ProcessorTest < Minitest::Test
+
+    class MetaProcessor < Processor
+      def media_file_processed; end
+    end
+
+    class NormalProcessor < Processor
+      def process; end
+    end
+
     def test_initialize_should_extract_action_and_entity
       entity = "media_file"
       action = "processed"
@@ -11,24 +20,24 @@ module Larva
       assert_equal action, processor.action
     end
 
-    class GoodProcessor < Processor
-      def process
-        true
-      end
-    end
-
-    class BadProcessor < Processor
-      def process
-        false
-      end
-    end
-
     def test_process_logs_message
       message = {entity: "media_file", action: "processed", media_file_id: "8"}
       output = "Processing message: #{message}"
       Propono.config.logger.stubs(:info)
       Propono.config.logger.expects(:info).with(output)
-      GoodProcessor.process(message)
+      NormalProcessor.process(message)
+    end
+
+    def test_process_calls_meta_method
+      message = {entity: "media_file", action: "processed", media_file_id: "8"}
+      MetaProcessor.any_instance.expects(:media_file_processed)
+      MetaProcessor.process(message)
+    end
+
+    def test_process_is_called_if_no_meta_method_exists
+      message = {entity: "media_file", action: "processed", media_file_id: "8"}
+      NormalProcessor.expects(:process)
+      NormalProcessor.process(message)
     end
 
     def test_process_logs_success
@@ -36,7 +45,8 @@ module Larva
       output = "Message Processed: #{message}"
       Propono.config.logger.stubs(:info)
       Propono.config.logger.expects(:info).with(output)
-      GoodProcessor.process(message)
+      NormalProcessor.any_instance.expects(:process).returns(true)
+      NormalProcessor.process(message)
     end
 
     def test_process_logs_message
@@ -47,7 +57,8 @@ module Larva
 
       Propono.config.logger.stubs(:info)
       Propono.config.logger.expects(:info).with(output)
-      BadProcessor.process(message)
+      NormalProcessor.any_instance.expects(:process).returns(false)
+      NormalProcessor.process(message)
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: larva
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - iHiD