bup 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 66fb72e2d0fbc1251274b4b505e62f695cf975aba7daa6fb6896fe7c72f2f969
+  data.tar.gz: 38be925b9fb61f41475b495145b572e6244ce8a692b40e8af311816315cca517
+SHA512:
+  metadata.gz: 0c9621fb9d2087df3767a57ce5e71f540e8316d1dc0be9a1a8eb47c3da81f9230f234de7832f2b507754764759305a3edb21131da182caeb1a40bb6e752e3615
+  data.tar.gz: d762849552b7c575d7a366eaeea96900a1fd822ef07f4e7cf736afb737368c004e2aab9a8a34563971f9124cc348fd5bca0aa6686327ef34edc73a2b37fdffe0

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 3.0
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-11-10
+
+- Initial release

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in bup.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.7"

data/Gemfile.lock

@@ -0,0 +1,56 @@
+PATH
+  remote: .
+  specs:
+    bup (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.4.4)
+    parallel (1.21.0)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
+    rubocop (1.22.3)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.12.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.13.0)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.1.0)
+
+PLATFORMS
+  x86_64-darwin-20
+  x86_64-linux
+
+DEPENDENCIES
+  bup!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.7)
+
+BUNDLED WITH
+   2.2.26

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 TODO: Write your name
+
+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,43 @@
+# 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.
+
+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
+
+## 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).
+
+## Contributing
+
+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).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+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).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "bup"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bup.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative "lib/bup/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "bup"
+  spec.version       = Bup::VERSION
+  spec.authors       = ["Sam Baskinger"]
+  spec.email         = ["basking2@yahoo.com"]
+
+  spec.summary       = "Backup tool driver."
+  spec.description   = "Backup tool driver that connects tar, gnupg, and other tools to accomplish backups."
+  spec.homepage      = "https://rubygems.org/gems/bup"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 3.0.2"
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'https://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://gitlab.com/basking2/bup"
+  spec.metadata["changelog_uri"] = "https://gitlab.com/basking2/bup/-/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/buprc

@@ -0,0 +1,14 @@
+---
+profiles:
+  default:
+    include:
+    - "$HOME"
+    exclude:
+    - "$HOME"
+    - "$HOME/backups"
+    lastrun: '2021-11-11T14:18:27 +0000'
+    destination: "$HOME/backups"
+    history: 10
+    tarcmd:
+    - sudo
+    - tar

data/exe/bup

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bup"
+require "optparse"
+
+configfile = File.join(ENV["HOME"], ".buprc")
+config = Bup::Config.new
+
+OptParse.new do |opt|
+  opt.banner = "#{$PROGRAM_NAME} #{Bup::VERSION}"
+
+  opt.on("-c", "--config=file", String, "Config file.") do |c|
+    configfile = c
+  end
+
+  opt.on("-p", "--profile=profile", String, "Profile name.") do |p|
+    config.runtime["profile"] = p
+  end
+
+  opt.on("-t", "--type=type", String, "Type of backup.") do |t|
+    config.runtime["type"] = t == "incremental" ? t : "full"
+  end
+end.parse!
+
+config.load(configfile) if File.exist?(configfile)
+
+tar = Bup::Tar.new(config)
+
+tar.call
+
+config.save(configfile)

data/lib/bup/config.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require "yaml"
+
+require "date"
+
+module Bup
+  class Config
+    @@timeformat = "%Y-%m-%dT%H:%M:%S %z"
+
+    attr_accessor :config, :runtime
+
+    def initialize
+      @runtime = {
+        "profile" => "default",
+        "type" => "full"
+      }
+
+      @config = {
+        "profiles" => {
+          "default" => {
+          }
+        }
+      }
+    end
+
+    def load(file)
+      c = File.open(file) do |io|
+        YAML.safe_load(io)
+      end
+
+      Config.merge(@config, c)
+    end
+
+    def save(file)
+      File.open(file, "w") do |io|
+        io.write(YAML.dump(@config))
+      end
+    end
+
+    def update_lastrun(name)
+      date = DateTime.now.new_offset(0)
+      set_lastrun(name, date)
+    end
+
+    # Return the last run time of the backup or nil if there is none.
+    def lastrun(name)
+      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)
+    end
+
+    def profile(name)
+      @config["profiles"][name] || (raise RuntimeError("No such profile #{name}."))
+    end
+
+    def self.merge(c1, c2)
+      (c1.keys + c2.keys)
+        .each_with_object({}) do |r, l|
+          l[r] = 1
+        end.each_key do |key|
+          v1 = c1[key]
+          v2 = c2[key]
+          if v1.nil?
+            if v2.nil?
+              # nop
+            else
+              c1[key] = v2
+            end
+          elsif v2.nil?
+            # Nop - c1[key] already equals v1.
+          elsif v1.instance_of?(Array) && v2.instance_of?(Array)
+            c1[key] = v1 + v2
+          elsif v1.instance_of?(Hash) && v2.instance_of?(Hash)
+            c1[key] = merge(v1, v2)
+          elsif !v2.nil?
+            c1[key] = v2
+          end
+        end
+      c1
+    end
+  end
+end

data/lib/bup/tar.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+require "English"
+require "English"
+require "tempfile"
+require "open3"
+require "date"
+
+module Bup
+  class Tar
+    def initialize(config)
+      @config = config
+    end
+
+    def expand_string(str)
+      while str =~ /\${?([a-zA-Z0-9]+)}?/
+        all = $LAST_MATCH_INFO[0]
+        nm = $LAST_MATCH_INFO[1]
+        str = str.sub(all, ENV[nm] || "")
+      end
+
+      str
+    end
+
+    def build_exclude_file(patterns)
+      tf = Tempfile.new("bup")
+      patterns.each do |p|
+        p = expand_string(p)
+        tf.write(p)
+        tf.write("\n")
+      end
+      tf.close
+      tf
+    end
+
+    # 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}")
+
+      history = @config.profile(profile_name)["history"] || 0
+
+      if type == "full" && history.positive?
+
+        oldest_kept_file = nil
+
+        # Keep some full backups and remove the others.
+        # We capture the oldest full backup and get rid of preceeding incrementals.
+        Dir["#{destination}/#{filename_base}*"].sort.reverse.each_with_index do |fullbackup, idx|
+          if idx < history
+            oldest_kept_file = fullbackup
+          else
+            File.delete(fullbackup)
+          end
+        end
+
+        # Remove all incremental files that are older than the oldest kept full backup.
+        remove_before = File.stat(oldest_kept_file).ctime
+        Dir["#{destination}/#{profile_name}*"].each do |backupfile|
+          File.delete(backupfile) if File.stat(backupfile).ctime < remove_before
+        end
+      end
+
+      filename
+    end
+
+    def call(profile_name = nil)
+      profile_name ||= @config.runtime["profile"]
+      profile = @config.config["profiles"][profile_name]
+
+      raise "Missing profile #{profile_name}." unless profile
+
+      args = @config.profile(profile_name)["tarcmd"].dup || ["tar"]
+
+      args << "cJvf"
+
+      filename = prepare_destination(profile_name)
+      args << filename
+
+      if @config.runtime["type"] == "incremental"
+        lastrun = @config.lastrun(profile_name)
+        args += ["--newer", lastrun.strftime("%Y-%m-%d %H:%M:%S %z")] if lastrun
+      end
+
+      @config.update_lastrun(profile_name)
+
+      tf = build_exclude_file(profile["exclude"] || [])
+
+      args += ["--exclude-from", tf.path]
+      args += (@config.profile(profile_name)["include"] || ["."]).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|
+              print stream.read
+            end
+          end
+
+          wait_thr.join
+          print stdout.read
+          print stderr.read
+        end
+      ensure
+        tf.unlink
+      end
+    end
+  end
+end

data/lib/bup/version.rb

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

data/lib/bup.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative "bup/version"
+require_relative "bup/config"
+require_relative "bup/tar"
+
+module Bup
+  class Error < StandardError; end
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: bup
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sam Baskinger
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-11-11 00:00:00.000000000 Z
+dependencies: []
+description: Backup tool driver that connects tar, gnupg, and other tools to accomplish
+  backups.
+email:
+- basking2@yahoo.com
+executables:
+- bup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bup.gemspec
+- buprc
+- exe/bup
+- lib/bup.rb
+- lib/bup/config.rb
+- lib/bup/tar.rb
+- lib/bup/version.rb
+homepage: https://rubygems.org/gems/bup
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://rubygems.org/gems/bup
+  source_code_uri: https://gitlab.com/basking2/bup
+  changelog_uri: https://gitlab.com/basking2/bup/-/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key:
+specification_version: 4
+summary: Backup tool driver.
+test_files: []