brb 0.3.0 → 0.3.1

data/Gemfile

@@ -0,0 +1,5 @@
+source 'http://rubygems.org'
+source 'http://gems.github.com'
+
+gem "rspec", "~> 1.3.2"
+gem "eventmachine"

data/Gemfile.lock

@@ -0,0 +1,13 @@
+GEM
+  remote: http://rubygems.org/
+  remote: http://gems.github.com/
+  specs:
+    eventmachine (0.12.10)
+    rspec (1.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  eventmachine
+  rspec (~> 1.3.2)

data/README.rdoc

@@ -15,13 +15,15 @@ A process exposes an object over the network and any ruby process (after having
 BrB only support message passing with Marshable dumpable object : String, symbol, Array, hash, Number, Object etc...
 That mean you can not send file descriptor, Thread or another funky things like that :)
 
+For any question, use the Ruby BrB google group: http://groups.google.com/group/ruby-brb
+
 == Main Functionalities
 
 * Unlimited objects exposed
 * Processes can expose object and be client to exposed object too at the same time
 * Do not wait for return by default : just do simple message passing
 * Handle return values without blocking with the usage of a simple block
-* Blocking wait for return if needed by simply adding <em>_block</em> at the end of the method name
+* Blocking wait for a return value if needed by simply adding <em>_block</em> at the end of the method name
 * Transmission of Exception when blocking call
 * Thread safe if used correctly with Event Machine
 
@@ -40,10 +42,16 @@ After connection are ready, just call method on the tunnel. It will just act lik
 * Taking advantage of multi-core and multi-threaded systems.
 
 ==  TODO
-* Better README and Wiki
 * Writing more examples
 * Publish Benchmarks VS drb
 * Improve logging mechanism
 * Clean up
 
+== Contributors
+
+* kwi (Guillaume Luccisano)
+* bwalton (Brian Walton)
+* dpree (Jens Bissinger)
+
+
 Copyright (c) 2009-2010 Guillaume Luccisano - g-mai|: guillaume.luccisano, released under the MIT license

data/lib/brb.rb

@@ -1,4 +1,5 @@
+require File.join(File.dirname(__FILE__), 'brb', 'logger.rb')
 require File.join(File.dirname(__FILE__), 'brb', 'exception.rb')
 require File.join(File.dirname(__FILE__), 'brb', 'event_machine.rb')
 require File.join(File.dirname(__FILE__), 'brb', 'service.rb')
-require File.join(File.dirname(__FILE__), 'brb', 'tunnel.rb')
+require File.join(File.dirname(__FILE__), 'brb', 'tunnel.rb')

data/lib/brb/event_machine.rb

@@ -40,7 +40,7 @@ module BrB
           return q.pop
 
         rescue Exception => e
-          puts e.backtrace.join("\n")
+          BrB.logger.error e.backtrace.join("\n")
           raise "#{e} - #{uri}"
         end
       end
@@ -65,7 +65,7 @@ module BrB
           max -= 1
           port += 1
           retry if max > 0
-          puts e.backtrace.join("\n")
+          BrB.logger.error e.backtrace.join("\n")
           raise "#{e} - BrB Tcp Event machine Can not bind on #{host}:#{port}"
         end
 

data/lib/brb/logger.rb

@@ -0,0 +1,35 @@
+require "logger"
+
+module BrB
+  class << self
+    
+    # returns the default logger instance
+    def default_logger
+      Logger.new(STDOUT)
+    end
+    
+    # set a custom logger instance
+    def logger=(custom_logger)
+      @@logger = custom_logger
+    end
+    
+    # returns the logger instance
+    def logger
+      # use default logger if no custom logger is set
+      @@logger = default_logger unless defined? @@logger
+      
+      # this overwrites the original method with a static definition
+      eval %Q{
+        def logger
+          @@logger
+        end
+      }
+      @@logger
+    end
+  end
+  
+  # alias to BrB.logger
+  def logger
+    BrB.logger
+  end
+end

data/lib/brb/request.rb

@@ -70,8 +70,8 @@ module BrB
           brb_send([ReturnCode, r, thread, idrequest])
         rescue Exception => e
           brb_send([ReturnCode, e, thread, idrequest])
-          tputs e.to_s
-          tputs e.backtrace.join("\n")
+          BrB.logger.error e.to_s
+          BrB.logger.error e.backtrace.join("\n")
           #raise e
         end
       else
@@ -79,8 +79,8 @@ module BrB
         begin
           (args.size > 0) ? @object.send(meth, *args) : @object.send(meth)
         rescue Exception => e
-          tputs "#{e.to_s} => By calling #{meth} on #{@object.class} with args : #{args.inspect}"
-          tputs e.backtrace.join("\n")
+          BrB.logger.error "#{e.to_s} => By calling #{meth} on #{@object.class} with args : #{args.inspect}"
+          BrB.logger.error e.backtrace.join("\n")
           raise e
         end
 

data/lib/brb/service.rb

@@ -7,14 +7,9 @@ module BrB
     @@uri = nil
     @@em_signature = nil
     @@verbose = false
-
+    
     class << self
 
-    private
-      def tputs(s)
-        puts s if @@verbose
-      end
-
     public
 
       # Start a server hosted on the object given,
@@ -23,12 +18,13 @@ module BrB
         return if @@em_signature
   
         @@verbose = opts[:verbose]
+        BrB.logger.level = @@verbose ? Logger::INFO : Logger::WARN
 
         addr = opts[:uri] || "brb://#{opts[:host] || 'localhost'}:#{opts[:port] || 6200}"
 
-        tputs " [BrB] Start service on #{addr} ..."
+        BrB.logger.info " [BrB] Start service on #{addr} ..."
         @@uri, @@em_signature = BrB::Protocol::open_server(addr, BrB::Tunnel::Handler, opts.merge(:block => block))
-        tputs " [BrB] Service started on #{@@uri}"
+        BrB.logger.info " [BrB] Service started on #{@@uri}"
       end
 
       def uri
@@ -39,7 +35,7 @@ module BrB
       def stop_service
         return if !@@em_signature or !EM::reactor_running?
       
-        tputs " [BrB] Stop service on #{@@uri}"
+        BrB.logger.info " [BrB] Stop service on #{@@uri}"
         sign = @@em_signature
         q = Queue.new # Creation of a Queue for waiting server to stop
         EM::schedule do
@@ -52,7 +48,7 @@ module BrB
       
       # Deprecated old method
       def instance
-        puts "DEPRECATION WARNING: BrB::Service::instance is deprecated => Just use BrB::Service"
+        BrB.logger.warn "DEPRECATION WARNING: BrB::Service::instance is deprecated => Just use BrB::Service"
         self
       end
     end

data/lib/brb/tunnel.rb

@@ -24,6 +24,7 @@ module BrB
         super
         @object = opts[:object]
         @verbose = opts[:verbose]
+        BrB.logger.level = @verbose ? Logger::INFO : Logger::WARN
         @timeout_rcv_value = opts[:timeout] || 30 # Currently not implemented due to the lack of performance of ruby Timeout
         @close_after_timeout = opts[:close_after_timeout] || false
         @uri = opts[:uri]
@@ -41,7 +42,7 @@ module BrB
 
       # EventMachine Callback, called after connection has been initialized
       def post_init
-        tputs " [BrB] Tunnel initialized on #{@uri}"
+        BrB.logger.info " [BrB] Tunnel initialized on #{@uri}"
         @active = true
         if @block
           EM.defer do
@@ -58,7 +59,7 @@ module BrB
       # EventMachine unbind event
       # The connection has been closed
       def unbind
-        tputs ' [BrB] Tunnel service closed'
+        BrB.logger.info ' [BrB] Tunnel service closed'
         @active = false
         if @block
           EM.defer do
@@ -69,7 +70,7 @@ module BrB
       
       # Stop the service
       def stop_service
-        tputs ' [BrB] Stopping Tunnel service...'
+        BrB.logger.info ' [BrB] Stopping Tunnel service...'
         @active = false
         EM.schedule do
           close_connection

data/lib/brb/tunnel/shared.rb

@@ -3,10 +3,6 @@
 module BrB
   module Tunnel
     module Shared
-      def tputs(s)
-        puts s if @verbose
-      end
-
       def make_proxy(r)
         if r.is_a?(Array)
           t = []
@@ -14,7 +10,7 @@ module BrB
             t << if obj.is_a? Array
               make_proxy(obj)
             elsif !obj.is_a?(Symbol) and !obj.is_a?(String) and obj and !(Marshal::dump(obj) rescue nil)
-              #puts "  - > Make proxy for : #{obj.class}"
+              #BrB.logger.debug "  - > Make proxy for : #{obj.class}"
               obj.to_s.to_sym
             else
               obj

data/spec/brb/brb_logger_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+class CustomLogger
+  attr_accessor :level, :history
+  def initialize
+    @history = []
+  end
+  def info(msg)
+    @history << msg
+  end
+  alias :error :info
+  alias :warn :info
+  alias :debug :info
+end
+
+describe :brb_logger do
+  before(:each) do
+    @original_logger = BrB.logger
+  end
+  
+  after(:each) do
+    BrB.logger = @original_logger
+  end
+  
+  it 'should be assigned a default logger' do
+    BrB.logger.should_not be_nil
+    BrB.logger.class.should == Logger
+  end
+  
+  it 'should be possible to use a custom logger' do
+    BrB.logger = CustomLogger.new
+    BrB.logger.info('foo')
+    BrB.logger.history.last.should == 'foo'
+  end
+end

metadata

@@ -1,12 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: brb
 version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 3
-  - 0
-  version: 0.3.0
+  prerelease: 
+  version: 0.3.1
 platform: ruby
 authors: 
 - Guillaume Luccisano
@@ -14,19 +10,17 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-21 00:00:00 +02:00
+date: 2011-05-18 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: eventmachine
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">"
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 12
         version: "0.12"
   type: :runtime
   version_requirements: *id001
@@ -43,16 +37,20 @@ files:
 - examples/simple_core.rb
 - lib/brb/event_machine.rb
 - lib/brb/exception.rb
+- lib/brb/logger.rb
 - lib/brb/request.rb
 - lib/brb/service.rb
 - lib/brb/tunnel/shared.rb
 - lib/brb/tunnel.rb
 - lib/brb.rb
+- spec/brb/brb_logger_spec.rb
 - spec/brb/brb_massive_usage_spec.rb
 - spec/brb/brb_service_spec.rb
 - spec/brb/brb_tunnel_spec.rb
 - spec/spec_helper.rb
 - CHANGELOG.rdoc
+- Gemfile
+- Gemfile.lock
 - MIT-LICENSE
 - Rakefile
 - README.rdoc
@@ -67,25 +65,21 @@ rdoc_options: []
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 1
-      - 3
-      - 4
       version: 1.3.4
 requirements: 
 - eventmachine
 rubyforge_project: brb
-rubygems_version: 1.3.6
+rubygems_version: 1.5.2
 signing_key: 
 specification_version: 3
 summary: BrB is a simple, fully transparent and extremely fast interface for doing simple distributed ruby