fearoffish-backup 0.0.1

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/History.txt ADDED
@@ -0,0 +1,4 @@
1
+ == 0.0.1 / 2008-05-01
2
+
3
+ * 1 major enhancement
4
+ * Birth!
data/LICENSE ADDED
@@ -0,0 +1,19 @@
1
+ Backup
2
+
3
+ (The GPL v.2 License)
4
+
5
+ Copyright (C) 2008 Engine Yard Inc.
6
+
7
+ This program is free software; you can redistribute it and/or modify
8
+ it under the terms of the GNU General Public License as published by
9
+ the Free Software Foundation; either version 2 of the License, or
10
+ (at your option) any later version.
11
+
12
+ This program is distributed in the hope that it will be useful,
13
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
14
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15
+ GNU General Public License for more details.
16
+
17
+ You should have received a copy of the GNU General Public License along
18
+ with this program; if not, write to the Free Software Foundation, Inc.,
19
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
data/Manifest.txt ADDED
@@ -0,0 +1,22 @@
1
+ History.txt
2
+ LICENSE
3
+ Manifest.txt
4
+ README.txt
5
+ Rakefile
6
+ lib/backup.rb
7
+ lib/backup/backup.rb
8
+ spec/backup/backup_spec.rb
9
+ spec/spec.opts
10
+ spec/spec_helper.rb
11
+ tasks/ann.rake
12
+ tasks/bones.rake
13
+ tasks/gem.rake
14
+ tasks/manifest.rake
15
+ tasks/notes.rake
16
+ tasks/post_load.rake
17
+ tasks/rdoc.rake
18
+ tasks/rubyforge.rake
19
+ tasks/setup.rb
20
+ tasks/spec.rake
21
+ tasks/svn.rake
22
+ tasks/test.rake
data/README.txt ADDED
@@ -0,0 +1,54 @@
1
+ backup
2
+ by Jamie van Dyke - Engine Yard Inc.
3
+
4
+ == DESCRIPTION:
5
+
6
+ A library to keep the latest X number of a file as backups
7
+
8
+ == FEATURES/PROBLEMS:
9
+
10
+ FIXME: The spec for checking it backs up the latest X files, passes no matter what
11
+ FIXME: Make releases an instance variable, not a constant
12
+
13
+ == SYNOPSIS:
14
+
15
+ # Take the file and create a timestamped version of it
16
+ # Keeping only the latest X number of backups
17
+ backup = Backup.new("/my/file")
18
+ backup.run
19
+
20
+ == REQUIREMENTS:
21
+
22
+ None
23
+
24
+ == INSTALL:
25
+
26
+ RubyGems >= 1.1.1
27
+
28
+ $ sudo gem sources -a http://gems.github.com/ (you only need to do this once)
29
+ $ sudo gem install fearoffish-backup
30
+
31
+ RubyGems < 1.1.1
32
+
33
+ $ sudo gem install fearoffish-backup --source=http://gems.github.com
34
+
35
+
36
+ == LICENSE:
37
+
38
+ (The GPL v.2 License)
39
+
40
+ Copyright (C) 2008 Engine Yard Inc.
41
+
42
+ This program is free software; you can redistribute it and/or modify
43
+ it under the terms of the GNU General Public License as published by
44
+ the Free Software Foundation; either version 2 of the License, or
45
+ (at your option) any later version.
46
+
47
+ This program is distributed in the hope that it will be useful,
48
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
49
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
50
+ GNU General Public License for more details.
51
+
52
+ You should have received a copy of the GNU General Public License along
53
+ with this program; if not, write to the Free Software Foundation, Inc.,
54
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
data/Rakefile ADDED
@@ -0,0 +1,21 @@
1
+ # Look in the tasks/setup.rb file for the various options that can be
2
+ # configured in this Rakefile. The .rake files in the tasks directory
3
+ # are where the options are used.
4
+
5
+ require 'lib/backup/backup.rb'
6
+ ENV['VERSION'] = EngineYard::Backup::VERSION
7
+ load 'tasks/setup.rb'
8
+
9
+ ensure_in_path 'lib'
10
+
11
+ task :default => 'spec:run'
12
+
13
+ PROJ.name = 'backup'
14
+ PROJ.authors = 'Jamie van Dyke'
15
+ PROJ.email = 'jvandyke@engineyard.com'
16
+ # PROJ.url = ''
17
+ # PROJ.rubyforge.name = 'backup'
18
+
19
+ PROJ.spec.opts << '--color'
20
+
21
+ # EOF
data/lib/backup.rb ADDED
@@ -0,0 +1,9 @@
1
+ $:.unshift(File.dirname(__FILE__)) unless
2
+ $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
3
+
4
+ APP_ROOT = File.expand_path('../') unless defined?(APP_ROOT)
5
+
6
+ require 'date'
7
+ require 'fileutils'
8
+
9
+ require 'backup/backup.rb'
@@ -0,0 +1,62 @@
1
+ module EngineYard
2
+ class Backup
3
+ include FileUtils
4
+
5
+ attr_reader :filename, :backups
6
+
7
+ VERSION = "0.0.1"
8
+
9
+ RELEASES = 5
10
+ TIMESTAMP = "%Y%m%d%H%M%S"
11
+
12
+ def initialize(file)
13
+ raise "No such file found" unless File.file?(file)
14
+ @filename, @backups = file, []
15
+ end
16
+
17
+ def run
18
+ backup_current
19
+ delete_old_backups
20
+ end
21
+
22
+ def backup_current
23
+ FileUtils.mv(@filename, "#{@filename}.#{Time.now.strftime(TIMESTAMP)}")
24
+ end
25
+
26
+ # Look for releases and delete the oldest ones outside of our RELEASES threshold
27
+ def delete_old_backups
28
+ find_all_releases
29
+ delete_list = @backups - keep_list
30
+ delete_list.each {|f| File.delete(f) }
31
+ end
32
+
33
+ def keep_list
34
+ @backups[-RELEASES..-1]
35
+ end
36
+
37
+ # Find all versions of our backup filename, which match file.TIMESTAMP
38
+ def find_all_releases
39
+ Dir.chdir(File.dirname(@filename))
40
+ backups = Dir.glob("#{File.basename(@filename)}.*")
41
+ remove_faults(backups)
42
+ backups.sort! do |x,y|
43
+ Date.strptime(x.split(".").last, TIMESTAMP) <=> Date.strptime(y.split(".").last, TIMESTAMP)
44
+ end
45
+ @backups = backups
46
+ end
47
+
48
+ private
49
+
50
+ def remove_faults(backups)
51
+ backups.each do |backup|
52
+ begin
53
+ Date.strptime(backup.split(".").last, TIMESTAMP)
54
+ rescue ArgumentError
55
+ backups.delete(backup)
56
+ end
57
+ end
58
+ backups
59
+ end
60
+
61
+ end
62
+ end
@@ -0,0 +1,84 @@
1
+ # $Id$
2
+
3
+ require File.join(File.dirname(__FILE__), %w[.. spec_helper])
4
+ require 'lib/boot.rb'
5
+
6
+ include EngineYard
7
+
8
+ describe Backup do
9
+
10
+ describe "when initialized" do
11
+ it "should take 1 argument of a filename" do
12
+ lambda { Backup.new }.should raise_error(ArgumentError)
13
+ lambda { Backup.new("something") }.should raise_error("No such file found")
14
+ File.should_receive(:file?).any_number_of_times.and_return(true)
15
+ lambda { Backup.new("something") }.should_not raise_error
16
+ end
17
+
18
+ describe "and passed a valid filename" do
19
+ before(:each) do
20
+ File.should_receive(:file?).any_number_of_times.and_return(true)
21
+ Dir.stub!(:glob).and_return(
22
+ %w[ my.cnf.20050430185242 my.cnf.20080430185243 my.cnf.20080430185242
23
+ my.cnf.20060420185242 my.cnf.20070430185242 my.cnf.20060430185242
24
+ my.cnf.20060410185242 my.cnf.20040430185242 my.cnf.20050430185242 ]
25
+ )
26
+ @backup = Backup.new("my.cnf")
27
+ end
28
+
29
+ it "should save a new file and delete all backups out of the threshold" do
30
+ FileUtils.should_receive(:mv).exactly(1).times
31
+ File.should_receive(:delete).with(/^my.cnf./).exactly(4).times.and_return(1)
32
+ @backup.run
33
+ end
34
+
35
+ describe "which returns a valid glob of files" do
36
+
37
+ before(:each) do
38
+ Dir.stub!(:glob).and_return(
39
+ %w[ my.cnf.20050430185242 my.cnf.20080430185243 my.cnf.20080430185242
40
+ my.cnf.20060420185242 my.cnf.20070430185242 my.cnf.20060430185242
41
+ my.cnf.20060410185242 my.cnf.20040430185242 my.cnf.20050430185241 ]
42
+ )
43
+ @backup = Backup.new("my.cnf")
44
+ @backup.find_all_releases
45
+ end
46
+
47
+ it "should sort them into chronological order" do
48
+ @backup.backups.should eql(
49
+ %w[ my.cnf.20080430185243 my.cnf.20080430185242 my.cnf.20070430185242
50
+ my.cnf.20060430185242 my.cnf.20060420185242 my.cnf.20060410185242
51
+ my.cnf.20050430185241 my.cnf.20050430185242 my.cnf.20040430185242 ].reverse
52
+ )
53
+ end
54
+
55
+ it "should keep the 5 newest releases when creating a new backup" do
56
+ @backup.keep_list.should eql(
57
+ %w[ my.cnf.20080430185243 my.cnf.20080430185242 my.cnf.20070430185242
58
+ my.cnf.20060430185242 my.cnf.20060420185242 ].reverse
59
+ )
60
+ end
61
+
62
+ end
63
+
64
+ describe "which returns an invalid glob of files" do
65
+
66
+ before(:each) do
67
+ Dir.stub!(:glob).and_return(
68
+ %w[ my.cnf.2005a85242 my.cnf.20080430185243 my.cnf.20080430185242 ]
69
+ )
70
+ end
71
+
72
+ it "should handle incorrectly named files gracefully" do
73
+ lambda { Backup.new("my.cnf") }.should_not raise_error(ArgumentError)
74
+ end
75
+
76
+ end
77
+
78
+ end
79
+
80
+ end
81
+
82
+ end
83
+
84
+ # EOF
data/spec/spec.opts ADDED
@@ -0,0 +1,6 @@
1
+ --format
2
+ progress
3
+ --loadby
4
+ mtime
5
+ --reverse
6
+ --color
@@ -0,0 +1,14 @@
1
+ # $Id$
2
+
3
+ Spec::Runner.configure do |config|
4
+ # == Mock Framework
5
+ #
6
+ # RSpec uses it's own mocking framework by default. If you prefer to
7
+ # use mocha, flexmock or RR, uncomment the appropriate line:
8
+ #
9
+ # config.mock_with :mocha
10
+ # config.mock_with :flexmock
11
+ # config.mock_with :rr
12
+ end
13
+
14
+ # EOF
data/tasks/ann.rake ADDED
@@ -0,0 +1,81 @@
1
+ # $Id$
2
+
3
+ begin
4
+ require 'bones/smtp_tls'
5
+ rescue LoadError
6
+ require 'net/smtp'
7
+ end
8
+ require 'time'
9
+
10
+ namespace :ann do
11
+
12
+ # A prerequisites task that all other tasks depend upon
13
+ task :prereqs
14
+
15
+ file PROJ.ann.file do
16
+ ann = PROJ.ann
17
+ puts "Generating #{ann.file}"
18
+ File.open(ann.file,'w') do |fd|
19
+ fd.puts("#{PROJ.name} version #{PROJ.version}")
20
+ fd.puts(" by #{Array(PROJ.authors).first}") if PROJ.authors
21
+ fd.puts(" #{PROJ.url}") if PROJ.url.valid?
22
+ fd.puts(" (the \"#{PROJ.release_name}\" release)") if PROJ.release_name
23
+ fd.puts
24
+ fd.puts("== DESCRIPTION")
25
+ fd.puts
26
+ fd.puts(PROJ.description)
27
+ fd.puts
28
+ fd.puts(PROJ.changes.sub(%r/^.*$/, '== CHANGES'))
29
+ fd.puts
30
+ ann.paragraphs.each do |p|
31
+ fd.puts "== #{p.upcase}"
32
+ fd.puts
33
+ fd.puts paragraphs_of(PROJ.readme_file, p).join("\n\n")
34
+ fd.puts
35
+ end
36
+ fd.puts ann.text if ann.text
37
+ end
38
+ end
39
+
40
+ desc "Create an announcement file"
41
+ task :announcement => ['ann:prereqs', PROJ.ann.file]
42
+
43
+ desc "Send an email announcement"
44
+ task :email => ['ann:prereqs', PROJ.ann.file] do
45
+ ann = PROJ.ann
46
+ from = ann.email[:from] || PROJ.email
47
+ to = Array(ann.email[:to])
48
+
49
+ ### build a mail header for RFC 822
50
+ rfc822msg = "From: #{from}\n"
51
+ rfc822msg << "To: #{to.join(',')}\n"
52
+ rfc822msg << "Subject: [ANN] #{PROJ.name} #{PROJ.version}"
53
+ rfc822msg << " (#{PROJ.release_name})" if PROJ.release_name
54
+ rfc822msg << "\n"
55
+ rfc822msg << "Date: #{Time.new.rfc822}\n"
56
+ rfc822msg << "Message-Id: "
57
+ rfc822msg << "<#{"%.8f" % Time.now.to_f}@#{ann.email[:domain]}>\n\n"
58
+ rfc822msg << File.read(ann.file)
59
+
60
+ params = [:server, :port, :domain, :acct, :passwd, :authtype].map do |key|
61
+ ann.email[key]
62
+ end
63
+
64
+ params[3] = PROJ.email if params[3].nil?
65
+
66
+ if params[4].nil?
67
+ STDOUT.write "Please enter your e-mail password (#{params[3]}): "
68
+ params[4] = STDIN.gets.chomp
69
+ end
70
+
71
+ ### send email
72
+ Net::SMTP.start(*params) {|smtp| smtp.sendmail(rfc822msg, from, to)}
73
+ end
74
+ end # namespace :ann
75
+
76
+ desc 'Alias to ann:announcement'
77
+ task :ann => 'ann:announcement'
78
+
79
+ CLOBBER << PROJ.ann.file
80
+
81
+ # EOF
data/tasks/bones.rake ADDED
@@ -0,0 +1,21 @@
1
+ # $Id$
2
+
3
+ if HAVE_BONES
4
+
5
+ namespace :bones do
6
+
7
+ desc 'Show the PROJ open struct'
8
+ task :debug do |t|
9
+ atr = if ARGV.length == 2
10
+ t.application.top_level_tasks.pop
11
+ end
12
+
13
+ if atr then Bones::Debug.show_attr(PROJ, atr)
14
+ else Bones::Debug.show PROJ end
15
+ end
16
+
17
+ end # namespace :bones
18
+
19
+ end # HAVE_BONES
20
+
21
+ # EOF
data/tasks/gem.rake ADDED
@@ -0,0 +1,118 @@
1
+ # $Id$
2
+
3
+ require 'rake/gempackagetask'
4
+
5
+ namespace :gem do
6
+
7
+ PROJ.gem._spec = Gem::Specification.new do |s|
8
+ s.name = PROJ.name
9
+ s.version = PROJ.version
10
+ s.summary = PROJ.summary
11
+ s.authors = Array(PROJ.authors)
12
+ s.email = PROJ.email
13
+ s.homepage = Array(PROJ.url).first
14
+ s.rubyforge_project = PROJ.rubyforge.name
15
+
16
+ s.description = PROJ.description
17
+
18
+ PROJ.gem.dependencies.each do |dep|
19
+ s.add_dependency(*dep)
20
+ end
21
+
22
+ s.files = PROJ.gem.files
23
+ s.executables = PROJ.gem.executables.map {|fn| File.basename(fn)}
24
+ s.extensions = PROJ.gem.files.grep %r/extconf\.rb$/
25
+
26
+ s.bindir = 'bin'
27
+ dirs = Dir["{#{PROJ.libs.join(',')}}"]
28
+ s.require_paths = dirs unless dirs.empty?
29
+
30
+ incl = Regexp.new(PROJ.rdoc.include.join('|'))
31
+ excl = PROJ.rdoc.exclude.dup.concat %w[\.rb$ ^(\.\/|\/)?ext]
32
+ excl = Regexp.new(excl.join('|'))
33
+ rdoc_files = PROJ.gem.files.find_all do |fn|
34
+ case fn
35
+ when excl; false
36
+ when incl; true
37
+ else false end
38
+ end
39
+ s.rdoc_options = PROJ.rdoc.opts + ['--main', PROJ.rdoc.main]
40
+ s.extra_rdoc_files = rdoc_files
41
+ s.has_rdoc = true
42
+
43
+ if test ?f, PROJ.test.file
44
+ s.test_file = PROJ.test.file
45
+ else
46
+ s.test_files = PROJ.test.files.to_a
47
+ end
48
+
49
+ # Do any extra stuff the user wants
50
+ PROJ.gem.extras.each do |msg, val|
51
+ case val
52
+ when Proc
53
+ val.call(s.send(msg))
54
+ else
55
+ s.send "#{msg}=", val
56
+ end
57
+ end
58
+ end # Gem::Specification.new
59
+
60
+ # A prerequisites task that all other tasks depend upon
61
+ task :prereqs
62
+
63
+ desc 'Show information about the gem'
64
+ task :debug => 'gem:prereqs' do
65
+ puts PROJ.gem._spec.to_ruby
66
+ end
67
+
68
+ pkg = Rake::PackageTask.new(PROJ.name, PROJ.version) do |pkg|
69
+ pkg.need_tar = PROJ.gem.need_tar
70
+ pkg.need_zip = PROJ.gem.need_zip
71
+ pkg.package_files += PROJ.gem._spec.files
72
+ end
73
+ Rake::Task['gem:package'].instance_variable_set(:@full_comment, nil)
74
+
75
+ gem_file = if PROJ.gem._spec.platform == Gem::Platform::RUBY
76
+ "#{pkg.package_name}.gem"
77
+ else
78
+ "#{pkg.package_name}-#{PROJ.gem._spec.platform}.gem"
79
+ end
80
+
81
+ desc "Build the gem file #{gem_file}"
82
+ task :package => ['gem:prereqs', "#{pkg.package_dir}/#{gem_file}"]
83
+
84
+ file "#{pkg.package_dir}/#{gem_file}" => [pkg.package_dir] + PROJ.gem._spec.files do
85
+ when_writing("Creating GEM") {
86
+ Gem::Builder.new(PROJ.gem._spec).build
87
+ verbose(true) {
88
+ mv gem_file, "#{pkg.package_dir}/#{gem_file}"
89
+ }
90
+ }
91
+ end
92
+
93
+ desc 'Install the gem'
94
+ task :install => [:clobber, :package] do
95
+ sh "#{SUDO} #{GEM} install --no-update-sources pkg/#{PROJ.gem._spec.full_name}"
96
+ end
97
+
98
+ desc 'Uninstall the gem'
99
+ task :uninstall do
100
+ installed_list = Gem.source_index.find_name(PROJ.name)
101
+ if installed_list and installed_list.collect { |s| s.version.to_s}.include?(PROJ.version) then
102
+ sh "#{SUDO} #{GEM} uninstall -v '#{PROJ.version}' -I -x #{PROJ.name}"
103
+ end
104
+ end
105
+
106
+ desc 'Reinstall the gem'
107
+ task :reinstall => [:uninstall, :install]
108
+
109
+ end # namespace :gem
110
+
111
+ desc 'Alias to gem:package'
112
+ task :gem => 'gem:package'
113
+
114
+ task :clobber => 'gem:clobber_package'
115
+
116
+ remove_desc_for_task %w(gem:clobber_package)
117
+
118
+ # EOF
@@ -0,0 +1,49 @@
1
+ # $Id$
2
+
3
+ require 'find'
4
+
5
+ namespace :manifest do
6
+
7
+ desc 'Verify the manifest'
8
+ task :check do
9
+ fn = PROJ.manifest_file + '.tmp'
10
+ files = manifest_files
11
+
12
+ File.open(fn, 'w') {|fp| fp.puts files}
13
+ lines = %x(#{DIFF} -du #{PROJ.manifest_file} #{fn}).split("\n")
14
+ if HAVE_FACETS_ANSICODE and ENV.has_key?('TERM')
15
+ lines.map! do |line|
16
+ case line
17
+ when %r/^(-{3}|\+{3})/; nil
18
+ when %r/^@/; Console::ANSICode.blue line
19
+ when %r/^\+/; Console::ANSICode.green line
20
+ when %r/^\-/; Console::ANSICode.red line
21
+ else line end
22
+ end
23
+ end
24
+ puts lines.compact
25
+ rm fn rescue nil
26
+ end
27
+
28
+ desc 'Create a new manifest'
29
+ task :create do
30
+ files = manifest_files
31
+ unless test(?f, PROJ.manifest_file)
32
+ files << PROJ.manifest_file
33
+ files.sort!
34
+ end
35
+ File.open(PROJ.manifest_file, 'w') {|fp| fp.puts files}
36
+ end
37
+
38
+ task :assert do
39
+ files = manifest_files
40
+ manifest = File.read(PROJ.manifest_file).split($/)
41
+ raise "ERROR: #{PROJ.manifest_file} is out of date" unless files == manifest
42
+ end
43
+
44
+ end # namespace :manifest
45
+
46
+ desc 'Alias to manifest:check'
47
+ task :manifest => 'manifest:check'
48
+
49
+ # EOF
data/tasks/notes.rake ADDED
@@ -0,0 +1,28 @@
1
+ # $Id$
2
+
3
+ if HAVE_BONES
4
+
5
+ desc "Enumerate all annotations"
6
+ task :notes do |t|
7
+ id = if ARGV.length > 1
8
+ t.application.top_level_tasks.slice!(1..-1).join(' ')
9
+ end
10
+ Bones::AnnotationExtractor.enumerate(
11
+ PROJ, PROJ.notes.tags.join('|'), id, :tag => true)
12
+ end
13
+
14
+ namespace :notes do
15
+ PROJ.notes.tags.each do |tag|
16
+ desc "Enumerate all #{tag} annotations"
17
+ task tag.downcase.to_sym do |t|
18
+ id = if ARGV.length > 1
19
+ t.application.top_level_tasks.slice!(1..-1).join(' ')
20
+ end
21
+ Bones::AnnotationExtractor.enumerate(PROJ, tag, id)
22
+ end
23
+ end
24
+ end
25
+
26
+ end # if HAVE_BONES
27
+
28
+ # EOF
@@ -0,0 +1,37 @@
1
+ # $Id$
2
+
3
+ # This file does not define any rake tasks. It is used to load some project
4
+ # settings if they are not defined by the user.
5
+
6
+ PROJ.rdoc.exclude << "^#{Regexp.escape(PROJ.manifest_file)}$"
7
+ PROJ.exclude << "^#{Regexp.escape(PROJ.ann.file)}$"
8
+
9
+ flatten_arrays = lambda do |this,os|
10
+ os.instance_variable_get(:@table).each do |key,val|
11
+ next if key == :dependencies
12
+ case val
13
+ when Array; val.flatten!
14
+ when OpenStruct; this.call(this,val)
15
+ end
16
+ end
17
+ end
18
+ flatten_arrays.call(flatten_arrays,PROJ)
19
+
20
+ PROJ.changes ||= paragraphs_of(PROJ.history_file, 0..1).join("\n\n")
21
+
22
+ PROJ.description ||= paragraphs_of(PROJ.readme_file, 'description').join("\n\n")
23
+
24
+ PROJ.summary ||= PROJ.description.split('.').first
25
+
26
+ PROJ.gem.files ||=
27
+ if test(?f, PROJ.manifest_file)
28
+ files = File.readlines(PROJ.manifest_file).map {|fn| fn.chomp.strip}
29
+ files.delete ''
30
+ files
31
+ else [] end
32
+
33
+ PROJ.gem.executables ||= PROJ.gem.files.find_all {|fn| fn =~ %r/^bin/}
34
+
35
+ PROJ.rdoc.main ||= PROJ.readme_file
36
+
37
+ # EOF
data/tasks/rdoc.rake ADDED
@@ -0,0 +1,51 @@
1
+ # $Id$
2
+
3
+ require 'rake/rdoctask'
4
+
5
+ namespace :doc do
6
+
7
+ desc 'Generate RDoc documentation'
8
+ Rake::RDocTask.new do |rd|
9
+ rdoc = PROJ.rdoc
10
+ rd.main = rdoc.main
11
+ rd.rdoc_dir = rdoc.dir
12
+
13
+ incl = Regexp.new(rdoc.include.join('|'))
14
+ excl = Regexp.new(rdoc.exclude.join('|'))
15
+ files = PROJ.gem.files.find_all do |fn|
16
+ case fn
17
+ when excl; false
18
+ when incl; true
19
+ else false end
20
+ end
21
+ rd.rdoc_files.push(*files)
22
+
23
+ title = "#{PROJ.name}-#{PROJ.version} Documentation"
24
+
25
+ rf_name = PROJ.rubyforge.name
26
+ title = "#{rf_name}'s " + title if rf_name.valid? and rf_name != title
27
+
28
+ rd.options << "-t #{title}"
29
+ rd.options.concat(rdoc.opts)
30
+ end
31
+
32
+ desc 'Generate ri locally for testing'
33
+ task :ri => :clobber_ri do
34
+ sh "#{RDOC} --ri -o ri ."
35
+ end
36
+
37
+ task :clobber_ri do
38
+ rm_r 'ri' rescue nil
39
+ end
40
+
41
+ end # namespace :doc
42
+
43
+ desc 'Alias to doc:rdoc'
44
+ task :doc => 'doc:rdoc'
45
+
46
+ desc 'Remove all build products'
47
+ task :clobber => %w(doc:clobber_rdoc doc:clobber_ri)
48
+
49
+ remove_desc_for_task %w(doc:clobber_rdoc)
50
+
51
+ # EOF
@@ -0,0 +1,57 @@
1
+ # $Id$
2
+
3
+ if PROJ.rubyforge.name.valid? && HAVE_RUBYFORGE
4
+
5
+ require 'rubyforge'
6
+ require 'rake/contrib/sshpublisher'
7
+
8
+ namespace :gem do
9
+ desc 'Package and upload to RubyForge'
10
+ task :release => [:clobber, :package] do |t|
11
+ v = ENV['VERSION'] or abort 'Must supply VERSION=x.y.z'
12
+ abort "Versions don't match #{v} vs #{PROJ.version}" if v != PROJ.version
13
+ pkg = "pkg/#{PROJ.gem._spec.full_name}"
14
+
15
+ if $DEBUG then
16
+ puts "release_id = rf.add_release #{PROJ.rubyforge.name.inspect}, #{PROJ.name.inspect}, #{PROJ.version.inspect}, \"#{pkg}.tgz\""
17
+ puts "rf.add_file #{PROJ.rubyforge.name.inspect}, #{PROJ.name.inspect}, release_id, \"#{pkg}.gem\""
18
+ end
19
+
20
+ rf = RubyForge.new
21
+ puts 'Logging in'
22
+ rf.login
23
+
24
+ c = rf.userconfig
25
+ c['release_notes'] = PROJ.description if PROJ.description
26
+ c['release_changes'] = PROJ.changes if PROJ.changes
27
+ c['preformatted'] = true
28
+
29
+ files = [(PROJ.gem.need_tar ? "#{pkg}.tgz" : nil),
30
+ (PROJ.gem.need_zip ? "#{pkg}.zip" : nil),
31
+ "#{pkg}.gem"].compact
32
+
33
+ puts "Releasing #{PROJ.name} v. #{PROJ.version}"
34
+ rf.add_release PROJ.rubyforge.name, PROJ.name, PROJ.version, *files
35
+ end
36
+ end # namespace :gem
37
+
38
+
39
+ namespace :doc do
40
+ desc "Publish RDoc to RubyForge"
41
+ task :release => %w(doc:clobber_rdoc doc:rdoc) do
42
+ config = YAML.load(
43
+ File.read(File.expand_path('~/.rubyforge/user-config.yml'))
44
+ )
45
+
46
+ host = "#{config['username']}@rubyforge.org"
47
+ remote_dir = "/var/www/gforge-projects/#{PROJ.rubyforge.name}/"
48
+ remote_dir << PROJ.rdoc.remote_dir if PROJ.rdoc.remote_dir
49
+ local_dir = PROJ.rdoc.dir
50
+
51
+ Rake::SshDirPublisher.new(host, remote_dir, local_dir).upload
52
+ end
53
+ end # namespace :doc
54
+
55
+ end # if HAVE_RUBYFORGE
56
+
57
+ # EOF
data/tasks/setup.rb ADDED
@@ -0,0 +1,266 @@
1
+ # $Id$
2
+
3
+ require 'rubygems'
4
+ require 'rake'
5
+ require 'rake/clean'
6
+ require 'fileutils'
7
+ require 'ostruct'
8
+
9
+ class OpenStruct; undef :gem; end
10
+
11
+ PROJ = OpenStruct.new(
12
+ # Project Defaults
13
+ :name => nil,
14
+ :summary => nil,
15
+ :description => nil,
16
+ :changes => nil,
17
+ :authors => nil,
18
+ :email => nil,
19
+ :url => "\000",
20
+ :version => ENV['VERSION'] || '0.0.0',
21
+ :exclude => %w(tmp$ bak$ ~$ CVS .svn/ ^pkg/ ^doc/),
22
+ :release_name => ENV['RELEASE'],
23
+
24
+ # System Defaults
25
+ :ruby_opts => %w(-w),
26
+ :libs => [],
27
+ :history_file => 'History.txt',
28
+ :manifest_file => 'Manifest.txt',
29
+ :readme_file => 'README.txt',
30
+
31
+ # Announce
32
+ :ann => OpenStruct.new(
33
+ :file => 'announcement.txt',
34
+ :text => nil,
35
+ :paragraphs => [],
36
+ :email => {
37
+ :from => nil,
38
+ :to => %w(ruby-talk@ruby-lang.org),
39
+ :server => 'localhost',
40
+ :port => 25,
41
+ :domain => ENV['HOSTNAME'],
42
+ :acct => nil,
43
+ :passwd => nil,
44
+ :authtype => :plain
45
+ }
46
+ ),
47
+
48
+ # Gem Packaging
49
+ :gem => OpenStruct.new(
50
+ :dependencies => [],
51
+ :executables => nil,
52
+ :extensions => FileList['ext/**/extconf.rb'],
53
+ :files => nil,
54
+ :need_tar => true,
55
+ :need_zip => false,
56
+ :extras => {}
57
+ ),
58
+
59
+ # File Annotations
60
+ :notes => OpenStruct.new(
61
+ :exclude => %w(^tasks/setup.rb$),
62
+ :extensions => %w(.txt .rb .erb) << '',
63
+ :tags => %w(FIXME OPTIMIZE TODO)
64
+ ),
65
+
66
+ # Rcov
67
+ :rcov => OpenStruct.new(
68
+ :dir => 'coverage',
69
+ :opts => %w[--sort coverage -T],
70
+ :threshold => 90.0,
71
+ :threshold_exact => false
72
+ ),
73
+
74
+ # Rdoc
75
+ :rdoc => OpenStruct.new(
76
+ :opts => [],
77
+ :include => %w(^lib/ ^bin/ ^ext/ .txt$),
78
+ :exclude => %w(extconf.rb$),
79
+ :main => nil,
80
+ :dir => 'doc',
81
+ :remote_dir => nil
82
+ ),
83
+
84
+ # Rubyforge
85
+ :rubyforge => OpenStruct.new(
86
+ :name => "\000"
87
+ ),
88
+
89
+ # Rspec
90
+ :spec => OpenStruct.new(
91
+ :files => FileList['spec/**/*_spec.rb'],
92
+ :opts => []
93
+ ),
94
+
95
+ # Subversion Repository
96
+ :svn => OpenStruct.new(
97
+ :root => nil,
98
+ :path => '',
99
+ :trunk => 'trunk',
100
+ :tags => 'tags',
101
+ :branches => 'branches'
102
+ ),
103
+
104
+ # Test::Unit
105
+ :test => OpenStruct.new(
106
+ :files => FileList['test/**/test_*.rb'],
107
+ :file => 'test/all.rb',
108
+ :opts => []
109
+ )
110
+ )
111
+
112
+ # Load the other rake files in the tasks folder
113
+ rakefiles = Dir.glob('tasks/*.rake').sort
114
+ rakefiles.unshift(rakefiles.delete('tasks/post_load.rake')).compact!
115
+ import(*rakefiles)
116
+
117
+ # Setup the project libraries
118
+ %w(lib ext).each {|dir| PROJ.libs << dir if test ?d, dir}
119
+
120
+ # Setup some constants
121
+ WIN32 = %r/djgpp|(cyg|ms|bcc)win|mingw/ =~ RUBY_PLATFORM unless defined? WIN32
122
+
123
+ DEV_NULL = WIN32 ? 'NUL:' : '/dev/null'
124
+
125
+ def quiet( &block )
126
+ io = [STDOUT.dup, STDERR.dup]
127
+ STDOUT.reopen DEV_NULL
128
+ STDERR.reopen DEV_NULL
129
+ block.call
130
+ ensure
131
+ STDOUT.reopen io.first
132
+ STDERR.reopen io.last
133
+ $stdout, $stderr = STDOUT, STDERR
134
+ end
135
+
136
+ DIFF = if WIN32 then 'diff.exe'
137
+ else
138
+ if quiet {system "gdiff", __FILE__, __FILE__} then 'gdiff'
139
+ else 'diff' end
140
+ end unless defined? DIFF
141
+
142
+ SUDO = if WIN32 then ''
143
+ else
144
+ if quiet {system 'which sudo'} then 'sudo'
145
+ else '' end
146
+ end
147
+
148
+ RCOV = WIN32 ? 'rcov.bat' : 'rcov'
149
+ RDOC = WIN32 ? 'rdoc.bat' : 'rdoc'
150
+ GEM = WIN32 ? 'gem.bat' : 'gem'
151
+
152
+ %w(rcov spec/rake/spectask rubyforge bones facets/ansicode).each do |lib|
153
+ begin
154
+ require lib
155
+ Object.instance_eval {const_set "HAVE_#{lib.tr('/','_').upcase}", true}
156
+ rescue LoadError
157
+ Object.instance_eval {const_set "HAVE_#{lib.tr('/','_').upcase}", false}
158
+ end
159
+ end
160
+ HAVE_SVN = (Dir.entries(Dir.pwd).include?('.svn') and
161
+ system("svn --version 2>&1 > #{DEV_NULL}"))
162
+
163
+ # Reads a file at +path+ and spits out an array of the +paragraphs+
164
+ # specified.
165
+ #
166
+ # changes = paragraphs_of('History.txt', 0..1).join("\n\n")
167
+ # summary, *description = paragraphs_of('README.txt', 3, 3..8)
168
+ #
169
+ def paragraphs_of( path, *paragraphs )
170
+ title = String === paragraphs.first ? paragraphs.shift : nil
171
+ ary = File.read(path).delete("\r").split(/\n\n+/)
172
+
173
+ result = if title
174
+ tmp, matching = [], false
175
+ rgxp = %r/^=+\s*#{Regexp.escape(title)}/i
176
+ paragraphs << (0..-1) if paragraphs.empty?
177
+
178
+ ary.each do |val|
179
+ if val =~ rgxp
180
+ break if matching
181
+ matching = true
182
+ rgxp = %r/^=+/i
183
+ elsif matching
184
+ tmp << val
185
+ end
186
+ end
187
+ tmp
188
+ else ary end
189
+
190
+ result.values_at(*paragraphs)
191
+ end
192
+
193
+ # Adds the given gem _name_ to the current project's dependency list. An
194
+ # optional gem _version_ can be given. If omitted, the newest gem version
195
+ # will be used.
196
+ #
197
+ def depend_on( name, version = nil )
198
+ spec = Gem.source_index.find_name(name).last
199
+ version = spec.version.to_s if version.nil? and !spec.nil?
200
+
201
+ PROJ.gem.dependencies << case version
202
+ when nil; [name]
203
+ when %r/^\d/; [name, ">= #{version}"]
204
+ else [name, version] end
205
+ end
206
+
207
+ # Adds the given arguments to the include path if they are not already there
208
+ #
209
+ def ensure_in_path( *args )
210
+ args.each do |path|
211
+ path = File.expand_path(path)
212
+ $:.unshift(path) if test(?d, path) and not $:.include?(path)
213
+ end
214
+ end
215
+
216
+ # Find a rake task using the task name and remove any description text. This
217
+ # will prevent the task from being displayed in the list of available tasks.
218
+ #
219
+ def remove_desc_for_task( names )
220
+ Array(names).each do |task_name|
221
+ task = Rake.application.tasks.find {|t| t.name == task_name}
222
+ next if task.nil?
223
+ task.instance_variable_set :@comment, nil
224
+ end
225
+ end
226
+
227
+ # Change working directories to _dir_, call the _block_ of code, and then
228
+ # change back to the original working directory (the current directory when
229
+ # this method was called).
230
+ #
231
+ def in_directory( dir, &block )
232
+ curdir = pwd
233
+ begin
234
+ cd dir
235
+ return block.call
236
+ ensure
237
+ cd curdir
238
+ end
239
+ end
240
+
241
+ # Scans the current working directory and creates a list of files that are
242
+ # candidates to be in the manifest.
243
+ #
244
+ def manifest_files
245
+ files = []
246
+ exclude = Regexp.new(PROJ.exclude.join('|'))
247
+ Find.find '.' do |path|
248
+ path.sub! %r/^(\.\/|\/)/o, ''
249
+ next unless test ?f, path
250
+ next if path =~ exclude
251
+ files << path
252
+ end
253
+ files.sort!
254
+ end
255
+
256
+ # We need a "valid" method thtat determines if a string is suitable for use
257
+ # in the gem specification.
258
+ #
259
+ class Object
260
+ def valid?
261
+ return !(self.empty? or self == "\000") if self.respond_to?(:to_str)
262
+ return false
263
+ end
264
+ end
265
+
266
+ # EOF
data/tasks/spec.rake ADDED
@@ -0,0 +1,55 @@
1
+ # $Id$
2
+
3
+ if HAVE_SPEC_RAKE_SPECTASK
4
+ require 'spec/rake/verify_rcov'
5
+
6
+ namespace :spec do
7
+
8
+ desc 'Run all specs with basic output'
9
+ Spec::Rake::SpecTask.new(:run) do |t|
10
+ t.ruby_opts = PROJ.ruby_opts
11
+ t.spec_opts = PROJ.spec.opts
12
+ t.spec_files = PROJ.spec.files
13
+ t.libs += PROJ.libs
14
+ end
15
+
16
+ desc 'Run all specs with text output'
17
+ Spec::Rake::SpecTask.new(:specdoc) do |t|
18
+ t.ruby_opts = PROJ.ruby_opts
19
+ t.spec_opts = PROJ.spec.opts + ['--format', 'specdoc']
20
+ t.spec_files = PROJ.spec.files
21
+ t.libs += PROJ.libs
22
+ end
23
+
24
+ if HAVE_RCOV
25
+ desc 'Run all specs with RCov'
26
+ Spec::Rake::SpecTask.new(:rcov) do |t|
27
+ t.ruby_opts = PROJ.ruby_opts
28
+ t.spec_opts = PROJ.spec.opts
29
+ t.spec_files = PROJ.spec.files
30
+ t.libs += PROJ.libs
31
+ t.rcov = true
32
+ t.rcov_dir = PROJ.rcov.dir
33
+ t.rcov_opts = PROJ.rcov.opts + ['--exclude', 'spec']
34
+ end
35
+
36
+ RCov::VerifyTask.new(:verify) do |t|
37
+ t.threshold = PROJ.rcov.threshold
38
+ t.index_html = File.join(PROJ.rcov.dir, 'index.html')
39
+ t.require_exact_threshold = PROJ.rcov.threshold_exact
40
+ end
41
+
42
+ task :verify => :rcov
43
+ remove_desc_for_task %w(spec:clobber_rcov)
44
+ end
45
+
46
+ end # namespace :spec
47
+
48
+ desc 'Alias to spec:run'
49
+ task :spec => 'spec:run'
50
+
51
+ task :clobber => 'spec:clobber_rcov' if HAVE_RCOV
52
+
53
+ end # if HAVE_SPEC_RAKE_SPECTASK
54
+
55
+ # EOF
data/tasks/svn.rake ADDED
@@ -0,0 +1,48 @@
1
+ # $Id$
2
+
3
+ if HAVE_SVN
4
+
5
+ unless PROJ.svn.root
6
+ info = %x/svn info ./
7
+ m = %r/^Repository Root:\s+(.*)$/.match(info)
8
+ PROJ.svn.root = (m.nil? ? '' : m[1])
9
+ end
10
+ PROJ.svn.root = File.join(PROJ.svn.root, PROJ.svn.path) unless PROJ.svn.path.empty?
11
+
12
+ namespace :svn do
13
+
14
+ # A prerequisites task that all other tasks depend upon
15
+ task :prereqs
16
+
17
+ desc 'Show tags from the SVN repository'
18
+ task :show_tags => 'svn:prereqs' do |t|
19
+ tags = %x/svn list #{File.join(PROJ.svn.root, PROJ.svn.tags)}/
20
+ tags.gsub!(%r/\/$/, '')
21
+ tags = tags.split("\n").sort {|a,b| b <=> a}
22
+ puts tags
23
+ end
24
+
25
+ desc 'Create a new tag in the SVN repository'
26
+ task :create_tag => 'svn:prereqs' do |t|
27
+ v = ENV['VERSION'] or abort 'Must supply VERSION=x.y.z'
28
+ abort "Versions don't match #{v} vs #{PROJ.version}" if v != PROJ.version
29
+
30
+ svn = PROJ.svn
31
+ trunk = File.join(svn.root, svn.trunk)
32
+ tag = "%s-%s" % [PROJ.name, PROJ.version]
33
+ tag = File.join(svn.root, svn.tags, tag)
34
+ msg = "Creating tag for #{PROJ.name} version #{PROJ.version}"
35
+
36
+ puts "Creating SVN tag '#{tag}'"
37
+ unless system "svn cp -m '#{msg}' #{trunk} #{tag}"
38
+ abort "Tag creation failed"
39
+ end
40
+ end
41
+
42
+ end # namespace :svn
43
+
44
+ task 'gem:release' => 'svn:create_tag'
45
+
46
+ end # if PROJ.svn.path
47
+
48
+ # EOF
data/tasks/test.rake ADDED
@@ -0,0 +1,38 @@
1
+ # $Id$
2
+
3
+ require 'rake/testtask'
4
+
5
+ namespace :test do
6
+
7
+ Rake::TestTask.new(:run) do |t|
8
+ t.libs = PROJ.libs
9
+ t.test_files = if test(?f, PROJ.test.file) then [PROJ.test.file]
10
+ else PROJ.test.files end
11
+ t.ruby_opts += PROJ.ruby_opts
12
+ t.ruby_opts += PROJ.test.opts
13
+ end
14
+
15
+ if HAVE_RCOV
16
+ desc 'Run rcov on the unit tests'
17
+ task :rcov => :clobber_rcov do
18
+ opts = PROJ.rcov.opts.dup << '-o' << PROJ.rcov.dir
19
+ opts = opts.join(' ')
20
+ files = if test(?f, PROJ.test.file) then [PROJ.test.file]
21
+ else PROJ.test.files end
22
+ files = files.join(' ')
23
+ sh "#{RCOV} #{files} #{opts}"
24
+ end
25
+
26
+ task :clobber_rcov do
27
+ rm_r 'coverage' rescue nil
28
+ end
29
+ end
30
+
31
+ end # namespace :test
32
+
33
+ desc 'Alias to test:run'
34
+ task :test => 'test:run'
35
+
36
+ task :clobber => 'test:clobber_rcov' if HAVE_RCOV
37
+
38
+ # EOF
metadata ADDED
@@ -0,0 +1,77 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: fearoffish-backup
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.0.1
5
+ platform: ruby
6
+ authors:
7
+ - Jamie van Dyke
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+
12
+ date: 2008-05-01 00:00:00 -07:00
13
+ default_executable:
14
+ dependencies: []
15
+
16
+ description: Backup is a Ruby library to ease the backup of files, keeping the latest X releases. Just require it and go.
17
+ email: jvandyke@engineyard.com
18
+ executables: []
19
+
20
+ extensions: []
21
+
22
+ extra_rdoc_files:
23
+ - History.txt
24
+ - Manifest.txt
25
+ - README.txt
26
+ files:
27
+ - History.txt
28
+ - LICENSE
29
+ - Manifest.txt
30
+ - README.txt
31
+ - Rakefile
32
+ - lib/backup.rb
33
+ - lib/backup/backup.rb
34
+ - spec/backup/backup_spec.rb
35
+ - spec/spec.opts
36
+ - spec/spec_helper.rb
37
+ - tasks/ann.rake
38
+ - tasks/bones.rake
39
+ - tasks/gem.rake
40
+ - tasks/manifest.rake
41
+ - tasks/notes.rake
42
+ - tasks/post_load.rake
43
+ - tasks/rdoc.rake
44
+ - tasks/rubyforge.rake
45
+ - tasks/setup.rb
46
+ - tasks/spec.rake
47
+ - tasks/svn.rake
48
+ - tasks/test.rake
49
+ has_rdoc: true
50
+ homepage: http://github.com/fearoffish/backup
51
+ post_install_message:
52
+ rdoc_options:
53
+ - --main
54
+ - README.txt
55
+ require_paths:
56
+ - lib
57
+ required_ruby_version: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - ">="
60
+ - !ruby/object:Gem::Version
61
+ version: "0"
62
+ version:
63
+ required_rubygems_version: !ruby/object:Gem::Requirement
64
+ requirements:
65
+ - - ">="
66
+ - !ruby/object:Gem::Version
67
+ version: "0"
68
+ version:
69
+ requirements: []
70
+
71
+ rubyforge_project:
72
+ rubygems_version: 1.0.1
73
+ signing_key:
74
+ specification_version: 2
75
+ summary: A library to keep the latest X number of a file as backups
76
+ test_files:
77
+ - spec/backup/backup_spec.rb