mongo 2.1.2 → 2.2.0.rc0

data/lib/mongo/collection/view/builder.rb

@@ -0,0 +1,20 @@
+# Copyright (C) 2015 MongoDB, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'mongo/collection/view/builder/aggregation'
+require 'mongo/collection/view/builder/map_reduce'
+require 'mongo/collection/view/builder/op_query'
+require 'mongo/collection/view/builder/find_command'
+require 'mongo/collection/view/builder/flags'
+require 'mongo/collection/view/builder/modifiers'

data/lib/mongo/collection/view/builder/aggregation.rb

@@ -0,0 +1,98 @@
+# Copyright (C) 2015 MongoDB, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Mongo
+  class Collection
+    class View
+      module Builder
+
+        # Builds an aggregation command specification from the view and options.
+        #
+        # @since 2.2.0
+        class Aggregation
+          extend Forwardable
+
+          # The mappings from ruby options to the aggregation options.
+          #
+          # @since 2.2.0
+          MAPPINGS = BSON::Document.new(
+            :allow_disk_use => 'allowDiskUse',
+            :max_time_ms => 'maxTimeMS',
+            :explain => 'explain',
+            :bypass_document_validation => 'bypassDocumentValidation'
+          ).freeze
+
+          def_delegators :@view, :collection, :database, :read
+
+          # @return [ Array<Hash> ] pipeline The pipeline.
+          attr_reader :pipeline
+
+          # @return [ Collection::View ] view The collection view.
+          attr_reader :view
+
+          # @return [ Hash ] options The map/reduce specific options.
+          attr_reader :options
+
+          # Initialize the builder.
+          #
+          # @example Initialize the builder.
+          #   Aggregation.new(map, reduce, view, options)
+          #
+          # @param [ Array<Hash> ] pipeline The aggregation pipeline.
+          # @param [ Collection::View ] view The collection view.
+          # @param [ Hash ] options The map/reduce options.
+          #
+          # @since 2.2.0
+          def initialize(pipeline, view, options)
+            @pipeline = pipeline
+            @view = view
+            @options = options
+          end
+
+          # Get the specification to pass to the aggregation operation.
+          #
+          # @example Get the specification.
+          #   builder.specification
+          #
+          # @return [ Hash ] The specification.
+          #
+          # @since 2.2.0
+          def specification
+            { selector: aggregation_command, db_name: database.name, read: read }
+          end
+
+          private
+
+          def aggregation_command
+            command = BSON::Document.new(:aggregate => collection.name, :pipeline => pipeline)
+            command[:cursor] = cursor if cursor
+            command[:readConcern] = collection.read_concern if collection.read_concern
+            command.merge!(Options::Mapper.transform_documents(options, MAPPINGS))
+            command
+          end
+
+          def cursor
+            if options[:use_cursor] == true || options[:use_cursor].nil?
+              batch_size_doc
+            end
+          end
+
+          def batch_size_doc
+            (value = options[:batch_size] || view.batch_size) ?  { :batchSize => value } : {}
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mongo/collection/view/builder/find_command.rb

@@ -0,0 +1,111 @@
+# Copyright (C) 2015 MongoDB, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Mongo
+  class Collection
+    class View
+      module Builder
+
+        # Builds a find command specification from options.
+        #
+        # @since 2.2.0
+        class FindCommand
+          extend Forwardable
+
+          # The mappings from ruby options to the find command.
+          #
+          # @since 2.2.0
+          MAPPINGS = BSON::Document.new(
+            sort: 'sort',
+            projection: 'projection',
+            hint: 'hint',
+            skip: 'skip',
+            limit: 'limit',
+            batch_size: 'batchSize',
+            single_batch: 'singleBatch',
+            comment: 'comment',
+            max_scan: 'maxScan',
+            max_time_ms: 'maxTimeMS',
+            max_value: 'max',
+            min_value: 'min',
+            return_key: 'returnKey',
+            show_disk_loc: 'showRecordId',
+            snapshot: 'snapshot',
+            tailable: 'tailable',
+            oplog_replay: 'oplogReplay',
+            no_cursor_timeout: 'noCursorTimeout',
+            await_data: 'awaitData',
+            allow_partial_results: 'allowPartialResults',
+            read_concern: 'readConcern'
+          ).freeze
+
+          def_delegators :@view, :collection, :database, :filter, :options, :read
+
+          # Get the specification for an explain command that wraps the find
+          # command.
+          #
+          # @example Get the explain spec.
+          #   builder.explain_specification
+          #
+          # @return [ Hash ] The specification.
+          #
+          # @since 2.2.0
+          def explain_specification
+            { selector: { explain: find_command }, db_name: database.name, read: read }
+          end
+
+          # Create the find command builder.
+          #
+          # @example Create the find command builder.
+          #   FindCommandBuilder.new(view)
+          #
+          # @param [ Collection::View ] view The collection view.
+          #
+          # @since 2.2.2
+          def initialize(view)
+            @view = view
+          end
+
+          # Get the specification to pass to the find command operation.
+          #
+          # @example Get the specification.
+          #   builder.specification
+          #
+          # @return [ Hash ] The specification.
+          #
+          # @since 2.2.0
+          def specification
+            { selector: find_command, db_name: database.name, read: read }
+          end
+
+          private
+
+          def find_command
+            document = BSON::Document.new('find' => collection.name, 'filter' => filter)
+            command = Options::Mapper.transform_documents(options, MAPPINGS, document)
+            convert_negative_limit(command)
+          end
+
+          def convert_negative_limit(command)
+            if command[:limit] && command[:limit] < 0
+              command.delete('limit')
+              command[:singleBatch] = true
+            end
+            command
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mongo/collection/view/builder/flags.rb

@@ -0,0 +1,62 @@
+# Copyright (C) 2015 MongoDB, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Mongo
+  class Collection
+    class View
+      module Builder
+
+        # Provides behaviour for mapping flags.
+        #
+        # @since 2.2.0
+        module Flags
+          extend self
+
+          # Options to cursor flags mapping.
+          #
+          # @since 2.2.0
+          MAPPINGS = {
+            :allow_partial_results => [ :partial ],
+            :oplog_replay => [ :oplog_replay ],
+            :no_cursor_timeout => [ :no_cursor_timeout ],
+            :tailable => [ :tailable_cursor ],
+            :tailable_await => [ :await_data, :tailable_cursor],
+            :await_data => [ :await_data ],
+            :exhaust => [ :exhaust ]
+          }.freeze
+
+          # Maps an array of flags from the provided options.
+          #
+          # @example Map the flags.
+          #   Flags.map_flags(options)
+          #
+          # @param [ Hash, BSON::Document ] options The options.
+          #
+          # @return [ Array<Symbol> ] The flags.
+          #
+          # @since 2.2.0
+          def map_flags(options)
+            MAPPINGS.each.reduce(options[:flags] || []) do |flags, (key, value)|
+              cursor_type = options[:cursor_type]
+              if options[key] || (cursor_type && cursor_type == key)
+                flags.push(*value)
+              end
+              flags
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mongo/collection/view/builder/map_reduce.rb

@@ -0,0 +1,134 @@
+# Copyright (C) 2015 MongoDB, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Mongo
+  class Collection
+    class View
+      module Builder
+
+        # Builds a map/reduce specification from the view and options.
+        #
+        # @since 2.2.0
+        class MapReduce
+          extend Forwardable
+
+          # The mappings from ruby options to the map/reduce options.
+          #
+          # @since 2.2.0
+          MAPPINGS = BSON::Document.new(
+            finalize: 'finalize',
+            js_mode: 'jsMode',
+            out: 'out',
+            scope: 'scope',
+            verbose: 'verbose',
+            bypass_document_validation: 'bypassDocumentValidation'
+          ).freeze
+
+          def_delegators :@view, :collection, :database, :filter, :read
+
+          # @return [ String ] map The map function.
+          attr_reader :map
+
+          # @return [ String ] reduce The reduce function.
+          attr_reader :reduce
+
+          # @return [ Collection::View ] view The collection view.
+          attr_reader :view
+
+          # @return [ Hash ] options The map/reduce specific options.
+          attr_reader :options
+
+          # Initialize the builder.
+          #
+          # @example Initialize the builder.
+          #   MapReduce.new(map, reduce, view, options)
+          #
+          # @param [ String ] map The map function.
+          # @param [ String ] reduce The reduce function.
+          # @param [ Collection::View ] view The collection view.
+          # @param [ Hash ] options The map/reduce options.
+          #
+          # @since 2.2.0
+          def initialize(map, reduce, view, options)
+            @map = map
+            @reduce = reduce
+            @view = view
+            @options = options
+          end
+
+          # Get the specification for issuing a find command on the map/reduce
+          # results.
+          #
+          # @example Get the command specification.
+          #   builder.command_specification
+          #
+          # @return [ Hash ] The specification.
+          #
+          # @since 2.2.0
+          def command_specification
+            { selector: find_command, db_name: database.name, read: read }
+          end
+
+          # Get the specification for the document query after a map/reduce.
+          #
+          # @example Get the query specification.
+          #   builder.query_specification
+          #
+          # @return [ Hash ] The specification.
+          #
+          # @since 2.2.0
+          def query_specification
+            { selector: {}, options: {}, db_name: database.name, coll_name: query_collection }
+          end
+
+          # Get the specification to pass to the map/reduce operation.
+          #
+          # @example Get the specification.
+          #   builder.specification
+          #
+          # @return [ Hash ] The specification.
+          #
+          # @since 2.2.0
+          def specification
+            { selector: map_reduce_command, db_name: database.name, read: read }
+          end
+
+          private
+
+          def find_command
+            BSON::Document.new('find' => query_collection, 'filter' => {})
+          end
+
+          def map_reduce_command
+            command = BSON::Document.new(
+              :mapreduce => collection.name,
+              :map => map,
+              :reduce => reduce,
+              :query => filter,
+              :out => { inline: 1 }
+            )
+            command[:readConcern] = collection.read_concern if collection.read_concern
+            command.merge!(Options::Mapper.transform_documents(options, MAPPINGS))
+            command.merge!(view.options)
+            command
+          end
+
+          def query_collection
+            options[:out].respond_to?(:keys) ? options[:out].values.first : options[:out]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mongo/collection/view/builder/modifiers.rb

@@ -0,0 +1,80 @@
+# Copyright (C) 2015 MongoDB, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Mongo
+  class Collection
+    class View
+      module Builder
+
+        # Provides behaviour for mapping modifiers.
+        #
+        # @since 2.2.0
+        module Modifiers
+          extend self
+
+          # Mappings from driver options to legacy server values.
+          #
+          # @since 2.2.0
+          DRIVER_MAPPINGS = BSON::Document.new(
+            sort: '$orderby',
+            hint: '$hint',
+            comment: '$comment',
+            snapshot: '$snapshot',
+            max_scan: '$maxScan',
+            max_value: '$max',
+            min_value: '$min',
+            max_time_ms: '$maxTimeMS',
+            return_key: '$returnKey',
+            show_disk_loc: '$showDiskLoc',
+            explain: '$explain'
+          ).freeze
+
+          # Mappings from server values to driver options.
+          #
+          # @since 2.2.0
+          SERVER_MAPPINGS = BSON::Document.new(DRIVER_MAPPINGS.invert).freeze
+
+          # Transform the provided server modifiers to driver options.
+          #
+          # @example Transform to driver options.
+          #   Modifiers.map_driver_options(modifiers)
+          #
+          # @param [ Hash ] modifiers The modifiers.
+          #
+          # @return [ BSON::Document ] The driver options.
+          #
+          # @since 2.2.0
+          def self.map_driver_options(modifiers)
+            Options::Mapper.transform_documents(modifiers, SERVER_MAPPINGS)
+          end
+
+          # Transform the provided options into a document of only server
+          # modifiers.
+          #
+          # @example Map the server modifiers.
+          #   Modifiers.map_server_modifiers(options)
+          #
+          # @param [ Hash, BSON::Document ] options The options.
+          #
+          # @return [ BSON::Document ] The modifiers.
+          #
+          # @since 2.2.0
+          def self.map_server_modifiers(options)
+            Options::Mapper.transform_documents(options, DRIVER_MAPPINGS)
+          end
+        end
+      end
+    end
+  end
+end