highcharts_on_rails 0.0.1.alpha

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 YOURNAME
+
+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:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,3 @@
+= HighchartsOnRails
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,40 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'HighchartsOnRails'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/app/assets/javascripts/highcharts_on_rails/application.js.coffee

@@ -0,0 +1,15 @@
+# This is a manifest file that'll be compiled into application.js, which will include all the files
+# listed below.
+#
+# Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+# or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+#
+# It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+# the compiled file.
+#
+# WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+# GO AFTER THE REQUIRES BELOW.
+#
+#= require jquery
+#= require jquery_ujs
+#= require_tree .

data/app/assets/javascripts/highcharts_on_rails/charts.coffee

@@ -0,0 +1,6 @@
+window.highChart = (config, callback) ->  new Highcharts.Chart(config, callback)
+
+window.radializeColors = (colors) ->
+  $.map(colors, (color)  ->
+    return { radialGradient: { cx: 0.5, cy: 0.3, r: 0.7 }, stops: [[0, color], [1, Highcharts.Color(color).brighten(-0.3).get('rgb')]] }
+  )

data/app/assets/stylesheets/highcharts_on_rails/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/app/controllers/highcharts_on_rails/application_controller.rb

@@ -0,0 +1,4 @@
+module HighchartsOnRails
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/helpers/highcharts_on_rails/application_helper.rb

@@ -0,0 +1,20 @@
+module HighchartsOnRails
+  module ApplicationHelper
+    def highchart(_chart)
+
+      if Rails.env.development?
+        puts "--------------------------------------"
+        puts "highChart(#{_chart.to_json})"
+      end
+
+      content_tag(:div, '', :id => _chart.container) + javascript_tag(<<JAVASCRIPT
+    try {
+    window.#{_chart.container}_chart = highChart(#{_chart.to_json});
+    } catch(err) {
+    console.log(err);
+    }
+JAVASCRIPT
+      )
+    end
+  end
+end

data/app/views/layouts/highcharts_on_rails/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>HighchartsOnRails</title>
+  <%= stylesheet_link_tag    "highcharts_on_rails/application", :media => "all" %>
+  <%= javascript_include_tag "highcharts_on_rails/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,2 @@
+HighchartsOnRails::Engine.routes.draw do
+end

data/lib/highcharts_on_rails/bar_chart.rb

@@ -0,0 +1,39 @@
+class HighchartsOnRails::BarChart < HighchartsOnRails::BaseChart
+  add_json({
+               chart: {
+                   type: 'bar',
+                   marginRight: 50
+               },
+               tooltip: {
+                   formatter: "function () { return this.series.name + ': ' + this.y + ''; }"
+               },
+               yAxis: {
+                   max: 100,
+                   title: {
+                       text: ''
+                   }
+               },
+               plotOptions: {
+                   bar: {
+                       dataLabels: {
+                           enabled: true,
+                           formatter: "function () { return this.y + '%'; }",
+                           style: {
+                               fontWeight: 'bold',
+                               fontSize: '10px',
+                               color: "#373535"
+                           }
+                       },
+                       enableMouseTracking: false
+                   }
+               },
+               legend: false,
+               title: false
+           })
+
+
+  def add_series(label, data, options={})
+    @_series ||= []
+    @_series.unshift({name: label, data: data})
+  end
+end

data/lib/highcharts_on_rails/base_chart.rb

@@ -0,0 +1,118 @@
+class HighchartsOnRails::BaseChart
+  attr_reader :container
+  class_attribute :json_hash, :functions_array
+
+  def initialize(&block)
+    block.call(self)
+  end
+
+  def self.add_json(_json_hash)
+    self.json_hash ||= {}
+    self.json_hash = json_hash.deep_merge(_json_hash)
+  end
+
+  def self.add_function(_function_string)
+    self.functions_array ||= []
+    self.functions_array += [_function_string]
+  end
+
+  # Defaults
+  add_json({exporting: {enabled: false}, credits: {enabled: false}})
+
+  def to_json
+    [dump_json, dump_function].compact.join(',')
+  end
+
+  def add_json(_json_hash)
+    @_json_customizations ||= []
+    @_json_customizations << _json_hash
+  end
+
+  def add_function(_function_string)
+    @_functions ||= []
+    @_functions << _function_string
+  end
+
+  def add_series(label, data, options={})
+    raise NotImplementedError, "The look of series differ between charts, therefore this needs to be implemented in subclass"
+  end
+
+
+  #==================================
+  #========== JSON Helpers ==========
+  #==================================
+
+  def set_container(name)
+    @container = name
+    add_json({chart: {renderTo: name}})
+  end
+
+  def colors(colors_array)
+    _colors_array = preprocess_gradients(colors_array)
+
+    add_json(colors: _colors_array)
+  end
+
+  def text_color(color)
+    add_json(title: {style: {color: color}})
+  end
+
+  def title(text)
+    add_json({title: {text: text}})
+  end
+
+  def subtitle(text)
+    add_json({subtitle: {text: text}})
+  end
+
+  def height(pixels)
+    add_json({chart: {height: pixels}})
+  end
+
+  def width(pixels)
+    add_json({chart: {width: pixels}})
+  end
+
+  def categories(categories)
+    add_json({xAxis: {categories: categories}})
+  end
+
+
+  private
+
+  def preprocess_gradients(colors_array)
+    colors_array.map do |color_definition|
+      if color_definition =~ />#/
+        color_from, color_to = color_definition.split('>')
+        gradient(color_from, color_to)
+      else
+        color_definition
+      end
+    end
+  end
+
+  def gradient(start, stop)
+    {
+        linearGradient: {x1: 0, y1: 0, x2: 1, y2: 0},
+        stops: [[0, start], [1, stop]]
+    }
+  end
+
+  def dump_json
+    final_json_hash.to_json.gsub(/"function[^"]+"/) { |m| m.gsub('"', '') }
+  end
+
+  def dump_function
+    "function (chart) { #{(Array.wrap(self.class.functions_array) + Array.wrap(@_functions)).compact.join("\n")} }"
+  end
+
+  def final_json_hash
+    add_json({series: @_series})
+
+    result = self.class.json_hash.deep_dup
+    @_json_customizations.each do |_json_hash|
+      result = result.deep_merge(_json_hash)
+    end
+    result
+  end
+end

data/lib/highcharts_on_rails/column_chart.rb

@@ -0,0 +1,41 @@
+class HighchartsOnRails::ColumnChart < HighchartsOnRails::BaseChart
+  add_json({
+               chart: {
+                   type: 'column',
+                   marginRight: 50
+               },
+               tooltip: {
+                   formatter: "function () { return this.series.name + ': ' + this.y + ''; }"
+               },
+               yAxis: {
+                   max: 100,
+                   title: {
+                       text: ''
+                   }
+               },
+               plotOptions: {
+                   line: {
+                       dataLabels: {
+                           enabled: true,
+                           formatter: "function () { return this.y + '%'; }",
+                           style: {
+                               fontWeight: 'bold',
+                               fontSize: '10px',
+                               color: "#373535"
+                           }
+                       },
+                       enableMouseTracking: false
+                   }
+               },
+               legend: {
+                   enabled: false
+               },
+               title: false
+           })
+
+
+  def add_series(label, data, options={})
+    @_series ||= []
+    @_series += [{name: label, data: data}]
+  end
+end

data/lib/highcharts_on_rails/engine.rb

@@ -0,0 +1,5 @@
+module HighchartsOnRails
+  class Engine < ::Rails::Engine
+    isolate_namespace HighchartsOnRails
+  end
+end

data/lib/highcharts_on_rails/hollow_pie_chart.rb

@@ -0,0 +1,46 @@
+class HighchartsOnRails::HollowPieChart < HighchartsOnRails::PieChart
+  add_json({
+               plotOptions: {
+                   pie: {
+                       size: "80%",
+                       innerSize: "60%",
+                       dataLabels: {
+                           enabled: false
+                       }
+                   },
+
+               }
+           })
+
+  #============== Helpers ===============
+
+  def with_labels!
+    super
+    add_json({plotOptions: {pie: {size: "60%", innerSize: "40%"}}})
+  end
+
+  def centered_percentage_label(color)
+    centered_label("Math.round(chart.series[0].data[0].percentage) + '%'", color)
+  end
+
+  def centered_count_label(color)
+    centered_label("Math.round(chart.series[0].data[0].y)", color)
+  end
+
+  def centered_label(formula, color)
+    add_function <<END_OF_FORMULA
+        var x = chart.chartWidth / 2,
+            y = chart.chartHeight / 2;
+
+        // Render the text
+        chart.renderer.text(#{formula}, x, y + 5).css({
+            color: '#{color}',
+            fontSize: '18px',
+            fontWeight: 'bold'
+        }).attr({
+            align: 'center',
+            zIndex: 0
+        }).add();
+END_OF_FORMULA
+  end
+end

data/lib/highcharts_on_rails/line_chart.rb

@@ -0,0 +1,35 @@
+class HighchartsOnRails::LineChart < HighchartsOnRails::BaseChart
+  add_json({
+               chart: {
+                   type: 'line'
+               },
+               tooltip: {
+                   enabled: false,
+                   formatter: "function() { return '<b>'+ this.series.name +'</b><br/>'+ this.x +': '+ this.y; }"
+               },
+               yAxis: {
+                   min: 0,
+                   title: {
+                       text: ''
+                   }
+               },
+               plotOptions: {
+                   line: {
+                       dataLabels: {
+                           enabled: true
+                       },
+                       enableMouseTracking: false
+                   }
+               },
+           })
+
+
+  def add_series(label, data, options={})
+    @_series ||= []
+    @_series += [{name: label, data: data}]
+  end
+
+  def color(color)
+    add_json({plotOptions: {series: {color: color}}})
+  end
+end

data/lib/highcharts_on_rails/pie_chart.rb

@@ -0,0 +1,80 @@
+class HighchartsOnRails::PieChart < HighchartsOnRails::BaseChart
+  add_json({
+               title: {
+                   style: {
+                       color: '#726E6C',
+                       fontWeight: 'bold'
+                   },
+                   text: "",
+                   floating: true
+               },
+               xAxis: {
+                   categories: nil
+               },
+               chart: {
+                   type: "pie",
+                   borderWidth: false,
+                   borderColor: false,
+               },
+               plotOptions: {
+                   pie: {
+                       size: "80%",
+                       dataLabels: {
+                           enabled: false
+                       }
+                   },
+                   series: {
+                       shadow: false
+                   }
+               },
+               tooltip: {
+                   formatter: "function () {return this.point.name + ':</b> <b>' + this.y + '</b>';}"
+               }
+           })
+
+
+  def add_series(label, data, options={})
+    labels = Array.wrap(label)
+    @_series ||= []
+    @_series.unshift({name: '', data: construct_series_data(data, labels)})
+  end
+
+  #We need this fancy hash for pie charts :/
+  def construct_series_data(data, labels)
+    colors = Array.new(data.size) { get_color }
+
+    if (lsize = labels.size) < data.size
+      labels = labels.fill(nil, lsize, data.size-lsize)
+    end
+
+    [data, labels, colors].transpose.map do |y, name, color|
+      {'color' => color, 'y' => y, 'name' => name}
+    end
+  end
+
+  #============== Helpers ===============
+
+  def with_labels!
+    add_json({plotOptions: {pie: {size: "90%", dataLabels: {enabled: true,
+                                                            formatter: "function() { return '<b>'+ this.point.name +'</b>: '+ Math.round(this.percentage) +' %'; }",
+                                                            distance: 5,
+                                                            softConnector: false}}}})
+  end
+
+
+  def colors(_colors)
+    @colors = _colors
+  end
+
+  private
+
+  def get_colors
+    @colors ||= %w(#FF0000 #FFFFFF)
+  end
+
+  def get_color
+    color = get_colors.first
+    @colors.rotate!
+    color
+  end
+end

data/lib/highcharts_on_rails/stacked_bar_chart.rb

@@ -0,0 +1,26 @@
+class HighchartsOnRails::StackedBarChart < HighchartsOnRails::BarChart
+  add_json({
+               plotOptions: {
+                   series: {
+                       stacking: 'percent'
+                   },
+                   bar: {
+                       dataLabels: {
+                           formatter: "function() { return this.y > 0 ? (Math.round(this.percentage) +'%') : ''; }"
+                       }
+                   }
+               },
+               legend: {
+                   borderColor: false,
+                   backgroundColor: false,
+                   verticalAlign: 'top',
+                   reversed: true,
+                   enabled: true
+               }
+           })
+
+  def title(text)
+    super
+    add_json({legend: {y: 20}, chart: {marginTop: 60}})
+  end
+end

data/lib/highcharts_on_rails/version.rb

@@ -0,0 +1,3 @@
+module HighchartsOnRails
+  VERSION = "0.0.1.alpha"
+end

data/lib/highcharts_on_rails.rb

@@ -0,0 +1,11 @@
+require "highcharts_on_rails/engine"
+require "highcharts_on_rails/base_chart"
+require "highcharts_on_rails/bar_chart"
+require "highcharts_on_rails/column_chart"
+require "highcharts_on_rails/pie_chart"
+require "highcharts_on_rails/hollow_pie_chart"
+require "highcharts_on_rails/line_chart"
+require "highcharts_on_rails/stacked_bar_chart"
+
+module HighchartsOnRails
+end

data/lib/tasks/highcharts_on_rails_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :highcharts_on_rails do
+#   # Task goes here
+# end