rustic 0.3.0 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3cffcd950bd1cafc45ac925deed3c4d5ffeed28feecd547f83fbe270b990d8c6
-  data.tar.gz: aa028fac39c981b0b4a6667dd1d84da19157ff2666a44abe06143c7b8f0473c1
+  metadata.gz: 749ff9e10d60fb610892f8c1984fcc5badf605eb5ef7dbe954d71f70aaf6e335
+  data.tar.gz: 0c499c7d0fd8536f464a8c9410099c9d0d9e587895f53fd50e8aff406dc20344
 SHA512:
-  metadata.gz: 4877cbfd5481d617d15cd4a58332516e533f9af4168a9e05e1099edbf0b3572fb087bd01b985958ca77d8f96053bea3c5e660ce545af36d7a26ab2c718f03faa
-  data.tar.gz: ad3f12c6b8cba8de97544d91481569ccc7dd0152dcdcb53a73f27f0b2b56ffeb70cca5747fc5966d0de093ce4c05e621b95842fc3fae68e60d6a7c6c7fe2c45d
+  metadata.gz: 1d806e658a7aedb406195cf6eeb87579c891a2e4c71db159685a5bcfe8ad94375e9ecdb9dcf9d56c06ed1e2164376f565793e55854b1d222fdf0fd2ada5bdcae
+  data.tar.gz: 1f592a8a4e737873ede871bc1877bf0da4f5959a8e384835f7412950456d6db38fb55ce691b71cd75a2f0a22144cc80730a873bbf77026db4b12bb1a990fef2a

data/.github/workflows/main.yml

@@ -44,7 +44,6 @@ jobs:
 
       - uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 3.0
           bundler-cache: true
 
       - name: Build gem

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rustic (0.3.0)
+    rustic (0.3.3)
       async-process (~> 1.3)
       ptools (~> 1.4)
       zeitwerk (~> 2.5)
@@ -10,11 +10,11 @@ GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
-    async (1.30.1)
+    async (1.30.3)
       console (~> 1.10)
       nio4r (~> 2.3)
       timers (~> 4.1)
-    async-io (1.32.2)
+    async-io (1.33.0)
       async
     async-process (1.3.1)
       async
@@ -25,7 +25,7 @@ GEM
       rspec-memory (~> 1.0)
     backport (1.2.0)
     benchmark (0.2.0)
-    console (1.14.0)
+    console (1.15.3)
       fiber-local
     diff-lcs (1.4.4)
     docile (1.4.0)
@@ -110,7 +110,7 @@ GEM
     timers (4.3.3)
     unicode-display_width (2.1.0)
     yard (0.9.26)
-    zeitwerk (2.5.1)
+    zeitwerk (2.6.0)
 
 PLATFORMS
   x86_64-linux

data/{rustic.rb → examples/rustic.rb}

@@ -3,7 +3,7 @@
 
 require "rustic"
 
-Rustic.define do
+Rustic.define do # rubocop:disable Metrics/BlockLength
   repository "tmp/repository"
 
   password "password"
@@ -27,6 +27,29 @@ Rustic.define do
     exclude "lib/rustic"
   end
 
+  check do
+    before do
+      logger.info(self, "BEFORE CHECK")
+    end
+
+    after do
+      logger.info(self, "AFTER CHECK")
+    end
+  end
+
+  forget do
+    before do
+      logger.info(self, "BEFORE FORGET")
+    end
+
+    after do
+      logger.info(self, "AFTER FORGET")
+    end
+
+    prune!
+    keep(last: 2, weekly: 2, monthly: 2)
+  end
+
   after do
     logger.info(self, "AFTER")
   end

data/lib/rustic/application.rb

@@ -7,9 +7,8 @@ class Rustic::Application
     @config = config
   end
 
-  def run(argv)
+  def run(*argv)
     command = argv.first || "backup"
-    command, env = Rustic::CommandBuilder.new(command, @config).build
-    Rustic::Wrapper.new(command, env).run
+    Rustic::Evaluator.new(command, @config).evaluate
   end
 end

data/lib/rustic/command_builder.rb

@@ -18,14 +18,14 @@ class Rustic::CommandBuilder
     add_repository_path!
     add_password!
 
-    add_command!
+    config = add_command!
 
-    [[@config.restic_path, *@args], @env_variables] # TODO: properly handle spaces in paths
+    [[@config.restic_path, *@args], @env_variables, config] # TODO: properly handle spaces in paths
   end
 
   private
 
-  def add_repository_path! = @args += ["-r", @config.repository]
+  def add_repository_path! = @args.concat(["-r", @config.repository])
 
   def add_password!
     return @env_variables.merge!("RESTIC_PASSWORD" => @config.password) if @config.password
@@ -35,8 +35,9 @@ class Rustic::CommandBuilder
   end
 
   def add_command!
-    command_class = Rustic::CommandBuilders.const_get(@command.capitalize)
-    @args.concat(command_class.new(@config).build)
+    command_builder = Rustic::CommandBuilders.const_get(@command.capitalize).new(@config)
+    @args.concat(command_builder.build)
+    command_builder.config
   rescue NameError
     raise UnknownCommandError, "Unknown command #{@command}"
   end

data/lib/rustic/command_builders/backup.rb

@@ -1,24 +1,27 @@
 # frozen_string_literal: true
 
 class Rustic::CommandBuilders::Backup
+  attr_reader :config
+
   def initialize(config)
-    @config = config
+    @config = config.backup_config
   end
 
   def build
-    config = @config.backup_config
-    raise Rustic::CommandBuilder::MissingConfigError, "Command `backup` misses it's configuration" if config.nil?
-    raise Rustic::CommandBuilder::MalformedConfigError, "Backup paths cannot be empty" if config.paths.empty?
+    raise Rustic::CommandBuilder::MissingConfigError, "Command `backup` misses it's configuration" if @config.nil?
+    raise Rustic::CommandBuilder::MalformedConfigError, "Backup paths cannot be empty" if @config.paths.empty?
 
     [
+      "--compression",
+      @config.compression_mode,
       "backup",
-      config.one_fs ? "-x" : nil,
-      *config.paths,
+      @config.one_fs ? "-x" : nil,
+      *@config.paths,
       *excludes
     ].compact
   end
 
   private
 
-  def excludes = ["--exclude"].product(@config.backup_config.excluded_paths).flatten
+  def excludes = ["--exclude"].product(@config.excluded_paths).flatten
 end

data/lib/rustic/command_builders/check.rb

@@ -1,24 +1,27 @@
 # frozen_string_literal: true
 
 class Rustic::CommandBuilders::Check
+  attr_reader :config
+
   def initialize(config)
-    @config = config
+    @config = config.check_config
   end
 
   def build
-    config = @config.check_config
     [
       "check",
-      config&.check_unused ? "--check-unused" : nil,
-      read_data_subset(config),
-      config&.with_cache ? "--with-cache" : nil
+      @config&.check_unused ? "--check-unused" : nil,
+      read_data_subset,
+      @config&.with_cache ? "--with-cache" : nil
     ].compact
   end
 
-  def read_data_subset(config)
-    return nil if config.nil? || config.read_data_subset.nil?
-    return "--read-data" if config.read_data_subset == 100
+  private
+
+  def read_data_subset
+    return nil if @config.nil? || @config.read_data_subset.nil?
+    return "--read-data" if @config.read_data_subset == 100
 
-    "--read-data-subset=#{config.read_data_subset}%"
+    "--read-data-subset=#{@config.read_data_subset}%"
   end
 end

data/lib/rustic/command_builders/forget.rb

@@ -1,20 +1,21 @@
 # frozen_string_literal: true
 
 class Rustic::CommandBuilders::Forget
+  attr_reader :config
+
   def initialize(config)
-    @config = config
+    @config = config.forget_config
   end
 
   def build
-    config = @config.forget_config
-    raise Rustic::CommandBuilder::MissingConfigError, "Command `forget` misses it's configuration" if config.nil?
+    raise Rustic::CommandBuilder::MissingConfigError, "Command `forget` misses it's configuration" if @config.nil?
 
     [
       "forget",
-      config.keep_last ? "--keep-last=#{config.keep_last}" : nil,
-      config.keep_weekly ? "--keep-weekly=#{config.keep_weekly}" : nil,
-      config.keep_monthly ? "--keep-monthly=#{config.keep_monthly}" : nil,
-      config.prune ? "--prune" : nil
+      @config.keep_last ? "--keep-last=#{@config.keep_last}" : nil,
+      @config.keep_weekly ? "--keep-weekly=#{@config.keep_weekly}" : nil,
+      @config.keep_monthly ? "--keep-monthly=#{@config.keep_monthly}" : nil,
+      @config.prune ? "--prune" : nil
     ].compact
   end
 end

data/lib/rustic/command_builders/prune.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 class Rustic::CommandBuilders::Prune
-  def initialize(config)
-    @config = config
-  end
+  attr_reader :config
+
+  def initialize(_config) = nil
 
   def build
     ["prune"]

data/lib/rustic/command_builders/snapshots.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 class Rustic::CommandBuilders::Snapshots
-  def initialize(config)
-    @config = config
-  end
+  attr_reader :config
+
+  def initialize(_config) = nil
 
   def build
     ["snapshots"]

data/lib/rustic/configs/backup.rb

@@ -3,12 +3,13 @@
 class Rustic::Configs::Backup
   include Rustic::HooksExt
 
-  attr_reader :paths, :excluded_paths, :one_fs
+  attr_reader :paths, :excluded_paths, :one_fs, :compression_mode
 
   def initialize
     @paths = []
     @excluded_paths = []
     @one_fs = false
+    @compression_mode = "auto"
   end
 
   def backup(*paths)
@@ -24,4 +25,8 @@ class Rustic::Configs::Backup
   end
 
   def one_fs! = @one_fs = true
+
+  def compression(value)
+    @compression_mode = value
+  end
 end

data/lib/rustic/evaluator.rb

@@ -3,11 +3,19 @@
 class Rustic::Evaluator
   include Console
 
-  def initialize(config) = @config = config
+  def initialize(command, config)
+    @command = command
+    @config = config
+  end
 
   def evaluate
     with_hooks(@config) do
-      backup! unless @config.backup_config.nil?
+      builder = Rustic::CommandBuilder.new(@command, @config)
+      command, env, config = builder.build
+
+      with_hooks(config) do
+        Rustic::Wrapper.new(command, env).run
+      end
     end
   rescue StandardError => e
     on_error(e)
@@ -15,13 +23,5 @@ class Rustic::Evaluator
   end
 
   def on_error(error) = @config.on_error&.call(error)
-
-  def backup!
-    with_hooks(@config.backup_config) do
-      command, env = Rustic::CommandBuilder.new("backup", @config).build
-      Rustic::Wrapper.new(command, env).run
-    end
-  end
-
   def with_hooks(config, args = nil, &block) = Rustic::Hooks.new(config).with_hooks(args, &block)
 end

data/lib/rustic/hooks.rb

@@ -2,8 +2,8 @@
 
 class Rustic::Hooks
   def initialize(config)
-    @before = config.before
-    @after = config.after
+    @before = config&.before
+    @after = config&.after
   end
 
   def with_hooks(arg = nil)
@@ -11,6 +11,6 @@ class Rustic::Hooks
 
     @before&.call(arg)
     yield
-    @after&.call(arg) # TODO: do not call the after block if an exception was raised
+    @after&.call(arg)
   end
 end

data/lib/rustic/version.rb

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

data/lib/rustic.rb

@@ -20,7 +20,7 @@ module Rustic
         config.instance_eval(&block)
         validate!(config)
         Rustic::Application.new(config).tap do |app|
-          app.run(ARGV) if run
+          app.run(*ARGV) if run
         end
       end
     end

data/rustic.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.description   = "DSL for the restic backup tool."
   spec.homepage      = "https://github.com/zhulik/rustic"
   spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 3.0.0")
+  spec.required_ruby_version = [">= 3.0.0", "< 3.1"]
 
   spec.metadata["homepage_uri"] = spec.homepage
   # spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rustic
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.3
 platform: ruby
 authors:
 - Gleb Sinyavskiy
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-11-20 00:00:00.000000000 Z
+date: 2022-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-process
@@ -73,6 +73,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- examples/rustic.rb
 - lib/rustic.rb
 - lib/rustic/application.rb
 - lib/rustic/command_builder.rb
@@ -92,7 +93,6 @@ files:
 - lib/rustic/version.rb
 - lib/rustic/wrapper.rb
 - rustic.gemspec
-- rustic.rb
 - rustic_script.rb
 homepage: https://github.com/zhulik/rustic
 licenses:
@@ -108,6 +108,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ">="
     - !ruby/object:Gem::Version
       version: 3.0.0
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="