filetree 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e67c14781dc6c85ee01ba2c8168a532ea063d29b
+  data.tar.gz: f3a115c9f24ff821d792ead2377ebeb6b6e2ef59
+SHA512:
+  metadata.gz: 1206d7e6234e526823b53d1e795afc2960a56932d81a543aad0d6e4bf3d81347b4d94dc37a70f2cd70cd91f4f554d44831f23c2efe6109c13619a160b1d49846
+  data.tar.gz: 60b2c4ffbe9e9af4f027c8c5e70eb320baabe8065d932bb5e561aa693f0c8e5967a00856f4f036e2584bf9c78046c4c4fa9c4aefc2a9b7af2d5ca70a10f0fd03

data/LICENSE

@@ -0,0 +1,10 @@
+Copyright (c) 2013, Eric S. West
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+    * The name of Eric S. West may not be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,78 @@
+# FileTree
+
+A simple tree structure for working with FilePath objects in ruby. I simply took the simple_tree module from https://github.com/ealdent/simple-tree and hacked it into [Pathname](http://www.ruby-doc.org/stdlib-2.0/libdoc/pathname/rdoc/Pathname.html) from the std-lib. This means you get all the awesome features of working with Pathname, as well as making it easy to examine a filepath's ancestors and descendants.
+
+# Usage
+
+```ruby
+
+    require "filetree"
+
+    tree = FileTree.new('/home/user/test/test1/test2')
+    # => #<FileTree:/home/user/test/test1/test2>
+
+    tree.parent
+    # => #<FileTree:/home/user/test/test1>
+
+    tree.ancestors
+    # => [#<FileTree:/home/user/test>,
+    #     #<FileTree:/home/user>,
+    #     #<FileTree:/home>,
+    #     #<FileTree:/>]
+
+    tree.descendants
+    # => [#<FileTree:/home/user/test/test1/test2/testee>,
+    #     #<FileTree:/home/user/test/test1/test2/testee/testeggg>,
+    #     #<FileTree:/home/user/test/test1/test2/testee/testeggg/test4>,
+    #     #<FileTree:/home/user/test/test1/test2/testee/testeggg/test4/myfile.txt>,
+    #     #<FileTree:/home/user/test/test1/test2/testee/testeggg/test3>,
+    #     #<FileTree:/home/user/test/test1/test2/testee/testeggg/test3/no>,
+    #     #<FileTree:/home/user/test/test1/test2/testee/test4>,
+    #     #<FileTree:/home/user/test/test1/test2/testee/test4/myfile.txt>,
+    #     #<FileTree:/home/user/test/test1/test2/testee/test3>,
+    #     #<FileTree:/home/user/test/test1/test2/testee/test3/no>]
+
+    des_arr = tree.descendants.map { |e| FileTree.new(e.relative_path_from(FileTree.new('/home/user'))) }
+    # => [#<FileTree:test/test1/test2/testee>,
+    #     #<FileTree:test/test1/test2/testee/testeggg>,
+    #     #<FileTree:test/test1/test2/testee/testeggg/test4>,
+    #     #<FileTree:test/test1/test2/testee/testeggg/test4/myfile.txt>,
+    #     #<FileTree:test/test1/test2/testee/testeggg/test3>,
+    #     #<FileTree:test/test1/test2/testee/testeggg/test3/no>,
+    #     #<FileTree:test/test1/test2/testee/test4>,
+    #     #<FileTree:test/test1/test2/testee/test4/myfile.txt>,
+    #     #<FileTree:test/test1/test2/testee/test3>,
+    #     #<FileTree:test/test1/test2/testee/test3/no>]
+
+    des_arr.first
+    # => #<FileTree:test/test1/test2/testee>
+
+    des_arr.last.ancestors # infinite loop. "ancestors" depends on hitting "/" to stop.
+
+    # the "tree_rep" method provides prettyprinting for creating your own to_s methods
+    puts tree.tree_rep
+    # => nil
+
+    # >> #<FileTree:/home/user/test/test1/test2>
+    # >>  \- #<FileTree:/home/user/test/test1/test2/testee>
+    # >>      \- #<FileTree:/home/user/test/test1/test2/testee/testeggg>
+    # >>      |    \- #<FileTree:/home/user/test/test1/test2/testee/testeggg/test4>
+    # >>      |    |    \- #<FileTree:/home/user/test/test1/test2/testee/testeggg/test4/myfile.txt>
+    # >>      |    \- #<FileTree:/home/user/test/test1/test2/testee/testeggg/test3>
+    # >>      |    |    \- #<FileTree:/home/user/test/test1/test2/testee/testeggg/test3/no>
+    # >>      \- #<FileTree:/home/user/test/test1/test2/testee/test4>
+    # >>      |    \- #<FileTree:/home/user/test/test1/test2/testee/test4/myfile.txt>
+    # >>      \- #<FileTree:/home/user/test/test1/test2/testee/test3>
+    # >>      |    \- #<FileTree:/home/user/test/test1/test2/testee/test3/no>
+
+```
+# Credits
+
+All credit belongs to the following persons, I just cobbled this together from their work:
+
+- [@ealdent](https://github.com/ealdent/simple-tree)
+- The authors and maintainers of [Pathname](http://www.ruby-doc.org/stdlib-2.0/libdoc/pathname/rdoc/Pathname.html)
+
+# License
+
+Distributed under the BSD license, please see [LICENSE](https://github.com/edubkendo/FileTree/blob/master/LICENSE) for more information.

data/examples/simple_filetree.rb

@@ -0,0 +1,58 @@
+require "filetree"
+
+tree = FileTree.new('/home/user/test/test1/test2')
+# => #<FileTree:/home/user/test/test1/test2>
+
+tree.parent
+# => #<FileTree:/home/user/test/test1>
+
+tree.ancestors
+# => [#<FileTree:/home/user/test>,
+#     #<FileTree:/home/user>,
+#     #<FileTree:/home>,
+#     #<FileTree:/>]
+
+tree.descendants
+# => [#<FileTree:/home/user/test/test1/test2/testee>,
+#     #<FileTree:/home/user/test/test1/test2/testee/testeggg>,
+#     #<FileTree:/home/user/test/test1/test2/testee/testeggg/test4>,
+#     #<FileTree:/home/user/test/test1/test2/testee/testeggg/test4/myfile.txt>,
+#     #<FileTree:/home/user/test/test1/test2/testee/testeggg/test3>,
+#     #<FileTree:/home/user/test/test1/test2/testee/testeggg/test3/no>,
+#     #<FileTree:/home/user/test/test1/test2/testee/test4>,
+#     #<FileTree:/home/user/test/test1/test2/testee/test4/myfile.txt>,
+#     #<FileTree:/home/user/test/test1/test2/testee/test3>,
+#     #<FileTree:/home/user/test/test1/test2/testee/test3/no>]
+
+des_arr = tree.descendants.map { |e| FileTree.new(e.relative_path_from(FileTree.new('/home/user'))) }
+# => [#<FileTree:test/test1/test2/testee>,
+#     #<FileTree:test/test1/test2/testee/testeggg>,
+#     #<FileTree:test/test1/test2/testee/testeggg/test4>,
+#     #<FileTree:test/test1/test2/testee/testeggg/test4/myfile.txt>,
+#     #<FileTree:test/test1/test2/testee/testeggg/test3>,
+#     #<FileTree:test/test1/test2/testee/testeggg/test3/no>,
+#     #<FileTree:test/test1/test2/testee/test4>,
+#     #<FileTree:test/test1/test2/testee/test4/myfile.txt>,
+#     #<FileTree:test/test1/test2/testee/test3>,
+#     #<FileTree:test/test1/test2/testee/test3/no>]
+
+des_arr.first
+# => #<FileTree:test/test1/test2/testee>
+
+des_arr.last.ancestors # infinite loop. "ancestors" depends on hitting "/" to stop.
+
+# the "tree_rep" method provides prettyprinting for creating your own to_s methods
+puts tree.tree_rep
+# => nil
+
+# >> #<FileTree:/home/user/test/test1/test2>
+# >>  \- #<FileTree:/home/user/test/test1/test2/testee>
+# >>      \- #<FileTree:/home/user/test/test1/test2/testee/testeggg>
+# >>      |    \- #<FileTree:/home/user/test/test1/test2/testee/testeggg/test4>
+# >>      |    |    \- #<FileTree:/home/user/test/test1/test2/testee/testeggg/test4/myfile.txt>
+# >>      |    \- #<FileTree:/home/user/test/test1/test2/testee/testeggg/test3>
+# >>      |    |    \- #<FileTree:/home/user/test/test1/test2/testee/testeggg/test3/no>
+# >>      \- #<FileTree:/home/user/test/test1/test2/testee/test4>
+# >>      |    \- #<FileTree:/home/user/test/test1/test2/testee/test4/myfile.txt>
+# >>      \- #<FileTree:/home/user/test/test1/test2/testee/test3>
+# >>      |    \- #<FileTree:/home/user/test/test1/test2/testee/test3/no>

data/filetree.gemspec

@@ -0,0 +1,19 @@
+Gem::Specification.new do |s|
+  s.name        = 'filetree'
+  s.version     = '0.0.1'
+  s.date        = '2013-05-27'
+  s.summary     = "A simple ruby library for manipulating filepaths as tree structures"
+  s.description = "A simple tree structure for working with FilePath objects in ruby. I simply took the simple_tree module from https://github.com/ealdent/simple-tree and hacked it into [Pathname](http://www.ruby-doc.org/stdlib-2.0/libdoc/pathname/rdoc/Pathname.html) from the std-lib. This means you get all the awesome features of working with Pathname, as well as making it easy to examine a filepath's ancestors and descendants."
+  s.authors     = ["Eric West"]
+  s.email       = 'nick@quaran.to'
+  s.files       = ["lib/filetree.rb",
+                    "lib/filetree/simple_tree.rb",
+                    "LICENSE",
+                    "README.md",
+                    "examples/simple_filetree.rb",
+                    "filetree.gemspec"
+                  ]
+  s.licenses = ["BSD"]
+  s.homepage    =
+    'https://github.com/edubkendo/FileTree'
+end

data/lib/filetree.rb

@@ -0,0 +1,42 @@
+require "pathname"
+require "filetree/simple_tree"
+
+class Pathname
+  alias :_parent :parent
+  alias :_children :children
+end
+
+class FileTree < Pathname
+  include SimpleTree
+
+  attr_accessor :name, :id, :identifier
+
+  def name
+    @name ||= self.inspect
+  end
+
+  def id
+    @id ||= self.inspect
+  end
+
+  def identifier
+    @identifier ||= self.inspect
+  end
+
+  # See #Pathname.parent
+
+  def parent
+    FileTree.new(_parent)
+  end
+
+  #See #Pathname.children
+
+  def children(*args)
+    if self.directory?
+      _children(*args)
+    else
+      []
+    end
+  end
+
+end

data/lib/filetree/simple_tree.rb

@@ -0,0 +1,185 @@
+#
+# Ruby Tree Interface by Jason M. Adams.  Distributed under the BSD license:
+# Copyright (c) 2008, Jason M. Adams
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+#
+#     * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+#     * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+#     * The name of Jason M. Adams may not be used to endorse or promote products derived from this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#
+# To use this interface, drop it in your current class with +include+.
+# You must then simply implement the +parent+ and +children+ methods.
+#  * +parent+ returns the parent node of the current node or else nil if it's a root
+#  * +children+ returns an +Array+ of all children of this node or an empty +Array+ if it is a leaf node
+#
+module SimpleTree
+  def parent() raise "parent must be overridden"; end
+  def children() raise "children must be overridden"; end
+
+
+  #
+  # Return whether this node is a leaf node in the hierarchy.
+  #
+  def is_leaf?
+    if children.size == 0
+      true
+    else
+      false
+    end
+  end
+
+
+  #
+  # Determine whether this is the root node in the hierarchy.
+  #
+  def is_root?
+    if parent
+      false
+    else
+      true
+    end
+  end
+
+
+  #
+  # Determine whether the node has a parent.
+  #
+  def has_parent?
+    not is_root?
+  end
+
+
+  #
+  # Determine whether the node has children.
+  #
+  def has_children?
+    not is_leaf?
+  end
+
+
+  #
+  # Return the height of this subtree.  A single node has height 1.
+  #
+  def height
+    heights = children.map {|child| child.height}
+    return 1 if heights.size == 0
+    return heights.max + 1
+  end
+
+
+  #
+  # Return an array containing the siblings of the current node.
+  #
+  def siblings
+    # handle case where this is the root node
+    return Array.new unless parent
+
+    sibs = Array.new
+    parent.children.each do |child|
+      next if child.id == self.id
+      sibs << child
+    end
+
+    sibs
+  end
+
+
+  #
+  # Return every node descending from this node's parent (except this node).
+  # This include all of the node's descendants.
+  #
+  def family
+    if parent
+      fam = [parent] + parent.descendants
+    else
+      fam = descendants
+    end
+
+    fam.delete(self)
+    fam
+  end
+
+  #
+  # Return an array containing every ancestor of the current node.
+  #
+  def ancestors
+    d = Array.new
+    current = self.parent()
+
+    until d.include?(current.parent)
+      current = current.parent
+      d << current
+    end
+
+    d.flatten
+  end
+
+  #
+  # Return an array containing every descendant of the current node.
+  #
+  def descendants
+    d = Array.new
+
+    children.each do |child|
+      d << child
+      d << child.descendants
+    end
+
+    d.flatten
+  end
+
+
+  #
+  # Return the grandparent of this node.
+  #
+  def grandparent
+    parent.parent if parent     # returns nil by default if no parent
+  end
+
+
+  #
+  # Return all the leaf nodes having the current node as an ancestor.
+  #
+  def leaves
+    outp = Array.new
+    children.each do |child|
+      if child.is_leaf?
+        outp << child
+      else
+        outp << child.leaves
+      end
+    end
+
+    outp.flatten
+  end
+
+
+  #
+  # Helper method for to_s, returns a tree representation of the subtree
+  # rooted at this node.  This assumes some sort of identifier is specified
+  # for the object being called (self.name, self.identifier, etc)
+  #
+  def tree_rep(depth=0)
+    if self.name
+      ident = self.name
+    elsif self.identifier
+      ident = self.identifier
+    else
+      ident = self.object_id
+    end
+    if depth > 0
+      outp = " #{(["    "] * (depth - 1)).join("|")}\\- #{ident}\n"
+    else
+      outp = "#{ident}\n"
+    end
+    children.each do |child|
+      outp += child.tree_rep(depth + 1)
+    end
+    outp
+  end
+
+end

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: filetree
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Eric West
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-27 00:00:00.000000000 Z
+dependencies: []
+description: A simple tree structure for working with FilePath objects in ruby. I
+  simply took the simple_tree module from https://github.com/ealdent/simple-tree and
+  hacked it into [Pathname](http://www.ruby-doc.org/stdlib-2.0/libdoc/pathname/rdoc/Pathname.html)
+  from the std-lib. This means you get all the awesome features of working with Pathname,
+  as well as making it easy to examine a filepath's ancestors and descendants.
+email: nick@quaran.to
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/filetree.rb
+- lib/filetree/simple_tree.rb
+- LICENSE
+- README.md
+- examples/simple_filetree.rb
+- filetree.gemspec
+homepage: https://github.com/edubkendo/FileTree
+licenses:
+- BSD
+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.0.0.rc.2
+signing_key: 
+specification_version: 4
+summary: A simple ruby library for manipulating filepaths as tree structures
+test_files: []