Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 107 lines (61 sloc) 3.642 kb
893ddf52 »
2009-11-23 first import
1 = dm-lucene-adapter
2
3 *Homepage*: [http://dm-lucene-adapter.rubyforge.org]
4
5 *Git*: [http://github.com/mkristian/dm-lucene-adapter]
6
7 *Author*: Kristian Meier
8
9 *Copyright*: 2009
10
11 == DESCRIPTION:
12
a84bda5d »
2010-01-13 round up for new gem-maven-plugin
13 adapter to use lucene with datamapper (datamapper.org). you can search in a fuzzy manner with use of :like in the condition without any wildcards.
893ddf52 »
2009-11-23 first import
14
6f5901f8 »
2009-11-25 reached be now in workable state: CRUD with basic search
15 == FEATURES/PROBLEMS/LIMITATIONS:
893ddf52 »
2009-11-23 first import
16
a84bda5d »
2010-01-13 round up for new gem-maven-plugin
17 * lucene is java library so the whole thing works ONLY with jruby !!!!
18
6f5901f8 »
2009-11-25 reached be now in workable state: CRUD with basic search
19 * can handle only resources with Serial
20
21 * handles all properties internally as Strings, i.e. all GT, GTE, LT, LTE, Range queries do not work
22
23 * limit and offset with sorting will retrieving the complete result set, sorts it and apply the limit and offset to it.
24
a84bda5d »
2010-01-13 round up for new gem-maven-plugin
25 * fuzzy search has only default fuzzyness (0.5) and the fuzzy search is always ON when using :like without any wildcards
893ddf52 »
2009-11-23 first import
26
27 == SYNOPSIS:
28
29 FIX (code sample of usage)
30
31 == REQUIREMENTS:
32
a84bda5d »
2010-01-13 round up for new gem-maven-plugin
33 * lucene-core-3.0.0.jar in classpath or install it as gem with maven
893ddf52 »
2009-11-23 first import
34
35 == INSTALL:
36
37 * jgem install dm-lucene-adapter
38
a84bda5d »
2010-01-13 round up for new gem-maven-plugin
39 = WORKING WITH THE SOURCES
40
41 == the ruby way
42
43 * gem install rake-compiler
44
45 * first install lucene jar (needs maven) : mvn initialize
46
47 * install lucene library as gem (optional): mvn -P install-lucene-as-gem
48 will be used by dm-lucene-adapter when installed
49
50 * building the source: jruby -S rake compile
51
52 * running the specs : jruby -S rake spec
53
54 * install the gem : jruby -S rake install
55
56 == maven way
57
58 the maven setup allows to use a local setup of gems for the project only. when you add the 'localgems' profile (add -P localgems or comma separate the profiles like -P maven3,localgems) then you will get a rubygems repository in the directory 'target/rubygems'. it is also possible to define a rubygems repository for all uses of maven via the settings.xml (more details under http://github.com/mkristian/jruby-maven-plugins/ )
59
60 === maven2
61
62 * first you need to make sure you have the 'dm-core' gem installed
63
64 * building the source and running the specs : mvn install
65
66 * building the source without running the specs: mvn install -DskipSpecs=true
67
68 === maven3
69
70 * maven will install all the needed gems like dm-core, etc
71
72 * building the source and running the specs : mvn -P maven3 install
73
74 * building the source without running the specs: mvn -P maven3 install -DskipSpecs=true
75
76 === maven2 + maven3
77
78 * install the gem, after a prior run of install: mvn gem:install
79
80 * install lucene library as gem : mvn -P install-lucene-as-gem
81 will be used by dm-lucene-adapter when installed
82
83
84 = LICENSE:
893ddf52 »
2009-11-23 first import
85
86 (The MIT License)
87
88 Copyright (c) 2009 Kristian Meier
89
90 Permission is hereby granted, free of charge, to any person obtaining
91 a copy of this software and associated documentation files (the
92 'Software'), to deal in the Software without restriction, including
93 without limitation the rights to use, copy, modify, merge, publish,
94 distribute, sublicense, and/or sell copies of the Software, and to
95 permit persons to whom the Software is furnished to do so, subject to
96 the following conditions:
97
98 The above copyright notice and this permission notice shall be
99 included in all copies or substantial portions of the Software.
100
101 THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
102 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
103 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
104 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
105 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
106 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
107 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Something went wrong with that request. Please try again.