wolfe 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5f3507d28088e498ba540c4cbe92f6e510f17d01
+  data.tar.gz: 8ee66841f21b71d418dca828b3b44fc7de7a0541
+SHA512:
+  metadata.gz: 63e9c6f52d05dba90bd22c62fdc10de05b2be85ada6da2af1c4dff75dbd16cdf52527ad1c67dfda75b1234d51585c28dc7f225bb145821262ebe28bffd2467de
+  data.tar.gz: 3a1156453f097e830adf7f94d109569a1aa740d095d889a76428e2b829f36cf17201bd30bda4397a5495c2d61600ecd3bf33091727e4fbd9e08868c6401d92ca

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in wolfe.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Martin Sereinig
+
+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,47 @@
+# Wolfe
+
+Wolfe's purpose is to clean up database (and other) backups that encode year, month, day and hour in their filename. That's also what wolfe will look at when deciding if a file has to be removed or not. Wolfe can be configured to keep daily and monthly backups for a given timespan and will always keep one backup for every year.
+
+Original code was written by [@michaelem](https://github.com/michaelem), tests and gemification by [@srecnig](https://github.com/srecnig). In case you're wondering, the name wolfe is a [reference](http://www.imdb.com/title/tt0110912/quotes?item=qt0447112).
+
+## Installation
+
+Wolfe can be installed through the usual sources: add it to your application's ``Gemfile`` or install manually through ``gem install``.
+
+## Usage
+
+Call wolfe from the command line and give a rule file as one single parameter.
+
+```bash
+wolfe cleanup rules.yml
+```
+
+Or call wolfe from within your project if you've added it to the Gemfile.
+
+```ruby
+Wolfe.run_cleanup "/path/to/rules.yml"
+```
+
+## Rules.yml
+
+The rule file contains the information on where backups are stored, how the date metadata is encoded in the filename and how many backups to keep per timespan.
+
+```yaml
+---
+backup_name:
+  path: /mnt/data/backups/database
+  filename: 'backup-database-%{year}-%{month}-%{day}-%{hour}.tar.gz'
+  one_per_day_timespan: 15.days
+  one_per_month_timespan: 1.year
+```
+
+To configure the timespans we rely on ``active support``'s [time extensions](http://guides.rubyonrails.org/active_support_core_extensions.html#time) to ``Numeric``, so something like ``1.month``, ``2.years``, etc. will work. No spaces or ruby code please.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/lomography/wolfe. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "wolfe"
+
+# 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

data/bin/setup

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

data/exe/wolfe

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'wolfe'
+
+Wolfe::CLI.start

data/lib/wolfe.rb

@@ -0,0 +1,15 @@
+require "yaml"
+
+require "wolfe/cleanup"
+require "wolfe/cli"
+require "wolfe/version"
+
+module Wolfe
+  def self.run_cleanup file_path
+    raise ArgumentError.new("Cleanup configuration file does not exist.") unless File.exist? file_path
+
+    config = YAML::load_file( file_path )
+    cleanup = Cleanup.new(config)
+    cleanup.start
+  end
+end

data/lib/wolfe/cleanup.rb

@@ -0,0 +1,114 @@
+require "active_support"
+require "active_support/core_ext"
+require "fileutils"
+
+module Wolfe
+  class Cleanup
+    attr_accessor :configuration
+
+    def initialize(configuration)
+      @configuration = configuration
+      validate_configuration
+    end
+
+    def start
+      configuration.each do |name, config|
+        puts "-----------------------------------------------------"
+        puts "Cleaning up backups: #{name}"
+        puts "-----------------------------------------------------"
+
+        cleanup( config )
+      end
+    end
+
+    private
+
+      #
+      # validation
+      #
+
+      def validate_configuration
+        raise ArgumentError.new("Configuration must be hash.") unless configuration.is_a? Hash
+        configuration.each do |name, config|
+          raise ArgumentError.new("Configuration keys for #{name} missing.") unless configuration_keys.all? { |k| config.key?(k) }
+          raise ArgumentError.new("Invalid timespan argument for #{name}")   unless config['one_per_day_timespan'] =~ timespan_regex
+          raise ArgumentError.new("Invalid timespan argument for #{name}")   unless config['one_per_month_timespan'] =~ timespan_regex
+          raise ArgumentError.new("Path for #{name} does not exist.")        unless Dir.exist?(config['path'])
+        end
+      end
+
+      def configuration_keys
+        ['path', 'filename', 'one_per_day_timespan', 'one_per_month_timespan']
+      end
+
+      def timespan_regex
+        /^\d+\.(days?|weeks?|months?|years?)$/
+      end
+
+      #
+      # cleanup
+      #
+
+      def cleanup( config )
+        daily_date = Date.today - eval( config['one_per_day_timespan'] )
+        monthly_date = Date.today - eval( config['one_per_month_timespan'] )
+        first_relevant_date = Date.today - 5.years
+
+        if File.directory?(config['path'])
+          clean_monthly( monthly_date, daily_date, config )
+          clean_yearly( first_relevant_date, monthly_date, config )
+        else
+          puts "Path '#{config['path']}' is not a directory."
+        end
+      end
+
+      def clean_monthly( monthly_date, daily_date, config )
+        daily_date.downto( monthly_date ) do |date|
+          delete_but_keep_one_per_month( config['path'], config['filename'], date )
+        end
+      end
+
+      def clean_yearly( first_relevant_date, monthly_date, config )
+        monthly_date.downto( first_relevant_date ) do |date|
+          delete_but_keep_one_per_year( config['path'], config['filename'], date )
+        end
+      end
+
+      def delete_but_keep_one_per_month( path, filename, date )
+        filename_month = filename % { year: date.strftime('%Y'),
+                                     month: date.strftime('%m'),
+                                       day: '*',
+                                      hour: '*' }
+        filename_day = filename % { year: date.strftime('%Y'),
+                                   month: date.strftime('%m'),
+                                     day: date.strftime('%d'),
+                                    hour: '*' }
+        delete_but_keep_one( full_path( path, filename_month ), full_path( path, filename_day ) )
+      end
+
+      def delete_but_keep_one_per_year( path, filename, date )
+        filename_year = filename % { year: date.strftime('%Y'),
+                                    month: '*',
+                                      day: '*',
+                                     hour: '*' }
+        filename_day = filename % { year: date.strftime('%Y'),
+                                   month: date.strftime('%m'),
+                                     day: date.strftime('%d'),
+                                    hour: '*' }
+        delete_but_keep_one( full_path( path, filename_year ), full_path( path, filename_day ) )
+      end
+
+      def full_path( path, filename )
+        File.expand_path(File.join(path, filename))
+      end
+
+      def delete_but_keep_one( keep_path, delete_path )
+        Dir.glob(delete_path).each do |f|
+          if Dir.glob(keep_path).count > 1
+            puts "Delete: #{f}"
+            FileUtils.rm(f)
+          end
+        end
+      end
+  end
+end

data/lib/wolfe/cli.rb

@@ -0,0 +1,14 @@
+require 'thor'
+
+module Wolfe
+  class CLI < Thor
+    desc "cleanup path/to/rule/file.yml", "Clean up files according to rules specified in given yaml file."
+    def cleanup file
+      begin
+        Wolfe.run_cleanup file
+      rescue ArgumentError => e
+        puts "Error: #{e}"
+      end
+    end
+  end
+end

data/lib/wolfe/version.rb

@@ -0,0 +1,3 @@
+module Wolfe
+  VERSION = "1.0.0"
+end

data/wolfe.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'wolfe/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "wolfe"
+  spec.version       = Wolfe::VERSION
+  spec.authors       = ["Michael Emhofer", "Martin Sereinig"]
+  spec.email         = ["dev@lomography.com"]
+
+  spec.summary       = %q{Cleanup (backup) files by date.}
+  spec.description   = "Often backup files have year, month, date and hour encoded in their filename. " \
+                       "Wolfe uses this information to clean up such files and can be configured to " \
+                       "keep daily/monthly backups for a certain timespans. It will always keep one backup per year."
+  spec.homepage      = "http://github.com/lomography/wolfe"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "thor"
+  spec.add_dependency "activesupport"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "byebug"
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: wolfe
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Michael Emhofer
+- Martin Sereinig
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-10-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Often backup files have year, month, date and hour encoded in their filename.
+  Wolfe uses this information to clean up such files and can be configured to keep
+  daily/monthly backups for a certain timespans. It will always keep one backup per
+  year.
+email:
+- dev@lomography.com
+executables:
+- wolfe
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/wolfe
+- lib/wolfe.rb
+- lib/wolfe/cleanup.rb
+- lib/wolfe/cli.rb
+- lib/wolfe/version.rb
+- wolfe.gemspec
+homepage: http://github.com/lomography/wolfe
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Cleanup (backup) files by date.
+test_files: []