auom 0.0.3 → 0.0.4

data/Changelog.md

@@ -0,0 +1,9 @@
+# v0.0.4 2012-11-20
+
+* [feature] Support for relational operatiors >, <, >= and <=
+
+[Compare v0.0.3..v0.0.4](https://github.com/mbj/auom/compare/v0.0.3...v0.0.4)
+
+# v0.0.3 2012-11-19
+
+First public release :)

data/config/flay.yml

@@ -1,3 +1,3 @@
 ---
-threshold: 12.0
-total_score: 68.0
+threshold: 12
+total_score: 128.0

data/config/heckle.yml

@@ -2,8 +2,13 @@
 library: auom
 namespace: AUOM
 aliases:
+  AUOM::Relational: 
+    '>=': greater_than_or_equal_to?
+    '<=': less_than_or_equal_to?
+    '<': less_than?
+    '>': greater_than?
   AUOM::Algebra: 
-   '-': substract
-   '+': add
-   '*': multiply
-   '/': divide
+    '-': substract
+    '+': add
+    '*': multiply
+    '/': divide

data/config/roodi.yml

@@ -3,7 +3,7 @@ AbcMetricMethodCheck:
   score: 25.1
 AssignmentInConditionalCheck:    { }
 CaseMissingElseCheck:            { }
-ClassLineCountCheck:             { line_count: 274 }
+ClassLineCountCheck:             { line_count: 315 }
 ClassNameCheck:                  
   pattern: !ruby/regexp /\A(?:[A-Z]+|[A-Z][a-z](?:[A-Z]?[a-z])+)\z/
 ClassVariableCheck:              { }
@@ -14,7 +14,7 @@ ForLoopCheck:                    { }
 MethodLineCountCheck:            { line_count: 14 }
 MethodNameCheck:                 
   pattern: !ruby/regexp /\A(?:[a-z\d](?:_?[a-z\d])+[?!=]?|\[\]=?|==|<=>|<<|[+*&|-])\z/
-ModuleLineCountCheck:            { line_count: 277 }
+ModuleLineCountCheck:            { line_count: 318 }
 ModuleNameCheck:                 
   pattern: !ruby/regexp /\A(?:[A-Z]+|[A-Z][a-z](?:[A-Z]?[a-z])+)\z/
 ParameterNumberCheck:            { parameter_count: 3 }

data/lib/auom.rb

@@ -4,6 +4,7 @@ require 'backports'
 require 'auom/algebra'
 require 'auom/equalization'
 require 'auom/inspection'
+require 'auom/relational'
 
 # Library namespace
 module AUOM
@@ -12,6 +13,7 @@ module AUOM
     include Algebra
     include Equalization
     include Inspection
+    include Relational
 
     # Return scalar
     #
@@ -111,6 +113,31 @@ module AUOM
       numerators.empty? and denominators.empty?
     end
 
+    # Test if units are the same
+    #
+    # @param [Unit] other
+    #
+    # @return [true]
+    #   if units are the same
+    #
+    # @return [false]
+    #   otehrwise
+    #
+    # @example
+    #  
+    #   a = Unit.new(1)
+    #   b = Unit.new(1, :euro)
+    #   c = Unit.new(2, :euro)
+    #
+    #   a.same_unit?(b) # => false
+    #   b.same_unit?(c) # => true
+    #
+    # @api public
+    #
+    def same_unit?(other)
+      other.unit.eql?(unit)
+    end
+
     # Instancitate a new unit
     #
     # @param [Rational] scalar
@@ -156,6 +183,22 @@ module AUOM
       super(scalar, *[numerators, denominators].map { |base| base.sort_by(&:to_s) }).freeze
     end
 
+    # Assert units are the same
+    #
+    # @param [Unit] other
+    #
+    # @return [self]
+    #
+    # @api private
+    #
+    def assert_same_unit(other)
+      unless same_unit?(other)
+        raise ArgumentError, 'Incompatible units'
+      end
+
+      self
+    end
+
   private
 
     # Initialize unit
@@ -180,7 +223,6 @@ module AUOM
       @scalar.freeze
     end
 
-
     # Return converted operand or raise error
     #
     # @param [Object] operand

data/lib/auom/algebra.rb

@@ -24,9 +24,7 @@ module AUOM
       klass = self.class
       operand = klass.convert(operand)
 
-      unless operand.unit == unit
-        raise ArgumentError, 'Incompatible units for substraction or addition'
-      end
+      assert_same_unit(operand)
 
       klass.new(
         operand.scalar + scalar,
@@ -35,7 +33,7 @@ module AUOM
       )
     end
 
-    alias :+ :add
+    alias_method :+, :add
 
     # Return substraction result
     #
@@ -60,7 +58,7 @@ module AUOM
       self.add(self.class.convert(operand) * -1)
     end
 
-    alias :- :substract
+    alias_method :-, :substract
 
     # Return multiplication result
     #
@@ -92,7 +90,7 @@ module AUOM
       )
     end
 
-    alias :* :multiply
+    alias_method :*, :multiply
 
     # Return division result
     #
@@ -124,6 +122,6 @@ module AUOM
       )
     end
 
-    alias :/ :divide
+    alias_method :/, :divide
   end
 end

data/lib/auom/relational.rb

@@ -0,0 +1,90 @@
+module AUOM
+  # Mixin to add relational operators
+  module Relational
+
+    # Test if unit is less than or equal to other
+    #
+    # @param [Unit] other
+    #
+    # @return [true]
+    #   if unit is less than other
+    #
+    # @return [false]
+    #   otherwise
+    #
+    # @api private
+    #
+    def less_than_or_equal_to?(other)
+      relational_operation(other, :<=)
+    end
+    alias_method :<=, :less_than_or_equal_to?
+
+    # Test if unit is greater than or equal toother
+    #
+    # @param [Unit] other
+    #
+    # @return [true]
+    #   if unit is greater than other
+    #
+    # @return [false]
+    #   otherwise
+    #
+    # @api private
+    #
+    def greater_than_or_equal_to?(other)
+      relational_operation(other, :>=)
+    end
+    alias_method :>=, :greater_than_or_equal_to?
+
+    # Test if unit is less than other
+    #
+    # @param [Unit] other
+    #
+    # @return [true]
+    #   if unit is less than other
+    #
+    # @return [false]
+    #   otherwise
+    #
+    # @api private
+    #
+    def less_than?(other)
+      relational_operation(other, :<)
+    end
+    alias_method :<, :less_than?
+
+    # Test if unit is greater than other
+    #
+    # @param [Unit] other
+    #
+    # @return [true]
+    #   if unit is greater than other
+    #
+    # @return [false]
+    #   otherwise
+    #
+    # @api private
+    #
+    def greater_than?(other)
+      relational_operation(other, :>)
+    end
+    alias_method :<, :less_than?
+
+  private
+
+    # Peform relational operation
+    #
+    # @param [Unit] other
+    # @param [Symbol] operation
+    #
+    # @return [Object]
+    #
+    # @api private
+    #
+    def relational_operation(other, operation)
+      assert_same_unit(other)
+      scalar.public_send(operation, other.scalar)
+    end
+
+  end
+end

data/lib/auom/version.rb

@@ -1,3 +1,3 @@
 module AUOM
-  VERSION = '0.0.3'.freeze
+  VERSION = '0.0.4'.freeze
 end

data/spec/shared/incompatible_operation_behavior.rb

@@ -1,5 +1,5 @@
 shared_examples_for 'an incompatible operation' do
   it 'should raise ArgumentError' do
-    expect { subject }.to raise_error(ArgumentError,'Incompatible units for substraction or addition')
+    expect { subject }.to raise_error(ArgumentError,'Incompatible units')
   end
 end

data/spec/unit/auom/relational/greater_than_or_equal_to_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe AUOM::Relational,'#greater_than_or_equal_to?' do
+
+  subject { object.greater_than_or_equal_to?(operand) }
+
+  let(:object) { AUOM::Unit.new(1, :meter) }
+
+  let(:operand) { 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(true) }
+    end
+
+    context 'and operand scalar is equal to receiver scalar' do
+      let(:scalar) { 1 }
+
+      it { should be(true) }
+    end
+
+    context 'and operand scalar is greater than receiver scalar' do
+      let(:scalar) { 2 }
+
+      it { should be(false) }
+    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

data/spec/unit/auom/relational/greater_than_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe AUOM::Relational,'#greater_than?' do
+
+  subject { object.greater_than?(operand) }
+
+  let(:object) { AUOM::Unit.new(1, :meter) }
+
+  let(:operand) { 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(true) }
+    end
+
+    context 'and operand scalar is equal to receiver scalar' do
+      let(:scalar) { 1 }
+
+      it { should be(false) }
+    end
+
+    context 'and operand scalar is greater than receiver scalar' do
+      let(:scalar) { 2 }
+
+      it { should be(false) }
+    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

data/spec/unit/auom/relational/less_than_or_equal_to_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe AUOM::Relational,'#less_than_or_equal_to?' do
+
+  subject { object.less_than_or_equal_to?(operand) }
+
+  let(:object) { AUOM::Unit.new(1, :meter) }
+
+  let(:operand) { 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(false) }
+    end
+
+    context 'and operand scalar is equal to receiver scalar' do
+      let(:scalar) { 1 }
+
+      it { should be(true) }
+    end
+
+    context 'and operand scalar is greater than receiver scalar' do
+      let(:scalar) { 2 }
+
+      it { should be(true) }
+    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

data/spec/unit/auom/relational/less_than_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe AUOM::Relational,'#less_than?' do
+
+  subject { object.less_than?(operand) }
+
+  let(:object) { AUOM::Unit.new(1, :meter) }
+
+  let(:operand) { 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(false) }
+    end
+
+    context 'and operand scalar is equal to receiver scalar' do
+      let(:scalar) { 1 }
+
+      it { should be(false) }
+    end
+
+    context 'and operand scalar is greater than receiver scalar' do
+      let(:scalar) { 2 }
+
+      it { should be(true) }
+    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

data/spec/unit/auom/unit/assert_same_unit_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe AUOM::Unit,'#assert_same_unit' do
+
+  subject { object.assert_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(object) }
+  end
+
+  context 'when units arent the same' do
+    let(:other) { AUOM::Unit.new(2, :meter) }
+
+    it_should_behave_like 'an incompatible operation'
+  end
+
+end

data/spec/unit/auom/unit/same_unit_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe AUOM::Unit,'#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 arent the same' do
+    let(:other) { AUOM::Unit.new(2, :meter) }
+
+    it { should be(false) }
+  end
+
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: auom
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 23
   prerelease: 
   segments: 
   - 0
   - 0
-  - 3
-  version: 0.0.3
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - Markus Schirp
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-11-19 00:00:00 Z
+date: 2012-11-20 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: backports
@@ -46,6 +46,7 @@ files:
 - .gitignore
 - .rspec
 - .travis.yml
+- Changelog.md
 - Gemfile
 - Gemfile.devtools
 - Guardfile
@@ -64,6 +65,7 @@ files:
 - lib/auom/algebra.rb
 - lib/auom/equalization.rb
 - lib/auom/inspection.rb
+- lib/auom/relational.rb
 - lib/auom/version.rb
 - spec/rcov.opts
 - spec/shared/command_method_behavior.rb
@@ -76,7 +78,6 @@ files:
 - spec/shared/sunits_shared.rb
 - spec/spec.opts
 - spec/spec_helper.rb
-- spec/unit/auom/add_spec.rb
 - spec/unit/auom/algebra/add_spec.rb
 - spec/unit/auom/algebra/divide_spec.rb
 - spec/unit/auom/algebra/multiply_spec.rb
@@ -86,6 +87,11 @@ files:
 - spec/unit/auom/equalization/hash_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_spec.rb
+- spec/unit/auom/relational/greater_than_spec.rb
+- spec/unit/auom/relational/less_than_or_equal_to_spec.rb
+- spec/unit/auom/relational/less_than_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
@@ -93,6 +99,7 @@ files:
 - 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_spec.rb
 - spec/unit/auom/unit/scalar_spec.rb
 - spec/unit/auom/unit/unit_spec.rb
 - spec/unit/auom/unit/unitless_spec.rb
@@ -141,7 +148,6 @@ test_files:
 - spec/shared/sunits_shared.rb
 - spec/spec.opts
 - spec/spec_helper.rb
-- spec/unit/auom/add_spec.rb
 - spec/unit/auom/algebra/add_spec.rb
 - spec/unit/auom/algebra/divide_spec.rb
 - spec/unit/auom/algebra/multiply_spec.rb
@@ -151,6 +157,11 @@ test_files:
 - spec/unit/auom/equalization/hash_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_spec.rb
+- spec/unit/auom/relational/greater_than_spec.rb
+- spec/unit/auom/relational/less_than_or_equal_to_spec.rb
+- spec/unit/auom/relational/less_than_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
@@ -158,6 +169,7 @@ test_files:
 - 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_spec.rb
 - spec/unit/auom/unit/scalar_spec.rb
 - spec/unit/auom/unit/unit_spec.rb
 - spec/unit/auom/unit/unitless_spec.rb