kronk 1.5.4 → 1.6.0

data/History.rdoc

@@ -1,3 +1,17 @@
+=== 1.6.0 / 2011-09-11
+
+* Major Enhancements:
+
+  * Diff output limited context with a default of 3 lines.
+
+* Enhancements:
+
+  * Parsed headers output is a Hash of Strings instead of Arrays.
+
+* Bugfixes:
+
+  * Path transaction fixes for accessing and yielding already removed data.
+
 === 1.5.4 / 2011-09-02
 
 * Bugfixes:

data/Manifest.txt

@@ -12,7 +12,10 @@ lib/kronk/data_renderer.rb
 lib/kronk/diff.rb
 lib/kronk/diff/ascii_format.rb
 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/transaction.rb
 lib/kronk/player.rb
 lib/kronk/player/benchmark.rb
@@ -38,14 +41,17 @@ test/mocks/302_response.txt
 test/mocks/cookies.yml
 test/mocks/get_request.txt
 test/test_assertions.rb
-test/test_core_ext.rb
 test/test_cmd.rb
-test/test_helper_methods.rb
+test/test_core_ext.rb
+test/test_data_string.rb
 test/test_diff.rb
 test/test_helper.rb
+test/test_helper_methods.rb
 test/test_input_reader.rb
 test/test_kronk.rb
 test/test_path.rb
+test/test_path_match.rb
+test/test_path_matcher.rb
 test/test_player.rb
 test/test_request.rb
 test/test_request_parser.rb

data/README.rdoc

@@ -89,6 +89,12 @@ a regexp and values are evaluated by const_get.
     plist: PlistParser
     json:  JSON
 
+Number of lines of context to use for diff. Full diff is returned when
+set to false:
+
+  :context: 5     # show 5 lines before and after diff
+  :context: false # show the full file
+
 How to format the diff output. Supports the "special" values
 :ascii_diff and :color_diff or any string that will correctly
 resolve to a constant:

data/TODO.rdoc

@@ -0,0 +1,12 @@
+= TODO
+
+* Support data diffing for arrays (including data struct).
+
+* Allow for showing diffed sections of a diff only.
+  Do it by sorted paths? Example:
+    - "/path/foo": "value1"
+    + "/path/bar": "value1"
+
+* Should these Path case be handled as looking for a blank node or any node?
+    "/path/foo="
+    "/path/=foo"

data/lib/kronk.rb

@@ -14,7 +14,7 @@ require 'yaml'
 class Kronk
 
   # This gem's version.
-  VERSION = '1.5.4'
+  VERSION = '1.6.0'
 
   require 'kronk/constants'
   require 'kronk/player'
@@ -26,10 +26,13 @@ class Kronk
   require 'kronk/player/input_reader'
   require 'kronk/cmd'
   require 'kronk/path'
+  require 'kronk/path/path_match'
+  require 'kronk/path/matcher'
   require 'kronk/path/transaction'
   require 'kronk/data_renderer'
   require 'kronk/diff/ascii_format'
   require 'kronk/diff/color_format'
+  require 'kronk/diff/output'
   require 'kronk/diff'
   require 'kronk/response'
   require 'kronk/request'
@@ -277,7 +280,8 @@ class Kronk
     @responses = [res1, res2]
     @response  = res2
 
-    @diff = Diff.new str1, str2
+    opts = {:labels => [res1.uri, res2.uri]}.merge @options
+    @diff = Diff.new str1, str2, opts
   end
 
 

data/lib/kronk/cmd.rb

@@ -115,6 +115,12 @@ Parse and run diffs against data from live and cached http responses.
         end
 
 
+        opt.on('--context [NUM]', Integer,
+               'Show NUM context lines for diff') do |value|
+          options[:context] = value || Kronk.config[:context] || 3
+        end
+
+
         opt.on('-q', '--brief', 'Output only whether URI responses differ') do
           Kronk.config[:brief] = true
         end
@@ -126,6 +132,11 @@ Parse and run diffs against data from live and cached http responses.
         end
 
 
+        opt.on('--full', 'Show the full diff') do
+          options[:context] = false
+        end
+
+
         opt.on('-i', '--include [HEADER1,HEADER2]', Array,
                'Include all or given headers in response') do |value|
           options[:with_headers] ||= []
@@ -161,7 +172,7 @@ Parse and run diffs against data from live and cached http responses.
         end
 
 
-        opt.on('--irb', 'Start an IRB console') do
+        opt.on('--irb', 'Start an IRB console with the response') do
           options[:irb] = true
         end
 
@@ -182,6 +193,11 @@ Parse and run diffs against data from live and cached http responses.
         end
 
 
+        opt.on('--paths', 'Render data as path value pairs') do
+          Kronk.config[:render_paths] = true
+        end
+
+
         opt.on('--prev', 'Use last response to diff against') do
           options[:uris].unshift Kronk.config[:cache_file]
         end
@@ -280,7 +296,7 @@ Parse and run diffs against data from live and cached http responses.
                'Header to pass to the server request') do |value|
           options[:headers] ||= {}
 
-          key, value = value.split /:\s*/, 2
+          key, value = value.split(/:\s*/, 2)
           options[:headers][key] = value.to_s.strip
         end
 

data/lib/kronk/constants.rb

@@ -80,6 +80,7 @@ class Kronk
   DEFAULT_CONFIG = {
     :content_types  => DEFAULT_CONTENT_TYPES.dup,
     :cache_file     => DEFAULT_CACHE_FILE,
+    :context        => 3,
     :cookies_file   => DEFAULT_COOKIES_FILE,
     :default_host   => "http://localhost:3000",
     :diff_format    => :ascii_diff,

data/lib/kronk/data_renderer.rb

@@ -1,5 +1,62 @@
 class Kronk
 
+  ##
+  # A String with per-line metadata.
+
+  class DataString < String
+
+    attr_accessor :meta
+
+    def initialize str="", metadata=nil
+      @meta = [metadata].compact * str.length
+      super str
+    end
+
+
+    ##
+    # Add a string with metadata to the data string.
+
+    def append str, metadata=nil
+      dstr = self.class.new str
+      dstr.meta = [metadata] * str.length
+      self << dstr
+    end
+
+
+    def << str
+      if str.class == self.class
+        @meta.concat str.meta
+      else
+        @meta.concat([@meta.last] * str.length)
+      end
+      super str
+    end
+
+
+    def [] arg
+      dstr = self.class.new super
+      dstr.meta = @meta[arg]
+      dstr
+    end
+
+
+    def split pattern=$;, *more
+      arr      = super
+      i        = 0
+      interval = 0
+      interval = (self.length - arr.join.length) / (arr.length - 1) if
+        arr.length > 1
+
+      arr.map do |str|
+        ds = self.class.new str
+        ds.meta = @meta[i,str.length]
+        i += str.length + interval
+        ds
+      end
+    end
+  end
+
+
   ##
   # Creates ordered data strings for rendering to the output.
 
@@ -21,6 +78,7 @@ class Kronk
       end
     end
 
+
     ##
     # Returns a json data string that is diff-able, meaning sorted by
     # Hash keys when available.
@@ -40,52 +98,67 @@ class Kronk
     end
 
 
-    def self.ordered_data_string data, struct_only=false, indent=nil, &block
+    ##
+    # Turns a data set into an ordered string output for diff-ing.
+
+    def self.ordered_data_string data, struct_only=false, path=[], &block
       i_width  = Kronk.config[:indentation] || 1
-      indent ||= 0
-      indent += i_width
+      indent   = (path.length + 1) * i_width
+      pad      = " " * indent
+      path_str = Path.join path
 
       case data
 
       when Hash
-        return "{}" if data.empty?
-
-        output = "{\n"
+        return DataString.new("{}", path_str) if data.empty?
+        output = DataString.new "{\n", path_str
 
         sorted_keys = sort_any data.keys
 
         data_values =
           sorted_keys.map do |key|
-            value   = data[key]
-            pad     = " " * indent
-            subdata = ordered_data_string value, struct_only, indent, &block
-            "#{pad}#{ yield(:key, key) }#{ yield(:key_assign) } #{subdata}"
+            value    = data[key]
+            new_path = path.dup << key
+            subdata  = ordered_data_string value, struct_only, new_path, &block
+            line     = "#{pad}#{ yield(:key, key) }#{ yield(:key_assign) } "
+            line     = DataString.new line, path_str
+            line << subdata
           end
 
-        output << data_values.join(",\n") << "\n"
-        output << "#{" " * (indent - i_width)}}"
+        data_values.each_with_index do |val, i|
+          val << "," unless i == data_values.length - 1
+          output << val << "\n"
+        end
 
-      when Array
-        return "[]" if data.empty?
+        output.append(("#{" " * (indent - i_width)}}"), path_str)
 
-        output = "[\n"
+      when Array
+        return DataString.new("[]", path_str) if data.empty?
+        output = DataString.new "[\n", path_str
 
         data_values =
-          data.map do |value|
-            pad = " " * indent
-            "#{pad}#{ordered_data_string value, struct_only, indent, &block}"
+          (0...data.length).map do |key|
+            value    = data[key]
+            new_path = path.dup << key
+            subdata  = ordered_data_string value, struct_only, new_path, &block
+            line     = DataString.new pad, path_str
+            line << subdata
           end
 
-        output << data_values.join(",\n") << "\n"
-        output << "#{" " * (indent - i_width)}]"
+        data_values.each_with_index do |val, i|
+          val << "," unless i == data_values.length - 1
+          output << val << "\n"
+        end
+
+        output.append(("#{" " * (indent - i_width)}]"), path_str)
 
       else
-        struct_only ? yield(:struct, data) : yield(:value, data)
+        output = struct_only ? yield(:struct, data) : yield(:value, data)
+        DataString.new(output.to_s, path_str)
       end
     end
 
 
-
     ##
     # Sorts an array of any combination of string, integer, or symbols.
 

data/lib/kronk/diff.rb

@@ -9,9 +9,9 @@ class Kronk
     ##
     # Creates a new diff from two data objects.
 
-    def self.new_from_data data1, data2, options={}
-      new ordered_data_string(data1, options[:struct]),
-          ordered_data_string(data2, options[:struct])
+    def self.new_from_data data1, data2, opts={}
+      new ordered_data_string(data1, opts[:struct]),
+          ordered_data_string(data2, opts[:struct]), opts
     end
 
 
@@ -20,6 +20,8 @@ class Kronk
     # Hash keys when available.
 
     def self.ordered_data_string data, struct_only=false
+      data = Kronk::Path.pathed(data) if Kronk.config[:render_paths]
+
       case Kronk.config[:render_lang].to_s
       when 'ruby' then DataRenderer.ruby(data, struct_only)
       else
@@ -32,7 +34,7 @@ class Kronk
     # Adds line numbers to each lines of a String.
 
     def self.insert_line_nums str, formatter=nil
-      format = Diff.formatter formatter || Kronk.config[:diff_format]
+      format = Diff::Output.formatter formatter || Kronk.config[:diff_format]
 
       out   = ""
       width = str.lines.count.to_s.length
@@ -45,26 +47,14 @@ class Kronk
     end
 
 
-    ##
-    # Returns a formatter from a symbol or string. Returns nil if not found.
-
-    def self.formatter name
-      return AsciiFormat if name == :ascii_diff
-      return ColorFormat if name == :color_diff
-      Kronk.find_const name rescue name
-    end
-
+    attr_accessor :str1, :str2, :char, :output
 
-    attr_accessor :str1, :str2, :char, :formatter, :show_lines
-
-    def initialize str1, str2, char=/\r?\n/
+    def initialize str1, str2, opts={}
       @str1       = str1
       @str2       = str2
-      @char       = char
       @diff_ary   = nil
-      @show_lines = Kronk.config[:show_lines]
-      @formatter  =
-        self.class.formatter(Kronk.config[:diff_format]) || AsciiFormat
+      @char       = opts[:char] || /\r?\n/
+      @output     = Output.new self, opts
     end
 
 
@@ -81,6 +71,7 @@ class Kronk
 
     def create_diff
       diff_ary = []
+      return diff_ary if @str1.empty? && @str2.empty?
 
       arr1 = @str1.split @char
       arr2 = @str2.split @char
@@ -207,54 +198,17 @@ class Kronk
 
     ##
     # Returns a formatted output as a string.
-    # Supported options are:
-    # :join_char:: String - The string used to join lines; default "\n"
-    # :show_lines:: Boolean - Insert line numbers or not; default @show_lines
-    # :formatter:: Object - The formatter to use; default @formatter
-
-    def formatted options={}
-      options = {
-        :join_char  => "\n",
-        :show_lines => @show_lines,
-        :formatter  => @formatter
-      }.merge options
-
-      format = options[:formatter]
-
-      line1 = line2 = 0
 
-      lines1 = @str1.lines.count
-      lines2 = @str2.lines.count
-
-      width = (lines1 > lines2 ? lines1 : lines2).to_s.length
-
-      diff_array.map do |item|
-        case item
-        when String
-          line1 = line1.next
-          line2 = line2.next
-
-          lines = format.lines [line1, line2], width if options[:show_lines]
-          "#{lines}#{format.common item}"
+    def formatted opts={}
+      @output.render if any?
+    end
 
-        when Array
-          item = item.dup
 
-          item[0] = item[0].map do |str|
-            line1 = line1.next
-            lines = format.lines [line1, nil], width if options[:show_lines]
-            "#{lines}#{format.deleted str}"
-          end
-
-          item[1] = item[1].map do |str|
-            line2 = line2.next
-            lines = format.lines [nil, line2], width if options[:show_lines]
-            "#{lines}#{format.added str}"
-          end
+    ##
+    # Returns true if any diff is found.
 
-          item
-        end
-      end.flatten.join options[:join_char]
+    def any?
+      !!diff_array.find{|i| Array === i }
     end