minichart 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6109cfc57cb909c2ba0a9df4e184bc4319220399b774ff2098b728bf4a41f57e
-  data.tar.gz: 32cd8ff3c3260d08f81106c3ac74037e36990d4601eb8ff7e40c8840d44b3ca3
+  metadata.gz: 133646d3a37d8994e640a03eebd3a631f608e1decfd7c5666271dc07c4acbbc0
+  data.tar.gz: b4dd484bd550a26b8ef2f7be811a79a1cefe79dd0c6b13e5ebbe5d13a2bc1f63
 SHA512:
-  metadata.gz: 63e01d19bd4539ccf1283a98bee8f941a7e270ee0f1a2956aed20ecbab21661e7923420588c28f0aa90027cfc6fadc88f5f90b5776ff8dfa3523c9faf85c03ba
-  data.tar.gz: 1861ffff3d852e85fbf9b8c334d091f6dd40ce823086ae4215edb95c96f20a5f9e79e4da5caaf51b35956a8da92ca9de054ee35aae67c84884c02ad5f59af628
+  metadata.gz: 3f7e5d813fc8cccf069494ef14ac4b4c0db59147b3f1467e064b33d411833387da6589484a7bbba578846e632161a944063ce87f5f1225ee020629473b89ec2f
+  data.tar.gz: 37cc2233dae92905239c27ee4ae70c6d18b15b9fd0813f0ee9d6d99a894553cb501da3f3f321dbbcfa032d1e2c0e4442bba72fe87d42c7c0c5aebc06560366f6

data/README.md

@@ -16,6 +16,8 @@ Create SVG mini charts with Ruby
   * [Area Chart](#area-chart)
   * [Horizontal Bar Meter](#horizontal-bar-meter)
   * [Vertical Bar Meter](#vertical-bar-meter)
+  * [Horizontal Status Leds](#horizontal-status-leds)
+  * [Vertical Status Leds](#vertical-status-leds)
 * [Configuration](#configuration)
   * [Class-level default options](#class-level-default-options)
   * [Instance initialization options](#instance-initialization-options)
@@ -23,6 +25,7 @@ Create SVG mini charts with Ruby
 * [Options Reference](#options-reference)
   * [Basic Options](#basic-options)
   * [Meter Options](#meter-options)
+  * [Leds Options](#leds-options)
 * [Examples](#examples)
 
 
@@ -87,8 +90,8 @@ The objects returned from all the mini chart classes are [Victor::SVG][2] object
 <img src='examples/line_chart.svg' align='right' width=300>
 
 ```ruby
-LineChart.new data, height: 50, background: '#eee',
-  aspect_ratio: 5, color: 'green'
+LineChart.new [10, 30, 20, 40, 30], background: '#eee',
+  height: 50, width: 250, color: 'green'
 ```
 
 ### Bar Chart
@@ -96,8 +99,8 @@ LineChart.new data, height: 50, background: '#eee',
 <img src='examples/bar_chart.svg' align='right' width=300>
 
 ```ruby
-BarChart.new data, height: 50, background: '#eee',
-  aspect_ratio: 5, color: 'green'
+BarChart.new [10, 30, 20, 40, 30], background: '#eee',
+  height: 50, width: 250, color: 'green'
 ```
 
 ### Area Chart
@@ -105,8 +108,8 @@ BarChart.new data, height: 50, background: '#eee',
 <img src='examples/area_chart.svg' align='right' width=300>
 
 ```ruby
-AreaChart.new data, height: 50, background: '#eee',
-  aspect_ratio: 5, color: 'green'
+AreaChart.new [10, 30, 20, 40, 30], background: '#eee',
+  height: 50, width: 250, color: 'green'
 ```
 
 ### Horizontal Bar Meter
@@ -122,7 +125,7 @@ negative = HorizontalBarMeter.new -80,
 
 dual = HorizontalBarMeter.new 80,
   height: 20, width: 250, background: '#99f', color: 'blue',
-  mode: :dual, zero_line: true
+  mode: :dual, notches: [0]
 ```
 
 Meter charts support [additional options](#meter-options).
@@ -140,11 +143,33 @@ negative = VerticalBarMeter.new -80,
 
 dual = VerticalBarMeter.new 80,
   width: 20, height: 250, background: '#99f', color: 'blue',
-  mode: :dual, zero_line: true
+  mode: :dual, notches: [0]
 ```
 
 Meter charts support [additional options](#meter-options).
 
+### Horizontal Status Leds
+
+<img src='examples/horizontal_status_leds.svg' align='right' width=150>
+
+```ruby
+HorizontalStatusLeds.new [1,1,-1,0,1,1,1,1,1,-1,-1,1],
+  background: '#ccc'
+```
+
+Led charts support [additional options](#leds-options).
+
+### Vertical Status Leds
+
+<img src='examples/vertical_status_leds.svg' align='right' width=25>
+
+```ruby
+VerticalStatusLeds.new [1,1,1,1,-1,1,-1,1,0,1],
+  background: '#ccc'
+```
+
+Led charts support [additional options](#leds-options).
+
 
 ## Configuration
 
@@ -211,6 +236,10 @@ Line stroke width. This has a different effect in different chart types.
 
 CSS Style hash to apply to the entire SVG.
 
+#### padding
+
+Chart padding in pixels.
+
 
 ### Meter Options
 
@@ -253,6 +282,23 @@ Thickness of the clipping indicator.
 
 Color of the clipping indicator.
 
+### Leds Options
+
+Leds charts support these options in additon to the basic options (excluding
+the `color` option):
+
+#### positive_color
+
+Color to use when the value is greater than 0.
+
+#### negative_color
+
+Color to use when the value is less than 0.
+
+#### neutral_color
+
+Color to use when the value is 0 or nil.
+
 ## Examples
 
 See more examples (code and SVG output) in the [examples folder][1].

data/lib/minichart.rb

@@ -8,5 +8,8 @@ require 'minichart/charts/area_chart'
 require 'minichart/meters/meter'
 require 'minichart/meters/vertical_bar_meter'
 require 'minichart/meters/horizontal_bar_meter'
+require 'minichart/leds/leds'
+require 'minichart/leds/horizontal_status_leds'
+require 'minichart/leds/vertical_status_leds'
 
 require 'byebug' if ENV['BYEBUG']

data/lib/minichart/base.rb

@@ -11,7 +11,8 @@ module Minichart
           width: 300,
           stroke: 2,
           style: {},
-          color: '#66f'
+          color: '#66f',
+          padding: 10,
         }
       end
 
@@ -33,7 +34,7 @@ module Minichart
 
       super viewBox: viewbox, style: options[:style]
       element :rect, x: 0, y: 0,
-        width: options[:width], height: options[:height],
+        width: full_width, height: full_height,
         fill: options[:background], stroke_width: 0
 
       clip_path_id = IDGenerator.next
@@ -47,13 +48,21 @@ module Minichart
     def setup_clip_path(id)
       element :defs do
         element :clipPath, id: id do
-          element :rect, width: options[:width], height: options[:height]
+          element :rect, width: full_width, height: full_height
         end
       end
     end
 
     def viewbox
-      "0 0 #{options[:width]} #{options[:height]}"
+      "0 0 #{full_width} #{full_height}"
+    end
+
+    def full_height
+      options[:height] + options[:padding] * 2
+    end
+
+    def full_width
+      options[:width] + options[:padding] * 2
     end
 
     def build

data/lib/minichart/charts/area_chart.rb

@@ -5,21 +5,25 @@ module Minichart
         stroke: options[:color],
         stroke_width: options[:stroke],
         stroke_linejoin: :round,
+        stroke_linecap: :round,
         points: points
     end
 
   protected
 
     def points
-      result = ["0,#{options[:height]}"]
+      first_point = "#{options[:padding]},#{options[:height] + options[:padding]}"
+      result = [first_point]
 
       inverted_points.each do |point|
-        x = options[:width] *point[0]
-        y = options[:height] * point[1]
+        x = options[:width] * point[0] + options[:padding]
+        y = options[:height] * point[1] + options[:padding]
         result << "#{x},#{y}"
       end
 
-      result << "#{options[:width]},#{options[:height]}"
+      result << "#{options[:width] + options[:padding]},#{options[:height] + options[:padding]}"
+      result << first_point
+      
 
       result
     end

data/lib/minichart/charts/bar_chart.rb

@@ -15,10 +15,11 @@ module Minichart
     end
 
     def bar_options(x, y)
-      y = y * options[:height]
-      bar_height = options[:height] - y
+      y = y * options[:height] + options[:padding]
+
+      bar_height = options[:height] - y + options[:padding]
       { 
-        x: x * options[:width], 
+        x: x * options[:width] + options[:padding], 
         y: y, 
         width: bar_width,
         height: bar_height,

data/lib/minichart/charts/line_chart.rb

@@ -5,6 +5,7 @@ module Minichart
         stroke: options[:color],
         stroke_width: options[:stroke],
         stroke_linejoin: :round,
+        stroke_linecap: :round,
         points: points
     end
 
@@ -13,8 +14,8 @@ module Minichart
     def points
       result = []
       inverted_points.each do |point|
-        x = options[:width] * point[0]
-        y = options[:height] * point[1]
+        x = options[:width] * point[0] + options[:padding]
+        y = options[:height] * point[1] + options[:padding]
         result << "#{x},#{y}"
       end
       result

data/lib/minichart/leds/horizontal_status_leds.rb

@@ -0,0 +1,43 @@
+module Minichart
+  class HorizontalStatusLeds < Leds
+    class << self
+      def defaults
+        leds_defaults.merge width: 300, height: 50
+      end
+    end
+
+    def build
+      data.each_with_index do |value, i|
+        element :rect, bar_options(value, i)
+      end
+    end
+
+  protected
+
+    def bar_width
+      @bar_width ||= options[:width] / data.size
+    end
+
+    def bar_options(value, i)
+      color = if value == 0 or !value
+        :neutral_color
+      elsif value > 0
+        :positive_color
+      else
+        :negative_color
+      end
+
+      { 
+        x: (options[:padding] + i * bar_width),
+        y: options[:padding], 
+        width: bar_width,
+        height: options[:height],
+        style: {
+          fill: options[color],
+          stroke_width: options[:stroke],
+          stroke: options[:background]
+        }
+      }
+    end
+  end
+end

data/lib/minichart/leds/leds.rb

@@ -0,0 +1,17 @@
+module Minichart
+  # Base class for led charts
+  class Leds < Base
+
+    class << self
+      def leds_defaults
+        @meter_defaults ||= {
+          positive_color: '#6f6',
+          negative_color: '#f66',
+          neutral_color: '#eee',
+          padding: 2,
+        }
+      end
+    end
+
+  end
+end

data/lib/minichart/leds/vertical_status_leds.rb

@@ -0,0 +1,49 @@
+module Minichart
+  class VerticalStatusLeds < Leds
+    class << self
+      def defaults
+        leds_defaults.merge width: 50, height: 300
+      end
+    end
+
+    def build
+      data.each_with_index do |value, i|
+        element :rect, bar_options(value, i)
+      end
+    end
+
+  protected
+
+    def points
+      @points ||= data.size
+    end
+
+    def bar_height
+      @bar_height ||= options[:height] / points
+    end
+
+    def bar_options(value, i)
+      y = options[:padding] + (points - i - 1) * bar_height
+      
+      color = if value == 0 or !value
+        :neutral_color
+      elsif value > 0
+        :positive_color
+      else
+        :negative_color
+      end
+
+      { 
+        x: options[:padding],
+        y: y,
+        width: options[:width],
+        height: bar_height,
+        style: {
+          fill: options[color],
+          stroke_width: options[:stroke],
+          stroke: options[:background]
+        }
+      }
+    end
+  end
+end

data/lib/minichart/meters/horizontal_bar_meter.rb

@@ -19,7 +19,7 @@ module Minichart
       x2 = x_for clamped_value
       x = [x1, x2].min
 
-      element :rect, x: x, y: 0, height: options[:height],
+      element :rect, x: x, y: options[:padding], height: options[:height],
         width: bar_width, style: style
     end
 
@@ -44,7 +44,8 @@ module Minichart
     def draw_vertical_line(target_value, color:, stroke:)
       x = x_for target_value
 
-      element :line, x1: x, x2: x, y1: 0, y2: options[:height],
+      element :line, x1: x, x2: x,
+        y1: options[:padding], y2: options[:height] + options[:padding],
         stroke: color, stroke_width: stroke
     end
 
@@ -65,15 +66,15 @@ module Minichart
     end
 
     def x_for(target_value)
-      result = target_value.abs / options[:max].to_f * options[:width]
+      result = target_value.abs / options[:max].to_f * options[:width] + options[:padding]
 
       case mode
       when :positive
         result
       when :negative
-        options[:width] - result
+        full_width - result
       when :dual
-        target_value / options[:max].to_f * half_width + half_width
+        target_value / options[:max].to_f * half_width + half_width + options[:padding]
       end
     end
   end

data/lib/minichart/meters/meter.rb

@@ -5,19 +5,18 @@ module Minichart
     class << self
       def meter_defaults
         @meter_defaults ||= {
-          height: 50,
           max: 100,
           notches: [],
-          notch_thickness: 10,
+          notch_thickness: 4,
           notch_color: 'black',
           clipping_indicator: false,
-          clipping_indicator_thickness: 20,
+          clipping_indicator_thickness: 4,
           clipping_indicator_color: 'yellow',
+          padding: 2,
         }
       end
     end
 
-
   protected 
 
     def value

data/lib/minichart/meters/vertical_bar_meter.rb

@@ -19,7 +19,7 @@ module Minichart
       y2 = y_for clamped_value
       y = [y1, y2].min
 
-      element :rect, x: 0, y: y, height: bar_height,
+      element :rect, x: options[:padding], y: y, height: bar_height,
         width: options[:width], style: style
     end
 
@@ -44,7 +44,8 @@ module Minichart
     def draw_horizontal_line(target_value, color:, stroke:)
       y = y_for target_value
 
-      element :line, x1: 0, x2: options[:width], y1: y, y2: y,
+      element :line, x1: options[:padding], x2: options[:width] + options[:padding],
+        y1: y, y2: y,
         stroke: color, stroke_width: stroke
     end
 
@@ -65,15 +66,15 @@ module Minichart
     end
 
     def y_for(target_value)
-      result = target_value.abs / options[:max].to_f * options[:height]
+      result = target_value.abs / options[:max].to_f * options[:height] + options[:padding]
 
       case mode
       when :positive
-        options[:height] - result
+        full_height - result
       when :negative
         result
       when :dual
-        options[:height] - (target_value / options[:max].to_f * half_height + half_height)
+        options[:height] - (target_value / options[:max].to_f * half_height + half_height) + options[:padding]
       end
     end
   end

data/lib/minichart/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: minichart
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-30 00:00:00.000000000 Z
+date: 2020-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: victor
@@ -38,6 +38,9 @@ files:
 - lib/minichart/charts/chart.rb
 - lib/minichart/charts/line_chart.rb
 - lib/minichart/id_generator.rb
+- lib/minichart/leds/horizontal_status_leds.rb
+- lib/minichart/leds/leds.rb
+- lib/minichart/leds/vertical_status_leds.rb
 - lib/minichart/meters/horizontal_bar_meter.rb
 - lib/minichart/meters/meter.rb
 - lib/minichart/meters/vertical_bar_meter.rb