minidoc 2.1.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 003a6c6c6a986d6e5193a35c320500665de4ca191e7e95025cbfaabfb3cfe38b
-  data.tar.gz: f523648aa8f17fd5c338e7bf5306aeba83176c9ff93eba27b5c5f71e4b2a5d02
+  metadata.gz: db222ae3336710cc1304f5c0528c8e92bd57579dd2cf6ae3f1aee9d8b686b131
+  data.tar.gz: 363c7e70ee2e925907cb0fb5ea4d875735cc7b11ef215b2c1f9d41ba829e3d48
 SHA512:
-  metadata.gz: f7dbc5a167eb7154b9c6ac518c3b14bc06a932f9f392ad6f9f7ab9352f370ef9ebc5b0725ee033552dfe3235d11f15d8cc775ec9ac34f1056d0d8964df850518
-  data.tar.gz: 7a5d5e8021410d2c97849e7a8d68df67cd1fad709d8f1b9d6efa4068edb33c8c0953cde2d0d54a691693fcc9c4e357f5525149843411a9edbb12705a48c4d03d
+  metadata.gz: 5a76ee71f56f3325a28e89b5a09f6e8e745a29973b7fa535f4f64dbf0d3659e3d73b8b118b9b88a811269f6fdc78a76c1bd65b554c667ac6205368af1a589ac3
+  data.tar.gz: 12e94541e1bdefd34c7cc3009a4bb2435a3b5e860fa80c546a9e28de1393bb5e34efbbcca327382b18bb057cffdf622319a5a1a2a613399dde938941fa12b5ab

data/lib/minidoc/connection.rb

@@ -12,12 +12,13 @@ module Minidoc::Connection
 
   module ClassMethods
     def collection
-      database[collection_name]
+      validate_config
+      connection.use(database_name)
+      connection[collection_name]
     end
 
     def database
-      validate_config
-      connection[database_name]
+      connection.use(database_name).database
     end
 
     def collection_name=(name)

data/lib/minidoc/counters.rb

@@ -27,10 +27,10 @@ class Minidoc
       end
 
       def increment(step_size = 1)
-        result = record.class.collection.find_and_modify(
-          query: { _id: record.id },
-          update: { "$inc" => { field => step_size } },
-          new: true,
+        result = record.class.collection.find_one_and_update(
+          { _id: record.id },
+          { "$inc" => { field => step_size } },
+          return_document: :after,
         )
 
         result[field.to_s]

data/lib/minidoc/duplicate_key.rb

@@ -1,12 +1,11 @@
-class Minidoc::DuplicateKey < Mongo::OperationFailure
-  DUPLICATE_KEY_ERROR_CODE = 11000
+class Minidoc::DuplicateKey < StandardError
+  DUPLICATE_KEY_ERROR_CODE = "E11000".freeze
 
-  def self.duplicate_key_exception(exception)
-    if exception.respond_to?(:error_code) && exception.error_code == DUPLICATE_KEY_ERROR_CODE
-      new(exception.message, exception.error_code, exception.result)
+  def self.duplicate_key_exception(ex)
+    if ex.is_a?(Mongo::Error::OperationFailure) && ex.message.starts_with?(DUPLICATE_KEY_ERROR_CODE)
+      new(ex.message)
     else
       nil
     end
   end
-
 end

data/lib/minidoc/finders.rb

@@ -1,4 +1,5 @@
 require "active_support/concern"
+require "forwardable"
 
 module Minidoc::Finders
   extend ActiveSupport::Concern
@@ -15,7 +16,7 @@ module Minidoc::Finders
     end
 
     def count(selector = {})
-      collection.count(query: selector)
+      collection.count_documents(selector)
     end
 
     def exists?(selector = {})
@@ -24,17 +25,21 @@ module Minidoc::Finders
 
     def find(id_or_selector, options = {})
       if id_or_selector.is_a?(Hash)
-        options.merge!(transformer: method(:wrap))
-        collection.find(id_or_selector, options)
+        ResultSet.new(collection.find(id_or_selector, options), wrapper)
       else
         raise ArgumentError unless options.empty?
         id = BSON::ObjectId(id_or_selector.to_s)
-        wrap(collection.find_one(_id: id))
+        wrapper.call(collection.find(_id: id).first)
       end
     end
 
     def find_one(selector = {}, options = {})
-      wrap(collection.find_one(selector, options))
+      # running collection.find({}).first will leave the cursor open unless we iterate across all of the documents
+      # so in order to do not let a cusror open we want to kill the cursor after having grabbed the first document
+      view = collection.find(selector, options)
+      wrapped_doc = wrapper.call(view.first)
+      view.close_query
+      wrapped_doc
     end
 
     def find_one!(selector = {}, options = {})
@@ -54,14 +59,39 @@ module Minidoc::Finders
       doc
     end
 
-    def wrap(doc)
-      return nil unless doc
+    def wrapper
+      @wrapper ||= proc do |doc|
+        if doc
+          if doc.is_a?(Array) || doc.is_a?(Mongo::Cursor)
+            doc.map { |d| from_db(d) }
+          else
+            from_db(doc)
+          end
+        end
+      end
+    end
+  end
+
+  class ResultSet
+    include Enumerable
 
-      if doc.is_a?(Array) || doc.is_a?(Mongo::Cursor)
-        doc.map { |d| from_db(d) }
+    def initialize(view, doc_wrapper)
+      @view = view
+      @doc_wrapper = doc_wrapper
+    end
+
+    def each(&_block)
+      if block_given?
+        @view.each do |doc|
+          yield @doc_wrapper.call(doc)
+        end
       else
-        from_db(doc)
+        to_enum
       end
     end
+
+    def count
+      @view.count_documents
+    end
   end
 end

data/lib/minidoc/grid.rb

@@ -1,7 +1,18 @@
-class Minidoc::Grid < Mongo::Grid
+class Minidoc::Grid
+  def initialize(database)
+    @bucket = Mongo::Grid::FSBucket.new(database)
+  end
+
+  def put(str, filename = SecureRandom.uuid)
+    bucket.upload_from_stream(filename, StringIO.new(str))
+  end
+
   def get(id)
     id = BSON::ObjectId(id.to_s)
-    super(id)
+    io = StringIO.new
+    bucket.download_to_stream(id, io)
+    io.rewind
+    io
   end
 
   def get_json(id)
@@ -11,6 +22,10 @@ class Minidoc::Grid < Mongo::Grid
 
   def delete(id)
     id = BSON::ObjectId(id.to_s)
-    super(id)
+    bucket.delete(id)
   end
+
+  private
+
+  attr_reader :bucket
 end

data/lib/minidoc/test_helpers.rb

@@ -12,7 +12,7 @@ class Minidoc
     end
 
     def clear_collections(connection = Minidoc.connection)
-      each_collection(connection) { |c| c.remove({}) }
+      each_collection(connection, &:drop)
     end
 
     def clear_indexes(connection = Minidoc.connection)
@@ -20,7 +20,7 @@ class Minidoc
     end
 
     def each_collection(connection, &block)
-      connection.db.collections.
+      connection.collections.
         reject { |c| c.name.include?("system") }.
         each(&block)
     end

data/lib/minidoc/version.rb

@@ -1,3 +1,3 @@
 class Minidoc
-  VERSION = "2.1.0".freeze
+  VERSION = "3.0.0".freeze
 end

data/lib/minidoc.rb

@@ -41,7 +41,7 @@ class Minidoc
   end
 
   def self.delete(id)
-    collection.remove(_id: BSON::ObjectId(id.to_s))
+    collection.delete_one(_id: BSON::ObjectId(id.to_s))
   end
 
   def self.set(id, attributes)
@@ -61,12 +61,12 @@ class Minidoc
   end
 
   def self.update_one(id, updates)
-    collection.update({ "_id" => id }, updates)
+    collection.update_one({ "_id" => id }, updates)
   end
 
   def self.atomic_set(query, attributes)
-    result = collection.update(query, "$set" => attributes)
-    result["ok"] == 1 && result["n"] == 1
+    result = collection.update_one(query, "$set" => attributes)
+    result.ok? && result.n == 1
   end
 
   def self.value_class
@@ -85,7 +85,7 @@ class Minidoc
     yield
   rescue Minidoc::DuplicateKey
     false
-  rescue Mongo::OperationFailure => ex
+  rescue Mongo::Error::OperationFailure => ex
     if Minidoc::DuplicateKey.duplicate_key_exception(ex)
       false
     else
@@ -193,7 +193,7 @@ private
     new_record? ? create : update
     @new_record = false
     true
-  rescue Mongo::OperationFailure => exception
+  rescue Mongo::Error::OperationFailure => exception
     if (duplicate_key_exception = Minidoc::DuplicateKey.duplicate_key_exception(exception))
       raise duplicate_key_exception
     else
@@ -202,11 +202,11 @@ private
   end
 
   def create
-    self.class.collection << attributes
+    self.class.collection.insert_one(attributes)
   end
 
   def update
-    self.class.collection.update({ _id: id }, { "$set" => attributes.except(:_id) })
+    self.class.collection.update_one({ _id: id }, { "$set" => attributes.except(:_id) })
   end
 
   if ActiveSupport.respond_to?(:run_load_hooks)

data/spec/minidoc/connection_spec.rb

@@ -29,7 +29,7 @@ describe "connection" do
 
   describe ".database" do
     it "exposes the underlying Mongo object" do
-      expect(User.database).to be_a Mongo::DB
+      expect(User.database).to be_a Mongo::Database
     end
 
     it "passes through the database name to the underlying Mongo::DB" do

data/spec/minidoc/finders_spec.rb

@@ -3,8 +3,8 @@ require "spec_helper"
 describe Minidoc::Finders do
   describe ".all" do
     it "returns all of the documents in the collection" do
-      (User.collection << { name: "Joe" })
-      (User.collection << { name: "Bryan" })
+      User.collection.insert_one(name: "Joe")
+      User.collection.insert_one(name: "Bryan")
       users = User.all
       expect(["Bryan", "Joe"]).to match_array(users.map(&:name))
     end
@@ -12,21 +12,21 @@ describe Minidoc::Finders do
 
   describe ".count" do
     it "counts the documents in the collection" do
-      (User.collection << { name: "Joe" })
-      (User.collection << { name: "Bryan" })
+      User.collection.insert_one(name: "Joe")
+      User.collection.insert_one(name: "Bryan")
       expect(User.count).to eq 2
     end
 
     it "can be scoped by a query" do
-      (User.collection << { name: "Joe" })
-      (User.collection << { name: "Bryan" })
+      User.collection.insert_one(name: "Joe")
+      User.collection.insert_one(name: "Bryan")
       expect(User.count(name: "Bryan")).to eq 1
     end
   end
 
   describe ".exists?" do
     it "tells you if any documents exist that match a query" do
-      (User.collection << { name: "Joe" })
+      User.collection.insert_one(name: "Joe")
       expect(User.exists?(name: "Joe")).to be(true)
       expect(User.exists?(name: "Bryan")).to be(false)
     end

data/spec/minidoc/grid_spec.rb

@@ -10,7 +10,6 @@ describe Minidoc::Grid do
 
       document = grid.get doc_id.to_s
 
-      expect(document).to be_a Mongo::GridIO
       expect(document.read).to eq "estamos en espana"
     end
   end
@@ -30,9 +29,9 @@ describe Minidoc::Grid do
     it "removes the 'file' from the database" do
       doc_id = grid.put "estamos en espana"
 
+      expect(grid.get(doc_id).read).to eq("estamos en espana")
       grid.delete doc_id.to_s
-
-      expect { grid.get doc_id }.to raise_error(Mongo::GridFileNotFound)
+      expect { grid.get(doc_id) }.to raise_error(Mongo::Error::FileNotFound)
     end
   end
 end

data/spec/minidoc/read_only_spec.rb

@@ -3,12 +3,15 @@ require "spec_helper"
 describe Minidoc::ReadOnly do
   class ReadOnlyUser < Minidoc::ReadOnly
     self.collection_name = "users"
+    self.database_name = "minidoc_test"
+    self.connection = $mongo
+
     attribute :name, String
   end
 
   class AltModel < Minidoc::ReadOnly
     self.connection = $alt_mongo
-    self.database_name = $alt_mongo.db.name
+    self.database_name = $alt_mongo.database.name
 
     attribute :name, String
   end
@@ -27,7 +30,7 @@ describe Minidoc::ReadOnly do
 
   it "can have a separate mongo connection" do
     expect(AltModel.count).to eq(0)
-    $alt_mongo.db[:alt_models].insert(name: "42")
+    $alt_mongo.database[:alt_models].insert_one(name: "42")
     expect(AltModel.count).to eq(1)
 
     instance = AltModel.find_one(name: "42")

data/spec/minidoc_spec.rb

@@ -95,7 +95,7 @@ describe Minidoc do
     it "raises Minidoc::DuplicateKey where appropriate" do
       collection = double
       expect(User).to receive(:collection).and_return(collection)
-      expect(collection).to receive(:<<).and_raise(Mongo::OperationFailure.new("Duplicate key exception", Minidoc::DuplicateKey::DUPLICATE_KEY_ERROR_CODE))
+      expect(collection).to receive(:insert_one).and_raise(Mongo::Error::OperationFailure.new("E11000 Boooo"))
       user = User.new
 
       expect { user.save }.to raise_error(Minidoc::DuplicateKey)
@@ -104,7 +104,7 @@ describe Minidoc do
     it "doesn't suppress errors it shouldn't" do
       collection = double
       expect(User).to receive(:collection).and_return(collection)
-      expect(collection).to receive(:<<).and_raise(ArgumentError)
+      expect(collection).to receive(:insert_one).and_raise(ArgumentError)
       user = User.new
 
       expect { user.save }.to raise_error(ArgumentError)
@@ -260,7 +260,7 @@ describe Minidoc do
       user = User.create!(name: "Bryan")
       expect(user.reload.name).to eq "Bryan"
 
-      User.collection.update({ :_id => user.id }, name: "Noah")
+      User.collection.update_one({ :_id => user.id }, name: "Noah")
       expect(user.name).to eq "Bryan"
 
       user.reload

data/spec/spec_helper.rb

@@ -1,4 +1,10 @@
 require "simplecov"
+
+if ENV["CI"]
+  require "simplecov_json_formatter"
+  SimpleCov.formatter = SimpleCov::Formatter::JSONFormatter
+end
+
 SimpleCov.start do
   add_filter "/test/"
 end
@@ -22,12 +28,16 @@ class SecondUser < Minidoc
   attribute :age, Integer
 end
 
-$mongo = Mongo::MongoClient.from_uri(ENV["MONGODB_URI"] || "mongodb://localhost/minidoc_test")
+uri = Mongo::URI.new(ENV["MONGODB_URI"] || "mongodb://localhost:27017")
+
+$mongo = Mongo::Client.new(uri.servers, uri.client_options)
+$mongo.logger.level = Logger::FATAL
+
 Minidoc.connection = $mongo
-Minidoc.database_name = $mongo.db.name
+Minidoc.database_name = $mongo.database.name
 
-alt_url = "mongodb://#{$mongo.host}/#{$mongo.db.name}_2"
-$alt_mongo = Mongo::MongoClient.from_uri(alt_url)
+options = uri.options.merge(database: "#{uri.database}_2")
+$alt_mongo = Mongo::Client.new(uri.servers, options)
 
 RSpec.configure do |config|
   if config.files_to_run.one?

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: minidoc
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Bryan Helmkamp
 - Code Climate
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-05-10 00:00:00.000000000 Z
+date: 2023-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -52,40 +52,46 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '6'
 - !ruby/object:Gem::Dependency
-  name: virtus
+  name: mongo
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.0
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.14'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 2.14.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.0
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.14'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 2.14.1
 - !ruby/object:Gem::Dependency
-  name: mongo
+  name: virtus
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
-description: 
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+description:
 email:
 - bryan@brynary.com
 - hello@codeclimate.com
@@ -122,7 +128,7 @@ homepage: https://github.com/codeclimate/minidoc
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -137,8 +143,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Lightweight wrapper for MongoDB documents
 test_files: