peace_love 0.0.5 → 0.1.0

data/Rakefile

@@ -9,6 +9,7 @@ begin
     gemspec.authors = ["Lachie Cox"]
 
     gemspec.add_dependency("mongo", ['~>1.0.0'])
+    gemspec.add_dependency("angry_hash", ['=0.0.5'])
   end
 rescue LoadError
   puts "Jeweler not available. Install it with: gem install jeweler"

data/VERSION

@@ -1 +1 @@
-0.0.5
+0.1.0

data/examples/eg.helper.rb

@@ -19,6 +19,7 @@ end
 
 require 'mongo'
 
+# In YAML, output BSON ObjectIds succinctly.
 class BSON::ObjectID
   def to_yaml(opts = {})
     YAML.quick_emit(nil, opts) do |out|

data/examples/readme.eg.rb

@@ -0,0 +1,58 @@
+require 'eg.helper'
+require 'peace_love'
+
+PeaceLove.db = $db
+
+eg.setup do
+  PeaceLove['beans'].remove
+end
+
+module Bean
+  include PeaceLove::Doc
+  mongo_collection 'beans'
+
+  def is_a_bean?; true end
+end
+
+eg 'arthur' do
+  lima_bean  = { :name => 'lima' }
+  human_bean = { :name => 'Arthur', :prefered_drinks => %w[tea] }
+
+  PeaceLove['beans'].insert(lima_bean)
+  PeaceLove['beans'].insert(human_bean)
+
+  arthur = PeaceLove['beans'].find_one(:name => 'Arthur')
+
+  Show(arthur)
+
+  Show( arthur.prefered_drinks ) #=> [ 'tea' ]
+  Show( arthur.is_a_bean? )      #=> true
+
+  Show(arthur.is_a? Hash)
+  Show(arthur.class)
+
+  PeaceLove['beans'].update({:name => 'Arthur'}, '$push' => {'prefered_drinks' => 'pan-galactic gargle blaster'})
+  arthur = PeaceLove['beans'].find_one(:name => 'Arthur')
+
+  Show( arthur.prefered_drinks )
+end
+
+eg 'chaos taste' do
+  module Taste
+    def zesty?
+      spicy? && sour?
+    end
+  end
+
+  module Bean2
+    include PeaceLove::Doc
+    mongo_collection 'beans'
+    
+    sub_doc :taste, Taste
+  end
+
+  PeaceLove['beans'].mixin = Bean2
+
+  chaos = PeaceLove['beans'].build(:name => 'chaos', :taste => {:sour => true, :spicy => true})
+  Show( chaos.taste.zesty? ) #=> true
+end

data/examples/usage.eg.rb

@@ -3,118 +3,144 @@ require 'angry_hash'
 require 'peace_love'
 
 
+
+## Fixtures
+# Here are a couple of modules we're going to mix into hashes from Mongo.
+
+# Note that `PeaceLove.db` needs to be set before `mongo_collection` is called.
+# This will be fixed in the future.
+PeaceLove.db = $db
+
 module Kind
-  def claws; "dainty" end
+  def healthy; "healthy" end
 
-  def for_kids?
-    fictional? && cartoon?
+  def kids_love?
+    fictional?
   end
 end
 
-module Bear
+module Bean
   include PeaceLove::Doc
-  sub_doc :kind, Kind
-  sub_col :lovers, Bear
+  sub_doc :kind  , Kind
+  sub_col :examples, Bean
 
-  def claws; "woah" end
-  def liver
-    super.upcase
-  end
+  mongo_collection 'beans'
+
+  def texture; super.upcase end
 end
 
 eg.setup do
-  PeaceLove.db = $db
 
-  @mbears = $db['bears']
-  @mbears.remove()
+  @mongo_beans = $db['beans']
+  @mongo_beans.remove()
 
-  Bear.collection = 'bears'
-  @plbears = PeaceLove['bears']
+  @peace_love_beans = PeaceLove['beans']
 end
+
 eg.helpers do
-  attr_reader :mbears, :plbears
+  attr_reader :mongo_beans, :peace_love_beans
 end
 
 
-eg 'loading a document with a mixin' do
-  mbears.insert(:name => 'yogi', :liver => 'pure', :kind => {:fictional => true, :cartoon => true})
+eg 'loading a document' do
+  mongo_beans.insert(:name    => 'lima',
+                     :texture => 'crunchy',
+                     :colours => %w[green white],
+                     :kind => {:grown     => true,
+                               :fictional => false
+                              }
+                    )
+
+  lima = peace_love_beans.find_one(:name => 'lima')
 
-  yogi = plbears.find_one(:name => 'yogi')
+  # attributes on the document
+  Assert( lima.name         == 'lima'          )
+  Assert( lima.colours      == %w[green white] )
 
-  Assert( yogi.claws      == 'woah' )
-  Assert( yogi.kind.claws == 'dainty' )
-  Assert( yogi.name       == 'yogi' )
+  # methods on a document
+  Assert( lima.texture      == 'CRUNCHY' )
+
+  # sub-document
+  Assert( lima.kind.grown? )
+
+  # methods on a sub-doc
+  Assert(   lima.kind.healthy == 'healthy' )
+  Assert( ! lima.kind.kids_love? )
 
-  Assert( yogi.liver == 'PURE' )
-  Assert( yogi.kind.for_kids? )
 end
 
 
-eg 'loading a non-existent doc' do
-  b = plbears.find_one(:name => 'bertrand')
+eg 'loading a non-existent documents' do
+  b = peace_love_beans.find_one(:name => 'delicious')
 
   Assert( b.nil? )
 end
 
 
-eg 'wrapping the mongo cursor' do
-  mbears.insert(:name => 'yogi'    , :liver => 'pure', :kind => {:fictional => true, :cartoon => true})
-  mbears.insert(:name => 'humphrey', :liver => 'cihrrotic', :kind => {:fictional => true, :cartoon => false})
 
-  
+eg 'loading a list of documents' do
+  mongo_beans.insert(:name => 'baked'  , :texture => 'Mushy'  , :kind => {:fictional => false })
+  mongo_beans.insert(:name => 'magical', :texture => 'sparkly', :kind => {:fictional => true  })
+
   i = 0
-  plbears.find.each {|b|
+  peace_love_beans.find.each {|b|
 
     case i
     when 0
-      Assert( b.kind.claws == 'dainty' )
-      Assert( b.liver == 'PURE' )
+      Assert( b.name == 'baked'    )
+      Assert( ! b.kind.kids_love?  )
+      Assert( b.texture == 'MUSHY' )
     when 1
-      Assert( b.kind.claws == 'dainty' )
-      Assert( b.liver == 'CIHRROTIC' )
+      Assert( b.name == 'magical'    )
+      Assert( b.kind.kids_love?      )
+      Assert( b.texture == 'SPARKLY' )
     end
 
     i += 1
   }
 end
 
-
-eg 'mixing in to each element of a sub collection' do
-  mbears.remove()
-  mbears.insert(:name => 'yogi', :liver => 'pure', :kind => {:fictional => true, :cartoon => true}, :lovers => 
-                      [
-                        {:name => 'mrs. yogi', :liver => 'donated'}, {:name => 'yogi paw', :liver => 'jaundiced'}
+eg 'looking into an array sub collection' do
+  mongo_beans.insert(:name => 'jelly', :texture => 'wibbly', :kind => {:fictional => false},
+                     :examples => [
+                       {:name => 'red'  , :texture => 'raspberry'},
+                       {:name => 'black', :texture => 'shunned'  }
                       ])
+                       
 
-  yogi = plbears.find_one(:name => 'yogi')
+  jelly = peace_love_beans.find_one(:name => 'jelly')
 
-  Assert( yogi.lovers[0].liver == 'DONATED'   )
-  Assert( yogi.lovers[1].liver == 'JAUNDICED' )
+  Assert( jelly.examples[0].texture == 'RASPBERRY' )
+  Assert( jelly.examples[1].texture == 'SHUNNED'   )
 end
 
 
-eg 'building a blank doc' do
-  yogi = plbears.build
+eg 'building a blank document' do
+  bean = peace_love_beans.build
 
-  Assert( yogi.claws      == 'woah' )
-  Assert( yogi.kind.claws == 'dainty' )
+  Assert( bean.nothing.nil? )
+  Assert( bean.kind.healthy == 'healthy' )
 end
 
 
 eg 'saving a hash' do
-  h = AngryHash[ :somesuch => 'second thing' ]
-  id = plbears.insert( h )
+  h  = { :some_key => 'some value' }
+  id = peace_love_beans.insert( h )
 
-  Assert( plbears.find_one(id).somesuch == 'second thing' )
+  Assert( peace_love_beans.find_one(id).some_key == 'some value' )
 end
 
 
 eg 'the id accessor works in ruby 1.8 & 1.9' do
-  Assert(Bear.build(:id => 'abc').id == 'abc')
+  Assert( Bean.build(:id => 'abc').id == 'abc' )
 end
 
+__END__
+
+eg 'looking into a hash sub collection' do
+end
 
 # TODO
-#eg 'setting the mixin on the collection' do
-  #PeaceLove['bears'].mixin = Bear
-#end
+eg 'setting the mixin on the collection' do
+  PeaceLove['beans'].mixin = Bear
+end

data/lib/peace_love/document.rb

@@ -15,10 +15,14 @@ module PeaceLove
 
 
       def object_extensions
-        @object_extensions ||= Hash.new {|h,k| h[k] = []}
+        @object_extensions ||= {}
       end
+
       def mark_extension(obj,with)
-        object_extensions[obj.__id__] << with
+        if (previously_with = object_extensions[obj.__id__]) && previously_with != with
+          raise "object #{obj} has already been extended by a different PeaceLove::Doc (was: #{previously_with}, now: #{with})"
+        end
+        object_extensions[obj.__id__] = with
       end
 
       def mixin_registry
@@ -28,6 +32,7 @@ module PeaceLove
       def register_mixin(target_class,field,mod,options)
         mixin_registry[target_class][field.to_s] = [:single, mod, options]
       end
+
       def register_mixin_array(target_class, field, mod, options)
         mixin_registry[target_class][field.to_s] = [:array, mod, options]
       end
@@ -39,12 +44,11 @@ module PeaceLove
       end
 
       def mixin_to(parent_obj,field,obj)
-        # XXX - what does having multiple extensions really mean here?
-        extensions = object_extensions[parent_obj.__id__]
+        extension = object_extensions[parent_obj.__id__]
 
-        mixins = mixin_registry.values_at(*extensions).map {|m| m[field.to_s]}.compact
+        if mixin = mixin_registry[extension][field.to_s]
+          kind,mod,options = *mixin
 
-        mixins.each {|(kind,mod,options)|
           if options.key?(:default) && obj.nil?
             obj = options[:default]
           end
@@ -52,15 +56,15 @@ module PeaceLove
           # XXX - what happens when obj is nil
 
           case kind
-            when :single
-              extend_doc(obj,mod,parent_obj)
-            when :array
-              # XXX - this is ok for now... we really need to typecheck, perhaps wrap in a smart-array
+          when :single
+            extend_doc(obj,mod,parent_obj)
+          when :array
+            # XXX - this is ok for now... we really need to typecheck, perhaps wrap in a smart-array
 
 
-              obj.map! {|elt| extend_doc elt, mod, parent_obj}
-            end
-        }
+            obj.map! {|elt| extend_doc elt, mod, parent_obj}
+          end
+        end
 
         obj
       end
@@ -77,6 +81,7 @@ module PeaceLove
     def __source_collection=(col)
       @source_collection = col
     end
+
     def __parent_doc(doc)
       self.__source_collection = doc.__source_collection if doc.respond_to?(:__source_collection)
       @parent_doc = doc
@@ -95,8 +100,11 @@ module PeaceLove
         @collection = PeaceLove[collection_name]
         @collection.set_mixin(self)
       end
+      alias mongo_collection collection=
 
-      def collection; @collection end
+      def collection
+        @collection
+      end
       
       def sub_document(field,mod,options={})
         Doc.register_mixin(self,field,mod,options)

data/peace_love.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{peace_love}
-  s.version = "0.0.5"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Lachie Cox"]
-  s.date = %q{2010-07-14}
+  s.date = %q{2010-07-18}
   s.description = %q{A simple mixin layer for enhancing hashes retrieved from MongoDB. It eschews the normal 'mapping' compulsion of mongo libraries.}
   s.email = %q{lachie@smartbomb.com.au}
   s.files = [
@@ -32,7 +32,10 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.6}
   s.summary = %q{Peace, Love and Mongo.}
   s.test_files = [
-    "examples/eg.helper.rb",
+    "examples/collections.eg.rb",
+     "examples/documents.eg.rb",
+     "examples/eg.helper.rb",
+     "examples/readme.eg.rb",
      "examples/usage.eg.rb"
   ]
 
@@ -42,11 +45,14 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<mongo>, ["~> 1.0.0"])
+      s.add_runtime_dependency(%q<angry_hash>, ["= 0.0.5"])
     else
       s.add_dependency(%q<mongo>, ["~> 1.0.0"])
+      s.add_dependency(%q<angry_hash>, ["= 0.0.5"])
     end
   else
     s.add_dependency(%q<mongo>, ["~> 1.0.0"])
+    s.add_dependency(%q<angry_hash>, ["= 0.0.5"])
   end
 end
 

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
+  - 1
   - 0
-  - 5
-  version: 0.0.5
+  version: 0.1.0
 platform: ruby
 authors: 
 - Lachie Cox
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-14 00:00:00 +10:00
+date: 2010-07-18 00:00:00 +10:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -31,6 +31,20 @@ dependencies:
         version: 1.0.0
   type: :runtime
   version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: angry_hash
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 0
+        - 5
+        version: 0.0.5
+  type: :runtime
+  version_requirements: *id002
 description: A simple mixin layer for enhancing hashes retrieved from MongoDB. It eschews the normal 'mapping' compulsion of mongo libraries.
 email: lachie@smartbomb.com.au
 executables: []
@@ -83,5 +97,8 @@ signing_key:
 specification_version: 3
 summary: Peace, Love and Mongo.
 test_files: 
+- examples/collections.eg.rb
+- examples/documents.eg.rb
 - examples/eg.helper.rb
+- examples/readme.eg.rb
 - examples/usage.eg.rb