officer 0.5.3 → 0.6.0

data/README.markdown

@@ -77,6 +77,9 @@ Run Officer in the background (production mode) and listen on a specific IP and
 
 - Retrieve the list of locks for the current connection.
 - Client: Option to abort a lock request if there is already a certain number of clients waiting for the lock.
+- Client: Namespaced lock names.
+- Server: configure the daemons gem to allow multiple server processes to run on one box.
+- Tests
 
 ## Copyright
 

data/Rakefile

@@ -12,7 +12,6 @@ begin
     gem.authors = ["Chad Remesch"]
     gem.add_development_dependency "eventmachine", ">= 0"
     gem.add_development_dependency "json", ">= 0"
-    gem.add_development_dependency "activesupport", ">= 0"
     gem.add_development_dependency "daemons", ">= 0"
     gem.add_development_dependency "choice", ">= 0"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings

data/VERSION

@@ -1 +1 @@
-0.5.3
+0.6.0

data/bin/officer

@@ -29,10 +29,16 @@ def parse_command_line
       cast Integer
     end
 
-    option :verbose do
-      short '-v'
-      long '--verbose'
-      desc 'Print lock information to stdout every five seconds (default: off)'
+    option :log_level do
+      short '-l'
+      long '--log-level'
+      desc 'Set the log level to debug, info, or error (default: error)'
+    end
+
+    option :stats do
+      short '-s'
+      long '--stats'
+      desc 'Log stats every 5 seconds (default: off, requires log level: info)'
     end
 
     option :help do

data/lib/officer/client.rb

@@ -2,7 +2,6 @@ require 'socket'
 require 'fcntl'
 
 require 'rubygems'
-require 'active_support'
 require 'json'
 
 module Officer
@@ -15,10 +14,8 @@ module Officer
 
   class Client
     def initialize options={}
-      options.reverse_merge! :host => 'localhost', :port => 11500
-
-      @host = options[:host]
-      @port = options[:port]
+      @host = options[:host] || 'localhost'
+      @port = options[:port] || 11500
 
       connect
     end

data/lib/officer/commands.rb

@@ -19,7 +19,7 @@ module Officer
     class Base
       class << self
         def register
-          Factory.register to_s.split('::').last.underscore, self
+          Factory.register underscore(to_s.split('::').last), self
         end
       end
 
@@ -37,6 +37,17 @@ module Officer
       end
 
     private
+      class << self
+        # Originally from ActiveSupport
+        def underscore camel_cased_word
+          camel_cased_word.to_s.gsub(/::/, '/').
+            gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+            gsub(/([a-z\d])([A-Z])/,'\1_\2').
+            tr("-", "_").
+            downcase
+        end
+      end
+
       def setup # Override if necessary.
       end
 

data/lib/officer/connection.rb

@@ -5,16 +5,20 @@ module Officer
       def post_init
         @connected = true
         @timers = {} # name => Timer
+
+        Officer::Log.info "Connected: #{to_host_s}"
       end
 
       def receive_line line
         line.chomp!
 
+        Officer::Log.debug "#{to_host_s} received line: #{line}"
+
         command = Officer::Command::Factory.create line, self
         command.execute
 
       rescue Exception => e
-        L.debug_exception e
+        Officer::Log.error e
         raise
       end
 
@@ -22,6 +26,8 @@ module Officer
         @connected = false
 
         Officer::LockStore.instance.reset self
+
+        Officer::Log.info "Disconnected: #{to_host_s}"
       end
     end
 
@@ -29,24 +35,24 @@ module Officer
       def acquired name
         @timers.delete(name).cancel if @timers[name]
 
-        send_line({:result => 'acquired', :name => name}.to_json)
+        send_result 'acquired', :name => name
       end
 
       def already_acquired name
-        send_line({:result => 'already_acquired', :name => name}.to_json)
+        send_result 'already_acquired', :name => name
       end
 
       def released name
-        send_line({:result => 'released', :name => name}.to_json)
+        send_result 'released', :name => name
       end
 
       def release_failed name
-        send_line({:result => 'release_failed', :name => name}.to_json)
+        send_result 'release_failed', :name => name
       end
 
       def reset_succeeded
         @timers.values.each {|timer| timer.cancel}
-        send_line({:result => 'reset_succeeded'}.to_json)
+        send_result 'reset_succeeded'
       end
 
       def queued name, options={}
@@ -61,15 +67,15 @@ module Officer
 
       def timed_out name
         @timers.delete name
-        send_line({:result => 'timed_out', :name => name}.to_json)
+        send_result 'timed_out', :name => name
       end
 
       def locks locks_hash
-        send_line({:result => 'locks', :value => locks_hash}.to_json)
+        send_result 'locks', :value => locks_hash
       end
 
       def connections conns_hash
-        send_line({:result => 'connections', :value => conns_hash}.to_json)
+        send_result 'connections', :value => conns_hash
       end
     end
 
@@ -78,16 +84,29 @@ module Officer
       include LockStoreCallbacks
 
       def to_host_s
-        port, ip = Socket.unpack_sockaddr_in get_peername
-        "#{ip}:#{port}"
+        @to_host_s ||= non_cached_to_host_s
       end
 
     private
       attr_reader :connected
 
+      def non_cached_to_host_s
+        port, ip = Socket.unpack_sockaddr_in get_peername
+        "#{ip}:#{port}"
+      end
+
       def send_line line
+        Officer::Log.debug "#{to_host_s} sent line: #{line}"
+
         send_data "#{line}\n" if @connected
       end
+
+      def send_result result, options={}
+        params = options.dup
+        params[:result] = result
+
+        send_line params.to_json
+      end
     end
 
   end

data/lib/officer/lock_store.rb

@@ -20,27 +20,29 @@ module Officer
     end
 
     def log_state
-      L.info '-----'
+      l = Officer::Log
 
-      L.info 'LOCK STORE:'
-      L.info ''
-      
-      L.info "locks:"
+      l.info '-----'
+
+      l.info 'LOCK STORE:'
+      l.info ''
+
+      l.info "locks:"
       @locks.each do |name, lock|
-        L.info "#{name}: connections=[#{lock.queue.map{|c| c.object_id}.join(', ')}]"
+        l.info "#{name}: connections=[#{lock.queue.map{|c| c.to_host_s}.join(', ')}]"
       end
-      L.info ''
+      l.info ''
 
-      L.info "Connections:"
+      l.info "Connections:"
       @connections.each do |connection, names|
-        L.info "#{connection.object_id}: names=[#{names.to_a.join(', ')}]"
+        l.info "#{connection.to_host_s}: names=[#{names.to_a.join(', ')}]"
       end
-      L.info ''
+      l.info ''
 
-      L.info "Acquire Rate: #{@acquire_counter.to_f / 5}/s"
+      l.info "Acquire Rate: #{@acquire_counter.to_f / 5}/s"
       @acquire_counter = 0
 
-      L.info '-----'
+      l.info '-----'
     end
 
     def acquire name, connection, options={}
@@ -60,7 +62,7 @@ module Officer
     end
 
     def release name, connection, options={}
-      options.reverse_merge! :callback => true
+      options[:callback] ||= true
 
       lock = @locks[name]
       names = @connections[connection]

data/lib/officer/log.rb

@@ -1,36 +1,37 @@
 module Officer
 
-  class Log
+  class Log < SimpleDelegator
     include Singleton
 
-    def debug message
-      return unless [:debug].include?(LOG_LEVEL)
+    class << self
+      def debug msg
+        instance.debug msg
+      end
 
-      write message
-    end
+      def info msg
+        instance.info msg
+      end
 
-    def info message
-      return unless [:debug, :info].include?(LOG_LEVEL)
+      def error msg
+        instance.error msg
+      end
 
-      write message
-    end
+      def set_log_level level
+        level = case level
+          when 'debug' then Logger::DEBUG
+          when 'info'  then Logger::INFO
+          else Logger::ERROR
+        end
 
-    def debug_exception e
-      debug '-----'
-      debug "EXCEPTION: "
-      debug e
-      debug e.backtrace.join "\n  "
-      debug '-----'
-      debug "ARGV: #{ARGV.inspect}"
+        instance.level = level
+      end
     end
 
-  private
-    def write message
-      puts message
+    def initialize
+      @logger = Logger.new STDOUT
+
+      super @logger
     end
   end
-  
-end
 
-L = Officer::Log.instance
-LOG_LEVEL = :debug
+end

data/lib/officer/server.rb

@@ -1,25 +1,26 @@
 module Officer
 
   class Server
-    def initialize opts={}
-      @port      = opts[:port]    || 11500
-      @host      = opts[:host]    || '0.0.0.0'
-      @verbose   = opts[:verbose] || false
+    def initialize params={}
+      @params = params
+
+      params[:port] ||= 11500
+      params[:host] ||= '0.0.0.0'
+      params[:stats] ||= false
+      params[:log_level] ||= 'error'
+
+      Officer::Log.set_log_level params[:log_level]
     end
 
     def run
-      EM.error_handler do |e|
-        L.debug_exception e
-      end
-    
+      EM.error_handler {|e| Officer::Log.error e}
+
       EM::run do
-        if @verbose
-          EM::PeriodicTimer.new(5) do
-            Officer::LockStore.instance.log_state
-          end
+        if @params[:stats]
+          EM::PeriodicTimer.new(5) {Officer::LockStore.instance.log_state}
         end
 
-        EM::start_server @host, @port, Connection::Connection
+        EM::start_server @params[:host], @params[:port], Connection::Connection
       end
     end
   end

data/lib/officer.rb

@@ -1,10 +1,11 @@
 # Standard Ruby.
 require 'singleton'
 require 'set'
+require 'logger'
+require 'delegate'
 
 # Gems.
 require 'rubygems'
-require 'active_support'
 require 'eventmachine'
 require 'json'
 require 'daemons'

data/officer.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{officer}
-  s.version = "0.5.3"
+  s.version = "0.6.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Chad Remesch"]
-  s.date = %q{2010-02-11}
+  s.date = %q{2010-02-13}
   s.default_executable = %q{officer}
   s.description = %q{Distributed lock server and client written in Ruby and EventMachine}
   s.email = %q{chad@remesch.com}
@@ -54,20 +54,17 @@ Gem::Specification.new do |s|
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_development_dependency(%q<eventmachine>, [">= 0"])
       s.add_development_dependency(%q<json>, [">= 0"])
-      s.add_development_dependency(%q<activesupport>, [">= 0"])
       s.add_development_dependency(%q<daemons>, [">= 0"])
       s.add_development_dependency(%q<choice>, [">= 0"])
     else
       s.add_dependency(%q<eventmachine>, [">= 0"])
       s.add_dependency(%q<json>, [">= 0"])
-      s.add_dependency(%q<activesupport>, [">= 0"])
       s.add_dependency(%q<daemons>, [">= 0"])
       s.add_dependency(%q<choice>, [">= 0"])
     end
   else
     s.add_dependency(%q<eventmachine>, [">= 0"])
     s.add_dependency(%q<json>, [">= 0"])
-    s.add_dependency(%q<activesupport>, [">= 0"])
     s.add_dependency(%q<daemons>, [">= 0"])
     s.add_dependency(%q<choice>, [">= 0"])
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: officer
 version: !ruby/object:Gem::Version 
-  version: 0.5.3
+  version: 0.6.0
 platform: ruby
 authors: 
 - Chad Remesch
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-11 00:00:00 -05:00
+date: 2010-02-13 00:00:00 -05:00
 default_executable: officer
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -32,16 +32,6 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
     version: 
-- !ruby/object:Gem::Dependency 
-  name: activesupport
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
-    version: 
 - !ruby/object:Gem::Dependency 
   name: daemons
   type: :development