solr_mapper 0.1.3

data/lib/solr_mapper/solr_document.rb

@@ -0,0 +1,225 @@
+# Copyright 2010 The Skunkworx.
+#
+# 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.
+
+module SolrMapper
+  module SolrDocument
+    def self.included(base)
+      base.extend(ClassMethods)
+      base.solr_fields = []
+      base.has_many_relationships = {}
+    end
+
+    module ClassMethods
+      attr_accessor :base_url
+      attr_accessor :per_page
+      attr_accessor :solr_fields
+
+      def execute_read(opts)
+        eval(RestClient.get(build_url('select', opts.merge(:wt => 'ruby'))))
+      end
+
+      def execute_write(data, opts = nil)
+        send_update(data, opts)
+
+        # make an xml commit message Solr will be happy with
+        commit_message = ''
+        builder = Builder::XmlMarkup.new(:target => commit_message, :indent => 2)
+        builder.commit('waitFlush' => true, 'waitSearcher' => true)
+
+        send_update(commit_message)
+      end
+
+      def build_url(path, opts = nil)
+        qs = build_qs(opts)
+        qs = '?' + qs unless qs.empty?
+
+        URI::escape("#{base_url}/#{path}#{qs}")
+      end
+
+      def build_qs(opts)
+        uri = ''
+
+        if opts
+          opts.each_pair do |k, v|
+            uri << "#{k}=#{v}&"
+          end
+        end
+
+        uri.chop
+      end
+
+      def search(values, opts = {})
+        puts "Warning, the search method is deprecated and will be removed in a future release."
+        puts "Instead use 'query' which can accept a string."
+
+        query(values, opts)
+      end
+
+      def query(values, opts = {})
+        results, _ = query_counted(values, opts)
+        results
+      end
+
+      def query_counted(values, opts = {})
+        if values.kind_of?(Hash)
+          search_string = ''
+
+          values.each_pair do |k, v|
+            search_string << "#{k}:#{v} "
+          end
+
+          search_string = search_string.chop
+        else
+          search_string = values.to_s
+        end
+
+        response = execute_read(opts.merge(:q => search_string))
+        return map(response), response['response']['numFound']
+      end
+
+      def find(id)
+        result = query(:id => id)
+        return result[0] if result.count > 0
+      end
+
+      # return will_paginate pages for search queries
+      def paginate(search_query, opts = {})
+        opts[:page] ||= 1
+        opts[:page] = opts[:page].to_i if opts[:page].respond_to?(:to_i)
+        opts[:rows] ||= per_page || 10
+        opts[:start] = (opts[:page] - 1) * opts[:rows]
+
+        WillPaginate::Collection.create(opts[:page], opts[:rows]) do |pager|
+          results, count = query_counted(search_query, opts)
+
+          if results
+            results.compact!
+
+            pager.total_entries = count
+            pager.replace(results)
+            return pager
+          end          
+        end
+      end
+
+      protected
+      def map(docs)
+        objs = []
+
+        docs['response']['docs'].each do |doc|
+          obj = self.new
+
+          doc.each_pair do |k, v|
+            k = '_id' if k.to_s == 'id'
+
+            unless obj.class.method_defined?(k)
+              class_eval { attr_accessor k }
+              solr_fields << k.to_s unless solr_fields.include?(k.to_s)
+            end
+            
+            obj.instance_variable_set("@#{k}", v)
+          end
+
+          objs << obj
+        end
+
+        objs
+      end
+
+      def send_update(data, opts = nil)
+        solr_resource = RestClient::Resource.new(build_url('update', opts))
+        solr_resource.post(data, {:content_type => 'text/xml'})
+      end
+    end
+
+    attr_accessor :_id
+
+    def method_missing(m, *args, &block)
+      method_name = m.to_s
+      assignment = method_name.match(/\=$/)
+      method_name = method_name.gsub(/\=/, '') if assignment
+      self.class.class_eval { attr_accessor method_name }
+      send "#{method_name}=", args[0] if assignment
+    end
+
+    def save()
+      self.class.execute_write(to_solr_xml, {:overwrite => true})
+    end
+
+    def destroy
+      # make an xml delete message that Solr will be happy with
+      delete_message = ''
+      builder = Builder::XmlMarkup.new(:target => delete_message, :indent => 2)
+
+      builder.delete do |delete|
+        delete.id(_id)
+      end
+
+      self.class.execute_write(delete_message)
+    end
+
+    def to_solr_xml
+      output = ''
+      builder = Builder::XmlMarkup.new(:target => output, :indent => 2)
+
+      builder.add do |add|
+        add.doc do |doc|
+          self.class.solr_fields.each do |field_name|
+            field_name = field_name.to_s
+
+            if field_name == '_id'
+              solr_field_name = 'id'
+            else
+              solr_field_name = field_name
+            end
+
+            val = instance_variable_get("@#{field_name}")
+
+            if val
+              if val.kind_of? Array
+                val.each do |child|
+                  doc.field({:name => solr_field_name}, child)
+                end
+              else
+                doc.field({:name => solr_field_name}, val)
+              end
+            end
+          end
+        end
+      end
+
+      output
+    end
+
+    def update_attributes_values(data)
+      data.each_pair do |k, v|
+        instance_variable_set("@#{k}", v)
+        self.class.solr_fields << k.to_s unless self.class.solr_fields.include?(k.to_s)
+      end
+    end
+
+    def update_attributes(data)
+      update_attributes_values(data)
+      save()
+    end
+
+    def to_param
+      instance_variable_get('@_id').to_s
+    end
+
+    def initialize(data = {})
+      update_attributes_values(data)
+    end
+  end
+end

data/solr_mapper.gemspec

@@ -0,0 +1,42 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{solr_mapper}
+  s.version = "0.1.3"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Chris Umbel"]
+  s.date = %q{2010-10-26}
+  s.description = %q{Object Document Mapper for the Apache Foundation's Solr search platform}
+  s.email = %q{chrisu@dvdempire.com}
+  s.extra_rdoc_files = ["LICENSE.txt", "README.rdoc", "lib/solr_mapper.rb", "lib/solr_mapper/calculations.rb", "lib/solr_mapper/locators.rb", "lib/solr_mapper/relations.rb", "lib/solr_mapper/solr_document.rb"]
+  s.files = ["LICENSE.txt", "Manifest", "README.rdoc", "Rakefile", "lib/solr_mapper.rb", "lib/solr_mapper/calculations.rb", "lib/solr_mapper/locators.rb", "lib/solr_mapper/relations.rb", "lib/solr_mapper/solr_document.rb", "solr_mapper.gemspec", "spec/base.rb", "spec/calculations_spec.rb", "spec/locators_spec.rb", "spec/misc_spec.rb", "spec/paginated_spec.rb", "spec/query_spec.rb", "spec/relation_spec.rb", "spec/solr/stuff/config/schema.xml", "spec/solr/thing/config/schema.xml", "spec/solr/widget/conf/schema.xml", "spec/url_spec.rb"]
+  s.homepage = %q{http://github.com/skunkworx/solr_mapper}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Solr_mapper", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{solr_mapper}
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Object Document Mapper for the Apache Foundation's Solr search platform}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rest-client>, [">= 0"])
+      s.add_runtime_dependency(%q<uuid>, [">= 0"])
+      s.add_runtime_dependency(%q<will_paginate>, [">= 0"])
+      s.add_runtime_dependency(%q<activesupport>, [">= 0"])
+    else
+      s.add_dependency(%q<rest-client>, [">= 0"])
+      s.add_dependency(%q<uuid>, [">= 0"])
+      s.add_dependency(%q<will_paginate>, [">= 0"])
+      s.add_dependency(%q<activesupport>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rest-client>, [">= 0"])
+    s.add_dependency(%q<uuid>, [">= 0"])
+    s.add_dependency(%q<will_paginate>, [">= 0"])
+    s.add_dependency(%q<activesupport>, [">= 0"])
+  end
+end

data/spec/base.rb

@@ -0,0 +1,45 @@
+# Copyright 2010 The Skunkworx.
+#
+# 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.
+
+require 'rubygems'
+require 'uuid'
+require 'rest_client'
+require File.dirname(__FILE__) + '/../lib/solr_mapper'
+
+include SolrMapper
+
+class Stuff
+  include SolrDocument
+  @base_url = 'http://localhost:8080/solr_stuff'
+  @per_page = 10
+
+  belongs_to :thing
+end
+
+class Widget
+  include SolrDocument
+  @base_url = 'http://localhost:8080/solr_widget'
+  @per_page = 10
+
+  belongs_to :thing
+end
+
+class Thing
+  include SolrDocument
+  @base_url = 'http://localhost:8080/solr_thing'
+  @per_page = 10
+
+  has_many :stuffs
+  has_one :widget
+end

data/spec/calculations_spec.rb

@@ -0,0 +1,49 @@
+# Copyright 2010 The Skunkworx.
+#
+# 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.
+
+require File.dirname(__FILE__) + '/base'
+require 'rest_client'
+
+
+describe SolrMapper::SolrDocument do
+  before(:each) do
+    url = Thing::base_url
+    resource = RestClient::Resource.new("#{url}/update")
+    resource.post("<delete><query>id:[* TO *]</query></delete>", {:content_type => 'text/xml'})
+    resource.post("<commit/>", {:content_type => 'text/xml'})
+
+    thing = Thing.new({:_id => '04787560-bc23-012d-817c-60334b2add60', :content => 'sample content 1'})
+    thing.save
+
+    thing = Thing.new({:_id => '04787560-bc23-012d-817c-60334b2add61', :content => 'sample content 2'})
+    thing.save
+  end
+
+  it "should count all records" do
+    Thing.count.should == 2
+
+    thing = Thing.new({:_id => '04787560-bc23-012d-817c-60334b2add62', :content => 'sample content 2'})
+    thing.save
+
+    Thing.count.should == 3
+  end
+
+  it "should count records by query" do
+    thing = Thing.new({:_id => '04787560-bc23-012d-817c-60334b2add62', :content => 'test'})
+    thing.save
+
+    Thing.count('test').should == 1
+    Thing.count('sample').should == 2
+  end
+end

data/spec/locators_spec.rb

@@ -0,0 +1,40 @@
+# Copyright 2010 The Skunkworx.
+#
+# 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.
+
+require File.dirname(__FILE__) + '/base'
+
+describe SolrMapper::SolrDocument do
+  before(:all) do
+    url = Thing::base_url
+    resource = RestClient::Resource.new("#{url}/update")
+    resource.post("<delete><query>id:[* TO *]</query></delete>", {:content_type => 'text/xml'})
+    resource.post("<commit/>", {:content_type => 'text/xml'})
+
+    thing = Thing.new({:_id => '04787560-bc23-012d-817c-60334b2add60', :name => 'A', :content => 'sample content 1'})
+    thing.save
+    thing = Thing.new({:_id => '04787560-bc23-012d-817c-60334b2add61', :name => 'B', :content => 'sample content 2'})
+    thing.save
+  end
+
+  it "should return the first item with no query" do
+    thing = Thing.first()
+    thing.content.should_not be(nil)
+  end
+
+  it "should return the first item with a search string" do
+    thing = Thing.first('*:*', {:sort => 'name desc'})
+    thing.content.should_not be(nil)
+    thing.content.should == 'sample content 2'
+  end
+end

data/spec/misc_spec.rb

@@ -0,0 +1,34 @@
+# Copyright 2010 The Skunkworx.
+#
+# 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.
+
+require File.dirname(__FILE__) + '/base'
+
+include SolrMapper
+
+describe SolrDocument do
+  before(:all) do
+    url = Thing::base_url
+    resource = RestClient::Resource.new("#{url}/update")
+    resource.post("<delete><query>id:[* TO *]</query></delete>", {:content_type => 'text/xml'})
+    resource.post("<commit/>", {:content_type => 'text/xml'})
+
+    thing = Thing.new({:_id => '04787560-bc23-012d-817c-60334b2add60', :name => 'A', :content => 'sample content 1'})
+    thing.save
+  end
+
+  it "should match its ID to to_param" do
+    thing = Thing.first()
+    thing._id.should == thing.to_param()
+  end
+end

data/spec/paginated_spec.rb

@@ -0,0 +1,100 @@
+# Copyright 2010 The Skunkworx.
+#
+# 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.
+
+require File.dirname(__FILE__) + '/base'
+
+require 'rest_client'
+
+describe SolrMapper::SolrDocument do
+  before(:all) do
+    url = Thing::base_url
+    resource = RestClient::Resource.new("#{url}/update")
+    resource.post("<delete><query>id:[* TO *]</query></delete>", {:content_type => 'text/xml'})
+    resource.post("<commit/>", {:content_type => 'text/xml'})
+
+    thing = Thing.new({:_id => '04787560-bc23-012d-817c-60334b2add60', :content => 'sample content 1'})
+    thing.save
+    thing = Thing.new({:_id => '04787560-bc23-012d-817c-60334b2add61', :content => 'sample content 2'})
+    thing.save
+    thing = Thing.new({:_id => '04787560-bc23-012d-817c-60334b2add62', :content => 'sample content 3'})
+    thing.save
+    thing = Thing.new({:_id => '04787560-bc23-012d-817c-60334b2add63', :content => 'sample content 4'})
+    thing.save
+    thing = Thing.new({:_id => '04787560-bc23-012d-817c-60334b2add64', :content => 'sample content 5'})
+    thing.save
+    thing = Thing.new({:_id => '04787560-bc23-012d-817c-60334b2add65', :content => 'sample content 6'})
+    thing.save
+    thing = Thing.new({:_id => '04787560-bc23-012d-817c-60334b2add66', :content => 'sample content 7'})
+    thing.save
+    thing = Thing.new({:_id => '04787560-bc23-012d-817c-60334b2add67', :content => 'sample content 8'})
+    thing.save
+    thing = Thing.new({:_id => '04787560-bc23-012d-817c-60334b2add68', :content => 'sample content 9'})
+    thing.save
+    thing = Thing.new({:_id => '04787560-bc23-012d-817c-60334b2add69', :content => 'sample content 10'})
+    thing.save
+    thing = Thing.new({:_id => '04787560-bc23-012d-817c-60334b2add70', :content => 'sample content 11'})
+    thing.save
+    thing = Thing.new({:_id => '04787560-bc23-012d-817c-60334b2add11', :content => 'sample content 12'})
+    thing.save
+  end
+
+  it "should have correct default counts" do
+    page = Thing.paginate('*:*')
+    page.per_page.should == 10
+    page.total_entries.should == 12
+    page.total_pages.should == 2
+    page.current_page.should == 1
+  end
+
+  it "should have correct specified counts by search string" do
+    page1 = Thing.paginate('*:*', :rows => 5)
+    page2 = Thing.paginate('*:*', :rows => 5, :page => 2)
+    page3 = Thing.paginate('*:*', :rows => 5, :page => 3)
+
+    page1.total_pages.should == 3
+    page2.total_pages.should == 3
+    page3.total_pages.should == 3
+    page1.count.should == 5
+    page2.count.should == 5
+    page3.count.should == 2
+  end
+
+  it "should have correct specified counts by query" do
+    page1 = Thing.paginate({'*' => '*'}, {:rows => 5})
+    page2 = Thing.paginate({'*' => '*'}, {:rows => 5, :page => 2})
+    page3 = Thing.paginate({'*' => '*'}, {:rows => 5, :page => 3})
+
+    page1.total_pages.should == 3
+    page2.total_pages.should == 3
+    page3.total_pages.should == 3
+    page1.count.should == 5
+    page2.count.should == 5
+    page3.count.should == 2
+  end
+
+  it "should have a small page 2 bisect a page 1 twice its size by search string" do
+    big_page1 = Thing.paginate('*:*')
+    small_page2 = Thing.paginate('*:*', :rows => 5, :page => 2)
+
+    big_page1[5]._id.should == small_page2[0]._id
+  end
+
+  it "should have a small page 2 bisect a page 1 twice its size by query" do
+    big_page1 = Thing.paginate('*' => '*')
+    small_page2 = Thing.paginate({'*' => '*'}, {:rows => 5, :page => 2})
+
+    big_page1[5]._id.should == small_page2[0]._id
+  end
+end
+