emerald_odm 1.1.1 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5730dcce3f54aca15736e052c5a98a758d0d691b243e544f406de15c7d1cbbb4
-  data.tar.gz: 3814ee64675fe80d44e96a15ff17e05d849c71f44477c607a388a7c3f9863a53
+  metadata.gz: 58be3d671b46d8703d0308a6921e515a6b68e38da855a766c25bc01c9435c4c4
+  data.tar.gz: 8d6aa735ce20df9d627408d79d527774bd9dab8b40df5c6477053a4503b15c3d
 SHA512:
-  metadata.gz: b6b884d39e9b34f8a13237413753fbfe5265e51f463a93befe6c4b848b8bce379f37cfb84103f425788042b6480a138f4a51e87fffb039d77a6ae01b5d8f9bcf
-  data.tar.gz: 751d69add77372aa90f657d4a6802f1794391f7155ff9451a019750704e6cf84c125212a9c97d41e5049ce9bed26e9e379ccf1d693ddce3797c37525321f4b6c
+  metadata.gz: 380ad74efa2cdd7eeca559c3a1fcd66fa3546b2abfa3812d4ea6e82621d90c73bc019551506a4b5aae6a01a8ef8fb3e8b6381cb8213bb450e289b2487eddf440
+  data.tar.gz: 01047b0d65a1c6067c24d967f6b300bbda7b7550915da8c96138da875ea23919caad7f59e596a7aa1fed9d02c1c1a98aedb8f55acddc9ddeebc7f03e2c8a5243

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/emerald_odm.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.email         = ['mikael.santilio@gmail.com']
 
   spec.summary       = 'MongoDB ODM'
-  spec.description   = 'Simple MongoDB ODM'
+  spec.description   = 'A simple MongoDB ODM without Active Record'
   spec.homepage      = 'https://github.com/MikaelSantilio/emerald-odm'
   spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
 

data/lib/emerald_odm/version.rb

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

data/lib/emerald_odm.rb

@@ -25,20 +25,20 @@ module EmeraldODM
   end
 
   class AttrInitializer
-    attr_reader :document
+    attr_reader :_document
 
     def initialize(document)
       self.class.fields.each do |field|
         document_value = document[field]
         send("#{field}=", document_value) unless document_value.nil?
       end
-      instance_variable_set('@document', document)
+      instance_variable_set('@_document', document)
     end
 
     # @return [Array]
     def self.fields
       public_instance_methods = self.public_instance_methods(false).grep(/=$/)
-      rejected_attr_names = %w[document]
+      rejected_attr_names = %w[_document]
       fields = []
       public_instance_methods.each do |attr|
         attr_name = attr.to_s.gsub('=', '')
@@ -51,6 +51,41 @@ module EmeraldODM
     def nil?
       document.nil? || document.empty?
     end
+
+    def self.array_to_h(array)
+      array.map do |item|
+        if item.is_a?(AttrInitializer)
+          item.to_h
+        elsif item.is_a?(Array)
+          array_to_h(item)
+        else
+          item
+        end
+      end
+    end
+
+    def to_h
+      hash = {}
+      known_fields = self.class.fields
+      unknown_fields = document.keys - known_fields
+      unknown_fields.reject! { |field| field.start_with?('_') }
+      known_fields.each do |field|
+        value = send(field)
+        if value.is_a?(AttrInitializer)
+          hash[field] = value.to_h
+        elsif value.is_a?(Array)
+          hash[field] = self.class.array_to_h(value)
+        else
+          hash[field] = value
+        end
+      end
+      unknown_fields.each do |field|
+        value = document[field]
+        hash[field] = value
+      end
+
+      hash
+    end
   end
 
   class Collection < AttrInitializer
@@ -79,7 +114,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 +128,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.3.1
 platform: ruby
 authors:
 - mikael
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-01-21 00:00:00.000000000 Z
+date: 2023-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -108,7 +108,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Simple MongoDB ODM
+description: A simple MongoDB ODM without Active Record
 email:
 - mikael.santilio@gmail.com
 executables: []
@@ -145,7 +145,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: MongoDB ODM