trample_search 0.17.0 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d6aae72f53b824559e0bcf84a7c544737bc8b180
-  data.tar.gz: 50bca159319464c8cc994d0f87b7aec131b279c4
+  metadata.gz: 6935fd536814586a0f865e35502b3aced06e513b
+  data.tar.gz: 5da146f8bac62c4b417f1ac90f8822b7d4071221
 SHA512:
-  metadata.gz: da90c4512a189ee0909d685eed2b4ea4e4f90408925efaa03dd78584055f07ae5c01f17b98052f11aa3207203e1320b885d419a99d59a7753f1ea23a8bf100b0
-  data.tar.gz: 5bc12aaff9e5665ec1b50c86272495d85622d016bee5c81cbb7fd3a03a0c8ce9ef3289fb4628d6ed44cdb519463855f92d2d35bf3e4123a887757bf21fea7eba
+  metadata.gz: 01a3f811375bdd35d87d1de619002caeb0c6f3df8b6fde9de54d7e7dbf7f91dc72d0c68d46d24c46f090f6e35cd9109554b2a1ce69026b7dc210935f4b36c564
+  data.tar.gz: c15d50aacbf8234de5f2996a79818ad6f5e816955b7093b8c729d3915eb18c776b4c5fd884373fa83adb35df54d0aabf5dd401d11033ddfa792ffe2efdca34ea

data/.gitignore

@@ -10,3 +10,4 @@
 /spec/reports/
 /tmp/
 vendor
+.byebug_history

data/Guardfile

@@ -0,0 +1,17 @@
+guard :rspec, cmd: "bundle exec rspec --color --format documentation" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+  watch(%r{^spec/(.*)\/?(.*)_spec\.rb$})
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/lib/trample.rb

@@ -3,9 +3,11 @@ require 'virtus'
 require "trample/version"
 require "trample/aggregation"
 require "trample/serializable"
+require "trample/lookup_not_found"
 require "trample/condition"
 require "trample/condition_proxy"
 require "trample/metadata"
+require "trample/text_lookup"
 require "trample/search"
 require "trample/backend/searchkick"
 require "trample/results"

data/lib/trample/condition.rb

@@ -1,7 +1,6 @@
 module Trample
   class Condition
     include Virtus.model
-
     attribute :name, Symbol
     attribute :query_name, Symbol, default: :name
     attribute :values, Array
@@ -20,12 +19,32 @@ module Trample
     attribute :fields, Array
     attribute :user_query, Hash
     attribute :transform, Proc, default: ->(_,_) { ->(val) { val } }
+    attribute :search_klass
+    attribute :lookup, Hash
 
     def initialize(attrs)
       attrs.merge!(single: true) if attrs[:name] == :keywords
       super(attrs)
     end
 
+    def lookup_autocomplete
+      if require_autocomplete_lookup?
+        options = (lookup || {}).dup
+        klass   = options.delete(:klass) || '::Trample::TextLookup'
+
+        options.assert_valid_keys(:key, :label)
+
+        options = options.merge({
+          search_klass: search_klass,
+          condition_name: name
+        })
+
+        lookup_instance = klass.to_s.constantize.new(options)
+
+        self.values = lookup_instance.load(values) 
+      end
+    end
+
     def blank?
       values.reject { |v| v == "" || v.nil? }.empty? && !range?
     end
@@ -204,5 +223,10 @@ module Trample
 
       { runtime_query_name => hash }
     end
+
+    def require_autocomplete_lookup?
+      (values.present? && values.first.is_a?(Hash)) && 
+        values.any? { |v| v[:text].blank? }
+    end
   end
 end

data/lib/trample/lookup_not_found.rb

@@ -0,0 +1,37 @@
+module Trample
+  class LookupNotFoundError < StandardError
+
+    attr_reader :condition, :lookup_results, :corresponding_lookup
+
+    def initialize(condition, lookup_results, corresponding_lookup)
+      @condition = condition
+      @lookup_results = lookup_results
+      @corresponding_lookup = corresponding_lookup
+      super(message)
+    end
+
+    def message
+      msg = <<-MSG.strip_heredoc
+            No corresponding lookup found for condition #{condition.name}
+
+            Corresponding Lookup Result: #{ corresponding_lookup }
+
+            Criteria Keys:        #{ criteria_keys.join(", ") }
+            Lookup Result Keys:   #{ lookup_keys.join(", ") }
+            Missing:              #{ diff.join(", ") }
+            MSG
+    end
+
+    def criteria_keys
+      @criteria_keys ||= Array(condition.values).map { |l| l[:key] }.sort
+    end
+
+    def lookup_keys
+      @lookup_keys ||= Array(lookup_results).map {|l| l[:key] }.sort
+    end
+
+    def diff
+      criteria_keys - lookup_keys
+    end
+  end
+end

data/lib/trample/search.rb

@@ -23,7 +23,8 @@ module Trample
     end
 
     def self.condition(name, attrs = {})
-      attrs.merge!(name: name)
+      attrs.merge!(name: name, search_klass: self)
+
       @_conditions[name] = Condition.new(attrs)
     end
 
@@ -133,9 +134,12 @@ module Trample
       @backend ||= Backend::Searchkick.new(metadata, self.class._models)
     end
 
-    def query!
+    def query!(options = { lookup: true })
       @records = nil
       hash = backend.query!(conditions, aggregations)
+
+      load_autocompletes if options[:lookup]
+
       self.metadata.took = hash[:took]
       self.metadata.scroll_id = hash[:scroll_id]
       self.metadata.pagination.total = hash[:total]
@@ -191,5 +195,8 @@ module Trample
       Marshal.load(Marshal.dump(o))
     end
 
+    def load_autocompletes
+      self.conditions.values.each(&:lookup_autocomplete)
+    end
   end
 end

data/lib/trample/text_lookup.rb

@@ -0,0 +1,27 @@
+module Trample
+  class TextLookup
+    include Virtus.model
+    attribute :search_klass
+    attribute :condition_name,  Symbol
+    attribute :key,             Symbol, default: :id
+    attribute :label,           Symbol, default: :text
+
+    def load(values)
+      search = search_klass.new
+      search.condition(condition_name).in(values)
+      search.query!(lookup: false)
+
+      values.map do | value |
+        result = find_corresponding_value(value, search.results)
+        value[:text] = result[label]
+        value
+      end
+    end
+
+    private 
+
+    def find_corresponding_value(value, results)
+      results.find { |result| value[:key].to_s == result[key].to_s  }
+    end
+  end
+end

data/lib/trample/version.rb

@@ -1,3 +1,3 @@
 module Trample
-  VERSION = "0.17.0"
+  VERSION = "0.18.0"
 end

data/trample.gemspec

@@ -29,4 +29,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-rspec"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trample_search
 version: !ruby/object:Gem::Version
-  version: 0.17.0
+  version: 0.18.0
 platform: ruby
 authors:
 - richmolj
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-08 00:00:00.000000000 Z
+date: 2016-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: virtus
@@ -150,6 +150,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Abstraction on top of searchkick to handle form inputs easily
 email:
 - richmolj@gmail.com
@@ -161,6 +189,7 @@ files:
 - ".rspec"
 - ".travis.yml"
 - Gemfile
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -174,12 +203,14 @@ files:
 - lib/trample/condition.rb
 - lib/trample/condition_proxy.rb
 - lib/trample/errors.rb
+- lib/trample/lookup_not_found.rb
 - lib/trample/metadata.rb
 - lib/trample/railtie.rb
 - lib/trample/results.rb
 - lib/trample/search.rb
 - lib/trample/serializable.rb
 - lib/trample/swagger.rb
+- lib/trample/text_lookup.rb
 - lib/trample/version.rb
 - trample.gemspec
 homepage: 
@@ -202,7 +233,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Abstraction on top of searchkick to handle form inputs easily