kronk 1.0.1 → 1.0.2

data/History.txt

@@ -1,3 +1,17 @@
+=== 1.0.2 / 2010-12
+
+* Enhancements:
+
+  * Added support for custom diff formatters.
+
+  * Added verbose mode.
+
+  * Added diff count.
+
+* Bugfixes:
+
+  * Support for ruby-1.9.2
+
 === 1.0.1 / 2010-12-06
 
 * Bugfixes:

data/README.txt

@@ -7,7 +7,7 @@
 Kronk runs diffs against data from live and cached http responses. 
 Kronk was made possible by the sponsoring of AT&T Interactive.
 
-== FEATURES/PROBLEMS:
+== FEATURES:
 
 * Parse and diff data from http response body and/or headers.
 
@@ -17,10 +17,10 @@ Kronk was made possible by the sponsoring of AT&T Interactive.
 
 * Support for custom data parsers.
 
-== FUTURE:
-
 * Line numbered and custom diff output.
 
+== FUTURE:
+
 * Auto-queryer with optional param randomizing.
 
 * Support for test suites.

data/lib/kronk.rb

@@ -17,7 +17,7 @@ require 'yaml'
 class Kronk
 
   # This gem's version.
-  VERSION = '1.0.1'
+  VERSION = '1.0.2'
 
 
   require 'kronk/data_set'
@@ -49,6 +49,7 @@ class Kronk
   DEFAULT_CONFIG = {
     :content_types  => DEFAULT_CONTENT_TYPES.dup,
     :diff_format    => :ascii_diff,
+    :show_lines     => false,
     :cache_file     => DEFAULT_CACHE_FILE,
     :requires       => []
   }
@@ -103,7 +104,7 @@ class Kronk
   # Find a fully qualified ruby namespace/constant.
 
   def self.find_const namespace
-    consts = namespace.split "::"
+    consts = namespace.to_s.split "::"
     curr = self
 
     until consts.empty? do
@@ -120,8 +121,8 @@ class Kronk
   def self.parser_for content_type
     parser_pair =
       config[:content_types].select do |key, value|
-        (content_type =~ %r{#{key}}) && value
-      end
+        (content_type =~ %r{#{key}([^\w]|$)}) && value
+      end.to_a
 
     return if parser_pair.empty?
 
@@ -210,7 +211,8 @@ class Kronk
 
     if uri1 && uri2
       diff = compare uri1, uri2, options
-      puts diff.formatted(config[:diff_format])
+      puts diff.formatted
+      verbose "\n\nFound #{diff.count} diff(s).\n"
 
     elsif options[:raw]
       puts Request.retrieve(uri1, options).selective_string(options)
@@ -226,6 +228,14 @@ class Kronk
   end
 
 
+  ##
+  # Print string only if verbose
+
+  def self.verbose str
+    $stdout << "#{str}\n" if config[:verbose]
+  end
+
+
   ##
   # Parse ARGV
 
@@ -357,9 +367,20 @@ Kronk runs diffs against data from live and cached http responses.
       end
 
 
-      #opt.on('-v', '--verbose', 'Make the operation more talkative') do
-      #  options[:verbose] = true
-      #end
+      opt.on('--format STR', String,
+             'Use a custom diff formatter') do |value|
+        config[:diff_format] = value
+      end
+
+
+      opt.on('--lines', 'Show line numbers') do
+        config[:show_lines] = true
+      end
+
+
+      opt.on('-V', '--verbose', 'Make the operation more talkative') do
+        config[:verbose] = true
+      end
 
       opt.separator nil
     end

data/lib/kronk/diff.rb

@@ -7,6 +7,60 @@ class Kronk
 
   class Diff
 
+    ##
+    # Format diff with ascii
+
+    class AsciiFormat
+
+      def self.lines d_line, a_line, col_width
+        "#{d_line.to_s.rjust(col_width)}|#{a_line.to_s.rjust(col_width)} "
+      end
+
+
+      def self.deleted str
+        "- #{str}"
+      end
+
+
+      def self.added str
+        "+ #{str}"
+      end
+
+
+      def self.common str
+        "  #{str}"
+      end
+    end
+
+
+    ##
+    # Format diff with ascii
+
+    class ColorFormat
+
+      def self.lines d_line, a_line, col_width
+        d_line = d_line.to_s.rjust col_width
+        a_line = a_line.to_s.rjust col_width
+
+        "\033[7;31m#{d_line}\033[32m#{a_line.to_s.rjust(col_width)}\033[0m "
+      end
+
+
+      def self.deleted str
+        "\033[31m#{str}\033[0m"
+      end
+
+
+      def self.added str
+        "\033[32m#{str}\033[0m"
+      end
+
+
+      def self.common str
+        str
+      end
+    end
+
 
     ##
     # Creates a new diff from two data objects.
@@ -62,14 +116,26 @@ class Kronk
     end
 
 
-    attr_accessor :str1, :str2, :char, :format
+    ##
+    # 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, :formatter, :show_lines
 
     def initialize str1, str2, char=/\r?\n/
-      @str1 = str1
-      @str2 = str2
-      @char = char
-      @diff_ary = nil
-      @format = Kronk.config[:diff_format] || :ascii_diff
+      @str1       = str1
+      @str2       = str2
+      @char       = char
+      @diff_ary   = nil
+      @show_lines = Kronk.config[:show_lines]
+      @formatter  =
+        self.class.formatter(Kronk.config[:diff_format]) || AsciiFormat
     end
 
 
@@ -147,46 +213,57 @@ class Kronk
     # Returns a formatted output as a string.
     # Custom formats may be achieved by passing a block.
 
-    def formatted format=@format, join_char="\n", &block
-      block ||= method format
+    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|
-        block.call item.dup
-      end.flatten.join join_char
-    end
+        case item
+        when String
+          line1 = line1.next
+          line2 = line2.next
 
+          lines = format.lines line1, line2, width if options[:show_lines]
+          "#{lines}#{format.common item}"
 
-    ##
-    # Formats a single diff element to the default diff format.
+        when Array
+          item = item.dup
 
-    def ascii_diff item
-      case item
-      when String
-        "  #{item}"
-      when Array
-        item[0] = item[0].map{|str| "- #{str}"}
-        item[1] = item[1].map{|str| "+ #{str}"}
-        item
-      else
-        "  #{item.inspect}"
-      end
+          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
+
+          item
+        end
+      end.flatten.join options[:join_char]
     end
 
 
     ##
-    # Formats a single diff element with colors.
+    # Returns the number of diffs found.
 
-    def color_diff item
-      case item
-      when String
-        item
-      when Array
-        item[0] = item[0].map{|str| "\033[31m#{str}\033[0m"}
-        item[1] = item[1].map{|str| "\033[32m#{str}\033[0m"}
-        item
-      else
-        item.inspect
-      end
+    def count
+      diff_array.select{|i| Array === i }.length
     end
 
 

data/lib/kronk/request.rb

@@ -12,6 +12,8 @@ class Kronk
     # number of redirects left if it's an Integer.
 
     def self.follow_redirect resp, options={}
+      Kronk.verbose "Following redirect..."
+
       rdir = options[:follow_redirects]
       rdir = rdir - 1 if Integer === rdir && rdir > 0
 
@@ -35,8 +37,6 @@ class Kronk
     # :follow_redirects:: Integer/Bool - number of times to follow redirects
     # :headers:: Hash - extra headers to pass to the request
     # :http_method:: Symbol - the http method to use; defaults to :get
-    #
-    # TODO: Log request speed.
 
     def self.retrieve query, options={}
       resp =
@@ -72,6 +72,8 @@ class Kronk
     # Read http response from a file and return a HTTPResponse instance.
 
     def self.retrieve_file path, options={}
+      Kronk.verbose "\nReading file:\n#{path}\n"
+
       options = options.dup
 
       path = Kronk::DEFAULT_CACHE_FILE if path == :cache
@@ -107,6 +109,8 @@ class Kronk
     # to using a post request.
 
     def self.retrieve_uri uri, options={}
+      Kronk.verbose "\nRetrieving URL:  #{uri}#{options[:uri_suffix]}\n"
+
       options     = options.dup
       http_method = options.delete(:http_method)
       http_method ||= options[:data] ? :post : :get

data/lib/kronk/response.rb

@@ -84,6 +84,8 @@ class Kronk
       # the Content-Type, or will return the cached parsed body if available.
 
       def parsed_body parser=nil
+        @parsed_body ||= nil
+
         return @parsed_body if @parsed_body && !parser
         parser ||= Kronk.parser_for self['Content-Type']
 

data/test/test_diff.rb

@@ -291,36 +291,56 @@ STR
   end
 
 
+  def test_count
+    assert_equal 4, @diff.count
+  end
+
+
   def test_formatted
     assert_equal diff_302_301_str, @diff.formatted
   end
 
 
+  def test_formatted_lines
+    output = @diff.formatted :show_lines => true
+    assert_equal diff_302_301_str_lines, output
+  end
+
+
   def test_formatted_color
-    assert_equal diff_302_301_color, @diff.formatted(:color_diff)
+    assert_equal diff_302_301_color,
+      @diff.formatted(:formatter => Kronk::Diff::ColorFormat)
 
-    @diff.format = :color_diff
+    @diff.formatter = Kronk::Diff::ColorFormat
     assert_equal diff_302_301_color, @diff.formatted
   end
 
 
   def test_formatted_join_char
     expected = diff_302_301_str.gsub(/\n/, "\r\n")
-    assert_equal expected, @diff.formatted(:ascii_diff, "\r\n")
+    assert_equal expected,
+      @diff.formatted(
+        :formatter => Kronk::Diff::AsciiFormat,
+        :join_char => "\r\n")
   end
 
 
-  def test_formatted_block
-    str_diff = @diff.formatted do |item|
-      if Array === item
-        item[0].map!{|str| "<<<302<<< #{str}"}
-        item[1].map!{|str| ">>>301>>> #{str}"}
-        item
-      else
-        item.to_s
-      end
+  class CustomFormat
+    def self.added str
+      ">>>301>>> #{str}"
+    end
+
+    def self.deleted str
+      "<<<302<<< #{str}"
+    end
+
+    def self.common str
+      str.to_s
     end
+  end
 
+  def test_formatted_custom
+    str_diff = @diff.formatted :formatter => CustomFormat
     expected = diff_302_301_str.gsub(/^\+/, ">>>301>>>")
     expected = expected.gsub(/^\-/, "<<<302<<<")
     expected = expected.gsub(/^\s\s/, "")
@@ -397,6 +417,37 @@ STR
     str.strip
   end
 
+
+  def diff_302_301_str_lines
+    str = <<STR
+ 1|   - HTTP/1.1 302 Found
+ 2|   - Location: http://igoogle.com/
+  | 1 + HTTP/1.1 301 Moved Permanently
+  | 2 + Location: http://www.google.com/
+ 3| 3   Content-Type: text/html; charset=UTF-8
+ 4| 4   Date: Fri, 26 Nov 2010 16:14:45 GMT
+ 5| 5   Expires: Sun, 26 Dec 2010 16:14:45 GMT
+ 6| 6   Cache-Control: public, max-age=2592000
+ 7| 7   Server: gws
+ 8|   - Content-Length: 260
+  | 8 + Content-Length: 219
+ 9| 9   X-XSS-Protection: 1; mode=block
+10|10   
+11|11   <HTML><HEAD><meta http-equiv="content-type" content="text/html;charset=utf-8">
+12|   - <TITLE>302 Found</TITLE></HEAD><BODY>
+13|   - <H1>302 Found</H1>
+  |12 + <TITLE>301 Moved</TITLE></HEAD><BODY>
+  |13 + <H1>301 Moved</H1>
+14|14   The document has moved
+15|15   <A HREF="http://www.google.com/">here</A>.
+16|   - <A HREF="http://igoogle.com/">here</A>.
+17|16   </BODY></HTML>
+STR
+
+    str.rstrip
+  end
+
+
   def diff_302_301_color
     str = <<STR
 \033[31mHTTP/1.1 302 Found\033[0m

data/test/test_kronk.rb

@@ -12,6 +12,7 @@ class TestKronk < Test::Unit::TestCase
       },
       :cache_file  => Kronk::DEFAULT_CACHE_FILE,
       :diff_format => :ascii_diff,
+      :show_lines  => false,
       :requires    => []
     }
 
@@ -27,6 +28,7 @@ class TestKronk < Test::Unit::TestCase
       },
       :ignore_headers => ["Content-Type"],
       :cache_file  => Kronk::DEFAULT_CACHE_FILE,
+      :show_lines  => false,
       :requires    => [],
       :foo => :bar
     }
@@ -47,6 +49,7 @@ class TestKronk < Test::Unit::TestCase
       :diff_format => :ascii_diff,
       :cache_file  => Kronk::DEFAULT_CACHE_FILE,
       :requires    => [],
+      :show_lines  => false,
       :ignore_headers => ["Content-Type"],
       :foo => :bar
     }

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: kronk
 version: !ruby/object:Gem::Version 
-  hash: 21
   prerelease: false
   segments: 
   - 1
   - 0
-  - 1
-  version: 1.0.1
+  - 2
+  version: 1.0.2
 platform: ruby
 authors: 
 - Jeremie Castagna
@@ -15,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-06 00:00:00 -08:00
+date: 2010-12-07 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,7 +25,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 3
         - 1
@@ -42,7 +40,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 31
         segments: 
         - 1
         - 2
@@ -58,7 +55,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 29
         segments: 
         - 1
         - 3
@@ -74,7 +70,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 11
         segments: 
         - 0
         - 5
@@ -90,7 +85,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 15
         segments: 
         - 2
         - 0
@@ -106,7 +100,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 7
         segments: 
         - 2
         - 0
@@ -122,7 +115,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 47
         segments: 
         - 0
         - 9
@@ -138,7 +130,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 19
         segments: 
         - 2
         - 6
@@ -195,7 +186,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
+      hash: 1889693282695565885
       segments: 
       - 0
       version: "0"
@@ -204,7 +195,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"