dirtree 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e2547ddc3ecb80bf7083207cbca639f543c304b6
-  data.tar.gz: 12d42cd27343ad8eebaa262ca9b82181a6bb71fd
+  metadata.gz: cb64f8d686c8126e4dab42c711d7f3b17eb050d3
+  data.tar.gz: ff74a6c7a5e016e8e5852421916fb62190c7c24f
 SHA512:
-  metadata.gz: 494cc0241accc14941175013b3c7a493d71b79a88a3b1ce87a5fd634477d97cc926bd8c079d74ae0cb9bcc6dadedbe22568fabae9e8c1752df25feff3dc833a5
-  data.tar.gz: 229f45fdfaf9860d6554393501f9c4c6a318bee3f1bcc2f593c4b43d322fa532edaf21e7abccd63b2a3a5b60402f1882bf2df6cb4ebc2f39df63f34793af71a6
+  metadata.gz: 67ed70759e896f00a666d5568b0e7d793081f6e85fecb7bf61e6eff1e33ce9a0f0f984f1aaacacda46147caa457c6be2a80939630a73af18db6662908020878d
+  data.tar.gz: a41b0d579446826b277b709c4f538c4486db68f33cdb59b54510e2ca523543bdeb0132903104e46b968284991121d5a579ffbb5a3e036c9b747ef207bdc49c7d

data/Gemfile

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

data/README.md

@@ -1,7 +1,15 @@
 # Dirtree
 
+[![Gem Version](https://badge.fury.io/rb/dirtree.svg)](https://badge.fury.io/rb/dirtree)
+
 Dirtree visualizes an list of file paths into a tree graph, printed as HTML page, it can be useful in visualizing a whole project you're working on to start cleanup or organizing your code or spotting large directories or unneeded files.
 
+## Tree template
+![http://i.imgur.com/cGhx0lG.png](http://i.imgur.com/cGhx0lG.png)
+
+## Circles template
+![http://i.imgur.com/WvfOgCp.png](http://i.imgur.com/WvfOgCp.png)
+
 ## Installation
 
 
@@ -15,28 +23,54 @@ Dirtree visualizes an list of file paths into a tree graph, printed as HTML page
         -o, --output=File.html           Specify a path to write output, if not specified output will be printed to STDOUT
 
 
-### Visualize current directory recursively
+## Examples
+
+**Visualize current directory recursively**
+
+```
+$ dirtree -o output.html **/* *
+```
+
+  make sure you have `globstar` on
+```
+$ shopt -s globstar
+```
+
+**Visualize files from git ls**
+
+```
+$ git ls-files | dirtree -o output.html
+```
 
-    $ dirtree -o output.html **/* *
+**Dirtree prints to standard output if no --output option specified so you can redirect it**
 
-### Visualize files from git ls
+```
+$ git ls-files | dirtree > output.html
+```
 
-    $ git ls-files | dirtree -o output.html
+**visualize only files that include specific word**
 
-### Dirtree prints to standard output if no --output option specified so you can redirect it
+```
+$ git ls-files | grep keyword | dirtree > output.html
+```
 
-    $ git ls-files | dirtree > output.html
+**works with find**
 
-### visualize only files that include specific word
+visualize all files that ends with `rb`
 
-    $ git ls-files | grep keyword | dirtree > output.html
+```
+$ find ~ -name *rb | dirtree > output.html
+```
 
-### works with find
+**With ag:silver searcher**
 
-visulaize all files that ends with `rb`
+```
+$ ag -l | dirtree -o output.html
+```
 
-    $ find ~ -name *rb | dirtree > output.html
+## Conjunctions
 
+* [lsgh](https://www.github.com/blazeeboy/lsgh) Draw a tree for a github user/org and open pull requests.
 
 ## Contributing
 

data/dirtree.gemspec

@@ -1,4 +1,5 @@
 # coding: utf-8
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'dirtree/version'

data/exe/dirtree

@@ -4,23 +4,51 @@ require 'optparse'
 require 'json'
 require 'erb'
 
-options = {}
+templates_dir = File.join(File.dirname(__FILE__), '..', 'templates')
+templates = Dir.open(templates_dir).map do |file|
+  file[0...file.index('.')]
+end.reject(&:empty?)
+
+options = {
+  template: 'tree'
+}
+
 OptionParser.new do |opts|
   opts.banner = 'Usage: dirtree [options]... [file]...'
 
-  opts.on('-v', '--version', 'Print version') do
+  opts.on(
+    '-v',
+    '--version',
+    'Print version'
+  ) do
     puts "Dirtree version #{Dirtree::VERSION}"
     exit
   end
 
-  opts.on('-h', '--help', 'Show this help text') do
+  opts.on(
+    '-h',
+    '--help',
+    'Show this help text'
+  ) do
     puts opts
     exit
   end
 
-  opts.on('-oFile.html', '--output=File.html', 'Specify a path to write output, if not specified output will be printed to STDOUT') do |value|
+  opts.on(
+    '-oFile.html',
+    '--output=File.html',
+    'Specify a path to write output, by default will be printed to STDOUT'
+  ) do |value|
     options[:output] = value
   end
+
+  opts.on(
+    '-tTemplateName',
+    '--template=TemplateName',
+    'Specify the template name, available templates ' + templates.to_s
+  ) do |value|
+    options[:template] = value
+  end
 end.parse!
 
 files = ARGV.empty? ? STDIN.read.lines : ARGV
@@ -28,8 +56,7 @@ files.map!(&:strip)
 
 root = Dirtree::Node.new('/')
 files.each { |file| root.insert(file.split('/')) }
-templates_dir = File.join(File.dirname(__FILE__), '..', 'templates')
-template_file = File.join(templates_dir, 'tree.html.erb')
+template_file = File.join(templates_dir, options[:template] + '.html.erb')
 template = File.read(File.expand_path(template_file))
 
 tree = root.as_json

data/lib/dirtree/version.rb

@@ -1,3 +1,3 @@
 module Dirtree
-  VERSION = "0.1.0"
+  VERSION = '0.2.0'.freeze
 end

data/templates/circles.html.erb

@@ -0,0 +1,111 @@
+<!DOCTYPE html>
+<meta charset="utf-8">
+<style>
+
+ html, body{
+   height: 100%;
+   margin: 0;
+   padding: 0;
+ }
+
+ .node {
+   cursor: pointer;
+ }
+
+ .node:hover {
+   stroke: #000;
+   stroke-width: 1.5px;
+ }
+
+ .node--leaf {
+   fill: white;
+ }
+
+ .label {
+   font: 11px "Helvetica Neue", Helvetica, Arial, sans-serif;
+   text-anchor: middle;
+   text-shadow: 0 1px 0 #fff, 1px 0 0 #fff, -1px 0 0 #fff, 0 -1px 0 #fff;
+ }
+
+ .label,
+ .node--root,
+ .node--leaf {
+   pointer-events: none;
+ }
+
+</style>
+<svg width="100%" height="100%"></svg>
+<script src="https://d3js.org/d3.v4.min.js"></script>
+<script>
+ // Copied from https://bl.ocks.org/mbostock/7607535
+ var width = window.innerWidth,
+     height = window.innerHeight;
+ var svg = d3.select("svg"),
+     margin = 20,
+     diameter = Math.min(width, height),
+     g = svg.append("g").attr("transform", "translate(" + diameter / 2 + "," + diameter / 2 + ")");
+
+ var color = d3.scaleLinear()
+               .domain([-1, 5])
+               .range(["hsl(152,80%,80%)", "hsl(228,30%,40%)"])
+               .interpolate(d3.interpolateHcl);
+
+ var pack = d3.pack()
+              .size([diameter - margin, diameter - margin])
+              .padding(2);
+
+ root = <%= tree.to_json %>;
+ root = d3.hierarchy(root)
+          .sum(function(d) { return d.children.length + 1; })
+          .sort(function(a, b) { return b.value - a.value; });
+
+ var focus = root,
+     nodes = pack(root).descendants(),
+     view;
+
+ var circle = g.selectAll("circle")
+               .data(nodes)
+               .enter().append("circle")
+               .attr("class", function(d) { return d.parent ? d.children ? "node" : "node node--leaf" : "node node--root"; })
+               .style("fill", function(d) { return d.children ? color(d.depth) : null; })
+               .on("click", function(d) { if (focus !== d) zoom(d), d3.event.stopPropagation(); });
+
+ var text = g.selectAll("text")
+             .data(nodes)
+             .enter().append("text")
+             .attr("class", "label")
+             .style("fill-opacity", function(d) { return d.parent === root ? 1 : 0; })
+             .style("display", function(d) { return d.parent === root ? "inline" : "none"; })
+             .text(function(d) { return d.data.name; });
+
+ var node = g.selectAll("circle,text");
+
+ svg
+   .style("background", color(-1))
+   .on("click", function() { zoom(root); });
+
+ zoomTo([root.x, root.y, root.r * 2 + margin]);
+
+ function zoom(d) {
+   var focus0 = focus; focus = d;
+
+   var transition = d3.transition()
+                      .duration(d3.event.altKey ? 7500 : 750)
+                      .tween("zoom", function(d) {
+                        var i = d3.interpolateZoom(view, [focus.x, focus.y, focus.r * 2 + margin]);
+                        return function(t) { zoomTo(i(t)); };
+                      });
+
+   transition.selectAll("text")
+             .filter(function(d) { return d.parent === focus || this.style.display === "inline"; })
+             .style("fill-opacity", function(d) { return d.parent === focus ? 1 : 0; })
+             .on("start", function(d) { if (d.parent === focus) this.style.display = "inline"; })
+             .on("end", function(d) { if (d.parent !== focus) this.style.display = "none"; });
+ }
+
+ function zoomTo(v) {
+   var k = diameter / v[2]; view = v;
+   node.attr("transform", function(d) { return "translate(" + (d.x - v[0]) * k + "," + (d.y - v[1]) * k + ")"; });
+   circle.attr("r", function(d) { return d.r * k; });
+ }
+</script>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dirtree
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Emad Elsaid
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-25 00:00:00.000000000 Z
+date: 2017-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -56,6 +56,7 @@ files:
 - lib/dirtree.rb
 - lib/dirtree/node.rb
 - lib/dirtree/version.rb
+- templates/circles.html.erb
 - templates/tree.html.erb
 homepage: https://www.github.com/blazeeboy/dirtree
 licenses:
@@ -77,7 +78,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
 summary: display list of file paths as an interactive tree