chartkick 1.3.2 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ca23cf2a483dec9fdb551db05a0026cebaffb654
-  data.tar.gz: 787086c3fa0287b611c5895c1fe5c43902347b05
+  metadata.gz: 9e4271e7d959b8fcad6ab2a8265231d64f16c3c8
+  data.tar.gz: 96e3d4ef110a67385e2973357cf390ec334db12b
 SHA512:
-  metadata.gz: 6a4dcfde3aeb6f4068cda287772d4d36d3280eb88bbc9b64172b8d678f34319ffc89ab55e50b7e88ae38bd3041e9f56c26826ca151ad6880c9cbefba6518d96c
-  data.tar.gz: 2a3ee87316b2aa0c8faef093a042c8a7126d13b8b96adacec8623cb331465e8b26dc10a22c5c2a0cf546c0236d3dbba0e2ea49d7517fc0d28a46e8706df0f370
+  metadata.gz: 5811e2cd0fc00aaa8f49686d001f965283296a6e75ebd3ec80251c9b67063ffd79b8e08e57474bec3924518fec3570a73da3663b8ec54c9b14e42605f976b2ab
+  data.tar.gz: 17f0605334a89a8a29bf16f3ea5534806d2b6eb6ede00bffc577f1e785764984fe32f391595fb62a283dd897155d29d2ec4f502fe9481b6377263fd9dfc4805a

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 1.4.0
+
+- Added scatter chart
+- Added axis titles
+
 ## 1.3.2
 
 - Fixed `except` error when not using Rails

data/Gemfile

@@ -1,4 +1,4 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in chartkick.gemspec
 gemspec

data/README.md

@@ -8,7 +8,7 @@ Works with Rails, Sinatra and most browsers (including IE 6)
 
 :two_hearts: A perfect companion to [groupdate](https://github.com/ankane/groupdate), [hightop](https://github.com/ankane/hightop), and [active_median](https://github.com/ankane/active_median)
 
-:speech_balloon: Get [handcrafted updates](http://chartkick.us7.list-manage.com/subscribe?u=952c861f99eb43084e0a49f98&id=6ea6541e8e&group[0][1]=true) for new features
+:speech_balloon: Get [handcrafted updates](http://chartkick.us7.list-manage.com/subscribe?u=952c861f99eb43084e0a49f98&id=6ea6541e8e&group[0][2]=true) for new features
 
 ## Charts
 
@@ -42,6 +42,12 @@ Area chart
 <%= area_chart Visit.group_by_minute(:created_at).maximum(:load_time) %>
 ```
 
+Scatter chart
+
+```erb
+<%= scatter_chart City.pluck(:size, :population) %>
+```
+
 Geo chart
 
 ```erb
@@ -132,6 +138,12 @@ Discrete axis
 <%= line_chart data, discrete: true %>
 ```
 
+Axis titles
+
+```erb
+<%= line_chart data, xtitle: "Time", ytitle: "Population" %>
+```
+
 You can pass options directly to the charting library with:
 
 ```erb

data/Rakefile

@@ -1,7 +1,7 @@
 require "bundler/gem_tasks"
 require "rake/testtask"
 
-task :default => :test
+task default: :test
 Rake::TestTask.new do |t|
   t.libs << "test"
   t.pattern = "test/**/*_test.rb"

data/app/assets/javascripts/chartkick.js

@@ -2,7 +2,7 @@
  * Chartkick.js
  * Create beautiful Javascript charts with minimal code
  * https://github.com/ankane/chartkick.js
- * v1.2.2
+ * v1.4.0
  * MIT License
  */
 
@@ -101,7 +101,7 @@
     return false;
   }
 
-  function jsOptionsFunc(defaultOptions, hideLegend, setMin, setMax, setStacked) {
+  function jsOptionsFunc(defaultOptions, hideLegend, setMin, setMax, setStacked, setXtitle, setYtitle) {
     return function (series, opts, chartOptions) {
       var options = merge({}, defaultOptions);
       options = merge(options, chartOptions || {});
@@ -113,14 +113,14 @@
       }
 
       // min
-      if ("min" in opts) {
+      if (opts.min) {
         setMin(options, opts.min);
       } else if (!negativeValues(series)) {
         setMin(options, 0);
       }
 
       // max
-      if ("max" in opts) {
+      if (opts.max) {
         setMax(options, opts.max);
       }
 
@@ -132,6 +132,14 @@
         options.colors = opts.colors;
       }
 
+      if (opts.xtitle) {
+        setXtitle(options, opts.xtitle);
+      }
+
+      if (opts.ytitle) {
+        setYtitle(options, opts.ytitle);
+      }
+
       // merge library last
       options = merge(options, opts.library || {});
 
@@ -231,9 +239,14 @@
     var HighchartsAdapter = new function () {
       var Highcharts = window.Highcharts;
 
+      this.name = "highcharts";
+
       var defaultOptions = {
         chart: {},
         xAxis: {
+          title: {
+            text: null
+          },
           labels: {
             style: {
               fontSize: "12px"
@@ -288,7 +301,15 @@
         options.plotOptions.series.stacking = "normal";
       };
 
-      var jsOptions = jsOptionsFunc(defaultOptions, hideLegend, setMin, setMax, setStacked);
+      var setXtitle = function (options, title) {
+        options.xAxis.title.text = title;
+      };
+
+      var setYtitle = function (options, title) {
+        options.yAxis.title.text = title;
+      };
+
+      var jsOptions = jsOptionsFunc(defaultOptions, hideLegend, setMin, setMax, setStacked, setXtitle, setYtitle);
 
       this.renderLineChart = function (chart, chartType) {
         chartType = chartType || "spline";
@@ -326,6 +347,15 @@
         new Highcharts.Chart(options);
       };
 
+      this.renderScatterChart = function (chart) {
+        var chartOptions = {};
+        var options = jsOptions(chart.data, chart.options, chartOptions);
+        options.chart.type = 'scatter';
+        options.chart.renderTo = chart.element.id;
+        options.series = chart.data;
+        new Highcharts.Chart(options);
+      };
+
       this.renderPieChart = function (chart) {
         var chartOptions = {};
         if (chart.options.colors) {
@@ -401,6 +431,8 @@
     var GoogleChartsAdapter = new function () {
       var google = window.google;
 
+      this.name = "google";
+
       var loaded = {};
       var callbacks = [];
 
@@ -408,7 +440,7 @@
         var cb, call;
         for (var i = 0; i < callbacks.length; i++) {
           cb = callbacks[i];
-          call = google.visualization && ((cb.pack == "corechart" && google.visualization.LineChart) || (cb.pack == "timeline" && google.visualization.Timeline))
+          call = google.visualization && ((cb.pack === "corechart" && google.visualization.LineChart) || (cb.pack === "timeline" && google.visualization.Timeline))
           if (call) {
             cb.callback();
             callbacks.splice(i, 1);
@@ -461,6 +493,7 @@
             color: "#666",
             fontSize: 12
           },
+          titleTextStyle: {},
           gridlines: {
             color: "transparent"
           },
@@ -472,6 +505,7 @@
             color: "#666",
             fontSize: 12
           },
+          titleTextStyle: {},
           baselineColor: "#ccc",
           viewWindow: {}
         },
@@ -507,7 +541,17 @@
         options.isStacked = true;
       };
 
-      var jsOptions = jsOptionsFunc(defaultOptions, hideLegend, setMin, setMax, setStacked);
+      var setXtitle = function (options, title) {
+        options.hAxis.title = title;
+        options.hAxis.titleTextStyle.italic = false;
+      }
+
+      var setYtitle = function (options, title) {
+        options.vAxis.title = title;
+        options.vAxis.titleTextStyle.italic = false;
+      };
+
+      var jsOptions = jsOptionsFunc(defaultOptions, hideLegend, setMin, setMax, setStacked, setXtitle, setYtitle);
 
       // cant use object as key
       var createDataTable = function (series, columnType) {
@@ -530,9 +574,17 @@
         }
 
         var rows2 = [];
+        var value;
         for (i in rows) {
           if (rows.hasOwnProperty(i)) {
-            rows2.push([(columnType === "datetime") ? new Date(toFloat(i)) : i].concat(rows[i]));
+            if (columnType === "datetime") {
+              value = new Date(toFloat(i));
+            } else if (columnType === "number") {
+              value = toFloat(i);
+            } else {
+              value = i;
+            }
+            rows2.push([value].concat(rows[i]));
           }
         }
         if (columnType === "datetime") {
@@ -655,6 +707,19 @@
         });
       };
 
+      this.renderScatterChart = function (chart) {
+        waitForLoaded(function () {
+          var chartOptions = {};
+          var options = jsOptions(chart.data, chart.options, chartOptions);
+          var data = createDataTable(chart.data, "number");
+
+          chart.chart = new google.visualization.ScatterChart(chart.element);
+          resize(function () {
+            chart.chart.draw(data, options);
+          });
+        });
+      };
+
       this.renderTimeline = function (chart) {
         waitForLoaded("timeline", function () {
           var chartOptions = {
@@ -662,7 +727,7 @@
           };
 
           if (chart.options.colors) {
-            chartOptions.colorAxis.colors = chart.options.colors;
+            chartOptions.colors = chart.options.colors;
           }
           var options = merge(merge(defaultOptions, chartOptions), chart.options.library || {});
 
@@ -684,16 +749,16 @@
     adapters.push(GoogleChartsAdapter);
   }
 
-  // TODO add adapter option
   // TODO remove chartType if cross-browser way
   // to get the name of the chart class
   function renderChart(chartType, chart) {
-    var i, adapter, fnName;
+    var i, adapter, fnName, adapterName;
     fnName = "render" + chartType;
+    adapterName = chart.options.adapter;
 
     for (i = 0; i < adapters.length; i++) {
       adapter = adapters[i];
-      if (isFunction(adapter[fnName])) {
+      if ((!adapterName || adapterName === adapter.name) && isFunction(adapter[fnName])) {
         return adapter[fnName](chart);
       }
     }
@@ -702,8 +767,31 @@
 
   // process data
 
-  function processSeries(series, opts, time) {
-    var i, j, data, r, key;
+  var toFormattedKey = function (key, keyType) {
+    if (keyType === "number") {
+      key = toFloat(key);
+    } else if (keyType === "datetime") {
+      key = toDate(key);
+    } else {
+      key = toStr(key);
+    }
+    return key;
+  };
+
+  var formatSeriesData = function (data, keyType) {
+    var r = [], key, j;
+    for (j = 0; j < data.length; j++) {
+      key = toFormattedKey(data[j][0], keyType);
+      r.push([key, toFloat(data[j][1])]);
+    }
+    if (keyType === "datetime") {
+      r.sort(sortByTime);
+    }
+    return r;
+  };
+
+  function processSeries(series, opts, keyType) {
+    var i;
 
     // see if one series or multiple
     if (!isArray(series) || typeof series[0] !== "object" || isArray(series[0])) {
@@ -713,22 +801,12 @@
       opts.hideLegend = false;
     }
     if (opts.discrete) {
-      time = false;
+      keyType = "string";
     }
 
     // right format
     for (i = 0; i < series.length; i++) {
-      data = toArr(series[i].data);
-      r = [];
-      for (j = 0; j < data.length; j++) {
-        key = data[j][0];
-        key = time ? toDate(key) : toStr(key);
-        r.push([key, toFloat(data[j][1])]);
-      }
-      if (time) {
-        r.sort(sortByTime);
-      }
-      series[i].data = r;
+      series[i].data = formatSeriesData(toArr(series[i].data), keyType);
     }
 
     return series;
@@ -753,12 +831,12 @@
   }
 
   function processLineData(chart) {
-    chart.data = processSeries(chart.data, chart.options, true);
+    chart.data = processSeries(chart.data, chart.options, "datetime");
     renderChart("LineChart", chart);
   }
 
   function processColumnData(chart) {
-    chart.data = processSeries(chart.data, chart.options, false);
+    chart.data = processSeries(chart.data, chart.options, "string");
     renderChart("ColumnChart", chart);
   }
 
@@ -768,12 +846,12 @@
   }
 
   function processBarData(chart) {
-    chart.data = processSeries(chart.data, chart.options, false);
+    chart.data = processSeries(chart.data, chart.options, "string");
     renderChart("BarChart", chart);
   }
 
   function processAreaData(chart) {
-    chart.data = processSeries(chart.data, chart.options, true);
+    chart.data = processSeries(chart.data, chart.options, "datetime");
     renderChart("AreaChart", chart);
   }
 
@@ -782,6 +860,11 @@
     renderChart("GeoChart", chart);
   }
 
+  function processScatterData(chart) {
+    chart.data = processSeries(chart.data, chart.options, "number");
+    renderChart("ScatterChart", chart);
+  }
+
   function processTimelineData(chart) {
     chart.data = processTime(chart.data);
     renderChart("Timeline", chart);
@@ -819,6 +902,9 @@
     GeoChart: function (element, dataSource, opts) {
       setElement(this, element, dataSource, opts, processGeoData);
     },
+    ScatterChart: function (element, dataSource, opts) {
+      setElement(this, element, dataSource, opts, processScatterData);
+    },
     Timeline: function (element, dataSource, opts) {
       setElement(this, element, dataSource, opts, processTimelineData);
     },

data/chartkick.gemspec

@@ -1,19 +1,19 @@
 # coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'chartkick/version'
+require "chartkick/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "chartkick"
   spec.version       = Chartkick::VERSION
   spec.authors       = ["Andrew Kane"]
   spec.email         = ["acekane1@gmail.com"]
-  spec.description   = %q{Create beautiful Javascript charts with one line of Ruby}
-  spec.summary       = %q{Create beautiful Javascript charts with one line of Ruby}
-  spec.homepage      = ""
+  spec.description   = "Create beautiful Javascript charts with one line of Ruby"
+  spec.summary       = "Create beautiful Javascript charts with one line of Ruby"
+  spec.homepage      = "http://chartkick.com"
   spec.license       = "MIT"
 
-  spec.files         = `git ls-files`.split($/)
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]

data/lib/chartkick.rb

@@ -15,9 +15,9 @@ end
 # use Enumerable so it can be called on arrays
 module Enumerable
   def chart_json
-    if is_a?(Hash) and (key = keys.first) and key.is_a?(Array) and key.size == 2
-      group_by{|k, v| k[0] }.map do |name, data|
-        {name: name, data: data.map{|k, v| [k[1], v] }}
+    if is_a?(Hash) && (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
       self

data/lib/chartkick/engine.rb

@@ -1,16 +1,14 @@
 module Chartkick
   class Engine < ::Rails::Engine
-
-    initializer "precompile", :group => :all do |app|
+    initializer "precompile", group: :all do |app|
       # use a proc instead of a string
-      app.config.assets.precompile << Proc.new{|path| path == "chartkick.js" }
+      app.config.assets.precompile << proc { |path| path == "chartkick.js" }
     end
 
-    initializer "helper" do |app|
+    initializer "helper" do
       ActiveSupport.on_load(:action_view) do
         include Helper
       end
     end
-
   end
 end

data/lib/chartkick/helper.rb

@@ -3,7 +3,6 @@ require "erb"
 
 module Chartkick
   module Helper
-
     def line_chart(data_source, options = {})
       chartkick_chart "LineChart", data_source, options
     end
@@ -24,6 +23,10 @@ module Chartkick
       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
@@ -34,15 +37,15 @@ module Chartkick
 
     private
 
-    def chartkick_chart(klass, data_source, options, &block)
+    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"
       # content_for: nil must override default
-      content_for = options.has_key?(:content_for) ? options.delete(:content_for) : Chartkick.content_for
+      content_for = options.key?(:content_for) ? options.delete(:content_for) : Chartkick.content_for
 
-      html = (options.delete(:html) || %[<div id="%{id}" style="height: %{height}; 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)}
+      html = (options.delete(:html) || %(<div id="%{id}" style="height: %{height}; 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)}
 
       js = <<JS
 <script type="text/javascript">
@@ -61,12 +64,11 @@ JS
     # 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|
+      hash_b.each_pair do |k, v|
         tv = hash_a[k]
         hash_a[k] = tv.is_a?(Hash) && v.is_a?(Hash) ? tv.deep_merge(v) : v
       end
       hash_a
     end
-
   end
 end

data/lib/chartkick/sinatra.rb

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

data/lib/chartkick/version.rb

@@ -1,3 +1,3 @@
 module Chartkick
-  VERSION = "1.3.2"
+  VERSION = "1.4.0"
 end

data/test/chartkick_test.rb

@@ -21,4 +21,9 @@ class TestChartkick < Minitest::Test
     assert column_chart(@data)
   end
 
+  def test_options_not_mutated
+    options = {id: "boom"}
+    line_chart @data, options
+    assert_equal "boom", options[:id]
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chartkick
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.4.0
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-04 00:00:00.000000000 Z
+date: 2015-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -75,7 +75,7 @@ files:
 - lib/chartkick/version.rb
 - test/chartkick_test.rb
 - test/test_helper.rb
-homepage: ''
+homepage: http://chartkick.com
 licenses:
 - MIT
 metadata: {}
@@ -95,10 +95,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Create beautiful Javascript charts with one line of Ruby
 test_files:
 - test/chartkick_test.rb
 - test/test_helper.rb
+has_rdoc: