hyper-vis 1.0.0.lap24

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fe18835be08b221fd9615c5726edee4a71c3fb58381f57b97e174e4ec7c762bf
+  data.tar.gz: c12b8e5d6289cf07211e077e1e026caaeb0caaa07167ed63ead659d5ee1dbc63
+SHA512:
+  metadata.gz: 491a08e191f79ccdb77c279850f3d30688a6bc798ca24e39945a63427ac4e244444351df077e1d0251b58b86f5f560da8aa6be3c2c809c23c7b2b297120232e5
+  data.tar.gz: f2dc038fc7c21240169882776ca970e4f91435406063885148013724d1f736061f9b888a8feda6019d619f9abffe984673dde5b6f96f4de02f50e00409920f55

data/.gitignore

@@ -0,0 +1,51 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+spec/test_app/Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+gem "opal-jquery", git: "https://github.com/opal/opal-jquery.git", branch: "master"
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Jan Biedermann
+
+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 @@
+# hyper-vis

data/hyper-vis.gemspec

@@ -0,0 +1,28 @@
+require_relative "lib/hyperloop/vis/version"
+
+Gem::Specification.new do |s|
+  s.name         = "hyper-vis"
+  s.version      = Hyperloop::Vis::VERSION
+  s.author       = "Jan Biedermann"
+  s.email        = "jan@kursator.de"
+  s.homepage     = "https://github.com/janbiedermann/hyper-vis"
+  s.summary      = "Ruby bindings for Vis as a Ruby Hyperloop Component"
+  s.description  = "Write React Components in ruby to show graphics created with Vis.js in the ruby way"
+
+  s.files          = `git ls-files`.split("\n")
+  s.executables    = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.test_files     = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_paths  = ["lib"]
+
+  s.add_runtime_dependency "opal", "~> 0.11.0"
+  s.add_runtime_dependency "opal-activesupport", "~> 0.3.1"
+  s.add_runtime_dependency "hyper-component", "~> 1.0.0.lap23"
+  s.add_runtime_dependency "hyperloop-config", "~> 1.0.0.lap23"
+  s.add_development_dependency "hyperloop", "~> 1.0.0.lap23"
+  s.add_development_dependency "hyper-spec", "~> 1.0.0.lap23"
+  s.add_development_dependency "listen"
+  s.add_development_dependency "rake", ">= 11.3.0"
+  s.add_development_dependency "rails", ">= 5.1.0"
+  s.add_development_dependency "rspec-rails"
+  s.add_development_dependency "sqlite3"
+end

data/lib/hyper-vis.rb

@@ -0,0 +1,15 @@
+require 'hyperloop-config'
+require 'hyper-component'
+Hyperloop.import 'vis/source/vis.js', client_only: true
+Hyperloop.import 'hyper-vis'
+require 'opal-activesupport'
+require 'hyperloop/vis/version'
+
+if RUBY_ENGINE == 'opal'
+  require 'vis'
+  require 'hyper-component'
+  require 'hyperloop/vis/mixin'
+  require 'hyperloop/vis/component'
+else
+  Opal.append_path __dir__.untaint
+end

data/lib/hyperloop/vis/component.rb

@@ -0,0 +1,12 @@
+module Hyperloop
+  module Vis
+    class Component
+      include Hyperloop::Vis::Mixin
+      def self.inherited(base)
+        base.class_eval do
+          param data: nil
+        end
+      end
+    end
+  end
+end

data/lib/hyperloop/vis/mixin.rb

@@ -0,0 +1,50 @@
+require 'react/component'
+
+module Hyperloop
+  module Vis
+    module Mixin
+      def self.included(base)
+        base.include(Hyperloop::Component::Mixin)
+        base.class_eval do
+          param data: nil
+
+          def _set_dom_node(dom_node)
+            @_dom_node = dom_node
+          end
+
+          def data
+            @_data
+          end
+          
+          def self.render_with_dom_node(tag = 'DIV', &block)
+            render do
+              @_vis_render_block = block
+              @_data = params.data
+              send(tag, ref: method(:_set_dom_node).to_proc)
+            end
+          end
+
+          def should_component_update?
+            false
+          end
+
+          after_mount do
+            if @_dom_node && @_vis_render_block
+              @_vis_render_block.call(@_dom_node, @_data)
+            end
+          end
+
+          before_receive_props do |new_props|
+            if new_props[:data] != @_data
+              @_data = new_props[:data] 
+              if @_dom_node && @_vis_render_block
+                @_vis_render_block.call(@_dom_node, @_data)
+              end
+            end
+          end
+        end
+      end
+      
+    end
+  end
+end

data/lib/hyperloop/vis/version.rb

@@ -0,0 +1,5 @@
+module Hyperloop
+  module Vis
+    VERSION = '1.0.0.lap24'
+  end
+end

data/lib/vis.rb

@@ -0,0 +1,9 @@
+require 'opal'
+require 'active_support/core_ext/string'
+require 'vis/native'
+require 'vis/utilities'
+require 'vis/event_support'
+require 'vis/data_common'
+require 'vis/data_set'
+require 'vis/data_view'
+require 'vis/network'

data/lib/vis/data_common.rb

@@ -0,0 +1,23 @@
+module Vis
+  module DataCommon
+    def [](id)
+      get(id)
+    end
+
+    def get(*args)
+      if `Opal.is_a(args.$last(), Opal.Hash)`
+        args.push(options_to_native(args.pop))
+      end
+      res = `self["native"].get.apply(self["native"], Opal.to_a(args))`
+      if `res !== null && Opal.is_a(res, Opal.Array)`
+        native_to_hash_array(res)
+      else
+        `res !== null ? Opal.Hash.$new(res) : #{nil}`
+      end
+    end
+
+    def get_ids(options)
+      @native.JS.getIds(options_to_native(options))
+    end
+  end
+end

data/lib/vis/data_set.rb

@@ -0,0 +1,91 @@
+module Vis
+  class DataSet
+    include Native
+    include Vis::Utilities
+    include Vis::EventSupport
+    include Vis::DataCommon
+
+    aliases_native %i[clear distinct flush length]
+    native_method_with_options :setOptions
+    alias :size :length
+    
+    attr_reader :event_handlers
+
+    def initialize(*args)
+      if args[0] && `Opal.is_a(args[0], Opal.Hash)`
+        hash_array = []
+        options = args[0]
+      elsif args[0] && `Opal.is_a(args[0], Opal.Array)`
+        hash_array = args[0]
+        options = args[1] ? args[1] : {}
+      else
+        hash_array = []
+        options = {}
+      end
+      native_data = hash_array_to_native(hash_array)
+      native_options = options_to_native(options)
+      @event_handlers = {}
+      @native = `new vis.DataSet(native_data, native_options)`
+    end
+
+    def []=(id, hash)
+      if get(id)
+        update(hash[:id] = id)
+      else
+        add(hash[:id] = id)
+      end
+    end
+
+    def add(*args)
+      if args[0] && `Opal.is_a(args[0], Opal.Hash)`
+        args[0] = args[0].to_n
+      elsif args[0] && `Opal.is_a(args[0], Opal.Array)`
+        args[0] = hash_array_to_native(args[0])
+      end
+      `self["native"].add.apply(self["native"], Opal.to_a(args))`
+    end
+
+    def each(options = nil, &block)
+      native_options = options_to_native(options)
+      `return self["native"].forEach(function(item) { return block.$call(Opal.Hash.$new(item)); }, native_options)`
+    end
+
+    def get_data_set
+      self
+    end
+
+    def map(options = nil, &block)
+      native_options = options_to_native(options)
+      `return self["native"].map(function(item) { return #{block.call(`Opal.Hash.$new(item)`)}; }, native_options)`
+    end
+
+    def max(field)
+      res = @native.JS.max(field)
+      `res !== null ? Opal.Hash.$new(res) : #{nil}`
+    end
+    
+    def min(field)
+      res = @native.JS.min(field)
+      `res !== null ? Opal.Hash.$new(res) :  #{nil}`
+    end
+
+    def remove(*args)
+      if `Opal.is_a(args[0], Opal.Array)`
+        args[0] = hash_array_to_native(args[0])
+      elsif `Opal.is_a(args[0], Opal.Hash)`
+        args[0] = args[0].to_n
+      end
+      `self["native"].remove.apply(self["native"], Opal.to_a(args))`
+    end
+
+    def update(*args)
+      if args[0] && `Opal.is_a(args[0], Opal.Hash)`
+        args[0] = args[0].to_n
+      elsif args[0] && `Opal.is_a(args[0], Opal.Array)`
+        args[0] = hash_array_to_native(args[0])
+      end
+      `self["native"].update.apply(self["native"], Opal.to_a(args))`
+    end
+
+  end
+end

data/lib/vis/data_view.rb

@@ -0,0 +1,29 @@
+module Vis
+  class DataView
+    include Native
+    include Vis::Utilities
+    include Vis::EventSupport
+    include Vis::DataCommon
+
+    aliases_native %i[refresh length]
+    alias :size :length
+
+    attr_reader :event_handlers
+
+    def initialize(data_set_or_view, options = {})
+      native_options = options_to_native(options)
+      @data_set_or_view = data_set_or_view
+      @event_handlers = {}
+      @native = `new vis.DataView(data_set_or_view.$to_n(), native_options)`
+    end
+
+    def get_data_set
+      @data_set_or_view
+    end
+
+    def set_data(data_set_or_view)
+      @data_set_or_view = data_set_or_view
+      @native.JS.setData(data_set_or_view.to_n)
+    end
+  end
+end

data/lib/vis/event_support.rb

@@ -0,0 +1,24 @@
+module Vis
+  module EventSupport
+    def off(event, event_handler_id)
+      event = lower_camelize(event)
+      handler = @event_handlers[event][event_handler_id]
+      `self["native"].off(event, handler)`
+      @event_handlers[event].delete(event_handler_id)
+    end
+    
+    def on(event, &block)
+      event = lower_camelize(event)
+      @event_handlers[event] = {} unless @event_handlers[event]
+      event_handler_id = `Math.random().toString(36).substring(6)`
+      handler = %x{
+        function(event_str, properties, sender_id) {
+          #{block.call(`event_str`, `Opal.Hash.$new(properties)`, `sender_id`)};
+        }
+      }
+      @event_handlers[event][event_handler_id] = handler
+      `self["native"].on(event, handler);`
+      event_handler_id
+    end
+  end
+end

data/lib/vis/native.rb

@@ -0,0 +1,11 @@
+require "native"
+
+module Native
+  module Helpers
+    def aliases_native(native_names)
+      native_names.each do |native_name|
+        alias_native(native_name.underscore, native_name)
+      end
+    end
+  end
+end

data/lib/vis/network.rb

@@ -0,0 +1,212 @@
+module Vis
+  class Network
+    include Native
+    include Vis::Utilities
+
+    aliases_native %i[
+      addEdgeMode
+      addNodeMode
+      deleteSelected
+      destroy
+      editEdgeMode
+      editNode
+      enableEditMode
+      disableEditMode
+      findNode 
+      getBaseEdges 
+      getClusteredEdges
+      getConnectedEdges
+      getConnectedNodes
+      getNodesInCluster
+      getScale
+      getSeed
+      getSelectedEdges
+      getSelectedNodes
+      isCluster
+      moveNode
+      redraw
+      releaseNode
+      selectEdges
+      selectNodes
+      stabilize
+      startSimulation
+      stopSimulation
+      storePositions
+      unselectAll
+    ]
+
+    def initialize(native_container, dataset_hash, options = {})
+      native_options = options_to_native(options)
+      nodes_dataset = dataset_hash[:nodes].to_n
+      edges_dataset = dataset_hash[:edges].to_n
+      native_data = `{ nodes: nodes_dataset, edges: edges_dataset }`
+      @event_handlers = {}
+      @native = `new vis.Network(native_container, native_data, native_options)`
+    end
+
+    # global methods
+
+    def off(event, event_handler_id)
+      event = lower_camelize(event)
+      handler = @event_handlers[event][event_handler_id]
+      `self["native"].off(event, handler)`
+      @event_handlers[event].delete(event_handler_id)
+    end
+    
+    def on(event, &block)
+      event = lower_camelize(event)
+      @event_handlers[event] = {} unless @event_handlers[event]
+      event_handler_id = `Math.random().toString(36).substring(6)`
+      handler = %x{
+        function(event_info) {
+          #{block.call(`Opal.Hash.$new(event_info)`)};
+        }
+      }
+      @event_handlers[event][event_handler_id] = handler
+      `self["native"].on(event, handler);`
+      event_handler_id
+    end
+
+    def once(event, &block)
+      handler = %x{
+        function(event_info) {
+          #{block.call(`Opal.Hash.$new(event_info)`)};
+        }
+      }
+      `self["native"].once(event, handler);`
+    end
+
+    def set_data(dataset_hash)
+      nodes_dataset = dataset_hash[:nodes].to_n
+      edges_dataset = dataset_hash[:edges].to_n
+      native_data = `{ nodes: nodes_dataset, edges: edges_dataset }`
+      @native.JS.setData(native_data)
+    end
+
+    def set_options(options)
+      native_options = options_to_native(options)
+      @native.JS.setOptions(native_options)
+    end
+
+    # canvas methods
+
+    def canvas_to_dom(xy_hash)
+      res = @native.JS.canvasToDOM(xy_hash.to_n)
+      `Opal.Hash.$new(res)`
+    end
+
+    def dom_to_canvas(xy_hash)
+      res = @native.JS.DOMtoCanvas(xy_hash.to_n)
+      `Opal.Hash.$new(res)`
+    end
+
+    def set_size(width, height)
+      width = width.to_s
+      height = height.to_s
+      @native.JS.setSize(width, height)
+    end
+
+    # clustering
+
+    def cluster(options)
+      @native.JS.cluster(options_to_native(options))
+    end
+
+    def cluster_by_connection(node_id, options)
+      @native.JS.clusterByConnection(node_id, options_to_native(options))
+    end
+
+    def cluster_by_hubsize(hub_size, options)
+      @native.JS.clusterByHubsize(hub_size, options_to_native(options))
+    end
+
+    def cluster_outliers(options)
+      @native.JS.clusterOutliers(options_to_native(options))
+    end
+
+    def open_cluster(node_id, options)
+      @native.JS.openCluster(node_id, options_to_native(options))
+    end
+
+    def update_edge(start_edge_id, options)
+      @native.JS.updateEdge(start_edge_id, options_to_native(options))
+    end
+
+    def update_clustered_node(clustered_node_id, options)
+      @native.JS.updateClusteredNode(start_edge_id, options_to_native(options))
+    end
+
+    # information
+
+    def get_bounding_box(node_id)
+      res = @native.JS.getBoundingBox(node_id)
+      `Opal.Hash.$new(res)`
+    end
+
+    def get_positions(array_of_node_ids)
+      res = @native.JS.getPositions(array_of_node_ids)
+      `Opal.Hash.$new(res)`
+    end
+
+    # selection
+
+    def get_edge_at(dom_xy_hash)
+      @native.JS.getEdgeAt(xy_hash.to_n)
+    end
+
+    def get_node_at(dom_xy_hash)
+      @native.JS.getNodeAt(xy_hash.to_n)
+    end
+
+    def get_selection
+      res = @native.JS.getSelection
+      `Opal.Hash.$new(res)`
+    end
+
+    def set_selection(selection_hash, options)
+      @native.JS.setSelection(selection_hash.to_n, options_to_native(options))
+    end
+
+    # viewport
+
+    def fit(options)
+      @native.JS.fit(options_to_native(options))
+    end
+
+    def focus(node_id, options)
+      @native.JS.focus(node_id, options_to_native(options))
+    end
+
+    def get_view_position
+      res = @native.JS.getViewPosition
+      `Opal.Hash.$new(res)`
+    end
+
+    def move_to(options)
+      @native.JS.moveTo(options_to_native(options))
+    end
+
+    # configurator module
+    def get_options_from_configurator
+      res = @native.JS.getOptionsFromConfigurator
+      `Opal.Hash.$new(res)`
+    end
+
+    # importing data
+    def self.convert_gephi(gephi_json, options)
+      native_options = options_to_native(options)
+      res = `vis.network.convertGephi(gephi_json, native_options)`
+      `Opal.Hash.$new(res)`
+    end
+
+    def self.convert_dot(dot_string)
+      res = `vis.network.convertDot(dot_string)`
+      `Opal.Hash.$new(res)`
+    end
+
+    # test helper
+    def self.test_container
+      `document.body.appendChild(document.createElement('div'))`
+    end
+  end
+end