emerald_odm 1.1.1 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5730dcce3f54aca15736e052c5a98a758d0d691b243e544f406de15c7d1cbbb4
-  data.tar.gz: 3814ee64675fe80d44e96a15ff17e05d849c71f44477c607a388a7c3f9863a53
+  metadata.gz: 801a45bf7c2940c3547f9260d255c47b2b87fc8becad126899ea1e8c078aaf00
+  data.tar.gz: de2e365a5c4e60dc4c79766ff624f8300e84245d09c6937169e7fa98c23771f3
 SHA512:
-  metadata.gz: b6b884d39e9b34f8a13237413753fbfe5265e51f463a93befe6c4b848b8bce379f37cfb84103f425788042b6480a138f4a51e87fffb039d77a6ae01b5d8f9bcf
-  data.tar.gz: 751d69add77372aa90f657d4a6802f1794391f7155ff9451a019750704e6cf84c125212a9c97d41e5049ce9bed26e9e379ccf1d693ddce3797c37525321f4b6c
+  metadata.gz: 40df24b7d653f85b7707d212ef97d661f196e3f3b96cd7dc6a7c735cd74bd44acc2708dc2700e894288f5fc9c12a4d818c7896315e353758b44381797f639f85
+  data.tar.gz: '08e0a9504e115b9d296689b4467147b34f2a74cf8e9d3d7d4ea20788e504de2be38d65f72bd83b835fd893a6adcc89df6197dc7352f2e2a5f6965f50c437ffb2'

data/README.md

@@ -1,60 +1,121 @@
 # EmeraldODM
+EmeraldODM is an Object-Document Mapper (ODM) for Ruby that allows you to interact with MongoDB databases in a simple, Ruby-like way. It provides a high-level, easy-to-use interface for working with MongoDB documents, while abstracting away the low-level details of the MongoDB driver.
 
-EmeraldODM is an simple ODM (Object-Document Mapper) framework for MongoDB in Ruby.
+The main objective of this gem is primarily to facilitate reading data from a MongoDB database.
 
-
-
-## Installation
-
-```bash
-gem install emerald_odm
+# Installation
+To install EmeraldODM, simply add it to your Gemfile:
+```ruby
+gem 'emerald_odm'
 ```
+Then run bundle install to install the gem and its dependencies.
 
-## Usage
+# Usage
+Here's a quick example of how to use EmeraldODM to interact with a MongoDB database:
 
+## 1. Setup DB connection
 ```ruby
 require 'emerald_odm'
 
-# 1. Setup DB connection
+# Connect to the MongoDB servers before using EmeraldODM
 EmeraldODM.databases_settings.merge!(
   {
-    test: [
-        [ ENV['IP_MONGO_DATABASE'] ],
-        {
-          database: 'test',
-          user: ENV['DB_LOGIN'],
-          password: ENV['DB_PASSWD'],
-          auth_source:  ENV['auth_source'],
-          max_pool_size: 20,
-        }
-    ]
+    blog: [
+      [ '192.168.0.1:27017', '192.168.1.1:27017'],
+      {
+        database: 'blog',
+        user: ENV['MONGO_LOGIN'],
+        password: ENV['MONGO_PASSWD'],
+        auth_source:  ENV['auth_source'],
+        max_pool_size: 20,
+      }
+    ],
+    ecommerce: [
+      [ '193.168.0.1:27017', '193.168.1.1:27017'],
+      {
+        database: 'ecommerce',
+        user: ENV['MONGO_LOGIN'],
+        password: ENV['MONGO_PASSWD'],
+        auth_source:  ENV['auth_source'],
+        max_pool_size: 20,
+      }
+    ],
   }
 )
 
-# 2. Define your model
-class Users < EmeraldODM::Collection
-  attr_accessor :_id, :name, :email, :age
+```
+
+## 2. Define your model
+```ruby
+require 'emerald_odm'
+# Define a model for the "users" collection
+class User < EmeraldODM::Collection
   
+  attr_accessor :_id, :name, :email, :posts, :keywords_count
+
   def self.collection_name
     :users
   end
   
   def self.db_name
-    :test
+    :blog
+  end
+  
+  def self.posts=(posts)
+    @posts = posts.map { |post| Post.new(post)}
   end
+  
+  class Post < EmeraldODM::AttrInitializer
+    attr_accessor :id, :title, :body, :created_at, :updated_at
+    
+    def created_at
+      Time.parse(@created_at)
+    end
+
+    def updated_at
+      Time.parse(@updated_at)
+    end
+    
+    def keywords
+      body.scan(/\w+/)
+    end
+  end
+  
 end
 
-# 3. Use it
-Users.find(filter: {_id: '5c9b9b9b9b9b9b9b9b9b9b9b'}).first
-
-Users.update_one(filter: {_id: '5c9b9b9b9b9b9b9b9b9b9b9b'}, set: {name: 'John Doe'}, unset: {age: 1})
 ```
 
-## Contributing
+## 3. Use it
+```ruby
+# Find users using a query
+users = User.find(
+  {name: 'John Doe'}, # filter query is required
+  projection: {name: 1, email: 1, posts: 1, keywords_count: 1}, # optional, the default is to return all fields defined in the model
+  limit: 10, # optional, the default is to return all documents
+  sort: {name: 1} # optional
+)
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/MikaelSantilio/emerald-odm.
+# users is an array of User objects like Array<User>
+users.each do |user|
+  posts = user.posts
+  all_user_keywords = posts.map(&:keywords).flatten.uniq
+  User.update_one(
+    {_id: user._id},
+    set: {keywords_count: all_user_keywords.count}
+  )
+end
+```
+
+# Advanced usage
+EmeraldODM supports advanced usage such as:
 
+## Accessing the underlying MongoDB driver
+```ruby
+User.collection # returns the underlying MongoDB::Collection object
+```
 
-## License
+# Contributing
+Bug reports and pull requests are welcome on GitHub at https://github.com/MikaelSantilio/emerald-odm/.
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+# License
+The gem is available as open source under the terms of the MIT License.

data/lib/emerald_odm/version.rb

@@ -1,3 +1,3 @@
 module EmeraldODM
-  VERSION = '1.1.1'
+  VERSION = '1.2.1'
 end

data/lib/emerald_odm.rb

@@ -79,7 +79,7 @@ module EmeraldODM
     # @param [Hash] sort The sort
     # @param [Integer] limit The limit
     # @return [Array<self>] The documents
-    def find(filter: {}, projection: {}, sort: {}, limit: 0)
+    def find(filter, projection: {}, sort: {}, limit: 0)
       self.class.validate_fields_from_stages(filter, projection, sort)
 
       if projection.empty?
@@ -93,8 +93,8 @@ module EmeraldODM
       query.to_a.map { |document| self.class.new(document) }
     end
 
-    def self.find(filter: {}, projection: {}, sort: {}, limit: 0)
-      new({}).find(filter: filter, projection: projection, sort: sort, limit: limit)
+    def self.find(filter, projection: {}, sort: {}, limit: 0)
+      new({}).find(filter, projection: projection, sort: sort, limit: limit)
     end
 
     def self.update(type, filter, set: {}, unset: {})

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: emerald_odm
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.1
 platform: ruby
 authors:
 - mikael
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-01-21 00:00:00.000000000 Z
+date: 2023-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler