spacetree 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e1ec12ace1a11f7639558f401ffb4c2169978ae0
+  data.tar.gz: 0281ff038ee6bed1dd0f1e6349aa196905d8b71d
+SHA512:
+  metadata.gz: 34f9c9a26e16ca0113c6069968af7ef1373bc1c6d2e7154fe1374a4b652a30551c5f519428f1dd081602ed1f59fb96e631f4a646cc262341d07b2f4cddeb163c
+  data.tar.gz: a795c3716be4b02facd945fcee59c7802cf4aa09ebf1a6f6379649554429eac4c3b56a3b3bf71108c4472fbab63d97515896ced02a389066a46b5a36fd082e78

data/Changelog

@@ -0,0 +1,2 @@
+1.0.0
+First release.

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2016 Jan Friedrich
+
+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,39 @@
+spacetree
+=========
+
+A Ruby library to generate a tree structure from a text file indented by spaces.
+
+Example
+-------
+
+Given a text file tree.txt
+
+    foo
+      bar
+      baz
+
+Parsing it:
+
+    require 'spacetree'
+    parser = Spacetree::Parser.new
+    tree = parser.parse File.read('tree.txt')
+    p tree.value # => "foo"
+    p tree.map(&:value) # => ["bar", "baz"]
+
+Emitting a tree as indented text:
+
+    puts tree.emit
+
+or simple
+
+    puts tree
+  
+Author
+------
+
+Jan Friedrich <janfri26@gmail.com>
+
+License
+-------
+
+MIT license see file LICENSE.

data/Rakefile

@@ -0,0 +1,13 @@
+require 'rim/tire'
+require 'rim/version'
+require_relative 'lib/spacetree'
+
+Rim.setup do
+  name 'spacetree'
+  authors 'Jan Friedrich'
+  email 'janfri26@gmail.com'
+  license 'MIT'
+  summary 'Generate a tree structure from a text file indented by spaces.'
+  version Spacetree::VERSION
+end
+

data/lib/spacetree.rb

@@ -0,0 +1,22 @@
+# -- encoding: utf-8 --
+# Generate a tree structure from a text file indented by spaces.
+module Spacetree
+
+  VERSION = '1.0.0'
+
+  autoload :Node, 'spacetree/node'
+  autoload :Parser, 'spacetree/parser'
+
+  # Do parsing @see Parser#parse
+  def self.parse s, &blk
+    Parser.new.parse s, &blk
+  end
+
+  # Generate a formatted string representation of a node and its children
+  # recursively
+  # @see Node#emit
+  def self.emit node
+    node.emit
+  end
+
+end

data/lib/spacetree/node.rb

@@ -0,0 +1,59 @@
+# -- encoding: utf-8 --
+module Spacetree
+
+  # Represent a node respectively a tree
+  class Node
+
+    include Enumerable
+
+    attr_accessor :value, :children
+
+    # @param value value of the node
+    # @children array of nodes wich represent the children of this node
+    def initialize value=nil, *children
+      @value = value
+      @children = children
+    end
+
+    def == o
+      return false unless o.kind_of? Node
+      [self.value, self.children] == [o.value, o.children]
+    end
+
+    def each *args, &blk
+      enum = Enumerator.new do |y|
+        y << self
+        children.each do |c|
+          c.each *args, &blk
+        end
+      end
+      if block_given?
+        enum.each *args, &blk
+      else
+        enum
+      end
+    end
+
+    # Generate a formatted string representation of a node and its children
+    # recursively
+    # @param indent Count of spaces to indent a level deeper
+    # @param level level of indentation
+    def emit indent: 2, level: 0
+      res = []
+      if value.nil?
+        children.each {|c| res << c.emit(indent: indent, level: level)}
+      else
+        spaces = ' ' * indent * level
+        res << (spaces << value.to_s)
+        children.each {|c| res << c.emit(indent: indent, level: level+1)}
+      end
+      res.join("\n")
+    end
+
+    def to_s
+      emit
+    end
+
+  end
+
+end

data/lib/spacetree/parser.rb

@@ -0,0 +1,44 @@
+# -- encoding: utf-8 --
+module Spacetree
+
+  # Parser to parse a text file indented by spaces to a tree structure
+  class Parser
+
+    # Do parsing
+    # @s String to parse
+    # @blk if block given each line without the starting spaces is yielded
+    def parse s, &blk
+      root = Node.new
+      @indent_map = {-1 => root}
+      s.chomp.split(/\n/).each do |line|
+        generate_node line, &blk
+      end
+      root
+    end
+
+    protected
+
+    def generate_node line
+      if line =~ /(^ *)([^ ].*)$/
+        indent = $1.size
+        line = $2
+        line = yield line if block_given?
+        parent = search_parent_node indent
+        new_node = Node.new line
+        @indent_map[indent] = new_node
+        parent.children << new_node
+      end
+    end
+
+    def search_parent_node indent
+      fail ArgumentError if indent < 0
+      (indent - 1).downto(-1).each do |i|
+        res = @indent_map[i]
+        return res if res
+      end
+      fail ArgumentError
+    end
+
+  end
+
+end

data/test/helper.rb

@@ -0,0 +1,13 @@
+# -- encoding: utf-8 --
+require 'minitest/autorun'
+require 'spacetree'
+
+module Helper
+
+  protected
+
+  def n *args
+    Spacetree::Node.new *args
+  end
+
+end

data/test/test_node.rb

@@ -0,0 +1,58 @@
+# -- encoding: utf-8 --
+require_relative 'helper'
+
+class TestNode < Minitest::Test
+
+  include Helper
+
+  FOO_BAR_BAZ_TREE_STRING = <<~END.chomp
+    foo1
+      foo2
+        foo3
+    bar1
+      bar2
+        bar3
+    baz1
+      baz2
+        baz3
+  END
+
+  def test_enumerable
+    arr = [nil, 'foo1', 'foo2', 'foo3', 'bar1', 'bar2', 'bar3', 'baz1', 'baz2', 'baz3']
+    res = foo_bar_baz_tree.map &:value
+    assert_equal arr, res
+  end
+
+  def test_emit_one_node
+    assert_equal '', n(nil).emit
+    assert_equal 'foo', n('foo').emit
+    assert_equal '  foo', n('foo').emit(level: 1)
+    assert_equal '    foo', n('foo').emit(level: 2)
+    assert_equal '   foo', n('foo').emit(indent: 3, level: 1)
+    assert_equal '      foo', n('foo').emit(indent: 3, level: 2)
+  end
+
+  def test_complex_emit
+    assert_equal FOO_BAR_BAZ_TREE_STRING, foo_bar_baz_tree.emit
+  end
+
+  def test_emit_argumenterror_for_negative_arguments
+    assert_raises ArgumentError do
+      n('foo').emit(indent: -1)
+    end
+    assert_raises ArgumentError do
+      n('foo').emit(level: -1)
+    end
+  end
+
+  def test_to_s
+    assert_equal FOO_BAR_BAZ_TREE_STRING, foo_bar_baz_tree.emit
+  end
+
+  protected
+
+  def foo_bar_baz_tree
+    n(nil, n('foo1', n('foo2', n('foo3'))), n('bar1', n('bar2', n('bar3'))), n('baz1', n('baz2', n('baz3'))))
+  end
+
+end

data/test/test_parser.rb

@@ -0,0 +1,78 @@
+# -- encoding: utf-8 --
+require_relative 'helper'
+
+class TestParser < Minitest::Test
+
+  include Helper
+  include Spacetree
+
+  def setup
+    @parser = Parser.new
+  end
+
+  def test_empty_string
+    assert_equal n, @parser.parse('')
+  end
+
+  def test_one_node
+    assert_equal n(nil, n('foo')), @parser.parse('foo')
+  end
+
+  def test_more_nodes
+    tree = n(nil, n('foo'), n('bar'), n('baz'))
+    s = <<~END
+      foo
+      bar
+      baz
+    END
+    assert_equal tree, @parser.parse(s)
+  end
+
+  def test_simple_indentation
+    tree = n(nil, n('foo', n('bar')))
+    s = <<~END
+      foo
+        bar
+    END
+    assert_equal tree, @parser.parse(s)
+  end
+
+  def test_usual_indentation
+    tree = n(nil, n('foo1', n('foo2', n('foo3'))), n('bar1', n('bar2', n('bar3'))), n('baz1', n('baz2', n('baz3'))))
+    s = <<~END
+      foo1
+        foo2
+          foo3
+      bar1
+        bar2
+          bar3
+      baz1
+        baz2
+          baz3
+    END
+    assert_equal tree, @parser.parse(s)
+  end
+
+  def test_spaces_in_line
+    tree = n(nil, n('foo and bar', n('bar and baz', n('baz and foo'))))
+    s = <<~END
+      foo and bar
+        bar and baz
+          baz and foo
+    END
+    assert_equal tree, @parser.parse(s)
+  end
+
+  def test_converting_line
+    tree = n(nil, n(%i(foo bar)), n(%i(bar baz)))
+    s = <<~END
+      foo bar
+      bar baz
+    END
+    res = @parser.parse(s) do |line|
+      line.split.map &:to_sym
+    end
+    assert_equal tree, res
+  end
+
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: spacetree
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jan Friedrich
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rim
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+description: ''
+email: janfri26@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Changelog
+- LICENSE
+- README.md
+- Rakefile
+- lib/spacetree.rb
+- lib/spacetree/node.rb
+- lib/spacetree/parser.rb
+- test/helper.rb
+- test/test_node.rb
+- test/test_parser.rb
+homepage: 
+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.4
+signing_key: 
+specification_version: 4
+summary: Generate a tree structure from a text file indented by spaces.
+test_files: []
+has_rdoc: