termplot 0.2.1 → 0.3.0

data/lib/termplot/consumers.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Termplot
+  module Consumers
+    autoload :BaseConsumer, "termplot/consumers/base_consumer"
+    autoload :MultiSourceConsumer, "termplot/consumers/multi_source_consumer"
+    autoload :SingleSourceConsumer, "termplot/consumers/single_source_consumer"
+
+    autoload :StdinConsumer, "termplot/consumers/stdin_consumer"
+    autoload :CommandConsumer, "termplot/consumers/command_consumer"
+  end
+end

data/lib/termplot/consumers/base_consumer.rb

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+
+require "termplot/renderer"
+require "termplot/message_broker"
+require "termplot/shell"
+
+module Termplot
+  module Consumers
+    class BaseConsumer
+      def initialize(options)
+        @options = options
+        @broker_pool = MessageBrokerPool.new
+        @producer_pool = ProducerPool.new
+        @renderer = Renderer.new(
+          cols: options.cols,
+          rows: options.rows,
+          widgets: positioned_widgets,
+          debug: options.debug
+        )
+
+        @renderer_thread = RendererThread.new(
+          renderer: renderer,
+          broker_pool: broker_pool
+        )
+      end
+
+      def run
+        register_producers_and_brokers
+        broker_pool.on_message { renderer_thread.continue }
+
+        Shell.init(clear: options.full_screen)
+        renderer_thread.start
+
+        # Blocks main thread
+        producer_pool.start_and_block
+
+        # At this point producer threads have all exited, tell renderer to
+        # consume all messages left on the queue
+        renderer_thread.continue while !broker_pool.empty?
+
+        # Close queues
+        broker_pool.shutdown
+
+        # Shutdown renderer
+        renderer_thread.join
+      end
+
+      private
+      attr_reader :options,
+                  :broker_pool,
+                  :producer_pool,
+                  :renderer,
+                  :renderer_thread
+
+      class RendererThread
+        def initialize(renderer:, broker_pool:, &block)
+          @renderer = renderer
+          @broker_pool = broker_pool
+          @block = block
+          @thread = nil
+        end
+
+        def start
+          @thread = Thread.new do
+            # Pause and wait to be woken for rendering
+            pause
+            while !broker_pool.closed?
+              num_samples = broker_pool.pending_message_count
+
+              if num_samples.zero?
+                pause
+              else
+                broker_pool.flush_messages
+
+                if num_samples > 0
+                  renderer.render
+                end
+              end
+            end
+          end
+        end
+
+        def continue
+          thread.run
+        end
+
+        def pause
+          Thread.stop
+        end
+
+        def join
+          thread.join unless thread.stop?
+        end
+
+        private
+        attr_reader :renderer, :broker_pool, :block, :thread
+      end
+
+      class ProducerPool
+        def initialize
+          @producers = []
+          @threads = []
+        end
+
+        def start
+          # Run Producers with producers
+          @threads = producers.map do |producer|
+            Thread.new do
+              producer.run
+            end
+          end
+        end
+
+        def wait
+          threads.each(&:join)
+        end
+
+        def start_and_block
+          start
+          wait
+        end
+
+        def add_producer(producer)
+          producers.push(producer)
+        end
+
+        private
+        attr_reader :producers, :threads
+      end
+    end
+  end
+end

data/lib/termplot/consumers/command_consumer.rb

@@ -0,0 +1,14 @@
+
+require "termplot/positioned_widget"
+require "termplot/widgets"
+require "termplot/producers"
+
+module Termplot
+  module Consumers
+    class CommandConsumer < SingleSourceConsumer
+      def producer_class
+        Termplot::Producers::CommandProducer
+      end
+    end
+  end
+end

data/lib/termplot/consumers/multi_source_consumer.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "termplot/file_config"
+require "termplot/producers"
+
+module Termplot
+  module Consumers
+    class MultiSourceConsumer < BaseConsumer
+      def positioned_widgets
+        @positioned_widgets ||= config.positioned_widgets
+      end
+
+      def register_producers_and_brokers
+        config.widget_configs.each do |widget_config|
+          producer = build_producer(widget_config)
+          broker_pool.broker(sender: producer, receiver: widget_config.widget)
+          producer_pool.add_producer(producer)
+        end
+      end
+
+      private
+      def config
+        @config ||= FileConfig.new(options).parse_config
+      end
+
+      def build_producer(widget_config)
+        Termplot::Producers::CommandProducer.new(
+          widget_config.producer_options
+        )
+      end
+    end
+  end
+end

data/lib/termplot/consumers/single_source_consumer.rb

@@ -0,0 +1,36 @@
+
+require "termplot/positioned_widget"
+require "termplot/widgets"
+require "termplot/producers"
+
+module Termplot
+  module Consumers
+    class SingleSourceConsumer < BaseConsumer
+      def positioned_widgets
+        @positioned_widgets ||= [PositionedWidget.new(row: 0, col: 0, widget: widget)]
+      end
+
+      def register_producers_and_brokers
+        producer = build_producer
+        broker_pool.broker(sender: producer, receiver: widget)
+        producer_pool.add_producer(producer)
+      end
+
+      private
+      def widget
+        return @widget if defined? @widget
+        wigdet_classes = {
+          "timeseries" => "Termplot::Widgets::TimeSeriesWidget",
+          "stats"      => "Termplot::Widgets::StatisticsWidget",
+          "hist"       => "Termplot::Widgets::HistogramWidget",
+        }
+        klass = Object.const_get(wigdet_classes[options.type])
+        @widget = klass.new(options.to_h)
+      end
+
+      def build_producer
+        producer_class.new(options.producer_options)
+      end
+    end
+  end
+end

data/lib/termplot/consumers/stdin_consumer.rb

@@ -0,0 +1,11 @@
+require "termplot/producers"
+
+module Termplot
+  module Consumers
+    class StdinConsumer < SingleSourceConsumer
+      def producer_class
+        Termplot::Producers::StdinProducer
+      end
+    end
+  end
+end

data/lib/termplot/cursors/buffered_console_cursor.rb

@@ -50,7 +50,7 @@ module Termplot
       end
 
       def flush
-        print buffer.join
+        buffer.join
       end
 
       def position=()

data/lib/termplot/cursors/virtual_cursor.rb

@@ -64,6 +64,10 @@ module Termplot
         @position = position - (position % window.cols)
       end
 
+      def beginning_of_line?
+        @position % window.cols == 0
+      end
+
       def position=(n)
         @position = n
       end

data/lib/termplot/dsl/panels.rb

@@ -0,0 +1,80 @@
+require "termplot/commands"
+require "termplot/dsl/widgets"
+
+module Termplot
+  module DSL
+    class Panel
+      include Termplot::Commands
+      include Termplot::WidgetDSL
+
+      attr_accessor(
+        :rows,
+        :cols,
+        :start_row,
+        :start_col
+      )
+
+      def initialize(options, children = [])
+        @options = options
+        @children = children
+      end
+
+      def set_dimensions(rows, cols, start_row, start_col)
+        raise "Must be implemented"
+      end
+
+      def flatten
+        children.map(&:flatten).flatten
+      end
+
+      private
+      attr_reader :options, :children
+
+      def row(&block)
+        new_row = Row.new(options)
+        new_row.instance_eval(&block)
+        children.push(new_row)
+      end
+
+      def col(&block)
+        new_col = Col.new(options)
+        new_col.instance_eval(&block)
+        children.push(new_col)
+      end
+    end
+
+    class Row < Panel
+      def set_dimensions(rows, cols, start_row, start_col)
+        @rows = rows
+        @cols = cols
+        child_cols = cols / children.count
+
+        children.each_with_index do |child, index|
+          child.set_dimensions(
+            rows,
+            child_cols,
+            start_row,
+            child_cols * index
+          )
+        end
+      end
+    end
+
+    class Col < Panel
+      def set_dimensions(rows, cols, start_row, start_col)
+        @rows = rows
+        @cols = cols
+        child_rows = rows / children.count
+
+        children.each_with_index do |child, index|
+          child.set_dimensions(
+            child_rows,
+            cols,
+            child_rows * index,
+            start_col
+          )
+        end
+      end
+    end
+  end
+end

data/lib/termplot/dsl/widgets.rb

@@ -0,0 +1,128 @@
+require "termplot/positioned_widget"
+require "termplot/widgets"
+
+module Termplot
+  module WidgetDSL
+    def timeseries(attrs)
+      attrs = merge_defaults(attrs)
+      children.push(TimeSeriesConfig.new(attrs))
+    end
+
+    def statistics(attrs)
+      attrs = merge_defaults(attrs)
+      children.push(StatisticsConfig.new(attrs))
+    end
+
+    def histogram(attrs)
+      attrs = merge_defaults(attrs)
+      children.push(HistogramConfig.new(attrs))
+    end
+
+    private
+
+    def merge_defaults(attrs)
+      Termplot::Options.default_options.merge(attrs)
+    end
+
+    class WidgetConfig
+      attr_reader(
+        :title,
+        :command,
+        :interval,
+        :col,
+        :row,
+        :cols,
+        :rows,
+        :debug
+      )
+
+      def initialize(opts)
+        @title = opts[:title]
+
+        @command = opts[:command]
+        @interval = opts[:interval]
+        @debug = opts[:debug]
+
+        post_initialize(opts)
+      end
+
+      def post_initialize(opts)
+        # Implemented in subclasses
+      end
+
+      def set_dimensions(rows, cols, start_row, start_col)
+        @rows = rows
+        @cols = cols
+        @row = start_row
+        @col = start_col
+      end
+
+      def flatten
+        self
+      end
+
+      def positioned_widget
+        @positioned_widget ||= PositionedWidget.new(
+          row: row,
+          col: col,
+          widget: widget
+        )
+      end
+
+      def widget
+        raise "Must be implemented"
+      end
+
+      def producer_options
+        ProducerOptions.new(command: command, interval: interval)
+      end
+    end
+
+    class TimeSeriesConfig < WidgetConfig
+      attr_reader :color, :line_style
+      def post_initialize(opts)
+        @color = opts[:color]
+        @line_style = opts[:line_style]
+      end
+
+      def widget
+        @widget ||= Termplot::Widgets::TimeSeriesWidget.new(
+          title: title,
+          line_style: line_style,
+          color: color,
+          cols: cols,
+          rows: rows,
+          debug: debug
+        )
+      end
+    end
+
+    class StatisticsConfig < WidgetConfig
+      def widget
+        @widget ||= Termplot::Widgets::StatisticsWidget.new(
+          title: title,
+          cols: cols,
+          rows: rows,
+          debug: debug
+        )
+      end
+    end
+
+    class HistogramConfig < WidgetConfig
+      attr_reader :color
+      def post_initialize(opts)
+        @color = opts[:color]
+      end
+
+      def widget
+        @widget ||= Termplot::Widgets::HistogramWidget.new(
+          title: title,
+          color: color,
+          cols: cols,
+          rows: rows,
+          debug: debug
+        )
+      end
+    end
+  end
+end