treedent 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4c91cc4f4bd56c3fdd07cc036caeca834c7fff5c
+  data.tar.gz: c960c0c65cd6ece8ba22179c6538d24db912ec10
+SHA512:
+  metadata.gz: 2dc9bc4fb346b5ec81d7a5ba1ef28c7690758ad6376d06761bb13dfbcc29d584746d93f59d75b55917c0a130d0629c24b752f6dd148143c3015b8d940751de74
+  data.tar.gz: 9b347be2e2c4a8c26d5539394c3d051fd8c3dedea9fe9cb4eca4f00f142c96c41f6f87e697fa4a55403b205fe2bf676520d326421709c978a589654f22559c24

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.14.6

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 pete@metanation.com. 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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in treedent.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Pete Nicholls
+
+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,72 @@
+# Treedent
+
+A command-line tool for generating `tree`-like formatted output from indented plain text.
+
+## Installation
+
+    gem install treedent
+
+## Usage
+
+Pass `treedent` a file or pipe it some content, and it will format your text as an ASCII tree:
+
+    $ cat family-tree.txt
+
+    Starks
+      Ned & Catelyn
+        Robb
+        Sansa
+        Arya
+        Bran
+        Rickon
+        Jon Snow
+    Lannisters
+      Tywin & Joanna
+        Cersei
+          Joffrey
+          Myrcella
+          Tommen
+        Jamie
+        Tyrion
+      Kevan & Dorna
+        Lancel
+
+    $ treedent family-tree.txt
+
+      Starks
+      └── Ned & Catelyn
+          ├── Robb
+          ├── Sansa
+          ├── Arya
+          ├── Bran
+          ├── Rickon
+          └── Jon Snow
+      Lannisters
+      ├── Tywin & Joanna
+      │   ├── Cersei
+      │   │   ├── Joffrey
+      │   │   ├── Myrcella
+      │   │   └── Tommen
+      │   ├── Jamie
+      │   └── Tyrion
+      └── Kevan & Dorna
+          └── Lancel
+
+`treedent` reads from stdin (i.e. `treedent < notes.txt` or `cat notes.txt | treedent` will work).
+
+Run `treedent --help` for more options.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/Aupajo/treedent. 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.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/USAGE

@@ -0,0 +1,19 @@
+Usage:
+  treedent file [options]
+
+Options:
+  -h, --help    # Show this help message and quit
+  -v, --version # Show treedent version message and quit
+
+Example:
+
+  echo "a\\n  b\\n    c\\n  d\\n  e\\n    f" | treedent
+
+  Will return:
+
+    a
+    ├── b
+    │   └── c
+    ├── d
+    └── e
+        └── f

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "treedent"
+
+# 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/exe/treedent

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'treedent/cli'
+Treedent::CLI.start

data/lib/treedent.rb

@@ -0,0 +1,6 @@
+require "treedent/version"
+require "treedent/formatted_output"
+require "treedent/indented_line"
+require "treedent/node_drawing"
+require "treedent/node"
+require "treedent/tree"

data/lib/treedent/cli.rb

@@ -0,0 +1,28 @@
+require 'treedent'
+require 'pathname'
+
+module Treedent
+  class CLI
+    def self.start
+      return usage if options?('-h', '--help')
+      return version if options?('-v', '--version')
+      format
+    end
+
+    def self.usage
+      puts Pathname(__dir__).join('..', '..', 'USAGE').read
+    end
+
+    def self.version
+      puts "treedent #{Treedent::VERSION}"
+    end
+
+    def self.format
+      puts Treedent::FormattedOutput.new(ARGF.read).to_s
+    end
+
+    def self.options?(*values)
+      values.any? { |value| ARGV.include?(value) }
+    end
+  end
+end

data/lib/treedent/formatted_output.rb

@@ -0,0 +1,18 @@
+module Treedent
+  class FormattedOutput < Struct.new(:input)
+
+    def to_s
+      tree.map { |node| NodeDrawing.new(node).to_s }.join
+    end
+
+    private
+
+    def tree
+      Tree.new(indented_lines)
+    end
+
+    def indented_lines
+      input.lines.map { |line| IndentedLine.from(line) }
+    end
+  end
+end

data/lib/treedent/indented_line.rb

@@ -0,0 +1,14 @@
+require 'strscan'
+
+module Treedent
+  class IndentedLine < Struct.new(:indentation, :content)
+    WHITESPACE_PATTERN = /[ \t]*/
+
+    def self.from(line_string)
+      scanner = StringScanner.new(line_string)
+      indentation = scanner.scan(WHITESPACE_PATTERN)&.length || 0
+      content = scanner.rest
+      self.new(indentation, content)
+    end
+  end
+end

data/lib/treedent/node.rb

@@ -0,0 +1,51 @@
+module Treedent
+  class Node
+    attr_reader :value, :parent
+    attr_accessor :successor
+
+    def initialize(value = nil, parent = nil, successor = nil)
+      @value, @parent, @successor = value, parent, successor
+    end
+
+    def depth
+      @depth ||= ancestors.count
+    end
+
+    def final_sibling?
+      successor.nil? || successors.all? { |node| node.parent != parent }
+    end
+
+    def successors_only_descend?
+      successors.all? { |node| node.depth >= depth }
+    end
+
+    def orphan?
+      parent.root?
+    end
+
+    def last?
+      successor.nil?
+    end
+
+    def root?
+      value.nil?
+    end
+
+    def ancestors(&block)
+      return enum_for(:ancestors) unless block_given?
+      traverse_relationship(:parent, &block)
+    end
+
+    def successors(&block)
+      return enum_for(:successors) unless block_given?
+      traverse_relationship(:successor, &block)
+    end
+
+    private
+
+    def traverse_relationship(relation, &block)
+      node = self
+      yield node while node = node.public_send(relation)
+    end
+  end
+end

data/lib/treedent/node_drawing.rb

@@ -0,0 +1,39 @@
+module Treedent
+  class NodeDrawing < Struct.new(:node)
+    SPACE  = "    "
+    BAR    = "│   "
+    TEE    = "├── "
+    CORNER = "└── "
+
+    def to_s
+      [drawings, node.value.content].compact.join
+    end
+
+    def drawings
+      return [] if node.orphan?
+      [outer_indentation, inner_indentation].flatten
+    end
+
+    private
+
+    def inner_indentation
+      if node.final_sibling?
+        CORNER
+      else
+        TEE
+      end
+    end
+
+    def outer_indentation
+      node.ancestors.reverse_each.map do |parent|
+        next if parent.root? || parent.orphan?
+
+        if parent.final_sibling?
+          SPACE
+        else
+          BAR
+        end
+      end
+    end
+  end
+end

data/lib/treedent/tree.rb

@@ -0,0 +1,36 @@
+module Treedent
+  class Tree < Struct.new(:indented_lines)
+    include Enumerable
+
+    def each
+      node = root
+      yield node while node = node.successor
+    end
+
+    def root
+      root_node = Node.new
+      parent_node = root_node
+      prev_node = root_node
+
+      indented_lines.each do |line|
+        unless prev_node.root?
+          if line.indentation != prev_node.value.indentation
+            parent_node = prev_node
+
+            if line.indentation < prev_node.value.indentation
+              parent_node = prev_node.ancestors.find do |parent|
+                parent.root? || parent.value.indentation < line.indentation
+              end
+            end
+          end
+        end
+
+        node = Node.new(line, parent_node)
+        prev_node.successor = node
+        prev_node = node
+      end
+
+      root_node
+    end
+  end
+end

data/lib/treedent/version.rb

@@ -0,0 +1,3 @@
+module Treedent
+  VERSION = "1.0.0"
+end

data/treedent.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'treedent/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "treedent"
+  spec.version       = Treedent::VERSION
+  spec.authors       = ["Pete Nicholls"]
+  spec.email         = ["pete@metanation.com"]
+
+  spec.summary       = %q{A command-line tool for formatting indented text like `tree`.}
+  spec.homepage      = "https://github.com/Aupajo/treedent"
+  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 "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: treedent
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Pete Nicholls
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-04-25 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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: 
+email:
+- pete@metanation.com
+executables:
+- treedent
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- USAGE
+- bin/console
+- bin/setup
+- exe/treedent
+- lib/treedent.rb
+- lib/treedent/cli.rb
+- lib/treedent/formatted_output.rb
+- lib/treedent/indented_line.rb
+- lib/treedent/node.rb
+- lib/treedent/node_drawing.rb
+- lib/treedent/tree.rb
+- lib/treedent/version.rb
+- treedent.gemspec
+homepage: https://github.com/Aupajo/treedent
+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.6.8
+signing_key: 
+specification_version: 4
+summary: A command-line tool for formatting indented text like `tree`.
+test_files: []