chartjs-ror 1.0.0 → 1.0.1

data/README.md

@@ -6,6 +6,8 @@ Simplifies using [Chart.js][] in Rails views.
 * Legends for your charts.
 * Renders charts on page load rather than DOMContentReady ([reason][browsersupport]).
 * Animates unless you have Modernizr and it doesn't detect canvas support ([reason][browsersupport]).  You can manually override this.
+* Optional alternative (better?) abscissa scale calculations.
+* Utility method for filling in gaps in integer series.
 
 NOTE: this is Rails 3.0 only at the moment, so pre-asset pipeline.  I plan to upgrade soon.
 
@@ -165,7 +167,7 @@ And in Ruby:
 
 You can put anything in the `options` hash that Chart.js recognises.  It also supports these non-Chart.js settings:
 
-* `:css_class` - class of the enclosing `<figure/>` - default is `chart`.
+* `:class` - class of the enclosing `<figure/>` - default is `chart`.
 * `:element_id` - id of the `<canvas/>` - default is `chart-n` where `n` is the 0-based index of the chart on the page.
 * `:width` - width of the canvas in px - default is `400`.
 * `:height` - height of the canvas in px - default is `400`.
@@ -214,6 +216,11 @@ Each item in the legend array is given two classes:
 This lets you style legends in general but override the styles for specific charts.
 
 
+### Scale calculations
+
+The plugin implements its own abscissa scale calculations which I prefer to Chart.js's.  You can opt-in to these calculations by passing `scaleOverride: true` in the `options` hash, without any of the other scale override keys (`scaleSteps`, `scaleStepWidth`, `scaleStartValue`).
+
+
 ## Inspiration
 
 * [Chart.js][] (obviously)

data/Rakefile

@@ -1 +1,8 @@
 require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose  = true
+end

data/chartjs-ror.gemspec

@@ -16,4 +16,7 @@ Gem::Specification.new do |gem|
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
+
+  gem.add_dependency 'activesupport', '>3'
+  gem.add_development_dependency 'rake'
 end

data/lib/chartjs/axis_helpers.rb

@@ -0,0 +1,130 @@
+require 'active_support'
+
+module Chartjs
+  module AxisHelpers
+
+    # Returns an ordered copy of data with "missing" keys mapped to 0 values.
+    #
+    # data - a Hash of Integer keys mapped to to Integer values.
+    #
+    # Returns an OrderedHash whose Integer keys run from 0 to data's maximum key
+    # and whose values are the corresponding values in data or 0.
+    def series(data)
+      return {} if data.nil? || data.empty?
+      (0..data.keys.max).reduce(ActiveSupport::OrderedHash.new) { |hash,k| hash[k] = data[k] || 0; hash }
+    end
+
+    # Calculates the number of steps and the step width for ordinate axis labels.
+    # The ordinate axis is assumed to start at 0.
+    #
+    # data - an Array of Numerics.
+    #
+    # Returns a Hash with:
+    #   :scaleSteps      - the number of steps (always <= 10)
+    #   :scaleStepWidth  - the value jump between steps
+    #   :scaleStartValue - 0
+    def ordinate_scale(data)
+      scale_max = calculate_scale_max data.max
+      normalised_scale_max = normalise scale_max
+
+      # normalised_scale_max  number_steps  step_width
+      #          0                 0           0
+      #          0.5               5           1
+      #          1                 5           2
+      #          1.5               5           3
+      #          2                 4           5
+      #          2.5               5           5
+      #          3                 6           5
+      #          3.5               7           5
+      #          4                 8           5
+      #          4.5               9           5
+      #          5                10           5
+      #          5.5               6          10
+      #          6                 6          10
+      #          6.5               7          10
+      #          7                 7          10
+      #          7.5               8          10
+      #          8                 8          10
+      #          8.5               9          10
+      #          9                 9          10
+      #          9.5              10          10
+      if normalised_scale_max.zero?
+        number_steps = 0
+        step_width = 0
+      elsif normalised_scale_max < 2
+        number_steps = 5
+        step_width = scale_max / number_steps
+      elsif normalised_scale_max < 5.5
+        step_width = 5 * 10**(order_of_magnitude(scale_max) - 1)
+        number_steps = scale_max / step_width.to_f
+      else
+        step_width = 10**(order_of_magnitude(scale_max))
+        number_steps = scale_max / step_width.to_f
+      end
+
+      {scaleSteps: number_steps.ceil, scaleStepWidth: step_width, scaleStartValue: 0}
+    end
+
+    # Rounds up value to the next "increment", where an increment is half
+    # the order of magnitude value.
+    #
+    # value - a Numeric.
+    #
+    # Examples
+    #
+    #   input  output
+    #     12     15
+    #     15     15
+    #     16     20
+    #   1432   1500
+    #   7654   8000
+    #
+    # Returns an Integer.
+    def calculate_scale_max(value)
+      normalised = normalise value
+      quotient, modulus = normalised.divmod 1
+      next_increment = if modulus.zero?
+                         quotient
+                       elsif modulus <= 0.5
+                         quotient + 0.5
+                       else
+                         quotient + 1
+                       end
+      (next_increment * 10**(order_of_magnitude(value))).to_i
+    end
+
+    # Normalises the value to between 0 inclusive and 10.
+    #
+    # value - a Numeric.
+    #
+    # Returns a Float or 0 if value is nil or zero..
+    def normalise(value)
+      return 0 if value.nil? || value.zero?
+      value.to_f / 10**(order_of_magnitude(value))
+    end
+
+    # Calculates the order of magnitude of value.
+    #
+    # value - a Numeric.
+    #
+    # Examples
+    #
+    #   order_of_magnitude(3)
+    #   # => 1
+    #
+    #   order_of_magnitude(13)
+    #   # => 1
+    #
+    #   order_of_magnitude(153)
+    #   # => 2
+    #
+    # Returns a Integer or 0 if value is nil or zero.
+    def order_of_magnitude(value)
+      return 0 if value.nil? || value.zero?
+      magnitude = Math.log10 value
+      order_of_magnitude = magnitude.floor
+      order_of_magnitude.zero? ? 1 : order_of_magnitude
+    end
+
+  end
+end

data/lib/chartjs/chart_helpers.rb

@@ -56,6 +56,11 @@ module Chartjs
                  ''
                end
 
+      # Alternative scale calculations.
+      if options[:scaleOverride] && !options.has_key?(:scaleSteps)
+        options.merge! ordinate_scale(combined_data(datasets))
+      end
+
       script = javascript_tag do
         <<-END.html_safe
         var initChart = function() {
@@ -87,5 +92,9 @@ module Chartjs
       end
     end
 
+    def combined_data(datasets)
+      datasets.map { |d| d[:data] || d[:value] }.flatten
+    end
+
   end
 end

data/lib/chartjs/railtie.rb

@@ -1,9 +1,11 @@
 require 'chartjs/chart_helpers'
+require 'chartjs/axis_helpers'
 
 module Chartjs
   class Railtie < Rails::Railtie
     initializer 'chartjs.chart_helpers' do
       ActionView::Base.send :include, Chartjs::ChartHelpers
+      ActionView::Base.send :include, Chartjs::AxisHelpers
     end
   end
 end

data/lib/chartjs/version.rb

@@ -1,3 +1,3 @@
 module Chartjs
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/test/axis_helpers_test.rb

@@ -0,0 +1,64 @@
+require 'minitest/autorun'
+require 'chartjs/axis_helpers'
+
+class AxisHelpersTest < MiniTest::Unit::TestCase
+
+  def setup
+    @subject = Object.new
+    @subject.extend Chartjs::AxisHelpers
+  end
+
+  def test_series_empty_data
+    data = {}
+    result = @subject.series data
+    assert_equal 0, result.length
+  end
+
+  def test_series
+    data = { 2 => 42 }
+    result = @subject.series data
+    assert_equal 3, result.length
+    assert_equal({0 => 0, 1 => 0, 2 => 42}, result)
+  end
+
+  def test_calculate_scale_max
+    {
+         0 =>    0,
+         3 =>    5,
+         5 =>    5,
+         6 =>   10,
+         9 =>   10,
+        10 =>   10,
+        12 =>   15,
+        16 =>   20,
+        60 =>   60,
+        65 =>   65,
+       601 =>  650,
+      1430 => 1500,
+      7654 => 8000,
+    }.each do |input, expected_output|
+      assert_equal expected_output, @subject.calculate_scale_max(input)
+    end
+  end
+
+  def test_ordinate_scale
+    data = []
+    assert_equal({scaleSteps: 0, scaleStepWidth: 0, scaleStartValue: 0}, @subject.ordinate_scale(data))
+
+    data = [ 12 ]
+    assert_equal({scaleSteps: 5, scaleStepWidth: 3, scaleStartValue: 0}, @subject.ordinate_scale(data))
+
+    data = [ 33 ]
+    assert_equal({scaleSteps: 7, scaleStepWidth: 5, scaleStartValue: 0}, @subject.ordinate_scale(data))
+
+    data = [ 601 ]
+    assert_equal({scaleSteps: 7, scaleStepWidth: 100, scaleStartValue: 0}, @subject.ordinate_scale(data))
+
+    data = [ 999 ]
+    assert_equal({scaleSteps: 5, scaleStepWidth: 200, scaleStartValue: 0}, @subject.ordinate_scale(data))
+
+    data = [ 13001 ]
+    assert_equal({scaleSteps: 5, scaleStepWidth: 3000, scaleStartValue: 0}, @subject.ordinate_scale(data))
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chartjs-ror
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,40 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-06 00:00:00.000000000 Z
-dependencies: []
+date: 2013-06-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Simplifies using Chart.js in Rails
 email:
 - boss@airbladesoftware.com
@@ -26,9 +58,11 @@ files:
 - chartjs-ror.gemspec
 - lib/chartjs-ror.rb
 - lib/chartjs.rb
+- lib/chartjs/axis_helpers.rb
 - lib/chartjs/chart_helpers.rb
 - lib/chartjs/railtie.rb
 - lib/chartjs/version.rb
+- test/axis_helpers_test.rb
 homepage: https://github.com/airblade/chartjs-ror
 licenses: []
 post_install_message: 
@@ -53,4 +87,5 @@ rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Simplifies using Chart.js in Rails
-test_files: []
+test_files:
+- test/axis_helpers_test.rb