mongous 0.1.5 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6616ba889ba858cb82f877ba24bb755ec8e205aa9b8c70738864ce855d5ebb52
-  data.tar.gz: d733c6a2bcaeec6725f51f2e7638f8fd9cd99c7decfe568fcf0b80ee98cd3ebb
+  metadata.gz: e316aaf87661c4fe27054cdbaef39ba7f21f24432b3752ffb1cb308894de5272
+  data.tar.gz: 5597f0a55efc8d1afa45e6bf9ee93ea77653d7161d12e776bc979a6543b2c94a
 SHA512:
-  metadata.gz: 7ae43077eadf5806fe60e766050a58dfb926de35ebe50f7af0e2f7a37b3b9675112cdd3a80ca95837c93513b0286154caab863f125b3f33d0e4958ed14b6237a
-  data.tar.gz: 2e21b03862a403e6839ca2c6e569879c06e3c6f3f5e6fb63409ee6799a0257443a8e2c6612bf4a35956aa4cd931f108c2c3640c8a71c8749fa90b8913b7ac98d
+  metadata.gz: 4dc7ea514d20c8fc9ed8eaed86b4feb293df3e713a1db3acb60eb46abd61f28f0dbeeb9a68b9ac1442b6b690b3e4b12653bce102d007d912e6c08a700bd964ef
+  data.tar.gz: 44cfdfa61226dbfcaa40d846bfa2f00a76137b297141cbf4ea7318abdcc999271cddafd9e65bc5ea5d69745674da87aa719c2b34968d40968762d3f9e0855ced

data/README.adoc

@@ -5,9 +5,11 @@ Yet another mongo wrapper library.
 == Features
 
 * A light library that depends only on the mongo driver and bson, except for built-in and standard attachments.
-* Item default value can be described in the block.
-* Item constraints can be described by Array, Range, and Proc.
-* Checks that constraints are met when saving and setting values.
+* Document item constraints can be described in Array, Range, Regexp, Proc instances, or base classes.
+* Check if the constraint conditions are met when saving the document.
+* Check if the constraint condition is satisfied when setting the item value of the document.
+* The contents of undefined items in the document can be described by value or Proc.
+* Item contents at the time of document creation and update can be described by value or Proc.
 
 == Installation
 
@@ -37,10 +39,7 @@ Or install it yourself as:
 require  "mongous"
 
 Mongous.connect!
-
-class Book
-  include  Mongous::Document
-end
+Mongous.attach!  :Book
 ----
 
 === Detail declaration
@@ -54,15 +53,19 @@ Mongous.connect!  ["localhost:27017"], database: "test"
 class Book
   include  Mongous::Document
 
-  field  :title,      String,  :must
+  field  :title,      String,   :must
   field  :author,     String
   field  :publisher,  String
-  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  :style,      String,   %w[hardcover, softcover, paperback]
+  field  :size,       String,   /[AB]\d/
+  field  :price,      Integer,  (0..1_000_000)
+  field  :page,       Integer,  proc{ page % 4 == 0 }
+  field  :isbn,       String,   proc{ isbn? }
+  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
@@ -84,13 +87,13 @@ end
 book = Book.new
 book.title = "title 1"
 book.price = 1000
-book.style = "A4"
+book.size = "A4"
 book.save
 
-book = Book.new( title: "title 2", price: 2000, style: "A5" )
+book = Book.new( title: "title 2", price: 2000, size: "A5" )
 book.save
 
-doc = { title: "title 3", price: 3000, style: "A6" }
+doc = { title: "title 3", price: 3000, size: "A6" }
 Book.create( **doc )
 ----
 
@@ -100,44 +103,48 @@ Book.create( **doc )
 ----
 pp books = Book.all
 
-p book = Book.filter( title: "title 1" ).first
+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), size: ["A4","A5"] ).each do |book|
   p book
 end
 
-filter1 = Book.filter( title: /title/ )
-filter2 = Book.filter( price: (1..2000) )
-filter3 = Book.filter( style: ["A4","A5"] )
+filter1 = Book.where( title: /title/ )
+filter2 = Book.where( :foobar )
+filter3 = Book.where( price: (1..2000) )
+filter4 = Book.where( size: ["A4","A5"] )
+
 Book.not( filter1 ).each do |book|
   p book
 end
-Book.and( filter1, filter2 ).each do |book|
+Book.and( filter1, filter3 ).each do |book|
   p book
 end
-Book.or( filter1, filter3 ).each do |book|
+Book.or( filter2, filter4 ).each do |book|
   p book
 end
 
-Book.find( {}, { projection: {_id: 0} } ).each do |book|
+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
 ----
@@ -146,7 +153,7 @@ book.save
 
 [source,ruby]
 ----
-book = Book.filter( title: "title 1" ).first
+book = Book.where( title: "title 1" ).first
 book.delete
 ----
 
@@ -156,7 +163,7 @@ book.delete
 
 [source,ruby]
 ----
-Mongous.connect!( hosts_or_uri = nil, **opts )
+Mongous.connect!( hosts_or_uri = nil, **options )
 ----
 
 * Result:
@@ -164,56 +171,98 @@ 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.
+
+=== Define collection operate class with default settings.
+
+[source,ruby]
+----
+Mongous.attach!( *names )
+----
+
+* Result:
+  ** nil.
 
-=== Include document functions.
+* Parameter:
+  ** names:           Collection names. (String or Symbol)
+
+=== Include document functions into collection operate class.
 
 [source,ruby]
 ----
 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.
 
@@ -221,12 +270,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.
 
@@ -241,6 +290,129 @@ 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]
+----
+Collection operate class #where( filter = nil, **conditions )
+----
+
+* Result:
+  ** Filter instance.
+
+* Parameter:
+  ** filter:          Filter name symbol, or filter instance.
+  ** conditions:      Search criteria.
+
+=== NOT search condition.
+
+[source,ruby]
+----
+Collection operate class #not( filter = nil, **conditions )
+----
+
+* Result:
+  ** Filter instance.
+
+* Parameter:
+  ** filter:          Filter name symbol, or filter instance.
+  ** conditions:      Search criteria.
+
+=== AND search condition.
+
+[source,ruby]
+----
+Collection operate class #and( *filters )
+----
+
+* Result:
+  ** Filter instance.
+
+* Parameter:
+  ** filters:         Filter name symbol, or filter instance.
+
+=== OR search condition.
+
+[source,ruby]
+----
+Collection operate class #or( *filters )
+----
+
+* Result:
+  ** Filter instance.
+
+* Parameter:
+  ** filters:         Field name symbol, or filter instance.
+
+=== Save document.
+
+[source,ruby]
+----
+Document operate object #save
+----
+
+* Result:
+  ** nil.
+
+=== Convert document to Hash.
+
+[source,ruby]
+----
+Document operate object #to_hash
+----
+
+* Result:
+  ** Hash object.
+
+=== Convert document to JSON.
+
+[source,ruby]
+----
+Document operate object #to_hash
+----
+
+* Result:
+  ** JSON String.
+
+=== Read document field.
+
+[source,ruby]
+----
+Document operate object #[]( field_name )
+Document operate object #field_name
+----
+
+* Result:
+  ** field_value.
+
+* Parameter:
+  ** field_name:      Field name.
+
+=== Write document field.
+
+[source,ruby]
+----
+Document operate object #[]=( field_name, field_value )
+Document operate object #field_name = field_value
+----
+
+* Result:
+  ** field_value.
+
+* Parameter:
+  ** field_name:      Field name.
+  ** field_value:     Field value.
 
 == Contributing
 

data/README.ja.adoc

@@ -4,10 +4,12 @@
 
 == 特徴
 
-* 組込みと標準添付を除いて、mongo driver と bson のみに依存する軽いライブラリである。
-* 項目デフォルト値をブロックで記述できる.
-* 項目制約条件を Array, Range, Proc で記述できる.
-* 保存時および値設定時に制約条件を満たすか検査する.
+* 組込みと標準添付を除いて、mongo driver と bson のみに依存する軽いライブラリである.
+* ドキュメント項目の制約条件を Array, Range, Regexp, Proc インスタンスまたは基本クラスで記述できる.
+* ドキュメント保存時に制約条件を満たすか検査する.
+* ドキュメントの項目値設定時に制約条件を満たすか検査する.
+* ドキュメントの未定義項目の内容を値または Proc で記述できる.
+* ドキュメント作成時および更新時の項目内容を値または Proc で記述できる.
 
 == 導入
 
@@ -30,17 +32,14 @@ gem 'mongous'
 
 == 使い方
 
-=== 簡素な定義
+=== 簡潔な定義
 
 [source,ruby]
 ----
 require  "mongous"
 
 Mongous.connect!
-
-class Book
-  include  Mongous::Document
-end
+Mongous.attach!  :Book
 ----
 
 === 詳細な定義
@@ -54,15 +53,19 @@ Mongous.connect!  ["localhost:27017"], database: "test"
 class Book
   include  Mongous::Document
 
-  field  :title,      String,  :must
+  field  :title,      String,   :must
   field  :author,     String
   field  :publisher,  String
-  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  :style,      String,   %w[hardcover, softcover, paperback]
+  field  :size,       String,   /[AB]\d/
+  field  :price,      Integer,  (0..1_000_000)
+  field  :page,       Integer,  proc{ page % 4 == 0 }
+  field  :isbn,       String,   proc{ isbn? }
+  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
@@ -84,13 +87,13 @@ end
 book = Book.new
 book.title = "title 1"
 book.price = 1000
-book.style = "A4"
+book.size = "A4"
 book.save
 
-book = Book.new( title: "title 2", price: 2000, style: "A5" )
+book = Book.new( title: "title 2", price: 2000, size: "A5" )
 book.save
 
-doc = { title: "title 3", price: 3000, style: "A6" }
+doc = { title: "title 3", price: 3000, size: "A6" }
 Book.create( **doc )
 ----
 
@@ -100,44 +103,48 @@ Book.create( **doc )
 ----
 pp books = Book.all
 
-p book = Book.filter( title: "title 1" ).first
+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), size: ["A4","A5"] ).each do |book|
   p book
 end
 
-filter1 = Book.filter( title: /title/ )
-filter2 = Book.filter( price: (1..2000) )
-filter3 = Book.filter( style: ["A4","A5"] )
+filter1 = Book.where( title: /title/ )
+filter2 = Book.where( :foobar )
+filter3 = Book.where( price: (1..2000) )
+filter4 = Book.where( size: ["A4","A5"] )
+
 Book.not( filter1 ).each do |book|
   p book
 end
-Book.and( filter1, filter2 ).each do |book|
+Book.and( filter1, filter3 ).each do |book|
   p book
 end
-Book.or( filter1, filter3 ).each do |book|
+Book.or( filter2, filter4 ).each do |book|
   p book
 end
 
-Book.find( {}, { projection: {_id: 0} } ).each do |book|
+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
 ----
@@ -146,7 +153,7 @@ book.save
 
 [source,ruby]
 ----
-book = Book.filter( title: "title 1" ).first
+book = Book.where( title: "title 1" ).first
 book.delete
 ----
 
@@ -156,7 +163,7 @@ book.delete
 
 [source,ruby]
 ----
-Mongous.connect!( hosts_or_uri = nil, **opts )
+Mongous.connect!( hosts_or_uri = nil, **options )
 ----
 
 * Result:
@@ -164,38 +171,77 @@ 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 インスタンス.
+
+=== コレクション操作クラスをデフォルト設定で定義する.
+
+[source,ruby]
+----
+Mongous.attach!( *names )
+----
+
+* Result:
+  ** nil.
 
-=== ドキュメントの機能を取り入れる.
+* Parameter:
+  ** names:           コレクション名. (String または Symbol)
+
+=== コレクション操作クラスにドキュメントの機能を取り入れる.
 
 [source,ruby]
 ----
 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
@@ -203,17 +249,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:           各項目値を検証して真偽を返す内容を記述する.
 
@@ -221,12 +270,12 @@ verify( *syms, &block )
 
 [source,ruby]
 ----
-index( *syms, **opts )
+index( *symbols, **options )
 ----
 
 * Parameter:
-  ** syms:            項目名シンボル
-  ** opts:            Mongo::Collection#indexes() のオプション.
+  ** symbols:         項目名
+  ** options:         Mongo::Collection#indexes() のオプション.
 
 === 項目値がナル値でも空文字列でもないことを検証する.
 
@@ -241,6 +290,129 @@ 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:         項目名またはフィルタインスタンス
+
+=== ドキュメントを保存.
+
+[source,ruby]
+----
+ドキュメント操作オブジェクト #save
+----
+
+* Result:
+  ** nil.
+
+=== ドキュメントをHashに変換.
+
+[source,ruby]
+----
+ドキュメント操作オブジェクト #to_hash
+----
+
+* Result:
+  ** Hash object.
+
+=== ドキュメントをJSONに変換.
+
+[source,ruby]
+----
+ドキュメント操作オブジェクト #to_hash
+----
+
+* Result:
+  ** JSON String.
+
+=== ドキュメントの項目値を読む.
+
+[source,ruby]
+----
+ドキュメント操作オブジェクト #[]( field_name )
+ドキュメント操作オブジェクト #field_name
+----
+
+* Result:
+  ** 項目値.
+
+* Parameter:
+  ** field_name:      項目名.
+
+=== ドキュメントの項目値を書く.
+
+[source,ruby]
+----
+ドキュメント操作オブジェクト #[]=( field_name, field_value )
+ドキュメント操作オブジェクト #field_name = field_value
+----
+
+* Result:
+  ** 項目値.
+
+* Parameter:
+  ** field_name:      項目名.
+  ** field_value:     項目値.
 
 == 貢献