file-utils 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/.document +5 -0
- data/.gitignore +5 -0
- data/LICENSE +20 -0
- data/README.md +42 -0
- data/Rakefile +56 -0
- data/VERSION +1 -0
- data/lib/file/utils.rb +60 -0
- data/test/file_utils_test.rb +7 -0
- data/test/test_helper.rb +11 -0
- metadata +84 -0
data/.document
ADDED
data/LICENSE
ADDED
@@ -0,0 +1,20 @@
|
|
1
|
+
Copyright (c) 2009 James Wilding
|
2
|
+
|
3
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
4
|
+
a copy of this software and associated documentation files (the
|
5
|
+
"Software"), to deal in the Software without restriction, including
|
6
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
7
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
8
|
+
permit persons to whom the Software is furnished to do so, subject to
|
9
|
+
the following conditions:
|
10
|
+
|
11
|
+
The above copyright notice and this permission notice shall be
|
12
|
+
included in all copies or substantial portions of the Software.
|
13
|
+
|
14
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
15
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
16
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
17
|
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
18
|
+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
19
|
+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
20
|
+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,42 @@
|
|
1
|
+
# file-utils
|
2
|
+
|
3
|
+
gem install file-utils
|
4
|
+
|
5
|
+
A better-looking wrapper for some common uses of FileUtils.
|
6
|
+
|
7
|
+
## Usage
|
8
|
+
|
9
|
+
require 'file/utils'
|
10
|
+
|
11
|
+
File::Utils.create '/some/file.rb'
|
12
|
+
File::Utils.create '/some/other/file.rb' do |f|
|
13
|
+
f.write "Hello world!"
|
14
|
+
end
|
15
|
+
File::Utils.rewrite '/some/other/file.rb', 'New contents'
|
16
|
+
File::Utils.destroy ['/some/file.rb', '/some/other/file.rb']
|
17
|
+
|
18
|
+
See the docs in <tt>lib/file/utils.rb</tt> for more usage examples.
|
19
|
+
|
20
|
+
## Contributing
|
21
|
+
|
22
|
+
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 :)
|
23
|
+
|
24
|
+
## To Do
|
25
|
+
|
26
|
+
Tests!
|
27
|
+
|
28
|
+
## Note on Patches/Pull Requests
|
29
|
+
|
30
|
+
* Fork the project.
|
31
|
+
* Make your feature addition or bug fix.
|
32
|
+
* Keep it simple.
|
33
|
+
* Add tests for it. This is important so I don't break it in a
|
34
|
+
future version unintentionally.
|
35
|
+
* Commit, do not mess with rakefile, version, or history.
|
36
|
+
(if you want to have your own version, that is fine but
|
37
|
+
bump version in a commit by itself I can ignore when I pull)
|
38
|
+
* Send me a pull request. Bonus points for topic branches.
|
39
|
+
|
40
|
+
## Copyright
|
41
|
+
|
42
|
+
Copyright (c) 2010 James Wilding. See LICENSE for details.
|
data/Rakefile
ADDED
@@ -0,0 +1,56 @@
|
|
1
|
+
require 'rubygems'
|
2
|
+
require 'rake'
|
3
|
+
|
4
|
+
begin
|
5
|
+
require 'jeweler'
|
6
|
+
Jeweler::Tasks.new do |gem|
|
7
|
+
gem.name = "file-utils"
|
8
|
+
gem.summary = %Q{A beautiful wrapper for FileUtils}
|
9
|
+
gem.description = %Q{file-utils makes using FileUtils easier}
|
10
|
+
gem.email = "james@jameswilding.net"
|
11
|
+
gem.homepage = "http://github.com/jameswilding/file-utils"
|
12
|
+
gem.authors = ["jameswilding"]
|
13
|
+
gem.add_development_dependency "thoughtbot-shoulda"
|
14
|
+
gem.add_development_dependency "redgreen"
|
15
|
+
# gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
|
16
|
+
end
|
17
|
+
Jeweler::GemcutterTasks.new
|
18
|
+
rescue LoadError
|
19
|
+
puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
|
20
|
+
end
|
21
|
+
|
22
|
+
require 'rake/testtask'
|
23
|
+
Rake::TestTask.new(:test) do |test|
|
24
|
+
test.libs << 'lib' << 'test'
|
25
|
+
test.pattern = 'test/**/*_test.rb'
|
26
|
+
test.verbose = true
|
27
|
+
end
|
28
|
+
|
29
|
+
begin
|
30
|
+
require 'rcov/rcovtask'
|
31
|
+
Rcov::RcovTask.new do |test|
|
32
|
+
test.libs << 'test'
|
33
|
+
test.pattern = 'test/**/*_test.rb'
|
34
|
+
test.verbose = true
|
35
|
+
end
|
36
|
+
rescue LoadError
|
37
|
+
task :rcov do
|
38
|
+
abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
|
39
|
+
end
|
40
|
+
end
|
41
|
+
|
42
|
+
task :default => :test
|
43
|
+
|
44
|
+
require 'rake/rdoctask'
|
45
|
+
Rake::RDocTask.new do |rdoc|
|
46
|
+
if File.exist?('VERSION')
|
47
|
+
version = File.read('VERSION')
|
48
|
+
else
|
49
|
+
version = ""
|
50
|
+
end
|
51
|
+
|
52
|
+
rdoc.rdoc_dir = 'rdoc'
|
53
|
+
rdoc.title = "file-utils #{version}"
|
54
|
+
rdoc.rdoc_files.include('README*')
|
55
|
+
rdoc.rdoc_files.include('lib/**/*.rb')
|
56
|
+
end
|
data/VERSION
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
0.1.0
|
data/lib/file/utils.rb
ADDED
@@ -0,0 +1,60 @@
|
|
1
|
+
class File #:nodoc:
|
2
|
+
module Utils
|
3
|
+
extend self
|
4
|
+
|
5
|
+
# Creates a file. If you provide a block, the method
|
6
|
+
# will yield the created file, opened for writing.
|
7
|
+
#
|
8
|
+
# === Without a block
|
9
|
+
#
|
10
|
+
# File::Utils.create '/my/file/rb'
|
11
|
+
#
|
12
|
+
# === With a block
|
13
|
+
#
|
14
|
+
# File::Utils.create '/my/file.rb' do |f|
|
15
|
+
# f.write "some code here"
|
16
|
+
# end
|
17
|
+
#
|
18
|
+
# === Raises
|
19
|
+
# Errno::EEXIST:: if the file already exists
|
20
|
+
def create(path, &block)
|
21
|
+
if File.file?(path)
|
22
|
+
raise Errno::EEXIST, path
|
23
|
+
end
|
24
|
+
|
25
|
+
FileUtils.mkdir_p(File.dirname(path))
|
26
|
+
FileUtils.touch(path)
|
27
|
+
|
28
|
+
if block_given?
|
29
|
+
begin yield file = File.open(path, 'w')
|
30
|
+
ensure file.close
|
31
|
+
end
|
32
|
+
end
|
33
|
+
end
|
34
|
+
|
35
|
+
# File::Utils.remove '/my/file.asp'
|
36
|
+
# File::Utils.remove Dir['*.asp']
|
37
|
+
def destroy(*paths)
|
38
|
+
paths.each do |path|
|
39
|
+
FileUtils.rm(path) if File.file?(path)
|
40
|
+
end
|
41
|
+
end
|
42
|
+
|
43
|
+
# Acts like <tt>remove</tt>, but doesn't check whether files exist
|
44
|
+
# before attempting to remove them.
|
45
|
+
#
|
46
|
+
# === Raises
|
47
|
+
# Errno::ENOENT:: if a file you're trying to delete doesn't exist.
|
48
|
+
def destroy!(*paths)
|
49
|
+
paths.each do |path|
|
50
|
+
FileUtils.rm(path)
|
51
|
+
end
|
52
|
+
end
|
53
|
+
|
54
|
+
# Opens a file, overwrite its contents with the contents you provide,
|
55
|
+
# then closes the file.
|
56
|
+
def rewrite(path, contents)
|
57
|
+
File.open(path, 'w') { |f| f.write(contents) }
|
58
|
+
end
|
59
|
+
end
|
60
|
+
end
|
data/test/test_helper.rb
ADDED
@@ -0,0 +1,11 @@
|
|
1
|
+
require 'rubygems'
|
2
|
+
require 'test/unit'
|
3
|
+
require 'shoulda'
|
4
|
+
require 'redgreen'
|
5
|
+
|
6
|
+
$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
|
7
|
+
$LOAD_PATH.unshift(File.dirname(__FILE__))
|
8
|
+
require 'file/utils'
|
9
|
+
|
10
|
+
class Test::Unit::TestCase
|
11
|
+
end
|
metadata
ADDED
@@ -0,0 +1,84 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: file-utils
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- jameswilding
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
|
12
|
+
date: 2010-01-16 00:00:00 +00:00
|
13
|
+
default_executable:
|
14
|
+
dependencies:
|
15
|
+
- !ruby/object:Gem::Dependency
|
16
|
+
name: thoughtbot-shoulda
|
17
|
+
type: :development
|
18
|
+
version_requirement:
|
19
|
+
version_requirements: !ruby/object:Gem::Requirement
|
20
|
+
requirements:
|
21
|
+
- - ">="
|
22
|
+
- !ruby/object:Gem::Version
|
23
|
+
version: "0"
|
24
|
+
version:
|
25
|
+
- !ruby/object:Gem::Dependency
|
26
|
+
name: redgreen
|
27
|
+
type: :development
|
28
|
+
version_requirement:
|
29
|
+
version_requirements: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - ">="
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: "0"
|
34
|
+
version:
|
35
|
+
description: file-utils makes using FileUtils easier
|
36
|
+
email: james@jameswilding.net
|
37
|
+
executables: []
|
38
|
+
|
39
|
+
extensions: []
|
40
|
+
|
41
|
+
extra_rdoc_files:
|
42
|
+
- LICENSE
|
43
|
+
- README.md
|
44
|
+
files:
|
45
|
+
- .document
|
46
|
+
- .gitignore
|
47
|
+
- LICENSE
|
48
|
+
- README.md
|
49
|
+
- Rakefile
|
50
|
+
- VERSION
|
51
|
+
- lib/file/utils.rb
|
52
|
+
- test/file_utils_test.rb
|
53
|
+
- test/test_helper.rb
|
54
|
+
has_rdoc: true
|
55
|
+
homepage: http://github.com/jameswilding/file-utils
|
56
|
+
licenses: []
|
57
|
+
|
58
|
+
post_install_message:
|
59
|
+
rdoc_options:
|
60
|
+
- --charset=UTF-8
|
61
|
+
require_paths:
|
62
|
+
- lib
|
63
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
64
|
+
requirements:
|
65
|
+
- - ">="
|
66
|
+
- !ruby/object:Gem::Version
|
67
|
+
version: "0"
|
68
|
+
version:
|
69
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
70
|
+
requirements:
|
71
|
+
- - ">="
|
72
|
+
- !ruby/object:Gem::Version
|
73
|
+
version: "0"
|
74
|
+
version:
|
75
|
+
requirements: []
|
76
|
+
|
77
|
+
rubyforge_project:
|
78
|
+
rubygems_version: 1.3.5
|
79
|
+
signing_key:
|
80
|
+
specification_version: 3
|
81
|
+
summary: A beautiful wrapper for FileUtils
|
82
|
+
test_files:
|
83
|
+
- test/file_utils_test.rb
|
84
|
+
- test/test_helper.rb
|