unitwise 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dfd97b3dc7b4fbee73653902232de8df74d79967
-  data.tar.gz: 25837b28be1ab4e3fbb71100bf6221986419fd65
+  metadata.gz: fb8605b862b95bff79423e03fabf502e89a39440
+  data.tar.gz: 83bf9041753023411557a9f9b22d84d6d61cecfc
 SHA512:
-  metadata.gz: bd81647b67a9ca56b420b6cf47d4c60e2f6311a1d7aef97d6a41309fd4e6a4ba43b746d9c4f776d9dd8dd0d82c95ec69d2e53ba0a211aee7dc49a2045092384e
-  data.tar.gz: 7fda14718114a1430b56873b68336e5eb92636f97597dce3e743ca72346499d2d3cdfcb4bb61eeedcd6162bfa3b90318f9eec0cc025e19f234f3e0eab7bc73a6
+  metadata.gz: c202998427bdbd04aef777b310afbca4bbfd1866bc2d5405054864f28b17d9e723ea0885eba6bed4ee981b9078ed99c3ab10c6f0f98ebc6ef73fe5eac94713d6
+  data.tar.gz: 806a06c5c4fcd80cd2ec3be0c6e723b2e7ce1b9b621340d9db194a782f08356594ea7816b8dec3d024245283404555559c5635b4c8fe05633a71aa0d043fd4e3

data/.ruby-version

@@ -1 +1 @@
-2.2.0
+2.4.0

data/.travis.yml

@@ -3,18 +3,14 @@ cache: bundler
 bundler_args: --without yard pry
 sudo: false
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1
-  - 2.2
+  - 2.1.10
+  - 2.2.7
+  - 2.3.4
+  - 2.4.1
+  - jruby-9.1.8.0
   - ruby-head
-  - rbx-2
+  - jruby-head
 matrix:
-  include:
-    - rvm: jruby-19mode
-      env: JRUBY_OPTS="$JRUBY_OPTS --debug"
-    - rvm: jruby-head
-      env: JRUBY_OPTS="$JRUBY_OPTS --debug"
   allow_failures:
     - rvm: ruby-head
     - rvm: jruby-head

data/CHANGELOG.md

@@ -5,6 +5,24 @@ version 1.0.0.
 
 Unitwise uses semantic versioning.
 
+## Unreleased
+
+## 2.1.0 - 2017-04-28
+
+### Removed
+
+- Support for Ruby MRI 1.9.3, MRI 2.0, and Rubinius
+
+### Added
+
+- `Unitwise.register` is a new method that allows user defined units
+- Support for MRI 2.3 and 2.4
+
+### Changed
+
+- Unit data refreshed from latest UCUM spec. Most notably, some metric atoms
+  names have seen case changes.
+
 ## 2.0.0 - 2015-09-13
 
 ### Fixed

data/Gemfile

@@ -2,9 +2,9 @@ source 'https://rubygems.org'
 
 gem 'coveralls',  '~> 0.7'
 if RUBY_VERSION >= '2.2.0'
-  gem 'bigdecimal', '~> 1.2.6', :platform => :mri
+  gem 'bigdecimal', '>= 1.2.6', :platform => :mri
 else
-  gem 'bigdecimal', '~> 1.2.5', :platform => :mri
+  gem 'bigdecimal', '<= 1.2.5', :platform => :mri
 end
 
 gemspec

data/README.md

@@ -237,17 +237,47 @@ Unitwise(1, "meter/s")      # Does not work, mixed designations (name and primar
 Unitwise(1, "meter") / Unitwise(1, "s") # Also works
 ```
 
+
+### Adding custom units
+
+While UCUM's list of units is rather exhaustive, there may still be occasions
+where you need custom or uncommon measurements. You can add them yourself
+with `Unitwise.register`, which will allow you to convert to or from the new
+unit.
+
+For example, if your app needed to pour "3 fingers" of bourbon, you could
+register an atom for that:
+
+```ruby
+Unitwise.register(
+  names: ["finger", "fingers"],
+  symbol: "🥃",
+  primary_code: "fng",
+  secondary_code: "fng",
+  scale: {
+    value: 1.0,
+    unit_code: '[foz_us]'
+  },
+  property: 'fluid volume'
+)
+
+Unitwise(1, "gallon").to_fingers
+# => #<Unitwise::Measurement value=0.153721590464621430998E3 unit=fingers>
+
+Unitwise(1, "🥃").to_cup
+# => #<Unitwise::Measurement value=0.125 unit=cup>
+```
+
 ## Supported Ruby Versions
 
 This library aims to support and is tested against the following Ruby
 implementations:
 
-* Ruby 1.9.3
-* Ruby 2.0.0
 * Ruby 2.1
 * Ruby 2.2
+* Ruby 2.3
+* Ruby 2.4
 * [JRuby](http://jruby.org/)
-* [Rubinius](http://rubini.us/)
 
 If something doesn't work on one of these versions, it's a bug.
 

data/data/base_unit.yaml

@@ -23,13 +23,13 @@
   :secondary_code: RAD
   :property: plane angle
   :dim: A
-- :names: Kelvin
+- :names: kelvin
   :symbol: K
   :primary_code: K
   :secondary_code: K
   :property: temperature
   :dim: C
-- :names: Coulomb
+- :names: coulomb
   :symbol: C
   :primary_code: C
   :secondary_code: C

data/data/derived_unit.yaml

@@ -24,7 +24,7 @@
   :special: false
   :arbitrary: false
 - :names: the number pi
-  :symbol: "π"
+  :symbol: π
   :primary_code: "[pi]"
   :secondary_code: "[PI]"
   :scale:
@@ -119,7 +119,7 @@
   :metric: true
   :special: false
   :arbitrary: false
-- :names: Hertz
+- :names: hertz
   :symbol: Hz
   :primary_code: Hz
   :secondary_code: HZ
@@ -131,7 +131,7 @@
   :metric: true
   :special: false
   :arbitrary: false
-- :names: Newton
+- :names: newton
   :symbol: N
   :primary_code: N
   :secondary_code: N
@@ -143,7 +143,7 @@
   :metric: true
   :special: false
   :arbitrary: false
-- :names: Pascal
+- :names: pascal
   :symbol: Pa
   :primary_code: Pa
   :secondary_code: PAL
@@ -155,7 +155,7 @@
   :metric: true
   :special: false
   :arbitrary: false
-- :names: Joule
+- :names: joule
   :symbol: J
   :primary_code: J
   :secondary_code: J
@@ -167,7 +167,7 @@
   :metric: true
   :special: false
   :arbitrary: false
-- :names: Watt
+- :names: watt
   :symbol: W
   :primary_code: W
   :secondary_code: W
@@ -179,7 +179,7 @@
   :metric: true
   :special: false
   :arbitrary: false
-- :names: Ampère
+- :names: ampère
   :symbol: A
   :primary_code: A
   :secondary_code: A
@@ -191,7 +191,7 @@
   :metric: true
   :special: false
   :arbitrary: false
-- :names: Volt
+- :names: volt
   :symbol: V
   :primary_code: V
   :secondary_code: V
@@ -203,7 +203,7 @@
   :metric: true
   :special: false
   :arbitrary: false
-- :names: Farad
+- :names: farad
   :symbol: F
   :primary_code: F
   :secondary_code: F
@@ -215,8 +215,8 @@
   :metric: true
   :special: false
   :arbitrary: false
-- :names: Ohm
-  :symbol: "Ω"
+- :names: ohm
+  :symbol: Ω
   :primary_code: Ohm
   :secondary_code: OHM
   :scale:
@@ -227,7 +227,7 @@
   :metric: true
   :special: false
   :arbitrary: false
-- :names: Siemens
+- :names: siemens
   :symbol: S
   :primary_code: S
   :secondary_code: SIE
@@ -239,7 +239,7 @@
   :metric: true
   :special: false
   :arbitrary: false
-- :names: Weber
+- :names: weber
   :symbol: Wb
   :primary_code: Wb
   :secondary_code: WB
@@ -264,7 +264,7 @@
   :metric: true
   :special: true
   :arbitrary: false
-- :names: Tesla
+- :names: tesla
   :symbol: T
   :primary_code: T
   :secondary_code: T
@@ -276,7 +276,7 @@
   :metric: true
   :special: false
   :arbitrary: false
-- :names: Henry
+- :names: henry
   :symbol: H
   :primary_code: H
   :secondary_code: H
@@ -312,7 +312,7 @@
   :metric: true
   :special: false
   :arbitrary: false
-- :names: Becquerel
+- :names: becquerel
   :symbol: Bq
   :primary_code: Bq
   :secondary_code: BQ
@@ -324,7 +324,7 @@
   :metric: true
   :special: false
   :arbitrary: false
-- :names: Gray
+- :names: gray
   :symbol: Gy
   :primary_code: Gy
   :secondary_code: GY
@@ -336,7 +336,7 @@
   :metric: true
   :special: false
   :arbitrary: false
-- :names: Sievert
+- :names: sievert
   :symbol: Sv
   :primary_code: Sv
   :secondary_code: SV
@@ -666,7 +666,7 @@
   :primary_code: "[h]"
   :secondary_code: "[H]"
   :scale:
-    :value: 6.6260755e-24
+    :value: 6.6260755e-34
     :unit_code: J.s
   :classification: const
   :property: action
@@ -1069,7 +1069,7 @@
   :metric: false
   :special: false
   :arbitrary: false
-- :names: statute mile
+- :names: mile
   :symbol: mi
   :primary_code: "[mi_i]"
   :secondary_code: "[MI_I]"
@@ -2244,6 +2244,19 @@
   :metric: false
   :special: false
   :arbitrary: false
+- :names: degree Réaumur
+  :symbol: "°Ré"
+  :primary_code: "[degRe]"
+  :secondary_code: "[degRe]"
+  :scale:
+    :function_code: degre
+    :value: 5.0
+    :unit_code: K/4
+  :classification: heat
+  :property: temperature
+  :metric: false
+  :special: true
+  :arbitrary: false
 - :names: calorie at 15 °C
   :symbol: cal<sub>15°C</sub>
   :primary_code: cal_[15]
@@ -3138,6 +3151,19 @@
   :metric: false
   :special: false
   :arbitrary: true
+- :names: index of reactivity
+  :symbol: IR
+  :primary_code: "[IR]"
+  :secondary_code: "[IR]"
+  :scale:
+    :value: 1.0
+    :unit_code: '1'
+  :classification: chemical
+  :property: amount of an allergen callibrated through in-vivo testing using the Stallergenes®
+    method.
+  :metric: false
+  :special: false
+  :arbitrary: true
 - :names: bioequivalent allergen unit
   :symbol: BAU
   :primary_code: "[BAU]"
@@ -3372,8 +3398,8 @@
   :metric: true
   :special: false
   :arbitrary: false
-- :names: "Ångström"
-  :symbol: "Å"
+- :names: Ångström
+  :symbol: Å
   :primary_code: Ao
   :secondary_code: AO
   :scale:
@@ -3491,6 +3517,18 @@
   :metric: false
   :special: false
   :arbitrary: false
+- :names: meter per square seconds per square root of hertz
+  :primary_code: "[m/s2/Hz^(1/2)]"
+  :secondary_code: "[M/S2/HZ^(1/2)]"
+  :scale:
+    :function_code: sqrt
+    :value: 1.0
+    :unit_code: m2/s4/Hz
+  :classification: misc
+  :property: amplitude spectral density
+  :metric: false
+  :special: true
+  :arbitrary: false
 - :names: bit
   :symbol: bit<sub>s</sub>
   :primary_code: bit_s

data/data/prefix.yaml

@@ -65,7 +65,7 @@
   :secondary_code: M
   :scalar: 1e-3
 - :names: micro
-  :symbol: "μ"
+  :symbol: μ
   :primary_code: u
   :secondary_code: U
   :scalar: 1e-6

data/lib/unitwise.rb

@@ -43,7 +43,19 @@ module Unitwise
       false
     end
   end
-  
+
+  # Add additional atoms. Useful for registering uncommon or custom units.
+  # @param properties [Hash] Properties of the atom
+  # @return [Unitwise::Atom] The newly created atom
+  # @raise [Unitwise::DefinitionError]
+  def self.register(atom_hash)
+    atom = Unitwise::Atom.new(atom_hash)
+    atom.validate!
+    Unitwise::Atom.all.push(atom)
+    Unitwise::Expression::Decomposer.send(:reset)
+    atom
+  end
+
   # The system path for the installed gem
   # @api private
   def self.path

data/lib/unitwise/atom.rb

@@ -7,13 +7,13 @@ module Unitwise
     include Compatible
 
     class << self
-      # Array of hashes representing atom properties.
+      # Array of hashes representing default atom properties.
       # @api private
       def data
         @data ||= data_files.map { |file| YAML.load(File.open file) }.flatten
       end
 
-      # Data files containing atom data
+      # Data files containing default atom data
       # @api private
       def data_files
         %w(base_unit derived_unit).map { |type| Unitwise.data_file type }
@@ -117,5 +117,34 @@ module Unitwise
       base? ? [Term.new(:atom_code => primary_code)] : scale.root_terms
     end
     memoize :root_terms
+
+
+    # A basic validator for atoms. It checks for the bare minimum properties
+    # and that it's scalar and magnitude can be resolved. Note that this method
+    # requires the units it depends on to already exist, so it is not used
+    # when loading the initial data from UCUM.
+    # @return [true] returns true if the atom is valid
+    # @raise [Unitwise::DefinitionError]
+    def validate!
+      missing_properties = %i{primary_code names scale}.select do |prop|
+        val = liner_get(prop)
+        val.nil? || (val.respond_to?(:empty) && val.empty?)
+      end
+
+      if !missing_properties.empty?
+        missing_list = missing_properties.join(',')
+        raise Unitwise::DefinitionError,
+          "Atom has missing properties: #{missing_list}."
+      end
+
+      msg = "Atom definition could not be resolved. Ensure that it is a base " \
+            "unit or is defined relative to existing units."
+
+      begin
+        !scalar.nil? && !magnitude.nil? || raise(Unitwise::DefinitionError, msg)
+      rescue Unitwise::ExpressionError
+        raise Unitwise::DefinitionError,  msg
+      end
+    end
   end
 end

data/lib/unitwise/errors.rb

@@ -1,7 +1,10 @@
 module Unitwise
-  class ExpressionError < Exception
+  class ExpressionError < StandardError
   end
 
-  class ConversionError < Exception
+  class ConversionError < StandardError
+  end
+
+  class DefinitionError < StandardError
   end
 end

data/lib/unitwise/expression/decomposer.rb

@@ -5,13 +5,7 @@ module Unitwise
     # of a string, as well as caching the results.
     class Decomposer
 
-      MODES = [:primary_code, :secondary_code, :names, :slugs, :symbol]
-
-      PARSERS = MODES.reduce({}) do |hash, mode|
-        hash[mode] = Parser.new(mode); hash
-      end
-
-      TRANSFORMER = Transformer.new
+      MODES = [:primary_code, :secondary_code, :names, :slugs, :symbol].freeze
 
       class << self
 
@@ -25,6 +19,16 @@ module Unitwise
           end
         end
 
+        def parsers
+          @parsers ||= MODES.reduce({}) do |hash, mode|
+            hash[mode] = Parser.new(mode); hash
+          end
+        end
+
+        def transformer
+          @transformer = Transformer.new
+        end
+
         private
 
         # A simple cache to prevent re-decomposing the same units
@@ -32,6 +36,14 @@ module Unitwise
         def cache
           @cache ||= {}
         end
+
+        # Reset memoized data. Allows rebuilding of parsers, transformers, and
+        # the cache after list of atoms has been modified.
+        def reset
+          @parsers = nil
+          @transformer = nil
+          @cache = nil
+        end
       end
 
       attr_reader :expression, :mode
@@ -44,7 +56,7 @@ module Unitwise
       end
 
       def parse
-        PARSERS.reduce(nil) do |_, (mode, parser)|
+        self.class.parsers.reduce(nil) do |_, (mode, parser)|
           parsed = parser.parse(expression) rescue next
           @mode = mode
           break parsed
@@ -52,7 +64,7 @@ module Unitwise
       end
 
       def transform
-        @transform ||= TRANSFORMER.apply(parse, :mode => mode)
+        @transform ||= self.class.transformer.apply(parse, :mode => mode)
       end
 
       def terms

data/lib/unitwise/expression/matcher.rb

@@ -5,19 +5,15 @@ module Unitwise
     class Matcher
       class << self
         def atom(mode)
-          @atom ||= {}
-          @atom[mode] ||= new(Atom.all, mode).alternative
+          new(Atom.all, mode).alternative
         end
 
         def metric_atom(mode)
-          @metric_atom ||= {}
-          @metric_atom[mode] ||=
-            new(Atom.all.select(&:metric?), mode).alternative
+          new(Atom.all.select(&:metric?), mode).alternative
         end
 
         def prefix(mode)
-          @prefix ||= {}
-          @prefix[mode] ||= new(Prefix.all, mode).alternative
+          new(Prefix.all, mode).alternative
         end
       end
 
@@ -41,7 +37,6 @@ module Unitwise
       def alternative
         Parslet::Atoms::Alternative.new(*matchers)
       end
-
     end
   end
 end

data/lib/unitwise/expression/parser.rb

@@ -5,14 +5,21 @@ module Unitwise
     class Parser < Parslet::Parser
       attr_reader :key
       def initialize(key = :primary_code)
-        @key = key
+        @key                 = key
+        @atom_matcher        = Matcher.atom(key)
+        @metric_atom_matcher = Matcher.metric_atom(key)
+        @prefix_matcher      = Matcher.prefix(key)
       end
 
+      private
+
+      attr_reader :atom_matcher, :metric_atom_matcher, :prefix_matcher
+
       root :expression
 
-      rule (:atom) { Matcher.atom(key).as(:atom_code) }
-      rule (:metric_atom) { Matcher.metric_atom(key).as(:atom_code) }
-      rule (:prefix) { Matcher.prefix(key).as(:prefix_code) }
+      rule (:atom) { atom_matcher.as(:atom_code) }
+      rule (:metric_atom) { metric_atom_matcher.as(:atom_code) }
+      rule (:prefix) { prefix_matcher.as(:prefix_code) }
 
       rule (:simpleton) do
         (prefix.as(:prefix) >> metric_atom.as(:atom) | atom.as(:atom))

data/lib/unitwise/version.rb

@@ -1,3 +1,3 @@
 module Unitwise
-  VERSION = '2.0.0'
+  VERSION = '2.1.0'
 end

data/test/test_helper.rb

@@ -9,9 +9,8 @@ require 'minitest/pride'
 require 'unitwise'
 
 module Minitest::Assertions
-  def assert_almost_equal(expected, actual)
+  def assert_almost_equal(expected, actual, range=0.0001)
     message = "Expected #{actual} to be almost equal to #{expected}"
-    range   = 0.00001
     assert expected + range > actual && expected - range < actual, message
   end
 end

data/test/unitwise/atom_test.rb

@@ -31,7 +31,7 @@ describe Unitwise::Atom do
   let(:joule)   { Unitwise::Atom.find("J")}
   describe "#scale" do
     it "must be nil for base atoms" do
-      second.scale.must_equal nil
+      second.scale.must_be_nil
     end
     it "sould be a Scale object for derived atoms" do
       yard.scale.must_be_instance_of Unitwise::Scale
@@ -126,4 +126,40 @@ describe Unitwise::Atom do
       second.frozen?.must_equal true
     end
   end
-end
+
+  describe "validate!" do
+    it "returns true for a valid atom" do
+      atom = Unitwise::Atom.new(
+        primary_code: "warp",
+        secondary_code: "[warp]",
+        names: ["Warp", "Warp Factor"],
+        scale: {
+          value: 1,
+          unit_code: "[c]"
+        }
+      )
+
+      atom.validate!.must_equal true
+    end
+
+    it "returns an error for an atom with missing properties" do
+      atom = Unitwise::Atom.new(names: "hot dog")
+
+      assert_raises { atom.validate! }
+    end
+
+    it "returns an error for an atom that doesn't resolve" do
+      atom = Unitwise::Atom.new(
+        primary_code: "feels",
+        secondary_code: "FEELS",
+        names: ["feels"],
+        scale: {
+          value: 1,
+          unit_code: "hearts"
+        }
+      )
+
+      assert_raises { atom.validate! }
+    end
+  end
+end

data/test/unitwise/expression/matcher_test.rb

@@ -15,8 +15,8 @@ describe Unitwise::Expression::Matcher do
     it "must be an Alternative list of names" do
       subject.must_be_instance_of Parslet::Atoms::Alternative
     end
-    it "must parse 'Joule'" do
-      subject.parse('Joule').must_equal('Joule')
+    it "must parse 'joule'" do
+      subject.parse('joule').must_equal('joule')
     end
   end
 
@@ -39,4 +39,4 @@ describe Unitwise::Expression::Matcher do
       subject.parse('h').must_equal('h')
     end
   end
-end
+end

data/test/unitwise_test.rb

@@ -28,8 +28,28 @@ describe Unitwise do
     end
   end
 
+  describe 'register' do
+    it 'should allow custom units to be registered' do
+      josh = {
+        names: ["Josh W Lewis", "joshwlewis"],
+        symbol: "JWL",
+        primary_code: "jwl",
+        secondary_code: "jwl",
+        scale: {
+          value: 71.875,
+          unit_code: "[in_i]"
+        }
+      }
+
+      Unitwise.register(josh)
+
+      joshes = Unitwise(1, 'mile').to_jwl
+
+      joshes.to_i.must_equal(881)
+    end
+  end
+
   it "should have a path" do
     Unitwise.path.must_match(/unitwise$/)
   end
-
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unitwise
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Josh Lewis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-13 00:00:00.000000000 Z
+date: 2017-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: liner
@@ -217,7 +217,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Convert between and perform mathematical operations on physical quantities