mongo-hashie 0.1.0 → 0.1.1

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 Oliver Kiessler
+Copyright (c) 2009/2010 Oliver Kiessler
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -1,6 +1,52 @@
 = mongo-hashie
 
-Description goes here.
+mongo-hashie is a mongodb library that aims to be simple and effective. No need to explicitly define properties. Getters and setters are created through the underlying Mash class from hashie.
+
+== Install
+
+ $ gem install mongo-hashie
+
+== Usage
+
+class Document < MongoHashie::Base
+end
+
+Simply add new properties by calling the setter.
+
+Basic CRUD operations
+
+ $ document = Document.new(:author => "Oliver Kiessler")
+ $ document.name = "test attribute"
+ $ document.save # create
+ $ puts document._id # Mongo ObjectID String represenation
+
+ $ document.name = "simple change"
+ $ document.save # update
+
+ $ document.destroy
+
+ $ document2 = Document.create(:author => "Oliver Kiessler", :name => "Great Document Name")
+
+ $ Document.destroy_all
+
+Find operations
+
+ $ Document.first
+ $ Document.find("4b3f4bd4c1d7110513000001") # Mongo ObjectID String represenation
+
+ $ Document.all
+ $ Document.all(:author => "Oliver Kiessler")
+ $ Document.find(:author => "Oliver Kiessler", :name => "Great Document Name")
+
+ $ Document.count
+
+Meta Data
+
+ $ document1 = Document.create(:author => "Oliver Kiessler", :name => "Great Document Name", :prop1 => "Test")
+ $ document2 = Document.create(:author => "Oliver Kiessler", :name => "Great Document Name", :prop2 => "Test")
+ $ document3 = Document.create(:author => "Oliver Kiessler", :name => "Great Document Name", :prop3 => "Test")
+
+ $ puts Document.properties_used.inspect
 
 == Note on Patches/Pull Requests
  
@@ -14,4 +60,4 @@ Description goes here.
 
 == Copyright
 
-Copyright (c) 2009 Oliver Kiessler. See LICENSE for details.
+Copyright (c) 2009/2010 Oliver Kiessler. See LICENSE for details.

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/lib/mongo-hashie/base.rb

@@ -2,8 +2,11 @@ module MongoHashie
   def self.included(base)
     base.class_eval do
       extend ClassMethods
-      include InstanceMethods
+      extend Rails
+      extend MetaData::ClassMethods
       include Mongo
+      include InstanceMethods
+      include MetaData::InstanceMethods
     end
   end
 
@@ -13,12 +16,13 @@ module MongoHashie
     end
 
     def save
-      if self._id.blank?
+      if self._id.nil?
         self._id = Mongo::ObjectID.new
         collection.insert(self)
       else
         collection.update({'_id' => self._id}, self)
       end
+      update_keys if MongoHashie::Configuration.create_meta_data and not self.is_a?(MetaDataProperties)
       self
     end
 
@@ -28,46 +32,50 @@ module MongoHashie
   end
 
   module ClassMethods
-    def database
-      @@database ||= "mongohashie"
-    end
-    def database=(value); @@database = value; end
-
     def connection
-      Mongo::Connection.new("localhost", 27017, :pool_size => 5, :timeout => 5)
+      Mongo::Connection.new(MongoHashie::Configuration.host, MongoHashie::Configuration.port,
+        :pool_size => MongoHashie::Configuration.pool_size, :timeout => MongoHashie::Configuration.timeout)
     end
 
-    def db; @@db ||= connection.db(database); end
-    def create(hash = {}); self.new(hash).save; end
+    def db; @@db ||= connection.db(MongoHashie::Configuration.database); end
+  end
+end
 
-    def all(options = {})
-      self.new.collection.find.collect {|doc| self.new(doc)}
-    end
+class MongoHashie::Base < Hashie::Mash
+  include MongoHashie
+end
 
-    def first(options = {})
-      self.new(self.new.collection.find_one)
-    end
+class MongoHashie::MetaDataProperties < MongoHashie::Base
+end
 
-    def find(*args)
-      if args.first.is_a?(Hash)
-        result = self.new.collection.find(args.first)
-      else
-        result = self.new.collection.find('_id' => Mongo::ObjectID.from_string(args.first))
-      end
-      result.count == 1 ? result.collect {|doc| self.new(doc)}.first : result.collect {|doc| self.new(doc)}
-    end
+class MongoHashie::Configuration
+  def self.database
+    @@database ||= 'mongohashie'
+  end
+  def self.database=(value); @@database = value; end
 
-    def count
-      self.new.collection.count
-    end
+  def self.host
+    @@host ||= 'localhost'
+  end
+  def self.host=(value); @@host = value; end
 
-    def destroy_all
-      self.new.collection.remove
-    end
+  def self.port
+    @@port ||= 27017
   end
-end
+  def self.port=(value); @@port = value; end
 
-class MongoHashie::Base < Hashie::Mash
-  include MongoHashie
-end
+  def self.pool_size
+    @@pool_size ||= 5
+  end
+  def self.pool_size=(value); @@pool_size = value; end
 
+  def self.timeout
+    @@timeout ||= 5
+  end
+  def self.timeout=(value); @@timeout = value; end
+
+  def self.create_meta_data
+    @@create_meta_data ||= true
+  end
+  def self.create_meta_data=(value); @@create_meta_data = value; end
+end

data/lib/mongo-hashie/meta_data.rb

@@ -0,0 +1,48 @@
+module MongoHashie
+  module MetaData
+    module InstanceMethods
+      def update_keys
+        meta_data_wrapper = MetaDataProperties.first(:class_name => self.class.name)
+        if meta_data_wrapper
+          updated = false
+          keys.each do |key|
+            if not MetaDataProperties.ignored_keys.include?(key) and not meta_data_wrapper.key?(key)
+              meta_data_wrapper.send("#{key.to_sym}=", self.send(key.to_sym).class.name)
+              updated = true
+            end
+            meta_data_wrapper.save if updated
+          end
+        else
+          properties_used = {:class_name => self.class.name}
+          keys.each do |key|
+            properties_used[key] = self.send(key.to_sym).class.name unless MetaDataProperties.ignored_keys.include?(key)
+          end
+          MetaDataProperties.create(properties_used)
+        end
+      end
+
+      def reset_keys
+        meta_data_wrapper = MetaDataProperties.first(:class_name => self.class.name)
+        meta_data_wrapper.destroy if meta_data_wrapper
+      end
+    end
+
+    module ClassMethods
+      def properties_used
+        meta_data_properties = MetaDataProperties.first(:class_name => name)
+        meta_data_properties_pairs = {}
+        if meta_data_properties
+          properties = meta_data_properties.keys.select {|k| k unless ignored_keys.include?(k)}
+          properties.each do |key|
+            meta_data_properties_pairs[key] = meta_data_properties.send(key.to_sym)
+          end
+        end
+        meta_data_properties_pairs
+      end
+      
+      def ignored_keys
+        ['_id', 'class_name']
+      end
+    end
+  end
+end

data/lib/mongo-hashie/rails.rb

@@ -0,0 +1,33 @@
+module MongoHashie
+  module Rails
+    def create(hash = {}); self.new(hash).save; end
+
+    def all(options = {})
+      self.new.collection.find.collect {|doc| self.new(doc)}
+    end
+
+    def first(options = {})
+      result = self.new.collection.find_one(options)
+      self.new(result) if result
+    end
+
+    def find(*args)
+      if args.first.is_a?(Hash)
+        result = self.new.collection.find(args.first)
+      else
+        result = self.new.collection.find('_id' => Mongo::ObjectID.from_string(args.first))
+      end
+      result.count == 1 ? result.collect {|doc| self.new(doc)}.first : result.collect {|doc| self.new(doc)}
+    end
+
+    def count
+      self.new.collection.count
+    end
+
+    def destroy_all
+      target = self.new
+      target.collection.remove
+      target.reset_keys
+    end
+  end
+end

data/lib/mongo-hashie.rb

@@ -1,4 +1,6 @@
 require "mongo"
 require "hashie"
+require 'mongo-hashie/rails'
+require 'mongo-hashie/meta_data'
+require 'mongo-hashie/meta_data'
 require 'mongo-hashie/base'
-

data/mongo-hashie.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{mongo-hashie}
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Oliver Kiessler"]
-  s.date = %q{2009-12-12}
+  s.date = %q{2010-01-02}
   s.description = %q{Simple MongoDB Object Wrapper based on Hashie}
   s.email = %q{kiessler@inceedo.com}
   s.extra_rdoc_files = [
@@ -25,6 +25,8 @@ Gem::Specification.new do |s|
      "VERSION",
      "lib/mongo-hashie.rb",
      "lib/mongo-hashie/base.rb",
+     "lib/mongo-hashie/meta_data.rb",
+     "lib/mongo-hashie/rails.rb",
      "mongo-hashie.gemspec",
      "test/helper.rb",
      "test/test_mongo-hashie.rb"

data/test/helper.rb

@@ -8,3 +8,5 @@ require 'mongo-hashie'
 
 class Test::Unit::TestCase
 end
+
+MongoHashie::Configuration.database = 'mongo-hashie-testdb'

data/test/test_mongo-hashie.rb

@@ -1,9 +1,76 @@
 require 'helper'
 
+class BlogPost < MongoHashie::Base
+end
+
 class TestMongoHashie < Test::Unit::TestCase
-  should "test" do
-    # TODO
-    assert true
+  def setup
+    BlogPost.destroy_all; MongoHashie::MetaDataProperties.destroy_all
+    @blog_post_hash = {:title => 'Test Title', :text => 'Bodytext', :author => 'Oliver Kiessler', :views => 1,
+      :tags => ['test1', 'test2', 'test3']}
   end
-end
+  
+  context "basic operations" do
+    should "have a connection and database set" do
+      assert_equal MongoHashie::Configuration.database, 'mongo-hashie-testdb'
+      assert_not_nil BlogPost.connection
+      assert_not_nil BlogPost.db
+    end
+
+    should "create a new object" do
+      blog_post = BlogPost.new(@blog_post_hash)
+      assert_equal BlogPost.count, 0
+      blog_post.save
+      assert_not_nil blog_post._id
+      assert_equal BlogPost.count, 1
+    end
+
+    should "destroy object" do
+      blog_post = BlogPost.new(@blog_post_hash)
+      blog_post.save
+      assert_equal BlogPost.count, 1
+      blog_post.destroy
+      assert_equal BlogPost.count, 0
+    end
 
+    should "create object by passing a hash" do
+      assert_equal BlogPost.count, 0
+      blog_post = BlogPost.create(@blog_post_hash)
+      assert_equal BlogPost.count, 1
+    end
+  end
+  
+  context "meta data" do
+    should "have meta data properties" do
+      assert_equal BlogPost.count, 0
+      assert_equal MongoHashie::MetaDataProperties.count, 0
+      blog_post = BlogPost.create(@blog_post_hash)
+      assert_equal BlogPost.count, 1
+      assert_equal MongoHashie::MetaDataProperties.count, 1
+    end
+
+    should "include all keys in the meta data properties" do
+      blog_post = BlogPost.create(@blog_post_hash)
+      assert_equal BlogPost.properties_used.keys.size, 5
+      assert BlogPost.properties_used.keys.include?('title')
+      assert BlogPost.properties_used.keys.include?('text')
+      assert BlogPost.properties_used.keys.include?('author')
+      assert BlogPost.properties_used.keys.include?('views')
+      assert BlogPost.properties_used.keys.include?('tags')
+    end
+    
+    should "update keys in the meta data properties" do
+      BlogPost.create(@blog_post_hash)
+      assert_equal BlogPost.properties_used.keys.size, 5
+      BlogPost.create(@blog_post_hash.merge(:likes => 2))
+      assert_equal BlogPost.properties_used.keys.size, 6
+    end
+    
+    should "reset keys in the meta data properties when destroy_all is called" do
+      2.times {BlogPost.create(@blog_post_hash)}
+      assert_not_nil MongoHashie::MetaDataProperties.first(:class_name => 'BlogPost')
+      BlogPost.destroy_all
+      assert_nil MongoHashie::MetaDataProperties.first(:class_name => 'BlogPost')
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mongo-hashie
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Oliver Kiessler
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-12 00:00:00 +01:00
+date: 2010-01-02 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -60,6 +60,8 @@ files:
 - VERSION
 - lib/mongo-hashie.rb
 - lib/mongo-hashie/base.rb
+- lib/mongo-hashie/meta_data.rb
+- lib/mongo-hashie/rails.rb
 - mongo-hashie.gemspec
 - test/helper.rb
 - test/test_mongo-hashie.rb