auom 0.1.0 → 0.2.0

data/lib/auom/equalization.rb

@@ -1,5 +1,3 @@
-# encoding: UTF-8
-
 module AUOM
   # Equalization for auom units
   module Equalization

data/lib/auom/inspection.rb

@@ -1,8 +1,11 @@
-# encoding: UTF-8
-
 module AUOM
   # Inspection module for auom units
   module Inspection
+
+    INSPECT_FORMAT = '<%s @scalar=%s%s>'.freeze
+    SCALAR_FORMAT  = '~%0.4f'.freeze
+    UNIT_FORMAT    = ' %s/%s'.freeze
+
     # Return inspectable representation
     #
     # @return [String]
@@ -10,12 +13,24 @@ module AUOM
     # @api private
     #
     def inspect
-      sprintf('<%s @scalar=%s%s>', self.class, pretty_scalar, pretty_unit)
+      format(INSPECT_FORMAT, self.class, pretty_scalar, pretty_unit)
+    end
+
+    # Return prettified units
+    #
+    # @param [Array] base
+    #
+    # @return [String]
+    #
+    # @api private
+    #
+    def self.prettify_unit_part(base)
+      counts(base).map { |unit, length| length > 1 ? "#{unit}^#{length}" : unit }.join('*')
     end
 
   private
 
-    # Return prettyfied scalar
+    # Return prettified scalar
     #
     # @return [String]
     #
@@ -23,13 +38,13 @@ module AUOM
     #
     def pretty_scalar
       if reminder?
-        sprintf('~%0.4f', scalar)
+        format(SCALAR_FORMAT, scalar)
       else
-        scalar.to_i
+        scalar.to_int
       end
     end
 
-    # Return prettyfied unit part
+    # Return prettified unit part
     #
     # @return [String]
     #   if there is a prettifiable unit part
@@ -42,15 +57,15 @@ module AUOM
     def pretty_unit
       return if unitless?
 
-      numerator   = Inspection.prettify_unit_part(@numerators)
-      denominator = Inspection.prettify_unit_part(@denominators)
+      numerator   = Inspection.prettify_unit_part(numerators)
+      denominator = Inspection.prettify_unit_part(denominators)
 
       numerator   = '1' if numerator.empty?
       if denominator.empty?
         return " #{numerator}"
       end
 
-      sprintf(' %s/%s', numerator, denominator)
+      format(UNIT_FORMAT, numerator, denominator)
     end
 
     # Test if scalar has and reminder in decimal representation
@@ -67,18 +82,6 @@ module AUOM
       !(scalar % scalar.denominator).zero?
     end
 
-    # Return prettified units
-    #
-    # @param [Array] base
-    #
-    # @return [String]
-    #
-    # @api private
-    #
-    def self.prettify_unit_part(base)
-      counts(base).map { |unit, length| length > 1 ? "#{unit}^#{length}" : unit }.join('*')
-    end
-
     # Return unit counts
     #
     # @param [Array] base
@@ -91,7 +94,7 @@ module AUOM
       counts = base.each_with_object(Hash.new(0)) { |unit, hash| hash[unit] += 1 }
       counts.sort do |left, right|
         result = right.last <=> left.last
-        if result == 0
+        if result.equal?(0)
           left.first <=> right.first
         else
           result

data/lib/auom/relational.rb

@@ -1,5 +1,3 @@
-# encoding: UTF-8
-
 module AUOM
   # Mixin to add relational operators
   module Relational
@@ -21,7 +19,7 @@ module AUOM
     end
     alias_method :<=, :less_than_or_equal_to?
 
-    # Test if unit is greater than or equal toother
+    # Test if unit is greater than or equal to other
     #
     # @param [Unit] other
     #
@@ -74,7 +72,7 @@ module AUOM
 
   private
 
-    # Peform relational operation
+    # Perform relational operation
     #
     # @param [Unit] other
     # @param [Symbol] operation

data/lib/auom/unit.rb

@@ -1,5 +1,3 @@
-# encoding: UTF-8
-
 module AUOM
   # A scalar with units
   class Unit
@@ -43,7 +41,7 @@ module AUOM
     #
     #   include AUOM
     #   m = Unit.new(1, :meter)
-    #   m.denoninators # => []
+    #   m.denominators # => []
     #
     # @return [Rational]
     #
@@ -78,7 +76,7 @@ module AUOM
       kilometer: [1000, :meter]
     }.freeze
 
-    # Return buildin units symbols
+    # Return built-in units symbols
     #
     # @return [Hash]
     #
@@ -115,7 +113,7 @@ module AUOM
     #   if units are the same
     #
     # @return [false]
-    #   otehrwise
+    #   otherwise
     #
     # @example
     #
@@ -132,7 +130,7 @@ module AUOM
       other.unit.eql?(unit)
     end
 
-    # Instancitate a new unit
+    # Instantiate a new unit
     #
     # @param [Rational] scalar
     # @param [Enumerable] numerators
@@ -161,7 +159,7 @@ module AUOM
     #   # A complex unit
     #   u = Unit.new(Rational(1, 3), :euro, :meter)
     #   u.fractions? # => true
-    #   u.sclar      # => Rational(1, 3)
+    #   u.scalar     # => Rational(1, 3)
     #   u.inspect    # => <AUOM::Unit @scalar=~0.3333 euro/meter>
     #   u.unit       # => [[:euro], [:meter]]
     #
@@ -189,7 +187,7 @@ module AUOM
     #
     def assert_same_unit(other)
       unless same_unit?(other)
-        raise ArgumentError, 'Incompatible units'
+        fail ArgumentError, 'Incompatible units'
       end
 
       self
@@ -209,7 +207,7 @@ module AUOM
     def self.convert(operand)
       converted = try_convert(operand)
       unless converted
-        raise ArgumentError, "Cannot convert #{operand.inspect} to #{self}"
+        fail ArgumentError, "Cannot convert #{operand.inspect} to #{self}"
       end
       converted
     end
@@ -230,7 +228,7 @@ module AUOM
       case operand
       when self
         operand
-      when Fixnum, Rational
+      when Integer, Rational
         new(operand)
       end
     end
@@ -252,18 +250,18 @@ module AUOM
         left.delete_if { |item| right.delete_at(right.index(item) || right.length) }
       end
 
-      @numerators = numerators.freeze
+      @numerators   = numerators.freeze
       @denominators = denominators.freeze
 
-      @unit = [@numerators, @denominators].freeze
-      @scalar.freeze
+      @unit = [numerators, denominators].freeze
+      scalar.freeze
     end
 
     # Return rational converted from value
     #
     # @param [Object] value
     #
-    # @return [Rationa]
+    # @return [Rational]
     #
     # @raise [ArgumentError]
     #   raises argument error when cannot be converted to a rational
@@ -274,10 +272,10 @@ module AUOM
       case value
       when Rational
         value
-      when Fixnum
+      when Integer
         Rational(value)
       else
-        raise ArgumentError, "#{value.inspect} cannot be converted to rational"
+        fail ArgumentError, "#{value.inspect} cannot be converted to rational"
       end
     end
 
@@ -314,7 +312,7 @@ module AUOM
     #
     def self.lookup(value)
       units.fetch(value) do
-        raise ArgumentError, "Unknown unit #{value.inspect}"
+        fail ArgumentError, "Unknown unit #{value.inspect}"
       end
     end
 

data/spec/shared/incompatible_operation_behavior.rb

@@ -1,5 +1,3 @@
-# encoding: UTF-8
-
 shared_examples_for 'an incompatible operation' do
   it 'should raise ArgumentError' do
     expect { subject }.to raise_error(ArgumentError, 'Incompatible units')

data/spec/shared/operation_behavior.rb

@@ -1,13 +1,14 @@
-# encoding: UTF-8
-
 shared_examples_for 'an operation' do
   it 'returns a new object' do
-    object.should_not equal(subject)
+    expect(object).to_not equal(subject)
   end
 
   it 'is idempotent on equivalency' do
     first = subject
-    __memoized.delete(:subject)
+    fail unless RSpec.configuration.threadsafe?
+    mutex = __memoized.instance_variable_get(:@mutex)
+    memoized = __memoized.instance_variable_get(:@memoized)
+    mutex.synchronize { memoized.delete(:subject) }
     should eql(first)
   end
 

data/spec/shared/sunits_shared.rb

@@ -1,5 +1,3 @@
-# encoding: UTF-8
-
 shared_examples_for 'unitless unit' do
   its(:numerators)   { should == [] }
   its(:denominators) { should == [] }

data/spec/spec_helper.rb

@@ -1,5 +1,2 @@
-# encoding: UTF-8
-
 require 'auom'
-require 'devtools'
-Devtools.init_spec_helper
+require 'devtools/spec_helper'

data/spec/unit/auom/algebra/add_spec.rb

@@ -1,7 +1,3 @@
-# encoding: UTF-8
-
-require 'spec_helper'
-
 describe AUOM::Algebra, '#add' do
   subject { object.add(operand) }
 
@@ -10,22 +6,22 @@ describe AUOM::Algebra, '#add' do
   context 'when unit is unitless' do
     let(:arguments) { [1] }
 
-    context 'and operand is a Fixnum' do
-      let(:operand) { 1 }
+    context 'and operand is an Integer' do
+      let(:operand) { 2 }
 
       it_should_behave_like 'an operation'
 
-      it { should eql(AUOM::Unit.new(2)) }
+      it { should eql(AUOM::Unit.new(3)) }
     end
 
     context 'and operand is a unitless unit' do
-      let(:operand) { AUOM::Unit.new(1) }
+      let(:operand) { AUOM::Unit.new(2) }
 
-      it { should eql(AUOM::Unit.new(2)) }
+      it { should eql(AUOM::Unit.new(3)) }
     end
 
     context 'and operand is a unitful unit' do
-      let(:operand) { AUOM::Unit.new(1, :meter) }
+      let(:operand) { AUOM::Unit.new(2, :meter) }
 
       it_should_behave_like 'an incompatible operation'
     end
@@ -34,28 +30,28 @@ describe AUOM::Algebra, '#add' do
   context 'when unit is unitful' do
     let(:arguments) { [1, :meter, :euro] }
 
-    context 'and operand is a Fixnum' do
-      let(:operand) { 1 }
+    context 'and operand is an Integer' do
+      let(:operand) { 2 }
 
       it_should_behave_like 'an incompatible operation'
     end
 
     context 'and operand is a unitless unit' do
-      let(:operand) { AUOM::Unit.new(1) }
+      let(:operand) { AUOM::Unit.new(2) }
 
       it_should_behave_like 'an incompatible operation'
     end
 
     context 'and operand is a incompatible unit' do
-      let(:operand) { AUOM::Unit.new(1, :euro) }
+      let(:operand) { AUOM::Unit.new(2, :euro) }
 
       it_should_behave_like 'an incompatible operation'
     end
 
     context 'and operand is a compatible unit' do
-      let(:operand) { AUOM::Unit.new(1, :meter, :euro) }
+      let(:operand) { AUOM::Unit.new(2, :meter, :euro) }
 
-      it { should eql(AUOM::Unit.new(2, :meter, :euro)) }
+      it { should eql(AUOM::Unit.new(3, :meter, :euro)) }
     end
   end
 end

data/spec/unit/auom/algebra/divide_spec.rb

@@ -1,85 +1,83 @@
-# encoding: UTF-8
+describe AUOM::Algebra do
+  describe '#divide' do
+    subject { object.divide(operand) }
 
-require 'spec_helper'
+    let(:object) { AUOM::Unit.new(*arguments) }
 
-describe AUOM::Algebra, '#divide' do
-  subject { object.divide(operand) }
+    context 'with unitless unit' do
+      let(:arguments) { [4] }
 
-  let(:object) { AUOM::Unit.new(*arguments) }
+      context 'when operand is a fixnum' do
+        let(:operand) { 2 }
 
-  context 'with unitless unit' do
-    let(:arguments) { [4] }
-
-    context 'when operand is a fixnum' do
-      let(:operand) { 2 }
-
-      it_should_behave_like 'an operation'
+        it_should_behave_like 'an operation'
 
-      it { should eql(AUOM::Unit.new(2)) }
-    end
+        it { should eql(AUOM::Unit.new(2)) }
+      end
 
-    context 'when operand is a unitless unit' do
-      let(:operand) { AUOM::Unit.new(2) }
+      context 'when operand is a unitless unit' do
+        let(:operand) { AUOM::Unit.new(2) }
 
-      it_should_behave_like 'an operation'
+        it_should_behave_like 'an operation'
 
-      it { should eql(AUOM::Unit.new(2)) }
-    end
+        it { should eql(AUOM::Unit.new(2)) }
+      end
 
-    context 'when operand is a unitful unit' do
-      let(:operand) { AUOM::Unit.new(2, :meter) }
+      context 'when operand is a unitful unit' do
+        let(:operand) { AUOM::Unit.new(2, :meter) }
 
-      it_should_behave_like 'an operation'
+        it_should_behave_like 'an operation'
 
-      it { should eql(AUOM::Unit.new(2, [], :meter)) }
+        it { should eql(AUOM::Unit.new(2, [], :meter)) }
+      end
     end
-  end
 
-  context 'with unitful unit' do
-    let(:arguments) { [2, :meter] }
+    context 'with unitful unit' do
+      let(:arguments) { [2, :meter] }
 
-    context 'when operand is a fixnum' do
-      let(:operand) { 1 }
+      context 'when operand is a fixnum' do
+        let(:operand) { 1 }
 
-      it_should_behave_like 'an operation'
+        it_should_behave_like 'an operation'
 
-      it { should eql(AUOM::Unit.new(2, :meter)) }
-    end
+        it { should eql(AUOM::Unit.new(2, :meter)) }
+      end
 
-    context 'when operand is a unitless unit' do
-      let(:operand) { AUOM::Unit.new(1) }
+      context 'when operand is a unitless unit' do
+        let(:operand) { AUOM::Unit.new(1) }
 
-      it_should_behave_like 'an operation'
+        it_should_behave_like 'an operation'
 
-      it { should eql(AUOM::Unit.new(2, :meter)) }
-    end
+        it { should eql(AUOM::Unit.new(2, :meter)) }
+      end
 
-    context 'when operand is a unitful unit' do
+      context 'when operand is a unitful unit' do
 
-      context 'and units get added to denominator' do
-        let(:operand) { AUOM::Unit.new(1, :euro) }
+        context 'and units get added to denominator' do
+          let(:operand) { AUOM::Unit.new(1, :euro) }
 
-        it_should_behave_like 'an operation'
+          it_should_behave_like 'an operation'
 
-        it { should eql(AUOM::Unit.new(2, :meter, :euro)) }
-      end
+          it { should eql(AUOM::Unit.new(2, :meter, :euro)) }
+        end
 
-      context 'and units get added to numerator' do
-        let(:operand) { AUOM::Unit.new(1, nil, :euro) }
+        context 'and units get added to numerator' do
+          let(:operand) { AUOM::Unit.new(1, nil, :euro) }
 
-        it_should_behave_like 'an operation'
+          it_should_behave_like 'an operation'
 
-        it { should eql(AUOM::Unit.new(2, [:euro, :meter])) }
-      end
+          it { should eql(AUOM::Unit.new(2, %i[euro meter])) }
+        end
 
-      context 'and units cancle each other' do
-        let(:operand) { AUOM::Unit.new(1, :meter) }
+        context 'and units cancel each other' do
+          let(:operand) { AUOM::Unit.new(1, :meter) }
 
-        it_should_behave_like 'an operation'
+          it_should_behave_like 'an operation'
 
-        it { should eql(AUOM::Unit.new(2)) }
-      end
+          it { should eql(AUOM::Unit.new(2)) }
+        end
 
+      end
     end
   end
 end