solrj_wrapper 0.0.1

data/.gitignore

@@ -0,0 +1,25 @@
+## PROJECT
+.bundle
+rdoc
+doc
+.yardoc
+*.lock
+solrmarc.log*
+
+## vim
+*.swp
+
+## rcov
+coverage.data
+coverage
+
+## MAC OS
+.DS_Store
+
+## TextMate
+*.tmproj
+tmtags
+
+## Rubymine
+.idea/*
+

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "solrmarc"]
+	path = solrmarc
+	url = git://github.com/solrmarc/stanford-solr-marc.git

data/.rvmrc

@@ -0,0 +1 @@
+rvm use jruby-1.6.7@solrj_wrapper --create

data/Gemfile

@@ -0,0 +1,4 @@
+source :rubygems
+
+# See solrj_wrapper.gemspec for this gem's dependencies
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Naomi Dushay
+
+MIT License
+
+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/README.rdoc

@@ -0,0 +1,40 @@
+= SolrjWrapper
+
+Ruby wrapper for interacting with Solrj objects, such as org.apache.solr.client.solrj.impl.StreamingUpdateSolrServer.
+
+== Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'solrj_wrapper'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install solrj_wrapper
+
+== Usage
+
+This gem must be run under JRuby, and also requires a directory containing Solrj jar files and solr url (see config/settings.yml)
+
+Here are some examples of use cribbed from the specs:
+
+	sjw = SolrjWrapper.new(solrj_jar_dir, solr_url, solrj_queue_size, solrj_num_threads)
+  sjw.get_query_result_docs(q).should be_an_instance_of(Java::OrgApacheSolrCommon::SolrDocumentList)
+  sjw.streaming_update_server.should be_an_instance_of(Java::OrgApacheSolrClientSolrjImpl::StreamingUpdateSolrServer)
+  sid = Java::OrgApacheSolrCommon::SolrInputDocument.new
+  sjw.add_vals_to_fld(sid, "single", ["val"])
+
+
+== Contributing
+
+See also the wiki page for committers:  https://github.com/sul-dlss/solrj_wrapper/wiki/For-Committers
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,22 @@
+#!/usr/bin/env rake
+require 'bundler/setup'
+require "bundler/gem_tasks"
+
+require 'rake'
+require 'bundler'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+Dir.glob('lib/tasks/*.rake').each { |r| import r }
+
+namespace :sj_wrap do
+  task :default => :ci  
+  task :rspec => :rspec_plain
+  task :spec => :rspec_plain
+end

data/lib/config/settings.yml

@@ -0,0 +1,23 @@
+# settings for production
+prod:
+  solr_url: your_production_solr_url
+  solrj_jar_dir: your_solrj_jar_dir
+  solrj_queue_size: 20
+  solrj_num_threads: 1
+  log_level: error
+
+# settings for local development
+dev:
+  solr_url: http://127.0.0.1:8985/solr/dev
+  solrj_jar_dir: solrmarc/dist/lib
+  solrj_queue_size: 20
+  solrj_num_threads: 1
+  log_level: info
+
+# settings for continuous integration
+ci:
+  solr_url: http://127.0.0.1:8985/solr/test
+  solrj_jar_dir: solrmarc/dist/lib
+  solrj_queue_size: 20
+  solrj_num_threads: 1
+  log_level: info

data/lib/solrj_wrapper/settings.rb

@@ -0,0 +1,45 @@
+require 'yaml'
+
+# Read the .yml file containing the configuration values
+class Settings
+  
+  attr_reader :solr_url, :solrj_jar_dir, :solrj_queue_size, :solrj_num_threads, :log_level, :log_file
+  
+  def initialize(settings_group)
+    yml = YAML.load_file('lib/config/settings.yml')[settings_group]
+    @solr_url = yml["solr_url"]
+    @solrj_jar_dir = yml["solrj_jar_dir"]
+    @solrj_queue_size = yml["solrj_queue_size"]
+    @solrj_num_threads = yml["solrj_num_threads"]
+    @log_level = yml["log_level"]
+    @log_file = yml["log_file"]
+  end
+  
+  # @return the attributes of this class as a Hash
+  def as_hash
+    {:solr_url => @solr_url,
+      :solrj_jar_dir => @solrj_jar_dir,
+      :solrj_queue_size => @solrj_queue_size,
+      :solrj_num_threads => @solrj_num_threads,
+      :log_level => get_log_level, 
+      :log_file => @log_file
+       }
+  end
+  
+  def get_log_level
+    case (@log_level)
+      when "debug"
+        logger_level = Logger::DEBUG
+      when "warn"
+        logger_level = Logger::WARN
+      when "error"
+        logger_level = Logger::ERROR
+      when "fatal"
+        logger_level = Logger::FATAL
+      else
+        logger_level = Logger::INFO
+    end
+    logger_level
+  end
+  
+end

data/lib/solrj_wrapper/version.rb

@@ -0,0 +1,3 @@
+class SolrjWrapper
+  VERSION = "0.0.1"
+end

data/lib/solrj_wrapper.rb

@@ -0,0 +1,124 @@
+include Java
+
+require "solrj_wrapper/version"
+require 'logger'
+
+# Methods required to interact with SolrJ objects, such as org.apache.solr.client.solrj.impl.StreamingUpdateSolrServer
+class SolrjWrapper
+  
+  attr_reader :streaming_update_server, :query_server
+  attr_accessor :query
+  
+  # @param solrj_jar_dir  the location of Solrj jars needed to use SolrJ here
+  # @param solr_url  base url of the solr instance
+  # @param queue_size the number of Solr documents to buffer before writing to Solr
+  # @param num_threads the number of threads to use when writing to Solr (should not be more than the number of cpu cores avail) 
+  # @param log_level  level of Logger messages to output; defaults to Logger::INFO
+  # @param log_file  file to receive Logger output; defaults to STDERR
+  def initialize(solrj_jar_dir, solr_url, queue_size, num_threads, log_level=Logger::INFO, log_file=STDERR)
+    if not defined? JRUBY_VERSION
+      raise "SolrjWrapper only runs under jruby"
+    end
+    @logger = Logger.new(log_file)
+    @logger.level = log_level
+    load_solrj(solrj_jar_dir)
+    @query_server = org.apache.solr.client.solrj.impl.CommonsHttpSolrServer.new(solr_url)
+    @streaming_update_server = org.apache.solr.client.solrj.impl.StreamingUpdateSolrServer.new(solr_url, queue_size, num_threads)
+    useJavabin!
+  end
+
+  # send the query to Solr and get the SolrDocumentList from the response
+  # @param org.apache.solr.client.solrj.SolrQuery object populated with query information to send to Solr
+  # @return Java::OrgApacheSolrCommon::SolrDocumentList per the query.  The list size will be the number of rows in the Solr response
+  def get_query_result_docs(query_obj)
+    response = @query_server.query(query_obj)
+    response.getResults
+  end
+  
+  # Send requests using the Javabin binary format instead of serializing to XML
+  # Requires /update/javabin to be defined in solrconfig.xml as
+  # <requestHandler name="/update/javabin" class="solr.BinaryUpdateRequestHandler" />
+  def useJavabin!
+    @streaming_update_server.setRequestWriter Java::org.apache.solr.client.solrj.impl.BinaryRequestWriter.new
+  end
+
+  # given a SolrInputDocument, add the field and/or the values.  This will not add empty values, and it will not add duplicate values
+  # @param solr_input_doc - the SolrInputDocument object receiving a new field value
+  # @param fld_name - the name of the Solr field
+  # @param val_array - an array of values for the Solr field
+  def add_vals_to_fld(solr_input_doc, fld_name, val_array)
+    unless val_array.nil? || solr_input_doc.nil? || fld_name.nil?
+      val_array.each { |value|  
+        add_val_to_fld(solr_input_doc, fld_name, value)
+      }
+    end
+  end
+
+  # given a SolrInputDocument, add the field and/or the value.  This will not add empty values, and it will not add duplicate values
+  # @param solr_input_doc - the SolrInputDocument object receiving a new field value
+  # @param fld_name - the name of the Solr field
+  # @param value - the value to add to the Solr field
+  def add_val_to_fld(solr_input_doc, fld_name, value)
+    if !solr_input_doc.nil? && !fld_name.nil? && fld_name.size > 0 && !value.nil? && value.size > 0
+      if !solr_input_doc[fld_name].nil? && solr_input_doc
+        existing_vals = solr_input_doc[fld_name].getValues
+      end
+      if existing_vals.nil? || !existing_vals.contains(value)
+        solr_input_doc.addField(fld_name, value, 1.0)
+      end
+    end
+  end
+
+  # given a SolrInputDocument, replace all the values of the field with the new values.  
+  #  If the values to be added are an empty array, the field will be removed.
+  #  If the field doesn't exist in the document, then it will be created (if the value array isn't empty)
+  # @param solr_input_doc - the SolrInputDocument object receiving a new field value
+  # @param fld_name - the name of the Solr field
+  # @param value - an array of values for the Solr field
+  def replace_field_values(solr_input_doc, fld_name, val_array)
+    solr_input_doc.removeField(fld_name)
+    add_vals_to_fld(solr_input_doc, fld_name, val_array)
+  end
+
+  # add the doc to Solr by calling add on the Solrj StreamingUpdateServer object
+  # @param solr_input_doc - the SolrInputDocument to be added to the Solr index
+  # @param id - the id of the Solr document, used for log messages
+  def add_doc_to_ix(solr_input_doc, id)
+    unless solr_input_doc.nil?
+      begin
+        @streaming_update_server.add(solr_input_doc)
+        @logger.info("updating Solr document #{id}")        
+      rescue org.apache.solr.common.SolrException => e 
+        @logger.error("SolrException while indexing document #{id}")
+        @logger.error("#{e.message}")
+        @logger.error("#{e.backtrace}")
+      end
+    end
+  end
+  
+  # send a commit to the Solrj StreamingUpdateServer object
+  def commit
+    begin
+      update_response = @streaming_update_server.commit
+    rescue org.apache.solr.common.SolrException => e
+      @logger.error("SolrException while committing updates")
+      @logger.error("#{e.message}")
+      @logger.error("#{e.backtrace}")
+    end
+  end
+  
+  # remove all docs from the Solr index.  Assumes default request handler has type dismax
+  def empty_ix
+    delete_response = @streaming_update_server.deleteByQuery("*:*")
+    commit
+  end
+
+
+protected 
+
+  # require all the necessary jars to use Solrj classes
+  def load_solrj(solrj_jar_dir)
+    Dir["#{solrj_jar_dir}/*.jar"].each {|jar_file| require jar_file }
+  end
+
+end

data/lib/tasks/ci.rake

@@ -0,0 +1,9 @@
+namespace :sj_wrap do
+
+  desc "run continuous integration suite (tests, coverage, docs)" 
+  task :ci do 
+    Rake::Task["sj_wrap:rspec_wrapped"].invoke
+    Rake::Task["sj_wrap:doc"].invoke
+  end
+
+end

data/lib/tasks/doc.rake

@@ -0,0 +1,23 @@
+require 'yard'
+require 'yard/rake/yardoc_task'
+
+namespace :sj_wrap do
+  
+  # Use yard to build docs
+  begin
+    project_root = File.expand_path(File.dirname(__FILE__) + "/../..")
+    doc_dest_dir = File.join(project_root, 'doc')
+
+    YARD::Rake::YardocTask.new(:doc) do |yt|
+      yt.files = Dir.glob(File.join(project_root, 'lib', '**', '*.rb')) +
+                   [ File.join(project_root, 'README.rdoc') ]
+      yt.options = ['--output-dir', doc_dest_dir, '--readme', 'README.rdoc', '--title', 'SolrJ_Wrapper Documentation']
+    end
+  rescue LoadError
+    desc "Generate YARD Documentation"
+    task :doc do
+      abort "Please install the YARD gem to generate rdoc."
+    end
+  end  
+
+end

data/lib/tasks/jetty.rake

@@ -0,0 +1,38 @@
+require 'jettywrapper'
+
+namespace :sj_wrap do
+  namespace :jetty do
+    
+    desc "Modify test jetty solr to be multicore"
+    task :config => ['sj_wrap:solrmarc:setup_test_jetty'] do
+
+      # copy the solr.xml file for multi-core to test jetty solr
+      jetty_solr_dir = "solrmarc/test/jetty/solr" 
+      cp('spec/solr/solr.xml', jetty_solr_dir, :verbose => true)
+
+      # set up solr dev and test conf directories
+      dev_conf_dir = "#{jetty_solr_dir}/dev/conf"
+      test_conf_dir = "#{jetty_solr_dir}/test/conf"
+      mkdir_p(dev_conf_dir) unless Dir.exists?(dev_conf_dir)
+      mkdir_p(test_conf_dir) unless Dir.exists?(test_conf_dir)
+      single_core_conf_dir = "#{jetty_solr_dir}/conf"
+      Dir["#{single_core_conf_dir}/*"].each { |f| 
+        cp_r(f, dev_conf_dir, :verbose => true)
+        cp_r(f, test_conf_dir, :verbose => true)
+      }
+      
+      require 'fileutils'
+      # remove single core conf directory
+      FileUtils.rm_rf("#{jetty_solr_dir}/conf/.", :verbose => true)
+      Dir.foreach(jetty_solr_dir + "/conf") { |f| 
+        fn = File.join(jetty_solr_dir, f)
+        File.delete(fn) if f != '.' && f != '..'
+      }
+      
+    end
+
+    desc "Copies the SOLR config files and starts up the test-jetty instance"
+    task :load => [:config, 'jetty:start']
+
+  end
+end

data/lib/tasks/solrmarc.rake

@@ -0,0 +1,17 @@
+namespace :sj_wrap do
+  namespace :solrmarc do
+    require 'ant'
+    
+    desc "run ant dist_site target in solrmarc"
+    task :ant_dist_site do
+      ant '-f solrmarc/build.xml dist_site'
+    end
+    
+    desc "run ant target to set up testing jetty per straight solrmarc"
+    task :setup_test_jetty do
+      ant '-f solrmarc/build.xml test_clean_site'
+      ant '-f solrmarc/build.xml site_setup_test_jetty'
+    end
+
+  end
+end

data/lib/tasks/spec.rake

@@ -0,0 +1,26 @@
+require 'rspec/core/rake_task'
+
+namespace :sj_wrap do
+
+  desc "Run all specs, with jetty instance running"
+  task :rspec_wrapped => ['sj_wrap:solrmarc:ant_dist_site', 'sj_wrap:jetty:config'] do
+    test_jetty_dir = File.expand_path(File.dirname(__FILE__) + '../../../solrmarc/test/jetty')
+    require 'jettywrapper'
+    jetty_params = Jettywrapper.load_config.merge({
+      :jetty_home => test_jetty_dir,
+      :solr_home => test_jetty_dir + '/solr',
+      :java_opts => "-Dsolr.data.dir=" + test_jetty_dir + "/solr/test/data",
+      :jetty_port => 8985,
+      :startup_wait => 25
+    })
+    error = Jettywrapper.wrap(jetty_params) do 
+      Rake::Task['sj_wrap:rspec_plain'].invoke
+    end
+    raise "TEST FAILURES: #{error}" if error
+  end
+
+  RSpec::Core::RakeTask.new(:rspec_plain) do |spec|
+    spec.rspec_opts = ["-c", "-f progress", "-r ./spec/spec_helper.rb"]
+  end
+
+end

data/solrj_wrapper.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+require File.join(File.dirname(__FILE__), 'lib/solrj_wrapper/version')
+
+Gem::Specification.new do |gem|
+  gem.name          = "solrj_wrapper"
+  gem.version       = SolrjWrapper::VERSION
+  gem.authors       = ["Naomi Dushay"]
+  gem.email         = ["ndushay@stanford.edu"]
+  gem.summary       = "Ruby wrapper for interacting with Solrj objects"
+  gem.description   = "Ruby wrapper for interacting with Solrj objects, such as org.apache.solr.client.solrj.impl.StreamingUpdateSolrServer"
+  gem.summary      = "This gem must be run under JRuby, and also requires a directory containing SolrJ jars and solr url (see config/settings.yml)"
+
+  gem.files         = `git ls-files`.split($\)
+#  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(spec|features)/})
+  gem.require_paths = ["lib"]
+  
+  # No Runtime dependencies
+
+  # Bundler will install these gems too if you've checked out solrjwrapper source from git and run 'bundle install'
+  # It will not add these as dependencies if you require solrj_wrapper for other projects
+  gem.add_development_dependency "rake"
+  # docs
+  gem.add_development_dependency "rdoc"
+  gem.add_development_dependency "yard"
+  # tests
+	gem.add_development_dependency 'rspec'
+	gem.add_development_dependency 'simplecov'
+	gem.add_development_dependency 'simplecov-rcov'
+  gem.add_development_dependency "jettywrapper"
+
+end

data/spec/solr/solr.xml

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<!--
+All (relative) paths are relative to the installation path
+persistent: Save changes made via the API to this file
+sharedLib: path to a lib directory that will be shared across all cores
+-->
+<solr persistent="false" sharedLib="lib">
+  <cores adminPath="/admin/cores" shareSchema="true">
+    <core name="dev" instanceDir="dev" />
+    <core name="test" instanceDir="test" />
+  </cores>
+</solr>

data/spec/solrj_wrapper_spec.rb

@@ -0,0 +1,188 @@
+require File.expand_path('../spec_helper', __FILE__)
+require 'solrj_wrapper'
+
+describe SolrjWrapper do
+  
+  before(:all) do
+    @solrj_wrapper = SolrjWrapper.new(@@settings.solrj_jar_dir, @@settings.solr_url, @@settings.solrj_queue_size, @@settings.solrj_num_threads, @@settings.log_level, @@settings.log_file)
+  end
+  
+  it "should initialize a query_server object" do
+    @solrj_wrapper.query_server.should be_an_instance_of(Java::OrgApacheSolrClientSolrjImpl::CommonsHttpSolrServer)
+  end
+
+  context "get_query_result_docs" do
+    it "should return a SolrDocumentList object" do
+      q = org.apache.solr.client.solrj.SolrQuery.new
+      @solrj_wrapper.get_query_result_docs(q).should be_an_instance_of(Java::OrgApacheSolrCommon::SolrDocumentList)
+    end
+    
+    it "should return an object of size 0 when there are no hits" do
+      q = org.apache.solr.client.solrj.SolrQuery.new
+      q.setQuery("zzzzzznohitszzzzzzzz")
+      @solrj_wrapper.get_query_result_docs(q).size.should == 0
+    end
+    
+    it "should return an object of size 0 when rows = 0" do
+      q = org.apache.solr.client.solrj.SolrQuery.new
+      q.setRows(0)
+      @solrj_wrapper.get_query_result_docs(q).size.should == 0
+    end
+
+    it "should return an object of size > 1 when there are hits and rows is > 0" do
+      sid = Java::OrgApacheSolrCommon::SolrInputDocument.new
+      @solrj_wrapper.add_val_to_fld(sid, "id", "test_rec")
+      @solrj_wrapper.add_doc_to_ix(sid, "test_rec")
+      @solrj_wrapper.commit
+      q = org.apache.solr.client.solrj.SolrQuery.new
+      @solrj_wrapper.get_query_result_docs(q).size.should_not == 0
+      @solrj_wrapper.empty_ix
+    end
+  end
+  
+  it "should initialize a streaming_update_server object" do
+    @solrj_wrapper.streaming_update_server.should be_an_instance_of(Java::OrgApacheSolrClientSolrjImpl::StreamingUpdateSolrServer)
+  end
+  
+  context "add_vals_to_fld" do
+    it "should do nothing if the field name or value is nil or of size 0" do
+      sid = Java::OrgApacheSolrCommon::SolrInputDocument.new
+      @solrj_wrapper.add_vals_to_fld(sid, nil, ["val"])
+      sid.isEmpty.should be_true
+      @solrj_wrapper.add_vals_to_fld(sid, "", ["val"])
+      sid.isEmpty.should be_true
+      @solrj_wrapper.add_vals_to_fld(sid, "fldname", nil)
+      sid.isEmpty.should be_true
+      @solrj_wrapper.add_vals_to_fld(sid, "fldname", [])
+      sid.isEmpty.should be_true
+    end
+    
+    it "should create a new field when none exists" do
+      sid = Java::OrgApacheSolrCommon::SolrInputDocument.new
+      @solrj_wrapper.add_vals_to_fld(sid, "single", ["val"])
+      vals = sid["single"].getValues
+      vals.size.should == 1
+      vals[0].should == "val"
+      @solrj_wrapper.add_vals_to_fld(sid, "mult", ["val1", "val2"])
+      vals = sid["mult"].getValues
+      vals.size.should == 2
+      vals[0].should == "val1"
+      vals[1].should == "val2"
+    end
+    
+    it "should keep the existing values when it adds a value to a field" do
+      sid = Java::OrgApacheSolrCommon::SolrInputDocument.new
+      @solrj_wrapper.add_vals_to_fld(sid, "fld", ["val"])
+      vals = sid["fld"].getValues
+      vals.size.should == 1
+      vals[0].should == "val"
+      @solrj_wrapper.add_vals_to_fld(sid, "fld", ["val1", "val2"])
+      vals = sid["fld"].getValues
+      vals.size.should == 3
+      vals.contains("val").should_not be_nil
+      vals.contains("val1").should_not be_nil
+      vals.contains("val2").should_not be_nil
+    end
+    
+    it "should add all values, except those already present" do
+      sid = Java::OrgApacheSolrCommon::SolrInputDocument.new
+      @solrj_wrapper.add_vals_to_fld(sid, "fld", ["val"])
+      vals = sid["fld"].getValues
+      vals.size.should == 1
+      vals[0].should == "val"
+      @solrj_wrapper.add_vals_to_fld(sid, "fld", ["val1", "val2", "val"])
+      vals = sid["fld"].getValues
+      vals.size.should == 3
+      vals.contains("val").should_not be_nil
+      vals.contains("val1").should_not be_nil
+      vals.contains("val2").should_not be_nil
+    end
+  end # context add_vals_to_fld
+
+  context "add_val_to_fld" do
+    it "should do nothing if the field name or value is nil or of size 0" do
+      sid = Java::OrgApacheSolrCommon::SolrInputDocument.new
+      @solrj_wrapper.add_val_to_fld(sid, nil, "val")
+      sid.isEmpty.should be_true
+      @solrj_wrapper.add_val_to_fld(sid, "", "val")
+      sid.isEmpty.should be_true
+      @solrj_wrapper.add_val_to_fld(sid, "fldname", nil)
+      sid.isEmpty.should be_true
+      @solrj_wrapper.add_val_to_fld(sid, "fldname", [])
+      sid.isEmpty.should be_true
+    end
+    
+    it "should create a new field when none exists" do
+      sid = Java::OrgApacheSolrCommon::SolrInputDocument.new
+      @solrj_wrapper.add_val_to_fld(sid, "single", "val")
+      vals = sid["single"].getValues
+      vals.size.should == 1
+      vals[0].should == "val"
+    end
+    
+    it "should keep the existing values when it adds a value to a field" do
+      sid = Java::OrgApacheSolrCommon::SolrInputDocument.new
+      @solrj_wrapper.add_vals_to_fld(sid, "fld", ["val1", "val2"])
+      @solrj_wrapper.add_val_to_fld(sid, "fld", "val")
+      vals = sid["fld"].getValues
+      vals.size.should == 3
+      vals.contains("val").should_not be_nil
+      vals.contains("val1").should_not be_nil
+      vals.contains("val2").should_not be_nil
+    end
+    
+    it "should add all values, except those already present" do
+      sid = Java::OrgApacheSolrCommon::SolrInputDocument.new
+      @solrj_wrapper.add_vals_to_fld(sid, "fld", ["val1", "val2", "val"])
+      @solrj_wrapper.add_val_to_fld(sid, "fld", "val")
+      vals = sid["fld"].getValues
+      vals.size.should == 3
+      vals.contains("val").should_not be_nil
+      vals.contains("val1").should_not be_nil
+      vals.contains("val2").should_not be_nil
+    end
+  end # context add_vals_to_fld
+
+  context "replace_field_values" do
+    it "should work for disjoint sets of field values" do
+      sid = Java::OrgApacheSolrCommon::SolrInputDocument.new
+      @solrj_wrapper.add_vals_to_fld(sid, "fld", ["val1", "val2", "val3"])
+      @solrj_wrapper.replace_field_values(sid, "fld", ["val4", "val5"])
+      vals = sid["fld"].getValues
+      vals.size.should == 2
+      vals.contains("val1").should be_false
+      vals.contains("val2").should be_false
+      vals.contains("val3").should be_false
+      vals.contains("val4").should be_true
+      vals.contains("val5").should be_true
+    end
+
+    it "should retain unchanged values" do
+      sid = Java::OrgApacheSolrCommon::SolrInputDocument.new
+      @solrj_wrapper.add_vals_to_fld(sid, "fld", ["val1", "val2"])
+      @solrj_wrapper.replace_field_values(sid, "fld", ["val2", "val3"])
+      vals = sid["fld"].getValues
+      vals.size.should == 2
+      vals.contains("val1").should be_false
+      vals.contains("val2").should be_true
+      vals.contains("val3").should be_true
+    end
+    
+    it "should create a field when none existed before" do
+      sid = Java::OrgApacheSolrCommon::SolrInputDocument.new
+      sid["fld"].should be_nil
+      @solrj_wrapper.replace_field_values(sid, "fld", ["val1"])
+      vals = sid["fld"].getValues
+      vals.size.should == 1
+      vals.contains("val1").should be_true
+    end
+    
+    it "should remove a field if there are no values to add" do
+      sid = Java::OrgApacheSolrCommon::SolrInputDocument.new
+      @solrj_wrapper.add_vals_to_fld(sid, "fld", ["val1", "val2"])
+      @solrj_wrapper.replace_field_values(sid, "fld", [])
+      sid["fld"].should be_nil
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+# for test coverage
+require 'simplecov'
+require 'simplecov-rcov'
+class SimpleCov::Formatter::MergedFormatter
+  def format(result)
+     SimpleCov::Formatter::HTMLFormatter.new.format(result)
+     SimpleCov::Formatter::RcovFormatter.new.format(result)
+  end
+end
+SimpleCov.formatter = SimpleCov::Formatter::MergedFormatter
+SimpleCov.start do
+  add_filter "/spec/"
+  add_filter "/lib/config/"
+end
+
+require 'solrj_wrapper/settings'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+RSpec.configure do |config|
+  # Set up the environment for testing and make all variables available to the specs
+  settings_env = ENV["SETTINGS"] ||= 'dev'
+  @@settings = Settings.new(settings_env)
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: solrj_wrapper
+version: !ruby/object:Gem::Version
+  prerelease:
+  version: 0.0.1
+platform: ruby
+authors:
+- Naomi Dushay
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2012-04-18 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  version_requirements: &3808 !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  requirement: *3808
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  version_requirements: &3826 !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  requirement: *3826
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: yard
+  version_requirements: &3842 !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  requirement: *3842
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: rspec
+  version_requirements: &3858 !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  requirement: *3858
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  version_requirements: &3874 !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  requirement: *3874
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: simplecov-rcov
+  version_requirements: &3890 !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  requirement: *3890
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: jettywrapper
+  version_requirements: &3906 !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  requirement: *3906
+  prerelease: false
+  type: :development
+description: Ruby wrapper for interacting with Solrj objects, such as org.apache.solr.client.solrj.impl.StreamingUpdateSolrServer
+email:
+- ndushay@stanford.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .gitmodules
+- .rvmrc
+- Gemfile
+- LICENSE
+- README.rdoc
+- Rakefile
+- lib/config/settings.yml
+- lib/solrj_wrapper.rb
+- lib/solrj_wrapper/settings.rb
+- lib/solrj_wrapper/version.rb
+- lib/tasks/ci.rake
+- lib/tasks/doc.rake
+- lib/tasks/jetty.rake
+- lib/tasks/solrmarc.rake
+- lib/tasks/spec.rake
+- solrj_wrapper.gemspec
+- spec/solr/solr.xml
+- spec/solrj_wrapper_spec.rb
+- spec/spec_helper.rb
+homepage:
+licenses: []
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      segments:
+      - 0
+      hash: 2
+      version: '0'
+  none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      segments:
+      - 0
+      hash: 2
+      version: '0'
+  none: false
+requirements: []
+rubyforge_project:
+rubygems_version: 1.8.15
+signing_key:
+specification_version: 3
+summary: This gem must be run under JRuby, and also requires a directory containing SolrJ jars and solr url (see config/settings.yml)
+test_files:
+- spec/solr/solr.xml
+- spec/solrj_wrapper_spec.rb
+- spec/spec_helper.rb
+has_rdoc:
+...