minichart 0.0.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7a7348b03ecdf74aeaa57f5fba37079542211e40
-  data.tar.gz: b85da04d30a6fe59f8b38b688e29962b8a69c1a2
+SHA256:
+  metadata.gz: 7debe086fa2ba7994f1362fa53ab2d5da5cc61a0010f6f08d6ca125cc447bc27
+  data.tar.gz: 77dd9cf342830795872c284befe937cba7caa9c2372bdae2b8a42a44e6d4bb13
 SHA512:
-  metadata.gz: d14c1514bc83eb80ab82b05476999824097a378af0729f47ba02e8c998e60495bbf94c79834ccbd35f531a57056ac70c15e9609e36e047724334e3009a9744c8
-  data.tar.gz: 8141275bea9a34dad840cd7c26d19b0c693b839f4162fddb87a2c7ac77fe81286c7dae653636befb848087097e797c6056acce759de370ab689e5df650737dbd
+  metadata.gz: 5a331fa46640d9bfb32759a5aa160680cd684bd7f57f194e212f7b0d0f5c2af61f03f8b526702de0421dbe608fbc70c39df8c219967b8c2de9fe647f04822e42
+  data.tar.gz: 2fede85eef059f2ac6980ff9ba6249b1e7b716edb38eacfe514cebace11488e0cb1ca4520ff4d7a3bf58934e746e846130026c9c98f7bc41419c4216a68c8734

data/README.md

@@ -1,17 +1,16 @@
-Minichart - SVG Chart Generator
-==================================================
-
+# Minichart - SVG Chart Generator
 
 ---
 
 Create SVG mini charts with Ruby
 
+![demo](examples/multiple.svg)
+
 ---
 
-Install
---------------------------------------------------
+## Install
 
-```
+```shell
 $ gem install minichart
 ```
 
@@ -21,17 +20,155 @@ Or with bundler:
 gem 'minichart'
 ```
 
-Example
---------------------------------------------------
+## Usage
+
+Require and optionally include the library:
 
 ```ruby
 require 'minichart'
 include Minichart
+```
+
+Initialize a chart with data, and optional options:
+
+```ruby
+data = [3, 1, 4, 1, 5, 9, 2, 6, 5, 3, 5, 9]
+chart = AreaChart.new data, color: 'blue'
+```
+
+Get the full SVG output by calling `#render`:
+
+```ruby
+puts chart.render
+#=> <?xml version="1.0" standalone="no"?>
+#   <svg> ... </svg>
+```
+
+Save it to file, by calling `#save`:
+
+```ruby
+chart.save "my-chart.svg"
+```
+
+Get its inner SVG string by calling `#to_s`:
+
+```ruby
+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' width=300>
+
+```ruby
+LineChart.new data, height: 50, background: '#eee',
+  aspect_ratio: 5, color: 'green'
+```
+
+### Bar Chart
+
+<img src='examples/bar_chart.svg' align='right' width=300>
+
+```ruby
+BarChart.new data, height: 50, background: '#eee',
+  aspect_ratio: 5, color: 'green'
+```
+
+### Area Chart
 
-plot = LineChart.new
-plot.aspect_ratio = 2
-plot.data = [10, 30, 20, 40, 30]
-plot.save 'line'
+<img src='examples/area_chart.svg' align='right' width=300>
+
+```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
 ```
 
-See more examples in the examples folder.
+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
+
+All chart classes support a second hash argument for options
+
+```ruby
+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`<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 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
+
+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,4 +1,12 @@
 require 'victor'
-require 'minichart/chart'
-require 'minichart/line_chart'
-require 'minichart/bar_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/vertical_bar_meter'
+require 'minichart/meters/horizontal_bar_meter'
+
+require 'byebug' if ENV['BYEBUG']

data/lib/minichart/base.rb

@@ -0,0 +1,67 @@
+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
+      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
+
+      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/charts/area_chart.rb

@@ -0,0 +1,27 @@
+module Minichart
+  class AreaChart < Chart
+    def build
+      element :polyline, fill: color,
+        stroke: color,
+        stroke_width: stroke,
+        stroke_linejoin: :round,
+        points: points
+    end
+
+  protected
+
+    def points
+      result = ["0,#{height}"]
+
+      inverted_points.each do |point|
+        x = width*point[0]
+        y = height*point[1]
+        result << "#{x},#{y}"
+      end
+
+      result << "#{width},#{height}"
+
+      result
+    end
+  end
+end

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

@@ -1,33 +1,29 @@
-module Minichart
-  class BarChart < Chart
-    def build
-      opts  = { x_point_count: data.size }
-
-      inverted_points(opts).each do |x, y|
-        svg.rect bar_options x, y
-      end
-    end
-
-    private
-
-    def style
-      @style ||= { stroke_width: 1, stroke: '#eee' }
-    end
-
-    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: style 
-      }
-    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,17 +1,23 @@
-module Minichart
-  class LineChart < Chart
-    def build
-      svg.polyline fill: :none, stroke: :black, stroke_width: 2, points: points
-    end
-
-    def points
-      result = []
-      inverted_points.each do |point|
-        x = width*point[0]
-        y = height*point[1]
-        result << "#{x},#{y}"
-      end
-      result
-    end
-  end
-end
+module Minichart
+  class LineChart < Chart
+    def build
+      element :polyline, fill: :none,
+        stroke: color,
+        stroke_width: stroke,
+        stroke_linejoin: :round,
+        points: points
+    end
+
+  protected
+
+    def points
+      result = []
+      inverted_points.each do |point|
+        x = width*point[0]
+        y = height*point[1]
+        result << "#{x},#{y}"
+      end
+      result
+    end
+  end
+end

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,64 @@
+module Minichart
+  class HorizontalBarMeter < Meter
+    def build
+      draw_bar
+      draw_zero_line if zero_line
+      draw_clipping_indicator if clipping_indicator and clipping?
+    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_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: clipping_indicator_size,
+        fill: clipping_indicator_color, stroke_width: 0
+
+    end
+
+    def draw_zero_line
+      x = if mode == :negative
+        width - zero_line_size
+      elsif mode == :dual
+        width / 2 - zero_line_size / 2
+      else
+        0
+      end
+
+      element :rect, x: x, y: 0,
+        height: height, width: zero_line_size,
+        fill: zero_line_color, stroke_width: 0
+
+    end
+
+    def width_factor
+      width / max.to_f
+    end
+
+    def bar_width
+      if mode == :dual
+        clamped_value.abs * width_factor * 0.5
+      else
+        clamped_value.abs * width_factor
+      end
+    end
+  end
+end

data/lib/minichart/meters/meter.rb

@@ -0,0 +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.0.1"
+  VERSION = "0.2.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: minichart
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-20 00:00:00.000000000 Z
+date: 2020-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: victor
@@ -16,70 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
-- !ruby/object:Gem::Dependency
-  name: runfile
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.8'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.8'
-- !ruby/object:Gem::Dependency
-  name: runfile-tasks
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.4'
-- !ruby/object:Gem::Dependency
-  name: byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '9.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '9.0'
-- !ruby/object:Gem::Dependency
-  name: filewatcher
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.3'
 description: Generate mini charts with SVG
 email: db@dannyben.com
 executables: []
@@ -88,9 +32,15 @@ extra_rdoc_files: []
 files:
 - README.md
 - lib/minichart.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/meters/vertical_bar_meter.rb
 - lib/minichart/version.rb
 homepage: https://github.com/DannyBen/minichart
 licenses:
@@ -104,15 +54,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: SVG Mini Charts

data/lib/minichart/chart.rb

@@ -1,47 +0,0 @@
-module Minichart
-  class Chart
-    attr_accessor :data, :aspect_ratio
-
-    def save(name)
-      svg.rect x: 0, y: 0, width: width, height: height, fill: '#ccc'
-      build
-      svg.save name
-    end
-
-    def build
-      raise "Subeclass needs to implement #build"
-    end
-
-    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
-
-    def width
-      @width ||= (aspect_ratio * height).round
-    end
-
-    def height
-      100
-    end
-
-    def svg
-      @svg ||= SVG.new viewBox: "0 0 #{width} #{height}", style: { background: '#ddd' }
-    end
-  end
-end