expire 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e2818cf2a154487c32c4019de8278bc16866d1ca333eba0df45b5abf65859696
+  data.tar.gz: fc10fcc4ef4e17800fdda73b4293fd071a1725d9140604e89967299dfca122e5
+SHA512:
+  metadata.gz: 0b34e9c57c67bc0ca624b8f8050af4e861b681806804f582e813c0850c153f0078cd60e9f17efafce086433ed0b78ce6f9068e152478db3a3bc926225cef24d3
+  data.tar.gz: f6af0819e14453eee1f54623c59d9e10fc549307e0f4b357234c9163cc827bee6a27f7888cf7a879bc60588e65fa269c4d84112fe8699c4b5c8bf6376bdeb7d7

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+/.rbenv-gemsets
+/.ruby-version
+/.byebug_history

data/.reek.yml

@@ -0,0 +1,23 @@
+---
+detectors:
+  Attribute:
+    exclude:
+    - Expire::Rules#daily_to_keep
+    - Expire::Rules#hourly_to_keep
+    - Expire::Rules#monthly_to_keep
+    - Expire::Rules#weekly_to_keep
+    - Expire::Rules#yearly_to_keep
+  TooManyStatements:
+    max_statements: 8
+  UtilityFunction:
+    public_methods_only: true
+  UncommunicativeVariableName:
+    accept:
+      - e
+      - _
+directories:
+  "lib/expire/commands":
+    UnusedParameters:
+        enabled: false
+    UtilityFunction:
+       enabled: false 

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,45 @@
+require: rubocop-rspec
+
+AllCops:
+  Exclude:
+    - 'Gemfile'
+    - 'Rakefile'
+    - 'bin/console'
+    - 'expire.gemspec'
+    - 'spec/spec_helper.rb'
+  NewCops: enable
+  SuggestExtensions: false
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+
+Layout/HashAlignment:
+  EnforcedColonStyle: table
+
+Naming/VariableNumber:
+  EnforcedStyle: snake_case
+
+RSpec/DescribeClass:
+  Enabled: true
+  Exclude:
+    - 'spec/integration/*'
+
+RSpec/FilePath:
+  Enabled: true
+  Exclude:
+    - 'spec/unit/*'
+
+RSpec/ImplicitExpect:
+  Enabled: false
+
+Lint/MissingSuper:
+  Enabled: true
+  Exclude:
+    - 'lib/expire/*'
+    - 'lib/expire/commands/*'
+
+Lint/UnusedMethodArgument:
+  Enabled: true
+  Exclude:
+    - lib/expire/commands/*

data/.simplecov

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+SimpleCov.start

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.6
+before_install: gem install bundler -v 1.17.2

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in expire.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,152 @@
+PATH
+  remote: .
+  specs:
+    expire (0.2.0)
+      activesupport (~> 6.1)
+      pastel (~> 0.8)
+      thor (~> 1.1)
+      zeitwerk (~> 2.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.1.2.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    aruba (1.0.4)
+      childprocess (>= 2.0, < 5.0)
+      contracts (~> 0.16.0)
+      cucumber (>= 2.4, < 6.0)
+      rspec-expectations (~> 3.4)
+      thor (~> 1.0)
+    ast (2.4.2)
+    builder (3.2.4)
+    byebug (11.1.3)
+    childprocess (4.0.0)
+    concurrent-ruby (1.1.8)
+    contracts (0.16.0)
+    cucumber (5.3.0)
+      builder (~> 3.2, >= 3.2.4)
+      cucumber-core (~> 8.0, >= 8.0.1)
+      cucumber-create-meta (~> 2.0, >= 2.0.2)
+      cucumber-cucumber-expressions (~> 10.3, >= 10.3.0)
+      cucumber-gherkin (~> 15.0, >= 15.0.2)
+      cucumber-html-formatter (~> 9.0, >= 9.0.0)
+      cucumber-messages (~> 13.1, >= 13.1.0)
+      cucumber-wire (~> 4.0, >= 4.0.1)
+      diff-lcs (~> 1.4, >= 1.4.4)
+      multi_test (~> 0.1, >= 0.1.2)
+      sys-uname (~> 1.2, >= 1.2.1)
+    cucumber-core (8.0.1)
+      cucumber-gherkin (~> 15.0, >= 15.0.2)
+      cucumber-messages (~> 13.0, >= 13.0.1)
+      cucumber-tag-expressions (~> 2.0, >= 2.0.4)
+    cucumber-create-meta (2.0.4)
+      cucumber-messages (~> 13.1, >= 13.1.0)
+      sys-uname (~> 1.2, >= 1.2.1)
+    cucumber-cucumber-expressions (10.3.0)
+    cucumber-gherkin (15.0.2)
+      cucumber-messages (~> 13.0, >= 13.0.1)
+    cucumber-html-formatter (9.0.0)
+      cucumber-messages (~> 13.0, >= 13.0.1)
+    cucumber-messages (13.2.1)
+      protobuf-cucumber (~> 3.10, >= 3.10.8)
+    cucumber-tag-expressions (2.0.4)
+    cucumber-wire (4.0.1)
+      cucumber-core (~> 8.0, >= 8.0.1)
+      cucumber-cucumber-expressions (~> 10.3, >= 10.3.0)
+      cucumber-messages (~> 13.0, >= 13.0.1)
+    diff-lcs (1.4.4)
+    docile (1.3.5)
+    ffi (1.14.2)
+    i18n (1.8.9)
+      concurrent-ruby (~> 1.0)
+    kwalify (0.7.2)
+    middleware (0.1.0)
+    minitest (5.14.3)
+    multi_test (0.1.2)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
+    pastel (0.8.0)
+      tty-color (~> 0.5)
+    protobuf-cucumber (3.10.8)
+      activesupport (>= 3.2)
+      middleware
+      thor
+      thread_safe
+    psych (3.3.0)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    reek (6.0.3)
+      kwalify (~> 0.7.0)
+      parser (~> 3.0.0)
+      psych (~> 3.1)
+      rainbow (>= 2.0, < 4.0)
+    regexp_parser (2.0.3)
+    rexml (3.2.4)
+    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.2)
+    rubocop (1.10.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.1)
+      parser (>= 2.7.1.5)
+    rubocop-rspec (2.2.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    ruby-progressbar (1.11.0)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.2)
+    sys-uname (1.2.2)
+      ffi (~> 1.1)
+    thor (1.1.0)
+    thread_safe (0.3.6)
+    tty-color (0.6.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.0.0)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  aruba (~> 1.0)
+  bundler (~> 2.1)
+  byebug (~> 11.1)
+  cucumber (~> 5.3)
+  expire!
+  rake (~> 13.0)
+  reek (~> 6.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.9)
+  rubocop-rspec (~> 2.2)
+  simplecov (~> 0.21)
+
+BUNDLED WITH
+   2.2.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 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,551 @@
+<!-- omit in toc -->
+# Expire
+
+**Expire** is a tool for identifying backups that are no longer needed and to delete them.
+It can be used either from the command line or as a ruby gem.
+
+<!-- omit in toc -->
+## Installation
+
+**The installation is currently not yet possible!**
+
+Add this line to your application's Gemfile:
+
+``` ruby
+gem 'expire'
+```
+
+And then execute:
+
+``` shell
+bundle
+```
+
+Or install it yourself as:
+
+``` shell
+gem install expire
+```
+
+- [Usage](#usage)
+- [Purge](#purge)
+  - [The `--simulate`, `-s` flag](#the---simulate--s-flag)
+  - [The `--format`, `-f` options](#the---format--f-options)
+    - [`--format=expired`](#--formatexpired)
+    - [`--format=kept`](#--formatkept)
+    - [`--format=none`](#--formatnone)
+    - [`--format=simple`](#--formatsimple)
+    - [`--format=enhanced`](#--formatenhanced)
+  - [Rules](#rules)
+    - [`--keep-most-recent`](#--keep-most-recent)
+    - [`--keep-most-recent-for`](#--keep-most-recent-for)
+    - [`--from-now-keep-most-recent-for`](#--from-now-keep-most-recent-for)
+    - [Adjectives](#adjectives)
+    - [`--keep-<adjective>`](#--keep-adjective)
+    - [`--keep-<adjective>-for`](#--keep-adjective-for)
+    - [`--from-now-keep-<adjective>-for`](#--from-now-keep-adjective-for)
+    - [Time ranges](#time-ranges)
+  - [`--rules-file`](#--rules-file)
+  - [The `--purge-command`, `--cmd` option](#the---purge-command---cmd-option)
+- [How backup timestamps are detected](#how-backup-timestamps-are-detected)
+- [Newest](#newest)
+- [Oldest](#oldest)
+- [Remove](#remove)
+- [Rule classes](#rule-classes)
+- [Rule names](#rule-names)
+- [Rule option names](#rule-option-names)
+- [Development](#development)
+- [Contributing](#contributing)
+- [License](#license)
+
+## Usage
+
+The most important command of `expire` is `purge` which is explained first.
+
+## Purge
+
+The `purge` command is used to calculate and delete expired backups.
+It is invoked as follows:
+
+``` shell
+expire path/to/backups <rules>
+```
+
+This would delete, according to the rules, all expired backups under `path/to/backups`.
+
+Before deleting, you may want to know what would be removed.
+The `--simulate` option is suitable for this purpose.
+
+### The `--simulate`, `-s` flag
+
+To check the expire-rules you can call `expire purge` with the `--simulate` option:
+
+``` shell
+expire path/to/backups <rules> --simulate
+```
+
+When `purge` is called this way it will calculate the expired backups
+but will not delete anything.
+
+To see what `purge` would delete you have to specify a format, covered in the following section.
+
+### The `--format`, `-f` options
+
+Formats are used to control the output of `expire`.
+`expire` supports various formats.
+The following examples assume a backup-directory containing some backups:
+
+```shell
+backups
+├── 2016-01-27T1112
+├── 2019-12-24T1200
+├── 2021-01-19T1113
+├── 2021-01-26T1111
+├── 2021-01-27T1111
+└── 2021-01-27T1112
+```
+
+All `--format`-examples use the `--keep-most-recent=3` rule.
+Rules are explained later in this document.
+
+#### `--format=expired`
+
+The **expired** format prints the paths of the expired backups, one per line.
+
+```bash
+$ expire purge backups --format=expired --keep-most-recent=3
+backups/2016-01-27T1112
+backups/2019-12-24T1200
+backups/2021-01-19T1113
+```
+
+#### `--format=kept`
+
+The **kept** format prints the paths of the kept backups, one per line.
+
+```shell
+$ expire purge backups --format=kept --keep-most-recent=3
+backups/2021-01-26T1111
+backups/2021-01-27T1111
+backups/2021-01-27T1112
+```
+
+#### `--format=none`
+
+This is the default format, it prints nothing.
+Nothing is printed here, so no example.
+
+#### `--format=simple`
+
+The **simple** format prints the path of the kept backups preceded by the work `keeping`
+and the expired backups preceded by the word `purged`.
+
+```bash
+$ expire purge backups --format=simple --keep-most-recent=3
+purged backups/2016-01-27T1112
+purged backups/2019-12-24T1200
+purged backups/2021-01-19T1113
+keeping backups/2021-01-26T1111
+keeping backups/2021-01-27T1111
+keeping backups/2021-01-27T1112
+```
+
+#### `--format=enhanced`
+
+The **enhanced** format works the same way as the simple format.
+In addition, it prints the reasons why a backup is kept.
+
+```bash
+$ expire purge backups --format=enhanced --keep-most-recent=3
+purged backups/2016-01-27T1112
+purged backups/2019-12-24T1200
+purged backups/2021-01-19T1113
+keeping backups/2021-01-26T1111
+  reasons:
+    - keep the 3 most recent backups
+keeping backups/2021-01-27T1111
+  reasons:
+    - keep the 3 most recent backups
+keeping backups/2021-01-27T1112
+  reasons:
+    - keep the 3 most recent backups
+```
+
+### Rules
+
+Rules control which backups to keep and which to discard.
+Rules can be specified by command line parameters or in a YAML-file.
+
+You must specify at least one rule or `expire purge` will fail.
+
+#### `--keep-most-recent`
+
+The `--keep-most-recent=3` option preserves the three newest backups from being purged.
+
+```shell
+$ expire purge backups --keep-most-recent 3 --format simple
+purged backups/2016-01-27T1112
+purged backups/2019-12-24T1200
+purged backups/2021-01-19T1113
+keeping backups/2021-01-26T1111
+keeping backups/2021-01-27T1111
+keeping backups/2021-01-27T1112
+```
+
+#### `--keep-most-recent-for`
+
+Keeps the newest backups for a **time range** specified by *amount* and *unit*.
+An *amount* is an integer and a unit is something like *days* or *years*.
+Time ranges are discussed in more detail within their own section.
+
+The `--keep-most-recent-for "3 years"` option keeps all backups that are not older than three years.
+The **calculation takes the timestamp of the newest backup as reference**.
+
+```shell
+$ expire purge backups --keep-most-recent-for "3 years" --format simple
+purged backups/2016-01-27T1112
+keeping backups/2019-12-24T1200
+keeping backups/2021-01-19T1113
+keeping backups/2021-01-26T1111
+keeping backups/2021-01-27T1111
+keeping backups/2021-01-27T1112
+```
+
+#### `--from-now-keep-most-recent-for`
+
+The `--from-now-keep-most-recent-for` option works almost the same way as
+the `--keep-most-recent-for` option does.
+But it **bases its calculation on the current time**, not the timestamp of the newest backup.
+
+Assuming today is the 28th January 2021 the option `--from-now-most-recent-for=5.days`
+would act like this:
+
+```shell
+$ expire purge backups --from-now-keep-most-recent-for 5.days --format simple 
+purged backups/2016-01-27T1112
+purged backups/2019-12-24T1200
+purged backups/2021-01-19T1113
+keeping backups/2021-01-26T1111
+keeping backups/2021-01-27T1111
+keeping backups/2021-01-27T1112
+```
+
+#### Adjectives
+
+The following rules contain an adjective in their name.
+These adjectives are *hourly*, *daily*, *weekly*, *monthly* and *yearly*.
+
+#### `--keep-<adjective>`
+
+To keep **one backup per time unit** the *adjective rules* are handy.
+There are five adjective rules:
+
+- `--keep-hourly`
+- `--keep-daily`
+- `--keep-weekly`
+- `--keep-monthly`
+- `--keep-yearly`
+
+All of these expect an integer that specifies the maximum of backups they should preserve.
+
+```shell
+$ expire purge backups --keep-weekly 3 --format=simple
+purged backups/2016-01-27T1112
+keeping backups/2019-12-24T1200
+keeping backups/2021-01-19T1113
+purged backups/2021-01-26T1111
+purged backups/2021-01-27T1111
+keeping backups/2021-01-27T1112
+```
+
+You can also use `all` or `-1` to preserve all backups per time unit.
+
+```shell
+expire purge backups --keep-yearly all --format=simple
+keeping backups/2016-01-27T1112
+keeping backups/2019-12-24T1200
+purged backups/2021-01-19T1113
+purged backups/2021-01-26T1111
+purged backups/2021-01-27T1111
+keeping backups/2021-01-27T1112
+```
+
+#### `--keep-<adjective>-for`
+
+To preserve **one backup per unit for a certain time range** you can use *adjective for rules*.
+Time ranges are discussed in more detail within their own section
+There are five *adjective-for* rules:
+
+- `--keep-hourly-for`
+- `--keep-daily-for`
+- `--keep-weekly-for`
+- `--keep-monthly-for`
+- `--keep-yearly-for`
+
+The **calculation takes the timestamp of the newest backup as reference**.
+
+```shell
+$ expire purge backups --keep-daily-for='3 months' --format=simple
+purged backups/2016-01-27T1112
+purged backups/2019-12-24T1200
+keeping backups/2021-01-19T1113
+keeping backups/2021-01-26T1111
+purged backups/2021-01-27T1111
+keeping backups/2021-01-27T1112
+```
+
+#### `--from-now-keep-<adjective>-for`
+
+The *from now adjective for rules* work similar to *adjective for rules*,
+expect they **base their calculations on the current time**, not the timestamp of the newest backup.
+
+There are five *from now adjective for rules*:
+
+- `--from-now-keep-hourly-for`
+- `--from-now-keep-daily-for`
+- `--from-now-keep-weekly-for`
+- `--from-now-keep-monthly-for`
+- `--from-now-keep-yearly-for`
+
+Assuming today is the 28th January 2021 the option `--from-now-most-recent-for=5.days`
+would act like this:
+
+```shell
+$ expire purge backups --from-now-keep-daily-for='3 months' --format=simple
+purged backups/2016-01-27T1112
+purged backups/2019-12-24T1200
+keeping backups/2021-01-19T1113
+keeping backups/2021-01-26T1111
+purged backups/2021-01-27T1111
+keeping backups/2021-01-27T1112
+```
+
+#### Time ranges
+
+Some rules take a time range as argument.
+Time ranges can be expressed like this:
+
+```shell
+1 hour
+2.weeks
+3 months
+1_000 years
+```
+
+As you can see, a range is expressed as a combination of an **integer** and a **unit**.
+The integer portion can include underscores (`_`) **between** the digits.
+Possible values for the unit portion are:
+
+- `hour` and `hours`
+- `day` and `days`
+- `week` and `weeks`
+- `moth` and `months`
+- `year` and `years`
+
+Units are case-insensitive, so `Year` and `yEaR` are valid too.
+
+### `--rules-file`
+
+To read the rules form a YAML-file use the `--rules-file` option.
+The rules have to be specified with an underscore instead of a hyphen.
+
+Here is an example rules-file called `rules.yml`:
+
+```yml
+keep_most_recent: 3
+```
+
+With this rules-file we can `expire` with the `--rules-file` option:
+
+```shell
+$ expire purge backups --rules-file rules.yml --format=simple
+purged backups/2016-01-27T1112
+purged backups/2019-12-24T1200
+purged backups/2021-01-19T1113
+keeping backups/2021-01-26T1111
+keeping backups/2021-01-27T1111
+keeping backups/2021-01-27T1112
+```
+
+There is also a shortcut for the `--rules-file` option: `-r`.
+
+### The `--purge-command`, `--cmd` option
+
+The `expire` program can remove files and directories,
+but it doesn't know how to deal with logical volumes or subvolumes.
+This is where the `--purge-command` option comes in.
+
+The `--purge-command` option takes a command as argument.
+For each expired backup this command is executed with the backup-path as argument.
+
+```shell
+bundle exec exe/expire purge backups --keep-most-recent 3 --format=simple --purge-command='rm -rf'
+purged backups/2016-01-27T1112
+purged backups/2019-12-24T1200
+purged backups/2021-01-19T1113
+keeping backups/2021-01-26T1111
+keeping backups/2021-01-27T1111
+keeping backups/2021-01-27T1112
+```
+
+The previous example has called these shell commands:
+
+```shell
+rm -rf backups/2016-01-27T1112
+rm -rf backups/2019-12-24T1200
+rm -rf backups/2021-01-19T1113
+```
+
+## How backup timestamps are detected
+
+`expire` recognizes the date of a backup by its file name (or directory name).
+This file name must consist of twelve or 14 digits and can optionally contain other characters.
+The digits are considered as `YYYYmmddHHMMSS`, where,
+
+- `YYYY` denotes the year of the backup such as `2021`
+- `mm` denotes the month the backups was created such as `01` or `11`
+- `dd` denotes the day of month such as `07` or `28`
+- `HH` denotes the hour (`00`..`23`)
+- `MM` denotes the minute
+- `SS` denotes the second; seconds are optional
+
+Some valid filenames:
+
+```shell
+2021-01-19T1113   # with arbitrary characters
+2021-01-19T111345 # with arbitrary characters and seconds
+202101191113      # no arbitrary characters
+20210119111345    # with seconds and no arbitrary characters
+```
+
+Some **invalid** filenames:
+
+```shell
+2021-01-19       # just a date, no time
+2021-02-31T1113  # February 31
+2101191113       # year 2101, only 10 digits
+2021011911134501 # 16 digits are too much
+```
+
+Date detection via ctime or mtime is planned for a future release.
+
+## Newest
+
+The `newest` command shows the newest backup:
+
+```shell
+$ expire newest backups                
+backups/2021-01-27T1112
+```
+
+## Oldest
+
+The `oldest` command shows the oldest backup:
+
+```shell
+$ expire oldest backups          
+backups/2016-01-27T1112
+```
+
+## Remove
+
+The `remove` command can be used to remove files or directories:
+
+```shell
+$ expire remove /tmp/stuff
+removed /tmp/stuff
+```
+
+## Rule classes
+
+The `rule-classes` command returns a list of all rule-classes:
+
+```shell
+$ expire rule-classes
+Expire::KeepMostRecentRule
+Expire::KeepMostRecentForRule
+Expire::FromNowKeepMostRecentForRule
+Expire::KeepHourlyRule
+Expire::KeepDailyRule
+Expire::KeepWeeklyRule
+Expire::KeepMonthlyRule
+Expire::KeepYearlyRule
+Expire::KeepHourlyForRule
+Expire::KeepDailyForRule
+Expire::KeepWeeklyForRule
+Expire::KeepMonthlyForRule
+Expire::KeepYearlyForRule
+Expire::FromNowKeepHourlyForRule
+Expire::FromNowKeepDailyForRule
+Expire::FromNowKeepWeeklyForRule
+Expire::FromNowKeepMonthlyForRule
+Expire::FromNowKeepYearlyForRule
+```
+
+## Rule names
+
+The `rule-names` command shows a list of all rule-names:
+
+```shell
+$ expire rule-names
+keep_most_recent
+keep_most_recent_for
+from_now_keep_most_recent_for
+keep_hourly
+keep_daily
+keep_weekly
+keep_monthly
+keep_yearly
+keep_hourly_for
+keep_daily_for
+keep_weekly_for
+keep_monthly_for
+keep_yearly_for
+from_now_keep_hourly_for
+from_now_keep_daily_for
+from_now_keep_weekly_for
+from_now_keep_monthly_for
+from_now_keep_yearly_for
+```
+
+## Rule option names
+
+To get a list of all rule option-names call:
+
+```shell
+$ expire rule-option-names
+--keep-most-recent
+--keep-most-recent-for
+--from-now-keep-most-recent-for
+--keep-hourly
+--keep-daily
+--keep-weekly
+--keep-monthly
+--keep-yearly
+--keep-hourly-for
+--keep-daily-for
+--keep-weekly-for
+--keep-monthly-for
+--keep-yearly-for
+--from-now-keep-hourly-for
+--from-now-keep-daily-for
+--from-now-keep-weekly-for
+--from-now-keep-monthly-for
+--from-now-keep-yearly-for
+```
+
+## 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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on
+GitHub at [thomasregnet/expire](https://github.com/thomasregnet/expire.)
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](https://opensource.org/licenses/MIT).