emerald_odm 1.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +12 -0
- data/.rspec +3 -0
- data/Gemfile +5 -0
- data/LICENSE.txt +21 -0
- data/README.md +40 -0
- data/emerald_odm.gemspec +41 -0
- data/lib/emerald_odm/version.rb +3 -0
- data/lib/emerald_odm.rb +154 -0
- metadata +152 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: bcf3882c777f9cb8c824984d2eefaf5b4abdcc442439c2ab0bdcaa41a1c50177
|
4
|
+
data.tar.gz: 2e2b31d76322c32bdb3c8147152151d94c7570653108f47a9d1486914335a3b8
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 168688c5ae6ccce8007d462b6b352a5ef237f403091b96159da32548a4e684b92b8222956140875aace4f1ad3629882e7b11f7967b592deececf54732985b3ea
|
7
|
+
data.tar.gz: 055e466d0dd48a9cc002e0c294921096b2741ef5c77ef4f15202c08377eee5d32686be7e91522241631eb7688fa8dfe2f1cfdb6a4f310be8df0c9f3ed6b03f8e
|
data/.gitignore
ADDED
data/.rspec
ADDED
data/Gemfile
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
The MIT License (MIT)
|
2
|
+
|
3
|
+
Copyright (c) 2022 mikael
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
7
|
+
in the Software without restriction, including without limitation the rights
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
10
|
+
furnished to do so, subject to the following conditions:
|
11
|
+
|
12
|
+
The above copyright notice and this permission notice shall be included in
|
13
|
+
all copies or substantial portions of the Software.
|
14
|
+
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
21
|
+
THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,40 @@
|
|
1
|
+
# Emerald::Orm
|
2
|
+
|
3
|
+
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.
|
4
|
+
|
5
|
+
TODO: Delete this and the text above, and describe your gem
|
6
|
+
|
7
|
+
## Installation
|
8
|
+
|
9
|
+
Add this line to your application's Gemfile:
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
gem 'emerald-orm'
|
13
|
+
```
|
14
|
+
|
15
|
+
And then execute:
|
16
|
+
|
17
|
+
$ bundle install
|
18
|
+
|
19
|
+
Or install it yourself as:
|
20
|
+
|
21
|
+
$ gem install emerald-orm
|
22
|
+
|
23
|
+
## Usage
|
24
|
+
|
25
|
+
TODO: Write usage instructions here
|
26
|
+
|
27
|
+
## Development
|
28
|
+
|
29
|
+
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.
|
30
|
+
|
31
|
+
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).
|
32
|
+
|
33
|
+
## Contributing
|
34
|
+
|
35
|
+
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/emerald-orm.
|
36
|
+
|
37
|
+
|
38
|
+
## License
|
39
|
+
|
40
|
+
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
|
data/emerald_odm.gemspec
ADDED
@@ -0,0 +1,41 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
|
5
|
+
require_relative 'lib/emerald_odm/version'
|
6
|
+
|
7
|
+
Gem::Specification.new do |spec|
|
8
|
+
spec.name = 'emerald_odm'
|
9
|
+
spec.version = EmeraldODM::VERSION
|
10
|
+
spec.authors = ['mikael']
|
11
|
+
spec.email = ['mikael.santilio@gmail.com']
|
12
|
+
|
13
|
+
spec.summary = 'MongoDB ODM'
|
14
|
+
spec.description = 'Simple MongoDB ODM'
|
15
|
+
spec.homepage = 'https://github.com/MikaelSantilio/emerald-odm'
|
16
|
+
spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
|
17
|
+
|
18
|
+
spec.metadata['allowed_push_host'] = 'https://rubygems.org'
|
19
|
+
|
20
|
+
spec.metadata['homepage_uri'] = spec.homepage
|
21
|
+
spec.metadata['source_code_uri'] = 'https://github.com/MikaelSantilio/emerald-odm'
|
22
|
+
|
23
|
+
# Specify which files should be added to the gem when it is released.
|
24
|
+
# The `git ls-files -z` loads the files in the RubyGem that have been added into git.
|
25
|
+
spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
|
26
|
+
`git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
|
27
|
+
end
|
28
|
+
spec.bindir = 'exe'
|
29
|
+
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
|
30
|
+
spec.require_paths = ['lib']
|
31
|
+
|
32
|
+
spec.add_development_dependency 'bundler'
|
33
|
+
spec.add_development_dependency 'rake'
|
34
|
+
spec.add_development_dependency 'rspec'
|
35
|
+
spec.add_development_dependency 'dotenv'
|
36
|
+
spec.add_development_dependency 'pry'
|
37
|
+
spec.add_development_dependency 'simplecov'
|
38
|
+
|
39
|
+
spec.add_dependency 'mongo'
|
40
|
+
|
41
|
+
end
|
data/lib/emerald_odm.rb
ADDED
@@ -0,0 +1,154 @@
|
|
1
|
+
require 'emerald_odm/version'
|
2
|
+
require 'mongo'
|
3
|
+
|
4
|
+
module EmeraldODM
|
5
|
+
|
6
|
+
def self.databases_settings
|
7
|
+
@databases_settings ||= {}
|
8
|
+
end
|
9
|
+
|
10
|
+
module Connector
|
11
|
+
|
12
|
+
# @return [Mongo::Client] The database client
|
13
|
+
def self.database(db_name)
|
14
|
+
if databases_instances[db_name].nil?
|
15
|
+
db_settings = EmeraldODM.databases_settings[db_name]
|
16
|
+
raise Exceptions::MissingDatabaseSettings.new("Database settings not found for #{db_name}") if db_settings.nil? || db_settings.empty?
|
17
|
+
self.databases_instances[db_name] = Mongo::Client.new(*db_settings)
|
18
|
+
end
|
19
|
+
databases_instances[db_name]
|
20
|
+
end
|
21
|
+
|
22
|
+
def self.databases_instances
|
23
|
+
@databases_instances ||= {}
|
24
|
+
end
|
25
|
+
end
|
26
|
+
|
27
|
+
class Collection
|
28
|
+
|
29
|
+
attr_reader :document
|
30
|
+
|
31
|
+
def initialize(document)
|
32
|
+
self.class.fields.each do |field|
|
33
|
+
document_value = document[field]
|
34
|
+
send("#{field}=", document_value) unless document_value.nil?
|
35
|
+
end
|
36
|
+
instance_variable_set('@document', document)
|
37
|
+
end
|
38
|
+
|
39
|
+
# @return [Symbol, nil]
|
40
|
+
def self.db_name
|
41
|
+
nil
|
42
|
+
end
|
43
|
+
# @return [Symbol, nil]
|
44
|
+
def self.collection_name
|
45
|
+
nil
|
46
|
+
end
|
47
|
+
# @return [Array]
|
48
|
+
def self.fields
|
49
|
+
public_instance_methods = self.public_instance_methods(false).grep(/=$/)
|
50
|
+
rejected_attr_names = %w[document]
|
51
|
+
fields = []
|
52
|
+
public_instance_methods.each do |attr|
|
53
|
+
attr_name = attr.to_s.gsub('=', '')
|
54
|
+
next if rejected_attr_names.include?(attr_name)
|
55
|
+
fields << attr_name
|
56
|
+
end
|
57
|
+
fields
|
58
|
+
end
|
59
|
+
|
60
|
+
# @return [Mongo::Collection] The collection
|
61
|
+
def self.collection
|
62
|
+
Connector.database(db_name&.to_sym)[collection_name&.to_sym]
|
63
|
+
end
|
64
|
+
|
65
|
+
def self.is_valid_fields?(query_fields)
|
66
|
+
(query_fields - fields).count == 0
|
67
|
+
end
|
68
|
+
|
69
|
+
# @param [Hash] filter The filter
|
70
|
+
# @param [Hash] projection The projection
|
71
|
+
# @param [Hash] sort The sort
|
72
|
+
# @param [Integer] limit The limit
|
73
|
+
# @return [Array<self>] The documents
|
74
|
+
def find(filter: {}, projection: {}, sort: {}, limit: 0)
|
75
|
+
self.class.validate_fields_from_stages(filter, projection, sort)
|
76
|
+
|
77
|
+
if projection.empty?
|
78
|
+
projection = self.class.fields.map { |field| [field, 1] }.to_h
|
79
|
+
end
|
80
|
+
|
81
|
+
query = self.class.collection.find(filter).projection(projection).sort(sort)
|
82
|
+
if limit > 0
|
83
|
+
query = query.limit(limit)
|
84
|
+
end
|
85
|
+
query.to_a.map { |document| self.class.new(document) }
|
86
|
+
end
|
87
|
+
|
88
|
+
def self.find(filter: {}, projection: {}, sort: {}, limit: 0)
|
89
|
+
new({}).find(filter: filter, projection: projection, sort: sort, limit: limit)
|
90
|
+
end
|
91
|
+
|
92
|
+
def self.update(type, filter, set: {}, unset: {})
|
93
|
+
validate_fields_from_stages(filter, set, unset)
|
94
|
+
update = {}
|
95
|
+
update[:'$set'] = set unless set.empty?
|
96
|
+
update[:'$unset'] = unset unless unset.empty?
|
97
|
+
|
98
|
+
if update.empty?
|
99
|
+
raise 'Update without set or unset'
|
100
|
+
elsif filter.empty?
|
101
|
+
raise 'Update without filter'
|
102
|
+
end
|
103
|
+
|
104
|
+
if type == :one
|
105
|
+
update_response = collection.update_one(filter, update).to_a
|
106
|
+
elsif type == :many
|
107
|
+
update_response = collection.update_many(filter, update).to_a
|
108
|
+
else
|
109
|
+
raise 'Invalid type'
|
110
|
+
end
|
111
|
+
|
112
|
+
update_response.first
|
113
|
+
end
|
114
|
+
|
115
|
+
def self.update_one(filter, set: {}, unset: {})
|
116
|
+
update(:one, filter, set: set, unset: unset)
|
117
|
+
end
|
118
|
+
|
119
|
+
def self.update_many(filter, set: {}, unset: {})
|
120
|
+
update(:many, filter, set: set, unset: unset)
|
121
|
+
end
|
122
|
+
|
123
|
+
def self.validate_fields_from_stages(*stages)
|
124
|
+
validate_dollar_stages(*stages)
|
125
|
+
validate_common_stages(*stages)
|
126
|
+
end
|
127
|
+
|
128
|
+
def self.validate_dollar_stages(*stages)
|
129
|
+
known_dollar_stages = %w[$and $or $in]
|
130
|
+
formatted_stages = stages.map { |stage| stage.keys }.flatten.uniq.map{|k| k.to_s}.select{|k| k.start_with?('$')}
|
131
|
+
unless (formatted_stages - known_dollar_stages).empty?
|
132
|
+
raise "Invalid dollar stages: #{(formatted_stages - known_dollar_stages)}"
|
133
|
+
end
|
134
|
+
end
|
135
|
+
|
136
|
+
def self.validate_common_stages(*stages)
|
137
|
+
formatted_stages = stages.map { |stage| stage.keys }.flatten.uniq.map{|k| k.to_s}.reject{|k| k.start_with?('$')}
|
138
|
+
formatted_stages = formatted_stages.map{|f| f.to_s.split('.').first}.uniq
|
139
|
+
unless is_valid_fields?(formatted_stages)
|
140
|
+
raise "Invalid fields: #{(formatted_stages - self.fields)}"
|
141
|
+
end
|
142
|
+
end
|
143
|
+
|
144
|
+
end
|
145
|
+
|
146
|
+
module Exceptions
|
147
|
+
class InvalidFields < StandardError; end
|
148
|
+
class InvalidUpdateType < StandardError; end
|
149
|
+
class EmptyFilter < StandardError; end
|
150
|
+
class EmptyUpdate < StandardError; end
|
151
|
+
class MissingDatabaseSettings < StandardError; end
|
152
|
+
end
|
153
|
+
end
|
154
|
+
|
metadata
ADDED
@@ -0,0 +1,152 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: emerald_odm
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 1.0.1
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- mikael
|
8
|
+
autorequire:
|
9
|
+
bindir: exe
|
10
|
+
cert_chain: []
|
11
|
+
date: 2023-01-18 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: bundler
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - ">="
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '0'
|
20
|
+
type: :development
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - ">="
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '0'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: rake
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - ">="
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '0'
|
34
|
+
type: :development
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - ">="
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '0'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: rspec
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - ">="
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '0'
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - ">="
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '0'
|
55
|
+
- !ruby/object:Gem::Dependency
|
56
|
+
name: dotenv
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
58
|
+
requirements:
|
59
|
+
- - ">="
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: '0'
|
62
|
+
type: :development
|
63
|
+
prerelease: false
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - ">="
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: '0'
|
69
|
+
- !ruby/object:Gem::Dependency
|
70
|
+
name: pry
|
71
|
+
requirement: !ruby/object:Gem::Requirement
|
72
|
+
requirements:
|
73
|
+
- - ">="
|
74
|
+
- !ruby/object:Gem::Version
|
75
|
+
version: '0'
|
76
|
+
type: :development
|
77
|
+
prerelease: false
|
78
|
+
version_requirements: !ruby/object:Gem::Requirement
|
79
|
+
requirements:
|
80
|
+
- - ">="
|
81
|
+
- !ruby/object:Gem::Version
|
82
|
+
version: '0'
|
83
|
+
- !ruby/object:Gem::Dependency
|
84
|
+
name: simplecov
|
85
|
+
requirement: !ruby/object:Gem::Requirement
|
86
|
+
requirements:
|
87
|
+
- - ">="
|
88
|
+
- !ruby/object:Gem::Version
|
89
|
+
version: '0'
|
90
|
+
type: :development
|
91
|
+
prerelease: false
|
92
|
+
version_requirements: !ruby/object:Gem::Requirement
|
93
|
+
requirements:
|
94
|
+
- - ">="
|
95
|
+
- !ruby/object:Gem::Version
|
96
|
+
version: '0'
|
97
|
+
- !ruby/object:Gem::Dependency
|
98
|
+
name: mongo
|
99
|
+
requirement: !ruby/object:Gem::Requirement
|
100
|
+
requirements:
|
101
|
+
- - ">="
|
102
|
+
- !ruby/object:Gem::Version
|
103
|
+
version: '0'
|
104
|
+
type: :runtime
|
105
|
+
prerelease: false
|
106
|
+
version_requirements: !ruby/object:Gem::Requirement
|
107
|
+
requirements:
|
108
|
+
- - ">="
|
109
|
+
- !ruby/object:Gem::Version
|
110
|
+
version: '0'
|
111
|
+
description: Simple MongoDB ODM
|
112
|
+
email:
|
113
|
+
- mikael.santilio@gmail.com
|
114
|
+
executables: []
|
115
|
+
extensions: []
|
116
|
+
extra_rdoc_files: []
|
117
|
+
files:
|
118
|
+
- ".gitignore"
|
119
|
+
- ".rspec"
|
120
|
+
- Gemfile
|
121
|
+
- LICENSE.txt
|
122
|
+
- README.md
|
123
|
+
- emerald_odm.gemspec
|
124
|
+
- lib/emerald_odm.rb
|
125
|
+
- lib/emerald_odm/version.rb
|
126
|
+
homepage: https://github.com/MikaelSantilio/emerald-odm
|
127
|
+
licenses: []
|
128
|
+
metadata:
|
129
|
+
allowed_push_host: https://rubygems.org
|
130
|
+
homepage_uri: https://github.com/MikaelSantilio/emerald-odm
|
131
|
+
source_code_uri: https://github.com/MikaelSantilio/emerald-odm
|
132
|
+
post_install_message:
|
133
|
+
rdoc_options: []
|
134
|
+
require_paths:
|
135
|
+
- lib
|
136
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
137
|
+
requirements:
|
138
|
+
- - ">="
|
139
|
+
- !ruby/object:Gem::Version
|
140
|
+
version: 2.5.0
|
141
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
142
|
+
requirements:
|
143
|
+
- - ">="
|
144
|
+
- !ruby/object:Gem::Version
|
145
|
+
version: '0'
|
146
|
+
requirements: []
|
147
|
+
rubyforge_project:
|
148
|
+
rubygems_version: 2.7.7
|
149
|
+
signing_key:
|
150
|
+
specification_version: 4
|
151
|
+
summary: MongoDB ODM
|
152
|
+
test_files: []
|