conditionz 0.0.7 → 0.0.8

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YzVmNzI1N2EyZmZhYTAwMWE5YzMxYzY3M2ZlMTIwZjhkMGI3ZDlkNQ==
+    Y2VlM2U1MzljNzAzMDQxYmUxZjY0Nzg0YWY5ZTc5ZGJiYzYxM2VhNQ==
   data.tar.gz: !binary |-
-    ZTM5YTFiZDlhMDYxNWFmZTkwNWYzODc3NTUyZjNkZDY5NzViMzU0Yg==
+    MzM2MzRlOTk1YmM4Mzg1NGE2ZTEzMTU3ZWQzNjE3Zjk4YzQzZGU1ZQ==
 SHA512:
   metadata.gz: !binary |-
-    NTdhNjJmYjNlODQ4MTlmNjkyMGY0ZjNiZDgwOTU0ODc1NDgxYzA3NmUwOWNk
-    YjY5NTI3YmUyNTJlZGNhMTQ0ZWNhMzllY2E5MjczNmY2ZjMzM2YwNjVkYzkx
-    Yjc3NTQyMzlhYTQ1MTQ0NGNmNzQ1NTc1MmE4NjNlM2E2Mzc4OWU=
+    MTk2MjRiZTUzMjEwZjA4ZjliY2I5NzBjMTQxOTUwN2RiZGFjYmYwZWVjMzgy
+    MjdkOWY5MGQ4ZmJlNGQ5YTg4MDJiNDZiOTA2MTBhNWE2Zjg0OTNiZjkzZDNi
+    MzJlMzVkNDRiZTQ2ODMwMzdhMTFlMmExOWJkY2VkOTk3ZTEwNmI=
   data.tar.gz: !binary |-
-    Y2YyNjAyNmViMWZkZmZiZTA4NTJjN2M5NTIxMWQ1NGI1MzEyOTE0ODAwYWE1
-    NjJlZDNmNDUxNmExODkzYjQ5ODlmMTIyMGZmYTRmNGIwMTQ0ODYwZTg4NWU5
-    ZGRjOTEwNWRhYjg4NzlhZmNmZTVjZWIzZjA4MmJiYTAyYTMyODg=
+    ZGFjMmU1Zjg3N2ExMjFhNDAyMmI4NTBjMGU4MTI3NmIyZDMwMDk2YmE2MjY0
+    ODFhNDBmZmI0N2Y4OTZkNDQyNDA0YjBhNzZiOTA1OTA0NTI3YzgzMjY3YmQ5
+    OWMwYTk5ODMyODI1MjJhODE0NTkyZmVmOTMxNDlhMTJmNDU1NjM=

data/.gitignore

@@ -0,0 +1,25 @@
+*.rbc
+capybara-*.html
+.rspec
+/log
+/tmp
+/db/*.sqlite3
+/public/system
+/coverage/
+/spec/tmp
+/pkg
+**.orig
+rerun.txt
+pickle-email-*.html
+config/initializers/secret_token.rb
+config/secrets.yml
+
+## Environment normalisation:
+/.bundle
+/vendor/bundle
+
+# these should all be checked in to normalise the environment:
+# Gemfile.lock, .ruby-version, .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile.lock

@@ -0,0 +1,24 @@
+PATH
+  remote: .
+  specs:
+    conditionz (0.0.7)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.4)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  conditionz!
+  rspec (~> 2.6)

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 yaniv preiss
+
+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,103 @@
+conditionz
+===================
+
+# Description
+
+Semantic Design-By-Contract pre-conditions and post-conditions.
+
+The purpose is to raise an error when a certain condition or more are not met.
+
+See
+
+http://en.wikipedia.org/wiki/Design_by_contract
+
+http://en.wikipedia.org/wiki/Precondition
+
+http://en.wikipedia.org/wiki/Postcondition
+
+
+# Installation
+
+Add to your Gemfile:
+
+```ruby
+gem 'conditionz'
+```
+
+Then run:
+
+```ruby
+bundle install
+```
+
+# Usage
+
+Suppose you have the following class:
+
+```ruby
+class MyTime
+  attr_accessor :hour, :minute
+
+  def initialize(new_hour, new_minute)
+    hour = new_hour
+    minute = new_minute
+  end
+end
+```
+
+Now you wish that initialize method parameters are within a certain range.
+Include the pre condition, and add the precondition
+
+```ruby
+include Conditionz
+
+class MyTime
+  attr_accessor :hour, :minute
+
+  def initialize(new_hour, new_minute)
+    Precondition.require 0 <= new_hour && new_hour <= 23, "Hour must be between 0 and 23"
+    Precondition.require 0 <= new_minute && new_minute <= 59, "Minute must be between 0 and 59"
+
+    hour = new_hour
+    minute = new_minute
+  end
+end
+```
+
+Notice the call to ```Precondition.require```, which receives a predicate (a boolean expression),
+and an optional message ```string``` or ```proc```.
+
+Here's an example with proc:
+```ruby
+Precondition.require 0 <= new_hour && new_hour <= 23, Proc.new { "Hour must be between 0 and 23 but got #{new_hour}" }
+```
+
+Analogously, you can ensure post conditions:
+(In this example, instead of ```include```, the fully qualified name is used
+
+```ruby
+class MyQueue
+  attr_accessor :size
+
+  def push(item)
+    # some implementation of pushing to queue...
+
+    Conditionz::PostCondition.ensure size > 0
+  end
+end
+```
+
+
+Not directly related, and preferably unit tested, but could be useful - assert a predicate
+
+```ruby
+def foo
+  first_result = first_calculation()
+  Assert.that first_result > 0, "result should have been positive"
+  second_result = sqrt first_result
+end
+```
+
+# License
+
+see MIT-LICENSE

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/conditionz.gemspec

@@ -0,0 +1,21 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'version'
+
+Gem::Specification.new do |s|
+  s.name        = 'conditionz'
+  s.version     = Conditionz::VERSION
+  s.date        = '2014-04-01'
+  s.summary     = "Semantic 'Design-By-Contract pre and post conditions'"
+  s.description = "Assert pre-conditions and post-conditions inside methods"
+  s.authors     = ["Yaniv Preiss"]
+  s.email       = 'yanivpr@gmail.com'
+  s.files       = `git ls-files`.split("\n")
+  s.test_files  = s.files.grep(%r{^(spec)/})
+  s.homepage    = 'https://github.com/yanivpr/conditionz'
+  s.license     = 'MIT'
+
+  s.add_development_dependency "rspec", "~> 2.6"
+  s.add_development_dependency "bundler", "~> 1.4"
+  s.add_development_dependency "rake"
+end

data/gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/lib/conditionz.rb

@@ -1,7 +1,11 @@
+require 'version'
 require 'conditionz/condition_base'
 require 'conditionz/pre_condition'
 require 'conditionz/post_condition'
 require 'conditionz/assert'
 require 'conditionz/pre_condition_not_met_error'
 require 'conditionz/post_condition_not_met_error'
-require 'conditionz/assertion_error'
+require 'conditionz/assertion_error'
+
+module Conditionz
+end

data/lib/conditionz/assert.rb

@@ -0,0 +1,25 @@
+require_relative 'condition_base'
+
+module Conditionz
+
+  # Raise assertion error when +predicate+ is false
+  class Assert
+
+    # Raise assertion error if predicate is false. Otherwise do nothing
+    #
+    # ==== Attributes
+    #
+    # * +predicate+ - a boolean expression to eval
+    # * +message+ - Error message to raise
+    #
+    # ==== Examples
+    #
+    # Assert.that age > 0, "Age should have been positive"
+    # Assert.that age > 0
+    #
+    def self.that predicate, message = 'Assertion failed'
+      ConditionBase.verify predicate, AssertionError, message
+    end
+
+  end
+end

data/lib/conditionz/assertion_error.rb

@@ -0,0 +1,13 @@
+require_relative 'condition_base'
+
+module Conditionz
+
+  # Raised when assertion failed
+  class AssertionError < StandardError
+    attr_reader :message
+    def initialize(message = '')
+      @message = message
+    end
+  end
+
+end

data/lib/conditionz/condition_base.rb

@@ -0,0 +1,31 @@
+require_relative 'pre_condition_not_met_error'
+require_relative 'post_condition_not_met_error'
+
+module Conditionz
+
+  # Raise error when +predicate+ is false
+  class ConditionBase
+
+    # Raise error if predicate is false. Otherwise do nothing
+    #
+    # ==== Attributes
+    #
+    # * +predicate+ - a boolean expression to eval
+    # * +error_class+ - Class of the error to raise
+    # * +message+ - Error message to raise
+    #
+    # ==== Examples
+    #
+    # ConditionBase.verify age > 0, Conditionz::PreCondition, "Age must be positive"
+    # ConditionBase.verify age > 0, Conditionz::PreCondition
+    #
+    def self.verify predicate, error_class, message = 'Condition not met'
+      return if predicate
+
+      error_message = message.is_a?(String) ? message : message.call
+      raise error_class, error_message
+    end
+
+  end
+
+end

data/lib/conditionz/post_condition.rb

@@ -0,0 +1,25 @@
+require_relative 'condition_base'
+
+module Conditionz
+
+  # Raise postcondition error when +predicate+ is false
+  class PostCondition
+
+    # Raise postcondition error if predicate is false. Otherwise do nothing
+    #
+    # ==== Attributes
+    #
+    # * +predicate+ - a boolean expression to eval
+    # * +message+ - Error message to raise
+    #
+    # ==== Examples
+    #
+    # PostCondition.ensure age > 0, "Age should have been positive"
+    # PostCondition.ensure age > 0
+    #
+    def self.ensure predicate, message = 'Postcondition not met'
+      ConditionBase.verify predicate, PostConditionNotMetError, message
+    end
+
+  end
+end

data/lib/conditionz/post_condition_not_met_error.rb

@@ -0,0 +1,13 @@
+require_relative 'condition_base'
+
+module Conditionz
+
+  # Raised when a postcondition is not met
+  class PostConditionNotMetError < StandardError
+    attr_reader :message
+    def initialize(message = '')
+      @message = message
+    end
+  end
+
+end

data/lib/conditionz/pre_condition.rb

@@ -0,0 +1,25 @@
+require_relative 'condition_base'
+
+module Conditionz
+
+  # Raise precondition error when +predicate+ is false
+  class PreCondition
+
+    # Raise precondition error if predicate is false. Otherwise do nothing
+    #
+    # ==== Attributes
+    #
+    # * +predicate+ - a boolean expression to eval
+    # * +message+ - Error message to raise
+    #
+    # ==== Examples
+    #
+    # PreCondition.require age > 0, "Age must be positive"
+    # PreCondition.require age > 0
+    #
+    def self.require predicate, message = 'Precondition not met'
+      ConditionBase.verify predicate, PreConditionNotMetError, message
+    end
+
+  end
+end

data/lib/conditionz/pre_condition_not_met_error.rb

@@ -0,0 +1,11 @@
+module Conditionz
+
+  # Raised when a precondition is not met
+  class PreConditionNotMetError < StandardError
+    attr_reader :message
+    def initialize(message = '')
+      @message = message
+    end
+  end
+
+end

data/lib/version.rb

@@ -0,0 +1,3 @@
+module Conditionz
+  VERSION = "0.0.8"
+end

data/spec/lib/assert_spec.rb

@@ -0,0 +1,22 @@
+require 'conditionz/assert'
+
+describe Conditionz::Assert do
+
+  let(:predicate) { true } #doesn't matter for these tests
+
+  it "should call the condition base with assert error and message" do
+    message = "some message"
+    Conditionz::ConditionBase.should_receive(:verify).
+        with(predicate, Conditionz::AssertionError, message)
+
+    Conditionz::Assert.that predicate, message
+  end
+
+  it "should call the condition base with assert error and message_proc" do
+    message_proc = Proc.new { "some message" }
+    Conditionz::ConditionBase.should_receive(:verify).
+        with(predicate, Conditionz::AssertionError, message_proc)
+
+    Conditionz::Assert.that predicate, message_proc
+  end
+end

data/spec/lib/assertion_error_spec.rb

@@ -0,0 +1,11 @@
+require 'conditionz/assertion_error'
+
+describe Conditionz::AssertionError do
+
+  it "should have correct message" do
+    message = "some message"
+    error = Conditionz::AssertionError.new(message)
+
+    error.message.should == message
+  end
+end

data/spec/lib/condition_base_spec.rb

@@ -0,0 +1,93 @@
+require 'conditionz/condition_base'
+
+describe Conditionz::ConditionBase do
+
+  context "predicate is true" do
+    let(:true_predicate) { true }
+
+    it "should not raise precondition error" do
+      message = "custom pre condition message"
+
+      expect {
+        Conditionz::ConditionBase.verify true_predicate,
+                                                Conditionz::PreConditionNotMetError,
+                                                message
+      }.not_to raise_error
+    end
+
+    it "should not raise postcondition error" do
+      message = "custom post condition message"
+
+      expect {
+        Conditionz::ConditionBase.verify true_predicate,
+                                                Conditionz::PostConditionNotMetError,
+                                                message
+      }.to_not raise_error
+    end
+  end
+
+  context "predicate is false" do
+    let(:false_predicate) { false }
+
+    context "precondition" do
+      it "should raise error with given message" do
+        message = "custom pre condition message"
+
+        expect {
+          Conditionz::ConditionBase.verify false_predicate,
+                                                  Conditionz::PreConditionNotMetError,
+                                                  message
+        }.to raise_error Conditionz::PreConditionNotMetError, message
+      end
+
+      it "should raise error with given message proc" do
+        message = "custom pre condition message"
+        message_proc = Proc.new { message }
+
+        expect {
+          Conditionz::ConditionBase.verify false_predicate,
+                                                  Conditionz::PreConditionNotMetError,
+                                                  message_proc
+        }.to raise_error Conditionz::PreConditionNotMetError, message
+      end
+
+      it "should raise error with default message" do
+        expect {
+          Conditionz::ConditionBase.verify false_predicate,
+                                                  Conditionz::PreConditionNotMetError
+        }.to raise_error Conditionz::PreConditionNotMetError, 'Condition not met'
+      end
+    end
+
+    context "postcondition" do
+      it "should raise error with given message" do
+        message = "custom post condition message"
+
+        expect {
+          Conditionz::ConditionBase.verify false_predicate,
+                                                  Conditionz::PostConditionNotMetError,
+                                                  message
+        }.to raise_error Conditionz::PostConditionNotMetError, message
+      end
+
+      it "should raise error with given message proc" do
+        message = "custom post condition message"
+        message_proc = Proc.new { message }
+
+        expect {
+          Conditionz::ConditionBase.verify false_predicate,
+                                                  Conditionz::PostConditionNotMetError,
+                                                  message_proc
+        }.to raise_error Conditionz::PostConditionNotMetError, message
+      end
+
+      it "should raise error with default message" do
+        expect {
+          Conditionz::ConditionBase.verify false_predicate,
+                                                  Conditionz::PostConditionNotMetError
+        }.to raise_error Conditionz::PostConditionNotMetError, 'Condition not met'
+      end
+    end
+
+  end
+end

data/spec/lib/post_condition_not_met_error_spec.rb

@@ -0,0 +1,11 @@
+require 'conditionz/post_condition_not_met_error'
+
+describe Conditionz::PostConditionNotMetError do
+
+  it "should have correct message" do
+    message = "some message"
+    error = Conditionz::PostConditionNotMetError.new(message)
+
+    error.message.should == message
+  end
+end

data/spec/lib/post_condition_spec.rb

@@ -0,0 +1,22 @@
+require 'conditionz/post_condition'
+
+describe Conditionz::PostCondition do
+
+  let(:predicate) { true } #doesn't matter for these tests
+
+  it "should call the condition base with pre condition error and message" do
+    message = "some message"
+    Conditionz::ConditionBase.should_receive(:verify).
+        with(predicate, Conditionz::PostConditionNotMetError, message)
+
+    Conditionz::PostCondition.ensure predicate, message
+  end
+
+  it "should call the condition base with pre condition error and message_proc" do
+    message_proc = Proc.new { "some message" }
+    Conditionz::ConditionBase.should_receive(:verify).
+        with(predicate, Conditionz::PostConditionNotMetError, message_proc)
+
+    Conditionz::PostCondition.ensure predicate, message_proc
+  end
+end

data/spec/lib/pre_condition_not_met_error_spec.rb

@@ -0,0 +1,11 @@
+require 'conditionz/pre_condition_not_met_error'
+
+describe Conditionz::PreConditionNotMetError do
+
+  it "should have correct message" do
+    message = "some message"
+    error = Conditionz::PreConditionNotMetError.new(message)
+
+    error.message.should == message
+  end
+end

data/spec/lib/pre_condition_spec.rb

@@ -0,0 +1,22 @@
+require 'conditionz/pre_condition'
+
+describe Conditionz::PreCondition do
+
+  let(:predicate) { true } #doesn't matter for these tests
+
+  it "should call the condition base with pre condition error and message" do
+    message = "some message"
+    Conditionz::ConditionBase.should_receive(:verify).
+        with(predicate, Conditionz::PreConditionNotMetError, message)
+
+    Conditionz::PreCondition.require predicate, message
+  end
+
+  it "should call the condition base with pre condition error and message_proc" do
+    message_proc = Proc.new { "some message" }
+    Conditionz::ConditionBase.should_receive(:verify).
+        with(predicate, Conditionz::PreConditionNotMetError, message_proc)
+
+    Conditionz::PreCondition.require predicate, message_proc
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: conditionz
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Yaniv Preiss
@@ -24,14 +24,64 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Assert pre-conditions and post-conditions inside methods
 email: yanivpr@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- conditionz.gemspec
+- gemfile
 - lib/conditionz.rb
-homepage: http://rubygems.org/gems/conditionz
+- lib/conditionz/assert.rb
+- lib/conditionz/assertion_error.rb
+- lib/conditionz/condition_base.rb
+- lib/conditionz/post_condition.rb
+- lib/conditionz/post_condition_not_met_error.rb
+- lib/conditionz/pre_condition.rb
+- lib/conditionz/pre_condition_not_met_error.rb
+- lib/version.rb
+- spec/lib/assert_spec.rb
+- spec/lib/assertion_error_spec.rb
+- spec/lib/condition_base_spec.rb
+- spec/lib/post_condition_not_met_error_spec.rb
+- spec/lib/post_condition_spec.rb
+- spec/lib/pre_condition_not_met_error_spec.rb
+- spec/lib/pre_condition_spec.rb
+homepage: https://github.com/yanivpr/conditionz
 licenses:
 - MIT
 metadata: {}
@@ -55,4 +105,11 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Semantic 'Design-By-Contract pre and post conditions'
-test_files: []
+test_files:
+- spec/lib/assert_spec.rb
+- spec/lib/assertion_error_spec.rb
+- spec/lib/condition_base_spec.rb
+- spec/lib/post_condition_not_met_error_spec.rb
+- spec/lib/post_condition_spec.rb
+- spec/lib/pre_condition_not_met_error_spec.rb
+- spec/lib/pre_condition_spec.rb