mongous 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e316aaf87661c4fe27054cdbaef39ba7f21f24432b3752ffb1cb308894de5272
-  data.tar.gz: 5597f0a55efc8d1afa45e6bf9ee93ea77653d7161d12e776bc979a6543b2c94a
+  metadata.gz: bf1d2cbfd528ed1a623833025cf965b5200a1f973ce1200609ae459e6167694f
+  data.tar.gz: 785aea052055755ec01bab88f47da0915371546d9c84f14a7876f968c79a5e3d
 SHA512:
-  metadata.gz: 4dc7ea514d20c8fc9ed8eaed86b4feb293df3e713a1db3acb60eb46abd61f28f0dbeeb9a68b9ac1442b6b690b3e4b12653bce102d007d912e6c08a700bd964ef
-  data.tar.gz: 44cfdfa61226dbfcaa40d846bfa2f00a76137b297141cbf4ea7318abdcc999271cddafd9e65bc5ea5d69745674da87aa719c2b34968d40968762d3f9e0855ced
+  metadata.gz: 706bcfdac572ee3864a70d47101a689142134f030f20c37123e33f64575bd046eea74a656bdce29487f93c441a4374d77b97e96989fd234940daaf81171ace19
+  data.tar.gz: e4c1f4dae468a78f376b2a89a612a7f419e39939b0b486451980857e24127e0420e2fb2dc13f8afe8a7e1cb6686a5c2c82ce3e1b6a7dc94609327f258a785d12

data/README.adoc

@@ -38,7 +38,6 @@ Or install it yourself as:
 ----
 require  "mongous"
 
-Mongous.connect!
 Mongous.attach!  :Book
 ----
 
@@ -137,7 +136,15 @@ Book.find( { title: /title/ }, { projection: {_id: 0} } ).each do |book|
   p book
 end
 
-pp Book.where( title: /title/ )[0, 5].all
+Book.where( title: /title/ ).select( _id: 0 ).each do |book|
+  p book
+end
+
+Book.select( _id: 0 )[0, 5].each do |book|
+  p book
+end
+
+pp Book.select( :title, :price, :size )[5, 5].all
 ----
 
 === Update document
@@ -211,7 +218,7 @@ include Mongous::Document
 
 [source,ruby]
 ----
-self.client=( _client )
+self.client=( client )
 ----
 
 * Result:
@@ -220,6 +227,19 @@ self.client=( _client )
 * Parameter:
   ** client:          Mongo::Client instance.
 
+=== Get binded database.
+
+[source,ruby]
+----
+self.client
+----
+
+* Result:
+  ** Mongo::Client instance.
+
+* Parameter:
+  ** None.
+
 === Bind another collection.
 
 [source,ruby]
@@ -233,11 +253,37 @@ self.collection_name=( _collection_name )
 * Parameter:
   ** collection_name: Collection name.
 
+=== Get binded collection name.
+
+[source,ruby]
+----
+self.collection_name
+----
+
+* Result:
+  ** Collection name string.
+
+* Parameter:
+  ** None.
+
+=== Get collection.
+
+[source,ruby]
+----
+self.collection( collection_name = nil )
+----
+
+* Result:
+  ** Mongo::Collection instance.
+
+* Parameter:
+  ** collection_name: Tempolary collection name.
+
 === Declare document structure.
 
 [source,ruby]
 ----
-field( symbol, *attrs, **items )
+self.field( symbol, *attrs, **items )
 ----
 
 * Parameter:
@@ -258,7 +304,7 @@ field( symbol, *attrs, **items )
 
 [source,ruby]
 ----
-verify( *directives, &block )
+self.verify( *directives, &block )
 ----
 
 * Parameter:
@@ -270,7 +316,7 @@ verify( *directives, &block )
 
 [source,ruby]
 ----
-index( *symbols, **options )
+self.index( *symbols, **options )
 ----
 
 * Parameter:
@@ -281,7 +327,7 @@ index( *symbols, **options )
 
 [source,ruby]
 ----
-having?( label )
+self.having?( label )
 ----
 
 * Result:
@@ -294,22 +340,38 @@ having?( label )
 
 [source,ruby]
 ----
-filter( symbol, filter_or_cond )
+self.filter( symbol, filter_or_cond )
 ----
 
 * Parameter:
   ** symbol:          Filter name.
   ** filter_or_cond:  Filter or search criteria.
 
+=== Select output fields.
+
+[source,ruby]
+----
+Mongous::Document.select( *keys, **kwargs )
+Mongous::Filter#select( *keys, **kwargs )
+----
+
+* Result:
+  ** Mongous::Filter instance.
+
+* Parameter:
+  ** keys:            Field symbols.
+  ** kwargs:          Field symbols and values.
+
 === Search condition.
 
 [source,ruby]
 ----
-Collection operate class #where( filter = nil, **conditions )
+Mongous::Document.where( filter = nil, **conditions )
+Mongous::Filter#where( filter = nil, **conditions )
 ----
 
 * Result:
-  ** Filter instance.
+  ** Mongous::Filter instance.
 
 * Parameter:
   ** filter:          Filter name symbol, or filter instance.
@@ -319,11 +381,12 @@ Collection operate class #where( filter = nil, **conditions )
 
 [source,ruby]
 ----
-Collection operate class #not( filter = nil, **conditions )
+Mongous::Document.not( filter = nil, **conditions )
+Mongous::Filter#not( filter = nil, **conditions )
 ----
 
 * Result:
-  ** Filter instance.
+  ** Mongous::Filter instance.
 
 * Parameter:
   ** filter:          Filter name symbol, or filter instance.
@@ -333,11 +396,12 @@ Collection operate class #not( filter = nil, **conditions )
 
 [source,ruby]
 ----
-Collection operate class #and( *filters )
+Mongous::Document.and( *filters )
+Mongous::Filter#and( *filters )
 ----
 
 * Result:
-  ** Filter instance.
+  ** Mongous::Filter instance.
 
 * Parameter:
   ** filters:         Filter name symbol, or filter instance.
@@ -346,20 +410,34 @@ Collection operate class #and( *filters )
 
 [source,ruby]
 ----
-Collection operate class #or( *filters )
+Mongous::Document.or( *filters )
+Mongous::Filter#or( *filters )
 ----
 
 * Result:
-  ** Filter instance.
+  ** Mongous::Filter instance.
 
 * Parameter:
   ** filters:         Field name symbol, or filter instance.
 
+=== Create document.
+
+[source,ruby]
+----
+Mongous::Document.create( **doc )
+----
+
+* Result:
+  ** nil.
+
+* Parameter:
+  ** doc:             Keyword arguments.
+
 === Save document.
 
 [source,ruby]
 ----
-Document operate object #save
+Mongous::Document#save
 ----
 
 * Result:
@@ -369,7 +447,7 @@ Document operate object #save
 
 [source,ruby]
 ----
-Document operate object #to_hash
+Mongous::Document#to_hash
 ----
 
 * Result:
@@ -379,7 +457,7 @@ Document operate object #to_hash
 
 [source,ruby]
 ----
-Document operate object #to_hash
+Mongous::Document#to_json
 ----
 
 * Result:
@@ -389,8 +467,8 @@ Document operate object #to_hash
 
 [source,ruby]
 ----
-Document operate object #[]( field_name )
-Document operate object #field_name
+Mongous::Document#[]( field_name )
+Mongous::Document#field_name
 ----
 
 * Result:
@@ -403,8 +481,8 @@ Document operate object #field_name
 
 [source,ruby]
 ----
-Document operate object #[]=( field_name, field_value )
-Document operate object #field_name = field_value
+Mongous::Document#[]=( field_name, field_value )
+Mongous::Document#field_name = field_value
 ----
 
 * Result:

data/README.ja.adoc

@@ -38,7 +38,6 @@ gem 'mongous'
 ----
 require  "mongous"
 
-Mongous.connect!
 Mongous.attach!  :Book
 ----
 
@@ -137,7 +136,15 @@ Book.find( { title: /title/ }, { projection: {_id: 0} } ).each do |book|
   p book
 end
 
-pp Book.where( title: /title/ )[0, 5].all
+Book.where( title: /title/ ).select( _id: 0 ).each do |book|
+  p book
+end
+
+Book.select( _id: 0 )[0, 5].each do |book|
+  p book
+end
+
+pp Book.select( :title, :price, :size )[5, 5].all
 ----
 
 === ドキュメント更新
@@ -220,6 +227,19 @@ self.client=( client )
 * Parameter:
   ** client:          Mongo::Client インスタンス.
 
+=== Get binded database.
+
+[source,ruby]
+----
+self.client
+----
+
+* Result:
+  ** Mongo::Client インスタンス.
+
+* Parameter:
+  ** None.
+
 === 別のコレクションを割り当てる.
 
 [source,ruby]
@@ -233,11 +253,37 @@ self.collection_name=( collection_name )
 * Parameter:
   ** collection_name: コレクション名.
 
+=== Get binded collection name.
+
+[source,ruby]
+----
+self.collection_name
+----
+
+* Result:
+  ** Collection name 文字列.
+
+* Parameter:
+  ** None.
+
+=== Get collection.
+
+[source,ruby]
+----
+self.collection( collection_name = nil )
+----
+
+* Result:
+  ** Mongo::Collection インスタンス.
+
+* Parameter:
+  ** collection_name: 一時指定するコレクション名.
+
 === ドキュメントの要素を定義する.
 
 [source,ruby]
 ----
-field( symbol, *attrs, **items )
+self.field( symbol, *attrs, **items )
 ----
 
 * Parameter:
@@ -258,7 +304,7 @@ field( symbol, *attrs, **items )
 
 [source,ruby]
 ----
-verify( *directives, &block )
+self.verify( *directives, &block )
 ----
 
 * Parameter:
@@ -270,7 +316,7 @@ verify( *directives, &block )
 
 [source,ruby]
 ----
-index( *symbols, **options )
+self.index( *symbols, **options )
 ----
 
 * Parameter:
@@ -281,7 +327,7 @@ index( *symbols, **options )
 
 [source,ruby]
 ----
-having?( label )
+self.having?( label )
 ----
 
 * Result:
@@ -294,22 +340,38 @@ having?( label )
 
 [source,ruby]
 ----
-filter( symbol, filter_or_cond )
+self.filter( symbol, filter_or_cond )
 ----
 
 * Parameter:
   ** symbol:          項目名
   ** filter_or_cond:  フィルタまたは検索条件
 
+=== 出力項目を選択する.
+
+[source,ruby]
+----
+Mongous::Document.select( *keys, **kwargs )
+Mongous::Filter#select( *keys, **kwargs )
+----
+
+* Result:
+  ** Mongous::Filter instance.
+
+* Parameter:
+  ** keys:            項目名
+  ** kwargs:          項目名と項目値.
+
 === 検索条件.
 
 [source,ruby]
 ----
-コレクション操作クラス #where( filter = nil, **conditions )
+Mongous::Document.where( filter = nil, **conditions )
+Mongous::Filter#where( filter = nil, **conditions )
 ----
 
 * Result:
-  ** Filter instance.
+  ** Mongous::Filter instance.
 
 * Parameter:
   ** filter:          項目名またはフィルタインスタンス
@@ -319,11 +381,12 @@ filter( symbol, filter_or_cond )
 
 [source,ruby]
 ----
-コレクション操作クラス #not( filter = nil, **conditions )
+Mongous::Document.not( filter = nil, **conditions )
+Mongous::Filter#not( filter = nil, **conditions )
 ----
 
 * Result:
-  ** Filter instance.
+  ** Mongous::Filter instance.
 
 * Parameter:
   ** filter:          項目名またはフィルタインスタンス
@@ -333,11 +396,12 @@ filter( symbol, filter_or_cond )
 
 [source,ruby]
 ----
-コレクション操作クラス #and( *filters )
+Mongous::Document.and( *filters )
+Mongous::Filter#and( *filters )
 ----
 
 * Result:
-  ** Filter instance.
+  ** Mongous::Filter instance.
 
 * Parameter:
   ** filters:         項目名またはフィルタインスタンス
@@ -346,20 +410,34 @@ filter( symbol, filter_or_cond )
 
 [source,ruby]
 ----
-コレクション操作クラス #or( *filters )
+Mongous::Document.or( *filters )
+Mongous::Filter#or( *filters )
 ----
 
 * Result:
-  ** Filter instance.
+  ** Mongous::Filter instance.
 
 * Parameter:
   ** filters:         項目名またはフィルタインスタンス
 
+=== ドキュメントを作成.
+
+[source,ruby]
+----
+Mongous::Document.create( **doc )
+----
+
+* Result:
+  ** nil.
+
+* Parameter:
+  ** doc:             キーワード引数.
+
 === ドキュメントを保存.
 
 [source,ruby]
 ----
-ドキュメント操作オブジェクト #save
+Mongous::Document#save
 ----
 
 * Result:
@@ -369,7 +447,7 @@ filter( symbol, filter_or_cond )
 
 [source,ruby]
 ----
-ドキュメント操作オブジェクト #to_hash
+Mongous::Document#to_hash
 ----
 
 * Result:
@@ -379,7 +457,7 @@ filter( symbol, filter_or_cond )
 
 [source,ruby]
 ----
-ドキュメント操作オブジェクト #to_hash
+Mongous::Document#to_json
 ----
 
 * Result:
@@ -389,8 +467,8 @@ filter( symbol, filter_or_cond )
 
 [source,ruby]
 ----
-ドキュメント操作オブジェクト #[]( field_name )
-ドキュメント操作オブジェクト #field_name
+Mongous::Document#[]( field_name )
+Mongous::Document#field_name
 ----
 
 * Result:
@@ -403,8 +481,8 @@ filter( symbol, filter_or_cond )
 
 [source,ruby]
 ----
-ドキュメント操作オブジェクト #[]=( field_name, field_value )
-ドキュメント操作オブジェクト #field_name = field_value
+Mongous::Document#[]=( field_name, field_value )
+Mongous::Document#field_name = field_value
 ----
 
 * Result: