neolytics 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b9f88458d8ba044e986867ec1e740f292dce0961
+  data.tar.gz: 22b7537a706c4f377102f7e205d9a834e09bde12
+SHA512:
+  metadata.gz: 96424597969051fa96d53b6e0e26796b4519542f2c2bce900c9b28cfd14816f0af3c0f8034b78d9517e6ebee7806cb53464ff592dc83444fded90b6a65993160
+  data.tar.gz: 350a7ff4d6edbf45794aeae147f2ab8ee7229ec4a4aa59bf6c978b32eda3c14a1d4e6dabc84a573d1ca1597d6c19d5c55445135ec3d2bdcc0330dfad5267507c

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,50 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at public@brian-underwood.codes. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in neolytics.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Brian Underwood
+
+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,41 @@
+# Neolytics
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/neolytics`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'neolytics'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install neolytics
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/neolytics. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "neolytics"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/neo4apis/neolytics.rb

@@ -0,0 +1,160 @@
+require 'neo4apis/neolytics/trace_point_helpers'
+
+module Neo4Apis
+  class Neolytics < Base
+    common_label :Neolytics
+
+    uuid :Object, :ruby_object_id
+    uuid :TracePoint, :uuid
+    uuid :ASTNode, :uuid
+    uuid :File, :path
+
+    batch_size 10000
+
+    IMPORTED_OBJECT_NODES = {}
+
+    importer :Object do |object|
+      next IMPORTED_OBJECT_NODES[object.object_id] if IMPORTED_OBJECT_NODES.key?(object.object_id)
+
+      object_node = add_node(:Object) do |node|
+        node.ruby_object_id = object.object_id
+        node.ruby_inspect = object.inspect[0,500]
+        node._extra_labels = []
+        node._extra_labels << 'Class' if object.class == Class
+        node._extra_labels << 'Module' if object.class == Module
+      end
+
+      IMPORTED_OBJECT_NODES[object.object_id] = object_node
+
+      class_node = import :Object, object.class
+      add_relationship :IS_A, object_node, class_node if class_node
+
+      if object.respond_to?(:superclass) && object.superclass
+        superclass_node = import :Object, object.superclass
+        add_relationship :HAS_SUPERCLASS, object_node, superclass_node if superclass_node
+      end
+
+      if object.respond_to?(:included_modules)
+        object.included_modules.each do |mod|
+          module_node = import :Object, mod
+          add_relationship :INCLUDES_MODULE, object_node, module_node if module_node
+        end
+      end
+
+      object.instance_variables.each do |variable|
+        value = object.instance_variable_get(variable)
+        other_object_node = import :Object, value
+        add_relationship :INSTANCE_VARIABLE, object_node, other_object_node, variable: variable
+      end
+
+      object_node
+    end
+
+    importer :TracePoint do |tp, execution_time, execution_index, last_tracepoint_node, parent, associated_call|
+      next nil if tp.method_id.blank? && tp.defined_class.blank?
+
+      trace_point_node = add_node :TracePoint, tp, %i(event lineno method_id) do |node|
+        node.uuid = SecureRandom.uuid
+        node.defined_class = tp.defined_class.to_s
+        node.execution_time = execution_time if execution_time
+        node.execution_index = execution_index
+
+        node.path = Pathname.new(tp.path).realpath.to_s
+      end
+
+
+      if [:return, :c_return].include?(tp.event)
+        returned_object_node = import :Object, tp.return_value
+        add_relationship :RETURNED, trace_point_node, returned_object_node
+      end
+
+      unless tp == tp.self
+        begin
+          ruby_object_node = import :Object, tp.self
+          add_relationship :FROM_OBJECT, trace_point_node, ruby_object_node
+        rescue Exception
+          nil
+        end
+      end
+
+      if tp.event == :line
+        TracePointHelpers.each_referenced_variable(tp) do |var, value|
+          object_node = import :Object, value
+          add_relationship :HAS_VARIABLE_VALUE, trace_point_node, object_node, variable_name: var
+        end
+      end
+
+      if tp.event == :call
+        TracePointHelpers.each_received_arguments(tp) do |argument, value|
+          object_node = import :Object, value
+          add_relationship :RECEIVED_ARGUMENT, trace_point_node, object_node, argument_name: argument
+        end
+      end
+
+      add_relationship :NEXT, last_tracepoint_node, trace_point_node if last_tracepoint_node
+      add_relationship :HAS_PARENT, trace_point_node, parent if parent
+      add_relationship :STARTED_AT, trace_point_node, associated_call if associated_call
+
+      trace_point_node
+    end
+
+    AST_METHODS = %i(
+              keyword operator expression name argument
+              double_colon in else assoc dot selector
+              begin end
+            )
+
+    def extract_code_range(code, rangy_obj)
+      code[rangy_obj.begin_pos..rangy_obj.end_pos - 1] if rangy_obj
+    end
+
+    importer :ASTNode do |node, file_node, parent_db_entry = nil|
+      next nil if !node.respond_to?(:loc)
+
+      node_node = add_node :ASTNode do |n|
+        n.uuid = SecureRandom.uuid
+
+        n.file_path = file_node.props[:path]
+        n.type = node.type if node.respond_to?(:type)
+
+        loc = node.loc
+        n.line = node.line if node.respond_to?(:line)
+        n.column = node.column if node.respond_to?(:column)
+
+        n.loc_class = loc.class.to_s
+
+        if loc.respond_to?(:expression)
+          e = loc.expression
+          %i(first_line last_line begin_loc end_loc).each do |method|
+            n[method] = e.send(method) if e.respond_to?(method)
+          end
+
+          AST_METHODS.each do |method|
+            n[method] = extract_code_range(file_node.props[:content], loc.send(method)) if loc.respond_to?(method)
+          end
+        end
+
+        n.each_pair {|k, v| n.delete_field(k) if v.nil? }
+      end
+
+      add_relationship :HAS_PARENT, node_node, parent_db_entry if parent_db_entry
+
+      add_relationship :FROM_FILE, node_node, file_node
+
+      if node.respond_to?(:children)
+        node.children.compact.each do |child|
+          import :ASTNode, child, file_node, node_node
+        end
+      end
+
+      node_node
+    end
+
+    importer :File do |full_path, content|
+      add_node :File do |node|
+        node.path = full_path
+        node.content = content
+      end
+    end
+  end
+end

data/lib/neo4apis/neolytics/trace_point_helpers.rb

@@ -0,0 +1,75 @@
+module Neo4Apis
+  class Neolytics < Base
+    module TracePointHelpers
+
+      class << self
+
+        FILE_LINES = {}
+
+        def each_received_arguments(tp)
+          # Can't just use #method method because some objects implement a #method method
+          method = if tp.self.class.instance_method(:method).source_location.nil?
+            tp.self.method(tp.method_id)
+          else
+            tp.self.class.instance_method(tp.method_id)
+          end
+          parameter_names = method.parameters.map {|_, name| name }
+          arguments = parameter_names.each_with_object({}) do |name, arguments|
+            catch :not_found do
+              arguments[name] = get_trace_point_var(tp, name)
+            end
+          end
+          arguments.each do |name, object|
+            value = RubyObject.from_object(object)
+            yield name, value
+          end
+        end
+
+        def each_referenced_variable(tp)
+          line = get_file_line(tp.path, tp.lineno)
+          root = Parser::CurrentRuby.parse(line)
+          extract_variables(root).each do |variable|
+            catch :not_found do
+              value = get_trace_point_var(tp, variable)
+              yield variable, value
+            end
+          end
+        rescue Parser::SyntaxError
+          nil
+        end    
+
+        private
+
+        def extract_variables(ast_node)
+          if ast_node.is_a?(Parser::AST::Node)
+            if ast_node.type == :send &&
+                 ast_node.children.size == 2 &&
+                 ast_node.children[0].nil?
+              [ast_node.children[1]]
+            else
+              ast_node.children.flat_map do |child|
+                extract_variables(child)
+              end
+            end
+          else
+            []
+          end
+        end
+
+        def get_file_line(path, lineno)
+          FILE_LINES[path] ||= File.read(path).lines
+
+          FILE_LINES[path][lineno - 1]
+        end
+
+        def get_trace_point_var(tp, var_name)
+          begin
+            tp.binding.local_variable_get(variable)
+          rescue NameError
+            throw :not_found
+          end
+        end
+      end
+    end
+  end
+end

data/lib/neolytics.rb

@@ -0,0 +1,14 @@
+require 'neolytics/version'
+require 'neolytics/recorder'
+
+module Neolytics
+  class << self
+    def record_execution(neo4j_session)
+      recorder = Recorder.new(neo4j_session)
+
+      recorder.record do
+        yield
+      end
+    end
+  end
+end

data/lib/neolytics/recorder.rb

@@ -0,0 +1,129 @@
+require 'pathname'
+require 'parser/current'
+require 'neo4apis'
+require 'neo4apis/neolytics'
+
+module Neolytics
+  class Recorder
+    def initialize(neo4j_session)
+      @neo4j_session = neo4j_session
+      @neo4apis_session = Neo4Apis::Neolytics.new(neo4j_session)
+    end
+
+    def record(&block)
+      @neo4apis_session.batch do
+        record_execution_trace do
+          begin
+            block.call
+          rescue Exception => e
+            nil
+          end
+        end
+
+        file_paths = @neo4j_session.query("MATCH (tp) WHERE NOT(tp.path IS NULL) RETURN DISTINCT tp.path AS path").map(&:path)
+        file_paths.each(&method(:record_ast))
+
+        link_query = <<QUERY
+MATCH (tp:TracePoint), (node:ASTNode)
+WHERE
+  node.file_path = tp.path AND
+  node.first_line = tp.lineno AND
+  node.name = tp.method_id AND
+  node.type = 'def'
+MERGE (tp)-[:HAS_AST_NODE]->(node)
+QUERY
+        @neo4j_session.query(link_query)
+      end
+    end
+
+
+    def record_ast(file_path)
+      full_path = Pathname.new(file_path).realpath.to_s
+
+      code = File.read(full_path)
+
+      require 'parser/current'
+      root = Parser::CurrentRuby.parse(code)
+
+      file_node = @neo4apis_session.import :File, full_path, code
+      node_node = @neo4apis_session.import :ASTNode, root, file_node
+    end
+
+
+    def record_execution_trace
+      execution_index = 0
+      indent = 0
+      output = ''
+      last_tracepoint_node = nil
+      last_start_time = nil
+      ancestor_stack = []
+      run_time_stack = []
+
+      last_tracepoint_end_time = nil
+      last_run_time = nil
+
+      trace = TracePoint.new do |tp|
+        begin
+          last_run_time = 1_000_000.0 * (Time.now - last_tracepoint_end_time) if last_tracepoint_end_time
+
+          output << tracepoint_string(tp, indent)
+
+          last_method_time = nil
+          if [:call, :c_call].include?(tp.event)
+            run_time_stack.push(0)
+          elsif [:return, :c_return].include?(tp.event)
+            last_method_time = run_time_stack.pop
+          else
+            run_time_stack[-1] += last_run_time if run_time_stack[-1] && last_run_time
+          end
+
+          associated_call = nil
+          if [:return, :c_return].include?(tp.event) && indent.nonzero?
+            indent -= 1
+            associated_call = ancestor_stack.pop
+          elsif [:call, :c_call].include?(tp.event)
+            indent += 1
+          end
+
+          last_tracepoint_node = @neo4apis_session.import :TracePoint, tp,
+                              last_method_time,
+                              (execution_index += 1),
+                              last_tracepoint_node,
+                              ancestor_stack.last,
+                              associated_call
+          
+          if [:call, :c_call].include?(tp.event)
+            ancestor_stack.push(last_tracepoint_node)
+          end
+
+          last_tracepoint_end_time = Time.now
+        rescue Exception => e
+          puts 'EXCEPTION!!'
+          puts e.message
+          puts e.backtrace
+          exit!
+        end
+      end
+
+      trace.enable
+      yield
+    ensure
+      trace.disable
+      puts output
+    end
+
+    private
+
+    CYAN = "\e[36m"
+    CLEAR = "\e[0m"
+    GREEN = "\e[32m"
+
+    def tracepoint_string(tp, indent)
+      parts = []
+      parts << "#{'|  ' * indent}"
+      parts << "#{CYAN if tp.event == :call}%-8s#{CLEAR}"
+      parts << "%s:%-4d %-18s\n"
+      parts.join(' ') % [tp.event, tp.path, tp.lineno, tp.defined_class.to_s + '#' + GREEN + tp.method_id.to_s + CLEAR]
+    end
+  end
+end

data/lib/neolytics/version.rb

@@ -0,0 +1,3 @@
+module Neolytics
+  VERSION = "0.1.0"
+end

data/neolytics.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'neolytics/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "neolytics"
+  spec.version       = Neolytics::VERSION
+  spec.authors       = ["Brian Underwood"]
+  spec.email         = ["public@brian-underwood.codes"]
+
+  spec.summary       = %q{Dumps Ruby code analysis data to Neo4j}
+  spec.description   = %q{Dumps Ruby code analysis data to Neo4j}
+  spec.homepage      = "http://github.com/neo4jrb/neolytics"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'neo4apis', '~> 0.8.2'
+  spec.add_dependency 'neo4j-rake_tasks', '~> 0.3.0'
+  spec.add_dependency 'parser', '~> 2.2.3.0'
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: neolytics
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Brian Underwood
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-12-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: neo4apis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+- !ruby/object:Gem::Dependency
+  name: neo4j-rake_tasks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.3.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Dumps Ruby code analysis data to Neo4j
+email:
+- public@brian-underwood.codes
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/neo4apis/neolytics.rb
+- lib/neo4apis/neolytics/trace_point_helpers.rb
+- lib/neolytics.rb
+- lib/neolytics/recorder.rb
+- lib/neolytics/version.rb
+- neolytics.gemspec
+homepage: http://github.com/neo4jrb/neolytics
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Dumps Ruby code analysis data to Neo4j
+test_files: []
+has_rdoc: