mini_sanity 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c5da04d9d5a007087a446a04332d0ffc6384a5d8
+  data.tar.gz: a26754f66a63338980c31d97461d8a443d868106
+SHA512:
+  metadata.gz: d595fc9b17a60fb29ece9f2d553c0549aaa341ce055d16589157e4be2be072b0c28d92c8ea3a35973d6bce0aaf30444b1644f6f3704033e39462eb3289c9d8e7
+  data.tar.gz: '08db65b91fc28caa65d47a711afb0cb338ad0edfd1a601e78e642bb1846f4e150547612b42f996e77222c9ac27c8a35a86fa437da97a7c12fbc8c7af4cadb005'

data/.gitignore

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

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in mini_sanity.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Jonathan Hefner
+
+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,71 @@
+# mini_sanity
+
+In-line [sanity checks], written as extensions to core Ruby objects.  See
+API listing below, or browse the [full documentation].
+
+[sanity checks]: https://en.wikipedia.org/wiki/Sanity_check
+[full documentation]: http://www.rubydoc.info/gems/mini_sanity/
+
+
+# Example
+
+```ruby
+require "json"
+require "pathname"
+
+path = Pathname.new("hosted_files.json").assert_exist!
+
+hosted_files = JSON.parse(path.read).assert_instance_of!(Array)
+
+urls = hosted_files.flat_map do |file_info|
+  file_info.fetch("mirror_urls").refute_empty!
+end
+
+domains = urls.map do |url|
+  url.assert_match!(%r"^https?://").split("/")[2]
+end.uniq
+```
+
+
+# API
+
+- [Object](http://www.rubydoc.info/gems/mini_sanity/Object)
+  - [#assert_instance_of!](http://www.rubydoc.info/gems/mini_sanity/Object:assert_instance_of%21)
+  - [#assert_kind_of!](http://www.rubydoc.info/gems/mini_sanity/Object:assert_kind_of%21)
+  - [#assert_respond_to!](http://www.rubydoc.info/gems/mini_sanity/Object:assert_respond_to%21)
+  - [#refute_nil!](http://www.rubydoc.info/gems/mini_sanity/Object:refute_nil%21)
+- [Enumerable](http://www.rubydoc.info/gems/mini_sanity/Enumerable)
+  - [#refute_empty!](http://www.rubydoc.info/gems/mini_sanity/Enumerable:refute_empty%21)
+- [String](http://www.rubydoc.info/gems/mini_sanity/String)
+  - [#assert_match!](http://www.rubydoc.info/gems/mini_sanity/String:assert_match%21)
+  - [#refute_empty!](http://www.rubydoc.info/gems/mini_sanity/String:refute_empty%21)
+  - [#refute_match!](http://www.rubydoc.info/gems/mini_sanity/String:refute_match%21)
+- [Pathname](http://www.rubydoc.info/gems/mini_sanity/Pathname)
+  - [#assert_exist!](http://www.rubydoc.info/gems/mini_sanity/Pathname:assert_exist%21)
+  - [#refute_exist!](http://www.rubydoc.info/gems/mini_sanity/Pathname:refute_exist%21)
+
+
+## Installation
+
+Install from [Ruby Gems](https://rubygems.org/gems/mini_sanity):
+
+```bash
+$ gem install mini_sanity
+```
+
+Then require in your Ruby script:
+
+```ruby
+require "mini_sanity"
+```
+
+
+## Contributing
+
+Run `rake test` to run the tests.  You can also run `rake irb` for an
+interactive prompt that pre-loads the project code.
+
+
+## License
+
+[MIT License](https://opensource.org/licenses/MIT)

data/Rakefile

@@ -0,0 +1,23 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+require "yard"
+
+
+YARD::Rake::YardocTask.new(:doc) do |t|
+end
+
+desc "Launch IRB with this gem pre-loaded"
+task :irb do
+  require "mini_sanity"
+  require "irb"
+  ARGV.clear
+  IRB.start
+end
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/lib/mini_sanity.rb

@@ -0,0 +1,6 @@
+require_relative "mini_sanity/version"
+require_relative "mini_sanity/error"
+require_relative "mini_sanity/enumerable"
+require_relative "mini_sanity/object"
+require_relative "mini_sanity/pathname"
+require_relative "mini_sanity/string"

data/lib/mini_sanity/enumerable.rb

@@ -0,0 +1,23 @@
+module Enumerable
+
+  # Checks that the Enumerable is not empty, and returns the Enumerable
+  # unmodified.  If the Enumerable fails this check, an exception is
+  # raised.
+  #
+  # @example
+  #   [7, 8].refute_empty!  # == [7, 8]
+  #   [].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)
+    if self.empty?
+      raise MiniSanity::Error.new("#{name || self.class} is empty")
+    end
+    self
+  end
+
+end

data/lib/mini_sanity/error.rb

@@ -0,0 +1,2 @@
+class MiniSanity::Error < RuntimeError
+end

data/lib/mini_sanity/object.rb

@@ -0,0 +1,91 @@
+class Object
+
+  # Checks that the Object is not nil, and returns the Object
+  # unmodified.  If the Object fails this check, an exception is raised.
+  #
+  # @example
+  #   [7, 8].first.refute_nil!  # == 7
+  #   [].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?
+      message = name ? "#{name} is nil" : "unexpected nil"
+      raise MiniSanity::Error.new(message)
+    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
+  #   "abc".assert_instance_of!(String)   # == "abc"
+  #   "abc".assert_instance_of!(Numeric)  # 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)
+    unless self.instance_of?(klass)
+      prelude = name ? "#{name} is instance of #{self.class}" : "unexpected #{self.class}"
+      raise MiniSanity::Error.new("#{prelude}; expected #{klass}")
+    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
+  #   42.assert_kind_of!(Numeric)  # == 42
+  #   42.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)
+    unless self.kind_of?(klass)
+      prelude = name ? "#{name} is instance of #{self.class}" : "unexpected #{self.class}"
+      raise MiniSanity::Error.new("#{prelude}; expected #{klass} or one of its subclasses")
+    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)
+    unless self.respond_to?(method_name)
+      raise MiniSanity::Error.new("#{name || self.class} does not respond to #{method_name}")
+    end
+    self
+  end
+
+end

data/lib/mini_sanity/pathname.rb

@@ -0,0 +1,45 @@
+class Pathname
+
+  # Checks that the file or directory indicated by the Pathname exists,
+  # 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 file or directory indicated by the Pathname does not exist
+  def assert_exist!(name = nil)
+    unless self.exist?
+      descriptor = name ? "#{name} (#{self})" : self.to_s
+      raise MiniSanity::Error.new("#{descriptor} does not exist")
+    end
+    self
+  end
+
+  # Checks that the file or directory indicated by the Pathname does
+  # not already exist, 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 file or directory indicated by the Pathname already exists
+  def refute_exist!(name = nil)
+    if self.exist?
+      descriptor = name ? "#{name} (#{self})" : self.to_s
+      raise MiniSanity::Error.new("#{descriptor} already exists")
+    end
+    self
+  end
+
+end

data/lib/mini_sanity/string.rb

@@ -0,0 +1,68 @@
+class String
+
+  # Checks that the String is not empty, and returns the String
+  # unmodified.  If the String fails this check, an exception is raised.
+  #
+  # @example
+  #   "abc".refute_empty!  # == "abc"
+  #   "".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 || self.class} is empty")
+    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
+  #   "abc".assert_match!(/b/)  # == "abc"
+  #   "abc".assert_match!(/x/)  # 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)
+    unless regexp =~ self
+      descriptor = name ? "#{name} (#{self.inspect})" : self.inspect
+      raise MiniSanity::Error.new("#{descriptor} does not match #{regexp.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
+  #   "abc".refute_match!(/x/)  # == "abc"
+  #   "abc".refute_match!(/b/)  # 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
+      descriptor = name ? "#{name} (#{self.inspect})" : self.inspect
+      raise MiniSanity::Error.new("#{descriptor} matches #{regexp.inspect}; expected no match")
+    end
+    self
+  end
+
+end

data/lib/mini_sanity/version.rb

@@ -0,0 +1,3 @@
+module MiniSanity
+  VERSION = "1.0.0"
+end

data/mini_sanity.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "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.summary       = %q{In-line sanity checks}
+  spec.homepage      = "https://github.com/jonathanhefner/mini_sanity"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: mini_sanity
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jonathan Hefner
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-08-26 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: 
+email:
+- jonathan.hefner@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mini_sanity.rb
+- lib/mini_sanity/enumerable.rb
+- lib/mini_sanity/error.rb
+- lib/mini_sanity/object.rb
+- lib/mini_sanity/pathname.rb
+- lib/mini_sanity/string.rb
+- lib/mini_sanity/version.rb
+- mini_sanity.gemspec
+homepage: https://github.com/jonathanhefner/mini_sanity
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: In-line sanity checks
+test_files: []