lazy_high_charts 1.5.2 → 1.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9b7f95d1ee5bcbdf67651b6b00d8e84931ac40c5
-  data.tar.gz: 3854dc699812d374aea0bb7147732a1c45445de2
+SHA256:
+  metadata.gz: 3eee1a5afbb4b3c63d64dfc871914509471aab415d129342eea21b54ccf09fee
+  data.tar.gz: 246cdc1ea7fba6367c8d19603ffb7f0b3df67f86a3be9082cd316af3475e74a6
 SHA512:
-  metadata.gz: e5735e8b7ff7d0728724d700e975d93d9134aac7081c50d2f9d7d8a2c9306a00361b6c23fbaacdf016594c7d0c7f4c7813f3f9ba6eb84067291627a0f925cd7d
-  data.tar.gz: bdb7421200c933c14b3af885ca63db543daa77fc8611211f3e0ab4a43712a2488ce192fe95fb451af362662220b7880089b11eeade22e55f18aee0831b06ac53
+  metadata.gz: 03d0468dd7d3223b36e28109222e958b68540a80114607a54daa0f8ce0bcdeeead869a23bec4a956a071e34e448d29c680c59bce239431576350c179555bd385
+  data.tar.gz: 031b37c48d4ce4085b18543e7c50ac278fb4e19dfbc13362b1934242700a9dab73504e50f1f8ce2831f891a60a4aea5a833b6936498ef76b10325b02e9dcaf52

data/.travis.yml

@@ -5,5 +5,4 @@ bundler_args: --without production development
 script: bundle exec rake
 
 rvm:
-  - 1.9.3
-  - 2.0.0
+  - 2.2.5

data/CHANGELOG.md

@@ -1,10 +1,24 @@
+# VERSION 1.5.5
+  * Mon Oct 19, 2015
+    1. Support for HighChart global settings.
+    [#149](https://github.com/michelson/lazy_high_charts/issues/149)
+    2. Minor code refactorings.
+
+# VERSION 1.5.4
+  * Fri May 21
+    1. Include ActionView::Helpers::TagHelper to the layout helper to avoid method conflict in object.
+
+# VERSION 1.5.3
+  * Fri Apr 18
+    1. update HighChart js lib to latest.
+
 # VERSION 1.5.2
   * Sun Mar 11, 2014
     1. Merge some requirement tweaks to use gem in NON-Rails contexts
 
 # VERSION 1.5.1
   * Sun Dec 22, 2013
-    1. Share highcharts:update rake task for gem and rails host app 
+    1. Share highcharts:update rake task for gem and rails host app
 
 # VERSION 1.5.0
   * Sun Jul 21, 2013

data/GEM_VERSION

@@ -1 +1 @@
-1.5.2
+1.6.1

data/Gemfile

@@ -5,7 +5,7 @@ gemspec
 
 group :test, :development do # This causes the plugins to NOT load
   gem 'webrat', '~> 0.7'
-  gem 'rspec', '~> 2.0'
+  gem 'rspec', '~> 3.4'
   gem 'rails', '>= 3.2'
   gem 'guard-rspec'
   gem 'rb-fsevent', '~> 0.9.1'

data/README.md

@@ -1,7 +1,9 @@
 # LazyHighCharts
 
+[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/michelson/lazy_high_charts?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+
 This gem provides a simple and extremely flexible way to use HighCharts from ruby code.
-Tested on Ruby on Rails, Sinatra and Nanoc, but it should work with others too.
+Tested on Ruby on Rails, Sinatra and Nanoc, but it should work with others too. Highcharts is not free for commercial use, so make sure you have a valid license to use Highcharts.
 
 
 [![Build Status](https://travis-ci.org/michelson/lazy_high_charts.png?branch=master)](http://travis-ci.org/michelson/lazy_high_charts)
@@ -40,43 +42,104 @@ then run
 bundle install
 ```
 
+and make sure to get the latest version (unless you'd like an older version for some reason)
+```bash
+rake highcharts:update
+```
+
+and add this in the application.js
+
+```js
+//= require jquery
+//= require jquery_ujs
+//= require_tree .
+//= require turbolinks
+
+//= require highcharts/highcharts
+//= require highcharts/highcharts-more
+//= require highcharts/highstock
+```
+
 to install it.
 
 ## Usage:
 
 ### Controller code:
 ```ruby
-@chart2 = LazyHighCharts::HighChart.new('graph') do |f|
-  f.title(:text => "Population vs GDP For 5 Big Countries [2009]")
-  f.xAxis(:categories => ["United States", "Japan", "China", "Germany", "France"])
-  f.series(:name => "GDP in Billions", :yAxis => 0, :data => [14119, 5068, 4985, 3339, 2656])
-  f.series(:name => "Population in Millions", :yAxis => 1, :data => [310, 127, 1340, 81, 65])
+@chart = LazyHighCharts::HighChart.new('graph') do |f|
+  f.title(text: "Population vs GDP For 5 Big Countries [2009]")
+  f.xAxis(categories: ["United States", "Japan", "China", "Germany", "France"])
+  f.series(name: "GDP in Billions", yAxis: 0, data: [14119, 5068, 4985, 3339, 2656])
+  f.series(name: "Population in Millions", yAxis: 1, data: [310, 127, 1340, 81, 65])
 
   f.yAxis [
-    {:title => {:text => "GDP in Billions", :margin => 70} },
-    {:title => {:text => "Population in Millions"}, :opposite => true},
+    {title: {text: "GDP in Billions", margin: 70} },
+    {title: {text: "Population in Millions"}, opposite: true},
   ]
 
-  f.legend(:align => 'right', :verticalAlign => 'top', :y => 75, :x => -50, :layout => 'vertical',)
-  f.chart({:defaultSeriesType=>"column"})
+  f.legend(align: 'right', verticalAlign: 'top', y: 75, x: -50, layout: 'vertical')
+  f.chart({defaultSeriesType: "column"})
+end
+
+@chart_globals = LazyHighCharts::HighChartGlobals.new do |f|
+  f.global(useUTC: false)
+  f.chart(
+    backgroundColor: {
+      linearGradient: [0, 0, 500, 500],
+      stops: [
+        [0, "rgb(255, 255, 255)"],
+        [1, "rgb(240, 240, 255)"]
+      ]
+    },
+    borderWidth: 2,
+    plotBackgroundColor: "rgba(255, 255, 255, .9)",
+    plotShadow: true,
+    plotBorderWidth: 1
+  )
+  f.lang(thousandsSep: ",")
+  f.colors(["#90ed7d", "#f7a35c", "#8085e9", "#f15c80", "#e4d354"])
 end
 ```
 
 ### View Helpers:
 ```ruby
-<%= high_chart("my_id4", @chart4) %>
+<%= high_chart_globals(@chart_globals) %>
+<%= high_chart("some_id", @chart) %>
 ```
 
-###Demo projects:
+`high_chart_globals` is optional. Use it to set the global options of all charts that are currently displayed on the page. More info [here](http://api.highcharts.com/highcharts#global).
+
+### No Data
+
+When your series has no data and you want to display a message using Highcharts' noData feature ([Highcarts doc](http://api.highcharts.com/highcharts/noData)) you have to include the `no-data-to-display.js` file like so:
+
+````
+//= require highcharts/highcharts
+//= require highcharts/highcharts-more
+//= require highcharts/modules/no-data-to-display
+````
+
+You can then set the actual message that is displayed like so:
+
+````
+    @chart = LazyHighCharts::HighChart.new('graph') do |f|
+      f.options[:lang] = { noData: "My beautiful noData message" }
+      f.title(text: nil)
+      f.series([])
+    end
+````
+
+
+### Demo projects:
 
-[Nanoc App](spec/dummy_nanoc/README.md)
+[Nanoc App](spec/dummy_nanoc)
 
-[Rails App](spec/dummy_rails/README.md)
+[Rails App](spec/dummy_rails)
 
-[Sinatra App](spec/dummy_sinatra/README.md)
+[Sinatra App](spec/dummy_sinatra)
 
 
-### Update to latest js library. Aditional command line
+### Update to latest js library. Additional command line
 
   To update to the current highcharts.js directly from http://code.highcharts.com/",  you can always run 
 
@@ -97,7 +160,7 @@ We're open to any contribution. It has to be tested properly though.
 * Test your changes. We won't accept any untested contributions (except if they're not testable).
 * Create an [issue](https://github.com/michelson/lazy_high_charts/issues) with a link to your commits.
 
-Thanks for all [contributers](https://github.com/michelson/lazy_high_charts/contributors)
+Thanks for all [contributors](https://github.com/michelson/lazy_high_charts/contributors)
 
 ## Maintainers
 * Deshi Xiao [github/xiaods](https://github.com/xiaods)

data/lazy_high_charts.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |s|
 
   s.required_rubygems_version = ">= 1.3"
 
-  s.add_dependency "bundler", ">= 1.0"
+  s.add_development_dependency "bundler", ">= 1.0"
   s.add_dependency "hash-deep-merge"
 
   s.description = <<-DESC

data/lib/lazy_high_charts.rb

@@ -1,11 +1,11 @@
 require 'action_view'
-include ActionView::Helpers::TagHelper
 require 'json'
 
 require File.join(File.dirname(__FILE__), *%w[lazy_high_charts core_ext string])
 require File.join(File.dirname(__FILE__), *%w[lazy_high_charts options_key_filter])
 require File.join(File.dirname(__FILE__), *%w[lazy_high_charts layout_helper])
 require File.join(File.dirname(__FILE__), *%w[lazy_high_charts high_chart])
+require File.join(File.dirname(__FILE__), *%w[lazy_high_charts high_chart_globals])
 if defined?(::Rails::Railtie)
   require File.join(File.dirname(__FILE__), *%w[lazy_high_charts railtie])
   require File.join(File.dirname(__FILE__), *%w[lazy_high_charts engine]) if ::Rails.version.to_s >= '3.1'

data/lib/lazy_high_charts/high_chart.rb

@@ -34,7 +34,6 @@ module LazyHighCharts
       self.subtitle({})
     end
 
-
     # Pass other methods through to the javascript high_chart object.
     #
     # For instance: <tt>high_chart.grid(:color => "#699")</tt>
@@ -66,11 +65,13 @@ module LazyHighCharts
     #
     # @return [Hash] options JSON options hash
     def full_options
-      options_collection = [generate_json_from_hash(OptionsKeyFilter.filter(self.options))]
-      options_collection << %|"series": [#{generate_json_from_array(self.data)}]|
-      <<-EOJS
-      { #{options_collection.join(', ')} }
-      EOJS
+      options_collection_as_string self
+    end
+
+    def to_json
+      data = self.options.clone
+      data[:series] = self.series_data.clone
+      data
     end
 
     private
@@ -82,7 +83,7 @@ module LazyHighCharts
     end
 
     def series_options
-      @options.reject { |k, v| SERIES_OPTIONS.include?(k.to_s) == false }
+      @options.reject { |k, _| SERIES_OPTIONS.include?(k.to_s) == false }
     end
 
     def merge_options(name, opts)

data/lib/lazy_high_charts/high_chart_globals.rb

@@ -0,0 +1,29 @@
+module LazyHighCharts
+  class HighChartGlobals
+  	include LayoutHelper
+
+  	attr_accessor :options
+
+  	def initialize
+  	  self.tap do |chart_globals|
+        chart_globals.options ||= {}
+        yield chart_globals if block_given?
+      end
+  	end
+
+  	# Pass other methods through to the high_chart_globals object.
+    #
+    # For instance: <tt>high_chart_globals.global(:useUTC => false)</tt>
+    def method_missing(meth, opts = {})
+      if meth.to_s == 'to_ary'
+        super
+      end
+      merge_options meth, opts      
+    end
+
+    def merge_options(name, opts)
+      @options.merge! name => opts
+    end
+
+  end
+end

data/lib/lazy_high_charts/layout_helper.rb

@@ -2,6 +2,7 @@
 
 module LazyHighCharts
   module LayoutHelper
+    include ActionView::Helpers::TagHelper
 
     def high_chart(placeholder, object, &block)
       object.html_options.merge!({:id => placeholder})
@@ -15,6 +16,10 @@ module LazyHighCharts
       high_graph_stock(placeholder, object, &block).concat(content_tag("div", "", object.html_options))
     end
 
+    def high_chart_globals(object)
+      build_globals_html_output(object)
+    end
+
     def high_graph(placeholder, object, &block)
       build_html_output("Chart", placeholder, object, &block)
     end
@@ -23,59 +28,27 @@ module LazyHighCharts
       build_html_output("StockChart", placeholder, object, &block)
     end
 
-    def build_html_output(type, placeholder, object, &block)
-      options_collection = [generate_json_from_hash(OptionsKeyFilter.filter(object.options))]
-      options_collection << %|"series": [#{generate_json_from_array(object.series_data)}]|
+    private
 
+    def build_html_output(type, placeholder, object, &block)
       core_js =<<-EOJS
-        var options = { #{options_collection.join(',')} };
+        var options = #{options_collection_as_string(object)};
         #{capture(&block) if block_given?}
         window.chart_#{placeholder.underscore} = new Highcharts.#{type}(options);
       EOJS
 
-      if defined?(request) && request.respond_to?(:xhr?) && request.xhr?
-        graph =<<-EOJS
-        <script type="text/javascript">
-        (function() {
-          #{core_js}
-        })()
-        </script>
-        EOJS
-      elsif defined?(Turbolinks) && request.headers["X-XHR-Referer"]
-        graph =<<-EOJS
-        <script type="text/javascript">
-        (function() {
-          var f = function(){
-            document.removeEventListener('page:load', f, true);
-            #{core_js}
-          };
-          document.addEventListener('page:load', f, true);
-        })()
-        </script>
-        EOJS
-      else
-        graph =<<-EOJS
-        <script type="text/javascript">
-        (function() {
-          var onload = window.onload;
-          window.onload = function(){
-            if (typeof onload == "function") onload();
-            #{core_js}
-          };
-        })()
-        </script>
-        EOJS
-      end
+      encapsulate_js core_js
+    end
 
-      if defined?(raw)
-        return raw(graph)
-      else
-        return graph
-      end
+    def build_globals_html_output(object)
+      options_collection = [generate_json_from_hash(OptionsKeyFilter.filter(object.options))]
 
-    end
+      core_js =<<-EOJS
+        Highcharts.setOptions({ #{options_collection.join(',')} });
+      EOJS
 
-    private
+      encapsulate_js core_js
+    end
 
     def generate_json_from_hash hash
       hash.each_pair.map do |key, value|
@@ -100,6 +73,77 @@ module LazyHighCharts
       array.map { |value| generate_json_from_value(value) }.join(",")
     end
 
+    def request_is_xhr?
+      defined?(request) && request.respond_to?(:xhr?) && request.xhr?
+    end
+
+    def request_is_referrer?
+      defined?(request) && request.respond_to?(:headers) && request.headers["X-XHR-Referer"]
+    end
+
+    def request_turbolinks_5_tureferrer?
+      defined?(request) && request.respond_to?(:headers) && request.headers["Turbolinks-Referrer"]
+    end
+
+    def options_collection_as_string object
+      options_collection = [generate_json_from_hash(OptionsKeyFilter.filter(object.options))]
+      options_collection << %|"series": [#{generate_json_from_array(object.series_data)}]|
+      "{ #{options_collection.join(',')} }"
+    end
+
+    def encapsulate_js(core_js)
+      if request_is_xhr?
+        js_output = "#{js_start} #{core_js} #{js_end}"
+      # Turbolinks.version < 5
+      elsif defined?(Turbolinks) && request_is_referrer?
+        js_output =<<-EOJS
+        #{js_start}
+          var f = function(){
+            document.removeEventListener('page:load', f, true);
+            #{core_js}
+          };
+          document.addEventListener('page:load', f, true);
+        #{js_end}
+        EOJS
+      # Turbolinks >= 5
+      elsif defined?(Turbolinks) && request_turbolinks_5_tureferrer?
+        js_output =<<-EOJS
+        #{js_start}
+          document.addEventListener("turbolinks:load", function() {
+            #{core_js}
+          });
+        #{js_end}
+        EOJS
+      else
+        js_output =<<-EOJS
+        #{js_start}
+          window.addEventListener('load', function() {
+            #{core_js}
+          });
+        #{js_end}
+        EOJS
+      end
+
+      if defined?(raw)
+        return raw(js_output)
+      else
+        return js_output
+      end
+    end
+
+    def js_start
+      <<-EOJS
+        <script type="text/javascript">
+        (function() {
+      EOJS
+    end
+
+    def js_end
+      <<-EOJS
+        })()
+        </script>
+      EOJS
+    end
   end
 end