mongous 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dded44fdc39ecb6ff4eeb6db10183e3a940f19317062a73d85ecf4d4c6e10437
-  data.tar.gz: 34fa872a88fdc0aac33101465a490fb71f9132542e7f4583f86313527c532d9b
+  metadata.gz: e316aaf87661c4fe27054cdbaef39ba7f21f24432b3752ffb1cb308894de5272
+  data.tar.gz: 5597f0a55efc8d1afa45e6bf9ee93ea77653d7161d12e776bc979a6543b2c94a
 SHA512:
-  metadata.gz: 1b39238447cf6419f663b22563930a5e32671983e29395bfc31dabeaf77d1dfca3ff7dbd84e54b8e231c9f8810729c2701d491b7ae9e3e8171eda400a97bf041
-  data.tar.gz: 7660804d5e3452714dbcbe0ac30a532789dbc553f3e5929ec58d4f0dfafd4bb9bd4dc0cb8aa124265c9af6dd6ac25acfc1361b4fa239317fc2a5bde26eb2e932
+  metadata.gz: 4dc7ea514d20c8fc9ed8eaed86b4feb293df3e713a1db3acb60eb46abd61f28f0dbeeb9a68b9ac1442b6b690b3e4b12653bce102d007d912e6c08a700bd964ef
+  data.tar.gz: 44cfdfa61226dbfcaa40d846bfa2f00a76137b297141cbf4ea7318abdcc999271cddafd9e65bc5ea5d69745674da87aa719c2b34968d40968762d3f9e0855ced

data/README.adoc

@@ -9,8 +9,7 @@ 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.
 
 == Installation
 
@@ -40,10 +39,7 @@ Or install it yourself as:
 require  "mongous"
 
 Mongous.connect!
-
-class Book
-  include  Mongous::Document
-end
+Mongous.attach!  :Book
 ----
 
 === Detail declaration
@@ -57,7 +53,7 @@ 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]
@@ -191,7 +187,20 @@ Mongous.connect( hosts_or_uri = nil, **options )
 * Result:
   ** Mongo::Client instance.
 
-=== Include document functions.
+=== Define collection operate class with default settings.
+
+[source,ruby]
+----
+Mongous.attach!( *names )
+----
+
+* Result:
+  ** nil.
+
+* Parameter:
+  ** names:           Collection names. (String or Symbol)
+
+=== Include document functions into collection operate class.
 
 [source,ruby]
 ----
@@ -296,7 +305,7 @@ filter( symbol, filter_or_cond )
 
 [source,ruby]
 ----
-where( filter = nil, **conditions )
+Collection operate class #where( filter = nil, **conditions )
 ----
 
 * Result:
@@ -310,7 +319,7 @@ where( filter = nil, **conditions )
 
 [source,ruby]
 ----
-not( filter = nil, **conditions )
+Collection operate class #not( filter = nil, **conditions )
 ----
 
 * Result:
@@ -324,7 +333,7 @@ not( filter = nil, **conditions )
 
 [source,ruby]
 ----
-and( *filters )
+Collection operate class #and( *filters )
 ----
 
 * Result:
@@ -337,7 +346,7 @@ and( *filters )
 
 [source,ruby]
 ----
-or( *filters )
+Collection operate class #or( *filters )
 ----
 
 * Result:
@@ -346,6 +355,65 @@ or( *filters )
 * 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
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/arimay/mongous.

data/README.ja.adoc

@@ -4,13 +4,12 @@
 
 == 特徴
 
-* 組込みと標準添付を除いて、mongo driver と bson のみに依存する軽いライブラリである。
+* 組込みと標準添付を除いて、mongo driver と bson のみに依存する軽いライブラリである.
 * ドキュメント項目の制約条件を Array, Range, Regexp, Proc インスタンスまたは基本クラスで記述できる.
 * ドキュメント保存時に制約条件を満たすか検査する.
 * ドキュメントの項目値設定時に制約条件を満たすか検査する.
 * ドキュメントの未定義項目の内容を値または Proc で記述できる.
-* ドキュメントの作成時に項目設定内容を値または Proc で記述できる.
-* ドキュメントの更新時に項目設定内容を値または Proc で記述できる.
+* ドキュメント作成時および更新時の項目内容を値または Proc で記述できる.
 
 == 導入
 
@@ -33,17 +32,14 @@ gem 'mongous'
 
 == 使い方
 
-=== 簡素な定義
+=== 簡潔な定義
 
 [source,ruby]
 ----
 require  "mongous"
 
 Mongous.connect!
-
-class Book
-  include  Mongous::Document
-end
+Mongous.attach!  :Book
 ----
 
 === 詳細な定義
@@ -191,7 +187,20 @@ Mongous.connect( hosts_or_uri = nil, **options )
 * Result:
   ** Mongo::Client インスタンス.
 
-=== ドキュメントの機能を取り入れる.
+=== コレクション操作クラスをデフォルト設定で定義する.
+
+[source,ruby]
+----
+Mongous.attach!( *names )
+----
+
+* Result:
+  ** nil.
+
+* Parameter:
+  ** names:           コレクション名. (String または Symbol)
+
+=== コレクション操作クラスにドキュメントの機能を取り入れる.
 
 [source,ruby]
 ----
@@ -296,7 +305,7 @@ filter( symbol, filter_or_cond )
 
 [source,ruby]
 ----
-where( filter = nil, **conditions )
+コレクション操作クラス #where( filter = nil, **conditions )
 ----
 
 * Result:
@@ -310,7 +319,7 @@ where( filter = nil, **conditions )
 
 [source,ruby]
 ----
-not( filter = nil, **conditions )
+コレクション操作クラス #not( filter = nil, **conditions )
 ----
 
 * Result:
@@ -324,7 +333,7 @@ not( filter = nil, **conditions )
 
 [source,ruby]
 ----
-and( *filters )
+コレクション操作クラス #and( *filters )
 ----
 
 * Result:
@@ -337,7 +346,7 @@ and( *filters )
 
 [source,ruby]
 ----
-or( *filters )
+コレクション操作クラス #or( *filters )
 ----
 
 * Result:
@@ -346,6 +355,65 @@ or( *filters )
 * 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:     項目値.
+
 == 貢献
 
 不具合報告とプルリクエストは GitHub https://github.com/arimay/mongous まで. 

data/lib/mongous/base.rb

@@ -50,6 +50,36 @@ module Mongous
       self.class_variable_set( :@@client, _client )
     end
 
+    def attach!( *names )
+      raise  Mongous::Error, "missing argument."   if names.empty?
+
+      names.each do |name|
+        case  name
+        when  String
+        when  Symbol
+          name  =  name.to_s
+        else
+          raise  Mongous::Error, "type invalid. :  #{ name }"
+        end
+
+        raise  Mongous::Error, "missing argument."   unless  /^[A-Z]/.match(name)
+
+        if  Object.const_defined?( name )
+          if  Object.const_get( name ).include?( Mongous::Document )
+            Object.class_eval{ remove_const( name ) }
+          else
+            raise  Mongous::Error, "type invalid. :  #{ Object.class_eval(name) }"
+          end
+        end
+
+        Object.class_eval <<-CLASS
+          class #{name}
+            include Mongous::Document
+          end
+        CLASS
+      end
+    end
+ 
     def client
       self.class_variable_get( :@@client )    rescue  nil
     end

data/lib/mongous/document.rb

@@ -100,15 +100,23 @@ module Mongous
       when  :update
         self.class.collection.update_one( { "_id"=> @doc["_id"] }, { '$set' => @doc } )
       end
-
       self
     end
 
+    def to_hash
+      @doc.dup
+    end
+
+    def to_json
+      @doc.to_json
+    end
+
     def []( label )
       label  =  label.to_s
 
       if  self.class.symbols[:strict]
-        if  !(self.class.fields.keys.include?(label) || (label == "_id"))
+        labels  =  ["_id"] + self.class.fields.keys
+        if  !labels.include?( label )
           raise  Mongous::Error, "undefined field. : #{ label }"
         end
       end

data/lib/mongous/version.rb

@@ -1,3 +1,3 @@
 module Mongous
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

data/sample/declare_compact_1.rb

@@ -7,7 +7,6 @@ class Book
   include  Mongous::Document
 end
 
-
 book  =  Book.new
 book.title       =  "declare compact"
 book.author      =  "Alice"
@@ -16,12 +15,12 @@ book.style       =  "hardcover"
 book.size        =  "A4"
 book.price       =  100
 book.page        =  100
-# book.publish_at  =  nil # (default)
-# book.isbn        =  "978-3-16-148410-0"
+book.isbn        =  "978-3-16-148410-0"
 # book.lang        =  nil # (default)
+# book.created_at  =  nil # (created)
+# book.updated_at  =  nil # (updated)
 book.save
 
-
 Book.each do |book|
   pp book
 end

data/sample/declare_label_1.rb

@@ -13,9 +13,10 @@ class Book
   field  :size
   field  :price
   field  :page
-  field  :publish_at
   field  :isbn
   field  :lang
+  field  :created_at
+  field  :updated_at
 
   verify :strict
 end
@@ -29,9 +30,10 @@ book.style       =  "softcover"
 book.size        =  "A5"
 book.price       =  200
 book.page        =  200
-# book.publish_at  =  nil  # (default)
-# book.isbn        =  "978-3-16-148410-0"
+book.isbn        =  "978-3-16-148410-0"
 # book.lang        =  nil  # (default)
+# book.created_at  =  nil  # (created)
+# book.updated_at  =  nil  # (updated)
 book.save
 
 

data/sample/declare_ndex_1.rb

@@ -13,9 +13,10 @@ class Book
   field  :size
   field  :price
   field  :page
-  field  :publish_at
   field  :isbn
   field  :lang
+  field  :created_at
+  field  :updated_at
 
   index  :title
 
@@ -31,9 +32,10 @@ book.style       =  "paperback"
 book.size        =  "A6"
 book.price       =  300
 book.page        =  300
-# book.publish_at  =  nil  # (default)
 book.isbn        =  "978-3-16-148410-0"
 # book.lang        =  nil  # (default)
+# book.created_at  =  nil  # (created)
+# book.updated_at  =  nil  # (updated)
 book.save
 
 

data/sample/declare_ndex_2.rb

@@ -13,11 +13,12 @@ class Book
   field  :size
   field  :price
   field  :page
-  field  :publish_at
   field  :isbn
   field  :lang
+  field  :created_at
+  field  :updated_at
 
-  index  :isbn,         unique: true
+  index  :isbn
 
   verify :strict
 end
@@ -31,9 +32,10 @@ book.style       =  "paperback"
 book.size        =  "A6"
 book.price       =  300
 book.page        =  300
-# book.publish_at  =  nil  # (default)
 book.isbn        =  "978-3-16-148410-0"
 # book.lang        =  nil  # (default)
+# book.created_at  =  nil  # (created)
+# book.updated_at  =  nil  # (updated)
 book.save
 
 

data/sample/multi_collection_3.rb

@@ -0,0 +1,26 @@
+
+require "mongous"
+
+Mongous.connect!
+
+Mongous.attach!  :Book1
+Mongous.attach!  :Book2
+Mongous.attach!  :Book3
+
+pp Book1.collection
+pp Book2.collection
+pp Book3.collection
+
+Mongous.attach!  :Book1
+Mongous.attach!  :Book2, :Book3
+
+pp Book1.collection
+pp Book2.collection
+pp Book3.collection
+
+Mongous.attach!  :Book1, :Book2, :Book3
+
+pp Book1.collection
+pp Book2.collection
+pp Book3.collection
+

data/sample/query_detail_1.rb

@@ -13,9 +13,10 @@ class Book
   field  :size
   field  :price
   field  :page
-  field  :publish_at
   field  :isbn
   field  :lang
+  field  :created_at
+  field  :updated_at
 
   verify :strict
 end

data/sample/query_detail_2.rb

@@ -13,9 +13,10 @@ class Book
   field  :size
   field  :price,      Integer
   field  :page,       Integer
-  field  :publish_at, Date
   field  :isbn
   field  :lang
+  field  :created_at, Time
+  field  :updated_at, Time
 
   verify :strict
 end

data/sample/save_detail_3.rb

@@ -30,14 +30,14 @@ end
 book  =  Book.new
 book.title  =  "title detail 3"
 book.author  =  "Candy"
-#book.publisher
+book.publisher
 book.style  =  "paperback"
 book.size  =  "A6"
 book.price  =  3000
 book.page  =  300
 book.isbn  =  "978-3-16-148410-0"
-#book.lang
-#book.created_at
-#book.updated_at
+# book.lang
+# book.created_at
+# book.updated_at
 book.save
 

data/sample/save_verify_1.rb

@@ -15,8 +15,8 @@ class Book
   field  :page,         Integer, proc{ page > 0 }
   field  :isbn,         String,  proc{ isbn? }
   field  :lang,         String,  default: "en"
-  field  :created_at,   Time,    create: ->(){ Time.now }
-  field  :updated_at,   Time,    update: ->(){ Time.now }
+  field  :created_at,   Time,    create: proc{ Time.now }
+  field  :updated_at,   Time,    update: proc{ Time.now }
 
   verify :strict
   verify { having?( title ) }

data/sample/zap_basic_3.rb

@@ -0,0 +1,11 @@
+
+require "mongous"
+
+Mongous.connect!
+
+class Card
+  include  Mongous::Document
+end
+
+Card.delete
+

data/sample/zbenchmark_search_1.rb

@@ -0,0 +1,110 @@
+
+require "mongous"
+
+Mongous.connect!
+
+class Card
+  include  Mongous::Document
+  field :i1, Integer
+  field :i2, Integer
+  field :f1, Float
+  field :f2, Float
+  field :s1, String
+  field :s2, String
+  field :d1, Date
+  field :d2, Date
+  field :t1, Time
+  field :t2, Time
+
+  index :i2, unique: true
+  index :f2, unique: true
+  index :s2, unique: true
+  index :d2, unique: true
+  index :t2, unique: true
+end
+
+require "benchmark"
+require "date"
+
+COUNT = 10000
+
+D0  =  Date.parse( "2020-01-01" )
+T0  =  D0.to_time
+
+Benchmark.bm 32 do |r|
+  if COUNT !=  Card.count
+    Card.delete
+    r.report "create #{COUNT}" do
+      (0...COUNT).each do |i|
+          f  =  i.to_f
+          s  =  i.to_s
+          d  =  D0 + i
+          t  =  T0 + i
+          card  =  Card.create(
+            i1: i,
+            i2: i,
+            f1: f,
+            f2: f,
+            s1: s,
+            s2: s,
+            d1: d,
+            d2: d,
+            t1: t,
+            t2: t,
+          )
+      end
+    end
+  end
+
+  r.report "find a integer without index" do
+    (0...COUNT).each do |i|
+      Card.where( i1: i ).first
+    end
+  end
+  r.report "find a integer with index" do
+    (0...COUNT).each do |i|
+      Card.where( i2: i ).first
+    end
+  end
+  r.report "find a float   without index" do
+    (0...COUNT).each do |i|
+      Card.where( f1: i.to_f ).first
+    end
+  end
+  r.report "find a float   with index" do
+    (0...COUNT).each do |i|
+      Card.where( f2: i.to_f ).first
+    end
+  end
+  r.report "find a string  without index" do
+    (0...COUNT).each do |i|
+      Card.where( s1: i.to_s ).first
+    end
+  end
+  r.report "find a string  with index" do
+    (0...COUNT).each do |i|
+      Card.where( s2: i.to_s ).first
+    end
+  end
+  r.report "find a date    without index" do
+    (0...COUNT).each do |i|
+      Card.where( d1: D0 + i ).first
+    end
+  end
+  r.report "find a date    with index" do
+    (0...COUNT).each do |i|
+      Card.where( d2: D0 + i ).first
+    end
+  end
+  r.report "find a time    without index" do
+    (0...COUNT).each do |i|
+      Card.where( t1: T0 + i ).first
+    end
+  end
+  r.report "find a time    with index" do
+    (0...COUNT).each do |i|
+      Card.where( t2: T0 + i ).first
+    end
+  end
+end
+

data/sample/zbenchmark_search_2.rb

@@ -0,0 +1,110 @@
+
+require "mongous"
+
+Mongous.connect!
+
+class Card
+  include  Mongous::Document
+  field :i1, Integer
+  field :i2, Integer
+  field :f1, Float
+  field :f2, Float
+  field :s1, String
+  field :s2, String
+  field :d1, Date
+  field :d2, Date
+  field :t1, Time
+  field :t2, Time
+
+  index :i2, unique: true
+  index :f2, unique: true
+  index :s2, unique: true
+  index :d2, unique: true
+  index :t2, unique: true
+end
+
+require "benchmark"
+require "date"
+
+COUNT = 10000
+
+D0  =  Date.parse( "2020-01-01" )
+T0  =  D0.to_time
+
+Benchmark.bm 32 do |r|
+  if COUNT !=  Card.count
+    Card.delete
+    r.report "create #{COUNT}" do
+      (0...COUNT).each do |i|
+          f  =  i.to_f
+          s  =  i.to_s
+          d  =  D0 + i
+          t  =  T0 + i
+          card  =  Card.create(
+            i1: i,
+            i2: i,
+            f1: f,
+            f2: f,
+            s1: s,
+            s2: s,
+            d1: d,
+            d2: d,
+            t1: t,
+            t2: t,
+          )
+      end
+    end
+  end
+
+  r.report "find range integer without index" do
+    (0...COUNT).each do |i|
+      Card.where( i1: ( i ... (i+10) ) ).all
+    end
+  end
+  r.report "find range integer with    index" do
+    (0...COUNT).each do |i|
+      Card.where( i2: ( i ... (i+10) ) ).all
+    end
+  end
+  r.report "find range float   without index" do
+    (0...COUNT).each do |i|
+      Card.where( f1: ( i.to_f ... (i+10).to_f ) ).all
+    end
+  end
+  r.report "find range float   with    index" do
+    (0...COUNT).each do |i|
+      Card.where( f2: ( i.to_f ... (i+10).to_f ) ).all
+    end
+  end
+  r.report "find range string  without index" do
+    (0...COUNT).each do |i|
+      Card.where( s1: ( i.to_s ... (i+10).to_s ) ).all
+    end
+  end
+  r.report "find range string  with    index" do
+    (0...COUNT).each do |i|
+      Card.where( s2: ( i.to_s ... (i+10).to_s ) ).all
+    end
+  end
+  r.report "find range date    without index" do
+    (0...COUNT).each do |i|
+      Card.where( d1: ( (D0 + i) ... (D0 + i + 10) ) ).all
+    end
+  end
+  r.report "find range date    with    index" do
+    (0...COUNT).each do |i|
+      Card.where( d2: ( (D0 + i) ... (D0 + i + 10) ) ).all
+    end
+  end
+  r.report "find range time    without index" do
+    (0...COUNT).each do |i|
+      Card.where( t1: ( (T0 + i) ... (T0 + i + 10) ) ).all
+    end
+  end
+  r.report "find range time    with    index" do
+    (0...COUNT).each do |i|
+      Card.where( t2: ( (T0 + i) ... (T0 + i + 10) ) ).all
+    end
+  end
+end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mongous
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - arimay
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-10-08 00:00:00.000000000 Z
+date: 2020-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongo
@@ -92,6 +92,7 @@ files:
 - sample/declare_strict_2.rb
 - sample/multi_collection_1.rb
 - sample/multi_collection_2.rb
+- sample/multi_collection_3.rb
 - sample/query_basic_1.rb
 - sample/query_basic_2.rb
 - sample/query_basic_3.rb
@@ -123,6 +124,9 @@ files:
 - sample/update_basic_1.rb
 - sample/zap_basic_1.rb
 - sample/zap_basic_2.rb
+- sample/zap_basic_3.rb
+- sample/zbenchmark_search_1.rb
+- sample/zbenchmark_search_2.rb
 homepage: https://github.com/arimay/mongous
 licenses:
 - MIT