housekeeper 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 432db038e64efa65603ad13669f791ac44824f075b1490e4713d62b54a5a2886
+  data.tar.gz: d498c3567d638471798b206a2aa5c1d26a94dda5fd88243e5a3527d0298e0bce
+SHA512:
+  metadata.gz: 6f1832946aad08f6c63593715a040fb481818e3c9cd70617ae0ac9818c31aafee0e173669e9eacc383032c2f87bcf43d32899b7d4a25ad89c2fa7b20840f7bad
+  data.tar.gz: 0c9c584c89130b3e7a9cb224a7218c045ef916213db0659b8e7cdb2e7e2b983244c653d67ecae2174e5680a8dc932c1a9022ae841df1f6c7b72152a13fdfd26d

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.byebug_history
+*.gem
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

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

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,41 @@
+PATH
+  remote: .
+  specs:
+    housekeeper (0.1.0)
+      commander (~> 4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (10.0.2)
+    commander (4.4.7)
+      highline (~> 2.0.0)
+    diff-lcs (1.3)
+    highline (2.0.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  byebug (~> 10.0)
+  housekeeper!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Roman Lehnert
+
+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,57 @@
+# Housekeeper
+
+Housekeeper helps with keeping directories clean. It takes content that is older than a specified age and either deletes or archives it. 
+
+## Usage
+
+```shell
+$ housekeeper -h
+
+Usage: housekeeper [options]
+    -a, --action ACTION              Action (can be archive or delete)
+    -d, --dir DIRNAME                Directory to cleanup
+    -m, --age AGE                    The minimum mtime age in seconds of contents to be cleaned up
+```
+
+
+In order to have only contents in your `~/Downloads` directory, which are newer than 1 day, setup the following cronjob:
+
+```
+* * * * * housekeeper --dir $HOME/Downloads --age 86400 --action archive
+```
+
+And to keep only files in your `~/Downloads/archive` directory, which are newer than 5 days, setup the following cronjob:
+
+```
+* * * * * housekeeper --dir $HOME/Downloads/archive --age 432000 --action delete
+```
+
+
+Contents can be ignored by putting a file called `.housekeeper_ignore` with an [fnmatch pattern](https://ruby-doc.org/core-2.2.0/File.html#method-c-fnmatch), for example
+```
+myfile.*
+**.rb
+```
+
+
+
+## Installation
+
+Install it with bundler
+
+    $ gem install housekeeper
+
+
+## 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 https://github.com/romanlehnert/housekeeper.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'housekeeper'
+
+# 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(__FILE__)

data/bin/setup

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

data/exe/housekeeper

@@ -0,0 +1,40 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'housekeeper'
+require 'optparse'
+
+options = {}
+
+MANDATORY_ARGUMENTS = %i[action dir age].freeze
+VALID_ACTIONS = %w[archive delete].freeze
+
+parser = OptionParser.new do |parser|
+  parser.on('-a', '--action ACTION', String, 'Action (can be archive or delete)') do |action|
+    options[:action] = action
+  end
+
+  parser.on('-d', '--dir DIRNAME', String, 'Directory to cleanup') do |d|
+    options[:dir] = d
+  end
+
+  parser.on('-m', '--age AGE', Integer, 'The minimum mtime age in seconds of contents to be cleaned up') do |m|
+    options[:age] = m
+  end
+end
+
+begin
+  parser.parse!
+
+  missing = MANDATORY_ARGUMENTS.select { |param| options[param].nil? }
+
+  raise OptionParser::MissingArgument, missing.join(', ') unless missing.empty?
+  raise OptionParser::InvalidArgument, "action must be one of #{VALID_ACTIONS.join(', ')}" unless VALID_ACTIONS.include?(options[:action])
+rescue OptionParser::InvalidOption, OptionParser::MissingArgument, OptionParser::InvalidArgument
+  puts $ERROR_INFO.to_s
+  puts
+  puts parser
+  exit
+end
+
+Housekeeper::Cleaner.new(options[:dir], min_age_seconds: options[:age]).send(options[:action])

data/housekeeper.gemspec

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'housekeeper/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'housekeeper'
+  spec.version       = Housekeeper::VERSION
+  spec.authors       = ['Roman Lehnert']
+  spec.email         = ['roman.lehnert@gmail.com']
+
+  spec.summary       = 'Housekeeping for directories'
+  spec.description   = 'Lets you delete or archive files and dirs'
+  spec.homepage      = 'https://github.com/romanlehnert/housekeeper'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'commander', '~> 4'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'byebug', '~> 10.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/lib/housekeeper.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'housekeeper/version'
+require_relative 'housekeeper/cleaner'
+
+module Housekeeper
+  # Your code goes here...
+end

data/lib/housekeeper/cleaner.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Housekeeper
+  class Cleaner
+    attr_reader :archive_path
+    attr_reader :min_age_seconds
+    attr_reader :base_path
+
+    IGNORES_FILE_NAME = '.housekeeper_ignore'
+    DEFAULT_IGNORES = ['.', '..', 'archive'].freeze
+
+    def initialize(base_path, min_age_seconds: nil)
+      @base_path = base_path
+      @archive_path = File.join(base_path, 'archive/')
+      @min_age_seconds = min_age_seconds || 0
+    end
+
+    def archive
+      Dir.mkdir(archive_path) unless Dir.exist?(archive_path)
+
+      Dir.new(base_path).each do |entry|
+        next if skip_entry?(entry)
+
+        FileUtils.mv(entry_path(entry), archive_path)
+      end
+    end
+
+    def delete
+      Dir.new(base_path).each do |entry|
+        next if skip_entry?(entry)
+
+        FileUtils.remove_entry_secure(entry_path(entry))
+      end
+    end
+
+    private
+
+    def entry_path(entry_name)
+      File.join(base_path, entry_name)
+    end
+
+    def skip_entry?(entry)
+      return true if DEFAULT_IGNORES.include?(entry)
+      return true if filed_ignores.any? { |pattern| File.fnmatch(pattern, entry) }
+      return true if File.mtime(entry_path(entry)) > Time.now - min_age_seconds
+    end
+
+    def filed_ignores
+      ignore_file_path = File.join(base_path, IGNORES_FILE_NAME)
+
+      return [] unless File.exist?(ignore_file_path)
+
+      File.new(ignore_file_path).readlines
+    end
+  end
+end

data/lib/housekeeper/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Housekeeper
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: housekeeper
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Roman Lehnert
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-11-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: commander
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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: 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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Lets you delete or archive files and dirs
+email:
+- roman.lehnert@gmail.com
+executables:
+- housekeeper
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/housekeeper
+- housekeeper.gemspec
+- lib/housekeeper.rb
+- lib/housekeeper/cleaner.rb
+- lib/housekeeper/version.rb
+homepage: https://github.com/romanlehnert/housekeeper
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.7.7
+signing_key: 
+specification_version: 4
+summary: Housekeeping for directories
+test_files: []