kronk 1.0.2 → 1.0.3

data/History.txt

@@ -1,4 +1,18 @@
-=== 1.0.2 / 2010-12
+=== 1.0.3 / 2010-12-09
+
+* Enhancements:
+
+  * Supports overriding the parser from the command line.
+
+  * Support for ignoring or collecting parents of matched data paths.
+
+  * Support for uri-specific options in the .kronk config.
+
+* Bugfixes:
+
+  * Lines are displayed for non-diff requests.
+
+=== 1.0.2 / 2010-12-07
 
 * Enhancements:
 

data/Rakefile

@@ -8,13 +8,13 @@ Hoe.plugin :isolate
 Hoe.spec 'kronk' do
   developer('Jeremie Castagna', 'yaksnrainbows@gmail.com')
 
-  self.extra_deps << ['plist',         '>=3.1.0']
-  self.extra_deps << ['json',          '>=1.2.0']
-  self.extra_deps << ['nokogiri',      '>=1.3.3']
-  self.extra_deps << ['i18n',          '>=0.5.0']
+  self.extra_deps << ['plist',         '~>3.1.0']
+  self.extra_deps << ['json',          '~>1.2']
+  self.extra_deps << ['nokogiri',      '~>1.3']
+  self.extra_deps << ['i18n',          '~>0.5']
   self.extra_deps << ['activesupport', '>=2.0.0']
 
-  self.extra_dev_deps << ['mocha', '>=0.9.10']
+  self.extra_dev_deps << ['mocha', '~>0.9.10']
 end
 
 # vim: syntax=ruby

data/lib/kronk.rb

@@ -17,7 +17,7 @@ require 'yaml'
 class Kronk
 
   # This gem's version.
-  VERSION = '1.0.2'
+  VERSION = '1.0.3'
 
 
   require 'kronk/data_set'
@@ -51,7 +51,8 @@ class Kronk
     :diff_format    => :ascii_diff,
     :show_lines     => false,
     :cache_file     => DEFAULT_CACHE_FILE,
-    :requires       => []
+    :requires       => [],
+    :uri_options    => {}
   }
 
 
@@ -69,6 +70,7 @@ class Kronk
   def self.load_config filepath=DEFAULT_CONFIG_FILE
     conf          = YAML.load_file DEFAULT_CONFIG_FILE
     content_types = conf.delete :content_types
+    uri_options   = conf.delete :uri_options
 
     if conf[:requires]
       requires = [*conf.delete(:requires)]
@@ -76,6 +78,8 @@ class Kronk
       self.config[:requires].concat requires
     end
 
+    self.config[:uri_options].merge! uri_options if uri_options
+
     self.config[:content_types].merge!(content_types) if content_types
     self.config.merge! conf
   end
@@ -132,6 +136,19 @@ class Kronk
   end
 
 
+  ##
+  # Returns config-defined options for a given uri.
+  # Returns empty Hash if none found.
+
+  def self.options_for_uri uri
+    config[:uri_options].each do |key, options|
+      return options if uri == key || uri =~ %r{#{key}}
+    end
+
+    Hash.new
+  end
+
+
   ##
   # Make requests, parse the responses and compare the data.
   # If the second argument is omitted or is passed :cache, will
@@ -142,8 +159,10 @@ class Kronk
   # :data:: Hash/String - the data to pass to the http request
   # :headers:: Hash - extra headers to pass to the request
   # :http_method:: Symbol - the http method to use; defaults to :get
+  # :only_data:: String/Array - extracts the data from given data paths
   # :ignore_data:: String/Array - defines which data points to exclude
   # :with_headers:: Bool/String/Array - defines which headers to include
+  # :parser:: Object - The parser to use for the body; default nil
   # :raw:: Bool - run diff on raw strings
   #
   # Returns a diff object.
@@ -164,10 +183,13 @@ class Kronk
   # Return a diff object from two responses' raw data.
 
   def self.raw_diff query1, query2, options={}
-    resp1 = Request.retrieve query1, options
-    resp2 = Request.retrieve query2, options
+    opts1 = options.merge options_for_uri(query1)
+    opts2 = options.merge options_for_uri(query2)
 
-    Diff.new resp1.selective_string(options), resp2.selective_string(options)
+    resp1 = Request.retrieve query1, opts1
+    resp2 = Request.retrieve query2, opts2
+
+    Diff.new resp1.selective_string(opts1), resp2.selective_string(opts2)
   end
 
 
@@ -175,11 +197,14 @@ class Kronk
   # Return a diff object from two parsed responses.
 
   def self.data_diff query1, query2, options={}
-    resp1 = Request.retrieve query1, options
-    resp2 = Request.retrieve query2, options
+    opts1 = options.merge options_for_uri(query1)
+    opts2 = options.merge options_for_uri(query2)
+
+    resp1 = Request.retrieve query1, opts1
+    resp2 = Request.retrieve query2, opts2
 
-    Diff.new_from_data resp1.selective_data(options),
-                       resp2.selective_data(options),
+    Diff.new_from_data resp1.selective_data(opts1),
+                       resp2.selective_data(opts2),
                        options
   end
 
@@ -215,11 +240,19 @@ class Kronk
       verbose "\n\nFound #{diff.count} diff(s).\n"
 
     elsif options[:raw]
-      puts Request.retrieve(uri1, options).selective_string(options)
+      options = options.merge options_for_uri(uri1)
+
+      out = Request.retrieve(uri1, options).selective_string options
+      out = Diff.insert_line_nums out if config[:show_lines]
+      puts out
 
     else
+      options = options.merge options_for_uri(uri1)
+
       data = Request.retrieve(uri1, options).selective_data options
-      puts Diff.ordered_data_string(data, options[:struct])
+      out  = Diff.ordered_data_string data, options[:struct]
+      out  = Diff.insert_line_nums out if config[:show_lines]
+      puts out
     end
 
   rescue Request::NotFoundError, Response::MissingParser => e
@@ -246,7 +279,7 @@ class Kronk
       :uris            => []
     }
 
-    options[:only_data], options[:ignore_data] = parse_data_path_args argv
+    options = parse_data_path_args options, argv
 
     opts = OptionParser.new do |opt|
       opt.program_name = File.basename $0
@@ -269,6 +302,8 @@ Kronk runs diffs against data from live and cached http responses.
 
   Arguments after -- will be used to focus the diff on specific data points.
   If the data paths start with a '-' the matched data points will be removed.
+  If the data paths start with a ":" the parent of the matched data is used.
+  The ':' and '-' modifiers may be used together in that order (':-').
 
   Options:
       STR
@@ -378,6 +413,12 @@ Kronk runs diffs against data from live and cached http responses.
       end
 
 
+      opt.on('--parser STR', String,
+             'Override default parser') do |value|
+        options[:parser] = value
+      end
+
+
       opt.on('-V', '--verbose', 'Make the operation more talkative') do
         config[:verbose] = true
       end
@@ -404,23 +445,27 @@ Kronk runs diffs against data from live and cached http responses.
   # Searches ARGV and returns data paths to add or exclude in the diff.
   # Returns the array [only_paths, except_paths]
 
-  def self.parse_data_path_args argv
-    return unless argv.include? "--"
+  def self.parse_data_path_args options, argv
+    return options unless argv.include? "--"
 
     data_paths = argv.slice! argv.index("--")..-1
     data_paths.shift
 
-    only_paths   = nil
-    except_paths = nil
-
     data_paths.each do |path|
       if path[0,1] == "-"
-        (except_paths ||= []) << path[1..-1]
+        (options[:ignore_data] ||= []) << path[1..-1]
+
+      elsif path[0,2] == ":-"
+        (options[:ignore_data_with] ||= []) << path[2..-1]
+
+      elsif path[0,1] == ":"
+        (options[:only_data_with] ||= []) << path[1..-1]
+
       else
-        (only_paths ||= []) << path
+        (options[:only_data] ||= []) << path
       end
     end
 
-    [only_paths, except_paths]
+    options
   end
 end

data/lib/kronk/data_set.rb

@@ -12,10 +12,55 @@ class Kronk
     end
 
 
+    ##
+    # Retrieves the data at the given path array.
+
+    def data_at_path path
+      self.class.data_at_path @data, path
+    end
+
+
+    ##
+    # Checks if data is available at the given path.
+
+    def data_at_path? path
+      self.class.data_at_path? @data, path
+    end
+
+
+    ##
+    # Modify the data object by passing inclusive or exclusive data paths.
+    # Supports the following options:
+    # :only_data:: String/Array - keep data with that matches the paths
+    # :only_data_with:: String/Array - keep data with a matched child
+    # :ignore_data:: String/Array - remove data with that matches the paths
+    # :ignore_data_with:: String/Array - remove data with a matched child
+    #
+    # Note: the data is processed in the following order:
+    # * only_data_with
+    # * ignore_data_with
+    # * only_data
+    # * ignore_data
+
+    def modify options
+      collect_data_points options[:only_data_with], true if
+        options[:only_data_with]
+
+      delete_data_points options[:ignore_data_with], true if
+        options[:ignore_data_with]
+
+      collect_data_points options[:only_data]  if options[:only_data]
+
+      delete_data_points options[:ignore_data] if options[:ignore_data]
+
+      @data
+    end
+
+
     ##
     # Keep only specific data points from the data structure.
 
-    def collect_data_points data_paths
+    def collect_data_points data_paths, affect_parent=false
       new_data = @data.class.new
 
       [*data_paths].each do |data_path|
@@ -26,8 +71,13 @@ class Kronk
 
           path.each_with_index do |key, i|
 
-            if i == path.length - 1
+            if i == path.length - 1 && !affect_parent
               new_curr_data[key] = curr_data[key]
+
+            elsif i == path.length - 2 && affect_parent
+              new_curr_data[key] = curr_data[key]
+              break
+
             else
               new_curr_data[key] ||= curr_data[key].class.new
               new_curr_data        = new_curr_data[key]
@@ -44,12 +94,19 @@ class Kronk
     ##
     # Remove specific data points from the data structure.
 
-    def delete_data_points data_paths
+    def delete_data_points data_paths, affect_parent=false
       [*data_paths].each do |data_path|
-        find_data data_path do |obj, k, p|
-          case obj
-          when Hash  then obj.delete k
-          when Array then obj.delete_at k
+        find_data data_path do |obj, k, path|
+
+          if affect_parent && data_at_path?(path)
+            parent_data = data_at_path path[0..-3]
+            del_method  = Array === parent_data ? :delete_at : :delete
+
+            parent_data.send del_method, path[-2]
+
+          else
+            del_method = Array === obj ? :delete_at : :delete
+            obj.send del_method, k
           end
         end
       end
@@ -100,6 +157,33 @@ class Kronk
     end
 
 
+    ##
+    # Checks if data is available at the given path.
+
+    def self.data_at_path? data, path
+      data_at_path(data, path)
+      true
+
+    rescue NoMethodError, TypeError
+      false
+    end
+
+
+    ##
+    # Retrieve the data at the given path array location.
+
+    def self.data_at_path data, path
+      curr = data
+      path.each do |p|
+        raise TypeError, "Expected instance of Array or Hash" unless
+          Array === curr || Hash === curr
+        curr = curr[p]
+      end
+
+      curr
+    end
+
+
     ##
     # Parses a given data point and returns an array with the following:
     # - Key to match
@@ -175,6 +259,8 @@ class Kronk
         found = match_data_item(mkey, key) &&
                 match_data_item(mvalue, value)
 
+        #puts "Found: #{data.inspect} #{mkey.inspect} -> #{key.inspect}" if found
+
         yield data, key, curr_path if found
         yield_data_points data[key], mkey, mvalue, true, curr_path, &block if
           recursive

data/lib/kronk/diff.rb

@@ -12,8 +12,13 @@ class Kronk
 
     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)} "
+      def self.lines line_nums, col_width
+        out =
+          [*line_nums].map do |lnum|
+            lnum.to_s.rjust col_width
+          end.join "|"
+
+        "#{out} "
       end
 
 
@@ -38,11 +43,13 @@ class Kronk
 
     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
+      def self.lines line_nums, col_width
+        out =
+          [*line_nums].map do |lnum|
+            lnum.to_s.rjust col_width
+          end.join "\033[32m"
 
-        "\033[7;31m#{d_line}\033[32m#{a_line.to_s.rjust(col_width)}\033[0m "
+        "\033[7;31m#{out}\033[0m "
       end
 
 
@@ -116,6 +123,23 @@ class Kronk
     end
 
 
+    ##
+    # 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]
+
+      out   = ""
+      width = str.lines.count.to_s.length
+
+      str.split("\n").each_with_index do |line, i|
+        out << "#{format.lines(i+1, width)}#{line}\n"
+      end
+
+      out
+    end
+
+
     ##
     # Returns a formatter from a symbol or string. Returns nil if not found.
 
@@ -235,7 +259,7 @@ class Kronk
           line1 = line1.next
           line2 = line2.next
 
-          lines = format.lines line1, line2, width if options[:show_lines]
+          lines = format.lines [line1, line2], width if options[:show_lines]
           "#{lines}#{format.common item}"
 
         when Array
@@ -243,13 +267,13 @@ class Kronk
 
           item[0] = item[0].map do |str|
             line1 = line1.next
-            lines = format.lines line1, nil, width if options[:show_lines]
+            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.lines [nil, line2], width if options[:show_lines]
             "#{lines}#{format.added str}"
           end
 

data/lib/kronk/response.rb

@@ -87,6 +87,11 @@ class Kronk
         @parsed_body ||= nil
 
         return @parsed_body if @parsed_body && !parser
+
+        if String === parser
+          parser = Kronk.parser_for(parser) || Kronk.find_const(parser)
+        end
+
         parser ||= Kronk.parser_for self['Content-Type']
 
         raise MissingParser,
@@ -165,6 +170,7 @@ class Kronk
       # the response. Supports the following options:
       # :no_body:: Bool - Don't return the body; default nil
       # :with_headers:: Bool/String/Array - Return headers; default nil
+      # :parser:: Object - The parser to use for the body; default nil
       # :ignore_data:: String/Array - Removes the data from given data paths
       # :only_data:: String/Array - Extracts the data from given data paths
 
@@ -172,12 +178,7 @@ class Kronk
         data = nil
 
         unless options[:no_body]
-          ds = DataSet.new parsed_body
-
-          ds.collect_data_points options[:only_data]  if options[:only_data]
-          ds.delete_data_points options[:ignore_data] if options[:ignore_data]
-
-          data = ds.data
+          data = DataSet.new(parsed_body(options[:parser])).modify options
         end
 
         if options[:with_headers]

data/test/test_data_set.rb

@@ -31,6 +31,52 @@ class TestDataSet < Test::Unit::TestCase
   end
 
 
+  def test_modify_only_data
+    data = @dataset_mock.modify :only_data => "subs/1"
+    assert_equal({"subs" => [nil, "b"]}, data)
+  end
+
+
+  def test_modify_ignore_data
+    data = @dataset_mock.modify :ignore_data => "subs/1"
+
+    expected = mock_data
+    expected['subs'].delete_at 1
+
+    assert_equal expected, data
+  end
+
+
+  def test_modify_only_data
+    data = @dataset_mock.modify :only_data => "subs/1"
+    assert_equal({"subs" => [nil, "b"]}, data)
+  end
+
+
+  def test_modify_only_and_ignored_data
+    data = @dataset_mock.modify :ignore_data => "subs/1", :only_data => "subs/1"
+    assert_equal({"subs" => [nil]}, data)
+  end
+
+
+  def test_collect_data_points_affect_parent_array
+    data = @dataset_mock.collect_data_points "**=(A|a)?", true
+
+    expected = {
+      "root" => [nil, ["A1", "A2"]],
+      "subs" => ["a", "b"]
+    }
+
+    assert_equal expected, data
+  end
+
+
+  def test_collect_data_points_affect_parent_hash
+    data = @dataset_mock.collect_data_points "**=bar?", true
+    assert_equal({"tests"=>{:foo=>:bar, "test"=>[[1, 2], 2.123]}}, data)
+  end
+
+
   def test_collect_data_points_single
     data = @dataset_mock.collect_data_points "subs/1"
     assert_equal({"subs" => [nil, "b"]}, data)
@@ -69,6 +115,47 @@ class TestDataSet < Test::Unit::TestCase
   end
 
 
+  def test_delete_data_points_affect_parent_array
+    data = @dataset_mock.delete_data_points "**/test/0/*", true
+
+    expected = mock_data
+    expected['root'][3]['test'].delete_at 0
+    expected['tests']['test'].delete_at 0
+
+    assert_equal expected, data
+  end
+
+
+  def test_delete_data_points_affect_parent_array_value
+    data = @dataset_mock.delete_data_points "**/test/0/*=D*", true
+
+    expected = mock_data
+    expected['root'][3]['test'].delete_at 0
+
+    assert_equal expected, data
+  end
+
+
+  def test_delete_data_points_affect_parent_hash
+    data = @dataset_mock.delete_data_points "subs/1", true
+
+    expected = mock_data
+    expected.delete 'subs'
+
+    assert_equal expected, data
+  end
+
+
+  def test_delete_data_points_affect_parent_hash_value
+    data = @dataset_mock.delete_data_points "**/*=a", true
+
+    expected = mock_data
+    expected.delete 'subs'
+
+    assert_equal expected, data
+  end
+
+
   def test_delete_data_points_single
     data = @dataset_mock.delete_data_points "subs/1"
 

data/test/test_kronk.rb

@@ -13,7 +13,8 @@ class TestKronk < Test::Unit::TestCase
       :cache_file  => Kronk::DEFAULT_CACHE_FILE,
       :diff_format => :ascii_diff,
       :show_lines  => false,
-      :requires    => []
+      :requires    => [],
+      :uri_options => {}
     }
 
     assert_equal expected, Kronk::DEFAULT_CONFIG
@@ -30,6 +31,7 @@ class TestKronk < Test::Unit::TestCase
       :cache_file  => Kronk::DEFAULT_CACHE_FILE,
       :show_lines  => false,
       :requires    => [],
+      :uri_options => {'example.com' => {:parser => 'JSON'}},
       :foo => :bar
     }
 
@@ -51,6 +53,7 @@ class TestKronk < Test::Unit::TestCase
       :requires    => [],
       :show_lines  => false,
       :ignore_headers => ["Content-Type"],
+      :uri_options => {'example.com' => {:parser => 'JSON'}},
       :foo => :bar
     }
 
@@ -106,6 +109,20 @@ class TestKronk < Test::Unit::TestCase
   end
 
 
+  def test_options_for_uri
+    old_uri_opts = Kronk.config[:uri_options].dup
+    Kronk.config[:uri_options] = {
+      'example'     => 'options1',
+      'example.com' => 'options2'
+    }
+
+    assert_equal 'options1', Kronk.options_for_uri("http://example.com/path")
+    assert_equal Hash.new, Kronk.options_for_uri("http://thing.com/path")
+
+    Kronk.config[:uri_options] = old_uri_opts
+  end
+
+
   def test_compare_raw
     diff = Kronk.compare "test/mocks/200_response.json",
                          "test/mocks/200_response.xml",
@@ -145,6 +162,7 @@ class TestKronk < Test::Unit::TestCase
     assert_equal exp_diff.formatted, diff.formatted
   end
 
+
   def test_raw_diff
     diff = Kronk.raw_diff "test/mocks/200_response.json",
                           "test/mocks/200_response.xml",
@@ -185,10 +203,16 @@ class TestKronk < Test::Unit::TestCase
 
 
   def test_parse_data_path_args
-    argv = %w{this is --argv -- one -two -- -three four}
+    options = {}
+    argv = %w{this is --argv -- one -two -- -three four :parents :-not_parents}
+
+    options = Kronk.parse_data_path_args options, argv
+
+    assert_equal %w{one four}, options[:only_data]
+    assert_equal %w{two - three}, options[:ignore_data]
 
-    assert_equal [%w{one four}, %w{two - three}],
-                 Kronk.parse_data_path_args(argv)
+    assert_equal %w{parents}, options[:only_data_with]
+    assert_equal %w{not_parents}, options[:ignore_data_with]
 
     assert_equal %w{this is --argv}, argv
   end

data/test/test_response.rb

@@ -54,6 +54,18 @@ class TestResponse < Test::Unit::TestCase
   end
 
 
+  def test_parsed_body_string_parser
+    raw = File.read "test/mocks/200_response.json"
+    expected = JSON.parse raw.split("\r\n\r\n")[1]
+
+    assert_equal expected, @json_resp.parsed_body
+
+    assert_raises RuntimeError do
+      @json_resp.parsed_body 'PlistParser'
+    end
+  end
+
+
   def test_parsed_body_plist
     raw = File.read "test/mocks/200_response.plist"
     expected = Kronk::PlistParser.parse raw.split("\r\n\r\n")[1]
@@ -173,6 +185,15 @@ class TestResponse < Test::Unit::TestCase
   end
 
 
+  def test_selective_data_parser
+    assert_raises RuntimeError do
+      @json_resp.selective_data :parser => Kronk::PlistParser
+    end
+
+    assert @json_resp.selective_data(:parser => JSON)
+  end
+
+
   def test_selective_data_single_header
     body = JSON.parse @json_resp.body
     expected =

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 1
   - 0
-  - 2
-  version: 1.0.2
+  - 3
+  version: 1.0.3
 platform: ruby
 authors: 
 - Jeremie Castagna
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-07 00:00:00 -08:00
+date: 2010-12-09 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -23,7 +23,7 @@ dependencies:
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
         segments: 
         - 3
@@ -38,13 +38,12 @@ dependencies:
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
         segments: 
         - 1
         - 2
-        - 0
-        version: 1.2.0
+        version: "1.2"
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
@@ -53,13 +52,12 @@ dependencies:
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
         segments: 
         - 1
         - 3
-        - 3
-        version: 1.3.3
+        version: "1.3"
   type: :runtime
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
@@ -68,13 +66,12 @@ dependencies:
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
         segments: 
         - 0
         - 5
-        - 0
-        version: 0.5.0
+        version: "0.5"
   type: :runtime
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
@@ -113,7 +110,7 @@ dependencies:
   requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
         segments: 
         - 0
@@ -186,7 +183,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 1889693282695565885
+      hash: 2734576429023002030
       segments: 
       - 0
       version: "0"