singlogger 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f8045d7390151924e109e664a844ff94598b2fd3245526258697c6410426d7d0
+  data.tar.gz: 56b6e456e38d4816c306bec439d8dd826a09309f41b95297c271dd0333733843
+SHA512:
+  metadata.gz: 38ce691d8b27911ad97591d64bb1a80ab9980bc0d0fd1dd4741093e18059786e6f8311c5582d5e52af37e234252c230e9b9d68753d4abd61f8cb3bd0ee9e1d7a
+  data.tar.gz: 8ee554c571b7ef12dac135a3e0827f4198c225cd8ca25cf4df88b698959cc45e332fadf7727b8b053a6140882917ce3b3f07c906373ee1d2dec5963079448cbe

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in singlogger.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,32 @@
+PATH
+  remote: .
+  specs:
+    singlogger (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    docile (1.1.5)
+    json (2.1.0)
+    power_assert (1.1.3)
+    rake (10.5.0)
+    simplecov (0.14.1)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    test-unit (3.2.8)
+      power_assert
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  simplecov (~> 0.14.1)
+  singlogger!
+  test-unit (~> 3.2.8)
+
+BUNDLED WITH
+   1.16.1

data/README.md

@@ -0,0 +1,51 @@
+# SingLogger
+
+This is a simple singleton wrapper around the Logger class.
+
+I'm sure others have done this, but I found myself copying and pasting this
+wrapper into every project I write, so I thought it made sense to put it into a
+single gem that I can import wherever I want!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'singlogger'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install singlogger
+
+## Usage
+
+I generally start by using `SingLogger.set_level_from_string()` when the
+application runs, based on a user parameter. You can use
+`SingLogger.set_level_from_string()` or `SingLogger.set_level()` any time you
+want to change it. `set_level()` takes logger constants, such as
+`::Logger::DEBUG`, `::Logger::INFO`, etc.
+
+If you don't want to use STDERR for the sink, it's important to set the `sink:`
+parameter of `SingLogger.instance()` the first time you use it. That'll set the
+sink of the logger going forward.
+
+To actually log, in the `initialize()` function of your classes, add
+
+    @logger = SingLogger.instance()
+
+Then when you want to log:
+
+    @logger.debug("debug message")
+    @logger.info("info message")
+    @logger.warn("warn message")
+    @logger.error("error message")
+    @logger.fatal("fatal message")
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/iagox86/singlogger.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "singlogger"
+
+# 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/lib/singlogger.rb

@@ -0,0 +1,55 @@
+##
+# singlogger.rb
+# By Ron
+# 2018-01
+#
+# This is a simple wrapper around the ruby Logger class to make it a singleton
+# (since it's a little weird to create new instances all over the place)
+##
+
+require 'logger'
+
+class SingLogger < ::Logger
+  VERSION = "0.0.1"
+
+  @@instance = nil
+
+  private
+  def initialize(level:, sink:)
+    super(sink)
+    @level = level
+  end
+
+  public
+  def self.instance(level: nil, sink: ::STDERR)
+    if(@@instance)
+      if(level)
+        @@instance.level = level
+      end
+      return @@instance
+    end
+
+    @@instance = SingLogger.new(level: (level || ::Logger::INFO), sink: sink)
+    return @@instance
+  end
+
+  public
+  def self.set_level(level:)
+    self.instance(level: level)
+  end
+
+  public
+  def self.set_level_from_string(level:)
+
+    self.set_level(level: ::Logger::DEBUG)
+    if(level =~ /info/i)
+      self.set_level(level: ::Logger::INFO)
+    elsif(level =~ /warn/i)
+      self.set_level(level: ::Logger::WARN)
+    elsif(level =~ /error/i)
+      self.set_level(level: ::Logger::ERROR)
+    elsif(level =~ /fatal/i)
+      self.set_level(level: ::Logger::FATAL)
+    end
+  end
+end

data/singlogger.gemspec

@@ -0,0 +1,28 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "singlogger"
+
+Gem::Specification.new do |spec|
+  spec.name          = "singlogger"
+  spec.version       = SingLogger::VERSION
+  spec.authors       = ["iagox86"]
+  spec.email         = ["ron-git@skullsecurity.org"]
+  spec.license       = '0BSD'
+
+  spec.summary       = "Singleton wrapper around Logger"
+  spec.description   = "A simple Singleton wrapper around the ruby Logger class, gem-ified it because I found myself using it in several different projects"
+  spec.homepage      = "https://github.com/iagox86/singlogger"
+
+  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.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "test-unit", "~> 3.2"
+  spec.add_development_dependency "simplecov", "~> 0.14.1"
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: singlogger
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- iagox86
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-07-06 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: 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: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.1
+description: A simple Singleton wrapper around the ruby Logger class, gem-ified it
+  because I found myself using it in several different projects
+email:
+- ron-git@skullsecurity.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/singlogger.rb
+- singlogger.gemspec
+homepage: https://github.com/iagox86/singlogger
+licenses:
+- 0BSD
+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.3
+signing_key: 
+specification_version: 4
+summary: Singleton wrapper around Logger
+test_files: []