combi_search 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 855e3f92f4b8b51c83b7640408358a8631cd721c
+  data.tar.gz: b453298e6535615e504e29a57478a93168699a82
+SHA512:
+  metadata.gz: db99389c0fd91731a12bfcc2b6dc390236ae1becca5a3121a826ac925856fc80b4214a4556b2d30faf282939aa41d603ce2c2cee8e3b223700ce978c710ba596
+  data.tar.gz: bdcd43fc941e8fcea31f1f8601da9676a40eb9b92552edc97bb1f88746ab0fec0e7381d12540fae37b47d12a235ba73556ee58295b372dc137777d906a3d9c77

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in combi_search.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Douwe Homans
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,146 @@
+# CombiSearch
+
+Use CombiSearch to add a 'global' search to your app. For example; if you have `Book`s and `Movie`s and you want a combined search where you search in all of your titles.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'combi_search'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install combi_search
+
+## Usage
+#### 1. Add the _internal_ CombiSearch-Entry model to your database-schema
+This model is used to store your 'combined' search data. You can create it by running the following command in your rails console
+
+	CombiSearch.create_table
+
+The best way to add it to a rails project however, is to create a migration for it...
+That migration could look like this.
+
+```ruby
+class CreateCombiSearchEntries < ActiveRecord::Migration
+  def self.up
+    say_with_time("Creating table for combi_search_entries") do
+      CombiSearch.create_table
+    end
+  end
+
+  def self.down
+    say_with_time("Dropping table for combi_search_entries") do
+      CombiSearch.drop_table
+    end
+  end
+end
+```
+
+#### 2. Add `combi_search_scope`'s to your models
+For every model you want to include in your global search you should call `combi_search_scope` with the name of the scope, the model's `attributes` you want to include for that scope, and an optional `if` condition.
+
+Say you have a `Book` and a `Movie` model, and you want to search either on their titles, or all their text-contents; then your setup should look like this.
+
+```ruby
+class Book < ActiveRecord::Base
+  include CombiSearch
+  combi_search_scope :titles, on: [:title]
+  combi_search_scope :full_text, on: [:title, :author, :content]
+end
+
+class Movie < ActiveRecord::Base
+  include CombiSearch
+  combi_search_scope :titles, on: [:title]
+  combi_search_scope :full_text, on: [:title, :director, :script_content]
+end 
+```
+
+If you only want to include `published` books, when you search in the titles scope, then you should change your code like this.
+
+```ruby
+  combi_search_scope :titles, on: => [:title], if: lambda { |book| book.published }
+```
+
+#### 3. Create your search index
+The search-index gets updated once your model is updated. To make sure your search-index is up-to-date when you add it for pre-existing models, you can run the following in your console:
+
+	# delete existing index
+	CombiSearch.remove_index
+	
+	# Create index for Book's
+	Book.update_combi_search
+	
+	# Create index for Movie's
+	Movie.update_combi_search
+
+The best way _again_ to do this for your rails project, is to create a migration for it...
+That migration could look like this.
+
+```ruby
+class CreateCombiSearchEntries < ActiveRecord::Migration
+  def self.up
+    say_with_time("Updating search index") do
+      CombiSearch.remove_index
+      Book.update_combi_search
+      Movie.update_combi_search
+    end
+  end
+
+  def self.down
+    # there isn't a down migration for this....
+  end
+end
+```
+
+#### 4. That's it: search for it!
+To find all Book's and Movie's where the `:titles` includes Harry Potter:
+
+	library_items = CombiSearch.scoped(:titles).search("Harry Potter")
+	
+To find all Book's and Movie's where the `:full_text` includes "Abacadabra":
+
+	library_items = CombiSearch.scoped(:full_text).search("Abacadabra")
+	
+This returns an `ActiveRecord::Relation` of `CombiSearch::Entry` models. They are not that interesting.... however they have a relation to an included `searchable` model which is the original (`Book` or `Movie`) model.
+
+The following code:
+
+```ruby
+	library_items = CombiSearch.scoped(:titles).search("Harry Potter")
+	
+	library_items.each { |item| 
+		original = item.searchable
+		if original.is_a?(Book)
+			puts "We found a Book; and the title is: #{original.title}"
+		end
+		if original.is_a?(Movie)
+			puts "We found a Movie; and the director is: #{original.director}"
+		end
+	}
+```
+
+Could output something like:
+	
+	We found a Movie; and the director is: Chris Columbus
+	We found a Book; and the title is: Harry Potter and the Sorcerer's Stone
+
+## Development
+
+After checking out the repo, run `bundle exec rspec spec` to run the tests.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/douweh/combi_search/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "combi_search"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/combi_search.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'combi_search/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "combi_search"
+  spec.version       = CombiSearch::VERSION
+  spec.authors       = ["Douwe Homans"]
+  spec.email         = ["douwe@avocado.nl"]
+
+  spec.summary       = "Search in multiple models with one combined query."
+  spec.description   = "Use CombiSearch to add a 'global' search to your app. For example; if you have `Book`s and `Movie`s and you want a combined search where you search in all of your titles."
+  spec.homepage      = "https://github.com/douweh/combi_search"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.2"
+
+  spec.add_dependency "rails", "~> 4.0"
+  spec.add_dependency "sqlite3"
+  spec.add_dependency "search_cop"
+end

data/lib/combi_search.rb

@@ -0,0 +1,124 @@
+require "active_support"
+
+require "combi_search/version"
+require "combi_search/entry"
+require "combi_search/migration"
+
+module CombiSearch
+  extend ActiveSupport::Concern
+
+  included do
+
+    has_many :search_entries,
+             :as => :searchable,
+             :class_name => "CombiSearch::Entry",
+             :dependent => :delete_all
+
+    # register after_save handler to update search entry
+    after_save :update_search_entries
+
+    # register class_attribute combi_search_scopes to store search scopes
+    class_attribute :combi_search_scopes
+    self.combi_search_scopes = {};
+  end
+
+  def search_string_for_attrs(attrs)
+    if attrs.class == Array
+      return attrs.map { |attr| search_string_for_attrs(attr)}.join("\n")
+    end
+    if attrs.class == Symbol
+      return send(attrs)
+    end
+  end
+
+  def update_search_entries
+    # Retrieve all combi_search_scopes defined for our class
+    search_scopes = self.class.combi_search_scopes
+    existing_entries_hash = {}
+    search_entries.pluck(:id, :scope).each { |result|
+      existing_entries_hash[result[1].to_sym] = result[0]
+    }
+    search_scopes.each { |scope, array_with_configs|
+
+      # loop over all configs, to determine our searchable_text, if any...
+      search_entry_should_exist = false
+      searchable_text = ""
+
+      array_with_configs.each { |option|
+
+        # if an :if condition was defined, test it
+        if option[:if] && option[:if].is_a?(Proc)
+          if_condition_matched = option[:if].call(self)
+
+          # if this condition matched, we should use the text defined in this configuration
+          if if_condition_matched
+            search_entry_should_exist = true
+            searchable_text = search_string_for_attrs(option[:on])
+          end
+
+          # if there was no 'if' condition, then we shouldn't test for it,
+          # we should use the text defined in this configuration
+        else
+          search_entry_should_exist = true
+          searchable_text = search_string_for_attrs(option[:on])
+        end
+      }
+
+      # if we found a matching config (either with if-condition or not), create or update the entry
+      if search_entry_should_exist
+        # pre existing search_entry
+        id = existing_entries_hash[scope]
+        if !id.nil?
+          search_entries.update(id, :content=>searchable_text)
+          existing_entries_hash.delete(scope)
+        else
+          search_entries.create(:scope=>scope, :content=>searchable_text)
+        end
+      end
+    }
+
+    # add this point all pre_existing_entries should be updated and removed from the hash
+    # when there are still entries in the hash it means that 'scope' got removed in code
+    # therefore we should remove it's search_entry from the database
+    remove_ids = existing_entries_hash.each { |scope, id|
+      search_entries.delete(id)
+    }
+  end
+
+  module ClassMethods
+
+    # Method to add a combi_search_scope for a specific model
+    # Usage:
+    #   combi_search_scope :public, on: [:name, :title, :something_else]
+    def combi_search_scope(name, options = {})
+      if options.nil? || options[:on].nil? || !(options[:on].class == Symbol || options[:on].class == Array)
+        raise "No attributes defined for combi_search_scope: #{:name}, in: #{self}"
+      end
+
+      if !self.combi_search_scopes[name].is_a?(Array)
+        self.combi_search_scopes[name]=[]
+      end
+      self.combi_search_scopes[name].push(options)
+    end
+
+    def update_combi_search
+      self.all.each { |model|
+        model.update_search_entries
+      }
+    end
+
+  end
+
+
+  ## MODULE METHODS
+
+  def self.scoped(scope)
+    CombiSearch::Entry.where(:scope=>scope).includes(:searchable)
+  end
+
+  def self.remove_index
+    CombiSearch::Entry.destroy_all
+  end
+
+
+end

data/lib/combi_search/entry.rb

@@ -0,0 +1,15 @@
+require "active_record"
+require "search_cop"
+
+module CombiSearch
+  class Entry < ActiveRecord::Base
+    include SearchCop
+
+    self.table_name = 'combi_search_entries'
+    belongs_to :searchable, :polymorphic => true
+
+    search_scope :search do
+      attributes :content
+    end
+  end
+end

data/lib/combi_search/migration.rb

@@ -0,0 +1,14 @@
+module CombiSearch
+  def self.create_table
+    ActiveRecord::Base.connection.create_table :combi_search_entries do |t|
+      t.text :content
+      t.text :scope
+      t.belongs_to :searchable, :polymorphic => true
+      t.timestamps null: true
+    end
+  end
+
+  def self.drop_table
+    ActiveRecord::Base.connection.drop_table :combi_search_entries
+  end
+end

data/lib/combi_search/version.rb

@@ -0,0 +1,3 @@
+module CombiSearch
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: combi_search
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Douwe Homans
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: search_cop
+  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'
+description: Use CombiSearch to add a 'global' search to your app. For example; if
+  you have `Book`s and `Movie`s and you want a combined search where you search in
+  all of your titles.
+email:
+- douwe@avocado.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- combi_search.gemspec
+- lib/combi_search.rb
+- lib/combi_search/entry.rb
+- lib/combi_search/migration.rb
+- lib/combi_search/version.rb
+homepage: https://github.com/douweh/combi_search
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Search in multiple models with one combined query.
+test_files: []