auom 0.0.3

data/.gitignore

@@ -0,0 +1,3 @@
+/Gemfile.lock
+/tmp
+/coverage

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+script: 'bundle exec rake spec'
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  # - jruby-18mode Disabled for core dump on travis http://travis-ci.org/#!/mbj/veritas-elasticsearch-adapter/jobs/1769741
+  # - jruby-19mode Disabled for core dump on travis http://travis-ci.org/#!/mbj/veritas-elasticsearch-adapter/jobs/1768119
+  - rbx-18mode
+  - rbx-19mode
+notifications:
+  email:
+    - mbj@seonic.net

data/Gemfile

@@ -0,0 +1,10 @@
+# encoding: utf-8
+
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'devtools', :git => 'https://github.com/mbj/devtools'
+end
+eval File.read('Gemfile.devtools')

data/Gemfile.devtools

@@ -0,0 +1,52 @@
+group :development do 
+  gem 'rake',    '~> 0.9.2'
+  gem 'rspec',   '~> 1.3.2'
+  gem 'yard',    '~> 0.8.3'
+end
+
+group :guard do
+  gem 'guard',         '~> 1.1.1'
+  gem 'guard-bundler', '~> 0.1.3'
+  gem 'guard-rspec',   '~> 0.7.3'
+  gem 'rb-inotify', :git => 'https://github.com/mbj/rb-inotify'
+end
+
+group :benchmarks do
+  gem 'rbench', '~> 0.2.3'
+end
+
+platform :jruby do
+  group :jruby do
+    gem 'jruby-openssl', '~> 0.7.4'
+  end
+end
+
+group :metrics do
+  gem 'flay',      '~> 1.4.2'
+  gem 'flog',      '~> 2.5.1'
+  gem 'reek',      '~> 1.2.8', :git => 'https://github.com/dkubb/reek.git'
+  gem 'roodi',     '~> 2.1.0'
+  gem 'yardstick', '~> 0.7.0'
+  gem 'simplecov'
+
+  platforms :ruby_18, :ruby_19 do
+    # this indirectly depends on ffi which does not build on ruby-head
+    gem 'yard-spellcheck', '~> 0.1.5'
+  end
+
+  platforms :mri_18 do
+    gem 'arrayfields', '~> 4.7.4'  # for metric_fu
+    gem 'fattr',       '~> 2.2.0'  # for metric_fu
+    gem 'heckle',      '~> 1.4.3'
+    gem 'json',        '~> 1.7.3'  # for metric_fu rake task
+    gem 'map',         '~> 6.0.1'  # for metric_fu
+    gem 'metric_fu',   '~> 2.1.1'
+    gem 'mspec',       '~> 1.5.17'
+    gem 'rcov',        '~> 1.0.0'
+    gem 'ruby2ruby',   '= 1.2.2'   # for heckle
+  end
+
+  platforms :rbx do
+    gem 'pelusa', '~> 0.2.1'
+  end
+end

data/Guardfile

@@ -0,0 +1,8 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :version => 1 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Markus Schirp
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,92 @@
+AUOM Algebra (for) Units of Measuerment
+=======================================
+
+[![Build Status](https://secure.travis-ci.org/mbj/auom.png?branch=master)](http://travis-ci.org/mbj/auom)
+[![Dependency Status](https://gemnasium.com/mbj/auom.png)](https://gemnasium.com/mbj/auom)
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/mbj/auom)
+
+This is another unit system for ruby.
+It was created since I was not confident about the existing once.
+
+Features:
+
+* No unit conversions 
+* No core patches (Especially does not require mathn!)
+* Dependency free.
+* Functional implementation style.
+* No magic coercion from number like strings to numbers.
+* Will never loose precision (Uses rational as scalar internally)
+* Allows namespacing of unit systems via subclass.
+* Well tested (100% heckle coverage)
+
+The default set of predefined units is miminal as this library should be used in an application 
+specific subclass. Override: ```AUOR::Unit.units```
+
+Installation
+------------
+
+In your **Gemfile**
+
+``` ruby
+gem 'auom', :git => 'https://github.com/mbj/auom'
+```
+
+Examples
+--------
+
+``` ruby
+
+# Create a unit
+require 'auom'
+
+include AUOM
+
+u = Unit.new(1, :meter) # <AUOM::Unit @scalar=1 meter>
+u * 100                 # <AUOM::Unit @scalar=100 meter>
+u / Unit.new(10,:meter) # <AUOM::Unit @scalar=0.1>
+u * Unit.new(10,:meter) # <AUOM::Unit @scalar=10 meter^2>
+u * Unit.new(1, :euro)  # <AUOM::Unit @scalar=1 euro*meter>
+u - Unit.new(1, :meter) # <AUOM::Unit @scalar=0 meter>
+u + Unit.new(1, :meter) # <AUOM::Unit @scalar=2 meter>
+u + Unit.new(1, :euro)  # raises error about incompatible units
+```
+
+Credits
+-------
+
+Room for your name!
+
+Contributing
+-------------
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with Rakefile or version
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+License
+-------
+
+Copyright (c) 2012 Markus Schirp
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,5 @@
+# encoding: utf-8
+
+require 'devtools'
+
+Devtools.init

data/TODO

@@ -0,0 +1,3 @@
+* Remove more custom typecasting logic? Can we coerce to SUnit::Unit?
+* Use code metrics
+* Make buildin units configurable

data/auom.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/auom/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name = 'auom'
+  s.version = AUOM::VERSION.dup
+
+  s.authors  = ['Markus Schirp']
+  s.email    = 'mbj@seonic.net'
+  s.summary  = 'Algebra (with) Units Of Measurement'
+  s.homepage = 'http://github.com/mbj/auom'
+
+  s.files            = `git ls-files`.split("\n")
+  s.test_files       = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_paths    = %w(lib)
+  s.extra_rdoc_files = %w(TODO LICENSE)
+
+  s.rubygems_version = '1.8.10'
+
+  s.add_runtime_dependency('backports', '~> 2.6.3')
+end

data/config/flay.yml

@@ -0,0 +1,3 @@
+---
+threshold: 12.0
+total_score: 68.0

data/config/flog.yml

@@ -0,0 +1,2 @@
+---
+threshold: 24.6

data/config/heckle.yml

@@ -0,0 +1,9 @@
+---
+library: auom
+namespace: AUOM
+aliases:
+  AUOM::Algebra: 
+   '-': substract
+   '+': add
+   '*': multiply
+   '/': divide

data/config/roodi.yml

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

data/config/site.reek

@@ -0,0 +1,95 @@
+UncommunicativeParameterName:
+  accept: []
+  exclude: []
+  enabled: true
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+LargeClass:
+  max_methods: 14
+  enabled: true
+  exclude: []
+  max_instance_variables: 4
+UncommunicativeMethodName:
+  accept: []
+  exclude: []
+  enabled: true
+  reject:
+  - !ruby/regexp /^[a-z]$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+LongParameterList:
+  max_params: 2
+  exclude: 
+    - "AUOM::Unit#initialize"   # 3 params
+    - "AUOM::Unit#self.new"     # 3 params
+    - "AUOM::Unit#self.resolve" # 3 params
+  enabled: true
+  overrides: {}
+FeatureEnvy:
+  exclude: []
+  enabled: true
+ClassVariable:
+  exclude: []
+  enabled: true
+BooleanParameter:
+  exclude: []
+  enabled: true
+IrresponsibleModule:
+  exclude: []
+  enabled: true
+UncommunicativeModuleName:
+  accept: []
+  exclude: []
+  enabled: true
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+NestedIterators:
+  ignore_iterators: []
+  exclude: 
+   - AUOM::Unit#initialize # 2 levels
+  enabled: true
+  max_allowed_nesting: 1
+LongMethod:
+  max_statements: 5
+  exclude: 
+    - "AUOM::Inspection#pretty_unit" # 7 statements
+  enabled: true
+Duplication:
+  allow_calls: []
+  exclude:
+    - "AUOM::ClassMethods#new"     # invalid detection
+  enabled: true
+  max_calls: 1
+UtilityFunction:
+  max_helper_calls: 0
+  exclude: []
+  enabled: true
+Attribute:
+  exclude: []
+  enabled: false
+UncommunicativeVariableName:
+  accept: []
+  exclude: []
+  enabled: true
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+SimulatedPolymorphism:
+  enabled: true
+  max_ifs: 1
+DataClump:
+  exclude: []
+  enabled: true
+  max_copies: 0
+  min_clump_size: 2
+ControlCouple:
+  exclude: []
+  enabled: true
+LongYieldList:
+  max_params: 0
+  exclude: []
+  enabled: true

data/config/yardstick.yml

@@ -0,0 +1,2 @@
+---
+threshold: 100

data/lib/auom.rb

@@ -0,0 +1,287 @@
+require 'rational'
+require 'backports'
+
+require 'auom/algebra'
+require 'auom/equalization'
+require 'auom/inspection'
+
+# Library namespace
+module AUOM
+  # A scalar with units
+  class Unit
+    include Algebra
+    include Equalization
+    include Inspection
+
+    # Return scalar
+    #
+    # @example
+    #
+    #   include AUOM
+    #   m = Unit.new(1, :meter)
+    #   m.scalar # => Rational(1, 1)
+    #
+    # @return [Rational]
+    #
+    # @api public
+    #
+    attr_reader :scalar
+
+    # Return numerators
+    #
+    # @example
+    #
+    #   include AUOM
+    #   m = Unit.new(1, :meter)
+    #   m.numerators # => [:meter]
+    #
+    # @return [Rational]
+    #
+    # @api public
+    #
+    attr_reader :numerators
+
+    # Return denominators
+    #
+    # @example
+    #
+    #   include AUOM
+    #   m = Unit.new(1, :meter)
+    #   m.denoninators # => []
+    #
+    # @return [Rational]
+    #
+    # @api public
+    #
+    attr_reader :denominators
+
+    # Return unit descriptor
+    #
+    # @return [Array]
+    #
+    # @api public
+    #
+    # @example
+    #
+    #   u = Unit.new(1, [:meter, :meter], :euro)
+    #   u.unit # => [[:meter, :meter], [:euro]]
+    #
+    attr_reader :unit
+
+    # These constants can easily be changed
+    # by an application specific subclass that overrides
+    # AUOM::Unit.units with an own hash!
+    UNITS = {
+      :item =>      [1, :item],
+      :liter =>     [1, :liter],
+      :pack =>      [1, :pack],
+      :can =>       [1, :can],
+      :kilogramm => [1, :kilogramm],
+      :euro =>      [1, :euro],
+      :meter =>     [1, :meter],
+      :kilometer => [1000, :meter]
+    }.freeze
+
+    # Return buildin units symbols
+    #
+    # @return [Hash]
+    #
+    # @api private
+    #
+    def self.units
+      UNITS
+    end
+
+    # Check for unitless unit
+    #
+    # @return [true]
+    #   return true if unit is unitless
+    #
+    # @return [false]
+    #   return false if unit is NOT unitless
+    #
+    # @example
+    #
+    #   Unit.new(1).unitless?         # => true
+    #   Unit.new(1, :meter).unitless ? # => false
+    #
+    # @api public
+    #
+    def unitless?
+      numerators.empty? and denominators.empty?
+    end
+
+    # Instancitate a new unit
+    #
+    # @param [Rational] scalar
+    # @param [Enumerable] numerators
+    # @param [Enumerable] denominators
+    #
+    # @return [Unit]
+    #
+    # @example
+    #   
+    #   # A unitless unit
+    #   u = Unit.new(1)
+    #   u.unitless? # => true
+    #   u.scalar    # => Rational(1, 1)
+    #
+    #   # A unitless unit from string
+    #   u = Unit.new('1.5')
+    #   u.unitless? # => true
+    #   u.scalar    # => Rational(3, 2)
+    #
+    #   # A simple unit
+    #   u = Unit.new(1, :meter)
+    #   u.unitless?  # => false
+    #   u.numerators # => [:meter]
+    #   u.scalar     # => Rational(1, 1)
+    #
+    #   # A complex unit
+    #   u = Unit.new(Rational(1, 3), :euro, :meter)
+    #   u.fractions? # => true
+    #   u.sclar      # => Rational(1, 3)
+    #   u.inspect    # => <AUOM::Unit @scalar=~0.3333 euro/meter>
+    #   u.unit       # => [[:euro], [:meter]]
+    #
+    # @api public
+    #
+    def self.new(scalar, numerators=[], denominators=[])
+      scalar = rational(scalar)
+
+      scalar, numerators   = resolve([*numerators], scalar, :*)
+      scalar, denominators = resolve([*denominators], scalar, :/)
+
+      # sorting on #to_s as Symbol#<=> is not present on 1.8.7
+      super(scalar, *[numerators, denominators].map { |base| base.sort_by(&:to_s) }).freeze
+    end
+
+  private
+
+    # Initialize unit
+    #
+    # @param [Rational] scalar
+    # @param [Enumerable] numerators
+    # @param [Enumerable] denominators
+    #
+    # @api private
+    #
+    def initialize(scalar, numerators, denominators)
+      @scalar = scalar
+
+      [numerators, denominators].permutation do |left, right|
+        left.delete_if { |item| right.delete_at(right.index(item) || right.length) }
+      end
+
+      @numerators = numerators.freeze
+      @denominators = denominators.freeze
+
+      @unit = [@numerators, @denominators].freeze
+      @scalar.freeze
+    end
+
+
+    # Return converted operand or raise error
+    #
+    # @param [Object] operand
+    #
+    # @return [Unit]
+    #
+    # @raise [ArgumentError]
+    #   raises argument error in case operand cannot be converted
+    #
+    # @api private
+    #
+    def self.convert(operand)
+      converted = try_convert(operand)
+      unless converted
+        raise ArgumentError, "Cannot convert #{operand.inspect} to #{self}"
+      end
+      converted
+    end
+
+    # Return converted operand or nil
+    #
+    # @param [Object] operand
+    #
+    # @return [Unit]
+    #   return unit in case operand can be converted
+    #
+    # @return [nil]
+    #   return nil in case operand can NOT be converted
+    #
+    # @api private
+    #
+    def self.try_convert(operand)
+      case operand
+      when self
+        operand
+      when Fixnum, Rational
+        self.new(operand)
+      else
+        nil
+      end
+    end
+
+    # Return rational converted from value
+    #
+    # @param [Object] value
+    #
+    # @return [Rationa]
+    #
+    # @raise [ArgumentError]
+    #   raises argument error when cannot be converted to a rational
+    #
+    # @api private
+    #
+    def self.rational(value)
+      case value
+      when Rational
+        value
+      when Fixnum
+        Rational(value, 1)
+      else
+        raise ArgumentError, "#{value.inspect} cannot be converted to rational"
+      end
+    end
+
+    private_class_method :rational
+
+    # Resolve unit component
+    #
+    # @param [Enumerable] components
+    # @param [Symbol] operation
+    #
+    # @return [Array]
+    #
+    # @api private
+    #
+    def self.resolve(components, scalar, operation)
+      resolved = components.map do |component|
+        scale, component = lookup(component)
+        scalar = scalar.send(operation, scale) 
+        component
+      end
+      [scalar, resolved]
+    end
+
+    private_class_method :resolve
+
+    # Return unit information
+    #
+    # @param [Symbol] value
+    #   the unit to search for 
+    #
+    # @return [Array]
+    #
+    # @api private
+    #
+    def self.lookup(value)
+      units.fetch(value) do
+        raise ArgumentError, "Unknown unit #{value.inspect}"
+      end
+    end
+
+    private_class_method :lookup
+  end
+end