minidoc 1.0.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a39428fa02e34cc7687e65ebc52bda5a0dfa5417
-  data.tar.gz: 4bb38f83b40229e7709bb57689388cf8601671fa
+  metadata.gz: f94229d111dbbb7b7abdaaf21036b775c4dae1f0
+  data.tar.gz: 79957eed89f74d4564806d05e12b0f6c095e3bc2
 SHA512:
-  metadata.gz: 3e03054151882676cae311c7967eac76b82461c7cf51eff00edac9edfec77ea8f61f7bb4476825d104150c7d44c5235e80aab8b9b626c3d9353fbf53300c1f12
-  data.tar.gz: ad3cf4397561d99fd462a2a42dbfe3a167a9b197566073480f8204b719bb349cb156bdd7ab11895929c7b8e77e69f17fa9966a6c7a766f78e23a803dcb8bcfdc
+  metadata.gz: 3a74d5b6d68dbfd2abd69b669ca8ac5be982da8cfe643357aa4707f1a0e5d9a0bcd13942dd4be8ea541cb1ab957b3c6ad0b8d80a9e49a694eda2b5b5741a43c6
+  data.tar.gz: eb0c2fb02647e48fbce4e3ca68f9868d82f26d2032741ea312697ffc041a2ebcfa6033464aa6d2e95c5b4176782681b296876bf8afff4c8f08c8023739e565a2

data/lib/minidoc.rb

@@ -79,28 +79,6 @@ class Minidoc
     end
   end
 
-  # For databases that support it (e.g. TokuMX), perform the block within a
-  # transaction. For information on the +isolation+ argument, see
-  # https://www.percona.com/doc/percona-tokumx/commands.html#beginTransaction
-  def self.transaction(isolation = "mvcc")
-    return yield unless tokumx?
-
-    begin
-      database.command(beginTransaction: 1, isolation: isolation)
-      yield
-    rescue Exception => error
-      database.command(rollbackTransaction: 1) rescue nil
-      raise
-    ensure
-      begin
-        database.command(commitTransaction: 1) unless error
-      rescue Exception
-        database.command(rollbackTransaction: 1)
-        raise
-      end
-    end
-  end
-
   # Rescue a duplicate key exception in the given block. Returns the result of
   # the block, or +false+ if the exception was raised.
   def self.rescue_duplicate_key_errors
@@ -115,11 +93,6 @@ class Minidoc
     end
   end
 
-  def self.tokumx?
-    @server_info ||= connection.server_info
-    @server_info.key?("tokumxVersion")
-  end
-
   def initialize(attrs = {})
     if attrs["_id"].nil? && attrs[:_id].nil?
       attrs[:_id] = BSON::ObjectId.new

data/lib/minidoc/associations.rb

@@ -28,6 +28,11 @@ module Minidoc::Associations
       define_method(association_name) do
         read_association(association_name)
       end
+
+      define_method("#{association_name}!") do
+        read_association(association_name) or
+          raise Minidoc::DocumentNotFoundError
+      end
     end
   end
 

data/lib/minidoc/version.rb

@@ -1,3 +1,3 @@
 class Minidoc
-  VERSION = "1.0.1".freeze
+  VERSION = "2.0.0".freeze
 end

data/spec/minidoc/associations_spec.rb

@@ -30,8 +30,16 @@ describe Minidoc::Associations do
       user = User.create
       cat = Cat.new(owner_id: user.id)
       expect(cat.owner.id).to eq user.id
+      expect(cat.owner!.id).to eq user.id
       cat.save
       expect(cat.owner.id).to eq user.id
+      expect(cat.owner!.id).to eq user.id
+    end
+
+    it "defines methods that raise when not found" do
+      cat = Cat.new
+      cat.owner_id = BSON::ObjectId.new
+      expect { cat.owner! }.to raise_error(Minidoc::DocumentNotFoundError)
     end
 
     it "caches the association cache rather than go to the database each time" do

data/spec/spec_helper.rb

@@ -22,9 +22,9 @@ class SecondUser < Minidoc
   attribute :age, Integer
 end
 
-$mongo = Mongo::MongoClient.from_uri(ENV["MONGODB_URI"] || "mongodb://localhost")
+$mongo = Mongo::MongoClient.from_uri(ENV["MONGODB_URI"] || "mongodb://localhost/minidoc_test")
 Minidoc.connection = $mongo
-Minidoc.database_name = "minidoc_test"
+Minidoc.database_name = $mongo.db.name
 
 RSpec.configure do |config|
   if config.files_to_run.one?

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: minidoc
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Bryan Helmkamp
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-31 00:00:00.000000000 Z
+date: 2017-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -93,18 +93,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".codeclimate.yml"
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- ".ruby-version"
-- ".travis.yml"
-- CHANGELOG.md
-- CODE_OF_CONDUCT.md
-- Gemfile
-- LICENSE.txt
-- README.md
-- Rakefile
 - lib/minidoc.rb
 - lib/minidoc/associations.rb
 - lib/minidoc/autoload.rb
@@ -120,8 +108,6 @@ files:
 - lib/minidoc/validations.rb
 - lib/minidoc/value.rb
 - lib/minidoc/version.rb
-- minidoc.gemspec
-- spec/locale/en.yml
 - spec/minidoc/associations_spec.rb
 - spec/minidoc/connection_spec.rb
 - spec/minidoc/counters_spec.rb
@@ -157,7 +143,6 @@ signing_key:
 specification_version: 4
 summary: Lightweight wrapper for MongoDB documents
 test_files:
-- spec/locale/en.yml
 - spec/minidoc/associations_spec.rb
 - spec/minidoc/connection_spec.rb
 - spec/minidoc/counters_spec.rb

data/.codeclimate.yml

@@ -1,16 +0,0 @@
----
-engines:
-  duplication:
-    enabled: true
-    config:
-      languages:
-      - ruby
-  fixme:
-    enabled: true
-  rubocop:
-    enabled: true
-ratings:
-  paths:
-  - "**.rb"
-exclude_paths:
-- spec/

data/.gitignore

@@ -1,17 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp

data/.rspec

@@ -1,2 +0,0 @@
---color
---require spec_helper

data/.rubocop.yml

@@ -1,152 +0,0 @@
-################################################################################
-# Metrics
-################################################################################
-
-Metrics/LineLength:
-  Enabled: false
-
-Metrics/AbcSize:
-  Enabled: false
-
-################################################################################
-# Style
-################################################################################
-
-# Executables are conventionally named bin/foo-bar
-Style/FileName:
-  Exclude:
-  - bin/**/*
-
-# We don't (currently) document our code
-Style/Documentation:
-  Enabled: false
-
-# Always use double-quotes to keep things simple
-Style/StringLiterals:
-  EnforcedStyle: double_quotes
-
-Style/StringLiteralsInInterpolation:
-  EnforcedStyle: double_quotes
-
-# Use a trailing comma to keep diffs clean when elements are inserted or removed
-Style/TrailingCommaInArguments:
-  EnforcedStyleForMultiline: comma
-
-Style/TrailingCommaInLiteral:
-  EnforcedStyleForMultiline: comma
-
-# We avoid GuardClause because it can result in "suprise return"
-Style/GuardClause:
-  Enabled: false
-
-# We avoid IfUnlessModifier because it can result in "suprise if"
-Style/IfUnlessModifier:
-  Enabled: false
-
-# We don't care about the fail/raise distinction
-Style/SignalException:
-  EnforcedStyle: only_raise
-
-Style/DotPosition:
-  EnforcedStyle: trailing
-
-# Common globals we allow
-Style/GlobalVars:
-  AllowedVariables:
-  - "$statsd"
-  - "$mongo"
-  - "$rollout"
-
-# Using english names requires loading an extra module, which is annoying, so
-# we prefer the perl names for consistency.
-Style/SpecialGlobalVars:
-  EnforcedStyle: use_perl_names
-
-# We have common cases where has_ and have_ make sense
-Style/PredicateName:
-  Enabled: true
-  NamePrefixBlacklist:
-  - is_
-
-# We use %w[ ], not %w( ) because the former looks like an array
-Style/PercentLiteralDelimiters:
-  PreferredDelimiters:
-    "%i": "[]"
-    "%I": "[]"
-    "%w": "[]"
-    "%W": "[]"
-
-# Allow "trivial" accessors when defined as a predicate? method
-Style/TrivialAccessors:
-  AllowPredicates: true
-
-Style/Next:
-  Enabled: false
-
-# We think it's OK to use the "extend self" module pattern
-Style/ModuleFunction:
-  Enabled: false
-
-# Disallow extra spacing for token alignment
-Style/ExtraSpacing:
-  AllowForAlignment: false
-
-# and/or in conditionals has no meaningful difference (only gotchas), so we
-# disallow them there. When used for control flow, the difference in precedence
-# can make for a less noisy expression, as in:
-#
-#   x = find_x or raise XNotFound
-#
-Style/AndOr:
-  EnforcedStyle: conditionals
-
-Style/AlignParameters:
-  EnforcedStyle: with_fixed_indentation
-
-Style/MultilineOperationIndentation:
-  EnforcedStyle: indented
-
-Style/AlignHash:
-  EnforcedLastArgumentHashStyle: ignore_implicit
-
-# This has the behavior we want, but it has a bug in it which produces a lot of false positives
-# https://github.com/bbatsov/rubocop/issues/3462
-# MultilineMethodCallBraceLayout:
-#   EnforcedStyle: new_line
-
-################################################################################
-# Performance
-################################################################################
-
-Performance/RedundantMerge:
-  Enabled: false
-
-################################################################################
-# Rails - disable things because we're primarily non-rails
-################################################################################
-
-Rails/Delegate:
-  Enabled: false
-
-Rails/TimeZone:
-  Enabled: false
-
-################################################################################
-# Specs - be more lenient on length checks and block styles
-################################################################################
-
-Metrics/ModuleLength:
-  Exclude:
-  - spec/**/*
-
-Metrics/MethodLength:
-  Exclude:
-  - spec/**/*
-
-Style/ClassAndModuleChildren:
-  Exclude:
-  - spec/**/*
-
-Style/BlockDelimiters:
-  Exclude:
-  - spec/**/*

data/.ruby-version

@@ -1 +0,0 @@
-2.3.1

data/.travis.yml

@@ -1,12 +0,0 @@
-language: ruby
-rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.1
-services: mongodb
-before_install:
-  - gem update bundler
-script:
-  - rake
-after_script:
-  - CODECLIMATE_REPO_TOKEN=787a2f89b15c637323c7340d65ec17e898ac44480706b4b4122ea040c2a88f1d bundle exec codeclimate-test-reporter

data/CHANGELOG.md

@@ -1,65 +0,0 @@
-# Change log
-
-## master (unreleased)
-
-### New features
-
-### Bug fixes
-
-### Changes
-
-## v1.0.1 (2016-10-31)
-
-### Bug fixes
-
-* Updated `updated_at` when enabled from all setter methods. ([@wfleming][])
-
-## v1.0.0 (2016-10-27)
-
-No changes! Same as v1.0.0.rc2
-
-:tada:
-
-## v1.0.0.rc2 (2016-10-26)
-
-### New features
-
-* Allow omitting selectors to finder methods. ([@maxjacobson][])
-
-### Bug fixes
-
-* Minidoc#reload will raise Minidoc::DocumentNotFoundError when the document no longer exists, rather than a nil error. ([@maxjacobson][])
-
-### Changes
-
-* Make Minidoc.wrap and Minidoc.from_db private. ([@maxjacobson][])
-
-## v1.0.0.rc1 (2016-09-29)
-
-### New features
-
-* [#24](https://github.com/codeclimate/minidoc/pull/24): Add `Minidoc.all`. ([@pbrisbin][])
-* [#24](https://github.com/codeclimate/minidoc/pull/24): Add `Minidoc.find_one!`. ([@pbrisbin][])
-* [#28](https://github.com/codeclimate/minidoc/pull/28): Add `Minidoc.find_one_or_initialize`. ([@nporteschaikin][])
-* [#32](https://github.com/codeclimate/minidoc/pull/32): Infer class names for associations when not provided. ([@wfleming][])
-
-### Bug fixes
-
-* [#26](https://github.com/codeclimate/minidoc/pull/26): Improve performance of `Minidoc.exists?`. ([@wfleming][])
-* [#31](https://github.com/codeclimate/minidoc/pull/31): Fix `save` dropping some attributes. ([@nporteschaikin][])
-* Improve errors when the user has forgotten to provide database connection information. ([@maxjacobson][])
-
-### Changes
-
-* [#23](https://github.com/codeclimate/minidoc/pull/23): Remove `ensure_index`. ([@pbrisbin][])
-
-## v0.0.1 (2016-09-28)
-
-Minidoc was originally created by [@brynary][] and has been used in production extensively at Code Climate.
-This is the first version released to rubygems.
-
-[@brynary]: https://github.com/brynary
-[@maxjacobson]: https://github.com/maxjacobson
-[@nporteschaikin]: https://github.com/nporteschaikin
-[@pbrisbin]: https://github.com/pbrisbin
-[@wfleming]: https://github.com/wfleming

data/CODE_OF_CONDUCT.md

@@ -1,49 +0,0 @@
-# Contributor Code of Conduct
-
-As contributors and maintainers of this project, and in the interest of
-fostering an open and welcoming community, we pledge to respect all people who
-contribute through reporting issues, posting feature requests, updating
-documentation, submitting pull requests or patches, and other activities.
-
-We are committed to making participation in this project a harassment-free
-experience for everyone, regardless of level of experience, gender, gender
-identity and expression, sexual orientation, disability, personal appearance,
-body size, race, ethnicity, age, religion, or nationality.
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery
-* Personal attacks
-* Trolling or insulting/derogatory comments
-* Public or private harassment
-* Publishing other's private information, such as physical or electronic
-  addresses, without explicit permission
-* Other unethical or unprofessional conduct
-
-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.
-
-By adopting this Code of Conduct, project maintainers commit themselves to
-fairly and consistently applying these principles to every aspect of managing
-this project. Project maintainers who do not follow or enforce the Code of
-Conduct may be permanently removed from the project team.
-
-This code of conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community.
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting a project maintainer at hello@codeclimate.com. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. Maintainers are
-obligated to maintain confidentiality with regard to the reporter of an
-incident.
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage],
-version 1.3.0, available at
-[http://contributor-covenant.org/version/1/3/0/][version]
-
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -1,8 +0,0 @@
-source "https://rubygems.org"
-
-gem "codeclimate-test-reporter", "1.0.0.pre.rc2"
-gem "rake"
-gem "rspec"
-gem "simplecov"
-
-gemspec

data/LICENSE.txt

@@ -1,22 +0,0 @@
-Copyright (c) 2016 Bryan Helmkamp
-
-MIT License
-
-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

@@ -1,154 +0,0 @@
-[![Build Status](https://travis-ci.org/codeclimate/minidoc.svg)](https://travis-ci.org/codeclimate/minidoc)
-[![Gem Version](https://badge.fury.io/rb/minidoc.svg)](http://badge.fury.io/rb/minidoc)
-[![Code Climate](https://codeclimate.com/github/codeclimate/minidoc/badges/gpa.svg)](https://codeclimate.com/github/codeclimate/minidoc)
-[![Test Coverage](https://codeclimate.com/github/codeclimate/minidoc/badges/coverage.svg)](https://codeclimate.com/github/codeclimate/minidoc/coverage)
-
-# Minidoc
-
-Minidoc is an extremely lightweight layer on top of the MongoDB client to
-make interacting with documents from Ruby more convenient.
-
-We rely heavily on the MongoDB client, Virtus and ActiveModel to keep
-things as simple as possible.
-
-## Features
-
-* Interact with Ruby objects instead of hashes
-* Full access to the powerful MongoDB client
-* Thread safe (hopefully)
-* Simple and easily extensible
-* ActiveModel-compatible
-* Validations
-* Timestamp tracking (created_at/updated_at)
-* Very basic associations (for reads)
-* Conversion into immutable value objects
-* Read-only records
-
-## Anti-Features
-
-* Custom query API (just use Mongo)
-* Callbacks (just define a method like save and call super)
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem "minidoc"
-```
-
-And then execute:
-
-```
-$ bundle
-```
-
-Or install it yourself as:
-
-```
-$ gem install minidoc
-```
-
-## Usage
-
-### Setup
-
-```ruby
-Minidoc.connection = Mongo::MongoClient.from_uri("mongodb://localhost")
-Minidoc.database_name = "my_great_app_development"
-```
-
-### Basics
-
-```ruby
-class User < Minidoc
-  include Minidoc::Timestamps
-
-  attribute :name, String
-  attribute :language, String
-  timestamps!
-end
-
-user = User.create!(name: "Bryan", language: "Cobol")
-User.count # => 1
-
-user.language = "Lisp"
-user.save!
-
-user.set(language: "Fortran")
-
-user.destroy
-User.count # => 0
-```
-
-### Validations
-
-Just uses [`ActiveModel::Validations`](http://api.rubyonrails.org/classes/ActiveModel/Validations.html):
-
-```ruby
-class User < Minidoc
-  attribute :name, String
-
-  validates :name, presence: true
-end
-
-user = User.new
-user.valid? # => false
-user.name = "Bryan"
-user.valid? # => true
-```
-
-### Value Objects
-
-```ruby
-bryan = User.create(name: "Bryan").as_value
-bryan.name #=> "Bryan"
-bryan.name = "Brian" #=> NoMethodError
-```
-
-### Associations
-
-```ruby
-class Drink < Minidoc
-  include Minidoc::Associations
-
-  attribute :name, String
-
-  belongs_to :user
-end
-
-bryan = User.create(name: "Bryan")
-drink = Drink.create(name: "Paloma", user: bryan)
-drink.user == bryan #=> true
-```
-
-### Read-only records
-
-```ruby
-class DrinkEvents < Minidoc::ReadOnly
-  include Minidoc::Timestamps
-  timestamps!
-end
-
-DrinkEvents.count(created_at: { "$gt": 4.days.ago }) #=> 0
-DrinkEvents.create #=> NoMethodError
-```
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/codeclimate/minidoc. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
-
-When making a pull request, please update the [changelog](CHANGELOG.md).
-
-## Releasing
-
-* Update the changelog to mark the unreleased changes as part of the new release.
-* Update the version.rb with the new version number
-* Make a pull request with those changes
-* Merge those changes to master
-* Check out and pull down the latest master locally
-* `rake release` which will
-  * tag the latest commit based on version.rb
-  * push to github
-  * push to rubygems
-* Copy the relevant changelog entries into a new [GitHub release](https://github.com/codeclimate/minidoc/releases).

data/Rakefile

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

data/minidoc.gemspec

@@ -1,24 +0,0 @@
-# coding: utf-8
-lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "minidoc/version"
-
-Gem::Specification.new do |spec|
-  spec.name = "minidoc"
-  spec.version = Minidoc::VERSION
-  spec.authors = ["Bryan Helmkamp", "Code Climate"]
-  spec.email = ["bryan@brynary.com", "hello@codeclimate.com"]
-  spec.summary = %q{Lightweight wrapper for MongoDB documents}
-  spec.homepage = "https://github.com/codeclimate/minidoc"
-  spec.license = "MIT"
-
-  spec.files = `git ls-files`.split($/)
-  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
-
-  spec.add_dependency "activesupport", ">= 3.0.0", "< 5"
-  spec.add_dependency "activemodel", ">= 3.0.0", "< 5"
-  spec.add_dependency "virtus", "~> 1.0", ">= 1.0.0"
-  spec.add_dependency "mongo", "~> 1"
-end

data/spec/locale/en.yml

@@ -1,5 +0,0 @@
-en:
-  activemodel:
-    errors:
-      messages:
-        taken: "has already been taken"