fs 0.0.1 → 0.0.2

data/.gitignore

@@ -3,3 +3,5 @@
 Gemfile.lock
 pkg/*
 .rvmrc
+.yardoc/
+doc/

data/Rakefile

@@ -3,4 +3,10 @@ Bundler::GemHelper.install_tasks
 
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new
-task :default => :spec
+task :default => :spec
+
+require 'yard' 
+YARD::Rake::YardocTask.new do |t|
+  t.files   = ['lib/**/*.rb']
+  t.options = ["--title", "FS #{FS::VERSION}"]
+end

data/fs.gemspec

@@ -13,7 +13,8 @@ Gem::Specification.new do |s|
   s.description = %q{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.}
 
   s.add_development_dependency 'rspec', '2.5.0'
-  s.add_development_dependency 'fakefs', '0.3.1'
+  s.add_development_dependency 'yard', '0.6.5'
+  s.add_development_dependency 'bluecloth', '2.1.0'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/lib/fs.rb

@@ -1,80 +1,10 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__)) unless $LOAD_PATH.include?(File.dirname(__FILE__))
+
 require 'fileutils'
+require 'etc'
+require 'fs/base'
 
 module FS
   extend self
-
-  # FileUtils.touch
-  def touch(files)
-    FileUtils.touch(files)
-  end
-
-  # FileUtils#mkdir
-  def makedir(dirs)
-    FileUtils.mkdir(dirs)
-  end
-
-  # FileUtils#mkdir_p
-  def makedirs(dirs)
-    FileUtils.mkdir_p(dirs)
-  end
-  
-  # Dir#entries
-  def list(dir, pattern='*')
-    glob(dir, pattern)
-  end
-  
-  # Find#find
-  def find(dir, pattern='*')
-    glob(dir, '**', pattern)
-  end
-  
-  # FileUtils#mv
-  def move(*froms, to)
-    froms.each do |from|
-      FileUtils.mv(from, to)
-    end
-  end
-
-  # FileUtils#rm
-  def remove(*pathes)
-    FileUtils.rm(pathes, :verbose => true)
-  end
-
-  # File#open(file, 'w')
-  def write(file, content=nil, &block)
-    if block_given?
-      File.open(file, 'w', &block)
-    else
-      File.open(file, 'w') {|f| f.write(content) }
-    end
-  end
-  
-  # File#open(file, 'r')
-  def read(file, &block)
-    if block_given?
-      File.open(file, 'r', &block)
-    else
-      content = nil
-      File.open(file, 'r') {|f| content = f.read }
-      content
-    end
-  end
-
-  
-  def root
-    '/'
-  end
-  
-  def home(user=nil)
-    Dir.home(user)
-  end
-
-  private
-  
-  def glob(dir, *patterns)
-    Dir.glob(File.join(dir, patterns)).map do |path|
-      path.gsub(/^\.?#{dir}\/?/, '')
-    end
-  end
-  
+  extend FS::Base
 end

data/lib/fs/base.rb

@@ -0,0 +1,83 @@
+module FS
+  module Base
+    # FileUtils.touch
+    def touch(files)
+      FileUtils.touch(files)
+    end
+
+    # FileUtils#mkdir
+    def makedir(dirs)
+      FileUtils.mkdir(dirs)
+    end
+
+    # FileUtils#mkdir_p
+    def makedirs(dirs)
+      FileUtils.mkdir_p(dirs)
+    end
+
+    # Dir#glob
+    def list(dir='.', pattern='*')
+      glob(dir, pattern)
+    end
+
+    # Dir#glob
+    # TODO: use Find#find
+    def find(dir='.', pattern='*')
+      glob(dir, '**', pattern)
+    end
+
+    # FileUtils#mv
+    def move(*froms, to)
+      froms.each do |from|
+        FileUtils.mv(from, to)
+      end
+    end
+
+    # FileUtils#rm
+    def remove(*pathes)
+      FileUtils.rm(pathes)
+    end
+
+    # File#open(file, 'w')
+    def write(file, content=nil, &block)
+      if block_given?
+        File.open(file, 'w', &block)
+      else
+        File.open(file, 'w') {|f| f.write(content) }
+      end
+    end
+
+    # File#open(file, 'r')
+    def read(file, &block)
+      if block_given?
+        File.open(file, 'r', &block)
+      else
+        content = nil
+        File.open(file, 'r') {|f| content = f.read }
+        content
+      end
+    end
+
+    # Dir#home
+    def home(user=nil)
+      Dir.home(user)
+    end
+
+    # always returns '/'
+    def root
+      '/'
+    end
+
+    private
+    
+    def assert_dir(path)
+      raise "not a directory: #{path}" unless File.directory?(path)
+    end
+
+    def glob(dir, *patterns)
+      Dir.glob(File.join(dir, patterns)).map do |path|
+        path.gsub(/^\.?#{dir}\/?/, '')
+      end
+    end
+  end
+end

data/lib/fs/version.rb

@@ -1,3 +1,3 @@
 module FS
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/base_spec.rb

@@ -0,0 +1,221 @@
+require 'spec_helper'
+
+describe FS::Base do
+  
+  describe 'touch' do
+    it 'touches a single file' do
+      file = 'foobar.txt'
+      FS.touch(file)
+      File.exist?(file).should be_true 
+    end
+    
+    it 'touches a list of files' do
+      files = ['foo.txt', 'bar.txt']
+      FS.touch(files)
+      files.each do |file|
+        File.exist?(file).should be_true   
+      end
+    end
+  end
+  
+  describe 'makedir' do
+    it 'creates a dir' do
+      FS.makedir('foo')
+      File.directory?('foo').should be_true
+    end
+    
+    it 'fails if a parent dir is missing' do
+      lambda {FS.makedir('foo/bar')}.should raise_error
+    end
+  end
+  
+  describe 'makedirs' do
+    it 'creates all missing parent dirs' do
+      FS.makedirs 'foo/bar/baz'
+      File.directory?('foo').should be_true
+      File.directory?('foo/bar').should be_true
+      File.directory?('foo/bar/baz').should be_true
+    end
+  end
+  
+  describe 'list' do
+    it 'returns an empty list if there are no files' do
+      FS.list.should be_empty
+    end
+    
+    it 'lists all files and dirs (without . and ..)' do
+      FS.touch('file')
+      FS.makedir('dir')
+      FS.list.should eql(['dir', 'file'])
+    end
+    
+    it 'lists files and dirs in the current dir' do
+      FS.makedir('foo')
+      FS.makedir('foo/dir')
+      FS.touch('foo/file')
+      Dir.chdir('foo')
+      FS.list.should eql(['dir', 'file'])
+    end
+    
+    it 'globs files and dirs' do
+      FS.touch('file.txt')
+      FS.touch('file.rb')
+      FS.makedir('dir.txt')
+      FS.makedir('dir.rb')
+      FS.list('.', '*.txt').should eql(['dir.txt', 'file.txt'])
+    end
+    
+    it 'globs files and dirs' do
+      FS.touch('file.txt')
+      FS.touch('file.rb')
+      FS.makedir('dir.txt')
+      FS.makedir('dir.rb')
+      FS.list('.', '*.txt').should eql(['dir.txt', 'file.txt'])
+    end
+  
+    it 'lists files and dirs in a subdir' do
+      FS.makedir('foo')
+      FS.makedir('foo/dir')
+      FS.touch('foo/file')
+      FS.list('foo').should eql(['dir', 'file'])
+    end
+    
+    it 'globs files and dirs in a subdir' do
+      FS.makedir('foo')
+      FS.touch('foo/file.txt')
+      FS.touch('foo/file.rb')
+      FS.makedir('foo/dir.txt')
+      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
+      FS.makedirs('one/two/three')
+      FS.touch('one/file.one')
+      FS.touch('one/two/three/file.three')
+      FS.find.should eql([
+        'one',
+        'one/file.one',
+        'one/two',
+        'one/two/three',
+        'one/two/three/file.three'
+      ])
+    end
+    
+    it 'globs files in all subdirs' do
+      FS.makedirs('one/two/three')
+      FS.touch('one/file.one')
+      FS.touch('one/two/three/file.three')
+      FS.find('.', 'file.*').should eql([
+        'one/file.one',
+        'one/two/three/file.three'
+      ])
+    end
+  end
+  
+  describe 'move' do
+    it 'rename a file' do
+      FS.touch('foo.txt')
+      FS.move('foo.txt', 'bar.txt')
+      FS.list.should eql(['bar.txt'])
+    end
+    
+    it 'moves a file' do
+      FS.touch('foo.txt')
+      FS.makedirs('tmp')
+      FS.move('foo.txt', 'tmp')
+      FS.list.should eql(['tmp'])
+      FS.list('tmp').should eql(['foo.txt'])
+    end
+    
+    it 'moves files and dirs' do
+      FS.touch('file')
+      FS.makedir('dir')
+      FS.makedir('tmp')
+      FS.move('file', 'dir', 'tmp')
+      FS.list.should eql(['tmp'])
+      FS.list('tmp').should eql(['dir', 'file'])
+    end
+  end
+  
+  describe 'remove' do
+    it 'removes files' do
+      FS.touch('file')
+      FS.remove('file')
+      FS.list.should be_empty
+    end
+
+    it 'removes multiple files' do
+      FS.touch('file.a')
+      FS.touch('file.b')
+      FS.remove('file.a', 'file.b')
+      FS.list.should be_empty
+    end
+    
+    it 'fails on dirs' do
+      FS.makedir('dir')
+      lambda {FS.remove('dir')}.should raise_error
+    end
+    
+    # FIXME: fakefs
+    # it 'fails if the dir is not empty' do
+    #   FS.makedir('/foo')
+    #   FS.touch('/foo/bar')
+    #   lambda {FS.remove('/foo')}.should raise_error
+    # end
+  end
+  
+  describe 'write' do
+    it 'writes content from a string' do
+      FS.write('foo.txt', 'bar')
+      File.open('foo.txt').read.should eql('bar')
+    end
+    
+    it 'writes content from a block' do
+      FS.write('foo.txt') {|f| f.write 'bar' }
+      File.open('foo.txt').read.should eql('bar')
+    end
+  end
+  
+  describe 'read' do
+    it 'reads the content to a string' do
+      File.open('foo.txt', 'w') {|f| f.write 'bar' }
+      FS.read('foo.txt').should eql('bar')
+    end
+    
+    it 'reads the content to a block' do
+      File.open('foo.txt', 'w') {|f| f.write 'bar' }
+      FS.read('foo.txt') {|f| f.read.should eql('bar')}
+    end
+  end
+  
+  describe 'root' do
+    it 'always returns /' do
+      FS.root.should eql('/')
+    end
+  end
+  
+  describe 'home' do
+    it 'returns the home of the current user' do
+      FS.home.should match(/\/#{Etc.getlogin}$/)
+    end
+    
+    it 'returns the home of another user' do
+      FS.home('root').should match(/\/root$/)
+    end
+  end
+  
+  # describe 'removedir'
+  # describe 'removedirs'
+  # describe 'currentdir'
+  # describe 'changedir'
+  # describe 'copy'
+  # describe 'link'
+
+end

data/spec/spec_helper.rb

@@ -1,4 +1,4 @@
 require 'rspec/core'
-Dir['./spec/support/**/*.rb'].map {|f| require f}
+require 'fs'
 
-require 'fs'
+Dir['./spec/support/**/*.rb'].map {|f| require f}

data/spec/support/test_dir_support.rb

@@ -0,0 +1,33 @@
+module FS
+  module SpecHelpers
+    
+    def self.extended(example_group)
+      example_group.use_helper(example_group)
+    end
+
+    def self.included(example_group)
+      example_group.extend self
+    end
+
+    def use_helper(describe_block)
+      describe_block.before :each do
+        unless @test_dir
+          @test_dir = File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'tmp', 'test'))
+          FileUtils.mkdir_p(@test_dir)
+          Dir.chdir(@test_dir)
+        end
+      end
+
+      describe_block.after :each do
+        if @test_dir
+          FileUtils.rm_r(@test_dir)
+          @test_dir = nil
+        end
+      end
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include FS::SpecHelpers
+end

data/spec/test_dir_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe FS do
+  describe 'test dir' do
+    it 'is absolute' do
+      Pathname.new(@test_dir).should be_absolute
+    end
+    
+    it 'is created' do
+      File.exist?(@test_dir).should be_true
+    end
+    
+    it 'is a directory' do
+      File.directory?(@test_dir).should be_true
+    end
+    
+    it 'is empty' do
+      Dir.entries(@test_dir).should eql([".", ".."])
+    end
+    
+    it 'is the current dir' do
+      File.expand_path(Dir.pwd).should eql(@test_dir)
+    end
+    
+    it 'is deleted when not empty' do
+      filename = 'test.file'
+      FileUtils.touch(filename)
+      File.exist?(File.join(@test_dir, filename)).should be_true
+    end
+  end
+end

metadata

@@ -2,7 +2,7 @@
 name: fs
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - "Bernd J\xC3\xBCnger"
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-28 00:00:00 +02:00
+date: 2011-03-29 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -25,16 +25,27 @@ dependencies:
   type: :development
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: fakefs
+  name: yard
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
-        version: 0.3.1
+        version: 0.6.5
   type: :development
   version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: bluecloth
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 2.1.0
+  type: :development
+  version_requirements: *id003
 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: 
 - blindgaenger@gmail.com
@@ -51,10 +62,12 @@ files:
 - Rakefile
 - fs.gemspec
 - lib/fs.rb
+- lib/fs/base.rb
 - lib/fs/version.rb
-- spec/fs_spec.rb
+- spec/base_spec.rb
 - spec/spec_helper.rb
-- spec/support/fakefs_support.rb
+- spec/support/test_dir_support.rb
+- spec/test_dir_spec.rb
 has_rdoc: true
 homepage: http://github.com/blindgaenger/fs
 licenses: []
@@ -84,6 +97,7 @@ signing_key:
 specification_version: 3
 summary: Work with your filesystem!
 test_files: 
-- spec/fs_spec.rb
+- spec/base_spec.rb
 - spec/spec_helper.rb
-- spec/support/fakefs_support.rb
+- spec/support/test_dir_support.rb
+- spec/test_dir_spec.rb

data/spec/fs_spec.rb

@@ -1,196 +0,0 @@
-require 'spec_helper'
-
-describe FS do
-
-  describe 'touch' do
-    it 'touches a single file' do
-      file = '/foobar.txt'
-      FS.touch(file)
-      File.exist?(file).should be_true 
-    end
-    
-    it 'touches a list of files' do
-      files = ['/foo.txt', '/bar.txt']
-      FS.touch(files)
-      files.each do |file|
-        File.exist?(file).should be_true   
-      end
-    end
-  end
-  
-  describe 'makedir' do
-    it 'creates a dir' do
-      FS.makedir('/foo')
-      File.directory?('/foo').should be_true
-    end
-    
-    it 'fails if a parent dir is missing' do
-      lambda {FS.makedir('/foo/bar')}.should raise_error
-    end
-  end
-  
-  describe 'makedirs' do
-    it 'creates all missing parent dirs' do
-      FS.makedirs '/foo/bar/baz'
-      File.directory?('/foo').should be_true
-      File.directory?('/foo/bar').should be_true
-      File.directory?('/foo/bar/baz').should be_true
-    end
-  end
-  
-  describe 'list' do
-    it 'returns an empty list if there are no files' do
-      FS.list('/').should be_empty
-    end
-    
-    it 'lists all files and dirs (without . and ..)' do
-      FS.touch('/foo')
-      FS.makedir('/bar')
-      FS.list('/').should eql(['foo', 'bar'])
-    end
-    
-    it 'globs files and dirs' do
-      FS.touch('/file.txt')
-      FS.touch('/file.rb')
-      FS.makedir('/dir.txt')
-      FS.makedir('/dir.rb')
-      FS.list('/', '*.txt').should eql(['file.txt', 'dir.txt'])
-    end
-    
-    it 'lists files and dirs in a subdir' do
-      FS.makedir('/foo')
-      FS.makedir('/foo/dir')
-      FS.touch('/foo/file')
-      FS.list('/foo').should eql(['dir', 'file'])
-    end
-    
-    it 'globs files and dirs in a subdir' do
-      FS.makedir('/foo')
-      FS.touch('/foo/file.txt')
-      FS.touch('/foo/file.rb')
-      FS.makedir('/foo/dir.txt')
-      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.list('/').should be_empty
-    end
-    
-    it 'finds 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([
-        'one',
-        'one/file.one',
-        'one/two',
-        'one/two/three',
-        'one/two/three/file.three'
-      ])
-    end
-    
-    it 'globs files in all subdirs' do
-      FS.makedirs('/one/two/three')
-      FS.touch('/one/file.one')
-      FS.touch('/one/two/three/file.three')
-      FS.find('/', 'file.*').should eql([
-        'one/file.one',
-        'one/two/three/file.three'
-      ])
-    end
-  end
-  
-  describe 'move' do
-    it 'rename a file' do
-      FS.touch('/foo.txt')
-      FS.move('/foo.txt', '/bar.txt')
-      FS.list('/').should eql(['bar.txt'])
-    end
-    
-    # FIXME: fakefs
-    # it 'moves a file' do
-    #   FS.touch('/foo.txt')
-    #   FS.makedirs('/tmp')
-    #   FS.move('/foo.txt', '/tmp')
-    #   FS.list('/').should eql(['tmp'])
-    #   FS.list('/tmp').should eql(['foo.txt'])
-    # end
-    
-    # FIXME: fakefs
-    # it 'moves files and dirs' do
-    #   FS.touch('/file')
-    #   FS.makedir('/dir')
-    #   FS.makedir('/tmp')
-    #   FS.move('/file', '/dir', '/tmp')
-    #   FS.list('/').should eql(['tmp'])
-    #   FS.list('/tmp').should eql(['file', 'dir'])
-    # end
-  end
-
-  describe 'remove' do
-    it 'removes files and dirs' do
-      FS.touch('/file')
-      FS.makedir('/dir')
-      FS.remove('/file', '/dir')
-      FS.list('/').should be_empty
-    end
-
-    # FIXME: fakefs
-    # it 'fails if the dir is not empty' do
-    #   FS.makedir('/foo')
-    #   FS.touch('/foo/bar')
-    #   lambda {FS.remove('/foo')}.should raise_error
-    # end
-  end
-
-  describe 'write' do
-    it 'writes content from a string' do
-      FS.write('/foo.txt', 'bar')
-      File.open('/foo.txt').read.should eql('bar')
-    end
-    
-    it 'writes content from a block' do
-      FS.write('/foo.txt') {|f| f.write 'bar' }
-      File.open('/foo.txt').read.should eql('bar')
-    end
-  end
-  
-  describe 'read' do
-    it 'reads the content to a string' do
-      File.open('/foo.txt', 'w') {|f| f.write 'bar' }
-      FS.read('/foo.txt').should eql('bar')
-    end
-    
-    it 'reads the content to a block' do
-      File.open('/foo.txt', 'w') {|f| f.write 'bar' }
-      FS.read('/foo.txt') {|f| f.read.should eql('bar')}
-    end
-  end
-  
-  describe 'root' do
-    it 'always returns /' do
-      FS.root.should eql('/')
-    end
-  end
-
-  describe 'home' do
-    it 'returns the home of the current user' do
-      FS.home.should eql('/Users/me')
-    end
-    
-    it 'returns the home of another user' do
-      FS.home('you').should eql('/Users/you')
-    end
-  end
-  
-  # describe 'removedir'
-  # describe 'removedirs'
-  # describe 'currentdir'
-  # describe 'changedir'
-  # describe 'copy'
-  # describe 'link'
-
-end

data/spec/support/fakefs_support.rb

@@ -1,32 +0,0 @@
-require 'fakefs/spec_helpers'
-
-RSpec.configure do |config|
-  config.include FakeFS::SpecHelpers
-end
-
-# FileUtils.mkdir is not handled
-# https://github.com/defunkt/fakefs/issues/closed#issue/37
-#
-# Patch:
-# https://github.com/flavio/fakefs/blob/ea22773bc293ea3bce97317086b8171669780eab/lib/fakefs/fileutils.rb
-module FakeFS
-  module FileUtils
-    extend self
-    def mkdir(path)
-      parent = path.split('/')
-      parent.pop
-      raise Errno::ENOENT, "No such file or directory - #{path}" unless parent.join == "" || FileSystem.find(parent.join('/'))
-      raise Errno::EEXIST, "File exists - #{path}" if FileSystem.find(path)
-      FileSystem.add(path, FakeDir.new)
-    end
-  end
-end
-
-
-module FakeFS
-  class Dir
-    def self.home(user=nil)
-      "/Users/#{user || 'me'}"
-    end
-  end
-end