emerald_odm 1.0.1 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bcf3882c777f9cb8c824984d2eefaf5b4abdcc442439c2ab0bdcaa41a1c50177
-  data.tar.gz: 2e2b31d76322c32bdb3c8147152151d94c7570653108f47a9d1486914335a3b8
+  metadata.gz: 801a45bf7c2940c3547f9260d255c47b2b87fc8becad126899ea1e8c078aaf00
+  data.tar.gz: de2e365a5c4e60dc4c79766ff624f8300e84245d09c6937169e7fa98c23771f3
 SHA512:
-  metadata.gz: 168688c5ae6ccce8007d462b6b352a5ef237f403091b96159da32548a4e684b92b8222956140875aace4f1ad3629882e7b11f7967b592deececf54732985b3ea
-  data.tar.gz: 055e466d0dd48a9cc002e0c294921096b2741ef5c77ef4f15202c08377eee5d32686be7e91522241631eb7688fa8dfe2f1cfdb6a4f310be8df0c9f3ed6b03f8e
+  metadata.gz: 40df24b7d653f85b7707d212ef97d661f196e3f3b96cd7dc6a7c735cd74bd44acc2708dc2700e894288f5fc9c12a4d818c7896315e353758b44381797f639f85
+  data.tar.gz: '08e0a9504e115b9d296689b4467147b34f2a74cf8e9d3d7d4ea20788e504de2be38d65f72bd83b835fd893a6adcc89df6197dc7352f2e2a5f6965f50c437ffb2'

data/.gitignore

@@ -7,6 +7,8 @@
 /spec/reports/
 /tmp/
 .idea
+*.gem
+.ruby-version
 
 # rspec failure tracking
 .rspec_status

data/README.md

@@ -1,40 +1,121 @@
-# Emerald::Orm
+# 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.
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/emerald/orm`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
-
-## Installation
-
-Add this line to your application's Gemfile:
+The main objective of this gem is primarily to facilitate reading data from a MongoDB database.
 
+# Installation
+To install EmeraldODM, simply add it to your Gemfile:
 ```ruby
-gem 'emerald-orm'
+gem 'emerald_odm'
 ```
+Then run bundle install to install the gem and its dependencies.
 
-And then execute:
-
-    $ bundle install
+# Usage
+Here's a quick example of how to use EmeraldODM to interact with a MongoDB database:
 
-Or install it yourself as:
-
-    $ gem install emerald-orm
-
-## Usage
-
-TODO: Write usage instructions here
+## 1. Setup DB connection
+```ruby
+require 'emerald_odm'
+
+# Connect to the MongoDB servers before using EmeraldODM
+EmeraldODM.databases_settings.merge!(
+  {
+    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,
+      }
+    ],
+  }
+)
 
-## Development
+```
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+## 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
+    :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
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+```
 
-## 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
+)
+
+# 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
+```
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/emerald-orm.
+# 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.0.1'
+  VERSION = '1.2.1'
 end

data/lib/emerald_odm.rb

@@ -24,8 +24,7 @@ module EmeraldODM
     end
   end
 
-  class Collection
-
+  class AttrInitializer
     attr_reader :document
 
     def initialize(document)
@@ -36,14 +35,6 @@ module EmeraldODM
       instance_variable_set('@document', document)
     end
 
-    # @return [Symbol, nil]
-    def self.db_name
-      nil
-    end
-    # @return [Symbol, nil]
-    def self.collection_name
-      nil
-    end
     # @return [Array]
     def self.fields
       public_instance_methods = self.public_instance_methods(false).grep(/=$/)
@@ -57,6 +48,23 @@ module EmeraldODM
       fields
     end
 
+    def nil?
+      document.nil? || document.empty?
+    end
+  end
+
+  class Collection < AttrInitializer
+
+    # @return [Symbol, nil]
+    def self.db_name
+      nil
+    end
+
+    # @return [Symbol, nil]
+    def self.collection_name
+      nil
+    end
+
     # @return [Mongo::Collection] The collection
     def self.collection
       Connector.database(db_name&.to_sym)[collection_name&.to_sym]
@@ -71,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?
@@ -85,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.0.1
+  version: 1.2.1
 platform: ruby
 authors:
 - mikael
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-01-18 00:00:00.000000000 Z
+date: 2023-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -145,7 +145,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: MongoDB ODM