log_sweeper 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4db94e181fdea505a9a543ea7ad4316f06b4d3f396137804ef6db8cc8d38025d
-  data.tar.gz: 69f722b86d9c989f4ba0dac7408f9e58703ac51ed6bae91a3923d32f8c01b7c2
+  metadata.gz: 0bd0748e38c19967141c34eecdc9b748b80542a15f6e863dd2dd4d60869e1069
+  data.tar.gz: baac5ec981df3fe90b6f807b1e6d93b3d2af4589b6639d94eea7b2115e9fa554
 SHA512:
-  metadata.gz: 14b54d6394d7ddce37db6c7cd233f456fb00a11e513c7993f9b6ff4a7611d85857b5a02a7cf627bcab7c16f8a41e3ad0b5575732b73b1853757b64f46cb7364c
-  data.tar.gz: 44d078163fdb1dc8bede864a389afb91d9f485359bddb0fc1d08a494aaa541cc0e655c5094f0a451c4839738411770f4562cd7bc2147509e441f6bb11ac03081
+  metadata.gz: 3e13eae27b6e80a1b1900736e71f7752781432682e97fe6ab222a6426421901e1af3eafef05271bfc96e8f308b6ffae9eab5d0a7699ecb0edb66f44a6775147a
+  data.tar.gz: 5d026bdf9016299687e09e56ab602ffa3abca64210c6e136f9df5ed11a9c2552c5d4fb4c7c9506a1e6cb26172e2283a85689fb1540304e65632984770216eecc

data/.gitignore

@@ -6,6 +6,7 @@
 /pkg/
 /spec/reports/
 /tmp/
+/spec/log
 
 # rspec failure tracking
 .rspec_status

data/.rubocop.yml

@@ -3,4 +3,4 @@ inherit_gem:
 
 AllCops:
   DisplayCopNames: true
-  TargetRubyVersion: 2.5
+  TargetRubyVersion: 2.3

data/README.md

@@ -1,39 +1,42 @@
-# LogSweeper
+# LogSweeper   [![Gem Version](https://badge.fury.io/rb/log_sweeper.svg)](https://badge.fury.io/rb/log_sweeper) [![Build Status](https://travis-ci.org/umbrellio/log_sweeper.svg?branch=master)](https://travis-ci.org/umbrellio/log_sweeper) [![Coverage Status](https://coveralls.io/repos/github/umbrellio/log_sweeper/badge.svg?branch=master)](https://coveralls.io/github/umbrellio/log_sweeper?branch=master)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/log_sweeper`. To experiment with that code, run `bin/console` for an interactive prompt.
+`LogSweeper` is a simple module for cleaning up log directories.
 
-TODO: Delete this and the text above, and describe your gem
+It is designed to be used with Ruby logger rotation. By default, it will remove all log files older than 10 days and will gzip all log files that look like rotated log files. For example, `production.log.20190228` will be gzipped and replaced with `production.log.20190228.gz`. It logs what it's doing using the provided logger which defaults to `STDOUT` logger.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Juts add `gem "log_sweeper"` to your Gemfile.
 
-```ruby
-gem 'log_sweeper'
-```
-
-And then execute:
+## Examples
 
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install log_sweeper
+```ruby
+  # Just use the defaults
+  LogSweeper.run("log")
 
-## Usage
+  # Customize logs lifetime and logger
+  LogSweeper.run("log", logs_lifetime_days_count: 5, logger: Logger.new("/path/to/file.log"))
 
-TODO: Write usage instructions here
+  # In case you don't want any logging and deleting any logs
+  LogSweeper.run("log", logs_lifetime_days_count: Float::INFINITY, logger: Logger.new(nil))
+```
 
-## Development
+The best way to use this module is to run it via cron, for example you can use [whenever](https://github.com/javan/whenever) gem with similar config in `schedule.rb` file:
 
-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.
+```ruby
+every 1.hour do
+  runner "LogRotator.run(Rails.root.join('log'))"
+end
+```
 
-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).
+## License
 
-## Contributing
+Released under MIT License.
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/tycooon/log_sweeper.
+## Authors
 
-## License
+Created by Yuri Smirnov.
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+<a href="https://github.com/umbrellio/">
+<img style="float: left;" src="https://umbrellio.github.io/Umbrellio/supported_by_umbrellio.svg" alt="Supported by Umbrellio" width="439" height="72">
+</a>

data/lib/log_sweeper/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LogSweeper
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/lib/log_sweeper.rb

@@ -9,18 +9,22 @@ require "logger"
 module LogSweeper
   extend self
 
+  # Clean up provided log directory
+  # @param path [String, Pathname] path to the log directory to clean
+  # @param logs_lifetime_days_count [Numeric] number of days to keep the logs
+  # @param logger [Logger] logger to use
   def run(path, logs_lifetime_days_count: 10, logger: Logger.new(STDOUT))
-    min_mtime = Time.now - (logs_lifetime_days_count.to_f * 24 * 3600)
+    lifetime_threshold = logs_lifetime_days_count * 24 * 3600
 
     Pathname.new(path).each_child do |entry|
       next unless entry.file?
 
       filename = entry.basename.to_s
 
-      if filename.match?(/\.log\b/) && entry.mtime < min_mtime
+      if filename =~ /\.log\b/ && Time.now - entry.mtime > lifetime_threshold
         logger.info "deleting #{entry}"
         entry.delete
-      elsif filename.match?(/\.log\.\d+$/)
+      elsif filename =~ /\.log\.\d+$/
         logger.info "gzipping #{entry}"
         compress_file(entry)
         entry.delete

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: log_sweeper
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Yuri Smirnov