tty-tree 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b7ed240a5a6239047b55b961fa170aaa28df6109
+  data.tar.gz: b5363c4033cf2218c69d4a0174d1348d2dca5ab7
+SHA512:
+  metadata.gz: 0c873142481cc06042c4d6f1e3de114f91b372ddd52bca933a84f1a2ba3abedcaa86b0d35d75e4ed5cffe6a13ae5040576dc29e3d04a806a81730e82b6e372dc
+  data.tar.gz: 18c3d908b3a7c8e0e0205ccf908e9594237ccaece938c567ed5dd7bf86e0f300993cc8e139b5953d405b488cad2c36340c77f55dcd6245033d01d2b4e0c8a9c2

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--warnings

data/.travis.yml

@@ -0,0 +1,24 @@
+---
+language: ruby
+sudo: false
+before_install: gem install bundler -v 1.14.6
+bundler_args: --without tools
+script: "bundle exec rake ci"
+rvm:
+  - 2.0.0
+  - 2.1.10
+  - 2.2.6
+  - 2.3.3
+  - 2.4.0
+  - ruby-head
+  - jruby-9000
+  - jruby-head
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head
+  fast_finish: true
+branches:
+  only: master
+notifications:
+  email: false

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Change log
+
+## [v0.1.0] - 2017-05-01
+
+* Initial implementation and release
+
+[v0.1.0]: https://github.com/piotrmurach/tty-tree/compare/v0.1.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [email]. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,19 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem 'benchmark-ips', '~> 2.0.0'
+  gem 'simplecov', '~> 0.10.0'
+  gem 'coveralls', '~> 0.8.2'
+  gem 'term-ansicolor', '=1.3.2'
+end
+
+group :tools do
+  gem 'byebug', platform: :mri
+end
+
+group :metrics do
+  gem 'yard',      '~> 0.8.7'
+  gem 'yardstick', '~> 0.9.9'
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Piotr Murach
+
+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,240 @@
+# TTY::Tree [![Gitter](https://badges.gitter.im/Join%20Chat.svg)][gitter]
+
+[![Gem Version](https://badge.fury.io/rb/tty-tree.svg)][gem]
+[![Build Status](https://secure.travis-ci.org/piotrmurach/tty-tree.svg?branch=master)][travis]
+[![Build status](https://ci.appveyor.com/api/projects/status/q3s4gagj8xnospw4?svg=true)][appveyor]
+[![Code Climate](https://codeclimate.com/github/piotrmurach/tty-tree/badges/gpa.svg)][codeclimate]
+[![Coverage Status](https://coveralls.io/repos/github/piotrmurach/tty-tree/badge.svg)][coverage]
+[![Inline docs](http://inch-ci.org/github/piotrmurach/tty-tree.svg?branch=master)][inchpages]
+
+[gitter]: https://gitter.im/piotrmurach/tty
+[gem]: http://badge.fury.io/rb/tty-tree
+[travis]: http://travis-ci.org/piotrmurach/tty-tree
+[appveyor]: https://ci.appveyor.com/project/piotrmurach/tty-tree
+[codeclimate]: https://codeclimate.com/github/piotrmurach/tty-tree
+[coverage]: https://coveralls.io/github/piotrmurach/tty-tree
+[inchpages]: http://inch-ci.org/github/piotrmurach/tty-tree
+
+> Print directory or structured data in a tree like format.
+
+**TTY::Prompt** provides independent directory or hash data rendering component for [TTY](https://github.com/piotrmurach/tty) toolkit.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tty-tree'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tty-tree
+
+## Contents
+
+* [1. Usage](#1-usage)
+* [2. Interface](#2-interface)
+  * [2.1 new](#21-new)
+    * [2.1.1 level](#211-level)
+    * [2.1.2 file_limit](#212-level)
+    * [2.1.3 show_hidden](#213-show_hidden)
+    * [2.1.4 only_dirs](#214-only_dirs)
+  * [2.2 render](#22-render)
+    * [2.2.1 indent](#221-indent)
+
+## 1. Usage
+
+`TTY::Tree` accepts as input a directory path:
+
+```ruby
+tree = TTY::Tree.new(Dir.pwd)
+tree = TTY::Tree.new('dir-name')
+```
+
+or can be given as its input a `hash` data structure with keys representing directories and values as `array`s representing directory contents:
+
+```ruby
+data = {
+  dir1: [
+    'config.dat',
+    { dir2: [
+      { dir3: [ 'file3-1.txt' ] },
+      'file2-1.txt'
+      ]
+    },
+    'file1-1.txt',
+    'file1-2.txt'
+  ]
+}
+
+tree = TTY::Tree.new(data)
+```
+
+You can also construct tree with a DSL:
+
+```ruby
+tree = TTY::Tree.new do
+  node 'dir1' do
+    node 'config.dat'
+    node 'dir2' do
+      node 'dir3' do
+        leaf 'file3-1.txt'
+      end
+      leaf 'file2-1.txt'
+    end
+    node 'file1-1.txt'
+    leaf 'file1-2.txt'
+  end
+end
+```
+
+The `TTY::Tree` can print the content in various formats. By default, a directory format is used by invoking `render`:
+
+```ruby
+puts tree.render
+# =>
+# dir1
+# ├── config.dat
+# ├── dir2,
+# │   ├── dir3\n",
+# │   │   └── file3-1.txt\n",
+# │   └── file2-1.txt\n",
+# ├── file1-1.txt\n",
+# └── file1-2.txt\n",
+```
+
+The `render` call returns a string and leaves it up to api consumer how to handle the tree like output.
+
+## 2. Interface
+
+### 2.1 new
+
+In order to create `TTY::Tree` you need to provide either a path to directory which can be a String, Pathname or Dir:
+
+```ruby
+tree = TTY::Tree.new(Dir.pwd)
+tree = TTY::Tree.new('dir-name')
+tree = TTY::Tree.new(Pathname.pwd)
+```
+
+or hash data structure:
+
+```ruby
+data = {
+  dir1: [
+    'config.dat',
+    ...
+  ]
+}
+
+tree = TTY::Tree.new(data)
+```
+
+As as shortcut notation you can call `[]` like so:
+
+```ruby
+tree = TTY::Tree[Dir.pwd]
+```
+
+You can also use DSL to build tree by using `node` & `leaf`:
+
+```ruby
+tree = TTY::Tree.new do
+  node 'dir1' do
+    node 'config.dat'
+    node 'dir2' do
+      node 'dir3' do
+        leaf 'file3-1.txt'
+      end
+      leaf 'file2-1.txt'
+    end
+    node 'file1-1.txt'
+    leaf 'file1-2.txt'
+  end
+end
+```
+
+#### 2.1.1 level
+
+The maximum level of depth for this tree when parsing directory. The initial directory is treated as index `0`.
+
+```ruby
+tree = TTY::Tree.new('dir-name', level: 2)
+# => parse directories as deep as 2 levels
+```
+
+#### 2.1.2 file_limit
+
+Prevent `TTY::Tree` descending directories more than `#` entries:
+
+```ruby
+tree = TTY::Tree.new('dir-name', file_limit: 2)
+```
+
+#### 2.1.3 show_hidden
+
+In order to for `TTY::Tree` to include hidden files in its output use `:show_hidden` option like so:
+
+```ruby
+tree = TTY::Tree.new('dir-name', show_hidden: true)
+```
+
+#### 2.1.4 only_dirs
+
+To only display directory entries in the output use `:only_dirs` option:
+
+```ruby
+tree = TTY::Tree.new('dir-name', only_dirs: true)
+```
+
+Listing directories does not inlucde hidden ones. If you wish to show hidden directories as well do:
+
+```ruby
+tree = TTY::Tree.new('dir-name', only_dirs: true, show_hidden: true)
+```
+
+### 2.2 render
+
+By deafult content is printed using `TTY::PathRenderer`.
+
+If you prefer a numeric notation of nested content you can use `TTY::NumberRenderer` to enumerates each nested node like so:
+
+```ruby
+puts tree.render(as: :number)
+# =>
+# dir1\n",
+# 1.1 config.dat\n",
+# 1.2 dir2\n",
+#     2.3 dir3\n",
+#         3.4 file3-1.txt\n",
+#     2.5 file2-1.txt\n",
+# 1.6 file1-1.txt\n",
+# 1.7 file1-2.txt\n",
+```
+
+#### 2.2.1 indent
+
+The number of spaces to use when indenting nested directories. By default `4` spaces are used.
+
+```ruby
+tree.render(as: :dir, indent: 2)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/piotrmurach/tty-tree. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## Copyright
+
+Copyright (c) 2017 Piotr Murach. See LICENSE for further details.

data/Rakefile

@@ -0,0 +1,8 @@
+# encoding: utf-8
+
+require 'bundler/gem_tasks'
+
+FileList['tasks/**/*.rake'].each(&method(:import))
+
+desc 'Run all specs'
+task ci: %w[ spec ]

data/appveyor.yml

@@ -0,0 +1,23 @@
+---
+install:
+  - SET PATH=C:\Ruby%ruby_version%\bin;%PATH%
+  - ruby --version
+  - gem --version
+  - bundle install
+build: off
+test_script:
+  - bundle exec rake ci
+environment:
+  matrix:
+    - ruby_version: "193"
+    - ruby_version: "200"
+    - ruby_version: "200-x64"
+    - ruby_version: "21"
+    - ruby_version: "21-x64"
+    - ruby_version: "22"
+    - ruby_version: "22-x64"
+    - ruby_version: "23"
+    - ruby_version: "23-x64"
+matrix:
+  allow_failures:
+    - ruby_version: "193"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "tty/tree"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/tty-tree.rb

@@ -0,0 +1,3 @@
+# encoding: utf-8
+
+require_relative 'tty/tree'

data/lib/tty/tree.rb

@@ -0,0 +1,113 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+require_relative 'tree/node'
+require_relative 'tree/directory_renderer'
+require_relative 'tree/number_renderer'
+require_relative 'tree/hash_walker'
+require_relative 'tree/path_walker'
+require_relative 'tree/version'
+
+module TTY
+  class Tree
+    # @api public
+    def self.[](data)
+      new(data)
+    end
+
+    # The list of nodes in this tree.
+    attr_reader :nodes
+
+    # Create a Tree
+    #
+    # @param [String,Dir,Hash] data
+    #
+    # @api public
+    def initialize(data = nil, options = {}, &block)
+      @data   = data ? data.dup.freeze : nil
+      @walker = select_walker.new(options)
+      @nodes  = []
+
+      if @data
+        @walker.traverse(data)
+        @nodes = @walker.nodes
+      end
+
+      @nodes_stack = []
+
+      instance_eval(&block) if block_given?
+
+      freeze
+    end
+
+    # Add node to this tree.
+    #
+    # @param [Symbol,String] name
+    #   the name for the node
+    #
+    # @param [Node, LeafNode] type
+    #   the type of node to add
+    #
+    # @example
+    #   TTY::Tree.new do
+    #     node '...' do
+    #       node '...'
+    #     end
+    #   end
+    #
+    # @api public
+    def node(name, type = Node, &block)
+      parent = @nodes_stack.empty? ? Node::ROOT : @nodes_stack.last
+      level = [0, @nodes_stack.size - 1].max
+      prefix = ':pipe' * level
+      if parent.class == LeafNode
+        prefix = ':space' * level
+      end
+      node = type.new(name, parent.full_path, prefix, @nodes_stack.size)
+      @nodes << node
+
+      return unless block_given?
+
+      @nodes_stack << node
+      if block.arity.zero?
+        instance_eval(&block)
+      else
+        instance_eval(&(->(*_args) { block[node] }))
+      end
+      @nodes_stack.pop
+    end
+
+    # Add leaf node
+    #
+    # @api public
+    def leaf(name, &block)
+      node(name, LeafNode, &block)
+    end
+
+    # @api public
+    def render(options = {})
+      as = options.delete(:as) || :dir
+      renderer = select_renderer(as).new(nodes, options)
+      renderer.render
+    end
+
+    private
+
+    # @api private
+    def select_walker
+      if @data.is_a?(Hash) || @data.nil?
+        HashWalker
+      else
+        @data ||= Dir.pwd
+        PathWalker
+      end
+    end
+
+    def select_renderer(as)
+      case as
+      when :dir, :directory then DirectoryRenderer
+      when :num, :number then NumberRenderer
+      end
+    end
+  end # Tree
+end # TTY

data/lib/tty/tree/directory_renderer.rb

@@ -0,0 +1,46 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+module TTY
+  class Tree
+    # Render nodes as files paths explorer
+    class DirectoryRenderer
+      MARKERS = {
+        unicode: {
+          branch: '├──',
+          leaf: '└──',
+          pipe: '│'
+        },
+        ansi: {
+          branch: '|--',
+          leaf: '`--',
+          pipe: '|'
+        }
+      }.freeze
+
+      def initialize(nodes, options = {})
+        @nodes  = nodes
+        @indent = options.fetch(:indent, 4)
+        @pipe_mark  = MARKERS[:unicode][:pipe] + ' ' * [@indent - 1, 0].max
+        @space_mark = ' ' * @indent
+      end
+
+      def render
+        @nodes.reduce([]) do |acc, node|
+          render_node(acc, node, @pipe_mark, @space_mark)
+        end.join('')
+      end
+
+      private
+
+      def render_node(acc, node, pipe_mark, space_mark)
+        acc << node.prefix.gsub(/:pipe/, pipe_mark).gsub(/:space/, space_mark)
+        unless node.root?
+          acc << MARKERS[:unicode][node.leaf? ? :leaf : :branch]
+          acc << ' '
+        end
+        acc << node.name.to_s + "\n"
+      end
+    end # DirRenderer
+  end # Tree
+end # TTY

data/lib/tty/tree/hash_walker.rb

@@ -0,0 +1,71 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+require 'pathname'
+
+require_relative 'node'
+
+module TTY
+  class Tree
+    # Walk and collect nodes from hash data strcture.
+    #
+    # @api public
+    class HashWalker
+      attr_reader :nodes
+
+      attr_reader :files_count
+
+      attr_reader :dirs_count
+
+      def initialize(options = {})
+        @nodes       = []
+        @files_count = 0
+        @dirs_count  = 0
+        @level       = options.fetch(:level) { -1 }
+        @file_limit  = options.fetch(:file_limit) { - 1 }
+      end
+
+      def traverse(data)
+        walk(data, Pathname.new(''), '', 0, false)
+      end
+
+      def walk(data, parent_path, prefix, level, is_last)
+        node = is_last ? LeafNode : Node
+
+        case data
+        when Hash
+          return if @level != -1 && level + 1 > @level
+
+          data.each do |dir, item|
+            dir_node = node.new(dir.to_s, parent_path, prefix, level)
+            @nodes << dir_node
+            @dirs_count += 1 unless dir_node.root?
+
+            if level > 0
+              postfix = ':pipe'
+              postfix = ':space' if is_last
+            else
+              postfix = ''
+            end
+
+            walk(item, parent_path + dir.to_s,
+                 prefix + postfix, level + 1, false)
+          end
+        when Array
+          return if @file_limit != -1 && data.size > @file_limit
+
+          last_data_index = data.size - 1
+
+          data.each_with_index do |item, i|
+            last = (last_data_index == i)
+
+            walk(item, parent_path, prefix, level, last)
+          end
+        else
+          @nodes << node.new(data.to_s, parent_path, prefix, level)
+          @files_count += 1
+        end
+      end
+    end # HashWalker
+  end # Tree
+end # TTY

data/lib/tty/tree/node.rb

@@ -0,0 +1,85 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+require 'forwardable'
+require 'pathname'
+
+module TTY
+  class Tree
+    # A representation of tree node
+    #
+    # @api private
+    class Node
+      extend Forwardable
+
+      # The base name for the directory or file
+      attr_reader :name
+
+      # The parent directory path
+      attr_reader :parent
+
+      # The require path prefix
+      attr_reader :prefix
+
+      # The directory depth
+      attr_reader :level
+
+      # The file stat
+      attr_reader :stat
+
+      # The current path
+      attr_reader :path
+
+      def_delegators :@path, :directory?, :executable?, :file?,
+                     :symlink?, :socket?, :pipe?
+
+      def initialize(path, parent, prefix, level)
+        @path   = Pathname.new(path)
+        @name   = @path.basename
+        @parent = Pathname.new(parent)
+        @prefix = prefix
+        @level  = level
+      end
+
+      def full_path
+        return parent if name.to_s.empty?
+        parent.join(name)
+      end
+
+      def root?
+        parent.to_s.empty?
+      end
+
+      def hidden?
+        name.to_s.start_with?('.')
+      end
+
+      def leaf?
+        false
+      end
+
+      def to_s
+        @name
+      end
+
+      def ==(other)
+        other.is_a?(self.class) && other.state_attrs == state_attrs
+      end
+      alias eql? ==
+
+      protected
+
+      def state_attrs
+        [@name, @path, @parent, @prefix, @level]
+      end
+
+      ROOT = Node.new('', Pathname.new(''), '', 0).freeze
+    end # Node
+
+    class LeafNode < Node
+      def leaf?
+        true
+      end
+    end # LeafNode
+  end # Tree
+end # TTY

data/lib/tty/tree/number_renderer.rb

@@ -0,0 +1,31 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+module TTY
+  class Tree
+    # Render nodes as numbered list
+    class NumberRenderer
+      def initialize(nodes, options = {})
+        @indent = options.fetch(:indent, 4)
+        @nodes = nodes
+        @mark = ' ' * @indent
+      end
+
+      def render
+        @nodes.each_with_index.reduce([]) do |acc, (node, i)|
+          render_node(acc, node, i, @mark)
+        end.join
+      end
+
+      private
+
+      def render_node(acc, node, i, mark)
+        acc << node.prefix.gsub(/:pipe|:space/, mark)
+        unless node.root?
+          acc << "#{node.level}.#{i} "
+        end
+        acc << node.name.to_s + "\n"
+      end
+    end # NumberRenderer
+  end # Tree
+end # TTY

data/lib/tty/tree/path_walker.rb

@@ -0,0 +1,109 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+require 'pathname'
+
+require_relative 'node'
+
+module TTY
+  class Tree
+    # Walk and collect nodes from directory.
+    #
+    # @api public
+    class PathWalker
+      attr_reader :nodes
+
+      attr_reader :files_count
+
+      attr_reader :dirs_count
+
+      # Create a PathWalker
+      #
+      # @api public
+      def initialize(**options)
+        @files_count = 0
+        @dirs_count  = 0
+        @nodes       = []
+        @filters     = []
+        @level       = options.fetch(:level) { -1 }
+        @file_limit  = options.fetch(:file_limit) { - 1 }
+
+        unless options[:show_hidden]
+          add_filter(-> (p) { !p.basename.to_s.start_with?('.') })
+        end
+
+        if options[:only_dirs]
+          add_filter(-> (p) { p.directory? })
+        end
+      end
+
+      def add_filter(filter)
+        @filters << filter
+      end
+
+      # Traverse given path recursively
+      #
+      # @param [String] path
+      #   the path to traverse
+      #
+      # @api public
+      def traverse(path)
+        root_path  = Pathname.new(path)
+        empty_path = Pathname.new('')
+
+        unless root_path.directory?
+          raise ArgumentError, "#{root_path} is not a directory path"
+        end
+
+        @nodes << Node.new(root_path, empty_path, '', 0)
+
+        walk(root_path, root_path.children, '', 1)
+      end
+
+      private
+
+      # Filter entries
+      #
+      # @api private
+      def filter_entries(entries, filters)
+        return entries if filters.nil? || filters.empty?
+        filter = filters[0]
+        filter_entries(entries.select(&filter), filters[1..-1])
+      end
+
+      # Walk paths recursively
+      #
+      # @api private
+      def walk(parent_path, entries, prefix, level)
+        if entries.empty? || (@level != -1 && @level < level)
+          return
+        else
+          return if @file_limit != -1 && entries.size > @file_limit
+          processed_paths = filter_entries(entries, @filters).sort
+          last_path_index = processed_paths.size - 1
+
+          processed_paths.each_with_index do |path, i|
+            sub_path = path.relative_path_from(parent_path)
+
+            node = last_path_index == i ? LeafNode : Node
+
+            if path.directory?
+              next if @level != -1 && level + 1 > @level
+
+              @nodes << node.new(sub_path, parent_path, prefix, level)
+              @dirs_count += 1
+
+              postfix = ':pipe'
+              postfix = ':space' if i == last_path_index
+
+              walk(path, path.children, prefix + postfix, level + 1)
+            elsif path.file?
+              @nodes << node.new(path, parent_path, prefix, level)
+              @files_count += 1
+            end
+          end
+        end
+      end
+    end # PathWalker
+  end # Tree
+end # TTY

data/lib/tty/tree/version.rb

@@ -0,0 +1,7 @@
+# encoding: utf-8
+
+module TTY
+  class Tree
+    VERSION = "0.1.0"
+  end # Tree
+end # TTY

data/tasks/console.rake

@@ -0,0 +1,11 @@
+# encoding: utf-8
+
+desc 'Load gem inside irb console'
+task :console do
+  require 'irb'
+  require 'irb/completion'
+  require File.join(__FILE__, '../../lib/tty-prompt')
+  ARGV.clear
+  IRB.start
+end
+task c: %w[ console ]

data/tasks/coverage.rake

@@ -0,0 +1,11 @@
+# encoding: utf-8
+
+desc 'Measure code coverage'
+task :coverage do
+  begin
+    original, ENV['COVERAGE'] = ENV['COVERAGE'], 'true'
+    Rake::Task['spec'].invoke
+  ensure
+    ENV['COVERAGE'] = original
+  end
+end

data/tasks/spec.rake

@@ -0,0 +1,29 @@
+# encoding: utf-8
+
+begin
+  require 'rspec/core/rake_task'
+
+  desc 'Run all specs'
+  RSpec::Core::RakeTask.new(:spec) do |task|
+    task.pattern = 'spec/{unit,integration}{,/*/**}/*_spec.rb'
+  end
+
+  namespace :spec do
+    desc 'Run unit specs'
+    RSpec::Core::RakeTask.new(:unit) do |task|
+      task.pattern = 'spec/unit{,/*/**}/*_spec.rb'
+    end
+
+    desc 'Run integration specs'
+    RSpec::Core::RakeTask.new(:integration) do |task|
+      task.pattern = 'spec/integration{,/*/**}/*_spec.rb'
+    end
+  end
+
+rescue LoadError
+  %w[spec spec:unit spec:integration].each do |name|
+    task name do
+      $stderr.puts "In order to run #{name}, do `gem install rspec`"
+    end
+  end
+end

data/tty-tree.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tty/tree/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tty-tree"
+  spec.version       = TTY::Tree::VERSION
+  spec.authors       = ["Piotr Murach"]
+  spec.email         = [""]
+
+  spec.summary       = %q{Print directory or structured data in a tree like format.}
+  spec.description   = %q{Print directory or structured data in a tree like format.}
+  spec.homepage      = "https://piotrmurach.github.io/tty"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: tty-tree
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Piotr Murach
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-05-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Print directory or structured data in a tree like format.
+email:
+- ''
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- appveyor.yml
+- bin/console
+- bin/setup
+- lib/tty-tree.rb
+- lib/tty/tree.rb
+- lib/tty/tree/directory_renderer.rb
+- lib/tty/tree/hash_walker.rb
+- lib/tty/tree/node.rb
+- lib/tty/tree/number_renderer.rb
+- lib/tty/tree/path_walker.rb
+- lib/tty/tree/version.rb
+- tasks/console.rake
+- tasks/coverage.rake
+- tasks/spec.rake
+- tty-tree.gemspec
+homepage: https://piotrmurach.github.io/tty
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Print directory or structured data in a tree like format.
+test_files: []
+has_rdoc: