File Coverage

blib/lib/Catmandu/Store/Lucy.pm
Criterion Covered Total %
statement 49 49 100.0
branch 1 2 50.0
condition n/a
subroutine 17 17 100.0
pod n/a
total 67 68 98.5


line stmt bran cond sub pod time code
1             package Catmandu::Store::Lucy;
2              
3 1     1   65151 use Catmandu::Sane;
  1         104922  
  1         6  
4 1     1   210 use Moo;
  1         1  
  1         5  
5 1     1   610 use Lucy::Plan::Schema;
  1         15829  
  1         27  
6 1     1   399 use Lucy::Plan::StringType;
  1         99  
  1         26  
7 1     1   375 use Lucy::Plan::FullTextType;
  1         98  
  1         26  
8 1     1   357 use Lucy::Analysis::PolyAnalyzer;
  1         95  
  1         27  
9 1     1   353 use Lucy::Index::Indexer;
  1         94  
  1         23  
10 1     1   353 use Lucy::Search::IndexSearcher;
  1         391  
  1         28  
11 1     1   371 use Data::MessagePack;
  1         807  
  1         23  
12 1     1   408 use Catmandu::Store::Lucy::Bag;
  1         3  
  1         415  
13              
14             with 'Catmandu::Store';
15              
16             =head1 NAME
17              
18             Catmandu::Store::Lucy - A searchable store backed by Lucy
19              
20             =head1 VERSION
21              
22             Version 0.0101
23              
24             =cut
25              
26             our $VERSION = '0.0102';
27              
28             =head1 SYNOPSIS
29              
30             # From the command line
31              
32             $ catmandu import JSON to Lucy --path /path/to/index/ < data.json
33             $ catmandu export Lucy --path /path/to/index/ to JSON > data.json
34              
35             # From perl
36             use Catmandu;
37              
38             my $store = Catmandu->store('Lucy',path => '/path/to/index/');
39              
40             my $book = $store->bag->add({ title => 'Advanced Perl' });
41              
42             printf "book stored as %s\n", $book->{_id};
43              
44             $store->bag->commit;
45              
46             $bag->get($id);
47              
48             # all bags are iterators
49             $bag->each(sub { ... });
50             $bag->take(10)->each(sub { ... });
51              
52             my $hits = $bag->search(query => 'perl');
53              
54             # hits is an iterator
55             $hits->each(sub {
56             say $_[0]->{title};
57             });
58              
59             $bag->delete($id);
60             $bag->delete_by_query(query => 'perl');
61             $bag->delete_all;
62             $bag->commit;
63              
64             =cut
65              
66             has path => (is => 'ro', required => 1);
67              
68             for my $attr (qw(analyzer ft_field_type schema)) {
69             has "_$attr" => (is => 'ro', lazy => 1, builder => "_build_$attr");
70             }
71              
72             for my $attr (qw(indexer searcher)) {
73             has "_$attr" => (is => 'ro', lazy => 1, builder => "_build_$attr", clearer => 1, predicate => 1);
74             }
75              
76 15     15   207 sub _messagepack { state $_messagepack = Data::MessagePack->new->utf8 }
77              
78             sub _build_analyzer {
79 1     1   342 Lucy::Analysis::PolyAnalyzer->new(language => 'en');
80             }
81              
82             sub _build_ft_field_type {
83 1     1   337 my $self = $_[0];
84 1         4 Lucy::Plan::FullTextType->new(analyzer => $self->_analyzer, stored => 0);
85             }
86              
87             sub _build_schema {
88 1     1   296 my $self = $_[0];
89 1         20 my $schema = Lucy::Plan::Schema->new;
90 1         21 $schema->spec_field(name => '_id', type => Lucy::Plan::StringType->new(stored => 1, sortable => 1));
91 1         7 $schema->spec_field(name => '_bag', type => Lucy::Plan::StringType->new(stored => 0));
92 1         10 $schema->spec_field(name => '_data', type => Lucy::Plan::BlobType->new(stored => 1));
93 1         5 $schema;
94             }
95              
96             sub _build_indexer {
97 4     4   339 my $self = $_[0];
98 4         53 Lucy::Index::Indexer->new(schema => $self->_schema, index => $self->path, create => 1);
99             }
100              
101             sub _build_searcher {
102 5     5   353 my $self = $_[0];
103 5         56 Lucy::Search::IndexSearcher->new(index => $self->path);
104             }
105              
106             sub _commit {
107 4     4   4 my ($self) = @_;
108              
109 4 50       16 if ($self->_has_indexer) {
110 4         56 $self->_indexer->commit;
111 4         13430 $self->_clear_indexer;
112 4         618 $self->_clear_searcher;
113             }
114             }
115              
116             =head1 SEE ALSO
117              
118             L<Catmandu::Store>
119              
120             =head1 AUTHOR
121              
122             Nicolas Steenlant, C<< <nicolas.steenlant at ugent.be> >>
123              
124             =head1 LICENSE AND COPYRIGHT
125              
126             This program is free software; you can redistribute it and/or modify it
127             under the terms of either: the GNU General Public License as published
128             by the Free Software Foundation; or the Artistic License.
129              
130             See http://dev.perl.org/licenses/ for more information.
131              
132             =cut
133              
134             1;