rom-mongodb 0.1.0

data/README.md

@@ -0,0 +1,110 @@
+# MongoDB adapter for Ruby Object Mapper
+
+[![Maintainability](https://api.codeclimate.com/v1/badges/5b38ebba392bd37f166b/maintainability)](https://codeclimate.com/github/bestwebua/rom-mongo/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/5b38ebba392bd37f166b/test_coverage)](https://codeclimate.com/github/bestwebua/rom-mongo/test_coverage)
+[![CircleCI](https://circleci.com/gh/bestwebua/rom-mongo/tree/master.svg?style=svg)](https://circleci.com/gh/bestwebua/rom-mongo/tree/master)
+[![Gem Version](https://badge.fury.io/rb/rom-mongodb.svg)](https://badge.fury.io/rb/rom-mongodb)
+[![Downloads](https://img.shields.io/gem/dt/rom-mongodb.svg?colorA=004d99&colorB=0073e6)](https://rubygems.org/gems/rom-mongodb)
+[![GitHub](https://img.shields.io/github/license/bestwebua/rom-mongo)](LICENSE.txt)
+[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v1.4%20adopted-ff69b4.svg)](CODE_OF_CONDUCT.md)
+
+`rom-mongodb` - MongoDB adapter for [ROM](https://rom-rb.org). What is ROM? It's a fast ruby persistence library with the goal of providing powerful object mapping capabilities without limiting the full power of the underlying datastore.
+
+## Table of Contents
+
+- [Requirements](#requirements)
+- [Installation](#installation)
+- [Usage](#usage)
+- [Contributing](#contributing)
+- [License](#license)
+- [Code of Conduct](#code-of-conduct)
+- [Credits](#credits)
+- [Versioning](#versioning)
+- [Changelog](CHANGELOG.md)
+
+## Requirements
+
+Ruby MRI 2.5.0+
+
+## Installation
+
+Add this line to your application's `Gemfile`:
+
+```ruby
+gem 'rom-mongodb'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rom-mongodb
+
+## Usage
+
+```ruby
+# Define your container with mongo adapter
+
+require 'mongo'
+require 'rom'
+require 'rom/mongodb'
+
+connection = Mongo::Client.new('mongodb://127.0.0.1:27017/your_db_name')
+container = ROM.container(:mongo, connection) do |config|
+  config.relation(:users) do
+    schema(:users) do
+      attribute :_id, ROM::Types.Nominal(BSON::ObjectId)
+      attribute :email, ROM::Types::String
+      attribute :rating, ROM::Types::Integer
+      attribute :status, ROM::Types::Bool
+    end
+  end
+end
+
+# Define your repository
+
+require 'rom/repository'
+
+User = ::Class.new(ROM::Repository[:users]) do
+  commands(:create, :delete, update: :by_pk)
+
+  def all
+    users.to_a
+  end
+
+  def find(**options)
+    users.find(options)
+  end
+end
+
+user_repository = User.new(container)
+
+# Now you can do some manipulations with your repository
+
+user_repository.create({ email: 'olo@domain.com', rating: 42, status: true })
+user_repository.all
+user_repository.find(email: 'olo@domain.com')
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/bestwebua/rom-mongo. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct. Please check the [open tickets](https://github.com/bestwebua/rom-mongo/issues). Be sure to follow Contributor Code of Conduct below and our [Contributing Guidelines](CONTRIBUTING.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the rom-mongodb project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](CODE_OF_CONDUCT.md).
+
+## Credits
+
+- [The Contributors](https://github.com/bestwebua/rom-mongo/graphs/contributors) for code and awesome suggestions
+- [The Stargazers](https://github.com/bestwebua/rom-mongo/stargazers) for showing their support
+
+## Versioning
+
+rom-mongodb uses [Semantic Versioning 2.0.0](https://semver.org)

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'rom/mongo'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rom/mongo/commands/create.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module ROM
+  module Mongo
+    module Commands
+      # Create command
+      #
+      # Inserts a new tuple into a relation
+      #
+      # @abstract
+      class Create < ROM::Commands::Create
+        include ROM::Mongo::Commands::Helper
+
+        adapter :mongo
+
+        # TODO: always returns :one, even more then one documents have created
+        # Research how to display :many needed
+
+        # Passes tuple to relation for insertion
+        #
+        # @param attributes [Hash]
+        #
+        # @return [Array<Hash>]
+        #
+        # @api public
+        def execute(*attributes)
+          ids = dataset.insert(*attributes)
+          return [] if ids.empty?
+
+          attributes.each_with_object([]).with_index do |(attribute, arr), index|
+            arr << { _id: ids[index], **attribute }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rom/mongo/commands/delete.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module ROM
+  module Mongo
+    module Commands
+      # Delete command
+      #
+      # Removes tuple from its target relation
+      #
+      # @abstract
+      class Delete < ROM::Commands::Delete
+        include ROM::Mongo::Commands::Helper
+
+        adapter :mongo
+
+        # Passes tuple to relation for deletion
+        #
+        # @param attributes [Hash]
+        #
+        # @return [Array<Hash>]
+        #
+        # @api public
+        def execute(attributes)
+          filtered_documents = dataset.find(pk.merge(attributes), projection)
+          document_snapshot = process_with_schema(filtered_documents.first)
+          return [document_snapshot] if filtered_documents.delete_one.deleted_count.eql?(1)
+
+          []
+        end
+      end
+    end
+  end
+end

data/lib/rom/mongo/commands/helper.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module ROM
+  module Mongo
+    module Commands
+      module Helper
+        private
+
+        # @api private
+        def dataset
+          relation.dataset
+        end
+
+        # @api private
+        def pk
+          return {} unless dataset.respond_to?(:filter)
+
+          dataset.filter.transform_keys(&:to_sym)
+        end
+
+        # @api private
+        def process_with_schema(attributes)
+          schema.to_output_hash.call(attributes)
+        end
+
+        # @api private
+        def schema
+          relation.schema
+        end
+
+        # @api private
+        def schema_attributes
+          schema
+            .attributes
+            .map(&:name)
+            .each_with_object({}) { |item, hash| hash[item] = true }
+        end
+
+        # @api private
+        def projection
+          { projection: schema_attributes }
+        end
+      end
+    end
+  end
+end

data/lib/rom/mongo/commands/update.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module ROM
+  module Mongo
+    module Commands
+      # Update command
+      #
+      # Updates tuple in its relation with new attributes
+      #
+      # @abstract
+      class Update < ROM::Commands::Update
+        include ROM::Mongo::Commands::Helper
+
+        adapter :mongo
+
+        # Passes tuple to relation for updation
+        #
+        # @param attributes [Hash]
+        #
+        # @return [Array<Hash>]
+        #
+        # @api public
+        def execute(attributes)
+          document = process_with_schema(pk.merge(attributes))
+          return [document] if dataset.collection.update_one(pk, attributes).modified_count.eql?(1)
+
+          []
+        end
+      end
+    end
+  end
+end

data/lib/rom/mongo/core.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'rom/core'
+
+module ROM
+  module Mongo
+    module Commands
+      require_relative '../mongo/commands/helper'
+      require_relative '../mongo/commands/create'
+      require_relative '../mongo/commands/update'
+      require_relative '../mongo/commands/delete'
+    end
+
+    require_relative '../mongo/version'
+    require_relative '../mongo/dataset'
+    require_relative '../mongo/gateway'
+    require_relative '../mongo/schema'
+    require_relative '../mongo/relation'
+  end
+end

data/lib/rom/mongo/dataset.rb

@@ -0,0 +1,161 @@
+# frozen_string_literal: true
+
+module ROM
+  module Mongo
+    # Class interfacing with the MongoDB Ruby driver
+    # Provides a DSL for constructing queries
+    class Dataset
+      # The collection object
+      #
+      # @return [Mongo::Collection] The collection object
+      #
+      # @api public
+      attr_reader :collection
+
+      # Initializes the Dataset object
+      #
+      # @example Create a Dataset object.
+      #   ROM::Mongo::Dataset.new(collection)
+      #
+      # @param [Mongo::Collection] collection The collection to run the operation on
+      #
+      # @api public
+      def initialize(collection)
+        @collection = collection
+      end
+
+      # Constructs a collection view with a given selector
+      #
+      # @example Define ascending order by the name
+      #   dataset_instance.find(
+      #     { company: 'Some Company' },
+      #     { projection: { _id: true, name: true, email: true, company: true } }
+      #   )
+      #
+      # @param [Hash] options The query criteria
+      # @param [Hash] projection The projection criteria
+      #
+      # @return [Mongo::Collection::View] The collection view object
+      #
+      # @api public
+      def find(options = {}, projection = {})
+        view(options, projection)
+      end
+
+      # Difines order for collection view
+      #
+      # @example Define ascending order by the name
+      #   dataset_instance.sort(name: 1)
+      #
+      # @param [Hash] attributes The order criteria.
+      #
+      # @return [Mongo::Collection::View] The collection view object
+      #
+      # @api public
+      def sort(attributes)
+        view.sort(attributes)
+      end
+
+      # Difines limit for collection view
+      #
+      # @example Define ascending order by the name
+      #   dataset_instance.limit(42)
+      #
+      # @param [Integer] count The limit criteria.
+      #
+      # @return [Mongo::Collection::View] The collection view object
+      #
+      # @api public
+      def limit(count)
+        view.limit(count)
+      end
+
+      # Difines skip for collection view
+      #
+      # @example Define ascending order by the name
+      #   dataset_instance.skip(2)
+      #
+      # @param [Integer] count The limit criteria
+      #
+      # @return [Mongo::Collection::View] The collection view object
+      #
+      # @api public
+      def skip(count)
+        view.skip(count)
+      end
+
+      # Difines interface to insert one or more new documents
+      #
+      # @example Inserting one document
+      #   dataset_instance.insert({ name: 'Some Name', email: 'olo@molo.com' })
+      #
+      # @example Inserting more than one document
+      #   dataset_instance.insert(
+      #     { name: 'One', email: 'olo@domain.com' },
+      #     { name: 'Two', email: 'molo@domain.com' }
+      #   )
+      #
+      # @param [Hash] attributes The attributes for new document
+      #
+      # @return [Array<String>] The array with inserted ids
+      #
+      # @api public
+      def insert(*attributes)
+        method_params =
+          attributes.one? ? [:insert_one, *attributes] : [:insert_many, attributes]
+        collection.public_send(*method_params).inserted_ids
+      end
+
+      # Difines count for collection view
+      #
+      # @example Define ascending order by the name
+      #   dataset_instance.count
+      #
+      # @return [Integer] The total count of documents
+      #
+      # @api public
+      def count
+        view.count
+      end
+
+      # Difines distinct for collection view
+      #
+      # @example Define ascending order by the name
+      #   dataset_instance.distinct(:some_attribute)
+      #
+      # @param [Symbol] attribute The document field name
+      #
+      # @return [Array<String>] The collection of uniq values by field name
+      #
+      # @api public
+      def distinct(attribute)
+        view.distinct(attribute)
+      end
+
+      # Difines view without options
+      #
+      # @return [Mongo::Collection::View] The collection view object
+      #
+      # @api public
+      def to_a
+        view
+      end
+
+      # @api private
+      def map(&block)
+        to_a.map(&block)
+      end
+
+      private
+
+      # Applies given options to the view
+      #
+      # @return [Mongo::Collection::View] The collection view object
+      #
+      # @api private
+      def view(options = {}, projection = {})
+        collection.find(options, projection)
+      end
+    end
+  end
+end

data/lib/rom/mongo/gateway.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module ROM
+  module Mongo
+    # Wrapping the mongo collections to dataset abstractions
+    # and passing them to the relations
+    #
+    # @abstract
+    class Gateway < ROM::Gateway
+      adapter :mongo
+
+      # Builded datasets
+      #
+      # @return [Hash] The hash with datasets
+      #
+      # @api public
+      attr_reader :datasets
+
+      # Initializes the Gateway object
+      #
+      # @example Create a Gateway object
+      #   ROM::Mongo::Gateway.new(client)
+      #
+      # @param [Mongo::Client] client The mongo client instance
+      #
+      # @api public
+      def initialize(client)
+        @client = client
+        @datasets = {}
+      end
+
+      # Buildes dataset with the given name
+      #
+      # @param [Symbol] name dataset name
+      #
+      # @param [Class] dataset_class dataset class
+      #
+      # @return [ROM::Mongo::Dataset]
+      #
+      # @api public
+      def dataset(name, dataset_class = ROM::Mongo::Dataset)
+        datasets[name] = dataset_class.new(client[name])
+      end
+
+      # Checkes if dataset exists
+      #
+      # @param [Symbol] name dataset name
+      #
+      # @return [true, false]
+      #
+      # @api public
+      def dataset?(name)
+        datasets.key?(name)
+      end
+
+      # Retrieves dataset with the given name
+      #
+      # @param [Symbol] name dataset name
+      #
+      # @return [ROM::Mongo::Dataset, nil]
+      #
+      # @api public
+      def [](name)
+        datasets[name]
+      end
+
+      private
+
+      # @api private
+      attr_reader :client
+    end
+  end
+end

data/lib/rom/mongo/relation.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module ROM
+  module Mongo
+    # Mongo specific relation extensions
+    class Relation < ROM::Relation
+      adapter :mongo
+      schema_class ROM::Mongo::Schema
+      option :output_schema, default: -> { schema.to_output_hash }
+      forward :find, :sort, :limit, :skip
+
+      # @api private
+      def self.view_methods
+        super + [:by_pk]
+      end
+
+      # Returns relation restricted by _id
+      #
+      # @param id [BSON::ObjectId] Document's PK value
+      #
+      # @return [ROM::Mongo::Relation]
+      #
+      # @api public
+      auto_curry def by_pk(id)
+        find(_id: id)
+      end
+
+      # Single purpose aggregation operations
+
+      # Difines count for dataset
+      #
+      # @return [Integer] The total count of documents
+      #
+      # @api public
+      def count
+        dataset.count
+      end
+
+      # Difines distinct for dataset
+      #
+      # @param [Symbol] attribute The document field name
+      #
+      # @return [Array<String>] The collection of uniq values by field name
+      #
+      # @api public
+      def distinct(attribute)
+        dataset.distinct(attribute)
+      end
+    end
+  end
+end

data/lib/rom/mongo/schema.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module ROM
+  module Mongo
+    class Schema < ROM::Schema
+      # :nocov:
+      def to_output_hash
+        Types::Hash
+          .schema(to_h { |attr| [attr.key, attr.to_read_type] })
+          .with_key_transform(&:to_sym)
+      end
+      # :nocov:
+    end
+  end
+end

data/lib/rom/mongo/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ROM
+  module Mongo
+    VERSION = '0.1.0'
+  end
+end

data/lib/rom/mongo.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require_relative 'mongo/core'
+
+ROM.register_adapter(:mongo, ROM::Mongo)

data/rom-mongodb.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative 'lib/rom/mongo/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'rom-mongodb'
+  spec.version = ROM::Mongo::VERSION
+  spec.authors = ['Vladislav Trotsenko']
+  spec.email = ['admin@bestweb.com.ua']
+
+  spec.summary = %(rom-mongodb)
+  spec.description = 'MongoDB adapter for Ruby Object Mapper'
+
+  spec.homepage = 'https://github.com/bestwebua/rom-mongo'
+  spec.license = 'MIT'
+
+  spec.metadata = {
+    'homepage_uri' => 'https://rom-rb.org',
+    'changelog_uri' => 'https://github.com/bestwebua/rom-mongo/blob/master/CHANGELOG.md',
+    'source_code_uri' => 'https://github.com/bestwebua/rom-mongo',
+    'documentation_uri' => 'https://github.com/bestwebua/rom-mongo/blob/master/README.md',
+    'bug_tracker_uri' => 'https://github.com/bestwebua/rom-mongo/issues'
+  }
+
+  spec.required_ruby_version = '>= 2.5.0'
+
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| ::File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'mongo', '~> 2.17', '>= 2.17.1'
+  spec.add_runtime_dependency 'rom-core', '~> 5.2', '>= 5.2.6'
+
+  spec.add_development_dependency 'ffaker', '~> 2.21'
+  spec.add_development_dependency 'rake', '~> 13.0', '>= 13.0.6'
+  spec.add_development_dependency 'rom-repository', '~> 5.2', '>= 5.2.2'
+  spec.add_development_dependency 'rspec', '~> 3.11'
+end