clean_assert 1.0.0

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Niclas Nilsson
+
+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,39 @@
+# clean_assert
+
+A Ruby library to get really clean asserts.
+
+## Usage
+
+Example:
+
+    assert / "name != nil" / "not name.empty?" / "age >= 21"
+
+This will do three separate assertion checks and will give you an error message that includes
+the broken assertion code, the class and the method name. No need for having both the actual assertion and
+then a strained error message that you normally have to write to understand what broke. Also, due to it's terseness,
+you can afford having several guard clauses on one line instead of letting them take over your method, which keeps
+the signal-to-noise ratio sane.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'clean_assert'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install clean_assert
+
+## Contributing
+
+1. Fork it
+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,7 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+

data/clean_assert.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'clean_assert/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "clean_assert"
+  spec.version       = CleanAssert::VERSION
+  spec.authors       = ["Niclas Nilsson"]
+  spec.email         = ["niclas@niclasnilsson.se"]
+  spec.description   = %q{A Ruby gem to get really clean asserts}
+  spec.summary       = %q{A Ruby gem to get really clean asserts}
+  spec.homepage      = "https://github.com/niclasnilsson/clean_assert"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_dependency "facets", "~> 2.9"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/clean_assert/version.rb

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

data/lib/clean_assert.rb

@@ -0,0 +1,19 @@
+require 'facets'
+
+module Kernel
+  alias_method :assert, :binding
+end
+
+class Binding
+  
+  def / expression
+    if not eval expression
+      the_caller = /\`([^\']+)\'/.match(caller(0).first)
+      m = "unknown"
+      m = the_caller ? the_caller[1] : m
+      raise "Assertion '#{expression}' not satisfied in #{self.self()}##{m}"
+    end
+    self
+  end
+  
+end

data/spec/clean_assert_spec.rb

@@ -0,0 +1,72 @@
+$LOAD_PATH << File.expand_path(File.join('..', 'lib'), File.dirname(__FILE__))
+
+require 'clean_assert'
+
+class Binary
+  @@binary_states = 2
+  
+  def self.binary_states= value
+    @@binary_states = value
+  end
+  
+  def self.check_binary_states
+    assert / "@@binary_states == 2"
+  end
+end
+
+class Person
+  attr_accessor :age
+  def check_invariant
+    assert / "@age >= 0"
+  end
+end
+
+describe "clean asserts" do
+
+  before do
+    @my_member = "my member"
+  end
+  
+  it "should provide clean assertion syntax" do
+    name = "Niclas Nilsson"
+    assert / "name != nil"
+  end
+
+  it "should support chained assertions to keep code terse" do
+    name = "Niclas Nilsson"
+    age = 38
+    assert / "name != nil" / "not name.empty?" / "age >= 21"
+  end
+
+  describe "that are satisfied" do
+    it "should work for instance variables" do
+      niclas = Person.new
+      niclas.age = 38
+      niclas.check_invariant
+    end 
+
+    it "should work for class variables" do
+      Binary.binary_states = 2
+      Binary.check_binary_states
+    end
+    
+  end
+  
+  describe "that are not satisfied" do
+    it "should work for instance variables" do
+      niclas = Person.new
+      niclas.age = -1
+      lambda { niclas.check_invariant }.should raise_error(RuntimeError, /Assertion '@age >= 0' not satisfied/)
+    end 
+
+    it "should work for class variables" do
+      Binary.binary_states = 3
+      lambda { Binary.check_binary_states }.should raise_error(RuntimeError, /Assertion '@@binary_states == 2' not satisfied in Binary#check_binary_states/)
+    end
+  end
+
+  it "should work for regular methods" do
+    load "spec/regular_methods.rb"
+  end
+end
+

data/spec/regular_methods.rb

@@ -0,0 +1,32 @@
+require 'clean_assert'
+
+def method_with_valid_assert
+  assert / "2 == 2"
+end
+
+def method_with_broken_assert
+  assert / "1 == 2"
+end
+
+def method_with_argument value
+  assert / "value == 2"
+end
+
+# Test valid assertions outside of classes and outside of rspec
+method_with_valid_assert
+method_with_argument 2
+
+# Test broken assertions outside of classes and outside of rspec
+
+begin
+  method_with_broken_assert
+rescue RuntimeError => e
+  raise if not e.message =~ /Assertion '1 == 2' not satisfied in main#method_with_broken_assert/
+end
+
+begin
+  method_with_argument 3
+rescue RuntimeError => e
+  raise if not e.message =~ /Assertion 'value == 2' not satisfied in main#method_with_argument/
+end
+

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: clean_assert
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Niclas Nilsson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: facets
+  requirement: &70159545782540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70159545782540
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70159545781940 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: *70159545781940
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70159545781500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70159545781500
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70159545780880 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70159545780880
+description: A Ruby gem to get really clean asserts
+email:
+- niclas@niclasnilsson.se
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- clean_assert.gemspec
+- lib/clean_assert.rb
+- lib/clean_assert/version.rb
+- spec/clean_assert_spec.rb
+- spec/regular_methods.rb
+homepage: https://github.com/niclasnilsson/clean_assert
+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.17
+signing_key: 
+specification_version: 3
+summary: A Ruby gem to get really clean asserts
+test_files:
+- spec/clean_assert_spec.rb
+- spec/regular_methods.rb
+has_rdoc: