log-pretty 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 613fbcdce0669a518c2fb589a310e6a73ac9c0fb873421775d0a7eeef297c3b9
-  data.tar.gz: df60f6c0aa702875d08963ad6a90e51548e8d748f5efdd4eebdf7f9a4afc0f00
+  metadata.gz: a514b47d9728fc36838766ddf7dfb468b95fadeb34c973e7582416e0aa29b8a6
+  data.tar.gz: 4c9089d5dce89c36002566785fd2d8c67d188a1d4a1383b549dcb22f134a9b1e
 SHA512:
-  metadata.gz: 30bccc61a218863ac2d1d11306025b29248783cd2347ee75e568aa741a740ee346a08bb5c85c7340d78fe58637991232ccd24908367a84bc5d85f2209e991e54
-  data.tar.gz: ec97acb6918fcb4857370b654b536846eeae2016a80c64ba5d4c3f2260996f2dadd6f8be190ffdd7166087184eced635b253fbf9786dca5131bf1a5ff926458a
+  metadata.gz: dc1a186bb696547c179294975c6d792367f80d452f5a4b12dadf71db24c85f4774ec9fc7418f023e85e808fada76940aa1085f50fa7415215f2070916c37cee4
+  data.tar.gz: 8ca089c467d000e22de03443df35e2f5ecc7d1e898de41ca0edd7485b60e50b17370f08761f72a2cc11adc36fc9df0212f301e9072bad752103f7cb26e091906

data/README.md

@@ -1,6 +1,6 @@
 # LogPretty
 
-LogPretty adds functionaltiy to print to STDOUT using [ANSI escape](https://en.wikipedia.org/wiki/ANSI_escape_code) colors and formatting.
+LogPretty adds functionaltiy to print to STDOUT or any logging device using [ANSI escape](https://en.wikipedia.org/wiki/ANSI_escape_code) colors and formatting.
 
 You can echo the following to any ANSI-compatible terminal to see blue output.
 
@@ -8,7 +8,7 @@ You can echo the following to any ANSI-compatible terminal to see blue output.
 $ echo "\e[34mHello world!\e[0m"
 ```
 
-The '34' is the code for blue and the '0' at the end resets all styles.  You can find a helpful list of ANSI codes [here](https://gist.github.com/fnky/458719343aabd01cfb17a3a4f7296797).
+The '34' is the code for blue and the '0' at the end resets all styles. You can find a helpful list of ANSI codes [here](https://gist.github.com/fnky/458719343aabd01cfb17a3a4f7296797).
 
 ## Installation
 
@@ -34,7 +34,7 @@ include LogPretty
 
 ## Usage
 
-The main method `#logp` (which stands for 'log pretty') logs pretty content (colors, formatting, etc.) to standard output.  This can be useful for writing scrips and CLIs where you would like the user to see prettier content in their terminal.
+The main method `#logp` (which stands for 'log pretty') logs pretty content (colors, formatting, etc.) to standard output. This can be useful for writing scrips and CLIs where you would like the user to see prettier content in their terminal.
 
 Supply a String argument for the content and any optional formatting arguments.
 
@@ -51,10 +51,20 @@ logp('Red alert!', color: :red, format: %i[underline bold italic])
 ```
 
 Avaliable optional keys are:
+
 - color
 - background
 - format
 
+Additionally, you can specify a log file with an optional compatible Logger formatter proc.
+
+```
+l = LogPretty::Logger.new('log/log_pretty.log', formatter)
+l.logp("Hello, world! 👋")
+```
+
+By default, LogPretty will write to the logging file in addition to STDOUT and return the output to the caller.
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/log-pretty/logger.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'logger'
+
+# Extend module for global access to #logp method
+module LogPretty
+  # Initialize a custom logger if setting the device or formatter
+  class Logger
+    def initialize(log_device = nil, formatter = nil, **_opts)
+      @log_device = log_device || $stdout
+      @formatter = formatter || default_formatter
+    end
+
+    # Will print to custom loggin device, if other than STDOUT,
+    # STDOUT by default, and returns output
+    def logp(input, **)
+      output = AnsiPrinter.new(input:, **).output
+
+      # print to logger
+      logger.info(output)
+
+      # print to $stdout unless it already is.
+      $stdout.puts(output) unless logger.instance_variable_get(:@logdev).dev == $stdout
+
+      # return value
+      output
+    end
+
+    private
+
+    def logger
+      @logger ||= ::Logger.new(@log_device).tap do |l|
+        l.formatter = @formatter
+      end
+    end
+
+    def default_formatter
+      proc do |_severity, _datetime, _progname, message|
+        "#{message}\n"
+      end
+    end
+  end
+end

data/lib/log-pretty/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LogPretty
-  VERSION = '0.1.3'
+  VERSION = '0.2.0'
 end

data/lib/log-pretty.rb

@@ -1,19 +1,30 @@
 # frozen_string_literal: true
 
+require 'pry'
+# frozen_string_literal: true
+
 require_relative 'log-pretty/version'
 require_relative 'log-pretty/ansi_printer'
+require_relative 'log-pretty/logger'
 
 # Extend module for global access to #logp method
 module LogPretty
   class Error < StandardError; end
 
-  def logp(input, **opts)
-    output = AnsiPrinter.new(input:, **opts).output
-
-    # Print to STDOUT
-    $stdout.puts output
-
-    # Return value
-    output
+  # Stylize output simply with:
+  # import LogPretty
+  # logp('Hello, world! 👋', color: :teal, background: :blue, format: :bold)
+  #
+  # Or, set a custom log device and formatter:
+  #
+  # formatter = proc do |severity, datetime, progname, msg|
+  #   "...#{msg}"
+  # end
+  #
+  # logger = LogPretty::Logger.new("pretty.log", formatter)
+  # logger.logp('Hello, world! 👋', color: red)
+  #
+  def logp(input, **)
+    Logger.new.logp(input, **)
   end
 end

metadata

@@ -1,19 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: log-pretty
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Jesse vonBergen
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-09-27 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
 description: Provides intuitive methods for outputting ANSI escaped content to the
   terminal
 email:
-- jvon1904@gmail.com
+- jvon1904@avocoaster.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -26,6 +25,7 @@ files:
 - Rakefile
 - lib/log-pretty.rb
 - lib/log-pretty/ansi_printer.rb
+- lib/log-pretty/logger.rb
 - lib/log-pretty/version.rb
 - sig/log_pretty.rbs
 homepage: https://github.com/jvon1904/log-pretty
@@ -35,7 +35,6 @@ metadata:
   rubygems_mfa_required: 'true'
   homepage_uri: https://github.com/jvon1904/log-pretty
   source_code_uri: https://github.com/jvon1904/log-pretty
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -50,8 +49,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.20
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Provides intuitive methods for outputting ANSI escaped content to the terminal
 test_files: []