sunspot_solr 2.2.5 → 2.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 363689a832442e0a223078447ea05bf91ded42cd
-  data.tar.gz: 081fcf416dfe18589bda76453a77f53b5eced842
+  metadata.gz: 7a087d9d877cc686d5f2c13d0f432d1716a6f554
+  data.tar.gz: 62626a3807fd8db96f3386e80898ac32f7163431
 SHA512:
-  metadata.gz: e03d8ace0845388b1c7a85dc3b8055bb7008d4c52729721927e71b1fafc5524b32eb4b9b43cb0b76eb120ef0d58eea8e71de7a6190aabdcaff65736b0055495c
-  data.tar.gz: 31fe862218f921db7f36d00f587ebc1e8ac8aa50a9bd2ed435a2528375ea3712138ae5305e45464e7e3f6999e0a62621f05ea22bea79f70858b819b24d65467e
+  metadata.gz: 07097ad6bc5a3a557898097ded608601c56216fbbca639c8beaad203f98295168ef9550a471f621d79b02dab826b0aa4676a2f56dc1997e3dc3111fc3f14b09e
+  data.tar.gz: 80d9f86e9187be17713a4531252d2bc124b8f6741291bdd43b47f77a9a125a994d94fcf1444234a2a723c207dd252d62020b11bb04c7fd9a4d25f4cc647191a0

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -1,3 +1,3 @@
 source "http://rubygems.org"
 
-gemspec
+gemspec

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+
+begin
+  require "rspec/core/rake_task"
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+end
+
+task :default => :spec

data/lib/sunspot/solr/installer.rb

@@ -1,24 +1,82 @@
-%w(task_helper config_installer).each do |file|
-  require File.join(File.dirname(__FILE__), 'installer', file)
-end
+require "fileutils"
+require "pathname"
 
 module Sunspot
   module Solr
     class Installer
       class <<self
         def execute(solr_home, options = {})
-          new(solr_home, options).execute
+          new(Pathname(solr_home).expand_path, options).execute
+        end
+      end
+
+      attr_reader :config_path, :options
+
+      class << self
+        def execute(config_path, options = {})
+          new(config_path, options).execute
         end
+      end
 
-        private :new
+      def initialize(config_path, options)
+        @config_path = config_path
+        @options     = options
       end
 
-      def initialize(solr_home, options)
-        @solr_home, @options = solr_home, options
+      def force?
+        !!@options[:force]
+      end
+
+      def verbose?
+        !!@options[:verbose]
       end
 
       def execute
-        ConfigInstaller.execute(File.join(@solr_home, 'configsets'), @options)
+        return if sunspot_config_path == config_path
+
+        config_source_files.each do |source_path|
+          destination_path = get_destination_path(source_path)
+
+          if destination_path.exist?
+            next unless force?
+            output "Removing existing file #{ destination_path }"
+          end
+
+          destination_dir = destination_path.dirname
+          unless destination_dir.exist?
+            output "Creating directory #{ destination_dir }"
+            destination_dir.mkpath
+          end
+
+          output "Copying #{ source_path } => #{ destination_path }"
+          FileUtils.copy(source_path, destination_path)
+        end
+      end
+
+      def sunspot_config_path
+        @sunspot_config_path ||= Pathname(__FILE__).join("../../../../solr/solr")
+      end
+
+      def config_source_files
+        @config_source_files ||= glob_source_files
+      end
+
+      private
+
+      def get_destination_path(source_path)
+        source_path.sub(sunspot_config_path.to_s, config_path.to_s)
+      end
+
+      def glob_source_files
+        source_files = []
+        source_files += Pathname.glob(sunspot_config_path.join("solr.xml"))
+        source_files += Pathname.glob(sunspot_config_path.join("configsets/**/*"))
+        source_files += Pathname.glob(sunspot_config_path.join("**/core.properties"))
+        source_files.select(&:file?).map(&:expand_path)
+      end
+
+      def output message
+        STDOUT.puts(message) if verbose?
       end
     end
   end

data/lib/sunspot/solr/java.rb

@@ -1,12 +1,25 @@
-require 'rbconfig'
+require "rbconfig"
 
 module Sunspot
   module Solr
     module Java
-      NULL_DEVICE = RbConfig::CONFIG['host_os'] =~ /mswin|mingw/ ? 'NUL' : '/dev/null'
+      class << self
+        def ensure_install!
+          if installed?
+            true
+          else
+            raise Sunspot::Solr::Server::JavaMissing, "You need a Java Runtime Environment to run the Solr server"
+          end
+        end
 
-      def self.installed?
-        !system("java -version >#{NULL_DEVICE} 2>&1").nil?
+        def installed?
+          system("java", "-version", [:out, :err] => null_device)
+          $?.exitstatus.zero?
+        end
+
+        def null_device
+          RbConfig::CONFIG["host_os"] =~ /mswin|mingw/ ? "NUL" : "/dev/null"
+        end
       end
     end
   end

data/lib/sunspot/solr/server.rb

@@ -23,9 +23,8 @@ module Sunspot
 
       attr_writer :pid_dir, :pid_file, :solr_home, :solr_executable
 
-      def initialize(*args)
-        ensure_java_installed
-        super(*args)
+      def initialize
+        Sunspot::Solr::Java.ensure_install!
       end
 
       #
@@ -195,16 +194,6 @@ module Sunspot
 
       private
 
-      def ensure_java_installed
-        unless defined?(@java_installed)
-          @java_installed = Sunspot::Solr::Java.installed?
-          unless @java_installed
-            raise JavaMissing.new("You need a Java Runtime Environment to run the Solr server")
-          end
-        end
-        @java_installed
-      end
-
       def logging_config_path
         return @logging_config_path if defined?(@logging_config_path)
         @logging_config_path =

data/spec/installer_spec.rb

@@ -0,0 +1,82 @@
+require "spec_helper"
+
+describe Sunspot::Solr::Installer do
+  let(:install_dir) { Pathname(Dir.mktmpdir + "/test_install_directory") }
+  let(:install_manifest) do
+    [ "solr.xml",
+      "configsets/sunspot/conf/_rest_managed.json",
+      "configsets/sunspot/conf/admin-extra.html",
+      "configsets/sunspot/conf/currency.xml",
+      "configsets/sunspot/conf/elevate.xml",
+      "configsets/sunspot/conf/lang/stopwords_en.txt",
+      "configsets/sunspot/conf/mapping-ISOLatin1Accent.txt",
+      "configsets/sunspot/conf/protwords.txt",
+      "configsets/sunspot/conf/schema.xml",
+      "configsets/sunspot/conf/scripts.conf",
+      "configsets/sunspot/conf/solrconfig.xml",
+      "configsets/sunspot/conf/spellings.txt",
+      "configsets/sunspot/conf/synonyms.txt",
+      "default/core.properties",
+      "development/core.properties",
+      "test/core.properties" ]
+  end
+
+  let(:destination_files) { install_manifest.map { |file| install_dir.join(file) } }
+
+  it "creates the install directory" do
+    expect { described_class.execute(install_dir.to_s) }.
+      to change { install_dir.exist? }.from(false).to(true)
+  end
+
+  it "installs the Solr config files into the specified directory" do
+    described_class.execute(install_dir.to_s)
+    installed_files = Pathname.glob(install_dir.join("**/*")).select(&:file?)
+    expect(installed_files).to contain_exactly(*destination_files).and all( be_exist )
+  end
+
+  describe "force" do
+    let(:existing_file) { install_dir.join("solr.xml") }
+
+    before do
+      install_dir.mkpath
+      File.write(existing_file, "Hello, World!")
+    end
+
+    it "does not overwrite existing files when 'force' is false (default)" do
+      expect { described_class.execute(install_dir) }.
+        not_to change { existing_file.read }.from "Hello, World!"
+    end
+
+    it "overwrites existing files when 'force' is true" do
+      expect { described_class.execute(install_dir, force: true) }.
+        to change { existing_file.read }.
+        from("Hello, World!").
+        to(%r{<solr>(.|\n)*</solr>})
+    end
+  end
+
+  describe "verbose" do
+    let(:fake_stdout) { StringIO.new }
+
+    before do
+      stub_const("STDOUT", fake_stdout)
+      install_dir.mkpath
+      File.write(install_dir.join("solr.xml"), "Hello, World!")
+    end
+
+    it "does not output to STDOUT when 'verbose' is false (default)" do
+      described_class.execute(install_dir, force: true)
+      fake_stdout.rewind
+      expect(fake_stdout.read).to be_empty
+    end
+
+    it "outputs to STDOUT when 'verbose' is true" do
+      described_class.execute(install_dir, force: true, verbose: true)
+      fake_stdout.rewind
+      expect(fake_stdout.read).
+        to  match(/Removing existing file .+/).
+        and match(/Creating directory .+/).
+        and match(/Copying .+ => .+/)
+    end
+  end
+end

data/spec/java_spec.rb

@@ -0,0 +1,58 @@
+require "spec_helper"
+
+describe Sunspot::Solr::Java do
+
+  describe ".ensure_install!" do
+    subject { described_class.ensure_install! }
+
+    context "when Java is installed" do
+      before { expect(described_class).to receive(:installed?) { true } }
+      it { should be true }
+    end
+
+    context "when Java is not installed" do
+      before { expect(described_class).to receive(:installed?) { false } }
+      it "should raise a JavaMissing error" do
+        expect { subject }.
+          to raise_error Sunspot::Solr::Server::JavaMissing, /You need a Java/
+      end
+    end
+  end
+
+  describe ".installed?" do
+    subject { described_class.installed? }
+
+    context "when Java can be found" do
+      let(:command) { system("echo") }
+      before do
+        expect(described_class).to receive(:system).
+          with("java", "-version", [:out, :err] => "/dev/null") { system("echo", out: "/dev/null") }
+      end
+      it { should be true }
+    end
+
+    context "when Java cannot be found" do
+      before do
+        expect(described_class).to receive(:system).
+          with("java", "-version", [:out, :err] => "/dev/null") { system("some-command-not-found") }
+      end
+      it { should be false }
+    end
+  end
+
+  describe ".null_device" do
+    subject { described_class.null_device }
+
+    before { stub_const("RbConfig::CONFIG", { "host_os" => host_os }) }
+
+    context "when the OS is Windows" do
+      let(:host_os) { "mswin32" }
+      it { should eq "NUL" }
+    end
+
+    context "when the OS is not Windows" do
+      let(:host_os) { "darwin15.2.0" }
+      it { should eq "/dev/null" }
+    end
+  end
+end

data/spec/server_spec.rb

@@ -1,87 +1,55 @@
-require File.expand_path('spec_helper', File.dirname(__FILE__))
-require 'tempfile'
+require "spec_helper"
 
 describe Sunspot::Solr::Server do
-  SUNSPOT_START_JAR = File.expand_path(
-    File.join(File.dirname(__FILE__), '..', '..', 'solr', 'start.jar')
-  )
 
-  before :each do
-    @server = Sunspot::Solr::Server.new
-  end
-
-  it 'runs server in current process' do
-    @server.should_not_receive(:fork)
-    @server.should_receive(:exec).with(/java .*-jar start.jar/)
-    @server.run
-  end
-
-  it 'runs Java with memory set' do
-    @server.memory = 2048
-    @server.should_receive(:exec).with(/-Xmx2048/)
-    @server.should_receive(:exec).with(/-Xms2048/)
-    @server.run
-  end
-
-  it 'runs Jetty with specified port' do
-    @server.port = 8981
-    @server.should_receive(:exec).with(/-Djetty\.port=8981/)
-    @server.run
-  end
-
-  it 'runs Solr with specified Solr home' do
-    @server.solr_home = '/tmp/var/solr'
-    @server.should_receive(:exec).with(%r(-Dsolr\.solr\.home=/tmp/var/solr))
-    @server.run
-  end
-
-  it 'runs Solr with specified Solr jar' do
-    @server.solr_jar = SUNSPOT_START_JAR
-    FileUtils.should_receive(:cd).with(File.dirname(SUNSPOT_START_JAR))
-    @server.run
+  describe ".new" do
+    it "ensures Java is installed upon initialization" do
+      expect(Sunspot::Solr::Java).to receive(:ensure_install!)
+      described_class.new
+    end
   end
 
-  it 'raises an error if java is missing' do
-    Sunspot::Solr::Java.stub(:installed? => false)
-    expect {
-     Sunspot::Solr::Server.new
-    }.to raise_error(Sunspot::Solr::Server::JavaMissing)
+  describe "#bootstrap" do
+    it "installs the solr home directory if it doesn't yet exist" do
+      specified_dir = Dir.mktmpdir + "/test_directory"
+      subject.solr_home = specified_dir
+      expect(Sunspot::Solr::Installer).to receive(:execute).
+        with(specified_dir, force: true, verbose: true)
+      subject.bootstrap
+    end
   end
 
-  describe 'with logging' do
-    before :each do
-      @server.log_level = 'info'
-      @server.log_file = 'log/sunspot-development.log'
-      Tempfile.should_receive(:new).with('logging.properties').and_return(@tempfile = StringIO.new)
-      @tempfile.should_receive(:flush)
-      @tempfile.should_receive(:close)
-      @tempfile.stub(:path).and_return('/tmp/logging.properties.12345')
-      @server.stub(:exec)
-    end
+  describe "#run" do
+    before { expect(subject).to receive(:bootstrap) }
 
-    it 'runs Solr with logging properties file' do
-      @server.should_receive(:exec).with(%r(-Djava\.util\.logging\.config\.file=/tmp/logging\.properties\.12345))
-      @server.run
+    it 'runs the Solr server in the foreground' do
+      expect(subject).to receive(:exec).with("./solr", "start", "-f", any_args)
+      subject.run
     end
 
-    it 'sets logging level' do
-      @server.run
-      @tempfile.string.should =~ /^java\.util\.logging\.FileHandler\.level *= *INFO$/
+    it 'runs the Solr server with the memory specified' do
+      subject.memory = 2048
+      expect(subject).to receive(:exec).with("./solr", "start", "-f", "-m", "2048", any_args)
+      subject.run
     end
 
-    it 'sets handler' do
-      @server.run
-      @tempfile.string.should =~ /^handlers *= *java.util.logging.FileHandler$/
+    it 'runs the Solr server with the port specified' do
+      subject.port = 8981
+      expect(subject).to receive(:exec).with("./solr", "start", "-f", "-p", "8981", any_args)
+      subject.run
     end
 
-    it 'sets formatter' do
-      @server.run
-      @tempfile.string.should =~ /^java\.util\.logging\.FileHandler\.formatter *= *java\.util\.logging\.SimpleFormatter$/
+    it 'runs the Solr server with the hostname specified' do
+      subject.bind_address = "0.0.0.0"
+      expect(subject).to receive(:exec).with("./solr", "start", "-f", "-h", "0.0.0.0", any_args)
+      subject.run
     end
 
-    it 'sets log file' do
-      @server.run
-      @tempfile.string.should =~ /^java\.util\.logging\.FileHandler\.pattern *= *log\/sunspot-development\.log$/
+    it 'runs the Solr server with the solr home directory specified' do
+      specified_dir = Dir.mktmpdir + "/test_directory"
+      subject.solr_home = specified_dir
+      expect(subject).to receive(:exec).with(any_args, "-s", specified_dir)
+      subject.run
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,18 +1,6 @@
-begin
-  require 'rspec'
-rescue LoadError => e
-  require 'spec'
-end
-
-require 'sunspot_solr'
-
-rspec =
-  begin
-    RSpec
-  rescue NameError, ArgumentError
-    Spec::Runner
-  end
+require "sunspot_solr"
 
-rspec.configure do |config|
-  # Maybe later...
+RSpec.configure do |config|
+  config.filter_run_including focus: true
+  config.run_all_when_everything_filtered = true
 end

data/sunspot_solr.gemspec

@@ -29,10 +29,6 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_development_dependency 'rspec', '~> 1.1'
-  s.add_development_dependency 'hanna'
-
-  s.rdoc_options << '--webcvs=http://github.com/outoftime/sunspot/tree/master/%s' <<
-                  '--title' << 'Sunspot-Solr - Bundled Solr distribution for Sunspot - API Documentation' <<
-                  '--main' << 'README.rdoc'
+  s.add_development_dependency 'rake', '~> 11.1.2'
+  s.add_development_dependency 'rspec', '~> 3.4.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sunspot_solr
 version: !ruby/object:Gem::Version
-  version: 2.2.5
+  version: 2.2.6
 platform: ruby
 authors:
 - Mat Brown
@@ -26,36 +26,36 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-05 00:00:00.000000000 Z
+date: 2016-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: 11.1.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: 11.1.2
 - !ruby/object:Gem::Dependency
-  name: hanna
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.4.0
 description: |2
       Sunspot::Solr provides a bundled Solr distribution for use with Sunspot.
       Typical deployment environments will require more configuration, but this
@@ -68,13 +68,13 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".rspec"
 - Gemfile
 - README.rdoc
+- Rakefile
 - bin/sunspot-installer
 - bin/sunspot-solr
 - lib/sunspot/solr/installer.rb
-- lib/sunspot/solr/installer/config_installer.rb
-- lib/sunspot/solr/installer/task_helper.rb
 - lib/sunspot/solr/java.rb
 - lib/sunspot/solr/railtie.rb
 - lib/sunspot/solr/server.rb
@@ -556,6 +556,8 @@ files:
 - solr/solr/solr.xml
 - solr/solr/test/core.properties
 - solr/solr/zoo.cfg
+- spec/installer_spec.rb
+- spec/java_spec.rb
 - spec/server_spec.rb
 - spec/spec_helper.rb
 - sunspot_solr.gemspec
@@ -564,12 +566,7 @@ licenses:
 - MIT
 metadata: {}
 post_install_message: 
-rdoc_options:
-- "--webcvs=http://github.com/outoftime/sunspot/tree/master/%s"
-- "--title"
-- Sunspot-Solr - Bundled Solr distribution for Sunspot - API Documentation
-- "--main"
-- README.rdoc
+rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
@@ -589,5 +586,7 @@ signing_key:
 specification_version: 4
 summary: Bundled Solr distribution for Sunspot
 test_files:
+- spec/installer_spec.rb
+- spec/java_spec.rb
 - spec/server_spec.rb
 - spec/spec_helper.rb

data/lib/sunspot/solr/installer/config_installer.rb

@@ -1,87 +0,0 @@
-require 'fileutils'
-require 'rake/file_list'
-
-module Sunspot
-  module Solr
-    class Installer
-      class ConfigInstaller
-        include TaskHelper
-        include FileUtils
-
-        attr_accessor :config_path, :force
-        alias_method :force?, :force
-
-        class <<self
-          def execute(config_path, options = {})
-            new(config_path, options).execute
-          end
-        end
-
-        def initialize(config_path, options)
-          self.config_path = File.expand_path config_path
-          self.force   = !!options[:force]
-          @verbose = !!options[:verbose]
-        end
-
-        def execute
-          return if sunspot_config_path == config_path
-
-          sunspot_config_files do |file, dest|
-            if File.exist?(dest)
-              next unless force?
-              say("Removing existing file #{dest}")
-            end
-
-            dir = dest.pathmap('%d')
-            unless File.exist?(dir)
-              say("Creating directory #{dir}")
-              mkdir_p dir
-            end
-
-            next if File.directory? file
-
-            say("Copying #{file} => #{dest}")
-            cp(file, dest)
-          end
-        end
-
-        private
-
-        def sunspot_config_files(&blk)
-          src, dest = expand_files(config_source_files), expand_files(config_dest_files)
-          src.zip(dest).each(&blk)
-        end
-
-        def config_dest_files
-          @config_dest_files ||= config_source_files.pathmap("%{^#{sunspot_config_path},#{config_path}}p")
-        end
-
-        def config_source_files
-          @config_source_files ||= glob_source_files
-        end
-
-        def glob_source_files
-          list = Rake::FileList.new("#{sunspot_config_path}/**/*") do |fl| 
-            fl.include "#{sunspot_config_path}/../solr.xml", "#{sunspot_config_path}/../**/core.properties"
-          end
-
-          list.map! { |path| path.first(2) == '..' ? File.join(sunspot_config_path, path) : path }
-
-          list
-        end
-
-        def sunspot_config_path
-          @sunspot_config_path ||= File.expand_path sunspot_relative_config_path
-        end
-
-        def sunspot_relative_config_path
-          File.join File.dirname(__FILE__), '..', '..', '..', '..', 'solr', 'solr', 'configsets'
-        end
-
-        def expand_files(filelist)
-          filelist.map { |file| File.expand_path file }
-        end
-      end
-    end
-  end
-end

data/lib/sunspot/solr/installer/task_helper.rb

@@ -1,13 +0,0 @@
-module Sunspot
-  module Solr
-    class Installer
-      module TaskHelper
-        def say(message)
-          if @verbose
-            STDOUT.puts(message)
-          end
-        end
-      end
-    end
-  end
-end