mongo_aggregation_dsl 0.0.0.pre4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 939d254e03bcd1b34e04c7de797781863e8a9a53
+  data.tar.gz: d91bb52fd5bc15ef8a198715484f29ea1d3e887f
+SHA512:
+  metadata.gz: ced780b0b600bcf8b069445de552314d49fbcf4b22db1502f25b30ffe29a4d196ffba9b3da6f7aa9ad19685c49969dfd5c494957874cca3199749082cba8efb3
+  data.tar.gz: 58c41fc7f244b76fc54d6ee77cdb0e445ad24d17fcd82f4ce54ef6a6d7e9a31235207b928b2d60e67e80d5251f9556b9747061347694c90ae78a0974cf1cd8c7

data/.circleci/config.yml

@@ -0,0 +1,61 @@
+# Ruby CircleCI 2.0 configuration file
+#
+# Check https://circleci.com/docs/2.0/language-ruby/ for more details
+#
+version: 2
+jobs:
+  build:
+    docker:
+      # specify the version you desire here
+       - image: circleci/ruby:2.3.4-node-browsers
+         environment:
+
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+
+      # Download and cache dependencies
+      - restore_cache:
+          keys:
+          - v1-dependencies-{{ checksum "Gemfile.lock" }}
+          # fallback to using the latest cache if no exact match is found
+          - v1-dependencies-
+
+      - run:
+          name: Install system dependencies
+          command: |
+            sudo apt-get update
+            sudo apt-get install cmake
+
+      - run:
+          name: install dependencies
+          command: |
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+      - save_cache:
+          paths:
+            - ./venv
+          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
+
+      - run:
+          name: pronto
+          command: echo ${PRONTO_GITHUB_ACCESS_TOKEN} && bundle exec pronto-circleci
+
+      # run tests!
+      - run:
+          name: run tests
+          command: |
+            mkdir /tmp/test-results
+
+            bundle exec rspec --format progress \
+                            --format RspecJunitFormatter \
+                            --out /tmp/test-results/rspec.xml \
+                            --format progress
+
+      # collect reports
+      - store_test_results:
+          path: /tmp/test-results
+      - store_artifacts:
+          path: /tmp/test-results
+          destination: test-results

data/.gitignore

@@ -0,0 +1,54 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+.idea/
+.rspec_status
+cornucopia_report/

data/.reek.yml

@@ -0,0 +1,5 @@
+---
+detectors:
+  # TooManyStatements is covered by RuboCop.
+  TooManyStatements:
+    enabled: false

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,51 @@
+# https://github.com/bbatsov/rubocop/blob/master/config/default.yml
+
+Documentation:
+  Enabled: false
+
+AllCops:
+  TargetRubyVersion: 2.3
+  Exclude:
+    - "bin/**/*"
+
+LineLength:
+  Max:  150
+
+## Multi-line method chaining should be done with leading dots.
+Layout/DotPosition:
+  EnforcedStyle: trailing
+
+Layout/MultilineMethodCallIndentation:
+  Enabled: false
+
+Layout/MultilineOperationIndentation:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 15
+
+StringLiterals:
+  EnforcedStyle: double_quotes
+
+IndentHash:
+  EnforcedStyle: consistent
+
+# Indentation of `when`.
+Layout/CaseIndentation:
+  EnforcedStyle: case
+  SupportedStyles:
+    - case
+    - end
+  IndentOneStep: true
+  # By default, the indentation width from Style/IndentationWidth is used
+  # But it can be overridden by setting this parameter
+  # This only matters if IndentOneStep is true
+  IndentationWidth: ~
+
+Metrics/ClassLength:
+  Max: 150
+
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*"
+    - "*.gemspec"

data/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in acts-as-taggable-on-mongoid.gemspec
+gemspec
+
+gem "gem-release"

data/Gemfile.lock

@@ -0,0 +1,205 @@
+PATH
+  remote: .
+  specs:
+    mongo_aggregation_dsl (0.0.0.pre4)
+      autoloaded (~> 2)
+      contracts-lite
+      mongo (~> 2.6.2)
+      mongoid (~> 5.2.0)
+      origin (~> 2.3.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (4.2.10)
+      activesupport (= 4.2.10)
+      builder (~> 3.1)
+    activesupport (4.2.10)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    ast (2.4.0)
+    autoloaded (2.2.1)
+    axiom-types (0.1.1)
+      descendants_tracker (~> 0.0.4)
+      ice_nine (~> 0.11.0)
+      thread_safe (~> 0.3, >= 0.3.1)
+    brakeman (4.3.1)
+    bson (4.3.0)
+    builder (3.2.3)
+    code_analyzer (0.4.8)
+      sexp_processor
+    codeclimate-engine-rb (0.4.1)
+      virtus (~> 1.0)
+    codecov (0.1.10)
+      json
+      simplecov
+      url
+    coercible (1.0.0)
+      descendants_tracker (~> 0.0.1)
+    colorize (0.8.1)
+    concurrent-ruby (1.0.5)
+    contracts-lite (0.15.0)
+    database_cleaner (1.7.0)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.3)
+    docile (1.3.1)
+    equalizer (0.0.11)
+    erubis (2.7.0)
+    faraday (0.15.2)
+      multipart-post (>= 1.2, < 3)
+    fasterer (0.4.1)
+      colorize (~> 0.7)
+      ruby_parser (~> 3.11.0)
+    gem-release (2.0.1)
+    gitlab (4.5.0)
+      httparty (>= 0.14.0)
+      terminal-table (>= 1.5.1)
+    httparty (0.16.2)
+      multi_xml (>= 0.5.2)
+    i18n (0.9.5)
+      concurrent-ruby (~> 1.0)
+    ice_nine (0.11.2)
+    jaro_winkler (1.5.1)
+    json (2.1.0)
+    kwalify (0.7.2)
+    minitest (5.11.3)
+    mongo (2.6.2)
+      bson (>= 4.3.0, < 5.0.0)
+    mongoid (5.2.1)
+      activemodel (~> 4.0)
+      mongo (>= 2.4.1, < 3.0.0)
+      origin (~> 2.3)
+      tzinfo (>= 0.3.37)
+    multi_xml (0.6.0)
+    multipart-post (2.0.0)
+    octokit (4.11.0)
+      sawyer (~> 0.8.0, >= 0.5.3)
+    origin (2.3.1)
+    parallel (1.12.1)
+    parser (2.5.1.2)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    pronto (0.9.5)
+      gitlab (~> 4.0, >= 4.0.0)
+      httparty (>= 0.13.7)
+      octokit (~> 4.7, >= 4.7.0)
+      rainbow (~> 2.1)
+      rugged (~> 0.24, >= 0.23.0)
+      thor (~> 0.19.0)
+    pronto-brakeman (0.9.1)
+      brakeman (>= 3.2.0)
+      pronto (~> 0.9.0)
+    pronto-circleci (1.0.1)
+      pronto (~> 0.9)
+    pronto-fasterer (0.9.0)
+      fasterer (~> 0.3, >= 0.3.0)
+      pronto (~> 0.9.0)
+    pronto-rails_best_practices (0.9.0)
+      pronto (~> 0.9.0)
+      rails_best_practices (~> 1.16, >= 1.15.0)
+    pronto-reek (0.9.1)
+      pronto (~> 0.9.0)
+      reek (>= 4.2, < 6.0)
+    pronto-rubocop (0.9.1)
+      pronto (~> 0.9.0)
+      rubocop (~> 0.50, >= 0.49.1)
+    public_suffix (3.0.3)
+    rails_best_practices (1.19.3)
+      activesupport
+      code_analyzer (>= 0.4.8)
+      erubis
+      i18n
+      json
+      require_all (~> 2.0)
+      ruby-progressbar
+    rainbow (2.2.2)
+      rake
+    rake (10.5.0)
+    reek (5.0.2)
+      codeclimate-engine-rb (~> 0.4.0)
+      kwalify (~> 0.7.0)
+      parser (>= 2.5.0.0, < 2.6, != 2.5.1.1)
+      rainbow (>= 2.0, < 4.0)
+    require_all (2.0.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rspec_junit_formatter (0.3.0)
+      rspec-core (>= 2, < 4, != 2.12.0)
+    rubocop (0.59.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.10.0)
+    ruby_parser (3.11.0)
+      sexp_processor (~> 4.9)
+    rugged (0.27.4)
+    sawyer (0.8.1)
+      addressable (>= 2.3.5, < 2.6)
+      faraday (~> 0.8, < 1.0)
+    sexp_processor (4.11.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    simplecov-rcov (0.2.3)
+      simplecov (>= 0.4.1)
+    terminal-table (1.8.0)
+      unicode-display_width (~> 1.1, >= 1.1.1)
+    thor (0.19.4)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.4.0)
+    url (0.3.2)
+    virtus (1.0.5)
+      axiom-types (~> 0.1)
+      coercible (~> 1.0)
+      descendants_tracker (~> 0.0, >= 0.0.3)
+      equalizer (~> 0.0, >= 0.0.9)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  codecov (~> 0.1.0, ~> 0.1)
+  database_cleaner
+  gem-release
+  mongo_aggregation_dsl!
+  pronto
+  pronto-brakeman
+  pronto-circleci
+  pronto-fasterer
+  pronto-rails_best_practices
+  pronto-reek
+  pronto-rubocop
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rspec_junit_formatter (~> 0.3.0)
+  rubocop
+  simplecov
+  simplecov-rcov
+
+BUNDLED WITH
+   1.16.4

data/README.md

@@ -0,0 +1,56 @@
+# mongo_aggregation_dsl
+
+This gem provides a basic implementation of a mongo aggregation dsl. It is by no means complete.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mongo_aggregation_dsl'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mongo_aggregation_dsl
+    
+## Usage    
+
+Example returns an array containing the resulting document json
+```ruby
+Aggregate::Pipeline.new(User).
+        match(account_id: BSON::ObjectId("111111111111111")).
+        project(id: 1).
+        lookup(
+            from: EndUser,
+            let: { user_id: :"$_id" },
+            as: "my_record",
+            pipeline: Aggregate::Pipeline.new.
+                match(
+                    :expr.and => [
+                        { eq: %w[$user_id $$user_id] },
+                        { eq: ["$status_code", 1] }
+                    ]
+                ).
+                project(id: 1)
+        ).execute
+```
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies. Then, run `rake spec` to run the tests. 
+
+To release a new version, update the version number in `mongo_aggregation_dsl.gemspec`, 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/CardTapp/mongo_aggregation_dsl. 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.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+

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/codecov.yml

@@ -0,0 +1,3 @@
+codecov:
+  ci:
+    - CircleCI

data/config/pronto-circleci.yml

@@ -0,0 +1,7 @@
+github:
+  org: "CardTapp"
+  repo: "mongo_aggregation_dsl"
+pronto:
+  comments_on_diff: true
+  reviews_on_diff: true
+  report_status: true

data/lib/aggregate/contracts/class_includes.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Aggregate
+  module Contracts
+    # Validates that a class includes a given module
+    class ClassIncludes < ::Contracts::Builtin::CallableClass
+      def initialize(klasses)
+        @klasses = [klasses].flatten(1)
+      end
+
+      # :reek:FeatureEnvy
+      # :reek:ManualDispatch
+      def valid?(object)
+        @klasses.all? { |klass| object.respond_to?(:included_modules) && object.included_modules.include?(klass) }
+      end
+
+      def to_s
+        "Expected to include #{@klasses}"
+      end
+
+      def inspect
+        to_s
+      end
+    end
+  end
+end

data/lib/aggregate/contracts/hash_max_length.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Aggregate
+  module Contracts
+    # Validates a hash length does not exceed the max given value
+    class HashMaxLength < ::Contracts::Builtin::CallableClass
+      def initialize(*vals)
+        @length = vals[0]
+      end
+
+      def valid?(hash)
+        hash.length <= @length
+      end
+
+      def to_s
+        "Hash length to be less than than or equal to #{@length}"
+      end
+
+      def inspect
+        to_s
+      end
+    end
+  end
+end

data/lib/aggregate/contracts/hash_min_length.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Aggregate
+  module Contracts
+    # Validates a hash length is less than the min given value
+    class HashMinLength < ::Contracts::Builtin::CallableClass
+      def initialize(*vals)
+        @length = vals[0]
+      end
+
+      def valid?(hash)
+        hash.length >= @length
+      end
+
+      def to_s
+        "Hash length to be greater than or equal to #{@length}"
+      end
+
+      def inspect
+        to_s
+      end
+    end
+  end
+end

data/lib/aggregate/contracts/hash_value_type.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Aggregate
+  module Contracts
+    # Validates the value types in a given range are of a given type
+    class HashValueType < ::Contracts::Builtin::CallableClass
+      def initialize(*vals)
+        @range = vals[0]
+        @type = vals[1]
+        @error = nil
+      end
+
+      def valid?(hash)
+        values = hash.values[@range]
+        if values.is_a? Array
+          values.all? { |value| value.is_a? @type }
+        else
+          values.is_a?(@type)
+        end
+      end
+
+      def to_s
+        "Hash values #{@range} to be of type #{@type}"
+      end
+
+      def inspect
+        to_s
+      end
+    end
+  end
+end

data/lib/aggregate/contracts/starts_with.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Aggregate
+  module Contracts
+    # Validates an object in string format begins with the given value
+    class StartsWith < ::Contracts::Builtin::CallableClass
+      def initialize(*args)
+        @start = args[0]
+      end
+
+      def valid?(object)
+        object.to_s.start_with?(@start)
+      end
+
+      def to_s
+        "Expected to start with #{@start}"
+      end
+
+      def inspect
+        to_s
+      end
+    end
+  end
+end

data/lib/aggregate/contracts.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Aggregate
+  # Contracts are used in stages to apply validation of the options passed into a stage
+  module Contracts
+    Autoloaded.module {}
+  end
+end

data/lib/aggregate/pipeline.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Aggregate
+  # Represents an aggregation pipeline and is the main entry point to the DSL
+  # Example: Aggregate::Pipeline.new().match().project().execute()
+  class Pipeline
+    attr_reader :stages
+
+    def initialize(klass = nil)
+      @klass  = klass
+      @stages = []
+    end
+
+    def to_s
+      inspect
+    end
+
+    def inspect
+      @stages.to_s
+    end
+
+    # :reek:NilCheck
+    def execute
+      raise "Pipeline initializer must specify a class in order to be executable" if @klass.nil?
+
+      db      = Mongoid.default_client.database
+      command = "function(){return db.#{@klass.collection_name}.aggregate(#{self}).toArray()}"
+
+      # https://github.com/mongodb/mongo-ruby-driver/blob/master/lib/mongo/operation/result.rb
+      result = db.command("$eval": command, nolock: true, await_data: true)
+      result.documents
+    end
+
+    Aggregate::Stages.constants.each do |klass|
+      define_method(klass.to_s.underscore) do |options|
+        @stages << "Aggregate::Stages::#{klass}".constantize.new(options)
+        self
+      end
+    end
+  end
+end

data/lib/aggregate/stages/base.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Aggregate
+  module Stages
+    # derived stages are required to implement the following contract
+    # def to_s
+    # # return a properly formatted stage
+    # end
+    class Base < Aggregate::Values::Base
+      include ::Contracts::Core
+      include ::Contracts::Builtin
+      attr_reader :options
+      # :reek:NilCheck
+      def initialize(options)
+        value_handler = self.class.value_handlers.detect { |handler| handler.handles?(options) }
+        @options = value_handler.nil? ? options : value_handler.new(options, false)
+      end
+    end
+  end
+end