mongo-document 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 321421ae3e2f2c78d3c86a04f509894de8ee3365
-  data.tar.gz: aa7d497d6c2e69fa0dd318358fd0667fa29cc956
+  metadata.gz: 7d8d5c567b18d43532542788c170d51e9fe112ca
+  data.tar.gz: 3e8bf1bcc1618cb5bf250ead4fa244799eed72f9
 SHA512:
-  metadata.gz: 8680a58b6b74cf10a201e0abe7158aa591f402742fc80b33e015142b3d949e97166d06765352cad759952b122d7c6279e27c45b24ea291251cd61b4fcad9ef3d
-  data.tar.gz: 7f5905060f92d6bde8dfa85615afbbd0d2f9c4173811b97d4ccf3eaa9164bb231eaed89c327dd265b5b3748b9fc9072ff9824cbaaca8d4617e5d0d5d3fbb379e
+  metadata.gz: d3098da5589bf030da7eedd9b34da6eb2c075aa5fbfb05f7284033741149a7a9dedacc7a538878b43e6a5dcd467e0c30bea1567c9a4ffbe93138534cff9f2fb9
+  data.tar.gz: c248ee5a2c011a59a79c244c87f3c7a48ab781d34b82aa484f086d82b91e3924719130417cc3f00d4242f682b09135ba0293e2e993363988848c2bac190beac4

data/README.md

@@ -0,0 +1,73 @@
+# mongo-document
+A slim Mongo document model for MongoDB!
+
+# Why do I need it?
+1. You want something simple yet powerfull - The `mongo` Gem seems fit, but you can't build model class like `Mongoid` does with it.
+2. However you don't want to turn to Mongoid since it's far away from the simple `mongo`.
+
+`mongo-document` is just such a tiny helper for `mongo` that enables you to build model class like `Mongoid` does.
+
+# Installation
+```
+gem install mongo-document
+```
+
+# Usage
+
+```ruby
+require 'mongo/document'
+
+Mongo::Document.establish_connection(
+  :hosts => ["localhost:27017"],
+  :database => "mongo-document-test",
+)
+
+class User
+  include Mongo::Document
+  
+  indexes.create_many([
+    { :key => { :email => 1 }, :unique => true, :sparse => true },
+    { :key => { :type => 1 }},
+  ])
+end
+
+User.insert_one(:email => 'a@b.com', :type => 'dev', :name => 'Bob')
+users = User.find(:email => 'a@b.com')
+...
+
+```
+
+The model class `User` defines a collection named `users`. The mapping from class name to collection name conforms to the behaviour of ActiveRecord. You can override this by explicitly naming the collection like:
+
+```ruby
+class User
+  include Mongo::Document
+  
+  self.collection_name = 'old_users'
+end
+
+```
+
+The model class `User` has all public methods defined in `Mongo::Collection` by `mongo` Gem. In fact the former forwards those method calls to the latter. You use the model class just as a `Mongo::Collection` object!
+
+Before you call any methods of a `Mongo::Collection` object, you need to call `Mongo::Document.establish_connection` first. It takes a singel hash parameter, in which a `hosts` or a `uri` field must be provided. The `uri` conforms to the MongoDB document: https://docs.mongodb.com/manual/reference/connection-string/. The other fields of the `spec` hash are optional and documented in: https://docs.mongodb.com/ruby-driver/v2.2/tutorials/ruby-driver-create-client/#ruby-driver-client-options
+
+What's more, if you have a config file `config/database.yml` under the current working directory, it will be read for a call to `Mongo::Document.establish_connection` automatically. That's a Rails/Rack convention. You can disable this behaviour by setting environment variable `MD_NO_AUTO_CONFIG=1`. The format of the file is like:
+
+```yaml
+development:
+  hosts:
+    -- localhost:27017
+  database: dev-db
+  
+test:
+  hosts:
+    -- localhost:27017
+  database: test-db
+```
+
+The parameters are documented as mentioned above for `Mongo::Document.establish_connection`.
+
+# Very Light Footprint
+
+You're encouraged to open the single source file to see how slim the implementation is! Total code is less than 100 lines!

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongo-document
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Robert Zhang
@@ -24,12 +24,27 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
 description: 
 email: louirobert@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
 - lib/mongo/document.rb
 homepage: https://github.com/coin8086/mongo-document
 licenses:
@@ -51,7 +66,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: A slim Mongo document model