fs 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.rvmrc

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in fs.gemspec
+gemspec

data/README.mdown

@@ -0,0 +1,58 @@
+# FS (FileSystem)
+
+Work with your filesystem!
+
+## Problem
+
+This Gem shouldn't reinvent the wheel or be a replacement.
+But in Ruby working with the filesystem really hurts!
+
+In your toolbox are at least `File`, `Dir`, `FileUtils`, `Find`, and maybe some more.
+Good tools, but to complicated for most cases. 
+It's not about piping, or copying the shell as it is.
+But think about a simple `ls` in the shell, than how you would do this in Ruby. 
+Got the idea?
+
+## Solution
+
+`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.
+
+## Examples
+
+    FS.changedir('~/Projects/fs')
+    ==> "/Users/bjuenger/Projects/fs"
+    FS.list('.')
+    ==> [".git", ".gitignore", ".rvmrc", "fs.gemspec", "Gemfile", "Gemfile.lock", "lib", "Rakefile", "README.mdown", "spec"]
+    FS.makedirs('tmp/demo')
+    FS.touch('tmp/demo/newfile.txt')
+    FS.list('tmp/demo')
+    ==> ["newfile.txt"]
+    FS.remove('tmp/demo/newfile.txt')
+    FS.list('tmp/demo')
+    ==> []
+
+## Aliases
+
+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)
+
+## Todo
+
+- Aliases
+- list(dir, '*.rb')
+
+## BTW
+
+If you need a replacement for the shell in pure ruby, than have a look at 
+[Rush](http://rush.heroku.com/).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+task :default => :spec

data/fs.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "fs/version"
+
+Gem::Specification.new do |s|
+  s.name        = "fs"
+  s.version     = FS::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Bernd Jünger"]
+  s.email       = ["blindgaenger@gmail.com"]
+  s.homepage    = "http://github.com/blindgaenger/fs"
+  s.summary     = %q{Work with your filesystem!}
+  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.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/fs.rb

@@ -0,0 +1,80 @@
+require 'fileutils'
+
+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
+  
+end

data/lib/fs/version.rb

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

data/spec/fs_spec.rb

@@ -0,0 +1,196 @@
+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/spec_helper.rb

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

data/spec/support/fakefs_support.rb

@@ -0,0 +1,32 @@
+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

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification 
+name: fs
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- "Bernd J\xC3\xBCnger"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-28 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 2.5.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: fakefs
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 0.3.1
+  type: :development
+  version_requirements: *id002
+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
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.mdown
+- Rakefile
+- fs.gemspec
+- lib/fs.rb
+- lib/fs/version.rb
+- spec/fs_spec.rb
+- spec/spec_helper.rb
+- spec/support/fakefs_support.rb
+has_rdoc: true
+homepage: http://github.com/blindgaenger/fs
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Work with your filesystem!
+test_files: 
+- spec/fs_spec.rb
+- spec/spec_helper.rb
+- spec/support/fakefs_support.rb