epitools 0.5.1 → 0.5.2

data/lib/epitools/core_ext/truthiness.rb

@@ -0,0 +1,64 @@
+
+class Object
+  
+  #
+  # Default "integer?" behaviour.
+  #
+  def integer?; false; end
+   
+  #
+  # `truthy?` means `not blank?`
+  #
+  def truthy?
+    if respond_to? :blank?
+      not blank?
+    else
+      not nil?
+    end
+  end
+  
+end
+
+
+class TrueClass
+
+  def truthy?; true; end
+
+end
+
+
+class FalseClass
+
+  def truthy?; false; end
+
+end
+
+
+class Float
+
+  #
+  # 'true' if the float is 0.0
+  #
+  def blank?; self == 0.0; end
+
+end
+
+
+class NilClass
+
+  #
+  # Always 'true'; nil is considered blank.
+  #
+  def blank?; true; end
+
+end
+
+
+class Symbol
+
+  #
+  # Symbols are never blank.
+  #
+  def blank?; false; end
+
+end

data/lib/epitools/iter.rb

@@ -12,11 +12,16 @@ class Iter
   attr_accessor :container
 
   def initialize(vals)
-    @container = vals.map{|val| Elem.new(self, val)}
+    @container = vals.map { |val| elem(val) }
   end
   
+  # Wrap a value in an Elem container
+  def elem(val)
+    Elem.new(self, val)
+  end
+
   def self.from_elems(elems)
-    new([]).tap{|i| i.container = elems}
+    new([]).tap { |i| i.container = elems }
   end
 
   def ==(other)
@@ -31,12 +36,14 @@ class Iter
   def each
     @container.each do |elem|
       yield elem
+      elem.visited = true
     end
   end
   
   def each_cons(num=1)
     @container.each_cons(num) do |(*elems)|
       yield *elems 
+      elems.each { |e| e.visited = true }
     end
   end
   
@@ -59,11 +66,16 @@ class Iter
   
   class Elem < BasicObject
   
-    attr_accessor :val
-
+    attr_accessor :val, :visited
+    
     def initialize(iter, val)
       @iter = iter
-      @val  = val
+      @val  = val.is_a?(Elem) ? val.value : val
+      @visited = false
+    end
+    
+    def elem?
+      true
     end
     
     def ==(other)
@@ -78,6 +90,10 @@ class Iter
       self
     end
     
+    def visited?
+      @visited
+    end
+    
     def next
       p = pos+1
       if p >= container.size
@@ -143,7 +159,5 @@ class Iter
       "<Elem: #{@val.inspect}>"
     end
   end
-
   
-end
-
+end

data/lib/epitools/mimemagic.rb

@@ -16,7 +16,6 @@
 # Daniel Mendler
 #
 require 'epitools/mimemagic_tables'
-require 'stringio'
 
 # Mime type detection
 class MimeMagic

data/lib/epitools/path.rb

@@ -8,14 +8,13 @@
 require 'epitools'
 
 #
-# Path: An object-oriented wrapper for files.
-#       (Combines useful methods from FileUtils, File, Dir, and more!)
+# Path: An object-oriented wrapper for files. (Combines useful methods from FileUtils, File, Dir, and more!)
 #
 # Each Path object has the following attributes:
 #
 #    path            => the entire path
 #    filename        => just the name and extension
-#    basename        => just the filename
+#    basename        => just the filename (without extension)
 #    ext             => just the extension
 #    dir             => just the directory
 #    dirs            => an array of directories
@@ -33,25 +32,27 @@ require 'epitools'
 #     false
 #   end
 #    
-#
-# Examples:
+# More examples:
 #
 #   Path["*.jpeg"].each { |path| path.rename(:ext=>"jpg") }
-#
 #   Path["filename.txt"] << "Append data!"
-#
-#   entries = Path["/etc"].ls
-#
-#   Path
+#   etcfiles = Path["/etc"].ls
+#   Path["*.txt"].each(&:gzip)
 #
 # Swap two files:
 #
 #   a, b = Path["file_a", "file_b"]
-#   temp = a.with(:ext=>a.ext+".swapping")
+#   temp = a.with(:ext=>a.ext+".swapping") # return a modified version of this object
 #   a.mv(temp)
 #   b.mv(a)
 #   temp.mv(b)
-#   
+#
+# Paths can be created for existant and non-existant files. If you want to create a nonexistant
+# directory, just add a '/' at the end, so Path knows. (eg: Path["/etc/nonexistant/"]).
+#
+# Performance has been an important factor in Path's design, so doing crazy things with Path
+# usually doesn't kill your machine. Go nuts!
+#
 #
 class Path
   
@@ -170,8 +171,27 @@ class Path
       ""
     end
   end
+
+  #
+  # Path relative to current directory (Path.pwd)
+  #
+  def relative
+    relative_to(pwd)
+  end
+
+  def relative_to(to)
+    from = path.split(File::SEPARATOR)
+    to = Path[to].path.split(File::SEPARATOR)
+    p [from, to]
+    from.length.times do
+      break if from[0] != to[0]
+      from.shift; to.shift
+    end
+    fname = from.pop
+    join(*(from.map { RELATIVE_PARENTDIR } + to))
+  end
   
-  def relative_to(anchor=nil)
+  def relative_to2(anchor=nil)
     anchor ||= Path.pwd 
     
     # operations to transform anchor into self
@@ -231,15 +251,15 @@ class Path
   end
   
   def mtime
-    File.mtime path
+    lstat.mtime
   end
   
   def ctime
-    File.ctime path
+    lstat.ctime path
   end
   
   def atime
-    File.atime path
+    lstat.atime path
   end
   
   def dir?
@@ -258,6 +278,11 @@ class Path
     File.symlink?(path) and not File.exists?(path)
   end
   
+  def symlink_target
+    Path.new File.readlink(path) 
+  end
+  alias_method :readlink, :symlink_target
+  
   def uri?
     false
   end
@@ -322,7 +347,7 @@ class Path
   def read(length=nil, offset=nil)
     File.read(path, length, offset)
   end
-
+  
   #
   # All the lines in this file, chomped.
   #  
@@ -386,6 +411,79 @@ class Path
       end
     end    
   end
+
+  #
+  # Parse the file based on the file extension.
+  # (Handles json, html, yaml, marshal.)
+  #
+  def parse
+    case ext.downcase
+    when 'json'
+      read_json
+    when 'html', 'htm'
+      read_html
+    when 'xml', 'rdf', 'rss'
+      read_xml
+    when 'yaml', 'yml'
+      read_yaml
+    when 'marshal'
+      read_marshal
+    when 'bson'
+      read_bson
+    else
+      raise "Unrecognized format: #{ext}"
+    end
+  end
+
+  # Parse the file as JSON
+  def read_json
+    JSON.load(io)
+  end
+  
+  # Convert the object to JSON and write it to the file (overwriting the existing file).
+  def write_json(object)
+    write object.to_json
+  end
+
+
+  def read_html
+    Nokogiri::HTML(io)
+  end
+
+
+  # Convert the object to YAML and write it to the file (overwriting the existing file).
+  def write_yaml(object)
+    write object.to_yaml
+  end
+
+  # Parse the file as YAML
+  def read_yaml
+    YAML.load(io)
+  end
+
+
+  def read_xml
+    Nokogiri::XML(io)
+  end
+
+
+  def read_marshal
+    Marshal.load(io)
+  end
+
+  def write_marshal(object)
+    write object.marshal
+  end
+
+
+  def read_bson
+    BSON.deserialize(read)
+  end
+  
+  def write_bson(object)
+    write BSON.serialize(object)
+  end
+
   
   #
   # Examples:
@@ -514,6 +612,33 @@ raise "Broken!"
     end
   end
   
+  def lstat
+    @lstat ||= File.lstat self    # to cache or not to cache -- that is the question.
+    #File.lstat self
+  end
+  
+  def mode
+    lstat.mode
+  end
+
+  # TODO: Unstub
+  def owner?
+    raise "STUB"
+  end
+  
+  def executable?
+    mode & 0o111 > 0 
+  end
+  alias_method :exe?, :executable?
+  
+  def writable?
+    mode & 0o222 > 0
+  end
+
+  def readable?
+    mode & 0o444 > 0
+  end
+
   ## Dangerous methods.
   
   def rm
@@ -602,15 +727,6 @@ raise "Broken!"
     to_s =~ pattern
   end
 
-  def lstat
-    #@lstat ||= File.lstat self    # to cache or not to cache -- that is the question.
-    File.lstat self
-  end
-  
-  def mode
-    lstat.mode
-  end
-  
   #
   # Find the parent directory. If the `Path` is a filename, it returns the containing directory.
   #
@@ -637,8 +753,6 @@ raise "Broken!"
   end
 
   
-  # Mimetype finding and magic (requires 'mimemagic' gem)
-
   #
   # Find the file's mimetype (first from file extension, then by magic)
   #  
@@ -661,16 +775,16 @@ raise "Broken!"
     open { |io| MimeMagic.by_magic(io) }
   end
   
-  # TODO: rename type => magicext
-  
   #
-  # The filetype (as a standard file extension), verified with Magic.
+  # Returns the filetype (as a standard file extension), verified with Magic.
   #
   # (In other words, this will give you the *true* extension, even if the file's
   # extension is wrong.)
   #
   # Note: Prefers long extensions (eg: jpeg over jpg)
   #
+  # TODO: rename type => magicext?
+  #  
   def type
     @cached_type ||= begin
       
@@ -699,7 +813,8 @@ raise "Broken!"
       
     end
   end
-  
+
+
   ## aliases
   
   alias_method :to_path,    :path
@@ -903,15 +1018,14 @@ class Path::URL < Path
   end
   
   # ...and `path` is /path/filename.ext
-  
 end
 
 
 #
 # Path("/some/path") is an alias for Path["/some/path"]
 #
-def Path(*args)
-  Path[*args]
+def Path(arg)
+  Path[arg]
 end
 
 class String
@@ -921,4 +1035,3 @@ class String
   
   alias_method :to_P, :to_Path
 end
-