lazy_rotator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d56a9409316a9c515cacc6fb2ccce23d196236b205b70c223c27b52809d5b2cc
+  data.tar.gz: e0dfec11ffb6830ef9e6940279849f6ac993b94d4916001ad23ae8ca93a654f3
+SHA512:
+  metadata.gz: 9f7c200b136bd0f401822ead91a808e09c835890e26b24a1332207d344109d2ff401a8d5e8ff0b8e98feebba8fa83c0762c91a1e533d03f9b85dcd865571c59e
+  data.tar.gz: 6a491b1b0277f6a8390c0d981f0fe524b145decde8a489e0f37e64d8cdc1917dfa93db9594675df88fb959bf8b160c68f75a6547fb65589a2dfdc651ad52b0c8

data/.gitignore

@@ -0,0 +1,16 @@
+.DS_Store
+/.bundle/
+/.ruby-version
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/ruby
+
+/Gemfile.lock
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,15 @@
+AllCops:
+  TargetRubyVersion: 2.2
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+
+Metrics/LineLength:
+  Exclude:
+    - 'lazy_rotator.gemspec'
+    - 'spec/**/*'
+
+Style/MutableConstant:
+  Exclude:
+    - 'lib/lazy_rotator/version.rb'

data/CHANGELOG.md

@@ -0,0 +1,19 @@
+# Change Log
+
+## master (unreleased)
+
+### New features
+
+- N/A
+
+### Bug fixes
+
+- N/A
+
+### Changes
+
+- N/A
+
+## [0.1.0 (2018-08-07)](https://github.com/jlw/lazy_rotator/releases/tag/v0.1.0)
+
+- First release

data/CONTRIBUTING.md

@@ -0,0 +1,34 @@
+# Contributing
+
+If you discover issues, have ideas for improvements or new features, please report them to the [issue tracker][1] of the repository or submit a pull request. Please, try to follow these guidelines when you do so.
+
+## Issue reporting
+
+- Check that the issue has not already been reported.
+- Check that the issue has not already been fixed in the latest code (a.k.a. `master`).
+- Be clear, concise and precise in your description of the problem.
+- Open an issue with a descriptive title and a summary in grammatically correct, complete sentences.
+- Include any relevant code to the issue summary.
+
+## Pull requests
+
+- Read [how to properly contribute to open source projects on GitHub][2].
+- Fork the project.
+- Use a topic/feature branch to easily amend a pull request later, if necessary.
+- Write [good commit messages][3].
+- Use the same coding conventions as the rest of the project.
+- Commit and push until you are happy with your contribution.
+- If your change has a corresponding open GitHub issue, prefix the commit message with `[Fix #github-issue-number]`.
+- Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+- Add an entry to the [Change Log](CHANGELOG.md) accordingly.
+- Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+- Make sure the test suite is passing for all supported Ruby versions: `./all_rubies bundle && ./all_rubies spec`.
+- Make sure the code you wrote doesn't produce RuboCop offenses `bundle exec rubocop`.
+- [Squash related commits together][5].
+- Open a [pull request][4] that relates to _only_ one subject with a clear title and description in grammatically correct, complete sentences.
+
+[1]: https://github.com/jlw/lazy_rotator/issues
+[2]: http://gun.io/blog/how-to-github-fork-branch-and-pull-request
+[3]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
+[4]: https://help.github.com/articles/about-pull-requests
+[5]: http://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html

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 lazy_rotator.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+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 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.
+
+For more information, please refer to <http://unlicense.org>

data/README.md

@@ -0,0 +1,43 @@
+# LazyRotator
+
+Tie log (or other file) rotation to the (un-scheduled?) execution of code. The _raison d'étre_ for this gem is that I'm too lazy to clear out test and development logs manually and am too anal-retentive to be happy with large log files accumulating in my various project directories.
+
+On those rare occasions when I do want to look at a log file in my development environment, I don't want to waste time skipping past megabytes of older log entries. On the other hand, I might have restarted my app server or run tests (maybe a different set) again before deciding to look at the logs, so I don't want to simply truncate the log files on each run - keeping a few very recent files around seems to be a useful compromise.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'lazy_rotator', group: %i(development test)
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install lazy_rotator
+
+## Usage
+
+For a Rails app, add the following to `config/application.rb`:
+
+```ruby
+if defined?(LazyRotator) && (Rails.env.test? || Rails.env.development?)
+  LazyRotator.rotate(File.expand_path("../log/#{Rails.env}.log", __dir__))
+end
+```
+
+_Note:_ you will probably need to update your `.gitignore` file to match `/log/*.log*` - that trailing `*` will catch the rotated files.
+
+Set the number of copies to keep (the default is 5):
+```ruby
+LazyRotator.rotate('path/to/log', 20)
+```
+
+
+## Contributing
+
+[Bug reports and pull requests are welcome.](CONTRIBUTING.md)

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/all_rubies

@@ -0,0 +1,44 @@
+#!/bin/bash
+
+versions=('2.2.10' '2.3.7' '2.4.4' '2.5.1')
+
+switcher=`which rbenv`
+if [[ $switcher = *[!\ ]* ]]; then
+  verb="local"
+else
+  switcher=`which rvm`
+  if [[ $switcher = *[!\ ]* ]]; then
+    verb="use"
+  else
+    echo "Please install rbenv or rvm"
+    exit 1
+  fi
+fi
+
+case "$1" in
+  bundle)
+    for version in ${versions[@]}
+    do
+      echo "Bundle for Ruby $version"
+      eval "$switcher $verb $version"
+      gem list --local bundler | grep bundler || gem install bundler --no-ri --no-rdoc
+      bundle install --path vendor
+      bundle update
+    done
+    ;;
+
+  spec)
+    for version in ${versions[@]}
+    do
+      echo "Run specs with Ruby $version"
+      eval "$switcher $verb $version"
+      bundle exec rspec spec
+    done
+    ;;
+
+  *)
+    echo $"Usage: $0 {bundle|spec}"
+    exit 1
+esac
+
+exit 0

data/bin/console

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'lazy_rotator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'lazy_rotator'
+  spec.version       = LazyRotator::VERSION
+  spec.authors       = ['Jeremy Weathers']
+  spec.email         = ['jeremy@codekindly.com']
+
+  spec.summary       = 'Lazily rotate log files'
+  spec.description   = "Tie log (or other file) rotation to the (un-scheduled?) execution of code. The raison d'étre for this gem is that I'm too lazy to clear out test and development logs manually and am too anal-retentive to be happy with large log files accumulating in my various project directories."
+  spec.homepage      = 'https://github.com/jlw/lazy_rotator'
+  spec.license       = 'Unlicense'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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.required_ruby_version = '>= 2.2.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'fuubar'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'simplecov'
+end

data/lib/lazy_rotator.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'lazy_rotator/file'
+require 'lazy_rotator/set'
+require 'lazy_rotator/version'
+
+# Rotate a set of files
+module LazyRotator
+  def self.rotate(file_name, retention_limit = 5)
+    Set.new(file_name, retention_limit).process
+  end
+end

data/lib/lazy_rotator/file.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require_relative 'file/undetermined'
+require_relative 'file/delete'
+require_relative 'file/ignore'
+require_relative 'file/rename'
+require_relative 'file/touch'

data/lib/lazy_rotator/file/delete.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module LazyRotator
+  module File
+    # Removes files that have met the current retention limit
+    class Delete < Undetermined
+      def process
+        ::File.delete file_name
+      end
+    end
+  end
+end

data/lib/lazy_rotator/file/ignore.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module LazyRotator
+  module File
+    # Skips processing on a file that does not need to be renamed or deleted
+    # during the current rotation (this is an edge case suggesting a previous
+    # error or manual deletion of files)
+    class Ignore < Undetermined
+    end
+  end
+end

data/lib/lazy_rotator/file/rename.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module LazyRotator
+  module File
+    # Moves a file along in the rotation (assuming it should still be kept)
+    class Rename < Undetermined
+      attr_reader :new_number
+
+      def initialize(file_name, new_number)
+        @file_name  = file_name
+        @new_number = new_number
+      end
+
+      def file_name_without_number
+        @file_name_without_number ||= begin
+          m = Regexp.new("^(.+)\\.#{number}$").match(::File.basename(file_name))
+          return file_name unless m
+          ::File.join(::File.dirname(file_name), m[1])
+        end
+      end
+
+      def new_file_name
+        file_name_without_number + ".#{new_number}"
+      end
+
+      def process
+        ::File.rename(file_name, new_file_name)
+      end
+    end
+  end
+end

data/lib/lazy_rotator/file/touch.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module LazyRotator
+  module File
+    # Ensure the initial file is in place
+    class Touch < Undetermined
+      def process
+        return unless number.zero?
+        ::FileUtils.touch file_name
+      end
+    end
+  end
+end

data/lib/lazy_rotator/file/undetermined.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module LazyRotator
+  module File
+    # The placeholder for a file before determining the correct action as part
+    # of the current rotation process
+    class Undetermined
+      attr_reader :file_name
+
+      def initialize(file_name)
+        @file_name = file_name.to_s
+      end
+
+      def number
+        @number ||= self.class.file_number(file_name)
+      end
+
+      def process; end
+
+      # rubocop:disable Metrics/AbcSize
+      def ==(other)
+        return false if self.class.name != other.class.name
+        return false if number != other.number
+        return false if file_name != other.file_name
+        return true unless respond_to?(:new_number)
+        return false if new_number != other.new_number
+        true
+      end
+      # rubocop:enable Metrics/AbcSize
+
+      def <=>(other)
+        return number <=> other.number unless number == other.number
+        file_name <=> other.file_name
+      end
+
+      def self.file_number(file_name)
+        file_name.to_s.split('.').last.to_i
+      end
+    end
+  end
+end

data/lib/lazy_rotator/set.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module LazyRotator
+  # Collects rotated/to-rotate files and decides what to do with each
+  class Set
+    include Enumerable
+
+    attr_reader :files
+
+    def initialize(file_name, retention_limit)
+      # reverse the prepared set so that rotated naming works correctly
+      # if I rename '1' to '2' and then '2' to '3', etc. I lose those files
+      @files = self.class.prepare_files(file_name, retention_limit).reverse
+    end
+
+    def each(&block)
+      @files.each(&block)
+    end
+
+    def process
+      map(&:process)
+    end
+
+    class << self
+      def file_regexp(file_name)
+        Regexp.new(Regexp.quote(file_name) + '(\\.\\d+)?$')
+      end
+
+      # return a set of collected files with correct processing decisions
+      def prepare_files(file_name, retention_limit)
+        raw_files = collect_files(file_name.to_s)
+        prepared_files = [File::Touch.new(file_name)]
+        delete_after = retention_limit - 1
+        next_number = 1
+        raw_files.each do |file|
+          prepared_files << prepare_file(file, delete_after, next_number)
+          next_number += 1
+        end
+        prepared_files
+      end
+
+      private
+
+      # find all matching files that should be processed as part of the rotation
+      def collect_files(file_name)
+        regexp     = file_regexp(file_name)
+        naive_list = Dir.glob(file_name + '*')
+        file_list  = naive_list.select { |f| regexp.match(f) }
+        file_list.map { |f| File::Undetermined.new(f) }.sort
+      end
+
+      def prepare_file(file, delete_after, next_number)
+        corrected_number = next_number - 1
+        if corrected_number > delete_after
+          File::Delete.new(file.file_name)
+        elsif file.number == next_number
+          File::Ignore.new(file.file_name)
+        else
+          File::Rename.new(file.file_name, next_number)
+        end
+      end
+    end
+  end
+end

data/lib/lazy_rotator/version.rb

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

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: lazy_rotator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jeremy Weathers
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-08-07 00:00:00.000000000 Z
+dependencies:
+- !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: fuubar
+  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: 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'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: simplecov
+  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: Tie log (or other file) rotation to the (un-scheduled?) execution of
+  code. The raison d'étre for this gem is that I'm too lazy to clear out test and
+  development logs manually and am too anal-retentive to be happy with large log files
+  accumulating in my various project directories.
+email:
+- jeremy@codekindly.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- all_rubies
+- bin/console
+- bin/setup
+- lazy_rotator.gemspec
+- lib/lazy_rotator.rb
+- lib/lazy_rotator/file.rb
+- lib/lazy_rotator/file/delete.rb
+- lib/lazy_rotator/file/ignore.rb
+- lib/lazy_rotator/file/rename.rb
+- lib/lazy_rotator/file/touch.rb
+- lib/lazy_rotator/file/undetermined.rb
+- lib/lazy_rotator/set.rb
+- lib/lazy_rotator/version.rb
+homepage: https://github.com/jlw/lazy_rotator
+licenses:
+- Unlicense
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Lazily rotate log files
+test_files: []