tupelo 0.21 → 0.22

data/example/sqlite/poi-v2.rb

@@ -23,14 +23,14 @@ Tupelo.application do
       when "find box"
         arg = req[:arg] ## should validate args
         lat = arg[:lat]; lng = arg[:lng]
-        template = PoiTemplate.new(poi_template: poispace,
+        template = PoiTemplate.new(poispace,
           lat: lat[0]..lat[1], lng: lng[0]..lng[1])
         write id: req[:id], result: read_all(template)
 
       when "delete box"
         arg = req[:arg]
         lat = arg[:lat]; lng = arg[:lng]
-        template = PoiTemplate.new(poi_template: poispace,
+        template = PoiTemplate.new(poispace,
           lat: lat[0]..lat[1], lng: lng[0]..lng[1])
 
         deleted = []

data/example/subspaces/ramp.rb

@@ -1,6 +1,7 @@
 # Read-atomic multipartition transactions, as per:
 #   http://www.youtube.com/watch?v=_rAdJkAbGls (around minutes 28-30)
 #   http://www.bailis.org/blog/non-blocking-transactional-atomicity
+#   http://www.bailis.org/blog/scalable-atomic-visibility-with-ramp-transactions
 #
 # Example of transacting separately on two subspaces (i.e. shardable subsets of
 # the tuplespace), but hiding intermediate tuples so that the results show up
@@ -9,7 +10,7 @@
 # tupelo transactions.)
 #
 # In tupelo, we could use the classic tuplespace technique of taking a lock
-# tuple to protect the sequence ot two transactions on the two subspaces, but
+# tuple to protect the sequence of two transactions on the two subspaces, but
 # that would reduce concurrency and require a lease mechanism in case the lock
 # holder dies. That's possible, but not scalable. So we use transactions with a
 # trick...
@@ -33,7 +34,7 @@ X_REPLICATIONS = 1 # number of copies of the shard of X data
 Y_REPLICATIONS = 1 # number of copies of the shard of Y data
 
 def next_local_id
-  @counter = 0
+  @counter ||= 0
   @counter += 1
     # Protect this with a mutex or queue if other threads need it, or
     # use the atomic gem. It's ok in a multiprocess app without mutex,
@@ -128,6 +129,12 @@ Tupelo.application do
   # This doesn't test that RAMP is working -- it will always see a consistent
   # view because of tupelo, even without the pending/ack trick. It is more
   # informative to look at the log output from the x and y clients.
+  #
+  # The key point of this example is that we could write a reader process that
+  # doesn't use tupelo at all, but accesses the data stores directly (assuming
+  # we're using a client-server store like postgres or a concurrent key-value
+  # store like leveldb or lmdb). This non-tupelo process would only need to be
+  # aware of the RAMP semantics of pending and id fields.
   child subscribe: ["x", "y"], passive: true do
     log.progname = "reader"
     read do |t|

data/example/tcp.rb

@@ -18,6 +18,11 @@
 # Then run a client like this:
 #
 #   bin/tup remote-copy-of-tcp.yaml
+#
+# If you have ssh set up, you don't even need to copy the file. Just reference
+# it in the same way you would with scp:
+#
+#   bin/tup host:tcp.yaml
 
 require 'tupelo/app'
 

data/example/tiny-tcp-client.rb

@@ -0,0 +1,15 @@
+# See tiny-tcp-service.rb
+
+require 'tupelo/app'
+
+Tupelo.application do
+  if owns_services
+    abort "service not running"
+  end
+
+  local do
+    x = rand(0..100); y = rand(0..100)
+    write [x, y]
+    log "%p + %p = %p" % take([x, y, Numeric])
+  end
+end

data/example/tiny-tcp-service.rb

@@ -0,0 +1,32 @@
+# Run this with a specified filename: 
+#
+#   ruby tiny-tcp-service.rb srv.yaml
+#
+# Then you can run the client locally:
+#
+#   ruby tiny-tcp-client.rb srv.yaml
+#
+# or from a remote host that can ssh back to the server
+#
+#   ruby tiny-tcp-client.rb serverhost:path/to/srv.yaml
+#
+# (Use the --tunnel switch to send the data over ssh, as well.)
+#
+# You can also access the service using tup:
+#
+#   tup srv.yaml
+#   >> w [12, 34]
+#   >> r [12, 34, nil]
+#   => [12, 34, 46]
+
+require 'tupelo/app'
+
+Tupelo.tcp_application do
+  puts "service started"
+  local do
+    loop do
+      x, y = take [Numeric, Numeric]
+      write [x, y, x+y]
+    end
+  end
+end

data/lib/tupelo/app.rb

@@ -34,7 +34,7 @@ module Tupelo
 
     opts[:trace] = argv.delete("--trace")
     opts[:tunnel] = argv.delete("--tunnel")
-    
+
     [argv, opts]
   end
 
@@ -54,7 +54,7 @@ module Tupelo
   def self.application argv: nil,
         services_file: nil, blob_type: nil,
         seqd_addr: {}, cseqd_addr: {}, arcd_addr: {}, **opts, &block
-  
+
     unless argv
       argv, h = parse_args(ARGV)
       opts.merge! h
@@ -121,7 +121,7 @@ module Tupelo
 
       app = AppBuilder.new(ez, argv: argv.dup,
           owns_services: owns_services, tunnel_default: tunnel_default)
-      
+
       if enable_trace
         require 'tupelo/app/trace'
         app.start_trace
@@ -137,7 +137,7 @@ module Tupelo
 
       if block
         if block.arity == 0
-          app.instance_eval &block
+          app.instance_eval(&block)
         else
           yield app
         end

data/lib/tupelo/app/builder.rb

@@ -53,7 +53,7 @@ module Tupelo
         run_client client_class, **opts do |client|
           if block
             if block.arity == 0
-              client.instance_eval &block
+              client.instance_eval(&block)
             else
               yield client
             end
@@ -76,7 +76,7 @@ module Tupelo
         run_client client_class, **opts do |client|
           if block
             if block.arity == 0
-              client.instance_eval &block
+              client.instance_eval(&block)
             else
               yield client
             end

data/lib/tupelo/app/irb-shell.rb

@@ -7,7 +7,7 @@ module IRB
   def IRB.parse_opts
     # Don't touch ARGV, which belongs to the app which called this module.
   end
-  
+
   def IRB.start_session(*args)
     unless $irb
       IRB.setup nil
@@ -34,7 +34,7 @@ module IRB
     trap 'INT' do
       $irb.signal_handle
     end
-    
+
     custom_configuration if defined?(IRB.custom_configuration)
 
     begin
@@ -44,7 +44,7 @@ module IRB
     ensure
       IRB.irb_at_exit
     end
-    
+
     ## might want to reset your app's interrupt handler here
   end
 end

data/lib/tupelo/archiver.rb

@@ -6,8 +6,6 @@ require 'funl/history-client'
 ## should manipulate tuples as strings (at least in msgpack/json cases) instead
 ## of objects -- use msgpack extension for #hash and #== on packed objects
 
-class Tupelo::Archiver < Tupelo::Client; end
-
 require 'tupelo/archiver/worker'
 require 'tupelo/archiver/tuplestore' ## unless persistent?
 

data/lib/tupelo/archiver/tuplestore.rb

@@ -1,4 +1,4 @@
-class Tupelo::Archiver
+class Tupelo::Archiver < Tupelo::Client
   # Faster than the default tuplestore, but does not support some things
   # that are not needed in the Archiver: template searches, for example.
   class TupleStore

data/lib/tupelo/archiver/worker.rb

@@ -1,11 +1,11 @@
 require 'funl/history-worker'
 
-class Tupelo::Archiver
+class Tupelo::Archiver < Tupelo::Client
   class Worker < Tupelo::Client::Worker
     include Funl::HistoryWorker
-    
+
     def initialize *args, **opts
-      super *args
+      super(*args)
       @scheduled_actions = Hash.new {|h,k| h[k] = []}
       @opts = opts
     end
@@ -13,7 +13,7 @@ class Tupelo::Archiver
     def tuplestore
       @tuplestore ||= begin
         if client.tuplestore.respond_to? :new
-          client.tuplestore.new **@opts
+          client.tuplestore.new(**@opts)
         else
           client.tuplestore
         end
@@ -81,7 +81,7 @@ class Tupelo::Archiver
     ensure
       req.io.close
     end
-    
+
     def at_tick tick, &action
       @scheduled_actions[tick] << action
     end
@@ -99,7 +99,7 @@ class Tupelo::Archiver
         "send_tuplestore to #{stream.peer_name} " +
         "at tick #{global_tick.inspect} " +
         (sub_delta ? " with sub_delta #{sub_delta.inspect}" : "")}
-      
+
       stream << [global_tick]
 
       ## better: make use of sub_delta["subscribed_*"] to reduce what

data/lib/tupelo/client.rb

@@ -13,7 +13,7 @@ module Tupelo
     attr_reader :tuplestore
 
     def initialize(tuplestore: SimpleTupleStore, subscribe: :all, **opts)
-      super **opts
+      super(**opts)
       @tuplestore = tuplestore
       @worker = make_worker
       @initial_subscriptions = subscribe || []
@@ -57,7 +57,7 @@ module Tupelo
       if args.empty?
         super()
       else
-        super().unknown *args
+        super().unknown(*args)
       end
     end
   end

data/lib/tupelo/client/reader.rb

@@ -85,7 +85,7 @@ class Tupelo::Client
         false
       end
     end
-    
+
     def peek tuple
       queue << tuple
       once
@@ -102,10 +102,10 @@ class Tupelo::Client
       "<#{self.class}: #{template.inspect}>"
     end
   end
-  
+
   class Waiter < WaiterBase
   end
-  
+
   class Matcher < WaiterBase
     attr_reader :all # this is only cosmetic -- see #inspect
 

data/lib/tupelo/client/scheduler.rb

@@ -14,7 +14,7 @@ module Tupelo
       # Instead of calling this method, call Client#make_scheduler.
       def initialize client, **opts
         @client = client
-        super **opts
+        super(**opts)
       end
 
       # Accepts numeric +time+ or Time instance. Logs errors that occur

data/lib/tupelo/client/subspace.rb

@@ -34,10 +34,10 @@ class Tupelo::Client
       })
     end
 
-    def subspace tag
+    def subspace tag, wait: false
       tag = tag.to_s
       find_subspace_by_tag(tag) or begin
-        if subscribed_tags.include? tag
+        if wait or subscribed_tags.include? tag
           read tupelo_meta_key => "subspace",
             tag:      tag,
             template: nil,

data/lib/tupelo/client/transaction.rb

@@ -23,7 +23,7 @@ class Tupelo::Client
 
       val =
         if block.arity == 0
-          t.instance_eval &block
+          t.instance_eval(&block)
         else
           yield t
         end
@@ -39,7 +39,7 @@ class Tupelo::Client
     ensure
       t.cancel if t and t.open? and block_given?
     end
-    
+
     def abort
       raise TransactionAbort
     end
@@ -47,7 +47,7 @@ class Tupelo::Client
     # returns an object whose #wait method waits for write to be ack-ed
     def write_nowait *tuples
       t = transaction
-      t.write *tuples
+      t.write(*tuples)
       t.commit
     end
     alias write write_nowait
@@ -59,7 +59,7 @@ class Tupelo::Client
 
     def pulse_nowait *tuples
       t = transaction
-      t.pulse *tuples
+      t.pulse(*tuples)
       t.commit
     end
     alias pulse pulse_nowait
@@ -88,7 +88,7 @@ class Tupelo::Client
       end
     end
   end
-  
+
   class Transaction
     attr_reader :client
     attr_reader :worker
@@ -109,7 +109,7 @@ class Tupelo::Client
     attr_reader :missing
     attr_reader :tags
     attr_reader :read_only
-    
+
     STATES = [
       OPEN      = :open,    # initial state
       CLOSED    = :closed,  # client thread changes open -> closed
@@ -118,7 +118,7 @@ class Tupelo::Client
       DONE      = :done,    # worker thread changes pending -> done (terminal)
       FAILED    = :failed   # worker thread changes pending -> failed (terminal)
     ]
-    
+
     STATES.each do |s|
       class_eval %{
         def #{s}?; @status == #{s.inspect}; end
@@ -151,7 +151,7 @@ class Tupelo::Client
       @_take_nowait = nil
       @_read_nowait = nil
       @read_only = false
-      
+
       open!
 
       if deadline
@@ -160,11 +160,11 @@ class Tupelo::Client
         end
       end
     end
-    
+
     def client_id
       client.client_id
     end
-    
+
     def subspace tag
       client.subspace tag
     end
@@ -173,7 +173,7 @@ class Tupelo::Client
       if args.empty?
         @log
       else
-        @log.unknown *args
+        @log.unknown(*args)
       end
     end
 
@@ -185,9 +185,9 @@ class Tupelo::Client
         when done?
           "at global_tick: #{global_tick}"
         end
-      
+
       stat = [status, stat_extra].compact.join(" ")
-      
+
       ops = [ ["write", writes], ["pulse", pulses],
             ["take", take_templates], ["read", read_templates] ]
             ## exclude templates that were satisfied locally by writes
@@ -200,10 +200,10 @@ class Tupelo::Client
       ## show take/read tuples too?
       ## show current tick, if open or closed
       ## show nowait
-      
+
       "<#{self.class} #{stat} #{ops.join('; ')}>"
     end
-    
+
     # :section: Client methods
 
     def check_tuples tuples
@@ -233,7 +233,7 @@ class Tupelo::Client
         # to convert symbols to strings (in case of msgpack or json)
       nil
     end
-    
+
     def pulse *tuples
       check_open
       check_tuples tuples
@@ -241,7 +241,7 @@ class Tupelo::Client
       @pulses.concat tuples.map {|t| blobber.load(blobber.dump(t))}
       nil
     end
-    
+
     # raises TransactionFailure
     def take template_spec
       check_open
@@ -252,7 +252,7 @@ class Tupelo::Client
       wait
       return take_tuples_for_local.last
     end
-    
+
     def take_nowait template_spec
       check_open
       template = worker.make_template(template_spec)
@@ -265,7 +265,7 @@ class Tupelo::Client
       wait
       return take_tuples_for_local[i]
     end
-    
+
     # transaction applies only if template has a match
     def read template_spec
       if block_given?
@@ -328,7 +328,7 @@ class Tupelo::Client
     def wait
       return self if done?
       raise exception if failed?
-      
+
       log.debug {"waiting for #{inspect}"}
       @queue.pop
       log.debug {"finished waiting for #{inspect}"}
@@ -348,7 +348,7 @@ class Tupelo::Client
       wait
       granted_tuples
     end
-    
+
     class TransactionThread < Thread
       def initialize t, *args
         super(*args)
@@ -365,7 +365,7 @@ class Tupelo::Client
         begin
           val =
             if block.arity == 0
-              instance_eval &block
+              instance_eval(&block)
             else
               yield self
             end
@@ -381,7 +381,7 @@ class Tupelo::Client
     end
 
     # :section: Worker methods
-    
+
     def in_worker_thread?
       worker.in_thread?
     end
@@ -523,7 +523,7 @@ class Tupelo::Client
       ## redo the conversions etc
       return true
     end
-    
+
     def submit
       raise TransactionStateError, "must be closed" unless closed?
       raise unless in_worker_thread?
@@ -531,7 +531,7 @@ class Tupelo::Client
       @local_tick = worker.send_transaction self
       pending!
     end
-    
+
     def done global_tick, granted_tuples
       unless pending? or (closed? and read_only)
         raise TransactionStateError, "must be pending or closed+read_only"
@@ -549,17 +549,17 @@ class Tupelo::Client
     def fail missing
       raise unless in_worker_thread?
       raise if @global_tick or @exception
-      
+
       @missing = missing
       @exception = TransactionFailure
       failed!
       @queue << false
     end
-    
+
     def error ex
       raise unless in_worker_thread?
       raise if @global_tick or @exception
-      
+
       @exception = ex
       failed!
       @queue << false