funl 0.2 → 0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bef263a447c026a1fdf3e7597c0e36b9b2d6c0ab
-  data.tar.gz: af313f5626ae330a3392ee84824074303f6dc141
+  metadata.gz: cbb42a88d076acb7f545c98acbeeae62d94accae
+  data.tar.gz: f78b9b4f60684598d01b387fb56d57e4320d3c1c
 SHA512:
-  metadata.gz: 832827e2caa92174648705c8a406b61a8b1d4b4847e543cf8b0a36598ee6cbfb3c6c524f34c696ab7508fd6571607026614e12298cdb6ef80d0c4732041b9f0f
-  data.tar.gz: b3a1d31d1af4122f644c7543e803b5ce612f2cdf3929372c365522948cac93b91a1eaaf8491b8929fb88c2f951669fff0f65d2d0c75e958151086387484d02a9
+  metadata.gz: 6735b03e0e9a8833dcfbad3ef8ad1ad139b06b12483d3d525b50fd24df4c0ec42f5f8c198eaf19e0f16d3a4bdba1958a72a1bae3279717bebcad68ecd2bfe085
+  data.tar.gz: 71d767408b0eaa9e1d1f818cf45271d23e8a44ab262bd0f70a413de35cbb17cf229b4d480abb3d6c9996cfae3b9a3cb76bfa08a09aa0c8673fc4aa843a37656f

data/Rakefile

@@ -1,12 +1,19 @@
 require 'rake'
 require 'rake/testtask'
 
+PRJ = "funl"
+
 def version
-  require 'funl/version'
-  @version ||= Funl::VERSION
+  @version ||= begin
+    require 'funl/version'
+    warn "Funl::VERSION not a string" unless Funl::VERSION.kind_of? String
+    Funl::VERSION
+  end
 end
 
-prj = "funl"
+def tag
+  @tag ||= "#{PRJ}-#{version}"
+end
 
 desc "Run tests"
 Rake::TestTask.new :test do |t|
@@ -15,16 +22,43 @@ Rake::TestTask.new :test do |t|
   t.test_files = FileList["test/**/*.rb"]
 end
 
-desc "commit, tag, and push repo; build and push gem"
-task :release do
-  tag = "#{prj}-#{version}"
+desc "Commit, tag, and push repo; build and push gem"
+task :release => "release:is_new_version" do
+  require 'tempfile'
+  
+  sh "gem build #{PRJ}.gemspec"
 
-  sh "gem build #{prj}.gemspec"
+  file = Tempfile.new "template"
+  begin
+    file.puts "release #{version}"
+    file.close
+    sh "git commit --allow-empty -a -v -t #{file.path}"
+  ensure
+    file.close unless file.closed?
+    file.unlink
+  end
 
-  sh "git commit -a -m 'release #{version}'"
-  sh "git tag #{prj}-#{version}"
+  sh "git tag #{tag}"
   sh "git push"
   sh "git push --tags"
   
-  sh "gem push #{prj}-#{version}.gem"
+  sh "gem push #{tag}.gem"
+end
+
+namespace :release do
+  desc "Diff to latest release"
+  task :diff do
+    latest = `git describe --abbrev=0 --tags --match '#{PRJ}-*'`.chomp
+    sh "git diff #{latest}"
+  end
+
+  desc "Log to latest release"
+  task :log do
+    latest = `git describe --abbrev=0 --tags --match '#{PRJ}-*'`.chomp
+    sh "git log #{latest}.."
+  end
+
+  task :is_new_version do
+    abort "#{tag} exists; update version!" unless `git tag -l #{tag}`.empty?
+  end
 end

data/lib/funl/client.rb

@@ -44,6 +44,24 @@ module Funl
       seq_read_greeting
     end
 
+    def subscribe tags
+      seq << Message.control(SUBSCRIBE, tags)
+      ## wait for ack which has tick, ask arc for older messages
+    end
+
+    def subscribe_all
+      seq << Message.control(SUBSCRIBE_ALL)
+      ## wait for ack which has tick, ask arc for older messages
+    end
+
+    def unsubscribe tags
+      seq << Message.control(UNSUBSCRIBE, tags)
+    end
+
+    def unsubscribe_all
+      seq << Message.control(UNSUBSCRIBE_ALL)
+    end
+
     def cseq_read_client_id
       log.debug "getting client_id from cseq"
       @client_id = cseq.read["client_id"]

data/lib/funl/message-sequencer.rb

@@ -18,6 +18,7 @@ module Funl
     attr_reader :message_class
     attr_reader :blob_type
     attr_reader :greeting
+    attr_reader :subscribers
     
     def initialize server, *conns, log: Logger.new($stderr),
         stream_type: ObjectStream::MSGPACK_TYPE,
@@ -37,6 +38,10 @@ module Funl
       conns.each do |conn|
         try_conn conn
       end
+      
+      @subscribers_to_all = [] # [conn, ...]
+      @subscribers = Hash.new {|h, tag| h[tag] = []} # tag => [conn, ...]
+      @tags = Hash.new {|h, conn| h[conn] = []} # conn => [tag, ...]
     end
 
     def default_greeting
@@ -49,8 +54,8 @@ module Funl
       stream = message_server_stream_for(conn)
       current_greeting = greeting.merge({"tick" => tick})
       if write_succeeds?(current_greeting, stream)
-        log.debug "connected #{stream.inspect}"
-        @streams << stream
+        log.debug {"connected #{stream.inspect}"}
+        streams << stream
       end
     end
     private :try_conn
@@ -78,7 +83,7 @@ module Funl
           when server
             begin
               conn, addr = readable.accept_nonblock
-              log.debug "accepted #{conn.inspect} from #{addr.inspect}"
+              log.debug {"accepted #{conn.inspect} from #{addr.inspect}"}
               try_conn conn
             rescue IO::WaitReadable
               next
@@ -93,15 +98,18 @@ module Funl
               end
             rescue IOError, SystemCallError => ex
               log.debug {"closing #{readable}: #{ex}"}
-              @streams.delete readable
-              readable.close unless readable.closed?
+              reject_stream readable
             else
               log.debug {
                 "read #{msgs.size} messages from #{readable.peer_name}"}
             end
 
             msgs.each do |msg|
-              handle_message msg
+              if msg.control?
+                handle_control readable, *msg.control_op
+              else
+                handle_message msg
+              end
             end
           end
         end
@@ -111,12 +119,56 @@ module Funl
       raise
     end
 
+    def handle_control stream, op_type, tags = nil
+      log.debug {"#{stream} #{op_type} #{tags}"}
+
+      case op_type
+      when SUBSCRIBE_ALL
+        @subscribers_to_all += [stream]
+        ack = Message.control(op_type)
+        ack.global_tick = tick
+        write_succeeds?(ack, stream)
+      
+      when SUBSCRIBE
+        tags.each do |tag|
+          @subscribers[tag] += [stream]
+        end
+        @tags[stream] += tags
+        ack = Message.control(op_type, tags)
+        ack.global_tick = tick
+        write_succeeds?(ack, stream)
+
+      when UNSUBSCRIBE_ALL
+        @subscribers_to_all.delete stream
+
+      when UNSUBSCRIBE
+        tags.each do |tag|
+          @subscribers[tag].delete stream
+        end
+        @tags[stream] -= tags
+
+      else
+        log.error "bad operation: #{op_type.inspect}"
+        return
+      end
+    end
+
     def handle_message msg
       log.debug {"handling message #{msg.inspect}"}
+
       @tick += 1
       msg.global_tick = tick
       msg.delta = nil
-      @streams.keep_if do |stream|
+
+      tags = msg.tags
+      dest_streams =
+        if !tags or (tags.empty? rescue true)
+          @subscribers_to_all.dup
+        else
+          tags.inject(@subscribers_to_all) {|a,tag| a + @subscribers[tag]}
+        end
+
+      dest_streams.each do |stream|
         write_succeeds? msg, stream
       end
     end
@@ -127,9 +179,23 @@ module Funl
       true
     rescue IOError, SystemCallError => ex
       log.debug {"closing #{stream}: #{ex}"}
-      stream.close unless stream.closed?
+      reject_stream stream
       false
     end
     private :write_succeeds?
   end
+
+  def reject_stream stream
+    stream.close unless stream.closed?
+    if streams.include? stream
+      streams.delete stream
+      @subscribers_to_all.delete stream
+      tags = @tags.delete stream
+      if tags
+        tags.each do |tag|
+          @subscribers[tag].delete stream
+        end
+      end
+    end
+  end
 end

data/lib/funl/message.rb

@@ -29,6 +29,20 @@ module Funl
       client: nil, local: nil, global: nil, delta: nil, tags: nil, blob: nil)
       new client, local, global, delta, tags, blob
     end
+    
+    def self.control op_type, *args
+      Message.new.tap {|m| m.client_id = [op_type, *args]}
+    end
+
+    # Is this a control packet rather than a data packet?
+    def control?
+      @client_id.kind_of? Array
+    end
+    
+    # Array of [op_type, *args] for the control operation.
+    def control_op
+      @client_id
+    end
 
     def inspect
       d = delta ? "+#{delta}" : nil

data/lib/funl/stream.rb

@@ -1,6 +1,11 @@
 require 'object-stream-wrapper'
 
 module Funl
+  SUBSCRIBE       = "subscribe".freeze
+  UNSUBSCRIBE     = "unsubscribe".freeze
+  SUBSCRIBE_ALL   = "subscribe_all".freeze
+  UNSUBSCRIBE_ALL = "unsubscribe_all".freeze
+  
   # Mixin depends on stream_type, log, client_id, message_class.
   module Stream
     def client_stream_for io, type: stream_type

data/lib/funl/version.rb

@@ -1,3 +1,3 @@
 module Funl
-  VERSION = "0.2"
+  VERSION = "0.3"
 end

data/test/test-message-sequencer.rb

@@ -47,9 +47,16 @@ class TestMessageSequencer < Minitest::Test
     streams = (0...@n_clients).map do
       conn = UNIXSocket.new(@path)
       stream = ObjectStreamWrapper.new(conn, type: stream_type)
-      stream.write_to_outbox{{"client_id" => "test_later_conns"}}
+      stream.write_to_outbox({"client_id" => "test_later_conns"})
+      stream.write(Message.control(SUBSCRIBE_ALL))
       global_tick = stream.read["tick"]
       assert_equal 0, global_tick
+
+      stream.expect Message
+      ack = stream.read
+      assert ack.control?
+      assert_equal 0, ack.global_tick
+
       stream
     end
     
@@ -73,7 +80,6 @@ class TestMessageSequencer < Minitest::Test
     src << message
     
     replies = dst.map do |stream|
-      stream.expect Message
       stream.read
     end
     
@@ -103,10 +109,16 @@ class TestMessageSequencer < Minitest::Test
 
       conn = UNIXSocket.new(path)
       stream = ObjectStreamWrapper.new(conn, type: mseq.stream_type)
-      stream.write_to_outbox{{"client_id" => "test_persist"}} # not needed
+      stream.write_to_outbox({"client_id" => "test_persist"}) # not needed
+      stream.write(Message.control(SUBSCRIBE_ALL))
       tick = stream.read["tick"]
       assert_equal n_write, tick
 
+      stream.expect Message
+      ack = stream.read
+      assert ack.control?
+      assert_equal n_write, ack.global_tick
+
       stream.write Message.new
       stream.read
       n_write += 1

data/test/test-subscribe.rb

@@ -0,0 +1,175 @@
+require 'funl/message-sequencer'
+require 'socket'
+
+include Funl
+
+require 'minitest/autorun'
+
+class TestSubscribe < Minitest::Test
+  attr_reader :log, :mseq
+
+  def setup
+    @log = Logger.new($stderr)
+    log.level = Logger::WARN
+    
+    client_socks = []
+    server_socks = []
+    2.times do
+      cl, sv = UNIXSocket.pair
+      client_socks << cl
+      server_socks << sv
+    end
+    
+    dummy, _ = UNIXSocket.pair
+
+    @mseq = MessageSequencer.new dummy, *server_socks, log: log
+    mseq.start
+    
+    @streams = client_socks.each_with_index.map do |s,i|
+      stream = ObjectStreamWrapper.new(s, type: mseq.stream_type)
+      stream.write_to_outbox({"client_id" => "client #{i}"})
+      global_tick = stream.read["tick"]
+      stream.expect Message
+      stream
+    end
+  end
+  
+  def teardown
+    mseq.stop rescue nil
+  end
+
+  def test_single_tag
+    snd, rcv = @streams
+    rcv << Message.control(SUBSCRIBE, ["foo"])
+    ack = rcv.read
+    assert ack.control?
+    assert_equal 0, ack.global_tick
+    
+    snd << Message[
+      client: 0, local: 0, global: 0, delta: 1,
+      tags: ["bar"], blob: ""]
+    snd << Message[
+      client: 0, local: 0, global: 0, delta: 2,
+      tags: ["foo"], blob: ""]
+    
+    m = rcv.read
+    assert_equal 2, m.global_tick
+    assert_equal ["foo"], m.tags
+  end
+  
+  def test_multiple_tag
+    snd, rcv = @streams
+    rcv << Message.control(SUBSCRIBE, ["foo", "bar"])
+    ack = rcv.read
+    assert ack.control?
+    assert_equal 0, ack.global_tick
+    
+    snd << Message[
+      client: 0, local: 0, global: 0, delta: 1,
+      tags: ["bar"], blob: ""]
+    snd << Message[
+      client: 0, local: 0, global: 0, delta: 2,
+      tags: ["foo"], blob: ""]
+    
+    m = rcv.read
+    assert_equal 1, m.global_tick
+    assert_equal ["bar"], m.tags
+    m = rcv.read
+    assert_equal 2, m.global_tick
+    assert_equal ["foo"], m.tags
+  end
+  
+  def test_multiple_receiver
+    snd, rcv = @streams
+    @streams.each do |stream|
+      stream << Message.control(SUBSCRIBE, ["foo"])
+      ack = stream.read
+      assert ack.control?
+      assert_equal 0, ack.global_tick
+    end
+    
+    snd << Message[
+      client: 0, local: 0, global: 0, delta: 1,
+      tags: ["foo"], blob: ""]
+    
+    @streams.each do |stream|
+      m = stream.read
+      assert_equal 1, m.global_tick
+      assert_equal ["foo"], m.tags
+    end
+  end
+
+  def test_unsubscribe
+    snd, rcv = @streams
+    rcv << Message.control(SUBSCRIBE, ["foo"])
+    ack = rcv.read
+    assert ack.control?
+    assert_equal 0, ack.global_tick
+    
+    snd << Message[
+      client: 0, local: 0, global: 0, delta: 1,
+      tags: ["foo"], blob: ""]
+    
+    m = rcv.read
+    assert_equal 1, m.global_tick
+    assert_equal ["foo"], m.tags
+
+    rcv << Message.control(UNSUBSCRIBE, ["foo"])
+    
+    snd << Message[
+      client: 0, local: 0, global: 0, delta: 1,
+      tags: ["foo"], blob: ""]
+    
+    sleep 0.2
+    
+    rcv << Message.control(SUBSCRIBE, ["foo"])
+    ack = rcv.read
+    assert ack.control?
+    assert_equal 2, ack.global_tick
+    
+    snd << Message[
+      client: 0, local: 0, global: 0, delta: 1,
+      tags: ["foo"], blob: ""]
+    
+    m = rcv.read
+    assert_equal 3, m.global_tick
+    assert_equal ["foo"], m.tags
+  end
+  
+  def test_subscribe_all
+    snd, rcv = @streams
+    rcv << Message.control(SUBSCRIBE_ALL)
+    ack = rcv.read
+    assert ack.control?
+    assert_equal 0, ack.global_tick
+    
+    snd << Message[
+      client: 0, local: 0, global: 0, delta: 1,
+      tags: ["foo"], blob: ""]
+    
+    m = rcv.read
+    assert_equal 1, m.global_tick
+    assert_equal ["foo"], m.tags
+
+    rcv << Message.control(UNSUBSCRIBE_ALL)
+    
+    snd << Message[
+      client: 0, local: 0, global: 0, delta: 1,
+      tags: ["foo"], blob: ""]
+    
+    sleep 0.2
+    
+    rcv << Message.control(SUBSCRIBE_ALL)
+    ack = rcv.read
+    assert ack.control?
+    assert_equal 2, ack.global_tick
+    
+    snd << Message[
+      client: 0, local: 0, global: 0, delta: 1,
+      tags: ["foo"], blob: ""]
+    
+    m = rcv.read
+    assert_equal 3, m.global_tick
+    assert_equal ["foo"], m.tags
+  end
+end

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: funl
 version: !ruby/object:Gem::Version
-  version: '0.2'
+  version: '0.3'
 platform: ruby
 authors:
 - Joel VanderWerf
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-17 00:00:00.000000000 Z
+date: 2013-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: object-stream
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Sequences messages.
@@ -48,6 +48,7 @@ files:
 - test/test-client-sequencer.rb
 - test/test-message.rb
 - test/test-stream.rb
+- test/test-subscribe.rb
 - test/test-client.rb
 homepage: https://github.com/vjoel/funl
 licenses:
@@ -55,28 +56,28 @@ licenses:
 metadata: {}
 post_install_message: 
 rdoc_options:
-- --quiet
-- --line-numbers
-- --inline-source
-- --title
+- "--quiet"
+- "--line-numbers"
+- "--inline-source"
+- "--title"
 - funl
-- --main
+- "--main"
 - README.md
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.4
+rubygems_version: 2.1.4
 signing_key: 
 specification_version: 4
 summary: Sequences messages
@@ -85,5 +86,6 @@ test_files:
 - test/test-client-sequencer.rb
 - test/test-message.rb
 - test/test-stream.rb
+- test/test-subscribe.rb
 - test/test-client.rb
 has_rdoc: