file-utils 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 James Wilding
+
+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.md

@@ -0,0 +1,42 @@
+# file-utils
+
+	gem install file-utils
+
+A better-looking wrapper for some common uses of FileUtils.
+
+## Usage
+
+	require 'file/utils'
+	
+	File::Utils.create 	'/some/file.rb'	
+	File::Utils.create 	'/some/other/file.rb' do |f|
+		f.write "Hello world!"
+	end
+	File::Utils.rewrite '/some/other/file.rb', 'New contents'	
+	File::Utils.destroy ['/some/file.rb', '/some/other/file.rb']
+	
+See the docs in <tt>lib/file/utils.rb</tt> for more usage examples.
+
+## Contributing
+
+I write this to wrap some common FileUtils patterns I found myself using over and over. If there are patterns that you use repeatedly (and which involve FileUtils methods), please suggest an addition :)
+
+## To Do
+
+Tests! 
+
+## Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Keep it simple.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2010 James Wilding. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "file-utils"
+    gem.summary = %Q{A beautiful wrapper for FileUtils}
+    gem.description = %Q{file-utils makes using FileUtils easier}
+    gem.email = "james@jameswilding.net"
+    gem.homepage = "http://github.com/jameswilding/file-utils"
+    gem.authors = ["jameswilding"]
+    gem.add_development_dependency "thoughtbot-shoulda"
+    gem.add_development_dependency "redgreen"    
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "file-utils #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/file/utils.rb

@@ -0,0 +1,60 @@
+class File #:nodoc:
+  module Utils
+    extend self
+    
+    # Creates a file. If you provide a block, the method
+    # will yield the created file, opened for writing.
+    #
+    # === Without a block
+    #
+    #   File::Utils.create '/my/file/rb'
+    #
+    # === With a block
+    #
+    #   File::Utils.create '/my/file.rb' do |f|
+    #     f.write "some code here" 
+    #   end
+    #
+    # === Raises
+    #   Errno::EEXIST:: if the file already exists
+    def create(path, &block)
+      if File.file?(path)
+        raise Errno::EEXIST, path
+      end
+      
+      FileUtils.mkdir_p(File.dirname(path))
+      FileUtils.touch(path)
+      
+      if block_given?
+        begin yield file = File.open(path, 'w')
+        ensure file.close
+        end
+      end
+    end
+    
+    # File::Utils.remove '/my/file.asp'
+    # File::Utils.remove Dir['*.asp']
+    def destroy(*paths)
+      paths.each do |path|
+        FileUtils.rm(path) if File.file?(path)        
+      end
+    end
+    
+    # Acts like <tt>remove</tt>, but doesn't check whether files exist
+    # before attempting to remove them.
+    #
+    # === Raises
+    #   Errno::ENOENT:: if a file you're trying to delete doesn't exist.
+    def destroy!(*paths)
+      paths.each do |path|
+        FileUtils.rm(path)
+      end
+    end
+    
+    # Opens a file, overwrite its contents with the contents you provide,
+    # then closes the file.
+    def rewrite(path, contents)
+      File.open(path, 'w') { |f| f.write(contents) }
+    end    
+  end
+end

data/test/file_utils_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class UtilsTest < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'redgreen'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'file/utils'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification 
+name: file-utils
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- jameswilding
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-16 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: redgreen
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: file-utils makes using FileUtils easier
+email: james@jameswilding.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- lib/file/utils.rb
+- test/file_utils_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/jameswilding/file-utils
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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.3.5
+signing_key: 
+specification_version: 3
+summary: A beautiful wrapper for FileUtils
+test_files: 
+- test/file_utils_test.rb
+- test/test_helper.rb