unknown 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8a0d9af42a8cc29ebd2ee7c2d7c9bbe5e4ec87b6
+  data.tar.gz: db5fec80667071a7d564ed8d2ee7ecb0bfd12c30
+SHA512:
+  metadata.gz: fcba3d4796d3f42ece4c9d2feeb34fd5e92169a10495c73dddc49347a24e20f1d9ce473eaf96b5cb727f64a6f4f1b5523c86c7545be3d0c0b81bf276017d43d2
+  data.tar.gz: c5766b1e3b32ce524d220acb7aab25a4b0f8dce7a2d95e087c96a105d0706324fcdc520e1e7fd9bcbd929e223cb4b3dc527e648fc2fcda505cd30af8dcf6b773

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.1.2
+  - 2.2.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in unknown.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,18 @@
+# vim: set filetype=ruby
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+end

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Kevin Olbrich
+
+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,63 @@
+# Unknown
+
+Unknown is a class representing a Numeric that is unknown.  By using
+this class to represent unknown values instead of nil it is possible to
+avoid doing nil checks in your functions.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'unknown'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install unknown
+
+## Usage
+
+Before using Unknown
+
+    # nil checking of arguments
+    def population(a,k,t)
+      fail "a is missing" unless a
+      fail "k is missing" unless k
+      fail "t is missing" unless t
+      a*Math.exp(-k*t)
+    end
+
+    population(20, 30, nil) #=> Exception "t is missing"
+
+    #
+
+
+After using Unknown
+
+    require 'unknown'
+
+    def population(a=Unknown,k=Unknown,t=Unknown)
+      a*Math.exp(-k*t)
+    end
+
+    population(20,30,Unknown) # => Unknown
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/unknown/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+end
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "unknown"
+
+# 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

data/bin/setup

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

data/bmi.rb

@@ -0,0 +1,57 @@
+class Patient
+  attr_accessor :height
+  attr_accessor :weight
+  attr_accessor :name
+  def initialize(_name, _height, _weight)
+    @name = _name
+    @height = _height
+    @weight = _weight
+    # this might also raise an exception if height or weight were required
+    # fail ArgumentError, 'height is required' unless height
+  end
+
+  # Note the need for nil checks in the event that the height or weight is unknown
+  def bmi
+    return unless height && weight
+    ( weight.to_f / ( (height.to_f)**2 ) ) * 703.0
+  end
+
+  # Note the need for nil checks in the event that the height or weight is unknown
+  def bsa
+    return unless height && weight
+    Math.sqrt( height.to_f * weight.to_f / 3131.0 )
+  end
+end
+
+class PatientWithDefaults < Patient
+  def initialize(_name, _height = nil, _weight = nil)
+    @name = _name
+    @height = _height || 72
+    @weight = _weight || 200
+  end
+end
+
+# Presentation
+# nils in the initializers for unknown values.  A common convention, but
+# not as intention revealing as it could be
+patients = [
+  Patient.new('Bob', 72, 200),
+  Patient.new('Tom', 65, nil),
+  Patient.new('Sam', nil, 225),
+  Patient.new('Jim', nil, nil),
+  PatientWithDefaults.new('Terry')
+]
+
+# Note the need for nil checks here to handle cases where values are unknown
+puts
+puts "Name           Height (in)    Weight (lbs)   BMI            BSA"
+puts "==============================================================================="
+patients.each do |patient|
+  puts [
+    "#{patient.name}",
+    "#{patient.height || "Unknown" }",
+    "#{patient.weight || "Unknown" }",
+    "#{ patient.bmi ? sprintf('%0.2f',patient.bmi) : "Unknown" }",
+    "#{ patient.bsa ? sprintf('%0.2f',patient.bsa) : "Unknown" }"
+  ].map { |x| x.ljust(15) }.join
+end

data/bmi_unknown.rb

@@ -0,0 +1,57 @@
+require 'unknown'
+
+class Patient
+  attr_accessor :height
+  attr_accessor :weight
+  attr_accessor :name
+  def initialize(_name, _height = Unknown, _weight = Unknown)
+    @name = _name
+    # It's pretty obvious from these initializers when they are Unknown and when they aren't
+    @height = _height || Unknown
+    @weight = _weight || Unknown
+    # if height & weight are required then throw an exception
+    # fail ArgumentError, 'height is required' if _height.unknown?
+  end
+
+  # No nil checks for height and weight, just the relevant formula
+  def bmi
+    ( weight.to_f / ( (height.to_f)**2 ) ) * 703.0
+  end
+
+  # No nil checks for height and weight, just the relevant formula
+  def bsa
+    Math.sqrt( height.to_f * weight.to_f / 3131.0 )
+  end
+end
+
+class PatientWithDefaults < Patient
+  def initialize(_name, _height = Unknown, _weight = Unknown)
+    @name = _name
+    @height = _height.if_unknown? { 72 }
+    @weight = _weight.if_unknown? { 200 }
+  end
+end
+
+# Data
+patients = [
+  Patient.new('Bob', 72, 200),
+  Patient.new('Tom', 65, Unknown),
+  Patient.new('Sam', Unknown, 225),
+  Patient.new('Jim', Unknown, Unknown),
+  PatientWithDefaults.new('Terry')
+]
+
+# Presentation
+# Note that it is not necessary to do any nil checking in the output.
+puts
+puts "Name           Height (in)    Weight (lbs)   BMI            BSA"
+puts "==============================================================================="
+patients.each do |patient|
+  puts [
+    "#{patient.name}",
+    "#{patient.height}",
+    "#{patient.weight}",
+    "#{patient.bmi.if_known? {|x| sprintf('%0.2f', x)}}",
+    "#{patient.bsa.if_known? {|x| sprintf('%0.2f', x)}}"
+  ].map { |x| x.ljust(15) }.join
+end

data/lib/unknown.rb

@@ -0,0 +1,86 @@
+require "unknown/version"
+require 'unknown/extensions/numeric'
+require 'unknown/extensions/complex'
+require 'unknown/extensions/math'
+
+# A numeric class that encapsulates the idea of an unknown number.
+# Any math operation that includes an unknown is also Unknown
+# this allows complex math functions to run without throwing execptions
+# but the end result will be unknown if any of the values in the formula are also Unknown
+class UnknownClass < Numeric
+  def unknown?
+    true
+  end
+
+  def if_unknown?(value=nil, &block)
+    if block_given?
+      yield
+    else
+      value
+    end
+  end
+
+  def if_known?(&block)
+    self
+  end
+
+  def inspect(*_)
+    "Unknown"
+  end
+  alias_method :to_s, :inspect
+
+  def coerce(_)
+    [self, self]
+  end
+
+  def round(_=nil)
+    self
+  end
+
+  def divmod(_)
+    [self, self]
+  end
+
+  # arity 1
+  %w(* / + - ** fdiv modulo quo remainder).each do |meth|
+    define_method(meth.to_sym) do |_|
+      self
+    end
+  end
+
+  # arity 0
+  %w(
+    +@
+    -@
+    abs
+    abs2
+    angle
+    arg
+    ceil
+    conj
+    conjugate
+    denominator
+    floor
+    i
+    imag
+    imaginary
+    magnitude
+    numerator
+    phase
+    to_c
+    to_f
+    to_i
+    to_r
+    truncate
+  ).each do |meth|
+    define_method(meth.to_sym) do
+      self
+    end
+  end
+
+  def <=>(_)
+    nil
+  end
+end
+
+Unknown = ::UnknownClass.new

data/lib/unknown/extensions/complex.rb

@@ -0,0 +1,5 @@
+class Complex < Numeric
+  def unknown?
+    real.unknown? || imaginary.unknown?
+  end
+end

data/lib/unknown/extensions/math.rb

@@ -0,0 +1,49 @@
+module Math
+  # arity 1
+  %w(
+  acos
+  acosh
+  asin
+  asinh
+  atan
+  atanh
+  cbrt
+  cos
+  cosh
+  erf
+  erfc
+  exp
+  gamma
+  log
+  log2
+  sin
+  sinh
+  sqrt
+  tan
+  tanh
+  ).each do |original_method|
+    method_without_unknown = "#{original_method}_without_unknown".to_sym
+    alias_method(method_without_unknown, original_method.to_sym)
+    define_method(original_method.to_sym) do |arg|
+      return Unknown if arg.unknown?
+      send(method_without_unknown, arg)
+    end
+    module_function method_without_unknown
+    module_function original_method.to_sym
+  end
+
+  # arity 2
+  %w(
+  hypot
+  atan2
+  ).each do |original_method|
+    method_without_unknown = "#{original_method}_without_unknown".to_sym
+    alias_method method_without_unknown, original_method.to_sym
+    define_method(original_method.to_sym) do |arg1,arg2|
+      return Unknown if arg1.unknown? || arg2.unknown?
+      send(method_without_unknown, arg1, arg2)
+    end
+    module_function method_without_unknown
+    module_function original_method.to_sym
+  end
+end

data/lib/unknown/extensions/numeric.rb

@@ -0,0 +1,18 @@
+class Numeric
+  def unknown?
+    false
+  end
+
+  def known?
+    !unknown?
+  end
+
+  def if_unknown?
+    self
+  end
+
+  def if_known?(&block)
+    yield self
+  end
+
+end

data/lib/unknown/version.rb

@@ -0,0 +1,3 @@
+class UnknownClass < Numeric
+  VERSION = "0.1.0"
+end

data/unknown.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'unknown/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "unknown"
+  spec.version       = UnknownClass::VERSION
+  spec.authors       = ["Kevin Olbrich"]
+  spec.email         = ["kevin.olbrich@gmail.com"]
+
+  spec.summary       = %q{Handles doing math with unknown values}
+  spec.description   = %q{Handles doing math with unknown values so you can avoid doing nil checks on formulas}
+  spec.homepage      = "https://github.com/olbrich/unknown"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  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", "~> 10.0"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "codeclimate-test-reporter"
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: unknown
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kevin Olbrich
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-05-20 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: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  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: codeclimate-test-reporter
+  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: Handles doing math with unknown values so you can avoid doing nil checks
+  on formulas
+email:
+- kevin.olbrich@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bmi.rb
+- bmi_unknown.rb
+- lib/unknown.rb
+- lib/unknown/extensions/complex.rb
+- lib/unknown/extensions/math.rb
+- lib/unknown/extensions/numeric.rb
+- lib/unknown/version.rb
+- unknown.gemspec
+homepage: https://github.com/olbrich/unknown
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+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: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Handles doing math with unknown values
+test_files: []
+has_rdoc: