fs 0.1.2 → 0.2.0

data/.travis.yml

@@ -0,0 +1,2 @@
+rvm:
+  - 1.9.2

data/README.mdown

@@ -37,33 +37,34 @@ using the good old standard library, but providing simple methods in a single pl
 Although verbose method names are good, there are some aliases for unix shell
 commands (unsorted).
 
-- ls => list
-- mkdir => makedir
-- mkdir_p => makedirs
-- cd => changedir
-- mv => move
-- cp => copy
-- rm => remove
-- ln => link
-- cat => read (no concatenate)
+- ls      => :list
+- mkdir   => :makedir
+- mkdir_p => :makedirs
+- rmdir   => :removedir
+- rm_r    => :removedirs
+- cd      => :changedir
+- pwd     => :currentdir
+- mv      => :move
+- cp      => :copy
+- rm      => :remove
+- cat     => :read
+- ln      => :link
+- dir?    => :directory?
+- expand  => :expand_path
+- []      => :join
 
 ## Todo
 
-Here is my mind … here is my mind …
+Here is my mind …
 
 - maybe use underscores (remove_dir)
 - remove! to force something
 - maybe makedir! to mkdir -p
+- maybe touch! to mkdir -p && touch
 - use Find#find in FS#find ;)
-- file type
-- exist?
+- file type / ftype
 - list_dirs
 - list_files
 - find_dirs
 - find_files
 - FS.link('a.txt' => 'b.txt') with a hash
-
-## BTW
-
-If you need a replacement for the shell in pure ruby, than have a look at
-[Rush](http://rush.heroku.com/).

data/lib/fs.rb

@@ -3,12 +3,15 @@ $LOAD_PATH.unshift(File.dirname(__FILE__)) unless $LOAD_PATH.include?(File.dirna
 require 'fileutils'
 require 'etc'
 require 'tmpdir'
+require 'find'
 
 require 'fs/base'
+require 'fs/find'
 require 'fs/alias'
 
 module FS
   include FS::Base
+  include FS::Find
   include FS::Alias
   extend self
 end

data/lib/fs/alias.rb

@@ -15,6 +15,7 @@ module FS
       :ln      => :link,
       :dir?    => :directory?,
       :expand  => :expand_path,
+      :chop    => :chop_path,
       :[]      => :join,
     }
 

data/lib/fs/base.rb

@@ -31,13 +31,15 @@ module FS
 
     # Dir#glob
     def list(dir='.', pattern='*')
-      glob(dir, pattern)
+      glob(dir, pattern, nil)
     end
 
-    # Dir#glob
-    # TODO: use Find#find
-    def find(dir='.', pattern='*')
-      glob(dir, '**', pattern)
+    def list_dirs(dir='.', pattern='*')
+      glob(dir, pattern, ->(path){FS.directory?(path)})
+    end
+
+    def list_files(dir='.', pattern='*')
+      glob(dir, pattern, ->(path){FS.file?(path)})
     end
 
     # TODO: find time to make this cool, not work only
@@ -93,8 +95,9 @@ module FS
     end
 
     # Dir#home
+    # the path is always expanded
     def home(user=nil)
-      Dir.home(user)
+      File.expand_path(Dir.home(user))
     end
 
     # always returns '/'
@@ -168,8 +171,22 @@ module FS
     end
 
     # File.expand_path
-    def expand_path(path)
-      File.expand_path(path)
+    def expand_path(path, base=nil)
+      File.expand_path(path, base)
+    end
+
+    # chop base from the path
+    # if it's not a subdir the absolute path will be returned
+    def chop_path(path, base='.')
+      full_base = File.expand_path(base)
+      full_path = File.expand_path(path)
+      if full_path == full_base
+        '.'
+      elsif full_path.start_with?(full_base)
+        full_path[full_base.size+1..-1]
+      else
+        full_path
+      end
     end
 
     # checks for a slash at the beginning
@@ -209,13 +226,15 @@ module FS
     end
 
     # __FILE__ of the caller
+    # the path is always expanded
     def this_file
-      caller_file(caller)
+      File.expand_path(caller_file(caller))
     end
 
     # File.dirname(__FILE__) of the caller
+    # the path is always expanded
     def this_dir
-      File.dirname(caller_file(caller))
+      File.expand_path(File.dirname(caller_file(caller)))
     end
 
     private
@@ -224,12 +243,14 @@ module FS
       raise "not a directory: #{path}" unless File.directory?(path)
     end
 
-    def glob(dir, *patterns)
+    def glob(dir, *patterns, condition)
       fulldir = File.expand_path(dir)
       regexp = /^#{Regexp.escape(fulldir)}\/?/
-      Dir.glob(File.join(fulldir, patterns)).map do |path|
-        path.gsub(regexp, '')
-      end
+      Dir.
+        glob(File.join(fulldir, patterns)).
+        select {|path| condition.nil? || condition[path] }.
+        map {|path| path.gsub(regexp, '') }.
+        sort
     end
 
     def visit_tree(output, parent_path, indent, arm, tie, node)
@@ -259,7 +280,7 @@ module FS
     end
 
     # http://grosser.it/2009/07/01/getting-the-caller-method-in-ruby/
-    # Stolen from ActionMailer, where this was used but was not made reusable
+    # Stolen from ActionMailer, where it wasn't reusable
     def parse_caller(at)
       if /^(.+?):(\d+)(?::in `(.*)')?/ =~ at
         file   = Regexp.last_match[1]

data/lib/fs/find.rb

@@ -0,0 +1,42 @@
+module FS
+  module Find
+
+    # Find::find
+    def find(dir, options={}, &block)
+      defaults = {
+        :current => false,
+        :absolute => false,
+        :condition => nil
+      }
+      options = defaults.merge(options)
+
+      result = []
+
+      full_dir = File.expand_path(dir)
+      ::Find.find(dir) do |full_path|
+        next if !options[:current] && full_path == full_dir
+        path = options[:absolute] ? full_path : FS.chop(full_path, full_dir)
+        next if options[:condition] && !options[:condition][path]
+
+        if block
+          block[path]
+        else
+          result << path
+        end
+      end
+
+      block ? nil : result
+    end
+
+    def find_dirs(dir, options={}, &block)
+      condition = ->(path){FileTest.directory?(path)}
+      find(dir, options.merge(:condition => condition), &block)
+    end
+
+    def find_files(dir, options={}, &block)
+      condition = ->(path){!FileTest.directory?(path)}
+      find(dir, options.merge(:condition => condition), &block)
+    end
+
+  end
+end

data/lib/fs/version.rb

@@ -1,3 +1,3 @@
 module FS
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

data/spec/base_spec.rb

@@ -137,18 +137,12 @@ describe FS::Base do
       FS.makedir('foo/dir.rb')
       FS.list('foo', '*.txt').should eql(['dir.txt', 'file.txt'])
     end
-  end
-
-  describe '::find' do
-    it 'returns an empty list if there are no files' do
-      FS.find('.').should be_empty
-    end
 
-    it 'finds files in all subdirs' do
+    it 'lists files in all subdirs' do
       FS.makedirs('one/two/three')
       FS.touch('one/file.one')
       FS.touch('one/two/three/file.three')
-      FS.find.should eql([
+      FS.list('.', '**/*').should eql([
         'one',
         'one/file.one',
         'one/two',
@@ -161,13 +155,39 @@ describe FS::Base do
       FS.makedirs('one/two/three')
       FS.touch('one/file.one')
       FS.touch('one/two/three/file.three')
-      FS.find('.', 'file.*').should eql([
+      FS.list('.', '**/file.*').should eql([
         'one/file.one',
         'one/two/three/file.three'
       ])
     end
   end
 
+  describe '::list_dirs' do
+    it 'lists dirs only' do
+      FS.touch('bar.file')
+      FS.makedir('bar.dir')
+      FS.touch('foo.file')
+      FS.makedir('foo.dir')
+      FS.list_dirs.should eql([
+        'bar.dir',
+        'foo.dir'
+      ])
+    end
+  end
+
+  describe '::list_files' do
+    it 'lists files only' do
+      FS.touch('bar.file')
+      FS.makedir('bar.dir')
+      FS.touch('foo.file')
+      FS.makedir('foo.dir')
+      FS.list_files.should eql([
+        'bar.file',
+        'foo.file'
+      ])
+    end
+  end
+
   describe '::move' do
     it 'renames a file' do
       FS.touch('foo.txt')
@@ -327,7 +347,7 @@ describe FS::Base do
       FS.touch('a.file')
       FS.makedir('baz')
       FS.touch('baz/b.file')
-      FS.mkdir('baz/bar')
+      FS.makedir('baz/bar')
       FS.touch('baz/bar/c.file')
       FS.touch('baz/d.file')
       FS.makedir('foo')
@@ -406,8 +426,8 @@ TXT
     end
 
     it 'returns if a dir is empty' do
-      FS.mkdir('empty.dir')
-      FS.mkdir('content.dir')
+      FS.makedir('empty.dir')
+      FS.makedir('content.dir')
       FS.touch('content.dir/some.file')
       FS.empty?('empty.dir').should be_true
       FS.empty?('content.dir').should be_false
@@ -429,6 +449,46 @@ TXT
       FS.expand_path('foo').should eql(File.join(here, 'foo'))
       FS.expand_path('foo/bar').should eql(File.join(here, 'foo', 'bar'))
     end
+
+    it 'uses a base dir to expand the path' do
+      here = File.expand_path('.')
+      FS.expand_path('foo', nil).should eql(File.join(here, 'foo'))
+      FS.expand_path('foo', here).should eql(File.join(here, 'foo'))
+      FS.expand_path('foo', '/').should eql('/foo')
+      FS.expand_path('foo', '/bar').should eql('/bar/foo')
+      FS.expand_path('foo', '/bar/').should eql('/bar/foo')
+    end
+  end
+
+  describe '::chop_path' do
+    it 'does nothing for relative paths' do
+      FS.chop_path('.').should eql('.')
+      FS.chop_path('./foo').should eql('foo')
+      FS.chop_path('foo').should eql('foo')
+      FS.chop_path('foo/bar').should eql('foo/bar')
+    end
+
+    it 'does not chop for non subdirs' do
+      FS.chop_path('/').should eql('/')
+      FS.chop_path('..').should eql(File.expand_path('..'))
+      FS.chop_path('/foo', '/foo/bar').should eql('/foo')
+    end
+
+    it 'chop absolute the path' do
+      here = File.expand_path('.')
+      FS.chop_path(here).should eql('.')
+      FS.chop_path(File.join(here, '.')).should eql('.')
+      FS.chop_path(File.join(here, 'foo')).should eql('foo')
+      FS.chop_path(File.join(here, 'foo/bar')).should eql('foo/bar')
+      FS.chop_path('/foo/bar').should eql('/foo/bar')
+    end
+
+    it 'uses a base dir to chop the path' do
+      FS.chop_path('.', '.').should eql('.')
+      FS.chop_path('/', '/').should eql('.')
+      FS.chop_path('/foo', '/foo').should eql('.')
+      FS.chop_path('/foo/bar', '/foo').should eql('bar')
+    end
   end
 
   describe '::absolute?' do
@@ -520,7 +580,7 @@ TXT
       dir = FS.maketempdir
       File.exist?(dir).should be_true
       File.directory?(dir).should be_true
-      Dir.entries(dir).should eql([".", ".."])
+      Dir.entries(dir).should =~ ['.', '..']
       Dir.entries(Dir.tmpdir).should include(File.basename(dir))
     end
 
@@ -529,7 +589,7 @@ TXT
       dir.should match(/\/my_dir/)
       File.exist?(dir).should be_true
       File.directory?(dir).should be_true
-      Dir.entries(dir).should eql([".", ".."])
+      Dir.entries(dir).should =~ ['.', '..']
       Dir.entries(Dir.tmpdir).should include(File.basename(dir))
     end
 
@@ -538,7 +598,7 @@ TXT
       dir = FS.maketempdir(nil, parent_dir)
       File.exist?(dir).should be_true
       File.directory?(dir).should be_true
-      Dir.entries(dir).should eql([".", ".."])
+      Dir.entries(dir).should =~ ['.', '..']
       Dir.entries(parent_dir).should include(File.basename(dir))
     end
   end

data/spec/find_spec.rb

@@ -0,0 +1,135 @@
+require 'spec_helper'
+
+describe FS::Find do
+  before do
+    FS.touch    'a.txt'
+    FS.touch    'b.txt'
+    FS.makedirs 'bar'
+    FS.touch    'bar/c.txt'
+    FS.makedirs 'bar/foo'
+    FS.touch    'bar/foo/d.txt'
+    FS.makedirs 'baz'
+    FS.makedirs 'baz/lala'
+    FS.touch    'e.txt'
+  end
+
+  describe '::find' do
+    it 'returns the subdirs and files' do
+      FS.find(@test_dir).should == %w(
+        a.txt
+        b.txt
+        bar
+        bar/c.txt
+        bar/foo
+        bar/foo/d.txt
+        baz
+        baz/lala
+        e.txt
+      )
+    end
+
+    it 'returns current dir, subdirs and files' do
+      FS.find(@test_dir, :current => true).should == %w(
+        .
+        a.txt
+        b.txt
+        bar
+        bar/c.txt
+        bar/foo
+        bar/foo/d.txt
+        baz
+        baz/lala
+        e.txt
+      )
+    end
+
+    it 'returns the full path' do
+      FS.find(@test_dir, :absolute => true).should == [
+        FS[@test_dir, 'a.txt'],
+        FS[@test_dir, 'b.txt'],
+        FS[@test_dir, 'bar'],
+        FS[@test_dir, 'bar/c.txt'],
+        FS[@test_dir, 'bar/foo'],
+        FS[@test_dir, 'bar/foo/d.txt'],
+        FS[@test_dir, 'baz'],
+        FS[@test_dir, 'baz/lala'],
+        FS[@test_dir, 'e.txt']
+      ]
+    end
+
+    it 'yields the result' do
+      result = []
+
+      FS.find(@test_dir) do |path|
+        result << path
+      end
+
+      result.should == %w(
+        a.txt
+        b.txt
+        bar
+        bar/c.txt
+        bar/foo
+        bar/foo/d.txt
+        baz
+        baz/lala
+        e.txt
+      )
+    end
+  end
+
+  describe '::find_dirs' do
+    it 'returns dirs only' do
+      FS.find_dirs(@test_dir).should == %w(
+        bar
+        bar/foo
+        baz
+        baz/lala
+      )
+    end
+
+    it 'yields dirs only' do
+      result = []
+
+      FS.find_dirs(@test_dir) do |path|
+        result << path
+      end
+
+      result.should == %w(
+        bar
+        bar/foo
+        baz
+        baz/lala
+      )
+    end
+  end
+
+  describe '::find_files' do
+    it 'returns files only' do
+      FS.find_files(@test_dir).should == %w(
+        a.txt
+        b.txt
+        bar/c.txt
+        bar/foo/d.txt
+        e.txt
+      )
+    end
+
+    it 'yields files only' do
+      result = []
+
+      FS.find_files(@test_dir) do |path|
+        result << path
+      end
+
+      result.should == %w(
+        a.txt
+        b.txt
+        bar/c.txt
+        bar/foo/d.txt
+        e.txt
+      )
+    end
+  end
+
+end

data/spec/test_dir_spec.rb

@@ -15,7 +15,7 @@ describe FS do
     end
 
     it 'is empty' do
-      Dir.entries(@test_dir).should eql([".", ".."])
+      Dir.entries(@test_dir).should =~ ['.', '..']
     end
 
     it 'is the current dir' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fs
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-04 00:00:00.000000000Z
+date: 2011-11-10 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2157319500 !ruby/object:Gem::Requirement
+  requirement: &2158694320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -21,10 +21,10 @@ dependencies:
         version: 0.9.2.2
   type: :development
   prerelease: false
-  version_requirements: *2157319500
+  version_requirements: *2158694320
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2157319020 !ruby/object:Gem::Requirement
+  requirement: &2158693840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -32,10 +32,10 @@ dependencies:
         version: 2.7.0
   type: :development
   prerelease: false
-  version_requirements: *2157319020
+  version_requirements: *2158693840
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &2157318560 !ruby/object:Gem::Requirement
+  requirement: &2158693380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -43,10 +43,10 @@ dependencies:
         version: 0.7.2
   type: :development
   prerelease: false
-  version_requirements: *2157318560
+  version_requirements: *2158693380
 - !ruby/object:Gem::Dependency
   name: bluecloth
-  requirement: &2157318100 !ruby/object:Gem::Requirement
+  requirement: &2158692920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -54,7 +54,7 @@ dependencies:
         version: 2.2.0
   type: :development
   prerelease: false
-  version_requirements: *2157318100
+  version_requirements: *2158692920
 description: FS gathers the cluttered methods for working with files and dirs. Internally
   using the good old standard library, but providing simple methods in a single place.
 email:
@@ -65,6 +65,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .travis.yml
 - Gemfile
 - README.mdown
 - Rakefile
@@ -72,9 +73,11 @@ files:
 - lib/fs.rb
 - lib/fs/alias.rb
 - lib/fs/base.rb
+- lib/fs/find.rb
 - lib/fs/version.rb
 - spec/alias_spec.rb
 - spec/base_spec.rb
+- spec/find_spec.rb
 - spec/spec_helper.rb
 - spec/support/test_dir_support.rb
 - spec/test_dir_spec.rb
@@ -92,7 +95,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 612170262386871478
+      hash: 2428767844622882813
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -101,7 +104,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 612170262386871478
+      hash: 2428767844622882813
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.10
@@ -111,6 +114,7 @@ summary: Work with your filesystem!
 test_files:
 - spec/alias_spec.rb
 - spec/base_spec.rb
+- spec/find_spec.rb
 - spec/spec_helper.rb
 - spec/support/test_dir_support.rb
 - spec/test_dir_spec.rb