chartkick 2.3.5 → 3.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d37a995b1d870a7e93be5d5eb338d163e1b42653304baab7bad889aff6f655fe
-  data.tar.gz: 9c5495a74d4e6c03b199a263556d9dcee91ee4e0c87fb7694851971068a817e2
+  metadata.gz: 7f0229f1e93dc1d2b672317f7147394f8a17e4fb42bb1ab2c979a1ac5b67a0e7
+  data.tar.gz: c8229ee28b9bbcfbc61c971a39e67415295cdd8043b25cfac1fa5ef992981cf9
 SHA512:
-  metadata.gz: e2e350cf8f342a7d55bfbc0a6581c92e25b4a59442719ef12aa32400ba9610b137360a10535a96afa049025a739235f28b00ade4299ad1cad5d2f9525ea1517d
-  data.tar.gz: 3de86761cb1f9e63d71589640827cc8391c668b398f9e49cdf4f4029351850181cc4e8197d8c6c341b6e7d79147ee01d96be6cf72b55ccca1f1395f4504d951e
+  metadata.gz: dce86c2e3bcf36e4c1c104e1446076cc7086563cefb12968355f236bece5460034b4e076ed98fc64f9453f6abc10b6c38287caeaef84ba0bd00566f3de0b6fe1
+  data.tar.gz: a2774bde5c45e347d532720b14c9ee4ed04136d379796355339e6ba5b56194a98916bee56308a3e16252afdea50110a843e4e63b783db9712d20cfaf502f8113

data/CHANGELOG.md

@@ -1,52 +1,120 @@
-## 2.3.5
+## 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
+
+## 3.4.0 (2020-08-04)
+
+- Fixed CSS injection with `width` and `height` options - [more info](https://github.com/ankane/chartkick/issues/546)
+
+## 3.3.2 (2020-07-23)
+
+- Updated Chartkick.js to 3.2.1
+
+## 3.3.1 (2019-12-26)
+
+- Updated Chart.js to 2.9.3
+- Fixed deprecation warnings in Ruby 2.7
+
+## 3.3.0 (2019-11-09)
+
+- Updated Chartkick.js to 3.2.0
+- Rolled back Chart.js to 2.8.0 due to legend change
+
+## 3.2.2 (2019-10-27)
+
+- Updated Chartkick.js to 3.1.3
+- Updated Chart.js to 2.9.1
+
+## 3.2.1 (2019-07-15)
+
+- Updated Chartkick.js to 3.1.1
+
+## 3.2.0 (2019-06-04)
+
+- Fixed XSS vulnerability - [more info](https://github.com/ankane/chartkick/issues/488)
+
+## 3.1.0 (2019-05-26)
+
+- Updated Chartkick.js to 3.1.0
+- Updated Chart.js to 2.8.0
+
+## 3.0.2 (2019-01-03)
+
+- Fixed error with `nonce` option with Secure Headers and Rails < 5.2
+- Updated Chartkick.js to 3.0.2
+- Updated Chart.js to 2.7.3
+
+## 3.0.1 (2018-08-13)
+
+- Updated Chartkick.js to 3.0.1
+
+## 3.0.0 (2018-08-08)
+
+- Updated Chartkick.js to 3.0.0
+- Added `code` option
+- Added support for `nonce: true`
+
+Breaking changes
+
+- 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
+
+## 2.3.5 (2018-06-15)
 
 - Updated Chartkick.js to 2.3.6
 
-## 2.3.4
+## 2.3.4 (2018-04-10)
 
 - Updated Chartkick.js to 2.3.5
 - Updated Chart.js to 2.7.2
 
-## 2.3.3
+## 2.3.3 (2018-03-25)
 
 - Updated Chartkick.js to 2.3.4
 
-## 2.3.2
+## 2.3.2 (2018-02-26)
 
 - Updated Chartkick.js to 2.3.3
 
-## 2.3.1
+## 2.3.1 (2018-02-23)
 
 - Updated Chartkick.js to 2.3.1
 
-## 2.3.0
+## 2.3.0 (2018-02-21)
 
 - Fixed deep merge error for non-Rails apps
 - Updated Chartkick.js to 2.3.0
 
-## 2.2.5
+## 2.2.5 (2017-10-28)
 
 - Updated Chart.js to 2.7.1
 
-## 2.2.4
+## 2.2.4 (2017-05-14)
 
 - Added compatibility with Rails API
 - Updated Chartkick.js to 2.2.4
 
-## 2.2.3
+## 2.2.3 (2017-02-22)
 
 - Updated Chartkick.js to 2.2.3
 - Updated Chart.js to 2.5.0
 
-## 2.2.2
+## 2.2.2 (2017-01-07)
 
 - Updated Chartkick.js to 2.2.2
 
-## 2.2.1
+## 2.2.1 (2016-12-05)
 
 - Updated Chartkick.js to 2.2.1
 
-## 2.2.0
+## 2.2.0 (2016-12-03)
 
 - Updated Chartkick.js to 2.2.0
 - Improved JavaScript API
@@ -54,59 +122,59 @@
 - Added `refresh` option
 - Added `donut` option to pie chart
 
-## 2.1.3
+## 2.1.3 (2016-11-29)
 
 - Updated Chartkick.js to 2.1.2 - fixes missing zero values for Chart.js
 
-## 2.1.2
+## 2.1.2 (2016-11-28)
 
 - Added `defer` option
 - Added `nonce` option
 - Updated Chartkick.js to 2.1.1
 
-## 2.1.1
+## 2.1.1 (2016-09-11)
 
 - Use custom version of Chart.js to fix label overlap
 
-## 2.1.0
+## 2.1.0 (2016-09-10)
 
 - Added basic support for new Google Charts loader
 - Added `configure` function
 - Dropped jQuery and Zepto dependencies for AJAX
 - Updated Chart.js to 2.2.2
 
-## 2.0.2
+## 2.0.2 (2016-08-11)
 
 - Updated Chartkick.js to 2.0.1
 - Updated Chart.js to 2.2.1
 
-## 2.0.1
+## 2.0.1 (2016-07-29)
 
 - Small Chartkick.js fixes
 - Updated Chart.js to 2.2.0
 
-## 2.0.0
+## 2.0.0 (2016-05-30)
 
 - Chart.js is now the default adapter - yay open source!
 - Axis types are automatically detected - no need for `discrete: true`
 - Better date support
 - New JavaScript API
 
-## 1.5.2
+## 1.5.2 (2016-05-05)
 
 - Fixed Sprockets error
 
-## 1.5.1
+## 1.5.1 (2016-05-03)
 
 - Updated chartkick.js to latest version
 - Included `Chart.bundle.js`
 
-## 1.5.0
+## 1.5.0 (2016-05-01)
 
 - Added Chart.js adapter **beta**
 - Fixed line height on timeline charts
 
-## 1.4.2
+## 1.4.2 (2016-02-29)
 
 - Added `width` option
 - Added `label` option
@@ -115,86 +183,86 @@
 - Better tooltip for dates for Google Charts
 - Fixed asset precompilation issue with Rails 5
 
-## 1.4.1
+## 1.4.1 (2015-09-07)
 
 - Fixed regression with `min: nil`
 
-## 1.4.0
+## 1.4.0 (2015-08-31)
 
 - Added scatter chart
 - Added axis titles
 
-## 1.3.2
+## 1.3.2 (2014-07-04)
 
 - Fixed `except` error when not using Rails
 
-## 1.3.1
+## 1.3.1 (2014-06-30)
 
 - Fixed blank screen bug
 - Fixed language support
 
-## 1.3.0
+## 1.3.0 (2014-06-28)
 
 - Added timelines
 
-## 1.2.5
+## 1.2.5 (2014-06-12)
 
 - Added support for multiple groups
 - Added `html` option
 
-## 1.2.4
+## 1.2.4 (2014-03-24)
 
 - Added global options
 - Added `colors` option
 
-## 1.2.3
+## 1.2.3 (2014-03-23)
 
 - Added geo chart
 - Added `discrete` option
 
-## 1.2.2
+## 1.2.2 (2014-02-23)
 
 - Added global `content_for` option
 - Added `stacked` option
 
-## 1.2.1
+## 1.2.1 (2013-12-08)
 
 - Added localization for Google Charts
 
-## 1.2.0
+## 1.2.0 (2013-07-27)
 
 - Added bar chart and area chart
 - Resize Google Charts on window resize
 
-## 1.1.3
+## 1.1.3 (2013-06-26)
 
 - Added content_for option
 
-## 1.1.2
+## 1.1.2 (2013-06-11)
 
 - Updated chartkick.js to v1.0.1
 
-## 1.1.1
+## 1.1.1 (2013-06-10)
 
 - Added support for Sinatra
 
-## 1.1.0
+## 1.1.0 (2013-06-03)
 
 - Added support for Padrino and Rails 2.3+
 
-## 1.0.1
+## 1.0.1 (2013-05-23)
 
 - Updated chartkick.js to v1.0.1
 
-## 1.0.0
+## 1.0.0 (2013-05-15)
 
 - Use semantic versioning (no changes)
 
-## 0.0.5
+## 0.0.5 (2013-05-14)
 
 - Removed `:min => 0` default for charts with negative values
 - Show legend when data given in `{:name => "", :data => {}}` format
 
-## 0.0.4
+## 0.0.4 (2013-05-13)
 
 - Fix for `Uncaught ReferenceError: Chartkick is not defined` when chartkick.js is included in the `<head>`

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2013-2018 Andrew Kane
+Copyright (c) 2013-2020 Andrew Kane
 
 MIT License
 

data/README.md

@@ -2,12 +2,44 @@
 
 Create beautiful JavaScript charts with one line of Ruby. No more fighting with charting libraries!
 
-[See it in action](https://www.chartkick.com)
+[See it in action](https://chartkick.com)
 
-:fire: For admin charts and dashboards, check out [Blazer](https://github.com/ankane/blazer/)
+: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)
+
+## Quick Start
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "chartkick"
+```
+
+For Rails 6 / Webpacker, run:
+
+```sh
+yarn add chartkick chart.js
+```
+
+And in `app/javascript/packs/application.js`, add:
+
+```js
+require("chartkick")
+require("chart.js")
+```
+
+For Rails 5 / Sprockets, in `app/assets/javascripts/application.js`, add:
+
+```js
+//= require chartkick
+//= require Chart.bundle
+```
+
+This sets up Chartkick with Chart.js. For other charting libraries, see [detailed instructions](#installation).
+
 ## Charts
 
 Line chart
@@ -116,6 +148,12 @@ Min and max values
 
 `min` defaults to 0 for charts with non-negative values. Use `nil` to let the charting library decide.
 
+Min and max for x-axis - *Chart.js*
+
+```erb
+<%= line_chart data, xmin: "2018-01-01", xmax: "2019-01-01" %>
+```
+
 Colors
 
 ```erb
@@ -206,6 +244,30 @@ Set a decimal separator - *Chart.js, Highcharts*
 <%= line_chart data, decimal: "," %>
 ```
 
+Set significant digits - *Chart.js, Highcharts*
+
+```erb
+<%= line_chart data, precision: 3 %>
+```
+
+Set rounding - *Chart.js, Highcharts*
+
+```erb
+<%= line_chart data, round: 2 %>
+```
+
+Show insignificant zeros, useful for currency - *Chart.js, Highcharts*
+
+```erb
+<%= line_chart data, round: 2, zeros: true %>
+```
+
+Friendly byte sizes - *Chart.js 2.8+*
+
+```erb
+<%= line_chart data, bytes: true %>
+```
+
 Show a message when data is empty
 
 ```erb
@@ -257,18 +319,19 @@ You capture the JavaScript in a content block with:
 Chartkick.options[:content_for] = :charts_js
 ```
 
-Then, in your layout:
+Then, in your layout, use:
 
 ```erb
-<%= yield :charts_js %> <!-- Rails -->
-<%= yield_content :charts_js %> <!-- Padrino -->
+<%= yield :charts_js %>
 ```
 
+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
+Pass data as a hash or array
 
 ```erb
 <%= pie_chart({"Football" => 10, "Basketball" => 5}) %>
@@ -284,12 +347,33 @@ For multiple series, use the format
 ] %>
 ```
 
-Times can be a time, a timestamp, or a string (strings are parsed)
+Times can be a time or a string (strings are parsed)
 
 ```erb
-<%= line_chart({20.day.ago => 5, 1368174456 => 4, "2013-05-07 00:00:00 UTC" => 7}) %>
+<%= line_chart({20.day.ago => 5, "2013-05-07 00:00:00 UTC" => 7}) %>
 ```
 
+### Multiple Series
+
+You can pass a few options with a series:
+
+- `name`
+- `data`
+- `color`
+- `dataset` - *Chart.js only*
+- `points` - *Chart.js only*
+- `curve` - *Chart.js only*
+
+### Code
+
+If you want to use the charting library directly, get the code with:
+
+```erb
+<%= line_chart data, code: true %>
+```
+
+The code will be logged to the JavaScript console. JavaScript functions cannot be logged, so it may not be identical.
+
 ### Download Charts
 
 *Chart.js only*
@@ -300,13 +384,25 @@ Give users the ability to download charts. It all happens in the browser - no se
 <%= line_chart data, download: true %>
 ```
 
+Safari will open the image in a new window instead of downloading.
+
 Set the filename
 
 ```erb
-<%= line_chart data, download: "boom" %>
+<%= line_chart data, download: {filename: "boom"} %>
 ```
 
-**Note:** Safari will open the image in a new window instead of downloading.
+Set the background color
+
+```erb
+<%= line_chart data, download: {background: "#ffffff"} %>
+```
+
+Set title
+
+```erb
+<%= line_chart data, title: "Awesome chart" %>
+```
 
 ## Installation
 
@@ -318,91 +414,116 @@ gem "chartkick"
 
 Next, choose your charting library.
 
-### Charting Libraries
+- [Chart.js](#chart-js)
+- [Google Charts](#google-charts)
+- [Highcharts](#highcharts)
 
-**Note:** In the instructions below, `application.js` must be included **before** the charts in your views, unless using the `:content_for` option.
+In the instructions below, `application.js` must be included **before** the charts in your views, unless using the `:content_for` option.
 
-#### Chart.js
+### Chart.js
 
-In `application.js`, add:
+For Rails 6 / Webpacker, run:
 
-```js
-//= require Chart.bundle
-//= require chartkick
+```sh
+yarn add chartkick chart.js
 ```
 
-#### Google Charts
+And in `app/javascript/packs/application.js`, add:
+
+```js
+require("chartkick")
+require("chart.js")
+```
 
-In `application.js`, add:
+For Rails 5 / Sprockets, in `app/assets/javascripts/application.js`, add:
 
 ```js
 //= require chartkick
+//= require Chart.bundle
 ```
 
-In your views, before `application.js`, add:
+### Google Charts
+
+In your layout or views, add:
 
 ```erb
 <%= javascript_include_tag "https://www.gstatic.com/charts/loader.js" %>
 ```
 
-#### Highcharts
+For Rails 6 / Webpacker, run:
 
-Download [highcharts.js](https://code.highcharts.com/highcharts.js) into `vendor/assets/javascripts` (or use `yarn add highcharts` in Rails 5.1+).
+```sh
+yarn add chartkick
+```
 
-In `application.js`, add:
+And in `app/javascript/packs/application.js`, add:
 
 ```js
-//= require highcharts
-//= require chartkick
+require("chartkick")
 ```
 
-Works with Highcharts 2.1+
+For Rails 5 / Sprockets, in `app/assets/javascripts/application.js`, add:
 
-### Webpacker
+```js
+//= require chartkick
+```
 
-For Webpacker, use Yarn to install the JavaScript libraries:
+To specify a language or Google Maps API key, use:
 
-```sh
-yarn add chartkick chart.js # or highcharts
+```js
+Chartkick.configure({language: "de", mapsApiKey: "..."})
 ```
 
-Then include them in your pack.
+before your charts.
+
+### Highcharts
 
-```es6
-import Chartkick from "chartkick";
-window.Chartkick = Chartkick;
+For Rails 6 / Webpacker, run:
 
-// for Chart.js
-import Chart from "chart.js";
-Chartkick.addAdapter(Chart);
+```sh
+yarn add chartkick highcharts
+```
 
-// for Highcharts
-import Highcharts from "highcharts";
-Chartkick.addAdapter(Highcharts);
+And in `app/javascript/packs/application.js`, add:
 
-// for Google Charts
-// just include https://www.gstatic.com/charts/loader.js in your views
+```js
+require("chartkick").use(require("highcharts"))
 ```
 
-You pack must be included **before** the charts in your views, unless using the `:content_for` option.
+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:
+
+```js
+//= require chartkick
+//= require highcharts
+```
 
 ### Sinatra and Padrino
 
-You must include `chartkick.js` manually. [Download it here](https://raw.githubusercontent.com/ankane/chartkick/master/vendor/assets/javascripts/chartkick.js)
+Download [chartkick.js](https://raw.githubusercontent.com/ankane/chartkick/master/vendor/assets/javascripts/chartkick.js) and include it manually.
 
 ```html
 <script src="chartkick.js"></script>
 ```
 
-### Localization
+Then include the charting library.
 
-To specify a language for Google Charts, add:
+Chart.js - download [Chart.bundle.js](https://unpkg.com/chart.js@2/dist/Chart.bundle.js)
 
-```javascript
-Chartkick.configure({language: "de"});
+```html
+<script src="Chart.bundle.js"></script>
 ```
 
-after the JavaScript files and before your charts.
+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
 
@@ -461,6 +582,12 @@ Redraw the chart with:
 chart.redraw()
 ```
 
+Destroy the chart with:
+
+```javascript
+chart.destroy()
+```
+
 Loop over charts with:
 
 ```javascript
@@ -469,6 +596,10 @@ Chartkick.eachChart( function(chart) {
 })
 ```
 
+## Content Security Policy (CSP)
+
+Check out [how to configure CSP](https://github.com/ankane/chartkick/blob/master/guides/Content-Security-Policy.md)
+
 ## No Ruby? No Problem
 
 Check out [chartkick.js](https://github.com/ankane/chartkick.js)
@@ -476,18 +607,21 @@ Check out [chartkick.js](https://github.com/ankane/chartkick.js)
 ## Tutorials
 
 - [Charts with Chartkick and Groupdate](https://gorails.com/episodes/charts-with-chartkick-and-groupdate)
+- [Creando gráficos en Ruby on Rails con Chartkick y Chart.js](https://www.youtube.com/watch?v=W92AlkwQn3M)
 - [Make Easy Graphs and Charts on Rails with Chartkick](https://www.sitepoint.com/make-easy-graphs-and-charts-on-rails-with-chartkick/)
 - [Practical Graphs on Rails: Chartkick in Practice](https://www.sitepoint.com/graphs-on-rails-chartkick-in-practice/)
 
 ## Upgrading
 
-### 2.0
+### 3.0
 
 Breaking changes
 
-- Chart.js is now the default adapter if multiple are loaded - yay open source!
-- Axis types are automatically detected - no need for `discrete: true`
-- Better date support - dates are no longer treated as UTC
+- 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
 
 ## Credits
 
@@ -497,8 +631,6 @@ Chartkick uses [iso8601.js](https://github.com/Do/iso8601.js) to parse dates and
 
 View the [changelog](https://github.com/ankane/chartkick/blob/master/CHANGELOG.md)
 
-Chartkick follows [Semantic Versioning](https://semver.org/)
-
 ## Contributing
 
 Everyone is encouraged to help improve this project. Here are a few ways you can help:
@@ -507,3 +639,12 @@ Everyone is encouraged to help improve this project. Here are a few ways you can
 - Fix bugs and [submit pull requests](https://github.com/ankane/chartkick/pulls)
 - Write, clarify, or fix documentation
 - Suggest or add new features
+
+To get started with development:
+
+```sh
+git clone https://github.com/ankane/chartkick.git
+cd chartkick
+bundle install
+bundle exec rake test
+```