emerald_odm 1.0.1 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bcf3882c777f9cb8c824984d2eefaf5b4abdcc442439c2ab0bdcaa41a1c50177
-  data.tar.gz: 2e2b31d76322c32bdb3c8147152151d94c7570653108f47a9d1486914335a3b8
+  metadata.gz: 5730dcce3f54aca15736e052c5a98a758d0d691b243e544f406de15c7d1cbbb4
+  data.tar.gz: 3814ee64675fe80d44e96a15ff17e05d849c71f44477c607a388a7c3f9863a53
 SHA512:
-  metadata.gz: 168688c5ae6ccce8007d462b6b352a5ef237f403091b96159da32548a4e684b92b8222956140875aace4f1ad3629882e7b11f7967b592deececf54732985b3ea
-  data.tar.gz: 055e466d0dd48a9cc002e0c294921096b2741ef5c77ef4f15202c08377eee5d32686be7e91522241631eb7688fa8dfe2f1cfdb6a4f310be8df0c9f3ed6b03f8e
+  metadata.gz: b6b884d39e9b34f8a13237413753fbfe5265e51f463a93befe6c4b848b8bce379f37cfb84103f425788042b6480a138f4a51e87fffb039d77a6ae01b5d8f9bcf
+  data.tar.gz: 751d69add77372aa90f657d4a6802f1794391f7155ff9451a019750704e6cf84c125212a9c97d41e5049ce9bed26e9e379ccf1d693ddce3797c37525321f4b6c

data/.gitignore

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

data/README.md

@@ -1,38 +1,58 @@
-# Emerald::Orm
+# EmeraldODM
 
-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.
+EmeraldODM is an simple ODM (Object-Document Mapper) framework for MongoDB in Ruby.
 
-TODO: Delete this and the text above, and describe your gem
 
-## Installation
 
-Add this line to your application's Gemfile:
+## Installation
 
-```ruby
-gem 'emerald-orm'
+```bash
+gem install emerald_odm
 ```
 
-And then execute:
-
-    $ bundle install
-
-Or install it yourself as:
-
-    $ gem install emerald-orm
-
 ## Usage
 
-TODO: Write usage instructions here
-
-## 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.
-
-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).
+```ruby
+require 'emerald_odm'
+
+# 1. Setup DB connection
+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,
+        }
+    ]
+  }
+)
+
+# 2. Define your model
+class Users < EmeraldODM::Collection
+  attr_accessor :_id, :name, :email, :age
+  
+  def self.collection_name
+    :users
+  end
+  
+  def self.db_name
+    :test
+  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
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/emerald-orm.
+Bug reports and pull requests are welcome on GitHub at https://github.com/MikaelSantilio/emerald-odm.
 
 
 ## License

data/lib/emerald_odm/version.rb

@@ -1,3 +1,3 @@
 module EmeraldODM
-  VERSION = '1.0.1'
+  VERSION = '1.1.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]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: emerald_odm
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.1
 platform: ruby
 authors:
 - mikael
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-01-18 00:00:00.000000000 Z
+date: 2023-01-21 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