traceable 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3b33985a7f1cd981ee07372be082ea2686776086
-  data.tar.gz: 956815bb6c9baa2fb5d141497169aed860186b94
+  metadata.gz: 13c55b0d6931dd2f0f4184feeef4cd406888e010
+  data.tar.gz: 04e77dd75e7e855fd2cd7a1c9960fac5dfed38cd
 SHA512:
-  metadata.gz: a69ca83d50eafe13fea34bc927c5d41e5f5a46ead4b2b4ed438150f9f66a0edf80a86600e31934d7319e862ad4043a38a407237584be1c326351dd15c2fb3249
-  data.tar.gz: c8209b9f31551240e07ecc14dff517da72acaca75a6b6a76a83ede43252ee47c5d265bb910b2448761622d136e0223e279aa0e84d9fbd80a298031a444e9e5be
+  metadata.gz: 505830cf85e00c1a10191174f19fee91c60a0ee87bb2f08aec2b955b09076559854f785c07bd33ec3963e4cb2566838d2f98ad8c7aeae26623d99acd346dfd64
+  data.tar.gz: 9b257ae1d93c01b3f284f5bbcb4b5655f2beeba3340b0608497e953861ee15005c3d6f3839d46cfcd6bda153fa89c0f6d86e57c3894164dcf0b70203a0dd0756

data/lib/traceable/args.rb

@@ -24,37 +24,46 @@ module Traceable
     end
 
     MAX_STRING_LENGTH = 5000
-    TRUNC_STRING_LENGTH = MAX_STRING_LENGTH - 3
+    MAX_ARRAY_VALUES = 30
+    MAX_HASH_KEYS = 30
+
+    @max_string_length = MAX_STRING_LENGTH
+    @trunc_string_length = @max_string_length - 3
+    @max_array_values = MAX_ARRAY_VALUES
+    @max_hash_keys = MAX_HASH_KEYS
+
+    def self.set_config_limits(max_string_length:, max_array_values:, max_hash_keys:)
+      @max_string_length = max_string_length.nil? ? MAX_STRING_LENGTH : max_string_length
+      @trunc_string_length = [@max_string_length, 4].max - 3
+      @max_array_values = max_array_values.nil? ? MAX_ARRAY_VALUES : max_array_values
+      @max_hash_keys = max_hash_keys.nil? ? MAX_HASH_KEYS : max_array_values
+    end
 
     def self.format_string(val)
-      return val[0..TRUNC_STRING_LENGTH] + '...' if val.size > MAX_STRING_LENGTH
+      return val[0..@trunc_string_length] + '...' if val.size > @max_string_length
       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
+        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[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
+        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_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})"

data/lib/traceable/config.rb

@@ -6,20 +6,37 @@ module Traceable
   class Config
     attr_accessor :default_tags
     attr_accessor :logger
+    attr_accessor :max_string_length
+    attr_accessor :max_array_values
+    attr_accessor :max_hash_keys
 
     def initialize
       @logger = Logger.new(STDOUT)
       @logger.level = Logger::INFO
 
       @default_tags = {}
+
+      @max_string_length = Args::MAX_STRING_LENGTH
+      @max_array_values = Args::MAX_ARRAY_VALUES
+      @max_hash_keys = Args::MAX_HASH_KEYS
     end
   end
 
   def self.configure(&_)
     yield config
+    update_args_config
+    config
   end
 
   def self.config
     @config ||= Config.new
   end
+
+  def self.update_args_config
+    Args.set_config_limits(
+      max_string_length: config.max_string_length,
+      max_array_values: config.max_array_values,
+      max_hash_keys: config.max_hash_keys
+    )
+  end
 end

data/lib/traceable/version.rb

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

data/spec/traceable_args_spec.rb

@@ -1,6 +1,14 @@
 # frozen_string_literal: true
 
 RSpec.describe Traceable::Args do
+  before do
+    Traceable.configure do |config|
+      config.max_string_length = 2000
+      config.max_array_values = 10
+      config.max_hash_keys = 10
+    end
+  end
+
   describe '#args_to_tags' do
     class Foo
       class << self
@@ -27,14 +35,15 @@ RSpec.describe Traceable::Args do
   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] }
+  let(:long_string) { 'abcdefghijklmnopqrstuvwxyz'. * 100 }
+  let(:long_string_truncated) { long_string[0..1997] + '...' }
 
   describe '#format_value' do
-    let(:long_string) { 'abcdefghijklmnopqrstuvwxyz'. * 1000 }
     let(:number) { 1 }
 
     it 'truncates long strings' do
       expect(Traceable::Args.format_value(long_string))
-        .to eq(long_string[0..4997] + '...')
+        .to eq(long_string_truncated)
     end
 
     it 'returns simple values un-modified' do
@@ -59,5 +68,10 @@ RSpec.describe Traceable::Args do
         .to eq(a: 'a', b: 'b', c: 'c', d: 'd', e: 'e',
                f: 'f', g: 'g', h: 'h', i: 'i', ___: '...(17)')
     end
+
+    it 'truncates long strings in hashes' do
+      expect(Traceable::Args.format_hash_of_values(foo: long_string))
+        .to eq(foo: long_string_truncated)
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: traceable
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Jeremy Slade
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-18 00:00:00.000000000 Z
+date: 2018-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler