hedgelog 0.1.13.alpha.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 875b58fb26d8f6cffda3998b8ab3a5e6a9350895c8c6ac5fb01dc7eebdd9052e
-  data.tar.gz: 16636d198b831e232abcbcce6f6d55584ce3e1f0bfb635366031c8fdc594364e
+  metadata.gz: cf8635e3a83a61c6935a28fb8ea0aa72b47aec7810d1ec125cc507ccef939179
+  data.tar.gz: 97e10f2f2dcc69ae7cf73cf3e2a95c352bb8f477129cf9babee1549b8eb9106a
 SHA512:
-  metadata.gz: 0bc28f6bdbf2a8757ad1bcd9f66b55ff9511ef4b08ae5f070a301e5286ec9de17dab61329904b21c0b7e39670ae59b122300884bf24d95d85f5890cea1ec04f5
-  data.tar.gz: c281aeca41ab0516f8a77c922c544d7a5e0ef676d69141f99a884d68f45df4d6664657163aee47864b47d6553e1789adaeb706d9b246f381f764294d19a0a4ec
+  metadata.gz: 30155e59568b520b423762cae723b7eccd604bc3552aaa39e42bf62bf6fdf9171c6527eee27a88a0c46089d696813d166b7c1612bd370b9b19ae9d0d72aa257b
+  data.tar.gz: bd4d609ab864a0879f12b4624a9a4aef371a509d8f9ba24d798cfd9b4de0edb92e73cd69360f796496760d885bd9f2aeee719ccb8e6ab392bf181ba0f38c39ef

data/.rubocop.yml

@@ -2,77 +2,66 @@
 inherit_from: #{RUBOCOP_HOME}/config/default.yml
 
 AllCops:
-  SuggestExtensions: false
-  TargetRubyVersion: 2.7
+  TargetRubyVersion: 2.4
   Exclude:
     - 'vendor/**/*'
     - 'Guardfile'
-  NewCops: enable
 
-Gemspec/RequireMFA:
-  Enabled: false
-
-Layout/LeadingCommentSpace:
-  Enabled: false
-
-Layout/LineLength:
-  Max: 150
-
-Layout/SpaceInsideHashLiteralBraces:
-  EnforcedStyle: no_space
-
-Metrics/BlockLength:
-  Exclude:
-    - 'spec/**/*.rb'
-
-Metrics/BlockNesting:
-  Max: 4
-
-Metrics/ClassLength:
-  Enabled: false
-
-Metrics/CyclomaticComplexity:
+CyclomaticComplexity: 
   Max: 15
 
-Metrics/MethodLength:
+PerceivedComplexity:
+  Max: 20
+
+MethodLength:
   Max: 30
 
-Metrics/PerceivedComplexity:
-  Max: 20
+ClassLength:
+  Enabled: false
 
-Style/AccessModifierDeclarations:
-  EnforcedStyle: inline
+LineLength:
+  Max: 150
 
-Style/CommentAnnotation:
+WordArray:
   Enabled: false
 
-Style/Documentation:
+LeadingCommentSpace:
   Enabled: false
 
-Style/FrozenStringLiteralComment:
+CommentAnnotation:
   Enabled: false
 
-Style/HashConversion:
-  Enabled: true
+Documentation:
+  Enabled: false
 
-Style/Next:
+Next:
   Enabled: false
 
-Style/OptionalArguments:
+OptionalArguments:
   Enabled: false
 
-Style/RedundantStringEscape:
-  Enabled: true
+SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
 
-Style/SignalException:
+SignalException:
   EnforcedStyle: only_raise
 
+TrivialAccessors:
+  AllowPredicates: true
+
+BlockNesting:
+  Max: 4
+
 Style/StringLiterals:
   Enabled: true
   EnforcedStyle: single_quotes
 
-Style/TrivialAccessors:
-  AllowPredicates: true
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*.rb'
 
-Style/WordArray:
-  Enabled: false
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/AccessModifierDeclarations:
+  EnforcedStyle: inline

data/.ruby-version

@@ -1 +1 @@
-2.7
+2.4

data/.travis.yml

@@ -1,6 +1,6 @@
 language: ruby
 cache: bundler
-rvm: 2.7
+rvm: 2.4
 before_install:
   - gem update --system
   - gem install bundler

data/bin/profile

@@ -1,3 +1,4 @@
+#!/usr/bin/env ruby
 
 require 'bundler/setup'
 require 'hedgelog'

data/hedgelog.gemspec

@@ -5,13 +5,12 @@ require 'hedgelog/version'
 Gem::Specification.new do |spec|
   spec.name          = 'hedgelog'
   spec.version       = Hedgelog::VERSION
-  spec.required_ruby_version = '>= 2.7.0'
   spec.licenses      = ['MIT']
   spec.authors       = ['Jeff Utter']
   spec.email         = ['jeff.utter@firespring.com']
 
   spec.homepage      = 'https://github.com/firespring/hedgelog'
-  spec.summary       = 'A structured JSON logger for Ruby'
+  spec.summary       = 'A strucutred JSON logger for Ruby'
   spec.description   = 'An opinionated/structured JSON logger for Ruby'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }

data/lib/hedgelog/normalizer.rb

@@ -7,13 +7,13 @@ class Hedgelog
     end
 
     def normalize_struct(struct)
-      normalize_hash(struct.each_pair.to_a.to_h)
+      normalize_hash(Hash[struct.each_pair.to_a])
     end
 
     def normalize_hash(hash)
-      hash.transform_values do |val|
-        normalize_thing(val)
-      end
+      Hash[hash.map do |key, val|
+        [key, normalize_thing(val)]
+      end]
     end
 
     def normalize_array(array)

data/lib/hedgelog/scrubber.rb

@@ -3,9 +3,16 @@ require 'hedgelog/scrub_replacement'
 class Hedgelog
   class Scrubber
     def initialize(replacements = nil)
-      @replacements = replacements || [
-        ScrubReplacement.new('password', '**********')
-      ]
+      @replacements = [ScrubReplacement.new('password', '**********')]
+      unless replacements.nil?
+        replacements.each do |x|
+          if x.instance_of?(ScrubReplacement)
+            @replacements << x
+          else
+            @replacements << ScrubReplacement.new(x,'**********')
+          end
+        end
+      end
     end
 
     def scrub(data)

data/lib/hedgelog/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class Hedgelog
-  VERSION = '0.1.13.alpha.1'
+  VERSION = '0.2.0'
 end

data/lib/hedgelog.rb

@@ -25,12 +25,12 @@ class Hedgelog
   attr_reader :level
   attr_writer :app
 
-  def initialize(logdev = $stdout, shift_age = nil, shift_size = nil)
+  def initialize(logdev = STDOUT, shift_age = nil, shift_size = nil, cleaner=nil)
     @level = LEVELS[:debug]
     @channel = nil
     @logdev = nil
     @app = nil
-    @scrubber = Hedgelog::Scrubber.new
+    @scrubber = Hedgelog::Scrubber.new(cleaner)
     @normalizer = Hedgelog::Normalizer.new
     @channel_context = Hedgelog::Context.new(@scrubber, @normalizer)
 
@@ -48,7 +48,6 @@ class Hedgelog
     @level = int_level
   end
 
-  # rubocop:disable Metrics/ParameterLists
   def add(severity = LEVELS[:unknown], message = nil, progname = nil, context = {}, &block)
     return true if (@logdev.nil? && @channel.nil?) || severity < @level
 
@@ -63,7 +62,6 @@ class Hedgelog
 
     @channel&.add(severity, nil, progname, context)
   end
-  # rubocop:enable Metrics/ParameterLists
 
   def []=(key, val)
     @channel_context[key] = val
@@ -149,7 +147,7 @@ class Hedgelog
     data[:caller] = debugharder(caller(4, 1).first) if debug?
     data = extract_top_level_keys(data)
 
-    @logdev.write("#{Yajl::Encoder.encode(data)}\n")
+    @logdev.write(Yajl::Encoder.encode(data) + "\n")
     true
   end
 
@@ -178,7 +176,7 @@ class Hedgelog
     whence = $LOAD_PATH.find { |p| path.start_with?(p) }
     file = if whence
              # Remove the RUBYLIB path portion of the full file name
-             path[whence.length + 1..]
+             path[whence.length + 1..-1]
            else
              # We get here if the path is not in $:
              path

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hedgelog
 version: !ruby/object:Gem::Version
-  version: 0.1.13.alpha.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Jeff Utter
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-11-09 00:00:00.000000000 Z
+date: 2020-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yajl-ruby
@@ -68,10 +68,6 @@ files:
 - lib/hedgelog/scrub_replacement.rb
 - lib/hedgelog/scrubber.rb
 - lib/hedgelog/version.rb
-- script/.bash_helpers
-- script/.env.colors
-- script/.exit_handler
-- script/publish.sh
 homepage: https://github.com/firespring/hedgelog
 licenses:
 - MIT
@@ -84,15 +80,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: A structured JSON logger for Ruby
+summary: A strucutred JSON logger for Ruby
 test_files: []

data/script/.bash_helpers

@@ -1,47 +0,0 @@
-#!/bin/bash
-base_dir=$(dirname $BASH_SOURCE)
-. ${base_dir}/.env.colors
-
-die()
-{
-  echo
-  set_red
-  echo >&2 "$@"
-  reset_colors
-  exit 2
-}
-
-finish()
-{
-  echo
-  set_white
-  echo "$@"
-  reset_colors
-  exit 0
-}
-
-confirm()
-{
-  prompt="${1:-Are you sure? [y/N]}"
-
-  set_yellow
-  echo -n "$prompt "
-  reset_colors
-
-  if [ "${NO_INPUT:-}" == 'true' ]
-  then
-    # Continue if 'NO_INPUT' has been set
-    true
-  else
-    # call with a prompt string or use a default
-    read -r response
-    case "$response" in
-      [yY][eE][sS]|[yY])
-        true
-      ;;
-      *)
-        false
-      ;;
-    esac
-  fi
-}

data/script/.env.colors

@@ -1,94 +0,0 @@
-#!/bin/bash
-
-echo_red()
-{
-  set_red
-  echo "$@"
-  reset_colors
-}
-
-set_red()
-{
-  echo -ne "\033[31;1m"
-}
-
-set_background_red()
-{
-  echo -ne "\033[41;1m"
-}
-
-set_light_red()
-{
-  echo -ne "\033[91;1m"
-}
-
-echo_green()
-{
-  set_green
-  echo "$@"
-  reset_colors
-}
-
-set_green()
-{
-  echo -ne "\033[32;1m"
-}
-
-set_background_green()
-{
-  echo -ne "\033[42;1m"
-}
-
-set_light_green()
-{
-  echo -ne "\033[92;1m"
-}
-
-echo_yellow()
-{
-  set_yellow
-  echo "$@"
-  reset_colors
-}
-
-set_yellow()
-{
-  echo -ne "\033[33;1m"
-}
-
-set_background_yellow()
-{
-  echo -ne "\033[43;1m"
-}
-
-set_light_yellow()
-{
-  echo -ne "\033[93;1m"
-}
-
-set_white()
-{
-  echo -ne "\033[37;1m"
-}
-
-set_background_white()
-{
-  echo -ne "\033[47;1m"
-}
-
-echo_light_white()
-{
-  set_light_white
-  echo "$@"
-  reset_colors
-}
-
-set_light_white()
-{
-  echo -ne "\033[97;1m"
-}
-
-reset_colors()
-{
-  echo -ne "\033[0m"
-}

data/script/.exit_handler

@@ -1,50 +0,0 @@
-#!/bin/bash
-base_dir=$(dirname $BASH_SOURCE)
-. ${base_dir}/.env.colors
-
-exit_handler()
-{
-  RETVAL=$?
-
-  echo
-  if [ $RETVAL -eq 0 ]
-  then
-    echo_green "    Command [ ${BASH_SOURCE[1]} ] completed successfully"
-  else
-    set +o xtrace
-    set_background_red
-    echo "    Error in ${BASH_SOURCE[1]}:${BASH_LINENO[0]} - '${BASH_COMMAND}' exited with status $RETVAL"
-
-    # Print out the stack trace
-    if [ ${#FUNCNAME[@]} -gt 2 ]
-    then
-      echo
-      echo "    Stacktrace:"
-      for ((i=1;i<${#FUNCNAME[@]}-1;i++))
-      do
-        echo "      $i: ${BASH_SOURCE[$i+1]}:${BASH_LINENO[$i]} ${FUNCNAME[$i]}(...)"
-      done
-    fi
-    reset_colors
-  fi
-
-  echo
-  exit $RETVAL
-}
-
-int_handler()
-{
-  echo
-  echo_yellow "    Ctrl-C received, exiting"
-  echo
-  exit 130
-}
-
-SHOULD_ADD_EXIT_HANDLER=${SHOULD_ADD_EXIT_HANDLER:-}
-if [ "$SHOULD_ADD_EXIT_HANDLER" = '' ]
-then
-  trap exit_handler EXIT
-  trap int_handler INT
-fi
-export SHOULD_ADD_EXIT_HANDLER=1
-set -o errtrace

data/script/publish.sh

@@ -1,161 +0,0 @@
-#!/bin/bash
-set -euo pipefail
-base_dir=$(dirname $BASH_SOURCE)
-. ${base_dir}/.env.colors
-. ${base_dir}/.exit_handler
-. ${base_dir}/.bash_helpers
-
-HEDGELOG_DIR=$(readlink -f ${base_dir}/../)
-
-HEDGELOG_VERSION_FILE="${HEDGELOG_DIR}/lib/hedgelog/version.rb"
-
-HEDGELOG_VERSION=${HEDGELOG_VERSION:-}
-VALID_VERSION_FORMAT="^[0-9]+.[0-9]+.[0-9]+(\.alpha.[0-9+])?$"
-
-RUBYGEMS_CRED_FILE=".gem/credentials"
-RUBYGEMS_USER_CRED_FILE="${HOME}/${RUBYGEMS_CRED_FILE}"
-RUBYGEMS_ROOT_CRED_FILE="/root/${RUBYGEMS_CRED_FILE}"
-RUBYGEMS_CRED_VOLUME="${RUBYGEMS_USER_CRED_FILE}:${RUBYGEMS_ROOT_CRED_FILE}"
-touch "${RUBYGEMS_USER_CRED_FILE}"
-chmod 600 "${RUBYGEMS_USER_CRED_FILE}"
-
-
-usage() {
-  echo "USAGE: $(basename "$0")"
-  echo
-  echo "  Input parameters can be specified via environmental variables:"
-  echo "    HEDGELOG_VERSION (default: <none>) must be in the format '${VALID_VERSION_FORMAT}'"
-  echo
-  echo "  the following will update the hedgelog version to 4.8.1.alpha.2"
-  echo "    HEDGELOG_VERSION=4.8.1.alpha.2 $(basename "$0")"
-}
-
-validate()
-{
-  [ "$*" == "" ] || finish "$(usage)"
-
-  found_version_to_update=''
-  STARTING_HEDGELOG_VERSION=$(get_gem_version "${HEDGELOG_VERSION_FILE}")
-  if [ "${HEDGELOG_VERSION}" == "" ]
-  then
-    echo_light_white "No hedgelog version given. Leaving at [ ${STARTING_HEDGELOG_VERSION} ]"
-  else
-    found_version_to_update='true'
-    validate_version_format "${HEDGELOG_VERSION}" || die "Version [ ${HEDGELOG_VERSION} ] must be in the format ${VALID_VERSION_FORMAT}"
-    echo_light_white "This will update the hedgelog version from [ ${STARTING_HEDGELOG_VERSION} ] to [ ${HEDGELOG_VERSION} ]."
-  fi
-
-  if [ "${found_version_to_update}" == 'true' ]
-  then
-    echo
-    confirm "  Do you wish to continue? (y/n)" || finish "Exiting..."
-  else
-    echo
-    echo_yellow "No versions given to update"
-    echo
-    exit 0
-  fi
-}
-
-validate_version_format()
-{
-  local version=$1
-  echo "${version}" | grep -qE "${VALID_VERSION_FORMAT}"
-}
-
-main()
-{
-  echo
-  validate $*
-  echo
-
-  hedgelog_gem_update=""
-  if [ "${HEDGELOG_VERSION}" != "" ]
-  then
-      hedgelog_gem_update="hedgelog=$(normalize_gem_version "${HEDGELOG_VERSION}")"
-    publish_hedgelog "${HEDGELOG_VERSION}"
-  fi
-
-#  GEMS="${hedgelog_gem_update}" ${base_dir}/update_gems.sh
-
-  # I'm doing this because I don't want persistent cred files on our dev servers which would give access to publish
-  # gems - in case a dev server was ever compromised
-  [[ -f ${RUBYGEMS_USER_CRED_FILE} ]] && rm -f ${RUBYGEMS_USER_CRED_FILE}
-
-  echo
-  echo_light_white "Hedgelog has successfully been upgraded from version [ ${STARTING_HEDGELOG_VERSION} ] to [ ${HEDGELOG_VERSION} ]"
-  echo
-}
-
-publish_hedgelog()
-{
-  local desired_version=$1
-
-  # Change the version in the file
-  update_gem_version "${HEDGELOG_VERSION_FILE}" "${desired_version}"
-
-  # Make sure hedgelog is up to date
-  echo "Checking to see if the hedgelog gem needs to be published..."
-
-#  versions="$(MSYS_NO_PATHCONV=1 docker-compose ${COMPOSE_FILES} run --no-deps -v "${RUBYGEMS_CRED_VOLUME}" --entrypoint /bin/sh client-ruby -c "gem query --all --pre --remote stbaldricks")"
-  versions=`gem query --all --pre --remote hedgelog`
-  if echo "${versions}" | grep -Eq "(\(| )${desired_version}(,|\))"
-  then
-    # Make sure the user expected this to have already been published
-    confirm "  Hedgelog gem version ${desired_version} has already been published. Is this expected? (y/n)" || finish "Exiting..."
-  else
-    # Publish the gem
-    echo "Starting ruby container to build and publish gem"
-#    MSYS_NO_PATHCONV=1 docker-compose ${COMPOSE_FILES} run --no-deps -v "${RUBYGEMS_CRED_VOLUME}" --entrypoint /bin/sh client-ruby -c "gem build stbaldricks.gemspec && gem push stbaldricks-${desired_version}.gem"
-    gem build hedgelog.gemspec && gem push "hedgelog-${desired_version}.gem"
-  fi
-  echo
-}
-
-get_gem_version()
-{
-  local version_file=$1
-  normalize_version "$(sed -nre "s@.*VERSION.*=.*('|\")(.*)('|\").*@\2@gp" ${version_file})"
-}
-
-update_gem_version()
-{
-  local version_file=$1
-  local version=$2
-  local gem_version=$(normalize_gem_version "${version}")
-
-  # Try to update the gem version in the file
-  sed -i -re "s@(.*VERSION.*=.*)('|\")(.*)('|\")(.*)@\1\2${gem_version}\4\5@g" "${version_file}"
-
-  # Verify the version is now what we wanted
-  updated_version=$(get_gem_version "${version_file}")
-  if [ "${updated_version}" != "${version}" ]
-  then
-    die "Unable to update version [ ${version} ] in [ ${version_file} ] (got ${updated_version})"
-  fi
-  git add "${version_file}"
-}
-
-normalize_version()
-{
-  local version=$1
-  echo $version | sed -re "s@([0-9]).(alpha)@\1.\2@g"
-}
-
-normalize_gem_version()
-{
-  local version=$1
-  echo $version | sed -re "s@([0-9]).(alpha)@\1.\2@g"
-}
-
-strip_alpha()
-{
-  local starting_version=$1
-  echo ${starting_version} | sed -re 's@(.*).alpha.[0-9]+@\1@g'
-}
-
-export -f get_gem_version strip_alpha
-
-# Only run main if this script isn't currently being sourced
-$(return >/dev/null 2>&1) || main $*
-