highcharts-js-rails 0.2.1 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 104e6d6a6c11a70d570d6be756cba2e7eee8182e
+  data.tar.gz: 9e2affd411da4ff0f835c6d35a8b5cb71a35d14b
+SHA512:
+  metadata.gz: 5443ecd849f92fa8c4e1b358ec64120db2533103b0066e2bf2e66c2479c2f7418005a535d0feb444339e1f2a809c034d9d4b3be0da267fe104ee451385847f94
+  data.tar.gz: fa1b7175e87e2082d4422f19d811552d5be44d5119854cb91048766753d546fedd4e4eb851daf338104466f8feb5ec21ec73cc2cede6072be75bb9d591dab6d5

data/.gitignore

@@ -1,7 +1,8 @@
 *.gem
 .bundle
 .DS_Store
-.rvmrc
+.ruby-version
+.ruby-gemset
 Gemfile.lock
 coverage/
 pkg/*

data/.rspec

@@ -1,2 +1 @@
 --colour
---format documentation

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+script: bundle exec rspec spec

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## v1.0.0 (2013-04-18) ##
+
+* Upgrade Highcharts to 3.0.1.
+* Allow both new block-style chart initialization and older chart initialization.
+* Drop any possible support for Ruby 1.8.7.
+* Build out a test suite for the finer points of this gem, including Travis CI support.
+
 ## v0.2.1 (2013-02-25) ##
 
 * Loosen dependency on railties to allow 4.0.

data/{lib/LICENSE → LICENSE}

@@ -1,4 +1,4 @@
-Copyright (C) 2011 Alex Robbin
+Copyright (C) 2013 Alex Robbin
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

data/README.md

@@ -1,5 +1,6 @@
-Highcharts JS Rails
-===================
+# Highcharts JS Rails
+
+[![Build Status](https://secure.travis-ci.org/agrobbin/highcharts-js-rails.png?branch=master)](https://travis-ci.org/agrobbin/highcharts-js-rails) [![Dependency Status](https://gemnasium.com/agrobbin/highcharts-js-rails.png)](https://gemnasium.com/agrobbin/highcharts-js-rails)
 
 Easily configure a Highcharts JS chart for use in a Rails application.
 
@@ -25,28 +26,30 @@ Many have a default option assigned to them. Those that have one are listed belo
 * yAxis.labels: enabled (Boolean)
 * yAxis.title: text (String)
 
-xAxis Notes
--------
+## Requirements
+
+Highcharts JS Rails requires **Ruby 1.9.2+** and **Rails 3.1+**.
+
+## xAxis Notes
 
 * The `categories` option's array of values will be automatically formatted based on its class unless you pass :skip_category_formatting => true.
 * The `tickInterval` option is only necessary if you want to override automatic tickInterval creation. If the option is not passed or :auto is passed, the tickInterval will be calculated based on the number of categories passed.
 
 For the xAxis, yAxis, and series options, you must pass an array of hashes. Each of those hashes will be converted into the appropriate set of options.
 
-Example
---------
+## Example
 
 Ruby:
 
 ```ruby
 chart = Highcharts.new do |chart|
-  chart.chart(:renderTo => 'graph')
+  chart.chart(renderTo: 'graph')
   chart.title('Highcharts Example')
-  chart.xAxis(:categories => ['October 12', 'October 13', 'October 14'])
-  chart.yAxis(:title => 'Impressions', :min => 0)
-  chart.series(:name => 'Impressions', :yAxis => 0, :type => 'line', :data => [100000, 122000, 127000])
-  chart.legend(:layout => 'vertical', :align => 'right', :verticalAlign => 'top', :x => -10, :y => 100, :borderWidth => 0)
-  chart.tooltip(:formatter => "function(){ return '<b>' + this.series.name + '</b><br/>' + this.x + ': ' + this.y; }")
+  chart.xAxis(categories: ['October 12', 'October 13', 'October 14'])
+  chart.yAxis(title: 'Impressions', min: 0)
+  chart.series(name: 'Impressions', yAxis: 0, type: 'line', data: [100000, 122000, 127000])
+  chart.legend(layout: 'vertical', align: 'right', verticalAlign: 'top', x: -10, y: 100, borderWidth: 0)
+  chart.tooltip(formatter: "function(){ return '<b>' + this.series.name + '</b><br/>' + this.x + ': ' + this.y; }")
 end
 ```
 
@@ -55,4 +58,4 @@ HTML/ERB:
 ```html+erb
 <%= chart %>
 <div id="graph" style="width: 400px; height: 200px;"></div>
-```
+```

data/highcharts-js-rails.gemspec

@@ -1,11 +1,9 @@
 # -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-
 Gem::Specification.new do |s|
   s.name        = 'highcharts-js-rails'
-  s.version     = '0.2.1'
+  s.version     = '1.0.0'
   s.authors     = ['Alex Robbin']
-  s.email       = ['agrobbin@gmail.com']
+  s.email       = ['alex@robbinsweb.biz']
   s.homepage    = 'https://github.com/agrobbin/highcharts-js-rails'
   s.summary     = %q{Easily configure a Highcharts JS chart for use in a Rails application}
   s.description = s.summary
@@ -17,7 +15,7 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ['lib']
 
-  s.add_dependency 'railties', '>= 3.1'
+  s.add_dependency 'railties', ['>= 3.1', '< 4.1']
   s.add_development_dependency 'bundler'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec'

data/lib/highcharts-js-rails.rb

@@ -8,7 +8,7 @@ require 'highcharts/axis/stack_labels'
 require 'highcharts/axis/x'
 require 'highcharts/axis/y'
 require 'highcharts/chart'
-require 'highcharts/color'
+require 'highcharts/colors'
 require 'highcharts/credits'
 require 'highcharts/labels'
 require 'highcharts/legend'

data/lib/highcharts.rb

@@ -1,4 +1,5 @@
 require 'action_view'
+require 'active_support/core_ext/object/to_json'
 
 class Highcharts < ActionView::Base
   include ActionView::Helpers
@@ -8,8 +9,8 @@ class Highcharts < ActionView::Base
   def initialize
     @options = {}
 
-    @base_options = %w(labels lang loading)
-    @default_options = %w(chart colors credits legend point series symbols title tooltip)
+    @base_options = %w(global labels lang loading navigation pane)
+    @default_options = %w(chart colors credits legend series title tooltip)
     @custom_options = {
       'plotOptions' => 'PlotOptions',
       'subtitle' => 'Title',
@@ -17,7 +18,7 @@ class Highcharts < ActionView::Base
       'yAxis' => 'Axis::Y'
     }
 
-    yield self
+    yield self if block_given?
   end
 
   def inspect

data/lib/highcharts/axis/plot_bands.rb

@@ -4,7 +4,7 @@ class Highcharts
 
       def initialize(opts = {})
         @suboptions = {
-          :label => 'Base'
+          label: 'Base'
         }
         super
       end

data/lib/highcharts/axis/plot_lines.rb

@@ -4,7 +4,7 @@ class Highcharts
 
       def initialize(opts = {})
         @suboptions = {
-          :label => 'Base'
+          label: 'Base'
         }
         super
       end

data/lib/highcharts/axis/x.rb

@@ -7,11 +7,11 @@ class Highcharts
       def initialize(opts = {})
         @default = :categories
         @suboptions = {
-          :events => 'Axis::Events',
-          :labels => 'Labels',
-          :plotBands => 'Axis::PlotBands',
-          :plotLines => 'Axis::PlotLines',
-          :title => 'Title'
+          events: 'Axis::Events',
+          labels: 'Labels',
+          plotBands: 'Axis::PlotBands',
+          plotLines: 'Axis::PlotLines',
+          title: 'Title'
         }
         # Check to see if we want to skip automatic formatting of categories.
         @skip_category_formatting = true if opts.delete(:skip_category_formatting)
@@ -40,14 +40,12 @@ class Highcharts
         #   DateTime
         #
         # If the class of the category is none of the above, #to_s is returned.
-        # You can prevent this by passing :skip_category_formatting => true to the Axis options.
+        # You can prevent this by passing `skip_category_formatting: true` to the Axis options.
         def format_category(category)
           case category
           when Date
             category.strftime("%b. %d")
           when Time || DateTime
-          #   category.strftime("%H:%M")
-          # when DateTime
             category.strftime("%b. %d, %H:%M")
           else
             category.to_s

data/lib/highcharts/axis/y.rb

@@ -5,12 +5,12 @@ class Highcharts
       def initialize(opts = {})
         @default = :title
         @suboptions = {
-          :events => 'Axis::Events',
-          :labels => 'Labels',
-          :plotBands => 'Axis::PlotBands',
-          :plotLines => 'Axis::PlotLines',
-          :stackLabels => 'Axis::StackLabels',
-          :title => 'Title'
+          events: 'Axis::Events',
+          labels: 'Labels',
+          plotBands: 'Axis::PlotBands',
+          plotLines: 'Axis::PlotLines',
+          stackLabels: 'Axis::StackLabels',
+          title: 'Title'
         }
         super
       end

data/lib/highcharts/base.rb

@@ -1,5 +1,3 @@
-require 'rails'
-
 class Highcharts
   class Base
 
@@ -19,6 +17,7 @@ class Highcharts
           raise ArgumentError, "You must pass a Hash to #{self.class}. You passed #{options.inspect}"
         end
       end
+
       # If there is an option that is available as a suboption to the current class,
       # let's set the option to an instance of that subclass.
       options.each do |k, v|
@@ -41,12 +40,13 @@ class Highcharts
       json.join(',')
     end
 
-    # This method is used in #to_json to remove the first and last characters from an option's value.
-    # In the end this removes the encapsulating quotation marks (") from a specific option, provided
-    # it is included in the current class's skip_quotation array.
-    def check_quotation(key, json)
-      skip_quotation.present? && Array.wrap(skip_quotation).include?(key) ? json[1..-2] : json
-    end
+    private
+      # This method is used in #to_json to remove the first and last characters from an option's value.
+      # In the end this removes the encapsulating quotation marks (") from a specific option, provided
+      # it is included in the current class's skip_quotation array.
+      def check_quotation(key, json)
+        skip_quotation.present? && Array.wrap(skip_quotation).include?(key) ? json[1..-2] : json
+      end
 
   end
 end

data/lib/highcharts/engine.rb

@@ -1,3 +1,5 @@
+require 'rails'
+
 class Highcharts
   class Engine < ::Rails::Engine
   end

data/lib/highcharts/legend.rb

@@ -5,10 +5,10 @@ class Highcharts
       @default = :enabled
       @skip_quotation = :labelFormatter
       @suboptions = {
-        :navigation => 'Base'
+        navigation: 'Base'
       }
       super
     end
 
   end
-end
+end

data/lib/highcharts/plot_options.rb

@@ -3,19 +3,19 @@ class Highcharts
 
     def initialize(opts = {})
       @suboptions = {
-        :area => 'PlotOptions::PlotType',
-        :arearange => 'PlotOptions::PlotType',
-        :areaspline => 'PlotOptions::PlotType',
-        :areasplinerange => 'PlotOptions::PlotType',
-        :bar => 'PlotOptions::PlotType',
-        :column => 'PlotOptions::PlotType',
-        :columnrange => 'PlotOptions::PlotType',
-        :gauge => 'PlotOptions::PlotType',
-        :line => 'PlotOptions::PlotType',
-        :pie => 'PlotOptions::PlotType',
-        :series => 'PlotOptions::PlotType',
-        :scatter => 'PlotOptions::PlotType',
-        :spline => 'PlotOptions::PlotType'
+        area: 'PlotOptions::PlotType',
+        arearange: 'PlotOptions::PlotType',
+        areaspline: 'PlotOptions::PlotType',
+        areasplinerange: 'PlotOptions::PlotType',
+        bar: 'PlotOptions::PlotType',
+        column: 'PlotOptions::PlotType',
+        columnrange: 'PlotOptions::PlotType',
+        gauge: 'PlotOptions::PlotType',
+        line: 'PlotOptions::PlotType',
+        pie: 'PlotOptions::PlotType',
+        series: 'PlotOptions::PlotType',
+        scatter: 'PlotOptions::PlotType',
+        spline: 'PlotOptions::PlotType'
       }
       super
     end

data/lib/highcharts/plot_options/plot_type.rb

@@ -4,13 +4,13 @@ class Highcharts
 
       def initialize(opts = {})
         @suboptions = {
-          :dataLabels => 'Labels',
-          :dial => 'Base',
-          :events => 'PlotOptions::PlotType::Events',
-          :marker => 'PlotOptions::PlotType::Marker',
-          :pivot => 'Base',
-          :point => 'Point',
-          :states => 'PlotOptions::PlotType::States'
+          dataLabels: 'Labels',
+          dial: 'Base',
+          events: 'PlotOptions::PlotType::Events',
+          marker: 'PlotOptions::PlotType::Marker',
+          pivot: 'Base',
+          point: 'Point',
+          states: 'PlotOptions::PlotType::States'
         }
         super
       end

data/lib/highcharts/plot_options/plot_type/marker.rb

@@ -6,7 +6,7 @@ class Highcharts
         def initialize(opts = {})
           @default = :enabled
           @suboptions = {
-            :states => 'PlotOptions::PlotType::Marker::States'
+            states: 'PlotOptions::PlotType::Marker::States'
           }
           super
         end

data/lib/highcharts/plot_options/plot_type/marker/states.rb

@@ -6,8 +6,8 @@ class Highcharts
 
           def initialize(opts = {})
             @suboptions = {
-              :hover => 'Base',
-              :select => 'Base'
+              hover: 'Base',
+              select: 'Base'
             }
             super
           end

data/lib/highcharts/plot_options/plot_type/states.rb

@@ -5,7 +5,7 @@ class Highcharts
 
         def initialize(opts = {})
           @suboptions = {
-            :hover => 'PlotOptions::PlotType::States::Hover'
+            hover: 'PlotOptions::PlotType::States::Hover'
           }
           super
         end

data/lib/highcharts/plot_options/plot_type/states/hover.rb

@@ -6,7 +6,7 @@ class Highcharts
 
           def initialize(opts = {})
             @suboptions = {
-              :marker => 'Base'
+              marker: 'Base'
             }
             super
           end

data/lib/highcharts/point.rb

@@ -3,8 +3,8 @@ class Highcharts
 
     def initialize(opts = {})
       @suboptions = {
-        :events => 'Point::Events',
-        :marker => 'Base'
+        events: 'Point::Events',
+        marker: 'Base'
       }
       super
     end

data/spec/highcharts/axis/x_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+describe Highcharts::Axis::X do
+
+  subject { Highcharts::Axis::X.new(options) }
+
+  describe "#automate_tick_interval" do
+    let(:options) { {categories: (1..50).to_a} }
+
+    its(:to_json) { should include("\"tickInterval\":7") }
+
+    context "when tickInterval is explicitly passed" do
+      let(:options) { {tickInterval: 5} }
+
+      its(:to_json) { should eq("\"tickInterval\":5") }
+    end
+
+    context "when tickInterval is :auto" do
+      let(:options) { {categories: [1], tickInterval: :auto} }
+
+      its(:to_json) { should include("\"tickInterval\":1") }
+    end
+  end
+
+  describe "#format_category" do
+    context "when :skip_category is passed" do
+      let(:options) { {categories: [Date.new(2013, 1, 1)], skip_category_formatting: true} }
+
+      its(:to_json) { should include("\"categories\":[\"2013-01-01\"]") }
+    end
+
+    context "dates" do
+      let(:options) { {categories: [Date.new(2013, 1, 1), Date.new(2013, 2, 1)]} }
+
+      its(:to_json) { should include("\"categories\":[\"Jan. 01\",\"Feb. 01\"]") }
+    end
+
+    context "full dates and times" do
+      let(:options) { {categories: [Time.new(2013, 1, 1, 1, 1), Time.new(2013, 2, 1, 1, 1)]} }
+
+      its(:to_json) { should include("\"categories\":[\"Jan. 01, 01:01\",\"Feb. 01, 01:01\"]") }
+    end
+
+    context "other types of categories" do
+      let(:options) { {categories: [1, 2, 3, 4, 5]} }
+
+      its(:to_json) { should include("\"categories\":[\"1\",\"2\",\"3\",\"4\",\"5\"]") }
+    end
+  end
+
+end