apexcharts 0.1.10 → 0.1.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7da6c272c62c024c2e24180a80a69760efa4ba6703dd1fae81dc7119a2115ac1
-  data.tar.gz: 50bbebd360a73a13ebf328de39acef58d6c59270c136e58563eaa6f1a0764db8
+  metadata.gz: 709e9e394138ca8ede2eec0fa33a175b3e08ccaa764907c53fc6c72db067e3d5
+  data.tar.gz: ea1a5e008282d9edc581da80d06a61c743fbf130f91cdbfea659bb450489d5a9
 SHA512:
-  metadata.gz: de01a99814d9234441f6b4964239e9882f7676dd3749df05ffc995669a9bb74d4c29a57c4c839b37f9d2c675d0f8e72b8ad26f8d0f95d130a401777258c50f65
-  data.tar.gz: b57b96bc2bdcedadc007a093c7253a8ddb63d74dddbb58eb678e006e881a34d53ce26d1b623c7b25529845726832fd491c644b13ff3cf7a79794e8f5336f0834
+  metadata.gz: 561565108337e05159effd5c8c353765b6f4ac1b4741d2b8f520d3a3c8698f697ec0abb359debcaca14ae1ff32fa2ae8c8efe7ab2171377356a3293a2e81a0f2
+  data.tar.gz: 79413ca860115ccf2e9e729b40af747865bf93252ac7ae90c29260a33be0702f05c9780b32ac65fd34e43005c84aabf5c1265d9551ddfc6835212f7338cfc5ab

data/README.md

@@ -22,9 +22,6 @@
   <a href="https://codebeat.co/projects/github-com-styd-apexcharts-rb-master">
     <img alt="codebeat badge" src="https://codebeat.co/badges/7be581d6-e74a-406b-ae76-65605a2bff78" />
   </a>
-  <a href='https://coveralls.io/github/styd/apexcharts.rb?branch=master'>
-    <img src='https://coveralls.io/repos/github/styd/apexcharts.rb/badge.svg?branch=master' alt='Coverage Status' />
-  </a>
   <a href='http://clayallsopp.github.io/readme-score/?url=styd/apexcharts.rb'>
     <img src='http://readme-score-api.herokuapp.com/score.svg?url=styd/apexcharts.rb' alt='README Score' />
   </a>
@@ -52,25 +49,18 @@ Organization/Company                                                   | Use Cas
 > [this issue](https://github.com/styd/apexcharts.rb/issues/34).
 
 
-## Supported By
-
-<a href="https://www.jetbrains.com/?from=ApexCharts.RB">
-  <img src="images/supporters/jetbrains.svg" title="Grants 1 License for All Products Pack" width="120" height="120" />
-</a>
-
-
 ## README Versions
 
 This README might not be for the version you use.  
 Choose the right README:
 
-> [v0.1.10] | [v0.1.9] | [v0.1.8] | [v0.1.7] | [v0.1.6] | [v0.1.5] | [v0.1.4] | [v0.1.3] | [v0.1.2] | [v0.1.1]
+> [v0.1.11] | [v0.1.10] | [v0.1.9] | [v0.1.8] | [v0.1.7] | [v0.1.6] |
+> [v0.1.5] | [v0.1.4] | [v0.1.3] | [v0.1.2] | [v0.1.1]
 
 ## Table of Contents
 
 - [About](#about)
 - [Trusted By](#trusted-by)
-- [Supported By](#supported-by)
 - [README Versions](#readme-versions)
 - [Table of Contents](#table-of-contents)
 - [Usage](#usage)
@@ -83,6 +73,7 @@ Choose the right README:
     - [Range Bar Chart](#range-bar-chart)
     - [Scatter Chart](#scatter-chart)
     - [Candlestick Chart](#candlestick-chart)
+    - [Box Plot Chart](#box-plot-chart)
     - [Mixed Charts](#mixed-charts)
     - [Syncing Charts](#syncing-charts)
     - [Brush Chart](#brush-chart)
@@ -97,6 +88,7 @@ Choose the right README:
 - [Data Formats](#data-formats)
   - [Cartesian Charts](#cartesian-charts-1)
     - [Candlestick Chart](#candlestick-chart-1)
+    - [Box Plot Chart](#box-plot-chart-1)
   - [Heatmap Chart](#heatmap-chart-1)
   - [Radar Chart](#radar-chart-1)
   - [Bubble Chart](#bubble-chart-1)
@@ -105,9 +97,8 @@ Choose the right README:
   - [Global Options](#global-options)
   - [Formatter Function](#formatter-function)
   - [Defer Chart Rendering](#defer-chart-rendering)
+- [Schema](#schema)
 - [Reusable Custom Palette](#reusable-custom-palette)
-  - [Global Palette](#global-palette)
-  - [Local Palette](#local-palette)
 - [Use Alongside Other Charting Libraries](#use-alongside-other-charting-libraries)
   - [Alongside Chartkick](#alongside-chartkick)
     - [Chartkick (Chart.js) and ApexCharts](#chartkick-chartjs-and-apexcharts)
@@ -118,7 +109,6 @@ Choose the right README:
   - [Rails](#rails)
   - [Sinatra](#sinatra)
   - [Plain HTML+ERB (Without Framework)](#plain-htmlerb-without-framework)
-- [Roadmap](#roadmap)
 - [Contributing](#contributing)
 - [License](#license)
 - [Like the charts?](#like-the-charts)
@@ -288,6 +278,46 @@ You can make candlestick chart with this:
 ![Example Candlestick Chart](images/candlestick_chart.gif)
 
 
+#### Box Plot Chart
+
+Given:
+```erb
+<%
+  require 'date'
+
+  def box_plot_data
+    20.times.map {|i| [Date.today - 20 + i, box_plot_datum] }.to_h
+  end
+
+  def box_plot_datum
+    level = 1000
+    max = level + rand(50..300)
+    min = level - rand(50..300)
+    q1 = min + rand(10..50)
+    q3 = max - rand(10..50)
+    median = (min + q1 + q3 + max)/4
+    [min, q1, median, q3, max]
+  end
+
+  box_plot_options = {
+    plot_options: {
+      boxPlot: {
+        colors: {
+          upper: '#aaffaa',
+          lower: '#ffaaFF'
+        }
+      }
+    }
+  }
+%>
+```
+You can make box plot chart with this:
+```erb
+<%= box_plot_chart(box_plot_data, box_plot_options) %>
+```
+![Example Box Plot Chart](images/box_plot_chart.gif)
+
+
 #### Mixed Charts
 
 You can mix charts by using `mixed_charts` or `combo_charts` methods.
@@ -493,6 +523,29 @@ or this:
 ]
 ```
 
+#### Box Plot Chart
+
+Box plot chart is similar to candlestick chart, only the y value is
+an array of 5 members (Minimum-First Quartile-Median-Third Quartile-Maximum):
+
+```ruby
+{
+  <x value> => [<Min>, <Q1>, <Median>, <Q3>, <Max>],
+  <x value> => [<Min>, <Q1>, <Median>, <Q3>, <Max>],
+  ...
+}
+```
+
+or this:
+
+```ruby
+[
+  [<x value>, [<Min>, <Q1>, <Median>, <Q3>, <Max>]],
+  [<x value>, [<Min>, <Q1>, <Median>, <Q3>, <Max>]],
+  ...
+]
+```
+
 ### Heatmap Chart
 
 The data format for heatmap chart **per-series** is similar to cartesian
@@ -651,13 +704,26 @@ It's possible to defer chart rendering by passing the argument `defer: true` as
 ```
 
 
-## Reusable Custom Palette
+## Schema
+
+To use [dry-schema] as an alternative options schema, you can specify the following config
+before calling your charts:
 
-You can create custom palette that works globally or locally.
+```ruby
+ApexCharts.config.schema = :dry_schema
+```
 
-### Global Palette
+or
 
-To create global palettes to be used anywhere on your any parts of your app, you can use
+```ruby
+ApexCharts.configure do |config|
+  config.schema = :dry_schema
+end
+```
+
+## Reusable Custom Palette
+
+To create palettes to be used anywhere on your any parts of your app, you can use
 `ApexCharts::Theme.create`.
 
 For example, in rails app, you would write it in initializers:
@@ -689,8 +755,7 @@ You can prefix the helper methods name with your chosen words to avoid name clas
 other charting libraries (e.g. chartkick, google_charts, etc.) you already use. Just set
 the `APEXCHARTS_PREFIX` environment variable to a string before you start your app server,
 say, 'awesome\_' and then on your views/templates use the chart helpers as `awesome_line_chart`,
-`awesome_area_chart`, and so on. `create_palette` and `destroy_palette` are left as is (not
-prefixed) as other libraries don't seem to have anything similar to them.
+`awesome_area_chart`, and so on.
 
 Besides setting the environtment variable, if you just want a quick prefix, you can instead
 do this on your _Gemfile_:
@@ -855,17 +920,6 @@ $ erb sample.html.erb > sample.html
 ```
 
 
-## Roadmap
-
-- Support other ruby frameworks (hanami, roda, cuba, middleman, etc.)
-- v0.1.x
-  - Add more features (e.g. gradient line, background image, etc.)
-- v0.2.x
-  - Replace dependency `smart_kv` with `dry-schema`
-  - Display warnings on browser console on development instead of error page when
-    schema doesn't meet
-
-
 ## Contributing
 
 Everyone is encouraged to help improve this project by:
@@ -873,7 +927,6 @@ Everyone is encouraged to help improve this project by:
 - Fixing bugs and submiting pull requests
 - Fixing documentation
 - Suggesting new features
-- Implementing todos on Roadmap above
 
 
 ## License
@@ -889,8 +942,11 @@ The gem is available as open source under the terms of the
 
 
 [ApexCharts.JS]: https://github.com/apexcharts/apexcharts.js
+[dry-schema]: https://github.com/dry-rb/dry-schema
 
 
+[Unreleased]: https://github.com/styd/apexcharts.rb/compare/v0.1.11...HEAD
+[v0.1.11]: https://github.com/styd/apexcharts.rb/blob/v0.1.11/README.md
 [v0.1.10]: https://github.com/styd/apexcharts.rb/blob/v0.1.10/README.md
 [v0.1.9]: https://github.com/styd/apexcharts.rb/blob/v0.1.9/README.md
 [v0.1.8]: https://github.com/styd/apexcharts.rb/blob/v0.1.8/README.md

data/lib/apex_charts/charts.rb

@@ -8,6 +8,7 @@ module ApexCharts::Charts
     autoload :"#{type.capitalize}Chart", "apex_charts/charts/#{type}_chart.rb"
   end
 
+  autoload :BoxPlotChart, 'apex_charts/charts/box_plot_chart.rb'
   autoload :RangeBarChart, 'apex_charts/charts/range_bar_chart.rb'
   autoload :RadialBarChart, 'apex_charts/charts/radial_bar_chart.rb'
 

data/lib/apex_charts/charts/box_plot_chart.rb

@@ -0,0 +1,8 @@
+
+module ApexCharts::Charts
+  class BoxPlotChart < CartesianChart
+    def chart_type
+      'boxPlot'
+    end
+  end
+end

data/lib/apex_charts/config/schema.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module ApexCharts
+  module Config
+    module Schema
+      def schema
+        @schema ||= 'Default'
+      end
+
+      def schema=(name)
+        @schema = case name
+                  when :dry_schema, 'dry_schema', 'dry-schema'
+                    'DrySchema'
+                  else
+                    'Default'
+                  end
+      end
+    end
+  end
+end

data/lib/apex_charts/configuration.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative 'config/default_options'
+require_relative 'config/schema'
 
 module ApexCharts
   class << self
@@ -21,5 +22,6 @@ module ApexCharts
 
   class Configuration
     include ApexCharts::Config::DefaultOptions
+    include ApexCharts::Config::Schema
   end
 end

data/lib/apex_charts/helper.rb

@@ -78,6 +78,15 @@ module ApexCharts
       end
       alias_method :ohlc_chart, :candlestick_chart
 
+      def box_plot_chart(series, options={}, &block)
+        outer_self = eval('self', block.binding, __FILE__, __LINE__) if block_given?
+        draw_chart(
+          ApexCharts::Charts::BoxPlotChart.new(
+            outer_self, *prepare_series_and_options(series, options), &block
+          )
+        )
+      end
+
       def heatmap_chart(series, options={})
         draw_chart(
           ApexCharts::Charts::HeatmapChart.new(
@@ -148,17 +157,6 @@ module ApexCharts
       alias_method :circle_chart, :radial_bar_chart
     end
 
-    def create_palette(palette_name, colors)
-      warn "`create_palette' and `destroy_palette` are deprecated " +
-           "and will be removed in the next release."
-
-      Theme::Local.create palette_name, colors
-    end
-
-    def destroy_palette(palette_name)
-      Theme::Local.destroy palette_name
-    end
-
   private
 
     def draw_chart(chart)

data/lib/apex_charts/options/default/annotations_options.rb

@@ -0,0 +1,14 @@
+module ApexCharts::Options
+  module Default
+    class AnnotationsOptions < ::SmartKv
+      optional *%i[
+        images
+        points
+        position
+        texts
+        xaxis
+        yaxis
+      ]
+    end
+  end
+end

data/lib/apex_charts/options/default/chart_options.rb

@@ -0,0 +1,33 @@
+module ApexCharts::Options
+  module Default
+    class ChartOptions < ::SmartKv
+      optional *%i[
+        animations
+        background
+        brush
+        defaultLocale
+        dropShadow
+        events
+        fontFamily
+        foreColor
+        group
+        height
+        id
+        locales
+        offsetX
+        offsetY
+        parentHeightOffset
+        redrawOnParentResize
+        redrawOnWindowResize
+        selection
+        sparkline
+        stackType
+        stacked
+        toolbar
+        type
+        width
+        zoom
+      ]
+    end
+  end
+end

data/lib/apex_charts/options/default/data_labels_options.rb

@@ -0,0 +1,18 @@
+module ApexCharts::Options
+  module Default
+    class DataLabelsOptions < ::SmartKv
+      optional *%i[
+        background
+        distributed
+        dropShadow
+        enabled
+        enabledOnSeries
+        formatter
+        offsetX
+        offsetY
+        style
+        textAnchor
+      ]
+    end
+  end
+end

data/lib/apex_charts/options/default/fill_options.rb

@@ -0,0 +1,14 @@
+module ApexCharts::Options
+  module Default
+    class FillOptions < ::SmartKv
+      optional *%i[
+        colors
+        gradient
+        image
+        opacity
+        pattern
+        type
+      ]
+    end
+  end
+end

data/lib/apex_charts/options/default/grid_options.rb

@@ -0,0 +1,17 @@
+module ApexCharts::Options
+  module Default
+    class GridOptions < ::SmartKv
+      optional *%i[
+        borderColor
+        column
+        padding
+        position
+        row
+        show
+        strokeDashArray
+        xaxis
+        yaxis
+      ]
+    end
+  end
+end

data/lib/apex_charts/options/default/helper_options.rb

@@ -0,0 +1,22 @@
+require 'smart_kv'
+
+module ApexCharts::Options
+  module Default
+    class HelperOptions < ::SmartKv
+      optional *%i[
+        brushTarget
+        class
+        chartId
+        defer
+        group
+        id
+        style
+        var
+        xtitle
+        xtype
+        ytitle
+        ytype
+      ]
+    end
+  end
+end