minidoc 0.0.1 → 1.0.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bab3513e3711be6f000b2087acd5df2c327ed60f
-  data.tar.gz: 7cc05456284d80bbdba422cf58c93a829c45592b
+  metadata.gz: ca8f2d071dcb6f2ef8e43e9d995e36ef0b1d4c6e
+  data.tar.gz: 0b0a1037fa259ab0602d2e21401a368495739803
 SHA512:
-  metadata.gz: 4d4c5d33c49a995a7d65186a9da8390aac2a0ae87340ad58c38452288bea0c424ac9e7c1d58c77fc171937ae6e1c14a36620df188586b1d5b8ff8dbad5b0638e
-  data.tar.gz: 8fbe9a2e11e6c9c37a773f41ec0c832bbe99584170fff167aa423488e01522d8d0ef619798a6185272e763abfb4840dd89f240ed4fc1c5fb44b4b6f0a192a06e
+  metadata.gz: d5029b2a00f9427603fe3b3e50270959b1333c0312bd8b50fcd5b8b1d1d9144724a1d893e2bc77f6497435047def4f3fe3f9ce4deaeecc8f14639590f9f66ba4
+  data.tar.gz: c398c3570ac71d56aef8a27309ab3c8a4321e172ee829403e8050a64542944288f96a750a1fc24e826f3ecfe5a592df4661c3a528b1bc42f725c5de88b6b7dac

data/.codeclimate.yml

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

data/.rubocop.yml

@@ -0,0 +1,152 @@
+################################################################################
+# 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 +1 @@
-1.9.3-p545
+2.3.1

data/.travis.yml

@@ -6,3 +6,7 @@ rvm:
 services: mongodb
 before_install:
   - gem update bundler
+script:
+  - rake
+after_script:
+  - CODECLIMATE_REPO_TOKEN=787a2f89b15c637323c7340d65ec17e898ac44480706b4b4122ea040c2a88f1d bundle exec codeclimate-test-reporter

data/CHANGELOG.md

@@ -0,0 +1,39 @@
+# Change log
+
+## master (unreleased)
+
+### New features
+
+### Bug fixes
+
+### Changes
+
+## 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

@@ -0,0 +1,49 @@
+# 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,2 +1,9 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
+
+gem "minitest"
+gem "mocha"
+gem "rake"
+gem "simplecov"
+gem "codeclimate-test-reporter", "1.0.0.pre.rc2"
+
 gemspec

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2013 Bryan Helmkamp
+Copyright (c) 2016 Bryan Helmkamp
 
 MIT License
 

data/README.md

@@ -1,5 +1,7 @@
-[![Code Climate](https://codeclimate.com/github/brynary/minidoc.svg)](https://codeclimate.com/github/brynary/minidoc)
-[![Build Status](https://travis-ci.org/brynary/minidoc.svg)](https://travis-ci.org/brynary/minidoc)
+[![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
 
@@ -27,14 +29,41 @@ things as simple as possible.
 * 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
 
-    gem "minidoc", "~> 0.0.1"
+### 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!
@@ -71,6 +100,53 @@ 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
+* Commit and push to master
+* `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,10 +1,10 @@
 require "bundler/gem_tasks"
-require 'rake/testtask'
+require "rake/testtask"
 
 Rake::TestTask.new do |t|
   t.libs.push "lib"
   t.ruby_opts = %w[-W0]
-  t.test_files = FileList['test/*_test.rb']
+  t.test_files = FileList["test/*_test.rb"]
   t.verbose = true
 end
 

data/lib/minidoc.rb

@@ -4,20 +4,18 @@ require "active_model"
 require "active_support/core_ext"
 
 class Minidoc
-  VERSION = "0.0.1"
-
   require "minidoc/associations"
   require "minidoc/connection"
   require "minidoc/counters"
   require "minidoc/finders"
   require "minidoc/grid"
-  require "minidoc/indexes"
   require "minidoc/read_only"
   require "minidoc/record_invalid"
   require "minidoc/duplicate_key"
   require "minidoc/timestamps"
   require "minidoc/validations"
   require "minidoc/value"
+  require "minidoc/version"
 
   include Connection
   include Finders
@@ -235,7 +233,7 @@ private
   end
 
   def update
-    self.class.collection.update({ _id: id }, attributes)
+    self.class.collection.update({ _id: id }, { "$set" => attributes.except(:_id) })
   end
 
   if ActiveSupport.respond_to?(:run_load_hooks)

data/lib/minidoc/associations.rb

@@ -9,6 +9,8 @@ module Minidoc::Associations
     end
 
     def belongs_to(association_name, options = {})
+      options[:class_name] ||= "#{self.parent.name}::#{association_name.to_s.camelize}"
+
       association_name = association_name.to_sym
       associations[association_name] = options
 

data/lib/minidoc/connection.rb

@@ -8,12 +8,15 @@ module Minidoc::Connection
     class_attribute :database_name
   end
 
+  MissingConfiguration = Class.new(StandardError)
+
   module ClassMethods
     def collection
       database[collection_name]
     end
 
     def database
+      validate_config
       connection[database_name]
     end
 
@@ -24,5 +27,15 @@ module Minidoc::Connection
     def collection_name
       @collection_name ||= name.demodulize.underscore.pluralize
     end
+
+    private
+
+    def validate_config
+      if connection.nil?
+        raise MissingConfiguration, "Make sure to set Minidoc.connection"
+      elsif database_name.nil?
+        raise MissingConfiguration, "Make sure to set Minidoc.database_name"
+      end
+    end
   end
 end

data/lib/minidoc/finders.rb

@@ -3,7 +3,13 @@ require "active_support/concern"
 module Minidoc::Finders
   extend ActiveSupport::Concern
 
+  DocumentNotFoundError = Class.new(StandardError)
+
   module ClassMethods
+    def all
+      find({})
+    end
+
     def first
       find_one({})
     end
@@ -13,7 +19,7 @@ module Minidoc::Finders
     end
 
     def exists?(selector = {})
-      count(selector) > 0
+      find_one(selector).present?
     end
 
     def find(id_or_selector, options = {})
@@ -31,6 +37,15 @@ module Minidoc::Finders
       wrap(collection.find_one(selector, options))
     end
 
+    def find_one!(query, options = {})
+      find_one(query, options) or raise DocumentNotFoundError
+    end
+
+    def find_one_or_initialize(attributes, options = {})
+      raise ArgumentError unless attributes.is_a?(Hash)
+      find_one(attributes, options) || new(attributes)
+    end
+
     def from_db(attrs)
       doc = new(attrs)
       doc.instance_variable_set("@new_record", false)

data/lib/minidoc/version.rb

@@ -0,0 +1,3 @@
+class Minidoc
+  VERSION = "1.0.0.rc1"
+end

data/minidoc.gemspec

@@ -1,23 +1,24 @@
 # 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       = "0.0.1"
-  spec.authors       = ["Bryan Helmkamp"]
-  spec.email         = ["bryan@brynary.com"]
-  spec.summary       = %q{Lightweight wrapper for MongoDB documents}
-  spec.homepage      = "https://github.com/brynary/minidoc"
-  spec.license       = "MIT"
+  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.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"
-  spec.add_dependency "activemodel", ">= 3.0.0"
-  spec.add_dependency "virtus", "~> 1.0.0"
+  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"
-  spec.add_development_dependency "minitest"
-  spec.add_development_dependency "mocha"
-  spec.add_development_dependency "rake"
 end

data/test/activemodel_test.rb

@@ -1,4 +1,4 @@
-require File.expand_path('../helper', __FILE__)
+require File.expand_path("../helper", __FILE__)
 
 class ActiveModelTest < Minidoc::TestCase
   def test_model_name
@@ -12,13 +12,13 @@ class ActiveModelTest < Minidoc::TestCase
 
   def test_to_key
     user = User.new
-    user.id = BSON::ObjectId('52955618f9f6a52444000001')
+    user.id = BSON::ObjectId("52955618f9f6a52444000001")
     assert_equal ["52955618f9f6a52444000001"], user.to_key
   end
 
   def test_to_param
     user = User.new
-    user.id = BSON::ObjectId('52955618f9f6a52444000001')
+    user.id = BSON::ObjectId("52955618f9f6a52444000001")
     assert_equal "52955618f9f6a52444000001", user.to_param
   end
 

data/test/belongs_to_test.rb

@@ -1,4 +1,4 @@
-require File.expand_path('../helper', __FILE__)
+require File.expand_path("../helper", __FILE__)
 
 class BelongsToTest < Minidoc::TestCase
   class Cat < Minidoc
@@ -6,9 +6,24 @@ class BelongsToTest < Minidoc::TestCase
     belongs_to :owner, class_name: "User"
   end
 
+  class ::Dog < Minidoc
+    include Minidoc::Associations
+    belongs_to :user
+  end
+
   class User < ::User
   end
 
+  module Animal
+    class Armadillo < Minidoc
+      include Minidoc::Associations
+      belongs_to :predator
+    end
+
+    class Predator < Minidoc
+    end
+  end
+
   def test_loading
     assert_nil Cat.new.owner
     user = User.create
@@ -46,4 +61,22 @@ class BelongsToTest < Minidoc::TestCase
     cat.owner_id = user.id
     assert_equal "Noah", cat.owner.name # changes
   end
+
+  def test_top_level_inferred_class_name
+    assert_nil Dog.new.user
+    user = User.create
+    sam = Dog.new(user_id: user.id)
+    assert_equal user.id, sam.user.id
+    sam.save
+    assert_equal user.id, sam.user.id
+  end
+
+  def test_nested_inferred_class_name
+    assert_nil Animal::Armadillo.new.predator
+    predator = Animal::Predator.create
+    arnie = Animal::Armadillo.new(predator_id: predator.id)
+    assert_equal predator.id, arnie.predator.id
+    arnie.save
+    assert_equal predator.id, arnie.predator.id
+  end
 end

data/test/connection_test.rb

@@ -1,4 +1,4 @@
-require File.expand_path('../helper', __FILE__)
+require File.expand_path("../helper", __FILE__)
 
 class ConnectionTest < Minidoc::TestCase
   class Company < Minidoc

data/test/counters_test.rb

@@ -1,4 +1,4 @@
-require File.expand_path('../helper', __FILE__)
+require File.expand_path("../helper", __FILE__)
 
 class CountersTest < Minidoc::TestCase
   class SimpleCounter < Minidoc

data/test/duplicate_key_test.rb

@@ -1,4 +1,4 @@
-require File.expand_path('../helper', __FILE__)
+require File.expand_path("../helper", __FILE__)
 
 class DuplicateKeyTest < Minidoc::TestCase
   def test_rescue_duplicate_key_errors_result

data/test/first_run_test.rb

@@ -0,0 +1,40 @@
+# encoding: utf-8
+require File.expand_path('../helper', __FILE__)
+
+class FirstRunTest < Minidoc::TestCase
+  def test_missing_setup_values
+    with_alternative_configuration do
+      Minidoc.connection = nil
+      Minidoc.database_name = nil
+
+      ex =
+        assert_raises Minidoc::MissingConfiguration do
+          User.create(name: "Kären")
+        end
+      assert_equal ex.message, "Make sure to set Minidoc.connection"
+    end
+  end
+
+  def test_missing_database_name_only
+    with_alternative_configuration do
+      Minidoc.database_name = nil
+
+      ex =
+        assert_raises Minidoc::MissingConfiguration do
+          User.create(name: "Kären")
+        end
+      assert_equal ex.message, "Make sure to set Minidoc.database_name"
+    end
+  end
+
+  private
+
+  def with_alternative_configuration
+    original_connection = Minidoc.connection
+    original_database_name = Minidoc.database_name
+    yield
+  ensure
+    Minidoc.connection = original_connection
+    Minidoc.database_name = original_database_name
+  end
+end

data/test/grid_test.rb

@@ -1,4 +1,4 @@
-require File.expand_path('../helper', __FILE__)
+require File.expand_path("../helper", __FILE__)
 
 class GridTest < Minidoc::TestCase
 

data/test/helper.rb

@@ -1,16 +1,29 @@
-require 'minidoc'
-require 'minidoc/test_helpers'
-require 'minitest/autorun'
-require 'mocha/mini_test'
+require "simplecov"
+SimpleCov.start do
+  add_filter "/test/"
+end
+
+require "minidoc"
+require "minidoc/test_helpers"
+require "minitest/autorun"
+require "mocha/mini_test"
 
 I18n.enforce_available_locales = false
 I18n.load_path << File.expand_path("../locale/en.yml", __FILE__)
 
 class User < Minidoc
+  self.collection_name = "users"
+
   attribute :name, String
   attribute :age, Integer
 end
 
+class SecondUser < Minidoc
+  self.collection_name = "users"
+
+  attribute :age, Integer
+end
+
 $mongo = Mongo::MongoClient.from_uri(ENV["MONGODB_URI"] || "mongodb://localhost")
 Minidoc.connection = $mongo
 Minidoc.database_name = "minidoc_test"

data/test/persistence_test.rb

@@ -1,15 +1,15 @@
-require File.expand_path('../helper', __FILE__)
+require File.expand_path("../helper", __FILE__)
 
 class PersistenceTest < Minidoc::TestCase
   def test_ids
     user = User.new
     assert_equal BSON::ObjectId, user.id.class
 
-    user = User.new(_id: BSON::ObjectId('52955cc5f9f6a538a9000001'))
-    assert_equal BSON::ObjectId('52955cc5f9f6a538a9000001'), user.id
+    user = User.new(_id: BSON::ObjectId("52955cc5f9f6a538a9000001"))
+    assert_equal BSON::ObjectId("52955cc5f9f6a538a9000001"), user.id
 
-    user = User.new("_id" => BSON::ObjectId('52955cc5f9f6a538a9000001'))
-    assert_equal BSON::ObjectId('52955cc5f9f6a538a9000001'), user.id
+    user = User.new("_id" => BSON::ObjectId("52955cc5f9f6a538a9000001"))
+    assert_equal BSON::ObjectId("52955cc5f9f6a538a9000001"), user.id
   end
 
   def test_new_record
@@ -22,7 +22,7 @@ class PersistenceTest < Minidoc::TestCase
   def test_raises_duplicate_key_where_appropriate
     mock_collection = mock()
     User.stubs(:collection).returns(mock_collection)
-    mock_collection.stubs(:<<).raises(Mongo::OperationFailure.new('Duplicate key exception', Minidoc::DuplicateKey::DUPLICATE_KEY_ERROR_CODE))
+    mock_collection.stubs(:<<).raises(Mongo::OperationFailure.new("Duplicate key exception", Minidoc::DuplicateKey::DUPLICATE_KEY_ERROR_CODE))
 
     user = User.new
     assert_raises(Minidoc::DuplicateKey) { user.save }
@@ -72,6 +72,21 @@ class PersistenceTest < Minidoc::TestCase
     assert_equal "Noah", user.reload.name
   end
 
+  def test_update_same_collection
+    user = User.create(name: "Bryan", age: 20)
+    user.name = "Noah"
+    assert_equal "Noah", user.name
+    user.save
+    assert_equal "Noah", user.reload.name
+    second_user = SecondUser.find_one(age: 20)
+    assert_equal second_user.id, user.id
+    second_user.age = 21
+    assert_equal 21, second_user.age
+    second_user.save
+    assert_equal 21, second_user.reload.age
+    assert_equal "Noah", user.reload.name
+  end
+
   def test_destroy
     user = User.create(name: "Bryan")
     assert_equal false, user.destroyed?

data/test/query_test.rb

@@ -1,6 +1,13 @@
-require File.expand_path('../helper', __FILE__)
+require File.expand_path("../helper", __FILE__)
 
 class QueryTest < Minidoc::TestCase
+  def test_all
+    User.collection << { name: "Joe" }
+    User.collection << { name: "Bryan" }
+    users = User.all
+    assert_equal %w[Bryan Joe], users.map(&:name).sort
+  end
+
   def test_count_all
     User.collection << { name: "Joe" }
     User.collection << { name: "Bryan" }
@@ -37,4 +44,21 @@ class QueryTest < Minidoc::TestCase
     assert_equal user, User.find_one({})
     assert_equal nil, User.find_one(name: "Noah")
   end
+
+  def test_find_one!
+    user = User.create(name: "Bryan")
+    assert_equal user, User.find_one!(name: "Bryan")
+    assert_raises(Minidoc::DocumentNotFoundError) { User.find_one!(name: "Noah") }
+  end
+
+  def test_find_one_or_initialize
+    user = User.create(name: "Bryan", age: 1)
+    assert user == User.find_one_or_initialize(name: "Bryan")
+    assert User.find_one_or_initialize(name: "Noah").is_a?(User)
+    assert User.find_one_or_initialize(name: "Noah").new_record?
+    user = User.create(name: "Noah", age: 1)
+    assert user == User.find_one_or_initialize({ age: 1 }, { sort: { name: -1 } })
+    assert_raises(ArgumentError) { User.find_one_or_initialize("foo") }
+  end
+
 end

data/test/read_only_test.rb

@@ -1,4 +1,4 @@
-require File.expand_path('../helper', __FILE__)
+require File.expand_path("../helper", __FILE__)
 
 class ReadOnlyTest < Minidoc::TestCase
   class ReadOnlyUser < Minidoc::ReadOnly

data/test/timestamps_test.rb

@@ -1,4 +1,4 @@
-require File.expand_path('../helper', __FILE__)
+require File.expand_path("../helper", __FILE__)
 
 class TimestampsTest < Minidoc::TestCase
   class User < ::User

data/test/uniqueness_validator_test.rb

@@ -1,4 +1,4 @@
-require File.expand_path('../helper', __FILE__)
+require File.expand_path("../helper", __FILE__)
 
 class UniquenessValidatorTest < Minidoc::TestCase
   class User < ::User

data/test/validations_test.rb

@@ -1,4 +1,4 @@
-require File.expand_path('../helper', __FILE__)
+require File.expand_path("../helper", __FILE__)
 
 class ValidationsTest < Minidoc::TestCase
   class User < ::User

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: minidoc
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0.rc1
 platform: ruby
 authors:
 - Bryan Helmkamp
+- Code Climate
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-28 00:00:00.000000000 Z
+date: 2016-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -17,6 +18,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -24,6 +28,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
@@ -31,6 +38,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -38,11 +48,17 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: virtus
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.0
   type: :runtime
@@ -50,6 +66,9 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.0
 - !ruby/object:Gem::Dependency
@@ -66,58 +85,21 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: mocha
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: 
 email:
 - bryan@brynary.com
+- hello@codeclimate.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".gitignore"
+- ".rubocop.yml"
 - ".ruby-version"
 - ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -130,22 +112,22 @@ files:
 - lib/minidoc/duplicate_key.rb
 - lib/minidoc/finders.rb
 - lib/minidoc/grid.rb
-- lib/minidoc/indexes.rb
 - lib/minidoc/read_only.rb
 - lib/minidoc/record_invalid.rb
 - lib/minidoc/test_helpers.rb
 - lib/minidoc/timestamps.rb
 - lib/minidoc/validations.rb
 - lib/minidoc/value.rb
+- lib/minidoc/version.rb
 - minidoc.gemspec
 - test/activemodel_test.rb
 - test/belongs_to_test.rb
 - test/connection_test.rb
 - test/counters_test.rb
 - test/duplicate_key_test.rb
+- test/first_run_test.rb
 - test/grid_test.rb
 - test/helper.rb
-- test/indexes_test.rb
 - test/locale/en.yml
 - test/persistence_test.rb
 - test/query_test.rb
@@ -153,7 +135,7 @@ files:
 - test/timestamps_test.rb
 - test/uniqueness_validator_test.rb
 - test/validations_test.rb
-homepage: https://github.com/brynary/minidoc
+homepage: https://github.com/codeclimate/minidoc
 licenses:
 - MIT
 metadata: {}
@@ -168,9 +150,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.5.1
@@ -183,9 +165,9 @@ test_files:
 - test/connection_test.rb
 - test/counters_test.rb
 - test/duplicate_key_test.rb
+- test/first_run_test.rb
 - test/grid_test.rb
 - test/helper.rb
-- test/indexes_test.rb
 - test/locale/en.yml
 - test/persistence_test.rb
 - test/query_test.rb
@@ -193,4 +175,3 @@ test_files:
 - test/timestamps_test.rb
 - test/uniqueness_validator_test.rb
 - test/validations_test.rb
-has_rdoc: 

data/lib/minidoc/indexes.rb

@@ -1,31 +0,0 @@
-require "active_support/concern"
-
-module Minidoc::Indexes
-  extend ActiveSupport::Concern
-
-  module ClassMethods
-    MONGO_DUPLICATE_KEY_ERROR_CODE = 11000
-
-    def ensure_index(key_or_keys, options = {})
-      indexes = Array(key_or_keys).map { |key| { key => 1 } }.reduce(:merge)
-
-      collection.ensure_index(indexes, options)
-    end
-
-    # Rescue a <tt>Mongo::OperationFailure</tt> exception which originated from
-    # duplicate key error (error code 11000) in the given block.
-    #
-    # Returns the status of the operation in the given block, or +false+ if the
-    # exception was raised.
-    def rescue_duplicate_key_errors
-      yield
-    rescue Mongo::OperationFailure => exception
-      if exception.respond_to?(:error_code) &&
-        exception.error_code == MONGO_DUPLICATE_KEY_ERROR_CODE
-        return false
-      else
-        raise
-      end
-    end
-  end
-end

data/test/indexes_test.rb

@@ -1,52 +0,0 @@
-require File.expand_path('../helper', __FILE__)
-
-class IndexesTest < Minidoc::TestCase
-  class Company < Minidoc
-    self.collection_name = "accounts"
-
-    include Minidoc::Indexes
-
-    attribute :name
-    attribute :title
-    attribute :description
-  end
-
-  def test_ensure_index_single
-    Company.ensure_index(:name)
-
-    assert_equal %w( name ), indexed_keys(Company, "name_1")
-  end
-
-  def test_ensure_index_multiple
-    Company.ensure_index([:name, :title])
-
-    assert_equal %w( name title ), indexed_keys(Company, "name_1_title_1")
-  end
-
-  def test_ensure_index_options
-    Company.ensure_index(:name, unique: true)
-
-    assert index_info(Company, "name_1")["unique"]
-  end
-
-  def test_rescue_duplicate_key_errors_not_raising_exception
-    Company.ensure_index(:name, unique: true)
-
-    Company.rescue_duplicate_key_errors do
-      Company.create!(name: "CodeClimate")
-      Company.create!(name: "CodeClimate")
-    end
-  end
-
-  private
-
-  def index_info(klass, name)
-    klass.collection.index_information[name] || {}
-  end
-
-  def indexed_keys(klass, name)
-    key_info = index_info(klass, name)["key"] || {}
-    key_info.keys
-  end
-
-end