filetree 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 05d761d32074272dc9b464dd7222f347cf100ded
-  data.tar.gz: 160b0350362fff8d14090e0fcdc0929e17dd39c7
+  metadata.gz: 83caa925feb3d507378725abfb1ce9d716bf8feb
+  data.tar.gz: 6a2fedebf430894e6060da4853f7ec51b6d81026
 SHA512:
-  metadata.gz: 17b1e705f4b8a2f81e7ba207a0fc3faf9e01d5e72b98d855032735aedafd4b1d0169b9a8eaf59d66250ea3002ad2d2f40e268a7cc748c1fb8913d69b24260ee0
-  data.tar.gz: e0e5c3435fd350d2fc608ef21b6cadaa47f7f0ec391cbc6f934d23bf0a4220e236305bad7633aa61d7eb8de301eb7895372f118a2a352c87012d9eee2a389f17
+  metadata.gz: cc66fe7961828d31cdc9886b775782d5286c1ba584d2bb06870ab296e6859c3d01f4a7f8488f1c517399a865dca794821674c99ef75d56ad26757e641f30220a
+  data.tar.gz: e4d5b096363991caa752d655a6e51d85fb03425fdc78697b33e3a6962c3b8ce3fe1b6c55f2254a0a9c457b945f476030bd402b4b568cca29e57d81f96a8373d8

data/README.md

@@ -2,12 +2,13 @@
 
 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
+
 ## Install
 
 install with: `gem install filetree`
 
-
-# Usage
+## Examples
 
 ```ruby
 
@@ -71,6 +72,10 @@ install with: `gem install filetree`
     # >>      |    \- #<FileTree:/home/user/test/test1/test2/testee/test3/no>
 
 ```
+# Documentation
+
+View the [docs](http://rubydoc.info/gems/filetree).
+
 # Credits
 
 All credit belongs to the following persons, I just cobbled this together from their work:

data/examples/simple_filetree.rb

@@ -39,7 +39,7 @@ des_arr = tree.descendants.map { |e| FileTree.new(e.relative_path_from(FileTree.
 des_arr.first
 # => #<FileTree:test/test1/test2/testee>
 
-des_arr.last.ancestors # infinite loop. "ancestors" depends on hitting "/" to stop.
+# 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

data/filetree.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'filetree'
-  s.version     = '0.0.2'
+  s.version     = '0.0.3'
   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."

data/lib/filetree.rb

@@ -23,14 +23,20 @@ class FileTree < Pathname
     @identifier ||= self.inspect
   end
 
-  # See Pathname#parent
-
+  #
+  # See {http://rubydoc.info/stdlib/pathname/Pathname:parent Pathname.parent}
+  #
+  # @return [FileTree] The directory immediately above self.
+  #
   def parent
     FileTree.new(_parent)
   end
 
-  # See Pathname#children
-
+  #
+  # See {http://rubydoc.info/stdlib/pathname/Pathname:children Pathname.children}
+  #
+  # @return [Array] an Array of all entries contained in self.
+  #
   def children(*args)
     if self.directory?
       _children(*args)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: filetree
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Eric West
@@ -51,3 +51,4 @@ signing_key:
 specification_version: 4
 summary: A simple ruby library for manipulating filepaths as tree structures
 test_files: []
+has_rdoc: