feedx 0.6.2 → 0.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e5d88effb5a873a2cb2e16d4c7f824b824ef2f93bc306c500b3f97314b7d91c
-  data.tar.gz: be78ba37f5869fc6c2e026f2c1809dd083e7a0d02a55f66be3e9d555a6c7dc58
+  metadata.gz: 1f4710e181ac3c987f7b02ebc976cf70bbc4c9826139823bca58620d94aa994a
+  data.tar.gz: 273951be43e9e8ac3473bfccf428cf2860c34dd4c0869b86f726446c477c2e7f
 SHA512:
-  metadata.gz: 9dab374c591498c3a23a0f2fab33fc8268c3c6028205b83c5483a4ebe27e468f00b05dfeb1200b237f358997f1d01654bec61fc1bb6fdd5c89fe317dba1e562d
-  data.tar.gz: 71d086bc0f43ef382e354c710badb8b0f10f3cab75dca6f79abda448add5115c2c82ab26ab9a4b503cab23960918fd768d4b505d3ebb4a66156341d334525de1
+  metadata.gz: 862eeb21fda2add182866fdb686adab45091d585a9880565b7e12c2ef3240ecc3982ec09e0370f1e4734d57ac44aa97cd5fcd702215c84d9534e5eab5ba9b648
+  data.tar.gz: fc10bdbfea9922ca29d3d0967ab8a1aa14330b914b1e07972ca61e040620d2ccdcd710e0eb63860001feb3c366097652b825fd4660e847449edfeecdbd3232e0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    feedx (0.6.2)
+    feedx (0.6.3)
       bfs (>= 0.3.4)
 
 GEM

data/consumer.go

@@ -17,8 +17,8 @@ type ConsumerOptions struct {
 	Interval time.Duration
 
 	// AfterSync callbacks are triggered after each sync, receiving
-	// the updated status and error (if occurred).
-	AfterSync func(updated bool, consumer Consumer, err error)
+	// the sync state and error (if occurred).
+	AfterSync func(*ConsumerSync, error)
 }
 
 func (o *ConsumerOptions) norm(name string) error {
@@ -29,6 +29,18 @@ func (o *ConsumerOptions) norm(name string) error {
 	return nil
 }
 
+// ConsumerSync contains the state of the last sync.
+type ConsumerSync struct {
+	// Consumer exposes the current consumer state.
+	Consumer
+	// Updated indicates is the sync resulted in an update.
+	Updated bool
+	// PreviousData references the data before the update.
+	// It allows to apply finalizers to data structures created by ConsumeFunc.
+	// This is only set when an update happened.
+	PreviousData interface{}
+}
+
 // ConsumeFunc is a parsing callback which is run by the consumer every sync interval.
 type ConsumeFunc func(FormatDecoder) (data interface{}, err error)
 
@@ -137,7 +149,7 @@ func (c *consumer) Close() error {
 	return nil
 }
 
-func (c *consumer) sync(force bool) (bool, error) {
+func (c *consumer) sync(force bool) (*ConsumerSync, error) {
 	defer func() {
 		atomic.StoreInt64(&c.lastSync, timestampFromTime(time.Now()).Millis())
 	}()
@@ -145,32 +157,37 @@ func (c *consumer) sync(force bool) (bool, error) {
 	// retrieve original last modified time
 	lastMod, err := remoteLastModified(c.ctx, c.remote)
 	if err != nil {
-		return false, err
+		return nil, err
 	}
 
 	// skip update if not forced or modified
 	if lastMod.Millis() == atomic.LoadInt64(&c.lastMod) && !force {
-		return false, nil
+		return &ConsumerSync{Consumer: c}, nil
 	}
 
 	// open remote reader
 	reader, err := NewReader(c.ctx, c.remote, &c.opt.ReaderOptions)
 	if err != nil {
-		return false, err
+		return nil, err
 	}
 	defer reader.Close()
 
 	// consume feed
 	data, err := c.cfn(reader)
 	if err != nil {
-		return false, err
+		return nil, err
 	}
 
 	// update stores
+	previous := c.data.Load()
 	c.data.Store(data)
 	atomic.StoreInt64(&c.numRead, int64(reader.NumRead()))
 	atomic.StoreInt64(&c.lastMod, lastMod.Millis())
-	return true, nil
+	return &ConsumerSync{
+		Consumer:     c,
+		Updated:      true,
+		PreviousData: previous,
+	}, nil
 }
 
 func (c *consumer) loop() {
@@ -182,9 +199,9 @@ func (c *consumer) loop() {
 		case <-c.ctx.Done():
 			return
 		case <-ticker.C:
-			updated, err := c.sync(false)
+			state, err := c.sync(false)
 			if c.opt.AfterSync != nil {
-				c.opt.AfterSync(updated, c, err)
+				c.opt.AfterSync(state, err)
 			}
 		}
 	}

data/feedx.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name          = 'feedx'
-  s.version       = '0.6.2'
+  s.version       = '0.6.3'
   s.authors       = ['Black Square Media Ltd']
   s.email         = ['info@blacksquaremedia.com']
   s.summary       = %(Exchange data between components via feeds)

data/lib/feedx/format.rb

@@ -5,6 +5,12 @@ module Feedx
     autoload :Protobuf, 'feedx/format/protobuf'
 
     class << self
+      def register(ext, kind)
+        raise ArgumentError, "#{kind} is not a subclass of Feedx::Format::Abstract" unless kind.is_a?(Class) && kind < Abstract
+
+        registry[ext.to_s] = kind
+      end
+
       def resolve(name)
         _resolve(name) || raise(ArgumentError, "invalid format #{name}")
       end
@@ -24,13 +30,23 @@ module Feedx
 
       private
 
+      def registry
+        @registry ||= {
+          'json'     => :JSON,
+          'pb'       => :Protobuf,
+          'proto'    => :Protobuf,
+          'protobuf' => :Protobuf,
+        }
+      end
+
       def _resolve(name)
-        case name.to_s
-        when 'pb', 'proto', 'protobuf'
-          Protobuf
-        when 'json'
-          JSON
+        name  = name.to_s
+        klass = registry[name]
+        if klass.is_a?(Symbol)
+          klass = const_get(klass)
+          registry[name.to_s] = klass
         end
+        klass
       end
     end
   end

data/producer.go

@@ -24,8 +24,8 @@ type ProducerOptions struct {
 	LastModCheck func(context.Context) (time.Time, error)
 
 	// AfterPush callbacks are triggered after each push cycle, receiving
-	// the updated status and error (if occurred).
-	AfterPush func(updated bool, consumer *Producer, err error)
+	// the push state and error (if occurred).
+	AfterPush func(*ProducerPush, error)
 }
 
 func (o *ProducerOptions) norm(name string) error {
@@ -36,6 +36,14 @@ func (o *ProducerOptions) norm(name string) error {
 	return nil
 }
 
+// ProducerPush contains the state of the last push.
+type ProducerPush struct {
+	// Producer exposes the current producer state.
+	*Producer
+	// Updated indicates is the push resulted in an update.
+	Updated bool
+}
+
 // Producer (continously) produces a feed.
 type Producer struct {
 	remote    *bfs.Object
@@ -120,7 +128,7 @@ func (p *Producer) Close() error {
 	return nil
 }
 
-func (p *Producer) push() (bool, error) {
+func (p *Producer) push() (*ProducerPush, error) {
 	start := time.Now()
 	atomic.StoreInt64(&p.lastPush, timestampFromTime(start).Millis())
 
@@ -130,7 +138,7 @@ func (p *Producer) push() (bool, error) {
 	if p.opt.LastModCheck != nil {
 		modTime, err := p.opt.LastModCheck(p.ctx)
 		if err != nil {
-			return false, err
+			return nil, err
 		}
 		wopt.LastMod = modTime
 	}
@@ -138,31 +146,34 @@ func (p *Producer) push() (bool, error) {
 	// retrieve original last modified time
 	lastMod, err := remoteLastModified(p.ctx, p.remote)
 	if err != nil {
-		return false, err
+		return nil, err
 	}
 
 	// skip push if not modified
 	if lastMod.Time().Equal(wopt.LastMod) {
-		return false, nil
+		return &ProducerPush{Producer: p}, nil
 	}
 
 	writer, err := NewWriter(p.ctx, p.remote, &wopt)
 	if err != nil {
-		return false, err
+		return nil, err
 	}
 	defer writer.Discard()
 
 	if err := p.pfn(writer); err != nil {
-		return false, err
+		return nil, err
 	}
 
 	if err := writer.Commit(); err != nil {
-		return false, err
+		return nil, err
 	}
 
 	atomic.StoreInt64(&p.numWritten, int64(writer.NumWritten()))
 	atomic.StoreInt64(&p.lastMod, timestampFromTime(wopt.LastMod).Millis())
-	return true, nil
+	return &ProducerPush{
+		Producer: p,
+		Updated:  true,
+	}, nil
 }
 
 func (p *Producer) loop() {
@@ -174,9 +185,9 @@ func (p *Producer) loop() {
 		case <-p.ctx.Done():
 			return
 		case <-ticker.C:
-			updated, err := p.push()
+			state, err := p.push()
 			if p.opt.AfterPush != nil {
-				p.opt.AfterPush(updated, p, err)
+				p.opt.AfterPush(state, err)
 			}
 		}
 	}

data/writer.go

@@ -1,6 +1,7 @@
 package feedx
 
 import (
+	"bufio"
 	"context"
 	"fmt"
 	"io"
@@ -55,6 +56,7 @@ type Writer struct {
 
 	bw io.WriteCloser // bfs writer
 	cw io.WriteCloser // compression writer
+	ww *bufio.Writer
 	fe FormatEncoder
 }
 
@@ -96,8 +98,12 @@ func (w *Writer) Encode(v interface{}) error {
 		w.cw = cw
 	}
 
+	if w.ww == nil {
+		w.ww = bufio.NewWriter(w.cw)
+	}
+
 	if w.fe == nil {
-		fe, err := w.opt.Format.NewEncoder(w.cw)
+		fe, err := w.opt.Format.NewEncoder(w.ww)
 		if err != nil {
 			return err
 		}
@@ -131,6 +137,11 @@ func (w *Writer) Commit() error {
 			err = e
 		}
 	}
+	if w.ww != nil {
+		if e := w.ww.Flush(); e != nil {
+			err = e
+		}
+	}
 	if w.cw != nil {
 		if e := w.cw.Close(); e != nil {
 			err = e

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: feedx
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.6.3
 platform: ruby
 authors:
 - Black Square Media Ltd
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-17 00:00:00.000000000 Z
+date: 2019-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bfs