auom 0.0.6 → 0.1.0

data/.circle.yml

@@ -0,0 +1,4 @@
+---
+test:
+  override: 
+    - bundle exec rake ci

data/.rubocop.yml

@@ -0,0 +1,7 @@
+AllCops:
+  Includes:
+    - 'Gemfile'
+  Excludes:
+    - 'Gemfile.devtools'
+    - 'vendor/**'
+    - 'benchmarks/**'

data/.travis.yml

@@ -1,13 +1,6 @@
 language: ruby
 script: 'bundle exec rake ci'
 rvm:
-  - 1.8.7
   - 1.9.3
-  - 1.9.2
-  - jruby-18mode
-  - jruby-19mode 
-  - rbx-18mode
-  - rbx-19mode
-notifications:
-  email:
-    - mbj@seonic.net
+  - jruby-19mode
+  - rbx

data/Changelog.md

@@ -1,3 +1,7 @@
+# v0.1.0 2014-03-24
+
+* [breaking-change] Drop support for 1.8
+
 # v0.0.6 2013-01-03
 
 * [change] Update dependencies

data/Gemfile

@@ -4,5 +4,5 @@ source 'https://rubygems.org'
 
 gemspec
 
-gem 'devtools', :git => 'https://github.com/datamapper/devtools'
-eval File.read('Gemfile.devtools')
+gem 'devtools', git: 'https://github.com/rom-rb/devtools.git'
+eval_gemfile 'Gemfile.devtools'

data/Gemfile.devtools

@@ -1,55 +1,62 @@
 # encoding: utf-8
 
 group :development do
-  gem 'rake',  '~> 10.0.3'
-  gem 'rspec', '~> 2.13.0'
-  gem 'yard',  '~> 0.8.5'
+  gem 'rake',       '~> 10.1.0'
+  gem 'rspec',      '~> 2.14.1'
+  gem 'rspec-core', '~> 2.14.8'
+  gem 'yard',       '~> 0.8.7'
+
+  platform :rbx do
+    gem 'rubysl-singleton', '~> 2.0.0'
+  end
 end
 
 group :yard do
-  gem 'kramdown', '~> 0.14.2'
+  gem 'kramdown', '~> 1.3.2'
 end
 
 group :guard do
-  gem 'guard',         '~> 1.6.2'
-  gem 'guard-bundler', '~> 1.0.0'
-  gem 'guard-rspec',   '~> 2.4.1'
+  gem 'guard',         '~> 2.4.0'
+  gem 'guard-bundler', '~> 2.0.0'
+  gem 'guard-rspec',   '~> 4.2.6'
+  gem 'guard-rubocop', '~> 1.0.2'
 
   # file system change event handling
-  gem 'rb-fchange', '~> 0.0.6', :require => false
-  gem 'rb-fsevent', '~> 0.9.3', :require => false
-  gem 'rb-inotify', '~> 0.9.0', :require => false
-
-  gem 'listen', '~> 0.7.3'
+  gem 'listen',     '~> 2.5.0'
+  gem 'rb-fchange', '~> 0.0.6', require: false
+  gem 'rb-fsevent', '~> 0.9.3', require: false
+  gem 'rb-inotify', '~> 0.9.0', require: false
 
   # notification handling
-  gem 'libnotify',               '~> 0.8.0', :require => false
-  gem 'rb-notifu',               '~> 0.0.4', :require => false
-  gem 'terminal-notifier-guard', '~> 1.5.3', :require => false
+  gem 'libnotify',               '~> 0.8.0', require: false
+  gem 'rb-notifu',               '~> 0.0.4', require: false
+  gem 'terminal-notifier-guard', '~> 1.5.3', require: false
 end
 
 group :metrics do
-  gem 'flay',            '~> 2.1.0'
-  gem 'flog',            '~> 3.2.2'
-  gem 'reek',            '~> 1.3.1'
-  gem 'metric_fu-roodi', '~> 2.2.1'
-  gem 'yardstick',       '~> 0.9.4'
+  gem 'coveralls', '~> 0.7.0'
+  gem 'flay',      '~> 2.4.0'
+  gem 'flog',      '~> 4.2.0'
+  gem 'reek',      '~> 1.3.2'
+  gem 'rubocop',   '~> 0.18.1'
+  gem 'simplecov', '~> 0.8.2'
+  gem 'yardstick', '~> 0.9.9'
 
-  platforms :ruby_18, :ruby_19 do
-    # this indirectly depends on ffi which does not build on ruby-head
-    gem 'yard-spellcheck', '~> 0.1.5'
+  platforms :mri do
+    gem 'mutant',       '~> 0.5.7'
+    gem 'mutant-rspec', '~> 0.5.3'
   end
 
-  platforms :mri_19, :rbx do
-    gem 'mutant', '~> 0.2.20'
-  end
-
-  platforms :mri_19 do
-    gem 'simplecov', '~> 0.7.1'
+  platforms :ruby_19, :ruby_20 do
+    gem 'yard-spellcheck', '~> 0.1.5'
   end
 
-  platforms :rbx do
-    gem 'pelusa', '~> 0.2.2'
+  platform :rbx do
+    gem 'json',               '~> 1.8.1'
+    gem 'racc',               '~> 1.4'
+    gem 'rubysl-logger',      '~> 2.0.0'
+    gem 'rubysl-open-uri',    '~> 2.0.0'
+    gem 'rubysl-prettyprint', '~> 2.0.2'
   end
 end
 
@@ -59,6 +66,6 @@ end
 
 platform :jruby do
   group :jruby do
-    gem 'jruby-openssl', '~> 0.8.2'
+    gem 'jruby-openssl', '~> 0.8.5'
   end
 end

data/auom.gemspec

@@ -2,10 +2,10 @@
 
 Gem::Specification.new do |s|
   s.name = 'auom'
-  s.version = '0.0.6'
+  s.version = '0.1.0'
 
   s.authors  = ['Markus Schirp']
-  s.email    = 'mbj@seonic.net'
+  s.email    = 'mbj@schirp-dso.com'
   s.summary  = 'Algebra (with) Units Of Measurement'
   s.homepage = 'http://github.com/mbj/auom'
 
@@ -16,6 +16,5 @@ Gem::Specification.new do |s|
 
   s.rubygems_version = '1.8.10'
 
-  s.add_dependency('backports', [ '~> 3.0', '>= 3.0.3' ])
-  s.add_dependency('equalizer', '~> 0.0.5')
+  s.add_dependency('equalizer', '~> 0.0.9')
 end

data/circle.yml

@@ -0,0 +1,4 @@
+---
+test:
+  override:
+    - bundle exec rake ci

data/config/flay.yml

@@ -1,3 +1,3 @@
 ---
 threshold: 12
-total_score: 99.0
+total_score: 87.0

data/config/{site.reek → reek.yml}

@@ -6,7 +6,7 @@ UncommunicativeParameterName:
   - !ruby/regexp /^.$/
   - !ruby/regexp /[0-9]$/
   - !ruby/regexp /[A-Z]/
-LargeClass:
+TooManyMethods:
   max_methods: 14
   enabled: true
   exclude: []
@@ -21,7 +21,7 @@ UncommunicativeMethodName:
   - !ruby/regexp /[A-Z]/
 LongParameterList:
   max_params: 2
-  exclude: 
+  exclude:
     - "AUOM::Unit#initialize"   # 3 params
     - "AUOM::Unit#self.new"     # 3 params
     - "AUOM::Unit#self.resolve" # 3 params
@@ -48,16 +48,16 @@ UncommunicativeModuleName:
   - !ruby/regexp /[0-9]$/
 NestedIterators:
   ignore_iterators: []
-  exclude: 
+  exclude:
    - AUOM::Unit#initialize # 2 levels
   enabled: true
   max_allowed_nesting: 1
-LongMethod:
-  max_statements: 5
-  exclude: 
+TooManyStatements:
+  max_statements: 6
+  exclude:
     - "AUOM::Inspection#pretty_unit" # 7 statements
   enabled: true
-Duplication:
+DuplicateMethodCall:
   allow_calls: []
   exclude:
     - "AUOM::ClassMethods#new"     # invalid detection
@@ -78,16 +78,17 @@ UncommunicativeVariableName:
   - !ruby/regexp /^.$/
   - !ruby/regexp /[0-9]$/
   - !ruby/regexp /[A-Z]/
-SimulatedPolymorphism:
+RepeatedConditional:
   enabled: true
   max_ifs: 1
 DataClump:
   exclude: []
   enabled: true
-  max_copies: 0
+  max_copies: 1
   min_clump_size: 2
-ControlCouple:
-  exclude: []
+ControlParameter:
+  exclude:
+    - AUOM::Unit#assert_same_unit
   enabled: true
 LongYieldList:
   max_params: 0

data/config/rubocop.yml

@@ -0,0 +1,89 @@
+inherit_from: ../.rubocop.yml
+
+# General note about rubocop.
+# It does NOT allow to silence a specific rule violation.
+# For that reason I sometimes have to disable a whole cop where
+# I just tried to whitelist a specific occurence.
+
+
+AllCops:
+  Includes:
+    - '../**/*.rake'
+    - 'Gemfile'
+    - 'Gemfile.triage'
+    - 'mutant.gemspec'
+
+# Avoid parameter lists longer than five parameters.
+ParameterLists:
+  Max: 3
+  CountKeywordArgs: true
+
+# Avoid more than `Max` levels of nesting.
+BlockNesting:
+  Max: 3
+
+# Align with the style guide.
+CollectionMethods:
+  PreferredMethods:
+    collect:  'map'
+    inject:   'reduce'
+    find:     'detect'
+    find_all: 'select'
+
+MethodLength:
+  CountComments: false
+  Max: 17 # TODO: Bring down to 10
+
+RegexpLiteral: # I do not agree %r(\A) is more readable than /\A/
+  Enabled: false
+
+# Limit line length
+LineLength:
+  Max: 124  # TODO: lower to 79
+
+# Disable documentation checking until a class needs to be documented once
+Documentation:
+  Enabled: false
+
+# Do not favor modifier if/unless usage when you have a single-line body
+IfUnlessModifier:
+  Enabled: false
+
+# Allow case equality operator (in limited use within the specs)
+CaseEquality:
+  Enabled: false
+
+# Constants do not always have to use SCREAMING_SNAKE_CASE
+ConstantName:
+  Enabled: false
+
+# Not all trivial readers/writers can be defined with attr_* methods
+TrivialAccessors:
+  Enabled: false
+
+# And also have a differend opinion here
+AndOr:
+  Enabled: false
+
+# I like my raise
+SignalException:
+  Enabled: false
+
+# I need to chain optparse builder, else it is more ugly
+MultilineBlockChain:
+  Enabled: false
+
+ClassLength:
+  Max: 119
+
+# I align private keywords with class body
+IndentationWidth:
+  Enabled: false
+
+# I like to have an empty line before closing the currently opened body
+EmptyLinesAroundBody:
+  Enabled: false
+
+# I like my style more
+AccessModifierIndentation:
+  Enabled: false

data/lib/auom.rb

@@ -1,332 +1,14 @@
+# encoding: UTF-8
+
 require 'rational'
-require 'backports'
 require 'equalizer'
 
+# Library namespace
+module AUOM
+end
+
 require 'auom/algebra'
 require 'auom/equalization'
 require 'auom/inspection'
 require 'auom/relational'
-
-# Library namespace
-module AUOM
-  # A scalar with units
-  class Unit
-    include Equalizer.new(:scalar, :numerators, :denominators)
-    include Algebra
-    include Equalization
-    include Inspection
-    include Relational
-
-    # 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
-
-    # 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
-    # @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
-
-    # 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
-
-    # 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
-        new(operand)
-      else
-        nil
-      end
-    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 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)
-      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
+require 'auom/unit'