chartify 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2f754d491ce71c728183aefc7185bfafa1640e5d
+  data.tar.gz: 7dac10f51fc23054e640b775ea81faebe53eb7c7
+SHA512:
+  metadata.gz: b9b855fa25fb15fb6ec2da9c9adb192664c6300686cd9b3b7f2b03ae66b4b0ba3b5c43f360e31d26bb60b8da34e33c773489db790f35e56f5aa12e5d01744cfb
+  data.tar.gz: 852b34561415658344c9ab8a1be2583988d5a86056ea551de2ac7f33d65eba80d5c9d5880930f0a4a93ae6663ea77105033ce81272416c3b72358eb86c54f478

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 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.md

@@ -0,0 +1,48 @@
+Charter
+=======
+The purpose of this gem is to capture data to create a chart, in an object, so that we can do the following things
+
+- Render javascript graph, (which can be chart library agnostic)
+- Create the chart data using ruby only (no js to render chart)
+- Export chart as image (Needed when you want to email a chart)
+- Configuration for chart colors
+
+Note
+----
+The project is in progress. So please wait for the release.
+
+The project is similar to [chartkick](http://chartkick.com/). The reason I am planning to create another project
+is because it does not support to export charts in image.
+
+Charts supported
+----------------
+* Line chart
+* Bar chart
+* Pie chart
+
+For generating image from the chart data we are using [Gruff](https://github.com/topfunky/gruff)
+
+Here are some sample code to generate graph object and render to web.
+```ruby
+@chart = Charter::Factory.build(:line) do |chart|
+  chart.data = [{hours_remain: 100, estimated_hours_remain: 100, day: 3.days.ago.to_date},
+                {hours_remain: 50, estimated_hours_remain: 45, day: 2.days.ago.to_date},
+                {hours_remain: 5, estimated_hours_remain: 10, day: 1.days.ago.to_date}]
+  chart.columns = {hours_remain: 'Hours remaining', estimated_hours_remain: 'Estimated hours remaining'}
+  chart.label_column = :day
+end
+```
+In the web page,
+```erb
+<div id="chart" style="width: 900px; height: 180px;"></div>
+<%= @chart.render_chart('chart') %>
+```
+To export the chart as image,
+```ruby
+@chart.to_blob
+```
+Now you can attach the blob to email or in the PDF file.
+
+License
+-------
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,37 @@
+#!/usr/bin/env rake
+# encoding: utf-8
+
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task :default => "spec:all"
+
+namespace :spec do
+  desc "Run Tests against all ORMs"
+  task :all do
+    sh "bundle --quiet"
+    sh "bundle exec rake spec"
+  end
+end
+
+begin
+  require 'rdoc/task'
+
+  Rake::RDocTask.new do |rdoc|
+    require 'charter/version'
+
+    rdoc.rdoc_dir = 'rdoc'
+    rdoc.title = "Charter #{Charter::VERSION}"
+    rdoc.rdoc_files.include('README*')
+    rdoc.rdoc_files.include('lib/**/*.rb')
+  end
+rescue LoadError
+  puts 'RDocTask is not supported on this VM and platform combination.'
+end

data/lib/charter.rb

@@ -0,0 +1,29 @@
+module Charter
+  autoload :Configuration, "charter/config"
+
+  def self.configure(&block)
+    yield @config ||= Charter::Configuration.new
+  end
+
+  def self.config
+    @config
+  end
+
+  configure do |config|
+    config.web_api_name = :google_chart
+
+    config.web do |wc|
+      wc.background_color = '#FFFFFF'
+      wc.colors = ['#3366CC', # blue
+                   '#DC3912', # red
+                   '#FF9900', # yellow
+                   '#109618', # green
+                   '#990099', # dk purple
+                   '#0099C6', # sky
+                   '#DD4477' # grey
+      ]
+      wc.text_color = '#666666'
+      wc.line_width = 2
+    end
+  end
+end

data/lib/charter/bar_chart.rb

@@ -0,0 +1,28 @@
+require 'charter/chart_base'
+require 'gruff'
+
+module Charter
+  class BarChart < ChartBase
+    def to_blob
+      g = prepare_gruff(:bar)
+
+      columns.each do |column|
+        if column.kind_of?(Array)
+          key, text = column[0], column[1]
+        else
+          key, text = column, column.to_s.humanize
+        end
+
+        g.data(text, data_for_column(key))
+      end
+
+      labels = {}
+      data_for_column(label_column).each_with_index do |label, index|
+        labels[index] = label.to_s
+      end
+
+      g.labels = labels
+      g.to_blob
+    end
+  end
+end

data/lib/charter/chart_base.rb

@@ -0,0 +1,119 @@
+require 'charter/gruff_themes'
+
+module Charter
+  class ChartBase
+    attr_accessor :title, :data, :columns, :label_column
+
+    # data: array of hash
+    # [{date: 2013-1-2, hours_remain: 2, estimated_hours_remain: 10},
+    # {date: 2013-1-3, hours_remain: 4, estimated_hours_remain: 10},
+    # {date: 2013-1-4, hours_remain: 10, estimated_hours_remain: 10}]
+
+    def initialize
+      columns, data = [], []
+    end
+
+    def add_row(row)
+      data << row
+    end
+
+    def render_chart(html_dom_id, options = {})
+      api_name = options[:web_api_name] || Charter.config.web_api_name.to_s
+      class_name = self.class.name.split("::")[1]
+      load "charter/web_chart/#{api_name}/#{class_name.underscore}.rb"
+      chart = "Charter::WebChart::#{api_name.camelize}::#{class_name}".constantize.new
+      chart.data, chart.columns, chart.label_column = self.data, self.columns, self.label_column
+      html = <<-HTML
+      #{chart.include_js if chart.respond_to?(:include_js)}
+      <script type="application/javascript" class="chart_script">
+        #{chart.render(html_dom_id)}
+      </script>
+      HTML
+      html.html_safe
+    end
+
+    def self.evaluate_js
+      "eval($('script.chart_script').text());"
+    end
+
+    protected
+    # @param type - type of the Gruff. It's a factory to create the appropriate
+    def prepare_gruff(type)
+      chart_type = type.to_s.classify
+      chart_type = "Gruff::#{chart_type}".constantize
+
+      g = chart_type.new
+      g.theme = Charter::Themes::GOOGLE_CHART
+      g.title = self.title
+      g
+    end
+
+    def data_for_column(column_name)
+      data.map { |row| row[column_name] }
+    end
+
+    def column_names
+      @column_names ||= begin
+        columns.collect do |column|
+          column.kind_of?(Array) ? column[1] : column.to_s.humanize
+        end
+      end
+    end
+
+    def column_keys
+      @column_keys ||= begin
+        columns.collect do |column|
+          column.kind_of?(Array) ? column[0] : column
+        end
+      end
+    end
+
+    def text_color
+      web_config.text_color
+    end
+
+    def baseline_color
+      text_color
+    end
+
+    def grid_color
+      text_color
+    end
+
+    def bg_color
+      web_config.background_color
+    end
+
+    def web_colors
+      web_config.colors
+    end
+
+    # Amount should be a decimal between 0 and 1. Lower means darker
+    def darken_color(hex_color, amount=0.4)
+      hex_color = hex_color.gsub('#','')
+      rgb = hex_color.scan(/../).map {|color| color.hex}
+      rgb[0] = (rgb[0].to_i * amount).round
+      rgb[1] = (rgb[1].to_i * amount).round
+      rgb[2] = (rgb[2].to_i * amount).round
+      "#%02x%02x%02x" % rgb
+    end
+
+    # Amount should be a decimal between 0 and 1. Higher means lighter
+    def lighten_color(hex_color, amount=0.6)
+      hex_color = hex_color.gsub('#','')
+      rgb = hex_color.scan(/../).map {|color| color.hex}
+      rgb[0] = [(rgb[0].to_i + 255 * amount).round, 255].min
+      rgb[1] = [(rgb[1].to_i + 255 * amount).round, 255].min
+      rgb[2] = [(rgb[2].to_i + 255 * amount).round, 255].min
+      "#%02x%02x%02x" % rgb
+    end
+
+    def config
+      @config ||= Charter.config
+    end
+
+    def web_config
+      @web_config ||= Charter.config.web_config
+    end
+  end
+end

data/lib/charter/config.rb

@@ -0,0 +1,23 @@
+module Charter
+  class Configuration
+    include ActiveSupport::Configurable
+    config_accessor :web_api_name
+    config_accessor :chart
+
+    def web(&block)
+      yield @web_config ||= Charter::WebConfiguration.new
+    end
+
+    def web_config
+      @web_config
+    end
+  end
+
+  class WebConfiguration
+    include ActiveSupport::Configurable
+    config_accessor :background_color
+    config_accessor :colors
+    config_accessor :text_color
+    config_accessor :line_width
+  end
+end

data/lib/charter/factory.rb

@@ -0,0 +1,16 @@
+require 'charter/gruff_themes'
+require 'charter/line_chart'
+require 'charter/pie_chart'
+require 'charter/bar_chart'
+
+module Charter
+  class Factory
+    # @param type can be of line, pie, bar etc
+    def self.build(type, &block)
+      raise "type has to be a symbol" unless type.kind_of? Symbol
+      chart = "Charter::#{type.to_s.camelize}Chart".constantize.new
+      block.call chart
+      chart
+    end
+  end
+end

data/lib/charter/gruff_themes.rb

@@ -0,0 +1,18 @@
+module Charter
+  module Themes
+    GOOGLE_CHART = {
+        :colors => [
+            '#3366CC', # blue
+            '#DC3912', # red
+            '#FF9900', # yellow
+            '#109618', # green
+            '#990099', # dk purple
+            '#0099C6', # sky
+            '#DD4477' # grey
+        ],
+        :marker_color => '#aea9a9', # Grey
+        :font_color => 'black',
+        :background_colors => 'white'
+    }
+  end
+end

data/lib/charter/line_chart.rb

@@ -0,0 +1,38 @@
+require 'charter/chart_base'
+require 'gruff'
+
+# Example
+# -------
+# Charter::Factory.build(:line) do |chart|
+#   chart.data = [{hours_remain: 100, estimated_hours_remain: 100, day: 3.days.ago.to_date},
+#              {hours_remain: 50, estimated_hours_remain: 45, day: 2.days.ago.to_date},
+#              {hours_remain: 5, estimated_hours_remain: 10, day: 1.days.ago.to_date}]
+#   chart.columns = {hours_remain: 'Hours remaining', estimated_hours_remain: 'Estimated hours remaining'}
+#   chart.label_column = :day
+# end
+
+module Charter
+  class LineChart < ChartBase
+    def to_blob
+      g = prepare_gruff(:line)
+
+      columns.each do |column|
+        if column.kind_of?(Array)
+          key, text = column[0], column[1]
+        else
+          key, text = column, column.to_s.humanize
+        end
+
+        g.data(text, data_for_column(key))
+      end
+
+      labels = {}
+      data_for_column(label_column).each_with_index do |label, index|
+        labels[index] = label.to_s
+      end
+
+      g.labels = labels
+      g.to_blob
+    end
+  end
+end

data/lib/charter/pie_chart.rb

@@ -0,0 +1,27 @@
+require 'charter/chart_base'
+require 'gruff'
+
+# Example
+# -------
+# Charter::Factory.build(:pie) do |chart|
+#   chart.data = {'ruby' => 100,
+#                 'python' => 12}
+#   chart.columns = ['Language', 'Usage']
+# end
+module Charter
+  class PieChart < ChartBase
+    def to_blob
+      g = prepare_gruff(:pie)
+
+      data.each do |row|
+        if row.kind_of?(Array)
+          key, val = row[0], row[1]
+        else
+          key, val = row.key, row.val
+        end
+        g.data(key, val)
+      end
+      g.to_blob
+    end
+  end
+end

data/lib/charter/version.rb

@@ -0,0 +1,3 @@
+module Charter
+  VERSION = "0.1.0"
+end

data/lib/charter/web_chart/google_chart/bar_chart.rb

@@ -0,0 +1,24 @@
+require 'charter/bar_chart'
+require 'charter/web_chart/google_chart/google_chart_module'
+
+module Charter
+  module WebChart
+    module GoogleChart
+      class BarChart < Charter::BarChart
+        include Charter::WebChart::GoogleChart::GoogleChartModule
+
+        def render(html_dom_id)
+          js = <<-JS
+            google.load("visualization", "1", {packages:["corechart"]});
+            google.setOnLoadCallback(function () {
+              var data = google.visualization.arrayToDataTable(#{array_data_table.to_json});
+              var chart = new google.visualization.BarChart(document.getElementById('#{html_dom_id}'));
+              chart.draw(data, #{chart_options.to_json});
+            });
+          JS
+          js.html_safe
+        end
+      end
+    end
+  end
+end

data/lib/charter/web_chart/google_chart/google_chart_module.rb

@@ -0,0 +1,37 @@
+require 'charter/bar_chart'
+
+module Charter
+  module WebChart
+    module GoogleChart
+      module GoogleChartModule
+        def chart_options
+          {
+              title: title,
+              backgroundColor: bg_color,
+              colors: web_colors,
+              vAxis: {baselineColor: baseline_color,
+                      gridlines: {color: grid_color},
+                      textStyle: {color: text_color}},
+              hAxis: {baselineColor: baseline_color,
+                      gridlines: {color: grid_color},
+                      textStyle: {color: text_color}},
+              legend: {textStyle: {color: text_color}},
+              lineWidth: config.web_config.line_width
+          }
+        end
+
+        def array_data_table
+          array_data = [[label_column] + column_names]
+          array_data + data.collect do |row|
+            [row[label_column]] + column_keys.collect { |col| row[col] }
+          end
+        end
+
+        def include_js
+          %q{<script type="text/javascript" src="https://www.google.com/jsapi?autoload={'modules':[{'name':'visualization',
+       'version':'1','packages':['timeline']}]}"></script>}
+        end
+      end
+    end
+  end
+end

data/lib/charter/web_chart/google_chart/line_chart.rb

@@ -0,0 +1,24 @@
+require 'charter/line_chart'
+require 'charter/web_chart/google_chart/google_chart_module'
+
+module Charter
+  module WebChart
+    module GoogleChart
+      class LineChart < Charter::LineChart
+        include Charter::WebChart::GoogleChart::GoogleChartModule
+
+        def render(html_dom_id)
+          js = <<-JS
+            google.load("visualization", "1", {packages:["corechart"]});
+            google.setOnLoadCallback(function () {
+              var data = google.visualization.arrayToDataTable(#{array_data_table.to_json});
+              var chart = new google.visualization.LineChart(document.getElementById('#{html_dom_id}'));
+              chart.draw(data, #{chart_options.to_json});
+            });
+          JS
+          js.html_safe
+        end
+      end
+    end
+  end
+end

data/lib/charter/web_chart/google_chart/pie_chart.rb

@@ -0,0 +1,43 @@
+require 'charter/pie_chart'
+require 'charter/web_chart/google_chart/google_chart_module'
+
+module Charter
+  module WebChart
+    module GoogleChart
+      class PieChart < Charter::PieChart
+        include Charter::WebChart::GoogleChart::GoogleChartModule
+
+        # Js data
+        # var data = google.visualization.arrayToDataTable([
+        #                                                      ['Task', 'Hours per Day'],
+        #                                                      ['Work',     11],
+        #                                                      ['Eat',      2],
+        #                                                      ['Commute',  2],
+        #                                                      ['Watch TV', 2],
+        #                                                      ['Sleep',    7]
+        #                                                  ]);
+        def render(html_dom_id)
+          datasets = data.collect do |column|
+            if column.kind_of?(Array)
+              title, val = column[0], column[1]
+            else
+              title, val = column, column.to_s.humanize
+            end
+            [title, val]
+          end
+          datasets.insert 0, column_names
+
+          js = <<-JS
+            google.load("visualization", "1", {packages:["corechart"]});
+            google.setOnLoadCallback(function () {
+              var data = google.visualization.arrayToDataTable(#{datasets.to_json});
+              var chart = new google.visualization.PieChart(document.getElementById('#{html_dom_id}'));
+              chart.draw(data, #{chart_options.to_json});
+            });
+          JS
+          js.html_safe
+        end
+      end
+    end
+  end
+end

data/lib/tasks/charter_tasks.rake

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

metadata

@@ -0,0 +1,194 @@
+--- !ruby/object:Gem::Specification
+name: chartify
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- A.K.M. Ashrafuzzaman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gruff
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: A gem to manage online chart so that it can be exportable in image from
+  ruby code.
+email:
+- ashrafuzzaman.g2@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/charter.rb
+- lib/charter/bar_chart.rb
+- lib/charter/chart_base.rb
+- lib/charter/config.rb
+- lib/charter/factory.rb
+- lib/charter/gruff_themes.rb
+- lib/charter/line_chart.rb
+- lib/charter/pie_chart.rb
+- lib/charter/version.rb
+- lib/charter/web_chart/google_chart/bar_chart.rb
+- lib/charter/web_chart/google_chart/google_chart_module.rb
+- lib/charter/web_chart/google_chart/line_chart.rb
+- lib/charter/web_chart/google_chart/pie_chart.rb
+- lib/tasks/charter_tasks.rake
+homepage: https://github.com/ashrafuzzaman/charter
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A gem to manage online chart so that it can be exportable in image from ruby
+  code.
+test_files: []