logue 1.0.18 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 95cf55b9a46e87e0efde0c6dc8165b81589da57d
-  data.tar.gz: 72e63c79ecb54ced7592a2c29989a538fcb5da59
+SHA256:
+  metadata.gz: 9f60d8d9300dafd78cc242301c85454bef6739f7dad2b2a663dc7d8a3b3f9615
+  data.tar.gz: fc01ceb406615d287d83aecefc4975fb4cbade6220d54239a45525c78bc10eb4
 SHA512:
-  metadata.gz: 82e7dacd7ac3fb7abb70f5b1c2c11a50dd798c3b99d715e6123e3b6c67a84c60ee83eedfe0aea89b78baa773bdc1c851865a7dc61c190def8e82cc38d758eb26
-  data.tar.gz: 429aeb5c76d4144c8f1391812c600e8c9c4189532d84dc377a1006315de27718021d99cc1e36402e758cfe2f2745a9d69c36ba92d5e031e51b48fc865fac3d69
+  metadata.gz: d1adb9e5af42ff364a21ce3edbdb7270b7cd60a5164e2342781aa1ac32dabd151bae608e6726c84d3ecb08cc1838e51cf64149fc2ca8249309a8b148d1a12892
+  data.tar.gz: a6d621ea51c8072d538fbd9311aa491cbc34abbf389527d223c45c6c57e81ff292a23a3a0350ec663f17a1180284711c152229ec6b1814dad0688fe78a77e439

data/.idea/.gitignore

@@ -0,0 +1,10 @@
+# Default ignored files
+/shelf/
+/workspace.xml
+# Editor-based HTTP Client requests
+/httpRequests/
+# Datasource local storage ignored files
+/dataSources/
+/dataSources.local.xml
+# Zeppelin ignored files
+/ZeppelinRemoteNotebooks/

data/.idea/aws.xml

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="accountSettings">
+    <option name="activeRegion" value="us-east-1" />
+    <option name="recentlyUsedRegions">
+      <list>
+        <option value="us-east-1" />
+      </list>
+    </option>
+  </component>
+</project>

data/.idea/codeStyles/Project.xml

@@ -0,0 +1,7 @@
+<component name="ProjectCodeStyleConfiguration">
+  <code_scheme name="Project" version="173">
+    <ScalaCodeStyleSettings>
+      <option name="MULTILINE_STRING_CLOSING_QUOTES_ON_NEW_LINE" value="true" />
+    </ScalaCodeStyleSettings>
+  </code_scheme>
+</component>

data/.idea/codeStyles/codeStyleConfig.xml

@@ -0,0 +1,5 @@
+<component name="ProjectCodeStyleConfiguration">
+  <state>
+    <option name="PREFERRED_PROJECT_CODE_STYLE" value="Default" />
+  </state>
+</component>

data/.idea/inspectionProfiles/Project_Default.xml

@@ -0,0 +1,11 @@
+<component name="InspectionProjectProfileManager">
+  <profile version="1.0">
+    <option name="myName" value="Project Default" />
+    <inspection_tool class="RubyDefParenthesesInspection" enabled="false" level="WEAK WARNING" enabled_by_default="false" />
+    <inspection_tool class="SpellCheckingInspection" enabled="true" level="TYPO" enabled_by_default="true">
+      <option name="processCode" value="false" />
+      <option name="processLiterals" value="false" />
+      <option name="processComments" value="true" />
+    </inspection_tool>
+  </profile>
+</component>

data/.idea/libraries/pkg.xml

@@ -0,0 +1,16 @@
+<component name="libraryTable">
+  <library name="pkg">
+    <CLASSES>
+      <root url="jar://$PROJECT_DIR$/pkg/logue-1.0.3.zip!/" />
+      <root url="jar://$PROJECT_DIR$/pkg/logue-1.0.0.zip!/" />
+      <root url="jar://$PROJECT_DIR$/pkg/logue-1.0.2.zip!/" />
+      <root url="jar://$PROJECT_DIR$/pkg/logue-1.0.1.zip!/" />
+      <root url="jar://$PROJECT_DIR$/pkg/logue-1.0.7.zip!/" />
+      <root url="jar://$PROJECT_DIR$/pkg/logue-1.0.8.zip!/" />
+      <root url="jar://$PROJECT_DIR$/pkg/logue-0.0.1.zip!/" />
+      <root url="jar://$PROJECT_DIR$/pkg/logue-1.0.6.zip!/" />
+    </CLASSES>
+    <JAVADOC />
+    <SOURCES />
+  </library>
+</component>

data/.idea/logue.iml

@@ -0,0 +1,53 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="RUBY_MODULE" version="4">
+  <component name="NewModuleRootManager" inherit-compiler-output="true">
+    <exclude-output />
+    <content url="file://$MODULE_DIR$">
+      <sourceFolder url="file://$MODULE_DIR$" isTestSource="false" />
+      <sourceFolder url="file://$MODULE_DIR$/features" isTestSource="true" />
+      <sourceFolder url="file://$MODULE_DIR$/spec" isTestSource="true" />
+      <sourceFolder url="file://$MODULE_DIR$/test" isTestSource="true" />
+      <excludeFolder url="file://$MODULE_DIR$/pkg" />
+    </content>
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+    <orderEntry type="library" scope="PROVIDED" name="bundler (v2.1.4, RVM: ruby-2.4.10) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="paramesan (v0.1.1, RVM: ruby-2.4.10) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="power_assert (v3.0.1, RVM: ruby-2.4.10) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rainbow (v3.0.0, RVM: ruby-2.4.10) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rake (v13.0.6, RVM: ruby-2.4.10) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="test-unit (v3.6.1, RVM: ruby-2.4.10) [gem]" level="application" />
+  </component>
+  <component name="RModuleSettingsStorage">
+    <LOAD_PATH number="2" string0="$MODULE_DIR$" string1="$MODULE_DIR$/test" />
+    <I18N_FOLDERS number="0" />
+  </component>
+  <component name="RakeTasksCache">
+    <option name="myRootTask">
+      <RakeTaskImpl id="rake">
+        <subtasks>
+          <RakeTaskImpl description="Build logue-1.0.19.gem into the pkg directory" fullCommand="build" id="build" />
+          <RakeTaskImpl description="Remove any temporary products" fullCommand="clean" id="clean" />
+          <RakeTaskImpl description="Remove any generated files" fullCommand="clobber" id="clobber" />
+          <RakeTaskImpl description="Build and install logue-1.0.19.gem into system gems" fullCommand="install" id="install" />
+          <RakeTaskImpl id="install">
+            <subtasks>
+              <RakeTaskImpl description="Build and install logue-1.0.19.gem into system gems without network access" fullCommand="install:local" id="local" />
+            </subtasks>
+          </RakeTaskImpl>
+          <RakeTaskImpl description="Create tag v1.0.19 and build and push logue-1.0.19.gem to https://rubygems.org" fullCommand="release[remote]" id="release[remote]" />
+          <RakeTaskImpl description="Run tests" fullCommand="test" id="test" />
+          <RakeTaskImpl description="" fullCommand="default" id="default" />
+          <RakeTaskImpl description="" fullCommand="release" id="release" />
+          <RakeTaskImpl id="release">
+            <subtasks>
+              <RakeTaskImpl description="" fullCommand="release:guard_clean" id="guard_clean" />
+              <RakeTaskImpl description="" fullCommand="release:rubygem_push" id="rubygem_push" />
+              <RakeTaskImpl description="" fullCommand="release:source_control_push" id="source_control_push" />
+            </subtasks>
+          </RakeTaskImpl>
+        </subtasks>
+      </RakeTaskImpl>
+    </option>
+  </component>
+</module>

data/.idea/misc.xml

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="MarkdownSettingsMigration">
+    <option name="stateVersion" value="1" />
+  </component>
+  <component name="ProjectRootManager" version="2" languageLevel="JDK_20" project-jdk-name="RVM: ruby-2.4.10" project-jdk-type="RUBY_SDK">
+    <output url="file://$PROJECT_DIR$/out" />
+  </component>
+</project>

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/logue.iml" filepath="$PROJECT_DIR$/.idea/logue.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="" vcs="Git" />
+  </component>
+</project>

data/Gemfile.lock

@@ -1,28 +1,28 @@
 PATH
   remote: .
   specs:
-    logue (1.0.16)
+    logue (1.1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     paramesan (0.1.1)
-    power_assert (1.1.1)
+    power_assert (3.0.1)
     rainbow (3.0.0)
-    rake (10.5.0)
-    test-unit (3.2.7)
+    rake (13.0.6)
+    test-unit (3.6.1)
       power_assert
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.16)
+  bundler (>= 2.0)
   logue!
   paramesan (~> 0.1.1)
   rainbow (~> 3.0.0)
-  rake (~> 10.0)
-  test-unit (~> 3.1)
+  rake (~> 13.0.1)
+  test-unit (= 3.6.1)
 
 BUNDLED WITH
-   1.16.1
+   2.1.4

data/lib/logue/{colorlog.rb → colorable.rb}

@@ -1,17 +1,7 @@
-#!/usr/bin/ruby -w
-# -*- ruby -*-
-#
-# = colorlog.rb
-#
-# Logging Module
-#
-# Author:: Jeff Pace <jeugenepace@gmail.com>
-# Documentation:: Author
-#
-
 require 'rainbow/x11_color_names'
 require 'rainbow/color'
 require 'logue/level'
+require 'logue/core/dynamic'
 
 #
 # == ColorLog
@@ -24,9 +14,12 @@ require 'logue/level'
 # 
 
 module Logue
-  module ColorLog
+  module Colorable
+    include Dynamic
+
     def method_missing meth, *args, &blk
-      if code = valid_colors[meth]
+      code = valid_colors[meth]
+      if code
         add_color_method meth.to_s, code + 30
         send meth, *args, &blk
       else
@@ -42,23 +35,9 @@ module Logue
       super + valid_colors.keys
     end
 
-    def add_color_method color, code
-      instance_eval ColorLog.color_method_source(color, code)
-    end
-
     def valid_colors
       # Rainbow::X11ColorNames::NAMES
       Rainbow::Color::Named::NAMES
     end
-
-    class << self
-      def color_method_source color, code
-        Array.new.tap do |a|
-          a << 'def ' + color.to_s + '(msg = "", lvl = Logue::Level::DEBUG, classname: nil, &blk)'
-          a << '  log("\e[' + code.to_s + 'm#{msg}\e[0m", level: lvl, classname: classname, &blk)'
-          a << 'end'
-        end.join "\n"
-      end
-    end
   end
 end

data/lib/logue/core/applog.rb

@@ -0,0 +1,18 @@
+require 'singleton'
+
+module Logue
+  class AppLog
+    include Singleton
+
+    def use_legacy
+
+    end
+
+    def use_new
+    end
+
+    def loggable
+      ElementsLoggable
+    end
+  end
+end

data/lib/logue/core/base_loggable.rb

@@ -0,0 +1,58 @@
+#!/usr/bin/ruby -w
+# -*- ruby -*-
+#
+# = loggable.rb
+#
+# Logging Module
+#
+# Author:: Jeff Pace <jeugenepace@gmail.com>
+# Documentation:: Author
+#
+
+require 'logue/logger'
+require 'logue/log'
+require 'logue/core/object_util'
+
+#
+# == Loggable
+#
+# Including this module in a class gives access to the logger methods.
+# 
+# == Examples
+#
+# See the unit tests in loggable_test.rb
+#
+# == Usage
+#
+#  class YourClass
+#    include Logue::Loggable
+#
+#    def some_method
+#      log "my message"
+# 
+#  That will log from the given class and method, showing the line number from
+#  which the logger was called.
+#
+#    def another_method
+#      stack "my message"
+# 
+#  That will produce a stack trace from the given location.
+#
+
+module Logue
+  module BaseLoggable
+    [:stack, :log].each do |methname|
+      # level as positional and named arguments, for compatibility backward and with logger
+      define_method methname do |msg = ObjectUtil::NONE, obj = nil, lvl = nil, level: nil, &blk|
+        lvalue = level || lvl || Level::DEBUG
+        logger.send methname, msg, obj, level: lvalue, classname: self.class.to_s, &blk
+      end
+    end
+
+    [:debug, :info, :warn, :error, :fatal, :write].each do |methname|
+      define_method methname do |msg = ObjectUtil::NONE, obj = nil, &blk|
+        logger.send methname, msg, obj, classname: self.class.to_s, &blk
+      end
+    end
+  end
+end

data/lib/logue/core/base_writer.rb

@@ -0,0 +1,23 @@
+module Logue
+  class BaseWriter
+    attr_accessor :output
+    attr_accessor :colors
+    attr_accessor :colorize_line
+
+    def initialize output: $stdout, colors: Array.new, colorize_line: false
+      @output = output
+      @colors = colors
+      @colorize_line = colorize_line
+    end
+
+    def print lstr, lvl
+      str = @colors[lvl] ? lstr.color(lvl) : lstr
+      @output.puts str
+    end
+
+    def write location, str, level
+      lstr = location + " " + str
+      print lstr, level
+    end
+  end
+end

data/lib/logue/core/dynamic.rb

@@ -0,0 +1,17 @@
+module Logue
+  module Dynamic
+    def add_color_method color, code
+      add_class_method color do |msg = '', obj = nil, level = Level::DEBUG, &blk|
+        colmsg = "\e[#{code}m#{msg}\e[0m"
+        log colmsg, obj, level: level, &blk
+      end
+    end
+
+    def add_class_method meth, &impl
+      eigenclass = class << self; self; end
+      eigenclass.class_eval do
+        define_method meth, impl
+      end
+    end
+  end
+end

data/lib/logue/core/object_util.rb

@@ -0,0 +1,6 @@
+module Logue
+  module ObjectUtil
+    NONE = Object.new
+    def NONE.to_s; "<<<none>>>"; end
+  end
+end

data/lib/logue/elements/base_element.rb

@@ -0,0 +1,21 @@
+module Logue
+  class BaseElement
+    attr_reader :writer
+    attr_reader :context
+
+    def initialize context, writer
+      @context = context
+      @writer = writer
+    end
+
+    def write_msg_object msg, object
+      factory = ElementFactory.new @writer
+      element = factory.to_element msg, object, @context
+      element.write_element
+    end
+
+    def write_line str
+      @writer.write_line str
+    end
+  end
+end

data/lib/logue/elements/block_element.rb

@@ -0,0 +1,16 @@
+require 'logue/elements/base_element'
+
+module Logue
+  class BlockElement < BaseElement
+    def initialize msg, context, writer, &blk
+      super context, writer
+      @msg = msg
+      @blk = blk
+    end
+
+    def write_element
+      obj = @blk.call
+      write_msg_object @msg, obj
+    end
+  end
+end

data/lib/logue/elements/element.rb

@@ -0,0 +1,13 @@
+require 'logue/elements/base_element'
+
+module Logue
+  class Element < BaseElement
+    attr_reader :object
+
+    def initialize msg, object, context, writer
+      super context, writer
+      @msg = msg
+      @object = object
+    end
+  end
+end

data/lib/logue/elements/element_factory.rb

@@ -0,0 +1,50 @@
+require 'logue/elements/element'
+require 'logue/elements/msg_obj_element'
+require 'logue/elements/block_element'
+require 'logue/elements/hash_element'
+require 'logue/elements/struct_element'
+require 'logue/elements/indexed_element'
+require 'logue/elements/msg_element'
+require 'logue/core/object_util'
+
+module Logue
+  class ElementFactory
+    def initialize writer
+      @writer = writer
+    end
+
+    def to_element msg, obj, context
+      case obj
+      when Element
+        obj
+      when Struct
+        to_complex_element StructElement, msg, obj, context
+      when Hash
+        to_complex_element HashElement, msg, obj, context
+      when Enumerable
+        to_complex_element IndexedElement, msg, obj, context
+      else
+        to_msg_element msg, obj, context
+      end
+    end
+
+    def to_complex_element cls, msg, obj, context
+      if obj && context.include?(obj.object_id)
+        MsgObjElement.new msg, obj.object_id.to_s + " (recursed)", context, @writer
+      else
+        newlist = context.dup
+        newlist << obj.object_id
+        cls.new msg, obj, newlist, @writer
+      end
+    end
+
+    def to_msg_element msg, obj, context
+      # avoid using == on obj:
+      if obj.nil? || (obj.instance_of?(Object) && obj == ObjectUtil::NONE) || (obj.instance_of?(Symbol) && obj == :none)
+        MsgElement.new msg, context, @writer
+      else
+        MsgObjElement.new msg, obj, context, @writer
+      end
+    end
+  end
+end

data/lib/logue/elements/element_lines.rb

@@ -0,0 +1,23 @@
+require 'logue/core/base_writer'
+require 'logue/elements/element_factory'
+require 'logue/core/object_util'
+
+module Logue
+  class ElementLines
+    def initialize io, location = ""
+      @io = io
+      @factory = ElementFactory.new self
+      @location = location
+    end
+
+    def write_line str
+      lstr = @location + " " + str
+      @io.puts lstr
+    end
+
+    def add_msg_obj msg, obj, context = Array.new
+      element = @factory.to_element msg, obj, context
+      element.write_element
+    end
+  end
+end

data/lib/logue/elements/elements_log.rb

@@ -0,0 +1,21 @@
+require 'logue/log'
+require 'logue/elements/elements_writer'
+
+#
+# == ElementsLog
+#
+# ElementsLog uses the extended format for formatting complex elements instead
+# of using only their to-string methods.
+# 
+# See Log.
+#
+module Logue
+  class ElementsLog < Log
+    def self.reset
+      logger = Logger.new writer: ElementsWriter.new
+      Log.logger = logger
+    end
+
+    reset
+  end
+end

data/lib/logue/elements/elements_loggable.rb

@@ -0,0 +1,17 @@
+require 'logue/logger'
+require 'logue/log'
+require 'logue/core/base_loggable'
+
+module Logue
+  module ElementsLoggable
+    include BaseLoggable
+
+    def logger
+      @logger ||= Log.logger
+    end
+
+    def logger= logger
+      @logger = logger
+    end
+  end
+end

data/lib/logue/elements/elements_writer.rb

@@ -0,0 +1,33 @@
+require 'logue/core/base_writer'
+require 'logue/elements/element_lines'
+require 'logue/elements/block_element'
+require 'logue/core/object_util'
+
+module Logue
+  class ElementsWriter < BaseWriter
+    def write_msg_obj location, msg, obj, level
+      # we're not using the level, which at this point only is for colorizing output
+      lines = ElementLines.new @output, location
+      factory = ElementFactory.new lines
+      element = factory.to_element msg, obj, Array.new
+      write_element element
+    end
+
+    def write_msg_blk location, msg, level, &blk
+      # we're not using the level, which at this point only is for colorizing output
+      lines = ElementLines.new @output, location
+      element = BlockElement.new msg, Array.new, lines, &blk
+      write_element element
+    end
+
+    def write_block location, level, &blk
+      lines = ElementLines.new @output, location
+      element = BlockElement.new ObjectUtil::NONE, Array.new, lines, &blk
+      write_element element
+    end
+
+    def write_element element
+      element.write_element
+    end
+  end
+end

data/lib/logue/elements/enum_element.rb

@@ -0,0 +1,12 @@
+require 'logue/elements/element'
+
+module Logue
+  class EnumerableElement < Element
+    def write_enumerator enum
+      enum.each do |field, value|
+        newmsg = "#{@msg}[#{field}]"
+        write_msg_object newmsg, value
+      end
+    end
+  end
+end

data/lib/logue/elements/hash_element.rb

@@ -0,0 +1,9 @@
+require 'logue/elements/enum_element'
+
+module Logue
+  class HashElement < EnumerableElement
+    def write_element
+      write_enumerator @object.each
+    end
+  end
+end

data/lib/logue/elements/indexed_element.rb

@@ -0,0 +1,15 @@
+require 'logue/elements/enum_element'
+
+module Logue
+  class IndexedElement < EnumerableElement
+    def write_element
+      if @object.respond_to? :size
+        write_msg_object "#{@msg}.#", @object.size
+      end
+      @object.each_with_index do |value, index|
+        newmsg = "#{@msg}[#{index}]"
+        write_msg_object newmsg, value
+      end
+    end
+  end
+end

data/lib/logue/elements/msg_element.rb

@@ -0,0 +1,13 @@
+require 'logue/elements/element'
+
+module Logue
+  class MsgElement < Element
+    def initialize msg, context, writer
+      super msg, ObjectUtil::NONE, context, writer
+    end
+
+    def write_element
+      write_line @msg
+    end
+  end
+end