rumbrl 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d5ed542d2cf2c1f5c60ace389fc31b6a1193f3b4
+  data.tar.gz: 56739345db59ef3d3f9099da0b5a1690a6f24a4f
+SHA512:
+  metadata.gz: 9f8e21cfb001c4b183cffc44037fc65958b0cdb350bac281c18524b86ad6029c4da9caf18ed79953b5da88a60bf2917c3091fe2ae4addc8be25ecf0f25730199
+  data.tar.gz: 83593613546ba256221a364cb5dece3c7605eca8b0e1b17a4b676933a3a91dfb5ef03debd6fc5c94de6ed5fd424ff5f695f415b2d093bbf5425c12de97c9e1fc

data/.gitignore

@@ -0,0 +1,3 @@
+.vendor
+vendor
+.ruby-version

data/.singularityrc

@@ -0,0 +1,3 @@
+shelltask { command 'bundle' }
+rubocop
+rspec

data/Gemfile

@@ -0,0 +1,6 @@
+# encoding: utf-8
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rumbrl.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,63 @@
+PATH
+  remote: .
+  specs:
+    rumbrl (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.1.8)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    ast (2.0.0)
+    astrolabe (1.3.0)
+      parser (>= 2.2.0.pre.3, < 3.0)
+    diff-lcs (1.2.5)
+    gem-release (0.7.3)
+    i18n (0.6.11)
+    json (1.8.1)
+    minitest (5.5.0)
+    parser (2.2.0.pre.8)
+      ast (>= 1.1, < 3.0)
+      slop (~> 3.4, >= 3.4.5)
+    powerpack (0.0.9)
+    rainbow (2.0.0)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.7)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.3)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.2)
+    rubocop (0.28.0)
+      astrolabe (~> 1.3)
+      parser (>= 2.2.0.pre.7, < 3.0)
+      powerpack (~> 0.0.6)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.4)
+    ruby-progressbar (1.7.0)
+    shoulda-matchers (2.7.0)
+      activesupport (>= 3.0.0)
+    slop (3.6.0)
+    thread_safe (0.3.4)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  gem-release
+  rspec (~> 3.0)
+  rubocop (~> 0.24)
+  rumbrl!
+  shoulda-matchers (~> 2.7)

data/README.md

@@ -0,0 +1,44 @@
+rumbrl
+======
+
+**R**eally d**UMB** **R**uby **L**ogger
+
+So dumb you'll cry.
+
+### API
+
+Methods Delegated to `::Logger`:
+
+- `datetime_format=`
+- `log`
+- `debug?`
+- `error?`
+- `fatal?`
+- `info?`
+
+Wrapped `::Logger` Methods:
+
+- `debug`
+- `info`
+- `warn`
+- `error`
+- `fatal`
+- `unknown`
+
+### ENV vars
+
+#### `LOG_PATH`
+
+Directory where logs go
+
+#### `LOG_SHIFT_SIZE` & `LOG_SHIFT_AGE`
+
+Passed into [::Logger](http://www.ruby-doc.org/stdlib-2.1.0/libdoc/logger/rdoc/Logger.html) (as `shift_age` & `shift_size`). Defaults to `1048576` & `weekly`, respectively.
+
+#### `LOG_TIME_FORMAT`
+
+Time format (`::Logger#datetime_format`). Defaults to `"[%F %T %z]"`
+
+#### `LOG_DATA_FORMAT`
+
+How to format log data. Defaults to `[%s] [%s]`

data/lib/rumbrl.rb

@@ -0,0 +1,5 @@
+require 'rumbrl/version'
+
+require 'rumbrl/env'
+require 'rumbrl/factory'
+require 'rumbrl/log'

data/lib/rumbrl/env.rb

@@ -0,0 +1,24 @@
+module Rumbrl
+  # insanely dumb env for an insanely dumb log
+  class Env
+    def self.log_path
+      ENV.fetch('LOG_PATH', ::Dir.getwd)
+    end
+
+    def self.shift_size
+      ENV.fetch('LOG_SHIFT_SIZE', '1048576').to_i
+    end
+
+    def self.shift_age
+      ENV.fetch('LOG_SHIFT_AGE', 'weekly')
+    end
+
+    def self.time_format
+      ENV.fetch('LOG_TIME_FORMAT', '[%F %T %z]')
+    end
+
+    def self.log_format
+      ENV.fetch('LOG_DATA_FORMAT', '[%s] [%s]')
+    end
+  end
+end

data/lib/rumbrl/factory.rb

@@ -0,0 +1,50 @@
+require 'logger'
+require 'rumbrl/env'
+
+module Rumbrl
+  # an insanely dumb logger creator
+  # broken regulations & underaged workers abound
+  class Factory
+    attr_reader :dest, :name
+    attr_accessor :size, :age, :level, :log_format, :time_format
+
+    def self.create(nm, path: nil, age: nil, size: nil, level: nil)
+      new(nm, path: path, age: age, size: size, level: level).generate
+    end
+
+    def initialize(nm, path: nil, age: nil, size: nil, level: nil)
+      @name = nm
+      @log_format = Env.log_format
+      @time_format = Env.time_format
+      @size ||= (size || Env.shift_size)
+      @age ||= (age || Env.shift_age)
+      @level ||= (level || ::Logger::INFO)
+      @dest = log_dest path, nm
+    end
+
+    def generate
+      init_path dest
+      generate_logger
+    end
+
+    private
+
+    def generate_logger
+      logger = Log.new(dest, age, size, log_format)
+      logger.level = level
+      logger.datetime_format = time_format
+      logger
+    end
+
+    def log_dest(dir, name)
+      return name unless name.is_a? ::String
+      dir ||= Env.log_path
+      ::File.join dir, name
+    end
+
+    def init_path(path)
+      dir = ::File.dirname path
+      ::Dir.mkdir(dir) unless ::File.directory? dir
+    end
+  end
+end

data/lib/rumbrl/log.rb

@@ -0,0 +1,49 @@
+require 'forwardable'
+require 'logger'
+
+module Rumbrl
+  # an insanely dumb file log
+  class Log
+    extend Forwardable
+
+    ALLOWED_METHODS = [:debug, :info, :warn, :error, :fatal, :unknown]
+
+    attr_reader :logger, :data_format
+
+    def_delegators :logger,
+                   :datetime_format=,
+                   :level=,
+                   :log,
+                   :debug?,
+                   :error?,
+                   :fatal?,
+                   :info?
+
+    def initialize(path, age, size, data_format)
+      @logger = ::Logger.new(log_file(path), shift_age: age, shift_size: size)
+      @data_format = data_format
+    end
+
+    def method_missing(name, *args)
+      name = name.to_sym
+      return super(name, *args) unless ALLOWED_METHODS.member? name
+      fail 'requires a message and data' unless args.size == 2
+      write(args[0], data: args[1], level: name)
+    end
+
+    private
+
+    def log_file(path)
+      # TODO: make this...less hacky
+      ::File.open(path, File::WRONLY | File::APPEND | File::CREAT)
+    end
+
+    def write(message, level: :info, data: {})
+      @logger.method(level).call { format_message message, data }
+    end
+
+    def format_message(message, data)
+      sprintf @data_format, message, data
+    end
+  end
+end

data/lib/rumbrl/version.rb

@@ -0,0 +1,6 @@
+# encoding: utf-8
+
+# version const for gem
+module Rumbrl
+  VERSION = '0.0.1'
+end

data/rumbrl.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rumbrl/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rumbrl'
+  spec.version       = Rumbrl::VERSION
+  spec.authors       = ['chr0n1x']
+  spec.email         = ['heilong24@gmail.com']
+  spec.description   = 'Really_dUMB_Ruby_Logger'
+  spec.summary       = ''
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'rubocop', '~> 0.24'
+  spec.add_development_dependency 'shoulda-matchers', '~> 2.7'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'gem-release'
+end

data/spec/rumbrl/factory_spec.rb

@@ -0,0 +1,78 @@
+require_relative '../spec_helper'
+
+describe Rumbrl::Factory do
+  describe '.create' do
+    it 'is just a dumb wrapper for .new and #generate' do
+      instance = double
+      expect(Rumbrl::Factory).to receive(:new)
+        .with('foo', path: nil, age: nil, size: nil, level: nil)
+        .and_return(instance)
+      expect(instance).to receive(:generate)
+
+      Rumbrl::Factory.create 'foo'
+    end
+  end
+
+  describe '#initialize' do
+    it 'sets proper default values' do
+      expect(Rumbrl::Env).to receive(:log_format).and_return(nil)
+      expect(Rumbrl::Env).to receive(:time_format).and_return(nil)
+      expect(Rumbrl::Env).to receive(:shift_size).and_return(nil)
+      expect(Rumbrl::Env).to receive(:shift_age).and_return(nil)
+
+      factory = Rumbrl::Factory.new 'foo'
+
+      expect(factory.name).to eql 'foo'
+      expect(factory.log_format).to eql nil
+      expect(factory.time_format).to eql nil
+      expect(factory.size).to eql nil
+      expect(factory.age).to eql nil
+      expect(factory.level).to eql ::Logger::INFO
+      expect(factory.dest).to eql ::File.join(::Dir.getwd, 'foo')
+    end
+
+    it 'respects user-defined log overrides' do
+      expect(Rumbrl::Env).to_not receive(:shift_size)
+      expect(Rumbrl::Env).to_not receive(:shift_age)
+
+      factory = Rumbrl::Factory.new 'foo',
+                                    path: 'some/path',
+                                    age: 5,
+                                    size: 2,
+                                    level: ::Logger::DEBUG
+      factory.time_format = 'WOO'
+      factory.log_format = 'BLAH'
+
+      expect(factory.name).to eql 'foo'
+      expect(factory.log_format).to eql 'BLAH'
+      expect(factory.time_format).to eql 'WOO'
+      expect(factory.size).to eql 2
+      expect(factory.age).to eql 5
+      expect(factory.level).to eql ::Logger::DEBUG
+      expect(factory.dest).to eql ::File.join('some/path', 'foo')
+    end
+
+    it 'respects non-file log paths' do
+      factory = Rumbrl::Factory.new STDOUT, path: 'wont/work'
+
+      expect(factory.dest).to eql STDOUT
+    end
+  end
+
+  describe '#generate' do
+    it 'creates the log path if it does not exist' do
+      path = 'this/should/not/exist'
+      expect(::Dir).to receive(:mkdir).with(path)
+      allow(::File).to receive(:directory?)
+        .with(path)
+        .and_return(false)
+
+      log_double = double
+      expect(Rumbrl::Log).to receive(:new).and_return(log_double)
+      expect(log_double).to receive(:level=)
+      expect(log_double).to receive(:datetime_format=)
+
+      Rumbrl::Factory.create 'foo.log', path: path
+    end
+  end
+end

data/spec/rumbrl/log_spec.rb

@@ -0,0 +1,47 @@
+require_relative '../spec_helper'
+
+describe Rumbrl::Log do
+  let(:log) { Rumbrl::Log.new 'path/to/log', 'weekly', 123, '%s %s' }
+  let!(:logger_double) { double }
+
+  before(:each) do
+    allow(logger_double).to receive(:level=)
+    allow(logger_double).to receive(:datetime_format=)
+    allow(::Logger).to receive(:new).and_return logger_double
+    # TODO: make this...less hacky
+    allow(::File).to receive(:open).and_return(STDOUT)
+  end
+
+  describe 'delegates' do
+    it { expect(log).to delegate_method(:log).to(:logger) }
+    it { expect(log).to delegate_method(:debug?).to(:logger) }
+    it { expect(log).to delegate_method(:error?).to(:logger) }
+    it { expect(log).to delegate_method(:fatal?).to(:logger) }
+    it { expect(log).to delegate_method(:info?).to(:logger) }
+    it do
+      expect(log).to delegate_method(:datetime_format=)
+        .with_arguments('').to(:logger)
+    end
+  end
+
+  describe '#method_missing' do
+    context 'unknown method is called' do
+      it 'fails on unknown method call' do
+        expect { log.this_is_a_missing_method 'sadtimes log' }
+          .to raise_error(NoMethodError)
+      end
+    end
+
+    context 'method is known' do
+      it 'fails when less than 2 args given' do
+        expect { log.debug('boo') }
+          .to raise_error(RuntimeError, /message and data/)
+      end
+
+      it 'does things woo' do
+        expect(logger_double).to receive(:info)
+        log.info('message', ['data'])
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'rumbrl'
+require 'shoulda/matchers'

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: rumbrl
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- chr0n1x
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.24'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.24'
+- !ruby/object:Gem::Dependency
+  name: shoulda-matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: gem-release
+  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: Really_dUMB_Ruby_Logger
+email:
+- heilong24@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-version
+- .singularityrc
+- Gemfile
+- Gemfile.lock
+- README.md
+- lib/rumbrl.rb
+- lib/rumbrl/env.rb
+- lib/rumbrl/factory.rb
+- lib/rumbrl/log.rb
+- lib/rumbrl/version.rb
+- rumbrl.gemspec
+- spec/rumbrl/factory_spec.rb
+- spec/rumbrl/log_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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: ''
+test_files:
+- spec/rumbrl/factory_spec.rb
+- spec/rumbrl/log_spec.rb
+- spec/spec_helper.rb