activesearch 0.0.1

Sign up to get free protection for your applications and to get access to all the features.
data/.gitignore ADDED
@@ -0,0 +1,17 @@
1
+ *.gem
2
+ *.rbc
3
+ .bundle
4
+ .config
5
+ .yardoc
6
+ Gemfile.lock
7
+ InstalledFiles
8
+ _yardoc
9
+ coverage
10
+ doc/
11
+ lib/bundler/man
12
+ pkg
13
+ rdoc
14
+ spec/reports
15
+ test/tmp
16
+ test/version_tmp
17
+ tmp
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in activesearch.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,22 @@
1
+ Copyright (c) 2012 Rodrigo Alvarez
2
+
3
+ MIT License
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining
6
+ a copy of this software and associated documentation files (the
7
+ "Software"), to deal in the Software without restriction, including
8
+ without limitation the rights to use, copy, modify, merge, publish,
9
+ distribute, sublicense, and/or sell copies of the Software, and to
10
+ permit persons to whom the Software is furnished to do so, subject to
11
+ the following conditions:
12
+
13
+ The above copyright notice and this permission notice shall be
14
+ included in all copies or substantial portions of the Software.
15
+
16
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
20
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
21
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
22
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,45 @@
1
+ # Activesearch
2
+
3
+ This gem allows any class to be indexed by the chosen fulltext search engine.
4
+
5
+ ## Installation
6
+
7
+ Add this line to your application's Gemfile:
8
+
9
+ gem 'activesearch'
10
+
11
+ And then execute:
12
+
13
+ $ bundle
14
+
15
+ Or install it yourself as:
16
+
17
+ $ gem install activesearch
18
+
19
+ ## Supported engines
20
+
21
+ ###Mongoid
22
+
23
+ This is not a fulltext search engine, but it's a good solution for those users that don't have access to anything else.
24
+ It works by storing keywords taken from the specified fields and storing them in an Array field, which would be indexed.
25
+ fts() method will return a Mongod::Criteria, so you can chain it with further scopes.
26
+
27
+ ## Usage
28
+
29
+ class SomeModel
30
+ # [...] field definitions if needed
31
+ include ActiveSearch::Engine # "Engine" being your chosen engine ie. "Mongoid"
32
+
33
+ search_on :title, :body
34
+ end
35
+
36
+ SomeModel.fts("some words") # "fts" for full text search
37
+
38
+
39
+ ## Contributing
40
+
41
+ 1. Fork it
42
+ 2. Create your feature branch (`git checkout -b my-new-feature`)
43
+ 3. Commit your changes (`git commit -am 'Add some feature'`)
44
+ 4. Push to the branch (`git push origin my-new-feature`)
45
+ 5. Create new Pull Request
data/Rakefile ADDED
@@ -0,0 +1 @@
1
+ require "bundler/gem_tasks"
@@ -0,0 +1,23 @@
1
+ # -*- encoding: utf-8 -*-
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'activesearch/version'
5
+
6
+ Gem::Specification.new do |gem|
7
+ gem.name = "activesearch"
8
+ gem.version = Activesearch::VERSION
9
+ gem.authors = ["Rodrigo Alvarez"]
10
+ gem.email = ["papipo@gmail.com"]
11
+ gem.description = %q{ORM agnostic full text search}
12
+ gem.summary = %q{ActiveSearch lets you plug in a ruby module in any class that will allow you to do full text searches.}
13
+ gem.homepage = ""
14
+
15
+ gem.files = `git ls-files`.split($/)
16
+ gem.executables = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
17
+ gem.test_files = gem.files.grep(%r{^(test|spec|features)/})
18
+ gem.require_paths = ["lib"]
19
+
20
+ gem.add_development_dependency "rspec"
21
+ gem.add_development_dependency "bson_ext"
22
+ gem.add_development_dependency "mongoid", "~> 2.4"
23
+ end
@@ -0,0 +1,4 @@
1
+ require "activesearch/version"
2
+
3
+ module Activesearch
4
+ end
@@ -0,0 +1,26 @@
1
+ module ActiveSearch
2
+ module Mongoid
3
+ def self.included(base)
4
+ base.extend ClassMethods
5
+ end
6
+
7
+ module ClassMethods
8
+ def search_on(*fields)
9
+ field :_keywords, type: Array
10
+ index :_keywords
11
+
12
+ before_save do
13
+ self._keywords = []
14
+
15
+ fields.each do |f|
16
+ self._keywords = self._keywords | self[f].downcase.split if self[f]
17
+ end
18
+ end
19
+ end
20
+
21
+ def fts(query)
22
+ all_in(_keywords: query.split)
23
+ end
24
+ end
25
+ end
26
+ end
@@ -0,0 +1,3 @@
1
+ module Activesearch
2
+ VERSION = "0.0.1"
3
+ end
@@ -0,0 +1,6 @@
1
+ test:
2
+ sessions:
3
+ default:
4
+ database: mongoid
5
+ hosts:
6
+ - localhost:27017
@@ -0,0 +1,35 @@
1
+ require 'mongoid'
2
+ require 'activesearch/mongoid'
3
+
4
+ Mongoid.database = Mongo::Connection.new("localhost").db("activesearch_test")
5
+
6
+ class MongoidModel
7
+ include Mongoid::Document
8
+ include ActiveSearch::Mongoid
9
+
10
+ field :title, type: String
11
+ field :text, type: String
12
+ field :junk, type: String
13
+ search_on :title, :text
14
+ end
15
+
16
+ describe ActiveSearch::Mongoid do
17
+ before do
18
+ MongoidModel.delete_all
19
+ @findable = MongoidModel.create!(title: "Findable")
20
+ @quite_findable = MongoidModel.create!(title: "Some title", text: "Findable text")
21
+ MongoidModel.create!(title: "Junk", junk: "Findable junk")
22
+ end
23
+
24
+ it "should find the expected documents" do
25
+ MongoidModel.fts("findable").to_a.should == [@findable, @quite_findable]
26
+ end
27
+
28
+ it "should store the proper keywords" do
29
+ @quite_findable._keywords.should == %w{some title findable text}
30
+ end
31
+
32
+ it "should be chainable" do
33
+ MongoidModel.fts("findable").should respond_to(:where)
34
+ end
35
+ end
metadata ADDED
@@ -0,0 +1,107 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: activesearch
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.0.1
5
+ prerelease:
6
+ platform: ruby
7
+ authors:
8
+ - Rodrigo Alvarez
9
+ autorequire:
10
+ bindir: bin
11
+ cert_chain: []
12
+ date: 2012-10-25 00:00:00.000000000 Z
13
+ dependencies:
14
+ - !ruby/object:Gem::Dependency
15
+ name: rspec
16
+ requirement: !ruby/object:Gem::Requirement
17
+ none: false
18
+ requirements:
19
+ - - ! '>='
20
+ - !ruby/object:Gem::Version
21
+ version: '0'
22
+ type: :development
23
+ prerelease: false
24
+ version_requirements: !ruby/object:Gem::Requirement
25
+ none: false
26
+ requirements:
27
+ - - ! '>='
28
+ - !ruby/object:Gem::Version
29
+ version: '0'
30
+ - !ruby/object:Gem::Dependency
31
+ name: bson_ext
32
+ requirement: !ruby/object:Gem::Requirement
33
+ none: false
34
+ requirements:
35
+ - - ! '>='
36
+ - !ruby/object:Gem::Version
37
+ version: '0'
38
+ type: :development
39
+ prerelease: false
40
+ version_requirements: !ruby/object:Gem::Requirement
41
+ none: false
42
+ requirements:
43
+ - - ! '>='
44
+ - !ruby/object:Gem::Version
45
+ version: '0'
46
+ - !ruby/object:Gem::Dependency
47
+ name: mongoid
48
+ requirement: !ruby/object:Gem::Requirement
49
+ none: false
50
+ requirements:
51
+ - - ~>
52
+ - !ruby/object:Gem::Version
53
+ version: '2.4'
54
+ type: :development
55
+ prerelease: false
56
+ version_requirements: !ruby/object:Gem::Requirement
57
+ none: false
58
+ requirements:
59
+ - - ~>
60
+ - !ruby/object:Gem::Version
61
+ version: '2.4'
62
+ description: ORM agnostic full text search
63
+ email:
64
+ - papipo@gmail.com
65
+ executables: []
66
+ extensions: []
67
+ extra_rdoc_files: []
68
+ files:
69
+ - .gitignore
70
+ - Gemfile
71
+ - LICENSE.txt
72
+ - README.md
73
+ - Rakefile
74
+ - activesearch.gemspec
75
+ - lib/activesearch.rb
76
+ - lib/activesearch/mongoid.rb
77
+ - lib/activesearch/version.rb
78
+ - spec/config/mongoid.yml
79
+ - spec/mongoid_spec.rb
80
+ homepage: ''
81
+ licenses: []
82
+ post_install_message:
83
+ rdoc_options: []
84
+ require_paths:
85
+ - lib
86
+ required_ruby_version: !ruby/object:Gem::Requirement
87
+ none: false
88
+ requirements:
89
+ - - ! '>='
90
+ - !ruby/object:Gem::Version
91
+ version: '0'
92
+ required_rubygems_version: !ruby/object:Gem::Requirement
93
+ none: false
94
+ requirements:
95
+ - - ! '>='
96
+ - !ruby/object:Gem::Version
97
+ version: '0'
98
+ requirements: []
99
+ rubyforge_project:
100
+ rubygems_version: 1.8.24
101
+ signing_key:
102
+ specification_version: 3
103
+ summary: ActiveSearch lets you plug in a ruby module in any class that will allow
104
+ you to do full text searches.
105
+ test_files:
106
+ - spec/config/mongoid.yml
107
+ - spec/mongoid_spec.rb