berkeley_library-logging 0.2.0

data/.idea/modules.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/logging.iml" filepath="$PROJECT_DIR$/.idea/logging.iml" />
+    </modules>
+  </component>
+</project>

data/.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="$PROJECT_DIR$" vcs="Git" />
+  </component>
+</project>

data/.rubocop.yml

@@ -0,0 +1,271 @@
+AllCops:
+  # Exclude generated files
+  Exclude:
+    - 'bin/**/*'
+    - 'node_modules/**/*'
+    - 'artifacts/**/*'
+
+# Allow one line around block body (Layout/EmptyLines will still disallow two or more)
+Layout/EmptyLinesAroundBlockBody:
+  Enabled: false
+
+# Allow one line around class body (Layout/EmptyLines will still disallow two or more)
+Layout/EmptyLinesAroundClassBody:
+  Enabled: false
+
+# Allow one line around module body (Layout/EmptyLines will still disallow two or more)
+Layout/EmptyLinesAroundModuleBody:
+  Enabled: false
+
+# Reasonable line-length check; it's too easy for the cure to be worse than the disease
+Layout/LineLength:
+  Max: 150
+
+# Make indents consistent regardless of the lengths of variables and method names and whatnot
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+# Produces monsters
+Layout/MultilineOperationIndentation:
+  Enabled: false
+
+# We meant to do that
+Naming/MemoizedInstanceVariableName:
+  Enabled: False
+
+# It works in context, trust us
+Naming/MethodParameterName:
+  Enabled: False
+
+# Confusing and weird
+Naming/VariableNumber:
+  Enabled: False
+
+# Do what's readable in the context you're in
+Style/AccessModifierDeclarations:
+  Enabled: false
+
+# 👎 to cultural imperialism
+Style/AsciiComments:
+  Enabled: false
+
+# Seriously?
+Style/CommentedKeyword:
+  Enabled: False
+
+# Disable problematic module documentation check (see https://github.com/bbatsov/rubocop/issues/947)
+Style/Documentation:
+  Enabled: false
+
+# Adding more line noise to format strings will not improve them
+Style/FormatStringToken:
+  Enabled: false
+
+# Putting '# frozen_string_literal: true' everywhere does not make the world a better place
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+# Requiring the lambda() method just makes wordy calls wordier
+Style/Lambda:
+  EnforcedStyle: literal
+
+# `foo.positive?` is cute, but it's not actually more readable than `foo > 0`
+Style/NumericPredicate:
+  Enabled: false
+
+# Don't be unnecessarily redundant
+Style/ReturnNil:
+  Enabled: true
+  EnforcedStyle: return
+
+# Unclear why it's a good idea to give parameters semantically meaningless names
+Style/SingleLineBlockParams:
+  Enabled: false
+
+# The semantics of `foo&.bar` are a lot less interchangeable with `foo && foo.bar` than RuboCop thinks
+Style/SafeNavigation:
+  Enabled: false
+
+############################################################
+# Added in RuboCop 0.80
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+  
+############################################################
+# Added in RuboCop 0.81
+
+Lint/StructNewOverride:
+  Enabled: true
+
+Lint/RaiseException:
+  Enabled: true
+
+############################################################
+# Added in RuboCop 0.82
+
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+
+Style/ExponentialNotation:
+  Enabled: false
+
+############################################################
+# Added in RuboCop 0.83
+
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+
+Style/SlicingWithRange:
+  Enabled: true
+
+############################################################
+# Added in RuboCop 0.84
+
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+
+############################################################
+# Added in RuboCop 0.85
+
+Lint/MixedRegexpCaptureTypes:
+  Enabled: true
+
+Style/RedundantRegexpEscape:
+  Enabled: true
+
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+
+############################################################
+# Added in Rubocop 0.86
+
+Style/RedundantFetchBlock:
+  Enabled: true
+
+############################################################
+# Added in Rubocop 0.87
+
+# Sometimes we separate things for a reason
+Style/AccessorGrouping:
+  Enabled: false
+
+Style/BisectedAttrAccessor:
+  Enabled: true
+
+Style/RedundantAssignment:
+  Enabled: true
+
+############################################################
+# Added in Rubocop 0.88
+
+Lint/DuplicateElsifCondition:
+  Enabled: true
+
+Style/ArrayCoercion:
+  Enabled: true
+
+Style/CaseLikeIf:
+  Enabled: true
+
+Style/HashAsLastArrayItem:
+  Enabled: true
+
+Style/HashLikeCase:
+  Enabled: true
+
+Style/RedundantFileExtensionInRequire:
+  Enabled: true
+
+############################################################
+# Added in Rubocop 0.89
+
+Lint/BinaryOperatorWithIdenticalOperands:
+  Enabled: true
+
+Lint/DuplicateRescueException:
+  Enabled: true
+
+Lint/EmptyConditionalBody:
+  Enabled: true
+
+Lint/FloatComparison:
+  Enabled: true
+
+Lint/MissingSuper:
+  Enabled: true
+
+Lint/OutOfRangeRegexpRef:
+  Enabled: true
+
+Lint/SelfAssignment:
+  Enabled: true
+
+Lint/TopLevelReturnWithArgument:
+  Enabled: true
+
+Lint/UnreachableLoop:
+  Enabled: true
+
+Style/ExplicitBlockArgument:
+  Enabled: true
+
+Style/GlobalStdStream:
+  Enabled: true
+
+Style/OptionalBooleanParameter:
+  Enabled: true
+
+Style/SingleArgumentDig:
+  Enabled: true
+
+Style/SoleNestedConditional:
+  Enabled: true
+
+Style/StringConcatenation:
+  Enabled: true
+
+############################################################
+# Added in Rubocop 0.90
+
+Lint/DuplicateRequire:
+  Enabled: true
+
+Lint/EmptyFile:
+  Enabled: true
+
+Lint/TrailingCommaInAttributeDeclaration:
+  Enabled: true
+
+Lint/UselessMethodDefinition:
+  Enabled: true
+
+Style/CombinableLoops:
+  Enabled: true
+
+Style/KeywordParametersOrder:
+  Enabled: true
+
+Style/RedundantSelfAssignment:
+  Enabled: true
+
+############################################################
+# Added in Rubocop 0.91
+
+Layout/BeginEndAlignment:
+  Enabled: true
+
+Lint/ConstantDefinitionInBlock:
+  Enabled: true
+
+Lint/IdentityComparison:
+  Enabled: true
+
+Lint/UselessTimes:
+  Enabled: true

data/.ruby-version

@@ -0,0 +1 @@
+2.7

data/.simplecov

@@ -0,0 +1,4 @@
+SimpleCov.start 'rails' do
+  add_filter 'module_info.rb'
+  formatter SimpleCov::Formatter::SimpleFormatter
+end

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+
+os:
+  - linux
+  - osx
+
+rvm:
+  - 2.7
+  - ruby-head

data/CHANGES.md

@@ -0,0 +1,12 @@
+# 0.2.0 (2021-08-18)
+
+- Rename to `BerkeleyLibrary::Logging` in prep for move to GitHub
+
+# 0.1.1 (2021-05-03)
+
+- Adds a global logger accessible by including `UCBLIT::Logging`, or via class methods
+  on that module.
+  
+# 0.1.0 (2021-03-12)
+
+- Initial pseudo-release.

data/Dockerfile

@@ -0,0 +1,57 @@
+# =============================================================================
+# Target: base
+
+FROM ruby:2.7-alpine AS base
+
+RUN apk --no-cache --update upgrade && \
+    apk --no-cache add \
+        bash \
+        ca-certificates \
+        git \
+        libc6-compat \
+        openssl \
+        tzdata \
+        xz-libs \
+    && rm -rf /var/cache/apk/*
+
+WORKDIR /opt/app
+
+# =============================================================================
+# Target: development
+#
+
+FROM base AS development
+
+# Install system packages needed to build gems with C extensions.
+RUN apk --update --no-cache add \
+        build-base \
+        coreutils \
+        git \
+    && rm -rf /var/cache/apk/*
+
+# The base image ships bundler 1.17.2, but we want something more recent
+RUN gem install bundler -v 2.1.4
+
+# Copy codebase to WORKDIR. Unlike application projects, for a gem project
+# we need to do this before running `bundle install`, in order for the gem
+# we're building to be able to "install" itself.
+COPY . .
+
+# Install gems.
+RUN bundle install --path=/usr/local/bundle
+
+# =============================================================================
+# Target: production
+
+FROM base AS production
+
+# Copy the built codebase from the dev stage
+COPY --from=development /opt/app /opt/app
+COPY --from=development /usr/local/bundle /usr/local/bundle
+
+# Sanity-check that everything was installed correctly and still runs in the
+# slimmed-down production image.
+RUN bundle config set deployment 'true'
+RUN bundle install --local --path=/usr/local/bundle
+
+CMD ['bundle', 'exec', 'rake']

data/Gemfile

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

data/Jenkinsfile

@@ -0,0 +1,21 @@
+#!/usr/bin/env groovy
+
+dockerComposePipeline(
+    commands: [
+        'bundle exec rake coverage',
+        'bundle exec rake rubocop',
+        'bundle exec rake bundle:audit',
+        'bundle exec rake gem'
+    ],
+    artifacts: [
+        junit: 'artifacts/rspec/**/*.xml',
+        html : [
+            'Code Coverage': 'artifacts/rcov',
+            'RuboCop'      : 'artifacts/rubocop'
+        ],
+        raw  : [
+            'artifacts/**/*.gem',
+            'artifacts/**/*.json'
+        ]
+    ]
+)

data/LICENSE.md

@@ -0,0 +1,21 @@
+# The MIT License (MIT)
+
+Copyright © 2020 The Regents of the University of California
+
+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,47 @@
+# BerkeleyLibrary::Logging
+
+[![Build Status](https://travis-ci.com/BerkeleyLibrary/logging.svg?branch=main)](https://travis-ci.com/github/BerkeleyLibrary/logging/)
+[![Gem Version](https://img.shields.io/gem/v/berkeley_library-logging.svg)](https://github.com/BerkeleyLibrary/logging/releases)
+
+Opinionated logging for UCB Library IT Rails applications.
+
+## Usage
+
+### With Rails
+
+`BerkeleyLibrary::Logging` is implemented as a Railtie, so adding it to your Gemfile should
+cause it to be loaded automatically.
+
+### With or without Rails
+
+You can load `BerkeleyLibrary::Logging` explicitly with `require`:
+
+```ruby
+require 'berkeley_library/logging'
+
+logger = BerkeleyLibrary::Logging::Logger.default_logger
+```
+
+In a Rails environment, this will return the Rails logger (already configured by the
+Railtie); in a non-Rails environment, it will return a default, human-readable STDOUT
+logger.
+
+Alternatively, you can create a logger directly:
+
+```ruby
+require 'berkeley_library/logging'
+
+logger = BerkeleyLibrary::Logging::Loggers.new_readable_logger('/tmp/mylog.log')
+logger.warn('oops')
+puts File.read('/tmp/mylog.log')
+
+# => # Logfile created on 2021-02-03 16:47:06 -0800 by logger.rb/v1.4.2
+     [2021-02-03T16:47:10.506-08:00] WARN: oops
+
+logger = BerkeleyLibrary::Logging::Loggers.new_json_logger('/tmp/mylog.json')
+logger.warn('oops')
+puts File.read('/tmp/mylog.log')
+
+# => # Logfile created on 2021-02-03 16:49:30 -0800 by logger.rb/v1.4.2
+     {"name":"irb","hostname":"test.example.org","pid":7080,"level":40,"time":"2021-02-03T16:49:34.842-08:00","v":0,"severity":"WARN","msg":"oops"}
+```