auom 0.2.0 → 0.3.0

data/spec/unit/auom/relational_spec.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+describe AUOM::Relational do
+  describe '#<=>' do
+    subject { object <=> other }
+
+    let(:object) { AUOM::Unit.new(1, :meter)    }
+    let(:other)  { AUOM::Unit.new(scalar, unit) }
+
+    context 'when operand unit is the same' do
+      let(:unit) { :meter }
+
+      context 'and operand scalar is less than receiver scalar' do
+        let(:scalar) { 0 }
+
+        it { should be(1) }
+      end
+
+      context 'and operand scalar is equal to receiver scalar' do
+        let(:scalar) { 1 }
+
+        it { should be(0) }
+      end
+
+      context 'and operand scalar is greater than receiver scalar' do
+        let(:scalar) { 2 }
+
+        it { should be(-1) }
+      end
+    end
+
+    context 'when operand unit is not the same' do
+      let(:scalar) { 1     }
+      let(:unit)   { :euro }
+
+      it_should_behave_like 'an incompatible operation'
+    end
+  end
+end

data/spec/unit/auom/unit_spec.rb

@@ -0,0 +1,377 @@
+# frozen_string_literal: true
+
+describe AUOM::Unit do
+  describe '#assert_same_unit' do
+    subject { object.assert_same_unit(other) }
+
+    let(:object) { described_class.new(1, *unit) }
+    let(:unit)   { [%i[meter], %i[euro]]         }
+
+    context 'when units are the same' do
+      let(:other) { AUOM::Unit.new(2, :meter, :euro) }
+
+      it { should be(object) }
+    end
+
+    context 'when units are not the same' do
+      let(:other) { AUOM::Unit.new(2, :meter) }
+
+      it_should_behave_like 'an incompatible operation'
+    end
+  end
+
+  describe '#denominators' do
+    subject { object.denominators }
+
+    let(:object) { described_class.new(1, *unit) }
+    let(:unit)   { [[:meter], [:euro]] }
+
+    it 'should return denominators' do
+      should eql([:euro])
+    end
+
+    it { should be_frozen }
+
+    it_should_behave_like 'an idempotent method'
+  end
+
+  describe '#numerators' do
+    subject { object.numerators }
+
+    let(:object) { described_class.new(1, *unit) }
+    let(:unit)   { [[:meter], [:euro]] }
+
+    it 'should return numerators' do
+      should eql([:meter])
+    end
+
+    it { should be_frozen }
+
+    it_should_behave_like 'an idempotent method'
+  end
+
+  describe '#same_unit?' do
+    subject { object.same_unit?(other) }
+
+    let(:object) { described_class.new(1, *unit) }
+    let(:unit)   { [[:meter], [:euro]] }
+
+    context 'when units are the same' do
+      let(:other) { AUOM::Unit.new(2, :meter, :euro) }
+
+      it { should be(true) }
+    end
+
+    context 'when units are not the same' do
+      let(:other) { AUOM::Unit.new(2, :meter) }
+
+      it { should be(false) }
+    end
+  end
+
+  describe '#denominators' do
+    subject { object.scalar }
+
+    let(:object) { described_class.new(scalar) }
+    let(:scalar) { Rational(1, 2) }
+
+    it 'should return scalar' do
+      should eql(scalar)
+    end
+
+    it { should be_frozen }
+
+    it_should_behave_like 'an idempotent method'
+  end
+
+  describe '#unitless?' do
+    subject { object.unitless? }
+
+    let(:object) { described_class.new(1, *unit) }
+
+    context 'when unit is unitless' do
+      let(:unit) { [] }
+      it { should be(true) }
+    end
+
+    context 'when unit has no denominator' do
+      let(:unit) { [:meter] }
+
+      it { should be(false) }
+    end
+
+    context 'when unit has no numerator' do
+      let(:unit) { [[], :meter] }
+
+      it { should be(false) }
+    end
+  end
+
+  describe '#unit' do
+    subject { object.unit }
+
+    let(:object) { described_class.new(1, *unit) }
+    let(:unit)   { [[:meter], [:euro]] }
+
+    it 'should return unit of unit instance' do
+      should eql(unit)
+    end
+
+    it { should be_frozen }
+
+    it_should_behave_like 'an idempotent method'
+  end
+
+  describe '.convert' do
+    subject { object.convert(value) }
+
+    let(:object) { AUOM::Unit }
+
+    context 'with nil' do
+      let(:value) { nil }
+
+      it 'should raise error' do
+        expect { subject }.to raise_error(ArgumentError, 'Cannot convert nil to AUOM::Unit')
+      end
+    end
+
+    context 'with fixnum' do
+      let(:value) { 1 }
+
+      it { should eql(AUOM::Unit.new(1)) }
+    end
+
+    context 'with rational' do
+      let(:value) { Rational(2, 1) }
+
+      it { should eql(AUOM::Unit.new(2)) }
+    end
+
+    context 'with Object' do
+      let(:value) { Object.new }
+
+      it 'should raise error' do
+        expect { subject }.to raise_error(ArgumentError, "Cannot convert #{value.inspect} to AUOM::Unit")
+      end
+    end
+  end
+
+  describe '.lookup' do
+    subject { object.__send__(:lookup, value) }
+
+    let(:object) { described_class }
+
+    context 'with existing symbol' do
+      let(:value) { :meter }
+
+      it { should eql([1, :meter]) }
+    end
+
+    context 'with inexistent symbol' do
+      let(:value) { :foo }
+
+      it 'should raise error' do
+        expect { subject }.to raise_error(ArgumentError, 'Unknown unit :foo')
+      end
+    end
+  end
+
+  describe '.new' do
+    let(:object) { described_class }
+
+    subject do
+      described_class.new(*arguments)
+    end
+
+    shared_examples_for 'invalid unit' do
+      it 'should raise ArgumentError' do
+        expect { subject }.to raise_error(ArgumentError)
+      end
+    end
+
+    let(:expected_scalar) { 1 }
+    let(:expected_numerators) { [] }
+    let(:expected_denominators) { [] }
+
+    shared_examples_for 'valid unit' do
+      it { should be_frozen }
+
+      its(:scalar)       { should == expected_scalar       }
+      its(:scalar)       { should be_frozen                }
+      its(:numerators)   { should == expected_numerators   }
+      its(:numerators)   { should be_frozen                }
+      its(:denominators) { should == expected_denominators }
+      its(:denominators) { should be_frozen                }
+    end
+
+    describe 'without arguments' do
+      let(:arguments) { [] }
+      it_should_behave_like 'invalid unit'
+    end
+
+    describe 'with one scalar argument' do
+      let(:arguments) { [argument] }
+
+      context 'when scalar is a string' do
+        let(:argument) { '10.31' }
+        it 'should raise error' do
+          expect { subject }.to raise_error(ArgumentError, '"10.31" cannot be converted to rational')
+        end
+      end
+
+      context 'when argument is an Integer' do
+        let(:argument) { 1 }
+
+        it_should_behave_like 'unitless unit'
+        it_should_behave_like 'valid unit'
+      end
+
+      context 'when argument is a Rational' do
+        let(:argument) { Rational(1, 1) }
+
+        it_should_behave_like 'unitless unit'
+        it_should_behave_like 'valid unit'
+      end
+
+      context 'when argument is something else' do
+        let(:argument) { 1.0 }
+
+        it_should_behave_like 'invalid unit'
+      end
+    end
+
+    describe 'with scalar and numerator argument' do
+      let(:arguments) { [1, argument] }
+
+      context 'when argument is a valid unit' do
+        let(:argument) { :kilogramm }
+        let(:expected_numerators) { [:kilogramm] }
+
+        it_should_behave_like 'valid unit'
+      end
+
+      context 'when argument is a valid unit alias' do
+        let(:argument) { :kilometer }
+        let(:expected_numerators) { [:meter] }
+        let(:expected_scalar) { 1000 }
+
+        it_should_behave_like 'valid unit'
+      end
+
+      context 'when argument is an array of valid units' do
+        let(:argument)            { %i[kilogramm meter] }
+        let(:expected_numerators) { %i[kilogramm meter] }
+
+        it_should_behave_like 'valid unit'
+      end
+
+      context 'when argument is an array with invalid unit' do
+        let(:argument) { %i[kilogramm nonsense] }
+
+        it_should_behave_like 'invalid unit'
+      end
+
+      context 'when argument is an invalid unit' do
+        let(:argument) { :nonsense }
+
+        it_should_behave_like 'invalid unit'
+      end
+    end
+
+    describe 'with scalar, numerator and denominator argument' do
+      let(:arguments)           { [1, :kilogramm, argument] }
+      let(:expected_numerators) { %i[kilogramm]             }
+
+      context 'when argument is a valid unit' do
+        let(:argument) { :meter }
+        let(:expected_denominators) { [:meter] }
+
+        it_should_behave_like 'valid unit'
+      end
+
+      context 'when argument is a valid unit alias' do
+        let(:argument) { :kilometer }
+
+        let(:expected_denominators) { [:meter] }
+        let(:expected_scalar) { Rational(1, 1000) }
+
+        it_should_behave_like 'valid unit'
+      end
+
+      context 'when argument is an array of valid units' do
+        let(:argument)              { %i[euro meter] }
+        let(:expected_denominators) { %i[euro meter] }
+
+        it_should_behave_like 'valid unit'
+      end
+
+      context 'when argument is an array with invalid unit' do
+        let(:argument) { %i[euro nonsense] }
+
+        it_should_behave_like 'invalid unit'
+      end
+
+      context 'when argument is an invalid unit' do
+        let(:argument) { :nonsense }
+
+        it_should_behave_like 'invalid unit'
+      end
+    end
+
+    context 'when numerators and denominators overlap' do
+      let(:arguments)             { [1, numerators, denominators] }
+      let(:numerators)            { %i[kilogramm meter euro]      }
+      let(:denominators)          { %i[meter meter]               }
+      let(:expected_numerators)   { %i[euro kilogramm]            }
+      let(:expected_denominators) { [:meter]                      }
+
+      it_should_behave_like 'valid unit'
+    end
+  end
+
+  describe '.try_convert' do
+    subject { object.try_convert(value) }
+
+    let(:object) { AUOM::Unit }
+
+    context 'with unit' do
+      let(:value) { AUOM::Unit.new(1) }
+
+      it { should be(value) }
+    end
+
+    context 'with nil' do
+      let(:value) { nil }
+
+      it { should be(nil) }
+    end
+
+    context 'with fixnum' do
+      let(:value) { 1 }
+
+      it { should eql(AUOM::Unit.new(1)) }
+    end
+
+    context 'with rational' do
+      let(:value) { Rational(2, 1) }
+
+      it { should eql(AUOM::Unit.new(2)) }
+    end
+
+    context 'with Object' do
+      let(:value) { Object.new }
+
+      it { should be(nil) }
+    end
+  end
+
+  describe '.units' do
+    subject { object.units }
+
+    let(:object) { described_class }
+
+    it { should be_a(Hash) }
+
+    it_should_behave_like 'an idempotent method'
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: auom
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Markus Schirp
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-29 00:00:00.000000000 Z
+date: 2018-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: equalizer
@@ -30,23 +30,22 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.12
+        version: 0.1.21
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.12
+        version: 0.1.21
 description: 
 email: mbj@schirp-dso.com
 executables: []
 extensions: []
 extra_rdoc_files:
-- TODO
 - LICENSE
 files:
-- ".circle.yml"
+- ".circleci/config.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -56,9 +55,9 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- TODO
 - auom.gemspec
 - circle.yml
+- config/devtools.yml
 - config/flay.yml
 - config/flog.yml
 - config/mutant.yml
@@ -77,30 +76,11 @@ files:
 - spec/shared/operation_behavior.rb
 - spec/shared/sunits_shared.rb
 - spec/spec_helper.rb
-- spec/unit/auom/algebra/add_spec.rb
-- spec/unit/auom/algebra/divide_spec.rb
-- spec/unit/auom/algebra/multiply_spec.rb
-- spec/unit/auom/algebra/substract_spec.rb
-- spec/unit/auom/equalization/equality_operator_spec.rb
-- spec/unit/auom/inspection/class_methods/prettify_unit_part_spec.rb
-- spec/unit/auom/inspection/inspect_spec.rb
-- spec/unit/auom/relational/greater_than_or_equal_to_predicate_spec.rb
-- spec/unit/auom/relational/greater_than_predicate_spec.rb
-- spec/unit/auom/relational/less_than_or_equal_to_predicate_spec.rb
-- spec/unit/auom/relational/less_than_predicate_spec.rb
-- spec/unit/auom/unit/assert_same_unit_spec.rb
-- spec/unit/auom/unit/class_methods/convert_spec.rb
-- spec/unit/auom/unit/class_methods/lookup_spec.rb
-- spec/unit/auom/unit/class_methods/new_spec.rb
-- spec/unit/auom/unit/class_methods/try_convert_spec.rb
-- spec/unit/auom/unit/class_methods/units_spec.rb
-- spec/unit/auom/unit/denominators_spec.rb
-- spec/unit/auom/unit/numerators_spec.rb
-- spec/unit/auom/unit/same_unit_predicate_spec.rb
-- spec/unit/auom/unit/scalar_spec.rb
-- spec/unit/auom/unit/unit
-- spec/unit/auom/unit/unit_spec.rb
-- spec/unit/auom/unit/unitless_predicate_spec.rb
+- spec/unit/auom/algebra_spec.rb
+- spec/unit/auom/equalization_spec.rb
+- spec/unit/auom/inspection_spec.rb
+- spec/unit/auom/relational_spec.rb
+- spec/unit/auom/unit_spec.rb
 homepage: http://github.com/mbj/auom
 licenses: []
 metadata: {}
@@ -112,7 +92,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -120,7 +100,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Algebra (with) Units Of Measurement
@@ -130,27 +110,8 @@ test_files:
 - spec/shared/operation_behavior.rb
 - spec/shared/sunits_shared.rb
 - spec/spec_helper.rb
-- spec/unit/auom/algebra/add_spec.rb
-- spec/unit/auom/algebra/divide_spec.rb
-- spec/unit/auom/algebra/multiply_spec.rb
-- spec/unit/auom/algebra/substract_spec.rb
-- spec/unit/auom/equalization/equality_operator_spec.rb
-- spec/unit/auom/inspection/class_methods/prettify_unit_part_spec.rb
-- spec/unit/auom/inspection/inspect_spec.rb
-- spec/unit/auom/relational/greater_than_or_equal_to_predicate_spec.rb
-- spec/unit/auom/relational/greater_than_predicate_spec.rb
-- spec/unit/auom/relational/less_than_or_equal_to_predicate_spec.rb
-- spec/unit/auom/relational/less_than_predicate_spec.rb
-- spec/unit/auom/unit/assert_same_unit_spec.rb
-- spec/unit/auom/unit/class_methods/convert_spec.rb
-- spec/unit/auom/unit/class_methods/lookup_spec.rb
-- spec/unit/auom/unit/class_methods/new_spec.rb
-- spec/unit/auom/unit/class_methods/try_convert_spec.rb
-- spec/unit/auom/unit/class_methods/units_spec.rb
-- spec/unit/auom/unit/denominators_spec.rb
-- spec/unit/auom/unit/numerators_spec.rb
-- spec/unit/auom/unit/same_unit_predicate_spec.rb
-- spec/unit/auom/unit/scalar_spec.rb
-- spec/unit/auom/unit/unit
-- spec/unit/auom/unit/unit_spec.rb
-- spec/unit/auom/unit/unitless_predicate_spec.rb
+- spec/unit/auom/algebra_spec.rb
+- spec/unit/auom/equalization_spec.rb
+- spec/unit/auom/inspection_spec.rb
+- spec/unit/auom/relational_spec.rb
+- spec/unit/auom/unit_spec.rb