rubypath 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b9897ff8546e2a25f86e5a9feb820d2462755153
+  data.tar.gz: 0d8c6cc18c678673c599aa6b45e316039d1c16b2
+SHA512:
+  metadata.gz: f95207874afd05e04c4878c4fb7df9e55f0e4548336551ebfdcbe31b103d830e6340861ab4f1fe3a2d5e06e8d5b776c4b7404cf771e269ac54549227fb9c50a5
+  data.tar.gz: 9ea4c73e67e6361c4befa3ec2e37227241f80373631e5e380133a26fbc0f12ff32b78265e21bdbf950e335ecbd08dbe8bb991f49ad57d9d46397012edee2b55f

data/LICENSE.txt

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README.md

@@ -0,0 +1,29 @@
+# Ruby Path
+
+*Ruby Path* introduces a global `Path` class unifying most `File`, `Dir`, `FileUtils`, `Pathname` and `IO` operations with a flexible and powerful Object-Interface and still adding new useful methods and functions like mocking a while file system for fast and reliable testing.
+
+## Installation
+
+Add `rubypath` to your Gemfile, `gemspec` or install manually.
+
+## Usage
+
+TODO
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+Copyright (C) 2014 Jan Graichen
+
+This program is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License along with this program.  If not, see <http://www.gnu.org/licenses/>.

data/doc/file.README.html

@@ -0,0 +1,111 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+<title>
+  File: README
+  
+    &mdash; Documentation by YARD 0.8.7.3
+  
+</title>
+
+  <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
+
+  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
+
+<script type="text/javascript" charset="utf-8">
+  hasFrames = window.top.frames.main ? true : false;
+  relpath = '';
+  framesUrl = "frames.html#!" + escape(window.location.href);
+</script>
+
+
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+
+
+  </head>
+  <body>
+    <div id="header">
+      <div id="menu">
+  
+    <a href="_index.html">Index</a> &raquo; 
+    <span class="title">File: README</span>
+  
+
+  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+
+      <div id="search">
+  
+    <a class="full_list_link" id="class_list_link"
+        href="class_list.html">
+      Class List
+    </a>
+  
+    <a class="full_list_link" id="method_list_link"
+        href="method_list.html">
+      Method List
+    </a>
+  
+    <a class="full_list_link" id="file_list_link"
+        href="file_list.html">
+      File List
+    </a>
+  
+</div>
+      <div class="clear"></div>
+    </div>
+
+    <iframe id="search_frame"></iframe>
+
+    <div id="content"><div id='filecontents'><h1>Ruby::Path</h1>
+
+<p><em>Ruby::Path</em> introduces a global <code>Path</code> class unifying most <code>File</code>, <code>Dir</code>, <code>FileUtils</code>, <code>Pathname</code> and <code>IO</code> operations with a flexible and powerful Object-Interface and still adding new useful methods and functions like mocking a while file system for fast and reliable testing.</p>
+
+<h2>Installation</h2>
+
+<p>Add <code>ruby-path</code> to your Gemfile, <code>gemspec</code> or install manually.</p>
+
+<h2>Usage</h2>
+
+<p>TODO</p>
+
+<h2>Contributing</h2>
+
+<ol>
+<li>Fork it</li>
+<li>Create your feature branch (<code>git checkout -b my-new-feature</code>)</li>
+<li>Commit your changes (<code>git commit -am &#39;Add some feature&#39;</code>)</li>
+<li>Push to the branch (<code>git push origin my-new-feature</code>)</li>
+<li>Create new Pull Request</li>
+</ol>
+
+<h2>License</h2>
+
+<p>Copyright (C) 2014 Jan Graichen</p>
+
+<p>This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.</p>
+
+<p>This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.</p>
+
+<p>You should have received a copy of the GNU General Public License
+along with this program.  If not, see <a href="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</a>.</p>
+</div></div>
+
+    <div id="footer">
+  Generated on Mon Feb 17 00:33:05 2014 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.8.7.3 (ruby-2.1.0).
+</div>
+
+  </body>
+</html>

data/lib/rubypath/backend/mock.rb

@@ -0,0 +1,315 @@
+class Path::Backend
+
+  class Mock
+    attr_reader :user, :homes
+
+    # @!group Virtual File System Configuration
+
+    # Set user that owns the current process.
+    def current_user=(user)
+      @user = user.to_s
+    end
+
+    # Define new home directories. Must be given as has a hash that is
+    # interpreted as a user name to home directory mapping.
+    attr_writer :homes
+
+    # Set current working directory.
+    attr_writer :cwd
+
+    # @!group Internal Methods
+
+    def initialize
+      @user  = 'root'
+      @homes = {'root' => '/root'}
+      @cwd   = '/root'
+      @umask = 0022
+    end
+
+    def home(user)
+      homes.fetch(user){ raise ArgumentError.new "user #{user} doesn't exist" }
+    end
+
+    # @!group Backend Operations
+
+    def expand_path(path, base = getwd)
+      if %r{^~(?<name>[^/]*)(/(?<rest>.*))?$} =~ path
+        ::File.expand_path rest.to_s, home(name.empty? ? user : name)
+      else
+        ::File.expand_path(path, base)
+      end
+    end
+    alias_method :expand, :expand_path
+
+    def getwd
+      @cwd ||= '/'
+    end
+
+    def file?(path)
+      lookup(path).is_a?(File)
+    end
+
+    def directory?(path)
+      lookup(path).is_a?(Dir)
+    end
+
+    def exists?(path)
+      lookup(path) ? true : false
+    end
+
+    def mkdir(path)
+      return if path.to_s == '/'
+
+      node = lookup_parent! path
+      dir  = node.lookup ::File.basename path
+      unless dir.is_a?(Dir)
+        if dir.nil?
+          node.add Dir.new(self, ::File.basename(path))
+        else
+          raise ArgumentError.new \
+            "Node #{dir.path} exists and is no directory."
+        end
+      end
+    end
+
+    def mkpath(path)
+      path = expand_path(path)
+      ::Pathname.new(path).descend do |p|
+        mkdir(p.to_s)
+      end
+    end
+
+    def touch(path)
+      node = lookup_parent! path
+      file = node.lookup ::File.basename path
+      if file
+        file.mtime = Time.now
+      else
+        node.add File.new(self, ::File.basename(path))
+      end
+    end
+
+    def write(path, content, *args)
+      node = lookup_parent! path
+      file = node.lookup ::File.basename(path)
+      unless file
+        file = File.new self, ::File.basename(path)
+        node.add file
+      end
+
+      case file
+        when File
+          if args.empty?
+            file.content = content
+          else
+            offset = args[0].to_i
+            file.content[offset, content.length] = content
+          end
+          file.mtime   = Time.now
+        when Dir
+          raise Errno::EISDIR.new path
+        else
+          raise ArgumentError.new
+      end
+    end
+
+    def mtime(path)
+      lookup!(path).mtime
+    end
+
+    def mtime=(path, time)
+      lookup!(path).mtime = time
+    end
+
+    def atime(path)
+      lookup!(path).atime
+    end
+
+    def atime=(path, time)
+      lookup!(path).atime = time
+    end
+
+    def read(path, *args)
+      file       = lookup_file!(path)
+      file.atime = Time.now
+      content    = file.content
+      if args[0]
+        length  = args[0].to_i
+        offset  = args[1] ? args[1].to_i : 0
+        content = content.slice(offset, length)
+      end
+      content
+    end
+
+    def entries(path)
+      node = lookup_dir! path
+      node.children.map(&:name) + %w(. ..)
+    end
+
+    def glob(pattern, flags = 0, &block)
+      root.all.select do |node|
+        ::File.fnmatch pattern, node.path, (flags | ::File::FNM_PATHNAME)
+      end
+    end
+
+    def get_umask
+      @umask
+    end
+
+    def set_umask(mask)
+      @umask = Integer(mask)
+    end
+
+    def mode(path)
+      lookup!(path).mode
+    end
+
+    # @!group Internal Virtual File System
+
+    # Return root node.
+    def root
+      @root ||= Dir.new(self, '')
+    end
+
+    def to_lookup(path)
+      path = expand path
+      path.sub(/^\/+/, '')
+    end
+
+    def lookup(path)
+      root.lookup to_lookup path
+    end
+
+    def lookup!(path)
+      if (node = lookup(path))
+        node
+      else
+        raise Errno::ENOENT.new path
+      end
+    end
+
+    def lookup_file!(path)
+      node = lookup! path
+      case node
+        when File
+          node
+        when Dir
+          raise Errno::EISDIR.new path
+        else
+          raise ArgumentError.new "NOT A FILE: #{path}"
+      end
+    end
+
+    def lookup_dir!(path)
+      if (node = lookup!(path)).is_a?(Dir)
+        node
+      else
+        raise Errno::ENOENT.new path
+      end
+    end
+
+    def lookup_parent!(path)
+      node = lookup ::File.dirname expand path
+      if node
+        node.is_a?(Dir) ? node : raise(Errno::ENOTDIR.new path)
+      else
+        raise Errno::ENOENT.new path
+      end
+    end
+
+    #
+    class Node
+      attr_reader :sys, :name, :parent
+      attr_accessor :mtime, :atime, :mode
+
+      def initialize(backend, name, ops = {})
+        @sys   = backend
+        @name  = name
+        @mtime = Time.now
+        @atime = Time.now
+      end
+
+      def mtime=(time)
+        if time.is_a?(Time)
+          @mtime = time
+        else
+          raise "Not Time but `#{time.inspect}` of `#{time.class.name}` given."
+        end
+      end
+
+      def lookup(path)
+        raise NotImplementError.new 'Subclass responsibility.'
+      end
+
+      def added(parent)
+        @parent = parent
+      end
+
+      def path
+        parent ? "#{parent.path}/#{name}" : name
+      end
+    end
+
+    #
+    class Dir < Node
+      def initialize(backend, name, opts = {})
+        super
+        self.mode = 0777 - backend.get_umask
+      end
+
+      def lookup(path)
+        name, rest = path.to_s.split('/', 2).map(&:to_s)
+
+        if name.nil?
+          if rest.nil?
+            self
+          else
+            lookup rest
+          end
+        else
+          child = children.find{|c| c.name == name }
+          if child
+            rest.nil? ? child : child.lookup(rest)
+          else
+            nil
+          end
+        end
+      end
+
+      def add(node)
+        if children.any?{|c| c.name == node.name }
+          raise ArgumentError.new "Node #{path}/#{node.name} already exists."
+        else
+          children << node
+          node.added self
+        end
+      end
+
+      def all
+        children.reduce([]) do |memo, child|
+          memo << child
+          memo += child.all if child.is_a?(Dir)
+          memo
+        end
+      end
+
+      def children
+        @children ||= []
+      end
+    end
+
+    #
+    class File < Node
+      attr_accessor :content
+
+      def initialize(backend, name, opts = {})
+        super
+        self.mode = 0666 - backend.get_umask
+      end
+
+      def lookup(path)
+        nil
+      end
+    end
+  end
+end