unitwise 1.0.4 → 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cdeefee8c44bb010c6198248b58819010f753d6f
+  data.tar.gz: 3e7283137b22b8bf7bf621b8585ce29680ce993e
+SHA512:
+  metadata.gz: 1727d64bdd2929aa882a8150ca3f735a9e95035aebc06fb466e87108f4ba5bf9a3b4d2f734b0cebae0ef37fb9125616c2a307f61951802094fe0db7f656728f1
+  data.tar.gz: 9c516ce0638721abfe37b8a5f3236d39214896b96c46b813e9a8507027020c40748d9f64e24dcf16dd9228e790fcc6a47c3529fcccbc8f196510a7b5b1e8c142

data/CHANGELOG.md

@@ -5,6 +5,16 @@ version 1.0.0.
 
 Unitwise uses semantic versioning.
 
+## 1.1.0 - 2015-09-10
+
+- `require unitwise/ext` has been deprecated as it is a performance drag and
+  violates Ruby best practices. Use `require unitwise` instead. Any use of the
+  Numeric helpers like `1.meter`, `2.to_foot` will need to change to
+  `Unitwise(1, 'meter')`, and `Unitwise(2, 'foot')`.
+- `#to_s` should no longer return the unexpected ' 1' suffix for dimless measurements.
+- `#to_s(mode)` will fall back to using the atom's `primary_code` if the mode
+  isn't available.
+
 ## 1.0.4 - 2015-01-10
 
 - Added Ruby 2.2 support.

data/README.md

@@ -13,9 +13,11 @@ For an over the top example, consider a car (2800 lb) completing the quarter
 mile in 10 seconds (with uniform acceleration).
 
 ```ruby
-distance = 0.25.mile # => #<Unitwise::Measurement value=0.25 unit=mile>
-time = 10.second # => #<Unitwise::Measurement value=10 unit=second>
-mass = 2800.pound # => #<Unitwise::Measurement value=2800 unit=pound>
+require 'unitwise'
+
+distance = Unitwise(0.25, 'mile')   # => #<Unitwise::Measurement value=0.25 unit=mile>
+time     = Unitwise(10,   'second') # => #<Unitwise::Measurement value=10 unit=second>
+mass     = Unitwise(2800, 'pound')  # => #<Unitwise::Measurement value=2800 unit=pound>
 
 acceleration = 2.0 * distance / time ** 2
 # => #<Unitwise::Measurement value=0.005 unit=[mi_us]/s2>
@@ -71,23 +73,13 @@ Unitwise(2.3, 'kilogram') # => #<Unitwise::Measurement value=2.3 unit=kilogram>
 Unitwise(100, 'pound')    # => #<Unitwise::Measurement value=100 unit=pound>
 ```
 
-Unitwise doesn't mess with the core library by default. However, you can
-optionally require the core extensions for some handy helpers.
-
-```ruby
-require 'unitwise/ext'
-
-1.convert_to('liter') # => #<Unitwise::Measurement value=1 unit=liter>
-4.teaspoon            # => #<Unitwise::Measurement value=4 unit=teaspoon>
-```
-
 ### Conversion
 
 Unitwise is able to convert any unit within the UCUM spec to any other
 compatible unit.
 
 ```ruby
-5.0.kilometer.convert_to('mile')
+Unitwise(5.0, 'kilometer').convert_to('mile')
 # => #<Unitwise::Measurement value=3.106849747474748 unit=mile>
 ```
 
@@ -104,8 +96,8 @@ Unitwise(26.2, 'mile').to_kilometer
 It also has the ability to compare measurements with the same or different units.
 
 ```ruby
-12.inch == 1.foot # => true
-1.meter > 1.yard  # => true
+Unitwise(12, 'inch') == Unitwise(1, 'foot') # => true
+Unitwise(1, 'meter') > Unitwise(1, 'yard')  # => true
 ```
 
 Again, you have to compare compatible units. For example, comparing two
@@ -116,8 +108,8 @@ temperatures will work, comparing a mass to a length would fail.
 You can use shorthand for SI units.
 
 ```ruby
-1000.m == 1.km  # => true
-1.ml == 0.001.l # => true
+Unitwise(1000, 'm') == Unitwise(1, 'km')  # => true
+Unitwise(1, 'ml') == Unitwise(0.001, 'l') # => true
 ```
 
 ### Complex Units
@@ -145,29 +137,28 @@ Unitwise(1000, 'kg.s-1.(m/s)2').to_kilowatt
 You can add or subtract compatible measurements.
 
 ```ruby
-2.0.meter + 3.0.inch - 1.0.yard
+Unitwise(2.0, 'meter') + Unitwise(3.0, 'inch') - Unitwise(1.0, 'yard')
 # => #<Unitwise::Measurement value=1.1618 unit=meter>
 ```
 
 You can multiply or divide measurements and numbers.
 
 ```ruby
-110.volt * 2
+Unitwise(110, 'volt') * 2
 # => #<Unitwise::Measurement value=220 unit=volt>
 ```
 
 You can multiply or divide measurements with measurements.
 
 ```ruby
-20.milligram / 1.liter
+Unitwise(20, 'milligram') / Unitwise(1, 'liter')
 # => #<Unitwise::Measurement value=20 unit=mg/l>
-
 ```
 
 Exponentiation is also supported.
 
 ```ruby
-(10.cm ** 3).to_liter
+(Unitwise(10, 'cm') ** 3).to_liter
 # => #<Unitwise::Measurement value=1 unit=liter>
 ```
 
@@ -246,6 +237,21 @@ Unitwise(1, "meter/s")      # Does not work, mixed designations (name and primar
 Unitwise(1, "meter") / Unitwise(1, "s") # Also works
 ```
 
+## Core extensions (deprecated)
+
+Unitwise doesn't mess with the core library by default. However, you can
+optionally require the core extensions for some handy helpers. I find these
+fun for doing calculations in an irb or pry session, but use them in your
+application at your own risk. These extensions have been known to negatively
+impact performance, and will be removed in a future version.
+
+```ruby
+require 'unitwise/ext'
+
+4.teaspoon            # => #<Unitwise::Measurement value=4 unit=teaspoon>
+1.convert_to('liter') # => #<Unitwise::Measurement value=1 unit=liter>
+```
+
 ## Supported Ruby Versions
 
 This library aims to support and is tested against the following Ruby

data/lib/unitwise/base.rb

@@ -51,7 +51,7 @@ module Unitwise
     # @return [String]
     # @api public
     def to_s(mode = :primary_code)
-      res = send(mode)
+      res = send(mode) || primary_code
       res.respond_to?(:each) ? res.first.to_s : res.to_s
     end
   end

data/lib/unitwise/ext.rb

@@ -1,2 +1,5 @@
 require 'unitwise'
 require 'unitwise/ext/numeric'
+
+warn '`unitwise/ext` is deprecated. These core extensions will be removed ' \
+     'in a future version. Please use `unitwise` instead.'

data/lib/unitwise/ext/numeric.rb

@@ -1,6 +1,8 @@
 # Unitwise extends Numeric to add these dyanmic method conveniences: `1.meter`,
-# `26.2.to_mile`, and `4.convert_to("Joule")`. These overrides are optional due
-# to their controversial nature. `require 'unitwise/ext'` to enable them.
+# `26.2.to_mile`, and `4.convert_to("Joule")`. These overrides are optional
+# and may be enabled with `require 'unitwise/ext'`. These methods are known to
+# reduce performance, as well as violate Ruby best practices. They are
+# deprecated and will be removed in a future version.
 class Numeric
   # Converts numeric to a measurement
   # @param unit [Unitwise::Unit, String] The unit to use in the measurement

data/lib/unitwise/scale.rb

@@ -116,7 +116,12 @@ module Unitwise
     # Convert to a simple string representing the scale.
     # @api public
     def to_s(mode = nil)
-      "#{simplified_value} #{unit.to_s(mode)}"
+      unit_string = unit.to_s(mode)
+      if unit_string && unit_string != '1'
+        "#{simplified_value} #{unit_string}"
+      else
+        simplified_value.to_s
+      end
     end
 
     def inspect

data/lib/unitwise/term.rb

@@ -114,8 +114,12 @@ module Unitwise
     end
 
     def to_s(mode = :primary_code)
-      [(factor if factor != 1), (prefix.send(mode) if prefix),
-        (atom.send(mode) if atom), (exponent if exponent != 1)].compact.join('')
+      [
+        (factor if factor != 1),
+        (prefix.send(mode) if prefix),
+        (atom.send(mode) if atom),
+        (exponent if exponent != 1)
+      ].compact.join('')
     end
 
     private

data/lib/unitwise/version.rb

@@ -1,3 +1,3 @@
 module Unitwise
-  VERSION = '1.0.4'
+  VERSION = '1.1.0'
 end

data/test/unitwise/measurement_test.rb

@@ -228,6 +228,14 @@ describe Unitwise::Measurement do
       temp.to_s(:primary_code).must_equal("25 Cel")
       temp.to_s(:symbol).must_equal("25 °C")
     end
+    it "should fallback when there is no value for the provided mode" do
+      vol = described_class.new(12, "teaspoon")
+      vol.to_s(:symbol).must_equal("12 [tsp_us]")
+    end
+    it "should not return '1 1' for dimless measurements" do
+      dimless = described_class.new(1, "1")
+      dimless.to_s.must_equal("1")
+    end
   end
 
 end

metadata

@@ -1,158 +1,139 @@
 --- !ruby/object:Gem::Specification
 name: unitwise
 version: !ruby/object:Gem::Version
-  version: 1.0.4
-  prerelease: 
+  version: 1.1.0
 platform: ruby
 authors:
 - Josh Lewis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-10 00:00:00.000000000 Z
+date: 2015-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: liner
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.2'
 - !ruby/object:Gem::Dependency
   name: signed_multiset
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.2'
 - !ruby/object:Gem::Dependency
   name: memoizable
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.4'
 - !ruby/object:Gem::Dependency
   name: parslet
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.5.0
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.5.10
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.5.10
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: nori
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.3'
 description: Physical quantity and units of measure conversion and math library
@@ -162,9 +143,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .ruby-version
-- .travis.yml
+- ".gitignore"
+- ".ruby-version"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -222,27 +203,26 @@ files:
 homepage: http://github.com/joshwlewis/unitwise
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.4.5
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Convert between and perform mathematical operations on physical quantities
   and units of measure defined by the Unified Code for Units of Measure.
 test_files:
@@ -262,4 +242,3 @@ test_files:
 - test/unitwise/term_test.rb
 - test/unitwise/unit_test.rb
 - test/unitwise_test.rb
-has_rdoc: