solr_sail 0.0.1-java → 0.0.2-java

data/Gemfile

@@ -9,5 +9,6 @@ group :development do
   gem "bundler", "~> 1.1.4"
   gem "jeweler", "~> 1.8.4"
   gem 'jruby-openssl'
+  gem 'yard'
 end
 

data/Gemfile.lock

@@ -31,6 +31,7 @@ GEM
       diff-lcs (~> 1.1.3)
     rspec-mocks (2.11.2)
     thor (0.16.0)
+    yard (0.8.2.1)
 
 PLATFORMS
   java
@@ -43,3 +44,4 @@ DEPENDENCIES
   rsolr (~> 1.0.0)
   rspec (~> 2.11.0)
   thor (> 0.14.0)
+  yard

data/Jarfile.lock

@@ -4,7 +4,7 @@ scopes:
     dependencies: 
       - pom.xml
     resolved_dependencies: 
-      - com.tobedevoured.command:core:jar:0.0.1-SNAPSHOT
+      - com.tobedevoured.command:core:jar:0.0.1
       - org.modeshape:modeshape-common:jar:2.8.2.Final
       - com.metapossum:metapossum-scanner:jar:1.0.1
       - commons-beanutils:commons-beanutils:jar:1.8.3
@@ -36,22 +36,22 @@ scopes:
       - org.eclipse.jetty.orbit:com.sun.el:jar:2.2.0.v201108011116
       - org.eclipse.jetty.orbit:org.eclipse.jdt.core:jar:3.7.1
       - org.eclipse.jdt.core.compiler:ecj:jar:3.7.2
-      - org.apache.solr:solr-core:jar:3.6.0
-      - org.apache.solr:solr-solrj:jar:3.6.0
+      - org.apache.solr:solr-core:jar:3.6.1
+      - org.apache.solr:solr-solrj:jar:3.6.1
       - commons-httpclient:commons-httpclient:jar:3.1
       - org.codehaus.woodstox:wstx-asl:jar:3.2.7
-      - org.apache.lucene:lucene-core:jar:3.6.0
-      - org.apache.lucene:lucene-analyzers:jar:3.6.0
-      - org.apache.lucene:lucene-highlighter:jar:3.6.0
-      - org.apache.lucene:lucene-kuromoji:jar:3.6.0
-      - org.apache.lucene:lucene-memory:jar:3.6.0
-      - org.apache.lucene:lucene-misc:jar:3.6.0
-      - org.apache.lucene:lucene-phonetic:jar:3.6.0
-      - org.apache.lucene:lucene-queries:jar:3.6.0
+      - org.apache.lucene:lucene-core:jar:3.6.1
+      - org.apache.lucene:lucene-analyzers:jar:3.6.1
+      - org.apache.lucene:lucene-highlighter:jar:3.6.1
+      - org.apache.lucene:lucene-kuromoji:jar:3.6.1
+      - org.apache.lucene:lucene-memory:jar:3.6.1
+      - org.apache.lucene:lucene-misc:jar:3.6.1
+      - org.apache.lucene:lucene-phonetic:jar:3.6.1
+      - org.apache.lucene:lucene-queries:jar:3.6.1
       - jakarta-regexp:jakarta-regexp:jar:1.4
-      - org.apache.lucene:lucene-spatial:jar:3.6.0
-      - org.apache.lucene:lucene-spellchecker:jar:3.6.0
-      - org.apache.lucene:lucene-grouping:jar:3.6.0
+      - org.apache.lucene:lucene-spatial:jar:3.6.1
+      - org.apache.lucene:lucene-spellchecker:jar:3.6.1
+      - org.apache.lucene:lucene-grouping:jar:3.6.1
       - commons-codec:commons-codec:jar:1.6
       - commons-fileupload:commons-fileupload:jar:1.2.1
       - org.slf4j:jcl-over-slf4j:jar:1.6.1
@@ -72,6 +72,17 @@ scopes:
     resolved_dependencies: 
       - junit:junit:jar:4.10
       - org.hamcrest:hamcrest-core:jar:1.1
+      - org.apache.solr:solr-solrj:jar:3.6.1
+      - commons-httpclient:commons-httpclient:jar:3.1
+      - commons-io:commons-io:jar:2.1
+      - org.codehaus.woodstox:wstx-asl:jar:3.2.7
+      - org.slf4j:jcl-over-slf4j:jar:1.6.1
+      - org.slf4j:slf4j-api:jar:1.6.1
+      - org.apache.httpcomponents:httpclient:jar:4.2.1
+      - org.apache.httpcomponents:httpcore:jar:4.2.1
+      - commons-logging:commons-logging:jar:1.1.1
+      - commons-codec:commons-codec:jar:1.6
+      - org.apache.httpcomponents:httpmime:jar:4.2.1
 repositories: 
   - http://repo1.maven.org/maven2/
   - http://repository.jboss.org/nexus/content/groups/public-jboss

data/README.md

@@ -4,14 +4,68 @@ From zero to search in the flash of a gem.
 
 ## Install
 
+### For Ruby
+
     gem install solr_sail
+
+### For Java
+
+    <dependency>
+      <groupId>com.tobedevoured</groupId>
+      <artifactId>solrsail</artifactId>
+      <version>0.0.2</version>
+    </dependency>
     
 ## Usage
 
-### Install jar dependencies and Solr config
+### From the command line
+
+The _solr_sail_ gem comes with the executable **solrsail** which makes it easy to setup 
+and start Solr.
+
+#### Setup Solr
+
+To create a config directory to run Solr from, in the default path of **solr**, 
+simply run:
 
     solrsail install
     
-### Start up Solr
+To change the directory, you can pass _--solr_home_ or _-h_:
+  
+    solrsail install -h new/path/to/solr
+    
+If you want to make changes to how the Solr Server runs, you can edit the 
+[conf](https://github.com/typesafehub/config) _solr_sail.conf_ under the installed
+Solr home. Presently only _port_ and _contentpath_ are configurable. An example 
+_solr_sail.conf_:
+
+    solr_sail.solr.port=8983
+    solr_sail.solr.contextpath=/solr
+    
+#### Start up Solr
 
-    solrsail start
+    solrsail start
+    
+To change the directory of the Solr home, you can pass _--solr_home_ or _-h_:
+  
+    solrsail start -h new/path/to/solr
+    
+### From Ruby
+
+#### Setup Solr
+
+To create a config directory for Solr to run from
+
+    require 'rubygems'
+    require 'solr_sail'
+    
+    SolrSail.install_config()
+
+#### Start up Solr    
+
+    require 'rubygems'
+    require 'solr_sail'
+    
+    SolrSail.start()
+      
+    

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/lib/solr_sail/cli.rb

@@ -5,15 +5,15 @@ require 'solr_sail'
 module SolrSail
   class CLI < Thor
     desc "install", "Install Solr config"
-    method_option :dest,  :aliases => "-d", :default => 'solr', :desc => "Path to install solr config"
+    method_option :solr_home,  :aliases => "-h", :default => 'solr', :desc => "Path to install solr config"
     def install
-        SolrSail.install_config( :dest => options[:dest] )      
+        SolrSail.install_config( :solr_home => options[:solr_home] )      
     end
     
     desc "start", "Run Solr"
-    method_option :dest,  :aliases => "-d", :default => 'solr', :desc => "Path to install solr config"
+    method_option :solr_home,  :aliases => "-h", :default => 'solr', :desc => "Path to install solr config"
     def start
-        SolrSail.start( :dest => options[:dest] )   
+        SolrSail.start( :solr_home => options[:solr_home] )   
     end
     
     desc "version", "Version"

data/lib/solr_sail.rb

@@ -4,38 +4,79 @@ require 'java'
 
 require 'solr_sail/version'
 
+# :title:SolrSail
+#
+# Handles extracting the config and running an instance of Solr
+#
+# = Authors
+# Michael Guymon
+#
 module SolrSail
   
   DEFAULT_JAR_NAME = "solr_sail-#{SolrSail::VERSION}.jar"
   DEFAULT_JAR = File.expand_path("#{File.dirname(__FILE__)}/../#{DEFAULT_JAR_NAME}")
   DEFAULT_LOCKFILE = File.expand_path("#{File.dirname(__FILE__)}/../Jarfile.lock")
   
+  #
+  # Extract the configuration files for Solr
+  #
+  # opts:
+  #  * :jar: path to the solr_sail jar, default to jar packaged with the gem
+  #  * :lockfile: path to lockfile that contains the jar dependencies, defaults to Jarfile.lock packaged with the gem
+  #  * :solr_home: path to solr home, defaults to 'solr'
   def self.install_config( opts )
-    opts = { :jar => DEFAULT_JAR, :lockfile => DEFAULT_LOCKFILE }.merge( opts )
+    opts = { :solr_home => 'solr', :jar => DEFAULT_JAR, :lockfile => DEFAULT_LOCKFILE }.merge( opts )
     lockfile = opts.delete(:lockfile)
     jar = opts.delete(:jar)
     
     # XXX: should use LockJar to prevent duplicates in the classpath
     $CLASSPATH << File.expand_path( jar )
     
+    # XXX: need a safer way to pass opts to LockJar
     LockJar.install( lockfile, opts )
     LockJar.load( lockfile, opts )
     
-    solr_config = com.tobedevoured.solrsail.SolrConfig.new( opts[:dest] )
+    solr_config = com.tobedevoured.solrsail.SolrConfig.new( opts[:solr_home] )
     solr_config.install()
   end
   
+  #
+  # Start Solr
+  #
+  # The server is configued by solr_sail.conf loaded from the solr home. The
+  # opts passed in override solr_sail.conf
+  #
+  # opts:
+  #  * :context_path: context path solr runs under, defaults to /solr
+  #  * :jar: path to the solr_sail jar, default to jar packaged with the gem
+  #  * :join: have the server join the thread. Defaults to false 
+  #  * :lockfile: path to lockfile that contains the jar dependencies, defaults to Jarfile.lock packaged with the gem
+  #  * :port: the port solr runs on, defaults to 8983
+  #  * :solr_home: path to solr home, defaults to 'solr'
+  #
   def self.start( opts )
-    opts = { :jar => DEFAULT_JAR, :lockfile => DEFAULT_LOCKFILE, :join => true }.merge( opts )
+    opts = { 
+      :solr_home => 'solr', :jar => DEFAULT_JAR, :lockfile => DEFAULT_LOCKFILE, :join => false }.merge( opts )
+    
     lockfile = opts.delete(:lockfile)
     jar = opts.delete(:jar)
         
     # XXX: should use LockJar to prevent duplicates in the classpath
     $CLASSPATH << File.expand_path( jar )
     
+    # XXX: need a safer way to pass opts to LockJar
     LockJar.load( lockfile, opts )
     
-    jetty = com.tobedevoured.solrsail.JettyServer.new()
+    jetty = com.tobedevoured.solrsail.JettyServer.new( opts[:solr_home] )
+    
+    if opts[:port]
+      jetty.setPort( opts[:port] )
+    end
+    
+    if opts[:context_path]
+      jetty.setContextPath(opts[:context_path])
+    end
+    
     jetty.start(opts[:join])
       
     jetty

data/pom.xml

@@ -4,7 +4,7 @@
 
 	<groupId>com.tobedevoured</groupId>
 	<artifactId>solr_sail</artifactId>
-	<version>0.0.1</version>
+	<version>0.0.2</version>
 	<packaging>jar</packaging>
 
 	<name>Solr Sail</name>
@@ -102,7 +102,7 @@
 		<dependency>
 			<groupId>org.apache.solr</groupId>
 			<artifactId>solr-core</artifactId>
-			<version>3.6.0</version>
+			<version>3.6.1</version>
 		</dependency>
 
 		<!-- Logging -->
@@ -112,8 +112,6 @@
 			<version>1.0.6</version>
 		</dependency>
 
-
-
 		<!-- Testing -->
 		<dependency>
 			<groupId>junit</groupId>
@@ -121,19 +119,39 @@
 			<version>4.10</version>
 			<scope>test</scope>
 		</dependency>
+		<dependency>
+		  <groupId>org.apache.solr</groupId>
+		  <artifactId>solr-solrj</artifactId>
+		  <version>3.6.1</version>
+      <scope>test</scope>
+		</dependency>
+		<dependency>
+		  <groupId>org.apache.httpcomponents</groupId>
+		  <artifactId>httpclient</artifactId>
+		  <version>4.2.1</version>
+		  <scope>test</scope>
+		</dependency>
+		<dependency>
+      <groupId>org.apache.httpcomponents</groupId>
+      <artifactId>httpmime</artifactId>
+      <version>4.2.1</version>
+      <scope>test</scope>
+    </dependency>  
 	</dependencies>
 
-
 	<build>
 		<plugins>
-			<!-- <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-shade-plugin</artifactId> 
-				<version>1.7.1</version> <executions> <execution> <phase>package</phase> 
-				<goals> <goal>shade</goal> </goals> <configuration> <filters> <filter> <artifact>*:*</artifact> 
-				<excludes> <exclude>META-INF/*.SF</exclude> <exclude>META-INF/*.DSA</exclude> 
-				<exclude>META-INF/*.RSA</exclude> </excludes> </filter> </filters> <transformers> 
-				<transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer"> 
-				<mainClass>com.tobedevoured.command.Runner</mainClass> </transformer> </transformers> 
-				</configuration> </execution> </executions> </plugin> -->
+			<plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-jar-plugin</artifactId>
+        <configuration>
+          <archive>
+            <manifest>
+              <mainClass>com.tobedevoured.command.Runner</mainClass>
+            </manifest>
+          </archive>
+        </configuration>
+      </plugin>
 			<plugin>
 				<groupId>org.apache.maven.plugins</groupId>
 				<artifactId>maven-source-plugin</artifactId>

metadata

@@ -2,7 +2,7 @@
 name: solr_sail
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.1
+  version: 0.0.2
 platform: java
 authors: 
   - Michael Guymon
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-09-02 00:00:00 Z
+date: 2012-09-03 00:00:00 Z
 dependencies: 
   - !ruby/object:Gem::Dependency 
     name: lock_jar
@@ -89,6 +89,17 @@ dependencies:
     requirement: *id007
     prerelease: false
     type: :development
+  - !ruby/object:Gem::Dependency 
+    name: yard
+    version_requirements: &id008 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: "0"
+    requirement: *id008
+    prerelease: false
+    type: :development
 description: From zero to search in the flash of a gem.
 email: michael@tobedevoured.com
 executables: 
@@ -111,8 +122,7 @@ files:
   - lib/solr_sail/cli.rb
   - lib/solr_sail/version.rb
   - pom.xml
-  - solr_sail-0.0.1.jar
-  - solr_sail.gemspec
+  - solr_sail-0.0.2.jar
 homepage: http://github.com/mguymon/solr_sail
 licenses: 
   - MIT

data/solr_sail.gemspec

@@ -1,73 +0,0 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
-# -*- encoding: utf-8 -*-
-
-Gem::Specification.new do |s|
-  s.name = "solr_sail"
-  s.version = "0.0.1"
-  s.platform = "java"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Michael Guymon"]
-  s.date = "2012-09-02"
-  s.description = "From zero to search in the flash of a gem."
-  s.email = "michael@tobedevoured.com"
-  s.executables = ["solrsail"]
-  s.extra_rdoc_files = [
-    "LICENSE",
-    "README.md"
-  ]
-  s.files = [
-    "Gemfile",
-    "Gemfile.lock",
-    "Jarfile",
-    "Jarfile.lock",
-    "LICENSE",
-    "README.md",
-    "VERSION",
-    "bin/solrsail",
-    "lib/solr_sail.rb",
-    "lib/solr_sail/cli.rb",
-    "lib/solr_sail/version.rb",
-    "pom.xml",
-    "solr_sail-0.0.1.jar",
-    "solr_sail.gemspec"
-  ]
-  s.homepage = "http://github.com/mguymon/solr_sail"
-  s.licenses = ["MIT"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.24"
-  s.summary = "From zero to search in the flash of a gem."
-
-  if s.respond_to? :specification_version then
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<lock_jar>, ["~> 0.5.2"])
-      s.add_runtime_dependency(%q<thor>, ["> 0.14.0"])
-      s.add_development_dependency(%q<rsolr>, ["~> 1.0.0"])
-      s.add_development_dependency(%q<rspec>, ["~> 2.11.0"])
-      s.add_development_dependency(%q<bundler>, ["~> 1.1.4"])
-      s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
-      s.add_development_dependency(%q<jruby-openssl>, [">= 0"])
-    else
-      s.add_dependency(%q<lock_jar>, ["~> 0.5.2"])
-      s.add_dependency(%q<thor>, ["> 0.14.0"])
-      s.add_dependency(%q<rsolr>, ["~> 1.0.0"])
-      s.add_dependency(%q<rspec>, ["~> 2.11.0"])
-      s.add_dependency(%q<bundler>, ["~> 1.1.4"])
-      s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
-      s.add_dependency(%q<jruby-openssl>, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<lock_jar>, ["~> 0.5.2"])
-    s.add_dependency(%q<thor>, ["> 0.14.0"])
-    s.add_dependency(%q<rsolr>, ["~> 1.0.0"])
-    s.add_dependency(%q<rspec>, ["~> 2.11.0"])
-    s.add_dependency(%q<bundler>, ["~> 1.1.4"])
-    s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
-    s.add_dependency(%q<jruby-openssl>, [">= 0"])
-  end
-end
-