ernie 1.2.0 → 1.3.0

data/History.txt

@@ -1,3 +1,10 @@
+= 1.3.0 / 2009-11-30
+  * API Additions
+    * Add loglevel for setting log level
+    * Add Ernie.auto_start bool
+  * Major changes
+    * Better logging granularity
+
 = 1.2.0 / 2009-11-23
   * API Additions
     * Add Ernie.expose

data/README.md

@@ -32,18 +32,18 @@ Running
         -n, --number NUMBER              Number of handler instances
         -d, --detached                   Run as a daemon
         -P, --pidfile PIDFILE            Location to write pid file.
-    
+
     Commands:
       <none>                Start an Ernie server.
       reload-handlers       Gracefully reload all of the the ruby handlers
                             and use the new code for all subsequent requests.
       stats                 Print a list of connection and handler statistics.
-    
+
     Examples:
       ernie -d -p 9999 -n 10 -h calc.rb
         Start the ernie server in the background on port 9999 with ten
         handlers, using the calc.rb handler file.
-    
+
       ernie reload-handlers -p 9999
         Reload the handlers for the ernie server currently running on
         port 9999.
@@ -51,34 +51,56 @@ Running
 Example Handler
 ---------------
 
-Using the DSL:
+Using a Ruby module and Ernie.expose:
 
     require 'ernie'
     
-    mod(:calc) do
-      fun(:add) do |a, b|
+    module Calc
+      def add(a, b)
         a + b
       end
     end
-
-Using Ernie.expose:
+    
+    Ernie.expose(:calc, Calc)
+    
+Using the DSL (this will be deprecated in a future release):
 
     require 'ernie'
-    
-    module Calc
-      def add(a, b)
+
+    mod(:calc) do
+      fun(:add) do |a, b|
         a + b
       end
     end
-    
-    Ernie.expose(:calc, Calc)
+
+
+Logging
+-------
+
+You can have logging sent to a file by adding these lines to your handler:
+
+    logfile('/var/log/ernie.log')
+    loglevel(Logger::INFO)
+
+This will log startup info, requests, and error messages to the log. Choosing
+Logger::DEBUG will include the response (be careful, doing this can generate
+very large log files).
+
+
+Autostart
+---------
+
+Normally Ernie handlers will become active after the file has been loaded in.
+you can disable this behavior by setting:
+
+    Ernie.auto_start = false
 
 
 Example BERT-RPC call for above example
 ---------------------------------------
 
     -> {call, calc, add, [1, 2]}
-    
+
     <- {reply, 3}
 
 
@@ -88,7 +110,7 @@ Using the BERTRPC gem to make calls to Ernie
 You can make BERT-RPC calls from Ruby with the [BERTRPC gem](http://github.com/mojombo/bertrpc):
 
     require 'bertrpc'
-    
+
     svc = BERTRPC::Service.new('localhost', 8000)
     svc.call.calc.add(1, 2)
     # => 3
@@ -99,10 +121,14 @@ Contribute
 
 If you'd like to hack on Ernie, start by forking my repo on GitHub:
 
-http://github.com/mojombo/ernie
+    http://github.com/mojombo/ernie
+
+To get all of the dependencies, install the gem first. To run ernie from
+source, you must first build the Erlang code:
+
+    rake ebuild
 
-To get all of the dependencies, install the gem first. The best way to get
-your changes merged back into core is as follows:
+The best way to get your changes merged back into core is as follows:
 
 1. Clone down your fork
 1. Create a topic branch to contain your change
@@ -118,4 +144,4 @@ your changes merged back into core is as follows:
 Copyright
 ---------
 
-Copyright (c) 2009 Tom Preston-Werner. See LICENSE for details.
+Copyright (c) 2009 Tom Preston-Werner. See LICENSE for details.

data/VERSION.yml

@@ -1,4 +1,5 @@
 --- 
-:minor: 2
+:minor: 3
+:build: 
 :patch: 0
 :major: 1

data/ernie.gemspec

@@ -1,19 +1,19 @@
 # Generated by jeweler
-# DO NOT EDIT THIS FILE
-# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in rakefile, and run the gemspec command
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{ernie}
-  s.version = "1.2.0"
+  s.version = "1.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Tom Preston-Werner"]
-  s.date = %q{2009-11-23}
+  s.date = %q{2009-11-30}
   s.default_executable = %q{ernie}
   s.email = %q{tom@mojombo.com}
   s.executables = ["ernie"]
-  s.extensions = ["ext/extconf.rb"]
+  s.extensions = ["ext/extconf.rb", "ext/extconf.rb"]
   s.extra_rdoc_files = [
     "LICENSE",
      "README.md"
@@ -79,3 +79,4 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<bertrpc>, [">= 1.0.0"])
   end
 end
+

data/examples/dsl.rb

@@ -1,6 +1,9 @@
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'ernie'
 
+# logfile('/tmp/ernie.log')
+# loglevel(Logger::INFO)
+
 mod(:test) do
   # Add two numbers together
   fun(:add) do |a, b|

data/lib/ernie.rb

@@ -4,12 +4,15 @@ require 'logger'
 
 class Ernie
   class << self
-    attr_accessor :mods, :current_mod, :logger
+    attr_accessor :mods, :current_mod, :log
+    attr_accessor :auto_start
   end
 
   self.mods = {}
   self.current_mod = nil
-  self.logger = nil
+  self.log = Logger.new(STDOUT)
+  self.log.level = Logger::INFO
+  self.auto_start = true
 
   # Record a module.
   #   +name+ is the module Symbol
@@ -53,15 +56,15 @@ class Ernie
   #
   # Returns nothing
   def self.logfile(file)
-    self.logger = Logger.new(file)
+    self.log = Logger.new(file)
   end
 
-  # If logging is enabled, log the given text.
-  #   +text+ is the String to log
+  # Set the log level.
+  #   +level+ is the Logger level (Logger::WARN, etc)
   #
   # Returns nothing
-  def self.log(text)
-    self.logger.info(text) if self.logger
+  def self.loglevel(level)
+    self.log.level = level
   end
 
   # Dispatch the request to the proper mod:fun.
@@ -114,8 +117,8 @@ class Ernie
   #
   # Loops forever
   def self.start
-    self.log("Starting")
-    self.log(self.mods.inspect)
+    self.log.info("(#{Process.pid}) Starting")
+    self.log.debug(self.mods.inspect)
 
     input = IO.new(3)
     output = IO.new(4)
@@ -126,31 +129,32 @@ class Ernie
       iruby = self.read_berp(input)
       unless iruby
         puts "Could not read BERP length header. Ernie server may have gone away. Exiting now."
+        self.log.info("(#{Process.pid}) Could not read BERP length header. Ernie server may have gone away. Exiting now.")
         exit!
       end
 
       if iruby.size == 4 && iruby[0] == :call
         mod, fun, args = iruby[1..3]
-        self.log("-> " + iruby.inspect)
+        self.log.info("-> " + iruby.inspect)
         begin
           res = self.dispatch(mod, fun, args)
           oruby = t[:reply, res]
-          self.log("<- " + oruby.inspect)
+          self.log.debug("<- " + oruby.inspect)
           write_berp(output, oruby)
         rescue ServerError => e
           oruby = t[:error, t[:server, 0, e.class.to_s, e.message, e.backtrace]]
-          self.log("<- " + oruby.inspect)
-          self.log(e.backtrace.join("\n"))
+          self.log.error("<- " + oruby.inspect)
+          self.log.error(e.backtrace.join("\n"))
           write_berp(output, oruby)
         rescue Object => e
           oruby = t[:error, t[:user, 0, e.class.to_s, e.message, e.backtrace]]
-          self.log("<- " + oruby.inspect)
-          self.log(e.backtrace.join("\n"))
+          self.log.error("<- " + oruby.inspect)
+          self.log.error(e.backtrace.join("\n"))
           write_berp(output, oruby)
         end
       elsif iruby.size == 4 && iruby[0] == :cast
         mod, fun, args = iruby[1..3]
-        self.log("-> " + [:cast, mod, fun, args].inspect)
+        self.log.info("-> " + [:cast, mod, fun, args].inspect)
         begin
           self.dispatch(mod, fun, args)
         rescue Object => e
@@ -158,9 +162,9 @@ class Ernie
         end
         write_berp(output, t[:noreply])
       else
-        self.log("-> " + iruby.inspect)
+        self.log.error("-> " + iruby.inspect)
         oruby = t[:error, t[:server, 0, "Invalid request: #{iruby.inspect}"]]
-        self.log("<- " + oruby.inspect)
+        self.log.error("<- " + oruby.inspect)
         write_berp(output, oruby)
       end
     end
@@ -178,6 +182,7 @@ class Ernie::Mod
   end
 
   def fun(name, block)
+    raise TypeError, "block required" if block.nil?
     self.funs[name] = block
   end
 end
@@ -196,6 +201,10 @@ def logfile(name)
   Ernie.logfile(name)
 end
 
+def loglevel(level)
+  Ernie.loglevel(level)
+end
+
 at_exit do
-  Ernie.start unless $test
+  Ernie.start if Ernie.auto_start
 end

data/test/ernie_test.rb

@@ -2,11 +2,29 @@ require File.dirname(__FILE__) + '/helper'
 
 class ErnieTest < Test::Unit::TestCase
   context "mod" do
+    should "yield to the block" do
+      called = false
+      mod(:foo) { called = true }
+      assert called, "mod did not yield to the block"
+    end
+
     should "add a mod to the mods hash" do
       mod(:foo) { }
       assert Ernie.mods[:foo]
       assert Ernie.mods[:foo].instance_of?(Ernie::Mod)
     end
+
+    should "overwrite previous mod with the same name" do
+      first_mod_object, second_mod_object = nil, nil
+      mod(:foo) { first_mod_object = Ernie.current_mod }
+      mod(:foo) { second_mod_object = Ernie.current_mod }
+      assert_not_same second_mod_object, first_mod_object
+    end
+
+    should "set the mod's name" do
+      mod(:foo) { }
+      assert_equal :foo, Ernie.mods[:foo].name
+    end
   end
 
   context "fun" do
@@ -14,6 +32,17 @@ class ErnieTest < Test::Unit::TestCase
       mod(:foo) { fun(:bar) { } }
       assert Ernie.mods[:foo].funs[:bar]
     end
+
+    should "dispatch to a fun" do
+      mod(:foo) { fun(:echo) { |arg| arg } }
+      assert 'hello', Ernie.dispatch(:foo, :echo, 'hello')
+    end
+
+    should "fail when no block is provided" do
+      assert_raises(TypeError) do
+        mod(:foo) { fun(:bar) }
+      end
+    end
   end
 
   module TestExposingModule

data/test/helper.rb

@@ -7,11 +7,11 @@ ERNIE_ROOT = File.join(File.dirname(__FILE__), *%w[..])
 $:.unshift(File.join(ERNIE_ROOT, 'lib'))
 
 require 'ernie'
+Ernie.auto_start = false
+
 begin
   require 'bertrpc'
 rescue LoadError
   puts "You need bertrpc gem installed to run tests."
   exit!(1)
 end
-
-$test = true

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ernie
 version: !ruby/object:Gem::Version 
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors: 
 - Tom Preston-Werner
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-23 00:00:00 -08:00
+date: 2009-11-30 00:00:00 -08:00
 default_executable: ernie
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -38,6 +38,7 @@ executables:
 - ernie
 extensions: 
 - ext/extconf.rb
+- ext/extconf.rb
 extra_rdoc_files: 
 - LICENSE
 - README.md