abort_if 0.1.0

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,70 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+  # Rails files
+  rails = dsl.rails(view_extensions: %w(erb haml slim))
+  dsl.watch_spec_files_for(rails.app_files)
+  dsl.watch_spec_files_for(rails.views)
+
+  watch(rails.controllers) do |m|
+    [
+      rspec.spec.("routing/#{m[1]}_routing"),
+      rspec.spec.("controllers/#{m[1]}_controller"),
+      rspec.spec.("acceptance/#{m[1]}")
+    ]
+  end
+
+  # Rails config changes
+  watch(rails.spec_helper)     { rspec.spec_dir }
+  watch(rails.routes)          { "#{rspec.spec_dir}/routing" }
+  watch(rails.app_controller)  { "#{rspec.spec_dir}/controllers" }
+
+  # Capybara features specs
+  watch(rails.view_dirs)     { |m| rspec.spec.("features/#{m[1]}") }
+  watch(rails.layouts)       { |m| rspec.spec.("features/#{m[1]}") }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|
+    Dir[File.join("**/#{m[1]}.feature")][0] || "spec/acceptance"
+  end
+end

data/README.md

@@ -0,0 +1,74 @@
+# AbortIf
+
+[![Gem Version](https://badge.fury.io/rb/AbortIf.svg)](http://badge.fury.io/rb/AbortIf) [![Build Status](https://travis-ci.org/mooreryan/abort_if.svg?branch=master)](https://travis-ci.org/mooreryan/abort_if) [![Coverage Status](https://coveralls.io/repos/github/mooreryan/abort_if/badge.svg?branch=master)](https://coveralls.io/github/mooreryan/abort_if?branch=master)
+
+Simple error logging and assertions for Ruby.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'abort_if'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install abort_if
+
+## Usage
+
+See [documentation](http://www.rubydoc.info/gems/AbortIf) for complete
+usage.
+
+### Example ###
+
+Here is a tiny example program.
+
+    require "abort_if"
+
+    include AbortIf
+    include AbortIf::Assert
+
+    a = 5
+    b = 5
+    numbers = [1, 2, 3]
+    fname = "apple_pie.txt"
+    hash = nil
+
+    # this will pass
+    assert a == b, "%d should equal %d", a, b
+
+    # this will pass
+    abort_unless numbers.include?(1), "numbers should include 1"
+
+    # this will pass
+    abort_if_file_exists fname, "#{fname} should not exist"
+
+    File.open(fname, "w") do |f|
+      f.puts "Important info to follow...."
+    end
+
+    # oops, this will abort the progam and will log a nice message
+    # like this
+    # F, [2016-03-06T18:14:03.255900 #5357] FATAL -- : the hash was nil
+    abort_unless hash, "the hash was nil"
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/mooreryan/abort_if. This project is intended to be
+a safe, welcoming space for collaboration, and contributors are
+expected to adhere to the
+[Contributor Covenant](http://contributor-covenant.org) code of
+conduct.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/abort_if.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'abort_if/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "abort_if"
+  spec.version       = AbortIf::VERSION
+  spec.authors       = ["Ryan Moore"]
+  spec.email         = ["moorer@udel.edu"]
+
+  spec.summary       = %q{Easy error logging and assertions.}
+  spec.description   = %q{Easy error logging and assertions..}
+  spec.homepage      = "https://github.com/mooreryan/abort_if"
+  spec.license       = "GPLv3: http://www.gnu.org/licenses/gpl.txt"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = ">= 1.9.3"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "guard-rspec", "~> 4.6", ">= 4.6.4"
+  spec.add_development_dependency "yard", "~> 0.8.7.6"
+  spec.add_development_dependency "coveralls", "~> 0.8.11"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "abort_if"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/abort_if.rb

@@ -0,0 +1,127 @@
+# Copyright 2016 Ryan Moore
+# Contact: moorer@udel.edu
+#
+# This file is part of AbortIf.
+#
+# AbortIf is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# AbortIf is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with AbortIf.  If not, see <http://www.gnu.org/licenses/>.
+
+require "abort_if/version"
+require "abort_if/error"
+require "abort_if/argument_error"
+require "assert/assert"
+require "logger"
+
+module AbortIf
+  # Writes a message to the logger then calls abort if test is truthy,
+  # else returns nil.
+  #
+  # If test is true, write contents of msg to an error logger, then
+  # abort.
+  #
+  # @example When test is true
+  #   arr = []
+  #   abort_if arr.empty?, "Array empty"
+  #   # Prints this message to standard error, then exits
+  #   F, [2016-03-06T18:14:03.255900 #5357] FATAL -- : Array empty
+  #
+  # @example When test is false
+  #   arr = [1,2,3]
+  #   abort_if arr.empty?, "Array empty"
+  #   #=> nil
+  #
+  # @param test Some object or test
+  # @param msg [String] the message written by the
+  #   error logger
+  #
+  # @raise [SystemExit] if test is truthy
+  #
+  # @return [nil] if test is false or nil
+  #
+  # @note The abort_if style methods don't interpolate arguments to
+  #   msg as the Assert module methods do
+  def abort_if test, msg="Fatal error"
+    if test
+      logger.fatal msg
+      abort
+    end
+  end
+
+  # Writes a message to the logger then aborts if fname is a file that
+  # already exists.
+  #
+  # @param fname [String] name of a file
+  #
+  # @raise [SystemExit] if file exists
+  #
+  # @return [nil] if file does not exist
+  def abort_if_file_exists fname
+    abort_if File.exists?(fname),
+             "File '#{fname}' already exists"
+  end
+
+  # Writes a message to the logger then calls abort if test is false
+  # or nil, else returns nil.
+  #
+  # @example When test is true
+  #   arr = []
+  #   abort_unless arr.empty?, "Array should be empty"
+  #   #=> nil
+  #
+  # @example When test is false
+  #   arr = [1,2,3]
+  #   abort_unless arr.empty?, "Array not empty"
+  #   # Prints this message to standard error, then exits
+  #   F, [2016-03-06T18:14:03.255900 #5357] FATAL -- : Array not empty
+  #
+  # @param (see #abort_if)
+  #
+  # @raise [SystemExit] if test is false or nil
+  #
+  # @return [nil] if test is truthy
+  def abort_unless test, msg="Fatal error"
+    abort_if !test, msg
+  end
+
+  # Writes a message to the logger then aborts if fname is a file that
+  # does not exist.
+  #
+  # @param (see #abort_if_file_exists)
+  #
+  # @raise [SystemExit] if file does not exist
+  #
+  # @return [nil] if file exists
+  def abort_unless_file_exists fname
+    abort_unless File.exists?(fname),
+                 "File '#{fname}' does not exist"
+  end
+
+  # Returns a Logger.
+  #
+  # This method will create an instance of Logger with all the default
+  # options if one does not already exist. If a logger has already
+  # been created, return the old one.
+  #
+  # @example Logging an error
+  #   logger.error "An error occured"
+  #
+  # @return [Logger] a module level instance of Logger
+  #
+  # @note There is only one logger for the module.
+  # @note You can modify this logger just any of the Logger class from
+  #   the Ruby standard library (see
+  #   http://ruby-doc.org/stdlib-2.2.0/libdoc/logger/rdoc/Logger.html)
+  def logger
+    @@logger ||= Logger.new STDERR
+  end
+end

data/lib/abort_if/argument_error.rb

@@ -0,0 +1,23 @@
+# Copyright 2016 Ryan Moore
+# Contact: moorer@udel.edu
+#
+# This file is part of AbortIf.
+#
+# AbortIf is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# AbortIf is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with AbortIf.  If not, see <http://www.gnu.org/licenses/>.
+
+module AbortIf
+  # Raised if a method is passed improper arguments.
+  class ArgumentError < Error
+  end
+end

data/lib/abort_if/error.rb

@@ -0,0 +1,26 @@
+# Copyright 2016 Ryan Moore
+# Contact: moorer@udel.edu
+#
+# This file is part of AbortIf.
+#
+# AbortIf is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# AbortIf is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with AbortIf.  If not, see <http://www.gnu.org/licenses/>.
+
+module AbortIf
+  # Basic Error from which all other AbortIf errors inherit from.
+  #
+  # To rescue any error raised specifically by the AbortIf module, you
+  # could do `resuce AbortIf::Error => e`
+  class Error < StandardError
+  end
+end

data/lib/abort_if/version.rb

@@ -0,0 +1,21 @@
+# Copyright 2016 Ryan Moore
+# Contact: moorer@udel.edu
+#
+# This file is part of AbortIf.
+#
+# AbortIf is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# AbortIf is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with AbortIf.  If not, see <http://www.gnu.org/licenses/>.
+
+module AbortIf
+  VERSION = "0.1.0"
+end

data/lib/assert/assert.rb

@@ -0,0 +1,216 @@
+# Copyright 2016 Ryan Moore
+# Contact: moorer@udel.edu
+#
+# This file is part of AbortIf.
+#
+# AbortIf is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# AbortIf is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with AbortIf.  If not, see <http://www.gnu.org/licenses/>.
+
+module AbortIf
+  module Assert
+    # Error raised when any assert or refute method fails
+    class AssertionFailureError < Error
+    end
+
+    # If test is true, return nil, else raise AssertionFailureError
+    # with the given message.
+    #
+    # @example Test is true
+    #   a, b = 1, 1
+    #   assert a == b, "%d should equal %d", a, b
+    #   #=> nil
+    #
+    # @example Test is false
+    #   arr = [1,2,3]
+    #   assert arr.empty?,
+    #          "Array should be empty, had %d items"
+    #          arr.count
+    #   # raises AssertionFailureError with given msg
+    #
+    # @param test Some object or test
+    # @param msg [String] the message passed to the
+    #   AssertionFailureError
+    # @param *args arguments to interpolate into msg
+    #
+    # @raise [AssertionFailureError] if test is false or nil
+    #
+    # @return [nil] if test is truthy
+    def assert test, msg="Assertion failed", *args
+      unless test
+        raise AssertionFailureError, msg % args
+      end
+    end
+
+    # If test is false or nil, return nil, else raise
+    # AssertionFailureError.
+    #
+    # @param (see #assert)
+    #
+    # @raise [AssertionFailureError] if test is truthy
+    #
+    # @return [nil] if thest is false or nil
+    #
+    # @note The opposite of assert
+    def refute test, msg="Assertion failed", *args
+      assert !test, msg, *args
+    end
+
+    # If coll includes obj, return nil, else raise
+    # AssertionFailureError.
+    #
+    # @example Passing
+    #   assert_includes [1,2,3], 1
+    #   #=> nil
+    #
+    # @example Failing
+    #   assert_includes [1,2,3], 10
+    #   # raises AssertionFailureError
+    #
+    # @param coll [#include?] some collection
+    # @param obj the object to check for
+    #
+    # @raise [AssertionFailureError] if coll does not include object
+    # @raise [ArgumentError] if coll does not respond to :include?
+    #
+    # @return [nil] if coll includes obj
+    def assert_includes coll, obj
+      check_responds_to coll, :include?
+
+      assert coll.include?(obj),
+             "Expected coll to include obj"
+    end
+
+    # If coll includes obj, raise AssertionFailureError, else return
+    # nil.
+    #
+    # @param (see #assert_includes)
+    #
+    # @raise [AssertionFailureError] if coll does include object
+    # @raise [ArgumentError] if coll doesn't respond to :include?
+    #
+    # @return [nil] if coll does not include obj
+    def refute_includes coll, obj
+      check_responds_to coll, :include?
+
+      refute coll.include?(obj),
+             "Expected coll not to include obj"
+    end
+
+    # If any key is not present in coll, raise AssertionFailureError,
+    # else return nil.
+    #
+    # @example Passing
+    #   assert_keys {a: 2, b: 1}, :a, :b
+    #   #=> nil
+    #
+    # @example Failing
+    #   assert_keys {a: 2, b: 1}, :a, :b, :c
+    #   # raises AssertionFailureError
+    #
+    # @param coll [#[]] collection of things
+    # @param *keys keys to check for
+    #
+    # @raise [AssertionFailureError] if coll does include every key
+    # @raise [ArgumentError] if coll doesn't respond to :[]
+    #
+    # @return [nil] if coll has every key
+    def assert_keys coll, *keys
+      check_responds_to coll, :[]
+
+      check_not_empty keys
+
+      assert keys.all? { |key| coll[key] },
+             "Expected coll to include all keys"
+    end
+
+    # If the key is present in hash, return nil, else raise
+    # AssertionFailureError.
+    #
+    # @example Passing
+    #   assert_has_key {a: 2, b: 1}, :a
+    #   #=> nil
+    #
+    # @example Failing
+    #   assert_has_key {a: 2, b: 1}, :c
+    #   # raises AssertionFailureError
+    #
+    # @param hash [#has_key?] anything that responds to :has_key?
+    # @param key the key to check for
+    #
+    # @raise [AssertionFailureError] if hash doesn't include key
+    # @raise [ArgumentError] if coll doesn't respond to :has_key?
+    #
+    # @return [nil] if hash has key
+    def assert_has_key hash, key
+      check_responds_to hash, :has_key?
+
+      assert hash.has_key?(key),
+             "Expected hash to include key"
+    end
+
+    # If the key is present in hash, raise AssertionFailureError, else
+    # return nil.
+    #
+    # @example Passing
+    #   refute_has_key {a: 2, b: 1}, :a
+    #   # raises AssertionFailureError
+    #
+    # @example Failing
+    #   refute_has_key {a: 2, b: 1}, :c
+    #   #=> nil
+    #
+    # @param (see #assert_has_key)
+    #
+    # @raise [AssertionFailureError] if hash includes key
+    # @raise [ArgumentError] if coll doesn't respond to :has_key?
+    #
+    # @return [nil] if hash does not have key
+    def refute_has_key hash, key
+      check_responds_to hash, :has_key?
+
+      refute hash.has_key?(key),
+             "Expected hash not to include key"
+    end
+
+    # If coll is given length, return nil, else raise
+    # AssertionFailureError.
+    #
+    # @param coll [#length] anything that responds to :length
+    # @param len [Number] the length to check for
+    #
+    # @raise [AssertionFailureError] if length of coll doesn't match
+    #   given len
+    # @raise [ArgumentError] if coll doesn't respond to :length
+    #
+    # @return [nil] if length of coll matches given len
+    def assert_length coll, len
+      check_responds_to coll, :length
+
+      assert coll.length == len,
+             "Expected coll to have %d items",
+             len
+    end
+
+    private
+
+    def check_responds_to coll, method
+      raise ArgumentError unless coll.respond_to? method
+    end
+
+    def check_not_empty coll
+      check_responds_to coll, :count
+
+      raise ArgumentError unless coll.count > 0
+    end
+  end
+end