mongous 0.2.0 → 0.4.2

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,13 @@ gem 'mongous'
 
 == 使い方
 
-=== 簡素な定義
+=== 簡潔な定義
 
 [source,ruby]
 ----
 require  "mongous"
 
-Mongous.connect!
-
-class Book
-  include  Mongous::Document
-end
+Mongous.document!  :Book
 ----
 
 === 詳細な定義
@@ -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
 ----
 
 === ドキュメント更新
@@ -187,7 +195,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]
 ----
@@ -207,6 +230,19 @@ self.client=( client )
 * Parameter:
   ** client:          Mongo::Client インスタンス.
 
+=== Get binded database.
+
+[source,ruby]
+----
+self.client
+----
+
+* Result:
+  ** Mongo::Client インスタンス.
+
+* Parameter:
+  ** None.
+
 === 別のコレクションを割り当てる.
 
 [source,ruby]
@@ -220,11 +256,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:
@@ -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_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:          項目名またはフィルタインスタンス
@@ -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:          項目名またはフィルタインスタンス
@@ -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:         項目名またはフィルタインスタンス
@@ -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:         項目名またはフィルタインスタンス
 
+=== ドキュメントを作成.
+
+[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 まで. 

data/Rakefile

@@ -13,7 +13,7 @@ class Bundler::GemHelper
     dest_path  =  File.join(dir, "#{name}-#{version}.zip")
     cmnd  =  "git archive --format zip --prefix=#{name}/ HEAD > #{dest_path}"
 
-    out, code = sh_with_status( cmnd )
+    _, code = sh_with_status( cmnd )
     raise "Couldn't archive gem,"  unless  code == 0
 
     Bundler.ui.confirm "#{name} #{version} archived to #{dest_path}."
@@ -23,11 +23,11 @@ class Bundler::GemHelper
     ver  =  version.to_s
 
     cmnd  =  "git push origin  #{ver} "
-    out, code = sh_with_status( cmnd )
+    _, code = sh_with_status( cmnd )
     raise "Couldn't git push origin."  unless  code == 0
 
     cmnd  =  "git push "
-    out, code = sh_with_status( cmnd )
+    _, code = sh_with_status( cmnd )
     raise "Couldn't git push."         unless  code == 0
 
     Bundler.ui.confirm "Git Push #{ver}."
@@ -43,15 +43,15 @@ class Bundler::GemHelper
     end
 
     cmnd  =  "git add  #{version_pathname} "
-    out, code = sh_with_status( cmnd )
+    _, code = sh_with_status( cmnd )
     raise "Couldn't git add,"  unless  code == 0
 
     cmnd  =  "git commit -m  '#{new_version}' "
-    out, code = sh_with_status( cmnd )
+    _, code = sh_with_status( cmnd )
     raise "Couldn't git commit."  unless  code == 0
 
     cmnd  =  "git tag        #{new_version} "
-    out, code = sh_with_status( cmnd )
+    _, code = sh_with_status( cmnd )
     raise "Couldn't git tag."          unless  code == 0
 
     Bundler.ui.confirm "Update Tags to #{new_version}."
@@ -80,14 +80,14 @@ Bundler::GemHelper.new(Dir.pwd).instance_eval do
 
   desc "Update Version Minor"
   task 'minor' do
-    major, minor, tiny  =  version.to_s.split('.')
+    major, minor, _tiny  =  version.to_s.split('.')
     new_version  =  [major, minor.to_i + 1, 0].join('.')
     update_version( new_version )
   end
 
   desc "Update Version Major"
   task 'major' do
-    major, minor, tiny  =  version.to_s.split('.')
+    major, _minor, _tiny  =  version.to_s.split('.')
     new_version  =  [major.to_i + 1, 0, 0].join('.')
     update_version( new_version )
   end

data/lib/mongous/base.rb

@@ -11,7 +11,7 @@ module Mongous
     def connect( hosts_or_uri = nil, file: nil, mode: nil, loglevel: nil, **options )
       case  hosts_or_uri
       when  Array, String
-        ;
+        hosts_or_uri
 
       when  NilClass
         if file
@@ -46,19 +46,63 @@ module Mongous
     end
 
     def connect!( hosts_or_uri = nil, **options )
-      _client  =  connect( hosts_or_uri, **options )
-      self.class_variable_set( :@@client, _client )
+      client_  =  connect( hosts_or_uri, **options )
+      self.class_variable_set( :@@client, client_ )
     end
 
+    def document!( *names, **opts )
+      raise  Mongous::Error, "missing argument."   if names.empty?
+
+      names.each do |name|
+        case  name
+        when  String
+          name
+        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
+
+        klass  =  Object.class_eval <<-CLASS
+          class #{name}
+            include Mongous::Document
+          end
+        CLASS
+
+        if opts[:timestamp]
+          klass.class_eval do
+            field  :created_at, Time, create: proc{ Time.now }
+            field  :updated_at, Time, update: proc{ Time.now }
+            index  :created_at
+            index  :updated_at
+          end
+        end
+      end
+    end
+    alias  :attach!  :document!
+ 
     def client
-      self.class_variable_get( :@@client )    rescue  nil
+      if not self.class_variable_defined?( :@@client )
+        connect!
+      end
+      self.class_variable_get( :@@client )
     end
 
-    def client=( _client )
-      if  !_client.is_a?( ::Mongo::Client )
-        raise  Mongous::Error, "type invalid. :  #{ _client }"
+    def client=( new_client )
+      if not new_client.is_a?( ::Mongo::Client )
+        raise  Mongous::Error, "type invalid. :  #{ new_client }"
       end
-      self.class_variable_set( :@@client, _client )
+      self.class_variable_set( :@@client, new_client )
     end
 
     def loger