rbkb 0.7.2 → 0.7.3

data/lib/rbkb/plug/plug.rb

@@ -1,219 +1,211 @@
-# Copyright 2009 emonti at matasano.com 
+# Copyright 2009 emonti at matasano.com
 # See README.rdoc for license information
 #
 
-require "rbkb/plug/peer.rb"
+require 'rbkb/plug/peer'
 require 'stringio'
 require 'socket'
 
-
 module Plug
   module UI
-    LOGCFG = {:out => STDERR, :dump => :hex}
+    LOGCFG = { out: STDERR, dump: :hex }
 
-    def self.prompt(*msg); STDERR.puts msg ; STDIN.gets ; end
+    def self.prompt(*msg)
+      warn msg
+      STDIN.gets
+    end
 
-    def self.log(*msg); LOGCFG[:out].puts msg ; end
+    def self.log(*msg)
+      LOGCFG[:out].puts msg
+    end
 
-    def self.verbose(*msg); LOGCFG[:out].puts msg if LOGCFG[:verbose] ; end
+    def self.verbose(*msg)
+      LOGCFG[:out].puts msg if LOGCFG[:verbose]
+    end
 
-    def self.debug(*msg); LOGCFG[:out].puts msg if LOGCFG[:debug] ; end
+    def self.debug(*msg)
+      LOGCFG[:out].puts msg if LOGCFG[:debug]
+    end
 
     def self.logmsg(name, msg)
       log "%% #{name} - #{msg}"
     end
 
     def self.dump(from, to, dat)
-      if dump=LOGCFG[:dump]
-        log "%% #{from} SAYS TO #{to} LEN=#{dat.size}" if LOGCFG[:verbose]
-        case dump
-        when :hex
-          dat.hexdump(:out => LOGCFG[:out])
-        when :raw
-          LOGCFG[:out].puts dat
-        else
-          LOGCFG[:out].puts dat
-        end
-        log "%%" if LOGCFG[:verbose]
+      return unless dump = LOGCFG[:dump]
+
+      log "%% #{from} SAYS TO #{to} LEN=#{dat.size}" if LOGCFG[:verbose]
+      case dump
+      when :hex
+        dat.hexdump(out: LOGCFG[:out])
+      when :raw
+        LOGCFG[:out].puts dat
+      else
+        LOGCFG[:out].puts dat
       end
+      log '%%' if LOGCFG[:verbose]
     end
   end
 
-
   module Base
     attr_accessor :peers, :transport, :kind, :tls, :tls_opts, :no_stop_on_unbind
 
-    def initialize(transport, opts={})
-#      raise "Invalid transport #{transport.inspect}" unless (:UDP, :TCP).include?(transport)
+    def initialize(transport, opts = {})
+      #      raise "Invalid transport #{transport.inspect}" unless (:UDP, :TCP).include?(transport)
       @transport = transport
       @peers = PeerList.new(self)
 
-      opts.each_pair do |k,v|
-        accessor = k.to_s + "="
-        if self.respond_to?(accessor)
-          self.send(accessor, v)
-        else
-          raise "Bad attribute: #{k}"
-        end
+      opts.each_pair do |k, v|
+        accessor = k.to_s + '='
+        raise "Bad attribute: #{k}" unless respond_to?(accessor)
+
+        send(accessor, v)
       end
     end
 
     def name
       sn = get_sockname
-      addr = sn ? Socket.unpack_sockaddr_in(sn).reverse.join(":") : "PENDING"
+      addr = sn ? Socket.unpack_sockaddr_in(sn).reverse.join(':') : 'PENDING'
       "#{kind.to_s.upcase}-#{addr}(#{@transport})"
     end
 
-
-    # plug_peer creates a peering association for a given peer based on 
+    # plug_peer creates a peering association for a given peer based on
     # get_peername. The existing or newly created peer object is returned.
     def plug_peer
       paddr = get_peername
-      peer = (@peers.find_peer(paddr) || @peers.add_peer(paddr) )
+      @peers.find_peer(paddr) || @peers.add_peer(paddr)
     end
 
-
-    # plug_receive is used by receive_data to divert incoming messages. 
-    # The "peer" is added if it is not already present. This instance 
+    # plug_receive is used by receive_data to divert incoming messages.
+    # The "peer" is added if it is not already present. This instance
     # will check whether # a peer is "muted" and will return the peer if not.
     # This method can be overriden by child classes to implement additional
     # checks. It receives "dat" so that such checks can optionally make
     # forwarding decisions based on message data contents as well.
     #
-    # Returns: 
+    # Returns:
     #   - nil : indicates that the message should be stifled
-    #   - A peer object : indicates that the message should be processed 
+    #   - A peer object : indicates that the message should be processed
     #     further
-    def plug_receive(dat)
+    def plug_receive(_dat)
       peer = plug_peer
-      return peer unless peer.mute
+      peer unless peer.mute
     end
-   
-    # This instance of the say method is an abstract stub and just 
-    # "dumps" the message. It should be overridden and optionally called 
-    # with super() if you actually want to do anything useful when 
+
+    # This instance of the say method is an abstract stub and just
+    # "dumps" the message. It should be overridden and optionally called
+    # with super() if you actually want to do anything useful when
     # incoming messages are received.
     def say(dat, sender)
-      UI.dump(sender.name, self.name, dat)
+      UI.dump(sender.name, name, dat)
     end
 
     def post_init
       UI.verbose "** #{name} Started"
-      if @kind==:server and peer=plug_peer
+      if @kind == :server and peer = plug_peer
         UI.log "** #{name} CONNECTED TO #{peer.name}"
-        if tls
-          start_tls(tls_opts || {})
-        end
+        start_tls(tls_opts || {}) if tls
       end
     end
 
     def receive_data(dat)
-      if peer=plug_receive(dat)
-        say(dat, peer) 
+      if peer = plug_receive(dat)
+        say(dat, peer)
       end
-      return peer
+      peer
     end
 
     def connection_completed
       peer = plug_peer
       UI.log "** #{name} CONNECTED TO #{peer.name}"
-      if tls
-        start_tls(tls_opts || {})
-      end
-      return peer
+      start_tls(tls_opts || {}) if tls
+      peer
     end
 
     def unbind
-      UI.log "** Connection " + ((@peers.empty?)? "refused." : "closed.")
-      unless @no_stop_on_unbind
-        UI.log "STOPPING!!"
-        EM.stop  
-      end
+      UI.log '** Connection ' + (@peers.empty? ? 'refused.' : 'closed.')
+      return if @no_stop_on_unbind
+
+      UI.log 'STOPPING!!'
+      EM.stop
     end
   end
 
-
   # An abstract module to implement custom servers for any protocol
   # incoming messages are diverted to 'process(dat, sender)' which takes
   # a block, the yields to which are messages to respond with
-  module UdpServer 
+  module UdpServer
     include Base
 
-    def kind ; :server ; end
+    def kind
+      :server
+    end
 
     def say(dat, sender)
       super(dat, sender)
 
-      if self.respond_to? :process
-        self.send(:process, dat, sender) { |rply| sender.say(rply, self) }
-      end
+      send(:process, dat, sender) { |rply| sender.say(rply, self) } if respond_to? :process
     end
   end
 
-
-
   # Telson is just a receiver for blit
   module Telson
     include Base
-    def kind ; :telson ; end
+    def kind
+      :telson
+    end
   end
 
-
   # Uses an array of static messages as a datasource for opaque protocol
   # messages. Useful as a generic blit-able loop
   module ArrayFeeder
     include Base
-    attr_accessor :pos, :feed, :step, :close_at_end, :go_first, 
+    attr_accessor :pos, :feed, :step, :close_at_end, :go_first,
                   :squelch_exhausted
-    
+
     def initialize(*args)
       super(*args)
 
       @pos ||= 0
       @feed ||= []
 
-      raise "feed must be enumerable" unless Enumerable === @feed
+      raise 'feed must be enumerable' unless @feed.is_a?(Enumerable)
     end
-    
+
     def go
-      if @go_first
-        feed_data
-        @go_first = false
-      end
+      return unless @go_first
+
+      feed_data
+      @go_first = false
     end
 
     def connection_completed
-      peer=super()
+      peer = super()
       go if @go_first
-      return peer
+      peer
     end
 
-    
     def say(dat, sender)
       super(dat, sender)
       if @step
         EventMachine.defer(
           proc { UI.prompt ">> Hit [enter] to continue at #{@pos}:" },
-          proc {|x| feed_data }
+          proc { |_x| feed_data }
         )
       else
         feed_data
       end
     end
 
-    def feed_data(dst=plug_peer)
-      unless dat=@feed[@pos]
-        UI.log "** FEED EXHAUSTED" unless @squelch_exhausted
+    def feed_data(dst = plug_peer)
+      unless dat = @feed[@pos]
+        UI.log '** FEED EXHAUSTED' unless @squelch_exhausted
         return nil
       end
 
       dst.say dat.to_s, self
 
-      if (@pos += 1) >= @feed.size and @close_at_end
-        close_connection_after_writing
-      end
+      close_connection_after_writing if (@pos += 1) >= @feed.size and @close_at_end
     end
-
   end # ArrayFeeder
 end # Plug
-

data/lib/rbkb/plug/proxy.rb

@@ -1,4 +1,4 @@
-# Copyright 2009 emonti at matasano.com 
+# Copyright 2009 emonti at matasano.com
 # See README.rdoc for license information
 #
 
@@ -7,20 +7,16 @@ module Plug
     include Base
     attr_accessor :target
 
-    def initialize(transport, target)
+    def initialize(transport, _target)
       @transport = transport
       @peers = ProxyPeerList.new(self)
       @kind = :proxy
     end
-
   end
 
   class ProxyPeerList < PeerList
+    def add_peer(addr); end
 
-    def add_peer(addr)
-    end
-
-    def add_peer_manually(*args)
-    end
+    def add_peer_manually(*args); end
   end
 end

data/lib/rbkb/plug/unix_domain.rb

@@ -1,4 +1,4 @@
-# Copyright 2009 emonti at matasano.com 
+# Copyright 2009 emonti at matasano.com
 # See README.rdoc for license information
 #
 
@@ -16,11 +16,11 @@ module Plug
       @owner = owner
     end
 
-    def [](junk)
+    def [](_junk)
       @owner
     end
 
-    def []=(junk)
+    def []=(_junk)
       [@owner]
     end
 
@@ -37,39 +37,37 @@ module Plug
     end
 
     def name
-      "a domain socket"
+      'a domain socket'
     end
 
     def receive_data(dat)
-      puts "Got:", dat.hexdump
+      puts 'Got:', dat.hexdump
     end
 
     def say(dat, sender)
-      UI.dump(sender.name, self.name, dat)
+      UI.dump(sender.name, name, dat)
       send_data(dat)
     end
   end
 end
 
-
 if $0 == __FILE__
   Plug::UI::LOGCFG[:verbose] = true
 
   b_addr = Plug::Blit::DEFAULT_IPADDR
   b_port = Plug::Blit::DEFAULT_PORT
-  unless (sock=ARGV.shift and ARGV.shift.nil?)
-    STDERR.puts "usage: #{File.basename $0} unix_socket"
+  unless sock = ARGV.shift and ARGV.shift.nil?
+    warn "usage: #{File.basename $0} unix_socket"
     exit 1
   end
 
-
-  EventMachine.run {
+  EventMachine.run do
     s = EventMachine.connect_unix_domain(sock, Plug::UnixDomain)
-    Plug::UI::verbose("** UNIX-DOMAIN-#{sock.inspect} Started")
+    Plug::UI.verbose("** UNIX-DOMAIN-#{sock.inspect} Started")
 
     # connect a blit channel:
     EventMachine.start_server(b_addr, b_port, Plug::Blit, :TCP, s)
-    Plug::UI::verbose("** BLITSRV-#{b_addr}:#{b_port}(TCP) Started")
-  }
+    Plug::UI.verbose("** BLITSRV-#{b_addr}:#{b_port}(TCP) Started")
+  end
 
 end

data/lib/rbkb/plug.rb

@@ -1,11 +1,10 @@
-# Copyright 2009 emonti at matasano.com 
+# Copyright 2009 emonti at matasano.com
 # See README.rdoc for license information
 #
 
-require "rbkb"
+require 'rbkb'
 
-begin require 'rubygems' ; rescue LoadError ; end
+begin require 'rubygems'; rescue LoadError; end
 require 'eventmachine'
-require "rbkb/plug/plug"
-require "rbkb/plug/blit"
-
+require 'rbkb/plug/plug'
+require 'rbkb/plug/blit'

data/lib/rbkb/version.rb

@@ -1,3 +1,3 @@
 module Rbkb
-  VERSION = "0.7.2"
+  VERSION = '0.7.3'
 end

data/lib/rbkb.rb

@@ -1,6 +1,5 @@
-require "rbkb/version"
-require "rbkb/extends"
+require 'rbkb/version'
+require 'rbkb/extends'
 
 module Rbkb
-
 end

data/rbkb.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake", "~> 0"
-  spec.add_development_dependency "rspec", "~> 0"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake", "~> 13"
+  spec.add_development_dependency "rspec"
 end

data/test/disabled_test_cli_blit.rb

@@ -1,4 +1,4 @@
-require File.join(File.dirname(__FILE__), "test_cli_helper.rb")
+require File.join(File.dirname(__FILE__), 'test_cli_helper.rb')
 
 class TestCliBlit < Test::Unit::TestCase
   include CliTest
@@ -7,5 +7,4 @@ class TestCliBlit < Test::Unit::TestCase
     @cli_class = Rbkb::Cli::Blit
     super()
   end
-
 end

data/test/disabled_test_cli_feed.rb

@@ -1,4 +1,4 @@
-require File.join(File.dirname(__FILE__), "test_cli_helper.rb")
+require File.join(File.dirname(__FILE__), 'test_cli_helper.rb')
 
 class TestCliFeed < Test::Unit::TestCase
   include CliTest
@@ -7,5 +7,4 @@ class TestCliFeed < Test::Unit::TestCase
     @cli_class = Rbkb::Cli::Feed
     super()
   end
-
 end

data/test/disabled_test_cli_telson.rb

@@ -1,4 +1,4 @@
-require File.join(File.dirname(__FILE__), "test_cli_helper.rb")
+require File.join(File.dirname(__FILE__), 'test_cli_helper.rb')
 
 class TestCliTelson < Test::Unit::TestCase
   include CliTest
@@ -7,5 +7,4 @@ class TestCliTelson < Test::Unit::TestCase
     @cli_class = Rbkb::Cli::Telson
     super()
   end
-
 end

data/test/test_cli_crc32.rb

@@ -81,7 +81,7 @@ class TestCliCrc32 < Test::Unit::TestCase
     assert_match(/invalid range/, @stderr_io.string)
   end
 
-  def test_range_last_ten_hex
+  def test_range_last_ten_hex_invalid
     assert_equal 1, go_with_args(%w(-x 26:z30))
     assert_match(/invalid range/, @stderr_io.string)
   end