swagchart 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f50cb24ac13690119021c8ccf54150f0a899933a
+  data.tar.gz: 224b0d54724f4150d6482ee47b50c710f7fe8e41
+SHA512:
+  metadata.gz: 8aba1feb3a8ddf4f6a4b8f31baa2ea0c64233f3cda53f9e52fc0a986b6bc024dfc6b468e007ebc381120626a7b9eb2dae3b87bf134a40e7b2a4295d471c3b894
+  data.tar.gz: 3f2f57951567c41f1d64b3060c1f5b4ce5ddda9e4a7528899be0790bbfbfd7f1f21119782f4db6632d252012232951c1bb0a678cc833bb456c3bbdb325fb930e

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,19 @@
+PATH
+  remote: .
+  specs:
+    swagchart (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.3.2)
+    rake (10.2.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  minitest
+  rake
+  swagchart!

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014
+
+MIT License
+
+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,87 @@
+# Swagchart
+
+Get your swag on with this incredibly easy to use wrapper around [Googles Chart API](https://developers.google.com/chart/).
+
+In case you haven't noticed, Swagchart is just an acronym for **S**.imple **W**.rapper **A**.round **G**.oogle **Chart**.
+
+Swagchart is highly inspired by [Chartkick](https://github.com/ankane/chartkick) but making use of Googles new ChartWrapper class which allows a more flexible and direct interaction.
+
+You can still create beautiful Javascript charts with one line of Ruby. In fact now you can pretty much use all the fancy chart types from [Googles Chart API](https://developers.google.com/chart/interactive/docs/gallery).
+
+Works with Rails, Sinatra and most browsers (including IE 6).
+
+## Usage examples
+
+Line chart
+
+```erb
+<%= chart :line_chart, User.group_by_day(:created_at).count %>
+```
+
+Pie chart
+
+```erb
+<%= chart 'PieChart', Goal.group(:name).count %>
+```
+
+~~Keep in mind that camelize is only available with activesupport. Use the camelized chart names ... i.e. "LineChart" instead of "line_chart"~~
+
+:thought_balloon: ... Note to self: Include more examples ... 
+
+
+
+### Data
+
+Pass data as a Array, Hash or "DataTable"
+
+```erb
+<%= chart :pie_chart, [["Football", 10], ["Basketball", 5]] %>
+```
+
+```erb
+<%= chart :pie_chart, {"Football" => 10, "Basketball" => 5} %>
+```
+
+```erb
+<%= chart :pie_chart, [["Sport", "Popularity"], ["Football", 10], ["Basketball", 5]] %>
+```
+
+Multiple series just work automatically
+
+```erb
+<%= chart :line_chart [[1,2,4],[2,3,8],[3,4,16],[4,5,32]], columns: ['x', 'Series 1', 'Series 2'] %>
+```
+
+If you want to use times or dates, do so. They have to be a time or date object!
+
+
+```erb
+<%= line_chart({20.day.ago => 5, Time.at(1368174456) => 4, Time.parse("2013-05-07 00:00:00 UTC") => 7, Date.new(1999,12,24) => 9}) %>
+
+```
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "swagchart"
+```
+
+And add the javascript files to your views.  These files must be included **before** the helper methods.
+
+
+```erb
+<script type="text/javascript" src="//www.google.com/jsapi"></script>
+```
+
+
+## Contributing
+
+Everyone is encouraged to help improve this project. Here are a few ways you can help:
+
+- Report bugs
+- Fix bugs and submit pull requests
+- Write, clarify, or fix documentation
+- Suggest or add new features

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+task :default => :test
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+end

data/lib/swagchart.rb

@@ -0,0 +1,10 @@
+require "swagchart/version"
+require "swagchart/helper"
+require "swagchart/rails" if defined?(Rails)
+require "swagchart/sinatra" if defined?(Sinatra)
+
+module Swagchart
+  class << self
+    attr_accessor :content_for
+  end
+end

data/lib/swagchart/engine.rb

@@ -0,0 +1,11 @@
+module Swagchart
+  class Engine < ::Rails::Engine
+
+    initializer "helper" do |app|
+      ActiveSupport.on_load(:action_view) do
+        include Helper
+      end
+    end
+
+  end
+end

data/lib/swagchart/helper.rb

@@ -0,0 +1,111 @@
+require 'json'
+require 'time'
+require 'erb'
+
+module Swagchart
+  module Helper
+
+    def chart(type, data, opts={}, &block)
+      @google_visualization_included ||= false
+      @chart_counter ||= 0
+      type = camelize(type.to_s)
+      opts[:columns] = opts[:columns].split(',').map(&:strip) if opts[:columns].is_a?(String)
+      data = data.to_a if data.is_a?(Hash)
+      if data.respond_to?(:first) && data.first.is_a?(Hash)
+        data = hash_array_to_data_table(data)
+        opts.delete(:columns)
+      elsif data.respond_to?(:unshift) && data.respond_to?(:first)
+        if opts[:columns]
+          data.unshift opts.delete(:columns)
+        elsif !data.first.find{|e| !e.is_a?(String) && !e.is_a?(Symbol) }
+          # Do nothing! This should already be in a DataTable format.
+          # First row seems to only define column names.
+        else
+          data.unshift Array.new(data.first.size, '')
+        end
+      end
+      chart_id = ERB::Util.html_escape(opts.delete(:chart_id) || "chart_#{@chart_counter += 1}")
+      style = 'height:320px;' #dirty hack right here .. you can override that with your style though
+      style << ERB::Util.html_escape(opts.delete(:style)) if opts[:style]
+      html = ''
+      unless @google_visualization_included #we only need to include this once
+        html << jsapi_includes_template
+        @google_visualization_included = true
+      end
+      options = opts.delete(:options) || {}
+      html << classic_template(id: chart_id, type: type, style: style, options: options, data: data)
+      html.respond_to?(:html_safe) ? html.html_safe : html
+    end
+
+    private
+
+    def hash_array_to_data_table(ha)
+      cols = ha.first.keys
+      rows = ha.map{|r| cols.reduce([]){|s,e| s<<r[e]} }
+      [cols, *rows]
+    end
+
+    def camelize(str)
+      str.split('_').each(&:capitalize!).join('')
+    end
+
+    # This finds and replaces some string representations of
+    # Ruby objects to their JavaScript equivalents.
+    # Yes it's dirty and using Ruby 2.x refinements to replace the
+    # to_s methods of those objects only in this module would
+    # be simply awesome, but refinements dont work in Ruby 1.x.
+    # TODO: Check if refinements are available and do either the
+    #       right or the dirty thing.
+    def ruby_to_js_conversions(str)
+      str.to_s.gsub(/["'](\d\d\d\d-\d\d-\d\d.*?)["']/){"new Date(Date.parse('#{$1}'))"}
+              .gsub(/\bnil\b/, 'null')
+      #drx = /#<Date: (\d\d\d\d)-(\d\d)-(\d\d).*?>/
+      #dtrx= /#<DateTime: (\d\d\d\d)-(\d\d)-(\d\d)T(\d\d):(\d\d):(\d\d)\+\d\d:\d\d .*?>/
+      #trx = /(\d\d\d\d)-(\d\d)-(\d\d) (\d\d):(\d\d):(\d\d) \+\d\d\d\d/
+      #blk = ->(s){v=$~.captures.map(&:to_i); v[1]-=1; "new Date(#{v.join(',')})"}
+      #str.to_s.gsub(dtrx, &blk).gsub(drx, &blk).gsub(trx, &blk)
+    end
+
+    def classic_template(opts={})
+<<HTML
+<div id='#{opts[:id]}' style='#{opts[:style]}'>Loading...</div>
+<script type='text/javascript'>
+google.setOnLoadCallback(function(){
+  new google.visualization.#{opts[:type]}(document.getElementById('#{opts[:id]}')).draw(
+    google.visualization.arrayToDataTable(
+      #{ruby_to_js_conversions(opts[:data])}
+    ), #{opts[:options].to_json});
+});
+</script>
+HTML
+    end
+
+    def chartwrapper_template(opts={})
+<<HTML
+<div id='#{opts[:id]}' style='#{opts[:style]}'>Loading...</div>
+<script type='text/javascript'>
+  google.setOnLoadCallback(function(){
+    new google.visualization.ChartWrapper({
+      chartType: '#{opts[:type]}',
+      containerId: '#{opts[:id]}',
+      options: #{opts[:options].to_json},
+      dataTable: #{ruby_to_js_conversions(opts[:data])}
+    }).draw();
+  });
+</script>
+HTML
+    end
+
+    def jsapi_includes_template
+<<HTML
+<script type='text/javascript'>
+  google.load('visualization','1');
+  google.load('visualization', '1', {packages: [
+    'corechart', 'geochart', 'map', 'treemap', 'annotatedtimeline',
+    'sankey', 'orgchart', 'calendar', 'gauge'
+  ]});
+</script>
+HTML
+    end
+  end
+end

data/lib/swagchart/rails.rb

@@ -0,0 +1,5 @@
+if Rails.version >= "3.1"
+  require "swagchart/engine"
+else
+  ActionView::Base.send :include, Swagchart::Helper
+end

data/lib/swagchart/sinatra.rb

@@ -0,0 +1,3 @@
+class Sinatra::Base
+  helpers Swagchart::Helper
+end

data/lib/swagchart/version.rb

@@ -0,0 +1,3 @@
+module Swagchart
+  VERSION = "1.0.0"
+end

data/swagchart.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'swagchart/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "swagchart"
+  spec.version       = Swagchart::VERSION
+  spec.authors       = ["pachacamac", "naema"]
+  spec.email         = []
+  spec.description   = %q{Use Google Charts easily within your Rails or Sinatra project or anywhere really}
+  spec.summary       = %q{Small Wrapper Around Google CHARTS}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+end

data/test/swagchart_test.rb

@@ -0,0 +1,39 @@
+require 'test_helper'
+require 'time'
+
+class TestSwagchart < Minitest::Test
+  include Swagchart::Helper
+
+  def test_no_random_exceptions
+    assert chart(:line_chart, [[23, 42], [666, 999]], columns: ['x', 'y'])
+    assert chart(:line_chart, [[23, 42], [666, 999]], columns: ['x', 'y'], style: 'width:100%;')
+    assert chart(:bar_chart, [['x', 'y'],[23, 42], [666, 999]])
+    assert chart('GeoMap', [{'Country'=>'Germany', 'Population'=>8600000}, {'Country'=>'France', 'Population'=>6500000}])
+  end
+
+  def test_time_object_literals
+    t = Time.parse('2014-12-24 13:37:04')
+    raw_chart = chart(:line_chart, [[t, 42], [t+3600, 999]], columns: ['x', 'y'])
+    assert raw_chart.include?('new Date(2014,11,24,13,37,4)') #month starts at 0 in js
+    assert raw_chart.include?('new Date(2014,11,24,14,37,4)')
+  end
+
+  def test_date_object_literals
+    d1, d2 = Date.new(2014, 12, 24), Date.new(2014, 12, 31)
+    raw_chart = chart(:line_chart, [[d1, 42], [d2, 999]], columns: ['x', 'y'])
+    assert raw_chart.include?('new Date(2014,11,24)')
+    assert raw_chart.include?('new Date(2014,11,31)')
+  end
+
+  def test_datetime_object_literals
+    dt = Time.parse('2014-12-24 13:37:04').to_datetime
+    raw_chart = chart(:line_chart, [[dt, 42]], columns: ['x', 'y'])
+    assert raw_chart.include?('new Date(2014,11,24,13,37,4)')
+  end
+
+  # def test_chart_output
+  #   puts chart('GeoMap', [{'Country'=>'Germany', 'Population'=>8600000}, {'Country'=>'France', 'Population'=>6500000}], columns: ['x', 'y'], :hAxis => {title: 'Year'}, style:'width:100%;')
+  #   puts chart(:line_chart, [[23, 42], [666, 999]], columns: ['x', 'y'])
+  # end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+require "bundler/setup"
+Bundler.require(:default)
+require "minitest/autorun"
+require "minitest/pride"

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: swagchart
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- pachacamac
+- naema
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: minitest
+  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'
+description: Use Google Charts easily within your Rails or Sinatra project or anywhere
+  really
+email: []
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/swagchart.rb
+- lib/swagchart/engine.rb
+- lib/swagchart/helper.rb
+- lib/swagchart/rails.rb
+- lib/swagchart/sinatra.rb
+- lib/swagchart/version.rb
+- swagchart.gemspec
+- test/swagchart_test.rb
+- test/test_helper.rb
+homepage: ''
+licenses:
+- MIT
+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: Small Wrapper Around Google CHARTS
+test_files:
+- test/swagchart_test.rb
+- test/test_helper.rb