mongous 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de69281ec1896f88f5b8d5c7c30654a12559cf3a7c97ea7d58cd2fde6e8579fd
-  data.tar.gz: 8db5720698450a5f9fcbf912fab5611d800588e02bfea09141c9bf23a1c0a088
+  metadata.gz: 26e437e93bf76ff87a088329b744df4f1425d7b14c106d80edb46f12bbfde12f
+  data.tar.gz: 4e6bb7dd48f0799ce33165629c658b174316fd9d271f4f51ae866b804607ae59
 SHA512:
-  metadata.gz: 90d5962f8140f085afc07e9b9c9380a6c38aca825dd977d5ee6a1e8d1042ad39514a6185eb9fed38f9a370e794dea2b8c99b5d99adb661dfc0e9306806084bdd
-  data.tar.gz: 9c22f0d55962fce5fead46e9d4e0c27d89fb4b87ca268cef9c123c8737d9b5ae8987748d158a3b39d3acf1c21175729005ebce917fdc0d9118c2fc1dd19623d1
+  metadata.gz: 392818352168bf2c196c90693559f421e35fe6ed15bdaa013a9a3f651a5dbda66f2eb0f4ed38c25e28c5d77c1c7d5122d8384c8de56bb701b896ffe2133b3ef0
+  data.tar.gz: 401266df4545a41f3b8d5e090f986dc2cd8215b48d153da195b8c276316a3e9ebed07b8a24e5dd677cc469d9676415a30ffb844f29211064c3d1fefa4c6badd5

data/README.adoc

@@ -30,7 +30,7 @@ Or install it yourself as:
 
 == Usage
 
-=== Simple description
+=== Simple declaration
 
 [source,ruby]
 ----
@@ -60,9 +60,12 @@ class Book
   field  :style,      String,  ["A4","B5","A5","B6"]
   field  :price,      Integer, (0..1_000_000)
   field  :page,       Integer, proc{ page % 4 == 0 }
-  field  :publish_at, Date,    &proc{ Date.today }
   field  :isbn,       String,  proc{ isbn? }
-  field  :lang,       String,  &proc{ "ja" }
+  field  :lang,       String,  default: "en"
+  field  :created_at, Time,    create: proc{ Time.now }
+  field  :updated_at, Time,    update: proc{ Time.now }
+
+  filter :foobar,     {title: /foobar/}
 
   verify :strict
   verify do
@@ -91,38 +94,57 @@ book = Book.new( title: "title 2", price: 2000, style: "A5" )
 book.save
 
 doc = { title: "title 3", price: 3000, style: "A6" }
-Book.create( doc )
+Book.create( **doc )
 ----
 
 === Search document
 
 [source,ruby]
 ----
-books = Book.all
-pp books
+pp books = Book.all
 
-book = Book.filter( title: "title 1" ).first
-p book
+p book = Book.where( title: "title 1" ).first
 
-books = Book.filter( title: /title/ ).all
+books = Book.where( title: /title/ ).all
 books.each do |book|
   p book
 end
 
-Book.filter( title: /title/ ).projection( _id: 0 ).each do |book|
+Book.where( title: /title/ ).projection( _id: 0 ).each do |book|
   p book
 end
 
-Book.filter( price: (1..2000), style: ["A4","A5"] ).each do |book|
+Book.where( price: (1..2000), style: ["A4","A5"] ).each do |book|
+  p book
+end
+
+filter1 = Book.where( title: /title/ )
+filter2 = Book.where( :foobar )
+filter3 = Book.where( price: (1..2000) )
+filter4 = Book.where( style: ["A4","A5"] )
+
+Book.not( filter1 ).each do |book|
   p book
 end
+Book.and( filter1, filter3 ).each do |book|
+  p book
+end
+Book.or( filter2, filter4 ).each do |book|
+  p book
+end
+
+Book.find( { title: /title/ }, { projection: {_id: 0} } ).each do |book|
+  p book
+end
+
+pp Book.where( title: /title/ )[0, 5].all
 ----
 
 === Update document
 
 [source,ruby]
 ----
-book = Book.filter( title: "title 1" ).first
+book = Book.where( title: "title 1" ).first
 book.title = "title 1 [update]"
 book.save
 ----
@@ -131,7 +153,7 @@ book.save
 
 [source,ruby]
 ----
-book = Book.filter( title: "title 1" ).first
+book = Book.where( title: "title 1" ).first
 book.delete
 ----
 
@@ -141,7 +163,7 @@ book.delete
 
 [source,ruby]
 ----
-Mongous.connect!( hosts_or_uri = nil, **opts )
+Mongous.connect!( hosts_or_uri = nil, **options )
 ----
 
 * Result:
@@ -149,21 +171,21 @@ Mongous.connect!( hosts_or_uri = nil, **opts )
 
 * Parameter:
   ** hosts_or_uri:    Array of hosts, or URI (default: ["localhost:21017"])
-  ** opts:            Options.
+  ** options:         Options.
     *** file:         Path to database configuration file.
     *** mode:         Execution mode. (default: "development")
     *** database:     Database name. (default: "test")
-    *** *             Other optional arguments for Mongo::Client.new.
+    ***               Other optional arguments for Mongo::Client.new.
 
 === Connect database.
 
 [source,ruby]
 ----
-Mongous.connect( hosts_or_uri = nil, **opts )
+Mongous.connect( hosts_or_uri = nil, **options )
 ----
 
 * Result:
-  ** Mongo::Client.
+  ** Mongo::Client instance.
 
 === Include document functions.
 
@@ -172,33 +194,62 @@ Mongous.connect( hosts_or_uri = nil, **opts )
 include Mongous::Document
 ----
 
+=== Bind another database.
+
+[source,ruby]
+----
+self.client=( _client )
+----
+
+* Result:
+  ** Mongo::Client instance.
+
+* Parameter:
+  ** client:          Mongo::Client instance.
+
+=== Bind another collection.
+
+[source,ruby]
+----
+self.collection_name=( _collection_name )
+----
+
+* Result:
+  ** Collection name string.
+
+* Parameter:
+  ** collection_name: Collection name.
+
 === Declare document structure.
 
 [source,ruby]
 ----
-field( label, *attrs, &block )
+field( symbol, *attrs, **items )
 ----
 
 * Parameter:
-  ** label:           Field label symbol.
+  ** symbol:          Field name.
   ** attrs:           Field attributes.
     *** Class:        Class for field verification.
     *** Proc:         Proc for field verification.
     *** Range:        Range for field verification.
     *** Array:        Array for field verification.
-    *** Symbol:       Special delectives.
+    *** Symbol:       Special directive symbol.
       **** must:      Not nil nor empty.
-  ** block:           Returning default value.
+  ** items:           Operation when saving.
+    *** default:      Value or proc when undefined.
+    *** create:       Value or proc when saving a new document.
+    *** update:       Value or proc when saving update document.
 
 === Verify before save or assignment action.
 
 [source,ruby]
 ----
-verify( *syms, &block )
+verify( *directives, &block )
 ----
 
 * Parameter:
-  ** syms:            Conditional symbols.
+  ** directives:      Special directive symbol.
     *** strict:       Verify that it is a defined item name.
   ** block:           Describe the content that verifies each item value and returns the truth.
 
@@ -206,12 +257,12 @@ verify( *syms, &block )
 
 [source,ruby]
 ----
-index( *syms, **opts )
+index( *symbols, **options )
 ----
 
 * Parameter:
-  ** syms:            Field label symbols.
-  ** opts:            Options for Mongo::Collection#indexes().
+  ** symbols:         Field names.
+  ** options:         Options for Mongo::Collection#indexes().
 
 === Verify field value is not nil nor empty.
 
@@ -226,6 +277,70 @@ having?( label )
 * Parameter:
   ** label:           Field label for method call.
 
+=== Name the search condition.
+
+[source,ruby]
+----
+filter( symbol, filter_or_cond )
+----
+
+* Parameter:
+  ** symbol:          Filter name.
+  ** filter_or_cond:  Filter or search criteria.
+
+=== Search condition.
+
+[source,ruby]
+----
+where( filter = nil, **conditions )
+----
+
+* Result:
+  ** Filter instance.
+
+* Parameter:
+  ** filter:          Filter name symbol, or filter instance.
+  ** conditions:      Search criteria.
+
+=== NOT search condition.
+
+[source,ruby]
+----
+not( filter = nil, **conditions )
+----
+
+* Result:
+  ** Filter instance.
+
+* Parameter:
+  ** filter:          Filter name symbol, or filter instance.
+  ** conditions:      Search criteria.
+
+=== AND search condition.
+
+[source,ruby]
+----
+and( *filters )
+----
+
+* Result:
+  ** Filter instance.
+
+* Parameter:
+  ** filters:         Filter name symbol, or filter instance.
+
+=== OR search condition.
+
+[source,ruby]
+----
+or( *filters )
+----
+
+* Result:
+  ** Filter instance.
+
+* Parameter:
+  ** filters:         Field name symbol, or filter instance.
 
 == Contributing
 

data/README.ja.adoc

@@ -60,9 +60,12 @@ class Book
   field  :style,      String,  ["A4","B5","A5","B6"]
   field  :price,      Integer, (0..1_000_000)
   field  :page,       Integer, proc{ page % 4 == 0 }
-  field  :publish_at, Date,    &proc{ Date.today }
   field  :isbn,       String,  proc{ isbn? }
-  field  :lang,       String,  &proc{ "ja" }
+  field  :lang,       String,  default: "en"
+  field  :created_at, Time,    create: proc{ Time.now }
+  field  :updated_at, Time,    update: proc{ Time.now }
+
+  filter :foobar,     {title: /foobar/}
 
   verify :strict
   verify do
@@ -91,38 +94,57 @@ book = Book.new( title: "title 2", price: 2000, style: "A5" )
 book.save
 
 doc = { title: "title 3", price: 3000, style: "A6" }
-Book.create( doc )
+Book.create( **doc )
 ----
 
 === ドキュメント検索
 
 [source,ruby]
 ----
-books = Book.all
-pp books
+pp books = Book.all
 
-book = Book.filter( title: "title 1" ).first
-p book
+p book = Book.where( title: "title 1" ).first
 
-books = Book.filter( title: /title/ ).all
+books = Book.where( title: /title/ ).all
 books.each do |book|
   p book
 end
 
-Book.filter( title: /title/ ).projection( _id: 0 ).each do |book|
+Book.where( title: /title/ ).projection( _id: 0 ).each do |book|
   p book
 end
 
-Book.filter( price: (1..2000), style: ["A4","A5"] ).each do |book|
+Book.where( price: (1..2000), style: ["A4","A5"] ).each do |book|
+  p book
+end
+
+filter1 = Book.where( title: /title/ )
+filter2 = Book.where( :foobar )
+filter3 = Book.where( price: (1..2000) )
+filter4 = Book.where( style: ["A4","A5"] )
+
+Book.not( filter1 ).each do |book|
   p book
 end
+Book.and( filter1, filter3 ).each do |book|
+  p book
+end
+Book.or( filter2, filter4 ).each do |book|
+  p book
+end
+
+Book.find( { title: /title/ }, { projection: {_id: 0} } ).each do |book|
+  p book
+end
+
+pp Book.where( title: /title/ )[0, 5].all
 ----
 
 === ドキュメント更新
 
 [source,ruby]
 ----
-book = Book.filter( title: "title 1" ).first
+book = Book.where( title: "title 1" ).first
 book.title = "title 1 [update]"
 book.save
 ----
@@ -131,7 +153,7 @@ book.save
 
 [source,ruby]
 ----
-book = Book.filter( title: "title 1" ).first
+book = Book.where( title: "title 1" ).first
 book.delete
 ----
 
@@ -141,7 +163,7 @@ book.delete
 
 [source,ruby]
 ----
-Mongous.connect!( hosts_or_uri = nil, **opts )
+Mongous.connect!( hosts_or_uri = nil, **options )
 ----
 
 * Result:
@@ -149,21 +171,21 @@ Mongous.connect!( hosts_or_uri = nil, **opts )
 
 * Parameter:
   ** hosts_or_uri:    ホスト配列または URI (default: ["localhost:21017"])
-  ** opts:            オプション
+  ** options:         オプション
     *** file:         データベース構成定義ファイルへのパス
     *** mode:         実行モード (default: "development")
     *** database:     データベース名 (default: "test")
-    *** *             Mongo::Client.new のその他オプション引数
+    ***               Mongo::Client.new のその他オプション引数
 
 === データベースに接続する
 
 [source,ruby]
 ----
-Mongous.connect( hosts_or_uri = nil, **opts )
+Mongous.connect( hosts_or_uri = nil, **options )
 ----
 
 * Result:
-  ** Mongo::Client.
+  ** Mongo::Client インスタンス.
 
 === ドキュメントの機能を取り入れる.
 
@@ -172,15 +194,41 @@ Mongous.connect( hosts_or_uri = nil, **opts )
 include Mongous::Document
 ----
 
+=== 別のデータベースを割り当てる.
+
+[source,ruby]
+----
+self.client=( client )
+----
+
+* Result:
+  ** Mongo::Client インスタンス.
+
+* Parameter:
+  ** client:          Mongo::Client インスタンス.
+
+=== 別のコレクションを割り当てる.
+
+[source,ruby]
+----
+self.collection_name=( collection_name )
+----
+
+* Result:
+  ** Collection name 文字列.
+
+* Parameter:
+  ** collection_name: コレクション名.
+
 === ドキュメントの要素を定義する.
 
 [source,ruby]
 ----
-field( label, *attrs, &block )
+field( symbol, *attrs, **items )
 ----
 
 * Parameter:
-  ** label:           項目名シンボル
+  ** symbol:          項目名
   ** attrs:           項目属性
     *** Class:        項目検証用 Class
     *** Proc:         項目検証用 Proc
@@ -188,17 +236,20 @@ field( label, *attrs, &block )
     *** Array:        項目検証用配列
     *** Symbol:       特別な指示子
       **** must:      ナル値でも空文字列でもない
-  ** block:           デフォルト値を返す
+  ** items:           保存時の操作.
+    *** default:      未定義のときの値または Proc.
+    *** create:       ドキュメントを新規保存するときの値または Proc.
+    *** update:       ドキュメントを更新するときの値または Proc.
 
 === 保存や代入の前にドキュメントの要素を検証する.
 
 [source,ruby]
 ----
-verify( *syms, &block )
+verify( *directives, &block )
 ----
 
 * Parameter:
-  ** syms:            条件シンボル
+  ** directives:      条件シンボル
     *** strict:       定義済み項目名であることを検証する.
   ** block:           各項目値を検証して真偽を返す内容を記述する.
 
@@ -206,12 +257,12 @@ verify( *syms, &block )
 
 [source,ruby]
 ----
-index( *syms, **opts )
+index( *symbols, **options )
 ----
 
 * Parameter:
-  ** syms:            項目名シンボル
-  ** opts:            Mongo::Collection#indexes() のオプション.
+  ** symbols:         項目名
+  ** options:         Mongo::Collection#indexes() のオプション.
 
 === 項目値がナル値でも空文字列でもないことを検証する.
 
@@ -226,6 +277,70 @@ having?( label )
 * Parameter:
   ** label:           メソッド呼び出しする項目名.
 
+=== 検索条件に名前をつける.
+
+[source,ruby]
+----
+filter( symbol, filter_or_cond )
+----
+
+* Parameter:
+  ** symbol:          項目名
+  ** filter_or_cond:  フィルタまたは検索条件
+
+=== 検索条件.
+
+[source,ruby]
+----
+where( filter = nil, **conditions )
+----
+
+* Result:
+  ** Filter instance.
+
+* Parameter:
+  ** filter:          項目名またはフィルタインスタンス
+  ** conditions:      検索条件
+
+=== 否定検索条件.
+
+[source,ruby]
+----
+not( filter = nil, **conditions )
+----
+
+* Result:
+  ** Filter instance.
+
+* Parameter:
+  ** filter:          項目名またはフィルタインスタンス
+  ** conditions:      検索条件
+
+=== 論理積検索条件.
+
+[source,ruby]
+----
+and( *filters )
+----
+
+* Result:
+  ** Filter instance.
+
+* Parameter:
+  ** filters:         項目名またはフィルタインスタンス
+
+=== 論理和検索条件.
+
+[source,ruby]
+----
+or( *filters )
+----
+
+* Result:
+  ** Filter instance.
+
+* Parameter:
+  ** filters:         項目名またはフィルタインスタンス
 
 == 貢献