exact_zero 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 636566ccfbb22ab1fde1f1b0324bfbe39687f581687ff40e28bc21f81f93e6ea
+  data.tar.gz: 0ae2acf8e6e217a87c1535bbeae6873c90f39742ae4fab95133ee5b4ee7b1576
+SHA512:
+  metadata.gz: 77b753f8c0825c6d313454fde898da643f4b71977a56264baa5a0a10471971c6709ccaeacb5bfb1bf1203eb412784968dfcf758ecdbb7da277b519d0a65897b4
+  data.tar.gz: 002f6b7efc28e40ad284c73be0ea2feb0f64987b9eec8fd9a246bddb5eb5e56ab67b7cc0a423359dfa372dba875bc04adb42dbf4486dc53583a0cfc038c3b90d

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.0
+before_install: gem install bundler -v 1.17.2

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in exact_zero.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Masahiro Nomoto
+
+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,96 @@
+# ExactZero
+
+This gem provides `Numeric#exact_zero?`, which determine the occurrence of zero division error in advance.
+
+There are some ideas of the judgement in the article https://qiita.com/HMMNRST/items/6cf7e7cc853e5d627a72. (Japanese)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'exact_zero'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install exact_zero
+
+## Usage
+
+```ruby
+require 'exact_zero'
+
+Integer("0")   .exact_zero?   #=> true
+Rational("0")  .exact_zero?   #=> true
+Float("0")     .exact_zero?   #=> false
+Complex("0")   .exact_zero?   #=> true
+Complex("0.0i").exact_zero?   #=> false
+
+require 'bigdecimal'
+BigDecimal("0").exact_zero?   #=> false
+```
+
+### Example 1: avoid ZeroDivisionError
+
+```ruby
+require 'exact_zero'
+
+class Numeric
+	def reciprocal
+		1.quo(self)
+	end
+
+	def reciprocal_safe
+		exact_zero? ? nil : reciprocal
+	end
+end
+
+num1 = 0.0
+num1.reciprocal        #=> Infinity
+num1.reciprocal_safe   #=> Infinity
+
+num2 = Complex(0, 0/1r)
+num2.reciprocal        #=> ZeroDivisionError: divided by 0
+num2.reciprocal_safe   #=> nil
+```
+
+### Example 2: Complex to Real
+
+```ruby
+require 'exact_zero'
+
+class Complex
+	%w(to_f to_r to_i).each do |name|
+		define_method("try_#{name}") do
+			imag.exact_zero? ? send(name) : nil
+		end
+	end
+end
+
+num1 = Complex("3+0/1i")
+num1.to_f       #=> 3.0
+num1.try_to_f   #=> 3.0
+
+num2 = Complex("3+0.0i")
+num2.to_f       #=> RangeError: can't convert 3+0.0i into Float
+num2.try_to_f   #=> nil
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hmmnrst/exact_zero.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "exact_zero"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exact_zero.gemspec

@@ -0,0 +1,27 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+	spec.name          = "exact_zero"
+	spec.version       = "0.0.1"
+	spec.authors       = ["Masahiro Nomoto"]
+	spec.email         = ["hmmnrst@users.noreply.github.com"]
+
+	spec.summary       = %q{Provides `Numeric#exact_zero?` to avoid ZeroDivisionError}
+	spec.homepage      = "https://github.com/hmmnrst/exact_zero"
+	spec.license       = "MIT"
+
+	# Specify which files should be added to the gem when it is released.
+	# The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+	spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+		`git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+	end
+	spec.bindir        = "exe"
+	spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+	spec.require_paths = ["lib"]
+
+	spec.add_development_dependency "bundler"
+	spec.add_development_dependency "rake"
+	spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/exact_zero.rb

@@ -0,0 +1,12 @@
+class Numeric
+	##
+	# Returns true when +self+ is exactly zero.
+	#
+	# @example
+	#   (0/1r).exact_zero?   #=> true
+	#   (-0.0).exact_zero?   #=> false
+	#
+	def exact_zero?
+		zero? && 1.0 / (-abs2).to_f > 0
+	end
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: exact_zero
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Masahiro Nomoto
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-01-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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'
+- !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'
+- !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: 
+email:
+- hmmnrst@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exact_zero.gemspec
+- lib/exact_zero.rb
+homepage: https://github.com/hmmnrst/exact_zero
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: Provides `Numeric#exact_zero?` to avoid ZeroDivisionError
+test_files: []