jmespath 0.9.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cd9b114d1de9308e2c28037ebf5664841fa60524
-  data.tar.gz: 2169a15d13d0ece59efe976b9e1d2da0f5d34aa5
+  metadata.gz: 4498ed69dc541e13ec1b682b754419a7ea88aa7d
+  data.tar.gz: c98d5347758fe4eb6418b1f15a0b253f4a903e88
 SHA512:
-  metadata.gz: 7bfe1d21d8aa9c7e05ba61e600b0f9fce2af250d61058807599bff87ee196ecd62343c288eae5926eb57b6f4456d8916a45adc9c55bf8b25b562c9b0b74909bf
-  data.tar.gz: 1396c1b380fc0a5fca6130bc2fb2b4b092c2d789948e015d642cbc884b665acd5906e362073c5cd680704ce14645ab0546f0f8f1d83a66539f13890d59374c27
+  metadata.gz: a81a6a8994b7fa722a8dc77f70ac5ee43c1799a756046ebd4b44f29a31c0a5e7a269df180163b2c83925ca78593025172a73ad059cc5326ceabaa5ff15d7d9fa
+  data.tar.gz: ad285ecab333df630843157cc6c5c93be080152cd84efcb79fe44108bbff17adc2ef437cb9e22aa2ffd7eca36151b69f35c33ba68036dc01f51840af8a952d07

data/lib/jmespath.rb

@@ -1,7 +1,9 @@
 require 'multi_json'
+require 'pathname'
 
 module JMESPath
 
+  autoload :CachingParser, 'jmespath/caching_parser'
   autoload :Errors, 'jmespath/errors'
   autoload :ExprNode, 'jmespath/expr_node'
   autoload :Lexer, 'jmespath/lexer'

data/lib/jmespath/caching_parser.rb

@@ -0,0 +1,30 @@
+require 'thread'
+
+module JMESPath
+  class CachingParser
+
+    def initialize(options = {})
+      @parser = options[:parser] || Parser.new(options)
+      @mutex = Mutex.new
+      @cache = {}
+    end
+
+    def parse(expression)
+      if cached = @cache[expression]
+        cached
+      else
+        cache_expression(expression)
+      end
+    end
+
+    private
+
+    def cache_expression(expression)
+      @mutex.synchronize do
+        @cache.clear if @cache.size > 1000
+        @cache[expression] = @parser.parse(expression)
+      end
+    end
+
+  end
+end

data/lib/jmespath/runtime.rb

@@ -1,46 +1,71 @@
-require 'thread'
-
 module JMESPath
   # @api private
   class Runtime
 
     # @api private
-    CACHE = {}
-
-    MUTEX = Mutex.new
+    DEFAULT_PARSER = CachingParser.new
 
-    # @option options [Parser] :parser
+    # Constructs a new runtime object for evaluating JMESPath expressions.
+    #
+    #     runtime = JMESPath::Runtime.new
+    #     runtime.search(expression, data)
+    #     #=> ...
+    #
+    # ## Caching
+    #
+    # When constructing a {Runtime}, the default parser caches expressions.
+    # This significantly speeds up calls to {#search} multiple times
+    # with the same expression but different data. To disable caching, pass
+    # `:cache_expressions => false` to the constructor or pass a custom
+    # `:parser`.
+    #
+    # @example Re-use a Runtime, caching enabled by default
+    #
+    #   runtime = JMESPath::Runtime.new
+    #   runtime.parser
+    #   #=> #<JMESPath::CachingParser ...>
+    #
+    # @example Disable caching
+    #
+    #   runtime = JMESPath::Runtime.new(cache_expressions: false)
+    #   runtime.parser
+    #   #=> #<JMESPath::Parser ...>
+    #
+    # @option options [Boolean] :cache_expressions (true) When `false`, a non
+    #   caching parser will be used. When `true`, a shared instance of
+    #   {CachingParser} is used.  Defaults to `true`.
+    #
+    # @option options [Parser,CachingParser] :parser
+    #
     # @option options [Interpreter] :interpreter
+    #
     def initialize(options = {})
-      @parser = options[:parser] || Parser.new
+      @parser = options[:parser] || default_parser(options)
       @interpreter = options[:interpreter] || TreeInterpreter.new
     end
 
+    # @return [Parser, CachingParser]
+    attr_reader :parser
+
+    # @return [Interpreter]
+    attr_reader :interpreter
+
     # @param [String<JMESPath>] expression
     # @param [Hash] data
     # @return [Mixed,nil]
     def search(expression, data)
-      @interpreter.visit(parse(expression), data)
+      @interpreter.visit(@parser.parse(expression), data)
     end
 
     private
 
-    def parse(expression)
-      if CACHE[expression]
-        CACHE[expression]
+    def default_parser(options)
+      if options[:cache_expressions] == false
+        Parser.new(options)
       else
-        MUTEX.synchronize { CACHE[expression] = @parser.parse(expression) }
+        DEFAULT_PARSER
       end
     end
 
-    class << self
-
-      # @api private
-      def clear_cache
-        MUTEX.synchronize { CACHE.clear }
-      end
-
-    end
-
   end
 end

data/lib/jmespath/version.rb

@@ -1,3 +1,3 @@
 module JMESPath
-  VERSION = '0.9.0'
+  VERSION = '1.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jmespath
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Trevor Rowe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-27 00:00:00.000000000 Z
+date: 2014-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -30,6 +30,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/jmespath/caching_parser.rb
 - lib/jmespath/errors.rb
 - lib/jmespath/expr_node.rb
 - lib/jmespath/lexer.rb