simple-gcharts 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ef9c9bbefb6c2ec887e3ff317194365baf920f06
+  data.tar.gz: 787ffd771ef5149652ff94244cea7758e44f073c
+SHA512:
+  metadata.gz: e621639e7b743378288e634820d18b240e40753a974709c4d2d39eb2a35911180ecbb6c906ffa51f7d3c3a0a3c313e7e6fdf7b4935542b4ad993dc5122d2b253
+  data.tar.gz: 4ea982391e2998a0abd838e8cc86268e5a2c7d1d06eaf12200d04ea21f12bec57982891c9c00dc1f6204d1327bcb745edbfc72fa81d4725de1f0ab45f2580430

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Charles Julian Knight
+
+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,113 @@
+# Simple GCharts
+
+Create Google Charts in your views using ruby, with no Javascript required. This library
+will serialize your data andautomatically load any required charts packages, and render
+your charts for you. Requires jQuery.
+
+## Example [PieChart](https://developers.google.com/chart/interactive/docs/gallery/piechart#example)
+
+```ruby
+class ActivitiesController < ActionController::Base
+  def graphs
+    @activities = {
+      'Work' => 11,
+      'Eat' => 2,
+      'Commute' => 2,
+      'Watch TV' => 2,
+      'Sleep' => 7
+    }
+  end
+end
+```
+
+```erb
+# views/activities/graphs.html.erb
+<%= google_chart :pie, ['Task', 'Hours per Day'], @activities.map { |k,v| [k, v] }, { title: 'My Daily Activities' } %>
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'simple-gcharts'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simple-gcharts
+
+Add script to `application.js` (or appropriate page)
+
+```js
+//= require jquery
+//= require simple-gcharts
+```
+
+## Usage
+
+See the [Google Charts Documentation](https://developers.google.com/chart) for chart type descriptions and options.
+
+### google_chart
+
+```ruby
+def google_chart type, headers, data, opts={}, chart_id="chart-#{SecureRandom.hex(10)}", parent_tag=:div
+```
+
+| Argument     | Description                                                                                                                                                                              |  
+| ----         | ----                                                                                                                                                                                     |  
+| `type`       | The type of chart (e.g. `:line`, see [below](#chart-types))                                                                                                                                    |  
+| `headers`    | The column data. Can be column name or object                                                                                                                                            |  
+| `data`       | A 2-D array of data rows. `headers` and `data` combined are passed to [`arrayToDataTable()`](https://developers.google.com/chart/interactive/docs/datatables_dataviews#arraytodatatable) |  
+| `opts`       | Options passed to `chart.draw()`                                                                                                                                                         |  
+| `chart_id`   | The HTML id attribute to use for the chart                                                                                                                                               |  
+| `parent_tag` | The tag used to wrap the child tags                                                                                                                                                      |  
+
+Ruby can't make Javascript date objects, but fortunately Google Charts supports [an alternate syntax](https://developers.google.com/chart/interactive/docs/datesandtimes#dates-and-times-using-the-date-string-representation) for date and time datatypes. You can use `chart_date_format` to convert DateTime objects to the proper format. 
+
+```ruby
+def chart_date_format(datetime, time=false)
+  if time
+    datetime.strftime "Date(%Y, %m, %d, %H, %M, %S)"
+  else
+    datetime.strftime "Date(%Y, %m, %d)"
+  end
+end
+```
+
+### Chart Types
+
+| Types        |  
+| ----         |  
+| :annotation  |  
+| :area        |  
+| :bubble      |  
+| :bar         |  
+| :calendar    |  
+| :candlestick |  
+| :column      |  
+| :combo       |  
+| :gantt       |  
+| :gauge       |  
+| :geochart    |  
+| :histogram   |  
+| :line        |  
+| :map         |  
+| :orgchart    |  
+| :pie         |  
+| :snakey      |  
+| :scatter     |  
+| :stepped     |  
+| :table       |  
+| :timeline    |  
+| :treemap     |  
+| :word        |  
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/app/helpers/google_chart_helper.rb

@@ -0,0 +1,17 @@
+module GoogleChartHelper
+
+  def google_chart type, headers, data, opts={}, chart_id="chart-#{SecureRandom.hex(10)}", parent_tag=:div
+    content_tag(parent_tag) do
+      c = content_tag(:script, {data: data.prepend(headers), options: opts}.to_json, {type: "text/json", chart: chart_id}, false)
+      c << content_tag(:div, "", class: "google-chart", id: chart_id, chart_type: type)
+    end
+  end
+
+  def chart_date_format(datetime, time=false)
+    if time
+      datetime.strftime "Date(%Y, %m, %d, %H, %M, %S)"
+    else
+      datetime.strftime "Date(%Y, %m, %d)"
+    end
+  end
+end

data/lib/simple-gcharts/version.rb

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

data/lib/simple-gcharts.rb

@@ -0,0 +1,8 @@
+require "simple-gcharts/version"
+
+module SimpleGCharts
+  module Rails
+    class Engine < ::Rails::Engine
+    end
+  end
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: simple-gcharts
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Charles Julian Knight
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: jquery-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: A helper and some javascript to make it easy to generate Google Charts.
+email:
+- charles@rabidaudio.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/helpers/google_chart_helper.rb
+- lib/simple-gcharts.rb
+- lib/simple-gcharts/version.rb
+homepage: https://github.com/rabidaudio/simple-gcharts
+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.4.8
+signing_key: 
+specification_version: 4
+summary: A simple library for creating Google Charts in Rails.
+test_files: []