mini_sanity 1.1.0 → 3.0.0

data/lib/mini_sanity/results.rb

@@ -0,0 +1,70 @@
+require_relative "error"
+
+
+class Enumerator
+
+  # Iterates the Enumerator with a given +block+, and checks that the
+  # result is an Enumerable that has one or more elements.  Raises an
+  # exception if this check fails.  Otherwise, returns the Enumerable
+  # result.
+  #
+  # @example
+  #   [1, 2, 3].select.results!(&:odd?)  # == [1, 3]
+  #   [2, 4, 6].select.results!(&:odd?)  # raises exception
+  #
+  # @return [Enumerable]
+  # @raise [ArgumentError]
+  #   if no +block+ is provided
+  # @raise [MiniSanity::Error]
+  #   if iterating does not result in an Enumerable, or if the resulting
+  #   Enumerable has no elements
+  def results!(&block)
+    raise ArgumentError, "Enumerator#results! requires a block" unless block
+
+    results = self.each(&block)
+
+    if !results.is_a?(Enumerable)
+      raise MiniSanity::Error.new("Result from Enumerator with block is not an Enumerable", {
+        "Enumerator" => self.inspect,
+        "Block" => MiniSanity::Error.describe_block(&block),
+        "Result" => results.inspect,
+      })
+    elsif !results.any?{ true }
+      raise MiniSanity::Error.new("No results from Enumerator with block", {
+        "Enumerator" => self.inspect,
+        "Block" => MiniSanity::Error.describe_block(&block),
+      })
+    end
+
+    results
+  end
+
+  # Iterates the Enumerator with a given +block+, and checks that the
+  # result is not nil.  Raises an exception if the result is nil.
+  # Otherwise, returns the non-nil result.
+  #
+  # @example
+  #   [1, 2, 3].find.result!(&:even?)  # == 2
+  #   [1, 3, 5].find.result!(&:even?)  # raises exception
+  #
+  # @return [Object]
+  # @raise [ArgumentError]
+  #   if no +block+ is provided
+  # @raise [MiniSanity::Error]
+  #   if iterating results in a nil value
+  def result!(&block)
+    raise ArgumentError, "Enumerator#result! requires a block" unless block
+
+    result = self.each(&block)
+
+    if result.nil?
+      raise MiniSanity::Error.new("Nil result from Enumerator with block", {
+        "Enumerator" => self.inspect,
+        "Block" => MiniSanity::Error.describe_block(&block),
+      })
+    end
+
+    result
+  end
+
+end

data/lib/mini_sanity/version.rb

@@ -1,3 +1,3 @@
 module MiniSanity
-  VERSION = "1.1.0"
+  VERSION = "3.0.0"
 end

data/lib/mini_sanity.rb

@@ -1,7 +1,5 @@
 require_relative "mini_sanity/version"
-require_relative "mini_sanity/error"
-require_relative "mini_sanity/array"
-require_relative "mini_sanity/enumerable"
-require_relative "mini_sanity/object"
-require_relative "mini_sanity/pathname"
-require_relative "mini_sanity/string"
+require_relative "mini_sanity/assert"
+require_relative "mini_sanity/change"
+require_relative "mini_sanity/match"
+require_relative "mini_sanity/results"

data/mini_sanity.gemspec

@@ -1,27 +1,25 @@
-# coding: utf-8
-lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "mini_sanity/version"
+require_relative "lib/mini_sanity/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "mini_sanity"
   spec.version       = MiniSanity::VERSION
   spec.authors       = ["Jonathan Hefner"]
-  spec.email         = ["jonathan.hefner@gmail.com"]
+  spec.email         = ["jonathan@hefner.pro"]
 
   spec.summary       = %q{In-line sanity checks}
   spec.homepage      = "https://github.com/jonathanhefner/mini_sanity"
   spec.license       = "MIT"
+  spec.required_ruby_version = ">= 3.4"
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = spec.metadata["source_code_uri"] + "/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(__dir__) do
+    `git ls-files -z`.split("\x0").reject { |f| f.start_with?("test/", ".git") }
   end
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "bundler", "~> 1.15"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "minitest", "~> 5.0"
-  spec.add_development_dependency "yard", "~> 0.9"
 end

metadata

@@ -1,103 +1,39 @@
 --- !ruby/object:Gem::Specification
 name: mini_sanity
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Jonathan Hefner
-autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-11 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.15'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.15'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-description: 
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
 email:
-- jonathan.hefner@gmail.com
+- jonathan@hefner.pro
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/mini_sanity.rb
-- lib/mini_sanity/array.rb
-- lib/mini_sanity/enumerable.rb
+- lib/mini_sanity/assert.rb
+- lib/mini_sanity/change.rb
 - lib/mini_sanity/error.rb
-- lib/mini_sanity/object.rb
-- lib/mini_sanity/pathname.rb
-- lib/mini_sanity/string.rb
-- lib/mini_sanity/util.rb
-- lib/mini_sanity/util/enumerable.rb
-- lib/mini_sanity/util/regexp.rb
-- lib/mini_sanity/util/string.rb
+- lib/mini_sanity/match.rb
+- lib/mini_sanity/results.rb
 - lib/mini_sanity/version.rb
 - mini_sanity.gemspec
 homepage: https://github.com/jonathanhefner/mini_sanity
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  source_code_uri: https://github.com/jonathanhefner/mini_sanity
+  changelog_uri: https://github.com/jonathanhefner/mini_sanity/blob/master/CHANGELOG.md
 rdoc_options: []
 require_paths:
 - lib
@@ -105,16 +41,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
-signing_key: 
+rubygems_version: 4.0.10
 specification_version: 4
 summary: In-line sanity checks
 test_files: []

data/.gitignore

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

data/.travis.yml

@@ -1,5 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.2.5
-before_install: gem install bundler -v 1.15.1

data/lib/mini_sanity/array.rb

@@ -1,63 +0,0 @@
-class Array
-
-  # Checks that the Array matches a given length, and returns the Array
-  # unmodified.  If the Array fails this check, an exception is
-  # raised.
-  #
-  # @example
-  #   coord = [0, 0, 0]
-  #   coord.assert_length(3)!  # == [0, 0, 0]
-  #
-  #   coord = [0, 0]
-  #   coord.assert_length(3)!  # raises exception
-  #
-  #   coord = [0, 0]
-  #   coord.assert_length(2..3)!  # == [0, 0]
-  #
-  # @param length [Integer, Range<Integer>]
-  #   length to match
-  # @param name [String, Symbol]
-  #   optional name to include in the error message
-  # @return [self]
-  # @raise [MiniSanity::Error]
-  #   if the Array length does not match +length+
-  def assert_length!(length, name = nil)
-    if !(length === self.length)
-      raise MiniSanity::Error.new(name,
-        "#{self.class} having #{length} elements",
-        self.inspect)
-    end
-    self
-  end
-
-  # Checks that the Array does not match a given length, and returns the
-  # Array unmodified.  If the Array fails this check, an exception is
-  # raised.
-  #
-  # @example
-  #   some = ["one"]
-  #   some.refute_length!(0)  # == ["one"]
-  #
-  #   some = []
-  #   some.refute_length(0)!  # raises exception
-  #
-  #   many = ["one", "many"]
-  #   many.refute_length!(0..1)  # == ["one", "many"]
-  #
-  # @param length [Integer, Range<Integer>]
-  #   length to not match
-  # @param name [String, Symbol]
-  #   optional name to include in the error message
-  # @return [self]
-  # @raise [MiniSanity::Error]
-  #   if the Array length matches +length+
-  def refute_length!(length, name = nil)
-    if length === self.length
-      raise MiniSanity::Error.new(name,
-        "#{self.class} not having #{length} elements",
-        self.inspect)
-    end
-    self
-  end
-
-end

data/lib/mini_sanity/enumerable.rb

@@ -1,52 +0,0 @@
-module Enumerable
-
-  # Checks that the Enumerable is empty, and returns the Enumerable
-  # unmodified.  If the Enumerable fails this check, an exception is
-  # raised.
-  #
-  # @example
-  #   errors = []
-  #   errors.assert_empty!  # == []
-  #
-  #   errors = ["something went wrong"]
-  #   errors.assert_empty!  # raises exception
-  #
-  # @param name [String, Symbol]
-  #   optional name to include in the error message
-  # @return [self]
-  # @raise [MiniSanity::Error]
-  #   if the Enumerable is not empty
-  def assert_empty!(name = nil)
-    if self.any?{ true }
-      raise MiniSanity::Error.new(name,
-        "empty #{self.class}",
-        self.inspect)
-    end
-    self
-  end
-
-  # Checks that the Enumerable is not empty, and returns the Enumerable
-  # unmodified.  If the Enumerable fails this check, an exception is
-  # raised.
-  #
-  # @example
-  #   ["result 1"].refute_empty!  # == ["result 1"]
-  #   [].refute_empty!            # raises exception
-  #
-  # @param name [String, Symbol]
-  #   optional name to include in the error message
-  # @return [self]
-  # @raise [MiniSanity::Error]
-  #   if the Enumerable is empty
-  def refute_empty!(name = nil)
-    # NOTE use #any? instead of #none? because Array#none? seems to be
-    # significantly slower than Array#any? (and likewise for Hash)
-    if !self.any?{ true }
-      raise MiniSanity::Error.new(name,
-        "non-empty #{self.class}",
-        self.inspect)
-    end
-    self
-  end
-
-end

data/lib/mini_sanity/object.rb

@@ -1,216 +0,0 @@
-class Object
-
-  # Checks that the Object is nil, and returns nil.  If the Object fails
-  # this check, an exception is raised.
-  #
-  # @example
-  #   result = {}
-  #   result[:error].assert_nil!  # == nil
-  #
-  #   result = { error: "something went wrong" }
-  #   result[:error].assert_nil!  # == raises exception
-  #
-  # @param name [String, Symbol]
-  #   optional name to include in the error message
-  # @return [self]
-  # @raise [MiniSanity::Error]
-  #   if the Object is not nil
-  def assert_nil!(name = nil)
-    if !self.nil?
-      raise MiniSanity::Error.new(name,
-        "nil",
-        self.inspect)
-    end
-    self
-  end
-
-  # Checks that the Object is not nil, and returns the Object
-  # unmodified.  If the Object fails this check, an exception is raised.
-  #
-  # @example
-  #   ["result 1"].first.refute_nil!  # == "result 1"
-  #   [].first.refute_nil!            # raises exception
-  #
-  # @param name [String, Symbol]
-  #   optional name to include in the error message
-  # @return [self]
-  # @raise [MiniSanity::Error]
-  #   if the Object is nil
-  def refute_nil!(name = nil)
-    if self.nil?
-      raise MiniSanity::Error.new(name,
-        "non-nil value",
-        "nil")
-    end
-    self
-  end
-
-  # Checks that the Object equals a given expected value, and returns
-  # the Object unmodified.  If the Object fails this check, an exception
-  # is raised.
-  #
-  # @example
-  #   "good".assert_equal!("good")  # == "good"
-  #   "bad".assert_equal!("good")   # raises exception
-  #
-  # @param expect [Object]
-  #   value to expect
-  # @param name [String, Symbol]
-  #   optional name to include in the error message
-  # @return [self]
-  # @raise [MiniSanity::Error]
-  #   if the Object does not equal +expect+
-  def assert_equal!(expect, name = nil)
-    if self != expect
-      raise MiniSanity::Error.new(name,
-        expect.inspect,
-        self.inspect)
-    end
-    self
-  end
-
-  # Checks that the Object does not equal a given reject value, and
-  # returns the Object unmodified.  If the Object fails this check, an
-  # exception is raised.
-  #
-  # @example
-  #   "good".refute_equal!("bad")  # == "good"
-  #   "bad".refute_equal!("bad")   # raises exception
-  #
-  # @param reject [Object]
-  #   value to reject
-  # @param name [String, Symbol]
-  #   optional name to include in the error message
-  # @return [self]
-  # @raise [MiniSanity::Error]
-  #   if the Object equals +reject+
-  def refute_equal!(reject, name = nil)
-    if self == reject
-      raise MiniSanity::Error.new(name,
-        "not #{reject.inspect}",
-        self.inspect)
-    end
-    self
-  end
-
-  # Checks that the Object is included in a given collection, and
-  # returns the Object unmodified.  If the Object fails this check, an
-  # exception is raised.
-  #
-  # @example
-  #   "good".assert_in!(["ok", "good", "great"])  # == "good"
-  #   "bad".assert_in!(["ok", "good", "great"])   # raises exception
-  #
-  # @param permitted [Enumerable, #include?]
-  #   collection of permitted values
-  # @param name [String, Symbol]
-  #   optional name to include in the error message
-  # @return [self]
-  # @raise [MiniSanity::Error]
-  #   if the Object is not included in +permitted+
-  def assert_in!(permitted, name = nil)
-    if !permitted.include?(self)
-      raise MiniSanity::Error.new(name,
-        "value included in #{permitted.inspect}",
-        self.inspect)
-    end
-    self
-  end
-
-  # Checks that the Object is not included in a given collection, and
-  # returns the Object unmodified.  If the Object fails this check, an
-  # exception is raised.
-  #
-  # @example
-  #   "good".refute_in!(["bad", "poor", "fail"])  # == "good"
-  #   "bad".refute_in!(["bad", "poor", "fail"])   # raises exception
-  #
-  # @param prohibited [Enumerable, #include?]
-  #   collection of prohibited values
-  # @param name [String, Symbol]
-  #   optional name to include in the error message
-  # @return [self]
-  # @raise [MiniSanity::Error]
-  #   if the Object is included in +prohibited+
-  def refute_in!(prohibited, name = nil)
-    if prohibited.include?(self)
-      raise MiniSanity::Error.new(name,
-        "value not included in #{prohibited.inspect}",
-        self.inspect)
-    end
-    self
-  end
-
-  # Checks that the Object is an instance of a given class, and returns
-  # the Object unmodified.  If the Object fails this check, an exception
-  # is raised.
-  #
-  # @example
-  #   123.assert_instance_of!(Numeric)  # == 123
-  #   123.assert_instance_of!(String)   # raises exception
-  #
-  # @param klass [Class]
-  #   class to check
-  # @param name [String, Symbol]
-  #   optional name to include in the error message
-  # @return [self]
-  # @raise [MiniSanity::Error]
-  #   if the Object is not an instance of +klass+
-  def assert_instance_of!(klass, name = nil)
-    if !self.instance_of?(klass)
-      raise MiniSanity::Error.new(name,
-        "instance of #{klass}",
-        "instance of #{self.class}: #{self.inspect}")
-    end
-    self
-  end
-
-  # Checks that the Object is an instance of a given class or one of its
-  # subclasses, and returns the Object unmodified.  If the Object fails
-  # this check, an exception is raised.
-  #
-  # @example
-  #   123.assert_kind_of!(Numeric)  # == 123
-  #   123.assert_kind_of!(Float)    # raises exception
-  #
-  # @param klass [Class]
-  #   class to check
-  # @param name [String, Symbol]
-  #   optional name to include in the error message
-  # @return [self]
-  # @raise [MiniSanity::Error]
-  #   if the Object is not an instance of +klass+ or its subclasses
-  def assert_kind_of!(klass, name = nil)
-    if !self.kind_of?(klass)
-      raise MiniSanity::Error.new(name,
-        "instance of #{klass} or one of its subclasses",
-        "instance of #{self.class}: #{self.inspect}")
-    end
-    self
-  end
-
-  # Checks that the Object responds to a given method, and returns the
-  # Object unmodified.  If the Object fails this check, an exception is
-  # raised.
-  #
-  # @example
-  #   "abc".assert_respond_to!(:empty?)  # == "abc"
-  #   "abc".assert_respond_to!(:pop)     # raises exception
-  #
-  # @param method_name [String, Symbol]
-  #   name of method to check
-  # @param name [String, Symbol]
-  #   optional name to include in the error message
-  # @return [self]
-  # @raise [MiniSanity::Error]
-  #   if the Object does not respond to +method_name+
-  def assert_respond_to!(method_name, name = nil)
-    if !self.respond_to?(method_name)
-      raise MiniSanity::Error.new(name,
-        "object responding to method #{method_name}",
-        "instance of #{self.class}: #{self.inspect}")
-    end
-    self
-  end
-
-end