traceable 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dc0fb1daa3bcf7f643a76c12767cb4b6879de019
-  data.tar.gz: a477c637eefd5b76b28105a83279d7faa5880650
+  metadata.gz: 88b2d98b02d74da456bfdd4cd8e778e32b59e726
+  data.tar.gz: c1b4c9f98b6681d6221c7445b30f98932d3b87dd
 SHA512:
-  metadata.gz: 3384130f5711e0c854c9b00d093b82cca25e8b9f7333c2be73b61d58eb741df9abab464ed07a5cbd3f50dafbaeee8b11aa062a1a9ef20d19699e5c06b9c883aa
-  data.tar.gz: 34a461846b43e0015c1e5c67b53eeb306233729270283f5c546d2e42140930bf54d4472b7726cb31b8502829c935e55f16be910ec7df039f7109f5215634634a
+  metadata.gz: 5a796c8e3c1fee4476dc61bca60c74dbbc8fbd70ada3212e9092cb87b4bb3c911d461fc7e98141ea4384a46b9992b19d3549f198cb2876cc198955cdb909dc8d
+  data.tar.gz: 354c89710e81545b518ccf44358405bbe2faa37cdee58cce1eae40020423e07fc557a844a68177b46b1986a6229f0635a55cdba2c37269809ea7997ad5755404

data/lib/traceable/args.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Traceable
+  class Args
+    # parameters comes from calling method(:foo).parameters,
+    # so it is an array of parameter descriptors e.g.
+    # [ [:req, :a], [:keyreq, :b] ]
+    # values is an array of values from an actual method invocation,
+    # so the two arrays are expected to match in length
+    def self.args_to_tags(parameters, values)
+      tags = {}
+      parameters.each_with_index do |param, i|
+        tags[param[1]] = format_value(values[i])
+      end
+      tags
+    end
+
+    def self.format_value(val)
+      return val.to_trace if val.respond_to? :to_trace
+      return format_array_of_values(val) if val.is_a? Array
+      return format_hash_of_values(val) if val.is_a? Hash
+      val
+    end
+
+    MAX_ARRAY_VALUES = 10
+
+    def self.format_array_of_values(val_array)
+      return format_array_of_values(truncated_array(val_array)) \
+        if val_array.size > MAX_ARRAY_VALUES
+      val_array.map { |v| format_value(v) }
+    end
+
+    def self.truncated_array(val_array)
+      subset = val_array[0..MAX_ARRAY_VALUES - 2]
+      subset << "...(#{val_array.size - subset.size})"
+      subset
+    end
+
+    MAX_HASH_KEYS = 10
+
+    def self.format_hash_of_values(val_hash)
+      return format_hash_of_values(truncated_hash(val_hash)) \
+        if val_hash.size > MAX_HASH_KEYS
+      Hash[val_hash.map { |k, v| [k, format_value(v)] }]
+    end
+
+    def self.truncated_hash(val_hash)
+      first_keys = val_hash.keys[0..MAX_HASH_KEYS - 2]
+      first_vals = first_keys.map { |k| val_hash[k] }
+      first_keys << :___
+      first_vals << "...(#{val_hash.size - first_vals.size})"
+      Hash[first_keys.zip(first_vals)]
+    end
+  end
+end

data/lib/traceable/class_methods.rb

@@ -29,13 +29,15 @@ module Traceable
     #     end
     #
     # The generated log message(s) will include the class name and method name
-    def traced_method(method_name)
-      klass = self
-      trace_name = "#{klass.name}##{method_name}"
-      orig_method = klass.instance_method(method_name)
+    def traced_method(method_name, include_args: true)
+      trace_name = "#{name}##{method_name}"
+      orig_method = instance_method(method_name)
+      params = orig_method.parameters
+      include_args = false if params.empty?
 
-      klass.send(:define_method, method_name) do |*args, &block|
-        trace trace_name do
+      send(:define_method, method_name) do |*args, &block|
+        trace_tags = include_args ? Traceable::Args.args_to_tags(params, args) : {}
+        trace(trace_name, **trace_tags) do
           if block
             orig_method.bind(self).call(*args) { |*block_args| block.call(*block_args) }
           else
@@ -47,7 +49,7 @@ module Traceable
       method_name
     end
 
-    # For the (relatively rare) case of calling trace() in a class method
+    # For the (relatively rare?) case of calling trace() in a class method
     # of a Traceable class - creates a new Tracer instance
     def trace(msg = nil, **tags)
       tracer = Tracer.new(Tracer.default_parent)

data/lib/traceable/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Traceable
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

data/lib/traceable.rb

@@ -54,6 +54,7 @@ module Traceable
   end
 end
 
+require 'traceable/args'
 require 'traceable/class_methods'
 require 'traceable/config'
 require 'traceable/tracer'

data/spec/traceable_args_spec.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+RSpec.describe Traceable::Args do
+  describe '#args_to_tags' do
+    class Foo
+      class << self
+        def m1(a, b); end
+      end
+    end
+
+    let(:m1_params) { Foo.method(:m1).parameters }
+
+    it 'converts simple params' do
+      expect(Traceable::Args.args_to_tags(m1_params, [1, 2]))
+        .to eq(a: 1, b: 2)
+    end
+
+    it 'converts array params' do
+      expect(Traceable::Args.args_to_tags(m1_params, [[1, 2], %i[a b c]]))
+        .to eq(a: [1, 2], b: %i[a b c])
+    end
+
+    it 'converts hash params' do
+      expect(Traceable::Args.args_to_tags(m1_params, [{ x: 1, y: 2 }, { 'z' => 3 }]))
+        .to eq(a: { x: 1, y: 2 }, b: { 'z' => 3 })
+    end
+  end
+
+  let(:letters) { %w[a b c d e f g h i j k l m n o p q r s t u v w x y z] }
+
+  describe '#format_array_of_values' do
+    it 'truncates long arrays' do
+      expect(Traceable::Args.format_array_of_values(letters))
+        .to eq(%w[a b c d e f g h i ...(17)])
+    end
+  end
+
+  describe '#format_hash_of_values' do
+    it 'truncates long hashes' do
+      h = Hash[letters.map { |l| [l.to_sym, l] }]
+      expect(Traceable::Args.format_hash_of_values(h))
+        .to eq(a: 'a', b: 'b', c: 'c', d: 'd', e: 'e',
+               f: 'f', g: 'g', h: 'h', i: 'i', ___: '...(17)')
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: traceable
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Jeremy Slade
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-23 00:00:00.000000000 Z
+date: 2018-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -116,11 +116,13 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/traceable.rb
+- lib/traceable/args.rb
 - lib/traceable/class_methods.rb
 - lib/traceable/config.rb
 - lib/traceable/tracer.rb
 - lib/traceable/version.rb
 - spec/spec_helper.rb
+- spec/traceable_args_spec.rb
 - spec/traceable_spec.rb
 homepage: https://github.com/instructure/inst-jobs-statsd
 licenses:
@@ -148,4 +150,5 @@ specification_version: 4
 summary: Instrument code with logging
 test_files:
 - spec/spec_helper.rb
+- spec/traceable_args_spec.rb
 - spec/traceable_spec.rb