measured 2.5.2 → 2.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce0f6c7c10571db0dd0d844638dd0bae637d2f9b13e87c29700bf9db51d84197
-  data.tar.gz: 936e5b74c36c65ca8393b94684b13341ff84d6981cfa34379af9cd0f8bdbed94
+  metadata.gz: 474f40f00059e15ec826a6ac74758ea6919f3b3c61a75bc42bcf181f9ac357dc
+  data.tar.gz: 356026fb5443a773928dbe21ac20f28f97ed72a987f6708b682cb665eeb511fc
 SHA512:
-  metadata.gz: 95eea761fff7e89716925729c8dae771b6274705390622930cf58443bc1d18bd2405bc65b13fa46b1c232ad249a231b0c1d5d7bedafa5d8262f860d94ac24437
-  data.tar.gz: b9d5ed9a9dc1a0fe8710a62c6c7d673d53c4fee4161f76452ab1f1b708edcb1a8ca081577dd4fb012358b375952d675f8e0bfc8d253f5b8519a024c944806bf1
+  metadata.gz: be4796ff68ae8e99abdd8361c68c79624e5b6b10f143a3314edc834e28cd79aa8c6f2c5707d49564d42c8d80fd0521a3db38023cd688a70e733a8f737991ff22
+  data.tar.gz: 56a1cf4956fc1eb5802bd74841dfcef1114eaf3514f1a0c3c3c9585aa7643e0c36f2ec287c8933c879ce4a5ecd2e1232ce2a4ea0e30f7cef7fc1a5cc90db69e8

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

@@ -1,3 +1,31 @@
+Unreleased
+-----
+
+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
 -----
 

data/README.md

@@ -1,4 +1,4 @@
-# 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. Built in support for weight, length, and volume.
 
@@ -273,12 +273,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/dev.yml

@@ -2,7 +2,7 @@ name: measured
 
 up:
   - ruby:
-      version: 2.6.3
+      version: 3.0.2
   - bundler
 
 commands:

data/gemfiles/{activesupport-5.0.gemfile → activesupport-5.2.gemfile}

@@ -2,4 +2,4 @@ source 'https://rubygems.org'
 
 gemspec path: '..'
 
-gem 'activesupport', '~> 5.0'
+gem 'activesupport', '~> 5.2'

data/gemfiles/activesupport-6.0.gemfile

@@ -2,4 +2,4 @@ source 'https://rubygems.org'
 
 gemspec path: '..'
 
-gem 'activesupport', '~> 6.0.0.rc1'
+gem 'activesupport', '~> 6.0'

data/gemfiles/{activesupport-5.1.gemfile → activesupport-6.1.gemfile}

@@ -2,4 +2,4 @@ source 'https://rubygems.org'
 
 gemspec path: '..'
 
-gem 'activesupport', '~> 5.1'
+gem 'activesupport', '~> 6.1'

data/lib/measured/base.rb

@@ -6,8 +6,6 @@ require "bigdecimal"
 require "json"
 
 module Measured
-  class UnitError < StandardError ; end
-
   class << self
     def build(&block)
       builder = UnitSystemBuilder.new
@@ -39,6 +37,10 @@ module Measured
   end
 end
 
+require "measured/unit_error"
+require "measured/cycle_detected"
+require "measured/unit_already_added"
+require "measured/missing_conversion_path"
 require "measured/arithmetic"
 require "measured/parser"
 require "measured/unit"

data/lib/measured/cache/json.rb

@@ -14,7 +14,7 @@ module Measured::Cache
 
     def read
       return unless exist?
-      decode(JSON.load(File.read(@path)))
+      decode(JSON.load(File.read(@path), nil, freeze: true))
     end
 
     def write(table)
@@ -37,11 +37,17 @@ module Measured::Cache
     end
 
     def decode(table)
-      table.each_with_object(table.dup) do |(k1, v1), accu|
-        v1.each do |k2, v2|
-          if v2.is_a?(Hash)
-            accu[k1][k2] = Rational(v2["numerator"], v2["denominator"])
+      table.transform_values do |value1|
+        if value1.is_a?(Hash)
+          value1.transform_values do |value2|
+            if value2.is_a?(Hash)
+              Rational(value2["numerator"], value2["denominator"])
+            else
+              value2
+            end
           end
+        else
+          value1
         end
       end
     end

data/lib/measured/conversion_table_builder.rb

@@ -24,6 +24,8 @@ class Measured::ConversionTableBuilder
   private
 
   def generate_table
+    validate_no_cycles
+
     units.map(&:name).each_with_object({}) do |to_unit, table|
       to_table = {to_unit => Rational(1, 1)}
 
@@ -37,10 +39,27 @@ class Measured::ConversionTableBuilder
     end
   end
 
+  def validate_no_cycles
+    graph = units.select { |unit| unit.conversion_unit.present? }.group_by { |unit| unit.name }
+    validate_acyclic_graph(graph, from: graph.keys[0])
+  end
+
+  # This uses a depth-first search algorithm: https://en.wikipedia.org/wiki/Depth-first_search
+  def validate_acyclic_graph(graph, from:, visited: [])
+    graph[from]&.each do |edge|
+      adjacent_node = edge.conversion_unit
+      if visited.include?(adjacent_node)
+        raise Measured::CycleDetected.new(edge)
+      else
+        validate_acyclic_graph(graph, from: adjacent_node, visited: visited + [adjacent_node])
+      end
+    end
+  end
+
   def find_conversion(to:, from:)
     conversion = find_direct_conversion_cached(to: to, from: from) || find_tree_traversal_conversion(to: to, from: from)
 
-    raise Measured::UnitError, "Cannot find conversion path from #{ from } to #{ to }." unless conversion
+    raise Measured::MissingConversionPath.new(from, to) unless conversion
 
     conversion
   end

data/lib/measured/cycle_detected.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+module Measured
+  class CycleDetected < UnitError
+    attr_reader :unit
+
+    def initialize(unit)
+      super("The following conversion introduces cycles in the unit system: #{unit}. Remove the conversion or fix the cycle.")
+      @unit = unit
+    end
+  end
+end

data/lib/measured/missing_conversion_path.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+module Measured
+  class MissingConversionPath < UnitError
+    attr_reader :from, :to
+
+    def initialize(from, to)
+      super("Cannot find conversion path from #{from} to #{to}.")
+      @from = from
+      @to = to
+    end
+  end
+end

data/lib/measured/parser.rb

@@ -33,6 +33,6 @@ module Measured::Parser
 
     raise Measured::UnitError, "Cannot parse measurement from '#{string}'" unless result
 
-    [result.captures[0].to_r, result.captures[1]]
+    [result.captures[0].to_r, -result.captures[1]]
   end
 end

data/lib/measured/unit_already_added.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+module Measured
+  class UnitAlreadyAdded < UnitError
+    attr_reader :unit_name
+
+    def initialize(unit_name)
+      super("Unit #{unit_name} has already been added.")
+      @unit_name = unit_name
+    end
+  end
+end

data/lib/measured/unit_error.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+module Measured
+  class UnitError < StandardError ; end
+end

data/lib/measured/unit_system_builder.rb

@@ -67,7 +67,7 @@ class Measured::UnitSystemBuilder
   def check_for_duplicate_unit_names!(unit)
     names = @units.flat_map(&:names)
     if names.any? { |name| unit.names.include?(name) }
-      raise Measured::UnitError, "Unit #{unit.name} has already been added."
+      raise Measured::UnitAlreadyAdded.new(unit.name)
     end
   end
 end

data/lib/measured/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Measured
-  VERSION = "2.5.2"
+  VERSION = "2.8.0"
 end

data/measured.gemspec

@@ -13,12 +13,20 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/Shopify/measured"
   spec.license       = "MIT"
 
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "activesupport", ">= 5.0"
+  spec.add_runtime_dependency "activesupport", ">= 5.2"
 
   spec.add_development_dependency "rake", "> 10.0"
   spec.add_development_dependency "minitest", "> 5.5.1"

data/test/conversion_table_builder_test.rb

@@ -117,6 +117,16 @@ class Measured::ConversionTableBuilderTest < ActiveSupport::TestCase
     end
   end
 
+  test "#to_h raises exception when there are cycles" do
+    unit1 = Measured::Unit.new(:pallets, value: "1 liters")
+    unit2 = Measured::Unit.new(:liters, value: "0.1 cases")
+    unit3 = Measured::Unit.new(:cases, value: "0.1 pallets")
+
+    assert_raises(Measured::CycleDetected) do
+      Measured::ConversionTableBuilder.new([unit1, unit2, unit3]).to_h
+    end
+  end
+
   test "#cached? returns true if there's a cache" do
     builder = Measured::ConversionTableBuilder.new([Measured::Unit.new(:test)], cache: { class: AlwaysTrueCache })
     assert_predicate builder, :cached?

data/test/unit_system_builder_test.rb

@@ -12,15 +12,17 @@ class Measured::UnitSystemBuilderTest < ActiveSupport::TestCase
   end
 
   test "#unit cannot add duplicate unit names" do
-    assert_raises Measured::UnitError do
+    error = assert_raises Measured::UnitAlreadyAdded do
       Measured.build do
         unit :m
         unit :in, aliases: [:inch], value: "0.0254 m"
         unit :in, aliases: [:thing], value: "123 m"
       end
     end
+    assert_equal("in", error.unit_name)
+    assert_equal("Unit in has already been added.", error.message)
 
-    assert_raises Measured::UnitError do
+    assert_raises Measured::UnitAlreadyAdded do
       Measured.build do
         unit :m
         unit :in, aliases: [:inch], value: "0.0254 m"
@@ -29,6 +31,19 @@ class Measured::UnitSystemBuilderTest < ActiveSupport::TestCase
     end
   end
 
+  test "#unit raises when cannot find conversion path" do
+    error = assert_raises Measured::MissingConversionPath do
+      Measured.build do
+        unit :m
+        unit :in, value: "0.0254 m"
+        unit :pallets, value: "5 cases"
+      end
+    end
+    assert_equal("pallets", error.from)
+    assert_equal("m", error.to)
+    assert_equal("Cannot find conversion path from pallets to m.", error.message)
+  end
+
   test "#unit is case sensitive" do
     measurable = Measured.build do
       unit :normal

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: measured
 version: !ruby/object:Gem::Version
-  version: 2.5.2
+  version: 2.8.0
 platform: ruby
 authors:
 - Kevin McPhillips
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-08 00:00:00.000000000 Z
+date: 2021-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -18,14 +18,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -104,8 +104,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
@@ -116,9 +116,9 @@ files:
 - cache/volume.json
 - cache/weight.json
 - dev.yml
-- gemfiles/activesupport-5.0.gemfile
-- gemfiles/activesupport-5.1.gemfile
+- gemfiles/activesupport-5.2.gemfile
 - gemfiles/activesupport-6.0.gemfile
+- gemfiles/activesupport-6.1.gemfile
 - lib/measured.rb
 - lib/measured/arithmetic.rb
 - lib/measured/base.rb
@@ -126,9 +126,13 @@ files:
 - lib/measured/cache/json_writer.rb
 - lib/measured/cache/null.rb
 - lib/measured/conversion_table_builder.rb
+- lib/measured/cycle_detected.rb
 - lib/measured/measurable.rb
+- lib/measured/missing_conversion_path.rb
 - lib/measured/parser.rb
 - lib/measured/unit.rb
+- lib/measured/unit_already_added.rb
+- lib/measured/unit_error.rb
 - lib/measured/unit_system.rb
 - lib/measured/unit_system_builder.rb
 - lib/measured/units/length.rb
@@ -159,7 +163,8 @@ files:
 homepage: https://github.com/Shopify/measured
 licenses:
 - MIT
-metadata: {}
+metadata:
+  allowed_push_host: https://rubygems.org
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -175,7 +180,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.20
 signing_key: 
 specification_version: 4
 summary: Encapsulate measurements with their units in Ruby

data/.travis.yml

@@ -1,17 +0,0 @@
-language: ruby
-sudo: false
-cache: bundler
-rvm:
-  - 2.4.9
-  - 2.5.7
-  - 2.6.5
-  - 2.7.0
-gemfile:
-  - Gemfile
-  - gemfiles/activesupport-5.0.gemfile
-  - gemfiles/activesupport-5.1.gemfile
-  - gemfiles/activesupport-6.0.gemfile
-matrix:
-  exclude:
-    - gemfile: gemfiles/activesupport-6.0.gemfile
-      rvm: 2.4.9