mongous 0.2.0 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 26e437e93bf76ff87a088329b744df4f1425d7b14c106d80edb46f12bbfde12f
-  data.tar.gz: 4e6bb7dd48f0799ce33165629c658b174316fd9d271f4f51ae866b804607ae59
+  metadata.gz: 6a7aef9ade90f7665f9152ca0fce4831c5f9ac3263bba36f1014b2f51d1596fb
+  data.tar.gz: 5b69a145e019b335bb49de2eec293fbe2109ada1d1702dcd58e27e7e918ff408
 SHA512:
-  metadata.gz: 392818352168bf2c196c90693559f421e35fe6ed15bdaa013a9a3f651a5dbda66f2eb0f4ed38c25e28c5d77c1c7d5122d8384c8de56bb701b896ffe2133b3ef0
-  data.tar.gz: 401266df4545a41f3b8d5e090f986dc2cd8215b48d153da195b8c276316a3e9ebed07b8a24e5dd677cc469d9676415a30ffb844f29211064c3d1fefa4c6badd5
+  metadata.gz: 6d81649ab8678859734b621712493adde5d7d0056f532c4abcb0297894442acd1be905b60e725eb85070aa95a75f4c2353d9e54bcbb44fb20346afd398cc3448
+  data.tar.gz: 0e7001c64b912df122d67c1bd67cbc378b6e9974c24b1a94235348c8ed74cd1fa22d4c65eba2d14e7968387ae8ca22ae375ae46ece75faa039cd8d4936cf1bc3

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

@@ -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
 
@@ -36,11 +38,7 @@ Or install it yourself as:
 ----
 require  "mongous"
 
-Mongous.connect!
-
-class Book
-  include  Mongous::Document
-end
+Mongous.document!  :Book
 ----
 
 === Detail declaration
@@ -54,16 +52,17 @@ 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  :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 }
+  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/}
 
@@ -87,13 +86,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 )
 ----
 
@@ -103,7 +102,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|
@@ -114,14 +114,14 @@ Book.where( title: /title/ ).projection( _id: 0 ).each do |book|
   p book
 end
 
-Book.where( 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( style: ["A4","A5"] )
+filter4 = Book.where( size: ["A4","A5"] )
 
 Book.not( filter1 ).each do |book|
   p book
@@ -137,7 +137,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
@@ -187,7 +195,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]
 ----
@@ -198,7 +221,7 @@ include Mongous::Document
 
 [source,ruby]
 ----
-self.client=( _client )
+self.client=( client )
 ----
 
 * Result:
@@ -207,6 +230,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]
@@ -220,11 +256,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:
@@ -245,7 +307,7 @@ field( symbol, *attrs, **items )
 
 [source,ruby]
 ----
-verify( *directives, &block )
+self.verify( *directives, &block )
 ----
 
 * Parameter:
@@ -257,7 +319,7 @@ verify( *directives, &block )
 
 [source,ruby]
 ----
-index( *symbols, **options )
+self.index( *symbols, **options )
 ----
 
 * Parameter:
@@ -268,7 +330,7 @@ index( *symbols, **options )
 
 [source,ruby]
 ----
-having?( label )
+self.having?( label )
 ----
 
 * Result:
@@ -281,22 +343,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.
@@ -306,11 +384,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.
@@ -320,11 +399,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.
@@ -333,15 +413,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.