auom 0.1.0 → 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0052fcab4f594eaadb81ddb9c50b5383a1f6ccbe
+  data.tar.gz: 7dee775c276bad51bfa0b8a926b022278f2c008b
+SHA512:
+  metadata.gz: 010b60063558dc2268e38fd1af143492334a37f45a5613e52bfb052a2bee8337305ff1df52ebf5ec8d35aca7db1d92185ca6b7fa9f10aba0aef1d12a75f037c8
+  data.tar.gz: 4db585b70f9db889c5ff9e39a1afb4793bec6d3d62e2dd710661d29711af67c3b3cbb0874a98057b3ad3675755bc1cbed0969d3cae570050a29c6f0ab06b5067

data/.rspec

@@ -1 +1,2 @@
 --color
+--require spec_helper

data/.rubocop.yml

@@ -1,7 +1,3 @@
 AllCops:
-  Includes:
-    - 'Gemfile'
-  Excludes:
-    - 'Gemfile.devtools'
-    - 'vendor/**'
-    - 'benchmarks/**'
+  DisplayCopNames: true
+  TargetRubyVersion: 2.2

data/.travis.yml

@@ -1,6 +1,9 @@
 language: ruby
 script: 'bundle exec rake ci'
 rvm:
-  - 1.9.3
-  - jruby-19mode
+  - 2.1
   - rbx
+matrix:
+  include:
+    - rvm: jruby
+      env: JRUBY_OPTS="$JRUBY_OPTS --debug --2.0"

data/Changelog.md

@@ -1,3 +1,7 @@
+# v0.2.0 2017-09-29
+
+* [breaking-change] Drop support for < 2.4
+
 # v0.1.0 2014-03-24
 
 * [breaking-change] Drop support for 1.8
@@ -12,7 +16,7 @@
 
 # v0.0.4 2012-11-20
 
-* [feature] Support for relational operatiors >, <, >= and <=
+* [feature] Support for relational operators >, <, >= and <=
 
 [Compare v0.0.3..v0.0.4](https://github.com/mbj/auom/compare/v0.0.3...v0.0.4)
 

data/Gemfile

@@ -1,8 +1,3 @@
-# encoding: utf-8
-
 source 'https://rubygems.org'
 
 gemspec
-
-gem 'devtools', git: 'https://github.com/rom-rb/devtools.git'
-eval_gemfile 'Gemfile.devtools'

data/README.md

@@ -1,4 +1,4 @@
-AUOM Algebra (for) Units of Measuerment
+AUOM Algebra (for) Units of Measurement
 =======================================
 
 [![Build Status](https://secure.travis-ci.org/mbj/auom.png?branch=master)](http://travis-ci.org/mbj/auom)
@@ -6,7 +6,7 @@ AUOM Algebra (for) Units of Measuerment
 [![Code Climate](https://codeclimate.com/github/mbj/auom.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.
+It was created since I was not confident about the existing ones.
 
 Features:
 
@@ -17,38 +17,33 @@ Features:
 * 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)
+* Well tested (100% mutation coverage via [mutant](https://github.com/mbj/mutant))
 
-The default set of predefined units is miminal as this library should be used in an application 
-specific subclass. Override: ```AUOR::Unit.units```
+The default set of predefined units is minimal as this library should be used in an application
+specific subclass. Override: ```AUOM::Unit.units```
 
 Installation
 ------------
 
-In your **Gemfile**
-
-``` ruby
-gem 'auom', :git => 'https://github.com/mbj/auom'
-```
+Install the gem `auom` via your preferred method.
 
 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
+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, :meter ]) # <AUOM::Unit @scaler=0.1 1/meter>
+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
@@ -70,6 +65,6 @@ Contributing
 Copyright
 ---------
 
-Copyright (c) 2012 Markus Schirp
+Copyright (c) 2014 Markus Schirp
 
-See LICENSE for details
+See `LICENSE` for details

data/TODO

@@ -1 +1 @@
-* Make buildin units configurable
+* Make built-in units configurable

data/auom.gemspec

@@ -1,20 +1,20 @@
-# -*- encoding: utf-8 -*-
+Gem::Specification.new do |gem|
+  gem.name = 'auom'
+  gem.version = '0.2.0'
 
-Gem::Specification.new do |s|
-  s.name = 'auom'
-  s.version = '0.1.0'
+  gem.authors  = ['Markus Schirp']
+  gem.email    = 'mbj@schirp-dso.com'
+  gem.summary  = 'Algebra (with) Units Of Measurement'
+  gem.homepage = 'http://github.com/mbj/auom'
 
-  s.authors  = ['Markus Schirp']
-  s.email    = 'mbj@schirp-dso.com'
-  s.summary  = 'Algebra (with) Units Of Measurement'
-  s.homepage = 'http://github.com/mbj/auom'
+  gem.files            = `git ls-files`.split("\n")
+  gem.test_files       = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.require_paths    = %w[lib]
+  gem.extra_rdoc_files = %w[TODO LICENSE]
 
-  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)
+  gem.required_ruby_version = '>= 2.4'
 
-  s.rubygems_version = '1.8.10'
+  gem.add_dependency('equalizer', '~> 0.0.9')
 
-  s.add_dependency('equalizer', '~> 0.0.9')
+  gem.add_development_dependency('devtools', '~> 0.1.12')
 end

data/circle.yml

@@ -1,4 +1,7 @@
 ---
+machine:
+  ruby:
+    version: '2.4.2'
 test:
   override:
     - bundle exec rake ci

data/config/flay.yml

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

data/config/flog.yml

@@ -1,2 +1,2 @@
 ---
-threshold: 20.6
+threshold: 15.1

data/config/reek.yml

@@ -55,7 +55,8 @@ NestedIterators:
 TooManyStatements:
   max_statements: 6
   exclude:
-    - "AUOM::Inspection#pretty_unit" # 7 statements
+    - AUOM::Inspection#pretty_unit # 7 statements
+    - AUOM::Unit#initialize # 8 statements
   enabled: true
 DuplicateMethodCall:
   allow_calls: []

data/config/rubocop.yml

@@ -1,18 +1,5 @@
 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
@@ -24,27 +11,36 @@ BlockNesting:
 
 # Align with the style guide.
 CollectionMethods:
+  Enabled: true
   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
+AccessModifierIndentation:
+  EnforcedStyle: outdent
 
 # Limit line length
 LineLength:
-  Max: 124  # TODO: lower to 79
+  Max: 120
 
 # Disable documentation checking until a class needs to be documented once
 Documentation:
   Enabled: false
 
+# Permit
+#
+#     boolean_check? or fail
+#
+# Reject
+#
+#     if foo or bar
+#       ...
+#     end
+AndOr:
+  EnforcedStyle: conditionals
+
 # Do not favor modifier if/unless usage when you have a single-line body
 IfUnlessModifier:
   Enabled: false
@@ -61,29 +57,129 @@ ConstantName:
 TrivialAccessors:
   Enabled: false
 
-# And also have a differend opinion here
-AndOr:
+# Allow empty lines around class body
+EmptyLinesAroundClassBody:
   Enabled: false
 
-# I like my raise
-SignalException:
+# Allow empty lines around module body
+EmptyLinesAroundModuleBody:
+  Enabled: false
+
+# Allow empty lines around block body
+EmptyLinesAroundBlockBody:
   Enabled: false
 
-# I need to chain optparse builder, else it is more ugly
-MultilineBlockChain:
+# Allow multiple line operations to not require indentation
+MultilineOperationIndentation:
   Enabled: false
 
-ClassLength:
-  Max: 119
+# Prefer String#% over Kernel#sprintf
+FormatString:
+  EnforcedStyle: format
+
+# Use square brackets for literal Array objects
+PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%':  '{}'
+    '%i': '[]'
+    '%q': ()
+    '%Q': ()
+    '%r': '{}'
+    '%s': ()
+    '%w': '[]'
+    '%W': '[]'
+    '%x': ()
+
+# Use %i[...] for arrays of symbols
+SymbolArray:
+  Enabled: true
+
+# Align if/else blocks with the variable assignment
+EndAlignment:
+  EnforcedStyleAlignWith: variable
+
+# Prefer #kind_of? over #is_a?
+ClassCheck:
+  EnforcedStyle: kind_of?
+
+# Do not prefer double quotes to be used when %q or %Q is more appropriate
+UnneededPercentQ:
+  Enabled: false
+
+# Allow a maximum ABC score
+Metrics/AbcSize:
+  Max: 21.02
 
-# I align private keywords with class body
-IndentationWidth:
+Metrics/BlockLength:
   Enabled: false
 
-# I like to have an empty line before closing the currently opened body
-EmptyLinesAroundBody:
+# Do not prefer lambda.call(...) over lambda.(...)
+LambdaCall:
   Enabled: false
 
-# I like my style more
-AccessModifierIndentation:
+# Buggy cop, returns false positive for our code base
+NonLocalExitFromIterator:
+  Enabled: false
+
+# To allow alignment of similar expressions we want to allow more than one
+# space around operators:
+#
+# let(:a) { bar    + something }
+# let(:b) { foobar + something }
+#
+SpaceAroundOperators:
+  Enabled: false
+
+# We use parallel assignments with great success
+ParallelAssignment:
+  Enabled: false
+
+# Allow additional specs
+ExtraSpacing:
+  AllowForAlignment: true
+
+# Buggy
+FormatParameterMismatch:
+  Enabled: false
+
+# Different preference
+SignalException:
+  EnforcedStyle: semantic
+
+# Do not use `alias`
+Alias:
+  EnforcedStyle: prefer_alias_method
+
+# Teaching people to ignore singleton class is pointless
+RedundantFreeze:
+  Enabled: false
+
+# Do not waste my horizontal or vertical space
+IndentArray:
+  Enabled: false
+
+# Prefer
+#
+#     some_receiver
+#       .foo
+#       .bar
+#       .baz
+#
+# Over
+#
+#     some_receiver.foo
+#                  .bar
+#                  .baz
+MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+# Align keys and values in a multiline hash
+AlignHash:
+  EnforcedColonStyle: table
+
+# Prefer `public_send` and `__send__` over `send`
+Send:
+  Enabled: true
+
+Lint/UnifiedInteger:
   Enabled: false

data/lib/auom.rb

@@ -1,5 +1,3 @@
-# encoding: UTF-8
-
 require 'rational'
 require 'equalizer'
 

data/lib/auom/algebra.rb

@@ -1,5 +1,3 @@
-# encoding: UTF-8
-
 module AUOM
   # The AUOM algebra
   module Algebra
@@ -31,7 +29,7 @@ module AUOM
 
     alias_method :+, :add
 
-    # Return substraction result
+    # Return subtraction result
     #
     # @param [Object] operand
     #
@@ -50,11 +48,11 @@ module AUOM
     #
     # @api public
     #
-    def substract(operand)
+    def subtract(operand)
       add(operand * -1)
     end
 
-    alias_method :-, :substract
+    alias_method :-, :subtract
 
     # Return multiplication result
     #
@@ -70,7 +68,7 @@ module AUOM
     #   # with unit
     #   Unit.new(2, :meter) * Unit.new(1, :meter) # => <AUOM::Unit @scalar=2 meter^2>
     #
-    #   # differend units
+    #   # different units
     #   Unit.new(2, :meter) * Unit.new(1, :euro) # => <AUOM::Unit @scalar=2 meter*euro>
     #
     # @api public
@@ -102,7 +100,7 @@ module AUOM
     #   # with unit
     #   Unit.new(2, :meter) / Unit.new(1, :meter) # => <AUOM::Unit @scalar=2>
     #
-    #   # differend units
+    #   # different units
     #   Unit.new(2, :meter) / Unit.new(1, :euro) # => <AUOM::Unit @scalar=2 meter/euro>
     #
     # @api public