niclasnilsson-clean-assert 0.5.0

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2009-04-29
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,12 @@
+History.txt
+Manifest.txt
+README.rdoc
+Rakefile
+clean-assert.gemspec
+lib/clean-assert.rb
+lib/clean-assert/clean-assert.rb
+script/console
+script/destroy
+script/generate
+spec/clean_assert_spec.rb
+spec/regular_methods.rb

data/README.rdoc

@@ -0,0 +1,50 @@
+= clean-assert
+
+* http://github.com/niclasnilsson/clean-assert/
+
+== DESCRIPTION:
+
+A Ruby library to get really clean asserts.
+
+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 in which method. No need for having first the actual assertion and
+a strained error message that you normally have to write. This is executable, Design by Contract style.
+
+== FEATURES/PROBLEMS:
+
+* No known problems.
+
+== INSTALL:
+
+* sudo gem install niclasnilsson-clean-assert
+
+(which is not working yet)
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Niclas Nilsson
+
+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/Rakefile

@@ -0,0 +1,28 @@
+%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/clean-assert'
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new('clean-assert', CleanAssert::VERSION) do |p|
+  p.developer('Niclas Nilsson', 'niclas@niclasnilsson.se')
+  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
+  p.rubyforge_name       = p.name # TODO this is default value
+  # p.extra_deps         = [
+  #   ['activesupport','>= 2.0.2'],
+  # ]
+  p.extra_dev_deps = [
+    ['newgem', ">= #{::Newgem::VERSION}"]
+  ]
+  
+  p.clean_globs |= %w[**/.DS_Store tmp *.log]
+  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
+  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
+  p.rsync_args = '-av --delete --ignore-errors'
+end
+
+require 'newgem/tasks' # load /tasks/*.rake
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# task :default => [:spec, :features]

data/clean-assert.gemspec

@@ -0,0 +1,44 @@
+Gem::Specification.new do |s|
+  s.name = %q{clean-assert}
+  s.version = "0.5.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Niclas Nilsson"]
+  s.date = %q{2009-04-29}
+  s.description = %q{A Ruby library to get really clean asserts.
+
+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 in which method. No need for having first the actual assertion and
+a strained error message that you normally have to write. This is executable, Design by Contract style.}
+  s.email = ["niclas@niclasnilsson.se"]
+  s.extra_rdoc_files = ["History.txt", "Manifest.txt", "README.rdoc"]
+  s.files = ["History.txt", "Manifest.txt", "README.rdoc", "Rakefile", "clean-assert.gemspec", "lib/clean-assert.rb", "lib/clean-assert/clean-assert.rb", "script/console", "script/destroy", "script/generate", "spec/clean_assert_spec.rb", "spec/regular_methods.rb"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/niclasnilsson/clean-assert/}
+  s.post_install_message = %q{PostInstall.txt}
+  s.rdoc_options = ["--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{clean-assert}
+  s.rubygems_version = %q{1.3.2}
+  s.summary = %q{A Ruby library to get really clean asserts}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<newgem>, [">= 1.3.0"])
+      s.add_development_dependency(%q<hoe>, [">= 1.8.0"])
+    else
+      s.add_dependency(%q<newgem>, [">= 1.3.0"])
+      s.add_dependency(%q<hoe>, [">= 1.8.0"])
+    end
+  else
+    s.add_dependency(%q<newgem>, [">= 1.3.0"])
+    s.add_dependency(%q<hoe>, [">= 1.8.0"])
+  end
+end

data/lib/clean-assert.rb

@@ -0,0 +1,8 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'clean-assert/clean-assert'
+
+module CleanAssert
+  VERSION = '0.5.0'
+end

data/lib/clean-assert/clean-assert.rb

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

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/clean-assert.rb'}"
+puts "Loading clean-assert gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/spec/clean_assert_spec.rb

@@ -0,0 +1,75 @@
+require "rubygems"
+require 'test/unit'
+require "spec"
+
+$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
+  
+  describe "that are satisfied" do
+    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
+
+    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
+    
+    it "should work for regular methods" do
+      load "spec/regular_methods.rb"
+    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
+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,87 @@
+--- !ruby/object:Gem::Specification 
+name: niclasnilsson-clean-assert
+version: !ruby/object:Gem::Version 
+  version: 0.5.0
+platform: ruby
+authors: 
+- Niclas Nilsson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-04-29 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: newgem
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.3.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.0
+    version: 
+description: "A Ruby library to get really clean asserts.  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 in which method. No need for having first the actual assertion and a strained error message that you normally have to write. This is executable, Design by Contract style."
+email: 
+- niclas@niclasnilsson.se
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- clean-assert.gemspec
+- lib/clean-assert.rb
+- lib/clean-assert/clean-assert.rb
+- script/console
+- script/destroy
+- script/generate
+- spec/clean_assert_spec.rb
+- spec/regular_methods.rb
+has_rdoc: true
+homepage: http://github.com/niclasnilsson/clean-assert/
+post_install_message: PostInstall.txt
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: clean-assert
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 3
+summary: A Ruby library to get really clean asserts
+test_files: []
+