measured 0.0.12 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d74ec88793dcfb465b93c16742ee24010aa23d1f
-  data.tar.gz: fc3b21627102730af5282ed7385263ce858d0edf
+  metadata.gz: 6c3f21a067bd19800087dbdd098e55e0355c2584
+  data.tar.gz: 973ff94aed9323f0beb2875cbe944fd0dcb3d405
 SHA512:
-  metadata.gz: 1223687fb266b9451f2d5008993e2464fed49da053d78a058dc16d74420c08f545fc15627cfe6197e2d99511ccb764be6e2ba74c0a8a27970c3bcdda5fbca37b
-  data.tar.gz: 5f71c822cd8c11ac4d73b47b6cd36689c8373f536ca2638af07dee05679cdb54c9a2a82c3ee7ac956ed2caf701cd10d546dfc5b3fe85804d490d6bf72a9c6be0
+  metadata.gz: a89c2dd0e93e0c348e76c493bd415ec5cc8aee7f2730d8a615d7f2cf208599ea94624f8994a1086d13bfb858f7f67528f011bdc87214deafec19a8af02a01625
+  data.tar.gz: e10e92567d23959d4c0fcf1df0b52bcef1624d105059890c38bfecf79a8cf66d01081b1e059efb6452575f4a1d92d63258a37a6d4e70e7ed010f8b96d454c8f3

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)
 
-Encapsulates measruements with their units. Provides easy conversion between units.
+Encapsulates measurements with their units. Provides easy conversion between units.
 
 Light weight and easily extensible to include other units and conversions. Conversions done with `BigDecimal` for precision.
 
@@ -181,6 +181,7 @@ class Measured::Thing < Measured::Measurable
 
   conversion.add :another_unit,             # Add a second unit to the system
     aliases: [:au],                         # All units allow aliases, as long as they are unique
+    case_sensitive: true,                   # Defaults to false; applies to name and aliases
     value: ["1.5 base_unit"]                # The conversion rate to another unit
 
   conversion.add :different_unit
@@ -191,6 +192,8 @@ end
 
 The base unit takes no value. Values for conversion units can be defined as a string with two tokens `"number unit"` or as an array with two elements. The numbers must be `Rational` or `BigDecimal`, else they will be coerced to `BigDecimal`. Conversion paths don't have to be direct as a conversion table will be built for all possible conversions using tree traversal.
 
+The `case_sensitive` flag, which is false by default, gets taken into account any time you attempt to reference a unit by name or alias.
+
 You can also open up the existing classes and add a new conversion:
 
 ```ruby

data/lib/measured/conversion.rb

@@ -7,12 +7,12 @@ class Measured::Conversion
 
   attr_reader :base_unit, :units
 
-  def set_base(unit_name, aliases: [])
-    add_new_unit(unit_name, aliases: aliases, base: true)
+  def set_base(unit_name, aliases: [], case_sensitive: false)
+    add_new_unit(unit_name, aliases: aliases, case_sensitive: case_sensitive, base: true)
   end
 
-  def add(unit_name, aliases: [], value:)
-    add_new_unit(unit_name, aliases: aliases, value: value)
+  def add(unit_name, aliases: [], case_sensitive: false, value:)
+    add_new_unit(unit_name, aliases: aliases, case_sensitive: case_sensitive, value: value)
   end
 
   def unit_names_with_aliases
@@ -24,11 +24,13 @@ class Measured::Conversion
   end
 
   def unit_or_alias?(name)
-    unit_names_with_aliases.include?(name.to_s)
+    @units.each{|unit| return true if unit.names_include?(name)}
+    false
   end
 
   def unit?(name)
-    unit_names.include?(name.to_s)
+    @units.each{|unit| return true if unit.name_eql?(name)}
+    false
   end
 
   def to_unit_name(name)
@@ -53,7 +55,7 @@ class Measured::Conversion
 
   private
 
-  def add_new_unit(unit_name, aliases:, value: nil, base: false)
+  def add_new_unit(unit_name, aliases:, case_sensitive: false, value: nil, base: false)
     if base && @base_unit
       raise Measured::UnitError, "Can only have one base unit. Adding #{ unit_name } but already defined #{ @base_unit }."
     elsif !base && !@base_unit
@@ -62,7 +64,7 @@ class Measured::Conversion
 
     check_for_duplicate_unit_names([unit_name] + aliases)
 
-    unit = Measured::Unit.new(unit_name, aliases: aliases, value: value)
+    unit = Measured::Unit.new(unit_name, aliases: aliases, case_sensitive: case_sensitive, value: value)
     @units << unit
     @base_unit = unit if base
 
@@ -79,7 +81,7 @@ class Measured::Conversion
 
   def unit_for(name)
     @units.each do |unit|
-      return unit if unit.names.include?(name.to_s)
+      return unit if unit.names_include?(name.to_s)
     end
 
     raise Measured::UnitError, "Cannot find unit for #{ name }."

data/lib/measured/measurable.rb

@@ -6,7 +6,7 @@ class Measured::Measurable
 
   def initialize(value, unit)
     raise Measured::UnitError, "Unit cannot be blank" if unit.blank?
-    raise Measured::UnitError, "Unit #{ unit } does not exits" unless self.class.conversion.unit_or_alias?(unit)
+    raise Measured::UnitError, "Unit #{ unit } does not exist" unless self.class.conversion.unit_or_alias?(unit)
 
     @value = case value
     when NilClass

data/lib/measured/unit.rb

@@ -1,14 +1,27 @@
 class Measured::Unit
   include Comparable
 
-  def initialize(name, aliases: [], value: nil)
+  def initialize(name, aliases: [], case_sensitive: false, value: nil)
     @name = name.to_s
     @names = ([@name] + aliases.map{|n| n.to_s }).sort
 
+    @case_sensitive = case_sensitive
     @conversion_amount, @conversion_unit = parse_value(value) if value
   end
 
-  attr_reader :name, :names, :conversion_amount, :conversion_unit
+  attr_reader :name, :names, :case_sensitive, :conversion_amount, :conversion_unit
+
+  def name_eql?(name_to_compare)
+    with_case_sensitivity(self.name).include?(with_case_sensitivity(name_to_compare).join)
+  end
+
+  def names_include?(name_to_compare)
+    with_case_sensitivity(self.names).include?(with_case_sensitivity(name_to_compare).join)
+  end
+
+  def add_alias(aliases)
+    @names = (@names << aliases).flatten.sort
+  end
 
   def to_s
     if conversion_string
@@ -40,6 +53,11 @@ class Measured::Unit
 
   private
 
+  def with_case_sensitivity(comparison)
+    comparison = [comparison].flatten
+    case_sensitive ? comparison : comparison.map(&:downcase)
+  end
+
   def conversion_string
     "#{ conversion_amount } #{ conversion_unit }" if @conversion_amount || @conversion_unit
   end

data/lib/measured/version.rb

@@ -1,3 +1,3 @@
 module Measured
-  VERSION = "0.0.12"
+  VERSION = "1.0.0"
 end

data/test/conversion_test.rb

@@ -66,20 +66,42 @@ class Measured::ConversionTest < ActiveSupport::TestCase
 
     assert @conversion.unit?(:inch)
     assert @conversion.unit?("m")
+    assert @conversion.unit?("M")
     refute @conversion.unit?("in")
     refute @conversion.unit?(:yard)
   end
 
+  test "#unit? takes into account case_sensitive flag" do
+    @conversion.set_base :m, case_sensitive: true
+    @conversion.add :inch, aliases: [:in], value: "0.0254 meter", case_sensitive: true
+
+    assert @conversion.unit?(:inch)
+    assert @conversion.unit?("m")
+    refute @conversion.unit?("M")
+    refute @conversion.unit?("in")
+  end
+
   test "#unit_or_alias? checks if the unit is part of the units but not aliases" do
     @conversion.set_base :m
     @conversion.add :inch, aliases: [:in], value: "0.0254 meter"
 
     assert @conversion.unit_or_alias?(:inch)
     assert @conversion.unit_or_alias?("m")
+    assert @conversion.unit_or_alias?(:IN)
     assert @conversion.unit_or_alias?("in")
     refute @conversion.unit_or_alias?(:yard)
   end
 
+  test "#unit_or_alias? takes into account case_sensitive flag" do
+    @conversion.set_base :m, case_sensitive: true
+    @conversion.add :inch, aliases: [:in], value: "0.0254 meter", case_sensitive: true
+
+    assert @conversion.unit_or_alias?(:inch)
+    assert @conversion.unit_or_alias?("m")
+    refute @conversion.unit_or_alias?(:M)
+    refute @conversion.unit_or_alias?("IN")
+  end
+
   test "#to_unit_name converts a unit name to its base unit" do
     assert_equal "fireball", Magic.conversion.to_unit_name("fire")
   end

data/test/unit_test.rb

@@ -13,6 +13,53 @@ class Measured::UnitTest < ActiveSupport::TestCase
     assert_equal ["cake", "pie", "sweets"], Measured::Unit.new(:pie, aliases: ["cake", :sweets]).names
   end
 
+  test "case_sensitive flag default to false" do
+    assert_equal false, @unit.case_sensitive
+  end
+
+  test "#name_eql?" do
+    assert_equal true, @unit.name_eql?("pIe")
+    assert_equal false, @unit.name_eql?("pastry")
+  end
+
+  test "#names_include?" do
+    unit = Measured::Unit.new(:pie, aliases:["cake", "tart"])
+    assert_equal true, unit.names_include?("pie")
+    assert_equal true, unit.names_include?("caKe")
+    assert_equal true, unit.names_include?("taRt")
+    assert_equal false, unit.names_include?("pastry")
+  end
+
+  test "case_sensitive flag set to false" do
+    assert_equal false, Measured::Unit.new(:pie, case_sensitive: false).case_sensitive
+  end
+
+  test "case_sensitive flag set to true, #name_eql?" do
+    unit = Measured::Unit.new(:pie, case_sensitive: true)
+    assert_equal true, unit.name_eql?("pie")
+    assert_equal false, unit.name_eql?("pIe")
+  end
+
+  test "case_sensitive flag set to true, #names_include?" do
+    unit = Measured::Unit.new(:pie, aliases: ["cake", "tart", "pastry"], case_sensitive: true)
+    assert_equal true, unit.names_include?("cake")
+    assert_equal false, unit.names_include?("tArt")
+  end
+
+  test "#add_alias with string" do
+    unit = Measured::Unit.new(:pie, aliases: ["cake"], value: "10 cake")
+    assert_equal ["cake", "pie"], unit.names
+    unit.add_alias("pastry")
+    assert_equal ["cake", "pastry", "pie"], unit.names
+  end
+
+  test "#add_alias with array" do
+    unit = Measured::Unit.new(:pie, aliases: ["cake"], value: "10 cake")
+    assert_equal ["cake", "pie"], unit.names
+    unit.add_alias(["pastry", "tart", "turnover"])
+    assert_equal ["cake", "pastry", "pie", "tart", "turnover"], unit.names
+  end
+
   test "#initialize parses out the unit and the number part" do
     assert_equal BigDecimal(10), @unit.conversion_amount
     assert_equal "cake", @unit.conversion_unit

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: measured
 version: !ruby/object:Gem::Version
-  version: 0.0.12
+  version: 1.0.0
 platform: ruby
 authors:
 - Kevin McPhillips
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-16 00:00:00.000000000 Z
+date: 2015-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport