mini_sanity 1.1.0 → 2.0.0

data/lib/mini_sanity/error.rb

@@ -1,11 +1,21 @@
-class MiniSanity::Error < RuntimeError
+module MiniSanity
+  class Error < RuntimeError
 
-  def initialize(name, expected, actual)
-    super(
-      "\n#{name || "value"} violates expectations\n" \
-      "  expected: #{expected}\n" \
-      "  actual: #{actual}\n"
-    )
-  end
+    def initialize(message, details = {})
+      super([
+        message,
+        *details.compact.map{|name, value| "#{name}:\n  #{value}" }
+      ].join("\n\n"))
+    end
+
+    # @!visibility private
+    def self.describe_block(&block)
+      if (symbol_name = block.to_s[/\(&:(.+)\)>$/, 1])
+        "&:#{symbol_name}"
+      elsif block&.source_location
+        "block@#{block.source_location.join(":")}"
+      end
+    end
 
+  end
 end

data/lib/mini_sanity/match.rb

@@ -0,0 +1,57 @@
+require_relative "error"
+
+
+class String
+
+  # Like {https://docs.ruby-lang.org/en/master/String.html#method-i-match
+  # +String#match+}, but raises an exception if the match fails.
+  #
+  # @example
+  #   "user@example.com".match!(/^([^@]+)@(.+)$/)  # === MatchData
+  #   "@user".match!(/^([^@]+)@(.+)$/)             # raises exception
+  #
+  # @param pattern [Regexp]
+  #   Pattern to search for
+  # @param pos [Integer]
+  #   Position in the String to search from
+  # @return [MatchData]
+  # @raise [MiniSanity::Error]
+  #   if +pattern+ does not match the String
+  def match!(pattern, pos = 0)
+    result = self.match(pattern, pos)
+
+    if result.nil?
+      raise MiniSanity::Error.new("String does not match pattern", {
+        "String" => self.inspect,
+        "Relevant portion (from position #{pos})" => (self[pos..].inspect if pos != 0),
+        "Pattern" => pattern.inspect,
+      })
+    end
+
+    result
+  end
+
+end
+
+
+class Regexp
+
+  # Like {https://docs.ruby-lang.org/en/master/Regexp.html#method-i-match
+  # +Regexp#match+}, but raises an exception if the match fails.
+  #
+  # @example
+  #   /^([^@]+)@(.+)$/.match!("user@example.com")  # === MatchData
+  #   /^([^@]+)@(.+)$/.match!("@user")             # raises exception
+  #
+  # @param str [String]
+  #   String to search
+  # @param pos [Integer]
+  #   Position in +str+ to search from
+  # @return [MatchData]
+  # @raise [MiniSanity::Error]
+  #   if the Regexp does not match +str+
+  def match!(str, pos = 0)
+    str.match!(self, pos)
+  end
+
+end

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 = "2.0.0"
 end

data/mini_sanity.gemspec

@@ -1,27 +1,26 @@
-# 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 = ">= 2.6"
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
+  spec.metadata["homepage_uri"] = spec.homepage
+  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.match(%r{^(test|spec|features)/}) }
   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,74 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: mini_sanity
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.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'
+date: 2020-02-02 00:00:00.000000000 Z
+dependencies: []
 description: 
 email:
-- jonathan.hefner@gmail.com
+- jonathan@hefner.pro
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -81,22 +25,20 @@ files:
 - 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: {}
+metadata:
+  homepage_uri: https://github.com/jonathanhefner/mini_sanity
+  source_code_uri: https://github.com/jonathanhefner/mini_sanity
+  changelog_uri: https://github.com/jonathanhefner/mini_sanity/blob/master/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -105,15 +47,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: In-line sanity checks

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