visualize_inheritance 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7c3402ddcc1259e4f445f60a758c5dfb1810c62e
+  data.tar.gz: 450e4b7740765f5e71f128aa68446bf0587166f0
+SHA512:
+  metadata.gz: 3f15eb0f6f944f4c858283356e5d50ededb25cc5bea2898aa63f4731fa945e9745c86499d4de35a23dce8a166d1a820accc2ce0bb1db1674ff527eddb53fc3fe
+  data.tar.gz: ab43bab19cf1bb28ac6612db98eaf998ec1ce94974547330e6a8e2653fbaae8ed8169998727fa59a3ccc8e48af9f0848976c31962761c379fbb95dbfe55c0e5b

data/.gitignore

@@ -0,0 +1,2 @@
+force.csv
+.DS_Store

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Cyrus Vandrevala
+
+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,38 @@
+
+# VisualizeInheritance
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'visualize_inheritance'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install visualize_inheritance
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/visualize_inheritance/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+
+Visualizing Inheritance Structure in Ruby
+=========================================
+
+This code uses a simple Bash script combined with a force directed graph in D3 to visualize the inheritance structure of a Ruby project.
+
+Put this in the main folder of the project.  Upon running the bash script create_graph.sh, it will scan the lib folder for all classes, and then create a force directed graph in a browser window using D3.

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+
+task :clean do
+  sh "rm -f raw_files.txt trimmed_files.txt"
+  sh "rm -f raw_classes.txt spaced_classes.txt"
+  sh "rm -f reordered_classes.txt force.csv"
+end

data/lib/visualize_inheritance/create_graph.sh

@@ -0,0 +1,45 @@
+#!/bin/sh
+
+rm -f raw_files.txt trimmed_files.txt 
+rm -f raw_classes.txt spaced_classes.txt
+rm -f reordered_classes.txt force.csv
+
+grep --recursive '../' --include \*.rb --regexp 'class ' \
+	> raw_files.txt
+
+tr -d ' \t\r\f' < raw_files.txt > trimmed_files.txt
+
+grep --extended-regexp --only-matching "(class\S+)" \
+	< trimmed_files.txt | cut -c 6- > raw_classes.txt
+
+sed 's/</ < /g' raw_classes.txt >> spaced_classes.txt
+
+awk '{ for (i=NF; i>=1; i--) printf (i!=1) ? $i OFS : $i "\n" }' \
+	spaced_classes.txt >> reordered_classes.txt
+
+echo 'source,target' > force.csv
+exec < reordered_classes.txt
+while read LINE; do
+	if [[ $LINE == *\<* ]]; then
+		Y=0
+		for WORD in $LINE; do
+			if [ $Y == 0 ]
+				then
+				PARENT=$WORD
+			elif [ $Y == 2 ]
+				then
+				CHILD=$WORD
+			fi
+			Y=$((Y+1))
+		done
+		echo "$PARENT,$CHILD" >> force.csv
+		echo "Ruby,$PARENT" >> force.csv
+	else
+		echo "Ruby,$LINE" >> force.csv
+	fi
+done
+
+open index.html
+#rm -f raw_files.txt trimmed_files.txt 
+#rm -f raw_classes.txt spaced_classes.txt
+#rm -f reordered_classes.txt

data/lib/visualize_inheritance/create_nodes.rb

@@ -0,0 +1,45 @@
+#!/bin/ruby
+
+rm -f raw_files.txt trimmed_files.txt 
+rm -f raw_classes.txt spaced_classes.txt
+rm -f reordered_classes.txt force.csv
+
+grep --recursive '../' --include \*.rb --regexp 'class ' \
+	> raw_files.txt
+
+tr -d ' \t\r\f' < raw_files.txt > trimmed_files.txt
+
+grep --extended-regexp --only-matching "(class\S+)" \
+	< trimmed_files.txt | cut -c 6- > raw_classes.txt
+
+sed 's/</ < /g' raw_classes.txt >> spaced_classes.txt
+
+awk '{ for (i=NF; i>=1; i--) printf (i!=1) ? $i OFS : $i "\n" }' \
+	spaced_classes.txt >> reordered_classes.txt
+
+echo 'source,target' > force.csv
+exec < reordered_classes.txt
+while read LINE; do
+	if [[ $LINE == *\<* ]]; then
+		Y=0
+		for WORD in $LINE; do
+			if [ $Y == 0 ]
+				then
+				PARENT=$WORD
+			elif [ $Y == 2 ]
+				then
+				CHILD=$WORD
+			fi
+			Y=$((Y+1))
+		done
+		echo "$PARENT,$CHILD" >> force.csv
+		echo "Ruby,$PARENT" >> force.csv
+	else
+		echo "Ruby,$LINE" >> force.csv
+	fi
+done
+
+open index.html
+#rm -f raw_files.txt trimmed_files.txt 
+#rm -f raw_classes.txt spaced_classes.txt
+#rm -f reordered_classes.txt

data/lib/visualize_inheritance/index.html

@@ -0,0 +1,187 @@
+<!DOCTYPE html>
+<meta charset="utf-8">
+<script src="http://d3js.org/d3.v3.min.js" charset="utf-8"></script>
+<style>
+
+path.link {
+  fill: none;
+  stroke: #666;
+  stroke-width: 1.5px;
+}
+
+path.link.twofive {
+  opacity: 0.25;
+}
+
+path.link.fivezero {
+  opacity: 0.50;
+}
+
+path.link.sevenfive {
+  opacity: 0.75;
+}
+
+path.link.onezerozero {
+  opacity: 1.0;
+}
+
+circle {
+  fill: #ccc;
+  stroke: #fff;
+  stroke-width: 1.5px;
+}
+
+text {
+  fill: #000;
+  font: 10px sans-serif;
+  pointer-events: none;
+}
+
+</style>
+<body>
+<script>
+
+// get the data
+d3.csv("force.csv", function(error, links) {
+
+var nodes = {};
+
+// Compute the distinct nodes from the links.
+links.forEach(function(link) {
+    link.source = nodes[link.source] ||
+        (nodes[link.source] = {name: link.source});
+    link.target = nodes[link.target] ||
+        (nodes[link.target] = {name: link.target});
+    link.value = +link.value;
+});
+
+var width = 960,
+    height = 500;
+
+var force = d3.layout.force()
+    .nodes(d3.values(nodes))
+    .links(links)
+    .size([width, height])
+    .linkDistance(100) //This used to be 60
+    .charge(-1000) //This used to be -300
+    .on("tick", tick)
+    .start();
+
+// Set the range
+var  v = d3.scale.linear().range([0, 100]);
+
+// Scale the range of the data
+v.domain([0, d3.max(links, function(d) { return d.value; })]);
+
+// asign a type per value to encode opacity
+links.forEach(function(link) {
+	if (v(link.value) <= 25) {
+		link.type = "twofive";
+	} else if (v(link.value) <= 50 && v(link.value) > 25) {
+		link.type = "fivezero";
+	} else if (v(link.value) <= 75 && v(link.value) > 50) {
+		link.type = "sevenfive";
+	} else if (v(link.value) <= 100 && v(link.value) > 75) {
+		link.type = "onezerozero";
+	}
+});
+
+var svg = d3.select("body").append("svg")
+    .attr("width", width)
+    .attr("height", height);
+
+// build the arrow.
+svg.append("svg:defs").selectAll("marker")
+    .data(["end"])      // Different link/path types can be defined here
+  .enter().append("svg:marker")    // This section adds in the arrows
+    .attr("id", String)
+    .attr("viewBox", "0 -5 10 10")
+    .attr("refX", 15)
+    .attr("refY", -1.5)
+    .attr("markerWidth", 6)
+    .attr("markerHeight", 6)
+    .attr("orient", "auto")
+  .append("svg:path")
+    .attr("d", "M0,-5L10,0L0,5");
+
+// add the links and the arrows
+var path = svg.append("svg:g").selectAll("path")
+    .data(force.links())
+  .enter().append("svg:path")
+    .attr("class", function(d) { return "link " + d.type; })
+    .attr("marker-end", "url(#end)");
+
+// define the nodes
+var node = svg.selectAll(".node")
+    .data(force.nodes())
+  .enter().append("g")
+    .attr("class", "node")
+    .on("click", click)
+    .on("dblclick", dblclick)
+    .call(force.drag);
+
+// add the nodes
+node.append("circle")
+    .attr("r", 5);
+
+// add the text
+node.append("text")
+    .attr("x", 12)
+    .attr("dy", ".35em")
+    .text(function(d) { return d.name; });
+
+// add the curvy lines
+function tick() {
+    path.attr("d", function(d) {
+        var dx = d.target.x - d.source.x,
+            dy = d.target.y - d.source.y,
+            dr = Math.sqrt(dx * dx + dy * dy);
+        return "M" +
+            d.source.x + "," +
+            d.source.y + "A" +
+            dr + "," + dr + " 0 0,1 " +
+            d.target.x + "," +
+            d.target.y;
+    });
+
+    node
+        .attr("transform", function(d) {
+		    return "translate(" + d.x + "," + d.y + ")"; });
+}
+
+// action to take on mouse click
+function click() {
+    d3.select(this).select("text").transition()
+        .duration(750)
+        .attr("x", 22)
+        .style("fill", "steelblue")
+        .style("stroke", "lightsteelblue")
+        .style("stroke-width", ".5px")
+        .style("font", "20px sans-serif");
+    d3.select(this).select("circle").transition()
+        .duration(750)
+        .attr("r", 16)
+        .style("fill", "lightsteelblue");
+}
+
+// action to take on mouse double click
+function dblclick() {
+    d3.select(this).select("circle").transition()
+        .duration(750)
+        .attr("r", 6)
+        .style("fill", "#ccc");
+    d3.select(this).select("text").transition()
+        .duration(750)
+        .attr("x", 12)
+        .style("stroke", "none")
+        .style("fill", "black")
+        .style("stroke", "none")
+        .style("font", "10px sans-serif");
+}
+
+});
+
+</script>
+</body>
+</html>
+

data/lib/visualize_inheritance/version.rb

@@ -0,0 +1,3 @@
+module VisualizeInheritance
+  VERSION = "0.0.1"
+end

data/lib/visualize_inheritance.rb

@@ -0,0 +1,5 @@
+require "visualize_inheritance/version"
+
+module VisualizeInheritance
+  # Your code goes here...
+end

data/visualize_inheritance.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'visualize_inheritance/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "visualize_inheritance"
+  spec.version       = VisualizeInheritance::VERSION
+  spec.authors       = ["Cyrus Vandrevala"]
+  spec.email         = ["cyrus.vandrevala@gmail.com"]
+  spec.description   = %q{Create a directed graph of the relationships between classes in a Ruby program.}
+  spec.summary       = %q{Directed graph of relations.}
+  spec.homepage      = "http://rubygems.org/gems/visualize_inheritance"
+  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.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: visualize_inheritance
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Cyrus Vandrevala
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !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: Create a directed graph of the relationships between classes in a Ruby
+  program.
+email:
+- cyrus.vandrevala@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/visualize_inheritance.rb
+- lib/visualize_inheritance/create_graph.sh
+- lib/visualize_inheritance/create_nodes.rb
+- lib/visualize_inheritance/index.html
+- lib/visualize_inheritance/version.rb
+- visualize_inheritance.gemspec
+homepage: http://rubygems.org/gems/visualize_inheritance
+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.2
+signing_key: 
+specification_version: 4
+summary: Directed graph of relations.
+test_files: []