pie-high 0.1.0 → 0.2.0

data/Rakefile

@@ -13,6 +13,7 @@ begin
     gem.authors = ["Jeff Sutherland"]
     gem.add_development_dependency "rspec", ">= 1.2.9"
     gem.add_development_dependency "ruport", ">=1.6.1"
+    gem.add_development_dependency "json_pure", ">=1.1.9"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
   Jeweler::GemcutterTasks.new

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/lib/hash_extensions.rb

@@ -0,0 +1,9 @@
+# I need to stringify keys, but I don't want to include the whole Rails framework, so I'm going extend Hash myself.
+class Hash
+  def stringify_keys!
+    keys.each do |key|
+      self[key.to_s] = delete(key)
+    end
+    self
+  end
+end

data/lib/high_chart.rb

@@ -1,6 +1,10 @@
+require "yaml"
+require "hash_extensions"
+require "json"
+
 class HighChart
   attr_accessor :chart, :credits, :colors, :global, :labels, :lang, :legend, :loading, :plot_options, :point, :series,
-                :subtitle, :symbols, :title, :toolbar, :tooltip, :x_axis, :y_axis, :x_axis_labels, :y_axis_title,
+                :subtitle, :symbols, :title, :toolbar, :tooltip, :x_axis, :y_axis, :x_axis_labels,
                 :chart_div, :chart_type, :width
 
   def initialize(series, options={})
@@ -41,6 +45,7 @@ class HighChart
     return default_value
   end
 
+  # read a yaml file of defaults and write out the options
   def read_defaults(config_file)
     begin
       defaults = YAML.load_file(config_file)
@@ -53,6 +58,8 @@ class HighChart
         end
       end
     rescue Exception => e
+      puts e.message
+      puts e.backtrace
       raise e
     end
   end
@@ -67,7 +74,7 @@ class HighChart
     end
 
     default_chart = {"renderTo" => @chart_div, "defaultSeriesType" => @chart_type}
-    default_chart.merge!({"width" => @width}) if width.present?
+    default_chart.merge!({"width" => @width}) if @width != nil
     default_chart.merge!(@chart) if @chart
 
     return default_chart
@@ -91,10 +98,7 @@ class HighChart
   end
 
   def y_axis
-    y_axis_hash = {}
-    y_axis_hash["title"] = @y_axis_title
-    y_axis_hash.merge!(@y_axis) if @y_axis
-    return y_axis_hash
+    return @y_axis
   end
 
   def to_json

data/lib/high_chart_series.rb

@@ -5,7 +5,7 @@ class HighChartSeries
 
   class << self
 
-    # builds an array of series from the same data set
+    # builds an array of series to make a chart more interesting
     # series_name_attribute - string of method to call to get series name
     # attribute_of_interest - method with the numeric data to build the chart
     # chart_data - array of query results with which to build a series
@@ -23,7 +23,7 @@ class HighChartSeries
       return series
     end
 
-    # will generate a hash for an individual series
+    # will generate a hash
     # {:name => "My Wonderful Series", :data => [0, 1, 2, 3]
     # series_options => used to define individual options for series
     def single_series(series_name, attribute_of_interest, chart_series_data, series_options={})
@@ -31,10 +31,10 @@ class HighChartSeries
 
       if chart_series_data.kind_of?(Array)
         for datum in chart_series_data
-          series_data << datum.send(attribute_of_interest)
+          series_data << datum.send(attribute_of_interest).to_f
         end
       else
-        series_data << chart_series_data
+        series_data << chart_series_data.to_f
       end
 
       unless series_options == nil
@@ -62,7 +62,8 @@ class HighChartSeries
       return final_series
     end
 
-    # accommodates multi-dimensional pivot tables from Ruport
+    # accommodates multi-dimensional pivot tables
+    # based on Ruport pivot tables
     # also generates your x-axis labels
     def pivot_series(series_name_attribute, attribute_of_interest, chart_data, options={})
       series = []
@@ -102,12 +103,12 @@ class HighChartSeries
       return x_labels, series
     end
 
-    # for building multiple, non-identical series for combo line/bar charts from multiple data sets
+    # for building multiple, non-identical series for combo line, bar charts
     # series_name_attributes - attributes to get "name" keys from
     # attributes_of_interest - array of strings naming the attributes to examine
     # chart_data - the data to build the chart from, an array of arrays, if you will
     # series_options - array of hashes to be passed to single_series
-    def multi_axis_series(series_name_attributes, attributes_of_interest, chart_data_arr, series_options=[{}, {"type" => "spline"}, {"type" => "spline"}])
+    def multi_axis_series(series_name_attributes, attributes_of_interest, chart_data_arr, series_options=[{}, {"type" => "line", "yAxis"=>1}, {"type" => "line", "yAxis"=>2}])
       series = []
 
       chart_data_arr.each_with_index do |chart_data, index|

data/pie-high.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{pie-high}
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jeff Sutherland"]
-  s.date = %q{2010-08-03}
+  s.date = %q{2010-08-31}
   s.description = %q{High Charts is one of the best JavaScript charting libraries there is.  Here is a straight-forward
                       Ruby API to harness all the power High Charts has to offer.  Includes support for Ruport pivot tables.}
   s.email = %q{jefferey.sutherland@gmail.com}
@@ -24,9 +24,11 @@ Gem::Specification.new do |s|
      "README.rdoc",
      "Rakefile",
      "VERSION",
+     "lib/hash_extensions.rb",
      "lib/high_chart.rb",
      "lib/high_chart_series.rb",
      "pie-high.gemspec",
+     "spec/assets/high_chart_defaults.yml",
      "spec/high_chart_series_spec.rb",
      "spec/high_chart_spec.rb",
      "spec/spec.opts",
@@ -50,13 +52,16 @@ Gem::Specification.new do |s|
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
       s.add_development_dependency(%q<ruport>, [">= 1.6.1"])
+      s.add_development_dependency(%q<json_pure>, [">= 1.1.9"])
     else
       s.add_dependency(%q<rspec>, [">= 1.2.9"])
       s.add_dependency(%q<ruport>, [">= 1.6.1"])
+      s.add_dependency(%q<json_pure>, [">= 1.1.9"])
     end
   else
     s.add_dependency(%q<rspec>, [">= 1.2.9"])
     s.add_dependency(%q<ruport>, [">= 1.6.1"])
+    s.add_dependency(%q<json_pure>, [">= 1.1.9"])
   end
 end
 

data/spec/assets/high_chart_defaults.yml

@@ -0,0 +1,9 @@
+---
+chart:
+  plotBackgroundColor: '#000000'
+
+legend:
+  enabled: true
+  layout: 'vertical'
+
+colors: [ '#FFFFFF', '#000000' ]

data/spec/high_chart_series_spec.rb

@@ -1,6 +1,8 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require "spec_helper"
 require "high_chart"
 require "high_chart_series"
+require "ruport"
+
 include Ruport::Data
 
 class ChartData
@@ -92,7 +94,7 @@ describe HighChartSeries do
     it "should build a multi series from a ruport table" do
       series = HighChartSeries.multi_series("event", "count", table.data.collect(& :data))
       series.size.should == 2
-      series.first[:data].first.should eql(2)
+      series.first[:data].first.to_i.should eql(2)
       series.first[:name].should eql("Event 1")
     end
 

data/spec/high_chart_spec.rb

@@ -1,16 +1,17 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require "spec_helper"
 require "high_chart"
+require "hash_extensions"
 
 describe HighChart do
   before(:each) do
     @series = [{:name => "series1", :data => [0]}, {:name => "series2", :data => [1]}]
     @x_labels = ["label1", "label2"]
     @y_title = "a title"
-    @chart = HighChart.new(@series, {:x_axis_labels => @x_labels, :y_axis_title => @y_title, :title => "chart title"})
+    @chart = HighChart.new(@series, {:x_axis_labels => @x_labels, :title => "chart title"})
   end
 
   it "should read some defaults from a config file" do
-    chart = HighChart.new(@series, {:x_axis_labels => @x_labels, :y_axis_title => @y_title, :title => "chart title", :config_file => File.dirname(__FILE__) + "/../assets/high_chart_defaults.yml"})
+    chart = HighChart.new(@series, {:x_axis_labels => @x_labels, :title => "chart title", :config_file => File.dirname(__FILE__) + "/assets/high_chart_defaults.yml"})
     chart.legend.should == {"enabled" => true, "layout" => "vertical"}
   end
 
@@ -19,12 +20,12 @@ describe HighChart do
   end
 
   it "should merge options from the hash passed in with the values in the config file" do
-    chart = HighChart.new(@series, {:x_axis_labels => @x_labels, :legend => {:enabled => false}, :config_file => File.dirname(__FILE__) + "/../assets/high_chart_defaults.yml"})
+    chart = HighChart.new(@series, {:x_axis_labels => @x_labels, :legend => {:enabled => false}, :config_file => File.dirname(__FILE__) + "/assets/high_chart_defaults.yml"})
     chart.legend.should == {"enabled" => false, "layout" => "vertical"}
   end
 
   it "should set instance variables from the options hash" do
-    chart = HighChart.new(@series, {:x_axis_labels => @x_labels, :y_axis_title => @y_title, :title => "chart title", :legend => {:enabled => false}, :config_file => File.dirname(__FILE__) + "/../assets/high_chart_defaults.yml"})
+    chart = HighChart.new(@series, {:x_axis_labels => @x_labels, :title => "chart title", :legend => {:enabled => false}, :config_file => File.dirname(__FILE__) + "/assets/high_chart_defaults.yml"})
     chart.title.should == {"text" => "chart title"}
   end
 
@@ -33,7 +34,7 @@ describe HighChart do
   end
 
   it "should return a colors hash" do
-    chart = HighChart.new(@series, {:x_axis_labels => @x_labels, :y_axis_title => @y_title, :title => "chart title", :colors => ["red", "green", "blue"]})
+    chart = HighChart.new(@series, {:x_axis_labels => @x_labels, :title => "chart title", :colors => ["red", "green", "blue"]})
     chart.colors.should == ["red", "green", "blue"]
   end
 
@@ -46,35 +47,34 @@ describe HighChart do
   end
 
   it "should return an xAxis hash" do
-    @chart.x_axis.should == {"categories" => ["label1", "label2"]}
+    @chart.x_axis["categories"].should == ["label1", "label2"]
   end
 
-  it "should return a yAxis hash" do
-    @chart.y_axis.should == {"title" => "a title"}
+  it "should return a yAxis array" do
+    chart = HighChart.new(@series, {:x_axis_labels => @x_labels, :y_axis => [{:opposite => true}, {:opposite => false}], :title => "chart title"})
+    chart.y_axis.should.kind_of?(Array)
+    chart.y_axis.size.should == 2
+    chart.y_axis[0][:opposite].should == true
+    chart.y_axis[1][:opposite].should == false
   end
 
   it "should fail if no x_axis_labels are provided" do
     lambda {HighChart.new(@series)}.should raise_error(HighChartError)
   end
 
-  it "should output JSON without null entries" do
-    @chart.to_json.should_not match(/null/)
-  end
-
   it "should read colors from a config file" do
-    chart = HighChart.new(@series, {:x_axis_labels => @x_labels, :y_axis_title => @y_title, :title => "chart title", :config_file => File.dirname(__FILE__) + "/../assets/high_chart_defaults.yml"})
+    chart = HighChart.new(@series, {:x_axis_labels => @x_labels, :title => "chart title", :config_file => File.dirname(__FILE__) + "/assets/high_chart_defaults.yml"})
     chart.colors.should == ['#FFFFFF', '#000000']
   end
 
   it "should merge default chart options from a config file" do
-    chart = HighChart.new(@series, {:x_axis_labels => @x_labels, :y_axis_title => @y_title, :title => "chart title", :config_file => File.dirname(__FILE__) + "/../assets/high_chart_defaults.yml"})
+    chart = HighChart.new(@series, {:x_axis_labels => @x_labels, :title => "chart title", :config_file => File.dirname(__FILE__) + "/assets/high_chart_defaults.yml"})
     chart.chart.should == {"defaultSeriesType"=>"bar", "renderTo"=>"high-chart-container", "plotBackgroundColor" => "#000000"}
   end
 
   it "should raise an error if series is not an array" do
     series = {:name => "series1", :data => [0]}
     x_labels = ["label1", "label2"]
-    y_title = "a title"
-    lambda {HighChart.new(series, {:x_axis_labels => x_labels, :y_axis_title => y_title, :title => "chart title"})}.should raise_error(HighChartError)
+    lambda {HighChart.new(series, {:x_axis_labels => x_labels, :title => "chart title"})}.should raise_error(HighChartError)
   end
-end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: pie-high
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 23
   prerelease: false
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Jeff Sutherland
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-03 00:00:00 -06:00
+date: 2010-08-31 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -50,6 +50,22 @@ dependencies:
         version: 1.6.1
   type: :development
   version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: json_pure
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 1
+        - 1
+        - 9
+        version: 1.1.9
+  type: :development
+  version_requirements: *id003
 description: |-
   High Charts is one of the best JavaScript charting libraries there is.  Here is a straight-forward
                         Ruby API to harness all the power High Charts has to offer.  Includes support for Ruport pivot tables.
@@ -68,9 +84,11 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION
+- lib/hash_extensions.rb
 - lib/high_chart.rb
 - lib/high_chart_series.rb
 - pie-high.gemspec
+- spec/assets/high_chart_defaults.yml
 - spec/high_chart_series_spec.rb
 - spec/high_chart_spec.rb
 - spec/spec.opts