mongous 0.2.1 → 0.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dded44fdc39ecb6ff4eeb6db10183e3a940f19317062a73d85ecf4d4c6e10437
-  data.tar.gz: 34fa872a88fdc0aac33101465a490fb71f9132542e7f4583f86313527c532d9b
+  metadata.gz: 6fec2b64e882095a188352b441075601ca5e84ba7063d70a04e7d182533ebb34
+  data.tar.gz: b332b82c2d95dab25b3c69c1786757e17c0c599319f88defacad44303f8d828c
 SHA512:
-  metadata.gz: 1b39238447cf6419f663b22563930a5e32671983e29395bfc31dabeaf77d1dfca3ff7dbd84e54b8e231c9f8810729c2701d491b7ae9e3e8171eda400a97bf041
-  data.tar.gz: 7660804d5e3452714dbcbe0ac30a532789dbc553f3e5929ec58d4f0dfafd4bb9bd4dc0cb8aa124265c9af6dd6ac25acfc1361b4fa239317fc2a5bde26eb2e932
+  metadata.gz: 6cb477d1f25353cecc88f333136840ed75880b2ab38e7825f6053c01134f7bb5aa24950777a626cd46cc93e2fc88a857a1093f7cf925362e524bd857f6eb794b
+  data.tar.gz: d8ee46a451a09ab429b9754e861f21e276d311cb6b6467faef093f79a4e4868881cbc0dfe7679aa5205b5838c2ca93d1d7ff48150cc12226a0efa8ff8d5e27d5

data/.rubocop.yml

@@ -0,0 +1,73 @@
+
+AllCops:
+  Exclude:
+    - '.*'
+    - '*'
+    - '*.gemspec'
+    - 'Gemfile*'
+    - 'bin/**'
+    - 'exe/**'
+    - 'config/**/*'
+    - 'spec/**/*'
+    - 'tmp/**/*'
+    - 'vendor/**/*'
+  TargetRubyVersion: 2.7
+
+Layout/ExtraSpacing:
+  Enabled: false
+
+Layout/SpaceAroundOperators:
+  Enabled: false
+
+Layout/SpaceBeforeFirstArg:
+  Enabled: false
+
+Layout/SpaceInsideParens:
+  Enabled: false
+
+Layout/SpaceInsideArrayLiteralBrackets:
+  Enabled: false
+ 
+Layout/SpaceInsideRangeLiteral:
+  Enabled: false
+
+Layout/SpaceInsideReferenceBrackets:
+  Enabled: false
+
+Layout/SpaceInsideStringInterpolation:
+  Enabled: false
+
+Lint/AmbiguousBlockAssociation:
+  Enabled: false
+
+Lint/EmptyWhen:
+  Enabled: false
+
+Lint/ReturnInVoidContext:
+  Enabled: false
+
+Lint/UselessAssignment:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/LineLength:
+  Enabled: false
+  Max: 120
+
+Metrics/MethodLength:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: true
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/NumericPredicate:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: false
+

data/README.adoc

@@ -9,8 +9,8 @@ Yet another mongo wrapper library.
 * 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.
+* Item contents at the time of document creation and update can be described by value or Proc.
+* The database collection name corresponding to the class name is not converted to the plural form.
 
 == Installation
 
@@ -39,11 +39,7 @@ Or install it yourself as:
 ----
 require  "mongous"
 
-Mongous.connect!
-
-class Book
-  include  Mongous::Document
-end
+Mongous.document!  :Book
 ----
 
 === Detail declaration
@@ -57,10 +53,10 @@ 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,   %w[hardcover, softcover, paperback]
+  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 }
@@ -107,7 +103,8 @@ Book.create( **doc )
 ----
 pp books = Book.all
 
-p book = Book.where( title: "title 1" ).first
+p book = Book.where( title: /title/ ).first
+p book = Book.where( title: /title/ ).last
 
 books = Book.where( title: /title/ ).all
 books.each do |book|
@@ -141,7 +138,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
@@ -191,7 +196,22 @@ Mongous.connect( hosts_or_uri = nil, **options )
 * Result:
   ** Mongo::Client instance.
 
-=== Include document functions.
+=== Define collection operate class with default settings.
+
+[source,ruby]
+----
+Mongous.document!( *names, **options )
+----
+
+* Result:
+  ** nil.
+
+* Parameter:
+  ** names:           Collection names. (String or Symbol)
+  ** options:         Options.
+    *** timestamp:    If true then add fields :created_at, :updated_at.
+
+=== Include document functions into collection operate class.
 
 [source,ruby]
 ----
@@ -202,7 +222,7 @@ include Mongous::Document
 
 [source,ruby]
 ----
-self.client=( _client )
+self.client=( client )
 ----
 
 * Result:
@@ -211,6 +231,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]
@@ -224,11 +257,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:
@@ -249,7 +308,7 @@ field( symbol, *attrs, **items )
 
 [source,ruby]
 ----
-verify( *directives, &block )
+self.verify( *directives, &block )
 ----
 
 * Parameter:
@@ -261,7 +320,7 @@ verify( *directives, &block )
 
 [source,ruby]
 ----
-index( *symbols, **options )
+self.index( *symbols, **options )
 ----
 
 * Parameter:
@@ -272,7 +331,7 @@ index( *symbols, **options )
 
 [source,ruby]
 ----
-having?( label )
+self.having?( label )
 ----
 
 * Result:
@@ -285,22 +344,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]
 ----
-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.
@@ -310,11 +385,12 @@ where( filter = nil, **conditions )
 
 [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:          Filter name symbol, or filter instance.
@@ -324,11 +400,12 @@ not( filter = nil, **conditions )
 
 [source,ruby]
 ----
-and( *filters )
+Mongous::Document.and( *filters )
+Mongous::Filter#and( *filters )
 ----
 
 * Result:
-  ** Filter instance.
+  ** Mongous::Filter instance.
 
 * Parameter:
   ** filters:         Filter name symbol, or filter instance.
@@ -337,15 +414,88 @@ and( *filters )
 
 [source,ruby]
 ----
-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]
+----
+Mongous::Document#save
+----
+
+* Result:
+  ** nil.
+
+=== Convert document to Hash.
+
+[source,ruby]
+----
+Mongous::Document#to_hash
+----
+
+* Result:
+  ** Hash object.
+
+=== Convert document to JSON.
+
+[source,ruby]
+----
+Mongous::Document#to_json
+----
+
+* Result:
+  ** JSON String.
+
+=== Read document field.
+
+[source,ruby]
+----
+Mongous::Document#[]( field_name )
+Mongous::Document#field_name
+----
+
+* Result:
+  ** field_value.
+
+* Parameter:
+  ** field_name:      Field name.
+
+=== Write document field.
+
+[source,ruby]
+----
+Mongous::Document#[]=( field_name, field_value )
+Mongous::Document#field_name = field_value
+----
+
+* Result:
+  ** field_value.
+
+* Parameter:
+  ** field_name:      Field name.
+  ** field_value:     Field value.
+
 == Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/arimay/mongous.

data/README.ja.adoc

@@ -4,13 +4,13 @@
 
 == 特徴
 
-* 組込みと標準添付を除いて、mongo driver と bson のみに依存する軽いライブラリである。
+* 組込みと標準添付を除いて、mongo driver と bson のみに依存する軽いライブラリである.
 * ドキュメント項目の制約条件を Array, Range, Regexp, Proc インスタンスまたは基本クラスで記述できる.
 * ドキュメント保存時に制約条件を満たすか検査する.
 * ドキュメントの項目値設定時に制約条件を満たすか検査する.
 * ドキュメントの未定義項目の内容を値または Proc で記述できる.
-* ドキュメントの作成時に項目設定内容を値または Proc で記述できる.
-* ドキュメントの更新時に項目設定内容を値または Proc で記述できる.
+* ドキュメント作成時および更新時の項目内容を値または Proc で記述できる.
+* クラス名に対応するデータベースのコレクション名は、複数形へ変換しない.
 
 == 導入
 
@@ -33,17 +33,13 @@ gem 'mongous'
 
 == 使い方
 
-=== 簡素な定義
+=== 簡潔な定義
 
 [source,ruby]
 ----
 require  "mongous"
 
-Mongous.connect!
-
-class Book
-  include  Mongous::Document
-end
+Mongous.document!  :Book
 ----
 
 === 詳細な定義
@@ -60,7 +56,7 @@ class Book
   field  :title,      String,   :must
   field  :author,     String
   field  :publisher,  String
-  field  :style,      String,   %w[hardcover, softcover, paperback]
+  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 }
@@ -107,7 +103,8 @@ Book.create( **doc )
 ----
 pp books = Book.all
 
-p book = Book.where( title: "title 1" ).first
+p book = Book.where( title: /title/ ).first
+p book = Book.where( title: /title/ ).last
 
 books = Book.where( title: /title/ ).all
 books.each do |book|
@@ -141,7 +138,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
 ----
 
 === ドキュメント更新
@@ -191,7 +196,22 @@ Mongous.connect( hosts_or_uri = nil, **options )
 * Result:
   ** Mongo::Client インスタンス.
 
-=== ドキュメントの機能を取り入れる.
+=== コレクション操作クラスをデフォルト設定で定義する.
+
+[source,ruby]
+----
+Mongous.document!( *names, **options )
+----
+
+* Result:
+  ** nil.
+
+* Parameter:
+  ** names:           コレクション名. (String または Symbol)
+  ** options:         オプション
+    *** timestamp:    真のとき, フィールド :created_at, :updated_at を追加する.
+
+=== コレクション操作クラスにドキュメントの機能を取り入れる.
 
 [source,ruby]
 ----
@@ -211,6 +231,19 @@ self.client=( client )
 * Parameter:
   ** client:          Mongo::Client インスタンス.
 
+=== Get binded database.
+
+[source,ruby]
+----
+self.client
+----
+
+* Result:
+  ** Mongo::Client インスタンス.
+
+* Parameter:
+  ** None.
+
 === 別のコレクションを割り当てる.
 
 [source,ruby]
@@ -224,11 +257,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:
@@ -249,7 +308,7 @@ field( symbol, *attrs, **items )
 
 [source,ruby]
 ----
-verify( *directives, &block )
+self.verify( *directives, &block )
 ----
 
 * Parameter:
@@ -261,7 +320,7 @@ verify( *directives, &block )
 
 [source,ruby]
 ----
-index( *symbols, **options )
+self.index( *symbols, **options )
 ----
 
 * Parameter:
@@ -272,7 +331,7 @@ index( *symbols, **options )
 
 [source,ruby]
 ----
-having?( label )
+self.having?( label )
 ----
 
 * Result:
@@ -285,22 +344,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:          項目名またはフィルタインスタンス
@@ -310,11 +385,12 @@ where( filter = nil, **conditions )
 
 [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:          項目名またはフィルタインスタンス
@@ -324,11 +400,12 @@ not( filter = nil, **conditions )
 
 [source,ruby]
 ----
-and( *filters )
+Mongous::Document.and( *filters )
+Mongous::Filter#and( *filters )
 ----
 
 * Result:
-  ** Filter instance.
+  ** Mongous::Filter instance.
 
 * Parameter:
   ** filters:         項目名またはフィルタインスタンス
@@ -337,15 +414,88 @@ and( *filters )
 
 [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]
+----
+Mongous::Document#save
+----
+
+* Result:
+  ** nil.
+
+=== ドキュメントをHashに変換.
+
+[source,ruby]
+----
+Mongous::Document#to_hash
+----
+
+* Result:
+  ** Hash object.
+
+=== ドキュメントをJSONに変換.
+
+[source,ruby]
+----
+Mongous::Document#to_json
+----
+
+* Result:
+  ** JSON String.
+
+=== ドキュメントの項目値を読む.
+
+[source,ruby]
+----
+Mongous::Document#[]( field_name )
+Mongous::Document#field_name
+----
+
+* Result:
+  ** 項目値.
+
+* Parameter:
+  ** field_name:      項目名.
+
+=== ドキュメントの項目値を書く.
+
+[source,ruby]
+----
+Mongous::Document#[]=( field_name, field_value )
+Mongous::Document#field_name = field_value
+----
+
+* Result:
+  ** 項目値.
+
+* Parameter:
+  ** field_name:      項目名.
+  ** field_value:     項目値.
+
 == 貢献
 
 不具合報告とプルリクエストは GitHub https://github.com/arimay/mongous まで.