bail 0.0.1

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.irbrc
+Guardfile
+.guardrc

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.rvmrc

@@ -0,0 +1 @@
+rvm use ruby-1.9.3-p392@bail --create

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 bjh
+
+MIT License
+
+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,87 @@
+# Bail
+
+#### What
+A miniscule DSL to write guard clauses. Also to ask some basic questions of my types when I get curious.
+
+#### Why
+I was finding my methods were collecting a top layer of IF/ELSE statements that got harder to read and maintain.
+
+#### How
+Sweet sexy voodoo magic.
+
+***
+
+A basic *un-sugared* guard looks something like this: 
+```
+Bail.when(:any, :of, :these, :things) {|item| item.nil?}
+```
+
+So you pass in an enumerator (defaults are the Enumerable module methods), any number of arguments, and a `block` for the condition test.
+
+Super *easy* and super *cheezy*.
+
+There are more specialized versions that do not require a block:  
+These are really just lightly *sugared* wrappers around Enumerable methods...
+
+```
+Bail.when_any(condition, *objects)
+Bail.when_all(condition, *objects)
+Bail.when_one(condition, *objects)
+Bail.when_none(condition, *objects)
+```
+
+#### Why would you care?
+To understand the **why** of this gem you can ask yourself this question:  
+Do I prefer to read this: 
+```
+[:one, :of, :these, :things].any? {|x| nil?}
+```
+or this: 
+```
+Bail.when_any(:nil, :one, :of, :these, :things)
+```
+
+#### Example Usage
+
+Bail will usually live at the top of your methods.
+
+```
+# Assuming that Bail.raise_on_error = false
+def some_method(that, takes, arguments)
+  return if Bail.when(:nil, that, takes, arguments)
+  return if Bail.when_none({:is_a, String}, that, takes, arguments)
+  
+  # I will use it for type discovery instead of blindly asking it to quack
+  # i.e. I know I want the takes variable to be an Integer but I get it as a String sometimes...
+  if Bail.when_any({:is_a: String}, takes)
+    Logger.debug("you are passing in `takes` to `some_method` as a String from somewhere...")
+    takes = takes.to_i
+  end
+end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'bail'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bail
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/bail/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,13 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+# If you want to make this the default task
+task default: :spec
+
+desc 'load gem files into IRB'
+task :console do
+  exec 'irb -Ilib -rbail'
+  # exec 'irb -I lib -r startingscript.rb'
+end

data/bail.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bail/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bail"
+  spec.version       = Bail::VERSION
+  spec.authors       = ["bjh"]
+  spec.email         = ["bjh@fake.fake"]
+  spec.summary       = %q{Bail out of functions early}
+  spec.description   = %q{Bail out of functions early...}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "guard-rspec"
+  # spec.add_development_dependency "guard"
+  # spec.add_development_dependency "guard-shell"
+  # spec.add_development_dependency 'rb-fsevent', '~> 0.9'
+end

data/lib/bail/behavior/behavior.rb

@@ -0,0 +1,9 @@
+
+module Bail
+  class Behavior
+  protected
+    def run(&block)
+      raise 'override me or you will be trampled by unicorns!'
+    end
+  end
+end

data/lib/bail/behavior/raise_behavior.rb

@@ -0,0 +1,15 @@
+require_relative 'behavior.rb'
+
+module Bail
+  class RaiseBehavior < Behavior
+    def run(&block)
+      yield block
+    rescue Bail::ConditionError => e
+      if not Bail.suppress_output
+        Bail.logger.warn(e.message)
+      end
+
+      raise e
+    end
+  end
+end

data/lib/bail/behavior/return_behavior.rb

@@ -0,0 +1,21 @@
+require_relative 'behavior.rb'
+
+module Bail
+  class ReturnBehavior < Behavior
+
+    attr_accessor :result
+
+    def run(&block)
+      yield block
+      result = false
+    rescue Bail::ConditionError => e
+      result = true
+
+      if not Bail.suppress_output
+        Bail.logger.warn(e.message)
+      end
+    ensure
+      return result
+    end
+  end
+end

data/lib/bail/condition_parser.rb

@@ -0,0 +1,32 @@
+require_relative 'helpers.rb'
+
+module Bail
+  class ConditionParser
+    attr_accessor :condition
+
+    def initialize(condition)
+      @condition = make_callable(condition)
+    end
+
+    def test(object)
+      condition.call(object)
+    end
+
+  protected
+    # TODO: find out if Helpers is actually included as protected
+    include Helpers
+
+    def make_callable(condition)
+      if condition.respond_to? :call
+        condition
+      elsif condition.is_a? Hash
+        condition_hash_to_lambda(condition)
+      else
+        # Assume Symbol or String for now
+        # so wrap it in a pretty dress
+        question = questionable(condition)
+        ->(to) { to.send(question) }
+      end
+    end
+  end
+end

data/lib/bail/condition_tester.rb

@@ -0,0 +1,21 @@
+require_relative 'helpers.rb'
+
+module Bail
+  class ConditionTester
+    include Helpers
+
+    attr_accessor :type
+
+    def initialize(type)
+      # can be methods from Enumerable basically
+      #  i.e. :any?, :all?
+      @type = questionable(type)
+    end
+
+    def run(condition_parser, objects)
+      if objects.send(type) {|object| condition_parser.test(object)}
+        raise Bail::ConditionError.new('A Bail condition has failed.')
+      end
+    end
+  end
+end

data/lib/bail/configuration.rb

@@ -0,0 +1,7 @@
+module Bail
+  module Configuration
+    attr_accessor :logger
+    attr_accessor :suppress_output
+    attr_accessor :behavior
+  end
+end

data/lib/bail/helpers.rb

@@ -0,0 +1,17 @@
+
+module Bail
+  module Helpers
+    def questionable(condition)
+      # TODO: Object.new.extend(Enumerable).respond_to? condition
+      # WHY: to allow {is_a: Thing} which becomes - [...].is_a? Thing
+      condition.to_s.gsub(/\?$/, '').gsub(/$/, '?').to_sym
+    end
+
+    def condition_hash_to_lambda(condition)
+      test = questionable(condition.keys.first)
+      against = condition.values.first
+
+      ->(testee) { testee.send(test, against) }
+    end
+  end
+end

data/lib/bail/version.rb

@@ -0,0 +1,3 @@
+module Bail
+  VERSION = "0.0.1"
+end

data/lib/bail.rb

@@ -0,0 +1,67 @@
+require 'logger'
+require 'bail/version'
+require 'bail/configuration'
+require 'bail/condition_parser.rb'
+require 'bail/condition_tester.rb'
+require 'bail/behavior/raise_behavior.rb'
+require 'bail/behavior/return_behavior.rb'
+
+module Bail
+  class ConditionError < ArgumentError; end
+
+  # Bail.when(:any, :of, :these, :things) {|item| item.nil?}
+  def self.when(enumerator, *objects, &block)
+    execute(enumerator, block, objects)
+  end
+
+  def self.when_any(condition, *objects)
+    execute(:any?, condition, objects)
+  end
+
+  def self.when_all(condition, *objects)
+    execute(:all?, condition, objects)
+  end
+
+  def self.when_one(condition, *objects)
+    execute(:one?, condition, objects)
+  end
+
+  def self.when_none(condition, *objects)
+    execute(:none?, condition, objects)
+  end
+
+  def self.execute(type, condition, objects)
+    Bail.behavior.run do
+      ConditionTester.new(type).run(ConditionParser.new(condition), objects)
+    end
+  end
+
+  private_class_method :execute
+
+  extend Configuration
+
+  # where the wood goes
+  Bail.logger = Logger.new(STDOUT)
+  Bail.logger.level = Logger::DEBUG
+  Bail.logger.formatter = proc do |severity, datetime, progname, msg|
+    "Bail::[#{msg}]\n"
+  end
+
+  # handle the behavior preferences
+  def self.raise_on_error
+    @@raise_on_error
+  end
+
+  def self.raise_on_error=(boolean_value)
+    @@raise_on_error = boolean_value
+
+    if boolean_value
+      Bail.behavior = RaiseBehavior.new
+    else
+      Bail.behavior = ReturnBehavior.new
+    end
+  end
+
+  # default to return true/false
+  Bail.raise_on_error = true
+end

data/spec/bail/helpers_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+require 'bail/helpers.rb'
+
+describe Bail::Helpers do
+  subject { Object.new.extend(Bail::Helpers) }
+
+  describe '.questionable' do
+    context 'when the condition already has a `?` on the end' do
+      it 'returns the condition unchanged' do
+        expect(subject.questionable(:is_a?)).to eq :is_a?
+      end
+    end
+
+    context 'when the condition does not have a `?` on the end' do
+      it 'returns the condition with a ? on the end' do
+        expect(subject.questionable(:is_a)).to eq :is_a?
+      end
+    end
+  end
+
+  describe '.condition_hash_to_lambda' do
+    it 'returns a lambda' do
+      f = subject.condition_hash_to_lambda(is_a: String)
+      expect(f).to be_a Proc
+    end
+  end
+end

data/spec/bail_spec.rb

@@ -0,0 +1,110 @@
+require 'spec_helper'
+require 'bail.rb'
+
+describe Bail do
+  before :each do
+    Bail.suppress_output = true
+    Bail.raise_on_error = false
+  end
+
+  after :each do
+    Bail.suppress_output = false
+    Bail.raise_on_error = true
+  end
+
+  describe '.behavior' do
+    context 'raise_on_error' do
+      it 'should raise an error when true' do
+        Bail.raise_on_error = true
+
+        expect {
+          Bail.when_any(:nil, nil)
+        }.to raise_error
+      end
+
+      it 'should return a boolean result when false' do
+        Bail.raise_on_error = false
+
+        expect {
+          Bail.when_any(:nil, nil)
+        }.not_to raise_error
+
+        expect(Bail.when_any(:nil, nil)).to be_true
+      end
+    end
+  end
+
+  describe '.when' do
+    it 'allows passing in a block as the condition test' do
+      r = Bail.when(:none, 1, 2, 3) { |x| x.nil? }
+      expect(r).to be_true
+    end
+  end
+
+  describe '.when_any' do
+    context 'using a lambda as the condition' do
+      it 'raises an error when any item is true' do
+        Bail.raise_on_error = true
+
+        expect {
+          Bail.when_any(->(x){x.nil?}, 1, nil, 3)
+        }.to raise_error
+      end
+    end
+
+    context 'using a symbol as the condition' do
+      it 'raises an error when any item is true' do
+        Bail.raise_on_error = true
+
+        expect {
+          Bail.when_any(:nil?, 1, 2, nil)
+        }.to raise_error
+      end
+
+      it 'does not raise an error when all items are false' do
+        expect {
+          Bail.when_any(:nil?, 1, 2, 3)
+        }.not_to raise_error
+      end
+    end
+
+    context 'using a Hash as the condition' do
+      it 'allows passing a type constraint along with the condition test' do
+        r = Bail.when_any({is_a: String}, 1, 2, '3')
+        expect(r).to be_true
+      end
+    end
+  end
+
+  describe '.when_all' do
+    it 'returns true when all items pass the condition test' do
+      r = Bail.when_all(:nil?, nil, nil, nil)
+      expect(r).to be_true
+    end
+
+    it 'returns false if any item fails the condition test' do
+      r = Bail.when_all(:nil?, nil, nil, 3)
+      expect(r).to be_false
+    end
+  end
+
+  describe '.when_one' do
+    it 'returns true if exactly one item is true' do
+      expect(Bail.when_one(:nil?, 1, 2, nil, 4, 5)).to be_true
+    end
+
+    it 'returns false if more than one item is true' do
+      expect(Bail.when_one(:nil?, 1, 2, nil, 4, 5, nil)).to be_false
+    end
+  end
+
+  describe '.when_none' do
+    it 'returns true if all items FAIL the test' do
+      expect(Bail.when_none(:nil?, 1, 2, 4, 5)).to be_true
+    end
+
+    it 'returns true if one or more items PASS the test' do
+      expect(Bail.when_none(:nil?, 1, 2, nil, 4, 5)).to be_false
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require 'bundler/setup'
+Bundler.setup
+
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: bail
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- bjh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Bail out of functions early...
+email:
+- bjh@fake.fake
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bail.gemspec
+- lib/bail.rb
+- lib/bail/behavior/behavior.rb
+- lib/bail/behavior/raise_behavior.rb
+- lib/bail/behavior/return_behavior.rb
+- lib/bail/condition_parser.rb
+- lib/bail/condition_tester.rb
+- lib/bail/configuration.rb
+- lib/bail/helpers.rb
+- lib/bail/version.rb
+- spec/bail/helpers_spec.rb
+- spec/bail_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Bail out of functions early
+test_files:
+- spec/bail/helpers_spec.rb
+- spec/bail_spec.rb
+- spec/spec_helper.rb