cli-tree 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e0f13728de1349b02be11f2ae0bbcb2bc3b306a3fabe278899b21fa7bc9df4c
-  data.tar.gz: e36b25b7f939f1bdbf2bd6cdc30ce9c0a0500785cd2b955999c19d9a2aca6346
+  metadata.gz: da90838e296f082ffc1c64eed162ea67d1b326e535467ae99f490cb07e03f84a
+  data.tar.gz: 8254103ce9f3f2f028da206874aa287aa4868847eb4669aaf1a425c84b068399
 SHA512:
-  metadata.gz: 0ba42cb576127242e0a08e46d66364121715e14a699a0e9c3a427eaaae232be4ef58a345032db858772fd4c0ac059b51a6c6bea746ab608df3e00631b0b74de2
-  data.tar.gz: 387b1fba15bd026f920a642133b883b3810a7029f1ee586d5b89e9e49679d85ecae2c74a7b22e61caa927471c2332a3ed989cbc33e1608e2dd9644bf021112a6
+  metadata.gz: a747e8dc304f108e57bca638fb3f94be3c291d03847d294a9a1123792da40a0540e52482f667abbf203d1ff386375bbcb8cf6f9f6593d3073ebc78c57595aba6
+  data.tar.gz: 49c150eb070e86c54305cb63b57c48e5651b7c2857c0adec500209b0bb8003413ad701b0b378f942ab12bb29d2175bf77ddd8c9b81f29bc9409b51c1050736c3

data/bin/json2tree.rb

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+require_relative '../lib/cli-tree'
+
+if ARGV.size == 0
+  STDERR.puts "Usage: #{$0} input.json"
+  exit 1
+end
+
+json = File.read ARGV.first
+tree = TreeNode.from_json json
+tree.print

data/bin/tree.rb

@@ -1,16 +1,76 @@
 #!/usr/bin/env ruby
 # encoding: utf-8
 
+require 'getoptlong'
 require_relative '../lib/cli-tree'
 
-def get_tree_node(path)
-  name = File.basename(path)
+Program = File.basename $0
+
+Usage = <<EOF
+Usage: #{Program} [options] [dir]
+
+Options:
+  -h, --help              Print this help message and exit
+  -v, --version           Print version information and exit
+  -a, --all               All files are printed, including hidden files
+  -d, --dir-only          List directories only
+  -f, --full-prefix       Prints the full path prefix for each file
+
+Arguments:
+  dir                     The directory to traverse (Default: .)
+EOF
+
+VersionInfo = "#{Program} v#{TreeNode::VERSION}"
+
+def parse_arguments
+  opts = GetoptLong.new(
+    ['--help',        '-h', GetoptLong::NO_ARGUMENT],
+    ['--version',     '-v', GetoptLong::NO_ARGUMENT],
+    ['--all',         '-a', GetoptLong::NO_ARGUMENT],
+    ['--dir-only',    '-d', GetoptLong::NO_ARGUMENT],
+    ['--full-prefix', '-f', GetoptLong::NO_ARGUMENT],
+  )
+
+  args = {
+    show_all: false,
+    dir_only: false,
+    full_prefix: false,
+  }
+
+  begin
+    opts.each do |opt, arg|
+      case opt
+        when '--help'
+          puts Usage
+          exit 0
+        when '--version'
+          puts VersionInfo
+          exit 0
+        when '--all'
+          args[:show_all] = true
+        when '--dir-only'
+          args[:dir_only] = true
+        when '--full-prefix'
+          args[:full_prefix] = true
+      end
+    end
+  rescue GetoptLong::Error
+    exit 1
+  end
+
+  args
+end
+
+def get_tree_node(path, **kwargs)
+  name = kwargs[:full_prefix] ? path : File.basename(path)
   if File.directory?(path)
     children = []
     Dir.new(path).each do |entry|
       next if ['.', '..'].include?(entry)
+      next if entry.start_with?('.') && !kwargs[:show_all]
+      next if !File.directory?(entry) && kwargs[:dir_only]
       entry_path = File.join(path, entry)
-      children << get_tree_node(entry_path)
+      children << get_tree_node(entry_path, **kwargs)
     end
     TreeNode.new(name, children)
   else
@@ -18,6 +78,7 @@ def get_tree_node(path)
   end
 end
 
-top_dir = ARGV.first || '.'
-tree = get_tree_node(top_dir)
+args = parse_arguments
+dir = ARGV.first || '.'
+tree = get_tree_node(dir, **args)
 tree.print

data/lib/cli-tree.rb

@@ -1,5 +1,7 @@
+require 'json'
+
 class TreeNode
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 
   attr_accessor :name, :children
 
@@ -8,6 +10,32 @@ class TreeNode
     @children = children
   end
 
+  def TreeNode.from_h(hash)
+    if hash.is_a?(Hash)
+      raw_children = hash.has_key?(:children) ? hash[:children] : []
+      children = raw_children.map{|ch| TreeNode.from_h(ch)}
+      TreeNode.new hash[:name], children
+    else
+      TreeNode.new hash
+    end
+  end
+
+  def TreeNode.from_json(json)
+    hash = JSON.parse json, symbolize_names: true
+    TreeNode.from_h hash
+  end
+
+  def to_h
+    {
+      name: @name,
+      children: @children.map{|node| node.to_h}
+    }
+  end
+
+  def to_json(**kwargs)
+    JSON.generate(to_h, **kwargs)
+  end
+
   def render
     lines = [@name]
     @children.each_with_index do |child, index|

data/ruby-cli-tree.gemspec

@@ -1,50 +1,28 @@
-# encoding: utf-8
-
-require_relative 'lib/cli-tree'
-
-Gem::Specification.new do |s|
-  s.name        = 'cli-tree'
-  s.version     = TreeNode::VERSION
-  s.date        = '2018-06-02'
-
-  s.summary     = 'A command line printer of tree structures (e.g. directory tree) written in Ruby.'
-  s.description = <<EOF
-This library can be used to build a tree structure, and render or print it
-like an ASCII graph. It can be used to implement a directory tree printer
-or something like that.
-
-Example:
-
-    require 'cli-tree'
-
-    tree = TreeNode.new("root", [
-      TreeNode.new("foo", [
-        TreeNode.new("bar"),
-        TreeNode.new("baz")
-      ])
-    ])
-
-    puts tree.render
-    # or simply
-    tree.print
-
-Output:
-
-    root
-    └── foo
-        ├── bar
-        └── baz
-EOF
-
-  s.authors     = ['physacco']
-  s.email       = ['physacco@gmail.com']
-  s.homepage    = 'https://github.com/physacco/ruby-cli-tree'
-  s.license     = 'MIT'
-
-  s.files       = Dir['lib/**/*.rb'] + Dir['bin/*'] +
-                  ['README.md', 'LICENSE', 'ruby-cli-tree.gemspec']
-  s.executables = ['tree.rb']
-
-  s.platform    = Gem::Platform::RUBY
-  s.required_ruby_version = '>= 2.0.0'
-end
+# encoding: utf-8
+
+require_relative 'lib/cli-tree'
+
+Gem::Specification.new do |s|
+  s.name        = 'cli-tree'
+  s.version     = TreeNode::VERSION
+  s.date        = '2018-06-02'
+
+  s.summary     = 'A command line printer of tree structures (e.g. directory tree) written in Ruby.'
+  s.description = <<EOF
+This library can be used to build a tree structure, and render or print it
+like an ASCII graph. It can be used to implement a directory tree viewer
+or something like that.
+EOF
+
+  s.authors     = ['physacco']
+  s.email       = ['physacco@gmail.com']
+  s.homepage    = 'https://github.com/physacco/ruby-cli-tree'
+  s.license     = 'MIT'
+
+  s.files       = Dir['lib/**/*.rb'] + Dir['bin/*'] + Dir['test/*'] +
+                  ['README.md', 'LICENSE', 'ruby-cli-tree.gemspec']
+  s.executables = ['tree.rb', 'json2tree.rb']
+
+  s.platform    = Gem::Platform::RUBY
+  s.required_ruby_version = '>= 2.0.0'
+end

data/test/1.json

@@ -0,0 +1,22 @@
+{
+  "name": "root",
+  "children": [
+    {
+      "name": "foo",
+      "children": [
+        {
+          "name": "bar",
+          "children": [
+
+          ]
+        },
+        {
+          "name": "baz",
+          "children": [
+
+          ]
+        }
+      ]
+    }
+  ]
+}

data/test/2.json

@@ -0,0 +1,9 @@
+{
+  "name": "root",
+  "children": [
+    {
+      "name": "foo",
+      "children": [ "bar", "baz" ]
+    }
+  ]
+}

data/test/test1.rb

@@ -0,0 +1,16 @@
+require_relative '../lib/cli-tree'
+
+tree = TreeNode.new("root", [
+  TreeNode.new("foo", [
+    TreeNode.new("bar"),
+    TreeNode.new("baz")
+  ])
+])
+
+puts tree.render
+
+json = tree.to_json(indent: "  ", space: " ", object_nl: "\n", array_nl: "\n")
+puts json
+
+tree2 = TreeNode.from_json(json)
+tree2.print

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cli-tree
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - physacco
@@ -12,42 +12,25 @@ date: 2018-06-02 00:00:00.000000000 Z
 dependencies: []
 description: |
   This library can be used to build a tree structure, and render or print it
-  like an ASCII graph. It can be used to implement a directory tree printer
+  like an ASCII graph. It can be used to implement a directory tree viewer
   or something like that.
-
-  Example:
-
-      require 'cli-tree'
-
-      tree = TreeNode.new("root", [
-        TreeNode.new("foo", [
-          TreeNode.new("bar"),
-          TreeNode.new("baz")
-        ])
-      ])
-
-      puts tree.render
-      # or simply
-      tree.print
-
-  Output:
-
-      root
-      └── foo
-          ├── bar
-          └── baz
 email:
 - physacco@gmail.com
 executables:
 - tree.rb
+- json2tree.rb
 extensions: []
 extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
+- bin/json2tree.rb
 - bin/tree.rb
 - lib/cli-tree.rb
 - ruby-cli-tree.gemspec
+- test/1.json
+- test/2.json
+- test/test1.rb
 homepage: https://github.com/physacco/ruby-cli-tree
 licenses:
 - MIT