mini_sanity 1.1.0 → 3.0.0

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

data/lib/mini_sanity/util/enumerable.rb

@@ -1,31 +0,0 @@
-module Enumerable
-
-  # Like {https://ruby-doc.org/core/Enumerable.html#method-i-first
-  # +Enumerable#first+}, but raises an exception if the Enumerable does
-  # not contain the requested number of elements.
-  #
-  # @example
-  #   [7, 8, 9].first     # == 7
-  #   [7, 8, 9].first(1)  # == [7]
-  #   [7, 8, 9].first(2)  # == [7, 8]
-  #   [7, 8, 9].first(4)  # raises exception
-  #   [].first            # raises exception
-  #
-  # @param n [Integer]
-  #   requested number of elements
-  # @return [Object, Array]
-  # @raise [MiniSanity::Error]
-  #   if the Enumerable does not contain the requested number of elements
-  def first!(n = nil)
-    result = n.nil? ? self.first : self.first(n)
-
-    if (result.nil? && !self.any?{ true }) || (!n.nil? && result.length < n)
-      raise MiniSanity::Error.new(nil,
-        "Enumerable having at least #{n || 1} elements",
-        self.inspect)
-    end
-
-    result
-  end
-
-end

data/lib/mini_sanity/util/regexp.rb

@@ -1,27 +0,0 @@
-class Regexp
-
-  # Like {https://ruby-doc.org/core/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 begin the search
-  # @return [MatchData]
-  # @raise [MiniSanity::Error]
-  #   if the Regexp does not match +str+
-  def match!(str, pos = 0)
-    result = self.match(str, pos)
-    if result.nil?
-      raise MiniSanity::Error.new(nil,
-        "String matching #{self.inspect}#{" from position #{pos}" if pos != 0}",
-        str.inspect)
-    end
-    result
-  end
-
-end

data/lib/mini_sanity/util/string.rb

@@ -1,77 +0,0 @@
-class String
-
-  # Like {https://ruby-doc.org/core/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 begin the search
-  # @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(nil,
-        "String matching #{pattern.inspect}#{" from position #{pos}" if pos != 0}",
-        self.inspect)
-    end
-    result
-  end
-
-  # Like {https://ruby-doc.org/core/String.html#method-i-sub-21
-  # +String#sub!+}, but raises an exception if no substitution was
-  # performed.
-  #
-  # @example
-  #   "author: YOUR_NAME".change!(/\bYOUR_NAME\b/, "Me")  # == "author: Me"
-  #   "author: TODO".change!(/\bYOUR_NAME\b/, "Me")       # raises exception
-  #
-  # @param pattern [Regexp, String]
-  #   pattern to search for
-  # @param replacement [String, Hash, &block]
-  #   substitution value (see +String#sub!+ documentation for full details)
-  # @return [String]
-  # @raise [MiniSanity::Error]
-  #   if no substitution was performed
-  def change!(pattern, replacement = nil, &replacement_block)
-    result = if replacement
-      self.sub!(pattern, replacement)
-    else
-      self.sub!(pattern, &replacement_block)
-    end
-
-    if !result
-      raise MiniSanity::Error.new(nil,
-        "String matching #{pattern.inspect}",
-        self.inspect)
-    end
-
-    result
-  end
-
-  # Like {https://ruby-doc.org/core/String.html#method-i-sub
-  # +String#sub+}, but raises an exception if no substitution was
-  # performed.
-  #
-  # @example
-  #   "author: YOUR_NAME".change(/\bYOUR_NAME\b/, "Me")  # == "author: Me"
-  #   "author: TODO".change(/\bYOUR_NAME\b/, "Me")       # raises exception
-  #
-  # @param pattern [Regexp, String]
-  #   pattern to search for
-  # @param replacement [String, Hash, &block]
-  #   substitution value (see +String#sub+ documentation for full details)
-  # @return [String]
-  # @raise [MiniSanity::Error]
-  #   if no substitution was performed
-  def change(pattern, replacement = nil, &replacement_block)
-    self.dup.change!(pattern, replacement, &replacement_block)
-  end
-
-end

data/lib/mini_sanity/util.rb

@@ -1,3 +0,0 @@
-require_relative "util/enumerable"
-require_relative "util/regexp"
-require_relative "util/string"