active_lucene 0.5.0

data/README.textile

@@ -0,0 +1,64 @@
+h2. ABOUT:
+
+ActiveLucene is an ActiveRecord/ActiveModel's like interface to Apache Lucene, with support for dynamic attributes, pagination, highlighting and Lucene's query syntax.
+
+ActiveLucene was extracted from Lunr:
+
+http://github.com/dcrec1/lunr
+
+ActiveLucene works with JRuby like this:
+
+<pre><code>class Advertise < ActiveLucene::Document
+end
+
+Advertise.create! :param1 => 'value 1', :param2 => 'value 2'
+
+Advertise.find :all
+Advertise.find "5"
+
+Advertise.search "value*"
+Advertise.search "param2:'value 2' AND param3:lorem"
+Advertise.search "param2:value OR param3:lorem"
+
+Advertise.search :param1 => 'value 1', :param2 => 'value'
+
+Advertise.serach(:param1 => 'va?ue').first.highlight
+
+Advertise.serach(:param1 => 'va?ue').total_pages</code></pre>
+
+Advertise#search accepts as a parameter any query supported by Lucene. For more information:
+
+http://lucene.apache.org/java/2_3_2/queryparsersyntax.html
+
+Note that you don't need to specify attributes, they are dynamic!
+
+The pagination is supposed to be compatible with will_paginate:
+
+http://github.com/mislav/will_paginate
+
+For more examples, please refer to the specs.
+
+h2. LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2010
+
+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/Rakefile

@@ -0,0 +1,47 @@
+require 'rubygems'
+require 'rubygems/specification'
+require 'rake'
+require 'rake/gempackagetask'
+require 'spec/rake/spectask'
+ 
+GEM = "active_lucene"
+GEM_VERSION = "0.5.0"
+SUMMARY = "ActiveRecord/ActiveModel's like interface for Lucene"
+AUTHOR = "Diego Carrion"
+EMAIL = "dc.rec1@gmail.com"
+HOMEPAGE = "http://www.diegocarrion.com"
+
+ 
+spec = Gem::Specification.new do |s|
+  s.name = GEM
+  s.version = GEM_VERSION
+  s.platform = Gem::Platform::RUBY
+  s.summary = SUMMARY
+  s.require_paths = ['lib']
+  s.files = FileList['lib/**/*.rb', '[A-Z]*'].to_a
+  
+  s.author = AUTHOR
+  s.email = EMAIL
+  s.homepage = HOMEPAGE
+end
+
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.spec_opts = %w(-fs --color)
+end
+  
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+ 
+desc "Install the gem locally"
+task :install => [:package] do
+  sh %{sudo gem install pkg/#{GEM}-#{GEM_VERSION}}
+end
+ 
+desc "Create a gemspec file"
+task :make_spec do
+  File.open("#{GEM}.gemspec", "w") do |file|
+    file.puts spec.to_ruby
+  end
+end

data/lib/active_lucene.rb

@@ -0,0 +1,31 @@
+require 'java'
+require 'rubygems'
+require 'active_support'
+
+Dir[File.expand_path(File.dirname(__FILE__) + "/*.jar")].each { |path| require path.split('/').last.gsub('.jar', '') }
+import org.apache.lucene.document.Field
+import org.apache.lucene.store.FSDirectory
+import org.apache.lucene.index.IndexWriter
+import org.apache.lucene.analysis.standard.StandardAnalyzer
+import org.apache.lucene.queryParser.standard.StandardQueryParser
+
+import org.apache.lucene.search.IndexSearcher
+import org.apache.lucene.search.BooleanClause
+import org.apache.lucene.search.BooleanQuery
+import org.apache.lucene.search.MatchAllDocsQuery
+import org.apache.lucene.search.WildcardQuery
+
+import org.apache.lucene.search.highlight.QueryScorer
+import org.apache.lucene.search.highlight.Highlighter
+
+import org.apache.lucene.util.Version
+
+APP_ROOT ||= RAILS_ROOT if defined?(RAILS_ROOT)
+APP_ENV ||= RAILS_ENV if defined?(RAILS_ENV)
+
+%w(analyzer document index query searcher term writer).each { |name| require "active_lucene/#{name}" }
+
+module ActiveLucene
+  ID = 'id'
+  ALL = '_all'
+end

data/lib/active_lucene/analyzer.rb

@@ -0,0 +1,7 @@
+module ActiveLucene
+  class Analyzer < StandardAnalyzer
+    def initialize
+      super Version::LUCENE_30
+    end
+  end
+end

data/lib/active_lucene/document.rb

@@ -0,0 +1,70 @@
+module ActiveLucene
+  class Document
+    PER_PAGE = 20
+
+    attr_reader :attributes, :id, :highlight
+
+    def initialize(attributes = {})
+      @attributes = attributes.stringify_keys
+      @highlight = @attributes.delete('highlight')
+      @id = @attributes.delete('id') || object_id.to_s
+    end
+
+    def save
+      document = org.apache.lucene.document.Document.new
+      _all = []
+      @attributes.each do |key, value|
+        document.add Field.new key, value, Field::Store::YES, Field::Index::ANALYZED
+        _all << value
+      end
+      document.add Field.new ID, @id, Field::Store::YES, Field::Index::NOT_ANALYZED
+      document.add Field.new ALL, _all.join(' '), Field::Store::NO, Field::Index::ANALYZED
+      Writer.write document
+    end
+
+    def destroy
+      Writer.delete @id
+    end
+
+    def update_attributes(new_attributes)
+      destroy
+      self.class.create! attributes.merge(new_attributes.merge(:id => @id))
+    end
+    alias :update_attributes! :update_attributes
+
+    def to_param
+      @id
+    end
+
+    def self.create!(attributes)
+      returning new(attributes) do |model|
+        model.save
+      end
+    end
+
+    def self.find(param)
+      if param.instance_of? Symbol
+        search :all
+      else
+        search(:id => param).first
+      end
+    end
+
+    def self.search(param)
+      search = Searcher.search(param)
+      results = search.attributes.map { |attributes| new attributes }
+      results.instance_eval "def total_pages; #{search.total_pages}; end;"
+      results
+    end
+
+    def self.columns
+      []
+    end
+
+    private
+
+    def method_missing(method_name, *args)
+      @attributes[method_name.to_s]
+    end
+  end
+end

data/lib/active_lucene/index.rb

@@ -0,0 +1,9 @@
+module ActiveLucene
+  module Index
+    PATH = "#{APP_ROOT}/db/lucene/#{APP_ENV}"
+
+    def directory
+      FSDirectory.open java.io.File.new(PATH)
+    end
+  end
+end

data/lib/active_lucene/query.rb

@@ -0,0 +1,28 @@
+module ActiveLucene
+  class Query
+
+    def self.for(param)
+      if param.instance_of? Hash
+        for_attributes param
+      elsif param.instance_of? Symbol
+        MatchAllDocsQuery.new
+      else
+        for_string param
+      end
+    end
+
+    private
+
+    def self.for_attributes(attributes)
+      returning BooleanQuery.new do |query|
+        attributes.each do |key, value|
+          query.add WildcardQuery.new(ActiveLucene::Term.for(key, value)), BooleanClause::Occur::MUST
+        end
+      end
+    end
+
+    def self.for_string(string)
+      StandardQueryParser.new(Analyzer.new).parse(string, ALL)
+    end
+  end
+end

data/lib/active_lucene/searcher.rb

@@ -0,0 +1,33 @@
+module ActiveLucene
+  class Searcher < IndexSearcher
+    include Index
+
+    attr_reader :attributes, :total_pages
+
+    def initialize
+      super directory, true
+    end
+
+    def self.search(param)
+      returning new do |searcher|
+        searcher.search param
+      end
+    end
+
+    def search(param)
+      query = Query.for(param)
+      top_docs = super(query, nil, Document::PER_PAGE)
+      @attributes = top_docs.scoreDocs.map do |score_doc|
+        attributes = {}
+        doc(score_doc.doc).fields.each do |field|
+          attributes.store field.name, field.string_value
+          highlight = Highlighter.new(QueryScorer.new(query)).get_best_fragment(Analyzer.new, ALL, field.string_value)
+          attributes[:highlight] = highlight if highlight
+        end
+        attributes
+      end
+      @total_pages = (top_docs.totalHits / Document::PER_PAGE.to_f).ceil
+    end
+
+  end
+end

data/lib/active_lucene/term.rb

@@ -0,0 +1,7 @@
+module ActiveLucene
+  class Term
+    def self.for(name, value)
+      org.apache.lucene.index.Term.new name.to_s, value.to_s.downcase
+    end
+  end
+end

data/lib/active_lucene/writer.rb

@@ -0,0 +1,24 @@
+module ActiveLucene
+  class Writer < IndexWriter
+    include Index
+
+    def initialize
+      overwrite = Dir[PATH + '/*'].size < 1
+      super directory, Analyzer.new, overwrite, IndexWriter::MaxFieldLength::UNLIMITED
+      yield self
+      close
+    end
+
+    def self.write(document)
+      new do |index|
+        index.add_document document
+      end
+    end
+
+    def self.delete(id)
+      new do |index|
+        index.delete_documents ActiveLucene::Term.for(ID, id)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification 
+name: active_lucene
+version: !ruby/object:Gem::Version 
+  version: 0.5.0
+platform: ruby
+authors: 
+- Diego Carrion
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-23 00:00:00 -02:00
+default_executable: 
+dependencies: []
+
+description: 
+email: dc.rec1@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/active_lucene/analyzer.rb
+- lib/active_lucene/document.rb
+- lib/active_lucene/index.rb
+- lib/active_lucene/query.rb
+- lib/active_lucene/searcher.rb
+- lib/active_lucene/term.rb
+- lib/active_lucene/writer.rb
+- lib/active_lucene.rb
+- Rakefile
+- README.textile
+has_rdoc: true
+homepage: http://www.diegocarrion.com
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: ActiveRecord/ActiveModel's like interface for Lucene
+test_files: []
+