mongo_aggregation_dsl 0.0.0.pre4

data/lib/aggregate/stages/facet.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Aggregate
+  module Stages
+    # Represents an aggregation facet
+    # https://docs.mongodb.com/manual/reference/operator/aggregation/facet/#pipe._S_facet
+    class Facet < HashBase
+      Contract And[
+                   C::HashMinLength[1],
+                   HashOf[Symbol, Aggregate::Pipeline]] => Any
+      def initialize(options)
+        super(options)
+      end
+
+      def to_s
+        inspect
+      end
+
+      def inspect
+        "{ $facet: #{options} }"
+      end
+    end
+  end
+end

data/lib/aggregate/stages/group.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Aggregate
+  module Stages
+    # Represents an aggregation group
+    # https://docs.mongodb.com/manual/reference/operator/aggregation/group/#pipe._S_group
+    class Group < HashBase
+      Contract And[
+                   Not[C::HashValueType[0, Hash]],
+                   C::HashValueType[1..-1, Hash]
+               ] => Any
+      def initialize(options)
+        super(options)
+      end
+
+      def to_s
+        inspect
+      end
+
+      def inspect
+        "{ $group: #{options} }"
+      end
+    end
+  end
+end

data/lib/aggregate/stages/hash_base.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Aggregate
+  module Stages
+    # Base class for all stages that take a hash as an initializer option
+    class HashBase < Base
+      Contract C::HashMinLength[1] => Any
+      def initialize(options)
+        super(Aggregate::Values::Hash.new(options, false))
+      end
+    end
+  end
+end

data/lib/aggregate/stages/lookup.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Aggregate
+  module Stages
+    # Represents an aggregation lookup
+    # https://docs.mongodb.com/manual/reference/operator/aggregation/lookup/#pipe._S_lookup
+    class Lookup < HashBase
+      Contract KeywordArgs[
+                       from: C::ClassIncludes[[Mongoid::Document]],
+                       as: String,
+                       let: And[HashOf[Symbol, Symbol], C::HashMinLength[1]],
+                       pipeline: Aggregate::Pipeline] => Any
+      def initialize(options)
+        super(options)
+      end
+
+      def to_s
+        inspect
+      end
+
+      def inspect
+        "{ $lookup: #{options} }"
+      end
+    end
+  end
+end

data/lib/aggregate/stages/match.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Aggregate
+  module Stages
+    # Represents an aggregation match
+    # https://docs.mongodb.com/manual/reference/operator/aggregation/match/#pipe._S_match
+    # TODO: Should probably have two match types.
+    # A simple match `match(account_id: BSON::ObjectId("11111111111111111111"))`
+    # An expression match `match( :expr.and => [ { eq: %w[$user_id $$user_id] }] )`
+    class Match < HashBase
+      Contract Or[HashOf[Symbol, Any], HashOf[Origin::Key, Any]] => Any
+      def initialize(options)
+        super(options)
+      end
+
+      def to_s
+        inspect
+      end
+
+      def inspect
+        "{ $match: #{options} }"
+      end
+    end
+  end
+end

data/lib/aggregate/stages/project.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Aggregate
+  module Stages
+    # Represents an aggregation project
+    # https://docs.mongodb.com/manual/reference/operator/aggregation/project/#pipe._S_project
+    class Project < HashBase
+      def to_s
+        inspect
+      end
+
+      def inspect
+        "{ $project: #{options} }"
+      end
+    end
+  end
+end

data/lib/aggregate/stages/replace_root.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Aggregate
+  module Stages
+    # Represents an aggregation replaceRoot
+    # https://docs.mongodb.com/manual/reference/operator/aggregation/replaceRoot/#pipe._S_replaceRoot
+    class ReplaceRoot < Base
+      Contract And[String, C::StartsWith["$"]] => Any
+      def initialize(new_root)
+        super(new_root)
+      end
+
+      def to_s
+        inspect
+      end
+
+      def inspect
+        "{ $replaceRoot: {newRoot: #{options}} }"
+      end
+    end
+  end
+end

data/lib/aggregate/stages/unwind.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Aggregate
+  module Stages
+    # Represents an aggregation unwind
+    # https://docs.mongodb.com/manual/reference/operator/aggregation/unwind/#pipe._S_unwind
+    class Unwind < Base
+      Contract Or[
+                   And[String, C::StartsWith["$"]],
+                   KeywordArgs[
+                      path: And[String, C::StartsWith["$"]],
+                      includeArrayIndex: Optional[Boolean],
+                      preserveNullAndEmptyArrays: Optional[Boolean]
+                   ],
+               ] => Any
+      def initialize(options)
+        super(options)
+      end
+
+      def to_s
+        inspect
+      end
+
+      def inspect
+        "{ $unwind: #{options} }"
+      end
+    end
+  end
+end

data/lib/aggregate/stages.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Aggregate
+  # Stages represent mongo aggregate pipeline stages.
+  # All classes which in this namespace have methods
+  # dynamically added to the Aggregate::Pipeline
+  module Stages
+    Autoloaded.module {}
+  end
+end

data/lib/aggregate/values/array.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Aggregate
+  module Values
+    # Takes an array and converts each to the appropriate value handler if one is available.
+    class Array < Base
+      def to_s
+        raise ArgumentError, "Array cannot be a hash key" if is_key
+
+        "[#{value.map { |value| get_value(value, false) }.join(', ')}]"
+      end
+
+      class << self
+        def handles?(value)
+          value.is_a? ::Array
+        end
+      end
+    end
+  end
+end

data/lib/aggregate/values/base.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Aggregate
+  module Values
+    # derived value handlers are required to implement the following contract
+    # def to_s
+    #   # Returns a properly formatted string for the given value. Note that care
+    #   # should be taken to properly format as a hash key or value depending on is_key
+    # end
+    # class << self
+    #   def handles?(value)
+    #     # returns true if this value handler can handle transforming the given value type into a string
+    #   end
+    # end
+    #
+    # In keeping with duck typing the above are not implemented here and will not raise
+    # a NotImplementedError. Instead a standard MethodMissing will be raised if a value handler
+    # cannot be called with `handles?(value)` or `to_s`
+    #
+    # http://chrisstump.online/2016/03/23/stop-abusing-notimplementederror/
+    class Base
+      attr_reader :value, :is_key
+      def initialize(value, is_key)
+        @value = value
+        @is_key = is_key
+      end
+
+      class << self
+        def value_handlers
+          @value_handlers ||= (Aggregate::Values.constants - [:Base]).map do |klass|
+            "Aggregate::Values::#{klass}".constantize
+          end
+        end
+      end
+
+      private
+
+      private
+
+      def get_value(original_value, is_hash_key)
+        handler = self.class.value_handlers.detect { |handler| handler.handles?(original_value) }
+        handler.nil? ? original_value : handler.new(original_value, is_hash_key)
+      end
+    end
+  end
+end

data/lib/aggregate/values/document_class.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Aggregate
+  module Values
+    # Takes a mongoid document and returns a string containing the document collection name
+    class DocumentClass < Base
+      def to_s
+        inspect
+      end
+
+      def inspect
+        raise ArgumentError("Document cannot be a hash key") if is_key
+
+        "'#{value.collection_name}'"
+      end
+
+      class << self
+        # :reek:ManualDispatch
+        def handles?(value)
+          return false unless value.respond_to? :included_modules
+
+          value.included_modules.include?(Mongoid::Document)
+        end
+      end
+    end
+  end
+end

data/lib/aggregate/values/hash.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Aggregate
+  module Values
+    # Takes hash and converts each key and pair to the appropriate value handler if one is available.
+    class Hash < Base
+      def to_s
+        inspect
+      end
+
+      def inspect
+        raise ArgumentError("Hash cannot be a hash key") if is_key
+
+        "{ #{transpose_options.map { |hash_key, hash_value| "#{hash_key}: #{hash_value}" }.join(', ')} }"
+      end
+
+      private
+
+      def transpose_options
+        new_hash = {}
+        value.each do |original_key, original_value|
+          if original_key.is_a?(Origin::Key)
+            expression = original_key.__expr_part__(original_value)
+            original_key = expression.keys.first.to_sym
+            original_value = expression.values.first
+          end
+
+          new_key = get_value(original_key, true)
+          new_value = get_value(original_value, false)
+
+          new_hash[new_key] = new_value
+        end
+        new_hash
+      end
+
+      class << self
+        def handles?(value)
+          value.is_a? ::Hash
+        end
+      end
+    end
+  end
+end

data/lib/aggregate/values/nil.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Aggregate
+  module Values
+    # Converts nil to null
+    # :reek:NilCheck
+    class Nil < Base
+      def to_s
+        inspect
+      end
+
+      def inspect
+        raise ArgumentError, "Nil cannot be a hash key" if is_key
+
+        "null"
+      end
+
+      class << self
+        def handles?(value)
+          value.nil?
+        end
+      end
+    end
+  end
+end

data/lib/aggregate/values/object_id.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Aggregate
+  module Values
+    # Converts a BSON::Object id to a string `ObjectId('123')`
+    class ObjectId < Base
+      def to_s
+        inspect
+      end
+
+      def inspect
+        raise ArgumentError, "ObjectId cannot be a hash key" if is_key
+
+        "ObjectId('#{value}')"
+      end
+
+      class << self
+        def handles?(value)
+          value.is_a? BSON::ObjectId
+        end
+      end
+    end
+  end
+end

data/lib/aggregate/values/string.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Aggregate
+  module Values
+    # Returns a string wrapped in single quotes if the value or string if a key
+    class String < Base
+      def to_s
+        inspect
+      end
+
+      def inspect
+        is_key ? value.to_s : "'#{value}'"
+      end
+
+      class << self
+        def handles?(value)
+          value.is_a? ::String
+        end
+      end
+    end
+  end
+end

data/lib/aggregate/values/symbol.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Aggregate
+  module Values
+    # Returns a string wrapped in single quotes if the value or string if a key
+    # Additionally adds $ to the reserved aggregation operations.
+    class Symbol < Base
+      # rubocop:disable Layout/AlignArray
+      EXPRESSION_OPERATORS = %i[
+        abs add ceil divide exp floor ln log log10 mod pow sqrt subtract trunc
+        arrayElemAt arrayToObject concatArrays filter in indexOfArray isArray map objectToArray
+          range reduce reverseArray size slice zip
+        and not or
+        cmp eq gt gte lt lte ne
+        cond ifNull switch
+        dateFromParts dateFromString dateToParts dateToString dayOfMonth dayOfWeek dayOfYear
+          hour isoDayOfWeek isoWeek isoWeekYear millisecond minute month second toDate week year
+        literal
+        mergeObjects
+        objectToArray
+        allElementsTrue anyElementTrue setDifference setEquals setIntersection setIsSubset setUnion
+        concat dateFromString dateToString indexOfBytes indexOfCP ltrim rtrim split strLenCP
+          strcasecmp substr substrBytes substrCP toLower toString trim toUpper
+        meta
+        convert toBool toDate toDecimal toDouble toInt toLong toObjectId toString type
+      ].freeze
+      # rubocop:enable Layout/AlignArray
+
+      GROUP_ACCUMULATORS = %i[avg first last max min push addToSet].freeze
+
+      PROJECT_ACCUMULATORS = %i[avg max min push stdDevPop stdDevSamp sum].freeze
+      def to_s
+        inspect
+      end
+
+      def inspect
+        is_operator = (%i[expr] + EXPRESSION_OPERATORS + GROUP_ACCUMULATORS + PROJECT_ACCUMULATORS).include?(value)
+        retval = is_operator ? "$#{value}" : value
+
+        retval = :_id if value == :id
+
+        is_key ? retval.to_s : "'#{retval}'"
+      end
+
+      class << self
+        def handles?(value)
+          value.is_a? ::Symbol
+        end
+      end
+    end
+  end
+end

data/lib/aggregate/values.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Aggregate
+  # Values handle transformation of known types into a correct string format
+  module Values
+    Autoloaded.module {}
+  end
+end

data/lib/aggregate.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "autoloaded"
+require "contracts"
+require "mongo"
+require "mongoid"
+require "origin"
+
+# Extend Symbol with origin handler functions
+Symbol.add_key(:and, "$and", "$and")
+Symbol.add_key(:nor, "$nor", "$nor")
+Symbol.add_key(:or, "$or", "$or")
+
+# The base module for the gem under which all classes are namespaced.
+module Aggregate
+  Autoloaded.module {}
+end
+
+C = Aggregate::Contracts

data/lib/mongo_aggregation_dsl.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "aggregate"

data/mongo_aggregation_dsl.gemspec

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |spec|
+  spec.name = "mongo_aggregation_dsl"
+  spec.version = "0.0.0.pre4"
+  spec.authors = ["KrimsonKla"]
+  spec.email   = ["admin@cardtapp.com"]
+  spec.date = "2018-09-10"
+  spec.summary = "An aggregation DSL for use with mongo ruby driver"
+
+  spec.homepage    = "http://www.cardtapp.com"
+  spec.license     = "MIT"
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "autoloaded", "~> 2"
+  spec.add_dependency "contracts-lite"
+  spec.add_dependency "mongo", "~> 2.6.2"
+  spec.add_dependency "mongoid", "~> 5.2.0"
+  spec.add_dependency "origin", "~> 2.3.1"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "codecov", "~> 0.1", "~> 0.1.0"
+  spec.add_development_dependency "database_cleaner"
+  spec.add_development_dependency "pronto"
+  spec.add_development_dependency "pronto-brakeman"
+  spec.add_development_dependency "pronto-circleci"
+  spec.add_development_dependency "pronto-fasterer"
+  spec.add_development_dependency "pronto-rails_best_practices"
+  spec.add_development_dependency "pronto-reek"
+  spec.add_development_dependency "pronto-rubocop"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec_junit_formatter", "~> 0.3.0"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "simplecov-rcov"
+end