nay / html5jp_graphs

Rails Plugin for html5jp JavaScript Graph Libraries

Html5jpGraphs¶ ↑

Html5jpGraphs is a Rails Plugin for HTML5.jp Graph Libraries.

HTML5.jp Graph Libraries are written by futomi, released under Apache License, Version 2.0. www.html5.jp/library/index.html

There are 4 kinds of graphs in HTML5.jp.

• vertical bar chart

• radar chart

• line chart

• pie chart

With this plugin, you can easily draw graphs using helper methods. Helper methods accepts both simple array data and your original complex model objects.

Note you need jQuery or prototype.js.

Install¶ ↑

Add html5jp_graphs in your GemFile for Bundler.

gem 'html5jp_graphs'

Setup¶ ↑

You need to include html5jp_graphs.js. Add this line to the application.js.

//= require html5jp_graphs

Also you need to add :htmltjp_graphs as a helper in your controllers.

class GraphsController < ApplicationController
  helper :html5jp_graphs
end

Example¶ ↑

Draw a Vertical Bar Chart¶ ↑

<%= vertical_bar_chart [['accesses', 520, 340, 804, 602], ['clicks', 101, 76, 239, 321]] %>

 or you can use your own model obejct (with some methods. Please see RDoc for the requirements).

<%= vertical_bar_chart access_click_summaries %>

Draw a Radar Chart¶ ↑

<%= radar_chart [['review1', 5, 4, 3], ['review2', 3, 5, 2]], :aCap => ['price', 'style', 'sound'] %>

<%= radar_chart reviews %>

Draw a Line Chart¶ ↑

<%= line_chart [['accesses', 520, 340, 804, 602], ['clicks', 101, 76, 239, 321]] %>

<%= line_chart access_click_summaries %>

Draw a Pie Chart¶ ↑

<%= pie_chart([["very good", 400], ["good", 300], ["bad", 100], ["very bad", 300]]) %>

<%= pie_chart opinions %>

Options¶ ↑

You can use all options in HTML5.jp. Note that string options should be wrapped in ‘ ’, or it would be used as a script code.

For example, to specify the backgroundColor option to a radar chart, write like this.

<%= radar_chart reviews, :backgroundColor => "'red'" %>

Copyright © 2008-2013 Yasuko Ohba ([email protected]), released under the apache license

html5jp_graphs's Issues

License missing from gemspec

RubyGems.org doesn't report a license for your gem. This is because it is not specified in the gemspec of your last release.

via e.g.

  spec.license = 'MIT'
  # or
  spec.licenses = ['MIT', 'GPL-2']

Including a license in your gemspec is an easy way for rubygems.org and other tools to check how your gem is licensed. As you can imagine, scanning your repository for a LICENSE file or parsing the README, and then attempting to identify the license or licenses is much more difficult and more error prone. So, even for projects that already specify a license, including a license in your gemspec is a good practice. See, for example, how rubygems.org uses the gemspec to display the rails gem license.

There is even a License Finder gem to help companies/individuals ensure all gems they use meet their licensing needs. This tool depends on license information being available in the gemspec. This is an important enough issue that even Bundler now generates gems with a default 'MIT' license.

I hope you'll consider specifying a license in your gemspec. If not, please just close the issue with a nice message. In either case, I'll follow up. Thanks for your time!

Appendix:

If you need help choosing a license (sorry, I haven't checked your readme or looked for a license file), GitHub has created a license picker tool. Code without a license specified defaults to 'All rights reserved'-- denying others all rights to use of the code.
Here's a list of the license names I've found and their frequencies

p.s. In case you're wondering how I found you and why I made this issue, it's because I'm collecting stats on gems (I was originally looking for download data) and decided to collect license metadata,too, and make issues for gemspecs not specifying a license as a public service :). See the previous link or my blog post about this project for more information.