sql_tagger 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9b7df0d78b3a94e79c9a8dbe4004b6b42a6b2ca2
-  data.tar.gz: 96f28433e8752ffd4c3ffd413ffdc8aa7078967b
+  metadata.gz: 6ba8b3d9228f6bc5892be02416589662b169071b
+  data.tar.gz: 8a27f05d376164274050b2ba2a773841cbf2b04d
 SHA512:
-  metadata.gz: b1505eab9c0b0f24dc4fc324b9d360d1e52810e957252c2eef814ba6996c384ce72b78fe173057a62a5d3d15603c08a3c43884979378e6d0f6d81df9f2673e93
-  data.tar.gz: b0d48bd55f0f659f5d71e494808dff705079b1726495a3f8ad22914c90e69197e880a2aa92d245f53a9d8875fbc7b680741989bc367d4c382af31d6e514b8717
+  metadata.gz: a14276e6e2746a2b685bc8d8ecfcf7096f12fbc6361d75663dba32d4dd790e448eaba61fbdbb73562435867caa4567be4e8193e32c3c8095c2a0632c11dd1a6c
+  data.tar.gz: 0a622ae346fc79fd05e147859e9dc4b4231f2cf7b986c888973dc84b83b847461f252f556a5f1241aa8e13d44023ed4200583a1e33d2333f282cd12f4d210ec5

data/VERSION

@@ -1 +1 @@
-0.0.4
+0.1.0

data/lib/sql_tagger.rb

@@ -7,6 +7,10 @@ class SqlTagger
     File.join(File.dirname(__FILE__), '..', 'VERSION')
   ).chomp.freeze
 
+  # @return [String, #call] a string or a proc which resolves to a string
+  #   to prefix the call trace tag
+  attr_accessor :custom_tag_prefix
+
   # @return [Regexp]
   #   regular expression used to match stack strings we should skip (usually
   #   because such stack strings aren't specific enough, like stack strings
@@ -33,7 +37,7 @@ class SqlTagger
     caller(2).each do |string|
       next if @exclusion_cache.member?(string)
       if string !~ @exclusion_pattern
-        return "/* #{string} */ #{sql}"
+        return "/* #{custom_tag_prefix_string} #{string} */ #{sql}"
       else
         @exclusion_cache.add(string)
       end
@@ -101,4 +105,17 @@ class SqlTagger
       end
     end
   end
+
+  private
+
+  # Returns a freshly resolved custom tag prefix string
+  #
+  # @return [String] string to prefix the call trace tag
+  def custom_tag_prefix_string
+    if @custom_tag_prefix.respond_to?(:call)
+      @custom_tag_prefix.call
+    else
+      @custom_tag_prefix
+    end
+  end
 end

data/spec/sql_tagger_spec.rb

@@ -21,7 +21,7 @@ RSpec.describe SqlTagger do
     end
 
     it 'skips stack strings that match @exclusion_pattern' do
-      expect(sql_tagger.tag(sql)).to eq("/* #{valid_stack_string} */ #{sql}")
+      expect(sql_tagger.tag(sql)).to eq("/*  #{valid_stack_string} */ #{sql}")
     end
 
     it 'returns the 1st stack string that does not match @exclusion_pattern' do
@@ -29,7 +29,7 @@ RSpec.describe SqlTagger do
         '/home/app/myapp/lib/document.rb:788',
         '/home/app/myapp/runner.rb:29'
       )
-      expect(sql_tagger.tag(sql)).to eq("/* #{valid_stack_string} */ #{sql}")
+      expect(sql_tagger.tag(sql)).to eq("/*  #{valid_stack_string} */ #{sql}")
     end
 
     it 'adds skipped stack strings into @exclusion_cache' do
@@ -45,7 +45,26 @@ RSpec.describe SqlTagger do
       correct_string = '/home/myapp/i.rb:2890'
       caller_result.push(correct_string)
       sql_tagger.exclusion_cache.add(valid_stack_string)
-      expect(sql_tagger.tag(sql)).to eq("/* #{correct_string} */ #{sql}")
+      expect(sql_tagger.tag(sql)).to eq("/*  #{correct_string} */ #{sql}")
+    end
+
+    context 'when @custom_tag_prefix is set as a proc' do
+      it 'prefixes the tag with a freshly resolved @custom_tag_prefix proc' do
+        string_stack = ['a', 'b']
+        sql_tagger.custom_tag_prefix = proc { string_stack.pop }
+        expect(sql_tagger.tag(sql)).
+          to eq("/* b #{valid_stack_string} */ #{sql}")
+        expect(sql_tagger.tag(sql)).
+          to eq("/* a #{valid_stack_string} */ #{sql}")
+      end
+    end
+
+    context 'when @custom_tag_prefix is set as a string' do
+      it 'prefixes the tag with the set @custom_tag_prefix' do
+        sql_tagger.custom_tag_prefix = 'a'
+        expect(sql_tagger.tag(sql)).
+          to eq("/* a #{valid_stack_string} */ #{sql}")
+      end
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sql_tagger
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors:
 - Toby Hsieh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-09 00:00:00.000000000 Z
+date: 2016-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec