measured 2.0.0 → 2.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7c468b43dd721649e5b050c0ad7f81b17e541734
-  data.tar.gz: d7c36b859f8e80539841a8a52457f923ca175136
+SHA256:
+  metadata.gz: 808003a2689c157f3d3a1ef7ff2eb2f1decc242d23c40a536d9bca8c57364a79
+  data.tar.gz: 42f4a72969b5331d7cd460f87d5668b3b331001b82f351c221f7153488859be5
 SHA512:
-  metadata.gz: fae18c324062e6274e0b6dab29b2ed0bcdb88012d90859edbc23fad081d1c02aba34710f54d0ecb2e7eb92a1940ef382fd5c0edaf2700ba2fc0ce422e333a3e7
-  data.tar.gz: ef22bf6cc930d8e3835095952e9aad259e32475584a0d0537f38f459e4ab141d4713f275f1c33d35e52eeabf0c7221c6192cec137827d3938287ece2e603f1da
+  metadata.gz: 4019bd9f128308af57f5ce9440e6a53f05587c1589f120b711c937b70d422a865c14d2e678d4b55bb13054e24a2663b5cb6ef51bfad12e834027eb4a644d5651
+  data.tar.gz: caf36d6ad0dbbd0e187adbb0d5a2ddd2718a38ddd67920e628c1d7ad09423f9c35edcef7f05cb863fec8e2849bb0eb8ce4145496aa0749cf2aaafbcd6459ba13

data/.github/workflows/ci.yml

@@ -0,0 +1,31 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    env:
+      BUNDLE_GEMFILE: ${{ matrix.gemfile }}
+    strategy:
+      matrix:
+        ruby:
+          - '2.6'
+          - '2.7'
+          - '3.0'
+        gemfile:
+          - Gemfile
+          - gemfiles/activesupport-5.2.gemfile
+          - gemfiles/activesupport-6.0.gemfile
+          - gemfiles/activesupport-6.1.gemfile
+    name: Ruby ${{ matrix.ruby }} ${{ matrix.gemfile }}
+    steps:
+      - uses: actions/checkout@v1
+      - name: Set up Ruby ${{ matrix.ruby }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: Run tests
+        run: |
+          bundle exec rake

data/CHANGELOG.md

@@ -0,0 +1,60 @@
+Unreleased
+-----
+
+
+
+2.8.2
+-----
+
+* Add cm3 and mm3 to volume. (@fekadeabdejene)
+
+2.8.1
+-----
+
+* Allow format without the conversion string. (@saraid)
+* Add special case for zero coercion to allow direct use of `sum` method. (@jmortlock)
+* Add useful numeric methods `finite?`, `infinite?`, `zero?`, `nonzero?`, `positive?` and `negative?`. (@jmortlock)
+
+2.8.0
+-----
+
+* Drop support for Ruby 2.5
+* Use Ruby 3.0.2 for development
+
+2.7.1
+-----
+
+* Fix Ruby 3.0 compatibility
+
+2.7.0
+-----
+
+* Raises an exception on cyclic conversions. (@arturopie)
+* Deduplicate strings loaded from the cache.
+* Deduplicate parsed units.
+
+2.6.0
+-----
+
+* Add `Measured::MissingConversionPath` and `Measured::UnitAlreadyAdded` as subclasses of `Measured::UnitError` to handle specific error cases. (@arturopie)
+* Support only ActiveSupport 5.2 and above.
+
+
+2.5.2
+-----
+
+* Allow unit values to be declared in the unit system through aliases and not just the base unit name.
+* Fix some deprecations in tests and CI.
+
+2.5.1
+----
+
+* Get rid of most memoizations in favor of eager computations.
+
+2.5.0
+-----
+
+* Add `CHANGELOG.md`.
+* Fix some deprecations and warnings.
+* Support Rails 6 and Ruby 2.6.
+* Cache conversion table in JSON file for first load performance.

data/README.md

@@ -1,6 +1,6 @@
-# Measured [![Build Status](https://travis-ci.org/Shopify/measured.svg)](https://travis-ci.org/Shopify/measured) [![Gem Version](https://badge.fury.io/rb/measured.svg)](http://badge.fury.io/rb/measured)
+# Measured [![Build Status](https://github.com/Shopify/measured/workflows/CI/badge.svg)](https://github.com/Shopify/measured/actions?query=workflow%3ACI)
 
-Encapsulates measurements with their units. Provides easy conversion between units.
+Encapsulates measurements with their units. Provides easy conversion between units. Built in support for weight, length, and volume.
 
 Lightweight and easily extensible to include other units and conversions. Conversions done with `Rational` for precision.
 
@@ -141,22 +141,78 @@ Measured::Weight.unit_names_with_aliases
 > ["g", "gram", "grams", "kg", "kilogram", "kilograms", "lb", "lbs", "ounce", "ounces", "oz", "pound", "pounds"]
 ```
 
+String formatting:
+```ruby
+Measured::Weight.new("3.14", "grams").format("%.1<value>f %<unit>s")
+> "3.1 g"
+```
+
+If no string is passed to the `format` method it defaults to `"%.2<value>f %<unit>s"`.
+
+If the unit isn't the standard SI unit, it will include a conversion string.
+
+```ruby
+Measured::Weight.new("3.14", "kg").format
+> "3.14 kg (1000/1 g)"
+Measured::Weight.new("3.14", "kg").format(with_conversion_string: false)
+> "3.14 kg"
+```
+
 ## Units and conversions
 
+### SI units support
+
+There is support for SI units through the use of `si_unit`. Units declared through it will have automatic support for all SI prefixes:
+
+| Multiplying Factor                | SI Prefix | Scientific Notation   |
+| --------------------------------- | --------- | --------------------- |
+| 1 000 000 000 000 000 000 000 000 | yotta (Y) | 10^24                 |
+| 1 000 000 000 000 000 000 000     | zetta (Z) | 10^21                 |
+| 1 000 000 000 000 000 000         | exa (E)   | 10^18                 |
+| 1 000 000 000 000 000             | peta (P)  | 10^15                 |
+| 1 000 000 000 000                 | tera (T)  | 10^12                 |
+| 1 000 000 000                     | giga (G)  | 10^9                  |
+| 1 000 000                         | mega (M)  | 10^6                  |
+| 1 000                             | kilo (k)  | 10^3                  |
+| 0.001                             | milli (m) | 10^-3                 |
+| 0.000 001                         | micro (µ) | 10^-6                 |
+| 0.000 000 001                     | nano (n)  | 10^-9                 |
+| 0.000 000 000 001                 | pico (p)  | 10^-12                |
+| 0.000 000 000 000 001             | femto (f) | 10^-15                |
+| 0.000 000 000 000 000 001         | atto (a)  | 10^-18                |
+| 0.000 000 000 000 000 000 001     | zepto (z) | 10^-21                |
+| 0.000 000 000 000 000 000 000 001 | yocto (y) | 10^-24                |
+
 ### Bundled unit conversion
 
 * `Measured::Weight`
-  * g, gram, grams
-  * kg, kilogram, kilograms
+  * g, gram, grams, and all SI prefixes
+  * t, metric_ton, metric_tons
+  * slug, slugs
+  * N, newtons, newton
+  * long_ton, long_tons, weight_ton, weight_tons, 'W/T', imperial_ton, imperial_tons, displacement_ton, displacement_tons
+  * short_ton, short_tons
   * lb, lbs, pound, pounds
   * oz, ounce, ounces
 * `Measured::Length`
-  * m, meter, metre, meters, metres
-  * cm, centimeter, centimetre, centimeters, centimetres
-  * mm, millimeter, millimetre, millimeters, millimetres
+  * m, meter, metre, meters, metres, and all SI prefixes
   * in, inch, inches
   * ft, foot, feet
   * yd, yard, yards
+  * mi, mile, miles
+* `Measured::Volume`
+  * l, liter, litre, liters, litres, and all SI prefixes
+  * m3, cubic_meter, cubic_meters, cubic_metre, cubic_metres
+  * ft3, cubic_foot, cubic_feet
+  * in3, cubic_inch, cubic_inches
+  * gal, imp_gal, imperial_gallon, imp_gals, imperial_gallons
+  * us_gal, us_gallon, us_gals, us_gallons
+  * qt, imp_qt, imperial_quart, imp_qts, imperial_quarts
+  * us_qt, us_quart, us_quarts
+  * pt, imp_pt, imperial_pint, imp_pts, imperial_pints
+  * us_pt, us_pint, us_pints
+  * oz, fl_oz, imp_fl_oz, imperial_fluid_ounce, imperial_fluid_ounces
+  * us_oz, us_fl_oz, us_fluid_ounce, us_fluid_ounces
 
 You can skip these and only define your own units by doing:
 
@@ -166,7 +222,7 @@ gem 'measured', require: 'measured/base'
 
 ### Shortcut syntax
 
-There is a shortcut initialization syntax for modules inside the `Measured` namespace, similar to `BigDecimal(123)` vs `BigDecimal.new(123)`:
+There is a shortcut initialization syntax for creating instances of measurement classes that can avoid the `.new`:
 
 ```ruby
 Measured::Weight(1, :g)
@@ -184,7 +240,7 @@ Measured::Thing = Measured.build do
 
   unit :another_unit,        # Add a second unit to the system
     aliases: [:au],          # All units allow aliases, as long as they are unique
-    value: ["1.5 bu"]        # The conversion rate to another unit
+    value: "1.5 bu"        # The conversion rate to another unit
 end
 ```
 
@@ -199,6 +255,7 @@ All units and classes are namespaced by default, but can be aliased in your appl
 ```ruby
 Weight = Measured::Weight
 Length = Measured::Length
+Volume = Measured::Volume
 ```
 
 ## Alternatives
@@ -225,12 +282,13 @@ Existing alternatives which were considered:
 
 ### Gem: [unitwise](https://github.com/joshwlewis/unitwise)
 * **Pros**
-  * Well written and maintained.
+  * Well written.
   * Conversions done with Unified Code for Units of Measure (UCUM) so highly accurate and reliable.
 * **Cons**
   * Lots of code. Good code, but lots of it.
   * Many modifications to core types.
   * ActiveRecord adapter exists but is written and maintained by a different person/org.
+  * Not actively maintained.
 
 ## Contributing
 

data/Rakefile

@@ -8,9 +8,12 @@ task default: :test
 
 desc 'Run the test stuite'
 Rake::TestTask.new do |t|
+  files = ARGV[1..-1]
+  files = "test/**/*_test.rb" if !files || files.length == 0
+
   t.libs << "test"
   t.libs << "lib/**/*"
-  t.test_files = FileList['test/**/*_test.rb']
+  t.test_files = FileList[files]
   t.verbose = true
 end
 
@@ -19,3 +22,21 @@ task tag: :build do
   system "git tag -a v#{ Measured::VERSION } -m 'Tagging #{ Measured::VERSION }'"
   system "git push --tags"
 end
+
+task :environment do
+  require 'measured'
+end
+
+namespace :cache do
+  task write: :environment do
+    class Measured::Cache::Json
+      prepend Measured::Cache::JsonWriter
+    end
+
+    puts "Updating cache files:"
+
+    Measured::Measurable.subclasses.each do |measurable|
+      puts "	#{measurable} - #{measurable.unit_system.update_cache ? 'ok' : 'skipped'}"
+    end
+  end
+end