chartkick 4.0.5 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ecf49f61e1962e1952df47113fea621bafe1bb423e50903ce98e1b6213c3c9cb
-  data.tar.gz: 29167dca418215178ea525061dc3113d186a53076ce77472241f54e99edc4b13
+  metadata.gz: ea8884a2d48b14492533dfb048fceba992f579b711d02576df6d998188068d6c
+  data.tar.gz: 1b918716b088e33d8a58e4bcb1669f79de634b8103ecef7d71c205a712eea0e6
 SHA512:
-  metadata.gz: 4ba35050af1933c7d343125a291a515e26f6ae143b081d6346e0e709b920d299ff44a0f262559b1b358d778154b2a103132b751f9c37a905c5e789776bafca17
-  data.tar.gz: 3a3f5d3c57e7af61bcfc7b86d5888b4f2124b5e07fa86256eb7eb6298125b14c5a6293e926802ea3ac2d45a48fdf5fd222a2c47ba9ffb08209f8dc5768ad6000
+  metadata.gz: afeb7f5d6339440e986b33e12130bb06e58c54eb1044cd30cbd4773efe01afe1ee376356fdca8659352290d36ec5d2d0169d023c698bd2e6f5a416409b91f9de
+  data.tar.gz: 4a09e32c9a78eec5c3e0fd7bdd50badde15bb19831786cd3541a9920eb8c5407bebd8fd6752ad30a00ce7a067f5bbdaa88cb017f1ba29b8f73039d749ff51d4e

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 4.1.0 (2021-10-23)
+
+- Added support for Turbo
+- Added experimental support for `importmap-rails`
+- Updated Chartkick.js to 4.1.0
+
 ## 4.0.5 (2021-07-07)
 
 - Updated Chartkick.js to 4.0.5

data/README.md

@@ -39,6 +39,13 @@ For Rails 5 / Sprockets, in `app/assets/javascripts/application.js`, add:
 //= require Chart.bundle
 ```
 
+For Rails 7 / Importmap (experimental), in `app/javascript/application.js`, add:
+
+```js
+import "chartkick"
+import "Chart.bundle"
+```
+
 This sets up Chartkick with [Chart.js](https://www.chartjs.org/). For other charting libraries, see [detailed instructions](#installation).
 
 ## Charts
@@ -98,9 +105,10 @@ Timeline - *Google Charts*
 Multiple series
 
 ```erb
-<%= line_chart @goals.map { |goal|
-    {name: goal.name, data: goal.feats.group_by_week(:created_at).count}
-} %>
+<%= line_chart [
+  {name: "Workout", data: {"2021-01-01" => 3, "2021-01-02" => 4}},
+  {name: "Call parents", data: {"2021-01-01" => 5, "2021-01-02" => 3}}
+] %>
 ```
 
 or
@@ -109,7 +117,23 @@ or
 <%= line_chart Feat.group(:goal_id).group_by_week(:created_at).count %>
 ```
 
-### Say Goodbye To Timeouts
+## Data
+
+Data can be a hash, array, or URL.
+
+#### Hash
+
+```erb
+<%= line_chart({"2021-01-01" => 2, "2021-01-02" => 3}) %>
+```
+
+#### Array
+
+```erb
+<%= line_chart [["2021-01-01", 2], ["2021-01-02", 3]] %>
+```
+
+#### URL
 
 Make your pages load super fast and stop worrying about timeouts. Give each chart its own endpoint.
 
@@ -133,7 +157,7 @@ For multiple series, add `chart_json` at the end.
 render json: Task.group(:goal_id).group_by_day(:completed_at).count.chart_json
 ```
 
-### Options
+## Options
 
 Id, width, and height
 
@@ -330,30 +354,6 @@ For Padrino, use `yield_content` instead of `yield`.
 
 This is great for including all of your JavaScript at the bottom of the page.
 
-### Data
-
-Pass data as a hash or array
-
-```erb
-<%= pie_chart({"Football" => 10, "Basketball" => 5}) %>
-<%= pie_chart [["Football", 10], ["Basketball", 5]] %>
-```
-
-For multiple series, use the format
-
-```erb
-<%= line_chart [
-  {name: "Series A", data: series_a},
-  {name: "Series B", data: series_b}
-] %>
-```
-
-Times can be a time or a string (strings are parsed)
-
-```erb
-<%= line_chart({20.day.ago => 5, "2021-05-07 00:00:00 UTC" => 7}) %>
-```
-
 ### Multiple Series
 
 You can pass a few options with a series:
@@ -440,6 +440,13 @@ For Rails 5 / Sprockets, in `app/assets/javascripts/application.js`, add:
 //= require Chart.bundle
 ```
 
+For Rails 7 / Importmap (experimental), in `app/javascript/application.js`, add:
+
+```js
+import "chartkick"
+import "Chart.bundle"
+```
+
 ### Google Charts
 
 In your layout or views, add:
@@ -466,6 +473,12 @@ For Rails 5 / Sprockets, in `app/assets/javascripts/application.js`, add:
 //= require chartkick
 ```
 
+For Rails 7 / Importmap (experimental), in `app/javascript/application.js`, add:
+
+```js
+import "chartkick"
+```
+
 To specify a language or Google Maps API key, use:
 
 ```js
@@ -495,6 +508,21 @@ For Rails 5 / Sprockets, download [highcharts.js](https://code.highcharts.com/hi
 //= require highcharts
 ```
 
+For Rails 7 / Importmap (experimental), run:
+
+```sh
+bin/importmap pin highcharts --download
+```
+
+And in `app/javascript/application.js`, add:
+
+```js
+import "chartkick"
+import Highcharts from "highcharts"
+
+window.Highcharts = Highcharts
+```
+
 ### Sinatra and Padrino
 
 Download [chartkick.js](https://raw.githubusercontent.com/ankane/chartkick/master/vendor/assets/javascripts/chartkick.js) and include it manually.

data/config/importmap.rb

@@ -0,0 +1 @@
+pin_all_from File.expand_path("../vendor/assets/javascripts", __dir__)

data/lib/chartkick/engine.rb

@@ -1,5 +1,14 @@
 module Chartkick
   class Engine < ::Rails::Engine
     # for assets
+
+    # for importmap
+    if defined?(Importmap)
+      initializer "chartkick.importmap", after: "importmap" do |app|
+        app.importmap.draw(Engine.root.join("config/importmap.rb"))
+        app.config.assets.precompile << "chartkick.js"
+        app.config.assets.precompile << "Chart.bundle.js"
+      end
+    end
   end
 end

data/lib/chartkick/helper.rb

@@ -117,6 +117,7 @@ module Chartkick
         <script#{nonce_html}>
           (function() {
             if (document.documentElement.hasAttribute("data-turbolinks-preview")) return;
+            if (document.documentElement.hasAttribute("data-turbo-preview")) return;
 
             var createChart = function() { #{createjs} };
             if ("Chartkick" in window) {

data/lib/chartkick/version.rb

@@ -1,3 +1,3 @@
 module Chartkick
-  VERSION = "4.0.5"
+  VERSION = "4.1.0"
 end

data/vendor/assets/javascripts/chartkick.js

@@ -2,7 +2,7 @@
  * Chartkick.js
  * Create beautiful charts with one line of JavaScript
  * https://github.com/ankane/chartkick.js
- * v4.0.5
+ * v4.1.0
  * MIT License
  */
 
@@ -2495,6 +2495,9 @@
     document.addEventListener("turbolinks:before-render", function() {
       Chartkick.destroyAll();
     });
+    document.addEventListener("turbo:before-render", function() {
+      Chartkick.destroyAll();
+    });
 
     // use setTimeout so charting library can come later in same JS file
     setTimeout(function() {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chartkick
 version: !ruby/object:Gem::Version
-  version: 4.0.5
+  version: 4.1.0
 platform: ruby
 authors:
 - Andrew Kane
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-07 00:00:00.000000000 Z
+date: 2021-10-23 00:00:00.000000000 Z
 dependencies: []
 description:
 email: andrew@ankane.org
@@ -19,6 +19,7 @@ files:
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
+- config/importmap.rb
 - lib/chartkick.rb
 - lib/chartkick/engine.rb
 - lib/chartkick/enumerable.rb
@@ -50,7 +51,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: Create beautiful JavaScript charts with one line of Ruby