searchr 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 000949f105a868a2f6e78e31ff582b1c37e08d8f
-  data.tar.gz: 91a95ee98d16e7401a891f6e50ddd7a957d05aee
+  metadata.gz: de94e9fecb06325ad65d0dfd8830452010ced344
+  data.tar.gz: 929ca90c0a5f8950c5763f66e5b1ea25ae748bd0
 SHA512:
-  metadata.gz: fae7f6d37acf030b967592ad7c0de6cfe9deb8f0f73686d0652f50752c45e2c34066649143de29c3cb3b5b04ed4d8fbb5f888d8b7a641b2c94da70edc107fbf6
-  data.tar.gz: dd6608f95993537d2d12a6cd7371b1b34109db4ab72583766847a82578c7c0ee9dd86ca5dea06d867b8df7c2a1549a9887617718f85d6fb767f883d663c03f59
+  metadata.gz: 8c57aaced27c17568e3be0b6785e34d5c9a3fd4d3b8cd270ea3506fa0d15e57a0a94cef47c42bbbf5314b377a11aaec28d64aaa44d1cdee891fe8f8c9edae601
+  data.tar.gz: a249f23ccc42cb90cc308b79e5f8354f5b798f14697fb3e6a9ee8e26102d4fd9ecc772f46fa87f7e3f29777e9ea30bb4a513a28e2a2cad81624a51d49f5689f3

data/README.md

@@ -1,8 +1,6 @@
 # Searchr
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/searchr`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Diagnose search result weights. Currently supports solr. To be used with searchr-rails.
 
 ## Installation
 

data/lib/searchr.rb

@@ -1,11 +1,8 @@
 require 'net/http'
 require 'json'
 
-require "searchr/version"
-require 'searchr/query'
-require 'searchr/solr_query'
-require 'searchr/result'
-require 'searchr/solr_result'
+require 'requirer'
+Requirer.require_dir_tree 'searchr'
 
 module Searchr
   # Your code goes here...

data/lib/searchr/explanation_parser.rb

@@ -0,0 +1,293 @@
+module Searchr
+  Explanation = Struct.new(:str, :nested, :flattened)
+
+  class ExplanationParser
+    attr_reader :lines
+
+    def initialize(lines)
+      @lines = lines.select{ |line| !line.empty? }.collect{ |line| ExplainLine.new line }
+    end
+
+    def explanation
+      Explanation.new top_node.simple_string, top_node.simple_json, top_node.simple_array
+    end
+
+    def top_node
+      @top_node ||= scrunch
+    end
+
+    private
+
+    def scrunch
+      @_nodes = Array.new(20)
+      @_nodes[0] = @lines[0].node(nil)
+      @_node_depth = 0
+      @_line_num = 1
+      process_next_line until eof?
+
+      return @_nodes[0]
+    end
+
+    def parent_node
+      @_nodes[line.indent_level - 1]
+    end
+    def line
+      @lines[@_line_num]
+    end
+
+    def set_current_node(node, depth)
+      @_node_depth = depth
+      @_nodes[depth] = node
+    end
+
+    def process_next_line
+      node = line.node parent_node
+      set_current_node node, line.indent_level
+      bump_line
+      consume_subordinate_lines node if node.is_leaf
+    end
+
+    def bump_line
+      @_line_num += 1
+    end
+
+    def eof?
+      @_line_num >= @lines.size
+    end
+
+    def consume_subordinate_lines(node)
+      current_line = line
+      bump_line
+      while !eof? and (line.indent_level==0 or current_line.indent_level<line.indent_level)
+        node.add_line "#{'  '*[line.indent_level-current_line.indent_level,0].max}#{line.line}"
+        bump_line
+      end
+    end
+  end
+
+  class ExplainLine
+    attr_reader :indent_level, :line
+
+    def self.node(str)
+      self.new(str).node
+    end
+
+    def initialize(line)
+      num_spaces = (/^\s*/.match line).to_s.size
+      @indent_level = num_spaces / 2
+      @line = line[num_spaces..line.size]
+    end
+
+    def node(parent)
+      line_type.new parent, self
+    end
+
+    def line_type
+      return ProductNode if @line.include? ') product of:'
+      return SumNode     if @line.include? ') sum of:'
+      return MaxNode     if @line.include? ') max of:'
+      return WeightNode  if @line.include? ') weight('
+      return CoordNode   if @line.include? '= coord('
+      msg = "Unknown line type: #{@line}"
+      msg.logit
+      raise msg
+    end
+
+    def score
+      @score ||= line.to_f
+    end
+  end
+
+  module Node
+    attr_reader :parent, :explain_line
+
+    def initialize(parent, explain_line)
+      set_parent parent
+      @explain_line = explain_line
+    end
+
+    def score
+      @explain_line.score
+    end
+
+    def children
+      @children ||= []
+    end
+
+    def is_leaf
+      false
+    end
+
+    private
+
+    def set_parent(parent)
+      @parent = parent
+      @parent.children << self if parent
+    end
+  end
+
+  class ProductNode
+    include Node
+
+    def simple_string
+      case children.size
+      when 0
+        ''
+      when 1
+        children[0].simple_string
+      else
+        "#{score}=(" + (children.collect {|child| child.simple_string}.join(" * ")) + ")"
+      end
+    end
+
+    def simple_json
+      case children.size
+      when 0
+        nil
+      when 1
+        children[0].simple_json
+      else
+        [score, '*', children.collect {|child| child.simple_json}.select {|ele| !ele.nil?}]
+      end
+    end
+
+    def simple_array
+      results = children.collect {|child| child.simple_array}
+      case results.size
+      when 0
+        []
+      when 1
+        results[0]
+      else
+        ['(', ['*', score]] + results.flatten(1) + [')']
+      end
+    end
+  end
+
+  class SumNode
+    include Node
+
+    def simple_string
+      case children.size
+      when 0
+        ''
+      when 1
+        children[0].simple_string
+      else
+        "#{score}=(" + (children.collect {|child| child.simple_string}.join(" + ")) + ")"
+      end
+    end
+
+
+    def simple_json
+      case children.size
+      when 0
+        nil
+      when 1
+        children[0].simple_json
+      else
+        [score, '+', children.collect {|child| child.simple_json}.select {|ele| !ele.nil?}]
+      end
+    end
+
+    def simple_array
+      results = children.collect {|child| child.simple_array}
+      case results.size
+      when 0
+        []
+      when 1
+        results[0]
+      else
+        ['(', ['+', score]] + results.flatten(1) + [')']
+      end
+    end
+  end
+
+  class MaxNode
+    include Node
+
+    def simple_string
+      case children.size
+      when 0
+        ''
+      when 1
+        children[0].simple_string
+      else
+        "#{score}=max(" + (children.collect {|child| child.simple_string}.join(", ")) + ")"
+      end
+    end
+
+
+    def simple_json
+      case children.size
+      when 0
+        nil
+      when 1
+        children[0].simple_json
+      else
+        [score, 'max', children.collect {|child| child.simple_json}.select {|ele| !ele.nil?}]
+      end
+    end
+
+    def simple_array
+      results = children.collect {|child| child.simple_array}
+      case results.size
+      when 0
+        []
+      when 1
+        results[0]
+      else
+        ['(', ['max', score]] + results.flatten(1) + [')']
+      end
+    end
+  end
+
+  class WeightNode
+    include Node
+
+    def is_leaf
+      true
+    end
+
+    def weight_name
+      m = /\) weight\(([^)]+)/.match explain_line.line
+      m[1]
+    end
+
+    def add_line(line)
+      subordinate_rows << line
+    end
+
+    def subordinate_rows
+      @subordinate_rows ||= []
+    end
+
+    def simple_string
+      "[#{score}=#{weight_name}]"
+    end
+
+    def simple_json
+      [score, weight_name, subordinate_rows]
+    end
+
+    def simple_array
+      [[weight_name, score, subordinate_rows]]
+    end
+  end
+
+  class CoordNode
+    include Node
+
+    def simple_string
+      "[#{score}=coord]"
+    end
+
+    def simple_json
+      [score, 'coord']
+    end
+
+    def simple_array
+      [['coord', score]]
+    end
+  end
+end

data/lib/searchr/query.rb

@@ -2,13 +2,18 @@ require 'addressable/uri'
 
 module Searchr
   class Query
-    attr_writer :query, :fields_to_query, :start_row, :num_rows
+    attr_writer :query, :fields_to_query
 
     def search
-      result_with http_response
+      result_class.new self, http_response
     end
 
-    def result_with
+    # There are more subclass responsibility methods in the protected section.
+    def result_class
+      subclass_responsibility
+    end
+
+    def query_parameters
       subclass_responsibility
     end
 
@@ -32,14 +37,43 @@ module Searchr
       @fields_to_query ||= default_fields_to_query
     end
 
+    def fields_to_return
+      @fields_to_return ||= default_fields_to_return
+      @fields_to_return.split(/\W+/)
+    end
+
+    def fields_to_return=(array_or_string)
+      @fields_to_return = if array_or_string.class==String
+                            array_or_string
+                          else
+                            array_or_string.join(' ')
+                          end
+    end
+
     def start_row
-      @start_row ||= 0
+      @start_row ||= 1
+    end
+
+    def start_row=(num)
+      num_as_int = Integer(num)
+      raise "start_row must be a positive integer (#{num})" if num_as_int < 1
+      @start_row = num_as_int
     end
 
     def num_rows
       @num_rows ||= default_num_rows
     end
 
+    def num_rows=(num)
+      num_as_int = Integer(num)
+      raise "num_rows must be a positive integer (#{num})" if num_as_int < 0
+      @num_rows = num_as_int
+    end
+
+    def end_row
+      start_row + num_rows - 1
+    end
+
     def indent?
       @do_indent ||= default_indent?
     end
@@ -52,10 +86,6 @@ module Searchr
       @return_type ||= default_return_type
     end
 
-    def query_parameters
-      subclass_responsibility
-    end
-
     def url
       uri = URI(base_query_url)
 
@@ -80,6 +110,10 @@ module Searchr
       subclass_responsibility
     end
 
+    def default_fields_to_return
+      subclass_responsibility
+    end
+
     def default_num_rows
       10
     end
@@ -90,7 +124,7 @@ module Searchr
     end
 
     def default_debug_query?
-      # true required to diagnose result weights
+      # true required to retrieve result weights
       true
     end
 

data/lib/searchr/result.rb

@@ -1,12 +1,15 @@
 module Searchr
   class Result
-    def initialize(http_response)
+    attr_reader :query
+
+    def initialize(query, http_response)
+      @query = query
       @http_response = http_response
       raise 'Http response for search did not succeed' if code!=200
     end
 
     def body
-      @body ||= JSON.parse(http_response.body)
+      @body ||= JSON.parse(@http_response.body)
     end
 
     def code

data/lib/searchr/solr_query.rb

@@ -1,12 +1,12 @@
 module Searchr
   class SolrQuery < Query
-    def result_with(http_response)
-      SolrResult.new http_response
+    def result_class
+      SolrResult
     end
 
     def query_parameters
       {
-          start: start_row,
+          start: start_row-1,
           rows: num_rows,
           q: query,
           qf: fields_to_query,

data/lib/searchr/solr_result.rb

@@ -1,4 +1,66 @@
 module Searchr
   class SolrResult < Result
+    def documents
+      @documents ||= body['response']['docs']
+    end
+
+    def num_documents_received
+      documents.size
+    end
+
+    def num_documents_requested
+      query.num_rows
+    end
+
+    def start_row
+      @start_row ||= body['response']['start']
+    end
+
+    def end_row
+      start_row + num_documents_received - 1
+    end
+
+    def num_matches
+      @num_found ||= body['response']['numFound']
+    end
+
+    def status
+      status ||= body['responseHeader']['status']
+    end
+
+    def parameters
+      @parameters ||= body['responseHeader']['params']
+    end
+
+    def explain
+      body['debug']['explain']
+    end
+
+    # calculated fields
+
+    def explanations
+      explanation_hash
+    end
+
+    def explanation_hash
+      unless @explanation_hash
+        @explanation_hash = extract_explanations
+        @explanation_hash.each do |key, rows|
+          parser = ExplanationParser.new rows
+          rows[0] = parser.explanation
+        end
+      end
+      @explanation_hash
+    end
+
+    protected
+
+    def extract_explanations
+      matches = {}
+      explain.each do |key, val|
+        matches[key] = val.split("\n")
+      end
+      matches
+    end
   end
 end

data/lib/searchr/version.rb

@@ -1,3 +1,3 @@
 module Searchr
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/searchr.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency 'addressable'
+  spec.add_dependency 'requirer'
 
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: searchr
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Brian Murphy-Dye
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-08-01 00:00:00.000000000 Z
+date: 2015-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: requirer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -166,6 +180,7 @@ files:
 - bin/console
 - bin/setup
 - lib/searchr.rb
+- lib/searchr/explanation_parser.rb
 - lib/searchr/query.rb
 - lib/searchr/result.rb
 - lib/searchr/solr_query.rb