rustic 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 87aaad479d9e91bcd7181431cc2f8375b4430c1031037577267fac7432fcf69a
-  data.tar.gz: e75eb8091276f16c57be19d526d64bf546010bff1b2e96925438cf1932a18d53
+  metadata.gz: 3cffcd950bd1cafc45ac925deed3c4d5ffeed28feecd547f83fbe270b990d8c6
+  data.tar.gz: aa028fac39c981b0b4a6667dd1d84da19157ff2666a44abe06143c7b8f0473c1
 SHA512:
-  metadata.gz: 22783cede44b8c30a8f93e1877928b225de776b36269b1bbcf35fefd21b1d3ce10f10650029a2143d06abc6175b0ec2c513965b3ea308c192dff8950bbb9a6d6
-  data.tar.gz: 02af5b50df986baa80294f7d4efb7db2432017bcc4a511bd5cad3de143b83a58cb74290eb14f0d8b1c529ecd50d2f6e94a839910f4dde02d096203e88d9490d6
+  metadata.gz: 4877cbfd5481d617d15cd4a58332516e533f9af4168a9e05e1099edbf0b3572fb087bd01b985958ca77d8f96053bea3c5e660ce545af36d7a26ab2c718f03faa
+  data.tar.gz: ad3f12c6b8cba8de97544d91481569ccc7dd0152dcdcb53a73f27f0b2b56ffeb70cca5747fc5966d0de093ce4c05e621b95842fc3fae68e60d6a7c6c7fe2c45d

data/.github/workflows/main.yml

@@ -1,18 +1,63 @@
 name: Ruby
 
-on: [push,pull_request]
+on: [push]
 
 jobs:
-  build:
+  lint:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: 3.0.1
-    - name: Run the default task
-      run: |
-        gem install bundler -v 2.2.15
-        bundle install
-        bundle exec rake
+      - uses: actions/checkout@v2
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+
+      - name: Run the default task
+        run: |
+          gem install bundler -v 2.2.27
+          bundle install
+          bundle exec rubocop
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+
+      - name: Install deps
+        run: |
+          gem install bundler -v 2.2.27
+          bundle install
+
+      - name: Run tests
+        run: bundle exec rspec
+  publish:
+    runs-on: ubuntu-latest
+    needs:
+      - lint
+      - test
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v')
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.0
+          bundler-cache: true
+
+      - name: Build gem
+        run: gem build
+
+      - name: Create credentials
+        run: |
+          mkdir ~/.gem
+          cat << EOF > ~/.gem/credentials
+          ---
+          :rubygems_api_key: ${{ secrets.RUBYGEMS_TOKEN }}
+          EOF
+          chmod 0600 /home/runner/.gem/credentials
+
+      - name: Push gem
+        run: gem push *gem

data/.gitignore

@@ -9,4 +9,5 @@
 
 # rspec failure tracking
 .rspec_status
-backup.rb
+/backup.rb
+*.gem

data/.rspec

@@ -1,3 +1,3 @@
---format documentation
 --color
 --require spec_helper
+--order random

data/.rubocop.yml

@@ -37,7 +37,7 @@ RSpec/NestedGroups:
   Max: 5
 
 RSpec/MultipleMemoizedHelpers:
-  Max: 9
+  Max: 10
 
 RSpec/ExampleLength:
   Max: 6

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.0.2

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    rustic (0.1.0)
+    rustic (0.3.0)
       async-process (~> 1.3)
+      ptools (~> 1.4)
       zeitwerk (~> 2.5)
 
 GEM
@@ -24,7 +25,7 @@ GEM
       rspec-memory (~> 1.0)
     backport (1.2.0)
     benchmark (0.2.0)
-    console (1.13.1)
+    console (1.14.0)
       fiber-local
     diff-lcs (1.4.4)
     docile (1.4.0)
@@ -41,6 +42,7 @@ GEM
     parallel (1.21.0)
     parser (3.0.2.0)
       ast (~> 2.4.1)
+    ptools (1.4.2)
     racc (1.6.0)
     rainbow (3.0.0)
     rake (13.0.6)

data/lib/rustic/application.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+class Rustic::Application
+  class UnknownCommandError < Rustic::Error; end
+
+  def initialize(config)
+    @config = config
+  end
+
+  def run(argv)
+    command = argv.first || "backup"
+    command, env = Rustic::CommandBuilder.new(command, @config).build
+    Rustic::Wrapper.new(command, env).run
+  end
+end

data/lib/rustic/{script/command_builder.rb → command_builder.rb}

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class Rustic::Script::CommandBuilder
+class Rustic::CommandBuilder
   class UnknownPasswordMethodError < Rustic::Error; end
   class UnknownCommandError < Rustic::Error; end
   class MissingConfigError < Rustic::Error; end
@@ -35,21 +35,9 @@ class Rustic::Script::CommandBuilder
   end
 
   def add_command!
-    command_method = "command_#{@command}"
-    return @args.concat(send(command_method)) if respond_to?(command_method, true)
-
+    command_class = Rustic::CommandBuilders.const_get(@command.capitalize)
+    @args.concat(command_class.new(@config).build)
+  rescue NameError
     raise UnknownCommandError, "Unknown command #{@command}"
   end
-
-  def excludes = ["--exclude"].product(@config.backup_config.excluded_paths).flatten
-
-  def command_snapshots = ["snapshots"]
-
-  def command_backup
-    config = @config.backup_config
-    raise MissingConfigError, "Command `backup` misses it's configuration" if config.nil?
-    raise MalformedConfigError, "Backup paths cannot be empty" if config.paths.empty?
-
-    ["backup", config.one_fs ? "-x" : nil, *config.paths, *excludes].compact
-  end
 end

data/lib/rustic/command_builders/backup.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+class Rustic::CommandBuilders::Backup
+  def initialize(config)
+    @config = 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?
+
+    [
+      "backup",
+      config.one_fs ? "-x" : nil,
+      *config.paths,
+      *excludes
+    ].compact
+  end
+
+  private
+
+  def excludes = ["--exclude"].product(@config.backup_config.excluded_paths).flatten
+end

data/lib/rustic/command_builders/check.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+class Rustic::CommandBuilders::Check
+  def initialize(config)
+    @config = 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
+    ].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
+
+    "--read-data-subset=#{config.read_data_subset}%"
+  end
+end

data/lib/rustic/command_builders/forget.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+class Rustic::CommandBuilders::Forget
+  def initialize(config)
+    @config = config
+  end
+
+  def build
+    config = @config.forget_config
+    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
+    ].compact
+  end
+end

data/lib/rustic/{script/validator.rb → command_builders/prune.rb}

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-class Rustic::Script::Validator
+class Rustic::CommandBuilders::Prune
   def initialize(config)
     @config = config
   end
 
-  def validate!
-    # TODO: write me!
+  def build
+    ["prune"]
   end
 end

data/lib/rustic/command_builders/snapshots.rb

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

data/lib/rustic/{script/config.rb → config.rb}

@@ -1,12 +1,13 @@
 # frozen_string_literal: true
 
-class Rustic::Script::Config
-  include Rustic::Script::HooksExt
+class Rustic::Config
+  include Rustic::HooksExt
 
-  attr_reader :restic_path, :backup_config
+  attr_reader :restic_path, :backup_config, :check_config, :forget_config, :strict_validation
 
   def initialize
     @restic_path = "restic"
+    @strict_validation = false
   end
 
   def restic(path)
@@ -38,7 +39,19 @@ class Rustic::Script::Config
   end
 
   def backup(&block)
-    @backup_config ||= Rustic::Script::BackupConfig.new
+    @backup_config ||= Rustic::Configs::Backup.new
     @backup_config.instance_eval(&block)
   end
+
+  def check(&block)
+    @check_config ||= Rustic::Configs::Check.new
+    @check_config.instance_eval(&block) unless block.nil?
+  end
+
+  def forget(&block)
+    @forget_config ||= Rustic::Configs::Forget.new
+    @forget_config.instance_eval(&block)
+  end
+
+  def strict_validation! = @strict_validation = true
 end

data/lib/rustic/{script/backup_config.rb → configs/backup.rb}

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-class Rustic::Script::BackupConfig
-  include Rustic::Script::HooksExt
+class Rustic::Configs::Backup
+  include Rustic::HooksExt
 
   attr_reader :paths, :excluded_paths, :one_fs
 
@@ -23,7 +23,5 @@ class Rustic::Script::BackupConfig
     @excluded_paths = paths
   end
 
-  def one_fs!
-    @one_fs = true
-  end
+  def one_fs! = @one_fs = true
 end

data/lib/rustic/configs/check.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+class Rustic::Configs::Check
+  include Rustic::HooksExt
+
+  attr_reader :check_unused, :read_data_subset, :with_cache
+
+  def initialize
+    @check_unused = false
+    @read_data_subset = nil
+    @with_cache = false
+  end
+
+  def check_unused! = @check_unused = true
+  def with_cache! = @with_cache = true
+
+  def subset(percent)
+    raise ArgumentError, "percent must be > 0 and <= 100. Given: #{percent}" if percent <= 0 || percent > 100
+
+    @read_data_subset = percent
+  end
+end

data/lib/rustic/configs/forget.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+class Rustic::Configs::Forget
+  include Rustic::HooksExt
+
+  attr_reader :keep_last, :keep_weekly, :keep_monthly, :prune
+
+  def initialize
+    @prune = false
+  end
+
+  def keep(last: nil, weekly: nil, monthly: nil)
+    raise ArgumentError, "keep options must be provided" if [last, weekly, monthly].all?(&:nil?)
+
+    @keep_last = last
+    @keep_weekly = weekly
+    @keep_monthly = monthly
+  end
+
+  def prune! = @prune = true
+end

data/lib/rustic/evaluator.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+class Rustic::Evaluator
+  include Console
+
+  def initialize(config) = @config = config
+
+  def evaluate
+    with_hooks(@config) do
+      backup! unless @config.backup_config.nil?
+    end
+  rescue StandardError => e
+    on_error(e)
+    raise
+  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/{script/hooks.rb → hooks.rb}

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class Rustic::Script::Hooks
+class Rustic::Hooks
   def initialize(config)
     @before = config.before
     @after = config.after

data/lib/rustic/{script/hooks_ext.rb → hooks_ext.rb}

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Rustic::Script::HooksExt
+module Rustic::HooksExt
   include Console
 
   def before(&block)

data/lib/rustic/validator.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+class Rustic::Validator
+  def initialize(config)
+    @config = config
+  end
+
+  def validate
+    @errors = []
+    @warnings = []
+    validate_config!
+    validate_backup_config!
+    [@errors, @warnings]
+  end
+
+  private
+
+  def validate_config! # rubocop:disable Metrics/AbcSize
+    if @config.restic_path.nil? || File.which(@config.restic_path).nil?
+      error!("restic path is miconfigured: '#{@config.restic_path.inspect}'")
+    end
+    error!("repository is not configured") if @config.repository.nil?
+    error!("password is not configured") if @config.password.nil? && @config.password_file.nil?
+    warning!("backup is not configured") if @config.backup_config.nil?
+  end
+
+  def validate_backup_config! # rubocop:disable Metrics/AbcSize
+    config = @config.backup_config
+    return if config.nil?
+
+    return unless @config.strict_validation
+
+    error!("backup paths must be alphabetically sorted") if config.paths != config.paths.sort
+    error!("backup paths contain duplicates") if config.paths != config.paths.uniq
+    error!("excluded paths must be alphabetically sorted") if config.excluded_paths != config.excluded_paths.sort
+    error!("excluded paths contain duplicates") if config.excluded_paths != config.excluded_paths.uniq
+  end
+
+  def error!(message) = @errors << message
+
+  def warning!(message) = @warnings << message
+end

data/lib/rustic/version.rb

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

data/lib/rustic.rb

@@ -1,17 +1,39 @@
 # frozen_string_literal: true
 
 require "async/process"
+require "ptools" # file File.which
 
 require "zeitwerk"
 
 loader = Zeitwerk::Loader.for_gem
 
-loader.inflector.inflect(
-  "cli" => "CLI"
-)
-
 loader.setup
 
-# Your code goes here...
-class Rustic::Error < StandardError
+module Rustic
+  class Error < StandardError; end
+  class ValidationError < Error; end
+
+  class << self
+    def define(run: true, &block)
+      Sync do
+        config = Rustic::Config.new
+        config.instance_eval(&block)
+        validate!(config)
+        Rustic::Application.new(config).tap do |app|
+          app.run(ARGV) if run
+        end
+      end
+    end
+
+    private
+
+    def validate!(config)
+      errors, warnings = Rustic::Validator.new(config).validate
+      warnings.each do |warning|
+        # TODO: print warning
+      end
+
+      raise ValidationError, errors.join("\n") if errors.any?
+    end
+  end
 end

data/rustic.gemspec

@@ -28,6 +28,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "async-process", "~> 1.3"
+  spec.add_dependency "ptools", "~> 1.4"
   spec.add_dependency "zeitwerk", "~> 2.5"
 
   # For more information and examples about making a new gem, checkout our

data/rustic.rb

@@ -1,32 +1,37 @@
+#!/bin/env ruby
 # frozen_string_literal: true
 
-repository "tmp/repository"
+require "rustic"
 
-password "password"
+Rustic.define do
+  repository "tmp/repository"
 
-before do
-  logger.info(self, "BEFORE")
-end
+  password "password"
+
+  before do
+    logger.info(self, "BEFORE")
+  end
+
+  backup do
+    one_fs!
+
+    before do |exists|
+      logger.info(self, "BEFORE BACKUP #{exists}")
+    end
 
-backup do
-  one_fs!
+    after do
+      logger.info(self, "AFTER BACKUP")
+    end
 
-  before do |exists|
-    logger.info(self, "BEFORE BACKUP #{exists}")
+    backup "lib"
+    exclude "lib/rustic"
   end
 
   after do
-    logger.info(self, "AFTER BACKUP")
+    logger.info(self, "AFTER")
   end
 
-  backup "lib"
-  exclude "lib/rustic"
-end
-
-after do
-  logger.info(self, "AFTER")
-end
-
-on_error do |error|
-  logger.warn(self, "ERROR:", error)
+  on_error do |error|
+    logger.warn(self, "ERROR:", error)
+  end
 end

data/rustic_script.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+repository "tmp/repository"
+
+password "password"
+
+before do
+  logger.info(self, "BEFORE")
+end
+
+backup do
+  one_fs!
+
+  before do |exists|
+    logger.info(self, "BEFORE BACKUP #{exists}")
+  end
+
+  after do
+    logger.info(self, "AFTER BACKUP")
+  end
+
+  backup "lib"
+  exclude "lib/rustic"
+end
+
+after do
+  logger.info(self, "AFTER")
+end
+
+on_error do |error|
+  logger.warn(self, "ERROR:", error)
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rustic
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Gleb Sinyavskiy
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-11-19 00:00:00.000000000 Z
+date: 2021-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-process
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: ptools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
@@ -41,8 +55,7 @@ dependencies:
 description: DSL for the restic backup tool.
 email:
 - zhulik.gleb@gmail.com
-executables:
-- rustic
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
@@ -50,6 +63,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- ".tool-versions"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -59,27 +73,33 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- exe/rustic
 - lib/rustic.rb
-- lib/rustic/cli.rb
-- lib/rustic/script/backup_config.rb
-- lib/rustic/script/command_builder.rb
-- lib/rustic/script/config.rb
-- lib/rustic/script/evaluator.rb
-- lib/rustic/script/hooks.rb
-- lib/rustic/script/hooks_ext.rb
-- lib/rustic/script/reader.rb
-- lib/rustic/script/validator.rb
+- lib/rustic/application.rb
+- lib/rustic/command_builder.rb
+- lib/rustic/command_builders/backup.rb
+- lib/rustic/command_builders/check.rb
+- lib/rustic/command_builders/forget.rb
+- lib/rustic/command_builders/prune.rb
+- lib/rustic/command_builders/snapshots.rb
+- lib/rustic/config.rb
+- lib/rustic/configs/backup.rb
+- lib/rustic/configs/check.rb
+- lib/rustic/configs/forget.rb
+- lib/rustic/evaluator.rb
+- lib/rustic/hooks.rb
+- lib/rustic/hooks_ext.rb
+- lib/rustic/validator.rb
 - lib/rustic/version.rb
 - lib/rustic/wrapper.rb
 - rustic.gemspec
 - rustic.rb
+- rustic_script.rb
 homepage: https://github.com/zhulik/rustic
 licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -95,7 +115,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.2.22
-signing_key:
+signing_key: 
 specification_version: 4
 summary: DSL for the restic backup tool.
 test_files: []

data/exe/rustic

@@ -1,8 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require "rustic"
-
-Async::Reactor.run do
-  Rustic::CLI.new(ARGV).run
-end

data/lib/rustic/cli.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-class Rustic::CLI
-  def initialize(argv)
-    @argv = argv
-  end
-
-  def run
-    case @argv.first
-    when "script"
-      config = Rustic::Script::Reader.new(@argv[1]).read
-      Rustic::Script::Evaluator.new(config).evaluate
-
-    else
-      Rustic::Wrapper.new(["restic", *@argv]).run
-    end
-  end
-end

data/lib/rustic/script/evaluator.rb

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-class Rustic::Script::Evaluator
-  include Console
-
-  def initialize(config)
-    @config = config
-  end
-
-  def evaluate
-    check!
-
-    with_hooks(@config) do
-      backup! unless @config.backup_config.nil?
-    end
-  rescue StandardError => e
-    on_error(e)
-    raise
-  end
-
-  def check!
-    command, env = Rustic::Script::CommandBuilder.new("snapshots", @config).build
-    Rustic::Wrapper.new(command, env).run
-  end
-
-  def on_error(error)
-    @config.on_error&.call(error)
-  end
-
-  def backup!
-    with_hooks(@config.backup_config) do
-      command, env = Rustic::Script::CommandBuilder.new("backup", @config).build
-      Rustic::Wrapper.new(command, env).run
-    end
-  end
-
-  def with_hooks(config, args = nil, &block)
-    Rustic::Script::Hooks.new(config).with_hooks(args, &block)
-  end
-end

data/lib/rustic/script/reader.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-class Rustic::Script::Reader
-  class FileReadingError < Rustic::Error; end
-  class EvaluationError < Rustic::Error; end
-
-  def initialize(file_path)
-    @file_path = file_path
-  end
-
-  def read
-    Rustic::Script::Config.new.tap do |config|
-      config.instance_eval(script)
-      Rustic::Script::Validator.new(@config).validate!
-    end
-  rescue SyntaxError, NameError
-    raise EvaluationError
-  end
-
-  private
-
-  def script
-    @script ||= File.read(@file_path)
-  rescue StandardError
-    raise FileReadingError
-  end
-end