opal-highcharts 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1d08409c708ece33c6ec981fe2a181258e31bd7e
+  data.tar.gz: c102f3aedf955483d30a1b9002cc469b8430786a
+SHA512:
+  metadata.gz: 09c83318246190c26ba317edd194012c676b9e33914afa64eaa32bb506ec642ca0db2a75b22a8b8c1321481b530ef94980a6295fb4677d91de6878502ce13c37
+  data.tar.gz: 79d984e22a2f549f55cd7ae07899ff798c96265d35f39a8c9e9d60c2901180e01f20b553652fc5786e53ea48f27f68cf7e830145d06991fd2ca8c12e2f81a6a5

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Colin Gunn
+
+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,81 @@
+## Ruby wrapper for the Highcharts.js and Highstock.js charting libraries
+
+The goal of this project is to wrap the Highcharts and Highstock APIs in Opal, providing a simple Ruby interface to Highcharts' functionality.
+
+To find out more about Highcharts, check out these links:
+
+* Highcharts: http://www.highcharts.com/products/highcharts
+* Highcharts Demos: http://www.highcharts.com/demo
+* Highstock Demos: http://www.highcharts.com/stock/demo
+
+To find out more about Opal, go to http://opalrb.org
+
+## Installation
+
+Install opal-highcharts from RubyGems:
+
+```
+$ gem install opal-highcharts
+```
+
+Or include it in your Gemfile for Bundler:
+
+```ruby
+gem 'opal-highcharts'
+```
+
+## Cloning this repository
+
+```
+$ git clone https://github.com/balmoral/opal-highcharts
+```
+
+## Getting Started
+
+### Usage
+
+`opal-highcharts` can be added to your opal application sources using a standard require:
+
+```ruby
+# app/application.rb
+require 'opal'
+require 'opal-highcharts'
+```
+
+> You need to bring your own `highcharts.js` or `highstock.js` file.
+> If you require Highstock functionality use `highstock.js`, which includes Highcharts. 
+> If you only require Highcharts functionality use `highcharts.js`. 
+> Download from
+> http://code.highcharts.com/highcharts.js or
+> http://code.highcharts.com/stock/highstock.js
+> and put the file in `app/` or whichever directory you are compiling assets from.
+
+## To do
+
+* Implement Highstock features
+* Documentation
+* Testing
+
+## Getting involved
+
+To contribute to this project, follow the steps below.
+
+1. Fork the repo ( https://github.com/balmoral/opal-highcharts/fork )
+2. Create your feature branch (`git checkout -b new-branch`)
+3. Commit your changes (`git commit -am 'description of commit'`)
+4. Push to the branch (`git push origin new-branch`)
+5. Create a Pull Request
+
+Contributions welcome.
+
+## Licenses
+
+### Highcharts
+Free for non-commercial use. 
+See http://www.highcharts.com/ for details.
+
+###opal-highcharts 
+MIT Licence.
+See LICENSE.txt
+
+

data/gemfile

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

data/lib/Rakefile

@@ -0,0 +1,48 @@
+require 'bundler'
+Bundler.require
+Bundler::GemHelper.install_tasks
+
+require 'opal/rspec/rake_task'
+Opal::RSpec::RakeTask.new(:default) do |s|
+    s.index_path = 'spec/html/index.html.erb'
+end
+
+desc "Build build/opal-highcharts.js"
+task :dist do
+  require 'fileutils'
+  FileUtils.mkdir_p 'build'
+
+  src = Opal::Builder.build('opal-highcharts')
+  #min = uglify src
+  #gzp = gzip min
+
+  File.open('build/opal-highcharts.js', 'w+') do |out|
+    out << src
+  end
+
+  #puts "development: #{src.size}, minified: #{min.size}, gzipped: #{gzp.size}"
+end
+
+# Used for uglifying source to minify
+def uglify(str)
+  IO.popen('uglifyjs', 'r+') do |i|
+    i.puts str
+    i.close_write
+    return i.read
+  end
+rescue Errno::ENOENT
+  $stderr.puts '"uglifyjs" command not found (install with: "npm install -g uglify-js")'
+  nil
+end
+
+# Gzip code to check file size
+def gzip(str)
+  IO.popen('gzip -f', 'r+') do |i|
+    i.puts str
+    i.close_write
+    return i.read
+  end
+rescue Errno::ENOENT
+  $stderr.puts '"gzip" command not found, it is required to produce the .gz version'
+  nil
+end

data/lib/opal-highcharts.rb

@@ -0,0 +1 @@
+require 'opal/highcharts'

data/lib/opal/highcharts.rb

@@ -0,0 +1,8 @@
+if RUBY_ENGINE == 'opal'
+  require 'opal/highcharts/setup'
+else
+  require 'opal'
+  require 'opal/highcharts/version'
+
+  Opal.append_path File.expand_path('../..', __FILE__).untaint
+end

data/lib/opal/highcharts/axis.rb

@@ -0,0 +1,25 @@
+module Highcharts
+
+  # http://api.highcharts.com/highcharts#Axis
+  class Axis
+    include Base
+
+    alias_native :add_plot_band, :addPlotBand
+    alias_native :add_plot_line, :addPlotLine
+    alias_native :extremes, :getExtremes, as: Extremes
+    alias_native :remove
+    alias_native :remove_plot_band, :removePlotBand
+    alias_native :remove_plot_line, :removePlotLine
+    alias_native :set_categories, :setCategories
+    alias_method :categories=, :set_categories
+    alias_native :set_extremes, :setExtremes
+    alias_method :extremes=, :set_extremes
+    alias_native :set_title, :setTitle
+    alias_method :title, :set_title
+    alias_native :to_pixels, :toPixels
+    alias_native :to_value, :toValue
+    alias_native :update
+
+  end
+
+end

data/lib/opal/highcharts/base.rb

@@ -0,0 +1,60 @@
+module Highcharts
+
+  class UnsupportedFeature < RuntimeError; end
+
+  class Axis;       end
+  class Chart;      end
+  class Extremes;   end
+  class Highcharts; end
+  class Options;    end
+  class Point;      end
+  class Renderer;   end
+  class Series;     end
+
+  module NativePatches
+    extend Native::Helpers
+
+    # Patch of Native.alias_native to provide us
+    # with ability to specify:
+    #    alias_native :ruby_name, :js_name, array: Class
+    # which will map the elements of the native array
+    # to elements type Class.
+    def alias_native(new, old = new, options = {})
+      if old.end_with? ?=
+        define_method new do |value|
+          `#@native[#{old[0 .. -2]}] = #{Native.convert(value)}`
+          value
+        end
+      elsif klass = options[:array]
+        define_method new do |*args, &block|
+          if value = Native.call(@native, old, *args, &block)
+            value.map{ |e| klass.new(e) }
+          end
+        end
+      else
+        if as = options[:as]
+          define_method new do |*args, &block|
+            if value = Native.call(@native, old, *args, &block)
+              as.new(value.to_n)
+            end
+          end
+        else
+          define_method new do |*args, &block|
+            Native.call(@native, old, *args, &block)
+          end
+        end
+      end
+    end
+  end
+
+  module Base
+    include Native
+
+    def self.included(klass)
+      #klass.extend Native::Helpers
+      klass.extend NativePatches
+    end
+
+  end
+end
+

data/lib/opal/highcharts/chart.rb

@@ -0,0 +1,147 @@
+module Highcharts
+
+  # Ruby wrapper for Highcharts.Chart.js
+  #
+  # @author Colin Gunn
+  # @see http://api.highcharts.com/highcharts#Chart
+
+  class Chart
+    include Base
+
+    # Creates a Highcharts or Highstock chart.
+    #
+    # @param [Hash,Native] options_or_native
+    # If the argument is a native object it is wrapped
+    # otherwise a new native chart is created and wrapped.
+    # @option options_or_native [Symbol] :mode Either :chart, :stock, :map
+    # @option options_or_native [Hash] :chart and others per Highcharts docs
+    #
+    # Highcharts.Map is not currently supported.
+    #
+    # @see http://api.highcharts.com/highcharts#chart
+    # @see http://api.highcharts.com/highstock#chart
+    def initialize(options_or_native)
+      if native?(options_or_native)
+        super(options_or_native)
+      else
+        options = options_or_native.to_h.dup
+        case mode = options.delete(:mode)
+          when :chart
+            super(`new Highcharts.Chart( #{ options.to_n } )`)
+          when :stock
+            super(`new Highcharts.StockChart( #{ options.to_n } )`)
+          when :map
+            raise UnsupportedFeature, "chart mode : '#{mode}' (Highcharts.Map)"
+            # super(`new Highcharts.Map( #{ options.to_n } )`)
+          else
+            raise ArgumentError, "invalid chart mode '#{mode}'"
+        end
+      end
+    end
+
+    # Adds an axis to the chart after render time.
+    # @param options [Hash] axis configuration options
+    # @param is_x [Boolean] optional, whether axis is X or Y axis, defaults to true
+    # @param redraw [Boolean] optional, whether to redraw after adding axis, defaults to true
+    # @param animation [Boolean,Hash] optional, whether to animate redraw, defaults to true
+    # @see http://api.highcharts.com/highcharts#Chart.addAxis
+    alias_native :add_axis, :addAxis
+
+    # Adds a series to the chart after render time.
+    # @param options [Hash] series configuration options
+    # @param is_x [Boolean] optional, whether axis is X or Y axis, defaults to true
+    # @param redraw [Boolean] optional, whether to redraw after adding axis, defaults to true
+    # @param animation [Boolean,Hash] optional, whether to animate redraw, defaults to true
+    # @see http://api.highcharts.com/highcharts#Chart.addSeries
+    alias_native :add_series, :addSeries
+
+    # Add a series to the chart as drilldown from a specific point in the parent series.
+    # @see http://api.highcharts.com/highcharts#Chart.addSeriesAsDrilldown
+    alias_native :add_series_as_drilldown, :addSeriesAsDrilldown
+
+    # Returns a (native) reference to the containing HTML element.
+    # @see http://api.highcharts.com/highcharts#Chart.container
+    alias_native :container
+
+    # Removes the chart and purges memory.
+    # @see http://api.highcharts.com/highcharts#Chart.destroy
+    alias_native :destroy
+
+    # When the chart is drilled down to a child series,
+    # chart.drill_up will drill up to the parent series.
+    # @see http://api.highcharts.com/highcharts#Chart.drillUp
+    alias_native :drill_up, :drillUp
+
+    # Exporting module required.
+    # Submit an SVG version of the chart to a server
+    # along with some parameters for conversion.
+    # @see http://api.highcharts.com/highcharts#Chart.exportChart
+    alias_native :export_chart, :exportChart
+
+    # Returns a chart element for a given a id.
+    # @see http://api.highcharts.com/highcharts#Chart.get
+    # @param id [String] the id of the chart element as set in configuration options
+    # @return [Axis,Series,Point,nil] the axis, series or point
+    alias_native :get
+
+    # Returns an SVG string representing the chart.
+    # Highcharts exporting module required.
+    # @see http://api.highcharts.com/highcharts#Chart.getSVG
+    # @param options [Hash] additional options
+    # @return [String]
+    alias_native :get_svg, :getSVG
+    alias_method :svg, :get_svg
+
+    # Returns the current configuration options of the chart.
+    # @see http://api.highcharts.com/highstock#Chart.options
+    # @return [Highcharts::Options]
+    alias_native :options, :options, as: Options
+
+    # Redraw the chart after any changes have been made.
+    # @param animation [Boolean,Hash] optional, whether to animate redraw, defaults to true
+    # @see http://api.highcharts.com/highstock#Chart.redraw
+    alias_native :redraw
+
+    # Returns the renderer for the chart.
+    # @see http://api.highcharts.com/highcharts#Renderer
+    # @return [Highcharts::Renderer]
+    alias_native :renderer, :renderer, as: Renderer
+
+    # Set a new title or subtitle for the chart.
+    # @param title [Hash] optional, configuration options for the title, default is nil
+    # @param subtitle [Hash] subtitle optional, configuration options for the subtitle. default is nil
+    # @param redraw [Boolean] optional, whether to redraw immediately, defaults to true
+    # @see http://api.highcharts.com/highstock#Chart.setTitle
+    alias_native :set_title, :setTitle
+
+    # Returns an array of the series in the chart.
+    # @see http://api.highcharts.com/highstock#Chart.series
+    # @return [Array<Series>]
+    alias_native :series, :series, array: Series # requires ##alias_native patch
+
+
+    # Change the title (but not subtitle) of the chart.
+    # @param text_or_options [String,Hash]
+    #   If a string, then only the title text will be changed.
+    #   If a hash it should contain title options.
+    # @param redraw [Boolean] optional, whether to redraw immediately, defaults to true
+    # @see http://api.highcharts.com/highstock#Chart.setTitle
+    def title=(string_or_hash, redraw = true)
+      t = string_or_hash.is_a?(String) ? {text: string_or_hash} : string_or_hash.to_h
+      set_title(t, nil, redraw)
+    end
+
+    # Change the subtitle (but not title) of the chart.
+    # @param text_or_options [String,Hash] string_or_hash
+    #   If a string, then only the subtitle text will be changed.
+    #   If a hash it should contain title options.
+    # @param redraw [Boolean] optional, whether to redraw immediately, defaults to true
+    # @see http://api.highcharts.com/highstock#Chart.setTitle
+    def subtitle=(string_or_hash, redraw = true)
+      t = string_or_hash.is_a?(String) ? {text: string_or_hash} : string_or_hash.to_h
+      set_title(nil, t, redraw)
+    end
+
+  end
+
+end

data/lib/opal/highcharts/extremes.rb

@@ -0,0 +1,14 @@
+module Highcharts
+
+  # http://api.highcharts.com/highcharts#Axis.getExtremes
+  class Extremes
+    include Base
+
+    alias_native :data_max, :dataMax
+    alias_native :data_min, :dataMin
+    alias_native :max, :max
+    alias_native :min, :min
+
+  end
+
+end  

data/lib/opal/highcharts/highcharts.rb

@@ -0,0 +1,36 @@
+# http://api.highcharts.com/highcharts#Highcharts
+
+module Highcharts
+  include Base
+
+  def self.chart(options)
+    Chart.new(options)
+  end
+
+  def self.charts
+    Native(`Highcharts.charts`).map { |e| Chart.new(e) }
+  end
+
+  def self.date_format(format, time = nil, capitalize = false)
+    `Highcharts.dateFormat(#{format}, #{time}, #{capitalize})`
+  end
+
+  def self.date_formats(*args, &block)
+    raise UnsupportedFeature, 'Highcharts.dateFormats'
+  end
+
+  def self.number_format(number, decimals = nil, decimal_point = nil, thousands_sep = nil)
+    `Highcharts.dateFormat(#{number}, #{decimals}, #{decimal_point}, #{thousands_sep})`
+  end
+
+  # Set global/default chart options (hash)
+  def self.set_options(options)
+    `Highcharts.setOptions( #{ options.to_n } )`
+  end
+
+  # Set global/default chart options (hash)
+  def self.options=(options)
+    set_options(options)
+  end
+
+end

data/lib/opal/highcharts/options.rb

@@ -0,0 +1,15 @@
+module Highcharts
+
+  # http://api.highcharts.com/highcharts#Chart.options
+  class Options
+    include Base
+
+    alias_native :colors
+    alias_native :symbols
+    alias_native :lang
+    alias_native :global
+    alias_native :chart
+
+  end
+
+end

data/lib/opal/highcharts/point.rb

@@ -0,0 +1,20 @@
+module Highcharts
+
+  # http://api.highcharts.com/highcharts#Point
+  class Point
+    include Base
+    
+    alias_native :category
+    alias_native :percentage
+    alias_native :remove
+    alias_native :select
+    alias_native :selected
+    alias_native :slice
+    alias_native :total
+    alias_native :update
+    alias_native :x
+    alias_native :y
+    
+  end
+
+end  

data/lib/opal/highcharts/renderer.rb

@@ -0,0 +1,18 @@
+module Highcharts
+
+  # http://api.highcharts.com/highcharts#Renderer
+  class Renderer
+    include Base
+    
+    alias_native :arc
+    alias_native :circle
+    alias_native :g
+    alias_native :image
+    alias_native :label
+    alias_native :path
+    alias_native :rect
+    alias_native :text
+
+  end
+
+end  

data/lib/opal/highcharts/series.rb

@@ -0,0 +1,30 @@
+module Highcharts
+
+  # http://api.highcharts.com/highcharts#Series
+  class Series
+    include Base
+
+    alias_native :add_point, :addPoint
+    alias_native :chart, :chart, as: Chart
+    alias_native :data, :data, array: Point
+    alias_native :hide
+    alias_native :name
+    alias_native :options # TODO: determine class for series options
+    alias_native :remove
+    alias_native :remove_point, :removePoint
+    alias_native :select
+    alias_native :selected
+    alias_native :set_data, :setData
+    alias_method :data=, :set_data
+    alias_native :set_visible, :setVisible
+    alias_native :show
+    alias_native :type
+    alias_native :update
+    alias_native :visible
+    alias_method :visible=, :set_visible
+    alias_native :x_axis, :xAxis, as: Axis
+    alias_native :y_axis, :yAxis, as: Axis
+
+  end
+
+end

data/lib/opal/highcharts/setup.rb

@@ -0,0 +1,13 @@
+# We need the Opal Native support library here:
+require 'native'
+
+# These requires must be loaded in order of dependency:
+require 'opal/highcharts/base'
+require 'opal/highcharts/options'
+require 'opal/highcharts/point'
+require 'opal/highcharts/extremes'
+require 'opal/highcharts/axis'
+require 'opal/highcharts/series'
+require 'opal/highcharts/renderer'
+require 'opal/highcharts/chart'
+require 'opal/highcharts/highcharts'

data/lib/opal/highcharts/version.rb

@@ -0,0 +1,7 @@
+module Opal
+
+  module Highcharts
+    VERSION = '0.1.1'
+  end
+
+end

data/opal-highcharts.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/opal/highcharts/version', __FILE__)
+
+Gem::Specification.new do |spec|
+  spec.name           = 'opal-highcharts'
+  spec.version        = Opal::Highcharts::VERSION
+  spec.authors        = [ 'Colin Gunn' ]
+  spec.email          = [ 'colgunn@icloud.com' ]
+  spec.homepage       = 'http://github.com/balmoral/opal-highcharts'
+  spec.summary        = 'Opal access to Highcharts and Highstock'
+  spec.description    = 'Opal DOM library for Highcharts and Highstock'
+  spec.license        = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_runtime_dependency 'opal', '>= 0.8.0', '< 0.9.0'
+  # spec.add_development_dependency 'opal-rspec', '~> 0.4.0'
+  # spec.add_development_dependency 'yard'
+  # spec.add_development_dependency 'rake'
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+# require 'opal-rspec'
+# require 'opal-highcharts'

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: opal-highcharts
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Colin Gunn
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: opal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+description: Opal DOM library for Highcharts and Highstock
+email:
+- colgunn@icloud.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- LICENSE.txt
+- README.md
+- gemfile
+- lib/Rakefile
+- lib/opal-highcharts.rb
+- lib/opal/highcharts.rb
+- lib/opal/highcharts/axis.rb
+- lib/opal/highcharts/base.rb
+- lib/opal/highcharts/chart.rb
+- lib/opal/highcharts/extremes.rb
+- lib/opal/highcharts/highcharts.rb
+- lib/opal/highcharts/options.rb
+- lib/opal/highcharts/point.rb
+- lib/opal/highcharts/renderer.rb
+- lib/opal/highcharts/series.rb
+- lib/opal/highcharts/setup.rb
+- lib/opal/highcharts/version.rb
+- opal-highcharts.gemspec
+- spec/spec_helper.rb
+homepage: http://github.com/balmoral/opal-highcharts
+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.6
+signing_key: 
+specification_version: 4
+summary: Opal access to Highcharts and Highstock
+test_files:
+- spec/spec_helper.rb
+has_rdoc: