bole 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6355de532f85d1cc039d722cff3fecb3d5c3acaf63b1483ec4e4e9783a146089
+  data.tar.gz: f575787cebbcda5ed2587ef2101921f36b80f4b3245d5f2d23a4017daa638222
+SHA512:
+  metadata.gz: 5f11a2c5f2fe49008d528c4e8bee4eedb599d4c75694ecc24b04b69aa930e83b572a0956edd2f105e221cf6e51643c3fa5c14fa445a171cb26b1175d6ac010d9
+  data.tar.gz: cbf6310b8a242effb02360adf284c18f80ae84e838d3b7750660d5e018e2c252eeed0c5ffc3e6efd585b5ceb87cdd453cd9d7cd2cfaf0eaeba219f24a3042d0c

data/.byebug_history

@@ -0,0 +1,176 @@
+continue
+next
+Bole::Manager.config.data.bole.file
+quit
+bole.logger.dev.read
+bole.logger.dev.rewind
+string_out.read
+next
+string_out
+next
+bole.logger.dev
+bole.logger
+string_out
+bole.level
+quit
+@logdev
+continue
+exception
+next
+quit
+exception
+next
+Bole::Manager.config.data.bole.file
+continue
+quit
+Sycle::Hash.new
+Bole::Manager.config.data
+Bole::Manager.config.class
+Bole::Manager.config
+Bole::Manager.config[:data]
+Bole::Manager.config.bole
+Bole::Manager.config.data
+Bole::Manager.config.class
+Bole::Manager.config.data
+Bole::Manager.config.data.bole
+Bole::Manager.config
+step
+next
+config
+continue
+next
+@level
+next
+@enabled
+next
+step
+next
+Bole::Manager.config.data.bole.progname
+Bole::Manager.config.data.bole
+Bole::Manager.config.data
+Bole::Manager.config
+step
+next
+config
+continue
+next
+config
+quit
+class Beef; puts name; end
+Balls::name
+%w$Id$
+%w$Id%
+continue
+next
+rev
+next
+name
+next
+rev
+name
+_
+quit
+file.read
+file.rewind
+file.read
+quit
+file.read
+file.rewind
+file.rewind.read
+quit
+Bole::Manager.config.data.bole.file.read
+Bole::Manager.config.data.bole.file.rewind
+Bole::Manager.config.data.bole.file
+Bole::Manager.config.
+bole.config
+file.rewind
+file.rewind.read
+file.read
+file
+bole.log(:info, 'foo')
+Bole::Manager.config.data.bole.level
+Bole::Manager.config.data.level
+bole.config
+bole.level
+bole.enabled
+file.read
+file.rewind
+file
+quit
+Bole::Manager.config
+quit
+bole.config
+bole
+Bole::Manager.config
+quit
+Bole::Manager.config
+bole.config
+bole = Bole::Manager.new('spec/fixtures/bole.yml')
+Bole::Manager.config = 'data'
+Bole::Manager.config
+quit
+@config
+continue
+@config
+continue
+@config
+continue
+@config
+continue
+@config
+continue
+logger.config
+Bole::Manager.config
+quit
+logger.config
+logger
+logger.config
+Bole::Manager.config
+quit
+continue
+@config
+quit
+Bole::Manager.config
+self.config
+config.nil?
+config
+quit
+continue
+@@config.data.bole.format
+continue
+quit
+continue
+step
+@@config.data.bole.format
+continue
+have_received(:parse_custom_formatter)
+step
+custom_format
+continue
+quit
+step
+custom_format
+continue
+step
+next
+step
+next
+@@config.data.bole
+step
+next
+nex
+Bole::Manager.config
+quit
+@@config.nil?
+@@config
+!@@config.nil?
+@@config
+q
+next
+quit
+exception
+next
+Bole::Manager.config = nil
+Bole::Manager.config
+Bole::Manager.config = nil
+Bole::Manager.config

data/.circleci/config.yml

@@ -0,0 +1,30 @@
+version: 2
+jobs:
+  build:
+    working_directory: ~/bole
+    docker:
+      - image: circleci/ruby:2.5.1-node-browsers
+    steps:
+      - checkout
+
+      - type: cache-restore
+        name: Restore bundle cache
+        key: initrax-bundle-{{ checksum "Gemfile.lock" }}
+
+      - run:
+          name: Bundle Install
+          command: bundle install --path vendor/bundle
+
+      - type: cache-save
+        name: Store bundle cache
+        key: initrax-bundle-{{ checksum "Gemfile.lock" }}
+        paths:
+          - vendor/bundle
+
+      - run:
+          name: Rubocop
+          command: bundle exec rubocop
+
+      - run:
+          name: Run Rspec specs
+          command: bundle exec rspec

data/.gitignore

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

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,111 @@
+# This is the configuration used to check the rubocop source code.
+
+require:
+  - rubocop/cop/internal_affairs
+  - rubocop-rspec
+
+AllCops:
+  Exclude:
+    - 'vendor/**/*'
+    - 'spec/fixtures/**/*'
+    - 'tmp/**/*'
+  TargetRubyVersion: 2.3
+
+Naming/PredicateName:
+  # Method define macros for dynamically generated method.
+  MethodDefinitionMacros:
+    - define_method
+    - define_singleton_method
+    - def_node_matcher
+    - def_node_search
+
+Style/FrozenStringLiteralComment:
+  EnforcedStyle: always
+
+Style/FormatStringToken:
+  # Because we parse a lot of source codes from strings. Percent arrays
+  # look like unannotated format string tokens to this cop.
+  Exclude:
+    - spec/**/*
+
+Style/IpAddresses:
+  # The test for this cop includes strings that would cause offenses
+  Exclude:
+  - spec/rubocop/cop/style/ip_addresses_spec.rb
+
+Layout/EndOfLine:
+  EnforcedStyle: lf
+
+Layout/ClassStructure:
+  Enabled: true
+  Categories:
+    module_inclusion:
+      - include
+      - prepend
+      - extend
+  ExpectedOrder:
+      - module_inclusion
+      - constants
+      - public_class_methods
+      - initializer
+      - instance_methods
+      - protected_methods
+      - private_methods
+
+Layout/IndentHeredoc:
+  EnforcedStyle: powerpack
+
+# Trailing white space is meaningful in code examples
+Layout/TrailingWhitespace:
+  AllowInHeredoc: true
+
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Lint/InterpolationCheck:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Lint/UselessAccessModifier:
+  MethodCreatingMethods:
+    - 'def_matcher'
+    - 'def_node_matcher'
+
+Lint/BooleanSymbol:
+  Enabled: false
+
+Metrics/AbcSize:
+  Max: 20
+
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+Metrics/LineLength:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Metrics/ParameterLists:
+  Max: 10
+
+Performance/Caller:
+  Exclude:
+    - spec/rubocop/cop/performance/caller_spec.rb
+
+RSpec/PredicateMatcher:
+  EnforcedStyle: inflected
+
+RSpec/NestedGroups:
+  Max: 7
+
+RSpec/MultipleExpectations:
+  Max: 2
+
+RSpec/ExampleLength:
+  Enabled: false

data/.ruby-gemset

@@ -0,0 +1 @@
+bole

data/.ruby-version

@@ -0,0 +1 @@
+2.5.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at tgourley@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+gemspec

data/Gemfile.lock

@@ -0,0 +1,64 @@
+PATH
+  remote: .
+  specs:
+    bole (0.1.0)
+      konfigyu (~> 0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    byebug (10.0.2)
+    diff-lcs (1.3)
+    jaro_winkler (1.5.1)
+    konfigyu (0.1.0)
+      syck (~> 1.3.0)
+      sycl (~> 1.6)
+    parallel (1.12.1)
+    parser (2.5.1.2)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    rainbow (3.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.1)
+      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)
+    rubocop (0.59.2)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    rubocop-rspec (1.29.1)
+      rubocop (>= 0.58.0)
+    ruby-progressbar (1.10.0)
+    syck (1.3.0)
+    sycl (1.6)
+    unicode-display_width (1.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bole!
+  bundler (~> 1.16)
+  byebug (~> 10.0.2)
+  rake (~> 10.0)
+  rspec (~> 3.8.0)
+  rubocop (~> 0.59.2)
+  rubocop-rspec (~> 1.29.1)
+
+BUNDLED WITH
+   1.16.5

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Tim Gourley
+
+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,175 @@
+# Bole
+
+![CircleCI branch](https://img.shields.io/circleci/project/github/bratta/bole/master.svg)
+![GitHub](https://img.shields.io/github/license/bratta/bole.svg)
+![GitHub issues](https://img.shields.io/github/issues/bratta/bole.svg)
+![Gem](https://img.shields.io/gem/v/bole.svg)
+
+The Ruby Logger, part of the standard library, is a pretty decent logging tool but isn't as easy to use or as configurable as I would like it to be. This gem wraps Logger with some extra love to allow it to load configuration values from a YAML file via the [Konfigyu](https://github.com/bratta/konfigyu) gem as well as giving it the ability to be enabled/disabled via a flag or by setting the logging level to `:none`.
+
+This gem also makes it easier to swap logging devices on the fly, so you can switch between log files, StringIO instances, or STDOUT, etc. without creating a new intance of the object.
+
+The Konfigyu data can be loaded from the YAML file when a Bole instance is created, or you can set it on the class if you have an existing config used by the rest of your application.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bole'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bole
+
+## Usage
+
+The most basic usage is the exact same as the [Ruby Logger](https://ruby-doc.org/stdlib-2.5.1/libdoc/logger/rdoc/Logger.html) class.
+
+It gets more interesting when you set up a config file and pass that to the class. For example, you can create a configuration file that looks like this and save it as `bole.yml`:
+
+```yaml
+bole:
+  file: /tmp/bole.log
+  level: info
+  progname: Bole
+  format: "[ {datetime} :: {severity} from {progname} ] {msg}"
+```
+
+Then, in your code, you can instantiate the Bole logger like this:
+
+```ruby
+require 'bole'
+bole = Bole::Manager.new(STDOUT, config: 'bole.yml')
+
+bole.info('This is a test log message')
+```
+
+Then if you look at `/tmp/bole.log` you should see:
+
+```
+# Logfile created on 2018-10-03 14:19:01 -0500 by logger.rb/61378
+[ 2018-10-03 14:22:02 -0500 :: INFO from Bole ] This is a test log message
+```
+
+## Switching the logger
+
+You can use `bole.logger` to change the logging device on the fly:
+
+```ruby
+require 'bole'
+require 'stringio'
+
+bole = Bole::Manager.new(STDOUT)
+bole.info('This goes to STDOUT')
+
+string_out = StringIO.new
+bole.logger = string_out
+bole.info('This goes to StringIO')
+string_out.rewind
+puts string_out.read
+```
+
+## Configuration File Format
+
+The format of the configuration file looks like this:
+
+```yaml
+bole:
+  # (optional) If not specified, logging will go to whatever
+  # is passed to the constructor of the object, or STDOUT barring
+  # that. If you wish to use a File object, STDERR, or something
+  # like StringIO, then omit this value and pass it in the 
+  # constructor, or set @logger (which this class exposes).
+  file: /var/log/bole.log
+
+  # (required) One of: none, fatal, error, warn, info, or debug
+  level: info
+
+  # (optional) The reporting program name. Defaults to 'Bole'
+  progname: Bole
+
+  # (optional) will default to Ruby's default Logger formatter
+  # This is a string with these variables replaced. If you
+  # wish to override the datetime format, you can always set the
+  # value in code, e.g.:
+  #
+  #     bole = Bole::Manager.new(config_file)
+  #     bole.datetime_format = '%Y-%m-%d %H:%M:%S'
+  format: "[ {datetime} :: {severity} from {progname} ] {msg}"
+```
+
+### bole.file
+
+In the configuration file, if you specify a file for Bole to use for logging, it will use that instead of whatever is passed to the constructor.  Note that currently this is a bit awkward as the config file is read AFTER the base logger is instantiated, so you end up with a default logger (STDOUT or whatever you pass as the first argument to the initializer), then it is switched over to whatever you specify in the file. Future versions may fix this.
+
+You can't use an open File object, StringIO, or STDOUT/STDERR in this case.  You will only be able to pass a file name via the configuration file. If you want to use something more advanced, do it when you create the logger or by using `bole.logger = STDOUT` to set the logging device.
+
+### bole.level
+
+These correspond to the logging levels in the default Ruby Logger class, but we also add the "none" level, which is one way to disable logging either temporarily or permenantly. You can also pause logging in code by setting `bole.enabled = false` and then `bole.enabled = true` to re-enable logging.
+
+### bole.progname
+
+This is the name of the program as displayed in the log message.
+
+### bole.format
+
+If you wish to override the format, you can specify a string here with some template variables.
+
+* **{datetime}** = The datetime
+* **{severity}** = The logging level (i.e. INFO, DEBUG, etc.)
+* **{progname}** = The program name
+* **{msg}** =  The log message itself
+
+An example would be this string:
+
+```yaml
+bole:
+  level: info
+  format: "-=# {datetime} -- Message from {progname} ({severity}) :: {msg} #=-"
+```
+
+Resulting in:
+
+```
+-=# 2018-10-03 14:22:02 -0500 -- Message from Bole (INFO) :: This is a test log message #=-
+```
+
+Note that none of the fields are required, so omit ones you don't need. In the future filtering and transorming might be possible. For now, though, if you need something complex like formatting the timestamp to something custom, you can use the regular facilities from the Ruby Logger class to make your changes.
+
+## Configuration Sharing
+
+Let's say you have an application that already has a Konfigyu YAML loaded and you want to add a section for Bole and use it. It's easy to share config by setting it on the class before instantiating it, and it will use that config:
+
+```ruby
+# Config exists in 'config'
+config = Konfigyu::Config.new('application.yml')
+
+Bole::Manager.config = config
+bole = Bole::Manager.new
+bole.info('Done!')
+```
+
+## 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`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/bratta/bole. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Bole project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/bratta/bole/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,7 @@
+# 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: false
+
+require 'bundler/setup'
+require 'bole'
+
+# 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/bole.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bole/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'bole'
+  spec.version       = Bole::VERSION
+  spec.authors       = ['Tim Gourley']
+  spec.email         = ['tgourley@gmail.com']
+
+  spec.summary       = 'Simple Ruby File Logger'
+  spec.description   = 'Log messages to a file or stdout with a timestamp'
+  spec.homepage      = 'https://github.com/bratta/bole'
+  spec.license       = 'MIT'
+
+  # 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']
+
+  # Required dependencies
+  spec.add_dependency 'konfigyu', '~> 0.1.0'
+
+  # Development Dependencies
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'byebug', '~> 10.0.2'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.8.0'
+  spec.add_development_dependency 'rubocop', '~> 0.59.2'
+  spec.add_development_dependency 'rubocop-rspec', '~> 1.29.1'
+end

data/bole.yml.example

@@ -0,0 +1,22 @@
+bole:
+  # (optional) If not specified, logging will go to whatever
+  # is passed to the constructor of the object, or STDOUT barring
+  # that. If you wish to use a File object, STDERR, or something
+  # like StringIO, then omit this value and pass it in the 
+  # constructor, or set @logger (which this class exposes).
+  file: /var/log/bole.log
+
+  # (required) One of: none, fatal, error, warn, info, or debug
+  level: info
+
+  # (optional) The reporting program name. Defaults to 'Bole'
+  progname: Bole
+
+  # (optional) will default to Ruby's default Logger formatter
+  # This is a string with these variables replaced. If you
+  # wish to override the datetime format, you can always set the
+  # value in code, e.g.:
+  #
+  #     bole = Bole::Manager.new(config_file)
+  #     bole.datetime_format = '%Y-%m-%d %H:%M:%S'
+  format: "[ {datetime} :: {severity} from {progname} ] {msg}"

data/lib/bole.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'logger'
+require 'konfigyu'
+require 'sycl'
+
+require 'bole/version'
+require 'bole/manager'
+
+# Define the module namespace for this gem
+module Bole
+end

data/lib/bole/manager.rb

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+
+module Bole
+  # Logger main class
+  class Manager < Logger
+    attr_accessor :enabled
+
+    PROGNAME = 'Bole'
+    LOG_LEVELS = {
+      none: Logger::UNKNOWN,
+      fatal: Logger::FATAL,
+      error: Logger::ERROR,
+      warn: Logger::WARN,
+      info: Logger::INFO,
+      debug: Logger::DEBUG
+    }.freeze
+
+    # Class level accessibility for config
+    class << self
+      attr_accessor :config
+    end
+
+    # Initializer arguments:
+    # The first set of arguments are the exact same as the Ruby
+    # Standard Library's logger class. The goal of this class is to
+    # extend the functionality to make the class easier to work with
+    # so we are adding an extra argument to take an additional option:
+    #
+    # config: '/path/to/bole.yml'
+    #
+    # This is an optional argument that is the path to the Konfigyu
+    # config YAML file so defaults can easily be persisted as part of
+    # your application's configuration. Optionally you can specify an
+    # existing Konfigyu object in Bole::Manager.config
+    def initialize(logdev = STDOUT, shift_age = 0, shift_size = 1_048_576,
+                   level: LOG_LEVELS[:debug], progname: nil, formatter: nil,
+                   datetime_format: nil, shift_period_suffix: '%Y%m%d',
+                   config: nil)
+      initialize_configuration(config)
+
+      @shift_age = shift_age
+      @shift_size = shift_size
+      @shift_period_suffix = '%Y%m%d'
+
+      super(logdev, shift_age, shift_size,
+            level: level, progname: progname, formatter: formatter,
+            datetime_format: datetime_format,
+            shift_period_suffix: shift_period_suffix)
+      initialize_logger
+    end
+
+    def logger
+      @logdev
+    end
+
+    def logger=(new_logdev)
+      @logdev = Logger::LogDevice.new(
+        new_logdev,
+        shift_age: @shift_age,
+        shift_size: @shift_size,
+        shift_period_suffix: @shift_period_suffix
+      )
+    end
+
+    def level=(severity)
+      if severity.to_s.casecmp('none').zero?
+        @level = Logger::UNKNOWN
+        @enabled = false
+      else
+        @enabled = true
+        super(severity)
+      end
+    end
+
+    def add(severity, message = nil, progname = nil)
+      super(severity, message, progname) if @enabled
+    end
+
+    private
+
+    def config_requirements
+      {
+        required_fields: ['bole', 'bole.level'],
+        required_values: {
+          'bole.level': LOG_LEVELS.keys.map(&:to_s)
+        }
+      }
+    end
+
+    def initialize_configuration(config_file = nil)
+      return unless Bole::Manager.config.nil?
+
+      Bole::Manager.config =
+        if config_file
+          Konfigyu::Config.new(config_file, config_requirements)
+        else
+          Sycl::Hash.from_hash(
+            'data' => { 'bole' => { 'level' => LOG_LEVELS.key(@level) } }
+          )
+        end
+    end
+
+    def initialize_logger
+      initialize_log_device
+      initialize_progname
+      initialize_formatter
+      initialize_log_level
+    end
+
+    def initialize_log_device
+      self.logger = Bole::Manager.config.data.bole.file if Bole::Manager.config.data.bole.file
+    end
+
+    def initialize_progname
+      @progname = Bole::Manager.config.data.bole.progname || PROGNAME if progname.nil?
+    end
+
+    def initialize_formatter
+      @formatter = get_custom_formatter(Bole::Manager.config.data.bole.format) if Bole::Manager.config.data.bole.format
+    end
+
+    def initialize_log_level
+      @enabled = Bole::Manager.config.data.bole.level != :none
+      @level = LOG_LEVELS[Bole::Manager.config.data.bole.level&.to_sym] || Logger::DEBUG
+    end
+
+    def get_custom_formatter(custom_format)
+      proc do |severity, datetime, progname, msg|
+        parse_custom_formatter(custom_format, severity, datetime, progname, msg)
+      end
+    end
+
+    def parse_custom_formatter(format, severity, datetime, progname, msg)
+      format.gsub('{severity}', severity || '')
+            .gsub('{datetime}', datetime.to_s || '')
+            .gsub('{progname}', progname || '')
+            .gsub('{msg}', msg || '')
+    end
+  end
+end

data/lib/bole/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+# Version number
+module Bole
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: bole
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tim Gourley
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-10-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: konfigyu
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !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.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.0.2
+- !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.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.59.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.59.2
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.29.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.29.1
+description: Log messages to a file or stdout with a timestamp
+email:
+- tgourley@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".byebug_history"
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-gemset"
+- ".ruby-version"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bole.gemspec
+- bole.yml.example
+- lib/bole.rb
+- lib/bole/manager.rb
+- lib/bole/version.rb
+homepage: https://github.com/bratta/bole
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Simple Ruby File Logger
+test_files: []