vidazing_logger 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9106df6123f10567ee61da20d022d23c5f43b97a05b2fa9a78291424b6c7b4ad
+  data.tar.gz: e7aaa6373349e1b2b1ac628a28daf169c314a8e3e452ae12a7b021f119427d86
+SHA512:
+  metadata.gz: 5c22b59b28fe9258a8453564f8c4db707ae4a3a84c2b120f8d994ecac31285306420365428f647adc478e281ef4c262b3c942182df3b5532ddc5172944e493c3
+  data.tar.gz: 3bfaf20cd8eead8be172c9839b9c202107510e580ab5ff7510485e04bdc38951785240a60a98400ba1590acceb669c8544840d32c6c05935664beef950f4dddd

data/.gitignore

@@ -0,0 +1,50 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.ruby-version

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

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 VidaZing
+
+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,59 @@
+# logger-gem
+VidaZing logging strategy using [TwP/logging](https://github.com/TwP/logging).
+
+Writes to rolling log files and the corresponding IO pipe.
+
+* <span style="color:red">Red</span> timestamps: `logs/error.log` + stderr.
+* <span style="color:blue">Blue</span> timestamps: `logs/build.log` + stdout.
+
+1. [**Installation**](#installation)
+2. [**Usage**](#usage)
+
+## Installation
+
+1. In your `Gemfile`, add the `vidazing_logger` gem:
+
+    ```ruby
+    gem 'vidazing_logger', '~> 0.1'
+    ```
+
+2. In your `shell`, run:
+
+    ```ruby
+    bundle install
+    ```
+
+3. (Optional - If you want to use the `rake loop:` tasks) Install [fswatch](https://github.com/emcrisostomo/fswatch)
+
+4. (Optional - If you use `pry`) Ran into a [byebug issue](https://github.com/deivid-rodriguez/byebug/issues/440) that you can fix with:
+
+    ```ruby
+    gem install byebug
+    gem install pry-byebug
+    ```
+
+## Usage
+See `rake -T`
+
+### Gem
+```ruby
+require 'vidazing_logger'
+
+logger = VidazingLogger.logger("OPTIONAL_LOGGER_NAME")
+```
+
+### Binary
+
+`vidazing_logger` for all your stand alone shell logging needs. We should probably let you disable the `logs/` file logging... Moving along!
+
+Install with `gem install vidazing_logger`
+
+See `vidazing_logger --help`
+
+## Under the hood
+
+[Logging gem docs](https://www.rubydoc.info/gems/logging/toplevel)
+
+### Considering
+
+[Timber](https://github.com/timberio/timber-ruby)

data/Rakefile

@@ -0,0 +1,110 @@
+require 'rainbow/refinement'
+using Rainbow
+require 'rake/testtask'
+
+$LOAD_PATH.push File.expand_path("../lib", __FILE__)
+require "vidazing_logger/version"
+VERSION = VidazingLogger::VERSION
+
+GEM_NAME = "vidazing_logger"
+
+# IMPORTANT: Color can't be used for `system` commands.
+GEM_NAME_VERSION = "#{GEM_NAME}-#{VERSION}"
+GEM_ARTIFACT = "#{GEM_NAME_VERSION}.gem"
+
+desc "Remove #{GEM_ARTIFACT} && Gemfile.lock"
+task :clean do
+  puts "Removing #{GEM_ARTIFACT} && Gemfile.lock".blue
+  system "rm -f *.gem Gemfile.lock"
+end
+
+desc "Build #{GEM_NAME_VERSION}"
+task :build => :clean do
+  puts "Building #{GEM_NAME_VERSION}".blue
+  system "gem build #{GEM_NAME}.gemspec"
+end
+
+desc "Publish #{GEM_ARTIFACT}"
+task :publish do
+  puts "Publishing #{GEM_NAME_VERSION}".blue
+  system "gem push #{GEM_NAME_VERSION}.gem"
+end
+
+desc "Installs #{GEM_ARTIFACT}"
+task :install => :build do
+  puts "Installing #{GEM_ARTIFACT}".blue
+  system "gem install #{GEM_NAME}"
+end
+
+desc "Uninstalls #{GEM_ARTIFACT}"
+task :uninstall do
+  puts "UNINSTALLING #{GEM_ARTIFACT}".inverse.blue
+  system "gem uninstall -xq #{GEM_NAME}"
+end
+
+namespace :doc do
+  desc "Build documentation into 'doc/'"
+  task :build do
+    puts "Building documentation into 'doc/':".blue
+    system "yard"
+  end
+
+  desc "Find undocumented code"
+  task :coverage do
+    puts "Documentation coverage:".blue
+    system "yard stats --list-undoc"
+  end
+
+  desc "See local documentation at http://localhost:8808"
+  task :serve do
+    system "yard server --reload"
+  end
+end
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/test*.rb']
+  t.verbose = true
+end
+
+namespace :loop do
+  def looper?
+    puts "Checking for 'fswatch' to monitor files".blue
+
+    has_fswatch = ! `which fswatch`.empty?
+
+    abort('fswatch is NOT installed. Visit https://github.com/emcrisostomo/fswatch'.bright.red) unless has_fswatch
+    puts('fswatch is installed.'.bright.green) if has_fswatch
+  end
+
+  def looping(cmd)
+    fswatch_cmd = "fswatch -0 -e .git/ -e *.gem -e logs -e .yardoc -l 1 ."
+    xargs_cmd = "xargs -0 -I {} sh -c \"echo 'File: {}' && %s\""
+    looping_cmd = "#{fswatch_cmd} |  #{xargs_cmd}"
+
+    system "#{looping_cmd}" % cmd
+  end
+
+  IGNORED_MESSAGE = "Ignores .git/, logs/, .yardoc/, and gems created. Watches every 1 seconds"
+
+  desc "Repeatedly installs the gem on file changes"
+  task :install do
+    looper?
+    puts "Rebuilding on file changes. #{IGNORED_MESSAGE}".blue
+    looping("rake uninstall install")
+  end
+
+  desc "Repeatedly runs tests on file changes"
+  task :test do
+    looper?
+    puts "Running tests on file changes. #{IGNORED_MESSAGE}".blue
+    looping("rake test")
+  end
+
+  desc "Repeatedly show documentation coverage on file changes"
+  task :"doc:coverage" do
+    looper?
+    puts "Showing undocumented code on file changes. #{IGNORED_MESSAGE}".blue
+    looping("rake doc:coverage")
+  end
+end

data/bin/vidazing_logger

@@ -0,0 +1,50 @@
+#!/usr/bin/env ruby
+
+require 'vidazing_logger'
+
+require 'optparse'
+require 'ostruct'
+
+class VidazingOptions
+  LEVEL_ALIASES = { 'd' => 'debug', 'i' => 'info', 'w' => 'warn', 'e' => 'error', 'f' => 'fatal' }
+
+  def self.parse(args)
+    options = OpenStruct.new
+    options.level = 'info'
+    options.clean = false
+
+    options_parser = OptionParser.new do |opts|
+      opts.banner = "Usage: vidazing_logger [options] \"Message\""
+
+      opts.separator ""
+      opts.separator "Specific options:"
+
+      level_list = LEVEL_ALIASES.flatten.join(',')
+      opts.on("-l", "--level LEVEL", LEVEL_ALIASES.values, LEVEL_ALIASES, "Select log level",
+              "  (#{level_list})") do |level|
+        options.level = level
+      end
+
+      opts.on_tail("-c", "--clean", "Remove the logs/ directory") do
+        options.clean = true
+      end
+    end
+
+    options_parser.parse!(args)
+    options
+  end
+end
+
+options = VidazingOptions.parse(ARGV)
+
+if options.clean
+  puts "Cleaning the logs/ directory"
+  VidazingLogger.clean
+end
+
+unless ARGV.empty?
+  message = ARGV.join(' ')
+
+  log = VidazingLogger.logger
+  log.public_send(options.level, message)
+end

data/lib/vidazing_logger/appenders/stderr.rb

@@ -0,0 +1,60 @@
+require 'logging'
+
+# Determines how to log messages. Attaches to Logging.logger
+# @api private
+module VidazingLogger::Appenders
+  # Appender writing to STDERR and 'logs/error.log'
+  # @api private
+  module Stderr
+    class << self
+      private
+
+      # ----- BUILD STDERR + LOG -----
+
+      # Logging holds the color scheme reference
+      ERROR_LOG_COLOR_SCHEME = "bright_error"
+      Logging.color_scheme(
+        ERROR_LOG_COLOR_SCHEME,
+        :levels => {
+          :info  => :green,
+          :warn  => :yellow,
+          :error => :red,
+          :fatal => [:white, :on_red]
+        },
+        :date => :red,
+        :logger => :cyan,
+        :message => :magenta
+      )
+
+      def readable_error_layout_pattern
+        Logging.layouts.pattern \
+          :pattern      => '[%d] %-5l %c: %m\n',
+          # ISO8601 without the 'T'
+          :date_pattern => '%Y-%m-%d %H:%M:%S',
+          :color_scheme => ERROR_LOG_COLOR_SCHEME
+      end
+
+      APPENDER_STDERR = "STDERR"
+      def stderr_appender
+        Logging.appenders.stderr \
+          APPENDER_STDERR,
+          :layout => readable_error_layout_pattern,
+          :level  => :error
+      end
+
+      def error_log_appender(log_dir)
+        error_log_path = "#{log_dir}/error.log"
+
+        appender_error_log = error_log_path
+        Logging.appenders.rolling_file \
+          appender_error_log,
+          :layout => readable_error_layout_pattern,
+          :age    => 'daily',
+          :keep   => 7,
+          :level  => :error
+
+        Logging.appenders[appender_error_log]
+      end
+    end
+  end
+end

data/lib/vidazing_logger/appenders/stdout.rb

@@ -0,0 +1,67 @@
+require 'logging'
+
+module VidazingLogger::Appenders
+  # Appender writing to STDOUT and 'logs/build.log'
+  # @api private
+  module Stdout
+    class << self
+      private
+
+      #----- BUILD STDOUT + LOG -----
+
+      # Logging holds the color scheme reference
+      LOG_COLOR_SCHEME = "bright"
+      Logging.color_scheme(
+        LOG_COLOR_SCHEME,
+        :levels => {
+          :info  => :green,
+          :warn  => :yellow,
+          :error => :red,
+          :fatal => [:white, :on_red]
+        },
+        :date => :blue,
+        :logger => :cyan,
+        :message => :magenta
+      )
+
+      def readable_layout_pattern
+        Logging.layouts.pattern \
+          :pattern      => '[%d] %-5l %c: %m\n',
+          # ISO8601 without the 'T'
+          :date_pattern => '%Y-%m-%d %H:%M:%S',
+          :color_scheme => LOG_COLOR_SCHEME
+      end
+
+      def stdout_levels
+        Logging::Filters::Level.new \
+          :debug,
+          :info,
+          :warn
+      end
+
+      APPENDER_STDOUT = "STDOUT"
+      def stdout_appender
+        Logging.appenders.stdout \
+          APPENDER_STDOUT,
+          :layout   => readable_layout_pattern,
+          :filters  => stdout_levels
+
+        Logging.appenders[APPENDER_STDOUT]
+      end
+
+      def build_log_appender(log_dir)
+        build_log_path = "#{log_dir}/build.log"
+
+        appender_build_log = build_log_path
+        Logging.appenders.rolling_file \
+          appender_build_log,
+          :layout => readable_layout_pattern,
+          :age    => 'daily',
+          :keep   => 7,
+          :filters  => stdout_levels
+
+        Logging.appenders[appender_build_log]
+      end
+    end
+  end
+end

data/lib/vidazing_logger/version.rb

@@ -0,0 +1,4 @@
+module VidazingLogger
+  # [String]
+  VERSION = '0.1.0'
+end

data/lib/vidazing_logger.rb

@@ -0,0 +1,47 @@
+require 'vidazing_logger/version'
+require 'vidazing_logger/appenders/stdout'
+require 'vidazing_logger/appenders/stderr'
+
+require 'logging'
+
+# Namespace for the convenience method to create a new logger
+#
+# @see VidazingLogger#logger
+# @since 0.1.0
+module VidazingLogger
+  class << self
+
+    # [String]
+    LOG_DIR = "logs"
+
+    # Creates the 'logs/' directory
+    def initialize
+      Dir.mkdir(LOG_DIR) unless Dir.exists?(LOG_DIR)
+    end
+
+    # Deletes the 'logs/' directory
+    def clean
+      FileUtils.remove_dir(LOG_DIR, true)
+    end
+
+    # Create a Logger with 4 Appenders.
+    # STDERR + 'logs/error.log'
+    # STDOUT + 'logs/build.log'
+    #
+    # @param name [String] Logger name used in messages
+    # @return [Logging.logger] See https://github.com/TwP/logging/blob/master/lib/logging/logger.rb
+    def logger(name = 'VidaZing')
+      require 'pry'; binding.pry
+      VidazingLogger.initialize
+
+      log = Logging.logger[name]
+      log.add_appenders \
+        VidazingLogger::Appenders::Stdout.stdout_appender,
+        VidazingLogger::Appenders::Stdout.build_log_appender(LOG_DIR),
+        VidazingLogger::Appenders::Stderr.stderr_appender,
+        VidazingLogger::Appenders::Stderr.error_log_appender(LOG_DIR)
+
+      log
+    end
+  end
+end

data/vidazing_logger.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.push File.expand_path("../lib", __FILE__)
+require "vidazing_logger/version"
+
+Gem::Specification.new do |s|
+  s.name        = "vidazing_logger"
+  s.version     = VidazingLogger::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["VidaZing, Inc."]
+  s.licenses    = ['MIT']
+  s.email       = ["VidaZing@gmail.com"]
+  s.homepage    = "https://github.com/VidaZing/logger_gem"
+  s.summary     = "Custom logging for VidaZing."
+  s.executables << 'vidazing_logger'
+
+  s.rubygems_version = "2.5.2"
+  s.required_ruby_version     = '>= 1.9.3'
+
+  s.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec)/}) }
+  s.require_paths = ["lib"]
+  # s.test_files = ["test/test_vidazing_logger.rb"]
+
+  s.add_runtime_dependency('logging', '2.2.2')
+
+  s.add_development_dependency 'rake', '~> 0'
+  s.add_development_dependency 'rainbow', '3.0.0'
+  s.add_development_dependency 'rspec', '3.8.0'
+  s.add_development_dependency 'pry', '0.10.4'
+  s.add_development_dependency 'pry-byebug', '3.6.0'
+  s.add_development_dependency 'byebug', '10.0.2'
+  s.add_development_dependency 'yard', '0.9.16'
+end

metadata

@@ -0,0 +1,169 @@
+--- !ruby/object:Gem::Specification
+name: vidazing_logger
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- VidaZing, Inc.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-08-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: logging
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+- !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: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.16
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.16
+description: 
+email:
+- VidaZing@gmail.com
+executables:
+- vidazing_logger
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/vidazing_logger
+- lib/vidazing_logger.rb
+- lib/vidazing_logger/appenders/stderr.rb
+- lib/vidazing_logger/appenders/stdout.rb
+- lib/vidazing_logger/version.rb
+- vidazing_logger.gemspec
+homepage: https://github.com/VidaZing/logger_gem
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+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: Custom logging for VidaZing.
+test_files: []