solr_mapper 0.1.8 → 0.1.9

data/Manifest

@@ -11,6 +11,7 @@ solr_mapper.gemspec
 spec/base.rb
 spec/calculations_spec.rb
 spec/facets_spec.rb
+spec/generation.rb
 spec/locators_spec.rb
 spec/misc_spec.rb
 spec/paginated_spec.rb

data/README.rdoc

@@ -44,6 +44,20 @@ gem install solr_mapper
     has_one :widget
   end
 
+=== Auto Generated IDs
+    
+  as of 0.1.9 you can cause a document to create a UUID id
+  for new objects with: 
+
+  class Stuff
+    include SolrDocument
+
+    # tells solr_mapper to generate the id
+    auto_generate_id
+
+    bind_service_url 'http://localhost:8080/solr/stuff'
+  end
+
 === Reading
 
   thing = Thing.find(1)

data/Rakefile

@@ -16,7 +16,7 @@ require 'rubygems'
 require 'rake'
 require 'echoe'
 
-Echoe.new('solr_mapper', '0.1.8') do |p|
+Echoe.new('solr_mapper', '0.1.9') do |p|
   p.description    = "Object Document Mapper for the Apache Foundation's Solr search platform"
   p.url            = "http://github.com/skunkworx/solr_mapper"
   p.author         = "Chris Umbel"

data/lib/solr_mapper/relations.rb

@@ -17,6 +17,7 @@ module SolrMapper
     module ClassMethods
       attr_accessor :has_many_relationships
 
+      # handle a has one relationship. this document contains a foreign key to a doc in another index
       def has_one(target, opts = {})
         class_name, field_name, variable_name, id_field = determine_names(target, opts)
 
@@ -38,6 +39,7 @@ module SolrMapper
         end
       end
 
+      # handle a has one relationship. this document contains a foreign key to another index's documents
       def has_many(target, opts = {})
         class_name, field_name, variable_name, id_field = determine_names(target, opts)
         @@facet_field_name = field_name
@@ -147,14 +149,17 @@ module SolrMapper
         end
       end
 
+      # handle a belongs to relation. target index contains document with foreign keys to this document
       def belongs_to(target_name, opts = {})
         target_id_field_name = foreign_key(self.name)
 
         class_eval do
+          # create getter for owner object
           define_method target_name do
             owner = instance_variable_get("@#{target_name}")
 
             unless owner
+              # owner object hasn't been lazy loaded.  do so now.
               owner = Object::const_get(classify(target_name)).query(target_id_field_name => instance_variable_get("@_id"))[0]
               instance_variable_set("@#{target_name}", owner)
             end
@@ -162,6 +167,7 @@ module SolrMapper
             owner
           end
 
+          # create setter for owner object
           define_method "#{target_name}=" do |val|
             instance_variable_set("@#{target_name}", val)
             val.instance_variable_set("@#{target_id_field_name}", instance_variable_get("@_id"))
@@ -172,6 +178,7 @@ module SolrMapper
 
       protected
 
+      # figure out the names of properties and classes involved in the relation
       def determine_names(target, opts = {})
         class_name = opts[:class_name]
         class_name ||= classify(target)
@@ -184,6 +191,7 @@ module SolrMapper
       end
     end
 
+    # when the owner collection is modified this will be called sync the relation up
     def refresh_relation(field_name)
       ids = instance_variable_get("@#{self.class.has_many_relationships[field_name]}")
       ids.clear

data/lib/solr_mapper/solr_document.rb

@@ -38,6 +38,14 @@ module SolrMapper
         @base_url
       end
 
+      def auto_generate_id
+        @auto_geneerate_id = true
+      end
+
+      def auto_generate_id?
+        @auto_geneerate_id
+      end
+
       # send a read REST command to Solr
       def execute_read(opts)
         url = build_url('select', opts.merge(:wt => 'ruby'))
@@ -47,7 +55,7 @@ module SolrMapper
       # send a write REST command to Solr
       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)
@@ -180,6 +188,7 @@ module SolrMapper
 
     attr_accessor :_id
 
+    # the property doesn't exist for this document. add it now.
     def method_missing(m, *args, &block)
       method_name = m.to_s
       assignment = method_name.match(/\=$/)
@@ -190,9 +199,13 @@ module SolrMapper
 
     def save()
       send(:before_save) if respond_to?(:before_save)
+      
+      if not @_id and self.class.auto_generate_id?
+        @_id = UUID.new().generate() 
+        self.class.solr_fields << '_id' unless self.class.solr_fields.include?('_id')
+      end
 
       self.class.execute_write(to_solr_xml, {:overwrite => true})
-
       send(:after_save) if respond_to?(:after_save)      
     end
 

data/solr_mapper.gemspec

@@ -2,15 +2,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{solr_mapper}
-  s.version = "0.1.8"
+  s.version = "0.1.9"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Chris Umbel"]
-  s.date = %q{2010-12-02}
+  s.date = %q{2010-12-28}
   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/facets_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.files = ["LICENSE.txt", "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", "spec/base.rb", "spec/calculations_spec.rb", "spec/facets_spec.rb", "spec/generation.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", "Manifest", "solr_mapper.gemspec"]
   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"]

data/spec/generation.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'
+
+include SolrMapper
+
+describe SolrDocument do
+  before(:all) do
+    class Thing
+      auto_generate_id
+    end
+
+    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({:name => 'A', :content => 'sample content 1'})
+    thing.save
+  end
+
+  it "should have an auto generated id" do
+    thing = Thing.first()
+    thing._id.should_not be(nil)
+  end
+
+  it "shouldn't let the id change after successive saves" do
+    thing = Thing.first()
+    old_id = thing._id
+    thing.save()
+    thing._id.should == old_id
+  end
+
+  after(:all) do
+    Thing.class_eval("@auto_generate_id = false")
+  end
+end

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: solr_mapper
 version: !ruby/object:Gem::Version 
-  hash: 11
   prerelease: false
   segments: 
   - 0
   - 1
-  - 8
-  version: 0.1.8
+  - 9
+  version: 0.1.9
 platform: ruby
 authors: 
 - Chris Umbel
@@ -15,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-02 00:00:00 -05:00
+date: 2010-12-28 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,7 +25,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
@@ -40,7 +38,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
@@ -54,7 +51,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
@@ -68,7 +64,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
@@ -82,7 +77,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 2
         - 0
@@ -105,7 +99,6 @@ extra_rdoc_files:
 - lib/solr_mapper/solr_document.rb
 files: 
 - LICENSE.txt
-- Manifest
 - README.rdoc
 - Rakefile
 - lib/solr_mapper.rb
@@ -113,10 +106,10 @@ files:
 - 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/facets_spec.rb
+- spec/generation.rb
 - spec/locators_spec.rb
 - spec/misc_spec.rb
 - spec/paginated_spec.rb
@@ -126,6 +119,8 @@ files:
 - spec/solr/thing/config/schema.xml
 - spec/solr/widget/conf/schema.xml
 - spec/url_spec.rb
+- Manifest
+- solr_mapper.gemspec
 has_rdoc: true
 homepage: http://github.com/skunkworx/solr_mapper
 licenses: []
@@ -145,7 +140,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -154,7 +148,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 11
       segments: 
       - 1
       - 2