solr_wrapper 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e09bf11e0bdc4b5b491f07d8a186d1a7b8a5f114
-  data.tar.gz: 7624c4541d2769a337b2388a5613b97223f4422d
+  metadata.gz: a736420ab20bd3fc03e76f752a4e9db186d0b178
+  data.tar.gz: 778628b88b1485249f8fd7fd7146fae12304bbf9
 SHA512:
-  metadata.gz: 4e39cd0114a9e4c0811d29507e111daebc58a10ac669ee2e83accc7730670ef77fd274522acdd128c5737e90729c969d39c4426dafe237c30c2ba5b941bab37e
-  data.tar.gz: 9a293c7571d72fc9b107bacf127bc6bc9b81872fd0726650699a3c72ea80a484bd7d779edcaaa52ec39e29c0165af9b524826958aa6204bef082ac832fe5eeb5
+  metadata.gz: 0bb64503886ff7849e6500c05d8ce4bcebcbcbe5027a7eed2925cdc1eb4793e4a2f9206ece614fd9b96c5a2c60c98d934d69e0acdb1ea0ec7ddf54511a2eab31
+  data.tar.gz: d5e82e93a082b919913916809b7276f1fd7a376d41662de88849a23f83337230dcadc183e1c394e60f4d86b99e9e506c5a5b7cba195054d4af72f2090bd44416

data/README.md

@@ -26,7 +26,7 @@ SolrWrapper.wrap port: 8983,
                  instance_dir: '/opt/solr'
 ```
 
-Options:
+### Valid ruby and YAML options
 
 |Option         |                                         |
 |---------------|-----------------------------------------|
@@ -44,6 +44,7 @@ Options:
 | ignore_md5sum | (Boolean) |
 | solr_options  | (Hash) |
 | env           | (Hash) |
+| preserve      | (Boolean) Preserves the data in you collection between startups |
 
 ```ruby
 solr.with_collection(name: 'collection_name', dir: 'path_to_solr_configs')
@@ -54,6 +55,30 @@ solr.with_collection(name: 'collection_name', dir: 'path_to_solr_configs')
 ```console
 $ solr_wrapper -p 8983
 ```
+To see a list of valid options when using solr_wrapper to launch a Solr instance from the command line:
+```
+$ solr_wrapper -h
+```
+
+### Configuration file
+SolrWrapper can read configuration options from a YAML configuration file.
+By default, it looks for configuration files at `.solr_wrapper` and `~/.solr_wrapper`.
+
+You can also specify a configuration file when launching from the command line as follows:
+```
+$ solr_wrapper -config <path_to_config_file>
+```
+
+### Cleaning your repository from the command line
+
+By defualt SorlWrapper will clean out your data when it shuts down.
+If you utilize the preserve option your data will remain between runs.
+
+To clean out data that is being preserved explicitly run:
+```
+$ solr_wrapper <configuration options> clean
+```
+***Note*** You must use the same configuration options on the clean command as you do on the run command to clean the correct instance.
 
 ## Rake tasks
 

data/exe/solr_wrapper

@@ -5,8 +5,14 @@ require 'optparse'
 
 options = {}
 collection_options = {}
+subtext = <<HELP
+Commonly used command are:
+   clean :     cleans all data from solr and configures a clean instance based on configuration options
+See 'solr_wrapper COMMAND --help' for more information on a specific command.
+HELP
+
 args = OptionParser.new do |opts|
-  opts.banner = "Usage: solr_wrapper [options]"
+  opts.banner = "Usage: solr_wrapper [options] subcommand"
 
   opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
     options[:verbose] = v
@@ -59,9 +65,23 @@ args = OptionParser.new do |opts|
   opts.on("--no-checksum", "Skip running checksum validation on the downloaded file") do |d|
     options[:ignore_md5sum] = true
   end
+
+  opts.separator ""
+  opts.separator subtext
 end
 
+
+subcommands = {
+    'clean' => OptionParser.new do |opts|
+      opts.banner = "Usage: clean"
+    end,
+}
+
+
 begin
+  args.order!
+  command = ARGV.shift
+  subcommands[command].order! if command
   args.parse!
 rescue => error
   $stderr.puts "ERROR: #{error}\n"
@@ -73,6 +93,17 @@ end
 options[:verbose] = true if options[:verbose].nil?
 
 instance = SolrWrapper.instance(options)
+
+if command == 'clean'
+  if instance.started?
+    $stderr.puts "Please stop solr before cleaning"
+    exit 1
+  end
+  $stderr.puts "cleaning #{instance.instance_dir}..."
+  instance.remove_instance_dir!
+  exit 0
+end
+
 $stderr.print "Starting Solr #{instance.version} on port #{instance.port} ... "
 instance.wrap do |conn|
   conn.with_collection(collection_options) do

data/lib/solr_wrapper/settings.rb

@@ -51,7 +51,7 @@ module SolrWrapper
 
     def instance_dir
       @instance_dir ||= static_config.instance_dir
-      @instance_dir ||= File.join(Dir.tmpdir, File.basename(download_url, ".zip"))
+      @instance_dir ||= File.join(tmpdir, File.basename(download_url, ".zip"))
     end
 
     def managed?
@@ -90,6 +90,14 @@ module SolrWrapper
 
     private
 
+      def tmpdir
+        if defined?(Rails) && Rails.root
+          File.join(Rails.root, 'tmp')
+        else
+          Dir.tmpdir
+        end
+      end
+
       def default_solr_zip_path
         File.join(download_dir, File.basename(download_url))
       end

data/lib/solr_wrapper/version.rb

@@ -1,3 +1,3 @@
 module SolrWrapper
-  VERSION = '0.11.0'
+  VERSION = '0.12.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solr_wrapper
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Chris Beer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-05-04 00:00:00.000000000 Z
+date: 2016-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubyzip