minichart 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c4d765607cf018435ce99cafa73e90043dffdb7ab2bc9916510fc17a7a8a62b5
-  data.tar.gz: 4c523073e91db45609206898fd17dde2d8b968578bdbcf6ad0c82426d4611406
+  metadata.gz: 767c1bdbf55e5aedb689c5286535fb84d3c48cf2c1c054b01da97237dee3437a
+  data.tar.gz: ea0b462ccfd166eea1df2e2a4ad08f32060c713a06f1aea36170079bc90a3671
 SHA512:
-  metadata.gz: 398cb0c87ffe4348868975c32049c306c3e529d03a0215da786e90af24c76df9c158dabf57435ed71db9f66638c1f5caaf4f221e0f4fc7f35958109011d43575
-  data.tar.gz: 4d5592dd32f5350556859aff90cd82d0858ed2a7564cf68371e64b7d2cecc347af137ea8163bc7b7677b0567dcff1f042c33ac499afe106fba172ba38002cb9b
+  metadata.gz: 57524a378c6ce4df0ad08d4edc134630d3ae6ebbb35e68638f11926ab61f4c3b3f6e8e0861d49213de54d619d52df2cb74c4813e2349409e9e444b0ddca2cb44
+  data.tar.gz: 45820a40054e716bfe412d661ba814ea4fb8589b39145fbeff6a079841ea83990d2adbaf6733c328378627133eaaa5891f5e87d268f66abab69a412727cbc29a

data/README.md

@@ -1,16 +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
 ```
 
@@ -20,20 +20,71 @@ 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]
+line = LineChart.new data, color: 'blue'
+bars = BarChart.new data, color: 'blue'
+area = AreaChart.new data, color: 'blue'
+```
+
+Get the full SVG output by calling `#render`:
+
+```ruby
+puts area.render
+#=> <?xml version="1.0" standalone="no"?>
+#   <svg> ... </svg>
+```
+
+Save it to file, by calling `#save`:
+
+```ruby
+area.save "my-chart.svg"
+```
+
+Get its inner SVG string by calling `#to_s`:
+
+```ruby
+puts area.to_s
+#=> <polyline fill="blue" stroke="blue" stroke-width="2" points="..."/>
+```
+
 
-plot = LineChart.new
-plot.aspect_ratio = 2
-plot.data = [10, 30, 20, 40, 30]
-plot.save 'line'
+The objects returned from all the mini chart classes are [Victor::SVG][2] objects, so they support all methods supported by it as well.
+
+## Options
+
+All minichart 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  |
+
+
+## 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

@@ -3,3 +3,5 @@ require 'minichart/chart'
 require 'minichart/line_chart'
 require 'minichart/bar_chart'
 require 'minichart/area_chart'
+
+require 'byebug' if ENV['BYEBUG']

data/lib/minichart/area_chart.rb

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

data/lib/minichart/bar_chart.rb

@@ -4,7 +4,7 @@ module Minichart
       opts  = { x_point_count: data.size }
 
       inverted_points(opts).each do |x, y|
-        svg.rect bar_options x, y
+        rect bar_options x, y
       end
     end
 

data/lib/minichart/chart.rb

@@ -1,21 +1,32 @@
 module Minichart
-  class Chart
-    attr_accessor :data, :aspect_ratio, :opts
+  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
 
-    def initialize(opts={})
-      @opts = opts
-    end
-
-    def save(name)
-      svg.rect x: 0, y: 0, width: width, height: height, fill: background
       build
-      svg.save name
     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
@@ -35,33 +46,5 @@ module Minichart
 
       result
     end
-
-    def width
-      @width ||= (aspect_ratio * height).round
-    end
-
-    def height
-      100
-    end
-
-    def svg
-      @svg ||= Victor::SVG.new viewBox: "0 0 #{width} #{height}", style: style
-    end
-
-    def style
-      @opts[:style] ||= {}
-    end
-
-    def background
-      @opts[:background] ||= '#eee'
-    end
-
-    def color
-      @opts[:color] || '#333'
-    end
-
-    def stroke
-      @opts[:stroke] ||= 2
-    end
   end
 end

data/lib/minichart/line_chart.rb

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

data/lib/minichart/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: minichart
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-25 00:00:00.000000000 Z
+date: 2020-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: victor
@@ -16,14 +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'
+        version: '0.3'
 description: Generate mini charts with SVG
 email: db@dannyben.com
 executables: []
@@ -49,14 +49,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: SVG Mini Charts