mongoid-falsehoods 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 19ae9c57dfad65f292335eed952262330e7b4e5fc99a282786189e2b83a7d35f
+  data.tar.gz: df33f08699f283940d3d1a6ddaae60bcee3458f4cb4f6ba1d348f2a885b4bada
+SHA512:
+  metadata.gz: dcf0106b4ae7af1e2307060d2b893f1e2b03ee0582c34347bc6f05e3b22f91bbc5c5c830bda339f6b50da047ae38decd60f46b8673bcbd8b0c6d3b063764564f
+  data.tar.gz: 40ed04661e5416c9d74fbdee895b0db4fadfe96f7d8a9bccc2a43dec39b9975a927a4838756fc95fc4a06bd812c82d2b9a65a1e58fd4d9f75979cd838a6bb084

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.5
+before_install: gem install bundler -v 2.1.4

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## 0.1.0
+
+Initial release with support for storing `false` instead of `null` for `DateTime` fields.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at joncodes+github@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in mongoid-falsehoods.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,55 @@
+PATH
+  remote: .
+  specs:
+    mongoid-falsehoods (0.1.0)
+      mongoid
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.2.4.2)
+      activesupport (= 5.2.4.2)
+    activesupport (5.2.4.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    bson (4.8.2)
+    concurrent-ruby (1.1.6)
+    diff-lcs (1.3)
+    i18n (1.8.2)
+      concurrent-ruby (~> 1.0)
+    minitest (5.14.0)
+    mongo (2.11.3)
+      bson (>= 4.4.2, < 5.0.0)
+    mongoid (6.4.4)
+      activemodel (>= 5.1, < 6.0.0)
+      mongo (>= 2.5.1, < 3.0.0)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  mongoid-falsehoods!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Jon Evans
+
+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,105 @@
+# Mongoid::Falsehoods
+
+Querying fields in Mongo for those with `null` values will often look like this:
+
+`db.users.find({ deleted_at: null })`
+
+This is inefficient, even if you've indexed `users.deleted_at` because Mongo
+has to look for both documents that have a `null` value in the `deleted_at`
+field and documents that do not have a `deleted_at` field set at all. If you
+look at the explain results, you'll see `"stage": "FETCH"` instead of
+`"stage": "IDXSCAN"`, which is really what we want.
+
+Mongoid does not support storing `false` instead of `null` for `DateTime` fields.
+
+This gem convinces it to allow doing so.
+
+I'd encourage you to do some baseline explain queries, look at the
+`executionTimeMillis` before the change. Then, add the Gem, migrate existing
+data, and see the difference. This is Mongo's estimation of how long it'll take to run the quey.
+
+Here's an example:
+
+```ruby
+# before
+User.where(deleted_at: nil).explain['executionStats']['executionTimeMillis'] # 56
+# after
+User.where(deleted_at: false).explain['executionStats']['executionTimeMillis'] #=> 41
+```
+
+The improvement will vary based on the number of documents. That's with around 8000.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mongoid-falsehoods'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install mongoid-falsehoods
+
+## Usage
+
+Turn code from this:
+
+```ruby
+field :deleted_at, type: DateTime
+
+index({ deleted_at: 1 }, background: true)
+
+def self.not_deleted
+  where(deleted_at: nil)
+end
+
+def active?
+  deleted_at.nil?
+end
+```
+
+to
+
+```ruby
+field :deleted_at, type: DateTime, default: false
+
+index({ deleted_at: 1 }, background: true)
+
+def self.not_deleted
+  where(deleted_at: false)
+end
+
+def active?
+  !deleted_at
+end
+```
+
+You'll also have to migrate existing data:
+
+```ruby
+User.where(deleted_at: null).update_all(deleted_at: false)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, 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/bonusly/mongoid-falsehoods. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/bonusly/mongoid-falsehoods/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Mongo::Falsehoods project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/bonusly/mongoid-falsehoods/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "mongoid/falsehoods"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/mongoid/falsehoods/monkeypatching.rb

@@ -0,0 +1,32 @@
+require 'mongoid'
+
+class FalseClass
+  def __evolve_time__
+    false
+  end
+end
+
+module Mongoid
+  module Extensions
+    module DateTime
+      module ClassMethods
+        alias_method :original_mongoize, :mongoize
+        alias_method :original_demongoize, :demongoize
+
+        def mongoize(object)
+          return false if object == false
+
+          original_mongoize(object)
+        end
+
+        def demongoize(object)
+          return false if object == false
+
+          original_demongoize(object)
+        end
+      end
+    end
+  end
+end
+
+::DateTime.extend(Mongoid::Extensions::DateTime::ClassMethods)

data/lib/mongoid/falsehoods/version.rb

@@ -0,0 +1,5 @@
+module Mongoid
+  module Falsehoods
+    VERSION = "0.1.0"
+  end
+end

data/lib/mongoid/falsehoods.rb

@@ -0,0 +1,8 @@
+require "mongoid/falsehoods/version"
+require "mongoid/falsehoods/monkeypatching"
+
+module Mongoid
+  module Falsehoods
+    class Error < StandardError; end
+  end
+end

data/mongoid-falsehoods.gemspec

@@ -0,0 +1,29 @@
+require_relative 'lib/mongoid/falsehoods/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mongoid-falsehoods"
+  spec.version       = Mongoid::Falsehoods::VERSION
+  spec.authors       = ["Jon Evans"]
+  spec.email         = ["jon@bonus.ly"]
+
+  spec.summary       = %q{Modify Mongoid to allow storing `DateTime` fields as `false` instead of `null`.}
+  spec.description   = %q{Mongo indexes do not handle querying by null values well. If we store them as false instead, we get improved index usage and faster queries.}
+  spec.homepage      = "https://github.com/bonusly/mongoid-falsehoods"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/bonusly/mongoid-falsehoods"
+  spec.metadata["changelog_uri"] = "https://github.com/bonusly/mongoid-falsehoods/blob/master/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency('mongoid')
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: mongoid-falsehoods
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jon Evans
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-04-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Mongo indexes do not handle querying by null values well. If we store
+  them as false instead, we get improved index usage and faster queries.
+email:
+- jon@bonus.ly
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/mongoid/falsehoods.rb
+- lib/mongoid/falsehoods/monkeypatching.rb
+- lib/mongoid/falsehoods/version.rb
+- mongoid-falsehoods.gemspec
+homepage: https://github.com/bonusly/mongoid-falsehoods
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/bonusly/mongoid-falsehoods
+  source_code_uri: https://github.com/bonusly/mongoid-falsehoods
+  changelog_uri: https://github.com/bonusly/mongoid-falsehoods/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.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: Modify Mongoid to allow storing `DateTime` fields as `false` instead of `null`.
+test_files: []