tree_outline 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MDBhZGU3NDMwMWY1NTM0YzA1OWI2NjhmNTM3ZDM0YzRhMjFkY2Y4ZA==
+  data.tar.gz: !binary |-
+    MjI4YjBmYTAyZmM5NjBjNGFjYzhiYzM0ZWVlZjhiNTMyNWRhODJmZQ==
+SHA512:
+  metadata.gz: !binary |-
+    ZmZlMjhhMzA5MzllMDUzN2I4NDQyNTljNjI2YmYzYTBkYzBhMjdlNmU3ODU2
+    ZTIyYjBhNTRiNjc5MDFhODM5M2VjMDczYzVkZjMxOTljMGUzNjViMzIxZjk4
+    OWVlNTYzZDEzYTY1NDMzMGUxMmZhY2RkYzEyOTAzMTlmNGYwMDI=
+  data.tar.gz: !binary |-
+    OGViODc4ZTRlY2ZkZGVjZjU3YzE1N2RjYmQ0MDNkZmJmYmIyMmM5MDIwMGEw
+    OWVlYmYyZDU1MzUxM2Y3MmEzMTAwN2ViZGI5NzFlZjZmZWQwYTlkYWYzOTcw
+    OTc1MGYzMDM0ODRiODRmM2Y5NTFkYWVlNGRjYjdmOTAzZTM1MmU=

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+rvm:
+- 2.2.2
+addons:
+  code_climate:
+    repo_token: 58e8a92216235bcf7808e03c37610985a6524d25ce7ac20aeedd2f8a5c32c797
+deploy:
+  provider: rubygems
+  api_key:
+    secure: ypr3m3B8Tr4IQNa7hqydWdB0Iu1lgjAxU8rtpze9yd0u6+q48GF0jdlwnIQ/po2pQDOc/O7uourXgTjp8g8zkZCgdDsvMzV1pAiRt5TlXeSAkBWL81033Sjo9CkMzeGxspekCx8JrjxjH7EhtUqe/OiX8PfYS1lUYCCQTryahcpTUdYJ0BK14X0Z9j4Z/qmvRe35oeoMVZ0K06O1GCdGfZmeKp9IoKxkZKj5df6oU3K5EQkauNVgar8MYzxvxfoJtSBnPs4LO1ruYaGdMaHfTI7xpPpzUlLCZdeEBjmnNmLG8tmSurl8NKQJuSY7hQCWtNMlGG/JZaMmdAgwJKZkK9wzh7ZlR/ItsVBFzNapMRTLPTNghwtNW29ceE1CPNdJJ93xZC02jf8GCux1+OOVhBtlLlgeDYVNO0i0p++11Q6gtgg6ToYm5xJnpq3+4Pib/s7Hidpka5ej0XOA+OxMxH+Llu++JDNOP41Hg38bgZ/st7G23G4R7rXC74ACsTa8yMPiJ6Cm0BN/vzuYoaiJxUFYPhZDdS6Yi0r+w1HpL2eeBH9gmRfpX6zMOo6+k0Uf4luGFqKoQpdH5+HHH5Vl7e0HjX75EPMhcWXFgoxinLUnp6DSC71MwADc2WQILytsMjFFok4bEnpxlxtoT73V00aMoDFKLnFNC4Ov5+0MHrs=
+  gem: tree_outline
+  on:
+    tags: true
+    repo: flower-pot/tree_outline

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in tree_outline.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Frederic Branczyk
+
+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,84 @@
+[![Build Status](https://travis-ci.org/flower-pot/tree_outline.svg?branch=master)](https://travis-ci.org/flower-pot/tree_outline)
+[![Test Coverage](https://codeclimate.com/github/flower-pot/tree_outline/badges/coverage.svg)](https://codeclimate.com/github/flower-pot/tree_outline/coverage)
+[![Code Climate](https://codeclimate.com/github/flower-pot/tree_outline/badges/gpa.svg)](https://codeclimate.com/github/flower-pot/tree_outline)
+
+# TreeOutline
+
+Use TreeOutline to stringify trees. It uses characters from the extended ASCII
+character encoding to make them the most beautiful they can be.
+
+The style the tree is formatted in is similar to the way the unix tool `tree`
+outputs the the tree of a directory.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tree_outline'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tree_outline
+
+## Usage
+
+All you need is a recursive datastructure such as the below `Node` class. It
+contains the attribute `children`, which is an enumeration of `Node`s as well.
+The `to_s` method is called to stringify a node itself.
+
+```ruby
+require 'tree_outline'
+
+class Node
+  attr_reader :name, :children
+
+  def initialize(name, children = [])
+    @name = name
+    @children = children
+  end
+
+  alias_method :to_s, :name
+end
+
+my_tree = Node.new('root', [
+  Node.new('first'),
+  Node.new('second'),
+  Node.new('third')
+])
+
+puts TreeOutline.new(my_tree).to_s
+# root
+# ├── first
+# ├── second
+# └── third
+```
+
+## Side-Note
+
+When implementing we noticed that this also makes a interesting, good (and
+hard) kata. Try implementing it and see for yourself.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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`, git tag for
+the version, push git commits and tags. Travis CI then runs the tests and when
+passed automatically pushes the new gem to
+[rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/tree_outline/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+# remove release task
+Rake::Task["release"].clear
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  puts 'rspec tasks could not be loaded'
+end

data/bin/console

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

data/bin/setup

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

data/lib/tree_outline/version.rb

@@ -0,0 +1,3 @@
+class TreeOutline
+  VERSION = "0.1.0"
+end

data/lib/tree_outline.rb

@@ -0,0 +1,69 @@
+require 'tree_outline/version'
+
+class TreeOutline
+  DEFAULT = '├── '
+  LINE    = '│   '
+  SINGLE  = '└── '
+  EMPTY   = '    '
+
+  def initialize(tree)
+    @tree = tree
+    @label_method = :to_s
+    @children_method = :children
+  end
+
+  def label_method(method_symbol)
+    @label_method = method_symbol
+    self
+  end
+
+  def children_method(method_symbol)
+    @children_method = method_symbol
+    self
+  end
+
+  def to_s
+    build_lines(@tree).join("\n")
+  end
+
+  private
+
+  def build_lines(node)
+    return [node_label(node)] if node_children(node).empty?
+    result = node_children(node).map do |c|
+      build_lines(c)
+    end
+    result = [node_label(node)] + last_map(result,
+      ->(block){
+        first_map(block, ->(line){ DEFAULT+line }, ->(line){ LINE+line })
+      },
+      ->(block){
+        first_map(block, ->(line){ SINGLE+line }, ->(line){ EMPTY+line })
+      }
+    ).flatten(1)
+  end
+
+  def first_map(enumerable, first, other)
+    result = [first.call(enumerable.first)]
+    result += enumerable.drop(1).map do |e|
+      other.call(e)
+    end
+    result
+  end
+
+  def last_map(enumerable, other, last)
+    result = enumerable[0..-2].map do |e|
+      other.call(e)
+    end
+    result = result + [last.call(enumerable.last)]
+    result
+  end
+
+  def node_label(node)
+    node.public_send @label_method
+  end
+
+  def node_children(node)
+    node.public_send @children_method
+  end
+end

data/tree_outline.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tree_outline/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tree_outline"
+  spec.version       = TreeOutline::VERSION
+  spec.authors       = ["flower-pot"]
+  spec.email         = ["fbranczyk@gmail.com"]
+
+  spec.summary       = "Stringifying trees"
+  spec.description   = "Stringify trees in a fashion similar the output known from the unix tool 'tree'"
+  spec.homepage      = "https://github.com/flower-pot/tree_outline"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'codeclimate-test-reporter'
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: tree_outline
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- flower-pot
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-06-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Stringify trees in a fashion similar the output known from the unix tool
+  'tree'
+email:
+- fbranczyk@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/tree_outline.rb
+- lib/tree_outline/version.rb
+- tree_outline.gemspec
+homepage: https://github.com/flower-pot/tree_outline
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Stringifying trees
+test_files: []