assert_valid 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8115bc34bd047a98c7cdf40de957cd50d579460de87c303d0c476b4a189ae4c3
+  data.tar.gz: 3c7797ec57d97cc5fd2b0285e49580994fa7b7e54a388279f050191f91402087
+SHA512:
+  metadata.gz: 9d1c76171acc87d6d4543bfac10f64dd9795b9660c0c33ab3f751f83b006a75be00de3cdb4da46120278f9a8d2f56f51ea26b84d500d3b7038337beddfa31a71
+  data.tar.gz: a46f373a2de5e42507f5288ef3a4e39e1056f7d6a628de0e6db94d6a45e96a0a63a562e8d808186acb43fc6d187d6994c95ad461e154fc56e6fb7ac252e44dae

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in assert_valid.gemspec
+gemspec
+
+gem "rake", "~> 13.0"

data/Gemfile.lock

@@ -0,0 +1,19 @@
+PATH
+  remote: .
+  specs:
+    assert_valid (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    rake (13.0.3)
+
+PLATFORMS
+  x86_64-darwin-20
+
+DEPENDENCIES
+  assert_valid!
+  rake (~> 13.0)
+
+BUNDLED WITH
+   2.2.16

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Brendan Tang
+
+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,61 @@
+# AssertValid
+
+A tiny gem that provides that provides two utility methods for testing ActiveRecord models: `assert_valid` and `assert_invalid`.
+
+This gem could easily just be a GitHub gist—the methods are written in less than 50 lines.
+
+But I've copy and pasted them enough times that I just made a gem.
+
+## Installation
+
+Add this gem to your Rails app's development group:
+
+```ruby
+group :test do
+  # ...
+  gem 'assert_valid'
+end
+```
+
+And then `bundle install`.
+
+Include the module in `test/test_helper.rb`:
+
+```ruby
+class ActiveSupport::TestCase
+  include AssertValid::Assertions
+  # ...
+```
+
+Or instead of using the gem, you could just copy the methods as defined in `lib/assert_valid/assertions.rb` and paste them into your `test/test_helper.rb`.
+
+
+## Usage
+
+In your unit tests, you can use `assert_valid` or `assert_invalid`, passing in the record you want to check.
+
+`assert_invalid` also optionally takes an attribute name to check for an error on that attribute specifically.
+
+If you specify an attribute, you can also specify an error kind. Example:
+
+```ruby
+# app/models/user.rb
+class User < ApplicationRecord
+  validates :name, uniqueness: true
+  #...
+  
+```
+
+```ruby
+# test/models/user_test.rb
+
+test "validates unique name" do
+  User.create(name: "bob")
+  duplicated_user = User.new(name: "bob")
+  assert_invalid(duplicated_user, :name, :taken)
+```
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/assert_valid.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative "lib/assert_valid/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "assert_valid"
+  spec.version = AssertValid::VERSION
+  spec.authors = ["Brendan Tang"]
+  spec.email = ["b@brendantang.net"]
+
+  spec.summary = "Provides assert_valid and assert_invalid utility methods for testing ActiveRecord models."
+  spec.description = spec.summary
+  spec.homepage = "https://github.com/brendantang/assert_valid"
+  spec.license = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = spec.homepage
+
+  # 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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "assert_valid"
+
+# 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/assert_valid.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative "assert_valid/version"
+require_relative "assert_valid/assertions"
+
+module AssertValid
+  class Error < StandardError; end
+end

data/lib/assert_valid/assertions.rb

@@ -0,0 +1,36 @@
+module AssertValid
+  module Assertions
+    def assert_invalid(invalid_record, attribute_name = nil, error_kind = nil)
+      assert_not(
+        invalid_record.valid?,
+        "No validation errors raised. Record: #{invalid_record.inspect}"
+      )
+      if attribute_name
+        assert_includes(
+          invalid_record.errors.attribute_names,
+          attribute_name,
+          "Expected record to have a(n) #{attribute_name} error.
+   Errors: #{invalid_record.errors.details}
+   Record: #{invalid_record.inspect}"
+        )
+        if error_kind
+          assert(
+            invalid_record.errors.details[attribute_name].any? do |err_detail|
+              err_detail[:error] == error_kind
+            end,
+            "Expected #{attribute_name} errors to include a #{error_kind} error.
+           #{attribute_name} errors were: #{invalid_record.errors.details}"
+          )
+        end
+      end
+    end
+
+    def assert_valid(record)
+      assert(
+        record.save,
+        "Record could not be saved. Record: #{record.inspect}
+   Errors: #{record.errors.details}"
+      )
+    end
+  end
+end

data/lib/assert_valid/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module AssertValid
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: assert_valid
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Brendan Tang
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-06-29 00:00:00.000000000 Z
+dependencies: []
+description: Provides assert_valid and assert_invalid utility methods for testing
+  ActiveRecord models.
+email:
+- b@brendantang.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- assert_valid.gemspec
+- bin/console
+- bin/setup
+- lib/assert_valid.rb
+- lib/assert_valid/assertions.rb
+- lib/assert_valid/version.rb
+homepage: https://github.com/brendantang/assert_valid
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/brendantang/assert_valid
+  source_code_uri: https://github.com/brendantang/assert_valid
+  changelog_uri: https://github.com/brendantang/assert_valid
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.16
+signing_key:
+specification_version: 4
+summary: Provides assert_valid and assert_invalid utility methods for testing ActiveRecord
+  models.
+test_files: []