termplot 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dda87efbf9aed716a37a8ca65eab2d8f773f9e4a18ea9db6ab7aff4dc820c2ff
-  data.tar.gz: 82a897c92653354d77de8515cd370507aaba295f9a35425134af1a0752fb6d2a
+  metadata.gz: '068a1b08253b8e5993572546e7b73409b0ff5750a1aaa671d3d6c907b621128f'
+  data.tar.gz: a6ce340dac417d5999e7fd6018efd931731ecabcc2d894ff8430a5bd6c9d6bb3
 SHA512:
-  metadata.gz: 16969163d4b669fd5cf930310af369aaa6e4a83d25e16bd51ba528d1ebb71c303d1beead130f4a9ef6d39992f7c92017fc149b2dbf0fcd46be6c0df15ed9b760
-  data.tar.gz: d509eeb9d34180fe4b338de314bcab5060e9f25a9d63d1ad4ff04e137c4d3b282209df7ff660a74a30e82c663d2eedd96fcc3d1204d8f3e16bf88d0ea47f1e76
+  metadata.gz: fe102cf42e2e1017ca2f3327c65847dbece92aeeea5de3c05b72e384bf3cfc6eb0dd602c7fa03585282ea747e88c167e8259e724ecbd30b64618c4dbce9ddc53
+  data.tar.gz: 13967f3be92508cc0fcc8dcc65eb9f0625ac359e30853ceaeed30e778863a7298eef38b55efe64d615ca61e9e37bcd781247c98b5e64967a46af9208deacf80c

data/.gitignore

@@ -9,3 +9,5 @@
 squiggles.txt
 Gemfile.lock
 README.md.html
+
+.ruby-version

data/README.md

@@ -1,5 +1,7 @@
 # Termplot
 
+[![Gem Version](https://badge.fury.io/rb/termplot.svg)](https://badge.fury.io/rb/termplot)
+
 Termplot is a simple terminal plotting tool for visualising streaming data.
 
 ![Termplot Demo Image](doc/demo.png)
@@ -76,7 +78,7 @@ ping example.com |
 ```
 ![Ping Response Times Plot](doc/ping.png)
 
-##### Plot histogram of data from column 33 of a CSV file
+##### Plot histogram of data from column 33 of a CSV file:
 ```
 cat file.csv | cut -d, -f33 | tail -n +2 |
   termplot -- --hist -r30 -t "Data" --color light_black
@@ -117,7 +119,7 @@ You can configure termplot to set up a multi-chart dashboard using a ruby
 configuration file:
 
 ```
-termplot --file FILE
+termplot [--file/-f] FILE
 ```
 
 The configuration file uses a simple ruby DSL to arrange charts into rows and
@@ -125,7 +127,9 @@ columns. Each chart will take a command and optionally an interval as well as
 formatting options. Termplot will then run the command at the specified interval
 and render the resulting data into the charts.
 
-Example file (sample.rb):
+#### Example
+
+File (sample.rb):
 ```ruby
 col do
   row do

data/lib/termplot/consumers/base_consumer.rb

@@ -31,7 +31,7 @@ module Termplot
         Shell.init(clear: options.full_screen)
         renderer_thread.start
 
-        # Blocks main thread
+        # Blocks main thread to produce values from the producer pool
         producer_pool.start_and_block
 
         # At this point producer threads have all exited, tell renderer to

data/lib/termplot/consumers/single_source_consumer.rb

@@ -25,7 +25,7 @@ module Termplot
           "hist"       => "Termplot::Widgets::HistogramWidget",
         }
         klass = Object.const_get(wigdet_classes[options.type])
-        @widget = klass.new(options.to_h)
+        @widget = klass.new(**options.to_h)
       end
 
       def build_producer

data/lib/termplot/message_broker.rb

@@ -29,8 +29,7 @@ module Termplot
 
     def closed?
       mutex.synchronize do
-        brokers.count > 0 &&
-          brokers.all?(:closed?)
+        (brokers.count == 0) || brokers.all?(&:closed?)
       end
     end
 
@@ -73,7 +72,7 @@ module Termplot
       register_callbacks
     end
 
-    def on_message(block = Proc.new)
+    def on_message(&block)
       on_message_callbacks.push(block)
     end
 
@@ -92,6 +91,10 @@ module Termplot
       queue.close
     end
 
+    def closed?
+      queue.closed?
+    end
+
     private
     attr_reader :sender, :receiver, :queue, :on_message_callbacks
 

data/lib/termplot/version.rb

@@ -1,3 +1,3 @@
 module Termplot
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: termplot
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Martin Nyaga
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-11 00:00:00.000000000 Z
+date: 2021-10-18 00:00:00.000000000 Z
 dependencies: []
 description: Plot time series charts in your terminal
 email:
@@ -68,7 +68,6 @@ files:
 - lib/termplot/shell.rb
 - lib/termplot/utils/ansi_safe_string.rb
 - lib/termplot/version.rb
-- lib/termplot/widget_dsl.rb
 - lib/termplot/widgets.rb
 - lib/termplot/widgets/base_widget.rb
 - lib/termplot/widgets/border.rb
@@ -86,7 +85,7 @@ metadata:
   homepage_uri: https://github.com/Martin-Nyaga/termplot
   source_code_uri: https://github.com/Martin-Nyaga/termplot
   changelog_uri: https://github.com/Martin-Nyaga/termplot
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -101,8 +100,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Plot time series charts in your terminal
 test_files: []

data/lib/termplot/widget_dsl.rb

@@ -1,130 +0,0 @@
-require "termplot/positioned_widget"
-require "termplot/widgets"
-
-module Termplot
-  module DSL
-    module Widgets
-      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
-end