kronk 1.7.2 → 1.7.3

data/History.rdoc

@@ -1,3 +1,15 @@
+=== 1.7.3 / 2011-10-25
+
+* Bugfixes:
+
+  * Handling for parent paths with path matchers.
+
+  * Renamed Path::PathMatch to Path::Match.
+
+  * Fix for benchmark output under ruby 1.8.7.
+
+  * Documentation cleanup.
+
 === 1.7.2 / 2011-10-10
 
 * Bugfixes:

data/Manifest.txt

@@ -19,7 +19,7 @@ lib/kronk/diff/color_format.rb
 lib/kronk/diff/output.rb
 lib/kronk/path.rb
 lib/kronk/path/matcher.rb
-lib/kronk/path/path_match.rb
+lib/kronk/path/match.rb
 lib/kronk/path/transaction.rb
 lib/kronk/player.rb
 lib/kronk/player/benchmark.rb

data/lib/kronk.rb

@@ -14,7 +14,7 @@ require 'yaml'
 class Kronk
 
   # This gem's version.
-  VERSION = '1.7.2'
+  VERSION = '1.7.3'
 
   require 'kronk/constants'
   require 'kronk/queue_runner'
@@ -27,7 +27,7 @@ class Kronk
   require 'kronk/player/input_reader'
   require 'kronk/cmd'
   require 'kronk/path'
-  require 'kronk/path/path_match'
+  require 'kronk/path/match'
   require 'kronk/path/matcher'
   require 'kronk/path/transaction'
   require 'kronk/data_string'
@@ -354,7 +354,7 @@ class Kronk
 
     resp
 
-  rescue SocketError, Errno::ENOENT, Errno::ECONNREFUSED
+  rescue SocketError, SystemCallError
     raise NotFoundError, "#{uri} could not be found"
 
   rescue Timeout::Error

data/lib/kronk/cmd.rb

@@ -537,7 +537,7 @@ Parse and run diffs against data from live and cached http responses.
 
       exit 1 unless success
 
-    rescue Kronk::Exception, Errno::ECONNRESET => e
+    rescue Kronk::Exception, SystemCallError => e
       error e.message, e.backtrace
       exit 2
     end

data/lib/kronk/data_string.rb

@@ -15,13 +15,13 @@ class Kronk
   #   # }
   #
   #   dstr.meta[dstr.index("\"a\"")]
-  #   # /
+  #   # []
   #
   #   dstr.meta[dstr.index("\"foo\"")]
-  #   # /a
+  #   # ['a']
   #
   #   dstr.meta[dstr.index("\"two\"")]
-  #   # /c/1
+  #   # ['c', 1]
 
   class DataString < String
 

data/lib/kronk/diff.rb

@@ -45,7 +45,7 @@ class Kronk
       @diff_ary   = nil
       @char       = opts[:char] || /\r?\n/
       @meta       = []
-      @output     = Output.new self, opts
+      @output     = Output.new opts
     end
 
 
@@ -55,10 +55,10 @@ class Kronk
     #   str1 = "match1\nin str2\nmore str2\nmatch2\nstr2 val"
     #
     #   Diff.new(str1, str2).create_diff
-    #   ["match 1",
-    #    [[], ["in str2", "more str2"]],
-    #    "match 2",
-    #    [["str1 val"], ["str2 val"]]]
+    #   #=> ["match 1",
+    #   #   [[], ["in str2", "more str2"]],
+    #   #   "match 2",
+    #   #   [["str1 val"], ["str2 val"]]]
 
     def create_diff
       diff_ary = []
@@ -112,7 +112,7 @@ class Kronk
 
 
     ##
-    # Recursively finds common sequences between two arrays and returns
+    # Finds non-overlapping common sequences between two arrays and returns
     # them in the order they occur as an array of arrays:
     #   find_common arr1, arr2
     #   #=> [[size, arr1_index, arr2_index], [size, arr1_index, arr2_index],...]
@@ -145,10 +145,12 @@ class Kronk
 
     ##
     # Returns all common sequences between to arrays ordered by sequence length
-    # according to the following format:
+    # (including overlapping ones) according to the following format:
     #   [[[len1, ix, iy], [len1, ix, iy]],[[len2, ix, iy]]]
     #   # e.g.
     #   [nil,[[1,2,3],[1,2,5]],nil,[[3,4,5],[3,6,9]]
+    #
+    # Output is indexed by sequence size.
 
     def common_sequences arr1, arr2, &block
       sequences = []
@@ -190,22 +192,15 @@ class Kronk
     end
 
 
-    def yield_sequences sequences, dist=0, &block
-      while sequences.length > dist
-        item = sequences.pop
-        next unless item
-        item.each(&block)
-      end
-    end
-
-
     ##
-    # Returns a formatted output as a string.
+    # Returns a formatted output as a String.
 
-    def formatted opts={}
-      @output.render if any?
+    def formatted
+      ( @output.render diff_array, @meta if any? ).to_s
     end
 
+    alias to_s formatted
+
 
     ##
     # Returns true if any diff is found.
@@ -233,11 +228,14 @@ class Kronk
     alias to_a diff_array
 
 
-    ##
-    # Returns a diff string with the default format.
+    private
 
-    def to_s
-      formatted
+    def yield_sequences sequences, dist=0, &block # :nodoc:
+      while sequences.length > dist
+        item = sequences.pop
+        next unless item
+        item.each(&block)
+      end
     end
   end
 end

data/lib/kronk/diff/output.rb

@@ -13,6 +13,10 @@ class Kronk::Diff
       attr_accessor :context, :format, :lindex, :rindex, :llen, :rlen,
                     :lmeta, :rmeta
 
+      ##
+      # Create a new Section to render, with a formatter, lines column
+      # width, and start indexes for left and right side.
+
       def initialize format, line_num_width=nil, lindex=0, rindex=0
         @format  = format
         @cwidth  = line_num_width
@@ -27,6 +31,13 @@ class Kronk::Diff
       end
 
 
+      ##
+      # Append a line or diff section to the section.
+      # If obj is a String, common section is assumed, if obj is an Array,
+      # a diff section is assumed.
+      #
+      # Metadata is optional but must be an Array of 2 items if given.
+
       def add obj, meta=nil
         @lmeta, @rmeta = meta if meta && !@lmeta && !@rmeta
         @lmeta = ary_to_path @lmeta if Array === @rmeta
@@ -43,7 +54,37 @@ class Kronk::Diff
       end
 
 
-      def add_common obj
+      ##
+      # Create a Kronk::Path String from an Array. Used when the meta data
+      # given for either side of the diff is an Array.
+
+      def ary_to_path ary
+        "#{Kronk::Path::DCH}#{Kronk::Path.join ary}"
+      end
+
+
+      ##
+      # Build the section String output once all lines and meta has been
+      # added.
+
+      def render
+        cleft  = "#{@lindex+1},#{@llen}"
+        cright = "#{@rindex+1},#{@rlen}"
+
+        if @lmeta != @rmeta && @lmeta && @rmeta
+          cleft  << " " << @lmeta
+          cright << " " << @rmeta
+        else
+          info = @lmeta || @rmeta
+        end
+
+        [@format.context(cleft, cright, info), *@lines]
+      end
+
+
+      private
+
+      def add_common obj # :nodoc:
         @llen    += 1
         @rlen    += 1
         @context += 1
@@ -55,7 +96,7 @@ class Kronk::Diff
       end
 
 
-      def add_left obj
+      def add_left obj # :nodoc:
         @llen   += 1
         @context = 0
 
@@ -64,33 +105,13 @@ class Kronk::Diff
       end
 
 
-      def add_right obj
+      def add_right obj # :nodoc:
         @rlen   += 1
         @context = 0
 
         line_nums = @format.lines [nil, @rlen+@rindex], @cwidth if @cwidth
         @lines << "#{line_nums}#{@format.added obj}"
       end
-
-
-      def ary_to_path ary
-        "#{Kronk::Path::DCH}#{Kronk::Path.join ary}"
-      end
-
-
-      def render
-        cleft  = "#{@lindex+1},#{@llen}"
-        cright = "#{@rindex+1},#{@rlen}"
-
-        if @lmeta != @rmeta && @lmeta && @rmeta
-          cleft  << " " << @lmeta
-          cright << " " << @rmeta
-        else
-          info = @lmeta || @rmeta
-        end
-
-        [@format.context(cleft, cright, info), *@lines]
-      end
     end
 
 
@@ -122,9 +143,7 @@ class Kronk::Diff
     # :labels:: Array - Left and right names to display; default %w{left right}
     # :show_lines:: Boolean - Show lines in diff; default false
 
-    def initialize diff, opts={}
-      @diff = diff
-
+    def initialize opts={}
       @format =
         self.class.formatter(opts[:format] || Kronk.config[:diff_format]) ||
         AsciiFormat
@@ -140,46 +159,78 @@ class Kronk::Diff
 
       @show_lines = opts[:show_lines] || Kronk.config[:show_lines]
       @section    = false
-
-      lines1 = diff.str1.lines.count
-      lines2 = diff.str2.lines.count
-      @cwidth = (lines1 > lines2 ? lines1 : lines2).to_s.length
     end
 
 
-    def continue_section? i
+    ##
+    # Determine if index i is a part of a section to render, including
+    # surrounding context.
+
+    def section? i, diff_ary
        !@context ||
-        !!@diff.diff_array[i,@context+1].to_a.find{|da| Array === da}
+        !!diff_ary[i,@context+1].to_a.find{|da| Array === da}
     end
 
 
-    def start_section? i
-      !@section && continue_section?(i)
+    ##
+    # Determine if index i is the beginning of a diff section to render,
+    # including surrounding context.
+
+    def start_section? i, diff_ary
+      !@section && section?(i, diff_ary)
     end
 
 
-    def end_section? i
+    ##
+    # Determine if index i is the end of a diff section to render, including
+    # surrounding context.
+
+    def end_section? i, diff_ary
       @section &&
-        (i >= @diff.diff_array.length ||
-         !continue_section?(i) && @context && @section.context >= @context)
+        (i >= diff_ary.length ||
+         !section?(i, diff_ary) && @context && @section.context >= @context)
+    end
+
+
+    ##
+    # Determine the width of the line number column from a diff Array.
+
+    def line_col_width diff_ary
+      lines1, lines2 = diff_ary.inject([0,0]) do |prev, obj|
+        if Array === obj
+          [prev[0] + obj[0].length, prev[1] + obj[1].length]
+        else
+          [prev[0] + 1, prev[1] + 1]
+        end
+      end
+
+      (lines1 > lines2 ? lines1 : lines2).to_s.length
     end
 
 
-    def render force=false
+    ##
+    # Render a diff String from a diff Array, with optional metadata.
+    #
+    # The meta argument must be an Array of 2 Arrays, one for each side of
+    # the diff.
+
+    def render diff_ary, meta=[]
       output = []
       output << @format.head(*@labels)
 
       line1 = line2 = 0
-      lwidth = @show_lines && @cwidth
+      lwidth = line_col_width diff_ary if @show_lines
 
-      @diff.diff_array.each_with_index do |item, i|
-        @section = Section.new @format, lwidth, line1, line2 if start_section? i
-        @section.add item, @diff.meta[i] if @section
+      diff_ary.each_with_index do |item, i|
+        @section = Section.new @format, lwidth, line1, line2 if
+          start_section? i, diff_ary
+
+        @section.add item, meta[i] if @section
 
         line1 += Array === item ? item[0].length : 1
         line2 += Array === item ? item[1].length : 1
 
-        if end_section?(i+1)
+        if end_section?(i+1, diff_ary)
           output.concat @section.render
           @section = false
         end
@@ -187,7 +238,5 @@ class Kronk::Diff
 
       output.join(@join_ch)
     end
-
-    alias to_s render
   end
 end

data/lib/kronk/path.rb

@@ -122,6 +122,13 @@ class Kronk
     ##
     # Returns a path-keyed data hash. Be careful of mixed key types in hashes
     # as Symbols and Strings both use #to_s.
+    #
+    #   Path.pathed {'foo' => %w{thing bar}, 'fizz' => {'buzz' => 123}}
+    #   #=> {
+    #   #     '/foo/0' => 'thing',
+    #   #     '/foo/1' => 'bar',
+    #   #     '/fizz/buzz' => 123
+    #   #   }
 
     def self.pathed data, escape=true
       new_data = {}

data/lib/kronk/path/{path_match.rb → match.rb}

@@ -1,7 +1,7 @@
 ##
 # Represents the single match of a relative path against a data set.
 
-class Kronk::Path::PathMatch < Array
+class Kronk::Path::Match < Array
 
   attr_accessor :matches, :splat
 
@@ -12,6 +12,14 @@ class Kronk::Path::PathMatch < Array
   end
 
 
+  def [] *args
+    path_match = super
+    path_match.matches = @matches.dup
+    path_match.splat   = @splat.map{|key, sp| [key, sp.dup]}
+    path_match
+  end
+
+
   def append_splat id, key # :nodoc:
     if @splat[-1] && @splat[-1][0] == id
       @splat[-1][1] << key

data/lib/kronk/path/matcher.rb

@@ -31,6 +31,14 @@ class Kronk::Path::Matcher
 
 
   attr_reader :key, :value, :regex_opts
+  attr_accessor :recursive
+
+  ##
+  # New instance of Matcher. Options supported:
+  # :key:: String - The path item key to match.
+  # :value:: String - The path item value to match.
+  # :recursive:: Boolean - Look for path item recursively.
+  # :regex_opts:: Fixnum - representing the Regexp options.
 
   def initialize opts={}
     @regex_opts = opts[:regex_opts]
@@ -57,7 +65,7 @@ class Kronk::Path::Matcher
   ##
   # Universal iterator for Hash and Array like objects.
   # The data argument must either respond to both :each_with_index
-  # and :length, or respond to :each yielding a key/value pair.
+  # and :length, or respond to :has_key? and :each yielding a key/value pair.
 
   def each_data_item data, &block
     if data.respond_to?(:has_key?) && data.respond_to?(:each)
@@ -74,7 +82,7 @@ class Kronk::Path::Matcher
 
 
   ##
-  # Finds data with the given key and value matcher, optionally recursively.
+  # Finds data with the given key and value matcher, optionally recursive.
   # Yields data, key and path Array when block is given.
   # Returns an Array of path arrays.
 
@@ -82,8 +90,8 @@ class Kronk::Path::Matcher
     return [] unless Array === data || Hash === data
 
     paths  = []
-    path ||= Kronk::Path::PathMatch.new
-    path   = Kronk::Path::PathMatch.new path if path.class == Array
+    path ||= Kronk::Path::Match.new
+    path   = Kronk::Path::Match.new path if path.class == Array
 
     each_data_item data do |key, value|
       c_path = path.dup << key
@@ -182,12 +190,4 @@ class Kronk::Path::Matcher
       str
     end
   end
-
-
-  ##
-  # Should this matcher try and find a match recursively.
-
-  def recursive?
-    @recursive
-  end
 end

data/lib/kronk/player.rb

@@ -8,7 +8,7 @@ class Kronk
 
   class Player < QueueRunner
 
-    RESCUABLE = [Kronk::Exception, Errno::ECONNRESET, URI::InvalidURIError]
+    RESCUABLE = [Kronk::Exception, SystemCallError, URI::InvalidURIError]
 
     attr_accessor :input, :output
 
@@ -172,7 +172,7 @@ class Kronk
 
 
     ##
-    # Check if w6ce5e2ce're only processing a single case.
+    # Check if we're only processing a single case.
     # If so, yield a single item and return immediately.
 
     def single_request?

data/lib/kronk/player/benchmark.rb

@@ -53,7 +53,7 @@ class Kronk
         @slowest = time if !@slowest || @slowest < time
         @fastest = time if !@fastest || @fastest > time
 
-        log_path resp.uri.to_s, time if resp.uri
+        log_req resp.request, time if resp.request
 
         @total_bytes += resp.raw.bytes.count
 
@@ -63,13 +63,16 @@ class Kronk
       end
 
 
-      def log_path path, time
-        path = "/" if !path || path.empty?
-        @paths[path] ||= [0, 0]
-        pcount = @paths[path][1] + 1
-        @paths[path][0] = (@paths[path][0] * @paths[path][1] + time) / pcount
-        @paths[path][0] = @paths[path][0].round @precision
-        @paths[path][1] = pcount
+      def log_req req, time
+        uri = req.uri.dup
+        uri.query = nil
+        uri = "#{req.http_method} #{uri.to_s}"
+
+        @paths[uri] ||= [0, 0]
+        pcount = @paths[uri][1] + 1
+        @paths[uri][0] = (@paths[uri][0] * @paths[uri][1] + time) / pcount
+        @paths[uri][0] = @paths[uri][0].round @precision
+        @paths[uri][1] = pcount
       end
 
 
@@ -173,7 +176,7 @@ Request Percentages (ms)
         unless slowest_reqs.empty?
           out << "
 Avg. Slowest Requests (ms, #)
-#{slowest_reqs.map{|arr| "  #{arr[1]}  #{arr[0]}"}.join "\n" }"
+#{slowest_reqs.map{|arr| "  #{arr[1].inspect}  #{arr[0]}"}.join "\n" }"
         end
 
         out

data/lib/kronk/queue_runner.rb

@@ -1,5 +1,40 @@
 class Kronk
 
+  ##
+  # A basic queue and input processor that supports both a multi-threaded and
+  # evented backend (using EventMachine).
+  #
+  # Input is optional and specified by creating an input trigger
+  # (passing a block to on(:input)).
+  # Input will be used to fill queue as the queue gets depleted by
+  # being processed.
+  #
+  #   qrunner = QueueRunner.new
+  #   qrunner.concurrency = 20  # thread count
+  #   qrunner.number = 100      # process 100 queue items
+  #
+  #   file = File.open "example.log", "r"
+  #
+  #   qrunner.on :input do
+  #     if file.eof?
+  #       qrunner.finish
+  #     else
+  #       file.readline
+  #     end
+  #   end
+  #
+  #   qrunner.on :complete do
+  #     file.close
+  #     puts "DONE!"
+  #   end
+  #
+  #   # If running in multi-threaded mode, item mutex will also be passed
+  #   # as optional second argument.
+  #   qrunner.run do |queue_item|
+  #     # Do something with item.
+  #     # When running in evented mode, make sure this section is non-blocking.
+  #   end
+
   class QueueRunner
 
     ##
@@ -57,6 +92,17 @@ class Kronk
     end
 
 
+    ##
+    # Stop runner processing gracefully.
+
+    def finish
+      stop_input!
+      EM.stop if defined?(EM) && EM.reactor_running?
+      @threads.each{|t| t.join}
+      @threads.clear
+    end
+
+
     ##
     # Immediately end all runner processing and threads.
 
@@ -106,10 +152,7 @@ class Kronk
         @count += 1
       end
 
-      @threads.each{|t| t.join}
-      @threads.clear
-
-      stop_input!
+      finish
     end
 
 
@@ -136,7 +179,7 @@ class Kronk
         EM.add_periodic_timer do
           if finished?
             next if EM.connection_count > 0
-            kill
+            finish
             next
           end
 

data/test/test_path_match.rb

@@ -3,7 +3,7 @@ require 'test/test_helper'
 class TestPathMatch < Test::Unit::TestCase
 
   def setup
-    @pmatch = Kronk::Path::PathMatch.new %w{path to resource}
+    @pmatch = Kronk::Path::Match.new %w{path to resource}
     @pmatch.matches = %w{this is 4 foo}
 
     @splat = @pmatch.dup

data/test/test_path_matcher.rb

@@ -30,7 +30,7 @@ class TestPathMatcher < Test::Unit::TestCase
   def test_new
     assert_equal %r{\Afoo(.*)\Z},     @matcher.key
     assert_equal %r{\A(.*)bar(.*)\Z}, @matcher.value
-    assert !@matcher.recursive?
+    assert !@matcher.recursive
   end
 
 
@@ -158,7 +158,7 @@ class TestPathMatcher < Test::Unit::TestCase
                                        :recursive => true
     paths = matcher.find_in @data
     assert_equal [[:key1, :key1a, 3, :findme]], paths
-    assert_equal Kronk::Path::PathMatch, paths.first.class
+    assert_equal Kronk::Path::Match, paths.first.class
 
     assert_equal ["me", "in"], paths.first.matches
   end
@@ -176,7 +176,7 @@ class TestPathMatcher < Test::Unit::TestCase
     ]
 
     assert_equal expected_paths, (expected_paths | paths)
-    assert_equal Kronk::Path::PathMatch, paths.first.class
+    assert_equal Kronk::Path::Match, paths.first.class
 
     assert_equal ["findme"], paths.first.matches
   end
@@ -188,7 +188,7 @@ class TestPathMatcher < Test::Unit::TestCase
                                        :recursive => true
     paths = matcher.find_in @data
     assert_equal [[:key1, :key1a, 3, :findme]], paths
-    assert_equal Kronk::Path::PathMatch, paths.first.class
+    assert_equal Kronk::Path::Match, paths.first.class
 
     assert_equal ["findme", "in"], paths.first.matches
   end
@@ -211,7 +211,7 @@ class TestPathMatcher < Test::Unit::TestCase
     end
 
     assert_equal expected_paths, (expected_paths | paths)
-    assert_equal Kronk::Path::PathMatch, paths.first.class
+    assert_equal Kronk::Path::Match, paths.first.class
     assert_equal expected_paths, (expected_paths | paths.map{|p| p.matches})
   end
 

metadata

@@ -2,7 +2,7 @@
 name: kronk
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.7.2
+  version: 1.7.3
 platform: ruby
 authors: 
 - Jeremie Castagna
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-10 00:00:00 Z
+date: 2011-10-25 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: json
@@ -125,7 +125,7 @@ files:
 - lib/kronk/diff/output.rb
 - lib/kronk/path.rb
 - lib/kronk/path/matcher.rb
-- lib/kronk/path/path_match.rb
+- lib/kronk/path/match.rb
 - lib/kronk/path/transaction.rb
 - lib/kronk/player.rb
 - lib/kronk/player/benchmark.rb