minichart 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 144b47573abadc9f4bfe5e41dea006bb24705db37dc93767353ba62d389bdd1d
-  data.tar.gz: 7c4936f6947307fd106b1e0700fff88c9ad7f5721dfc50dfd23ca3051a79b7b5
+  metadata.gz: 7debe086fa2ba7994f1362fa53ab2d5da5cc61a0010f6f08d6ca125cc447bc27
+  data.tar.gz: 77dd9cf342830795872c284befe937cba7caa9c2372bdae2b8a42a44e6d4bb13
 SHA512:
-  metadata.gz: c66ae222164ccc21a98cd8eddd790f54d114897ed6374b7e36fd242d16364e49ccec532e580d3a180d094c48fd27853f7b01bd85c81e7b8a4af8254a595af191
-  data.tar.gz: 6d19ce05f98de008d26127b8046512b66e1c68af0972e3b66f15ce3a6bfe4ac8a99a6de76457757e34903e3012b757ba31eeba688a018393304ca8cff41a1e74
+  metadata.gz: 5a331fa46640d9bfb32759a5aa160680cd684bd7f57f194e212f7b0d0f5c2af61f03f8b526702de0421dbe608fbc70c39df8c219967b8c2de9fe647f04822e42
+  data.tar.gz: 2fede85eef059f2ac6980ff9ba6249b1e7b716edb38eacfe514cebace11488e0cb1ca4520ff4d7a3bf58934e746e846130026c9c98f7bc41419c4216a68c8734

data/README.md

@@ -64,7 +64,7 @@ The objects returned from all the mini chart classes are [Victor::SVG][2] object
 
 ### Line Chart
 
-<img src='examples/line_chart.svg' align='right'>
+<img src='examples/line_chart.svg' align='right' width=300>
 
 ```ruby
 LineChart.new data, height: 50, background: '#eee',
@@ -73,7 +73,7 @@ LineChart.new data, height: 50, background: '#eee',
 
 ### Bar Chart
 
-<img src='examples/bar_chart.svg' align='right'>
+<img src='examples/bar_chart.svg' align='right' width=300>
 
 ```ruby
 BarChart.new data, height: 50, background: '#eee',
@@ -82,7 +82,7 @@ BarChart.new data, height: 50, background: '#eee',
 
 ### Area Chart
 
-<img src='examples/area_chart.svg' align='right'>
+<img src='examples/area_chart.svg' align='right' width=300>
 
 ```ruby
 AreaChart.new data, height: 50, background: '#eee',
@@ -107,6 +107,25 @@ dual = HorizontalBarMeter.new 80,
 
 Meter charts support [additional options](#meter-options).
 
+### Vertical Bar Meter
+
+<img src='examples/multiple_vertical_bars.svg' align='right'>
+
+```ruby
+positive = VerticalBarMeter.new 70,
+  width: 20, height: 250, background: '#9f9', color: 'green'
+
+negative = VerticalBarMeter.new -80,
+  width: 20, height: 250, background: '#f99', color: 'red'
+
+dual = VerticalBarMeter.new 80,
+  width: 20, height: 250, background: '#99f', color: 'blue',
+  mode: :dual, zero_line: true
+```
+
+Meter charts support [additional options](#meter-options).
+
+
 ## Options
 
 ### Basic Options
@@ -117,28 +136,32 @@ All chart classes support a second hash argument for options
 chart = LineChart.new data, options
 ```
 
-| Option         | Default                      | Description                                                  |
-| -------------- | ---------------------------- | ------------------------------------------------------------ |
-| `background`   | `"white"`                    | Chart background color                                       |
-| `color`        | `"#333"`                     | Chart color                                                  |
-| `aspect_ratio` | `3`                          | Set automatic width                                          |
-| `height`       | `100`                        | Chart height in pixels                                       |
-| `width`        | Calculated by `aspect_ratio` | Chart width in pixels                                        |
-| `stroke`       | `2`                          | Line stroke width.<br />In `BarChart` determines the gap between bars |
-| `style`        | *None*                       | Style hash for the SVG                                       |
+| Option         | Default                       | Description                                                  |
+| -------------- | ----------------------------- | ------------------------------------------------------------ |
+| `background`   | `"white"`                     | Chart background color                                       |
+| `color`        | `"#333"`                      | Chart color                                                  |
+| `aspect_ratio` | `3`                           | Set automatic width                                          |
+| `height`       | `100`<sup>*</sup>             | Chart height in pixels                                       |
+| `width`        | Calculated by `aspect_ratio`<sup>*</sup> | Chart width in pixels                                        |
+| `stroke`       | `2`                           | Line stroke width.<br />In `BarChart` determines the gap between bars |
+| `style`        | *None*                        | Style hash for the SVG                                       |
 
+_* Default dimensions are reversed for horizontal meters - `width` defaults to 100, and `height` is calculated automatically._
 
 ### Meter Options
 
 Meter charts support these options in additon to the basic options:
 
-| Option             | Default   | Description                                                  |
-| ------------------ | --------- | ------------------------------------------------------------ |
-| `mode`             | `:auto`   | Display mode.<br />Can be `:positive`, `:negative`, `:auto` or `:dual` |
-| `max`              | `100`     | The absolute maximum value.<br />This number should be positive even for nengative charts |
-| `zero_line`        | `false`   | If true, mark the zero line                                  |
-| `zero_line_stroke` | `4`       | Width of the zero line                                       |
-| `zero_line_color`  | `"black"` | Color of the zero line                                       |
+| Option                     | Default   | Description                                                  |
+| -------------------------- | --------- | ------------------------------------------------------------ |
+| `mode`                     | `:auto`   | Display mode.<br />Can be `:positive`, `:negative`, `:auto` or `:dual` |
+| `max`                      | `100`     | The absolute maximum value.<br />This number should be positive even for negative charts |
+| `zero_line`                | `false`   | If true, mark the zero line                                  |
+| `zero_line_size`           | `6`       | Size of the zero line                                        |
+| `zero_line_color`          | `"black"` | Color of the zero line                                       |
+| `clipping_indicator`       | `false`   | If true, show when the value exceeds the range               |
+| `clipping_indicator_size`  | `6`       | Size of the clipping indicator                               |
+| `clipping_indicator_color` | `"yelow"` | Color of the clipping indicator                              |
 
 ## Examples
 

data/lib/minichart.rb

@@ -6,6 +6,7 @@ require 'minichart/charts/line_chart'
 require 'minichart/charts/bar_chart'
 require 'minichart/charts/area_chart'
 require 'minichart/meters/meter'
+require 'minichart/meters/vertical_bar_meter'
 require 'minichart/meters/horizontal_bar_meter'
 
 require 'byebug' if ENV['BYEBUG']

data/lib/minichart/base.rb

@@ -7,8 +7,10 @@ module Minichart
     def initialize(data, opts = {})
       @data, @opts = data, opts
       
-      super height: height, width: width, style: style, viewBox: viewbox
-      element :rect, x: 0, y: 0, width: width, height: height, fill: background
+      # super height: height, width: width, style: style, viewBox: viewbox
+      super viewBox: viewbox, style: style
+      element :rect, x: 0, y: 0, width: width, height: height,
+        fill: background, stroke_width: 0
 
       clip_path_id = IDGenerator.next
       setup_clip_path clip_path_id

data/lib/minichart/meters/horizontal_bar_meter.rb

@@ -3,6 +3,7 @@ module Minichart
     def build
       draw_bar
       draw_zero_line if zero_line
+      draw_clipping_indicator if clipping_indicator and clipping?
     end
 
   protected
@@ -20,62 +21,38 @@ module Minichart
       element :rect, x: x, y: 0, height: height, width: bar_width, style: style
     end
 
-    def draw_zero_line
-      x = if mode == :negative
-        width-zero_line_stroke
-      elsif mode == :dual
-        width / 2 - zero_line_stroke / 2
+    def draw_clipping_indicator
+      x = if mode == :positive or (mode == :dual and value > 0)
+        width - clipping_indicator_size
       else
         0
       end
 
       element :rect, x: x, y: 0,
-        height: height, width: zero_line_stroke,
-        fill: zero_line_color
+        height: height, width: clipping_indicator_size,
+        fill: clipping_indicator_color, stroke_width: 0
 
     end
 
-    def mode
-      opts[:mode] ||= :auto
-
-      if opts[:mode] == :auto
-        value >= 0 ? :positive : :negative
+    def draw_zero_line
+      x = if mode == :negative
+        width - zero_line_size
+      elsif mode == :dual
+        width / 2 - zero_line_size / 2
       else
-        opts[:mode]
+        0
       end
-    end
-
-    def max
-      opts[:max] ||= 100
-    end
-
-    def zero_line
-      opts[:zero_line]
-    end
 
-    def zero_line_stroke
-      opts[:zero_line_stroke] || 6
-    end
+      element :rect, x: x, y: 0,
+        height: height, width: zero_line_size,
+        fill: zero_line_color, stroke_width: 0
 
-    def zero_line_color
-      opts[:zero_line_color] || 'black'
     end
 
     def width_factor
       width / max.to_f
     end
 
-    def clamped_value
-      case mode
-      when :positive
-        value.clamp 0, max
-      when :negative
-        value.clamp -max, 0
-      when :dual
-        value.clamp -max, max
-      end
-    end
-
     def bar_width
       if mode == :dual
         clamped_value.abs * width_factor * 0.5
@@ -83,9 +60,5 @@ module Minichart
         clamped_value.abs * width_factor
       end
     end
-
-    def style
-      { fill: color, stroke_width: stroke, stroke: background }
-    end
   end
 end

data/lib/minichart/meters/meter.rb

@@ -1,8 +1,73 @@
 module Minichart
   # Base class for charts with a single value
   class Meter < Base
+
+  protected 
+
     def value
       data
     end
+
+    def clipping?
+      value > max || value < -max
+    end
+
+    def mode
+      @mode ||= mode!
+    end
+
+    def mode!
+      opts[:mode] ||= :auto
+
+      if opts[:mode] == :auto
+        value >= 0 ? :positive : :negative
+      else
+        opts[:mode].to_sym
+      end
+    end
+
+    def max
+      opts[:max] ||= 100
+    end
+
+    def zero_line
+      opts[:zero_line]
+    end
+
+    def zero_line_size
+      opts[:zero_line_size] ||= 6
+    end
+
+    def zero_line_color
+      opts[:zero_line_color] ||= 'black'
+    end
+
+    def clipping_indicator
+      opts[:clipping_indicator]
+    end
+
+    def clipping_indicator_size
+      opts[:clipping_indicator_size] ||= 6
+    end
+
+    def clipping_indicator_color
+      opts[:clipping_indicator_color] ||= 'yellow'
+    end
+
+    def clamped_value
+      case mode
+      when :positive
+        value.clamp 0, max
+      when :negative
+        value.clamp -max, 0
+      when :dual
+        value.clamp -max, max
+      end
+    end
+
+    def style
+      { fill: color, stroke_width: stroke, stroke: background }
+    end
+
   end
 end

data/lib/minichart/meters/vertical_bar_meter.rb

@@ -0,0 +1,72 @@
+module Minichart
+  class VerticalBarMeter < Meter
+    def build
+      draw_bar
+      draw_zero_line if zero_line
+      draw_clipping_indicator if clipping_indicator and clipping?
+    end
+
+  protected
+
+    def width
+      opts[:width] ||= 100
+    end
+
+    def height
+      opts[:height] ||= (aspect_ratio * width).round
+    end
+
+    def draw_bar
+      y = if mode == :positive
+        height - bar_height
+      elsif mode == :dual
+        middle = height * 0.5
+        value >= 0 ? middle - bar_height : middle
+      else
+        0
+      end
+
+      element :rect, x: 0, y: y, height: bar_height, width: width, style: style
+    end
+
+    def draw_clipping_indicator
+      y = if mode == :negative or (mode == :dual and value < 0)
+        height - clipping_indicator_size
+      else
+        0
+      end
+
+      element :rect, x: 0, y: y,
+        height: clipping_indicator_size, width: width,
+        fill: clipping_indicator_color, stroke_width: 0
+
+    end
+
+    def draw_zero_line
+      y = if mode == :positive
+        height - zero_line_size
+      elsif mode == :dual
+        height / 2 - zero_line_size / 2
+      else
+        0
+      end
+
+      element :rect, x: 0, y: y,
+        height: zero_line_size, width: width,
+        fill: zero_line_color, stroke_width: 0
+
+    end
+
+    def height_factor
+      height / max.to_f
+    end
+
+    def bar_height
+      if mode == :dual
+        clamped_value.abs * height_factor * 0.5
+      else
+        clamped_value.abs * height_factor
+      end
+    end
+  end
+end

data/lib/minichart/version.rb

@@ -1,3 +1,3 @@
 module Minichart
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: minichart
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-29 00:00:00.000000000 Z
+date: 2020-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: victor
@@ -40,6 +40,7 @@ files:
 - lib/minichart/id_generator.rb
 - lib/minichart/meters/horizontal_bar_meter.rb
 - lib/minichart/meters/meter.rb
+- lib/minichart/meters/vertical_bar_meter.rb
 - lib/minichart/version.rb
 homepage: https://github.com/DannyBen/minichart
 licenses:
@@ -53,7 +54,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="