seven_bridges 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a26e6a0424fb15dd2c5f9a9e3720bd199aa021e2
+  data.tar.gz: 56d8ee4257e9ae93b1adaedaaaf7a9caa2462342
+SHA512:
+  metadata.gz: 38f109a30b43d6511b9025d013d49b3fbe27182a24316821ed5c0c3b4d3e0dbc97df87d9fbf8ebefcf689a40d3d4bb68ff0b44c6afa2fd0c119799b1ef15737e
+  data.tar.gz: 28e81e73eff1c6c8b43fa4e1576c1c15246ad5cd3a0a05facb080d6e27c5a63dc012211ffdf93e2e4803651ad10d27ea57853374894e122650e0f5e5b9165f4c

data/.gitignore

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

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.2.3

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in seven_bridges.gemspec
+gemspec
+
+group :test do
+  gem "activesupport"
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Scott Speidel
+
+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 @@
+# SevenBridges
+
+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/seven_bridges`. 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 'seven_bridges'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install seven_bridges
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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]/seven_bridges.
+
+
+## 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,11 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.warning = false
+  t.test_files = FileList['test/seven_bridges/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "seven_bridges"
+
+# 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,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/seven_bridges.rb

@@ -0,0 +1,101 @@
+require 'neo4j'
+require 'seven_bridges/method'
+require 'seven_bridges/call'
+require 'seven_bridges/called_by'
+require 'seven_bridges/test_method'
+require 'seven_bridges/neo4j_store'
+require 'seven_bridges/memory_store'
+require 'seven_bridges/memory_store_csv_dumper'
+
+module SevenBridges
+  class << self
+    attr_writer :klass, :project_root, :store
+
+    def klass
+      @klass ||= Minitest::Test
+    end
+
+    def project_root
+      @project_root ||= ''
+    end
+
+    def store
+      @store ||= SevenBridges::Neo4jStore.new
+    end
+
+    def configure
+      yield self
+
+      klass.class_eval do
+        alias_method :setup_without_trace, :setup
+        alias_method :teardown_without_trace, :teardown
+
+        def setup
+          setup_without_trace
+          @callstack = []
+          @trace = TracePoint.new(:call) do |tp|
+            if tp.path.start_with? SevenBridges.project_root
+              path = make_path(tp)
+              if !path.end_with?('#teardown')
+                find_location_and_build_graph path
+              end
+            end
+          end
+          @trace.enable
+        end
+
+        private
+
+        def make_path(tp)
+          "#{strip_project_root(tp.path)}##{tp.method_id}"
+        end
+
+        def get_or_create_current_node(path)
+          current = SevenBridges.store.find_method(path)
+          return current if current.present?
+
+          return SevenBridges.store.create_test_method_node(get_method_name(path), path) if @callstack.empty?
+          return SevenBridges.store.create_method_node(get_method_name(path), path)
+        end
+
+        def find_location_and_build_graph(path)
+          find_parent
+          current = get_or_create_current_node(path)
+          add_calling_relationship current
+          create_stack_frame current
+        end
+
+        def create_stack_frame(current)
+          @callstack << { node: current, level: caller.size }
+        end
+
+        def add_calling_relationship(current)
+          return if @callstack.empty?
+
+          SevenBridges.store.add_relationship(:calls, @callstack.last[:node], current)
+          SevenBridges.store.add_relationship(:called_by, current, @callstack.first[:node])
+        end
+
+        def find_parent
+          while(!@callstack.empty? && caller.size <= @callstack.last[:level]) do
+            @callstack.pop
+          end
+        end
+
+        def teardown
+          @trace.disable
+          @callstack = []
+          teardown_without_trace
+        end
+
+        def get_method_name(path)
+          path.split('#')[1]
+        end
+
+        def strip_project_root(path)
+          path[SevenBridges.project_root.length..-1]
+        end
+      end
+    end
+  end
+end

data/lib/seven_bridges/call.rb

@@ -0,0 +1,13 @@
+require 'neo4j'
+
+module SevenBridges
+  class Call
+    include Neo4j::ActiveRel
+    from_class 'SevenBridges::Method'
+    to_class   'SevenBridges::Method'
+
+    creates_unique
+
+    type 'calls'
+  end
+end

data/lib/seven_bridges/called_by.rb

@@ -0,0 +1,13 @@
+require 'neo4j'
+
+module SevenBridges
+  class CalledBy
+    include Neo4j::ActiveRel
+    from_class 'SevenBridges::Method'
+    to_class   'SevenBridges::Method'
+
+    creates_unique
+
+    type 'called_by'
+  end
+end

data/lib/seven_bridges/memory_store.rb

@@ -0,0 +1,32 @@
+module SevenBridges
+  class MemoryStore
+    def initialize
+      @nodes = {}
+      @edges = {}
+    end
+
+    def edges
+      @edges.keys
+    end
+
+    def nodes
+      @nodes.values
+    end
+
+    def find_method(path)
+      @nodes[path]
+    end
+
+    def create_test_method_node(method_name, path)
+      @nodes[path] ||= {name: method_name, path: path, type: 'test'}
+    end
+
+    def create_method_node(method_name, path)
+      @nodes[path] ||= {name: method_name, path: path, type: 'app'}
+    end
+
+    def add_relationship(label, from, to)
+      @edges[{label: label, from: from[:path], to: to[:path]}] = 1
+    end
+  end
+end

data/lib/seven_bridges/memory_store_csv_dumper.rb

@@ -0,0 +1,54 @@
+require 'csv'
+require 'fileutils'
+
+module SevenBridges
+  class MemoryStoreCSVDumper
+
+    def initialize(memory_store, base_path)
+      @store = memory_store
+      @base_path = base_path
+    end
+
+    def dump
+      FileUtils.mkdir_p(@base_path)
+
+      CSV.open(nodes_header_file, "wb") do |csv|
+        csv << ["path:ID", "name", ":LABEL"]
+      end
+
+      CSV.open(nodes_file, "wb") do |csv|
+        @store.nodes.each do |node|
+          csv << [node[:path], node[:name], ((node[:type] == 'app') ? "METHOD" : "TEST_METHOD")]
+        end
+      end
+
+      CSV.open(edges_header_file, "wb") do |csv|
+        csv << [":START_ID", ":END_ID", ":TYPE"]
+      end
+
+      CSV.open(edges_file, "wb") do |csv|
+        @store.edges.each do |edge|
+          csv << [edge[:from], edge[:to], edge[:label]]
+        end
+      end
+    end
+
+    private
+
+    def nodes_header_file
+      File.join(@base_path, "nodes_header.csv")
+    end
+
+    def nodes_file
+      File.join(@base_path, "nodes.csv")
+    end
+
+    def edges_header_file
+      File.join(@base_path, "relationships_header.csv")
+    end
+
+    def edges_file
+      File.join(@base_path, "relationships.csv")
+    end
+  end
+end

data/lib/seven_bridges/method.rb

@@ -0,0 +1,18 @@
+require 'neo4j'
+
+module SevenBridges
+  class Method
+    include Neo4j::ActiveNode
+    #self.mapped_label_name = 'Method'
+    property :name
+    property :path, index: :exact
+    property :type
+    # property :num_incoming_refs, type: Integer, default: 0
+
+    validates :path, presence: true
+    validates :type, presence: true
+    #validates :num_incoming_refs, numericality: { only_integer: true }
+    has_many :out, :calls , rel_class: 'SevenBridges::Call', model_class: 'SevenBridges::Method'
+    has_many :out, :called_by, rel_class: 'SevenBridges::CalledBy', model_class: 'SevenBridges::TestMethod'
+  end
+end

data/lib/seven_bridges/neo4j_store.rb

@@ -0,0 +1,20 @@
+module SevenBridges
+  class Neo4jStore
+
+    def find_method(path)
+       Method.find_by(path: path)
+    end
+
+    def create_test_method_node(method_name, path)
+      TestMethod.create(name: method_name, path: path, type: 'test')
+    end
+
+    def create_method_node(method_name, path)
+      Method.create(name: method_name, path: path, type: 'app')
+    end
+
+    def add_relationship(label, from, to)
+      from.public_send(label) << to
+    end
+  end
+end

data/lib/seven_bridges/test_method.rb

@@ -0,0 +1,5 @@
+require 'neo4j'
+module SevenBridges
+  class TestMethod < SevenBridges::Method
+  end
+end

data/lib/seven_bridges/version.rb

@@ -0,0 +1,3 @@
+module SevenBridges
+  VERSION = "0.1.1"
+end

data/seven_bridges.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'seven_bridges/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'seven_bridges'
+  spec.version       = SevenBridges::VERSION
+  spec.authors       = ['Scott Speidel', 'Michael Jewell', 'Stanley Fung']
+  spec.email         = ['scottspeidel@gmail.com', 'michaeljewell9911@gmail.com']
+
+  spec.summary       = 'Tool to help understand the relationships between ruby methods'
+  spec.description   = ''
+  spec.homepage      = 'https://github.com/appfolio/seven_bridges'
+  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_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_dependency 'neo4j'
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: seven_bridges
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Scott Speidel
+- Michael Jewell
+- Stanley Fung
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: neo4j
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email:
+- scottspeidel@gmail.com
+- michaeljewell9911@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/seven_bridges.rb
+- lib/seven_bridges/call.rb
+- lib/seven_bridges/called_by.rb
+- lib/seven_bridges/memory_store.rb
+- lib/seven_bridges/memory_store_csv_dumper.rb
+- lib/seven_bridges/method.rb
+- lib/seven_bridges/neo4j_store.rb
+- lib/seven_bridges/test_method.rb
+- lib/seven_bridges/version.rb
+- seven_bridges.gemspec
+homepage: https://github.com/appfolio/seven_bridges
+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: Tool to help understand the relationships between ruby methods
+test_files: []
+has_rdoc: