lazy_high_charts 1.2.2 → 1.3.0.beta

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+# VERSION 1.3.0.beta
+  * Oct 27,2012
+  1.merged hash deep merge patch
+  [#77](https://github.com/michelson/lazy_high_charts/issues/77)
+  2.enhance example case in README.md
+  [#78](https://github.com/michelson/lazy_high_charts/issues/78)
+
+# VERSION 1.2.2
 * Aug 31, 2012
   1. Correct highchart js location
     [issue#74](https://github.com/michelson/lazy_high_charts/issues/74)

data/GEM_VERSION

@@ -0,0 +1 @@
+1.3.0.beta

data/README.md

@@ -36,7 +36,7 @@ About javascript Assets notes:
 ````
 
 ### For Rails 2.x/3.0.x
- 
+
 1. you need manually put jquery/highcharts js to public/javascript
 2. modify your layout html
    Sample Code:
@@ -82,6 +82,29 @@ Overriding entire option:
   #.....
 ````
 
+If you want to use this syntax and still be able to build option step-by-step without overriding:
+
+````
+@h = LazyHighCharts::HighChart.new('graph') do |f|
+ #.....
+ f.xAxis!(:categories => @days.reverse! , :labels=>{:rotation=>-45 , :align => 'right'})
+ f.chart!({:defaultSeriesType=>"spline" , :renderTo => "myRenderArea" , :inverted => true})
+ #.....
+````
+
+Using the datetime axis type:
+
+````
+@h = LazyHighCharts::HighChart.new('graph', style: '') do |f|
+  f.options[:chart][:defaultSeriesType] = "area"
+  f.options[:plotOptions] = {areaspline: {pointInterval: 1.day, pointStart: 10.days.ago}}
+  f.series(:name=>'John', :data=>[3, 20, 3, 5, 4, 10, 12 ,3, 5,6,7,7,80,9,9])
+  f.series(:name=>'Jane', :data=> [1, 3, 4, 3, 3, 5, 4,-46,7,8,8,9,9,0,0,9])
+  f.xAxis(type: :datetime)
+end
+````
+A datetime axis [example](http://jsfiddle.net/gh/get/jquery/1.7.2/highslide-software/highcharts.com/tree/master/samples/highcharts/xaxis/type-datetime/)
+
 
 Usage in layout:
 ````
@@ -103,11 +126,11 @@ You can pass in additional javascript into to the view with a block, this will b
 To include javascript function calls or callbacks you can use the js_code method on your string`"function".js_code`:
 
 ````
-f.options[:plotOptions] = { 
+f.options[:plotOptions] = {
   :column => { :events => { :click => %|function() { window.location = "http://www.highcharts.com" }|.js_code } }
 }
 ````
-      
+
 
 ## HighStock Support:
 
@@ -123,7 +146,7 @@ http://www.highcharts.com/ref/
 ## HighCharts License:
 
 http://www.highcharts.com/license
-     
+
 
 ## Contributing
 

data/lazy_high_charts.gemspec

@@ -1,16 +1,16 @@
 # -*- encoding: utf-8 -*-
 $LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
-require 'lazy_high_charts/version'
+version = File.read(File.expand_path("../GEM_VERSION",__FILE__)).strip
 
 Gem::Specification.new do |s|
   s.name        = "lazy_high_charts"
-  s.version     = LazyHighCharts::VERSION
+  s.version     = version
   s.platform    = Gem::Platform::RUBY
   s.authors     = ['Miguel Michelson Martinez','Deshi Xiao']
   s.email       = ['miguelmichelson@gmail.com','xiaods@gmail.com']
   s.homepage    = "https://github.com/xiaods/lazy_high_charts"
-  s.summary     = "lazy higcharts gem for rails"
-  s.description = "use highcharts js libary to visualization your data by rubygem/rails"
+  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" ]
@@ -18,9 +18,10 @@ Gem::Specification.new do |s|
   s.required_rubygems_version = "~> 1.3"
 
   s.add_dependency "bundler", "~> 1.0"
+  s.add_dependency "hash-deep-merge"
 
   s.description = <<-DESC
-    lazy_high_charts is a Rails 3.x gem for displaying Highcharts graphs.
+    lazy_high_charts is leading edge rubyist render charts gem for displaying Highcharts graphs.
   DESC
 
   s.files = `git ls-files`.split("\n")

data/lib/lazy_high_charts.rb

@@ -1,4 +1,5 @@
 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 railtie]) if defined?(::Rails::Railtie)

data/lib/lazy_high_charts/high_chart.rb

@@ -22,7 +22,7 @@ module LazyHighCharts
     #	title:		legend: 		xAxis: 		yAxis: 		tooltip: 	credits:  :plotOptions
     def defaults_options
       self.title({ :text=>"example test title from highcharts gem"})
-      self.legend({ :layout=>"vertical", :style=>{} }) 
+      self.legend({ :layout=>"vertical", :style=>{} })
       self.xAxis({})
       self.yAxis({ :title=> {:text=> nil}, :labels=>{} })
       self.tooltip({ :enabled=>true })
@@ -37,7 +37,11 @@ module LazyHighCharts
     #
     # For instance: <tt>high_chart.grid(:color => "#699")</tt>
     def method_missing(meth, opts = {})
-      merge_options meth, opts
+      if meth.to_s.end_with? '!'
+        deep_merge_options meth[0..-2].to_sym, opts
+      else
+        merge_options meth, opts
+      end
     end
 
     # Add a simple series to the graph:
@@ -48,7 +52,7 @@ module LazyHighCharts
     def series(opts = {})
       @data ||= []
       if not opts.empty?
-        @data << opts.merge(:name => opts[:name], :data => opts[:data])
+        @data << OptionsKeyFilter.filter(opts.merge(:name => opts[:name], :data => opts[:data]))
       end
     end
 
@@ -62,6 +66,10 @@ private
       @options.merge!  name => opts
     end
 
+    def deep_merge_options(name, opts)
+      @options.deep_merge!  name => opts
+    end
+
     def arguments_to_options(args)
       if args.blank? 
         {:show => true}

data/lib/lazy_high_charts/layout_helper.rb

@@ -24,7 +24,7 @@ module LazyHighCharts
     end
 
     def build_html_output(type, placeholder, object, &block)
-      options_collection =  [ generate_json_from_hash(object.options) ]
+      options_collection =  [ generate_json_from_hash(OptionsKeyFilter.filter(object.options)) ]
       options_collection << %|"series": [#{generate_json_from_array(object.data)}]|
 
       core_js =<<-EOJS

data/lib/lazy_high_charts/options_key_filter.rb

@@ -0,0 +1,39 @@
+#
+# A way to filter certain keys of data provided to the LazyHighCharts#series method and the LazyHighCharts#options
+#
+# Add methods or keys to the FILTER_MAP hash to have them applied to the options in a series
+# In the FILTER_MAP, the hash keys are methods, and the values are arrays of the hash keys the filter should be
+# applied to
+#
+# Be careful that it is OK to filter the hash keys you specify for every key of the options or series hash
+#
+module LazyHighCharts
+  module OptionsKeyFilter
+    def self.milliseconds value
+      value * 1000
+    end
+
+    def self.date_to_js_code date
+      "Date.UTC(#{date.year}, #{date.month - 1}, #{date.day})".js_code
+    end
+
+    def self.filter options
+      new_options = options.map do |k, v|
+        if v.is_a? ::Hash
+          v = filter v
+        else
+          FILTER_MAP.each_pair do |method, matchers|
+            v = method.call(v) if matchers.include?(k)
+          end
+        end
+        [k, v]
+      end
+      Hash[new_options]
+    end
+
+    FILTER_MAP = {
+        method(:milliseconds) => [:pointInterval],
+        method(:date_to_js_code) => [:pointStart]
+    }
+  end
+end

data/spec/high_chart_spec.rb

@@ -104,6 +104,24 @@ describe "HighChart" do
         end
        chart.options[:subtitle][:text].should == "Bar"
     end
+
+    it 'should override entire option by default when resetting it again' do
+      chart = LazyHighCharts::HighChart.new('graph') do |f|
+        f.xAxis(categories: [3, 5, 7])
+        f.xAxis(title: {text: 'x title'})
+      end
+      chart.options[:xAxis][:categories].should == nil
+      chart.options[:xAxis][:title][:text].should == 'x title'
+    end
+
+    it 'should allow to build options step by step without overriding previously set values' do
+      chart = LazyHighCharts::HighChart.new('graph') do |f|
+        f.xAxis!(categories: [3, 5, 7])
+        f.xAxis!(title: {text: 'x title'})
+      end
+      chart.options[:xAxis][:categories].should == [3, 5, 7]
+      chart.options[:xAxis][:title][:text].should == 'x title'
+    end
      
   end
 

data/spec/options_key_filter_spec.rb

@@ -0,0 +1,28 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe LazyHighCharts::OptionsKeyFilter do
+  it "should filter :pointInterval from seconds to milliseconds" do
+    hash = LazyHighCharts::OptionsKeyFilter.filter(pointInterval: 1)
+    hash[:pointInterval].should == 1000
+  end
+
+  describe "filters :pointStart from a Date to a JavaScript compatible string" do
+    before(:each) do
+      hash = LazyHighCharts::OptionsKeyFilter.filter(pointStart: Date.new(2012, 9, 13))
+      @value = hash[:pointStart]
+    end
+
+    it "should be the correct string" do
+      @value.should == "Date.UTC(2012, 8, 13)"
+    end
+
+    it "should be js_code" do
+      @value.js_code.should be_true
+    end
+  end
+
+  it "should filter keys recursively" do
+    hash = LazyHighCharts::OptionsKeyFilter.filter({something: {another_thing: {pointInterval: 2}}})
+    hash[:something][:another_thing][:pointInterval].should == 2000
+  end
+end

data/spec/spec_helper.rb

@@ -14,6 +14,7 @@ require "active_support/core_ext"
 
 require File.expand_path(File.join(File.dirname(__FILE__), '../lib/lazy_high_charts'))
 require File.expand_path(File.join(File.dirname(__FILE__), '../lib/lazy_high_charts/layout_helper'))
+require File.expand_path(File.join(File.dirname(__FILE__), '../lib/lazy_high_charts/options_key_filter'))
 
 require 'webrat'
 require 'rspec'

metadata

@@ -1,8 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: lazy_high_charts
 version: !ruby/object:Gem::Version
-  version: 1.2.2
-  prerelease: 
+  version: 1.3.0.beta
+  prerelease: 6
 platform: ruby
 authors:
 - Miguel Michelson Martinez
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-31 00:00:00.000000000 Z
+date: 2012-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -28,8 +28,24 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.0'
-description: ! '    lazy_high_charts is a Rails 3.x gem for displaying Highcharts
-  graphs.
+- !ruby/object:Gem::Dependency
+  name: hash-deep-merge
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! '    lazy_high_charts is leading edge rubyist render charts gem for
+  displaying Highcharts graphs.
 
 '
 email:
@@ -44,6 +60,7 @@ files:
 - .gitignore
 - .rspec
 - CHANGELOG.md
+- GEM_VERSION
 - Gemfile
 - MIT-LICENSE
 - README.md
@@ -56,11 +73,12 @@ files:
 - lib/lazy_high_charts/core_ext/string.rb
 - lib/lazy_high_charts/high_chart.rb
 - lib/lazy_high_charts/layout_helper.rb
+- lib/lazy_high_charts/options_key_filter.rb
 - lib/lazy_high_charts/railtie.rb
-- lib/lazy_high_charts/version.rb
 - rails/init.rb
 - spec/high_chart_spec.rb
 - spec/lazy_high_charts_spec.rb
+- spec/options_key_filter_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/xiaods/lazy_high_charts
 licenses: []
@@ -86,6 +104,6 @@ rubyforge_project:
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: lazy higcharts gem for rails
+summary: rubyist way to render variant chart by highcharts without write javascript
+  right now, rails gem library.
 test_files: []
-has_rdoc: 

data/lib/lazy_high_charts/version.rb

@@ -1,3 +0,0 @@
-module LazyHighCharts
-  VERSION = "1.2.2"
-end