minidoc 0.0.1

data/test/persistence_test.rb

@@ -0,0 +1,183 @@
+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
+  end
+
+  def test_new_record
+    user = User.new
+    assert_equal true, user.new_record?
+    user.save
+    assert_equal false, user.new_record?
+  end
+
+  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))
+
+    user = User.new
+    assert_raises(Minidoc::DuplicateKey) { user.save }
+  end
+
+  def test_reraises_other_exception_types
+    mock_collection = mock()
+    User.stubs(:collection).returns(mock_collection)
+    mock_collection.stubs(:<<).raises(ArgumentError)
+
+    user = User.new
+    assert_raises(ArgumentError) { user.save }
+  end
+
+  def test_persisted
+    user = User.new
+    assert_equal false, user.persisted?
+    user.save
+    assert_equal true, user.persisted?
+    user.destroy
+    assert_equal false, user.persisted?
+  end
+
+  def test_save
+    user = User.new
+    old_id = user.id
+    assert_equal true, user.save
+    assert_equal 1, User.count
+    assert_equal old_id, user.id
+  end
+
+  def test_create
+    user = User.create!(name: "Bryan")
+    assert_equal "Bryan", user.name
+    assert_equal 1, User.count
+
+    user = User.create(name: "Bryan")
+    assert_equal "Bryan", user.name
+    assert_equal 2, User.count
+  end
+
+  def test_update
+    user = User.create(name: "Bryan")
+    user.name = "Noah"
+    assert_equal "Noah", user.name
+    user.save
+    assert_equal "Noah", user.reload.name
+  end
+
+  def test_destroy
+    user = User.create(name: "Bryan")
+    assert_equal false, user.destroyed?
+    user.destroy
+    assert_equal 0, User.count
+    assert_equal true, user.destroyed?
+  end
+
+  def test_delete
+    user = User.create(name: "Bryan")
+    User.delete(user.id)
+    assert_equal 0, User.count
+
+    user = User.create(name: "Bryan")
+    User.delete(user.id.to_s)
+    assert_equal 0, User.count
+
+    user = User.create(name: "Bryan")
+    user.delete
+    assert_equal 0, User.count
+  end
+
+  def test_reload
+    user = User.create(name: "Bryan")
+    assert_equal "Bryan", user.reload.name
+
+    User.collection.update({_id: user.id}, {name: "Noah"})
+    assert_equal "Noah", user.reload.name
+  end
+
+  def test_class_set
+    user = User.create(name: "Bryan")
+    User.set(user.id, name: "Noah")
+    assert_equal "Bryan", user.name # Class set can't trigger update
+    assert_equal "Noah", user.reload.name
+    assert_equal "Noah", User.first.name
+
+    User.set(user.id.to_s, name: "Mike")
+    assert_equal "Mike", user.reload.name
+    assert_equal "Mike", User.first.name
+  end
+
+  def test_instance_set
+    user = User.create(name: "Bryan")
+    user.set(name: "Noah")
+    assert_equal "Noah", user.name
+    assert_equal "Noah", user.reload.name
+    assert_equal "Noah", User.first.name
+
+    user = User.create(name: "Bryan")
+    user.set("name" => "Noah")
+    assert_equal "Noah", user.name
+    assert_equal "Noah", user.reload.name
+  end
+
+  def test_class_unset
+    user = User.create(name: "Bryan")
+    User.unset(user.id, :name)
+    assert_equal "Bryan", user.name # Class set can't trigger update
+    assert_equal nil, user.reload.name
+    assert_equal nil, User.first.name
+
+    User.unset(user.id.to_s, :name)
+    assert_equal nil, user.reload.name
+    assert_equal nil, User.first.name
+  end
+
+  def test_instance_unset
+    user = User.create(name: "Bryan")
+    user.unset(:name)
+    assert_equal nil, user.name
+    assert_equal nil, user.reload.name
+    assert_equal nil, User.first.name
+
+    user = User.create(name: "Bryan")
+    user.unset("name")
+    assert_equal nil, user.name
+    assert_equal nil, user.reload.name
+  end
+
+  def test_atomic_set_failure
+    user = User.create(name: "from", age: 18)
+
+    refute user.atomic_set({ name: "not-from" }, name: "to")
+    assert_equal "from", user.name
+    assert_equal 18, user.age
+
+    user.reload
+    assert_equal "from", user.name
+    assert_equal 18, user.age
+  end
+
+  def test_atomic_set_success
+    user = User.create(name: "from", age: 18)
+    other_user = User.create(name: "from", age: 21)
+
+    assert user.atomic_set({ name: "from" }, name: "to")
+    assert_equal "to", user.name
+    assert_equal 18, user.age
+
+    user.reload
+    assert_equal "to", user.name
+    assert_equal 18, user.age
+
+    other_user.reload
+    assert_equal "from", other_user.name
+    assert_equal 21, other_user.age
+  end
+end

data/test/query_test.rb

@@ -0,0 +1,40 @@
+require File.expand_path('../helper', __FILE__)
+
+class QueryTest < Minidoc::TestCase
+  def test_count_all
+    User.collection << { name: "Joe" }
+    User.collection << { name: "Bryan" }
+    assert_equal 2, User.count
+  end
+
+  def test_count_query
+    User.collection << { name: "Joe" }
+    User.collection << { name: "Bryan" }
+    assert_equal 1, User.count(name: "Bryan")
+  end
+
+  def test_exists
+    User.collection << { name: "Joe" }
+    assert User.exists?(name: "Joe")
+    refute User.exists?(name: "Bryan")
+  end
+
+  def test_first
+    assert_equal nil, User.first
+    user = User.create(name: "Bryan")
+    assert_equal "Bryan", User.first.name
+    assert_equal user, User.first
+  end
+
+  def test_find
+    user = User.create(name: "Bryan")
+    assert_equal [user], User.find({}).to_a
+    assert_equal [], User.find(name: "Noah").to_a
+  end
+
+  def test_find_one
+    user = User.create(name: "Bryan")
+    assert_equal user, User.find_one({})
+    assert_equal nil, User.find_one(name: "Noah")
+  end
+end

data/test/read_only_test.rb

@@ -0,0 +1,34 @@
+require File.expand_path('../helper', __FILE__)
+
+class ReadOnlyTest < Minidoc::TestCase
+  class ReadOnlyUser < Minidoc::ReadOnly
+    self.collection_name = "users"
+    attribute :name, String
+  end
+
+  def test_read_only
+    assert_raises NoMethodError do
+      ReadOnlyUser.create(name: "Bryan")
+    end
+
+    rw_user = User.create(name: "Bryan")
+    user = ReadOnlyUser.first
+    assert_equal "Bryan", user.name
+    assert_equal rw_user.id, user.id
+    assert_equal user, user.as_value
+
+    assert_raises NoMethodError do
+      user.name = "Noah"
+    end
+  end
+
+  def test_value
+    user = User.new(name: "Bryan")
+    user.name = "Noah"
+    user = user.as_value
+
+    assert_raises NoMethodError do
+      user.name = "Noah"
+    end
+  end
+end

data/test/timestamps_test.rb

@@ -0,0 +1,21 @@
+require File.expand_path('../helper', __FILE__)
+
+class TimestampsTest < Minidoc::TestCase
+  class User < ::User
+    include Minidoc::Timestamps
+    timestamps!
+  end
+
+  def test_create
+    user = User.create
+    assert user.created_at
+    assert_equal user.created_at, user.updated_at
+  end
+
+  def test_update
+    user = User.create
+    sleep 0.001
+    user.save
+    refute_equal user.created_at, user.updated_at
+  end
+end

data/test/uniqueness_validator_test.rb

@@ -0,0 +1,68 @@
+require File.expand_path('../helper', __FILE__)
+
+class UniquenessValidatorTest < Minidoc::TestCase
+  class User < ::User
+    validates :name, uniqueness: true
+  end
+
+  class InsensitiveUser < ::User
+    attribute :insensitive, String
+    validates :insensitive, uniqueness: { case_sensitive: false }
+  end
+
+  class ScopedUser < ::User
+    attribute :country_id, Integer
+    attribute :tax_id_number, Integer
+    validates :tax_id_number, uniqueness: { scope: :country_id }
+  end
+
+  def test_invalid_with_existing_value
+    User.create!(name: "same name")
+    user = User.new(name: "same name")
+    assert_equal false, user.valid?
+    assert_equal ["has already been taken"], user.errors[:name]
+  end
+
+  def test_case_sensitive_by_default
+    User.create!(name: "different case")
+    user = User.new(name: "DIFFERENT CASE")
+    assert_equal true, user.valid?
+  end
+
+  def test_unique_persisted_record_is_valid
+    user = User.create!(name: "lonely")
+    assert_equal true, user.valid?
+  end
+
+  def test_case_insensitive
+    InsensitiveUser.create!(insensitive: "equivalent")
+    user = InsensitiveUser.new(insensitive: "EquivALENT")
+    assert_equal false, user.valid?
+    assert_equal ["has already been taken"], user.errors[:insensitive]
+  end
+
+  def test_same_value_within_scope
+    ScopedUser.create!(country_id: 1, tax_id_number: 1)
+    user = ScopedUser.new(country_id: 1, tax_id_number: 1)
+    assert_equal false, user.valid?
+    assert_equal ["has already been taken"], user.errors[:tax_id_number]
+  end
+
+  def test_different_value_within_scope
+    ScopedUser.create!(country_id: 1, tax_id_number: 1)
+    user = ScopedUser.new(country_id: 1, tax_id_number: 2)
+    assert_equal true, user.valid?
+  end
+
+  def test_same_value_outside_scope
+    ScopedUser.create!(country_id: 1, tax_id_number: 1)
+    user = ScopedUser.new(country_id: 2, tax_id_number: 1)
+    assert_equal true, user.valid?
+  end
+
+  def test_same_value_outside_scope
+    ScopedUser.create!(country_id: 1, tax_id_number: 1)
+    user = ScopedUser.new(country_id: 2, tax_id_number: 2)
+    assert_equal true, user.valid?
+  end
+end

data/test/validations_test.rb

@@ -0,0 +1,36 @@
+require File.expand_path('../helper', __FILE__)
+
+class ValidationsTest < Minidoc::TestCase
+  class User < ::User
+    validates :name, presence: true
+  end
+
+  def test_valid
+    user = User.new
+    assert_equal false, user.valid?
+  end
+
+  def test_errors
+    user = User.new
+    user.valid?
+    assert_equal ["can't be blank"], user.errors[:name]
+  end
+
+  def test_create_bang
+    assert_raises Minidoc::RecordInvalid do
+      User.create!
+    end
+  end
+
+  def test_invalid_save
+    user = User.new
+    assert_equal false, user.save
+    assert_equal true, user.new_record?
+  end
+
+  def test_save_bang
+    assert_raises Minidoc::RecordInvalid do
+      User.new.save!
+    end
+  end
+end

metadata

@@ -0,0 +1,196 @@
+--- !ruby/object:Gem::Specification
+name: minidoc
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Bryan Helmkamp
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-09-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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.0.0
+- !ruby/object:Gem::Dependency
+  name: mongo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/minidoc.rb
+- lib/minidoc/associations.rb
+- lib/minidoc/autoload.rb
+- lib/minidoc/connection.rb
+- lib/minidoc/counters.rb
+- 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
+- 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/grid_test.rb
+- test/helper.rb
+- test/indexes_test.rb
+- test/locale/en.yml
+- test/persistence_test.rb
+- test/query_test.rb
+- test/read_only_test.rb
+- test/timestamps_test.rb
+- test/uniqueness_validator_test.rb
+- test/validations_test.rb
+homepage: https://github.com/brynary/minidoc
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Lightweight wrapper for MongoDB documents
+test_files:
+- test/activemodel_test.rb
+- test/belongs_to_test.rb
+- test/connection_test.rb
+- test/counters_test.rb
+- test/duplicate_key_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
+- test/read_only_test.rb
+- test/timestamps_test.rb
+- test/uniqueness_validator_test.rb
+- test/validations_test.rb
+has_rdoc: