solrsan 0.0.30 → 0.0.32

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    solrsan (0.0.25)
+    solrsan (0.0.31)
       activemodel (~> 3.0.5)
       activesupport (~> 3.0.5)
       rsolr (~> 1.0.0)
@@ -9,11 +9,11 @@ PATH
 GEM
   remote: http://rubygems.org/
   specs:
-    activemodel (3.0.5)
-      activesupport (= 3.0.5)
+    activemodel (3.0.7)
+      activesupport (= 3.0.7)
       builder (~> 2.1.2)
-      i18n (~> 0.4)
-    activesupport (3.0.5)
+      i18n (~> 0.5.0)
+    activesupport (3.0.7)
     builder (2.1.2)
     i18n (0.5.0)
     rsolr (1.0.0)

data/README.rdoc

@@ -0,0 +1,112 @@
+= solrsan
+
+http://github.com/tc/solrsan
+
+This gem is a lightweight wrapper for the Apache Solr API.
+
+Before you start, read the documentation for solr at http://wiki.apache.org/solr
+
+It'll be invaluable for knowing parameters and error messages. 
+I made a few test cases for further examples at http://github.com/tc/solrsan/tree/master/test/unit
+
+=== HOWTO
+Install Jetty
+
+  wget http://download.eclipse.org/jetty/stable-7/dist/jetty-distribution-7.3.0.v20110203.tar.gz
+  tar -zxvf jetty-distribution-*.tar.gz
+  rm jetty-distribution-*.tar.gz
+  mv jetty-distribution-* /usr/local
+  ln -s jetty-distribution-* jetty
+
+Install solr
+
+
+  wget http://www.ecoficial.com/apachemirror/lucene/solr/3.1.0/apache-solr-3.1.0.tgz
+  tar -zxvf apache-solr-*.tgz
+  cd apache-solr-*
+  cp dist/apache-solr-*.war /usr/local/jetty/webapps/solr.war
+
+Add solrsan to your Ruby application's Gemfile:
+  gem "solrsan"
+
+Create solr configuration files using:
+  rails generate solrsan:config
+
+The generator will copy the following files into your application.
+
+  config/solr.yml
+  config/solr
+  config/initializers/solrsan.rb
+  lib/tasks/solr.rake
+
+Edit the config/solr.yml for your directory paths.
+
+The rake file will add these rake tasks:
+
+  rake solr:start
+  rake solr:stop
+  rake solr:clear_index
+  rake solr:index
+
+you will need to alter clear_index/index to match your models
+
+Deploy tasks via capistrano:
+add to your deploy.rb
+
+  require 'solrsan/capistrano'
+
+This will add the following methods which will just call the
+corresponding rake tasks:
+
+  cap solr:start
+  cap solr:stop
+  cap solr:reindex
+
+=== Indexing documents:
+Edit config/solr/conf/schema.xml to state the types of fields you want
+to index. You can use dynamic fields as well.
+
+These fields are required for each solr document and are automatically
+generated:
+
+  id, db_id, type
+
+In your model, define as_solr_document and return a hash with specific fields.
+
+
+  class Document < ActiveRecord::Base
+    include Solrsan::Search
+    after_save :index
+    before_destroy :destroy_index_document
+
+    def as_solr_document
+      {:content => "hi"}
+    end
+  end
+
+
+In each model, you can include a Solrsan::Search module which will include a few interface helper methods:
+  index
+  destroy_index_document
+  search(params)
+
+=== Search:
+A simple search query:
+  Document.search(:q => "hello world")
+
+More searching examples can be seen in test/unit/search_test.rb
+
+== Changelog
+0.0.32
+Using Hashwithindifferentaccess for request parsing.
+
+0.0.31
+Usable version!
+
+0.0.1
+First release.
+
+== Copyright
+
+Copyright (c) 2011 Tommy Chheng. See LICENSE for details.
+

data/lib/rails/generators/solrsan/config/config_generator.rb

@@ -3,28 +3,21 @@ require 'rails/generators/solrsan_generator'
 module Solrsan
   module Generators
     class ConfigGenerator < Rails::Generators::Base
-      desc "This setups the configuration files for solrsan"
-      def self.source_root
-        File.expand_path("../templates", __FILE__)
-      end
+      source_root File.expand_path("../templates", __FILE__)
 
-      def create_config_files
-        template "solrsan.rb", File.join("config", "initializers", "solrsan.rb")
-        template "solr.yml", File.join("config", "solr.yml")
-      end
+      def create_config_files
+        template("solrsan.rb", File.join("config", "initializers", "solrsan.rb"))
+        template("solr.yml", File.join("config", "solr.yml"))
+      end
 
       def copy_solr_conf
-        Dir["config/solr/conf/*"].each do |source|
-          destination = "config/solr/conf/#{File.basename(source)}"
-          FileUtils.rm(destination) if options[:force]
-          if File.exist?(destination)  
-            puts "Skipping #{destination} because it already exists"
-          else  
-            puts "Generating #{destination}"
-            FileUtils.cp(source, destination)
-          end
-        end
+        directory "../../../../../../config/solr", "config/solr", :recursive => true
       end
+
+      def copy_rake_task
+        copy_file "../../../../../tasks/solr.rake", "lib/tasks/solr.rake"
+      end
+
     end
   end
 end

data/lib/solrsan/search.rb

@@ -37,10 +37,10 @@ module Solrsan
       end
 
       def parse_params_for_solr(search_params={})
-        solr_params = { :echoParams => 'explicit',
+        solr_params = HashWithIndifferentAccess.new({ :echoParams => 'explicit',
           :q => "*:*",
           :facet => "on",
-          :'facet.mincount' => 1}.merge(search_params)
+          :'facet.mincount' => 1}.merge(search_params))
         solr_params[:hl] = true unless search_params[:'hl.fl'].blank?
         solr_params[:fq] = ["type:#{class_name}"] + parse_fq(search_params[:fq])
         solr_params

data/lib/solrsan/version.rb

@@ -1,3 +1,3 @@
 module Solrsan
-  VERSION = "0.0.30"
+  VERSION = "0.0.32"
 end

data/test/unit/search_test.rb

@@ -85,6 +85,14 @@ class SearchTest < Test::Unit::TestCase
     assert_equal expected, filters
   end
 
+  def test_parse_fq_with_hash_multiple_entries
+    params = {:fq => {:tags => ["ruby", "scala"], :author => "Bert"}}
+    filters = Document.parse_fq(params[:fq])
+
+    expected = ["tags:\"ruby\"", "tags:\"scala\"", "author:\"Bert\""]
+    assert_equal expected, filters
+  end
+
   def test_parse_fq_with_hash_array_args
     params = {:fq => [{:tags => ["ruby", "scala"]}]}
     filters = Document.parse_fq(params[:fq])
@@ -115,6 +123,22 @@ class SearchTest < Test::Unit::TestCase
     assert_equal expected, filters
   end
 
+
+  def test_filter_query_mulitple_filters
+    Document.index(Document.new(:id => 3, :author => "Bert", :title => "solr lucene",:review_count => 10, :tags => ['ruby']))
+    Document.index(Document.new(:id => 4, :author => "Ernie", :title => "lucene solr", :review_count => 5, :tags => ['ruby', 'scala']))
+    
+    response = Document.search(:q => "solr", :fq => {:tags => ["scala"], :author => "Ernie"})
+    docs = response[:docs]
+    metadata = response[:metadata]
+
+    assert_equal 1, metadata[:total_count]
+
+    doc = docs.first
+    assert_not_nil doc['tags']
+    assert doc['tags'].include?("scala")
+  end
+
   def test_filter_query
     Document.index(Document.new(:id => 3, :author => "Bert", :title => "solr lucene",:review_count => 10, :tags => ['ruby']))
     Document.index(Document.new(:id => 4, :author => "Ernie", :title => "lucene solr", :review_count => 5, :tags => ['ruby', 'scala']))

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: solrsan
 version: !ruby/object:Gem::Version
-  version: 0.0.30
+  version: 0.0.32
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-04-11 00:00:00.000000000 -07:00
+date: 2011-05-03 00:00:00.000000000 -07:00
 default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rsolr
-  requirement: &2172979340 !ruby/object:Gem::Requirement
+  requirement: &2156388680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,10 +22,10 @@ dependencies:
         version: 1.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *2172979340
+  version_requirements: *2156388680
 - !ruby/object:Gem::Dependency
   name: activemodel
-  requirement: &2172978840 !ruby/object:Gem::Requirement
+  requirement: &2156388180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -33,10 +33,10 @@ dependencies:
         version: 3.0.5
   type: :runtime
   prerelease: false
-  version_requirements: *2172978840
+  version_requirements: *2156388180
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &2172978380 !ruby/object:Gem::Requirement
+  requirement: &2156404100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -44,7 +44,7 @@ dependencies:
         version: 3.0.5
   type: :runtime
   prerelease: false
-  version_requirements: *2172978380
+  version_requirements: *2156404100
 description: solrsan is a lightweight wrapper for using Apache Solr within a Ruby
   application including Rails and Sinatra.
 email:
@@ -57,7 +57,7 @@ files:
 - Gemfile
 - Gemfile.lock
 - LICENSE
-- README.markdown
+- README.rdoc
 - Rakefile
 - config/solr.yml
 - config/solr.yml.example

data/README.markdown

@@ -1,71 +0,0 @@
-# solrsan
-This gem is a lightweight wrapper for the Apache Solr API.
-
-Before you start, read the documentation for solr at http://wiki.apache.org/solr/
-
-It'll be invaluable for knowing parameters and error messages. I made a few test cases for further examples at http://github.com/tc/solrsan/tree/master/test/
-
-## HOWTO
-Install jetty:
-Download jetty 7 from http://download.eclipse.org/jetty/stable-7/dist/
-
-Install solr:
-Download solr from http://www.apache.org/dyn/closer.cgi/lucene/solr/
-Unzip the jar file:
-tar -zxvf apache-solr-*.jar
-
-Copy dist/apache-solr-*.war into jetty's webapps directory as solr.war:
-cd apache-solr-*
-cp dist/apache-solr-*.war JETTY_PATH/webapps/solr.war
-
-Create solrsan and solr configuration files using:
-  rails generate Solrsan:Config
-
-The generator will copy the following files into your application.
-  config/solr.yml
-  config/solr
-  config/initializers/solrsan.rb
-  lib/tasks/solr.rake
-
-The rake file will add
-rake solr:start
-rake solr:stop
-rake solr:clear_index
-rake solr:index
-#you will need to alter clear_index/index to match your models
-
-Deploy tasks via capistrano:
-add to your deploy.rb
- require 'solrsan/capistrano'
-
-This will add the following methods which will just call the
-corresponding rake tasks:
-cap solr:start
-cap solr:stop
-cap solr:reindex
-
-##
-The fields are required for each solr document:
-id, db_id, type
-
-In each model, you can include a Solrsan::Search module which will include a few interface helper methods:
-index
-destroy_index_document
-search(params)
-
-You can also add hooks for thse methods:
-class Document < ActiveRecord::Base
-  include Solrsan::Search
-  after_save :index
-  before_destroy :destroy_index_document
-end
-
----
-## Changelog
-0.0.1
-First release.
-
-## Copyright
-
-Copyright (c) 2011 Tommy Chheng. See LICENSE for details.
-