lazy_high_charts 1.5.1 → 1.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 808215e1935a22655c03ca1471e0432ada0f2fc5
-  data.tar.gz: c4ccbc09f28b8e503286276d30ac440fa843229b
+  metadata.gz: 9b7f95d1ee5bcbdf67651b6b00d8e84931ac40c5
+  data.tar.gz: 3854dc699812d374aea0bb7147732a1c45445de2
 SHA512:
-  metadata.gz: 966f51166c0f7c21cf3674d61c1fed7c1a63e6e44ff8d83b46cb8e528d0fee581c9d0f66f070bd281c8c9b32a69f69348fa1f47ce85808d4dfa53cd1d3832cf5
-  data.tar.gz: 2aa336210b28078a084d9ac93d8f891fa033c7c4d4aedbf6b3aac9d5c561b2c25f439dec73489ad1d271d9d0f442ef1d2b24c04914ecbaff1aff31c7429e3f7c
+  metadata.gz: e5735e8b7ff7d0728724d700e975d93d9134aac7081c50d2f9d7d8a2c9306a00361b6c23fbaacdf016594c7d0c7f4c7813f3f9ba6eb84067291627a0f925cd7d
+  data.tar.gz: bdb7421200c933c14b3af885ca63db543daa77fc8611211f3e0ab4a43712a2488ce192fe95fb451af362662220b7880089b11eeade22e55f18aee0831b06ac53

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# VERSION 1.5.2
+  * Sun Mar 11, 2014
+    1. Merge some requirement tweaks to use gem in NON-Rails contexts
+
 # VERSION 1.5.1
   * Sun Dec 22, 2013
     1. Share highcharts:update rake task for gem and rails host app 

data/GEM_VERSION

@@ -1 +1 @@
-1.5.1
+1.5.2

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2008-2010 Miguel Michelson Martinez
+Copyright (c) 2008-2014 Miguel Michelson Martinez / Deshi Xiao
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,15 +1,25 @@
-# LazyHighCharts - Official gem repository
+# LazyHighCharts
 
-Easily include HighCharts in your project with this gem
-[![Build Status](https://secure.travis-ci.org/michelson/lazy_high_charts.png)](http://travis-ci.org/michelson/lazy_high_charts)
+This gem provides a simple and extremely flexible way to use HighCharts from ruby code.
+Tested on Ruby on Rails, Sinatra and Nanoc, but it should work with others too.
+
+
+[![Build Status](https://travis-ci.org/michelson/lazy_high_charts.png?branch=master)](http://travis-ci.org/michelson/lazy_high_charts)
+[![Code Climate](https://codeclimate.com/github/michelson/lazy_high_charts.png)](https://codeclimate.com/github/michelson/lazy_high_charts)
 
-## Notice
-[![Gem
-Version](https://badge.fury.io/rb/lazy_high_charts.png)](http://badge.fury.io/rb/lazy_high_charts)
-Current
 [VERSION](https://github.com/michelson/lazy_high_charts/blob/master/GEM_VERSION)
 [ChangeLog](https://github.com/michelson/lazy_high_charts/blob/master/CHANGELOG.md)
 
+## Information
+
+* RDoc documentation [available on RubyDoc.info](http://rubydoc.info/gems/lazy_high_charts/frames)
+* Source code [available on GitHub](http://github.com/michelson/lazy_high_charts)
+* More information, known limitations, and how-tos [available on the wiki](https://github.com/michelson/lazy_high_charts/wiki)
+
+## Getting Help
+
+* Please report bugs on the [issue tracker](http://github.com/michelson/lazy_high_charts/issues) but read the "getting help" section in the wiki first.
+
 ## Installation
 
 ### Installation with rubygems
@@ -17,11 +27,11 @@ Current
 To install it, you just need to add it to your Gemfile:
 
 ```ruby
-    gem 'lazy_high_charts'
+gem 'lazy_high_charts'
 ```
 edge version on trial
 ```ruby
-    gem 'lazy_high_charts' --pre
+gem 'lazy_high_charts' --pre
 ```
 
 then run
@@ -32,11 +42,38 @@ bundle install
 
 to install it.
 
-##  Lazy_high_charts User Guide
+## Usage:
 
-See [project WIKI page](https://github.com/michelson/lazy_high_charts/wiki)
+### Controller code:
+```ruby
+@chart2 = LazyHighCharts::HighChart.new('graph') do |f|
+  f.title(:text => "Population vs GDP For 5 Big Countries [2009]")
+  f.xAxis(:categories => ["United States", "Japan", "China", "Germany", "France"])
+  f.series(:name => "GDP in Billions", :yAxis => 0, :data => [14119, 5068, 4985, 3339, 2656])
+  f.series(:name => "Population in Millions", :yAxis => 1, :data => [310, 127, 1340, 81, 65])
+
+  f.yAxis [
+    {:title => {:text => "GDP in Billions", :margin => 70} },
+    {:title => {:text => "Population in Millions"}, :opposite => true},
+  ]
+
+  f.legend(:align => 'right', :verticalAlign => 'top', :y => 75, :x => -50, :layout => 'vertical',)
+  f.chart({:defaultSeriesType=>"column"})
+end
+```
 
-[Demo Project](https://github.com/xiaods/highcharts-bootstrap)
+### View Helpers:
+```ruby
+<%= high_chart("my_id4", @chart4) %>
+```
+
+###Demo projects:
+
+[Nanoc App](spec/dummy_nanoc/README.md)
+
+[Rails App](spec/dummy_rails/README.md)
+
+[Sinatra App](spec/dummy_sinatra/README.md)
 
 
 ### Update to latest js library. Aditional command line
@@ -47,7 +84,9 @@ See [project WIKI page](https://github.com/michelson/lazy_high_charts/wiki)
 
   And HC will be copied to your vendor/assets directory on your app
 
-### Deprecation notice: if you use rails 2.3.x or 3.0.x or 3.1.x, please use versions less than 1.3.3.
+### Deprecation notice: 
+
+If you use rails 2.3.x or 3.0.x or 3.1.x, please use versions less than 1.3.3.
 
 ## Contributing
 
@@ -65,4 +104,4 @@ Thanks for all [contributers](https://github.com/michelson/lazy_high_charts/cont
 * Miguel Michelson [github/michelson](https://github.com/michelson)
 
 ## License
-* Copyright (c) 2013 [Deshi Xiao](http://xiaods.mit-license.org) - Miguel Michelson Martinez, released under the MIT license
+* Copyright (c) 2008-2014 [MIT LICENSE](MIT-LICENSE)

data/lib/lazy_high_charts.rb

@@ -1,3 +1,7 @@
+require 'action_view'
+include ActionView::Helpers::TagHelper
+require 'json'
+
 require File.join(File.dirname(__FILE__), *%w[lazy_high_charts core_ext string])
 require File.join(File.dirname(__FILE__), *%w[lazy_high_charts options_key_filter])
 require File.join(File.dirname(__FILE__), *%w[lazy_high_charts layout_helper])

data/spec/dummy_nanoc/.gitignore

@@ -0,0 +1,3 @@
+Gemfile.lock
+*.log
+tmp*

data/spec/dummy_nanoc/Gemfile

@@ -0,0 +1,7 @@
+source "http://rubygems.org"
+
+gem 'nanoc', '3.6.7'
+# gem 'just_high_charts', github: 'StevenClontz/just_high_charts'
+gem 'actionview'
+gemspec  :path => '../../'
+gem 'nokogiri'

data/spec/dummy_nanoc/README.md

@@ -0,0 +1,18 @@
+nanoc lazy high charts example
+==============================
+
+##Autor:
+
+Steven Clontz
+
+A very simple proof-of-concept of using [lazy_high_charts](https://github.com/michelson/lazy_high_charts) with a [nanoc](http://nanoc.ws) site
+(that is, without Rails)
+
+### The example
+
+<http://stevenclontz.github.io/nanoc_just_high_charts_example/>
+
+
+## USAGE:
+
+    bundle exec nanoc compile

data/spec/dummy_nanoc/Rules

@@ -0,0 +1,44 @@
+#!/usr/bin/env ruby
+
+# A few helpful tips about the Rules file:
+#
+# * The string given to #compile and #route are matching patterns for
+#   identifiers--not for paths. Therefore, you can’t match on extension.
+#
+# * The order of rules is important: for each item, only the first matching
+#   rule is applied.
+#
+# * Item identifiers start and end with a slash (e.g. “/about/” for the file
+#   “content/about.html”). To select all children, grandchildren, … of an
+#   item, use the pattern “/about/*/”; “/about/*” will also select the parent,
+#   because “*” matches zero or more characters.
+
+compile '/stylesheet/' do
+  # don’t filter or layout
+end
+
+compile '*' do
+  if item.binary?
+    # don’t filter binary items
+  else
+    filter :erb
+    layout 'default'
+    filter :relativize_paths, type: :html
+  end
+end
+
+route '/stylesheet/' do
+  '/style.css'
+end
+
+route '*' do
+  if item.binary?
+    # Write item with identifier /foo/ to /foo.ext
+    item.identifier.chop + '.' + item[:extension]
+  else
+    # Write item with identifier /foo/ to /foo/index.html
+    item.identifier + 'index.html'
+  end
+end
+
+layout '*', :erb

data/spec/dummy_nanoc/content/index.html

@@ -0,0 +1,7 @@
+---
+title: Home
+---
+
+<h1>A Brand New nanoc Site with a HighChart</h1>
+
+<%= highchart_example %>

data/spec/dummy_nanoc/content/stylesheet.css

@@ -0,0 +1,101 @@
+* {
+  margin: 0;
+  padding: 0;
+
+  font-family: Georgia, Palatino, serif;
+}
+
+body {
+  background: #fff;
+}
+
+a {
+  text-decoration: none;
+}
+
+a:link,
+a:visited {
+  color: #f30;
+}
+
+a:hover {
+  color: #f90;
+}
+
+#main {
+  position: absolute;
+
+  top: 40px;
+  left: 280px;
+
+  width: 500px;
+}
+
+#main h1 {
+  font-size: 40px;
+  font-weight: normal;
+
+  line-height: 40px;
+
+  letter-spacing: -1px;
+}
+
+#main p {
+  margin: 20px 0;
+
+  font-size: 15px;
+
+  line-height: 20px;
+}
+
+#main ul, #main ol {
+  margin: 20px;
+}
+
+#main li {
+  font-size: 15px;
+
+  line-height: 20px;
+}
+
+#main ul li {
+  list-style-type: square;
+}
+
+#sidebar {
+  position: absolute;
+
+  top: 40px;
+  left: 20px;
+  width: 200px;
+
+  padding: 20px 20px 0 0;
+
+  border-right: 1px solid #ccc;
+
+  text-align: right;
+}
+
+#sidebar h2 {
+  text-transform: uppercase;
+
+  font-size: 13px;
+
+  color: #333;
+
+  letter-spacing: 1px;
+
+  line-height: 20px;
+}
+
+#sidebar ul {
+  list-style-type: none;
+
+  margin: 20px 0;
+}
+
+#sidebar li {
+  font-size: 14px;
+
+  line-height: 20px;
+}

data/spec/dummy_nanoc/layouts/default.html

@@ -0,0 +1,32 @@
+<!DOCTYPE HTML>
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <title>A Brand New nanoc Site - <%= @item[:title] %></title>
+    <link rel="stylesheet" href="/style.css">
+
+    <!-- you don't need to keep this, but it's cool for stats! -->
+    <meta name="generator" content="nanoc <%= Nanoc::VERSION %>">
+    
+    <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.9.1/jquery.min.js"></script>
+    <script type="text/javascript" src="http://code.highcharts.com/highcharts.js"></script>
+  </head>
+  <body>
+    <div id="main">
+      <%= yield %>
+    </div>
+    <div id="sidebar">
+      <h2>Documentation</h2>
+      <ul>
+        <li><a href="http://nanoc.ws/docs/">Documentation</a></li>
+        <li><a href="http://nanoc.ws/docs/tutorial/">Getting Started</a></li>
+      </ul>
+      <h2>Community</h2>
+      <ul>
+        <li><a href="http://groups.google.com/group/nanoc/">Discussion Group</a></li>
+        <li><a href="irc://chat.freenode.net/#nanoc">IRC Channel</a></li>
+        <li><a href="http://github.com/nanoc/nanoc/wiki/">Wiki</a></li>
+      </ul>
+    </div>
+  </body>
+</html>

data/spec/dummy_nanoc/lib/default.rb

@@ -0,0 +1,30 @@
+# All files in the 'lib' directory will be loaded
+# before nanoc starts compiling.
+
+require 'lazy_high_charts'
+include LazyHighCharts::LayoutHelper
+
+def highchart_example
+  # https://github.com/michelson/lazy_high_charts/wiki/Combination-Chart
+  chart = LazyHighCharts::HighChart.new('graph') do |f|
+    f.title({ text: "Combination chart"})
+    f.options[:xAxis][:categories] = 
+      ['Apples', 'Oranges', 'Pears', 'Bananas', 'Plums']
+    f.labels(:items=>
+      [:html=>"Total fruit consumption", 
+       :style=>{:left=>"40px", :top=>"8px", :color=>"black"} ])
+    f.series(:type=> 'column',:name=> 'Jane',:data=> [3, 2, 1, 3, 4])
+    f.series(:type=> 'column',:name=> 'John',:data=> [2, 3, 5, 7, 6])
+    f.series(:type=> 'column', :name=> 'Joe',:data=> [4, 3, 3, 9, 0])
+    f.series(:type=> 'spline',:name=> 'Average', 
+             :data=> [3, 2.67, 3, 6.33, 3.33])
+    f.series(:type=> 'pie',:name=> 'Total consumption', 
+      :data=> [
+        {:name=> 'Jane', :y=> 13, :color=> 'red'}, 
+        {:name=> 'John', :y=> 23,:color=> 'green'},
+        {:name=> 'Joe', :y=> 19,:color=> 'blue'}
+      ],
+      :center=> [100, 80], :size=> 100, :showInLegend=> false)
+  end
+  high_chart("some_id", chart)
+end

data/spec/dummy_nanoc/nanoc.yaml

@@ -0,0 +1,59 @@
+# A list of file extensions that nanoc will consider to be textual rather than
+# binary. If an item with an extension not in this list is found,  the file
+# will be considered as binary.
+text_extensions: [ 'coffee', 'css', 'erb', 'haml', 'handlebars', 'hb', 'htm', 'html', 'js', 'less', 'markdown', 'md', 'ms', 'mustache', 'php', 'rb', 'sass', 'scss', 'txt', 'xhtml', 'xml' ]
+
+# The path to the directory where all generated files will be written to. This
+# can be an absolute path starting with a slash, but it can also be path
+# relative to the site directory.
+output_dir: output
+
+# A list of index filenames, i.e. names of files that will be served by a web
+# server when a directory is requested. Usually, index files are named
+# “index.html”, but depending on the web server, this may be something else,
+# such as “default.htm”. This list is used by nanoc to generate pretty URLs.
+index_filenames: [ 'index.html' ]
+
+# Whether or not to generate a diff of the compiled content when compiling a
+# site. The diff will contain the differences between the compiled content
+# before and after the last site compilation.
+enable_output_diff: false
+
+prune:
+  # Whether to automatically remove files not managed by nanoc from the output
+  # directory. For safety reasons, this is turned off by default.
+  auto_prune: false
+
+  # Which files and directories you want to exclude from pruning. If you version
+  # your output directory, you should probably exclude VCS directories such as
+  # .git, .svn etc.
+  exclude: [ '.git', '.hg', '.svn', 'CVS' ]
+
+# The data sources where nanoc loads its data from. This is an array of
+# hashes; each array element represents a single data source. By default,
+# there is only a single data source that reads data from the “content/” and
+# “layout/” directories in the site directory.
+data_sources:
+  -
+    # The type is the identifier of the data source. By default, this will be
+    # `filesystem_unified`.
+    type: filesystem_unified
+
+    # The path where items should be mounted (comparable to mount points in
+    # Unix-like systems). This is “/” by default, meaning that items will have
+    # “/” prefixed to their identifiers. If the items root were “/en/”
+    # instead, an item at content/about.html would have an identifier of
+    # “/en/about/” instead of just “/about/”.
+    items_root: /
+
+    # The path where layouts should be mounted. The layouts root behaves the
+    # same as the items root, but applies to layouts rather than items.
+    layouts_root: /
+
+    # Whether to allow periods in identifiers. When turned off, everything
+    # past the first period is considered to be the extension, and when
+    # turned on, only the characters past the last period are considered to
+    # be the extension. For example,  a file named “content/about.html.erb”
+    # will have the identifier “/about/” when turned off, but when turned on
+    # it will become “/about.html/” instead.
+    allow_periods_in_identifiers: false