lazy_high_charts 1.4.2 → 1.4.3

data/.travis.yml

@@ -6,4 +6,4 @@ script: bundle exec rake
 
 rvm:
   - 1.9.3
-  - ruby-head
+  - 2.0.0

data/CHANGELOG.md

@@ -1,7 +1,12 @@
+# VERSION 1.4.3
+  * Sat Jul 20, 2013
+    1. Formatting all files
+    2. change js update methods to rake, use rake highcharts:update to fetch upstream js files.
+    3. update highcharts to 3.0.2
+
 # VERSION 1.4.2
-  * Wed Apr 17 2013
-    1. upgraded js lib to 3.0.1.
-      [#121](https://github.com/michelson/lazy_high_charts/issues/121)
+  * April 17, 2013
+    1. bump new version to release
 # VERSION 1.4.1
   * Sat Apr 6, 2013
     1. support HighCharts 3.0

data/GEM_VERSION

@@ -1 +1 @@
-1.4.2
+1.4.3

data/Gemfile

@@ -4,7 +4,7 @@ source "https://rubygems.org"
 gemspec
 
 group :test, :development do # This causes the plugins to NOT load
-  gem 'webrat','~> 0.7'
+  gem 'webrat', '~> 0.7'
   gem 'rspec', '~> 2.0'
   gem 'rails', '>= 3.2'
   gem 'guard-rspec'

data/Guardfile

@@ -3,7 +3,7 @@
 
 guard 'rspec' do
   watch(%r{^spec/.+_spec\.rb$})
-  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
-  watch('spec/spec_helper.rb')  { "spec" }
+  watch(%r{^lib/(.+)\.rb$}) { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb') { "spec" }
 end
 

data/README.md

@@ -1,6 +1,6 @@
 # LazyHighCharts - Official gem repository
 
-Easily displaying Highcharts graphs with gem style.
+Easily include HighCharts in your project with this gem
 [![Build Status](https://secure.travis-ci.org/michelson/lazy_high_charts.png)](http://travis-ci.org/michelson/lazy_high_charts)
 
 ## Notice
@@ -10,7 +10,7 @@ Current
 
 ## Installation
 
-### Installing it by rubygems
+### Installation with rubygems
 
 To install it, you just need to add it to your Gemfile:
 
@@ -26,11 +26,11 @@ bundle install
 
 to install it.
 
-### legacy notice: if you use rails 2.3.x or 3.0.x or 3.1.x, please keep version should be less than 1.3.3.
+### Deprecation notice: if you use rails 2.3.x or 3.0.x or 3.1.x, please use versions less than 1.3.3.
 
 ##  Lazy_high_charts User Guide
 
-Todo...Hold on
+See [project WIKI page](https://github.com/michelson/lazy_high_charts/wiki)
 
 ## Contributing
 

data/Rakefile

@@ -9,5 +9,40 @@ task :default => :spec
 
 desc 'Test the lazy_high_charts plugin.'
 RSpec::Core::RakeTask.new('spec') do |t|
-    t.pattern = FileList['spec/**/*_spec.rb']
+  t.pattern = FileList['spec/**/*_spec.rb']
+end
+
+# Below implement highcharts js files bootstrap logic
+def say(msg, &block)
+  print "#{msg}..."
+
+  if block_given?
+      yield
+    puts " Done."
+  end
+end
+
+namespace :highcharts do
+  desc "Update highcharts.js from latest Builds on Highcharts codebase: http://code.highcharts.com/"
+  task :update => [:core, :stock]
+  task :core do
+    say "Grabbing Core from Highcharts codebase..." do
+      sh "curl -# http://code.highcharts.com/highcharts.js -L --compressed -o vendor/assets/javascripts/highcharts/highcharts.js"
+      sh "curl -# http://code.highcharts.com/highcharts-more.js -L --compressed -o vendor/assets/javascripts/highcharts/highcharts-more.js"
+      sh "curl -# http://code.highcharts.com/modules/exporting.js -L --compressed -o vendor/assets/javascripts/highcharts/modules/exporting.js"
+      sh "curl -# http://code.highcharts.com/adapters/mootools-adapter.js -L --compressed -o vendor/assets/javascripts/highcharts/adapters/mootools-adapter.js"
+      sh "curl -# http://code.highcharts.com/adapters/prototype-adapter.js -L --compressed -o vendor/assets/javascripts/highcharts/adapters/prototype-adapter.js"
+    end
+  end
+
+  task :stock do
+    say "Grabbing Highcharts Stock JS from Upstream..." do
+      sh "curl -# http://code.highcharts.com/stock/highstock.js -L --compressed -o vendor/assets/javascripts/highcharts/highstock.js"
+      sh "curl -# http://code.highcharts.com/stock/highcharts-more.js -L --compressed -o vendor/assets/javascripts/highcharts/stock/highcharts-more.js"
+      sh "curl -# http://code.highcharts.com/stock/modules/exporting.js -L --compressed -o vendor/assets/javascripts/highcharts/stock/modules/exporting.js"
+      sh "curl -# http://code.highcharts.com/stock/adapters/mootools-adapter.js -L --compressed -o vendor/assets/javascripts/highcharts/stock/adapters/mootools-adapter.js"
+      sh "curl -# http://code.highcharts.com/stock/adapters/prototype-adapter.js -L --compressed -o vendor/assets/javascripts/highcharts/stock/adapters/prototype-adapter.js"
+    end
+  end
+
 end

data/lazy_high_charts.gemspec

@@ -1,19 +1,19 @@
 # -*- encoding: utf-8 -*-
 $LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
-version = File.read(File.expand_path("../GEM_VERSION",__FILE__)).strip
+version = File.read(File.expand_path("../GEM_VERSION", __FILE__)).strip
 
 Gem::Specification.new do |s|
-  s.name        = "lazy_high_charts"
-  s.version     = version
-  s.platform    = Gem::Platform::RUBY
-  s.authors     = ['Miguel Michelson', 'Deshi Xiao']
-  s.email       = ['miguelmichelson@gmail.com', 'xiaods@gmail.com']
-  s.homepage    = "https://github.com/michelson/lazy_high_charts"
-  s.summary     = "rubyist way to render variant chart by highcharts without write javascript right now, rails gem library."
+  s.name = "lazy_high_charts"
+  s.version = version
+  s.platform = Gem::Platform::RUBY
+  s.authors = ['Miguel Michelson', 'Deshi Xiao']
+  s.email = ['miguelmichelson@gmail.com', 'xiaods@gmail.com']
+  s.homepage = "https://github.com/michelson/lazy_high_charts"
+  s.summary = "rubyist way to render variant chart by highcharts without write javascript right now, rails gem library."
   s.description = "lazy_high_charts is leading edge rubyist render charts gem for displaying Highcharts graphs."
 
-  s.extra_rdoc_files  = [ "README.md", "CHANGELOG.md" ]
-  s.rdoc_options      = [ "--charset=UTF-8" ]
+  s.extra_rdoc_files = ["README.md", "CHANGELOG.md"]
+  s.rdoc_options = ["--charset=UTF-8"]
   key = File.expand_path("~/.ssh/gem-private_key.pem")
   if File.exist?(key)
     s.signing_key = key
@@ -30,7 +30,7 @@ Gem::Specification.new do |s|
   DESC
 
   s.files = `git ls-files`.split("\n")
-  s.executables = `git ls-files`.split("\n").select{|f| f =~ /^bin/}
+  s.executables = `git ls-files`.split("\n").select { |f| f =~ /^bin/ }
   s.require_path = 'lib'
 
 end

data/lib/lazy_high_charts.rb

@@ -1,12 +1,14 @@
 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 high_chart])
 require File.join(File.dirname(__FILE__), *%w[lazy_high_charts layout_helper])
+require File.join(File.dirname(__FILE__), *%w[lazy_high_charts high_chart])
 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'
 end
 
 module LazyHighCharts
-
+  def self.root
+    File.expand_path '../..', __FILE__
+  end
 end

data/lib/lazy_high_charts/core_ext/string.rb

@@ -1,12 +1,12 @@
 class String
-  
+
   def js_code true_or_false = true
     @_lazy_high_charts_js_code = true_or_false
     self
   end
-  
+
   def js_code?
-    @_lazy_high_charts_js_code || false 
+    @_lazy_high_charts_js_code || false
   end
-  
+
 end

data/lib/lazy_high_charts/high_chart.rb

@@ -1,17 +1,20 @@
+
 module LazyHighCharts
   class HighChart
+    include LayoutHelper
+
     SERIES_OPTIONS = %w(data dataParser dataURL index legendIndex name stack type xAxis yAxis)
 
     attr_accessor :data, :options, :placeholder, :html_options
-    alias  :canvas :placeholder
-    alias  :canvas= :placeholder=
+    alias :canvas :placeholder
+    alias :canvas= :placeholder=
 
     def initialize(canvas = nil, html_opts = {})
 
       @collection_filter = nil
       self.tap do |high_chart|
-        high_chart.data       ||= []
-        high_chart.options    ||= {}
+        high_chart.data ||= []
+        high_chart.options ||= {}
         high_chart.defaults_options
         high_chart.html_options ||= html_opts
         high_chart.canvas = (canvas ? canvas : random_canvas_id)
@@ -21,14 +24,14 @@ module LazyHighCharts
 
     #	title:		legend: 		xAxis: 		yAxis: 		tooltip: 	credits:  :plotOptions
     def defaults_options
-      self.title({ :text=> nil })
-      self.legend({ :layout=>"vertical", :style=>{} })
+      self.title({:text => nil})
+      self.legend({:layout => "vertical", :style => {}})
       self.xAxis({})
-      self.yAxis({ :title=> {:text=> nil}, :labels=>{} })
-      self.tooltip({ :enabled=>true })
-      self.credits({ :enabled => false})
-      self.plotOptions({ :areaspline => { } })
-      self.chart({ :defaultSeriesType=>"line" , :renderTo => nil})
+      self.yAxis({:title => {:text => nil}, :labels => {}})
+      self.tooltip({:enabled => true})
+      self.credits({:enabled => false})
+      self.plotOptions({:areaspline => {}})
+      self.chart({:defaultSeriesType => "line", :renderTo => nil})
       self.subtitle({})
     end
 
@@ -56,28 +59,40 @@ module LazyHighCharts
       end
     end
 
-private
+    # Pre-processes and returns full set of options relevant to the chart. Identical to what happens in the high_charts
+    # view helper.
+    #
+    # @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
+    end
+
+    private
 
     def random_canvas_id
       canvas_id_length = 11
-# Don't use SecureRandom.urlsafe_base64; it gives invalid characters.
+      # Don't use SecureRandom.urlsafe_base64; it gives invalid characters.
       ('a'..'z').to_a.shuffle.take(canvas_id_length).join
     end
 
     def series_options
-      @options.reject {|k,v| SERIES_OPTIONS.include?(k.to_s) == false}
+      @options.reject { |k, v| SERIES_OPTIONS.include?(k.to_s) == false }
     end
 
     def merge_options(name, opts)
-      @options.merge!  name => opts
+      @options.merge! name => opts
     end
 
     def deep_merge_options(name, opts)
-      @options.deep_merge!  name => opts
+      @options.deep_merge! name => opts
     end
 
     def arguments_to_options(args)
-      if args.blank? 
+      if args.blank?
         {:show => true}
       elsif args.is_a? Array
         args.first

data/lib/lazy_high_charts/layout_helper.rb

@@ -3,16 +3,16 @@
 module LazyHighCharts
   module LayoutHelper
 
-    def high_chart(placeholder, object  , &block)
-      object.html_options.merge!({:id=>placeholder})
+    def high_chart(placeholder, object, &block)
+      object.html_options.merge!({:id => placeholder})
       object.options[:chart][:renderTo] = placeholder
-      high_graph(placeholder,object , &block).concat(content_tag("div","", object.html_options))
+      high_graph(placeholder, object, &block).concat(content_tag("div", "", object.html_options))
     end
 
-    def high_stock(placeholder, object  , &block)
-      object.html_options.merge!({:id=>placeholder})
+    def high_stock(placeholder, object, &block)
+      object.html_options.merge!({:id => placeholder})
       object.options[:chart][:renderTo] = placeholder
-      high_graph_stock(placeholder,object , &block).concat(content_tag("div","", object.html_options))
+      high_graph_stock(placeholder, object, &block).concat(content_tag("div", "", object.html_options))
     end
 
     def high_graph(placeholder, object, &block)
@@ -24,13 +24,13 @@ module LazyHighCharts
     end
 
     def build_html_output(type, placeholder, object, &block)
-      options_collection =  [ generate_json_from_hash(OptionsKeyFilter.filter(object.options)) ]
+      options_collection = [generate_json_from_hash(OptionsKeyFilter.filter(object.options))]
       options_collection << %|"series": [#{generate_json_from_array(object.data)}]|
 
       core_js =<<-EOJS
         var options = { #{options_collection.join(',')} };
         #{capture(&block) if block_given?}
-        window.chart_#{placeholder} = new Highcharts.#{type}(options);
+        window.chart_#{placeholder.underscore} = new Highcharts.#{type}(options);
       EOJS
 
       if defined?(request) && request.respond_to?(:xhr?) && request.xhr?
@@ -97,7 +97,7 @@ module LazyHighCharts
     end
 
     def generate_json_from_array array
-      array.map{|value| generate_json_from_value(value)}.join(",")
+      array.map { |value| generate_json_from_value(value) }.join(",")
     end
 
   end

data/lib/lazy_high_charts/railtie.rb

@@ -1,11 +1,11 @@
 # encoding: UTF-8
 module LazyHighCharts
-    class Railtie < ::Rails::Railtie
-      config.before_configuration do
-        if config.action_view.javascript_expansions
-          config.action_view.javascript_expansions[:high_charts] |= %w(highcharts exporting)
-        end
+  class Railtie < ::Rails::Railtie
+    config.before_configuration do
+      if config.action_view.javascript_expansions
+        config.action_view.javascript_expansions[:high_charts] |= %w(highcharts exporting)
       end
     end
-    
+  end
+
 end

data/spec/high_chart_spec.rb

@@ -4,14 +4,14 @@ Record = Struct.new(:frequency, :amplitude)
 
 describe "HighChart" do
   before(:each) do
-    @collection   = [Record.new(1,15), Record.new(2,30), Record.new(4,40)]
-    @data         = [          [1,15],           [2,30],           [4,40]]
+    @collection = [Record.new(1, 15), Record.new(2, 30), Record.new(4, 40)]
+    @data = [[1, 15], [2, 30], [4, 40]]
 
-    @placeholder  = "placeholder"
+    @placeholder = "placeholder"
     @html_options = {:class => "stylin"}
-    @options      = {:bars => {:show => true}}
+    @options = {:bars => {:show => true}}
 
-    @flot         = LazyHighCharts::HighChart.new(@placeholder, @html_options) {|chart| chart.options = @options }
+    @flot = LazyHighCharts::HighChart.new(@placeholder, @html_options) { |chart| chart.options = @options }
   end
 
   # this is almost all flotomatic stuff
@@ -31,20 +31,20 @@ describe "HighChart" do
     end
 
     it "should take an optional html_options argument (defaulting to 300px height)" do
-      LazyHighCharts::HighChart.new(@placeholder,@html_options).html_options.should == @html_options
+      LazyHighCharts::HighChart.new(@placeholder, @html_options).html_options.should == @html_options
     end
 
     it "should set options by default" do
       LazyHighCharts::HighChart.new.options.should == {
-        :title=>{:text=>nil}, 
-        :legend=>{:layout=>"vertical", :style=>{}}, 
-        :xAxis=>{}, 
-        :yAxis=>{:title=>{:text=>nil}, :labels=>{}}, 
-        :tooltip=>{:enabled=>true}, 
-        :credits=>{:enabled=>false}, 
-        :plotOptions=>{:areaspline=>{}}, 
-        :chart=>{:defaultSeriesType=>"line", :renderTo=>nil}, 
-        :subtitle=>{}}
+          :title => {:text => nil},
+          :legend => {:layout => "vertical", :style => {}},
+          :xAxis => {},
+          :yAxis => {:title => {:text => nil}, :labels => {}},
+          :tooltip => {:enabled => true},
+          :credits => {:enabled => false},
+          :plotOptions => {:areaspline => {}},
+          :chart => {:defaultSeriesType => "line", :renderTo => nil},
+          :subtitle => {}}
     end
 
     it "should set data empty by default" do
@@ -52,64 +52,64 @@ describe "HighChart" do
     end
 
     it "should take a block setting attributes" do
-      chart = LazyHighCharts::HighChart.new {|f| f.data = @data ; f.options = @options }
+      chart = LazyHighCharts::HighChart.new { |f| f.data = @data; f.options = @options }
       chart.data.should == @data
       chart.options.should == @options
     end
 
     it "should take a block setting attributes" do
-      chart = LazyHighCharts::HighChart.new {|f|  f.options[:legend][:layout] = "horizontal" }
+      chart = LazyHighCharts::HighChart.new { |f| f.options[:legend][:layout] = "horizontal" }
       chart.options[:legend][:layout].should == "horizontal"
     end
 
     it "should take a block setting attributes" do
-      chart = LazyHighCharts::HighChart.new {|f|  f.options[:range_selector] = {}; f.options[:range_selector][:selected] = 1}
+      chart = LazyHighCharts::HighChart.new { |f| f.options[:range_selector] = {}; f.options[:range_selector][:selected] = 1 }
       chart.options[:range_selector][:selected].should == 1
     end
 
     it "should change a block data without overriding options" do
       chart = LazyHighCharts::HighChart.new('graph') do |f|
-        f.series(:name=>'John', :data=>[3, 20])
-        f.series(:name=>'Jane',:data=> [1, 3] )
+        f.series(:name => 'John', :data => [3, 20])
+        f.series(:name => 'Jane', :data => [1, 3])
         # without overriding 
         f.options[:chart][:defaultSeriesType] = "area"
         f.options[:chart][:inverted] = true
         f.options[:legend][:layout] = "horizontal"
-        f.options[:xAxis][:categories] = ["uno" ,"dos" , "tres" , "cuatro"]
+        f.options[:xAxis][:categories] = ["uno", "dos", "tres", "cuatro"]
       end
-      chart.data.should ==  [{:name=>"John", :data=>[3, 20]}, {:name=>"Jane", :data=>[1, 3]}]
+      chart.data.should == [{:name => "John", :data => [3, 20]}, {:name => "Jane", :data => [1, 3]}]
       chart.options[:legend][:layout].should == "horizontal"
-      chart.options[:xAxis][:categories].should == ["uno" ,"dos" , "tres" , "cuatro"]
+      chart.options[:xAxis][:categories].should == ["uno", "dos", "tres", "cuatro"]
       chart.options[:chart][:defaultSeriesType].should == "area"
       chart.options[:chart][:inverted].should == true
     end
 
     it "should change a block data with overriding entire options" do
       chart = LazyHighCharts::HighChart.new('graph') do |f|
-        f.series(:name=>'John', :data=>[3, 20])
-        f.series(:name=>'Jane', :data=>[1, 3] )        
-        f.title({ :text=> nil })
-        # without overriding 
-        f.xAxis(:categories => ["uno" ,"dos" , "tres" , "cuatro"] , :labels=>{:rotation=>-45 , :align => 'right'})
-        f.chart({:defaultSeriesType=>"spline" , :renderTo => "myRenderArea" , :inverted => true})
+        f.series(:name => 'John', :data => [3, 20])
+        f.series(:name => 'Jane', :data => [1, 3])
+        f.title({:text => nil})
+        # without overriding
+        f.xAxis(:categories => ["uno", "dos", "tres", "cuatro"], :labels => {:rotation => -45, :align => 'right'})
+        f.chart({:defaultSeriesType => "spline", :renderTo => "myRenderArea", :inverted => true})
       end
-      chart.options[:xAxis][:categories].should == ["uno" ,"dos" , "tres" , "cuatro"]      
-      chart.options[:xAxis][:labels][:rotation].should == -45     
-      chart.options[:xAxis][:labels][:align].should == "right"    
-      chart.options[:chart][:defaultSeriesType].should == "spline"    
-      chart.options[:chart][:renderTo].should == "myRenderArea"    
-      chart.options[:chart][:inverted].should == true    
+      chart.options[:xAxis][:categories].should == ["uno", "dos", "tres", "cuatro"]
+      chart.options[:xAxis][:labels][:rotation].should == -45
+      chart.options[:xAxis][:labels][:align].should == "right"
+      chart.options[:chart][:defaultSeriesType].should == "spline"
+      chart.options[:chart][:renderTo].should == "myRenderArea"
+      chart.options[:chart][:inverted].should == true
     end
 
     it "should have subtitles" do
       chart = LazyHighCharts::HighChart.new('graph') do |f|
-        f.series(:name=>'John',:data=> [3, 20])
-        f.series(:name=>'Jane', :data=>[1, 3] )        
-        f.title({ :text=>nil})
+        f.series(:name => 'John', :data => [3, 20])
+        f.series(:name => 'Jane', :data => [1, 3])
+        f.title({:text => nil})
         # without overriding 
-        f.x_axis(:categories => ["uno" ,"dos" , "tres" , "cuatro"] , :labels=>{:rotation=>-45 , :align => 'right'})
-        f.chart({:defaultSeriesType=>"spline" , :renderTo => "myRenderArea" , :inverted => true})
-        f.subtitle({:text=>"Bar"})
+        f.x_axis(:categories => ["uno", "dos", "tres", "cuatro"], :labels => {:rotation => -45, :align => 'right'})
+        f.chart({:defaultSeriesType => "spline", :renderTo => "myRenderArea", :inverted => true})
+        f.subtitle({:text => "Bar"})
       end
       chart.options[:subtitle][:text].should == "Bar"
     end
@@ -132,6 +132,21 @@ describe "HighChart" do
       chart.options[:xAxis][:title][:text].should == 'x title'
     end
 
+    it 'should merge options and data into a full options hash' do
+      chart = LazyHighCharts::HighChart.new('graph') do |f|
+        f.series(name: 'John', data: [29.9, 71.5, 106.4, 129.2, 144.0, 176.0, 135.6, 148.5, 216.4, 194.1, 95.6, 54.4])
+        f.series(name: 'Jane', data: [140.02, 41.63, 66.72, 113.21, 107.98, 105.71, 28.59, 114.23, 5.56, 93.71, 137.35, 93.16])
+        f.title({text: 'Example Data'})
+        f.xAxis(categories: %w(Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec), labels: {rotation: -45, align: 'right'})
+        f.options[:tooltip][:formatter] = "function(){ return '<b>'+ this.point.name +'</b>: '+ Highcharts.numberFormat(this.percentage, 2) +' %'; }"
+      end
+
+      json = chart.full_options
+      json.should match /\"series\"/
+      json.should match /\"title\"/
+      json.should match /\"tooltip\": { \"enabled\": true,\"formatter\"/
+    end
+
   end
 
 end