chartkick 4.0.5 → 4.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ecf49f61e1962e1952df47113fea621bafe1bb423e50903ce98e1b6213c3c9cb
-  data.tar.gz: 29167dca418215178ea525061dc3113d186a53076ce77472241f54e99edc4b13
+  metadata.gz: 89ed1824ceea10158a8321a32e75daeb96dcb1eaeea839dc6f4eddd1de97cd88
+  data.tar.gz: 8c4a6ff2477b7314cec55237fbcfafe7e0b95efb4890a50925edb4eb095bb468
 SHA512:
-  metadata.gz: 4ba35050af1933c7d343125a291a515e26f6ae143b081d6346e0e709b920d299ff44a0f262559b1b358d778154b2a103132b751f9c37a905c5e789776bafca17
-  data.tar.gz: 3a3f5d3c57e7af61bcfc7b86d5888b4f2124b5e07fa86256eb7eb6298125b14c5a6293e926802ea3ac2d45a48fdf5fd222a2c47ba9ffb08209f8dc5768ad6000
+  metadata.gz: 5f6bedf2f1e49a194cdede42c1fb80d7dbf02a0d26955f0c0248b625736efc52269c966b3c8a50a0f3ba8bc5782bc7ad6843195a123fe6e9211026255305c825
+  data.tar.gz: 341942cf99eaf9a262d13b0abc8ca00898d88a2ac688a269bf932e6d0e365592a1ccca0f46bbc9e4ebca9fffcb9991853a8c4ea82448e73fe04b1847f12d5bd4

data/CHANGELOG.md

@@ -1,3 +1,24 @@
+## 4.1.3 (2022-01-15)
+
+- Support for `importmap-rails` is no longer experimental
+- Updated Chart.js to 3.7.0
+- Fixed asset precompilation error with `importmap-rails`
+
+## 4.1.2 (2021-11-06)
+
+- Removed automatic pinning for `importmap-rails` (still experimental)
+
+## 4.1.1 (2021-11-06)
+
+- Updated Chartkick.js to 4.1.1
+- Updated Chart.js to 3.6.0
+
+## 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

@@ -20,7 +20,33 @@ Add this line to your application’s Gemfile:
 gem "chartkick"
 ```
 
-For Rails 6 / Webpacker, run:
+Then follow the instructions for your framework:
+
+- [Rails 7 / Importmap](#rails-7--importmap)
+- [Rails 6 / Webpacker](#rails-6--webpacker)
+- [Rails 5 / Sprockets](#rails-5--sprockets)
+
+This sets up Chartkick with [Chart.js](https://www.chartjs.org/). For other charting libraries and frameworks, see [detailed instructions](#installation).
+
+### Rails 7 / Importmap
+
+In `config/importmap.rb`, add:
+
+```ruby
+pin "chartkick", to: "chartkick.js"
+pin "Chart.bundle", to: "Chart.bundle.js"
+```
+
+And in `app/javascript/application.js`, add:
+
+```js
+import "chartkick"
+import "Chart.bundle"
+```
+
+### Rails 6 / Webpacker
+
+Run:
 
 ```sh
 yarn add chartkick chart.js
@@ -32,15 +58,15 @@ And in `app/javascript/packs/application.js`, add:
 import "chartkick/chart.js"
 ```
 
-For Rails 5 / Sprockets, in `app/assets/javascripts/application.js`, add:
+### Rails 5 / Sprockets
+
+In `app/assets/javascripts/application.js`, add:
 
 ```js
 //= require chartkick
 //= require Chart.bundle
 ```
 
-This sets up Chartkick with [Chart.js](https://www.chartjs.org/). For other charting libraries, see [detailed instructions](#installation).
-
 ## Charts
 
 Line chart
@@ -98,9 +124,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 +136,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 +176,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 +373,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:
@@ -421,6 +440,20 @@ Next, choose your charting library.
 
 ### Chart.js
 
+For Rails 7 / Importmap, in `config/importmap.rb`, add:
+
+```ruby
+pin "chartkick", to: "chartkick.js"
+pin "Chart.bundle", to: "Chart.bundle.js"
+```
+
+And in `app/javascript/application.js`, add:
+
+```js
+import "chartkick"
+import "Chart.bundle"
+```
+
 For Rails 6 / Webpacker, run:
 
 ```sh
@@ -448,6 +481,18 @@ In your layout or views, add:
 <%= javascript_include_tag "https://www.gstatic.com/charts/loader.js" %>
 ```
 
+For Rails 7 / Importmap, in `config/importmap.rb`, add:
+
+```ruby
+pin "chartkick", to: "chartkick.js"
+```
+
+And in `app/javascript/application.js`, add:
+
+```js
+import "chartkick"
+```
+
 For Rails 6 / Webpacker, run:
 
 ```sh
@@ -476,6 +521,27 @@ before your charts.
 
 ### Highcharts
 
+For Rails 7 / Importmap, run:
+
+```sh
+bin/importmap pin highcharts --download
+```
+
+And in `config/importmap.rb`, add:
+
+```ruby
+pin "chartkick", to: "chartkick.js"
+```
+
+And in `app/javascript/application.js`, add:
+
+```js
+import "chartkick"
+import Highcharts from "highcharts"
+
+window.Highcharts = Highcharts
+```
+
 For Rails 6 / Webpacker, run:
 
 ```sh

data/lib/chartkick/engine.rb

@@ -1,5 +1,13 @@
 module Chartkick
   class Engine < ::Rails::Engine
     # for assets
+
+    # for importmap
+    initializer "chartkick.importmap" do |app|
+      if defined?(Importmap)
+        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.3"
 end

data/licenses/LICENSE-date-fns.txt

@@ -1,20 +1,21 @@
-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.
+MIT License
+
+Copyright (c) 2021 Sasha Koss and Lesha Koss https://kossnocorp.mit-license.org
+
+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.