evanescent 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e9756a1c8493afab25b856431ec5359429ec7a36
+  data.tar.gz: 7a649af3f5758d2d7d8bb180787d8ff334ab30c1
+SHA512:
+  metadata.gz: 22f7837d5e81ea7e90fa53b490a838a95f3ce8b865aa4b962fa86ce6cb3ac1d47deecfa0d09110b1b7e36fc7e77e72e319a255598e629cf0df46998d929583d7
+  data.tar.gz: 4af0198e703e5972b924a6ad1d8f70ab32eb4942c18674b962c0a5a754a84d44040f430ae9b1870e23d476c0b14ccf8133f7b3d697dec5852f07950b8de8c211

data/lib/evanescent.rb

@@ -0,0 +1,122 @@
+require 'chronic_duration'
+require 'fileutils'
+require 'zlib'
+
+# IO like object, that can be used with any logging class (such as Ruby's native Logger). This object will save its input to a file, and allows:
+#* Rotation by time / date.
+#* Compression of old files.
+#* Removal of old compressed files.
+# Its purpuse is to supplement logging classes, allowing everything related to logging management, to be done within Ruby, without relying on external tools (such as logrotate).
+class Evanescent
+  # Current path being written to.
+  attr_reader :path
+
+  # Rotation policy.
+  attr_reader :rotation
+
+  # How long rotated files are kept (in seconds).
+  attr_reader :keep
+
+  # Must receive a Hash with:
+  # +:path+:: Path where to write to.
+  # +:rotation+:: Either +:hourly+ or +:daily+.
+  # +:keep+:: For how long to keep rotated files. It is parsed with ChronicDuration's natural language features. Examples: '1 day', '1 month'.
+  def initialize opts
+    @path = opts[:path]
+    @rotation = opts[:rotation]
+    @keep = ChronicDuration.parse(opts[:keep])
+    @mutex = Mutex.new
+    @last_prefix = make_prefix(Time.now)
+    open_file
+  end
+
+  # Writes to #path and rotate, compress and purge if necessary.
+  def write string
+    @mutex.synchronize do
+      rotate
+      compress
+      purge
+      @io.write(string)
+    end
+  end
+
+  # Close file.
+  def close
+    @mutex.synchronize do
+      @io.close
+    end
+  end
+
+  private
+
+  def open_file
+    @io = File.open(path, File::APPEND | File::CREAT | File::WRONLY)
+    @io.sync = true
+  end
+
+  PARAMS = {
+    hourly: {
+      strftime: '%Y%m%d%H',
+      glob: '[0-9]' * (4 + 2 * 3)
+    },
+    daily: {
+      strftime: '%Y%m%d',
+      glob: '[0-9]' * (4 + 2 * 2)
+    }
+  }
+
+  def make_prefix time
+    time.strftime(PARAMS[rotation][:strftime])
+  end
+
+  def rotate
+    curr_suffix = make_prefix(Time.now)
+    if curr_suffix != @last_prefix
+      @io.close
+      rotated = "#{path}.#{curr_suffix}"
+      begin
+        FileUtils.mv(path, rotated)
+      rescue
+        warn("Error renaming '#{path}' to '#{rotated}': #{$!}")
+      end
+      open_file
+      @last_prefix = curr_suffix
+    end
+  end
+
+  def compress
+    Dir.glob("#{path}.#{PARAMS[rotation][:glob]}").each do |uncompressed|
+      compressed = "#{uncompressed}.gz"
+      Zlib::GzipWriter.open(compressed) do |gz|
+        gz.mtime = File.mtime(uncompressed)
+        gz.orig_name = uncompressed
+        File.open(uncompressed, 'r') do |io|
+          io.binmode
+          io.each do |data|
+            gz.write(data)
+          end
+        end
+      end
+      File.delete(uncompressed)
+    end
+  rescue
+    warn("Error compressing files: #{$!}")
+  end
+
+  def purge
+    Dir.glob("#{path}.#{PARAMS[rotation][:glob]}.gz").each do |compressed|
+      time_extractor = Regexp.new(
+        '^' + Regexp.escape("#{path}.") + "(?<time>.+)" + Regexp.escape(".gz") + '$'
+      )
+      time_string = compressed.match(time_extractor)[:time]
+      compressed_time = Time.strptime(time_string, PARAMS[rotation][:strftime])
+      age = Time.now - compressed_time
+      if age > keep
+        File.delete(compressed)
+      end
+    end
+  rescue
+    warn("Error purging old files: #{$!}")
+  end
+
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: evanescent
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Fabio Pugliese Ornellas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: chronic_duration
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.6
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.6'
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.6.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.6'
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.6.4
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: |-
+  This gem provides an IO like object, that can be used with any logging class (such as Ruby's native Logger). This object will save its input to a file, and allows:
+    * Rotation by time / date.
+    * Compression of old files.
+    * Removal of old compressed files.
+    Its purpuse is to supplement logging classes, allowing everything related to logging management, to be done within Ruby, without relying on external tools (such as logrotate).
+email: fabio.ornellas@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/evanescent.rb
+homepage: https://github.com/fornellas/evanescent
+licenses:
+- GPLv3
+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: IO like object that allows logging rotation, compression and purging.
+test_files: []