minichart 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 767c1bdbf55e5aedb689c5286535fb84d3c48cf2c1c054b01da97237dee3437a
-  data.tar.gz: ea0b462ccfd166eea1df2e2a4ad08f32060c713a06f1aea36170079bc90a3671
+  metadata.gz: 144b47573abadc9f4bfe5e41dea006bb24705db37dc93767353ba62d389bdd1d
+  data.tar.gz: 7c4936f6947307fd106b1e0700fff88c9ad7f5721dfc50dfd23ca3051a79b7b5
 SHA512:
-  metadata.gz: 57524a378c6ce4df0ad08d4edc134630d3ae6ebbb35e68638f11926ab61f4c3b3f6e8e0861d49213de54d619d52df2cb74c4813e2349409e9e444b0ddca2cb44
-  data.tar.gz: 45820a40054e716bfe412d661ba814ea4fb8589b39145fbeff6a079841ea83990d2adbaf6733c328378627133eaaa5891f5e87d268f66abab69a412727cbc29a
+  metadata.gz: c66ae222164ccc21a98cd8eddd790f54d114897ed6374b7e36fd242d16364e49ccec532e580d3a180d094c48fd27853f7b01bd85c81e7b8a4af8254a595af191
+  data.tar.gz: 6d19ce05f98de008d26127b8046512b66e1c68af0972e3b66f15ce3a6bfe4ac8a99a6de76457757e34903e3012b757ba31eeba688a018393304ca8cff41a1e74

data/README.md

@@ -33,15 +33,13 @@ Initialize a chart with data, and optional options:
 
 ```ruby
 data = [3, 1, 4, 1, 5, 9, 2, 6, 5, 3, 5, 9]
-line = LineChart.new data, color: 'blue'
-bars = BarChart.new data, color: 'blue'
-area = AreaChart.new data, color: 'blue'
+chart = AreaChart.new data, color: 'blue'
 ```
 
 Get the full SVG output by calling `#render`:
 
 ```ruby
-puts area.render
+puts chart.render
 #=> <?xml version="1.0" standalone="no"?>
 #   <svg> ... </svg>
 ```
@@ -49,42 +47,105 @@ puts area.render
 Save it to file, by calling `#save`:
 
 ```ruby
-area.save "my-chart.svg"
+chart.save "my-chart.svg"
 ```
 
 Get its inner SVG string by calling `#to_s`:
 
 ```ruby
-puts area.to_s
+puts chart.to_s
 #=> <polyline fill="blue" stroke="blue" stroke-width="2" points="..."/>
 ```
 
 
 The objects returned from all the mini chart classes are [Victor::SVG][2] objects, so they support all methods supported by it as well.
 
+## Chart Types
+
+### Line Chart
+
+<img src='examples/line_chart.svg' align='right'>
+
+```ruby
+LineChart.new data, height: 50, background: '#eee',
+  aspect_ratio: 5, color: 'green'
+```
+
+### Bar Chart
+
+<img src='examples/bar_chart.svg' align='right'>
+
+```ruby
+BarChart.new data, height: 50, background: '#eee',
+  aspect_ratio: 5, color: 'green'
+```
+
+### Area Chart
+
+<img src='examples/area_chart.svg' align='right'>
+
+```ruby
+AreaChart.new data, height: 50, background: '#eee',
+  aspect_ratio: 5, color: 'green'
+```
+
+### Horizontal Bar Meter
+
+<img src='examples/multiple_horizontal_bars.svg' align='right'>
+
+```ruby
+positive = HorizontalBarMeter.new 70,
+  height: 20, width: 250, background: '#9f9', color: 'green'
+
+negative = HorizontalBarMeter.new -80,
+  height: 20, width: 250, background: '#f99', color: 'red'
+
+dual = HorizontalBarMeter.new 80,
+  height: 20, width: 250, background: '#99f', color: 'blue',
+  mode: :dual, zero_line: true
+```
+
+Meter charts support [additional options](#meter-options).
+
 ## Options
 
-All minichart classes support a second hash argument for options
+### Basic Options
+
+All chart classes support a second hash argument for options
 
 ```ruby
 chart = LineChart.new data, options
 ```
 
-| Option         | Default                      | Description             |
-| -------------- | ---------------------------- | ----------------------- |
-| `background`   | *None*                       | 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       |
-| `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`                        | 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                                       |
+
+
+### 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                                       |
 
 ## Examples
 
 See more examples (code and SVG output) in the [examples folder][1].
 
+---
+
 
 [1]: https://github.com/DannyBen/minichart/tree/master/examples#examples
 [2]: https://github.com/DannyBen/victor

data/lib/minichart.rb

@@ -1,7 +1,11 @@
 require 'victor'
-require 'minichart/chart'
-require 'minichart/line_chart'
-require 'minichart/bar_chart'
-require 'minichart/area_chart'
+require 'minichart/id_generator'
+require 'minichart/base'
+require 'minichart/charts/chart'
+require 'minichart/charts/line_chart'
+require 'minichart/charts/bar_chart'
+require 'minichart/charts/area_chart'
+require 'minichart/meters/meter'
+require 'minichart/meters/horizontal_bar_meter'
 
 require 'byebug' if ENV['BYEBUG']

data/lib/minichart/base.rb

@@ -0,0 +1,65 @@
+module Minichart
+  # Base class for all Minichart classes
+  class Base < Victor::SVGBase
+    attr_reader :aspect_ratio, :background, :color, :data,
+      :height, :stroke, :style, :width, :opts
+
+    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
+
+      clip_path_id = IDGenerator.next
+      setup_clip_path clip_path_id
+
+      element :g, clip_path: "url(##{clip_path_id})" do
+        build
+      end      
+    end
+
+    def setup_clip_path(id)
+      element :defs do
+        element :clipPath, id: id do
+          element :rect, width: width, height: height
+        end
+      end
+    end
+
+    def background
+      opts[:background] ||= 'white'
+    end
+
+    def aspect_ratio
+      opts[:aspect_ratio] ||= 3
+    end
+
+    def height
+      opts[:height] ||= 100
+    end
+
+    def width
+      opts[:width] ||= (aspect_ratio * height).round
+    end
+
+    def stroke
+      opts[:stroke] ||= 2
+    end
+
+    def style
+      opts[:style] ||= {}
+    end
+
+    def color
+      opts[:color] ||= '#333'
+    end
+
+    def viewbox
+      "0 0 #{width} #{height}"
+    end
+
+    def build
+      raise NotImplementedError, "#build is not implemented"
+    end
+  end
+end

data/lib/minichart/{area_chart.rb → charts/area_chart.rb}

@@ -1,7 +1,7 @@
 module Minichart
   class AreaChart < Chart
     def build
-      polyline fill: color,
+      element :polyline, fill: color,
         stroke: color,
         stroke_width: stroke,
         stroke_linejoin: :round,

data/lib/minichart/{bar_chart.rb → charts/bar_chart.rb}

@@ -1,29 +1,29 @@
-module Minichart
-  class BarChart < Chart
-    def build
-      opts  = { x_point_count: data.size }
-
-      inverted_points(opts).each do |x, y|
-        rect bar_options x, y
-      end
-    end
-
-  protected
-
-    def bar_width
-      @bar_width ||= width / data.size
-    end
-
-    def bar_options(x, y)
-      y = y*height
-      bar_height = height-y
-      { 
-        x: x*width, 
-        y: y, 
-        width: bar_width, 
-        height: bar_height, 
-        style: { fill: color, stroke_width: stroke, stroke: background }
-      }
-    end
-  end
-end
+module Minichart
+  class BarChart < Chart
+    def build
+      opts  = { x_point_count: data.size }
+
+      inverted_points(opts).each do |x, y|
+        element :rect, bar_options(x, y)
+      end
+    end
+
+  protected
+
+    def bar_width
+      @bar_width ||= width / data.size
+    end
+
+    def bar_options(x, y)
+      y = y*height
+      bar_height = height-y
+      { 
+        x: x*width, 
+        y: y, 
+        width: bar_width, 
+        height: bar_height, 
+        style: { fill: color, stroke_width: stroke, stroke: background }
+      }
+    end
+  end
+end

data/lib/minichart/charts/chart.rb

@@ -0,0 +1,28 @@
+module Minichart
+  # Base class for charts with data series
+  class Chart < Base
+  
+  protected
+
+    def inverted_points(opts={})
+      normalized_points(opts).map { |point| [point[0], 1-point[1]] }
+    end
+
+    def normalized_points(opts={})
+      x_point_count = opts[:x_point_count] || data.count-1
+
+      range   = (data.max - data.min).to_f
+      x_width = 1 / (x_point_count).to_f
+      result  = []
+
+      data.each_with_index do |y, index|
+        x = index*x_width
+        y = (y - data.min) / range
+        result << [x,y]
+      end
+
+      result
+    end
+
+  end
+end

data/lib/minichart/{line_chart.rb → charts/line_chart.rb}

@@ -1,7 +1,7 @@
 module Minichart
   class LineChart < Chart
     def build
-      polyline fill: :none,
+      element :polyline, fill: :none,
         stroke: color,
         stroke_width: stroke,
         stroke_linejoin: :round,

data/lib/minichart/id_generator.rb

@@ -0,0 +1,14 @@
+module Minichart
+  module IDGenerator
+    class << self
+      def next
+        @id ||= 0
+        "minichart-#{@id += 1}"
+      end
+
+      def reset
+        @id = 0
+      end
+    end
+  end
+end

data/lib/minichart/meters/horizontal_bar_meter.rb

@@ -0,0 +1,91 @@
+module Minichart
+  class HorizontalBarMeter < Meter
+    def build
+      draw_bar
+      draw_zero_line if zero_line
+    end
+
+  protected
+
+    def draw_bar
+      x = if mode == :negative
+        width - bar_width
+      elsif mode == :dual
+        middle = width * 0.5
+        value >= 0 ? middle : middle - bar_width
+      else
+        0
+      end
+
+      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
+      else
+        0
+      end
+
+      element :rect, x: x, y: 0,
+        height: height, width: zero_line_stroke,
+        fill: zero_line_color
+
+    end
+
+    def mode
+      opts[:mode] ||= :auto
+
+      if opts[:mode] == :auto
+        value >= 0 ? :positive : :negative
+      else
+        opts[:mode]
+      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
+
+    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
+      else
+        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

@@ -0,0 +1,8 @@
+module Minichart
+  # Base class for charts with a single value
+  class Meter < Base
+    def value
+      data
+    end
+  end
+end

data/lib/minichart/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: minichart
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Danny Ben Shitrit
@@ -32,10 +32,14 @@ extra_rdoc_files: []
 files:
 - README.md
 - lib/minichart.rb
-- lib/minichart/area_chart.rb
-- lib/minichart/bar_chart.rb
-- lib/minichart/chart.rb
-- lib/minichart/line_chart.rb
+- lib/minichart/base.rb
+- lib/minichart/charts/area_chart.rb
+- lib/minichart/charts/bar_chart.rb
+- lib/minichart/charts/chart.rb
+- lib/minichart/charts/line_chart.rb
+- lib/minichart/id_generator.rb
+- lib/minichart/meters/horizontal_bar_meter.rb
+- lib/minichart/meters/meter.rb
 - lib/minichart/version.rb
 homepage: https://github.com/DannyBen/minichart
 licenses:

data/lib/minichart/chart.rb

@@ -1,50 +0,0 @@
-module Minichart
-  class Chart < Victor::SVG
-    attr_reader :aspect_ratio, :background, :color, :data,
-      :height, :stroke, :style, :width
-
-    def initialize(data, opts = {})
-      @data = data
-      @background = opts[:background]
-      @aspect_ratio = opts[:aspect_ratio] || 3
-      @height = opts[:height] || 100
-      @width = opts[:width] || (aspect_ratio * height).round
-      @stroke = opts[:stroke] || 2
-      @style = opts[:style] || {}
-      @color = opts[:color] || '#333'
-
-      super height: height, width: width, style: style, 
-        viewBox: "0 0 #{width} #{height}"
-      
-      rect x: 0, y: 0, width: width, height: height, fill: background if background
-
-      build
-    end
-
-    def build
-      raise NotImplementedError, "#build is not implemented"
-    end
-
-  protected
-
-    def inverted_points(opts={})
-      normalized_points(opts).map { |point| [point[0], 1-point[1]] }
-    end
-
-    def normalized_points(opts={})
-      x_point_count = opts[:x_point_count] || data.count-1
-
-      range   = (data.max - data.min).to_f
-      x_width = 1/(x_point_count).to_f
-      result  = []
-
-      data.each_with_index do |y, index|
-        x = index*x_width
-        y = (y-data.min)/range
-        result << [x,y]
-      end
-
-      result
-    end
-  end
-end