active_triples-solrizer 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7557fd15f57f7f52c0adbead308b52ed7d8f0308
+  data.tar.gz: d7994692b486842fa27216f29e9322ebef3b47c7
+SHA512:
+  metadata.gz: c62b03d3068b7f2b972c9527bf7098ba83e976e812ace4eea043fcffc93601dd3f121796fb6273a91e0673232b12d699dde9043be1cd473e0a5b674a57bda1f7
+  data.tar.gz: 2fbde62084e942428cb4ea155e21598511a0fdd919a8a5f833b45311801da4503d0ce8224acc1418c834dffb06e147a0bc66f46ab90d0d2c38948b08b41e45b9

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,27 @@
+log/*.log
+.sass-cache
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.idea
+.ruby-gemset
+.ruby-version

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+bundler_args: --without debug
+script: "bundle exec rspec spec"
+sudo: false
+cache: bundler
+rvm:
+ - 2.2.4
+ - 2.3.0
+ - jruby-9.0.4.0
+ - rbx-2
+matrix:
+  allow_failures:
+      - rvm: jruby-9.0.4.0
+      - rvm: rbx-2

data/AUTHORS.md

@@ -0,0 +1,3 @@
+* E. Lynette Rayle (elr37@cornell.edu)
+
+Additional Contributors:  Portions of the code were copied and/or modified from [ActiveFedora](https://github.com/projecthydra/active_fedora).  See the [contributors list](https://github.com/projecthydra/active_fedora/blob/master/CONTRIBUTORS.md) for that project.

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+gemspec
+

data/Guardfile

@@ -0,0 +1,9 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/LICENSE

@@ -0,0 +1,12 @@
+##########################################################################
+# 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.

data/README.md

@@ -0,0 +1,253 @@
+# ActiveTriples::Solrizer
+
+[![Build Status](https://travis-ci.org/ActiveTriples/active_triples-solrizer.png?branch=master)](https://travis-ci.org/ActiveTriples/active_triples-solrizer)
+[![Coverage Status](https://coveralls.io/repos/ActiveTriples/active_triples-solrizer/badge.svg?branch=master&service=github)](https://coveralls.io/github/ActiveTriples/active_triples-solrizer?branch=master)
+[![Gem Version](https://badge.fury.io/rb/active_triples-solrizer.svg)](http://badge.fury.io/rb/active_triples-solrizer)
+
+Provides a default solr implementation under the [ActiveTriples](https://github.com/ActiveTriples/ActiveTriples) framework.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'active_triples-solrizer'
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install active_triples-solrizer
+
+
+## Usage
+
+Property definitions for ActiveTriples resources can be extended by adding a block to define indexing data type and modifiers (see table of supported values below).
+
+```
+property :title, :predicate => RDF::SCHEMA.title   do |index|
+  index.data_type = :text         # specify the data type of the field in solr.  See (https://github.com/elrayle/active_triples-solrizer/blob/master/solr/schema.xml)[solr/schema.xml] for field type definitions.
+  index.as :indexed, :sortable    # specify modifiers for the solr field       
+end
+```
+
+| data_type   | Notes |
+| ----------- | ----- |
+| :text       | tokenized text |
+| :text_en    | tokenized English text |
+| :string     | non-tokenized string |
+| :integer    | |
+| :long       | |
+| :double     | |
+| :float      | |
+| :boolean    | |
+| :date       | format for this date field is of the form 1995-12-31T23:59:59Z; Optional fractional seconds are allowed: 1995-12-31T23:59:59.999Z |
+| :coordinate | TBA - used to index the lat and long components for the "location" |
+| :location   | TBA - latitude/longitude|
+| :guess      | allow guessing of the type based on the type of the property value; NOTE: only checks the type of the first value when multiple values |
+
+
+| index.as modifiers | works with types | Notes |
+| ------------------ | ---------------- | ----- |
+| :indexed     | all types except :coordinate           | searchable, but not returned in solr doc unless also has :stored modifier |
+| :stored      | all types except :coordinate           | returned in solr doc, but not searchable unless also has :indexed modifier |
+| :multiValued | all types except :boolean, :coordinate | NOTE: if not specified and multiple values exist, only the first value is included in the solr doc |
+| :sortable    | all types except :boolean, :coordinate, :location | numbers are stored as trie version of numeric type; :string, :text, :text_XX have an extra alphaSort field |
+| :range       | all numeric types including :integer, :long, :float, :double, :date | optimize for range queries |
+| :vectored    | valid for :text, :text_XX only         |  |
+
+NOTE: Modifiers placed on types that do not support the modifier are ignored.
+
+
+## Examples
+
+Common prep code for all examples:
+```ruby
+require 'active_triples'
+require 'active_triples/solrizer'
+
+# create an in-memory repository for ad-hoc testing
+ActiveTriples::Repositories.add_repository :default, RDF::Repository.new
+
+# configure the solr url
+ActiveTriples::Solrizer.configure do |config|
+  config.solr_uri = "http://localhost:8983/solr/#/~cores/active_triples"
+end
+
+# create a DummyResource for ad-hoc testing
+class DummyResource < ActiveTriples::Resource
+  configure :type => RDF::URI('http://example.org/SomeClass')
+  property :title,            :predicate => RDF::SCHEMA.title       do |index|
+    index.data_type = :text
+    index.as :indexed, :sortable
+  end
+  property :description_si,   :predicate => RDF::SCHEMA.description do |index|
+    index.data_type = :text
+    index.as :stored, :indexed
+  end
+  property :borrower_uri_i,   :predicate => RDF::SCHEMA.borrower    do |index|
+    index.data_type = :string
+    index.as :indexed
+  end
+  property :clip_number_simr, :predicate => RDF::SCHEMA.clipNumber  do |index|
+    index.data_type = :integer
+    index.as :stored, :indexed, :multiValued, :range
+  end
+  property :price_s,          :predicate => RDF::SCHEMA.price       do |index|
+    index.data_type = :float
+    index.as :stored
+  end
+  property :bookEdition,      :predicate => RDF::SCHEMA.bookEdition # non-indexed property
+end
+
+
+# initialize solr service with defaults
+ActiveTriples::Solrizer::SolrService.register
+```
+
+### Example: Indexing Service to create solr document
+
+```ruby
+# create a new resource
+dr = DummyResource.new('http://www.example.org/dr')
+dr.title                = 'Test Title'
+dr.description_si       = 'Test text description stored and indexed.'
+dr.borrower_uri_i       = 'http://example.org/i/b2'
+dr.clip_number_simr     = [7,8,9,10]
+dr.price_s              = 789.01
+dr.bookEdition          = 'Ed. 2'
+dr
+
+# get solr doc
+doc = ActiveTriples::Solrizer::IndexingService.new(dr).generate_solr_document
+# =>  {
+#         :id=>"http://www.example.org/dr",
+#         :at_model_ssi=>"DummyResource",
+#         :object_profile_ss=>expected_object_profile_short_all_values,
+#         :title_ti=>"Test Title",
+#         :title_ssort=>"Test Title",
+#         :description_si_tsi=>"Test text description stored and indexed.",
+#         :borrower_uri_i_si=>"http://example.org/i/b2",
+#         :clip_number_simr_itsim=>[7,8,9,10],
+#         :price_s_fs=>789.01
+#     }
+
+
+# persist doc to solr
+ActiveTriples::Solrizer::SolrService.add(doc)
+ActiveTriples::Solrizer::SolrService.commit
+```
+
+### Example: Profile Indexing Service to serialize/deserialize resource
+
+```ruby
+# create a new resource with all properties having values
+dr1 = DummyResource.new('http://www.example.org/dr1')
+dr1.title                = 'Test Title'
+dr1.description_si       = 'Test text description stored and indexed.'
+dr1.borrower_uri_i       = 'http://example.org/i/b2'
+dr1.clip_number_simr     = [7,8,9,10]
+dr1.price_s              = 789.01
+dr1.bookEdition          = 'Ed. 2'
+dr1
+
+# serialize resource into object profile
+object_profile1 = ActiveTriples::Solrizer::ProfileIndexingService.new(dr1).export
+# =>    '{"id":"http://www.example.org/dr1",'\
+#        '"title":["Test Title"],'\
+#        '"description_si":["Test text description stored and indexed."],'\
+#        '"borrower_uri_i":["http://example.org/i/b2"],'\
+#        '"clip_number_simr":[7,8,9,10],'\
+#        '"price_s":[789.01],'\
+#        '"bookEdition":["Ed. 2"]}'
+
+# deserialize resource from object profile
+dr1_filled = ActiveTriples::Solrizer::ProfileIndexingService.new().import( object_profile1, DummyResource )
+dr1_filled.attributes
+# => {"id"=>"http://www.example.org/dr2",
+#     "title"=>["Test Title"],
+#     "description_si"=>["Test text description stored and indexed."],
+#     "borrower_uri_i"=>["http://example.org/i/b2"],
+#     "clip_number_simr"=>[7, 8, 9, 10],
+#     "borrower_uri_i"=>[],
+#     "clip_number_simr"=>[],
+#     "price_s"=>[789.01],
+#     "bookEdition"=>["Ed. 2"]}
+
+# create a new resource with some properties with unset values
+dr2 = DummyResource.new('http://www.example.org/dr2')
+dr2.title                = 'Test Title'
+dr2.description_si       = 'Test text description stored and indexed.'
+dr2.price_s              = 789.01
+dr2.bookEdition          = 'Ed. 2'
+dr2
+
+# serialize resource into object profile
+object_profile2 = ActiveTriples::Solrizer::ProfileIndexingService.new(dr2).export
+# =>    '{"id":"http://www.example.org/dr1",'\
+#        '"title":["Test Title"],'\
+#        '"description_si":["Test text description stored and indexed."],'\
+#        '"borrower_uri_i":[],'\
+#        '"clip_number_simr":[],'\
+#        '"price_s":[789.01],'\
+#        '"bookEdition":["Ed. 2"]}'
+
+# deserialize resource from object profile
+dr2_filled = ActiveTriples::Solrizer::ProfileIndexingService.new().import( object_profile2, DummyResource )
+dr2_filled.attributes
+# => {"id"=>"http://www.example.org/dr2",
+#     "title"=>["Test Title"],
+#     "description_si"=>["Test text description stored and indexed."],
+#     "borrower_uri_i"=>[],
+#     "clip_number_simr"=>[],
+#     "price_s"=>[789.01],
+#     "bookEdition"=>["Ed. 2"]}
+```
+
+
+### Example: Properties Indexing Service to generate solr fields based on property definitions
+
+```ruby
+# NOTE re-use dr1 and dr2 from object profile examples
+
+# generate property fields
+property_fields1 = ActiveTriples::Solrizer::PropertiesIndexingService.new(dr1).export
+# => {
+#        :title_ti=>"Test Title",
+#        :title_ssort=>"Test Title",
+#        :description_si_tsi=>"Test text description stored and indexed.",
+#        :borrower_uri_i_si=>"http://example.org/i/b2",
+#        :clip_number_simr_itsim=>[7,8,9,10],
+#        :price_s_fs=>789.01
+#    }
+
+# generate property fields
+property_fields2 = ActiveTriples::Solrizer::PropertiesIndexingService.new(dr2).export
+# => {
+#        :title_ti=>"Test Title",
+#        :title_ssort=>"Test Title",
+#        :description_si_tsi=>"Test text description stored and indexed.",
+#        :price_s_fs=>789.01
+#    }
+```
+
+## Development Notes:
+
+* I would like to see this expand to support specification of facets.
+* The location and coordinate field types have not been tested and do not have examples.
+* Some of the code in solr_service.rb is untested.  It was copied from ActiveFedora as is.  Mentions in the code to querying have not been tested.  Query code was not copied at the time this document was written.
+
+
+## Contributing
+
+Please observe the following guidelines:
+
+ - Do your work in a feature branch based on ```master``` and rebase before submitting a pull request.
+ - Write tests for your contributions.
+ - Document every method you add using YARD annotations. (_Note: Annotations are sparse in the existing codebase, help us fix that!_)
+ - Organize your commits into logical units.
+ - Don't leave trailing whitespace (i.e. run ```git diff --check``` before committing).
+ - Use [well formed](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) commit messages.
+

data/active_triples-solrizer.gemspec

@@ -0,0 +1,36 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "active_triples/solrizer/version"
+
+Gem::Specification.new do |s|
+  s.name        = "active_triples-solrizer"
+  s.version     = ActiveTriples::Solrizer::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["E. Lynette Rayle"]
+  s.homepage    = 'https://github.com/ActiveTriples/active_triples-solrizer'
+  s.email       = 'elr37@cornell.edu'
+  s.summary     = %q{Provide default solrizer implementation for ActiveTriples.}
+  s.description = %q{active_triples-solrizer provides a default solr indexing implementation for ActiveTriples.}
+  s.license     = "APACHE2"
+  s.required_ruby_version     = '>= 2.2.0'
+
+  s.add_dependency 'rsolr'
+  s.add_dependency('active-triples')
+  s.add_dependency('solrizer')
+  s.add_dependency('json')
+
+  s.add_development_dependency('pry')
+  s.add_development_dependency('pry-byebug')
+  s.add_development_dependency('rdoc')
+  s.add_development_dependency('rspec')
+  s.add_development_dependency('coveralls')
+  s.add_development_dependency('guard-rspec')
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {spec}/*`.split("\n")
+
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.md"
+  ]
+end

data/lib/active_triples/solrizer.rb

@@ -0,0 +1,38 @@
+require 'active_triples/solrizer/version'
+require 'active_support'
+require 'solrizer'
+
+SOLR_DOCUMENT_ID = Solrizer.default_field_mapper.id_field unless defined?(SOLR_DOCUMENT_ID)
+
+module ActiveTriples
+  module Solrizer
+    extend ActiveSupport::Autoload
+    eager_autoload do
+      autoload :Configuration
+      autoload :IndexingService
+      autoload :ProfileIndexingService
+      autoload :PropertiesIndexingService
+      autoload :SolrService
+    end
+
+
+    # Methods for configuring the GEM
+    class << self
+      attr_accessor :configuration
+    end
+
+    def self.configuration
+      @configuration ||= Configuration.new
+    end
+
+    def self.reset
+      @configuration = Configuration.new
+    end
+
+    def self.configure
+      yield(configuration)
+    end
+
+  end
+end
+

data/lib/active_triples/solrizer/configuration.rb

@@ -0,0 +1,54 @@
+module ActiveTriples::Solrizer
+  class Configuration
+
+    attr_reader :solr_uri
+    attr_reader :read_timeout
+    attr_reader :open_timeout
+
+
+    def self.default_solr_uri
+      @default_solr_uri = "http://localhost:8983/solr/".freeze
+    end
+    private_class_method :default_solr_uri
+
+    def self.default_read_timeout
+      @default_read_timeout = 120
+    end
+    private_class_method :default_read_timeout
+
+    def self.default_open_timeout
+      @default_open_timeout = 120
+    end
+    private_class_method :default_open_timeout
+
+    def initialize
+      @solr_uri           = self.class.send(:default_solr_uri)
+      @read_timeout   = self.class.send(:default_read_timeout)
+      @open_timeout   = self.class.send(:default_open_timeout)
+    end
+
+    def solr_uri=(new_solr_uri)
+      @solr_uri = new_solr_uri
+    end
+
+    def reset_solr_uri
+      @solr_uri = self.class.send(:default_solr_uri)
+    end
+
+    def read_timeout=(new_read_timeout)
+      @read_timeout = new_read_timeout
+    end
+
+    def reset_read_timeout
+      @read_timeout = self.class.send(:default_read_timeout)
+    end
+
+    def open_timeout=(new_open_timeout)
+      @open_timeout = new_open_timeout
+    end
+
+    def reset_open_timeout
+      @open_timeout = self.class.send(:default_open_timeout)
+    end
+  end
+end