loba 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0f471467c64346c7c47d0b6496bf9f15677d8a2a107f8fe71dbf1901edd998d
-  data.tar.gz: b9c3ac98add22965ffcb61b3fcc9972d9144464690a70c78e66dd4f4b35483f9
+  metadata.gz: b36dc160a907314109b66e42c193c07bfbb40cf93b7113a682d0defec4a0e2fc
+  data.tar.gz: 726bdf0b19c228bef0296b86b47b71243465a241541fd5406d7862c0e98d9b45
 SHA512:
-  metadata.gz: a34112c0ce8214bc5dde3d5ad72bf1c457c954c0972b08d1fa0d43ff2d3b693b6db4a1d4ea4a86745712c5bb6d879f6cb885d1f3ac9453a50a4b2904c7eb3084
-  data.tar.gz: 85551529acd430a5e42849c87f76f2b811c63a038619b11f128e628f29f57d4ac86ddbface5eb878b5075b2920a6c5c5b467de4f9f25aeaa10991b3cdfe70cab
+  metadata.gz: affde22b1ec558c8bf7b58ee64552996573bbc7748c7eec705de2131fd161d62843a76f2290ad4c45aa68e26f0758b4023ff8907745ffb36752e0dea2e97d7c3
+  data.tar.gz: 4381427918e65ef4cd5dfd60c57402441ba57273c2aab8f2026ef5f7d1f621cc1fd4209a04c895e74422597a05664de814eaeab421f9c5ff553b90ae88189c01

data/CHANGELOG.md

@@ -0,0 +1,75 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog (1.0.0)](https://keepachangelog.com/en/1.0.0/),
+and, as of version 0.3.0 and later, this project adheres to [Semantic Versioning (2.0.0)](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [1.1.0] - 2021-08-20
+### Added
+- CHANGELOG.md to follow "Keep a Changelog" convention
+- minor unit tests
+
+### Changed
+- Replaced colorize gem with rainbow gem for MIT license purity
+- "Changelog" section of README.md to refer to new CHANGELOG.md
+- `Loba.ts`: "(in ...)" of notice now has a space instead of a "=" (matches `Loba.val`)
+- `Loba.ts`: string continuation instead of concatenation for performance
+- `Loba.val`: string continuation instead of concatenation for performance
+
+## [1.0.0] - 2021-08-18
+### Added
+- `Loba.val`: added `Loba.value` as an alias
+
+### Changed
+- `Loba.ts`: use Ruby 2.x-style keyword arguments instead of an options hash [BREAKING CHANGE]
+- `Loba.val`: use Ruby 2.x-style keyword arguments instead of an options hash [BREAKING CHANGE]
+- Updated for more recent Ruby versions (>= 2.5)
+- Updated gem dependencies
+- Expanded unit testing
+- Refactored code to better compartmentalize for easier maintainability
+- Updated user documentation, including corrections and better `production: true` warning
+- Updated YARD documentation
+
+### Removed
+- Gemnasium link from README
+- Last positional argument as `true` or `false` to control presence in production environments
+- Options hash support to control `production: true` and `inspect: false` [BREAKING CHANGE]
+
+## [0.3.1] - 2017-04-07
+### Added
+- YARD documentation
+- `Loba.val`: `inspect` option to control use of `.inspect` on an argument value
+- `Loba.ts`: added `Loba.timestamp` as an alias
+
+### Changed
+- Converted to options hash instead of implicit positional arguments
+- `Loba.val`: nil values now display as `-nil-` instead of blank output
+
+### Deprecated
+- Last positional argument as `true` or `false` to control presence in production environments
+
+## [0.3.0] - 2017-04-07 [YANKED]
+
+## [0.2.0] - 2016-12-02
+### Added
+- Initial publication to RubyGems.org
+- Gem badge to README
+- Code Climate integration
+
+### Changed
+- Improved and corrected documentation
+- Various bug fixes
+- Generalized for Ruby and reduced Rails centricity
+
+## 0.1.0 - 2016-01-06
+### Added
+- Initial implementation
+
+[Unreleased]: https://github.com/rdnewman/loba/compare/v1.1.0...HEAD
+[1.1.0]: https://github.com/rdnewman/loba/compare/v1.0.0...v1.1.0
+[1.0.0]: https://github.com/rdnewman/loba/compare/v0.3.1...v1.0.0
+[0.3.1]: https://github.com/rdnewman/loba/compare/v0.3.0...v0.3.1
+[0.3.0]: https://github.com/rdnewman/loba/compare/0.2.0...v0.3.0
+[0.2.0]: https://github.com/olivierlacan/keep-a-changelog/releases/tag/0.2.0

data/README.md

@@ -174,25 +174,8 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Changelog
-|version|notes|
-|-------|-----|
-|1.0.0|updated for more recent rubies; uses Ruby 2.x-style keyword arguments for specifying options|
-|0.3.1|updated dependences; added inspect to Loba.val; amended parameters*|
-|0.3.0|(yanked)|
-|0.2.0|release on RubyGems.org|
-|0.1.0|initial development|
 
-### Deprecations
-
-#### 1.0.0
-In v0.3.x, to allow Loba notes to write to the log while in :production, an options hash as `{:production => true}` was introduced; this is now specified directly via Ruby-2.x style keywords, e.g., `production: true`. THIS IS A BREAKING CHANGE FROM v0.3.1 and earlier versions.
-
-#### 0.3.0
-In prior versions, to allow Loba notes to write to the log while in :production, an optional third argument could be supplied as merely a boolean value.  In 0.3.0 and later versions, this must now be specified as part of an options hash as `{:production => true}`
-
-### Semantic versions
-
-As of version 0.3.0 and later, this gem follows semantic versioning [2.0.0](http://semver.org/spec/v2.0.0.html) conventions.
+See [CHANGELOG.md](CHANGELOG.md) for details. This gem follows semantic versioning.
 
 ## Contributing
 

data/lib/loba.rb

@@ -2,7 +2,7 @@ require 'loba/version'
 require 'loba/internal'
 
 require 'binding_of_caller'
-require 'colorize'
+require 'rainbow'
 
 # Loba module for quick tracing of Ruby and Rails.
 # If a Rails application, will use Rails.logger.debug.
@@ -32,16 +32,19 @@ module Loba
 
     begin
       stats = Internal::TimeKeeper.instance.ping
-      @loba_logger.call '[TIMESTAMP]'.black.on_light_black +
-                        ' #='.yellow +
-                        format('%04d', stats[:number]).to_s +
-                        ', diff='.yellow +
-                        format('%.6f', stats[:change]).to_s +
-                        ', at='.yellow +
-                        format('%.6f', stats[:now].round(6).to_f).to_s +
-                        "    \t(in=#{caller(1..1).first})".light_black
+      @loba_logger.call(
+        # 60: light_black / grey
+        "#{Rainbow('[TIMESTAMP]').black.bg(60)}" \
+        "#{Rainbow(' #=').yellow.bg(:default)}" \
+        "#{format('%04d', stats[:number])}" \
+        "#{Rainbow(', diff=').yellow}" \
+        "#{format('%.6f', stats[:change])}" \
+        "#{Rainbow(', at=').yellow}" \
+        "#{format('%.6f', stats[:now].round(6).to_f)}" \
+        "#{Rainbow("    \t(in #{caller(1..1).first})").color(60)}" # warning: nested interpolation
+      )
     rescue StandardError => e
-      @loba_logger.call "[TIMESTAMP] #=FAIL, in=#{caller(1..1).first}, err=#{e}".colorize(:red)
+      @loba_logger.call Rainbow("[TIMESTAMP] #=FAIL, in=#{caller(1..1).first}, err=#{e}").red
     end
 
     nil
@@ -104,10 +107,15 @@ module Loba
       inspect: inspect,
       depth_offset: 1
     )
-    @loba_logger.call "#{text[:tag]} ".green +
-                      "#{text[:label]} ".light_green +
-                      text[:value] +
-                      "    \t(in #{text[:line]})".light_black
+    @loba_logger.call(
+      # warning: nested interpolation below (slight help to performance)
+      # 60: light_black
+      # 62: light_green
+      "#{Rainbow("#{text[:tag]} ").green.bg(:default)}" \
+      "#{Rainbow("#{text[:label]} ").color(62)}" \
+      "#{text[:value]}" \
+      "#{Rainbow("    \t(in #{text[:line]})").color(60)}"
+    )
 
     nil
   end

data/lib/loba/version.rb

@@ -1,3 +1,3 @@
 module Loba
-  VERSION = '1.0.0'.freeze
+  VERSION = '1.1.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: loba
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Richard Newman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-08-18 00:00:00.000000000 Z
+date: 2021-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -39,19 +39,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: colorize
+  name: rainbow
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '3.0'
 description: Handy methods for adding trace lines to output or Rails logs.
 email:
 - richard@newmanworks.com
@@ -59,6 +59,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - LICENSE
 - README.md
@@ -75,6 +76,7 @@ licenses:
 metadata:
   source_code_uri: https://github.com/rdnewman/loba
   bug_tracker_uri: https://github.com/rdnewman/loba/issues
+  documentation_uri: https://www.rubydoc.info/gems/loba
 post_install_message: 
 rdoc_options: []
 require_paths: