inexact_equality_warning 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ae03455fe61747ac2eb8451499e8f16f416e11dd
+  data.tar.gz: 63bceb16e59cbd174328bbed7e065f7feff02e01
+SHA512:
+  metadata.gz: 4a7921d82180fb2d5487e68ea37233dfa31ca5748b4403e18ae8795dfd0d3d9efdf600ffaa3688c4bf473416c018ff52e800faebf7250584b5863871fe354d24
+  data.tar.gz: 48e48d662db050e4b3ae8fef947d1aa4382c3d0a5a8979887d552b67df5cc851808e9e25d2e9a31c1ba38b931043a2ea3c65a50716375b5cc68926ece01e2796

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+cache: bundler
+rvm:
+  - 2.0.0
+  - 2.1
+  - 2.2
+  - ruby-head
+script:
+  - bundle exec rspec
+matrix:
+  allow_failures:
+    - rvm: ruby-head

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+(MIT License)
+
+Copyright (c) 2015 Adam Prescott
+
+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,6 @@
+```ruby
+x = 1.0 - 0.9 - 0.1
+x == 0.0
+# WARNING: Testing for equality between inexact floats is ill-advised, when comparing -2.7755575615628914e-17 and 0 (/path/to/file.rb:123)
+# => false
+```

data/inexact_equality_warning.gemspec

@@ -0,0 +1,18 @@
+Gem::Specification.new do |gem|
+  gem.name          = "inexact_equality_warning"
+  gem.version       = "0.0.1"
+  gem.authors       = ["Adam Prescott"]
+  gem.email         = ["adam@aprescott.com"]
+  gem.description   = "Warn when comparing floats for equality."
+  gem.summary       = "You do not want to compare floating point numbers for equality."
+  gem.homepage      = "https://github.com/aprescott/ruby-inexact_equality_warning"
+
+  gem.files         = Dir["{lib/**/*,spec/**/*,*.gemspec}"] + %w[.rspec .travis.yml LICENSE Gemfile README.md]
+  gem.test_files    = Dir["spec/*"]
+  gem.require_path  = "lib"
+  gem.licenses      = ["MIT"]
+
+  gem.required_ruby_version = ">= 2.0.0"
+
+  gem.add_development_dependency("rspec", ">= 3.0")
+end

data/lib/inexact_equality_warning.rb

@@ -0,0 +1,10 @@
+# it would be good to use #inexact? here -- https://bugs.ruby-lang.org/issues/5321
+module EqualityWarning
+  def ==(other)
+    warn "WARNING: Testing for equality between inexact floats is ill-advised, when comparing #{self} and #{other} (#{caller.first})" if self.is_a?(Float) || other.is_a?(Float)
+    super
+  end
+end
+
+# classes that are leaf nodes of all subclasses of Numeric
+[Fixnum, Float, Bignum, Rational, Complex].each { |klass| klass.prepend(EqualityWarning) }

data/spec/inexact_equality_warning_spec.rb

@@ -0,0 +1,52 @@
+def capturing_stderr(&block)
+  original_stderr = $stderr
+  $stderr = output_capturer = StringIO.new
+  begin
+    yield
+  ensure
+    $stderr = original_stderr
+  end
+  output_capturer.string
+end
+
+RSpec.describe EqualityWarning do
+  def expect_warning(x, y)
+    expect(capturing_stderr { x == y }).to include("WARNING: Testing for equality between inexact floats is ill-advised, when comparing #{x} and #{y} (#{__FILE__}:#{__LINE__}:in `block in #{__method__}'")
+  end
+
+  def expect_no_warning(x, y)
+    expect(capturing_stderr { x == y }).to_not include("WARNING")
+  end
+
+  [
+    1.0, 1.0,
+    1.0, 1.0,
+    1.0, 1,
+    1, 1.0,
+    1.0, Complex(1, 0),
+    1.0, Complex(0, 2),
+    1.0, 2**1000, # Bignum
+  ].each_slice(2) do |x, y|
+    specify { expect_warning(x, y) }
+  end
+
+  [
+    "anything", 1.0,
+    1, 1,
+    Complex(1, 0), Complex(0, 2),
+    "anything", "anything",
+    2**1000, 2**1000, # Bignum
+  ].each_slice(2) do |x, y|
+    specify { expect_no_warning(x, y) }
+  end
+
+  it "is included on all Numeric leaf subclasses" do
+    constants = Object.constants.map { |sym| Object.const_get(sym) }
+    prepended_classes = constants.select { |klass| klass.is_a?(Class) && klass.ancestors.include?(EqualityWarning) }
+    numeric_classes = constants.select { |klass| klass.is_a?(Class) && klass < Numeric }
+
+    expect(prepended_classes).to eq([Fixnum, Float, Bignum, Rational, Complex])
+    # compact all `numeric_classes` by removing any that are subclasses of another class in `numeric_classes`
+    expect(numeric_classes.reject { |klass| numeric_classes.any? { |other_class| other_class < klass } }).to eq(prepended_classes)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,76 @@
+require "bundler/setup"
+require "inexact_equality_warning"
+
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+
+    expectations.syntax = :expect
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+
+    mocks.syntax = :expect
+  end
+
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    # config.default_formatter = "doc"
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  # config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: inexact_equality_warning
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Adam Prescott
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Warn when comparing floats for equality.
+email:
+- adam@aprescott.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- inexact_equality_warning.gemspec
+- lib/inexact_equality_warning.rb
+- spec/inexact_equality_warning_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/aprescott/ruby-inexact_equality_warning
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: You do not want to compare floating point numbers for equality.
+test_files:
+- spec/inexact_equality_warning_spec.rb
+- spec/spec_helper.rb