carnivore 0.2.0 → 0.2.2

data/lib/carnivore/utils/logging.rb

@@ -3,6 +3,7 @@ require 'celluloid'
 module Carnivore
   module Utils
 
+    # Logging utilities
     module Logging
 
       # Define base logging types
@@ -13,6 +14,9 @@ module Carnivore
       end
 
       # Log message
+      #
+      # @param args [Object] argument list
+      # @return [NilClass]
       def log(*args)
         if(args.empty?)
           Celluloid::Logger

data/lib/carnivore/utils/message_registry.rb

@@ -1,14 +1,19 @@
 module Carnivore
   module Utils
-      # Registry used for preventing duplicate message processing
+
+    # Registry used for preventing duplicate message processing
     class MessageRegistry
+
+      # Create new instance
       def initialize
         @store = []
         @size = 100
       end
 
-      # message:: Carnivore::Message
-      # Returns true if message has not been processed
+      # Validity of message (not found within registry)
+      #
+      # @param message [Carnivore::Message]
+      # @return [TrueClass, FalseClass]
       def valid?(message)
         checksum = sha(message)
         found = @store.include?(checksum)
@@ -18,8 +23,10 @@ module Carnivore
         !found
       end
 
-      # item:: checksum
-      # Pushes checksum into store
+      # Register checksum into registry
+      #
+      # @param item [String] checksum
+      # @return [self]
       def push(item)
         @store.push(item)
         if(@store.size > @size)
@@ -28,8 +35,10 @@ module Carnivore
         self
       end
 
-      # thing:: Instance
-      # Return checksum for give instance
+      # Generate checksum for given item
+      #
+      # @param thing [Object]
+      # @return [String] checksum
       def sha(thing)
         unless(thing.is_a?(String))
           thing = MultiJson.dump(thing)

data/lib/carnivore/utils/params.rb

@@ -1,10 +1,13 @@
 module Carnivore
   module Utils
 
+    # Parameter helper methods generally aimed at Hash instances
     module Params
 
-      # hash:: Hash
       # Symbolize keys in hash
+      #
+      # @param hash [Hash]
+      # @return [Hash] new hash instance with symbolized keys
       def symbolize_hash(hash)
         Hash[*(
             hash.map do |k,v|
@@ -21,10 +24,11 @@ module Carnivore
         )]
       end
 
-      # hash:: Hash
-      # args:: Symbols or strings
-      # Follow path in hash provided by args and return value or nil
-      # if path is not valid
+      # Retrieve value in hash at given path
+      #
+      # @param hash [Hash] hash to walk into
+      # @param args [String, Symbol] argument list to walk in hash
+      # @return [Object, NilClass]
       def retrieve(hash, *args)
         valids = [::Hash, hash.is_a?(Class) ? hash : hash.class]
         args.flatten.inject(hash) do |memo, key|

data/lib/carnivore/utils/smash.rb

@@ -0,0 +1,90 @@
+require 'hashie'
+
+module Carnivore
+  module Utils
+
+    # Customized Hash
+    class Smash < Hash
+      include Hashie::Extensions::IndifferentAccess
+      include Hashie::Extensions::DeepMerge
+      include Hashie::Extensions::Coercion
+
+      coerce_value Hash, Smash
+
+      # Create new instance
+      #
+      # @param args [Object] argument list
+      def initialize(*args)
+        base = nil
+        if(args.first.is_a?(::Hash))
+          base = args.shift
+        end
+        super *args
+        if(base)
+          self.replace(base)
+        end
+      end
+
+      # Get value at given path
+      #
+      # @param args [String, Symbol] key path to walk
+      # @return [Object, NilClass]
+      def retrieve(*args)
+        args.inject(self) do |memo, key|
+          if(memo.is_a?(Hash))
+            memo.to_smash[key]
+          else
+            nil
+          end
+        end
+      end
+      alias_method :get, :retrieve
+
+      # Fetch value at given path or return a default value
+      #
+      # @param args [String, Symbol, Object] key path to walk. last value default to return
+      # @return [Object] value at key or default value
+      def fetch(*args)
+        default_value = args.pop
+        retrieve(*args) || default_value
+      end
+
+      # Set value at given path
+      #
+      # @param args [String, Symbol, Object] key path to walk. set last value to given path
+      # @return [Object] value set
+      def set(*args)
+        unless(args.size > 1)
+          raise ArgumentError.new 'Set requires at least one key and a value'
+        end
+        value = args.pop
+        set_key = args.pop
+        leaf = args.inject(self) do |memo, key|
+          unless(memo[key].is_a?(Hash))
+            memo[key] = Smash.new
+          end
+          memo[key]
+        end
+        leaf[set_key] = value
+        value
+      end
+
+    end
+  end
+
+end
+
+# Hook helper into toplevel `Hash`
+class Hash
+
+  # Convert to Smash
+  #
+  # @return [Smash]
+  def to_smash
+    ::Smash.new.replace(self)
+  end
+  alias_method :hulk_smash, :to_smash
+
+end
+
+Smash = Carnivore::Utils::Smash

data/lib/carnivore/utils.rb

@@ -2,10 +2,12 @@ require 'carnivore'
 
 module Carnivore
 
+  # Helper utilities
   module Utils
     autoload :Params, 'carnivore/utils/params'
     autoload :Logging, 'carnivore/utils/logging'
     autoload :MessageRegistry, 'carnivore/utils/message_registry'
+    autoload :Smash, 'carnivore/utils/smash'
 
     extend Params
     extend Logging

data/lib/carnivore/version.rb

@@ -1,7 +1,7 @@
 module Carnivore
+  # Versioning class for library
   class Version < Gem::Version
   end
-  VERSION = Version.new('0.2.0')
+  # Current version of library
+  VERSION = Version.new('0.2.2')
 end
-
-require 'carnivore'

data/lib/carnivore.rb

@@ -1,5 +1,19 @@
 require 'carnivore/runner'
 require 'carnivore/version'
-
 # Load in celluloid as required
-autoload :Celluloid, 'celluloid'
+require 'celluloid/autostart'
+
+# Message consumer and processor
+module Carnivore
+  autoload :Config, 'carnivore/config'
+  autoload :Callback, 'carnivore/callback'
+  autoload :Container, 'carnivore/container'
+  autoload :Error, 'carnivore/errors'
+  autoload :Message, 'carnivore/message'
+  autoload :Source, 'carnivore/source'
+  autoload :Supervisor, 'carnivore/supervisor'
+  autoload :Utils, 'carnivore/utils'
+  autoload :Version, 'carnivore/version'
+end
+
+autoload :Smash, 'carnivore/utils/smash'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: carnivore
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-10 00:00:00.000000000 Z
+date: 2014-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: celluloid
@@ -59,6 +59,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Message processing helper
 email: chrisroberts.code@gmail.com
 executables: []
@@ -74,9 +90,9 @@ files:
 - lib/carnivore/runner.rb
 - lib/carnivore/spec_helper.rb
 - lib/carnivore/utils/message_registry.rb
+- lib/carnivore/utils/smash.rb
 - lib/carnivore/utils/logging.rb
 - lib/carnivore/utils/params.rb
-- lib/carnivore/autoloader.rb
 - lib/carnivore/config.rb
 - lib/carnivore/message.rb
 - lib/carnivore/source_container.rb
@@ -87,7 +103,8 @@ files:
 - README.md
 - CHANGELOG.md
 homepage: https://github.com/carnivore-rb/carnivore
-licenses: []
+licenses:
+- Apache 2.0
 post_install_message: 
 rdoc_options: []
 require_paths:

data/lib/carnivore/autoloader.rb

@@ -1,13 +0,0 @@
-# Register all base autoloading requirements
-
-module Carnivore
-  autoload :Config, 'carnivore/config'
-  autoload :Callback, 'carnivore/callback'
-  autoload :Container, 'carnivore/container'
-  autoload :Error, 'carnivore/errors'
-  autoload :Message, 'carnivore/message'
-  autoload :Source, 'carnivore/source'
-  autoload :Supervisor, 'carnivore/supervisor'
-  autoload :Utils, 'carnivore/utils'
-  autoload :Version, 'carnivore/version'
-end