zeng 0.0.1 → 0.0.2

data/README.md

@@ -0,0 +1,67 @@
+Zeng -- a data mapper tool for nosql database
+==============================================
+
+Main features
+-------------
+
+- **Install**
+
+  sudo gem install zeng
+
+- **Independent Object Storage**
+
+  Through backend_configure to appoint storage location
+
+        class User
+           include Zeng::Document
+           backend_configure :TT,"127.0.0.1:1987"
+        end
+
+- **Customize define persistent properties**
+
+  You can assign persitent properties by **assign** method,and set default value for each property.
+
+        class User
+           include Zeng::Document
+           backend_configure :TT,"127.0.0.1:1987"
+           assign :name, :email, :gender=>'male', :age=>25
+        end
+
+
+Index
+-----
+
+        class User
+          include Zeng::Document
+          backend_configure :TT,"127.0.0.1:1987"
+          assign :name,:email, :gender=>'male', :age=>25
+        end
+
+        @jim = User.create(:name=>"jim", :email=>"jim@nonobo.com")
+        @aaron = User.create(:name=>"aaron", :email=>"aaron@nonobo.com")
+        @jack= User.create(:name=>"jack", :email=>"jack@nonbo.com")
+        @lucy = User.create(:name=>"lucy", :email=>"lucy@nonobo.com")
+
+Using **Zeng::Indexer** module, you can build index for object, just like:
+
+        Zeng::Indexer::map(User=>[:name, :email, :age])
+
+then,
+
+
+        User.indexes << @jim
+        User.indexes << @aaron
+        User.indexes << @lucy
+        User.find_all_by_name("jim")     #=>@jim
+        User.find_all_by_age(25)         #=>@jim, @aaron, @lucy, @jack
+
+Supoort multiple database
+------------------------
+Zeng using adapter to connect database backend, now support **TokyoCabinet**/**TokyoTyrant**。
+
+
+Using in rails
+--------------
+  in environment.rb, you will add
+
+       require 'zeng

data/Rakefile

@@ -1,13 +1,14 @@
+# -*- coding: utf-8 -*-
 require 'rake'
 require 'rake/testtask'
 require 'rake/rdoctask'
 
 task :default=>:test
 
-task :test do 
-	Dir['spec/case/**/*'].each {|test|
-   sh "ruby #{test}" if test =~ /(_test\.rb)$/
-	}
+task :test do
+  Dir['spec/case/**/*'].each {|test|
+    sh "ruby #{test}" if test =~ /(_test\.rb)$/
+  }
 end
 
 desc "start test for given file"
@@ -17,21 +18,22 @@ end
 
 desc "创建gemspec文件"
 task :gemspec do
-	spec = Gem::Specification.new do |s|
-		s.name = %{zeng}
-		s.version = '0.0.1'
-                s.summary = 'A chinese fishing tool'
-		s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  spec = Gem::Specification.new do |s|
+    s.name = %{zeng}
+    s.version = '0.0.2'
+    s.summary = 'Zeng -- a data mapper tool for nosql database'
+    s.homepage = 'https://github.com/baya/zeng'
+    s.description = <<-EOF
+      Zeng(罾) is a fishing tool， it is target to capture data in nosql database。
+    EOF
+    s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+    s.email = ["kayak.jiang@gmail.com"]
+    s.authors = "Guimin Jiang"
+    s.files = Dir["./**/*"].delete_if {|path| path =~ /.gem$/}
+    s.require_paths = ["lib"]
+    s.add_dependency(%q<json>)
+  end
 
-		s.email = ["kayak.jiang@gmail.com"]
-		s.authors = "Guimin Jiang"
-		s.files = Dir["./**/*"].delete_if {|path| path =~ /.gem$/}
-		s.require_paths = ["lib"]
-		s.required_ruby_version = Gem::Requirement.new(">= 1.8.6")
-		s.rubygems_version = %q{1.3.4}
-		s.add_dependency(%q<ffi>)
-	end
-
-	File.open("zeng.gemspec", "w") {|f| f << spec.to_ruby }
+  File.open("zeng.gemspec", "w") {|f| f << spec.to_ruby }
 end
 

data/book.rb

@@ -0,0 +1,23 @@
+require 'rubygems'
+require 'zeng'
+
+class Book
+  include Zeng::Document
+  backend_configure(:TT, '127.0.0.1:1988')
+  assign :name, :price
+end
+
+Zeng::Indexer::map(Book => [:name])
+
+book = Book.create(:name => "ruby book", :price => 12.0)
+Book.indexes << book
+
+book = Book.find(book.id)
+puts book.inspect
+puts book.name
+puts book.price.class
+puts book.price
+
+books = Book.find_all_by_name("ruby book")
+puts books.inspect
+

data/{init.rb → lib/zeng.rb}

@@ -1,4 +1,8 @@
 $:.unshift(File.dirname(__FILE__)) unless
   $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
 
-require 'cutekv'
+require 'rubygems'
+require 'zeng/document'
+require 'zeng/connector'
+require 'zeng/indexer'
+

data/lib/{cute_kv → zeng}/adapters/tokyo_cabinet.rb

@@ -1,15 +1,16 @@
 # -*- coding: utf-8 -*-
 # 访问TokyoCabinet的加载模块
-require 'rufus/tokyo'
-module CuteKV
-  module Adapters
+require 'tokyocabinet'
+module Zeng
+  module Adapter
     module TokyoCabinet
+
       def put(key, value)
-        @db[key] = value
+        @db.put(key, value)
       end
 
       def get(key)
-        @db[key]
+        @db.get(key)
       end
 
       def delete(key)
@@ -26,7 +27,7 @@ module CuteKV
 
       private
       def establish(conf)
-        @db = Rufus::Tokyo::Cabinet.new(conf)
+        @db = HDB::new(conf)
       end
     end
   end

data/lib/zeng/adapters/tokyo_tyrant.rb

@@ -0,0 +1,30 @@
+# -*- coding: utf-8 -*-
+# 访问TokyoTyrant的加载模块
+require 'tokyotyrant'
+require 'zeng/adapters/tokyo_cabinet'
+include TokyoTyrant
+
+module Zeng
+  module Adapter
+    module TokyoTyrant
+      include Adapter::TokyoCabinet
+
+      private
+      def establish(conf)
+        if conf.is_a? Hash
+          @host = conf[:host] || conf["host"]
+          @port = (conf[:port] || conf["port"]).to_i
+        else
+          conf = conf.split(':')
+          @host = conf[0]
+          @port = conf[1].to_i
+        end
+        @db = ::RDB.new
+        if !@db.open(@host, @port)
+          ecode = @db.ecode
+          raise @db.errmsg(ecode)
+        end
+      end
+    end
+  end
+end

data/lib/zeng/connector.rb

@@ -0,0 +1,28 @@
+# -*- coding: utf-8 -*-
+module Zeng
+  class Connector
+    def self.config(adapter)
+      case adapter.to_sym
+      when :TC
+        require 'zeng/adapters/tokyo_cabinet'
+        include Adapter::TokyoCabinet
+      when :TT
+        require 'zeng/adapters/tokyo_tyrant'
+        include Adapter::TokyoTyrant
+      when :LC
+        require 'zeng/adapters/light_cloud'
+        include Adapter::TokyoCloud
+      else
+        raise ConfigError,'没有指定数据库类型！'
+      end
+    end
+
+    def initialize(adapter, conf)
+      @adapter = adapter
+      self.class.config(adapter)
+      establish(conf)
+    end
+
+  end
+
+end

data/lib/{cute_kv → zeng}/document.rb

@@ -4,17 +4,15 @@ require 'uuid'
 require 'json'
 require 'json/add/core'
 
-module CuteKV
-  class CuteKVError < StandardError;end
-  class ObjectNotSaved < CuteKVError; end
+module Zeng
 
-  #  CuteKV's built-in attribute id is the <t>key</t> to access <t>value</t>, and id is formated by uuid.
+  #  Zeng's built-in attribute id is the <t>key</t> to access <t>value</t>, and id is formated by uuid.
   #  ==
-  #  CuteKV provide a Document module to persistence class's attributes, when a class include Document module,
+  #  Zeng provide a Document module to persistence class's attributes, when a class include Document module,
   #  then it can <t>assign</t> attributes needed to persistence.
   #
   #    class User
-  #      include CuteKV::Document
+  #      include Zeng::Document
   #      assign :name,:age=>25,:gender=>"male"
   #    end
   #
@@ -27,7 +25,7 @@ module CuteKV
   #  Every object has a default +id+, if you want to set primary key, you can use <t>primary_key</t> to set up.
   #
   #    class Account < ActiveObject::Base
-  #      include CuteKV::Document
+  #      include Zeng::Document
   #      assign :name,:email,:encrypt_password
   #      primary_key :email
   #    end
@@ -65,11 +63,8 @@ module CuteKV
 
     def self.included(base)
       base.extend ClassMethods
-      # select serializers, exmaple "json", ",marshal", default is "json"
       base.select_serializer(:json)
       base.send :include, InstanceMethods
-      base.send :include, Serialization
-      base.send :include, Timestamp
       add_client(base) unless clients.include?(base)
     end
 
@@ -136,7 +131,7 @@ module CuteKV
       # Assigning attributs needed to persistence
       #  Example:
       #    class User
-      #      include CuteKV::Document
+      #      include Zeng::Document
       #      assign :name, :country=>"China", :gender=>"male"
       #    end
       def assign(*attributes)
@@ -175,7 +170,7 @@ module CuteKV
       end
 
 
-      # Configure CuteKV's Back-end database,now support LightCloud/TokyoTyrant/TokyoCabinet.
+      # Configure Zeng's Back-end database,now support LightCloud/TokyoTyrant/TokyoCabinet.
       #   +adapter+ specify what database to use
       #     :TC => TokyoCabinet (few to use :TC in our practice projects)
       #     :TT => TokyoTyrant

data/lib/{cute_kv → zeng}/indexer.rb

@@ -1,4 +1,4 @@
-module CuteKV
+module Zeng
   module Indexer
     Map = Class.new
     Collection = Class.new(Array)
@@ -12,7 +12,6 @@ module CuteKV
       attr_reader :key, :values
       attr_accessor :index_attrs
 
-
       def initialize(key, value)
         @key = key
         @values = JSON.parse value
@@ -99,4 +98,5 @@ module CuteKV
     end
 
   end
+
 end

data/spec/case/document_test.rb

@@ -3,182 +3,182 @@ ModelDivider.divide "User", "Account"
 
 class DocumentTest < Test::Unit::TestCase
 
-	def setup
-		User.backend_configure(:TT, '127.0.0.1:1985')
-		Account.backend_configure(:TT, :host=>'127.0.0.1', "port"=>1984)
-		User.assign(:name, :age=>25, :gender=>"male")
-		Account.assign(:email, :password, :country=>"China")
-		User.clear
-		Account.clear
-		@jim = User.new(:name=>"jim")
-		@a_jim = Account.new(:email=>"jim@nonobo.com")
-		@attrs_group = [{:name=>"jim"}, {:name=>"jack"}, {:name=>"nancy"}, {:name=>"kame"}]
-	end
-
-	def test_assign_attributes_to_persistence
-		assert User.assign(:name, :age=>25, :gender=>[])
-		assert Account.assign(:email, :password, :country=>{})
-		@jim = User.new(:name=>"jim")
-		assert_equal @jim.name, "jim"
-		assert_equal @jim.age, 25
-		assert_equal @jim.gender, []
-		@jack = User.new(:name=>"jack"){|u| u.gender="female"; u.age=36}
-		assert_equal @jack.name, "jack"
-		assert_equal @jack.age, 36
-		assert_equal @jack.gender, "female"
-		@account_jim = Account.new(:email=>"jim@nonobo.com")
-		assert_equal @account_jim.email, "jim@nonobo.com"
-		assert_equal @account_jim.country, {}
-	end
-
-	def test_set_backend
-		assert User.backend_configure(:TT, '127.0.0.1:1985')
-		assert Account.backend_configure(:TT, :host=>'127.0.0.1', "port"=>1984)
-		assert User.clear
-		assert Account.clear
-	end
-
-	def test_persistence_assigned_attributes_and_id
-		assert @jim.save
-		assert @a_jim.save
-		jim = User.find(@jim.id)
-		a_jim =  Account.find(@a_jim.id)
-		assert_equal jim.id, @jim.id
-		assert_equal jim.name, @jim.name
-		assert_equal jim.gender, @jim.gender
-		jim.age = 30
-		jim.save
-		j = User.find(@jim.id)
-		assert_equal j.id, @jim.id
-		assert_equal j.age, 30
-	end
-
-	def test_create_single_object
-		jack = User.create(:name=>"jack")
-		assert_equal jack.name, "jack"
-		assert_equal jack.gender, "male"
-		assert_equal jack.age, 25
-		jim = User.create(:name=>'jim') {|u| u.age=55; u.gender="female" }
-		assert_equal jim.age, 55
-		assert_equal jim.gender, 'female'
-		jm = User.find(jim.id)
-		assert_equal jm.id, jim.id
-		assert_equal jm.age, 55
-		assert_equal jm.gender, 'female'
-	end
-
-
-	def test_destroy_object
-		jim = User.create(:name=>"jim")
-		a_jim = Account.create(:email=>"jim@nonobo.com")
-		assert_equal jim.name, "jim"
-		assert_equal a_jim.email, "jim@nonobo.com"
-		assert User.destroy(jim)
-		assert_equal User.destroy(a_jim), nil
-		jm = User.find(jim.id)
-		assert jm.nil?
-	end
-
-	def test_update_object
-		jim = User.create(:name=>'jim')
-		assert_equal jim.age, 25
-		assert_equal jim.gender, 'male'
-		jim.update(:age=>52, :gender=>'female')
-		assert_equal jim.age, 52 
-		assert_equal jim.gender, 'female'
-		jm = User.find(jim.id)
-		assert_equal jm.age, 25
-		assert_equal jm.gender, 'male'
-		jim.save
-		jm = User.find(jim.id)
-		assert_equal jm.age, 52
-		assert_equal jm.gender, 'female'
-	end
-
-	def test_reload_object
-		jim = User.new(:name=>'jim')
-		jim_id = jim.id
-		assert jim.name == 'jim'
-		assert jim.age == 25
-		assert jim.reload.nil?
-		jim.save
-		jm = User.find(jim.id)
-		jm.age = 59
-		jm.save
-		assert_equal jim.age, 25
-		assert_equal jm.age, 59
-		assert jim.reload
-		assert_equal jim.age, 59
-		assert_equal jim.id, jim_id
-	end
-
-	def test_class_method_save
-		jim = User.new(:name=>"jim")
-		a_jim = Account.new(:email=>"jim@nonobo.com")
-		assert_equal jim.age, 25
-		assert jim.id
-		assert User.find(jim.id).nil?
-		assert User.save(jim)
-		assert User.find(jim.id)
-		assert User.save("jim").nil?
-		assert User.save(a_jim).nil?
-	end
-
-	def test_class_method_update
-		jim = User.new(:name=>"jim")
-		a_jim = Account.new(:email=>"jim@nonobo.com")
-		assert User.update(jim, :age=>36, :gender=>'female')
-		assert_equal jim.age, 36
-		assert_equal jim.gender, 'female'
-		assert User.update(jim, :age=>45)
-		assert_equal jim.age, 45
-		assert User.update(jim)
-		assert_equal jim.age, 45
-		assert_equal jim.gender, 'female'
-		assert User.update(a_jim).nil?
-	end
-
-	def test_class_reload
-		jim = User.new(:name=>"jim")
-		a_jim = Account.new(:email=>"jim@nonobo.com")
-		assert_equal jim.age, 25
-		assert_equal jim.gender, 'male'
-		jim.update(:age=>58, :gender=>'female')
-		jim.save
-		jim_id = jim.id
-		assert User.reload(jim)
-		assert_equal jim.id, jim_id
-		assert jim.age, 58
-		assert jim.gender, 'female'
-		assert User.reload(a_jim).nil?
-	end
-
-	def test_select_serializers
-		assert User.select_serializer(:json)
-		assert Account.select_serializer(:marshal)
-		assert User.serializer_type=="json"
-		assert Account.serializer_type=="marshal"
-		a_jim = Account.create(:email=>"jim@nonobo.com")
-		a_j = Account.find(a_jim.id)
-		assert_equal a_jim.email, "jim@nonobo.com"
-		assert_equal a_j.email, "jim@nonobo.com"
-		assert Account.select_serializer(:marshal)
-		assert Account.serializer_type=="marshal"
-		a_jack = Account.create(:email=>"jack@nonobo.com")
-		a_jk = Account.find(a_jack.id)
-		assert_equal a_jk.email, "jack@nonobo.com"
-		assert_equal a_jk.id, a_jack.id
-	end
-
-	def test_backend_configurations
-		assert User.backend_configure(:TT, '127.0.0.1:1984')
-		assert Account.backend_configure(:TT, '127.0.0.1:1985')
+  def setup
+    User.backend_configure(:TT, '127.0.0.1:1985')
+    Account.backend_configure(:TT, :host=>'127.0.0.1', "port"=>1984)
+    User.assign(:name, :age=>25, :gender=>"male")
+    Account.assign(:email, :password, :country=>"China")
+    User.clear
+    Account.clear
+    @jim = User.new(:name=>"jim")
+    @a_jim = Account.new(:email=>"jim@nonobo.com")
+    @attrs_group = [{:name=>"jim"}, {:name=>"jack"}, {:name=>"nancy"}, {:name=>"kame"}]
+  end
+
+  def test_assign_attributes_to_persistence
+    assert User.assign(:name, :age=>25, :gender=>[])
+    assert Account.assign(:email, :password, :country=>{})
+    @jim = User.new(:name=>"jim")
+    assert_equal @jim.name, "jim"
+    assert_equal @jim.age, 25
+    assert_equal @jim.gender, []
+    @jack = User.new(:name=>"jack"){|u| u.gender="female"; u.age=36}
+    assert_equal @jack.name, "jack"
+    assert_equal @jack.age, 36
+    assert_equal @jack.gender, "female"
+    @account_jim = Account.new(:email=>"jim@nonobo.com")
+    assert_equal @account_jim.email, "jim@nonobo.com"
+    assert_equal @account_jim.country, {}
+  end
+
+  def test_set_backend
+    assert User.backend_configure(:TT, '127.0.0.1:1985')
+    assert Account.backend_configure(:TT, :host=>'127.0.0.1', "port"=>1984)
+    assert User.clear
+    assert Account.clear
+  end
+
+  def test_persistence_assigned_attributes_and_id
+    assert @jim.save
+    assert @a_jim.save
+    jim = User.find(@jim.id)
+    a_jim =  Account.find(@a_jim.id)
+    assert_equal jim.id, @jim.id
+    assert_equal jim.name, @jim.name
+    assert_equal jim.gender, @jim.gender
+    jim.age = 30
+    jim.save
+    j = User.find(@jim.id)
+    assert_equal j.id, @jim.id
+    assert_equal j.age, 30
+  end
+
+  def test_create_single_object
+    jack = User.create(:name=>"jack")
+    assert_equal jack.name, "jack"
+    assert_equal jack.gender, "male"
+    assert_equal jack.age, 25
+    jim = User.create(:name=>'jim') {|u| u.age=55; u.gender="female" }
+    assert_equal jim.age, 55
+    assert_equal jim.gender, 'female'
+    jm = User.find(jim.id)
+    assert_equal jm.id, jim.id
+    assert_equal jm.age, 55
+    assert_equal jm.gender, 'female'
+  end
+
+
+  def test_destroy_object
+    jim = User.create(:name=>"jim")
+    a_jim = Account.create(:email=>"jim@nonobo.com")
+    assert_equal jim.name, "jim"
+    assert_equal a_jim.email, "jim@nonobo.com"
+    assert User.destroy(jim)
+    assert_equal User.destroy(a_jim), nil
+    jm = User.find(jim.id)
+    assert jm.nil?
+  end
+
+  def test_update_object
+    jim = User.create(:name=>'jim')
+    assert_equal jim.age, 25
+    assert_equal jim.gender, 'male'
+    jim.update(:age=>52, :gender=>'female')
+    assert_equal jim.age, 52
+    assert_equal jim.gender, 'female'
+    jm = User.find(jim.id)
+    assert_equal jm.age, 25
+    assert_equal jm.gender, 'male'
+    jim.save
+    jm = User.find(jim.id)
+    assert_equal jm.age, 52
+    assert_equal jm.gender, 'female'
+  end
+
+  def test_reload_object
+    jim = User.new(:name=>'jim')
+    jim_id = jim.id
+    assert jim.name == 'jim'
+    assert jim.age == 25
+    assert jim.reload.nil?
+    jim.save
+    jm = User.find(jim.id)
+    jm.age = 59
+    jm.save
+    assert_equal jim.age, 25
+    assert_equal jm.age, 59
+    assert jim.reload
+    assert_equal jim.age, 59
+    assert_equal jim.id, jim_id
+  end
+
+  def test_class_method_save
+    jim = User.new(:name=>"jim")
+    a_jim = Account.new(:email=>"jim@nonobo.com")
+    assert_equal jim.age, 25
+    assert jim.id
+    assert User.find(jim.id).nil?
+    assert User.save(jim)
+    assert User.find(jim.id)
+    assert User.save("jim").nil?
+    assert User.save(a_jim).nil?
+  end
+
+  def test_class_method_update
+    jim = User.new(:name=>"jim")
+    a_jim = Account.new(:email=>"jim@nonobo.com")
+    assert User.update(jim, :age=>36, :gender=>'female')
+    assert_equal jim.age, 36
+    assert_equal jim.gender, 'female'
+    assert User.update(jim, :age=>45)
+    assert_equal jim.age, 45
+    assert User.update(jim)
+    assert_equal jim.age, 45
+    assert_equal jim.gender, 'female'
+    assert User.update(a_jim).nil?
+  end
+
+  def test_class_reload
+    jim = User.new(:name=>"jim")
+    a_jim = Account.new(:email=>"jim@nonobo.com")
+    assert_equal jim.age, 25
+    assert_equal jim.gender, 'male'
+    jim.update(:age=>58, :gender=>'female')
+    jim.save
+    jim_id = jim.id
+    assert User.reload(jim)
+    assert_equal jim.id, jim_id
+    assert jim.age, 58
+    assert jim.gender, 'female'
+    assert User.reload(a_jim).nil?
+  end
+
+  def test_select_serializers
+    assert User.select_serializer(:json)
+    assert Account.select_serializer(:marshal)
+    assert User.serializer_type=="json"
+    assert Account.serializer_type=="marshal"
+    a_jim = Account.create(:email=>"jim@nonobo.com")
+    a_j = Account.find(a_jim.id)
+    assert_equal a_jim.email, "jim@nonobo.com"
+    assert_equal a_j.email, "jim@nonobo.com"
+    assert Account.select_serializer(:marshal)
+    assert Account.serializer_type=="marshal"
+    a_jack = Account.create(:email=>"jack@nonobo.com")
+    a_jk = Account.find(a_jack.id)
+    assert_equal a_jk.email, "jack@nonobo.com"
+    assert_equal a_jk.id, a_jack.id
+  end
+
+  def test_backend_configurations
+    assert User.backend_configure(:TT, '127.0.0.1:1984')
+    assert Account.backend_configure(:TT, '127.0.0.1:1985')
     assert_equal User.backend_configurations, {:adapter=>:TT, :host=>'127.0.0.1', :port=>1984}
     assert_equal Account.backend_configurations, {:adapter=>:TT, :host=>'127.0.0.1', :port=>1985}
-	end
+  end
 
-	def test_fresh_object
-		lili = User.new(:name=>'lili')
-	end
+  def test_fresh_object
+    lili = User.new(:name=>'lili')
+  end
 
 end