mongo_ql 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 54ebbab82b00ce95966996491caf76cea95683f8f88be3676f15655c836ffa6b
+  data.tar.gz: 4e9bd70e840f6f2c118fcba06e8d086ceca67d42bfa8ecd82d3cf8412dd9191e
+SHA512:
+  metadata.gz: 591efcb215b9769e6be3e4cdbf0d493a6c3800042fec75a649852afd0901b25916ad063516a3f46af05b9a44bdb62eb5cd719f754624d7b15135e85177e3e7d3
+  data.tar.gz: 586002d366b3d6f264ee8e6621297679febed34b869e6a9c94d4e9698d64a58a07d663b275d313682bef6d7ef16edf1187bd535503312e67acc53abdaea17264

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile*.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rubocop.yml

@@ -0,0 +1,173 @@
+AllCops:
+  TargetRubyVersion: 2.6
+  # RuboCop has a bunch of cops enabled by default. This setting tells RuboCop
+  # to ignore them, so only the ones explicitly set in this file are enabled.
+  DisabledByDefault: true
+  Exclude:
+    - 'bin/**/*'
+    - 'Rakefile'
+
+# Security
+Security:
+  Enabled: true
+
+Security/YAMLLoad:
+  Enabled: false
+
+# Prefer &&/|| over and/or.
+Style/AndOr:
+  Enabled: true
+
+# Do not use braces for hash literals when they are the last argument of a
+# method call.
+Style/BracesAroundHashParameters:
+  Enabled: true
+  EnforcedStyle: context_dependent
+
+# Align `when` with `case`.
+Layout/CaseIndentation:
+  Enabled: true
+
+# Align comments with method definitions.
+Layout/CommentIndentation:
+  Enabled: true
+
+Layout/ElseAlignment:
+  Enabled: true
+
+Layout/EmptyLineAfterMagicComment:
+  Enabled: false
+
+# In a regular class definition, no empty lines around the body.
+Layout/EmptyLinesAroundClassBody:
+  Enabled: true
+
+# In a regular method definition, no empty lines around the body.
+Layout/EmptyLinesAroundMethodBody:
+  Enabled: true
+
+# In a regular module definition, no empty lines around the body.
+Layout/EmptyLinesAroundModuleBody:
+  Enabled: false
+
+Layout/IndentFirstArgument:
+  Enabled: true
+
+# Use Ruby >= 1.9 syntax for hashes. Prefer { a: :b } over { :a => :b }.
+Style/HashSyntax:
+  Enabled: true
+
+# Method definitions after `private` or `protected` isolated calls need one
+# extra level of indentation.
+Layout/IndentationConsistency:
+  Enabled: true
+  EnforcedStyle: indented_internal_methods
+
+# Two spaces, no tabs (for indentation).
+Layout/IndentationWidth:
+  Enabled: true
+
+Layout/LeadingCommentSpace:
+  Enabled: true
+
+Layout/SpaceAfterColon:
+  Enabled: true
+
+Layout/SpaceAfterComma:
+  Enabled: true
+
+Layout/SpaceAroundEqualsInParameterDefault:
+  Enabled: true
+
+Layout/SpaceAroundKeyword:
+  Enabled: true
+
+Layout/SpaceAroundOperators:
+  Enabled: true
+
+Layout/SpaceBeforeComma:
+    Enabled: true
+
+Layout/SpaceBeforeFirstArg:
+    Enabled: true
+
+Style/DefWithParentheses:
+  Enabled: true
+
+# Defining a method with parameters needs parentheses.
+Style/MethodDefParentheses:
+  Enabled: true
+
+Style/FrozenStringLiteralComment:
+  Enabled: true
+  EnforcedStyle: always
+  Exclude:
+    - 'actionview/test/**/*.builder'
+    - 'actionview/test/**/*.ruby'
+    - 'actionpack/test/**/*.builder'
+    - 'actionpack/test/**/*.ruby'
+    - 'activestorage/db/migrate/**/*.rb'
+    - 'db/migrate/**/*.rb'
+    - 'db/*.rb'
+
+# Use `foo {}` not `foo{}`.
+Layout/SpaceBeforeBlockBraces:
+  Enabled: true
+
+# Use `foo { bar }` not `foo {bar}`.
+Layout/SpaceInsideBlockBraces:
+  Enabled: true
+
+# Use `{ a: 1 }` not `{a:1}`.
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: false
+
+Layout/SpaceInsideParens:
+  Enabled: true
+
+# Check quotes usage according to lint rule below.
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+# Detect hard tabs, no hard tabs.
+Layout/Tab:
+  Enabled: true
+
+# Blank lines should not have any spaces.
+Layout/TrailingBlankLines:
+  Enabled: false
+
+# No trailing whitespace.
+Layout/TrailingWhitespace:
+  Enabled: true
+
+# Use quotes for string literals when they are enough.
+Style/UnneededPercentQ:
+  Enabled: true
+
+Lint:
+  Enabled: true
+
+Lint/UselessAccessModifier:
+  Enabled: false
+
+Lint/UnusedMethodArgument:
+  Enabled: false
+
+Style/RedundantReturn:
+  Enabled: true
+  AllowMultipleReturnValues: true
+
+Style/Semicolon:
+  Enabled: true
+  AllowAsExpressionSeparator: true
+
+Naming/AccessorMethodName:
+  Enabled: true
+
+Naming/ConstantName:
+  Enabled: true
+
+Naming/FileName:
+  Enabled: true

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 KUBERCLOUD SOLUTIONS INC.
+
+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 @@
+# mongo_ql

data/Untitled-1

@@ -0,0 +1,4 @@
+include MongoQL
+define_singleton_method(:method_missing) do |m, *args, &block|
+  MongoQL::Expression::FieldNode.new(m)
+end

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "./lib/mongo_ql"
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,5 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install

data/design_specs.md

@@ -0,0 +1,80 @@
+
+# Query DSL
+```ruby
+Order.where { tax != 0 }                          
+#=> Order.where(tax: { "$ne": 0 })
+Order.where { total >= 100 }                      
+#=> Order.where(total: { "$gte": 100 })
+Order.where { (total >= 100) & (total_tax < 15) } 
+#=> Order.where({ "$and": [{ total: { "$gte": 100 }}, { total_tax: { "$lt": 15 }}]})
+Order.where { tax > (shipping / 2) }              
+#=> Order.where(tax: { "$gt": { "$divide": [ "$shipping", 2]}})
+Order.where { total  >= If(currency == "CAD", 100, 80) }
+#=> Order.where(total: { "$cond": { if: { "$eq": ["$currency", "CAD"]}, then: 100, else: 80 }})
+```
+
+# Aggregation Pipeline DSL
+```ruby
+Order.all.mongo_ql do
+  join    Customer, 
+          :customer_id => _id,
+          :as          => customers
+
+  join    Shipping, :as => shippings do
+    match  order_id == doc._id, 
+           status   == :shipped
+  end
+
+  match   province == "ON"
+
+  project :_id, 
+          :total, 
+          :customer  => customers.name,
+          :tax       => total * tax_rate
+
+  group   customer, 
+          :total     => total.sum,
+          :total_tax => tax.sum * 5
+end
+
+# The above aggregation is equivalent to the following mognodb pipeline
+Order.collection.pipeline([
+  { "$lookup":  {
+    from:         "customers",
+    localField:   "$customer_id",
+    foreignField: "$_id",
+    as:           "customers"
+  }},
+  { "$unwind":  {
+    path:         "customers"
+  }},
+  { "$lookup":  {
+    from:         "shippings",
+    as:           "shippings",
+    let:          { doc_id: "$_id" },
+    pipeline:     [{
+      "$match": {
+        order_id: { "$eq": "$$dock_id" },
+        status: :shipped  
+      }
+    }]
+  }},
+  { "$unwind":  {
+    path:         "customers"
+  }},
+  { "$match":   {
+    province:     { "$eq": "ON" }
+  }},
+  { "$project": {
+    _id:          1,
+    total:        1,
+    customer:     "$customers.name",
+    tax:          { "$multiply": ["$total", "$tax_rate"] }
+  }},
+  { "$group":   {
+    _id:          "$customer",
+    total:        { "$sum": "$total" },
+    total_tax:    { "$multiply": [{ "$sum": "$tax" }, 5] }
+  }}
+])
+```

data/lib/mongo_ql/binary_operators.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module MongoQL
+  module BinaryOperators
+    BINARY_OPS = {
+      "+":  "$add",
+      "-":  "$subtract",
+      "*":  "$multiply",
+      "/":  "$divide",
+      ">":  "$gt",
+      "<":  "$lt",
+      ">=": "$gte",
+      "<=": "$lte",
+      "!=": "$ne",
+      "==": "$eq",
+      "&":  "$and",
+      "|":  "$or",
+      "%":  "$mod",
+      "**": "$pow"
+    }.freeze
+
+    BINARY_OPS.keys.each do |op|
+      class_eval <<~RUBY
+        def #{op}(right_node)
+          Expression::Binary.new(BINARY_OPS[__method__], self, right_node)
+        end
+      RUBY
+    end
+  end
+end

data/lib/mongo_ql/collection_operators.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module MongoQL
+  module CollectionOperators
+    AGGREGATE_OPS = {
+      "max":   "$max",
+      "min":   "$min",
+      "first": "$first",
+      "last":  "$last",
+      "sum":   "$sum",
+      "avg":   "$avg",
+      "size":  "$size",
+      "push":  "$push"
+    }.freeze
+
+    AGGREGATE_OPS.keys.each do |op|
+      class_eval <<~RUBY
+        def #{op}
+          Expression::MethodCall.new(AGGREGATE_OPS[__method__], self)
+        end
+      RUBY
+    end
+
+    def filter(&block)
+      Expression::MethodCall.new "$filter", self, ast_template: -> (target, **_args) {
+        {
+          "input" => target,
+          "as"    => "item",
+          "cond"  => block.call(Expression::FieldNode.new("$item")).to_ast
+        }
+      }
+    end
+
+    def map(&block)
+      Expression::MethodCall.new "$map", self, ast_template: -> (target, **_args) {
+        {
+          "input" => target,
+          "as"    => "item",
+          "in"    => block.call(Expression::FieldNode.new("$item")).to_ast
+        }
+      }
+    end
+
+    def reduce(initial_value, &block)
+      Expression::MethodCall.new "$reduce", self, ast_template: -> (target, **_args) {
+        {
+          "input"        => target,
+          "initialValue" => to_expression(initial_value).to_ast,
+          "in"           => to_expression(block.call(Expression::FieldNode.new("$value"), Expression::FieldNode.new("$this"))).to_ast
+        }
+      }
+    end
+
+    def contains(ele)
+      Expression::MethodCall.new "$in", self, ast_template: -> (target, **_args) {
+        [to_expression(ele).to_ast, target]
+      }
+    end
+    alias_method :includes, :contains
+    alias_method :include,  :contains
+    alias_method :include?, :contains
+
+  end
+end

data/lib/mongo_ql/date_operators.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module MongoQL
+  module DateOperators
+    DATE_OPERATORS = {
+      "year":         "$year",
+      "week":         "$week",
+      "month":        "$month",
+      "day_of_month": "$dayOfMonth",
+      "day_of_week":  "$dayOfWeek",
+      "day_of_year":  "$dayOfYear",
+      "iso_day_of_week": "$isoDayOfWeek",
+      "iso_week":        "$isoWeek",
+      "iso_week_Year":   "$isoWeekYear"
+    }.freeze
+
+    DATE_OPERATORS.keys.each do |op|
+      class_eval <<~RUBY
+        def #{op}
+          Expression::MethodCall.new DATE_OPERATORS[__method__], self
+        end
+      RUBY
+    end
+  end
+end

data/lib/mongo_ql/expression/binary.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module MongoQL
+  class Expression::Binary < Expression
+    attr_accessor :operator, :left_node, :right_node
+
+    def initialize(operator, left, right)
+      @operator   = operator
+      @left_node  = to_expression(left)
+      @right_node = to_expression(right)
+    end
+
+    def to_ast
+      { operator => [left_node.to_ast, right_node.to_ast] }
+    end
+  end
+end

data/lib/mongo_ql/expression/date_note.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative "../date_operators"
+
+module MongoQL
+  class Expression::DateNode < Expression
+    include DateOperators
+
+    attr_accessor :expression
+
+    def initialize(expression)
+      @expression = expression
+    end
+
+    def to_ast
+      expression.to_ast
+    end
+  end
+end

data/lib/mongo_ql/expression/field_node.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module MongoQL
+  class Expression::FieldNode < Expression
+    attr_accessor :field_name
+
+    def initialize(name)
+      @field_name = name
+    end
+
+    def method_missing(method_name, *args, &block)
+      Expression::FieldNode.new("#{field_name}.#{method_name}")
+    end
+
+    def f(field)
+      Expression::FieldNode.new("#{field_name}.#{field}")
+    end
+
+    def to_ast
+      "$#{field_name}"
+    end
+  end
+end

data/lib/mongo_ql/expression/method_call.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module MongoQL
+  class Expression::MethodCall < Expression
+    attr_accessor :method, :target, :ast_template, :args
+
+    def initialize(method, target, ast_template: nil, **args)
+      @target       = to_expression(target)
+      @method       = method
+      @ast_template = ast_template
+      @args         = args
+    end
+
+    def to_ast
+      if ast_template
+        { method => ast_template.call(target.to_ast, **args) }
+      else
+        { method => target.to_ast }
+      end
+    end
+  end
+end

data/lib/mongo_ql/expression/unary.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module MongoQL
+  class Expression::Unary < Expression
+    attr_accessor :operator, :right_node
+
+    def initialize(operator, right)
+      @operator   = operator
+      @right_node = to_expression(right)
+    end
+
+    def to_ast
+      { operator => right_node.to_ast }
+    end
+  end
+end

data/lib/mongo_ql/expression/value_node.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module MongoQL
+  class Expression::ValueNode < Expression
+    attr_accessor :value
+
+    def initialize(val)
+      @value = val
+    end
+
+    def to_ast
+      value
+    end
+  end
+end

data/lib/mongo_ql/expression.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require_relative "binary_operators"
+require_relative "unary_operators"
+require_relative "collection_operators"
+require_relative "string_operators"
+
+module MongoQL
+  class Expression
+    include BinaryOperators
+    include UnaryOperators
+    include CollectionOperators
+    include StringOperators
+
+    FORMATING_OPS = {
+      "to_object_id": "$toObjectId",
+      "to_id":        "$toObjectId",
+      "to_s":         "$toString",
+      "to_string":    "$toString",
+      "to_int":       "$toInt",
+      "to_long":      "$toLong",
+      "to_bool":      "$toBool",
+      "to_date":      "$toDate",
+      "to_decimal":   "$toDecimal",
+      "to_double":    "$toDouble",
+      "downcase":     "$toLower",
+      "to_lower":     "$toLower",
+      "upcase":       "$toUpper",
+      "to_upper":     "$toUpper"
+    }.freeze
+
+    FORMATING_OPS.keys.each do |op|
+      class_eval <<~RUBY
+        def #{op}
+          Expression::MethodCall.new(FORMATING_OPS[__method__], self)
+        end
+      RUBY
+    end
+
+    def type
+      Expression::MethodCall.new "$type", self
+    end
+
+    def if_null(default_val)
+      Expression::MethodCall.new "$ifNull", self, ast_template: -> (target, **_args) {
+        [target, to_expression(default_val).to_ast]
+      }
+    end
+    alias_method :default, :if_null
+
+    def as_date
+      Expression::DateNode.new(self)
+    end
+
+    def to_ast
+      raise NotImplementedError, "#{self.class.name} must implement to_ast"
+    end
+
+    protected
+      def to_expression(val)
+        if val.is_a?(Expression)
+          val
+        else
+          Expression::ValueNode.new(val)
+        end
+      end
+  end
+end

data/lib/mongo_ql/string_operators.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module MongoQL
+  module StringOperators
+    def substr(start, length)
+      Expression::MethodCall.new "$substr", self, ast_template: -> (target, **_args) {
+        [target, to_expression(start).to_ast, to_expression(length).to_ast]
+      }
+    end
+
+    def trim(chars)
+      Expression::MethodCall.new "$trim", self, ast_template: -> (target, **_args) {
+        {
+          "input" => target,
+          "chars" => to_expression(chars).to_ast
+        }
+      }
+    end
+  end
+end

data/lib/mongo_ql/unary_operators.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module MongoQL
+  module UnaryOperators
+    UNARY_OPS = {
+      "!": "$not"
+    }.freeze
+
+    UNARY_OPS.keys.each do |op|
+      class_eval <<~RUBY
+        def #{op}
+          Expression::Unary.new(UNARY_OPS[__method__], self)
+        end
+      RUBY
+    end
+  end
+end

data/lib/mongo_ql/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module MongoQL
+  VERSION = "0.0.1"
+end

data/lib/mongo_ql.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module MongoQL
+end
+
+require_relative "mongo_ql/version"
+require_relative "mongo_ql/expression"
+require_relative "mongo_ql/expression/date_note"
+require_relative "mongo_ql/expression/field_node"
+require_relative "mongo_ql/expression/value_node"
+require_relative "mongo_ql/expression/method_call"
+require_relative "mongo_ql/expression/binary"
+require_relative "mongo_ql/expression/unary"

data/mongo_ql.gemspec

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "mongo_ql/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "mongo_ql"
+  spec.version       = MongoQL::VERSION
+  spec.authors       = ["Xizheng Ding"]
+  spec.email         = ["dingxizheng@gamil.com"]
+
+  spec.summary       = "A DSL for building mongo query in a more natual way"
+  spec.homepage      = "https://github.com/dingxizheng/mongo_ql"
+  spec.license       = "MIT"
+
+  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"]
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: mongo_ql
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Xizheng Ding
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-10-09 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- dingxizheng@gamil.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- LICENSE.txt
+- README.md
+- Untitled-1
+- bin/console
+- bin/setup
+- design_specs.md
+- lib/mongo_ql.rb
+- lib/mongo_ql/binary_operators.rb
+- lib/mongo_ql/collection_operators.rb
+- lib/mongo_ql/date_operators.rb
+- lib/mongo_ql/expression.rb
+- lib/mongo_ql/expression/binary.rb
+- lib/mongo_ql/expression/date_note.rb
+- lib/mongo_ql/expression/field_node.rb
+- lib/mongo_ql/expression/method_call.rb
+- lib/mongo_ql/expression/unary.rb
+- lib/mongo_ql/expression/value_node.rb
+- lib/mongo_ql/string_operators.rb
+- lib/mongo_ql/unary_operators.rb
+- lib/mongo_ql/version.rb
+- mongo_ql.gemspec
+homepage: https://github.com/dingxizheng/mongo_ql
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A DSL for building mongo query in a more natual way
+test_files: []