metaphor 0.2.1

data/LICENSE

@@ -0,0 +1,23 @@
+The MIT License
+
+Copyright (c) 2009 Sean O'Halpin
+Copyright (c) 2010 Craig R Webster <http://barkingiguana.com/>
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,92 @@
+Metaphor
+========
+
+From the Greek: μεταφορά - metaphora, meaning "transfer"
+
+
+Rationale
+---------
+
+As programmers an awful lot of what we do revolves around taking an
+input, doing something to it, and sending the result somewhere. Quite a
+bit of time is wasted writing the "glue" that transfers the results from
+one place to the next. Metaphor aims to provide a standardised and easy
+to use way of passing results, leaving you to concentrate on the bit
+that's important - the business logic.
+
+
+Programming with Metaphor
+-------------------------
+
+    metaphor = Metaphor.new
+    metaphor.processors << Foo.new
+    metaphor.processors << Bar.new
+    metaphor.processors << Baz.new
+    metaphor.processors << Metaphor::Processor::PrintMessage.new
+
+    # Process one message
+    metaphor.call(headers, body) # => [ new_headers, new_body ]
+                                 # => false (if halted by processor)
+
+    # Process messages from this class until the Ruby VM is killed or the
+    # input returns nil
+    metaphor.call(StdinInput.new)
+
+
+Classes used for input must respond to #get and return an array of headers
+and the message body:
+
+    class StdinInput
+      def get
+        # return an array like this:
+        [
+          { "header" => "value", ... }, # Message headers
+          "body"                        # Message body
+        ]
+      end
+    end
+
+Classes used as processors must respond to #call(headers, body):
+
+    class PrintMessage
+      def call(headers, body)
+        puts "Headers: #{headers.inspect}"
+        puts "Body   : #{body.inspect}"
+      end
+    end
+
+The return value of #call controls what happens to the message. If the
+processor returns:
+
+  * An array of headers and the message body
+    - they are passed to the next processor
+  * Boolean false (or something that is === to it)
+    - Metaphor stops processing this message and discards it
+  * Any other value that is not false
+    - Metaphor passes the same headers and message that were passed into
+      this processor to the next processor in the chain
+
+Contributing
+------------
+
+  * Fork the project.
+  * Make your feature addition or bug fix.
+  * Add tests for it. This is important so I don't break it in a
+    future version unintentionally.
+  * Commit, do not mess with the Rakefile or Metaphor::VERSION. If you
+    want to have your own version, that is fine but bump version in a
+    commit by itself I can ignore when I pull.
+  * Send me a pull request. Bonus points for topic branches.
+
+
+Authors
+-------
+
+  * Sean O'Halpin
+  * Craig R Webster <http://barkingiguana.com/>
+
+
+License
+-------
+
+Released under the MIT licence. See the LICENSE file for details.

data/lib/metaphor.rb

@@ -0,0 +1,33 @@
+class Metaphor
+  VERSION = '0.2.1'
+  attr_accessor :processors
+
+  def initialize
+    self.processors = []
+  end
+
+  def call(*args)
+    case args.size
+    when 1
+      while message = args.first.get
+        process_message(*message)
+      end
+    when 2
+      process_message(*args)
+    end
+  end
+
+  private
+  def process_message(headers, body)
+    processors.each do |processor|
+      processor_output = processor.call(headers, body)
+      case
+      when processor_output === false
+        return false
+      when processor_output.respond_to?(:size) && processor_output.size == 2
+        headers, body = processor_output
+      end
+    end
+    [ headers, body ]
+  end
+end

data/lib/metaphor/input/stdin_input.rb

@@ -0,0 +1,34 @@
+class Metaphor
+  module Input
+    class StdinInput
+      def initialize(source = STDIN, prompt = STDOUT)
+        @source = source
+        @prompt = prompt
+      end
+
+      def get
+        @prompt.puts "Enter headers in the format header:value."
+        @prompt.puts "Each header:value pair should be followed by a newline."
+        @prompt.puts "When you're done enter a blank line."
+        headers = {}
+        loop do
+          line = @source.readline.to_s.strip 
+          break if line == ""
+          header, value = line.split(/:/, 2).map{|s|s.strip}
+          headers[header] = value
+        end
+
+        @prompt.puts "Enter the message body."
+        @prompt.puts "When you're done enter a blank line."
+        body = []
+        loop do
+          line = @source.readline.to_s.strip
+          break if line == ""
+          body << line
+        end
+
+        [ headers, body.join("\n") ]
+      end
+    end
+  end
+end

data/lib/metaphor/processor/detour.rb

@@ -0,0 +1,34 @@
+class Metaphor
+  module Processor
+    class Detour
+      def initialize(default, detour)
+        @default = default
+        @detour = Metaphor.new
+        @detour.processors << detour
+        @detour.processors << default
+        @active = false
+      end
+
+      def activate
+        @active = true
+      end
+
+      def deactivate
+        @active = false
+      end
+
+      def active?
+        @active
+      end
+
+      def call(headers, body)
+        active_processor.call headers, body
+      end
+
+      private
+      def active_processor
+        (@active ? @detour : @default)
+      end
+    end
+  end
+end

data/lib/metaphor/processor/json_processor.rb

@@ -0,0 +1,18 @@
+class Metaphor
+  module Processor
+    class JsonProcessor
+      def initialize
+        require 'json'
+      end
+
+      def call(headers, body)
+        result = JSON[body]
+        headers['content-type'] = case result
+        when Hash:   'application/x-ruby'
+        when String: 'application/json'
+        end
+        [ headers, result ]
+      end
+    end
+  end
+end

data/lib/metaphor/processor/print_message.rb

@@ -0,0 +1,18 @@
+class Metaphor
+  module Processor
+    class PrintMessage
+      def initialize(target = STDOUT)
+        @target = target
+      end
+
+      def call(headers, body)
+        headers.each_pair do |header, value|
+          @target.puts "#{header}:#{value}"
+        end
+        @target.puts
+        @target.puts body
+        @target.puts
+      end
+    end
+  end
+end

data/lib/metaphor/processor/wiretap.rb

@@ -0,0 +1,28 @@
+class Metaphor
+  module Processor
+    class Wiretap
+      def initialize(default, wiretap)
+        @default = default
+        @wiretap = wiretap
+        @active = false
+      end
+
+      def active?
+        @active
+      end
+
+      def activate
+        @active = true
+      end
+
+      def deactivate
+        @active = false
+      end
+
+      def call(headers, body)
+        @wiretap.call(headers, body) if active?
+        @default.call(headers, body)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: metaphor
+version: !ruby/object:Gem::Version 
+  hash: 21
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 1
+  version: 0.2.1
+platform: ruby
+authors: 
+- Sean O'Halpin
+- Craig R Webster
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-20 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: Metaphor provides a standard interface for defining message processors and transformations and a simple framework for executing them.
+email: 
+- craig@barkingiguana.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/metaphor/input/stdin_input.rb
+- lib/metaphor/processor/detour.rb
+- lib/metaphor/processor/json_processor.rb
+- lib/metaphor/processor/print_message.rb
+- lib/metaphor/processor/wiretap.rb
+- lib/metaphor.rb
+- LICENSE
+- README.markdown
+has_rdoc: true
+homepage: http://github.com/seanohalpin/metaphor
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: metaphor
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Generic pipeline processing
+test_files: []
+