dirtree 0.3.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: dab1916c1ed6f532cea1b66c6ec5f6485342cfb8
-  data.tar.gz: da89e771d354d425ac016a407997b73d4caef95b
+SHA256:
+  metadata.gz: 155b20b468f5b18c1c7e217399622d88f9a518c71de7d4ac9a037c43b40bf5af
+  data.tar.gz: 803c02eca516c98bde2e2b0d87dd6234051760e837f3a505275cca7b0e1ebf2f
 SHA512:
-  metadata.gz: 27971ec983be71a799a7e304d660f9834be1f7c4c0dc0ad831a31414cf272c9f8437dae1358547a31cf3b0e46f8b0771c72105935642084773faf6c2d2c07f4c
-  data.tar.gz: 5ce9c49b082bc5aa8b3909e1183cd36a0808504558cf8881cd67ab0d30d8e3298f5bf8f440e506387a0fdfd1330e5b4ee6026412c52fa20f968f0a9ff67c98f3
+  metadata.gz: 0ae0616386b2d83dc7522b50bda09f334cc40a916a82745c55988af95b4f7b562f32eb2d970f64a1bd9cbe62bcd0fc03d85cfb17c1a9e121823afb7eae9ffdb8
+  data.tar.gz: 2e2890a550907ff651aaf62d3ed4c81564b31637284e4c34c343444ad2b3ce55487ea25dbe6460283055ca0fa3fd9400c3d16d37034b78d1732b3a4aa00f8fe8

data/README.md

@@ -7,23 +7,33 @@ Dirtree visualizes an list of file paths into a tree graph, printed as HTML page
 ## Tree template
 ![http://i.imgur.com/cGhx0lG.png](http://i.imgur.com/cGhx0lG.png)
 
+## Flame Graph template
+![https://i.imgur.com/eSTlQNE.png](https://i.imgur.com/eSTlQNE.png)
+
 ## Circles template
 ![http://i.imgur.com/WvfOgCp.png](http://i.imgur.com/WvfOgCp.png)
 
-## Installation
+## Treemap template
+![https://i.imgur.com/quO67Ky.png](https://i.imgur.com/quO67Ky.png)
 
+## Installation
 
     $ gem install dirtree
 
 ## Usage
 
     Usage: dirtree [options]... [file]...
+    
+    To get autocompletion functionality
+    run: dirtree completion >> ~/.bashrc
+    Or, dirtree completion > /usr/local/etc/bash_completion.d/dirtree
+        
         -v, --version                    Print version
         -h, --help                       Show this help text
         -l, --local-dependencies         Use saved JavaScript libraries instead of downloading them
-        -o, --output=File.html           Specify a path to write output, if not specified output will be printed to STDOUT
-        -t, --template=TemplateName      Specify the template name, available templates ["circles", "tree"]
-
+        -s, --screenshot                 Get an image screenshot of the directory tree
+        -o, --output=File.html           Specify a path to write HTML output
+        -t, --template=TemplateName      Specify the template name, available templates ["tree", "circles", "flame", "treemap"]
 
 ## Examples
 
@@ -33,7 +43,7 @@ Dirtree visualizes an list of file paths into a tree graph, printed as HTML page
 $ dirtree -o output.html **/* *
 ```
 
-  make sure you have `globstar` on
+make sure you have `globstar` on
 ```
 $ shopt -s globstar
 ```
@@ -72,11 +82,11 @@ $ ag -l | dirtree -o output.html
 
 ## Conjunctions
 
-* [lsgh](https://www.github.com/blazeeboy/lsgh) Draw a tree for a github user/org and open pull requests.
+* [lsgh](https://www.github.com/emad-elsaid/lsgh) Draw a tree for a github user/org and open pull requests.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/blazeeboy/dirtree.
+Bug reports and pull requests are welcome on GitHub at https://github.com/emad-elsaid/dirtree.
 
 ## License
 

data/dirtree.gemspec

@@ -1,5 +1,3 @@
-# coding: utf-8
-
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'dirtree/version'
@@ -8,7 +6,7 @@ Gem::Specification.new do |spec|
   spec.name          = 'dirtree'
   spec.version       = Dirtree::VERSION
   spec.authors       = ['Emad Elsaid']
-  spec.email         = ['blazeeboy@gmail.com']
+  spec.email         = ['emad.elsaid.hamed@gmail.com']
 
   spec.summary       = 'display list of file paths as an interactive tree'
   spec.description   = 'display list of file paths as an interactive tree'
@@ -23,6 +21,12 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.15'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+
+  spec.post_install_message = <<-GUIDE
+    To get autocompletion functionality
+    run: dirtree completion >> ~/.bashrc
+    Or, dirtree completion > /usr/local/etc/bash_completion.d/dirtree
+    GUIDE
 end

data/exe/dirtree

@@ -4,6 +4,13 @@ require 'optparse'
 require 'json'
 require 'erb'
 require 'open-uri'
+require 'tempfile'
+
+if ARGV.first == 'completion'
+  bash_file = File.join(File.dirname(__FILE__), 'dirtree-completion.bash')
+  puts File.read(bash_file)
+  exit 0
+end
 
 templates_dir = File.join(File.dirname(__FILE__), '..', 'templates')
 templates = Dir.open(templates_dir).map do |file|
@@ -15,7 +22,14 @@ options = {
 }
 
 OptionParser.new do |opts|
-  opts.banner = 'Usage: dirtree [options]... [file]...'
+  opts.banner = <<-BANNER
+  Usage: dirtree [options]... [file]...
+
+  To get autocompletion functionality
+  run: dirtree completion >> ~/.bashrc
+  Or, dirtree completion > /usr/local/etc/bash_completion.d/dirtree
+
+  BANNER
 
   opts.on(
     '-v',
@@ -43,12 +57,20 @@ OptionParser.new do |opts|
     options[:local_dependencies] = true
   end
 
+  opts.on(
+    '-s',
+    '--screenshot',
+    'Get an image screenshot of the directory tree'
+  ) do
+    options[:screenshot] = true
+  end
+
   opts.on(
     '-oFile.html',
     '--output=File.html',
-    'Specify a path to write output, if
-       not specified output will be printed to STDOUT'
+    'Specify a path to write HTML output'
   ) do |value|
+    raise 'missing filename after ‘-o’' if value.empty?
     options[:output] = value
   end
 
@@ -82,8 +104,25 @@ if options[:local_dependencies]
   end
 end
 
-if options.key?(:output)
-  File.write(options[:output], result)
-else
-  puts result
+File.write(options[:output], result) if options.key?(:output)
+
+if options.key?(:screenshot)
+  unless options.key?(:output)
+    tmp = Tempfile.new
+    tmp.write(result)
+    tmp.close
+  end
+  file = options[:output] || tmp.path
+  %w[chromium chrome google-chrome google-chrome-stable].each do |chrome|
+    system(
+      chrome,
+      '--disable-gpu',
+      '--headless',
+      '--screenshot',
+      '--window-size=1500,1500',
+      'file://' + file
+    ) && break
+  end
 end
+
+puts result unless options.key?(:output) || options.key?(:screenshot)

data/exe/dirtree-completion.bash

@@ -0,0 +1,31 @@
+# To get autocompletion functionality
+# run: dirtree completion >> ~/.bashrc
+# Or, dirtree completion > /usr/local/etc/bash_completion.d/dirtree
+#!/usr/bin/env bash
+
+_dirtree_completions()
+{
+    local cur prev
+
+    cur=${COMP_WORDS[COMP_CWORD]}
+    prev="${COMP_WORDS[COMP_CWORD-1]}"
+    COMPREPLY=() 
+    if [ "${#COMP_WORDS[@]}" != "2" ]; then
+        return
+    fi
+    case "$cur" in
+        -*)
+        COMPREPLY=( $( compgen -W '-v -h -l -s -o -t \
+                               --version --help --local \
+                               --screenshot --output --template' -- $cur ) )                           
+        ;;
+    esac
+
+    if [[ ${prev} == -t ]] || [[ ${prev} == --template ]]; then
+        COMPREPLY=( $( compgen -W 'circles flame tree treemap' -- $cur ) )
+    fi
+
+    return 0
+}
+
+complete -F _dirtree_completions dirtree

data/lib/dirtree/version.rb

@@ -1,3 +1,3 @@
 module Dirtree
-  VERSION = '0.3.0'.freeze
+  VERSION = '1.0.0'.freeze
 end

data/templates/flame.html.erb

@@ -0,0 +1,61 @@
+<!DOCTYPE html>
+<html>
+  <head>
+
+    <meta charset="utf-8">
+    <link rel="stylesheet" type="text/css" href="https://cdn.jsdelivr.net/gh/spiermar/d3-flame-graph@1.0.4/dist/d3.flameGraph.min.css">
+    <style>
+     html, body{
+         height: 100%;
+         margin: 0;
+         padding: 0;
+         font-size: 14px;
+     }
+    </style>
+    <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/d3/4.10.0/d3.min.js"></script>
+    <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/d3-tip/0.7.1/d3-tip.min.js"></script>
+    <script type="text/javascript" src="https://cdn.jsdelivr.net/gh/spiermar/d3-flame-graph@1.0.4/dist/d3.flameGraph.min.js"></script>
+
+  </head>
+  <body>
+
+    <div class="container">
+      <div id="chart">
+      </div>
+    </div>
+    <script>
+     // Uses D3js flamegraph: https://github.com/spiermar/d3-flame-graph
+     var flameGraph = d3.flameGraph()
+                        .width(window.innerWidth)
+                        .cellHeight(18)
+                        .transitionDuration(750)
+                        .transitionEase(d3.easeCubic)
+                        .sort(true)
+                        .title("");
+
+     var tip = d3.tip()
+                 .direction("s")
+                 .offset([8, 0])
+                 .attr('class', 'd3-flame-graph-tip')
+                 .html(function(d) { return "name: " + d.data.name + ", value: " + d.data.value; });
+
+     flameGraph.tooltip(tip);
+
+     function setValue(d) {
+         var val = 0;
+         for( var i=0; i<d.children.length; i++){
+             setValue(d.children[i]);
+             val += d.children[i].value;
+         }
+         d.value = val == 0 ? 1 : val;
+     }
+
+     root = <%= tree.to_json %>;
+     setValue(root)
+     d3.select("#chart")
+       .datum(root)
+       .call(flameGraph);
+    </script>
+
+  </body>
+</html>

data/templates/treemap.html.erb

@@ -0,0 +1,127 @@
+<!DOCTYPE html>
+<head>
+  <head>
+    <meta charset="utf-8">
+    <style>
+     html, body {
+         padding: 0;
+         margin: 0;
+         width: 100%;
+         height: 100%;
+         overflow: hidden;
+     }
+
+     text {
+         font: 12px sans-serif;
+     }
+
+     tspan:last-child {
+         font-size: 12px;
+         fill-opacity: 0.8;
+     }
+
+     .node rect {
+         shape-rendering: crispEdges;
+     }
+
+     .node--hover rect {
+         stroke: #000;
+     }
+
+    </style>
+    <svg width="100%" height="100%"></svg>
+    <script src="http://d3js.org/d3.v4.0.0-alpha.35.min.js"></script>
+    <script>
+
+     var svg = d3.select("svg"),
+         width = window.innerWidth,
+         height = window.innerHeight;
+
+     svg.attr("width", width + "px");
+     svg.attr("height", height + "px");
+
+     var format = d3.format(",d");
+
+     var color = d3.scaleMagma()
+                   .domain([-4, 4]);
+
+     var treemap = d3.treemap()
+                     .size([width, height])
+                     .paddingOuter(3)
+                     .paddingTop(19)
+                     .paddingInner(1)
+                     .round(true);
+
+
+     var data = <%= tree.to_json %>
+     var root = d3.hierarchy(data)
+                  .sum(function(d) {
+                      var value = 1;
+                      d.children.forEach(function(i){ value += i.value; })
+                      return value;
+                  })
+                  .sort(function(a, b) { return b.height - a.height || b.value - a.value; })
+
+     var counter = 0;
+     root.each(function(d){ d.id = counter++; })
+     treemap(root)
+
+     var cell = svg
+         .selectAll(".node")
+         .data(root.descendants())
+         .enter().append("g")
+         .attr("transform", function(d) { return "translate(" + d.x0 + "," + d.y0 + ")"; })
+         .attr("class", "node")
+         .each(function(d) { d.node = this; })
+         .on("mouseover", hovered(true))
+         .on("mouseout", hovered(false));
+
+     cell.append("rect")
+         .attr("id", function(d) { return "rect-" + d.id; })
+         .attr("width", function(d) { return d.x1 - d.x0; })
+         .attr("height", function(d) { return d.y1 - d.y0; })
+         .style("fill", function(d) { return color(d.depth); });
+
+     cell.append("clipPath")
+         .attr("id", function(d) { return "clip-" + d.id; })
+         .append("use")
+         .attr("xlink:href", function(d) { return "#rect-" + d.id + ""; });
+
+     var label = cell.append("text")
+                     .attr("clip-path", function(d) { return "url(#clip-" + d.id + ")"; });
+
+     label
+         .filter(function(d) { return d.children; })
+         .selectAll("tspan")
+         .data(function(d) { return [d.data.name]; })
+         .enter().append("tspan")
+         .attr("x", function(d, i) { return i ? null : 4; })
+         .attr("y", 13)
+         .text(function(d) { return d; });
+
+     label
+         .filter(function(d) { return !d.children; })
+         .selectAll("tspan")
+         .data(function(d) { return [d.data.name]; })
+         .enter().append("tspan")
+         .attr("x", 4)
+         .attr("y", function(d, i) { return 13 + i * 10; })
+         .text(function(d) { return d; });
+
+     cell.append("title")
+         .text(function(d) { return d.data.name; });
+
+     function hovered(hover) {
+         return function(d) {
+             d3.selectAll(d.ancestors().map(function(d) { return d.node; }))
+               .classed("node--hover", hover)
+               .select("rect")
+               .attr("width", function(d) { return d.x1 - d.x0 - hover; })
+               .attr("height", function(d) { return d.y1 - d.y0 - hover; });
+         };
+     }
+
+    </script>
+  </head>
+  <body></body>
+</head>

metadata

@@ -1,48 +1,49 @@
 --- !ruby/object:Gem::Specification
 name: dirtree
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Emad Elsaid
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2017-07-28 00:00:00.000000000 Z
+date: 2020-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 description: display list of file paths as an interactive tree
 email:
-- blazeeboy@gmail.com
+- emad.elsaid.hamed@gmail.com
 executables:
 - dirtree
+- dirtree-completion.bash
 extensions: []
 extra_rdoc_files: []
 files:
@@ -53,16 +54,22 @@ files:
 - Rakefile
 - dirtree.gemspec
 - exe/dirtree
+- exe/dirtree-completion.bash
 - lib/dirtree.rb
 - lib/dirtree/node.rb
 - lib/dirtree/version.rb
 - templates/circles.html.erb
+- templates/flame.html.erb
 - templates/tree.html.erb
+- templates/treemap.html.erb
 homepage: https://www.github.com/blazeeboy/dirtree
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message: |2
+      To get autocompletion functionality
+      run: dirtree completion >> ~/.bashrc
+      Or, dirtree completion > /usr/local/etc/bash_completion.d/dirtree
 rdoc_options: []
 require_paths:
 - lib
@@ -77,9 +84,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.12
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: display list of file paths as an interactive tree
 test_files: []