mongous 0.1.4 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8625111477cf919df2db565a10a074c1634be763e2608ba11f27c700225b84c9
-  data.tar.gz: 6ff1ca08f9180c3e3272746f2fbb155b1e2b723686c5089222c61707b7868eab
+  metadata.gz: dded44fdc39ecb6ff4eeb6db10183e3a940f19317062a73d85ecf4d4c6e10437
+  data.tar.gz: 34fa872a88fdc0aac33101465a490fb71f9132542e7f4583f86313527c532d9b
 SHA512:
-  metadata.gz: a90f92e753dc4e634bf8939760ca3808a995fc73fc76d929028a03b7cb66fd50d3c42895ba54795c72205c3906636850f2f794279e8615c1e21d28a67716cd6b
-  data.tar.gz: fcb2cf7f85a660635a552410a37febf03165538a708a93d4760a11ea3645752c2d4f1bd3ee38971d040e75e36ca9c44ecf6ce26d80a3fafb40d6a06eee52a650
+  metadata.gz: 1b39238447cf6419f663b22563930a5e32671983e29395bfc31dabeaf77d1dfca3ff7dbd84e54b8e231c9f8810729c2701d491b7ae9e3e8171eda400a97bf041
+  data.tar.gz: 7660804d5e3452714dbcbe0ac30a532789dbc553f3e5929ec58d4f0dfafd4bb9bd4dc0cb8aa124265c9af6dd6ac25acfc1361b4fa239317fc2a5bde26eb2e932

data/README.adoc

@@ -5,9 +5,12 @@ 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 settings can be described in values or Proc when creating a document.
+* Item settings can be described in values or Proc when updating the document.
 
 == Installation
 
@@ -30,7 +33,7 @@ Or install it yourself as:
 
 == Usage
 
-=== Simple description
+=== Simple declaration
 
 [source,ruby]
 ----
@@ -57,12 +60,16 @@ class Book
   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,45 +91,64 @@ 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" }
-Book.create( doc )
+doc = { title: "title 3", price: 3000, size: "A6" }
+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), size: ["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( size: ["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 +157,7 @@ book.save
 
 [source,ruby]
 ----
-book = Book.filter( title: "title 1" ).first
+book = Book.where( title: "title 1" ).first
 book.delete
 ----
 
@@ -141,7 +167,7 @@ book.delete
 
 [source,ruby]
 ----
-Mongous.connect!( hosts_or_uri = nil, **opts )
+Mongous.connect!( hosts_or_uri = nil, **options )
 ----
 
 * Result:
@@ -149,21 +175,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 +198,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 +261,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 +281,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

@@ -5,9 +5,12 @@
 == 特徴
 
 * 組込みと標準添付を除いて、mongo driver と bson のみに依存する軽いライブラリである。
-* 項目デフォルト値をブロックで記述できる.
-* 項目制約条件を Array, Range, Proc で記述できる.
-* 保存時および値設定時に制約条件を満たすか検査する.
+* ドキュメント項目の制約条件を Array, Range, Regexp, Proc インスタンスまたは基本クラスで記述できる.
+* ドキュメント保存時に制約条件を満たすか検査する.
+* ドキュメントの項目値設定時に制約条件を満たすか検査する.
+* ドキュメントの未定義項目の内容を値または Proc で記述できる.
+* ドキュメントの作成時に項目設定内容を値または Proc で記述できる.
+* ドキュメントの更新時に項目設定内容を値または Proc で記述できる.
 
 == 導入
 
@@ -54,15 +57,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,45 +91,64 @@ 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" }
-Book.create( doc )
+doc = { title: "title 3", price: 3000, size: "A6" }
+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), size: ["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( size: ["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 +157,7 @@ book.save
 
 [source,ruby]
 ----
-book = Book.filter( title: "title 1" ).first
+book = Book.where( title: "title 1" ).first
 book.delete
 ----
 
@@ -141,7 +167,7 @@ book.delete
 
 [source,ruby]
 ----
-Mongous.connect!( hosts_or_uri = nil, **opts )
+Mongous.connect!( hosts_or_uri = nil, **options )
 ----
 
 * Result:
@@ -149,21 +175,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 +198,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 +240,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 +261,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 +281,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:         項目名またはフィルタインスタンス
 
 == 貢献