neo-viz 1.0.1

data/.gitignore

@@ -0,0 +1,9 @@
+db
+vendor
+.bundle
+.sass-cache
+spec/coffeescripts/*.js
+views/coffeescript/*.js
+pkg
+Gemfile.lock
+

data/.livereload

@@ -0,0 +1,20 @@
+# Lines starting with pound sign (#) are ignored.
+
+# additional extensions to monitor
+config.exts << 'scss'
+config.exts << 'haml'
+
+# exclude files with NAMES matching this mask
+#config.exclusions << '~*'
+# exclude files with PATHS matching this mask (if the mask contains a slash)
+#config.exclusions << '/excluded_dir/*'
+# exclude files with PATHS matching this REGEXP
+#config.exclusions << /somedir.*(ab){2,4}.(css|js)$/
+
+# reload the whole page when .js changes
+#config.apply_js_live = false
+# reload the whole page when .css changes
+#config.apply_css_live = false
+
+# wait 100ms for more changes before reloading a page
+#config.grace_period = 0.1

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format p d

data/.rvmrc

@@ -0,0 +1,3 @@
+rvm use jruby-1.6.5
+
+

data/Gemfile

@@ -0,0 +1,6 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in neo-viz.gemspec
+gemspec
+
+

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2011 AmanziTel
+
+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,120 @@
+# Neo-Viz
+
+Neo-Viz is a tool for visualizing Neo data in the browser. It is
+a Sinatra application that uses Neo4j.rb to read data from a Neo
+database directory. It shows the data using Javascript in a browser.
+
+
+## Installing
+
+The visualizer can be used stand-alone or embedded in a Rails application.
+
+### External Dependencies
+
+The visualizer has an external dependency on coffee-script. It can be
+installed by:
+
+    # OS X
+    $ brew install coffee-script
+
+    # Linux
+    $ apt-get install coffee-script
+
+
+
+### Standalone
+
+To use it standalone you must first get the code from the repository.
+
+    $ git clone git@github.com:AmanziTel/neo-viz.git
+    $ cd neo-viz
+    
+    # To use it as is
+    $ rackup
+    [2011-06-23 07:48:34] INFO  WEBrick 1.3.1
+    [2011-06-23 07:48:34] INFO  ruby 1.8.7 (2011-05-23) [java]
+    [2011-06-23 07:48:34] INFO  WEBrick::HTTPServer#start: pid=64743 port=9292
+
+    
+    # To install it as a gem
+    $ rake install
+    neo-viz 1.0.0 built to pkg/neo-viz-1.0.0.gem
+    neo-viz (1.0.0) installed
+    
+    $ neo-viz
+    [2011-06-23 07:51:10] INFO  WEBrick 1.3.1
+    [2011-06-23 07:51:10] INFO  ruby 1.8.7 (2011-05-23) [java]
+    [2011-06-23 07:51:10] INFO  WEBrick::HTTPServer#start: pid=64864 port=1666
+    
+### Embedding in Rails
+
+To embed the visualizer in Rails, you first have to add it to your `Gemfile`.
+   
+    # Gemfile
+    gem 'neo-viz', :git => 'git@github.com:AmanziTel/neo-viz.git'
+
+Then you have to mount the route in `routes.rb`
+
+    # config/routes.rb
+    mount Neo::Viz::App => '/neo-viz'
+
+You can now access it at e.g. http://localhost:3000/neo-viz.
+
+## Neo4j Database
+
+The standalone version expects a `db` directory containing the usual
+Neo4j database files.
+    
+The embedded version uses the Neo4j database that has been configured
+for the embedding project.
+
+## Known issues
+
+There is a problem running the Jasmine specs (/run-specs) on Windows if the "therubyrhino" gem is installed
+and you are using JRuby. On Windows we want to use the built-in JScript runtime but ExecJS chooses Rhino if it
+is installed.
+
+Typical errors returned over HTTP when requesting a .coffee file:
+
+    throw Error("NativeException: org.mozilla.javascript.JavaScriptException:
+        Error: too many ) on line 2 (<eval>#8)\n  (in c:/..../neo-viz/public/coffeescripts/canvas_util.coffee)")
+
+A workaround is to uninstall the therubyrhino gem, but ofcourse it will be re-installed on every call to bundle.
+I can't figure out how to tell bundler not to load a specific gem when I'm on JRuby and Windows.
+
+## To do
+
+### Server
+
+* Make it possible to choose where that data comes from
+* Implement a command line interface for starting the server and
+  selecting the data source.
+
+
+### Client
+
+* Group nodes, if there are too many to show.
+* bind and trigger with custom events
+
+
+### License
+
+MIT, see LICENSE file
+
+### Changes
+
+* 2011-09-28 Added relationship filter
+* 2001-09-28 Enabled embedding from AJAX-call (/embedded)
+* 2011-06-23 Changed the namespace.
+* 2011-06-23 Added depth to the traversal algorithm
+* 2011-06-20 A query protocol for selecting only the relevant nodes
+* 2011-06-20 Query protocol editor to select the relevant nodes to ask
+* 2011-06-16 Views for showing only the relevant properties.
+* 2011-06-16 Node filter
+* 2011-06-16 Select number of nodes to show.
+* 2011-06-14 Click to show detailed information.
+* Connect with the Server to get the data.
+* Fetch new data from the Server when a node is selected.
+* Limit the amount of nodes shown on the screen.
+* Show the properties of the nodes and relations.
+

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+begin
+  require 'jasmine'
+  load 'jasmine/tasks/jasmine.rake'
+rescue LoadError
+  task :jasmine do
+    abort "Jasmine is not available. In order to run jasmine, you must: (sudo) gem install jasmine"
+  end
+end
+

data/bin/neo-viz

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+require 'rack'
+
+rackup_file = File.expand_path('../../config.ru', __FILE__)
+
+ARGV.concat(["-p", "1666"]) unless ARGV.include?("-p")
+ARGV.concat(["-E", "production"]) unless ARGV.include?("-E")
+ARGV << rackup_file unless ARGV.include?(/\.ru/)
+
+Rack::Server.start
+

data/config.ru

@@ -0,0 +1,35 @@
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/lib'
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/views'
+
+require 'sprockets'
+require 'neo-viz'
+require 'find'
+
+map '/' do
+  run Neo::Viz::App
+end
+
+map '/assets' do
+  environment = Sprockets::Environment.new
+
+  # map all dirs under /public to /assets
+  Find.find(File.join(Neo::Viz.install_path, "public")) do |path|
+    environment.append_path(path) if FileTest.directory?(path)
+  end
+
+  environment.instance_eval do
+    @context_class.instance_eval do
+      define_method :root_url do
+        '.'
+      end
+    end
+  end
+
+  run environment
+end
+
+map '/specs' do
+  environment = Sprockets::Environment.new
+  environment.append_path 'spec/coffeescripts'
+  run environment
+end

data/lib/neo-viz.rb

@@ -0,0 +1,185 @@
+require 'sinatra/base'
+
+require 'haml'
+require 'sass'
+require 'coffee-script'
+require 'neo4j'
+require 'sprockets'
+require 'execjs'
+
+module Neo; module Viz; end; end
+
+
+module Neo::Viz
+
+  def self.install_path
+    return File.expand_path('../..', __FILE__)
+  end
+
+  class App < Sinatra::Base
+
+    include Neo4j
+
+    configure do
+      set :public, File.expand_path('../../public/', __FILE__)
+      set :views, File.expand_path('../../views/', __FILE__)
+    end
+
+    configure(:development) do
+      require 'sinatra/reloader'
+      register Sinatra::Reloader
+      also_reload "lib/**/*.rb"
+    end
+
+    get '/' do
+      redirect to('/index')
+    end
+
+    get '/index' do
+      @assets_url_prefix = ''
+      haml :index
+    end
+
+    # Consumers of /embedded have to redefine this method inside
+    # the Sprockets environment. See config.ru.
+    def root_url
+      '.'
+    end
+
+    get '/embedded' do
+      @assets_url_prefix = request.env["rack.mount.prefix"] || ''
+      haml :embedded
+    end
+
+    get '/node-count' do
+      Neo4j.management.get_number_of_node_ids_in_use.to_s
+    end
+
+    get '/tree' do
+      Neo4j.ref_node.rels.map { |rel| rel.end_node.attributes }.inspect
+    end
+
+    get '/env' do
+      #p ExecJS::runtime
+      p request.env
+      request.env.inspect
+    end
+
+    get '/run-specs' do
+      haml :jasmine_specs_runner
+    end
+
+    get '/eval' do 
+      code = params[:code]
+      p code
+      ret = eval_code code, depth
+      if node_data?(ret)
+        ret.to_json
+      else
+        # Hallberg: is seems 'to_s' does not alias 'inspect' for Hash and Array
+        # on JRuby 1.6.4 on Windows. Instead {:foo => :bar}.to_s = "foobar".
+        # So special case them here.
+        if ret.kind_of?(Hash) || ret.kind_of?(Array)
+          { :result => ret.inspect}.to_json
+        else
+          { :result => "#{ret}" }.to_json
+        end
+      end
+    end
+
+
+    private
+
+    def node_data?(ret)
+      ret.kind_of?(Hash) && ret.length == 2 && ret.key?(:nodes) && ret.key?(:rels)
+    end
+
+    def depth
+      params[:depth].try(:to_i) || 1
+    end
+
+    def eval_code(code, depth)
+      code = underscore code
+
+      begin
+        $Depth = depth
+        tx = Neo4j::Transaction.new
+        begin
+          result = eval <<-EOT
+            #{code}
+          EOT
+        rescue SyntaxError => e
+          return e
+        end
+        tx.success
+        result
+      rescue => e
+        e
+      ensure
+        tx.finish
+      end
+
+    end
+
+    # This changes the code to use the internal versions that
+    # don't use classes, but just pure nodes and relations.
+    def underscore code
+      code.
+        gsub(/\bload\b/, '_load').
+        gsub(/\brels\b/, '_rels').
+        gsub(/\bnode\b/, '_node')
+    end
+
+    def viz(*args) 
+      depth = $Depth 
+      data = { :nodes => [], :rels => [] }
+      args.each do |arg|
+        data_for(data, arg, depth)
+      end
+      data
+    end
+
+    def data_for(data, obj, depth)
+      if obj.class.to_s == 'Neo4j::Relationship'
+        populate_data(data, arg.start_node, depth, [])
+      elsif obj.class.to_s == 'Neo4j::Node'
+        populate_data(data, obj, depth, [])
+      elsif obj.respond_to? :each
+        obj.each do |o|
+          data_for(data, o, depth)
+        end
+      end
+      data
+    end
+
+    def populate_data(data, node, depth, navigatedRels)
+      data[:nodes] << node_data(node)
+      return if depth == 0
+      node._rels.each do |rel|
+        # Make sure we don't walk the same rel path more than once
+        if !navigatedRels.include?(rel)
+          data[:rels] << rel_data(rel)
+          navigatedRels << rel
+          populate_data(data, rel._other_node(node), depth-1, navigatedRels)
+        end
+      end
+    end
+
+    def node_data(node)
+      {
+        :id => node.props['_neo_id'],
+        :data => node.props,
+      }
+    end
+
+    def rel_data(rel)
+      {
+        :id => rel.props['_neo_id'],
+        :start_node => rel._start_node.props['_neo_id'],
+        :end_node => rel._end_node.props['_neo_id'],
+        :data => rel.props.merge(:rel_type => rel.rel_type)
+      }
+    end
+  end
+
+end

data/lib/neo-viz/version.rb

@@ -0,0 +1,6 @@
+module Neo
+  module Viz
+    VERSION = "1.0.1"
+  end
+end
+