emerald_odm 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bcf3882c777f9cb8c824984d2eefaf5b4abdcc442439c2ab0bdcaa41a1c50177
+  data.tar.gz: 2e2b31d76322c32bdb3c8147152151d94c7570653108f47a9d1486914335a3b8
+SHA512:
+  metadata.gz: 168688c5ae6ccce8007d462b6b352a5ef237f403091b96159da32548a4e684b92b8222956140875aace4f1ad3629882e7b11f7967b592deececf54732985b3ea
+  data.tar.gz: 055e466d0dd48a9cc002e0c294921096b2741ef5c77ef4f15202c08377eee5d32686be7e91522241631eb7688fa8dfe2f1cfdb6a4f310be8df0c9f3ed6b03f8e

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.idea
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in emerald-orm.gemspec
+gemspec
+

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 mikael
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,40 @@
+# Emerald::Orm
+
+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:
+
+```ruby
+gem 'emerald-orm'
+```
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/emerald-orm.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/emerald_odm.gemspec

@@ -0,0 +1,41 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require_relative 'lib/emerald_odm/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'emerald_odm'
+  spec.version       = EmeraldODM::VERSION
+  spec.authors       = ['mikael']
+  spec.email         = ['mikael.santilio@gmail.com']
+
+  spec.summary       = 'MongoDB ODM'
+  spec.description   = 'Simple MongoDB ODM'
+  spec.homepage      = 'https://github.com/MikaelSantilio/emerald-odm'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/MikaelSantilio/emerald-odm'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'dotenv'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'simplecov'
+
+  spec.add_dependency 'mongo'
+
+end

data/lib/emerald_odm/version.rb

@@ -0,0 +1,3 @@
+module EmeraldODM
+  VERSION = '1.0.1'
+end

data/lib/emerald_odm.rb

@@ -0,0 +1,154 @@
+require 'emerald_odm/version'
+require 'mongo'
+
+module EmeraldODM
+
+  def self.databases_settings
+    @databases_settings ||= {}
+  end
+
+  module Connector
+
+    # @return [Mongo::Client] The database client
+    def self.database(db_name)
+      if databases_instances[db_name].nil?
+        db_settings = EmeraldODM.databases_settings[db_name]
+        raise Exceptions::MissingDatabaseSettings.new("Database settings not found for #{db_name}") if db_settings.nil? || db_settings.empty?
+        self.databases_instances[db_name] = Mongo::Client.new(*db_settings)
+      end
+      databases_instances[db_name]
+    end
+
+    def self.databases_instances
+      @databases_instances ||= {}
+    end
+  end
+
+  class Collection
+
+    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)
+    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(/=$/)
+      rejected_attr_names = %w[document]
+      fields = []
+      public_instance_methods.each do |attr|
+        attr_name = attr.to_s.gsub('=', '')
+        next if rejected_attr_names.include?(attr_name)
+        fields << attr_name
+      end
+      fields
+    end
+
+    # @return [Mongo::Collection] The collection
+    def self.collection
+      Connector.database(db_name&.to_sym)[collection_name&.to_sym]
+    end
+
+    def self.is_valid_fields?(query_fields)
+      (query_fields - fields).count == 0
+    end
+
+    # @param [Hash] filter The filter
+    # @param [Hash] projection The projection
+    # @param [Hash] sort The sort
+    # @param [Integer] limit The limit
+    # @return [Array<self>] The documents
+    def find(filter: {}, projection: {}, sort: {}, limit: 0)
+      self.class.validate_fields_from_stages(filter, projection, sort)
+
+      if projection.empty?
+        projection = self.class.fields.map { |field| [field, 1] }.to_h
+      end
+
+      query = self.class.collection.find(filter).projection(projection).sort(sort)
+      if limit > 0
+        query = query.limit(limit)
+      end
+      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)
+    end
+
+    def self.update(type, filter, set: {}, unset: {})
+      validate_fields_from_stages(filter, set, unset)
+      update = {}
+      update[:'$set'] = set unless set.empty?
+      update[:'$unset'] = unset unless unset.empty?
+
+      if update.empty?
+        raise 'Update without set or unset'
+      elsif filter.empty?
+        raise 'Update without filter'
+      end
+
+      if type == :one
+        update_response = collection.update_one(filter, update).to_a
+      elsif type == :many
+        update_response = collection.update_many(filter, update).to_a
+      else
+        raise 'Invalid type'
+      end
+
+      update_response.first
+    end
+
+    def self.update_one(filter, set: {}, unset: {})
+      update(:one, filter, set: set, unset: unset)
+    end
+
+    def self.update_many(filter, set: {}, unset: {})
+      update(:many, filter, set: set, unset: unset)
+    end
+
+    def self.validate_fields_from_stages(*stages)
+      validate_dollar_stages(*stages)
+      validate_common_stages(*stages)
+    end
+
+    def self.validate_dollar_stages(*stages)
+      known_dollar_stages = %w[$and $or $in]
+      formatted_stages = stages.map { |stage| stage.keys }.flatten.uniq.map{|k| k.to_s}.select{|k| k.start_with?('$')}
+      unless (formatted_stages - known_dollar_stages).empty?
+        raise "Invalid dollar stages: #{(formatted_stages - known_dollar_stages)}"
+      end
+    end
+
+    def self.validate_common_stages(*stages)
+      formatted_stages = stages.map { |stage| stage.keys }.flatten.uniq.map{|k| k.to_s}.reject{|k| k.start_with?('$')}
+      formatted_stages = formatted_stages.map{|f| f.to_s.split('.').first}.uniq
+      unless is_valid_fields?(formatted_stages)
+        raise "Invalid fields: #{(formatted_stages - self.fields)}"
+      end
+    end
+
+  end
+
+  module Exceptions
+    class InvalidFields < StandardError; end
+    class InvalidUpdateType < StandardError; end
+    class EmptyFilter < StandardError; end
+    class EmptyUpdate < StandardError; end
+    class MissingDatabaseSettings < StandardError; end
+  end
+end
+

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: emerald_odm
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- mikael
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-01-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mongo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple MongoDB ODM
+email:
+- mikael.santilio@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- emerald_odm.gemspec
+- lib/emerald_odm.rb
+- lib/emerald_odm/version.rb
+homepage: https://github.com/MikaelSantilio/emerald-odm
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/MikaelSantilio/emerald-odm
+  source_code_uri: https://github.com/MikaelSantilio/emerald-odm
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: MongoDB ODM
+test_files: []