chartkick 3.4.1 → 4.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5791c4748533e3fa0eaa1b2e1c6fbbffc726f8ab663f4590edfd0b9555894909
-  data.tar.gz: fb3e99507dcdf7934cf1bfc25052ba14f8c109af05379a45b47fda728c2eb3b7
+  metadata.gz: a0db2fe39f763929c498438dc88f75dd51dbc9ace5ede4819e9f4d88c0cad72f
+  data.tar.gz: a1dbaf6eddf2bccfdc1e6f4b9fc114eea952eb021dedb7775832d3d5c2b8a389
 SHA512:
-  metadata.gz: e417d6dcc2ae547cd63c7ded309329b112cfc9b6195c29c08d6192e3dbba4c630695815cc65f3d23e3b3833bdafc46bb04809b708362de8d98ee5f04568fbca3
-  data.tar.gz: 730f4f49ced271c3f7e15e3a3e57d5f3f81c08d5a2bd0de3792ec6e2747c433bd37b185bd38db2dfaede7aa0c5ab0ad63255d30a675379e7035182df898bf836
+  metadata.gz: 0eccf48920536b5f4277cac070759d501ee77177805e06146db100e1818337de38e7c9ae45109362817da72425d3385993136012d57530266122deb09c670ea1
+  data.tar.gz: 55190f89407e99810198d82cda444c49f8877b86ea0148e8d408f06a4d3fc9935e07ec77414119f4d06ccd905bf9124b6678c044c2cd9d68e7de206b2901e3d3

data/CHANGELOG.md

@@ -1,3 +1,35 @@
+## 4.0.3 (2021-04-10)
+
+- Updated Chartkick.js to 4.0.3
+- Updated Chart.js to 3.1.0
+
+## 4.0.2 (2021-04-06)
+
+- Updated Chartkick.js to 4.0.2
+
+## 4.0.1 (2021-04-06)
+
+- Fixed error with Uglifier
+- Updated Chartkick.js to 4.0.1
+
+## 4.0.0 (2021-04-04)
+
+- Added support for Chart.js 3
+- Added `loading` option
+- Made charts deferrable by default
+- Set `nonce` automatically when present
+- Prefer `empty` over `messages: {empty: ...}`
+- Removed support for Ruby < 2.6 and Rails < 5.2
+- Updated Chartkick.js to 4.0.0
+
+Breaking changes
+
+- Removed support for Chart.js 2
+
+## 3.4.2 (2020-10-20)
+
+- Updated Chart.js to 2.9.4
+
 ## 3.4.1 (2020-10-06)
 
 - Relaxed validation for `width` and `height` options

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2013-2019 Andrew Kane
+Copyright (c) 2013-2021 Andrew Kane
 
 MIT License
 

data/README.md

@@ -4,15 +4,17 @@ Create beautiful JavaScript charts with one line of Ruby. No more fighting with
 
 [See it in action](https://chartkick.com)
 
+**Chartkick 4.0 was recently released** - see [how to upgrade](#upgrading)
+
 :fire: For admin charts and dashboards, check out [Blazer](https://github.com/ankane/blazer/), and for advanced visualizations, check out [Vega](https://github.com/ankane/vega)
 
 :two_hearts: A perfect companion to [Groupdate](https://github.com/ankane/groupdate), [Hightop](https://github.com/ankane/hightop), and [ActiveMedian](https://github.com/ankane/active_median)
 
-[![Build Status](https://travis-ci.org/ankane/chartkick.svg?branch=master)](https://travis-ci.org/ankane/chartkick)
+[![Build Status](https://github.com/ankane/chartkick/workflows/build/badge.svg?branch=master)](https://github.com/ankane/chartkick/actions)
 
 ## Quick Start
 
-Add this line to your application's Gemfile:
+Add this line to your application’s Gemfile:
 
 ```ruby
 gem "chartkick"
@@ -27,8 +29,7 @@ yarn add chartkick chart.js
 And in `app/javascript/packs/application.js`, add:
 
 ```js
-require("chartkick")
-require("chart.js")
+require("chartkick/chart.js")
 ```
 
 For Rails 5 / Sprockets, in `app/assets/javascripts/application.js`, add:
@@ -38,7 +39,7 @@ For Rails 5 / Sprockets, in `app/assets/javascripts/application.js`, add:
 //= require Chart.bundle
 ```
 
-This sets up Chartkick with Chart.js. For other charting libraries, see [detailed instructions](#installation).
+This sets up Chartkick with [Chart.js](https://www.chartjs.org/). For other charting libraries, see [detailed instructions](#installation).
 
 ## Charts
 
@@ -151,7 +152,7 @@ Min and max values
 Min and max for x-axis - *Chart.js*
 
 ```erb
-<%= line_chart data, xmin: "2018-01-01", xmax: "2019-01-01" %>
+<%= line_chart data, xmin: "2021-01-01", xmax: "2022-01-01" %>
 ```
 
 Colors
@@ -208,12 +209,6 @@ Specify legend position
 <%= line_chart data, legend: "bottom" %>
 ```
 
-Defer chart creation until after the page loads
-
-```erb
-<%= line_chart data, defer: true %>
-```
-
 Donut chart
 
 ```erb
@@ -262,16 +257,22 @@ Show insignificant zeros, useful for currency - *Chart.js, Highcharts*
 <%= line_chart data, round: 2, zeros: true %>
 ```
 
-Friendly byte sizes - *Chart.js 2.8+*
+Friendly byte sizes - *Chart.js*
 
 ```erb
 <%= line_chart data, bytes: true %>
 ```
 
-Show a message when data is empty
+Specify the message when data is loading
+
+```erb
+<%= line_chart data, loading: "Loading..." %>
+```
+
+Specify the message when data is empty
 
 ```erb
-<%= line_chart data, messages: {empty: "No data"} %>
+<%= line_chart data, empty: "No data" %>
 ```
 
 Refresh data from a remote source every `n` seconds
@@ -310,7 +311,7 @@ Chartkick.options = {
 Customize the html
 
 ```ruby
-Chartkick.options[:html] = '<div id="%{id}" style="height: %{height};">Loading...</div>'
+Chartkick.options[:html] = '<div id="%{id}" style="height: %{height};">%{loading}</div>'
 ```
 
 You capture the JavaScript in a content block with:
@@ -350,7 +351,7 @@ For multiple series, use the format
 Times can be a time or a string (strings are parsed)
 
 ```erb
-<%= line_chart({20.day.ago => 5, "2013-05-07 00:00:00 UTC" => 7}) %>
+<%= line_chart({20.day.ago => 5, "2021-05-07 00:00:00 UTC" => 7}) %>
 ```
 
 ### Multiple Series
@@ -418,8 +419,6 @@ Next, choose your charting library.
 - [Google Charts](#google-charts)
 - [Highcharts](#highcharts)
 
-In the instructions below, `application.js` must be included **before** the charts in your views, unless using the `:content_for` option.
-
 ### Chart.js
 
 For Rails 6 / Webpacker, run:
@@ -431,8 +430,7 @@ yarn add chartkick chart.js
 And in `app/javascript/packs/application.js`, add:
 
 ```js
-require("chartkick")
-require("chart.js")
+require("chartkick/chart.js")
 ```
 
 For Rails 5 / Sprockets, in `app/assets/javascripts/application.js`, add:
@@ -487,7 +485,7 @@ yarn add chartkick highcharts
 And in `app/javascript/packs/application.js`, add:
 
 ```js
-require("chartkick").use(require("highcharts"))
+require("chartkick/highcharts")
 ```
 
 For Rails 5 / Sprockets, download [highcharts.js](https://code.highcharts.com/highcharts.js) into `vendor/assets/javascripts` (or use `yarn add highcharts` in Rails 5.1+), and in `app/assets/javascripts/application.js`, add:
@@ -505,6 +503,27 @@ Download [chartkick.js](https://raw.githubusercontent.com/ankane/chartkick/maste
 <script src="chartkick.js"></script>
 ```
 
+Then include the charting library.
+
+Chart.js - download [Chart.js](https://unpkg.com/chart.js@3/dist/chart.js) and the [date-fns adapter bundle](https://unpkg.com/chartjs-adapter-date-fns@2/dist/chartjs-adapter-date-fns.bundle.js)
+
+```html
+<script src="chart.js"></script>
+<script src="chartjs-adapter-date-fns.bundle.js"></script>
+```
+
+Google Charts
+
+```html
+<script src="https://www.gstatic.com/charts/loader.js"></script>
+```
+
+Highcharts - download [highcharts.js](https://code.highcharts.com/highcharts.js)
+
+```html
+<script src="highcharts.js"></script>
+```
+
 ### Multiple Libraries
 
 If more than one charting library is loaded, choose between them with:
@@ -593,19 +612,34 @@ Check out [chartkick.js](https://github.com/ankane/chartkick.js)
 
 ## Upgrading
 
-### 3.0
+### 4.0
 
-Breaking changes
+If you use Sprockets, update the gem and you’re good to go!
 
-- Removed support for Rails < 4.2
-- Removed chartkick.js from asset precompile (no longer needed)
-- Removed `xtype` option - numeric axes are automatically detected
-- Removed `window.Chartkick = {...}` way to set config - use `Chartkick.configure` instead
-- Removed support for the Google Charts jsapi loader - use loader.js instead
+If you use Webpacker, run:
 
-## Credits
+```sh
+yarn upgrade chartkick --latest
+```
+
+If you use Chart.js with Webpacker, also run:
 
-Chartkick uses [iso8601.js](https://github.com/Do/iso8601.js) to parse dates and times.
+```sh
+yarn upgrade chart.js --latest
+```
+
+And in `app/javascript/packs/application.js`, change:
+
+```js
+require("chartkick")
+require("chart.js")
+```
+
+to:
+
+```js
+require("chartkick/chart.js")
+```
 
 ## History
 

data/lib/chartkick/helper.rb

@@ -37,17 +37,22 @@ module Chartkick
 
     private
 
+    # don't break out options since need to merge with default options
     def chartkick_chart(klass, data_source, **options)
-      @chartkick_chart_id ||= 0
       options = chartkick_deep_merge(Chartkick.options, options)
+
+      @chartkick_chart_id ||= 0
       element_id = options.delete(:id) || "chart-#{@chartkick_chart_id += 1}"
+
       height = (options.delete(:height) || "300px").to_s
       width = (options.delete(:width) || "100%").to_s
       defer = !!options.delete(:defer)
+
       # content_for: nil must override default
       content_for = options.key?(:content_for) ? options.delete(:content_for) : Chartkick.content_for
 
-      nonce = options.delete(:nonce)
+      nonce = options.fetch(:nonce, true)
+      options.delete(:nonce)
       if nonce == true
         # Secure Headers also defines content_security_policy_nonce but it takes an argument
         # Rails 5.2 overrides this method, but earlier versions do not
@@ -57,34 +62,36 @@ module Chartkick
         elsif respond_to?(:content_security_policy_script_nonce)
           # Secure Headers
           nonce = content_security_policy_script_nonce
+        else
+          nonce = nil
         end
       end
       nonce_html = nonce ? " nonce=\"#{ERB::Util.html_escape(nonce)}\"" : nil
 
       # html vars
       html_vars = {
-        id: element_id
-      }
-      html_vars.each_key do |k|
-        html_vars[k] = ERB::Util.html_escape(html_vars[k])
-      end
-
-      # css vars
-      css_vars = {
+        id: element_id,
         height: height,
-        width: width
+        width: width,
+        # don't delete loading option since it needs to be passed to JS
+        loading: options[:loading] || "Loading..."
       }
-      css_vars.each_key do |k|
+
+      [:height, :width].each do |k|
         # limit to alphanumeric and % for simplicity
         # this prevents things like calc() but safety is the priority
         # dot does not need escaped in square brackets
-        raise ArgumentError, "Invalid #{k}" unless css_vars[k] =~ /\A[a-zA-Z0-9%.]*\z/
-        # we limit above, but escape for safety as fail-safe
+        raise ArgumentError, "Invalid #{k}" unless html_vars[k] =~ /\A[a-zA-Z0-9%.]*\z/
+      end
+
+      html_vars.each_key do |k|
+        # escape all variables
+        # we already limit height and width above, but escape for safety as fail-safe
         # to prevent XSS injection in worse-case scenario
-        css_vars[k] = ERB::Util.html_escape(css_vars[k])
+        html_vars[k] = ERB::Util.html_escape(html_vars[k])
       end
 
-      html = (options.delete(:html) || %(<div id="%{id}" style="height: %{height}; width: %{width}; text-align: center; color: #999; line-height: %{height}; font-size: 14px; font-family: 'Lucida Grande', 'Lucida Sans Unicode', Verdana, Arial, Helvetica, sans-serif;">Loading...</div>)) % html_vars.merge(css_vars)
+      html = (options.delete(:html) || %(<div id="%{id}" style="height: %{height}; width: %{width}; text-align: center; color: #999; line-height: %{height}; font-size: 14px; font-family: 'Lucida Grande', 'Lucida Sans Unicode', Verdana, Arial, Helvetica, sans-serif;">%{loading}</div>)) % html_vars
 
       # js vars
       js_vars = {
@@ -98,35 +105,33 @@ module Chartkick
       end
       createjs = "new Chartkick[%{type}](%{id}, %{data}, %{options});" % js_vars
 
-      if defer
-        # TODO remove type in 4.0
-        js = <<JS
-<script type="text/javascript"#{nonce_html}>
-  (function() {
-    var createChart = function() { #{createjs} };
-    if (window.addEventListener) {
-      window.addEventListener("load", createChart, true);
-    } else if (window.attachEvent) {
-      window.attachEvent("onload", createChart);
-    } else {
-      createChart();
-    }
-  })();
-</script>
-JS
-      else
-        # TODO remove type in 4.0
-        js = <<JS
-<script type="text/javascript"#{nonce_html}>
-  #{createjs}
-</script>
-JS
-      end
+      warn "[chartkick] The defer option is no longer needed and can be removed" if defer
+
+      # Turbolinks preview restores the DOM except for painted <canvas>
+      # since it uses cloneNode(true) - https://developer.mozilla.org/en-US/docs/Web/API/Node/
+      #
+      # don't rerun JS on preview to prevent
+      # 1. animation
+      # 2. loading data from URL
+      js = <<~JS
+        <script#{nonce_html}>
+          (function() {
+            if (document.documentElement.hasAttribute("data-turbolinks-preview")) return;
+
+            var createChart = function() { #{createjs} };
+            if ("Chartkick" in window) {
+              createChart();
+            } else {
+              window.addEventListener("chartkick:load", createChart, true);
+            }
+          })();
+        </script>
+      JS
 
       if content_for
         content_for(content_for) { js.respond_to?(:html_safe) ? js.html_safe : js }
       else
-        html += js
+        html += "\n#{js}"
       end
 
       html.respond_to?(:html_safe) ? html.html_safe : html

data/lib/chartkick/version.rb

@@ -1,3 +1,3 @@
 module Chartkick
-  VERSION = "3.4.1"
+  VERSION = "4.0.3"
 end

data/licenses/LICENSE-chart.js.txt

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright (c) 2014-2021 Chart.js Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/licenses/LICENSE-chartjs-adapter-date-fns.txt

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Chart.js Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/licenses/LICENSE-chartkick.js.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013-2021 Andrew Kane
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/licenses/LICENSE-date-fns.txt

@@ -0,0 +1,20 @@
+Copyright (C) 2020 Sasha Koss and Lesha Koss
+
+# License
+
+date-fns is licensed under the [MIT license](http://kossnocorp.mit-license.org).
+Read more about MIT at [TLDRLegal](https://tldrlegal.com/license/mit-license).
+
+---
+
+Text from http://kossnocorp.mit-license.org
+
+The MIT License (MIT)
+
+Copyright © 2021 Sasha Koss
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.