Add alternative options schema

CHANGELOG.md

@@ -6,6 +6,7 @@ All notable changes to this project will be documented in this file.
 - Make obsolete previously deprecated local palette creation
 - Update options schema to match ApexCharts.JS version 3.22.0
 - ApexCharts.JS version from 3.21.0 to 3.22.0
+- Add alternative options schema :dry_schema
 
 ## [0.1.10] - 2020-10-04
 ### Added

README.md

@@ -105,6 +105,7 @@ 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)
 - [Use Alongside Other Charting Libraries](#use-alongside-other-charting-libraries)
   - [Alongside Chartkick](#alongside-chartkick)
@@ -116,7 +117,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)
@@ -649,6 +649,23 @@ It's possible to defer chart rendering by passing the argument `defer: true` as
 ```
 
 
+## 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 palettes to be used anywhere on your any parts of your app, you can use
@@ -848,25 +865,13 @@ $ 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:
 - Reporting bugs
 - Fixing bugs and submiting pull requests
 - Fixing documentation
 - Suggesting new features
-- Implementing todos on Roadmap above
 
 
 ## License
@@ -882,6 +887,7 @@ 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
 
 
 [v0.1.10]: https://github.com/styd/apexcharts.rb/blob/v0.1.10/README.md

apexcharts.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |spec|
   spec.files = Dir['{lib,vendor}/**/*', 'LICENSE', 'README.md']
 
   spec.add_dependency 'smart_kv', '~> 0.2.8'
+  spec.add_dependency 'dry-schema', '~> 1.5'
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'coveralls'

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

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 @@ def config
 
   class Configuration
     include ApexCharts::Config::DefaultOptions
+    include ApexCharts::Config::Schema
   end
 end

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

lib/apex_charts/options/default/chart_options.rb

@@ -0,0 +1,32 @@
+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
+        selection
+        sparkline
+        stackType
+        stacked
+        toolbar
+        type
+        width
+        zoom
+      ]
+    end
+  end
+end

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

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

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

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

lib/apex_charts/options/default/legend_options.rb

@@ -0,0 +1,32 @@
+module ApexCharts::Options
+  module Default
+    class LegendOptions < ::SmartKv
+      optional *%i[
+        containerMargin
+        floating
+        fontFamily
+        fontSize
+        fontWeight
+        formatter
+        height
+        horizontalAlign
+        inverseOrder
+        itemMargin
+        labels
+        markers
+        offsetX
+        offsetY
+        onItemClick
+        onItemHover
+        position
+        show
+        showForNullSeries
+        showForSingleSeries
+        showForZeroSeries
+        textAnchor
+        tooltipHoverFormatter
+        width
+      ]
+    end
+  end
+end

lib/apex_charts/options/default/markers_options.rb

@@ -0,0 +1,24 @@
+module ApexCharts::Options
+  module Default
+    class MarkersOptions < ::SmartKv
+      optional *%i[
+        colors
+        discrete
+        fillOpacity
+        hover
+        offsetX
+        offsetY
+        radius
+        shape
+        size
+        strokeColors
+        strokeOpacity
+        strokeWidth
+        strokeDashArray
+        showNullDataPoints
+        onClick
+        onDblClick
+      ]
+    end
+  end
+end

lib/apex_charts/options/default/no_data_options.rb

@@ -0,0 +1,14 @@
+module ApexCharts::Options
+  module Default
+    class NoDataOptions < ::SmartKv
+      optional *%i[
+        align
+        offsetX
+        offsetY
+        style
+        text
+        verticalAlign
+      ]
+    end
+  end
+end