bup 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 02ca6df7a29ad6290ab682bd214dc097c70e6a7a464bbbea22b1b4d100465ec7
-  data.tar.gz: 7bf6a98055fed3353f131e56033c876860ec6f4e22b995c4f002ffedd5e8462b
+  metadata.gz: 3a9931bc931a38f83fe2eebebfb5939d997d685fe3bbb7fdf863860dab36c402
+  data.tar.gz: 701c9661de7b80acb3dec18b4ae053aec13cd41e73a4992e8f458f0cfcdaa2ea
 SHA512:
-  metadata.gz: f96824b5eaa8fa4089497aa3eff4daf4abf5f041931fac622ac0163aed57d79036cced77b50a771fb5c675b6abaa1473e1018b9312c8e8d5935d12fc6255c601
-  data.tar.gz: 31aaf6faab04f3e7806bc60b082aac8bd0177aa4ade5fb40e02189289e75fef8d401aaedfce4f4abd4454aeb6679c881af0391dc732169d6eb362a820c970c9a
+  metadata.gz: 2bb473340913988672050f49f0fa8ecdede02ac622b6a9630d1cd91ea3481c487da20997c313a2ee77c60cfd3a8be305e722a430506ac79c08c53cb705770ea3
+  data.tar.gz: 776de0097acfe0da73daa50ab4943cafab33524508c21d70e670a95c6a89d7de1d0f22de82eba354f27086da69387985a3a962a0a540f8117b0206c4b6de4ff4

data/.rubocop.yml

@@ -1,5 +1,8 @@
 AllCops:
   TargetRubyVersion: 3.0
+  Exclude:
+    - lib/bup/tar.rb
+    - lib/bup/config.rb
 
 Style/StringLiterals:
   Enabled: true

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## [Unreleased]
 
+- Communicate the backup file base name through the environment variable BUP_FILENAME.
+- Rubocop fixes or ignore files.
+- Add post commands, incase you want to default copy something around.
+
+## [0.2.0] - 2021-11-13
+
 - List profiles.
 - Bug fixes against empty backup directories.
 - Bug fix to print buffers using read_nonblock from popen3 streams.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    bup (0.2.0)
+    bup (0.3.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,43 +1,59 @@
 # Bup
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/bup`. To experiment with that code, run `bin/console` for an interactive prompt.
+Bup is a simple backup driver script that uses `tar` to backup files.
+The idea is to simplify creating backups, full and incremental, and leave
+restoration as a project for the user to untar the file where their contents
+is needed.
 
-TODO: Delete this and the text above, and describe your gem
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'bup'
-```
-
-And then execute:
-
-    $ bundle install
-
-Or install it yourself as:
-
-    $ gem install bup
+Features like backup profiles, file dating, history rotation,
+incremental backups, and post-processing scripting is provided.
 
 ## Usage
 
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+Create a file ~/.buprc with the default contents...
+
+```yaml
+---
+profiles:
+  default:
+    description: Simple backup of critical files.
+    include:
+    - "$HOME"
+    exclude:
+    - "$HOME"
+    - "$HOME/backups"
+    lastrun: '2021-11-14T03:06:45 +0000'
+    destination: "$HOME/backups"
+    history: 2
+    tarcmd:
+    - tar
+    - cJvf
+    - "${BUP_FILENAME}.tar.xz"
+    post_cmds:
+    - - ls
+      - $BUP_FILENAME.tar.xz
+```
 
-## Contributing
+This defines a single profile, "default". You can list
+defined profiles by running `bup -l`. You run the default backup profile
+simply by running `bup`. Other profiles must be selected on the command
+line using `bup -p <profile name>`.
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/bup. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/bup/blob/main/CODE_OF_CONDUCT.md).
+The default profile, as defined above, excludes both the `$HOME` and
+`$HOME/backups` directories. Remove `$HOME` from the excludes list to actually
+backup your entire home directory.
 
-## License
+## Incremental Backups
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+By calling `bup -t incremental` an incremental backup will be run.
+This runs `tar` with the `--newer` option included with the time
+specified in the profile's `lastrun` setting. `Tar` will then exclude
+files older than that time.
 
-## Code of Conduct
+## Backup History
 
-Everyone interacting in the Bup project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/bup/blob/main/CODE_OF_CONDUCT.md).
+Before a new backup is run, previous backups are removed. If you run many 
+uncompleted backups, you will eventually remove all good backups from your
+backup history. This behavior is desired because backups should nearly always
+succeed and we want to ensure that disk pressure is kep lower than higher.
+Higher disk pressure might cause a backup to fail.

data/buprc

@@ -1,15 +1,20 @@
 ---
 profiles:
   default:
-    description: "Simple backup of critical files."
+    description: Simple backup of critical files.
     include:
     - "$HOME"
     exclude:
     - "$HOME"
     - "$HOME/backups"
-    lastrun: '2021-11-11T18:45:33 +0000'
+    lastrun: '2021-11-14T03:06:45 +0000'
     destination: "$HOME/backups"
     history: 2
     tarcmd:
     - sudo
     - tar
+    - cJvf
+    - "${BUP_FILENAME}.tar.xz"
+    post_cmds:
+    - - ls
+      - $BUP_FILENAME.tar.xz

data/exe/bup

@@ -23,13 +23,13 @@ OptParse.new do |opt|
   end
 
   opt.on("-l", "--list", "List profiles and exit.") do
-    config.runtime['action'] = 'list'
+    config.runtime["action"] = "list"
   end
 end.parse!
 
 config.load(configfile) if File.exist?(configfile)
 
-case config.runtime["action"] 
+case config.runtime["action"]
 when "list"
   config.config["profiles"].each do |key, profile|
     puts "#{key} - #{profile["description"] || ""}"
@@ -38,4 +38,4 @@ else
   tar = Bup::Tar.new(config)
   tar.call
   config.save(configfile)
-end
+end

data/lib/bup/config.rb

@@ -5,12 +5,13 @@ require "yaml"
 require "date"
 
 module Bup
+  # Configuration management.
   class Config
-    @@timeformat = "%Y-%m-%dT%H:%M:%S %z"
 
     attr_accessor :config, :runtime
 
     def initialize
+      @timeformat = "%Y-%m-%dT%H:%M:%S %z"
       @runtime = {
         "profile" => "default",
         "type" => "full"
@@ -45,14 +46,14 @@ module Bup
 
     # Return the last run time of the backup or nil if there is none.
     def lastrun(name)
-      DateTime.strptime(profile(name)["lastrun"] || "", @@timeformat)
+      DateTime.strptime(profile(name)["lastrun"] || "", @timeformat)
     rescue Date::Error
       nil
     end
 
     # Return the last run time of the backup or nil if there is none.
     def set_lastrun(name, date)
-      profile(name)["lastrun"] = date.strftime(@@timeformat)
+      profile(name)["lastrun"] = date.strftime(@timeformat)
     end
 
     def profile(name)

data/lib/bup/tar.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "English"
-require "English"
 require "tempfile"
 require "open3"
 require "date"
@@ -13,9 +11,9 @@ module Bup
     end
 
     def expand_string(str)
-      while str =~ /\${?([a-zA-Z0-9]+)}?/
-        all = $LAST_MATCH_INFO[0]
-        nm = $LAST_MATCH_INFO[1]
+      while str =~ /\${?([a-zA-Z0-9_]+)}?/
+        all = $~[0]
+        nm = $~[1]
         str = str.sub(all, ENV[nm] || "")
       end
 
@@ -36,14 +34,13 @@ module Bup
     # Prepare the destination directory.
     def prepare_destination(profile_name)
       destination = expand_string(@config.profile(profile_name)["destination"] || ".")
-      suffix = ".tar.xz"
       type = @config.runtime["type"] || "full"
 
       FileUtils.mkdir_p(destination) unless File.exist?(destination)
 
       filename_base = "#{profile_name}-#{type}"
       filename = File.join(destination,
-                           "#{filename_base}-#{DateTime.now.new_offset(0).strftime("%Y%m%d%H%M%S")}#{suffix}")
+                           "#{filename_base}-#{DateTime.now.new_offset(0).strftime("%Y%m%d%H%M%S")}")
 
       history = @config.profile(profile_name)["history"] || 0
 
@@ -79,12 +76,9 @@ module Bup
 
       raise "Missing profile #{profile_name}." unless profile
 
-      args = @config.profile(profile_name)["tarcmd"].dup || ["tar"]
+      args = @config.profile(profile_name)["tarcmd"].dup || ["tar", "cJvf", "${BUP_FILENAME}.tar.xz"]
 
-      args << "cJvf"
-
-      filename = prepare_destination(profile_name)
-      args << filename
+      ENV["BUP_FILENAME"] = prepare_destination(profile_name)
 
       if @config.runtime["type"] == "incremental"
         lastrun = @config.lastrun(profile_name)
@@ -96,38 +90,39 @@ module Bup
       tf = build_exclude_file(profile["exclude"] || [])
 
       args += ["--exclude-from", tf.path]
-      args += (@config.profile(profile_name)["include"] || ["."]).map do |str|
+      args += (@config.profile(profile_name)["include"] || ["."])
+      args = args.map do |str|
         expand_string(str)
       end
 
       begin
-        Open3.popen3(*args) do |stdin, stdout, stderr, wait_thr|
-          stdin.close
-          while wait_thr.status
-            r, w, e = IO.select([stdout, stderr])
-            r.each do |stream|
-              begin
-                print stream.read_nonblock(1024)
-              rescue EOFError
-              end
-            end
-          end
+        run_cmd(*args)
+      ensure
+        tf.unlink
+      end
 
-          wait_thr.join
-          begin
-            print stdout.read_nonblock(1024)
-          rescue EOFError
-          end
+      @config.profile(profile_name)["post_cmds"].each do |args|
+        run_cmd(*args.map { |c| expand_string(c) })
+      end
+    end
 
-          begin
-            print stderr.read_nonblock(1024)
-          rescue EOFError
+    def run_cmd(*args)
+      Open3.popen3(*args) do |stdin, stdout, stderr, wait_thr|
+        stdin.close
+        x = nil
+        while wait_thr.status
+          r, _w, _e = IO.select([stdout, stderr])
+          r.each do |stream|
+            print x if (x = stream.read_nonblock(1024, exception: false))
           end
-
-          STDOUT.flush
         end
-      ensure
-        tf.unlink
+
+        wait_thr.join
+        print x if (x = stdout.read_nonblock(1024, exception: false))
+
+        print x if (x = stderr.read_nonblock(1024, exception: false))
+
+        $stdout.flush
       end
     end
   end

data/lib/bup/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Bup
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bup
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Sam Baskinger