zentradi 0.0.0 → 0.0.1

data/README.rdoc

@@ -61,7 +61,7 @@ In particular, I want:
   [
     "magic",
     "ruby hooks overrides",
-    "additions to the mongo mapper API",
+    "additions to the mongo driver API",
     "plugins paraphernalia",
     "use and abuse of generated methods -- find_by_blah_blah anyone? -- ",
     "features of ActiveRecord, Datamapper, [INSERT ORM HERE]"

data/Rakefile

@@ -22,7 +22,6 @@ begin
     gem.add_development_dependency "rake"
     gem.add_dependency "mongo"
     gem.add_dependency "mongo_ext"
-    gem.add_dependency "weak_hash"
     gem.add_dependency "hashie"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end

data/VERSION

@@ -1 +1 @@
-0.0.0
+0.0.1

data/lib/zentradi.rb

@@ -1,13 +1,18 @@
 require 'hashie'
-require 'weak_hash'
 require 'mongo'
 
-module Zentradi
-  autoload :Utils,           "zentradi/utils"
-  autoload :ClassHelpers,    'zentradi/class_helpers'
-  autoload :Instantiators,   'zentradi/instantiators'
-  autoload :IdentityMap,     'zentradi/identity_map'
-  autoload :Connection,      'zentradi/connection'
-  autoload :Finders,         'zentradi/finders'
-  autoload :Document,        'zentradi/document'
+module Zdi
+  autoload :Delegate        , 'zentradi/delegate'
+  autoload :DocumentWrapper , 'zentradi/document_wrapper'
+  autoload :Collection      , 'zentradi/collection'
+
+  class << self
+    attr_accessor :default_database
+
+    def Collection(collection, database = Zdi.default_database)
+      Class.new(Zdi::Collection) do
+        instance_variable_set("@collection", database[collection])
+      end
+    end
+  end
 end

data/lib/zentradi/collection.rb

@@ -0,0 +1,56 @@
+module Zdi
+  class Collection
+    class << self
+      extend Zdi::Delegate
+      delegate *(Mongo::Collection.public_instance_methods - public_instance_methods), :to => :collection
+    end
+
+    module ClassMethods
+      attr_accessor :collection
+
+      def inherited(base)
+        base.collection = self.collection
+      end
+
+      def ensure_collection
+        database.create_collection(collection.name)
+      end
+
+      def drop_collection
+        collection.drop
+      end
+
+      def recreate_collection
+        drop_collection; ensure_collection
+      end
+
+      def build(attributes = {})
+        DocumentWrapper.new(self, attributes)
+      end
+
+      def create(attributes = {})
+        doc = build(attributes)
+        doc.save
+        doc
+      end
+
+      def find_or_build(attributes)
+        find_one(attributes) || build(attributes)
+      end
+
+      def find_or_create(attributes)
+        update(attributes, attributes, :upsert => true)
+      end
+
+      def all
+        find
+      end
+    end
+
+    extend ClassMethods
+
+    class << self
+      alias_method :first, :find_one
+    end
+  end
+end

data/lib/zentradi/delegate.rb

@@ -0,0 +1,32 @@
+module Zdi
+  module Delegate
+    def delegate(*methods)
+      include Wrapper unless ancestors.include?(Wrapper)
+      to = methods.pop[:to]
+      methods.each do |name|
+        module_eval(<<-EOMETHOD, __FILE__, __LINE__ + 1)
+          def #{ name }(*args, &block)
+            new_args = args.map { |a| a.is_a?(DocumentWrapper) ? a.to_hash : a }
+
+            result = #{to}.send :#{name}, *new_args, &block
+
+            return wrap_if_document(result)
+          end
+        EOMETHOD
+      end
+    end
+
+    module Wrapper
+      def wrap_if_document(object)
+        if object.is_a?(OrderedHash)
+          DocumentWrapper.new(self, object)
+        elsif object.respond_to?(:map)
+          object.map { |e| wrap_if_document(e) }
+        else
+          return object
+        end
+      end
+    end
+
+  end
+end

data/lib/zentradi/document_wrapper.rb

@@ -0,0 +1,38 @@
+module Zdi
+  class DocumentWrapper < Hashie::Mash
+
+    attr_reader :collection
+
+    def initialize(collection, hash = {})
+      super(hash)
+      @collection = collection
+    end
+
+    def id
+      super || _id
+    end
+
+    def new?
+      id.nil? || @collection.find("_id" => id).count == 0
+    end
+
+    def save
+      if id.nil?
+        self.id = @collection.save(self)
+      else
+        @collection.update({"_id" => id}, self)
+      end
+      self
+    end
+
+    def update(attributes)
+      super(attributes)
+      save
+    end
+
+    def destroy
+      @collection.remove("_id" => id)
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -1 +1,3 @@
 require 'zentradi'
+
+Zdi.default_database = Mongo::Connection.new.db("zentradi")

data/spec/zentradi/document_spec.rb

@@ -1,19 +1,14 @@
 require 'spec_helper'
 
-class Post < Zentradi::Document
-  mongo :collection => "post", :database => "zentradi"
+Post = Zdi::Collection("posts")
 
-  mongo_accessor :title
-end
-
-describe Zentradi::Document do
+describe Zdi::Collection do
   before do
     Post.remove
   end
 
   it "creates a document" do
-    post = Post.new
-    post.id.should be_nil
+    post = Post.build
     post.should be_new
 
     post.save
@@ -22,18 +17,14 @@ describe Zentradi::Document do
     post.should_not be_new
   end
 
-  it "finds a document through the identity map" do
-    @post = Post.create(:title => "Hola Mundo", :body => "Hi.")
-    Post.first("_id" => @post.id).should be_an_instance_of(Post)
-  end
 
   it "finds or initializes a document" do
     @post = Post.create(:title => "Test")
 
-    found = Post.find_or_initialize(:title => "Test")
+    found = Post.find_or_build(:title => "Test")
     found.title.should == "Test"
 
-    found = Post.find_or_initialize(:title => "Test 2")
+    found = Post.find_or_build(:title => "Test 2")
     found.title.should == "Test 2"
     found.should be_new
     found.save
@@ -43,11 +34,14 @@ describe Zentradi::Document do
   end
 
   it "updates a document" do
-    @post = Post.create(:title => "Hola Mundo", :body => "Hi.")
-    @post.title = "ABC"
-    @post.save
-    @post.reload
-    @post.title.should == "ABC"
+    post = Post.create(:title => "Hola Mundo", :body => "Hi.")
+    post.title = "ABC"
+    post.save
+
+    post.update(:title => post.title + " DEF")
+
+    from_db = Post.first("_id" => post.id)
+    from_db.title.should == "ABC DEF"
   end
 
   it "destroys a document" do

data/spec/zentradi/indexes_spec.rb

@@ -1,3 +1,4 @@
+__END__
 require 'spec_helper'
 
 class Book < Zentradi::Document

data/zentradi.gemspec

@@ -0,0 +1,72 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{zentradi}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Emmanuel Oga"]
+  s.date = %q{2010-03-29}
+  s.description = %q{minimalistic tools for accessing mongodb}
+  s.email = %q{EmmanuelOga@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "Gemfile",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/zentradi.rb",
+     "lib/zentradi/collection.rb",
+     "lib/zentradi/delegate.rb",
+     "lib/zentradi/document_wrapper.rb",
+     "spec/spec_helper.rb",
+     "spec/zentradi/document_spec.rb",
+     "spec/zentradi/indexes_spec.rb",
+     "zentradi.gemspec"
+  ]
+  s.homepage = %q{http://github.com/EmmanuelOga/zentradi}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{minimalistic tools for accessing mongodb}
+  s.test_files = [
+    "spec/zentradi/document_spec.rb",
+     "spec/zentradi/indexes_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_development_dependency(%q<rake>, [">= 0"])
+      s.add_runtime_dependency(%q<mongo>, [">= 0"])
+      s.add_runtime_dependency(%q<mongo_ext>, [">= 0"])
+      s.add_runtime_dependency(%q<hashie>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<rake>, [">= 0"])
+      s.add_dependency(%q<mongo>, [">= 0"])
+      s.add_dependency(%q<mongo_ext>, [">= 0"])
+      s.add_dependency(%q<hashie>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<rake>, [">= 0"])
+    s.add_dependency(%q<mongo>, [">= 0"])
+    s.add_dependency(%q<mongo_ext>, [">= 0"])
+    s.add_dependency(%q<hashie>, [">= 0"])
+  end
+end
+

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 0
-  version: 0.0.0
+  - 1
+  version: 0.0.1
 platform: ruby
 authors: 
 - Emmanuel Oga
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-16 00:00:00 -03:00
+date: 2010-03-29 00:00:00 -03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -68,7 +68,7 @@ dependencies:
   type: :runtime
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  name: weak_hash
+  name: hashie
   prerelease: false
   requirement: &id005 !ruby/object:Gem::Requirement 
     requirements: 
@@ -79,18 +79,6 @@ dependencies:
         version: "0"
   type: :runtime
   version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: hashie
-  prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
-  type: :runtime
-  version_requirements: *id006
 description: minimalistic tools for accessing mongodb
 email: EmmanuelOga@gmail.com
 executables: []
@@ -109,16 +97,13 @@ files:
 - Rakefile
 - VERSION
 - lib/zentradi.rb
-- lib/zentradi/class_helpers.rb
-- lib/zentradi/connection.rb
-- lib/zentradi/document.rb
-- lib/zentradi/identity_map.rb
-- lib/zentradi/instantiators.rb
+- lib/zentradi/collection.rb
+- lib/zentradi/delegate.rb
+- lib/zentradi/document_wrapper.rb
 - spec/spec_helper.rb
 - spec/zentradi/document_spec.rb
-- spec/zentradi/identity_map_spec.rb
 - spec/zentradi/indexes_spec.rb
-- spec/zentradi_spec.rb
+- zentradi.gemspec
 has_rdoc: true
 homepage: http://github.com/EmmanuelOga/zentradi
 licenses: []
@@ -150,8 +135,6 @@ signing_key:
 specification_version: 3
 summary: minimalistic tools for accessing mongodb
 test_files: 
-- spec/zentradi_spec.rb
 - spec/zentradi/document_spec.rb
-- spec/zentradi/identity_map_spec.rb
 - spec/zentradi/indexes_spec.rb
 - spec/spec_helper.rb

data/lib/zentradi/class_helpers.rb

@@ -1,46 +0,0 @@
-module Zentradi
-  # Some random helpers to be used at class level.
-  module ClassHelpers
-
-    def instance_access_to_class_methods(*names)
-      names.each do |name|
-        module_eval(<<-EOMETHOD, __FILE__, __LINE__ + 1)
-          def #{ name }(*args, &block)
-            self.class.#{ name }(*args, &block)
-          end
-        EOMETHOD
-      end
-    end
-
-    # creates a shortcut for accessing keys
-    # on the mongo document.
-    # Not really needed but seems like after
-    # ActiveRecord nobody can live without this
-    # (including me? :-)
-    def mongo_accessor(*keys)
-      keys.each do |key|
-        module_eval(<<-EOMETHOD, __FILE__, __LINE__ + 1)
-          def #{ key }
-            document[#{key.inspect}]
-          end
-
-          def #{ key }=(val)
-            document[#{key.inspect}] = val
-          end
-        EOMETHOD
-      end
-    end
-
-    def delegate(*methods)
-      to = methods.pop[:to]
-      methods.each do |name|
-        module_eval(<<-EOMETHOD, __FILE__, __LINE__ + 1)
-          def #{ name }(*args, &block)
-            #{to}.#{name}(*args, &block)
-          end
-        EOMETHOD
-      end
-    end
-
-  end
-end

data/lib/zentradi/connection.rb

@@ -1,48 +0,0 @@
-module Zentradi
-  # methods to manage the mongo driver communication artefacts
-  module Connection
-
-    def connection(*args)
-      @_connection = nil unless args.empty?
-      @_connection ||= Mongo::Connection.new(*args)
-    end
-
-    def database(database_name = nil)
-      @_database = nil unless database_name.nil?
-      @_database ||= connection.db(database_name)
-    end
-
-    def collection(collection_name = nil)
-      @_collection = nil unless collection_name.nil?
-      @_collection ||= database[collection_name]
-    end
-
-    # configuration shortcut
-    def mongo(options)
-      connection *options[:connection] if options.member?(:connection)
-      database   options[:database]    if options.member?(:database)
-      collection options[:collection]  if options.member?(:collection)
-    end
-
-    # -------------------------------------------------------------------------
-
-    def ensure_collection
-      database.create_collection(collection.name)
-    end
-
-    def drop_collection!
-      collection.drop
-    end
-
-    def recreate_collection!
-      drop_collection! and ensure_collection
-    end
-
-    def identity_map
-      raise RuntimeError, "please set the mongo database first" unless database
-      raise RuntimeError, "please set the mongo collection first" unless collection
-      Zentradi::IdentityMap[database.name, collection.name]
-    end
-
-  end
-end

data/lib/zentradi/document.rb

@@ -1,83 +0,0 @@
-module Zentradi
-  class Document
-
-    extend Connection
-    extend ClassHelpers
-    extend Instantiators
-
-    attr_accessor :document
-    instance_access_to_class_methods :identity_map, :collection
-
-    def initialize(document = nil)
-      raise ArgumentError, "provide a Hash like object or no parameters" unless document.nil? || document.class.ancestors.include?(Hash)
-
-      @document = document ? Hashie::Mash.new(document) : Hashie::Mash.new
-    end
-
-    def update(document)
-      @document.update(document) and save
-    end
-
-    def update!(document)
-      @document.update(document) and save!
-    end
-
-    def [](key)
-      @document[key]
-    end
-
-    def []=(key, value)
-      @document[key] = value
-    end
-
-    def id
-      @document["_id"]
-    end
-
-    def new?
-      not saved?
-    end
-
-    def saved?
-      id && collection.find("_id" => id).count != 0
-    end
-
-    def save(safe = false)
-      if id
-        collection.update({"_id" => id}, @document, :safe => safe)
-      else
-        update("_id" => collection.save(@document, :safe => safe))
-      end
-    end
-
-    def save!
-      save(true)
-    end
-
-    def destroy
-      if id
-        collection.remove("_id" => id)
-        @document.delete("_id")
-      end
-    end
-
-    def reload
-      if _id = id
-        @document.clear["_id"] = _id # clear and set.
-        update(mongo_document)
-      end
-
-      self
-    end
-
-    private
-    def mongo_document
-      raise RuntimeError, "cannot retrieve a new document" if new?
-
-      collection.find_one("_id" => id).tap do |i|
-        raise RuntimeError, "nothing was retrieved while loading the mongo instance ( #{ i.inspect } )" if i.nil? || i.empty?
-      end
-    end
-
-  end
-end

data/lib/zentradi/identity_map.rb

@@ -1,75 +0,0 @@
-module Zentradi
-  # NOTE: WIP, not working yet.
-  #
-  # Stores weak references to objects to ensure only one
-  # instance of a ruby class is used for holding a reference
-  # to a specific mongo collection.
-  class IdentityMap
-    class << self
-      # one identity map per db/collection tuple
-      def [](db_name, collection_name)
-        @hash ||= Hash.new { |h,k| h[k] = Hash.new { |hh, kk| hh[kk] = IdentityMap.new } }
-        @hash[db_name][collection_name]
-      end
-    end
-
-    def initialize
-      @map = WeakHash.new
-    end
-
-    # retrieves a document with given _id
-    def get(_id)
-      @map[_id].tap { |instance| check(_id, instance) }
-    end
-
-    # stores a reference to the mongo document.
-    def set(_id, instance)
-      check(_id, @map[_id] = instance)
-    end
-
-  private
-    def check(_id, instance)
-      raise ArgumentError, "instance must be a Zentradi::Document" unless instance.nil? || instance.is_a?(Zentradi::Document)
-      raise RuntimeError, "instance #{ instance.inspect } does not match _id: #{ _id }" if instance && ( instance.id != _id )
-      instance
-    end
-
-    # Some helper methods to enable / disable the identity map at a class level.
-    module Management
-      def enable_identity_map
-        @_identity_map = true
-      end
-
-      def disable_identity_map
-        @_identity_map = false
-      end
-
-      # enabled by default
-      def identity_map_enabled?
-        @_identity_map.nil? || @_identity_map
-      end
-
-    private
-
-      def fetch_instance(param_doc)
-        if param_doc.nil?
-          nil
-        elsif identity_map_enabled? && param_doc["_id"]
-
-          if instance = identity_map.get(param_doc["_id"])
-            instance.update(param_doc)
-          else
-            document = param_doc.is_a?(Document) ? param_doc : new(param_doc)
-            instance = identity_map.set(document["_id"], document)
-          end
-
-          instance
-        else
-          param_doc.is_a?(Document) ? param_doc : new(param_doc)
-        end
-      end
-
-    end # end module Management
-
-  end
-end

data/lib/zentradi/instantiators.rb

@@ -1,36 +0,0 @@
-module Zentradi
-  module Instantiators
-    extend ClassHelpers
-
-    delegate :remove, :update, :to => :collection
-
-    def all(params = nil)
-      collection.find(params).map(&method(:instantiate))
-    end
-
-    def first(params = nil)
-      query = params.is_a?(String) || params.is_a?(Numeric) ? {"_id" => params} :  params
-
-      instantiate collection.find_one(query)
-    end
-
-    def find_or_initialize(params)
-      raise RuntimeError, "cannot find a document without params" if params.nil?
-
-      first(params) || instantiate(params)
-    end
-
-    def create(params)
-      instantiate(params).tap { |n| n.save }
-    end
-
-    def create!(params)
-      instantiate(params).tap { |n| n.save! }
-    end
-
-    def instantiate(document)
-      document ? new(document) : nil
-    end
-
-  end
-end

data/spec/zentradi/identity_map_spec.rb

@@ -1,26 +0,0 @@
-require 'spec_helper'
-
-describe Zentradi::IdentityMap do
-  before do
-    @oh = Zentradi::Document.new
-    @oh["_id"] = "123456"
-
-    @im = Zentradi::IdentityMap["a_db", "a_collection"]
-
-    GC.start # make sure @im is collected if it was overwritten (e.g. in second example run)
-  end
-
-  it "stores an object" do
-    @im.set("123456", @oh)
-    @im.get("123456").should == @oh
-  end
-
-  it "stores a weak reference" do
-    @im.set("123456", @oh)
-    @im.get("123456").should == @oh
-
-    @oh = nil; GC.start
-
-    @im.get("123456").should be_nil
-  end
-end

data/spec/zentradi_spec.rb

@@ -1,7 +0,0 @@
-require 'spec_helper'
-
-describe Zentradi do
-  it "works" do
-    true.should be_true
-  end
-end