cli-tree 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1e0f13728de1349b02be11f2ae0bbcb2bc3b306a3fabe278899b21fa7bc9df4c
+  data.tar.gz: e36b25b7f939f1bdbf2bd6cdc30ce9c0a0500785cd2b955999c19d9a2aca6346
+SHA512:
+  metadata.gz: 0ba42cb576127242e0a08e46d66364121715e14a699a0e9c3a427eaaae232be4ef58a345032db858772fd4c0ac059b51a6c6bea746ab608df3e00631b0b74de2
+  data.tar.gz: 387b1fba15bd026f920a642133b883b3810a7029f1ee586d5b89e9e49679d85ecae2c74a7b22e61caa927471c2332a3ed989cbc33e1608e2dd9644bf021112a6

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 ZQ
+
+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,49 @@
+# ruby-cli-tree
+
+A command line printer of tree structures (e.g. directory tree) written in Ruby.
+
+This library can be used to build a tree structure, and render or print it
+like an ASCII graph.
+
+e.g. it can be used to implement a directory tree printer
+just like the Linux utility [tree](http://mama.indstate.edu/users/ice/tree/). See [bin/tree.rb](bin/tree.rb)
+
+## Installation
+
+```shell
+gem install cli-tree
+```
+
+## Usage
+
+1. `require 'cli-tree'`
+2. Create a **TreeNode**: `tree = TreeNode.new(node_name, children = [])`
+3. Add more **TreeNode** objects to `children`: `tree.children << child_node`
+4. Add more **TreeNode** objects to `child_node`, and so on.
+5. Call `puts tree.render` or `tree.print` to print the tree.
+
+## Example
+
+```ruby
+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
+```

data/bin/tree.rb

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+require_relative '../lib/cli-tree'
+
+def get_tree_node(path)
+  name = File.basename(path)
+  if File.directory?(path)
+    children = []
+    Dir.new(path).each do |entry|
+      next if ['.', '..'].include?(entry)
+      entry_path = File.join(path, entry)
+      children << get_tree_node(entry_path)
+    end
+    TreeNode.new(name, children)
+  else
+    TreeNode.new(name)
+  end
+end
+
+top_dir = ARGV.first || '.'
+tree = get_tree_node(top_dir)
+tree.print

data/lib/cli-tree.rb

@@ -0,0 +1,33 @@
+class TreeNode
+  VERSION = '1.0.0'
+
+  attr_accessor :name, :children
+
+  def initialize(name, children = [])
+    @name = name
+    @children = children
+  end
+
+  def render
+    lines = [@name]
+    @children.each_with_index do |child, index|
+      child_lines = child.render
+      if index < @children.size - 1
+        child_lines.each_with_index do |line, idx|
+          prefix = (idx == 0) ? "├── " : "|   "
+          lines << "#{prefix}#{line}"
+        end
+      else
+        child_lines.each_with_index do |line, idx|
+          prefix = (idx == 0) ? "└── " : "    "
+          lines << "#{prefix}#{line}"
+        end
+      end
+    end
+    lines
+  end
+
+  def print(stream: STDOUT, prefix: '')
+    stream.puts render.map{|line| "#{prefix}#{line}\n"}
+  end
+end

data/ruby-cli-tree.gemspec

@@ -0,0 +1,50 @@
+# 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

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: cli-tree
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- physacco
+autorequire: 
+bindir: bin
+cert_chain: []
+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
+  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
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/tree.rb
+- lib/cli-tree.rb
+- ruby-cli-tree.gemspec
+homepage: https://github.com/physacco/ruby-cli-tree
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: A command line printer of tree structures (e.g. directory tree) written in
+  Ruby.
+test_files: []