solr_wrapper 0.0.7 → 0.0.8

data/.travis.yml

@@ -5,4 +5,4 @@ rvm:
   - jruby
 cache:
   directories:
-  - /tmp/solr-5.0.0
+  - /tmp/solr-5.1.0

data/Gemfile

@@ -1,4 +1,4 @@
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in solr_wrapper.gemspec
-gemspec
+gemspec

data/Rakefile

@@ -1,8 +1,7 @@
 require "bundler/gem_tasks"
 
-
 require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task default: ['spec']
+task default: ['spec']

data/lib/solr_wrapper.rb

@@ -3,16 +3,16 @@ require 'solr_wrapper/instance'
 
 module SolrWrapper
   def self.default_solr_version
-    "5.0.0"
+    "5.1.0"
   end
 
-  def self.default_instance options = {}
+  def self.default_instance(options = {})
     @default_instance ||= SolrWrapper::Instance.new options
   end
 
   ##
   # Ensures a Solr service is running before executing the block
-  def self.wrap options = {}, &block
+  def self.wrap(options = {}, &block)
     default_instance(options).wrap &block
   end
-end
+end

data/lib/solr_wrapper/instance.rb

@@ -21,14 +21,17 @@ module SolrWrapper
     # @option options [String] :instance_dir
     # @option options [String] :download_path
     # @option options [String] :md5sum
+    # @option options [String] :solr_xml
     # @option options [Boolean] :verbose
     # @option options [Boolean] :managed
     # @option options [Boolean] :ignore_md5sum
-    def initialize options = {}
+    # @option options [Hash] :solr_options
+    # @option options [Hash] :env
+    def initialize(options = {})
       @options = options
     end
 
-    def wrap &block
+    def wrap(&_block)
       start
       yield self
     ensure
@@ -52,7 +55,7 @@ module SolrWrapper
     ##
     # Stop Solr and wait for it to finish exiting
     def stop
-      if managed? and started?
+      if managed? && started?
 
         exec('stop', p: port)
         # Wait for solr to stop
@@ -82,18 +85,18 @@ module SolrWrapper
     # @param [Hash] options
     # @option options [String] :name
     # @option options [String] :dir
-    def create options = {}
+    def create(options = {})
       options[:name] ||= SecureRandom.hex
 
       exec("create", c: options[:name], d: options[:dir], p: port)
 
       options[:name]
     end
-    
+
     ##
     # Create a new collection in solr
     # @param [String] name collection name
-    def delete name, options = {}
+    def delete(name, _options = {})
       exec("delete", c: name, p: port)
     end
 
@@ -102,7 +105,7 @@ module SolrWrapper
     # @param [Hash] options
     # @option options [String] :name
     # @option options [String] :dir
-    def with_collection options = {}
+    def with_collection(options = {})
       name = create(options)
       begin
         yield name
@@ -112,7 +115,7 @@ module SolrWrapper
     end
 
     ##
-    # Get the port this Solr instance is running at 
+    # Get the port this Solr instance is running at
     def port
       options.fetch(:port, "8983").to_s
     end
@@ -128,9 +131,17 @@ module SolrWrapper
       FileUtils.remove_entry(version_file) if File.exists? version_file
     end
 
+    ##
+    # Get a (likely) URL to the solr instance
+    def url
+      "http://127.0.0.1:#{port}/solr/"
+    end
+
     protected
+
+    # rubocop:disable Lint/RescueException
     def extract
-      return solr_dir if File.exists?(solr_binary) and extracted_version == version
+      return solr_dir if File.exists?(solr_binary) && extracted_version == version
 
       zip_path = download
 
@@ -138,8 +149,8 @@ module SolrWrapper
         Zip::File.open(zip_path) do |zip_file|
           # Handle entries one by one
           zip_file.each do |entry|
-            dest_file = File.join(tmp_save_dir,entry.name)
-            FileUtils.remove_entry(dest_file,true)
+            dest_file = File.join(tmp_save_dir, entry.name)
+            FileUtils.remove_entry(dest_file, true)
             entry.extract(dest_file)
           end
         end
@@ -148,34 +159,37 @@ module SolrWrapper
         abort "Unable to unzip #{zip_path} into #{tmp_save_dir}: #{e.message}"
       end
 
-      begin  
-        FileUtils.remove_dir(solr_dir,true)
-        FileUtils.cp_r File.join(tmp_save_dir, File.basename(default_url, ".zip")), solr_dir
+      begin
+        FileUtils.remove_dir(solr_dir, true)
+        FileUtils.cp_r File.join(tmp_save_dir, File.basename(download_url, ".zip")), solr_dir
         self.extracted_version = version
         FileUtils.chmod 0755, solr_binary
       rescue Exception => e
         abort "Unable to copy #{tmp_save_dir} to #{solr_dir}: #{e.message}"
       end
 
+      configure
+
       solr_dir
     ensure
       FileUtils.remove_entry tmp_save_dir if File.exists? tmp_save_dir
     end
+    # rubocop:enable Lint/RescueException
 
     def download
-      unless File.exists? download_path and validate? download_path
-        fetch_with_progressbar url, download_path
+      unless File.exists?(download_path) && validate?(download_path)
+        fetch_with_progressbar download_url, download_path
         validate! download_path
       end
 
       download_path
     end
 
-    def validate? file
+    def validate?(file)
       Digest::MD5.file(file).hexdigest == expected_md5sum
     end
 
-    def validate! file
+    def validate!(file)
       unless validate? file
         raise "MD5 mismatch" unless options[:ignore_md5sum]
       end
@@ -184,18 +198,19 @@ module SolrWrapper
     ##
     # Run a bin/solr command
     # @see https://github.com/apache/lucene-solr/blob/trunk/solr/bin/solr
-    def exec cmd, options = {}
+    def exec(cmd, options = {})
       output = !!options.delete(:output)
-      args = [solr_binary, cmd] + options.map { |k,v| ["-#{k}", "#{v}"] }.flatten
+      args = [solr_binary, cmd] + solr_options.merge(options).map { |k, v| ["-#{k}", "#{v}"] }.flatten
 
       if IO.respond_to? :popen4
         # JRuby
-        pid, input, output, error = IO.popen4(args.join(" "))
-        
+        env_str = env.map { |k, v| "#{Shellwords.escape(k)}=#{Shellwords.escape(v)}" }.join(" ")
+        _, input, output, error = IO.popen4(env_str + " " + args.join(" "))
+
         stringio = StringIO.new
-        if verbose? and !output
-          IO.copy_stream(output,$stderr)
-          IO.copy_stream(error,$stderr)
+        if verbose? && !output
+          IO.copy_stream(output, $stderr)
+          IO.copy_stream(error, $stderr)
         else
           IO.copy_stream(output, stringio)
           IO.copy_stream(error, stringio)
@@ -203,7 +218,7 @@ module SolrWrapper
         input.close
         output.close
         error.close
-        
+
         stringio.rewind
 
         if $? != 0
@@ -212,10 +227,10 @@ module SolrWrapper
 
         stringio
       else
-        IO.popen(args + [err: [:child, :out]]) do |io|
+        IO.popen(env, args + [err: [:child, :out]]) do |io|
           stringio = StringIO.new
-          if verbose? and !output
-            IO.copy_stream(io,$stderr)
+          if verbose? && !output
+            IO.copy_stream(io, $stderr)
           else
             IO.copy_stream(io, stringio)
           end
@@ -232,12 +247,13 @@ module SolrWrapper
       end
     end
 
-    private  
-    def url
-      @download_url ||= options.fetch(:url, default_url)
+    private
+
+    def download_url
+      @download_url ||= options.fetch(:url, default_download_url)
     end
 
-    def default_url
+    def default_download_url
       @default_url ||= begin
         mirror_url = "http://www.apache.org/dyn/closer.cgi/lucene/solr/#{version}/solr-#{version}.zip?asjson=true"
         json = open(mirror_url).read
@@ -254,20 +270,28 @@ module SolrWrapper
       @version ||= options.fetch(:version, default_solr_version)
     end
 
+    def solr_options
+      options.fetch(:solr_options, {})
+    end
+
+    def env
+      options.fetch(:env, {})
+    end
+
     def default_solr_version
       SolrWrapper.default_solr_version
     end
 
     def download_path
-      @download_path ||= options.fetch(:download_path, default_download_path)  
+      @download_path ||= options.fetch(:download_path, default_download_path)
     end
 
     def default_download_path
-      File.join(Dir.tmpdir, File.basename(default_url))
+      File.join(Dir.tmpdir, File.basename(download_url))
     end
 
     def solr_dir
-      @solr_dir ||= options.fetch(:instance_dir, File.join(Dir.tmpdir, File.basename(default_url, ".zip")))
+      @solr_dir ||= options.fetch(:instance_dir, File.join(Dir.tmpdir, File.basename(download_url, ".zip")))
     end
 
     def verbose?
@@ -285,7 +309,7 @@ module SolrWrapper
     def expected_md5sum
       @md5sum ||= options.fetch(:md5sum, open(md5file).read.split(" ").first)
     end
-    
+
     def solr_binary
       File.join(solr_dir, "bin", "solr")
     end
@@ -298,17 +322,17 @@ module SolrWrapper
       @tmp_save_dir ||= Dir.mktmpdir
     end
 
-    def fetch_with_progressbar url, output
+    def fetch_with_progressbar(url, output)
       pbar = ProgressBar.create(title: File.basename(url), total: nil, format: "%t: |%B| %p%% (%e )")
-      open(url, content_length_proc: lambda {|t|
+      open(url, content_length_proc: lambda do|t|
         if t && 0 < t
           pbar.total = t
         end
-        },
-        progress_proc: lambda {|s|
-          pbar.progress = s
-        }) do |io|
-        IO.copy_stream(io,output)
+      end,
+                progress_proc: lambda do|s|
+                  pbar.progress = s
+                end) do |io|
+        IO.copy_stream(io, output)
       end
     end
 
@@ -324,10 +348,14 @@ module SolrWrapper
       File.read(version_file).strip if File.exists? version_file
     end
 
-    def extracted_version= version
+    def extracted_version=(version)
       File.open(version_file, "w") do |f|
         f.puts version
       end
     end
+
+    def configure
+      FileUtils.cp options[:solr_xml], File.join(solr_dir, "server", "solr", "solr.xml") if options[:solr_xml]
+    end
   end
-end
+end

data/lib/solr_wrapper/version.rb

@@ -1,3 +1,3 @@
 module SolrWrapper
-  VERSION = "0.0.7"
-end
+  VERSION = "0.0.8"
+end

data/spec/lib/solr_wrapper/instance_spec.rb

@@ -16,4 +16,4 @@ describe SolrWrapper::Instance do
       end
     end
   end
-end
+end

data/spec/lib/solr_wrapper_spec.rb

@@ -4,12 +4,12 @@ describe SolrWrapper do
   describe ".wrap" do
     it "should launch solr" do
       SolrWrapper.wrap do |solr|
-        expect {
+        expect do
           Timeout::timeout(15) do
             TCPSocket.new('127.0.0.1', solr.port).close
           end
-        }.not_to raise_exception
+        end.not_to raise_exception
       end
     end
   end
-end
+end

data/spec/spec_helper.rb

@@ -8,6 +8,5 @@ require 'rspec'
 
 FIXTURES_DIR = File.expand_path("fixtures", File.dirname(__FILE__))
 
-RSpec.configure do |config|
-
-end
+RSpec.configure do |_config|
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solr_wrapper
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Chris Beer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-25 00:00:00.000000000 Z
+date: 2015-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubyzip
@@ -116,6 +116,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
+- ".rubocop_hound.yml"
+- ".rubocop_todo.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE