unitwise-193 1.0.4

data/test/test_helper.rb

@@ -0,0 +1,19 @@
+if RUBY_VERSION > '1.8.7'
+  require 'coveralls'
+  Coveralls.wear!
+end
+
+require 'minitest/autorun'
+require 'minitest/pride'
+
+require 'unitwise'
+
+module Minitest::Assertions
+  def assert_almost_equal(expected, actual)
+    message = "Expected #{actual} to be almost equal to #{expected}"
+    range   = 0.00001
+    assert expected + range > actual && expected - range < actual, message
+  end
+end
+
+Numeric.infect_an_assertion :assert_almost_equal, :must_almost_equal

data/test/unitwise/atom_test.rb

@@ -0,0 +1,129 @@
+require 'test_helper'
+
+describe Unitwise::Atom do
+  subject { Unitwise::Atom }
+  describe "::data" do
+    it "must have data" do
+      subject.data.must_be_instance_of Array
+      subject.data.count.must_be :>, 0
+    end
+  end
+
+  describe "::all" do
+    it "must be an Array of instances" do
+      subject.all.must_be_instance_of Array
+      subject.all.first.must_be_instance_of Unitwise::Atom
+    end
+  end
+
+  describe "::find" do
+    it "must find atoms" do
+      subject.find("m").must_be_instance_of Unitwise::Atom
+      subject.find("V").must_be_instance_of Unitwise::Atom
+    end
+  end
+
+  let(:second)  { Unitwise::Atom.find("s") }
+  let(:yard)    { Unitwise::Atom.find("[yd_i]")}
+  let(:pi)      { Unitwise::Atom.find("[pi]")}
+  let(:celsius) { Unitwise::Atom.find("Cel")}
+  let(:pfu)     { Unitwise::Atom.find("[PFU]")}
+  let(:joule)   { Unitwise::Atom.find("J")}
+  describe "#scale" do
+    it "must be nil for base atoms" do
+      second.scale.must_equal nil
+    end
+    it "sould be a Scale object for derived atoms" do
+      yard.scale.must_be_instance_of Unitwise::Scale
+    end
+    it "must be a FunctionalScale object for special atoms" do
+      celsius.scale.must_be_instance_of Unitwise::Functional
+    end
+  end
+
+  describe "#base?" do
+    it "must be true for base atoms" do
+      second.base?.must_equal true
+    end
+    it "must be false for derived atoms" do
+      yard.base?.must_equal false
+      pi.base?.must_equal false
+    end
+  end
+
+  describe "#derived?" do
+    it "must be false for base atoms" do
+      second.derived?.must_equal false
+    end
+    it "must be true for derived atoms" do
+      yard.derived?.must_equal true
+      celsius.derived?.must_equal true
+    end
+  end
+
+  describe "#metric?" do
+    it "must be true for base atoms" do
+      second.metric?.must_equal true
+    end
+    it "must be false for english atoms" do
+      yard.metric?.must_equal false
+    end
+  end
+
+  describe "#special?" do
+    it "must be true for special atoms" do
+      celsius.special?.must_equal true
+    end
+    it "must be false for non-special atoms" do
+      second.special?.must_equal false
+    end
+  end
+
+  describe "#arbitrary?" do
+    it "must be true for arbitrary atoms" do
+      pfu.arbitrary?.must_equal true
+    end
+    it "must be false for non-arbitrary atoms" do
+      yard.arbitrary?.must_equal false
+      celsius.arbitrary?.must_equal false
+    end
+  end
+
+  describe "#terminal?" do
+    it "must be true for atoms without a valid measurement atom" do
+      second.terminal?.must_equal true
+      pi.terminal?.must_equal true
+    end
+    it "must be false for child atoms" do
+      yard.terminal?.must_equal false
+    end
+  end
+
+  describe "#scalar" do
+    it "must return scalar relative to terminal atom" do
+      second.scalar.must_equal 1
+      yard.scalar.must_almost_equal 0.9144
+      pi.scalar.must_almost_equal 3.141592653589793
+    end
+  end
+
+  describe "#dim" do
+    it "must return the dim" do
+      second.dim.must_equal 'T'
+      yard.dim.must_equal 'L'
+      joule.dim.must_equal 'L2.M.T-2'
+    end
+  end
+
+  describe "#measurement=" do
+    it "must create a new measurement object and set attributes" do
+      skip("need to figure out mocking and stubbing with minitest")
+    end
+  end
+
+  describe "#frozen?" do
+    it "should be frozen" do
+      second.frozen?.must_equal true
+    end
+  end
+end

data/test/unitwise/base_test.rb

@@ -0,0 +1,6 @@
+require 'test_helper'
+
+describe Unitwise::Base do
+
+
+end

data/test/unitwise/expression/decomposer_test.rb

@@ -0,0 +1,45 @@
+require 'test_helper'
+
+describe Unitwise::Expression::Decomposer do
+  subject { Unitwise::Expression::Decomposer }
+
+  describe "#terms" do
+    it "should accept codes" do
+      fts = subject.new("[ft_i]/s").terms
+      fts.count.must_equal 2
+    end
+    it "should accept names" do
+      kms = subject.new("kilometer/second").terms
+      kms.count.must_equal 2
+    end
+    it "should accept spaced names" do
+      ncg = subject.new("Newtonian constant of gravitation").terms
+      ncg.count.must_equal 1
+    end
+    it "should accept parameterized names" do
+      pc = subject.new("planck_constant").terms
+      pc.count.must_equal 1
+    end
+    it "should accept symbols" do
+      saff = subject.new("<i>g<sub>n</sub></i>").terms
+      saff.count.must_equal 1
+    end
+    it "should accept complex units" do
+      complex = subject.new("(mg.(km/s)3/J)2.Pa").terms
+      complex.count.must_equal 5
+    end
+    it "should accept more complex units" do
+      complex = subject.new("4.1(mm/2s3)4.7.3J-2").terms
+      complex.count.must_equal 3
+    end
+    it "should accept weird units" do
+      frequency = subject.new("/s").terms
+      frequency.count.must_equal 1
+    end
+    it "should accept units with a factor and unit" do
+      oddity = subject.new("2ms2").terms
+      oddity.count.must_equal 1
+    end
+  end
+
+end

data/test/unitwise/expression/matcher_test.rb

@@ -0,0 +1,42 @@
+require 'test_helper'
+
+describe Unitwise::Expression::Matcher do
+  describe "::atom(:codes)" do
+    subject { Unitwise::Expression::Matcher.atom(:primary_code)}
+    it "must be an Alternative list" do
+      subject.must_be_instance_of Parslet::Atoms::Alternative
+    end
+    it "must parse [in_i]" do
+      subject.parse("[in_i]").must_equal("[in_i]")
+    end
+  end
+  describe "::metric_atom(:names)" do
+    subject { Unitwise::Expression::Matcher.metric_atom(:names)}
+    it "must be an Alternative list of names" do
+      subject.must_be_instance_of Parslet::Atoms::Alternative
+    end
+    it "must parse 'Joule'" do
+      subject.parse('Joule').must_equal('Joule')
+    end
+  end
+
+  describe "::atom(:slugs)" do
+    subject { Unitwise::Expression::Matcher.atom(:slugs)}
+    it "must be an Alternative list of slugs" do
+      subject.must_be_instance_of Parslet::Atoms::Alternative
+    end
+    it "must match 'georgian_year'" do
+      subject.parse("mean_gregorian_year").must_equal("mean_gregorian_year")
+    end
+  end
+
+  describe "::prefix(:symbol)" do
+    subject { Unitwise::Expression::Matcher.prefix(:symbol)}
+    it "must be an Alternative list of symbols" do
+      subject.must_be_instance_of Parslet::Atoms::Alternative
+    end
+    it "must parse 'h'" do
+      subject.parse('h').must_equal('h')
+    end
+  end
+end

data/test/unitwise/expression/parser_test.rb

@@ -0,0 +1,109 @@
+require 'test_helper'
+
+describe Unitwise::Expression::Parser do
+  subject { Unitwise::Expression::Parser.new}
+  describe '#metric_atom' do
+    it "must match 'N'" do
+      subject.metric_atom.parse('N')[:atom_code].must_equal('N')
+    end
+  end
+
+  describe '#atom' do
+    it "must match '[in_i]'" do
+      subject.atom.parse('[in_i]')[:atom_code].must_equal('[in_i]')
+    end
+  end
+
+  describe '#prefix' do
+    it "must match 'k'" do
+      subject.prefix.parse('k')[:prefix_code].must_equal('k')
+    end
+  end
+
+  describe '#annotation' do
+    it "must match '{foobar}'" do
+      subject.annotation.parse('{foobar}')[:annotation].must_equal('foobar')
+    end
+  end
+
+  describe "#factor" do
+    it "must match positives and fixnums" do
+      subject.factor.parse('3.2')[:factor].must_equal(:fixnum => '3.2')
+    end
+    it "must match negatives and integers" do
+      subject.factor.parse('-5')[:factor].must_equal(:integer => '-5')
+    end
+  end
+
+  describe "#exponent" do
+    it "must match positives integers" do
+      subject.exponent.parse('4')[:exponent].must_equal(:integer => '4')
+    end
+    it "must match negative integers" do
+      subject.exponent.parse('-5')[:exponent].must_equal(:integer => '-5')
+    end
+  end
+
+  describe "term" do
+    it "must match basic atoms" do
+      subject.term.parse('[in_i]')[:term][:atom][:atom_code].must_equal('[in_i]')
+    end
+    it "must match prefixed atoms" do
+      match = subject.term.parse('ks')[:term]
+      match[:atom][:atom_code].must_equal('s')
+      match[:prefix][:prefix_code].must_equal('k')
+    end
+    it "must match exponential atoms" do
+      match = subject.term.parse('cm3')[:term]
+      match[:atom][:atom_code].must_equal 'm'
+      match[:prefix][:prefix_code].must_equal 'c'
+      match[:exponent][:integer].must_equal '3'
+    end
+    it "must match factors" do
+      subject.term.parse('3.2')[:term][:factor][:fixnum].must_equal '3.2'
+    end
+    it "must match annotations" do
+      match = subject.term.parse('N{Normal}')[:term]
+      match[:atom][:atom_code].must_equal 'N'
+      match[:annotation].must_equal 'Normal'
+    end
+  end
+
+  describe '#group' do
+    it "must match parentheses with a term" do
+      match = subject.group.parse('(s2)')[:group][:nested][:left][:term]
+      match[:atom][:atom_code].must_equal 's'
+      match[:exponent][:integer].must_equal '2'
+    end
+    it "must match nested groups" do
+      match = subject.group.parse('((kg))')[:group][:nested][:left][:group][:nested][:left][:term]
+      match[:atom][:atom_code].must_equal 'g'
+      match[:prefix][:prefix_code].must_equal 'k'
+    end
+    it "must pass exponents down" do
+      match = subject.group.parse('([in_i])3')[:group]
+      match[:exponent][:integer].must_equal '3'
+      match[:nested][:left][:term][:atom][:atom_code].must_equal '[in_i]'
+    end
+  end
+
+  describe "#expression" do
+    it "must match left only" do
+      match = subject.expression.parse('m')
+      match[:left][:term][:atom][:atom_code].must_equal("m")
+    end
+    it "must match left + right + operator" do
+      match = subject.expression.parse('m.s')
+      match[:left][:term][:atom][:atom_code].must_equal("m")
+      match[:operator].must_equal('.')
+      match[:right][:left][:term][:atom][:atom_code].must_equal('s')
+    end
+    it "must match operator + right" do
+      match = subject.expression.parse("/s")
+      match[:operator].must_equal('/')
+      match[:right][:left][:term][:atom][:atom_code].must_equal('s')
+    end
+  end
+
+
+end

data/test/unitwise/ext/numeric_test.rb

@@ -0,0 +1,54 @@
+require 'test_helper'
+require 'unitwise/ext'
+describe Numeric do
+  describe "#convert" do
+    it "must work for Integer" do
+      measurement = 22.convert_to("kg")
+      measurement.must_be_instance_of(Unitwise::Measurement)
+      measurement.value.must_equal 22
+    end
+    it "must work for Fixnum" do
+      measurement = 24.25.convert_to("[ft_i]")
+      measurement.must_be_instance_of(Unitwise::Measurement)
+      measurement.value.must_equal 24.25
+    end
+    it "must work for Float" do
+      measurement = (22.0/7).convert_to("[mi_i]")
+      measurement.must_be_instance_of(Unitwise::Measurement)
+      measurement.value.must_equal 3.142857142857143
+    end
+    it "must work for Rational" do
+      measurement = Rational(22/7).convert_to("N/m2")
+      measurement.must_be_instance_of(Unitwise::Measurement)
+      measurement.value.must_equal Rational(22/7)
+    end
+  end
+
+  describe "#method_missing" do
+    it "must match 'mm'" do
+      mm = 2.5.mm
+      mm.must_be_instance_of(Unitwise::Measurement)
+      mm.value.must_equal 2.5
+      1.0.respond_to?(:mm).must_equal true
+      3.respond_to?(:to_mm).must_equal true
+    end
+    it "must match 'to_mm'" do
+      mm = 2.5.to_mm
+      mm.must_be_instance_of(Unitwise::Measurement)
+      mm.value.must_equal 2.5
+      4.0.methods.grep(/mm/).count.must_equal 2
+      1.methods.grep(/mm/).count.must_equal 2
+    end
+
+    it "must not match 'foo'" do
+      lambda { 1.foo }.must_raise NoMethodError
+    end
+
+    it "must not match 'to_foo'" do
+      lambda { 1.to_foo }.must_raise NoMethodError
+    end
+
+  end
+
+
+end

data/test/unitwise/functional_test.rb

@@ -0,0 +1,17 @@
+require 'test_helper'
+
+describe Unitwise::Functional do
+  subject { Unitwise::Functional }
+  %w{cel degf hpX hpC tan100 ph ld ln lg 2lg}.each do |function|
+    describe function do
+      it 'should convert back and forth' do
+        number = rand(1000) / 1000.0
+        there = subject.send "to_#{function}", number
+        back_again = subject.send "from_#{function}", there
+        rounded_result = (back_again * 1000).round / 1000.0
+        rounded_result.must_equal number
+      end
+    end
+  end
+
+end

data/test/unitwise/measurement_test.rb

@@ -0,0 +1,233 @@
+# encoding: UTF-8
+require 'test_helper'
+require 'support/scale_tests'
+
+describe Unitwise::Measurement do
+  let(:described_class) { Unitwise::Measurement }
+  include ScaleTests
+
+  describe "#new" do
+    it "should raise an error for unknown units" do
+      lambda { Unitwise::Measurement.new(1,"funkitron") }.must_raise(Unitwise::ExpressionError)
+    end
+  end
+
+  describe "#convert_to" do
+    it "must convert to a similar unit code" do
+      mph.convert_to('km/h').value.must_almost_equal(96.56063)
+    end
+    it "must raise an error if the units aren't similar" do
+      lambda { mph.convert_to('N') }.must_raise Unitwise::ConversionError
+    end
+    it "must convert special units to their base units" do
+      cel.convert_to('K').value.must_equal 295.15
+    end
+    it "must convert base units to special units" do
+      k.convert_to('Cel').value.must_equal 100
+    end
+    it "must convert special units to special units" do
+      f.convert_to('Cel').value.must_almost_equal 37
+    end
+    it "must convert special units to non-special units" do
+      cel.convert_to("[degR]").value.must_almost_equal(531.27)
+    end
+    it "must convert derived units to special units" do
+      r.convert_to("Cel").value.must_almost_equal(0)
+    end
+    it "must convert to a unit of another measurement" do
+      mph.convert_to(kmh).value.must_almost_equal(96.56064)
+    end
+  end
+
+  describe "#*" do
+    it "must multiply by scalars" do
+      mult = mph * 4
+      mult.value.must_equal 240
+      mult.unit.must_equal Unitwise::Unit.new("[mi_i]/h")
+    end
+    it "must multiply similar units" do
+      mult = mph * kmh
+      mult.value.must_almost_equal 3728.22715342
+      mult.unit.must_equal Unitwise::Unit.new("([mi_i]/h).([mi_i]/h)")
+    end
+    it "must multiply unsimilar units" do
+      mult = mph * mile
+      mult.value.must_equal 180
+      mult.unit.must_equal Unitwise::Unit.new("[mi_i]2/h")
+    end
+    it "must multiply canceling units" do
+      mult = mph * hpm
+      mult.value.must_equal 360
+      mult.unit.to_s.must_equal "1"
+    end
+  end
+
+  describe "#/" do
+    it "must divide by scalars" do
+      div = kmh / 4
+      div.value.must_equal 25
+      div.unit.must_equal kmh.unit
+    end
+    it "must divide by the value of similar units" do
+      div = kmh / mph
+      div.value.must_almost_equal 1.03561865
+      div.unit.to_s.must_equal '1'
+    end
+    it "must divide dissimilar units" do
+      div = mph / hpm
+      div.value.must_equal 10
+      div.unit.to_s.must_equal "[mi_i]2/h2"
+    end
+  end
+
+  describe "#+" do
+    it "must add values when units are similar" do
+      added = mph + kmh
+      added.value.must_almost_equal 122.13711922
+      added.unit.must_equal mph.unit
+    end
+    it "must raise an error when units are not similar" do
+      assert_raises(TypeError) { mph + hpm}
+    end
+  end
+
+  describe "#-" do
+    it "must add values when units are similar" do
+      added = mph - kmh
+      added.value.must_almost_equal(-2.1371192)
+      added.unit.must_equal mph.unit
+    end
+    it "must raise an error when units are not similar" do
+      assert_raises(TypeError) { mph - hpm}
+    end
+  end
+
+  describe "#**" do
+    it "must raise to a power" do
+      exp = mile ** 3
+      exp.value.must_equal 27
+      exp.unit.to_s.must_equal "[mi_i]3"
+    end
+    it "must raise to a negative power" do
+      exp = mile ** -3
+      exp.value.must_equal 0.037037037037037035
+      exp.unit.to_s.must_equal "1/[mi_i]3"
+    end
+    it "must not raise to a weird power" do
+      lambda { mile ** 'weird' }.must_raise TypeError
+    end
+  end
+
+  describe "#coerce" do
+    let(:meter) { Unitwise::Measurement.new(1, 'm') }
+    it "must coerce numerics" do
+      (5 * meter).must_equal Unitwise::Measurement.new(5, 'm')
+    end
+    it "should raise an error for other crap" do
+      lambda { meter.coerce("foo") }.must_raise TypeError
+    end
+  end
+
+  describe "equality" do
+    let(:m)    { Unitwise::Measurement.new(1,'m') }
+    let(:feet) { Unitwise::Measurement.new(20, 'foot') }
+    let(:mm)   { Unitwise::Measurement.new(1000,'mm') }
+    let(:foot) { Unitwise::Measurement.new(1,'foot') }
+    let(:g)    { Unitwise::Measurement.new(1,'gram') }
+    it "should be ==" do
+      assert m == m
+      assert m == mm
+      refute m == foot
+      refute m == g
+    end
+    it "should be ===" do
+      assert m == m
+      assert m === mm
+      refute m === foot
+      refute m == g
+    end
+    it "should be equal?" do
+      assert m.equal?(m)
+      refute m.equal?(mm)
+      refute m.equal?(foot)
+      refute m.equal?(g)
+    end
+    it "should be eql?" do
+      assert m.eql?(m)
+      refute m.equal?(mm)
+      refute m.equal?(foot)
+      refute m.equal?(g)
+    end
+  end
+
+  describe "#method_missing" do
+    let(:meter) { Unitwise::Measurement.new(1, 'm')}
+    it "must convert 'to_mm'" do
+      convert = meter.to_mm
+      convert.must_be_instance_of Unitwise::Measurement
+      convert.value.must_equal 1000
+    end
+
+    it "must convert 'to_foot'" do
+      convert = meter.to_foot
+      convert.must_be_instance_of Unitwise::Measurement
+      convert.value.must_almost_equal 3.280839895
+    end
+
+    it "must not convert 'foo'" do
+      lambda { meter.foo }.must_raise NoMethodError
+    end
+
+    it "must not convert 'to_foo'" do
+      lambda { meter.to_foo }.must_raise NoMethodError
+    end
+
+  end
+
+  describe "#round" do
+    it "must round Floats to Integers" do
+      result = Unitwise::Measurement.new(98.6, "[degF]").round
+      result.value.must_equal(99)
+      result.value.must_be_kind_of(Integer)
+    end
+    it "must round Floats to Floats" do
+      if RUBY_VERSION > '1.8.7'
+        result = Unitwise::Measurement.new(17.625, "J").round(2)
+        result.value.must_equal(17.63)
+        result.value.must_be_kind_of(Float)
+      end
+    end
+  end
+  describe "#to_f" do
+    it "must convert to a float" do
+      f.to_f.must_be_kind_of(Float)
+    end
+  end
+
+  describe "#to_i" do
+    it "must convert to an integer" do
+      k.to_i.must_be_kind_of(Integer)
+    end
+  end
+
+  describe "#to_r" do
+    it "must convert to a rational" do
+      cel.to_r.must_be_kind_of(Rational)
+    end
+  end
+
+  describe "#to_s" do
+    it "should include the simplified value and use the mode it was created with" do
+      foot = described_class.new(7.00, "foot")
+      foot.to_s.must_equal "7 foot"
+      meter = described_class.new(BigDecimal("3.142"), "m")
+      meter.to_s.must_equal("3.142 m")
+    end
+    it "should accept a mode and print that mode string" do
+      temp = described_class.new(25, "degree Celsius")
+      temp.to_s(:primary_code).must_equal("25 Cel")
+      temp.to_s(:symbol).must_equal("25 °C")
+    end
+  end
+
+end