flat_kit 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa0b52b3ab12e9cf86492571258daf5d98dde967c25d5aad65b74a6003900fa2
-  data.tar.gz: fcd1abff76e54854d86b131aa6773d411f4d54acbf2e48b541c69c72dd2c1149
+  metadata.gz: 90aee146f0054a6afc302716d7bcbac4e013e0ec67bd09d390de326d9d090a27
+  data.tar.gz: b34138e0095b751ff2e29322c3899f7c4df54b5bd9649e2c2c9d550966225acb
 SHA512:
-  metadata.gz: 072e966f06fe03de16b686f469f0e3ac84aa2cc93910cc61210875e6d9cbf0bb3cc24bb1cf4f0863b90f2d02110abcdb0f88bbfa72777f2c19b2cce30c847e45
-  data.tar.gz: f5f67f8818e5cce8da7b547a3ec652d6dc288f9b66a957a62519878d819c893285ea3e81e7a32286de0d614412416f7ba38d8c28e7807f12add9ec00b3241e92
+  metadata.gz: 27f23b37c07b0702152904ffe4062269a091005dd112a570f374b902cedb9c489d5802e3d7cac366a275da435a5f1d38b25f3d20e34b8e12f3185330bdd65b0e
+  data.tar.gz: 9f11eda352f16db26ec54793836ff0e5153fb624659989d710789b7afb07a46be284ccbe235e649fb0bcb676327a040fc35f91a63c20c9772cccb3e50517e150

data/HISTORY.md

@@ -1,4 +1,9 @@
 # FlatKit Changelog
+## Version 0.2.0
+
+* add in event listening to allow for additional integrations
+* fix nil comparison on merge
+
 ## Version 0.1.0
 
 * Initial Release - Yeah!

data/Manifest.txt

@@ -13,6 +13,7 @@ lib/flat_kit/command/merge.rb
 lib/flat_kit/command/sort.rb
 lib/flat_kit/descendant_tracker.rb
 lib/flat_kit/error.rb
+lib/flat_kit/event_emitter.rb
 lib/flat_kit/format.rb
 lib/flat_kit/input.rb
 lib/flat_kit/input/file.rb
@@ -55,6 +56,7 @@ test/jsonl/test_writer.rb
 test/output/test_file.rb
 test/output/test_io.rb
 test/test_conversions.rb
+test/test_event_emitter.rb
 test/test_format.rb
 test/test_helper.rb
 test/test_merge.rb

data/lib/flat_kit.rb

@@ -1,8 +1,9 @@
 module FlatKit
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end
 require 'flat_kit/error'
 require 'flat_kit/logger'
+require 'flat_kit/event_emitter'
 require 'flat_kit/descendant_tracker'
 require 'flat_kit/format'
 require 'flat_kit/record'

data/lib/flat_kit/event_emitter.rb

@@ -0,0 +1,33 @@
+module FlatKit
+  # A simplified Observable class for use internally
+  #
+  module EventEmitter
+    def add_listener(listener)
+      raise ::NoMethodError, "#{listener} does not resond to #on_event" unless listener.respond_to?(:on_event)
+      self._listeners ||= []
+      self._listeners << listener unless _listeners.include?(listener)
+    end
+
+    def count_listeners
+      _listeners.size
+    end
+
+    def remove_listener(listener)
+      _listeners.delete(listener)
+    end
+
+    def remove_listeners
+      _listeners.clear
+    end
+
+    def notify_listeners(name:, data:)
+      _listeners.each do |l|
+        l.on_event(name: name, data: data)
+      end
+    end
+
+    def _listeners
+      @_listeners ||= Array.new
+    end
+  end
+end

data/lib/flat_kit/merge.rb

@@ -1,5 +1,8 @@
 module FlatKit
   class Merge
+
+    include ::FlatKit::EventEmitter
+
     attr_reader :readers
     attr_reader :writer
     attr_reader :compare_fields
@@ -15,21 +18,27 @@ module FlatKit
     end
 
     def call
-      ::FlatKit.logger.info "Merging the following files into #{writer.destination}"
-      ::FlatKit.logger.info "Using this key for sorting: #{compare_fields.join(", ")}"
+      ::FlatKit.logger.debug "Merging the following files into #{writer.destination}"
+      ::FlatKit.logger.debug "Using this key for sorting: #{compare_fields.join(", ")}"
       readers.each do |r|
-        ::FlatKit.logger.info "  #{r.source}"
+        ::FlatKit.logger.debug "  #{r.source}"
       end
 
       merge_tree = ::FlatKit::MergeTree.new(readers)
+
+      notify_listeners(name: :start, data: :start)
       merge_tree.each do |record|
         writer.write(record)
+        notify_listeners(name: :record, data: record)
       end
+      notify_listeners(name: :stop, data: :stop)
+
       readers.each do |r|
-        ::FlatKit.logger.info "  #{r.source} produced #{r.count} records"
+        ::FlatKit.logger.debug "  #{r.source} produced #{r.count} records"
       end
+
       writer.close
-      ::FlatKit.logger.info "Wrote #{writer.count} records to #{writer.destination}"
+      ::FlatKit.logger.debug "Wrote #{writer.count} records to #{writer.destination}"
     end
   end
 end

data/lib/flat_kit/record.rb

@@ -57,11 +57,15 @@ module FlatKit
         my_val         = self[field]
         other_val      = other[field]
 
-        return  0 if my_val.nil? && other_val.nil?
-        return -1 if my_val.nil?
-        return  1 if other_val.nil?
-
-        compare_result = my_val.<=>(other_val)
+        if my_val.nil? && other_val.nil? then
+          compare_result = 0
+        elsif my_val.nil?
+          compare_result = -1
+        elsif other_val.nil?
+          compare_result = 1
+        else
+          compare_result = my_val.<=>(other_val)
+        end
 
         return compare_result unless compare_result.zero?
       end

data/test/test_event_emitter.rb

@@ -0,0 +1,72 @@
+require 'test_helper'
+
+class TestEventEmitter < ::Minitest::Test
+  class Pub
+    include ::FlatKit::EventEmitter
+  end
+
+  class Sub
+    attr_reader :name
+    attr_reader :data
+
+    def initialize
+      @name = nil
+      @data = nil
+    end
+
+    def on_event(name:, data:)
+      @name = name
+      @data = data
+    end
+  end
+
+  class BadSub; end
+
+  def setup
+    @emitter = Pub.new
+    @receiver = Sub.new
+  end
+
+  def test_counts_no_listeners_before_adding_one
+    assert_equal(0, @emitter.count_listeners)
+  end
+
+  def test_adds_listener
+    @emitter.add_listener(@receiver)
+    assert_equal(1, @emitter.count_listeners)
+  end
+
+  def test_removes_listener
+    @emitter.add_listener(@receiver)
+    assert_equal(1, @emitter.count_listeners)
+
+    @emitter.remove_listener(@receiver)
+    assert_equal(0, @emitter.count_listeners)
+  end
+
+  def test_only_adds_an_listener_once
+    @emitter.add_listener(@receiver)
+    assert_equal(1, @emitter.count_listeners)
+
+    @emitter.add_listener(@receiver)
+    assert_equal(1, @emitter.count_listeners)
+  end
+
+  def test_verifies_reciever_responds_t_observed
+    assert_raises(::NoMethodError) { @emitter.add_listener(BadSub.new) }
+  end
+
+  def test_listeners_get_notified
+    @receiver_2 = Sub.new
+    @emitter.add_listener(@receiver)
+    @emitter.add_listener(@receiver_2)
+
+    @emitter.notify_listeners(name: :notification, data: "DATA!")
+
+    assert_equal(:notification, @receiver.name)
+    assert_equal(:notification, @receiver_2.name)
+
+    assert_equal("DATA!", @receiver.data)
+    assert_equal("DATA!", @receiver_2.data)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flat_kit
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Jeremy Hinegardner
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-27 00:00:00.000000000 Z
+date: 2021-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj
@@ -136,6 +136,7 @@ files:
 - lib/flat_kit/command/sort.rb
 - lib/flat_kit/descendant_tracker.rb
 - lib/flat_kit/error.rb
+- lib/flat_kit/event_emitter.rb
 - lib/flat_kit/format.rb
 - lib/flat_kit/input.rb
 - lib/flat_kit/input/file.rb
@@ -178,6 +179,7 @@ files:
 - test/output/test_file.rb
 - test/output/test_io.rb
 - test/test_conversions.rb
+- test/test_event_emitter.rb
 - test/test_format.rb
 - test/test_helper.rb
 - test/test_merge.rb
@@ -226,6 +228,7 @@ test_files:
 - test/output/test_file.rb
 - test/output/test_io.rb
 - test/test_conversions.rb
+- test/test_event_emitter.rb
 - test/test_format.rb
 - test/test_helper.rb
 - test/test_merge.rb