mongous 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 95182d94474fd128deef15317dc1131c44d3eee27e920f1cfca3030cc387a3dc
+  data.tar.gz: 2f11edcd8442be189916eadd722e131c2b63a70030285f42bc7347937351ab66
+SHA512:
+  metadata.gz: 337bd873fe2ac4323cd1fd3606a32058f669ffe9aaf8ac6f0778b37959d771d47a79b0a54739f2864d525c6283868f96676a1980631e56bd8e962b4f967d7298
+  data.tar.gz: 4881ebeeb6e17ccbcfab55ba050485974225a76790f9ccc19a06192c3c179669d5b6aadb3f955f9e2cd673bd2fee8b8562c1713b58418ac898f3c5d1cdfaf972

data/.gitignore

@@ -0,0 +1,23 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+/vendor/
+*.pid
+*.log
+*.log.*
+/var/
+/log/
+*.swp
+/.rspec_status
+

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in mongoidtest.gemspec
+gemspec
+

data/README.adoc

@@ -0,0 +1,239 @@
+= Mongous
+
+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.
+
+== Installation
+
+Add this line to your application's Gemfile:
+
+[source,ruby]
+----
+gem 'mongous'
+----
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install mongous
+    or
+    $ gem install -l mongous-x.x.x.gem
+
+== Usage
+
+=== Simple description
+
+[source,ruby]
+----
+require  "mongous"
+
+Mongous.connect!
+
+class Book
+  include  Mongous::Document
+end
+----
+
+=== Detail declaration
+
+[source,ruby]
+----
+require  "mongous"
+
+Mongous.connect!  ["localhost:27017"], database: "test"
+
+class Book
+  include  Mongous::Document
+
+  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" }
+
+  verify :strict
+  verify do
+    having?(author) | having?(publisher)
+  end
+
+  def isbn?
+    isbn.gsub(/[\D]*/, '').size == 13
+  end
+
+  index  :title
+end
+----
+
+=== Create document
+
+[source,ruby]
+----
+book = Book.new
+book.title = "title 1"
+book.price = 1000
+book.style = "A4"
+book.save
+
+book = Book.new( title: "title 2", price: 2000, style: "A5" )
+book.save
+
+doc = { title: "title 3", price: 3000, style: "A6" }
+Book.create( doc )
+----
+
+=== Search document
+
+[source,ruby]
+----
+books = Book.all
+pp books
+
+book = Book.filter( title: "title 1" ).first
+p book
+
+books = Book.filter( title: /title/ ).all
+books.each do |book|
+  p book
+end
+
+Book.filter( title: /title/ ).projection( _id: 0 ).each do |book|
+  p book
+end
+
+Book.filter( price: (1..2000), style: ["A4","A5"] ).each do |book|
+  p book
+end
+----
+
+=== Update document
+
+[source,ruby]
+----
+book = Book.filter( title: "title 1" ).first
+book.title = "title 1 [update]"
+book.save
+----
+
+=== Delete document
+
+[source,ruby]
+----
+book = Book.filter( title: "title 1" ).first
+book.delete
+----
+
+== Reference
+
+=== Connect default database.
+
+[source,ruby]
+----
+Mongous.connect!( hosts_or_uri = nil, **opts )
+----
+
+* Result:
+  ** nil.
+
+* Parameter:
+  ** hosts_or_uri:    Array of hosts, or URI (default: ["localhost:21017"])
+  ** opts:            Options.
+    *** file:         Path to database configuration file.
+    *** mode:         Execution mode. (default: "development")
+    *** database:     Database name. (default: "test")
+    *** *             Other optional arguments for Mongo::Client.new.
+
+  ** label:           Field label symbol.
+=== Connect database.
+
+[source,ruby]
+----
+Mongous.connect( hosts_or_uri = nil, **opts )
+----
+
+* Result:
+  ** Mongous::Client.
+
+=== Include document functions.
+
+[source,ruby]
+----
+include Mongous::Document
+----
+
+=== Declare document structure.
+
+[source,ruby]
+----
+field( label, *attrs, &block )
+----
+
+* Parameter:
+  ** label:           Field label symbol.
+  ** 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.
+      **** must:      Not nil nor empty.
+  ** block:           Returning default value.
+
+=== Verify before save or assignment action.
+
+[source,ruby]
+----
+verify( *syms, &block )
+----
+
+* Parameter:
+  ** syms:            Conditional symbols.
+    *** strict:       Verify that it is a defined item name.
+  ** block:           Describe the content that verifies each item value and returns the truth.
+
+=== Make index.
+
+[source,ruby]
+----
+index( *syms, **opts )
+----
+
+* Parameter:
+  ** syms:            Field label symbols.
+  ** opts:            Options for Mongo::Collection#indexes().
+
+=== Verify field value is not nil nor empty.
+
+[source,ruby]
+----
+having?( label )
+----
+
+* Result:
+  ** Boolean
+
+* Parameter:
+  ** label:           Field label for method call.
+
+
+== Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/arimay/mongous.
+
+== License
+
+The gem is available as open source under the terms of the http://opensource.org/licenses/MIT[MIT License].
+
+Copyright (c) ARIMA Yasuhiro <arima.yasuhiro@gmail.com>

data/README.ja.adoc

@@ -0,0 +1,238 @@
+= Mongous
+
+またまた新たな mongo ラッパーライブラリ.
+
+== 特徴
+
+* 組込みと標準添付を除いて、mongo driver と bson のみに依存する軽いライブラリである。
+* 項目デフォルト値をブロックで記述できる.
+* 項目制約条件を Array, Range, Proc で記述できる.
+* 保存時および値設定時に制約条件を満たすか検査する.
+
+== 導入
+
+アプリの Gemfile にこの行を追加
+
+[source,ruby]
+----
+gem 'mongous'
+----
+
+それから実行
+
+    $ bundle install
+
+または次のように手動で導入
+
+    $ gem install mongous
+    or
+    $ gem install -l mongous-x.x.x.gem
+
+== 使い方
+
+=== 簡素な定義
+
+[source,ruby]
+----
+require  "mongous"
+
+Mongous.connect!
+
+class Book
+  include  Mongous::Document
+end
+----
+
+=== 詳細な定義
+
+[source,ruby]
+----
+require  "mongous"
+
+Mongous.connect!  ["localhost:27017"], database: "test"
+
+class Book
+  include  Mongous::Document
+
+  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" }
+
+  verify :strict
+  verify do
+    having?(author) | having?(publisher)
+  end
+
+  def isbn?
+    isbn.gsub(/[\D]*/, '').size == 13
+  end
+
+  index  :title
+end
+----
+
+=== ドキュメント作成
+
+[source,ruby]
+----
+book = Book.new
+book.title = "title 1"
+book.price = 1000
+book.style = "A4"
+book.save
+
+book = Book.new( title: "title 2", price: 2000, style: "A5" )
+book.save
+
+doc = { title: "title 3", price: 3000, style: "A6" }
+Book.create( doc )
+----
+
+=== ドキュメント検索
+
+[source,ruby]
+----
+books = Book.all
+pp books
+
+book = Book.filter( title: "title 1" ).first
+p book
+
+books = Book.filter( title: /title/ ).all
+books.each do |book|
+  p book
+end
+
+Book.filter( title: /title/ ).projection( _id: 0 ).each do |book|
+  p book
+end
+
+Book.filter( price: (1..2000), style: ["A4","A5"] ).each do |book|
+  p book
+end
+----
+
+=== ドキュメント更新
+
+[source,ruby]
+----
+book = Book.filter( title: "title 1" ).first
+book.title = "title 1 [update]"
+book.save
+----
+
+=== ドキュメント削除
+
+[source,ruby]
+----
+book = Book.filter( title: "title 1" ).first
+book.delete
+----
+
+== リファレンス
+
+=== デフォルトデータベースに接続する
+
+[source,ruby]
+----
+Mongous.connect!( hosts_or_uri = nil, **opts )
+----
+
+* Result:
+  ** nil.
+
+* Parameter:
+  ** hosts_or_uri:    ホスト配列または URI (default: ["localhost:21017"])
+  ** opts:            オプション
+    *** file:         データベース構成定義ファイルへのパス
+    *** mode:         実行モード (default: "development")
+    *** database:     データベース名 (default: "test")
+    *** *             Mongo::Client.new のその他オプション引数
+
+=== データベースに接続する
+
+[source,ruby]
+----
+Mongous.connect( hosts_or_uri = nil, **opts )
+----
+
+* Result:
+  ** Mongous::Client.
+
+=== ドキュメントの機能を取り入れる.
+
+[source,ruby]
+----
+include Mongous::Document
+----
+
+=== ドキュメントの要素を定義する.
+
+[source,ruby]
+----
+field( label, *attrs, &block )
+----
+
+* Parameter:
+  ** label:           項目名シンボル
+  ** attrs:           項目属性
+    *** Class:        項目検証用 Class
+    *** Proc:         項目検証用 Proc
+    *** Range:        項目検証用範囲
+    *** Array:        項目検証用配列
+    *** Symbol:       特別な指示子
+      **** must:      ナル値でも空文字列でもない
+  ** block:           デフォルト値を返す
+
+=== 保存や代入の前にドキュメントの要素を検証する.
+
+[source,ruby]
+----
+verify( *syms, &block )
+----
+
+* Parameter:
+  ** syms:            条件シンボル
+    *** strict:       定義済み項目名であることを検証する.
+  ** block:           各項目値を検証して真偽を返す内容を記述する.
+
+=== 索引指定する.
+
+[source,ruby]
+----
+index( *syms, **opts )
+----
+
+* Parameter:
+  ** syms:            項目名シンボル
+  ** opts:            Mongo::Collection#indexes() のオプション.
+
+=== 項目値がナル値でも空文字列でもないことを検証する.
+
+[source,ruby]
+----
+having?( label )
+----
+
+* Result:
+  ** 論理値
+
+* Parameter:
+  ** label:           メソッド呼び出しする項目名.
+
+
+== 貢献
+
+不具合報告とプルリクエストは GitHub https://github.com/arimay/mongous まで. 
+
+== ライセンス
+
+この Gem は、 http://opensource.org/licenses/MIT[MITライセンス] の条件に基づいてオープンソースとして入手できる.
+
+Copyright (c) ARIMA Yasuhiro <arima.yasuhiro@gmail.com>