chartkickm 3.0.4

data/README.md

@@ -0,0 +1,582 @@
+# Chartkick
+
+Create beautiful JavaScript charts with one line of Ruby. No more fighting with charting libraries!
+
+[See it in action](https://chartkick.com)
+
+:fire: For admin charts and dashboards, check out [Blazer](https://github.com/ankane/blazer/)
+
+: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)
+
+---
+
+Have a minute? Take the [2019 Chartkick Survey](https://goo.gl/forms/x1Ic62QTKloUV95i1)
+
+---
+
+## Quick Start
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "chartkick"
+```
+
+In `application.js`, add:
+
+```js
+//= require Chart.bundle
+//= require chartkick
+```
+
+This sets up Chartkick with Chart.js. For other charting libraries, see [detailed instructions](#installation).
+
+## Charts
+
+Line chart
+
+```erb
+<%= line_chart User.group_by_day(:created_at).count %>
+```
+
+Pie chart
+
+```erb
+<%= pie_chart Goal.group(:name).count %>
+```
+
+Column chart
+
+```erb
+<%= column_chart Task.group_by_hour_of_day(:created_at, format: "%l %P").count %>
+```
+
+Bar chart
+
+```erb
+<%= bar_chart Shirt.group(:size).sum(:price) %>
+```
+
+Area chart
+
+```erb
+<%= area_chart Visit.group_by_minute(:created_at).maximum(:load_time) %>
+```
+
+Scatter chart
+
+```erb
+<%= scatter_chart City.pluck(:size, :population) %>
+```
+
+Geo chart - *Google Charts*
+
+```erb
+<%= geo_chart Medal.group(:country).count %>
+```
+
+Timeline - *Google Charts*
+
+```erb
+<%= timeline [
+  ["Washington", "1789-04-29", "1797-03-03"],
+  ["Adams", "1797-03-03", "1801-03-03"],
+  ["Jefferson", "1801-03-03", "1809-03-03"]
+] %>
+```
+
+Multiple series
+
+```erb
+<%= line_chart @goals.map { |goal|
+    {name: goal.name, data: goal.feats.group_by_week(:created_at).count}
+} %>
+```
+
+or
+
+```erb
+<%= line_chart Feat.group(:goal_id).group_by_week(:created_at).count %>
+```
+
+### Say Goodbye To Timeouts
+
+Make your pages load super fast and stop worrying about timeouts. Give each chart its own endpoint.
+
+```erb
+<%= line_chart completed_tasks_charts_path %>
+```
+
+And in your controller, pass the data as JSON.
+
+```ruby
+class ChartsController < ApplicationController
+  def completed_tasks
+    render json: Task.group_by_day(:completed_at).count
+  end
+end
+```
+
+For multiple series, add `chart_json` at the end.
+
+```ruby
+render json: Task.group(:goal_id).group_by_day(:completed_at).count.chart_json
+```
+
+### Options
+
+Id, width, and height
+
+```erb
+<%= line_chart data, id: "users-chart", width: "800px", height: "500px" %>
+```
+
+Min and max values
+
+```erb
+<%= line_chart data, min: 1000, max: 5000 %>
+```
+
+`min` defaults to 0 for charts with non-negative values. Use `nil` to let the charting library decide.
+
+Colors
+
+```erb
+<%= line_chart data, colors: ["#b00", "#666"] %>
+```
+
+Stacked columns or bars
+
+```erb
+<%= column_chart data, stacked: true %>
+```
+
+Discrete axis
+
+```erb
+<%= line_chart data, discrete: true %>
+```
+
+Label (for single series)
+
+```erb
+<%= line_chart data, label: "Value" %>
+```
+
+Axis titles
+
+```erb
+<%= line_chart data, xtitle: "Time", ytitle: "Population" %>
+```
+
+Straight lines between points instead of a curve
+
+```erb
+<%= line_chart data, curve: false %>
+```
+
+Hide points
+
+```erb
+<%= line_chart data, points: false %>
+```
+
+Show or hide legend
+
+```erb
+<%= line_chart data, legend: false %>
+```
+
+Specify legend position
+
+```erb
+<%= line_chart data, legend: "bottom" %>
+```
+
+Defer chart creation until after the page loads
+
+```erb
+<%= line_chart data, defer: true %>
+```
+
+Donut chart
+
+```erb
+<%= pie_chart data, donut: true %>
+```
+
+Prefix, useful for currency - *Chart.js, Highcharts*
+
+```erb
+<%= line_chart data, prefix: "$" %>
+```
+
+Suffix, useful for percentages - *Chart.js, Highcharts*
+
+```erb
+<%= line_chart data, suffix: "%" %>
+```
+
+Set a thousands separator - *Chart.js, Highcharts*
+
+```erb
+<%= line_chart data, thousands: "," %>
+```
+
+Set a decimal separator - *Chart.js, Highcharts*
+
+```erb
+<%= line_chart data, decimal: "," %>
+```
+
+Show a message when data is empty
+
+```erb
+<%= line_chart data, messages: {empty: "No data"} %>
+```
+
+Refresh data from a remote source every `n` seconds
+
+```erb
+<%= line_chart url, refresh: 60 %>
+```
+
+You can pass options directly to the charting library with:
+
+```erb
+<%= line_chart data, library: {backgroundColor: "#eee"} %>
+```
+
+See the documentation for [Chart.js](https://www.chartjs.org/docs/), [Google Charts](https://developers.google.com/chart/interactive/docs/gallery), and [Highcharts](https://api.highcharts.com/highcharts) for more info.
+
+To customize datasets in Chart.js, use:
+
+```erb
+<%= line_chart data, dataset: {borderWidth: 10} %>
+```
+
+You can pass this option to individual series as well.
+
+### Global Options
+
+To set options for all of your charts, create an initializer `config/initializers/chartkick.rb` with:
+
+```ruby
+Chartkick.options = {
+  height: "400px",
+  colors: ["#b00", "#666"]
+}
+```
+
+Customize the html
+
+```ruby
+Chartkick.options[:html] = '<div id="%{id}" style="height: %{height};">Loading...</div>'
+```
+
+You capture the JavaScript in a content block with:
+
+```ruby
+Chartkick.options[:content_for] = :charts_js
+```
+
+Then, in your layout:
+
+```erb
+<%= yield :charts_js %> <!-- Rails -->
+<%= yield_content :charts_js %> <!-- Padrino -->
+```
+
+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, "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.
+
+**Note:** JavaScript functions cannot be logged, so it may not be identical.
+
+### Download Charts
+
+*Chart.js only*
+
+Give users the ability to download charts. It all happens in the browser - no server-side code needed.
+
+```erb
+<%= line_chart data, download: true %>
+```
+
+**Note:** Safari will open the image in a new window instead of downloading.
+
+Set the filename
+
+```erb
+<%= line_chart data, download: {filename: "boom"} %>
+```
+
+Set the background color
+
+```erb
+<%= line_chart data, download: {background: "#ffffff"} %>
+```
+
+Set title
+
+```erb
+<%= line_chart data, title: "Awesome chart" %>
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "chartkick"
+```
+
+Next, choose your charting library.
+
+### Charting Libraries
+
+**Note:** In the instructions below, `application.js` must be included **before** the charts in your views, unless using the `:content_for` option.
+
+#### Chart.js
+
+In `application.js`, add:
+
+```js
+//= require Chart.bundle
+//= require chartkick
+```
+
+#### Google Charts
+
+In `application.js`, add:
+
+```js
+//= require chartkick
+```
+
+In your views, before `application.js`, add:
+
+```erb
+<%= javascript_include_tag "https://www.gstatic.com/charts/loader.js" %>
+```
+
+#### Highcharts
+
+Download [highcharts.js](https://code.highcharts.com/highcharts.js) into `vendor/assets/javascripts` (or use `yarn add highcharts` in Rails 5.1+).
+
+In `application.js`, add:
+
+```js
+//= require highcharts
+//= require chartkick
+```
+
+Works with Highcharts 2.1+
+
+### Webpacker
+
+For Webpacker, use Yarn to install the JavaScript libraries:
+
+```sh
+yarn add chartkick chart.js # or highcharts
+```
+
+Then include them in your pack.
+
+```es6
+import Chartkick from "chartkick";
+window.Chartkick = Chartkick;
+
+// for Chart.js
+import Chart from "chart.js";
+Chartkick.addAdapter(Chart);
+
+// for Highcharts
+import Highcharts from "highcharts";
+Chartkick.addAdapter(Highcharts);
+
+// for Google Charts
+// just include https://www.gstatic.com/charts/loader.js in your views
+```
+
+You pack must be included **before** the charts in your views, unless using the `:content_for` option.
+
+### Sinatra and Padrino
+
+You must include `chartkick.js` manually. [Download it here](https://raw.githubusercontent.com/ankane/chartkick/master/vendor/assets/javascripts/chartkick.js)
+
+```html
+<script src="chartkick.js"></script>
+```
+
+### Localization
+
+To specify a language for Google Charts, add:
+
+```javascript
+Chartkick.configure({language: "de"});
+```
+
+after the JavaScript files and before your charts.
+
+### Multiple Libraries
+
+If more than one charting library is loaded, choose between them with:
+
+```erb
+<%= line_chart data, adapter: "google" %> <!-- or highcharts or chartjs -->
+```
+
+## JavaScript API
+
+Access a chart with:
+
+```javascript
+var chart = Chartkick.charts["chart-id"]
+```
+
+Get the underlying chart object with:
+
+```javascript
+chart.getChartObject()
+```
+
+You can also use:
+
+```javascript
+chart.getElement()
+chart.getData()
+chart.getOptions()
+chart.getAdapter()
+```
+
+Update the data with:
+
+```javascript
+chart.updateData(newData)
+```
+
+You can also specify new options:
+
+```javascript
+chart.setOptions(newOptions)
+// or
+chart.updateData(newData, newOptions)
+```
+
+Refresh the data from a remote source:
+
+```javascript
+chart.refreshData()
+```
+
+Redraw the chart with:
+
+```javascript
+chart.redraw()
+```
+
+Loop over charts with:
+
+```javascript
+Chartkick.eachChart( function(chart) {
+  // do something
+})
+```
+
+## 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)
+
+## 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
+
+### 3.0
+
+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.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
+
+## Credits
+
+Chartkick uses [iso8601.js](https://github.com/Do/iso8601.js) to parse dates and times.
+
+## History
+
+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:
+
+- [Report bugs](https://github.com/ankane/chartkick/issues)
+- Fix bugs and [submit pull requests](https://github.com/ankane/chartkick/pulls)
+- Write, clarify, or fix documentation
+- Suggest or add new features

data/lib/chartkick/engine.rb

@@ -0,0 +1,5 @@
+module Chartkick
+  class Engine < ::Rails::Engine
+    # for assets
+  end
+end

data/lib/chartkick/helper.rb

@@ -0,0 +1,109 @@
+require "json"
+require "erb"
+
+module Chartkick
+  module Helper
+    def line_chart(data_source, **options)
+      chartkick_chart "LineChart", data_source, options
+    end
+
+    def pie_chart(data_source, **options)
+      chartkick_chart "PieChart", data_source, options
+    end
+
+    def column_chart(data_source, **options)
+      chartkick_chart "ColumnChart", data_source, options
+    end
+
+    def bar_chart(data_source, **options)
+      chartkick_chart "BarChart", data_source, options
+    end
+
+    def area_chart(data_source, **options)
+      chartkick_chart "AreaChart", data_source, options
+    end
+
+    def scatter_chart(data_source, **options)
+      chartkick_chart "ScatterChart", data_source, options
+    end
+
+    def geo_chart(data_source, **options)
+      chartkick_chart "GeoChart", data_source, options
+    end
+
+    def timeline(data_source, **options)
+      chartkick_chart "Timeline", data_source, options
+    end
+
+    private
+
+    def chartkick_chart(klass, data_source, **options)
+      @chartkick_chart_id ||= 0
+      options = chartkick_deep_merge(Chartkick.options, options)
+      element_id = options.delete(:id) || "chart-#{@chartkick_chart_id += 1}"
+      height = options.delete(:height) || "300px"
+      width = options.delete(:width) || "100%"
+      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)
+      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
+        if respond_to?(:content_security_policy_nonce) && (content_security_policy_nonce rescue nil)
+          # Rails 5.2
+          nonce = content_security_policy_nonce
+        elsif respond_to?(:content_security_policy_script_nonce)
+          # Secure Headers
+          nonce = content_security_policy_script_nonce
+        end
+      end
+      nonce_html = nonce ? " nonce=\"#{ERB::Util.html_escape(nonce)}\"" : nil
+
+      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>)) % {id: ERB::Util.html_escape(element_id), height: ERB::Util.html_escape(height), width: ERB::Util.html_escape(width)}
+
+      createjs = "new Chartkick.#{klass}(#{element_id.to_json}, #{data_source.respond_to?(:chart_json) ? data_source.chart_json : data_source.to_json}, #{options.to_json});"
+      if defer
+        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
+        js = <<JS
+<script type="text/javascript"#{nonce_html}>
+  #{createjs}
+</script>
+JS
+      end
+
+      if content_for
+        content_for(content_for) { js.respond_to?(:html_safe) ? js.html_safe : js }
+      else
+        html += js
+      end
+
+      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
+  end
+end

data/lib/chartkick/sinatra.rb

@@ -0,0 +1,5 @@
+require "sinatra/base"
+
+class Sinatra::Base
+  helpers Chartkick::Helper
+end

data/lib/chartkick/version.rb

@@ -0,0 +1,3 @@
+module Chartkick
+  VERSION = "3.0.4"
+end