approximately 1.0.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,7 @@
+source "http://rubygems.org"
+
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.8.3"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Julik
+
+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,44 @@
+= approximately
+
+Facilitates comparisons of Floats, primarily in mocking. Some mocking libraries will not allow you to put
+delta assertions within the expectations of your method calls. For example:
+
+   some_animated_point = mock()
+   mock.should_receive(:move_to).with(0.01456, -234.786)
+   
+Then you feed this mock from the outside, using some iterative algorithm with arbitrary precision, and your
+assertion fails.
+
+   Expectation not matched: called "move_to" with (0.01455999, -234.78576)
+
+This comes because what you should have done is comparing within a delta/epsilon value instead of comparing verbatim.
+
+And this is what most mocking libraries will do.
+
+Some mocking libraries allow you to stuff an "assert_in_delta" call into the block of the expectation setup, but not
+all of them - and the expectation block might not be called at all if the passed arguments do not match. So what
+we can do instead is create a special object that will be equal to another Float object when they both are in delta
+of one another. So instead you would do this (in your unit/spec framework du jour)
+  
+  include Approximately
+  
+  some_animated_point = mock()
+  mock.should_receive(:move_to).with(approx(0.01456, 0.001), approx(-234.786, 0.001))
+
+These objects will compare properly with your reference inputs.
+
+== Contributing to approximately
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2012 Julik. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,37 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+require File.dirname(__FILE__) + '/lib/approximately'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.version = Approximately::VERSION
+  gem.name = "approximately"
+  gem.homepage = "http://github.com/julik/approximately"
+  gem.license = "MIT"
+  gem.summary = %Q{Facilitates float comparisons in mocks}
+  gem.email = "me@julik.nl"
+  gem.authors = ["Julik"]
+  # dependencies defined in Gemfile
+end
+
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test

data/approximately.gemspec

@@ -0,0 +1,53 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "approximately"
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Julik"]
+  s.date = "2012-05-07"
+  s.email = "me@julik.nl"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "approximately.gemspec",
+    "lib/approximately.rb",
+    "test/helper.rb",
+    "test/test_approximately.rb"
+  ]
+  s.homepage = "http://github.com/julik/approximately"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.15"
+  s.summary = "Facilitates float comparisons in mocks"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.3"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+  end
+end
+

data/lib/approximately.rb

@@ -0,0 +1,32 @@
+module Approximately
+  VERSION = "1.0.0"
+  DEFAULT_DELTA = 0.01
+  
+  # This object can be used for float comparisons. When
+  # compared to another Float (or an object that responds to to_f)
+  # it will be equal to that object if the float value of the ApproximateFloat
+  # and the value being compared to are within a passed delta
+  class DeltaFloat
+    include Comparable
+    attr_accessor :float, :delta
+    alias_method :to_f, :float
+    
+    def initialize(float_value, delta)
+      @float, @delta = float_value.to_f, delta
+    end
+    
+    def to_f
+      @float
+    end
+    
+    def <=>(another)
+      d = (@float - another.to_f).abs
+      return 0 if d < delta
+      float <=> another.to_f
+    end
+  end
+  
+  def approx(float, delta = DEFAULT_DELTA)
+    DeltaFloat.new(float, delta)
+  end
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'approximately'
+
+class Test::Unit::TestCase
+end

data/test/test_approximately.rb

@@ -0,0 +1,25 @@
+require 'helper'
+
+class TestApproximately < Test::Unit::TestCase
+  include Approximately
+  
+  should "return an approximate object" do
+    obj = approx(10)
+    assert_kind_of Approximately::DeltaFloat, obj
+    assert_kind_of Float, obj.float, "Should have stored a float in the attribute"
+    assert_equal obj.float, obj.to_f
+    assert_in_delta 10.0, obj.float, 0.01
+  end
+  
+  should "compare to another float within delta" do
+    d = 0.1
+    assert_equal approx(1, d), approx(1, d), "Should be equal within delta"
+    assert_equal approx(1, d), approx(0.95, d), "Should be equal within delta"
+    assert_not_equal approx(1, d), approx(1.11, d), "Should not be equal outside delta"
+  end
+  
+  should "create the object with default delta" do
+    a = approx(0.013)
+    assert_equal a.delta, Approximately::DEFAULT_DELTA
+  end
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: approximately
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Julik
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: &9144310 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *9144310
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &9143030 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *9143030
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &9141960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+  type: :development
+  prerelease: false
+  version_requirements: *9141960
+description: 
+email: me@julik.nl
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- approximately.gemspec
+- lib/approximately.rb
+- test/helper.rb
+- test/test_approximately.rb
+homepage: http://github.com/julik/approximately
+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'
+      segments:
+      - 0
+      hash: -499016081
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Facilitates float comparisons in mocks
+test_files: []