kronk 1.3.1 → 1.4.0

data/History.rdoc

@@ -1,3 +1,31 @@
+=== 1.4.0 / 2011-07-04
+
+* Enhancements:
+
+  * Rewrote data path parsing to be more efficient and powerful. Added support
+    for ../ and ./ paradygms replacing the ':path' notation.
+
+  * Added path modifiers for case-insensitive and multiline matcher support.
+    Paths are once again case-sensitive by default.
+
+  * Created non-destructive path transactions to replace the DataSet
+    in-place modification.
+
+  * Support for displaying data indicies of modified Arrays.
+
+  * Removed explicit dependencies for ActiveSupport. Will attempt loading only
+    if String#pluralize isn't defined. Otherwise uses naïve pluralization.
+
+  * Removed Rack dependency.
+
+  * Made Kronk.compare concurrent for better performance.
+
+* Bugfixes:
+
+  * Mixed-type sorting of Hash keys when creating ordered data String.
+
+  * Data selections no longer have nil values on non-selected array elements.
+
 === 1.3.1 / 2011-06-01
 
 * Bugfixes:

data/Manifest.txt

@@ -11,6 +11,8 @@ lib/kronk/data_set.rb
 lib/kronk/diff.rb
 lib/kronk/diff/ascii_format.rb
 lib/kronk/diff/color_format.rb
+lib/kronk/path.rb
+lib/kronk/path/transaction.rb
 lib/kronk/plist_parser.rb
 lib/kronk/request.rb
 lib/kronk/response.rb
@@ -36,6 +38,8 @@ test/test_data_set.rb
 test/test_diff.rb
 test/test_helper.rb
 test/test_kronk.rb
+test/test_path.rb
 test/test_request.rb
 test/test_response.rb
+test/test_transaction.rb
 test/test_xml_parser.rb

data/README.rdoc

@@ -75,7 +75,7 @@ Parse the data and run an IRB console with the response:
 
 == CONFIGURATION:
 
-Kronk pulls it's config from $HOME/.kronk and supports the following:
+Kronk pulls it's config from $HOME/.kronk/rc and supports the following:
 
 Set the file to save the last http response retrieved in:
 
@@ -162,12 +162,9 @@ something like:
     "data" => {
       "path1" => "value1",
       "path2" => [
-        nil,
         {
           "child" => "child value"
-        },
-        nil,
-        nil
+        }
       ]
     }
   }
@@ -186,10 +183,9 @@ flag it to remove data:
   }
 
 If you would like to exclude or include only items with a specific child
-attribute, you can do so by prepending the path with a ':'.
-Both ':' and '-' can be combined as ':-'.
+attribute, you can do so by appending "/.." to the path.
 
-  $ kronk http://host.com -- :data/path2/1/child
+  $ kronk http://host.com -- data/path2/1/child/..
 
   {
     "data" => {
@@ -200,12 +196,42 @@ Both ':' and '-' can be combined as ':-'.
           "child" => "child value",
           "last_child" => "last value"
         },
-        nil,
-        nil
       ]
     }
   }
 
+Path matcher parsing may also be affected by appending Regexp options to the
+end of the path in the following fashion:
+
+  # Make path case insensitive
+  $ kronk host.com -- data/path2/1//i
+
+  {
+    "data" => {
+      "PATH2" => [
+        "item at index 1"
+      ],
+        
+      "path2" => [
+        {
+          "first_child" => "first value",
+          "child" => "child value",
+          "last_child" => "last value"
+        }
+      ]
+    }
+  }
+
+  # Make path case insensitive and multiline
+  $ kronk host.com -- data/**=*foobar*//im
+
+  {
+    "data" => {
+      "subdata" => "test for\nFOOBAR\nmultiline"
+    }
+  }
+
+
 There are additionally a variety of wildcard and special characters that
 are supported:
 
@@ -213,24 +239,28 @@ are supported:
 
 * \*\*/ matches any key recursively down the data structure
 
+* ../ matches the parent of the previously matched item
+
+* 2..5, 2...6 and 2,3 match any Integer or String from 2 to 5
+
 * ? matches zero or one character
 
 * | effectively works as an "OR" character, matches /^val1|val2$/
 
-* \= is used to match values and may be used in conjuction with a key or not.
+* \= is used to match values and may be used in conjuction with a key or not
 
-* Parentheses are ok to use if in conjunction with other special characters
+* Parentheses may be used in conjunction with other special characters
   for a given path item, such as: /path(1|2)
 
-Check out Kronk::DataSet for more details on data traversing.
+* \\ escapes any special path character
+
+Check out Kronk::Path and Kronk::DataSet for more details on data traversing.
 
 Note: Bash may try to parse your data paths, especially if they start with
 wildcards or if they contain the pipe "|" character, so you may need to put
 single quotes around some of your paths.
-  
-== REQUIREMENTS:
 
-* activesupport gem
+== REQUIREMENTS:
 
 * nokogiri gem
 
@@ -238,8 +268,6 @@ single quotes around some of your paths.
 
 * json gem
 
-* rack gem
-
 * cookiejar gem
 
 == INSTALL:

data/Rakefile

@@ -25,10 +25,7 @@ Hoe.spec 'kronk' do
   self.extra_deps << ['plist',         '~>3.1.0']
   self.extra_deps << ['json',          '~>1.5']
   self.extra_deps << ['nokogiri',      '~>1.4']
-  self.extra_deps << ['i18n',          '>=0.5']
-  self.extra_deps << ['activesupport', '>=2.0.0']
   self.extra_deps << ['cookiejar',     '~>0.3.0']
-  self.extra_deps << ['rack',          '~>1.0']
 
   self.extra_dev_deps << ['mocha', '~>0.9.10']
 end

data/bin/kronk

@@ -1,6 +1,7 @@
 #!/usr/bin/env ruby
 
-  $: << File.join(File.dirname(__FILE__), "../lib")
+$: << File.join(File.dirname(__FILE__), "../lib") if $0 =~ %r{bin/kronk$}
+
 begin
   require 'kronk'
 

data/lib/kronk.rb

@@ -2,7 +2,6 @@ require 'rubygems'
 
 require 'json'
 require 'cookiejar'
-require 'rack'
 
 require 'net/https'
 require 'optparse'
@@ -11,10 +10,12 @@ require 'yaml'
 class Kronk
 
   # This gem's version.
-  VERSION = '1.3.1'
+  VERSION = '1.4.0'
 
 
   require 'kronk/cmd'
+  require 'kronk/path'
+  require 'kronk/path/transaction'
   require 'kronk/data_set'
   require 'kronk/diff/ascii_format'
   require 'kronk/diff/color_format'
@@ -169,9 +170,9 @@ class Kronk
 
         # Hash or uri query String
         when :data, :query
-          val = Rack::Utils.parse_nested_query val if String === val
+          val = Request.parse_nested_query val if String === val
 
-          out_opts[key] = Rack::Utils.parse_nested_query out_opts[key] if
+          out_opts[key] = Request.parse_nested_query out_opts[key] if
             String === out_opts[key]
 
           out_opts[key] = val.merge out_opts[key], &DataSet::DEEP_MERGE
@@ -312,25 +313,30 @@ class Kronk
   # Supports the following options:
   # :data:: Hash/String - the data to pass to the http request
   # :query:: Hash/String - the data to append to the http request path
-  # :follow_redirects:: Integer/Bool - number of times to follow redirects
+  # :follow_redirects:: Integer/Boolean - 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
   # :user_agent:: String - user agent string or alias; defaults to 'kronk'
   # :auth:: Hash - must contain :username and :password; defaults to nil
   # :proxy:: Hash/String - http proxy to use; defaults to nil
   # :only_data:: String/Array - extracts the data from given data paths
-  # :only_data_with:: String/Array - extracts the data from given parent paths
   # :ignore_data:: String/Array - defines which data points to exclude
-  # :ignore_data_with:: String/Array - defines which parent data to exclude
-  # :with_headers:: Bool/String/Array - defines which headers to include
-  # :parser:: Object/String - The parser to use for the body; default nil
-  # :raw:: Bool - run diff on raw strings
+  # :keep_indicies:: Boolean - keep the original indicies of modified arrays,
+  #   and return them as hashes.
+  # :with_headers:: Boolean/String/Array - defines which headers to include
+  # :parser:: Object/String - the parser to use for the body; default nil
+  # :raw:: Boolean - run diff on raw strings
   #
   # Returns a diff object.
 
   def self.compare uri1, uri2, options={}
-    str1 = retrieve_data_string uri1, options
-    str2 = retrieve_data_string uri2, options
+    str1 = str2 = ""
+
+    t1 = Thread.new{ str1 = retrieve_data_string uri1, options }
+    t2 = Thread.new{ str2 = retrieve_data_string uri2, options }
+
+    t1.join
+    t2.join
 
     Diff.new str1, str2
   end
@@ -346,7 +352,7 @@ class Kronk
     resp = Request.retrieve uri, options
 
     if options[:irb]
-      irb resp
+      Cmd.irb resp
 
     elsif options[:raw]
       resp.selective_string options
@@ -362,89 +368,4 @@ class Kronk
       end
     end
   end
-
-
-  ###
-  # Deprecated methods...
-  ###
-
-
-  def self.deprecated method_name, replacement=nil
-    replacement &&= ", use #{replacement}"
-    replacement ||= " with no replacement"
-
-    Cmd.warn "#{method_name} deprecated#{replacement}"
-  end
-
-
-  ##
-  # Deprecated! Use Kronk::Cmd::irb
-
-  def self.irb resp
-    deprecated "Kronk::irb", "Kronk::Cmd::irb"
-    Cmd.irb resp
-  end
-
-
-  ##
-  # Deprecated! Use Kronk::Cmd::move_config_file
-
-  def self.move_config_file
-    deprecated "Kronk::move_config_file", "Kronk::Cmd::move_config_file"
-    Cmd.move_config_file
-  end
-
-
-  ##
-  # Deprecated! Use Kronk::Cmd::query_password
-
-  def self.query_password str=nil
-    deprecated "Kronk::query_password", "Kronk::Cmd::query_password"
-    Cmd.query_password str
-  end
-
-
-  ##
-  # Deprecated! Use Kronk::Cmd::parse_args
-
-  def self.parse_args argv
-    deprecated "Kronk::parse_args", "Kronk::Cmd::parse_args"
-    Cmd.parse_args argv
-  end
-
-
-  ##
-  # Deprecated! Use Kronk::Cmd::parse_data_path_args
-
-  def self.parse_data_path_args options, argv
-    deprecated "Kronk::parse_data_path_args", "Kronk::Cmd::parse_data_path_args"
-    Cmd.parse_data_path_args options, argv
-  end
-
-
-  ##
-  # Deprecated! Use Kronk::Cmd::run
-
-  def self.run argv=ARGV
-    deprecated "Kronk::run", "Kronk::Cmd::run"
-    Cmd.run argv
-  end
-
-
-  ##
-  # Deprecated! Use Kronk::Cmd::verbose
-
-  def self.verbose str
-    deprecated "Kronk::verbose", "Kronk::Cmd::verbose"
-    Cmd.verbose str
-  end
-
-
-  ##
-  # Deprecated! Use Kronk::Cmd::windows?
-
-  def self.windows?
-    deprecated "Kronk::windows?", "Kronk::Cmd::windows?"
-    Cmd.windows?
-  end
 end

data/lib/kronk/cmd.rb

@@ -67,11 +67,11 @@ class Kronk
 
     def self.parse_args argv
       options = {
-        :auth           => {},
-        :no_body        => false,
-        :proxy          => {},
-        :uris           => [],
-        :with_headers   => false
+        :auth         => {},
+        :no_body      => false,
+        :proxy        => {},
+        :uris         => [],
+        :with_headers => false
       }
 
       options = parse_data_path_args options, argv
@@ -90,7 +90,7 @@ Parse and run diffs against data from live and cached http responses.
   Usage:
     #{opt.program_name} --help
     #{opt.program_name} --version
-    #{opt.program_name} uri1 [uri2] [options...] [-- data-paths]
+    #{opt.program_name} uri1 [uri2] [options] [-- data-paths]
 
   Examples:
     #{opt.program_name} http://example.com/A
@@ -100,8 +100,6 @@ Parse and run 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
@@ -168,6 +166,11 @@ Parse and run diffs against data from live and cached http responses.
         end
 
 
+        opt.on('--indicies', 'Show modified array original indicies') do
+          options[:keep_indicies] = true
+        end
+
+
         opt.on('--irb', 'Start an IRB console') do
           options[:irb] = true
         end
@@ -190,7 +193,7 @@ Parse and run diffs against data from live and cached http responses.
 
 
         opt.on('--prev', 'Use last response to diff against') do
-          options[:uris].unshift :cache
+          options[:uris].unshift Kronk.config[:cache_file]
         end
 
 
@@ -319,6 +322,11 @@ Parse and run diffs against data from live and cached http responses.
       options[:uris].concat argv
       options[:uris].slice!(2..-1)
 
+      if options[:uris].empty? && File.file?(Kronk.config[:cache_file])
+        verbose "No URI specified - using kronk cache"
+        options[:uris] << Kronk.config[:cache_file]
+      end
+
       argv.clear
 
       raise OptionParser::MissingArgument, "You must enter at least one URI" if
@@ -348,9 +356,11 @@ Parse and run diffs against data from live and cached http responses.
           (options[:ignore_data] ||= []) << path[1..-1]
 
         elsif path[0,2] == ":-"
+          warn "The :path notation is deprecated, use path/.."
           (options[:ignore_data_with] ||= []) << path[2..-1]
 
         elsif path[0,1] == ":"
+          warn "The :path notation is deprecated, use path/.."
           (options[:only_data_with] ||= []) << path[1..-1]
 
         else
@@ -380,9 +390,6 @@ Parse and run diffs against data from live and cached http responses.
     # Runs the kronk command with the given terminal args.
 
     def self.run argv=ARGV
-
-      options = parse_args argv
-
       begin
         Kronk.load_config
 
@@ -402,6 +409,8 @@ Parse and run diffs against data from live and cached http responses.
         exit 2
       end
 
+      options = parse_args argv
+
       Kronk.load_cookie_jar
 
       load_requires options[:requires]
@@ -423,6 +432,7 @@ Parse and run diffs against data from live and cached http responses.
 
       if uri1 && uri2
         diff = Kronk.compare uri1, uri2, options
+
         puts "#{diff.formatted}\n" unless Kronk.config[:brief]
 
         if Kronk.config[:verbose] || Kronk.config[:brief]