expire 0.2.0

data/lib/expire/command.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+
+module Expire
+  # Helpers for TTY
+  class Command
+    extend Forwardable
+
+    def_delegators :command, :run
+
+    # Execute this command
+    #
+    # @api public
+    def execute(*)
+      raise(
+        NotImplementedError,
+        "#{self.class}##{__method__} must be implemented"
+      )
+    end
+
+    # The external commands runner
+    #
+    # @see http://www.rubydoc.info/gems/tty-command
+    #
+    # @api public
+    def command(**options)
+      require 'tty-command'
+      TTY::Command.new(options)
+    end
+
+    # The cursor movement
+    #
+    # @see http://www.rubydoc.info/gems/tty-cursor
+    #
+    # @api public
+    def cursor
+      require 'tty-cursor'
+      TTY::Cursor
+    end
+
+    # Open a file or text in the user's preferred editor
+    #
+    # @see http://www.rubydoc.info/gems/tty-editor
+    #
+    # @api public
+    def editor
+      require 'tty-editor'
+      TTY::Editor
+    end
+
+    # File manipulation utility methods
+    #
+    # @see http://www.rubydoc.info/gems/tty-file
+    #
+    # @api public
+    def generator
+      require 'tty-file'
+      TTY::File
+    end
+
+    # Terminal output paging
+    #
+    # @see http://www.rubydoc.info/gems/tty-pager
+    #
+    # @api public
+    def pager(**options)
+      require 'tty-pager'
+      TTY::Pager.new(options)
+    end
+
+    # Terminal platform and OS properties
+    #
+    # @see http://www.rubydoc.info/gems/tty-pager
+    #
+    # @api public
+    def platform
+      require 'tty-platform'
+      TTY::Platform.new
+    end
+
+    # The interactive prompt
+    #
+    # @see http://www.rubydoc.info/gems/tty-prompt
+    #
+    # @api public
+    def prompt(**options)
+      require 'tty-prompt'
+      TTY::Prompt.new(options)
+    end
+
+    # Get terminal screen properties
+    #
+    # @see http://www.rubydoc.info/gems/tty-screen
+    #
+    # @api public
+    def screen
+      require 'tty-screen'
+      TTY::Screen
+    end
+
+    # The unix which utility
+    #
+    # @see http://www.rubydoc.info/gems/tty-which
+    #
+    # @api public
+    def which(*args)
+      require 'tty-which'
+      TTY::Which.which(*args)
+    end
+
+    # Check if executable exists
+    #
+    # @see http://www.rubydoc.info/gems/tty-which
+    #
+    # @api public
+    def exec_exist?(*args)
+      require 'tty-which'
+      TTY::Which.exist?(*args)
+    end
+  end
+end

data/lib/expire/commands/newest.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative '../command'
+
+module Expire
+  module Commands
+    # Print the newest backup
+    class Newest < Expire::Command
+      def initialize(path, options)
+        @path = path
+        @options = options
+      end
+
+      attr_reader :path
+
+      def execute(input: $stdin, output: $stdout)
+        output.puts Expire.newest(path).pathname
+      end
+    end
+  end
+end

data/lib/expire/commands/oldest.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative '../command'
+
+module Expire
+  module Commands
+    # Print the oldest backup
+    class Oldest < Expire::Command
+      def initialize(path, options)
+        @path = path
+        @options = options
+      end
+
+      attr_reader :path
+
+      def execute(input: $stdin, output: $stdout)
+        output.puts Expire.oldest(path).pathname
+      end
+    end
+  end
+end

data/lib/expire/commands/purge.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative '../command'
+
+module Expire
+  module Commands
+    # Purge expired backups
+    class Purge < Expire::Command
+      def initialize(path, options)
+        @path = path
+        @options = options
+      end
+
+      attr_reader :path, :options
+
+      def execute(input: $stdin, output: $stdout)
+        Expire.purge(path, options)
+      rescue StandardError => _e
+        exit 1
+      end
+    end
+  end
+end

data/lib/expire/commands/remove.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative '../command'
+
+module Expire
+  module Commands
+    # Remove files and directories
+    class Remove < Expire::Command
+      def initialize(path:)
+        @path = path
+      end
+
+      attr_reader :path
+
+      def execute(output: $stdout)
+        begin
+          Expire.remove(path)
+        rescue Errno::ENOENT => e
+          output.puts "can't remove #{path}: #{e}"
+          exit 1
+        end
+        output.puts "removed #{path}"
+      end
+    end
+  end
+end

data/lib/expire/commands/rule_classes.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require_relative '../command'
+
+module Expire
+  module Commands
+    # Print all rule-classes
+    class RuleClasses < Expire::Command
+      def initialize(_); end
+
+      def execute(output: $stdout)
+        Expire.rule_classes.each do |rule_class|
+          output.puts rule_class
+        end
+      end
+    end
+  end
+end

data/lib/expire/commands/rule_names.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative '../command'
+
+module Expire
+  module Commands
+    # Print the names of all rules
+    class RuleNames < Expire::Command
+      def initialize(options)
+        @options = options
+      end
+
+      def execute(input: $stdin, output: $stdout)
+        Expire.rule_names.each do |rule_name|
+          output.puts rule_name
+        end
+      end
+    end
+  end
+end

data/lib/expire/commands/rule_option_names.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative '../command'
+
+module Expire
+  module Commands
+    # Print the option names of all rules
+    class RuleOptionNames < Expire::Command
+      def initialize(options)
+        @options = options
+      end
+
+      def execute(input: $stdin, output: $stdout)
+        Expire.rule_option_names.each do |option_name|
+          output.puts option_name
+        end
+      end
+    end
+  end
+end

data/lib/expire/from_now_keep_adjective_for_rule_base.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Expire
+  # Base class for from-now rules
+  class FromNowKeepAdjectiveForRuleBase < KeepAdjectiveRuleBase
+    extend FromRangeValue
+    include NumerusUnit
+
+    PRIMARY_RANK = 40
+
+    def self.primary_rank
+      PRIMARY_RANK
+    end
+
+    def initialize(unit:, **args)
+      super(**args)
+
+      @unit = unit
+    end
+
+    attr_reader :unit
+
+    def apply(backups, reference_datetime)
+      minimal_datetime = reference_datetime - amount.send(unit)
+      kept = backups.one_per(spacing).not_older_than(minimal_datetime)
+
+      kept.each { |backup| backup.add_reason_to_keep(reason_to_keep) }
+    end
+
+    def primary_rank
+      self.class.primary_rank
+    end
+
+    def reason_to_keep
+      "from now keep all backups for #{amount} #{numerus_unit}"
+    end
+  end
+end

data/lib/expire/from_now_keep_daily_for_rule.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Expire
+  # Keea a daily backup from now for a certain period of time
+  class FromNowKeepDailyForRule < FromNowKeepAdjectiveForRuleBase
+  end
+end

data/lib/expire/from_now_keep_hourly_for_rule.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Expire
+  # Keep one backup per hour from now for a certain period of time
+  class FromNowKeepHourlyForRule < FromNowKeepAdjectiveForRuleBase
+  end
+end

data/lib/expire/from_now_keep_monthly_for_rule.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Expire
+  # Keep one backup per month from now for a certain period of time
+  class FromNowKeepMonthlyForRule < FromNowKeepAdjectiveForRuleBase
+  end
+end

data/lib/expire/from_now_keep_most_recent_for_rule.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Expire
+  # Keep the most recent backups from now for a certain
+  # period of time.
+  class FromNowKeepMostRecentForRule < RuleBase
+    extend FromRangeValue
+    include NumerusUnit
+
+    RULE_RANK = 12
+
+    def self.rank
+      RULE_RANK
+    end
+
+    def initialize(unit:, **args)
+      super(**args)
+
+      @unit = unit
+    end
+
+    attr_reader :unit
+
+    def apply(backups, datetime_now)
+      reference_datetime = datetime_now - amount.send(unit)
+      kept = backups.not_older_than(reference_datetime)
+
+      kept.each do |backup|
+        backup.add_reason_to_keep(reason_to_keep)
+      end
+    end
+
+    def rank
+      self.class.rank
+    end
+
+    def reason_to_keep
+      "from now keep most recent backups for #{amount} #{numerus_unit}"
+    end
+  end
+end

data/lib/expire/from_now_keep_weekly_for_rule.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Expire
+  # Keep one backup per week from now for a certain
+  # period of time
+  class FromNowKeepWeeklyForRule < FromNowKeepAdjectiveForRuleBase
+  end
+end

data/lib/expire/from_now_keep_yearly_for_rule.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Expire
+  # Keep one backup per year from now for
+  # a ceretain period of time.
+  class FromNowKeepYearlyForRule < FromNowKeepAdjectiveForRuleBase
+  end
+end

data/lib/expire/from_range_value.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Expire
+  # Provide a pseudo constructor for rules that require a time range
+  module FromRangeValue
+    using RefineAllAndNone
+
+    FROM_VALUE_REGEX = /
+    \A
+    (([0-9](_[0-9]+){0,})+)
+    (\s+|\.)
+    (hour|day|week|month|year)s?
+    \z
+    /x.freeze
+
+    def from_value(string, **args)
+      # return new(args.merge({ amount: 0, unit: nil })) if string.none?
+      return new(**args.merge(amount: 0, unit: nil)) if string.none?
+
+      stripped_down = string.strip.downcase
+      match = stripped_down.match FROM_VALUE_REGEX
+      raise ArgumentError, "#{string} is not a valid range value" unless match
+
+      amount = Integer(match[1])
+      unit = match[5]
+      new(**args.merge(amount: amount, unit: unit))
+    end
+  end
+end