Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

first commit

  • Loading branch information...
commit 9066cf1ce53163be746b8a5a2622f795a6382c97 0 parents
David Andersen authored
6 History.txt
@@ -0,0 +1,6 @@
+=== 1.0.0 / 2008-07-23
+
+* 1 major enhancement
+
+ * Birthday!
+
9 Manifest.txt
@@ -0,0 +1,9 @@
+./build/jruby-lucene.gemspec
+./ext/LICENSE.txt
+./ext/lucene-core-2.3.2.jar
+./History.txt
+./lib/jruby/lucene.rb
+./Manifest.txt
+./Rakefile
+./README
+./test/test_all.rb
59 README
@@ -0,0 +1,59 @@
+= jruby-lucene
+
+* http://github.com/davidx/jruby-lucene/tree
+
+== DESCRIPTION:
+
+A jruby wrapper for lucene.
+
+== FEATURES/PROBLEMS:
+
+* Currently a basic prototype only
+
+== SYNOPSIS:
+
+require 'rubygems'
+require 'jruby/lucene'
+
+lucene = Lucene.new
+
+* Search:
+ result = lucene.search("testing 123")
+* Add documents
+ lucene.add_documents(id_text_pair_array) # e.g., [[1,"test1"],[2,'test2']]
+* Delete documents
+ lucene.delete_documents(id_array) # e.g., [1,5,88]
+
+== REQUIREMENTS:
+
+* simple wrapper jruby lucene demonstration
+
+== INSTALL:
+
+ /usr/local/jruby/bin/rake build
+ /usr/local/jruby/bin/gem install jruby-lucene
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 Mark Watson, David Andersen
+
+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.
12 Rakefile
@@ -0,0 +1,12 @@
+
+require 'rubygems'
+require 'rake'
+JRUBY_HOME=ENV['JRUBY_HOME']||'/usr/local/jruby'
+
+task :build do
+ print `#{JRUBY_HOME}/bin/gem build build/jruby-lucene.gemspec`
+end
+
+task :test do
+ print `jruby -v test/test_all.rb`
+end
22 build/jruby-lucene.gemspec
@@ -0,0 +1,22 @@
+require 'lib/jruby/lucene'
+
+
+Gem::Specification.new do |s|
+
+ s.name = 'jruby-lucene'
+ s.version = Lucene::VERSION
+ s.platform = Gem::Platform::RUBY
+ s.summary = <<-DESC.strip.gsub(/\n\s+/, " ")
+ A jruby interface to the native java lucene library
+ DESC
+
+ s.files = Dir.glob("{lib,test,ext}/**/*") + %w(README)
+ s.require_path = 'lib'
+ s.has_rdoc = true
+
+ s.authors = ["Mark Watson", "David Andersen"]
+ s.email = ["mark.watson@gmail.com", "davidx@gmail.com"]
+ s.homepage = "http://github.com/davidx/jruby-lucene/tree"
+ s.rubyforge_project = "jruby-lucene"
+
+end
BIN  data/0/_0.cfs
Binary file not shown
BIN  data/0/_0_1.del
Binary file not shown
BIN  data/0/_1.cfs
Binary file not shown
BIN  data/0/segments.gen
Binary file not shown
BIN  data/0/segments_6
Binary file not shown
202 ext/LICENSE.txt
@@ -0,0 +1,202 @@
+
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright [yyyy] [name of copyright owner]
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
BIN  ext/lucene-core-2.3.2.jar
Binary file not shown
BIN  jruby-lucene-1.0.2.gem
Binary file not shown
BIN  jruby-lucene-1.0.3.gem
Binary file not shown
58 lib/jruby/lucene.rb
@@ -0,0 +1,58 @@
+
+require "java"
+
+require File.dirname(__FILE__) + "/../../ext/lucene-core-2.3.2.jar"
+
+class Lucene
+ VERSION = "1.0.3"
+ @index_path = nil
+ def initialize(an_index_path = "data/")
+ @index_path = an_index_path
+ end
+ def add_documents(id_text_pair_array) # e.g., [[1,"test1"],[2,'test2']]
+ index_available = org.apache.lucene.index.IndexReader.index_exists(@index_path)
+ index_writer = org.apache.lucene.index.IndexWriter.new(
+ @index_path,
+ org.apache.lucene.analysis.standard.StandardAnalyzer.new,
+ !index_available)
+ id_text_pair_array.each {|id_text_pair|
+ term_to_delete = org.apache.lucene.index.Term.new("id", id_text_pair[0].to_s) # if it exists
+ a_document = org.apache.lucene.document.Document.new
+ a_document.add(org.apache.lucene.document.Field.new('text', id_text_pair[1],
+ org.apache.lucene.document.Field::Store::YES,
+ org.apache.lucene.document.Field::Index::TOKENIZED))
+ a_document.add(org.apache.lucene.document.Field.new('id', id_text_pair[0].to_s,
+ org.apache.lucene.document.Field::Store::YES,
+ org.apache.lucene.document.Field::Index::TOKENIZED))
+ index_writer.updateDocument(term_to_delete, a_document) # delete any old docs with same id
+ }
+ index_writer.close
+ end
+ def search(query)
+ parse_query = org.apache.lucene.queryParser.QueryParser.new(
+ 'text',
+ org.apache.lucene.analysis.standard.StandardAnalyzer.new)
+ query = parse_query.parse(query)
+ engine = org.apache.lucene.search.IndexSearcher.new(@index_path)
+ hits = engine.search(query).iterator
+ results = []
+ while (hits.hasNext && hit = hits.next)
+ id = hit.getDocument.getField("id").stringValue.to_i
+ text = hit.getDocument.getField("text").stringValue
+ results << [hit.getScore, id, text]
+ end
+ engine.close
+ results
+ end
+ def delete_documents id_array # e.g., [1,5,88]
+ index_available = org.apache.lucene.index.IndexReader.index_exists(@index_path)
+ index_writer = org.apache.lucene.index.IndexWriter.new(
+ @index_path,
+ org.apache.lucene.analysis.standard.StandardAnalyzer.new,
+ !index_available)
+ id_array.each {|id|
+ index_writer.deleteDocuments(org.apache.lucene.index.Term.new("id", id.to_s))
+ }
+ index_writer.close
+ end
+end
BIN  test/data/0/_0.cfs
Binary file not shown
BIN  test/data/0/_0_1.del
Binary file not shown
BIN  test/data/0/_1.cfs
Binary file not shown
BIN  test/data/0/segments.gen
Binary file not shown
BIN  test/data/0/segments_6
Binary file not shown
87 test/test_all.rb
@@ -0,0 +1,87 @@
+$:<< File.dirname(__FILE__) + '/../lib'
+
+require 'jruby/lucene'
+
+require 'test/unit'
+require 'rubygems'
+require 'fileutils'
+
+class IndexWriter < org.apache.lucene.index.IndexWriter; end
+class IndexReader < org.apache.lucene.index.IndexReader; end
+class StandardAnalyzer < org.apache.lucene.analysis.standard.StandardAnalyzer; end
+
+class TestLucene < Test::Unit::TestCase
+ INDEXPATH = './data/0'
+ DATA=[[1, "this is a test"], [2, "this is another test"]]
+ def test_create_index
+ FileUtils.rm_rf( INDEXPATH )
+ assert !File.exists?( INDEXPATH )
+ index_available = IndexReader.index_exists(INDEXPATH)
+ assert_not_nil index_available
+ assert_kind_of FalseClass, index_available
+ writer = IndexWriter.new(INDEXPATH, StandardAnalyzer.new, !index_available)
+ index_available = IndexReader.index_exists(INDEXPATH)
+ assert_kind_of TrueClass, index_available
+
+ assert File.exists?( INDEXPATH )
+ assert File.directory?( INDEXPATH )
+ assert_not_nil writer
+ assert_kind_of IndexWriter, writer
+ remove_index
+ end
+
+ def test_new
+ assert Object.const_defined?("Lucene")
+ assert Lucene.respond_to?(:new)
+ assert_nothing_raised { Lucene.new(INDEXPATH) }
+ l = Lucene.new(INDEXPATH)
+ assert_not_nil l
+ assert_kind_of Lucene, l
+ end
+ def test_add_documents
+ remove_index
+ create_index
+ l = Lucene.new(INDEXPATH)
+ assert_not_nil l
+ assert_kind_of Lucene, l
+ result = l.search("foo")
+ assert result.kind_of?( Array ), result.inspect
+ assert result.length == 0
+ l.add_documents([[23, "foo bar"]])
+ result = l.search("foo")
+ assert result.kind_of?( Array ), result.inspect
+ assert result.length > 0
+ end
+ def test_delete_documents
+ remove_index
+ create_index
+ l = Lucene.new(INDEXPATH)
+ l.add_documents([[23, "foo bar"]])
+ result = l.search("foo")
+ assert_kind_of Array, result
+ assert result.length == 1
+ l.delete_documents([23])
+ result = l.search("foo")
+ assert_kind_of Array, result
+ assert result.length == 0
+ end
+ def test_search
+ l = Lucene.new(INDEXPATH)
+ assert l.respond_to?(:search)
+ l.add_documents([[9, "this is yet another test"]])
+ result = l.search("yet")
+ assert_not_nil result
+ assert_kind_of Array, result
+ assert result.length > 0
+ assert_equal 9, result[0][1]
+ end
+ private
+ def create_index(path=INDEXPATH)
+ writer = IndexWriter.new(path, StandardAnalyzer.new, !IndexReader.index_exists(path))
+ writer.close
+ File.exists?(path)
+ end
+ def remove_index(path=INDEXPATH)
+ IndexReader.index_exists(path) ? FileUtils.rm_rf(path) : true
+ end
+end
Please sign in to comment.
Something went wrong with that request. Please try again.