assure 0.1.1

data/.gitignore

@@ -0,0 +1,4 @@
+*~
+*.gem
+pkg
+.kdev4

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2010-2013 Pluron, Inc.
+
+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,20 @@
+assure
+======
+Provides two methods: internal_error and assure
+
+
+internal_error
+--------------
+Raises internal error with a given message.
+
+
+assure
+------
+Raises internal error when expression evaluates to nil or false.
+Use this to check various preconditions, for example:
+
+    def do_smth(x)
+        assure(x.is_a? String)
+    end
+
+You can provide optional message to be printed in the exception output.

data/Rakefile

@@ -0,0 +1,25 @@
+require 'rake'
+require 'rake/testtask'
+require 'rdoc/task'
+require 'bundler'
+
+Bundler::GemHelper.install_tasks
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test assure.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for assure.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'assure'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/assure.gemspec

@@ -0,0 +1,18 @@
+require 'rubygems'
+
+SPEC = Gem::Specification.new do |s|
+    s.name        = "assure"
+    s.version     = "0.1.1"
+    s.author      = "Pluron, Inc."
+    s.email       = "support@pluron.com"
+    s.homepage    = "http://github.com/acunote/assure"
+    s.platform    = Gem::Platform::RUBY
+    s.description = "Adds assure and internal_error methods"
+    s.summary     = "Raises internal error when expression evaluates to nil or false."
+
+    s.files         = `git ls-files`.split("\n")
+    s.test_files    = `git ls-files -- test/*`.split("\n")
+
+    s.require_path  = "lib"
+    s.has_rdoc      = true
+end

data/init.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__) + "/lib")
+require 'assure'

data/lib/assure.rb

@@ -0,0 +1,44 @@
+# Copyright (c) 2010-2013 Pluron, Inc.
+
+#Use this to raise internal error with a given message.
+#This works for all modes - production, development, etc.
+def internal_error(message = 'internal error')
+    raise message
+end
+
+#Raises internal error when expression evaluates to nil or false
+#Use this to check various preconditions, for example
+# def do_smth(x)
+#   assure(x.is_a? String)
+# end
+#You can provide optional message to be printed in the exception output.
+def assure(expression, message = nil)
+    return if expression
+    file, method, line = get_caller_location_for_assure
+
+    #Try to find expression in assert
+    expression = File.readlines(file)[line.to_i-1].
+        gsub(/^.*assure\s*\(\s*/, '').gsub(/\s*\)\s*$/, '')
+
+    #cleanup path - remove rails root and "./"
+    if defined? Rails
+        file = file.gsub(Rails.root.to_s+'/', '')
+    else
+        file = file.gsub(Dir.pwd, '')
+    end
+    file = file.gsub(/^\.\//, '') 
+    raise internal_error("#{file}:#{line}: #{method}: Assertion \"#{expression}\" failed#{message ? "\n#{message}" : ""}")
+end
+
+def get_caller_location_for_assure(options = {:depth => 2})
+    caller_method = caller(options[:depth])[0]
+
+    #Sample output is:
+    #   test/unit/assure_test.rb:9:in `test_assure
+    #When working dir isn't set, the RAILS_ROOT will be prepended to the path
+    caller_method =~ /([^:]+):([0-9]+):in `(.+)'/
+    file = $1
+    line = $2
+    method = $3
+    [file, method, line]
+end

data/test/assure_test.rb

@@ -0,0 +1,33 @@
+# Copyright (c) 2011 Pluron, Inc.
+
+require 'test/unit'
+require 'assure'
+
+class AssureTest < Test::Unit::TestCase
+
+    def test_basic
+        assure("Test".is_a? String)
+
+        exception = assert_raise(RuntimeError) do
+            assure(false)
+        end
+        assert_equal 'test/assure_test.rb:12: test_basic: Assertion "false" failed', exception.message
+
+        exception = assert_raise(RuntimeError) do
+            assure(nil)
+        end
+        assert_equal 'test/assure_test.rb:17: test_basic: Assertion "nil" failed', exception.message
+
+        exception = assert_raise(RuntimeError) do
+            x = 2
+            assure( x == 3, "#{x} == 2" )
+        end
+        assert_equal "test/assure_test.rb:23: test_basic: Assertion \"x == 3, \"\#{x} == 2\"\" failed\n2 == 2", exception.message
+
+        exception = assert_raise(RuntimeError) do
+            assure(1.is_a? String)
+        end
+        assert_equal 'test/assure_test.rb:28: test_basic: Assertion "1.is_a? String" failed', exception.message
+    end
+
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: assure
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+  prerelease: 
+platform: ruby
+authors:
+- Pluron, Inc.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-19 00:00:00.000000000 Z
+dependencies: []
+description: Adds assure and internal_error methods
+email: support@pluron.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- LICENSE
+- README.md
+- Rakefile
+- assure.gemspec
+- init.rb
+- lib/assure.rb
+- test/assure_test.rb
+homepage: http://github.com/acunote/assure
+licenses: []
+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: Raises internal error when expression evaluates to nil or false.
+test_files:
+- test/assure_test.rb
+has_rdoc: true