mini_sanity 1.1.0 → 2.0.0

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

data/lib/mini_sanity/pathname.rb

@@ -1,135 +0,0 @@
-class Pathname
-
-  # Checks that the Pathname represents an existing file or directory,
-  # and returns the Pathname unmodified.  If the Pathname fails this
-  # check, an exception is raised.
-  #
-  # @example
-  #   Pathname.new(__FILE__).assert_exist!          # == Pathname.new(__FILE__)
-  #   Pathname.new("/dev/null/nope").assert_exist!  # == raises exception
-  #
-  # @param name [String, Symbol]
-  #   optional name to include in the error message
-  # @return [self]
-  # @raise [MiniSanity::Error]
-  #   if the Pathname does not represent an existing file or directory
-  def assert_exist!(name = nil)
-    if !self.exist?
-      raise MiniSanity::Error.new(name,
-        "existent file or directory",
-        "#{self} does not exist")
-    end
-    self
-  end
-
-  # Checks that the Pathname does not represent an existing file or
-  # directory, and returns the Pathname unmodified.  If the Pathname
-  # fails this check, an exception is raised.
-  #
-  # @example
-  #   Pathname.new("/dev/null/nope").refute_exist!  # == Pathname.new("/dev/null/nope")
-  #   Pathname.new(__FILE__).refute_exist!          # raises exception
-  #
-  # @param name [String, Symbol]
-  #   optional name to include in the error message
-  # @return [self]
-  # @raise [MiniSanity::Error]
-  #   if the Pathname represents an existing file or directory
-  def refute_exist!(name = nil)
-    if self.exist?
-      raise MiniSanity::Error.new(name,
-        "non-existent file or directory",
-        "#{self} already exists")
-    end
-    self
-  end
-
-  # Checks that the Pathname represents an existing directory, and
-  # returns the Pathname unmodified.  If the Pathname fails this check,
-  # an exception is raised.
-  #
-  # @example
-  #   Pathname.new(__dir__).assert_dir!   # == Pathname.new(__dir__)
-  #   Pathname.new(__FILE__).assert_dir!  # == raises exception
-  #
-  # @param name [String, Symbol]
-  #   optional name to include in the error message
-  # @return [self]
-  # @raise [MiniSanity::Error]
-  #   if the Pathname does not represent an existing directory
-  def assert_dir!(name = nil)
-    if !self.directory?
-      raise MiniSanity::Error.new(name,
-        "existent directory",
-        "#{self} is not a directory")
-    end
-    self
-  end
-
-  # Checks that the Pathname does not represent an existing directory,
-  # and returns the Pathname unmodified.  If the Pathname fails this
-  # check, an exception is raised.
-  #
-  # @example
-  #   Pathname.new(__FILE__).refute_dir!  # == Pathname.new(__FILE__)
-  #   Pathname.new(__dir__).refute_dir!   # raises exception
-  #
-  # @param name [String, Symbol]
-  #   optional name to include in the error message
-  # @return [self]
-  # @raise [MiniSanity::Error]
-  #   if the Pathname represents an existing directory
-  def refute_dir!(name = nil)
-    if self.directory?
-      raise MiniSanity::Error.new(name,
-        "not an existent directory",
-        "#{self} is a directory")
-    end
-    self
-  end
-
-  # Checks that the Pathname represents an existing file, and returns
-  # the Pathname unmodified.  If the Pathname fails this check, an
-  # exception is raised.
-  #
-  # @example
-  #   Pathname.new(__FILE__).assert_file!  # == Pathname.new(__FILE__)
-  #   Pathname.new(__dir__).assert_file!   # == raises exception
-  #
-  # @param name [String, Symbol]
-  #   optional name to include in the error message
-  # @return [self]
-  # @raise [MiniSanity::Error]
-  #   if the Pathname does not represent an existing file
-  def assert_file!(name = nil)
-    if !self.file?
-      raise MiniSanity::Error.new(name,
-        "existent file",
-        "#{self} is not a file")
-    end
-    self
-  end
-
-  # Checks that the Pathname does not represent an existing file, and
-  # returns the Pathname unmodified.  If the Pathname fails this check,
-  # an exception is raised.
-  #
-  # @example
-  #   Pathname.new(__dir__).refute_file!   # == Pathname.new(__dir__)
-  #   Pathname.new(__FILE__).refute_file!  # raises exception
-  #
-  # @param name [String, Symbol]
-  #   optional name to include in the error message
-  # @return [self]
-  # @raise [MiniSanity::Error]
-  #   if the Pathname represents an existing file
-  def refute_file!(name = nil)
-    if self.file?
-      raise MiniSanity::Error.new(name,
-        "not an existent file",
-        "#{self} is a file")
-    end
-    self
-  end
-
-end

data/lib/mini_sanity/string.rb

@@ -1,143 +0,0 @@
-class String
-
-  # Checks that the String is empty, and returns the String unmodified.
-  # If the String fails this check, an exception is raised.
-  #
-  # @example
-  #   "".assert_empty!     # == ""
-  #   "bad".assert_empty!  # raises exception
-  #
-  # @param name [String, Symbol]
-  #   optional name to include in the error message
-  # @return [self]
-  # @raise [MiniSanity::Error]
-  #   if the String is not empty
-  def assert_empty!(name = nil)
-    if !self.empty?
-      raise MiniSanity::Error.new(name,
-        "empty #{self.class}",
-        self.inspect)
-    end
-    self
-  end
-
-  # Checks that the String is not empty, and returns the String
-  # unmodified.  If the String fails this check, an exception is raised.
-  #
-  # @example
-  #   "result".refute_empty!  # == "result"
-  #   "".refute_empty!        # raises exception
-  #
-  # @param name [String, Symbol]
-  #   optional name to include in the error message
-  # @return [self]
-  # @raise [MiniSanity::Error]
-  #   if the String is empty
-  def refute_empty!(name = nil)
-    if self.empty?
-      raise MiniSanity::Error.new(name,
-        "non-empty #{self.class}",
-        self.inspect)
-    end
-    self
-  end
-
-  # Checks that the String matches a given length, and returns the
-  # String unmodified.  If the String fails this check, an exception is
-  # raised.
-  #
-  # @example
-  #   "password".assert_length!(8)           # == "password"
-  #   "long password".assert_length!(8..64)  # == "long password"
-  #   "pass".assert_length!(8..64)           # == raises exception
-  #
-  # @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 String length does not match +length+
-  def assert_length!(length, name = nil)
-    if !(length === self.length)
-      raise MiniSanity::Error.new(name,
-        "#{self.class} having #{length} characters",
-        self.inspect)
-    end
-    self
-  end
-
-  # Checks that the String does not match a given length, and returns
-  # the String unmodified.  If the String fails this check, an exception
-  # is raised.
-  #
-  # @example
-  #   "password".refute_length!(0)           # == "password"
-  #   "long password".refute_length!(0...8)  # == "long password"
-  #   "pass".refute_length!(0...8)           # == raises exception
-  #
-  # @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 String length matches +length+
-  def refute_length!(length, name = nil)
-    if length === self.length
-      raise MiniSanity::Error.new(name,
-        "#{self.class} not having #{length} characters",
-        self.inspect)
-    end
-    self
-  end
-
-  # Checks that the String matches a given regular expression, and
-  # returns the String unmodified.  If the String fails this check, an
-  # exception is raised.
-  #
-  # @example
-  #   "good result".assert_match!(/^good/)  # == "good result"
-  #   "bad result".assert_match!(/^good/)   # raises exception
-  #
-  # @param regexp [Regexp]
-  #   regular expression to check
-  # @param name [String, Symbol]
-  #   optional name to include in the error message
-  # @return [self]
-  # @raise [MiniSanity::Error]
-  #   if the String does not match +regexp+
-  def assert_match!(regexp, name = nil)
-    if regexp !~ self
-      raise MiniSanity::Error.new(name,
-        "#{self.class} matching #{regexp.inspect}",
-        self.inspect)
-    end
-    self
-  end
-
-  # Checks that the String does not match a given regular expression,
-  # and returns the String unmodified.  If the String fails this check,
-  # an exception is raised.
-  #
-  # @example
-  #   "good result".refute_match!(/^bad/)  # == "good result"
-  #   "bad result".refute_match!(/^bad/)   # raises exception
-  #
-  # @param regexp [Regexp]
-  #   regular expression to check
-  # @param name [String, Symbol]
-  #   optional name to include in the error message
-  # @return [self]
-  # @raise [MiniSanity::Error]
-  #   if the String matches +regexp+
-  def refute_match!(regexp, name = nil)
-    if regexp =~ self
-      raise MiniSanity::Error.new(name,
-        "#{self.class} not matching #{regexp.inspect}",
-        self.inspect)
-    end
-    self
-  end
-
-end