rsolr-nokogiri 0.0.0

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2008-2010 Matt Mitchell
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.rdoc

@@ -0,0 +1,25 @@
+=rsolr-nokogiri
+
+== Installation:
+  gem sources -a http://gemcutter.org
+  sudo gem install rsolr-nokogiri
+
+== Example:
+  require 'rubygems'
+  require 'rsolr-nokogiri'
+  solr = RSolr.connect :url=>'http://solrserver.com'
+  solr.message.use_nokogiri!
+  puts solr.message.add(:id => 1)
+
+== Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a future version unintentionally.
+* Commit, do not mess with rakefile, version, or history
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Matt Mitchell. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,50 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "rsolr-nokogiri"
+    gem.summary = %Q{Gives RSolr the power to use Nokogiri instead of Builder}
+    gem.description = %Q{Gives RSolr the power to use Nokogiri instead of Builder... it's faster.}
+    gem.email = "goodieboy@gmail.com"
+    gem.homepage = "http://github.com/mwmitchell/rsolr-nokogiri"
+    gem.authors = ["Matt Mitchell"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_dependency "rsolr", ">= 0.12.1"
+    
+    gem.files = FileList['lib/**/*.rb', 'LICENSE', 'README.rdoc', 'VERSION']
+    gem.test_files = ['spec/*', 'Rakefile']
+    
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  # Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rsolr-nokogiri #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/lib/rsolr-nokogiri.rb

@@ -0,0 +1,108 @@
+require 'rubygems'
+require 'rsolr'
+
+module RSolr::Nokogiri
+  
+  module Nokogiriable
+    
+    def use_nokogiri!
+      self.extend RSolr::Nokogiri::Generator
+    end
+    
+  end
+  
+  RSolr::Message::Generator.class_eval do
+    include Nokogiriable
+  end
+  
+  module Generator
+    
+    def build &block
+      require 'nokogiri'
+      b = Nokogiri::XML::Builder.new(:encoding => 'UTF-8')
+      yield b if block_given?
+      b.to_xml
+    end
+    
+    # generates "add" xml for updating solr
+    # "data" can be a hash or an array of hashes.
+    # - each hash should be a simple key=>value pair representing a solr doc.
+    # If a value is an array, multiple fields will be created.
+    #
+    # "add_attrs" can be a hash for setting the add xml element attributes.
+    # 
+    # This method can also accept a block.
+    # The value yielded to the block is a Message::Document; for each solr doc in "data".
+    # You can set xml element attributes for each "doc" element or individual "field" elements.
+    #
+    # For example:
+    #
+    # solr.add({:id=>1, :nickname=>'Tim'}, {:boost=>5.0, :commitWithin=>1.0}) do |doc_msg|
+    #   doc_msg.attrs[:boost] = 10.00 # boost the document
+    #   nickname = doc_msg.field_by_name(:nickname)
+    #   nickname.attrs[:boost] = 20 if nickname.value=='Tim' # boost a field
+    # end
+    #
+    # would result in an add element having the attributes boost="10.0"
+    # and a commitWithin="1.0".
+    # Each doc element would have a boost="10.0".
+    # The "nickname" field would have a boost="20.0"
+    # if the doc had a "nickname" field with the value of "Tim".
+    #
+    def add data, add_attrs={}, &block
+      data = [data] unless data.is_a?(Array)
+      build do |xml|
+        xml.add(add_attrs) do |add_node|
+          data.each do |doc|
+            doc = RSolr::Message::Document.new(doc) if doc.respond_to?(:each_pair)
+            yield doc if block_given?
+            add_node.doc_(doc.attrs) do |doc_node|
+              doc.fields.each do |field_obj|
+                doc_node.field field_obj.value, field_obj.attrs
+              end
+            end
+          end
+        end
+      end
+    end
+
+    # generates a <commit/> message
+    def commit(opts={})
+      build {|xml| xml.commit opts}
+    end
+
+    # generates a <optimize/> message
+    def optimize(opts={})
+      build {|xml| xml.optimize opts}
+    end
+
+    # generates a <rollback/> message
+    def rollback opts={}
+      build {|xml| xml.rollback opts}
+    end
+
+    # generates a <delete><id>ID</id></delete> message
+    # "ids" can be a single value or array of values
+    def delete_by_id(ids)
+      ids = [ids] unless ids.is_a?(Array)
+      build do |xml|
+        xml.delete do |delete_node|
+          ids.each { |id| delete_node.id_(id) }
+        end
+      end
+    end
+
+    # generates a <delete><query>ID</query></delete> message
+    # "queries" can be a single value or an array of values
+    def delete_by_query(queries)
+      queries = [queries] unless queries.is_a?(Array)
+      build do |xml|
+        xml.delete do |delete_node|
+          queries.each { |query| delete_node.query query }
+        end
+      end
+    end
+    
+  end
+  
+end

data/spec/rsolr-nokogiri_spec.rb

@@ -0,0 +1,65 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe RSolr::Nokogiri do
+  
+  module NokogiriEnabledHelpers
+    
+    def self.included base
+      base.let(:rsolr){
+        rsolr = RSolr.connect
+        rsolr.message.use_nokogiri!
+        rsolr
+      }
+    end
+  
+  end
+  
+  it 'should use Builder unless use_nokogiri! is called' do
+    rsolr = RSolr.connect
+    rsolr.message.should_not be_a(RSolr::Nokogiri::Generator)
+  end
+  
+  it 'should use Nokogiri after use_nokogiri! is called' do
+    rsolr = RSolr.connect
+    rsolr.message.use_nokogiri!
+    rsolr.message.should be_a(RSolr::Nokogiri::Generator)
+  end
+  
+  context 'RSolr::Client' do
+    
+    include NokogiriEnabledHelpers
+    
+    it 'should be using Nokogiri' do
+      rsolr.message.is_a? RSolr::Nokogiri::Generator
+    end
+    
+    it 'should forward calls to message/generator' do
+      rsolr.should_receive(:update).
+        with("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<optimize/>\n")
+      rsolr.optimize
+    end
+    
+  end
+  
+  context "RSolr::Nokogiri::Generator" do
+    
+    include NokogiriEnabledHelpers
+    
+    it 'should generator proper add XML' do
+      expected = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<add>\n  <doc>\n    <field name=\"id\">1</field>\n  </doc>\n</add>\n"
+      rsolr.message.add(:id=>1).should == expected
+    end
+    
+    it 'should generator proper delete XML - single id' do
+      expected = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<delete>\n  <id>1</id>\n</delete>\n"
+      rsolr.message.delete_by_id(1).should == expected
+    end
+    
+    it 'should generator proper delete XML - multiple ids' do
+      expected = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<delete>\n  <id>1</id>\n  <id>2</id>\n  <id>3</id>\n</delete>\n"
+      rsolr.message.delete_by_id([1,2,3]).should == expected
+    end
+    
+  end
+  
+end

data/spec/spec.opts

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

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rsolr-nokogiri'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification 
+name: rsolr-nokogiri
+version: !ruby/object:Gem::Version 
+  version: 0.0.0
+platform: ruby
+authors: 
+- Matt Mitchell
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-05 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rsolr
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.12.1
+    version: 
+description: Gives RSolr the power to use Nokogiri instead of Builder... it's faster.
+email: goodieboy@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- LICENSE
+- README.rdoc
+- VERSION
+- lib/rsolr-nokogiri.rb
+has_rdoc: true
+homepage: http://github.com/mwmitchell/rsolr-nokogiri
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Gives RSolr the power to use Nokogiri instead of Builder
+test_files: 
+- spec/rsolr-nokogiri_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- Rakefile