apexcharts 0.1.7 → 0.1.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 54ad80f2d5b534d005e140000f3accfb846be669b5ead95ba608a7bf98b31561
-  data.tar.gz: 5f26699fcd55813b799a5834ffae901a12f25fd768aadb814599715bd030afaa
+  metadata.gz: 709e9e394138ca8ede2eec0fa33a175b3e08ccaa764907c53fc6c72db067e3d5
+  data.tar.gz: ea1a5e008282d9edc581da80d06a61c743fbf130f91cdbfea659bb450489d5a9
 SHA512:
-  metadata.gz: 1f9bb66bf223bbc14f2b00789968324940488a860abdaa8a4128dc416b60110da4fcf9148d16845ca86c02c9835b3abb73d5071d38075eab2890f6f4d21aec48
-  data.tar.gz: ce976c0c8a8ac057f92ef0680cdfd3e5ab79af6b2d00f52d482704efc1146dbcb3bad8a0fcc330d89fa97d9618442dc6f78361b570e71835fbc9df96be43d445
+  metadata.gz: 561565108337e05159effd5c8c353765b6f4ac1b4741d2b8f520d3a3c8698f697ec0abb359debcaca14ae1ff32fa2ae8c8efe7ab2171377356a3293a2e81a0f2
+  data.tar.gz: 79413ca860115ccf2e9e729b40af747865bf93252ac7ae90c29260a33be0702f05c9780b32ac65fd34e43005c84aabf5c1265d9551ddfc6835212f7338cfc5ab

data/README.md

@@ -1,13 +1,13 @@
 <p align="center">
-  <img src="images/placeholder.png" height="80">
+  <img src="images/apexcharts.rb.png" height="150" />
 </p>
 
 <p align="center">
   <a href="https://rubygems.org/gems/apexcharts">
     <img src="https://img.shields.io/gem/v/apexcharts.svg?label=apexcharts" alt="Gem Version" />
   </a>
-  <a href="https://travis-ci.org/styd/apexcharts.rb">
-    <img src="https://travis-ci.org/styd/apexcharts.rb.svg?branch=master" alt="Build Status" />
+  <a href="https://github.com/styd/apexcharts.rb/actions">
+    <img src="https://github.com/styd/apexcharts.rb/workflows/build-test/badge.svg?branch=master" alt="Build Test Status" />
   </a>
   <a href="https://rubygems.org/gems/apexcharts">
     <img alt="Downloads" src="https://img.shields.io/gem/dt/apexcharts">
@@ -19,8 +19,8 @@
   <a href="https://codeclimate.com/github/styd/apexcharts.rb/maintainability">
     <img src="https://api.codeclimate.com/v1/badges/07a4f59e67abfeae21cb/maintainability" />
   </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 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='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' />
@@ -39,31 +39,28 @@
 
 ## Trusted By
 
-<img src="images/users/ventrata.png" title="Use case: ticket sales for clients (visitor attractions and tour operators)" width="180" height="40" />
+Organization/Company                                                   | Use Case
+-----------------------------------------------------------------------|------------------------------------------------------------------
+<img src="/images/users/copient-health.png" width="143" height="40" /> | Reports/charts related to Operating Room utilization statistics
+<img src="/images/users/bilendo.png" width="202" height="40" />        | Enterprise dashboards to visualize account receivables data
+<img src="/images/users/ventrata.png" width="180" height="40" />       | Ticket sales for clients (visitor attractions and tour operators)
 
 > If your organization/company uses ApexCharts.RB in production, please comment on
 > [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 (worth US$649.00/year)" width="120" height="120" />
-</a>
-
-
 ## README Versions
 
 This README might not be for the version you use.  
 Choose the right README:
 
-> [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)
@@ -76,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)
@@ -90,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)
@@ -97,9 +96,9 @@ Choose the right README:
 - [Options](#options)
   - [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)
@@ -110,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)
@@ -248,13 +246,18 @@ Given:
 <%
   require 'date'
 
-  def ohlc(ary)
-    [rand(ary.min..ary.max), ary.max, ary.min, rand(ary.min..ary.max)]
+  def candlestick_data
+    @acc = rand(6570..6650)
+    60.times.map {|i| [Date.today - 60 + i, ohlc] }.to_h
   end
 
-  candlestick_data = 50.times.map do |i|
-    [Date.today - 50 + i, ohlc(Array.new(2){ rand(6570..6650) })]
-  end.to_h
+  def ohlc
+    open = @acc + rand(-20..20)
+    high = open + rand(0..100)
+    low = open - rand(0..100)
+    @acc = close = open + rand(-((high-low)/3)..((high-low)/2))
+    [open, high, low, close]
+  end
 
   candlestick_options = {
     plot_options: {
@@ -274,8 +277,45 @@ You can make candlestick chart with this:
 ```
 ![Example Candlestick Chart](images/candlestick_chart.gif)
 
-Real life candlestick chart probably don't look like that.
-That's because I just use random sets of numbers as the data.
+
+#### 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
@@ -483,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
@@ -625,14 +688,42 @@ use it like so:
 <%= area_chart series, tooltip: {y: {formatter: function(val) { return '$' + parseFloat(val).toLocaleString() }}} %>
 ```
 
+Or, without the _functionable-json_ gem, use function as object as follows:
 
-## Reusable Custom Palette
+```erb
+<%= area_chart series, tooltip: {y: {formatter: {function: {args: "val", body: "return '$' + parseFloat(val).toLocaleString();"}} }} %>
+```
 
-You can create custom palette that works globally or locally.
 
-### Global Palette
+### Defer Chart Rendering
+
+It's possible to defer chart rendering by passing the argument `defer: true` as options.
+
+```erb
+<%= line_chart series, defer: true %>
+```
+
+
+## Schema
+
+To use [dry-schema] as an alternative options schema, you can specify the following config
+before calling your charts:
+
+```ruby
+ApexCharts.config.schema = :dry_schema
+```
+
+or
+
+```ruby
+ApexCharts.configure do |config|
+  config.schema = :dry_schema
+end
+```
+
+## Reusable Custom Palette
 
-To create global palettes to be used anywhere on your any parts of your app, you can use
+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:
@@ -657,26 +748,6 @@ If later for some reason I don't know you want to destroy the palette you can us
 ApexCharts::Theme.destroy "rainbow"
 ```
 
-### Local Palette
-
-To create local palettes to be used only for current thread (usually for the duration
-of a request), you can use the `create_palette` helper. The theme will only be available
-on that page and inside its partials after the palette created.
-
-For example:
-
-```ruby
-create_palette "ephemeral", ["#ab356d", "#12cdf3", "#665572", "#ababac"]
-```
-
-To destroy the palette:
-
-```ruby
-destroy_palette "ephemeral"
-```
-
-on the same page or in its partials. Otherwise, nothing will happen.
-
 
 ## Use Alongside Other Charting Libraries
 
@@ -684,14 +755,13 @@ 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_:
 
 ```ruby
-gem 'apexcharts', require: 'apexcharts/prefix_with_apex'
+gem 'apexcharts', require: 'apex_charts/prefix_with_apex'
 ```
 
 and you'll get `apex_line_chart`, `apex_area_chart`, etc.
@@ -794,7 +864,13 @@ $ yarn add apexcharts
 ```
 and then require it in your `app/javascript/packs/application.js`.
 ```js
-require("apexcharts")
+// AMD
+window.ApexCharts = require("apexcharts") // expose to window
+
+// or
+// ES6
+import ApexCharts from 'apexcharts'
+window.ApexCharts = ApexCharts
 ```
 
 ### Sinatra
@@ -844,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:
@@ -862,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
@@ -871,18 +935,21 @@ The gem is available as open source under the terms of the
 [MIT License](https://opensource.org/licenses/MIT).
 
 
-## Like the charts?
-
-Consider donating to the author of [ApexCharts.JS] to support his awesome library.
-This project wouldn't be possible without it.
+## Articles
 
-Become a sponsor on [Patreon](https://patreon.com/junedchhipa).  
-One time donation on [PayPal](https://paypal.me/junedchhipa)
+- [Rails em 8 minutos: Criando gráficos incríveis com ApexCharts](https://onebitcode.com/graficos-incriveis-no-ruby-on-rails/)
+- [【Rails】 5分でApexChart.jsを導入する方法](https://qiita.com/syukan3/items/aa741df278f628087a3c)
 
 
 [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
 [v0.1.7]: https://github.com/styd/apexcharts.rb/blob/v0.1.7/README.md
 [v0.1.6]: https://github.com/styd/apexcharts.rb/blob/v0.1.6/README.md
 [v0.1.5]: https://github.com/styd/apexcharts.rb/blob/v0.1.5/README.md

data/lib/apex_charts/charts.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module ApexCharts::Charts
+  %w[
+    base cartesian line area bar column scatter
+    candlestick heatmap bubble radar polar pie donut
+  ].each do |type|
+    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'
+
+  autoload :MixedCharts, 'apex_charts/charts/mixed_charts.rb'
+  autoload :SyncingCharts, 'apex_charts/charts/syncing_charts.rb'
+end

data/lib/{apexcharts/charts/area.rb → apex_charts/charts/area_chart.rb}

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module ApexCharts
+module ApexCharts::Charts
   class AreaChart < CartesianChart
     def chart_type
       'area'

data/lib/{apexcharts/charts/bar.rb → apex_charts/charts/bar_chart.rb}

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module ApexCharts
+module ApexCharts::Charts
   class BarChart < CartesianChart
     def chart_type
       'bar'

data/lib/{apexcharts/charts/base.rb → apex_charts/charts/base_chart.rb}

@@ -1,6 +1,8 @@
-module ApexCharts
+# frozen_string_literal: true
+
+module ApexCharts::Charts
   class BaseChart
-    include Utils::Hash
+    include ApexCharts::Utils::Hash
 
     attr_reader :options, :series, :sample
 
@@ -10,7 +12,7 @@ module ApexCharts
     end
 
     def render
-      Renderer.render_default(options)
+      ApexCharts::Renderer.render(options)
     end
 
     def chart_type; end
@@ -25,7 +27,7 @@ module ApexCharts
 
     def build_options(options)
       deep_merge(
-        OptionsBuilder.new(sample, options).build_options,
+        ApexCharts::OptionsBuilder.new(sample, options).build_options,
         camelize_keys(
           {**@series, chart: {type: chart_type}}.compact
         )

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/{apexcharts/charts/bubble.rb → apex_charts/charts/bubble_chart.rb}

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-module ApexCharts
+module ApexCharts::Charts
   class BubbleChart < BaseChart
     def chart_type
       'bubble'
     end
 
     def series_type
-      BubbleSeries
+      ApexCharts::Series::BubbleSeries
     end
   end
 end