lonelyelk-file_path 0.2

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2009 Sergey Kruk
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,19 @@
+= FilePath
+
+== Summary
+
+Utility for comfortable operation with file paths
+
+== Installation
+
+  sudo gem install lonelyelk-file_path
+  
+== Usage
+
+  require "rubygems"
+  require "file_path"
+  
+  spec_dir = "spec"
+  spec_files = (FilePath.new / spec_dir / "*_spec.rb").list  #=> an array
+  
+  (FilePath.new("/some") / "dir" / "some" / "file").exist?

data/Rakefile

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'spec/rake/spectask'
+require 'rake/rdoctask'
+
+desc "Run all specs"
+Spec::Rake::SpecTask.new do |t|
+    t.spec_files = Dir.glob(File.join("spec", "*_spec.rb"))
+    t.spec_opts = ['--options', 'spec/spec.opts']
+end
+
+desc "Generate RDoc"
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_files.include(Dir.glob(File.join("lib", "*.rb"))).
+                  include("README.rdoc", "LICENSE")
+  rdoc.main = "README.rdoc"
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.options << "--charset=UTF-8"
+  rdoc.options << "--inline-source"
+  rdoc.title = "FilePath"
+end

data/lib/file_path.rb

@@ -0,0 +1,92 @@
+# Class FilePath is used for comfortable work with file paths.
+#
+# Following File class methods are implemented:
+#   filepath.blockdev?        => File.blockdev?(filepath)
+#   filepath.chardev?         => File.chardev?(filepath)
+#   filepath.directory?       => File.directory?(filepath)
+#   filepath.executable?      => File.executable?(filepath)
+#   filepath.executable_real? => File.executable_real?(filepath)
+#   filepath.exist?           => File.exist?(filepath)
+#   filepath.file?            => File.file?(filepath)
+#   filepath.grpowned?        => File.grpowned?(filepath)
+#   filepath.owned?           => File.owned?(filepath)
+#   filepath.pipe?            => File.pipe?(filepath)
+#   filepath.readable?        => File.readable?(filepath)
+#   filepath.readable_real?   => File.readable_real?(filepath)
+#   filepath.setgid?          => File.setgid?(filepath)
+#   filepath.setuid?          => File.setuid?(filepath)
+#   filepath.size?            => File.size?(filepath)
+#   filepath.socket?          => File.socket?(filepath)
+#   filepath.sticky?          => File.sticky?(filepath)
+#   filepath.symlink?         => File.symlink?(filepath)
+#   filepath.writable?        => File.writable?(filepath)
+#   filepath.writable_real?   => File.writable_real?(filepath)
+#   filepath.zero?            => File.zero?(filepath)
+class FilePath < String
+  # Creates new file path. If <code>path</code> param is not given, dirname of
+  # current file is used
+  def initialize(path = nil)
+    if path
+      replace expand(path)
+    else
+      replace expand(File.dirname(caller(1)[0].split(":")[0]))
+    end
+  end
+
+  # Joins string or filepath into new path
+  # Example:
+  #   FilePath.new("/somedir")/"other_dir"/"file"     => "/somedir/other_dir/file"
+  def /(other)
+    self.class.new(expand(File.join(self, other)))
+  end
+
+  # Returns <code>true</code> if file path is a wildcard
+  def wildcard?
+    include?("*") || include?("?")
+  end
+
+  # Returns list of paths selected by wildcard or an array with one specified file
+  # if it exists
+  def list
+    Dir.glob(self).map{ |p| self.class.new(p)}
+  end
+
+  # Returns <code>true</code> if wildcard selection includes specified path
+  def include_path?(filepath)
+    list.include?(expand(filepath))
+  end
+
+  # Returns file path as in File.dirname but of FilePath type
+  def dirname
+    self.class.new(File.dirname(self))
+  end
+
+  # Returns string with basename like in File.basename
+  def basename(suffix = "")
+    File.basename(self, suffix)
+  end
+
+  [:blockdev?, :chardev?, :directory?, :executable?, :executable_real?, :exist?,
+    :file?, :grpowned?, :owned?, :pipe?, :readable?, :readable_real?, :setgid?,
+    :setuid?, :size?, :socket?, :sticky?, :symlink?, :writable?, :writable_real?,
+    :zero?].each do |mthd|
+      class_eval <<-RUBY
+        def #{mthd}
+          File.#{mthd}(self)
+        end
+      RUBY
+    end
+
+  class << self
+    # Path to current file: File.expand_path(__FILE__)
+    def current
+      new(caller(1)[0].split(":")[0])
+    end
+  end
+
+protected
+
+  def expand(path)
+    File.expand_path(path)
+  end
+end

data/spec/file_path_spec.rb

@@ -0,0 +1,42 @@
+require File.join(File.dirname(__FILE__), "..", "lib", "file_path.rb")
+
+describe FilePath do
+  it "should show correct current path" do
+    FilePath.current.should == File.expand_path(__FILE__)
+  end
+
+  it "should show correct current dirname path when initialized" do
+    FilePath.new.should == File.expand_path(File.dirname(__FILE__))
+  end
+  
+  it "should call File class methods on path which return boolean" do
+    FilePath.new.directory?.should == true
+    FilePath.current.file?.should == true
+    FilePath.new("/some/dir").exist?.should == false
+    # Should I really be testing it?
+  end
+  
+  it "should recognize wildcard" do
+    (FilePath.new/"**"/"*.rb").wildcard?.should == true
+    (FilePath.new/"s?mefile.??").wildcard?.should == true
+    FilePath.current.wildcard?.should == false
+  end
+  
+  it "should work with lists" do
+    (FilePath.new/".."/"**"/"*.*").list.should == Dir.glob(File.join(File.dirname(__FILE__), "..", "**", "*.*")).map{ |p| FilePath.new(p)}
+  end
+  
+  it "should correctly verify inclusion of filepath" do
+    (FilePath.new/"*.rb").include_path?(FilePath.current).should == true
+    (FilePath.new/"*.rb").include_path?(__FILE__).should == true
+  end
+  
+  it "should return dirname" do
+    FilePath.current.dirname.should == FilePath.new
+  end
+  
+  it "should return basename" do
+    FilePath.current.basename.should == "file_path_spec.rb"
+    FilePath.current.basename(".rb").should == "file_path_spec"
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--format
+specdoc

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification 
+name: lonelyelk-file_path
+version: !ruby/object:Gem::Version 
+  version: "0.2"
+platform: ruby
+authors: 
+- Sergey Kruk
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-07 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: sergey.kruk@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- LICENSE
+files: 
+- LICENSE
+- README.rdoc
+- Rakefile
+- lib
+- lib/file_path.rb
+- spec
+- spec/file_path_spec.rb
+- spec/spec.opts
+has_rdoc: true
+homepage: http://github.com/lonelyelk/file_path
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+- --charset
+- UTF-8
+- --webcvs
+- http://github.com/lonelyelk/file_path/tree/master
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: FilePath is a ruby class to simplify file path interaction
+test_files: []
+