chartkick 4.2.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f2d2a4efa99cc9de5d1f4bafd419ebc3d56f25fd9ff58abcf6ae4a3bbad8751f
-  data.tar.gz: c2c6ce648f0d0bde544ef4a7191396ba499a2bdb9b4d8892a63c19a96152f083
+  metadata.gz: 0e3e26d84662ff0821322864aa4481daefc1c8a33c90210cf69fa3e2641122c1
+  data.tar.gz: 65098ca753ee49fa221f93dc24cd630bc007a0bfbe81885143287c3640f1f221
 SHA512:
-  metadata.gz: 3ddd0b4c49fc2f761937a884440ce3500442f5ff998650a45723371315813f253d9f49f8f2833821f2d550fa879a09d533ca807e5a1bc69bfb552c3aff91f0b7
-  data.tar.gz: 38ee5f44d26d5d3b17aa84272493f4fcb4c39eb6ec581813fc30364398db5ab08b85b79fd2320b2bfdb885f3a2880c9b7639f9b27f478ae00da2f82f385586ce
+  metadata.gz: 781b9376d0f979e0fee356b5f872bbe339d2975c1fd46833262bc16476f83e0e2dc0149452616915a4c5eab323022db901b416722146dc7982fdc1a71bdc7240
+  data.tar.gz: ff8d09974073e3b09555654770c6d42534d0dffd87271b5f79d6bc15b58a5cec6d9695d23541e69ac32cafb428790ddf0fb6f697f5631bf1a3dca5aa5d1da44b

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+## 5.0.0 (2022-01-18)
+
+- Added support for Chart.js 4
+- Changed `chart_json` to be defined on `Hash` and `Array` instead of `Enumerable`
+- Updated Chartkick.js to 5.0.0
+- Removed support for Chart.js 3
+- Removed support for Ruby < 2.7 and Rails < 6
+
+## 4.2.1 (2022-08-02)
+
+- Updated Chart.js to 3.9.0
+
 ## 4.2.0 (2022-06-12)
 
 - Updated Chartkick.js to 4.2.0

data/LICENSE.txt

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

data/README.md

@@ -4,6 +4,8 @@ Create beautiful JavaScript charts with one line of Ruby. No more fighting with
 
 [See it in action](https://chartkick.com)
 
+**Chartkick 5.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)
@@ -18,16 +20,16 @@ Add this line to your application’s Gemfile:
 gem "chartkick"
 ```
 
-Then follow the instructions for your framework:
+Then follow the instructions for your JavaScript setup:
 
-- [Rails 7 / Importmap](#rails-7--importmap)
-- [Rails 7 / esbuild or Webpack](#rails-7--esbuild-or-webpack)
-- [Rails 6 / Webpacker](#rails-6--webpacker)
-- [Rails 5 / Sprockets](#rails-5--sprockets)
+- [Importmap](#rails-7--importmap) (Rails 7 default)
+- [esbuild, rollup.js, or Webpack](#rails-7--esbuild-rollupjs-or-webpack)
+- [Webpacker](#rails-6--webpacker) (Rails 6 default)
+- [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
+### Importmap
 
 In `config/importmap.rb`, add:
 
@@ -43,7 +45,7 @@ import "chartkick"
 import "Chart.bundle"
 ```
 
-### Rails 7 / esbuild or Webpack
+### esbuild, rollup.js, or Webpack
 
 Run:
 
@@ -57,7 +59,9 @@ And in `app/javascript/application.js`, add:
 import "chartkick/chart.js"
 ```
 
-### Rails 6 / Webpacker
+Note: For rollup.js, this requires `format: "iife"` in `rollup.config.js`.
+
+### Webpacker
 
 Run:
 
@@ -71,7 +75,7 @@ And in `app/javascript/packs/application.js`, add:
 import "chartkick/chart.js"
 ```
 
-### Rails 5 / Sprockets
+### Sprockets
 
 In `app/assets/javascripts/application.js`, add:
 
@@ -447,7 +451,7 @@ gem "chartkick"
 
 Next, choose your charting library.
 
-- [Chart.js](#chart-js)
+- [Chart.js](#chartjs)
 - [Google Charts](#google-charts)
 - [Highcharts](#highcharts)
 
@@ -691,35 +695,22 @@ Check out [chartkick.js](https://github.com/ankane/chartkick.js)
 
 ## Upgrading
 
-### 4.0
+### 5.0
 
-If you use Sprockets, update the gem and you’re good to go!
+If you use Importmaps or Sprockets, update the gem and you’re good to go!
 
-If you use Webpacker, run:
+If you use esbuild, Webpack, or Webpacker, run:
 
 ```sh
 yarn upgrade chartkick --latest
 ```
 
-If you use Chart.js with Webpacker, also run:
+If you use Chart.js with esbuild, Webpack, or Webpacker, also run:
 
 ```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
 
 View the [changelog](https://github.com/ankane/chartkick/blob/master/CHANGELOG.md)

data/lib/chartkick/core_ext.rb

@@ -0,0 +1,26 @@
+# for both multiple series and
+# making sure hash order is preserved in JavaScript
+
+class Array
+  def chart_json
+    map do |v|
+      if v.is_a?(Hash) && v[:data].is_a?(Hash)
+        v = v.dup
+        v[:data] = v[:data].to_a
+      end
+      v
+    end.to_json
+  end
+end
+
+class Hash
+  def chart_json
+    if (key = keys.first) && key.is_a?(Array) && key.size == 2
+      group_by { |k, _v| k[0] }.map do |name, data|
+        {name: name, data: data.map { |k, v| [k[1], v] }}
+      end
+    else
+      to_a
+    end.to_json
+  end
+end

data/lib/chartkick/helper.rb

@@ -1,6 +1,3 @@
-require "json"
-require "erb"
-
 module Chartkick
   module Helper
     def line_chart(data_source, **options)
@@ -39,7 +36,7 @@ module Chartkick
 
     # don't break out options since need to merge with default options
     def chartkick_chart(klass, data_source, **options)
-      options = chartkick_deep_merge(Chartkick.options, options)
+      options = Chartkick::Utils.deep_merge(Chartkick.options, options)
 
       @chartkick_chart_id ||= 0
       element_id = options.delete(:id) || "chart-#{@chartkick_chart_id += 1}"
@@ -57,7 +54,7 @@ module Chartkick
         # Secure Headers also defines content_security_policy_nonce but it takes an argument
         # Rails 5.2 overrides this method, but earlier versions do not
         if respond_to?(:content_security_policy_nonce) && (content_security_policy_nonce rescue nil)
-          # Rails 5.2
+          # Rails 5.2+
           nonce = content_security_policy_nonce
         elsif respond_to?(:content_security_policy_script_nonce)
           # Secure Headers
@@ -101,7 +98,7 @@ module Chartkick
         options: options.to_json
       }
       js_vars.each_key do |k|
-        js_vars[k] = chartkick_json_escape(js_vars[k])
+        js_vars[k] = Chartkick::Utils.json_escape(js_vars[k])
       end
       createjs = "new Chartkick[%{type}](%{id}, %{data}, %{options});" % js_vars
 
@@ -137,26 +134,5 @@ module Chartkick
 
       html.respond_to?(:html_safe) ? html.html_safe : html
     end
-
-    # https://github.com/rails/rails/blob/master/activesupport/lib/active_support/core_ext/hash/deep_merge.rb
-    def chartkick_deep_merge(hash_a, hash_b)
-      hash_a = hash_a.dup
-      hash_b.each_pair do |k, v|
-        tv = hash_a[k]
-        hash_a[k] = tv.is_a?(Hash) && v.is_a?(Hash) ? chartkick_deep_merge(tv, v) : v
-      end
-      hash_a
-    end
-
-    # from https://github.com/rails/rails/blob/master/activesupport/lib/active_support/core_ext/string/output_safety.rb
-    JSON_ESCAPE = { "&" => '\u0026', ">" => '\u003e', "<" => '\u003c', "\u2028" => '\u2028', "\u2029" => '\u2029' }
-    JSON_ESCAPE_REGEXP = /[\u2028\u2029&><]/u
-    def chartkick_json_escape(s)
-      if ERB::Util.respond_to?(:json_escape)
-        ERB::Util.json_escape(s)
-      else
-        s.to_s.gsub(JSON_ESCAPE_REGEXP, JSON_ESCAPE)
-      end
-    end
   end
 end

data/lib/chartkick/utils.rb

@@ -0,0 +1,24 @@
+module Chartkick
+  module Utils
+    # https://github.com/rails/rails/blob/master/activesupport/lib/active_support/core_ext/hash/deep_merge.rb
+    def self.deep_merge(hash_a, hash_b)
+      hash_a = hash_a.dup
+      hash_b.each_pair do |k, v|
+        tv = hash_a[k]
+        hash_a[k] = tv.is_a?(Hash) && v.is_a?(Hash) ? deep_merge(tv, v) : v
+      end
+      hash_a
+    end
+
+    # from https://github.com/rails/rails/blob/master/activesupport/lib/active_support/core_ext/string/output_safety.rb
+    JSON_ESCAPE = { "&" => '\u0026', ">" => '\u003e', "<" => '\u003c', "\u2028" => '\u2028', "\u2029" => '\u2029' }
+    JSON_ESCAPE_REGEXP = /[\u2028\u2029&><]/u
+    def self.json_escape(s)
+      if ERB::Util.respond_to?(:json_escape)
+        ERB::Util.json_escape(s)
+      else
+        s.to_s.gsub(JSON_ESCAPE_REGEXP, JSON_ESCAPE)
+      end
+    end
+  end
+end

data/lib/chartkick/version.rb

@@ -1,3 +1,3 @@
 module Chartkick
-  VERSION = "4.2.0"
+  VERSION = "5.0.0"
 end

data/lib/chartkick.rb

@@ -1,11 +1,16 @@
+# stdlib
+require "erb"
+require "json"
+
 # modules
-require "chartkick/enumerable"
-require "chartkick/helper"
-require "chartkick/version"
+require_relative "chartkick/core_ext"
+require_relative "chartkick/helper"
+require_relative "chartkick/utils"
+require_relative "chartkick/version"
 
 # integrations
-require "chartkick/engine" if defined?(Rails)
-require "chartkick/sinatra" if defined?(Sinatra)
+require_relative "chartkick/engine" if defined?(Rails)
+require_relative "chartkick/sinatra" if defined?(Sinatra)
 
 if defined?(ActiveSupport.on_load)
   ActiveSupport.on_load(:action_view) do

data/licenses/LICENSE-kurkle-color.txt

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright (c) 2018-2021 Jukka Kurkela
+
+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.