urbivore 0.0.1

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in urbivore.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 EC
+
+MIT License
+
+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.md

@@ -0,0 +1,29 @@
+# Urbivore
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'urbivore'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install urbivore
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/urbivore/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/urbivore.rb

@@ -0,0 +1,11 @@
+require "urbivore/version"
+require "urbivore/interface"
+require "urbivore/exceptions"
+require "urbivore/message"
+require "urbivore/message_packet"
+require "urbivore/logger"
+require "urbivore/processor"
+
+module Urbivore
+  # Your code goes here...
+end

data/lib/urbivore/exceptions.rb

@@ -0,0 +1,12 @@
+module Urbivore
+  module Exceptions
+    class RuntimeError < ::RuntimeError
+    end
+
+    class TypeError < ::TypeError
+    end
+    
+    class ConfigurationError < ::ArgumentError
+    end
+  end
+end

data/lib/urbivore/interface.rb

@@ -0,0 +1,100 @@
+module Urbivore
+  module Interface
+    # we expect logger to provide:
+    #  #configured_level (i.e., the default)
+    #  #configured_levels (i.e., the scale)
+    # ...if these are nil, we send system defaults from here
+    STANDARD_LEVELS = [:debug, :info, :user1, :warn, :error, :user2, :fatal, :unknown]
+    
+    # allow config here...
+    def default_logger
+      Urbivore::Logger
+    end
+
+    def default_level
+      logger.configured_level || :info
+    end
+
+    def default_levels
+      levels_by_minimum(default_level)
+    end
+
+    def available_levels
+      logger.configured_levels || STANDARD_LEVELS
+    end
+
+    def levels_by_minimum(level)
+      levels = available_levels
+      # memoize this locally in these methods,
+      # not in the getter above---we should
+      # anticipate runtime changes
+      levels.include?(level) ? levels.reject { |l| levels.index(l) < levels.index(level) } : nil
+    end
+
+    def levels_by_subset(levels)
+      available_levels & levels
+    end
+
+    def current_levels(requested = nil)
+      if requested
+        requested.is_a?(Array) ? levels_by_subset(requested) : levels_by_minimum(requested)
+      else
+        default_levels 
+      end
+    end
+
+    # helpers for standard levels--could make these configurable
+    STANDARD_LEVELS.each do |level|
+      define_method(level) do |*args, &block|
+        add(level, *args, &block)
+      end
+      
+      define_method("#{level}?") do |level|
+        level_active?(level)
+      end
+    end
+
+    def add(level, message_arg = nil, options = {}, &message_block)
+      level = level.is_a?(Numeric) ? available_levels.at(level) : level.to_sym
+      unless current_levels.include?(level)
+        return false
+      end
+
+      # support stdlib-style prognames thus:
+      if options.is_a?(String) 
+        progname = options
+        options  = { progname: options }
+      end
+      
+      unless options.is_a?(Hash)
+        raise Urbivore::Exceptions::TypeError.new("options must be a String or a Hash")
+      end
+
+      message    = block_given? ? yield : message_arg
+      options.merge!(level: level)
+      append_message(generate_message_object(message, options))
+    end
+
+    def append_message(message_object)
+      # allow this object to queue the message for
+      # later processing by defininng #message_collector
+      if respond_to?(:message_collector)
+        # check for optional live stream here
+        message_collector(message_object)
+      else
+        logger.submit(message_object) 
+      end
+    end
+
+    # this is the interface to use for building novel stuff with messages
+    # don't instantiate Message directly
+    def generate_message_object(message, options = {})
+      # ability to specify time useful for testing?
+      timestamp     = options[:timestamp]  || Time.now
+      level         = options[:level]      || default_level
+      progname      = options[:progname]
+      data          = options[:data]
+      Urbivore::Message.new(timestamp, message, level, progname, data)
+    end
+  end
+end

data/lib/urbivore/logger.rb

@@ -0,0 +1,121 @@
+module Urbivore
+  class Logger
+    class << self
+      include Urbivore::Interface
+
+      attr_reader :configured_levels, :configured_level
+
+      # worker constants
+      # default to 250ms sleep (more? less?)
+      DEFAULT_SLEEP_TIME        = (1.0/4.0)
+      DEFAULT_TOTAL_WORKERS     = 1 
+      DEFAULT_BATCH_SIZE        = 5
+
+      # use this to enqueue entries
+      def submit(entry)
+        # any prep work on the object goes here...
+        queue.push(entry)
+      end
+
+      def process(entry)
+        processor.process(entry)
+      end
+
+      def processor(processor = nil)
+        if processor
+          unless processor.respond_to?(:process)
+            raise Urbivore::Exceptions::ConfigurationError.new("Processor must respond_to?(:process)")
+          end
+          @processor = processor
+        else
+          @processor ||= Urbs::BasicProcessor
+        end
+      end
+        
+      def logger
+        self
+      end
+
+      def workers
+        @workers ||= []
+      end
+
+      def queue
+        @queue ||= Queue.new
+      end
+
+      def sleep_time
+        @sleep_time || DEFAULT_SLEEP_TIME
+      end
+
+      def total_workers
+        @total_workers || DEFAULT_TOTAL_WORKERS
+      end
+
+      def batch_size
+        @batch_size || DEFAULT_BATCH_SIZE
+      end
+
+      def sleep_time=(sleep_time)
+        unless sleep_time.is_a?(Numeric) || !sleep_time
+          raise Urbivore::Exceptions::ConfigurationError.new("Log.sleep_time must be a number")
+        end
+
+        # we should figure out whether access to this instance var 
+        # should be locked, in this method and the getter...
+        @sleep_time = sleep_time
+      end
+
+      def total_workers=(total_workers)
+        unless total_workers.is_a?(Fixnum) || !total_workers
+          raise Urbivore::Exceptions::ConfigurationError.new("Log.total_workers must be a number")
+        end
+        @total_workers = total_workers
+      end
+
+      def batch_size=(batch_size)
+        unless batch_size.is_a?(Fixnum) || !batch_size
+          raise Urbivore::Exceptions::ConfigurationError.new("Log.batch_size must be a number")
+        end
+        @batch_size = batch_size
+      end
+
+      # THREAD SAFETY...
+      def restart_logging(halt = false)
+        Thread.exclusive do
+          reset_state
+          if halt
+            true
+          else
+            @keep_going   = true
+            total_workers.times do
+              workers << Thread.new do
+                while @keep_going
+                  sleep sleep_time
+                  entries   = []
+                  batch_size.times do 
+                    entries << queue.pop
+                  end
+                  entries.each { |entry| process(entry) }
+                end
+              end
+            end
+          end
+        end
+      end
+      
+      private
+
+      def reset_state
+        @keep_going   = false
+        workers.each { |thr| thr.join }
+        @workers      = nil
+        @logging      = false
+        # close file handles, network connections and the like
+        # note we leave queue alone, so it can keep getting entries
+        # while we're reloading
+        # processor.reset_state
+      end
+    end
+  end
+end

data/lib/urbivore/message.rb

@@ -0,0 +1,37 @@
+module Urbivore
+  class Message
+    attr_reader :timestamp, :message, :level, :progname, :data
+
+    # generally speaking we don't want users initializing
+    # these directly---either Logger or MessagePacket should 
+    # be doing that in most cases
+    def initialize(timestamp, message, level, progname = nil, data = nil)
+      # that said, let's raise an error if at least they're
+      # calling this wrong... 
+      unless timestamp.is_a?(Time)
+        raise Urbivore::Exceptions::TypeError.new("Message expected timestamp to be a time")
+      end
+
+      @timestamp  = timestamp
+      @message    = message
+      @level      = level.to_sym
+      @progname   = progname
+      @data       = data
+    end
+
+    def to_s
+      str = "#{timestamp} [#{level}] #{message}"
+      progname ? str += " (#{progname})" : str
+    end
+
+    def <=>(comp)
+      if self.timestamp < comp.timestamp
+        -1
+      elsif self.timestamp > comp.timestamp
+        1
+      else
+        0
+      end
+    end
+  end
+end

data/lib/urbivore/message_packet.rb

@@ -0,0 +1,64 @@
+module Urbivore
+  class MessagePacket
+    include Urbivore::Interface
+
+    class << self
+      def logger(logger = nil)
+        if logger
+          @logger = logger
+        else
+          @logger
+        end
+      end
+    end
+
+    ## instance methods
+
+    attr_reader :logger
+
+    def initialize(options = {})
+      @logger          = options[:default_level] || self.class.logger || default_logger
+      @default_level   = options[:default_level]
+      @message_store   = {}
+      unless @logger.ancestors.include?(Urbivore::Logger)
+        raise Urbivore::Exceptions::TypeError.new("MessagePacket expected a Logger")
+      end
+    end
+
+    def message_collector(message_object)
+      # it may not matter... but keying these in a hash by level 
+      # seems like better design than putting them in a big pile
+      # and using #select---if you generate a massive amount of debugging
+      # info you don't want iterate over all of it just to generate a production
+      # log message, right?
+      @message_store[level] ||= []
+      # shit like this needs to be made threadsafe
+      @message_store[level] << message_object
+    end
+
+    def messages(requested = nil)
+      # pull all desired levels and collate
+      current_levels(requested).map { |level| @levels[level] }.flatten.sort
+    end
+    
+    # send self to the logging machine
+    def submit
+      if @submitted 
+        false
+      else
+        logger.submit(self)
+        @submitted = true
+      end
+    end
+
+    # as above, but raise exception when trying to submit
+    # an already submitted log
+    def submit!
+      if @submitted
+        raise Urbivore::Exceptions::RuntimeError.new("MessagePacket already submitted")
+      else
+        submit
+      end
+    end
+  end
+end

data/lib/urbivore/processor.rb

@@ -0,0 +1,13 @@
+module Urbivore
+  class BasicProcessor
+    class << self
+      def process(queued_object)
+        if queued_object.respond_to?(:messages)
+          queued_object.messages.each { |str| puts str }
+        else
+          puts queued_object.to_s
+        end
+      end
+    end
+  end
+end

data/lib/urbivore/version.rb

@@ -0,0 +1,3 @@
+module Urbivore
+  VERSION = "0.0.1"
+end

data/urbivore.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'urbivore/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "urbivore"
+  spec.version       = Urbivore::VERSION
+  spec.authors       = ["EC"]
+  spec.email         = ["erik.cameron@gmail.com"]
+  spec.summary       = "The Urbs structured logger"
+  spec.description   = ""
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: urbivore
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- EC
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email:
+- erik.cameron@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/urbivore.rb
+- lib/urbivore/exceptions.rb
+- lib/urbivore/interface.rb
+- lib/urbivore/logger.rb
+- lib/urbivore/message.rb
+- lib/urbivore/message_packet.rb
+- lib/urbivore/processor.rb
+- lib/urbivore/version.rb
+- urbivore.gemspec
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: The Urbs structured logger
+test_files: []