arbolobra 0.3.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0a7d8757dacdbea1f3bd516605a4fa635b3761dc
-  data.tar.gz: f30750650c66f8d727a2232e8ac907efe903ab7c
+  metadata.gz: 18869c79acefcad19ab23b03fb60631b791a6c0c
+  data.tar.gz: 8300a503605354e94d6ff232b869bc37553caa0f
 SHA512:
-  metadata.gz: d09963fc27a25a29662a4477b7fe524013e64b6bb13aa3474f47ef286f3f200d5bbbb987d10c36a966b81a288def7166faa5762e38194572d6d7c80260f72536
-  data.tar.gz: f4ff880e0e3f04557033d7896b5f311de51ed0357ee264f5ace9857519330903529476c15b02791a5fb11154343b07e0837482eeee69d3f41f08a08cb2b792d9
+  metadata.gz: 806746df05318376da007008cb30c3afc60a7354a302f1a7cf7e5d86a28aea6e515b21f49cc0a8addf5742120dcaeb13eca95358824510439b5605a772269709
+  data.tar.gz: cfebe7bf871c8e0e95b664beee6247125f4d52bcc4444e9d6dc0faa75778f92fb581936bf07a043797e1b7f88b101f5619e2070de2b3e792aa673815e72a0d01

data/README.md

@@ -1,10 +1,10 @@
 # Arbolobra
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up
-your Ruby library into a gem. Put your Ruby code in the file `lib/arbolobra`. To experiment with
-that code, run `bin/console` for an interactive prompt.
+Arbolobra is for reading and writing a hierarchical set of data, i.e., a tree. ("Arbol" is Spanish
+for "tree", so the palindrome "arbolobra" means a tree, backward and forward.)
 
-TODO: Delete this and the text above, and describe your gem
+Arbolobra makes it simple to take a flat set of data (such as a list of files of the form
+/path/to/filename) and write that as a tree, and the inverse.
 
 ## Installation
 
@@ -26,9 +26,14 @@ Or install it yourself as:
 
 Arbolobra is for reading and writing a hierarchical set of data, i.e., a tree.
 
-For example, a simple viewer of files and directories, as a tree:
+### Generating from Data
+
+For example, a simple viewer (a rough equivalent of "find") of files and directories, as a tree:
 
 ```ruby
+require 'arbolobra/node'
+require 'pathname'
+
 def build pn
   children = pn.directory? ? pn.children.sort : Array.new
   Arbolobra::Node.new pn.basename, children.collect { |child| build child }
@@ -39,49 +44,90 @@ args = ARGV.empty? ? %w{ . } : ARGV
 args.each do |arg|
   pn = Pathname.new arg
   node = build pn
-
   node.print
 end
 ```
 
-And to change output, such as from a list of files, from flat to hierarchical:
+The output of running the above in the Arbolobra project for the arguments [ "lib", "test" ]:
+
+```text
+lib
++---arbolobra
+|   +---chars.rb
+|   +---node.rb
+|   +---tree.rb
+|   \---version.rb
+\---arbolobra.rb
+test
++---arbolobra
+|   +---chars_test.rb
+|   +---node_test.rb
+|   \---tree_test.rb
++---arbolobra_test.rb
+\---test_helper.rb
+```
+
+### Generating from Strings (Lines)
+
+To convert strings, such as from a list of files, from flat to hierarchical:
 
 ```ruby
+require 'arbolobra/tree
+
 tree = Arbolobra::Tree.new $stdin.readlines, "/"
 tree.root.print
 ```
 
+In raw form:
+
 ```shell
-% git diff-index --name-only --no-commit-id <commit> | <above script>
+% git diff-index --name-only --no-commit-id  c2ef
 ```
 
+The output:
+
 ```text
+README.md
+arbolobra.gemspec
+lib/arbolobra/chars.rb
+lib/arbolobra/formatter.rb
+lib/arbolobra/node.rb
+lib/arbolobra/tree.rb
+test/arbolobra/chars_test.rb
+test/arbolobra/formatter_test.rb
+test/arbolobra/node_test.rb
+test/arbolobra/tc.rb
+test/arbolobra/tree_test.rb
+```
+
+Using the above script, converting Git output to a tree:
+
+```shell
+% git diff-index --name-only --no-commit-id c2ef | 
+  ruby -I lib -rarbolobra/tree -e 'tree = Arbolobra::Tree.new $stdin.readlines, "/"; tree.root.print'
+```
 
-+---.gitignore
+Output:
+
+```text
+.
 +---README.md
++---arbolobra.gemspec
 +---lib
 |   \---arbolobra
 |       +---chars.rb
+|       +---formatter.rb
 |       +---node.rb
 |       \---tree.rb
 \---test
     \---arbolobra
         +---chars_test.rb
+        +---formatter_test.rb
         +---node_test.rb
+        +---tc.rb
         \---tree_test.rb
 ```
 
-## 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/jpace/arbolobra.

data/arbolobra.gemspec

@@ -30,9 +30,9 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "test-unit", "~> 3.1"
+  spec.add_development_dependency "test-unit", "~> 3.1.5"
   spec.add_development_dependency "paramesan", "~> 0.1.1"
   spec.add_development_dependency "logue", "~> 1.0"
 end

data/lib/arbolobra/chars.rb

@@ -25,7 +25,6 @@ end
 # x   +---arbolobra_test.rb
 # x   \---test_helper.rb
 
-
 # this is the "intro" (i) and the "lead" (l):
 # <iiiiii><ll>
 # x   |   +---node_test.rb
@@ -60,7 +59,7 @@ class Arbolobra::CharList
   end
 
   def expand is_last
-    leftchr = @chars[is_last ? 0 : 1]
+    leftchr   = @chars[is_last ? 0 : 1]
     repeatchr = @chars[2]
     leftchr + repeatchr * (@width - 1)
   end
@@ -75,7 +74,7 @@ class Arbolobra::CharSet
   
   def initialize intro, lead
     @intro = intro
-    @lead = lead
+    @lead  = lead
   end
 
   DEFAULT = new Arbolobra::CharList::DEFAULT_INTRO, Arbolobra::CharList::DEFAULT_LEAD

data/lib/arbolobra/formatter.rb

@@ -0,0 +1,28 @@
+#!/usr/bin/ruby -w
+# -*- ruby -*-
+
+require 'arbolobra/chars'
+
+module Arbolobra
+end
+
+class Arbolobra::Formatter
+  def initialize charset: Arbolobra::CharSet::DEFAULT, output: $stdout
+    @charset = charset
+    @output = output
+  end
+  
+  def print node, intro = "", lead = ""
+    @output.print lead, node.value.to_s, "\n"
+    children = node.children
+    children.each_with_index do |child, idx|
+      print_child child, intro, idx == children.size - 1
+    end
+  end
+
+  def print_child child, intro, is_last
+    nextintro = intro + @charset.intro.expand(is_last)
+    nextlead  = intro + @charset.lead.expand(is_last)
+    print child, nextintro, nextlead
+  end
+end

data/lib/arbolobra/node.rb

@@ -2,40 +2,39 @@
 # -*- ruby -*-
 
 require 'arbolobra/chars'
+require 'arbolobra/formatter'
 
 module Arbolobra
-end
-
-class Arbolobra::Node
-  include Comparable
-  
-  attr_reader :value
-  attr_reader :children
-  
-  def initialize value, children = Array.new
-    @value = value
-    @children = children
-  end
-
-  def print intro: "", lead: "", output: $stdout, chars: Arbolobra::CharSet::DEFAULT
-    output.print lead, @value.to_s, "\n"
-    childargs = { intro: intro, output: output, chars: chars }
-    @children.each_with_index do |child, idx|
-      print_child child, childargs.merge({ is_last: idx == @children.size - 1 })
+  class Node
+    include Comparable
+    
+    attr_reader :value
+    attr_reader :children
+    
+    def initialize value, *children
+      @children = if children.size == 1 && children.first.class == Array
+                    children.first
+                  else
+                    children
+                  end
+      @value = value
     end
-  end
 
-  def print_child child, intro: "", is_last: false, output: $stdout, chars: Arbolobra::CharSet::DEFAULT
-    nextintro = intro + chars.intro.expand(is_last)
-    nextlead  = intro + chars.lead.expand(is_last)
-    child.print intro: nextintro, lead: nextlead, output: output, chars: chars
-  end
+    def print intro: "", lead: "", output: $stdout, charset: Arbolobra::CharSet::DEFAULT
+      fmt = Formatter.new charset: charset, output: output
+      fmt.print self, intro, lead
+    end
 
-  def to_s
-    @value
-  end
+    def to_s
+      "value: #{@value}, #{@children && @children.size}"
+    end
 
-  def <=> other
-    value <=> other.value && children <=> other.children
+    def <=> other
+      cmp = value <=> other.value
+      if cmp == 0
+        cmp = children <=> other.children
+      end
+      cmp
+    end
   end
 end

data/lib/arbolobra/tree.rb

@@ -3,20 +3,18 @@
 
 require 'arbolobra/node'
 
-module Arbolobra
-end
-
 class Arbolobra::Tree
   attr_reader :root
   attr_reader :nodes
   
-  def initialize lines, separator
-    raise "lines argument requires a separator" unless separator
-    @root = Arbolobra::Node.new nil
-    
-    lines.each do |line|
-      elements = line.chomp.split separator
-      create_nodes elements
+  def initialize lines, separator = "/"
+    if lines
+      @root = Arbolobra::Node.new "."
+      
+      lines.each do |line|
+        elements = line.chomp.split separator
+        create_nodes elements
+      end
     end
   end
 

data/lib/arbolobra/version.rb

@@ -1,3 +1,3 @@
 module Arbolobra
-  VERSION = "0.3.0"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: arbolobra
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Jeff Pace
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-17 00:00:00.000000000 Z
+date: 2020-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: 3.1.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: 3.1.5
 - !ruby/object:Gem::Dependency
   name: paramesan
   requirement: !ruby/object:Gem::Requirement
@@ -99,6 +99,7 @@ files:
 - bin/setup
 - lib/arbolobra.rb
 - lib/arbolobra/chars.rb
+- lib/arbolobra/formatter.rb
 - lib/arbolobra/node.rb
 - lib/arbolobra/tree.rb
 - lib/arbolobra/version.rb