matholroyd-dbc 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Mat Holroyd
+
+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.rdoc

@@ -0,0 +1,22 @@
+= dbc
+
+Design By Contract implemented for Ruby.  
+
+== Philosophy
+
+DBC, among other things, is a staple of the design concept, "Fail early, fail hard."  That is, it is better to catch problems earlier on rather than later.  DBC does this by specifying input/output requirements of code, typically functions.  When these constraints are broken, the DBC library causes a hard-fail of the system.
+
+A classic example of DBC in actions would be to checking the divisor in a division is non-zero. This would be written as 
+
+  def division(a, b)
+    DBC.require(b != 0, "Divisor must be non-zero")  
+    
+    a / b
+  end
+ 
+
+See http://en.wikipedia.org/wiki/Design_by_contract for more details.
+
+== Copyright
+
+Copyright (c) 2009 Mat Holroyd. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,48 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "dbc"
+    gem.summary = %Q{TODO}
+    gem.email = "matholroyd@gmail.com"
+    gem.homepage = "http://github.com/matholroyd/dbc"
+    gem.authors = ["Mat Holroyd"]
+
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "dbc #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:patch: 0
+:major: 0
+:minor: 1

data/lib/dbc.rb

@@ -0,0 +1,35 @@
+class DBC 
+  def self.require(condition, message = "")
+    unless condition
+      error('Pre', message, caller)
+    end
+  end
+
+  def self.require_not_blank(string, message = "")
+    if string.strip.blank?
+      error('Pre', message, caller)
+    end
+  end
+
+  def self.assert(condition, message = "")
+    unless condition
+      error('Assert', message, caller)
+    end
+  end
+
+  def self.ensure(condition, message = "")
+    unless condition
+      error('Post', message, caller)
+    end
+  end
+  
+  def self.fail(message = "")
+    error('Fail', message, caller)
+  end
+  
+  private 
+  
+  def self.error(type, message, caller)
+    raise RuntimeError.new("#{type}-condition failed: #{message}\nTrace was: #{caller.join("\n")}")
+  end
+end

data/spec/dbc_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe "Dbc" do
+  it "fails" do
+    fail "hey buddy, you should probably rename this file and start specing for real"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'spec'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'dbc'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification 
+name: matholroyd-dbc
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Mat Holroyd
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-04-13 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: matholroyd@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION.yml
+- lib/dbc.rb
+- spec/dbc_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/matholroyd/dbc
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: TODO
+test_files: 
+- spec/dbc_spec.rb
+- spec/spec_helper.rb