unitwise 0.1.0

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,36 @@
+require 'test_helper'
+
+describe Unitwise::Expression::Decomposer do
+  subject { Unitwise::Expression::Decomposer }
+
+  describe "PARSERS" do
+    it "should return multiple parsers" do
+      subject::PARSERS.must_be_instance_of Array
+      subject::PARSERS.sample.must_be_instance_of Unitwise::Expression::Parser
+    end
+  end
+
+  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
+  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,91 @@
+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 and integers" do
+      subject.exponent.parse('4')[:exponent].must_equal(integer: '4')
+    end
+    it "must match negatives and fixnums" do
+      subject.exponent.parse('-5.4')[:exponent].must_equal(fixnum: '-5.4')
+    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
+
+
+end

data/test/unitwise/ext/numeric_test.rb

@@ -0,0 +1,46 @@
+require 'test_helper'
+
+describe Numeric do
+
+  describe "#convert" do
+    it "must work for Integer" do
+      measurement = 22.convert("kg")
+      measurement.must_be_instance_of(Unitwise::Measurement)
+      measurement.value.must_equal 22
+    end
+    it "must work for Fixnum" do
+      measurement = 24.25.convert("[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("[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("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
+    end
+    it "must match foot" do
+      ft = 4.foot
+      ft.must_be_instance_of(Unitwise::Measurement)
+      ft.value.must_equal 4
+    end
+    it "must not match 'foo'" do
+      ->{ 1.foo }.must_raise NoMethodError
+    end
+
+  end
+
+
+end

data/test/unitwise/ext/string_test.rb

@@ -0,0 +1,13 @@
+require 'test_helper'
+
+describe String do
+  describe '#to_slug' do
+    it "should convert 'Pascal' to 'pascal'" do
+      "Pascal".to_slug.must_equal 'pascal'
+    end
+
+    it "should convert 'degree Celsius' to 'degree_celsius'" do
+      "degree Celsius".to_slug.must_equal 'degree_celsius'
+    end
+  end
+end

data/test/unitwise/function_test.rb

@@ -0,0 +1,42 @@
+require 'test_helper'
+
+describe Unitwise::Function do
+  subject { Unitwise::Function }
+
+  it '::all must be an Array' do
+    subject.all.must_be_instance_of Array
+  end
+
+  it '::add must add to :all' do
+    defined = subject.add('foo(2 3N)', ->{ 4 }, ->{ 6 })
+    subject.all.must_include(defined)
+  end
+
+  it "::find must find by name" do
+    defined = subject.add("foo", -> { 3 }, -> { 7 })
+    subject.find("foo").must_equal(defined)
+  end
+
+  let (:fp) { Unitwise::Function.new('foo(1 4J)', ->(x){ x + 1}, ->(x){ x - 1 }) }
+
+  it 'must have a #name' do
+    fp.name.must_equal('foo(1 4J)')
+  end
+
+  it 'must have a direct lambda' do
+    fp.direct.call(1).must_equal 2
+  end
+
+  it 'must have a inverse lambda' do
+    fp.inverse.call(1).must_equal 0
+  end
+
+  it 'must have a direct scalar' do
+    fp.functional(1, 1).must_equal 2
+  end
+
+  it 'must have an inverse scalar' do
+    fp.functional(1, -1).must_equal 0
+  end
+
+end

data/test/unitwise/measurement_test.rb

@@ -0,0 +1,168 @@
+require 'test_helper'
+
+describe Unitwise::Measurement do
+  subject { Unitwise::Measurement.new(1, 'm/s') }
+  describe "#new" do
+    it "must set attributes" do
+      subject.value.must_equal(1)
+      subject.unit.to_s.must_equal('m/s')
+    end
+  end
+
+  describe "#unit" do
+    it "must be a unit" do
+      subject.must_respond_to(:unit)
+      subject.unit.must_be_instance_of(Unitwise::Unit)
+    end
+  end
+
+  describe "#root_terms" do
+    it "must be a collection of terms" do
+      subject.must_respond_to(:root_terms)
+      subject.root_terms.must_be_kind_of Enumerable
+      subject.root_terms.sample.must_be_instance_of(Unitwise::Term)
+    end
+  end
+
+  describe "#dup" do
+    it "must return a new instance" do
+      subject.must_respond_to(:dup)
+      subject.dup.must_be_instance_of(Unitwise::Measurement)
+      subject.dup.value.must_equal subject.value
+      subject.dup.unit.to_s.must_equal subject.unit.to_s
+      subject.dup.object_id.wont_equal subject.dup.object_id
+    end
+  end
+
+  let(:mph) { Unitwise::Measurement.new(60, '[mi_i]/h') }
+  let(:kmh) { Unitwise::Measurement.new(100, 'km/h') }
+  let(:mile) { Unitwise::Measurement.new(3, '[mi_i]') }
+  let(:hpm) { Unitwise::Measurement.new(6, 'h/[mi_i]') }
+  let(:cui) { Unitwise::Measurement.new(12, "[in_i]3") }
+  let(:cel) { Unitwise::Measurement.new(22, 'Cel') }
+  let(:k) {Unitwise::Measurement.new(373.15, 'K') }
+  let(:f) {Unitwise::Measurement.new(98.6, '[degF]')}
+
+  describe "#scalar" do
+    it "must return value relative to terminal atoms" do
+      subject.scalar.must_equal 1
+      mph.scalar.must_equal 26.8224
+    end
+  end
+
+  describe "#convert" do
+    it "must convert to a similar unit code" do
+      mph.convert('km/h').value.must_equal 96.56063999999999
+    end
+    it "must raise an error if the units aren't similar" do
+      ->{ mph.convert('N') }.must_raise Unitwise::ConversionError
+    end
+    it "must convert special units to their base units" do
+      cel.convert('K').value.must_equal 295.15
+    end
+    it "must convert base units to special units" do
+      k.convert('Cel').value.must_equal 100
+    end
+    it "must convert special units to special units" do
+      f.convert('Cel').value.must_equal 37
+    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_equal 3728.227153424004
+      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_equal 1.03561865372889
+      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_equal 122.13711922373341
+      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_equal -2.1371192237334
+      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
+  end
+
+  describe "#method_missing" do
+    let(:meter) { Unitwise::Measurement.new(1, 'm')}
+    it "must convert 'mm'" do
+      convert = meter.mm
+      convert.must_be_instance_of Unitwise::Measurement
+      convert.value.must_equal 1000
+    end
+
+    it "must convert 'foot'" do
+      convert = meter.foot
+      convert.must_be_instance_of Unitwise::Measurement
+      convert.value.must_equal 3.280839895013123
+    end
+
+    it "must not convert 'foo'" do
+      ->{ meter.foo }.must_raise NoMethodError
+    end
+
+  end
+
+end