measured 1.6.0 → 2.0.0.pre1

data/test/support/fake_system.rb

@@ -1,46 +1,20 @@
-class Magic < Measured::Measurable
-
-  conversion.set_base :magic_missile,
-    aliases: [:magic_missiles]
-
-  conversion.add :fireball,
-    aliases: [:fire, :fireballs],
-    value: "2/3 magic_missile"
-
-  conversion.add :ice,
-    value: "2 magic_missile"
-
-  conversion.add :arcane,
-    value: "10 magic_missile"
-
-  conversion.add :ultima,
-    value: "10 arcane"
-
+Magic = Measured.build do
+  unit :magic_missile, aliases: [:magic_missiles]
+  unit :fireball, value: "2/3 magic_missile", aliases: [:fire, :fireballs]
+  unit :ice, value: "2 magic_missile"
+  unit :arcane, value: "10 magic_missile"
+  unit :ultima, value: "10 arcane"
 end
 
-class CaseSensitiveMagic < Measured::CaseSensitiveMeasurable
-
-  conversion.set_base :magic_missile,
-    aliases: [:magic_missiles]
-
-  conversion.add :fireball,
-    aliases: [:fire, :fireballs],
-    value: "2/3 magic_missile"
-
-  conversion.add :ice,
-    value: "2 magic_missile"
-
-  conversion.add :arcane,
-    value: "10 magic_missile"
-
-  conversion.add :ultima,
-    value: "10 arcane"
-
+CaseSensitiveMagic = Measured.build(case_sensitive: true) do
+  unit :magic_missile, aliases: [:magic_missiles]
+  unit :fireball, value: "2/3 magic_missile", aliases: [:fire, :fireballs]
+  unit :ice, value: "2 magic_missile"
+  unit :arcane, value: "10 magic_missile"
+  unit :ultima, value: "10 arcane"
 end
 
-class OtherFakeSystem < Measured::Measurable
-
-  conversion.set_base :other_fake_base
-  conversion.add :other_fake1, value: "2 other_fake_base"
-
+OtherFakeSystem = Measured.build do
+  unit :other_fake_base
+  unit :other_fake1, value: "2 other_fake_base"
 end

data/test/test_helper.rb

@@ -32,4 +32,9 @@ class ActiveSupport::TestCase
 
     assert_equal BigDecimal(to_amount), klass.new(from_amount, from_unit).convert_to(to_unit).value
   end
+
+  def assert_raises_with_message(exception, expected_message)
+    error = assert_raise(exception) { yield }
+    assert_equal expected_message, error.message, "Exception #{exception} raised but messages are not equal"
+  end
 end

data/test/unit_system_builder_test.rb

@@ -0,0 +1,58 @@
+require "test_helper"
+
+class Measured::UnitSystemBuilderTest < ActiveSupport::TestCase
+  test "#unit adds a new unit" do
+    measurable = Measured.build do
+      unit :m
+      unit :in, aliases: [:inch], value: "0.0254 m"
+    end
+
+    assert_equal 2, measurable.unit_names.count
+  end
+
+  test "#unit cannot add duplicate unit names" do
+    assert_raises Measured::UnitError do
+      Measured.build do
+        unit :m
+        unit :in, aliases: [:inch], value: "0.0254 m"
+        unit :in, aliases: [:thing], value: "123 m"
+      end
+    end
+
+    assert_raises Measured::UnitError do
+      Measured.build(case_sensitive: true) do
+        unit :m
+        unit :in, aliases: [:inch], value: "0.0254 m"
+        unit :inch, aliases: [:thing], value: "123 m"
+      end
+    end
+
+    assert_raises Measured::UnitError do
+      Measured.build(case_sensitive: false) do
+        unit :normal
+        unit :bold, aliases: [:strong], value: "10 normal"
+        unit :bolder, aliases: [:BOLD], value: "100 normal"
+      end
+    end
+  end
+
+  test "#case_sensitive true produces a case-sensitive conversion" do
+    measurable = Measured.build(case_sensitive: true) do
+      unit :normal
+      unit :bold, value: "10 normal"
+      unit :BOLD, value: "100 normal"
+    end
+
+    assert_equal 2, measurable.new(200, :normal).convert_to(:BOLD).value
+  end
+
+  test "case-insensitive conversion is produced by default" do
+    measurable = Measured.build(case_sensitive: false) do
+      unit :normal
+      unit :bold, value: "10 normal"
+      unit :bolder, value: "100 normal"
+    end
+
+    assert_equal 20, measurable.new(200, :normal).convert_to(:bOlD).value
+  end
+end

data/test/unit_system_test.rb

@@ -0,0 +1,99 @@
+require "test_helper"
+
+class Measured::UnitSystemTest < ActiveSupport::TestCase
+  setup do
+    @conversion = Measured::UnitSystem.new([
+      Measured::Unit.new(:m),
+      Measured::Unit.new(:in, aliases: [:Inch], value: "0.0254 m"),
+      Measured::Unit.new(:ft, aliases: [:Feet, :Foot], value: "0.3048 m"),
+    ])
+  end
+
+  test "#unit_names_with_aliases lists all allowed unit names" do
+    assert_equal ["Feet", "Foot", "Inch", "ft", "in", "m"], @conversion.unit_names_with_aliases
+  end
+
+  test "#unit_names lists all unit names without aliases" do
+    assert_equal ["ft", "in", "m"], @conversion.unit_names
+  end
+
+  test "#unit? checks if the unit is part of the units but not aliases" do
+    assert @conversion.unit?(:in)
+    assert @conversion.unit?("m")
+    refute @conversion.unit?("M")
+    refute @conversion.unit?("inch")
+    refute @conversion.unit?(:yard)
+  end
+
+  test "#unit? with blank and nil arguments" do
+    refute @conversion.unit?("")
+    refute @conversion.unit?(nil)
+  end
+
+  test "#unit_or_alias? checks if the unit is part of the units or aliases" do
+    assert @conversion.unit_or_alias?(:Inch)
+    assert @conversion.unit_or_alias?("m")
+    assert @conversion.unit_or_alias?("in")
+    refute @conversion.unit_or_alias?(:inch)
+    refute @conversion.unit_or_alias?(:IN)
+    refute @conversion.unit_or_alias?(:yard)
+  end
+
+  test "#unit_or_alias? with blank and nil arguments" do
+    refute @conversion.unit_or_alias?("")
+    refute @conversion.unit_or_alias?(nil)
+  end
+
+  test "#to_unit_name converts a unit name to its base unit" do
+    assert_equal "fireball", CaseSensitiveMagic.unit_system.to_unit_name("fire")
+  end
+
+  test "#to_unit_name does not care about string or symbol" do
+    assert_equal "fireball", CaseSensitiveMagic.unit_system.to_unit_name(:fire)
+  end
+
+  test "#to_unit_name passes through if already base unit name" do
+    assert_equal "fireball", CaseSensitiveMagic.unit_system.to_unit_name("fireball")
+  end
+
+  test "#to_unit_name returns nil if not found" do
+    assert_nil CaseSensitiveMagic.unit_system.to_unit_name("thunder")
+  end
+
+  test "#to_unit_name! converts a unit name to its base unit" do
+    assert_equal "fireball", CaseSensitiveMagic.unit_system.to_unit_name!("fire")
+  end
+
+  test "#to_unit_name! does not care about string or symbol" do
+    assert_equal "fireball", CaseSensitiveMagic.unit_system.to_unit_name!(:fire)
+  end
+
+  test "#to_unit_name! passes through if already base unit name" do
+    assert_equal "fireball", CaseSensitiveMagic.unit_system.to_unit_name!("fireball")
+  end
+
+  test "#to_unit_name! raises if not found" do
+    assert_raises_with_message(Measured::UnitError, "Unit 'thunder' does not exist") do
+      CaseSensitiveMagic.unit_system.to_unit_name!("thunder")
+    end
+  end
+
+  test "#convert raises if either unit is not found" do
+    assert_raises Measured::UnitError do
+      CaseSensitiveMagic.unit_system.convert(1, from: "fire", to: "doesnt_exist")
+    end
+
+    assert_raises Measured::UnitError do
+      CaseSensitiveMagic.unit_system.convert(1, from: "doesnt_exist", to: "fire")
+    end
+  end
+
+  test "#convert converts between two known units" do
+    assert_equal BigDecimal("3"), @conversion.convert(BigDecimal("36"), from: "in", to: "ft")
+    assert_equal BigDecimal("18"), @conversion.convert(BigDecimal("1.5"), from: "ft", to: "in")
+  end
+
+  test "#convert handles the same unit" do
+    assert_equal BigDecimal("2"), @conversion.convert(BigDecimal("2"), from: "in", to: "in")
+  end
+end

data/test/unit_test.rb

@@ -2,84 +2,21 @@ require "test_helper"
 
 class Measured::UnitTest < ActiveSupport::TestCase
   setup do
-    @unit = Measured::Unit.new(:pie, value: "10 cake")
+    @unit = Measured::Unit.new(:Pie, value: "10 Cake")
+    @unit_with_aliases = Measured::Unit.new(:Pie, aliases: ["Cake", "Tart"])
   end
 
   test "#initialize converts the name to a string" do
-    assert_equal "pie", @unit.name
+    assert_equal "Pie", @unit.name
   end
 
-  test "#initialize converts aliases to strings and makes a list of names which includes the base" do
-    assert_equal ["cake", "pie", "sweets"], Measured::Unit.new(:pie, aliases: ["cake", :sweets]).names
-  end
-
-  test "#name_eql?" do
-    assert @unit.name_eql?("pIe")
-    refute @unit.name_eql?("pastry")
-  end
-
-  test "#name_eql? with case_sensitive true" do
-    assert @unit.name_eql?("pie", case_sensitive: true)
-    refute @unit.name_eql?("Pie", case_sensitive: true)
-  end
-
-  test "#name_eql? with empty string" do
-    assert @unit.name_eql?("pie")
-    refute @unit.name_eql?("")
-  end
-
-  test "#names_include?" do
-    unit = Measured::Unit.new(:pie, aliases:["cake", "tart"])
-    assert unit.names_include?("pie")
-    assert unit.names_include?("caKe")
-    assert unit.names_include?("taRt")
-    refute unit.names_include?("pastry")
-  end
-
-  test "#names_include? with case_sensitive true" do
-    unit = Measured::Unit.new(:pie, aliases:["cake", "tart"])
-    assert unit.names_include?("pie", case_sensitive: true)
-    assert unit.names_include?("cake", case_sensitive: true)
-    refute unit.names_include?("TART", case_sensitive: true)
-  end
-
-  test "#names_include? with empty string" do
-    unit = Measured::Unit.new(:pie, aliases: ["cake", "tart"])
-    assert unit.names_include?("cake")
-    refute unit.names_include?("")
-  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 "#add_alias with nil" do
-    unit = Measured::Unit.new(:pie, aliases: ["cake"], value: "10 cake")
-    assert_equal ["cake", "pie"], unit.names
-    unit.add_alias(nil)
-    assert_equal ["cake", "pie"], unit.names
-  end
-
-  test "#add_alias with empty string" do
-    unit = Measured::Unit.new(:pie, aliases: ["cake"], value: "10 cake")
-    assert_equal ["cake", "pie"], unit.names
-    unit.add_alias("")
-    assert_equal ["cake", "pie"], unit.names
+  test "#initialize converts aliases to strings and makes a list of sorted names" do
+    assert_equal %w(Cake pie sweets), Measured::Unit.new(:pie, aliases: ["Cake", :sweets]).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
+    assert_equal "Cake", @unit.conversion_unit
 
     unit = Measured::Unit.new(:pie, value: "5.5 sweets")
     assert_equal BigDecimal("5.5"), unit.conversion_amount
@@ -100,7 +37,7 @@ class Measured::UnitTest < ActiveSupport::TestCase
     end
   end
 
-  test "#to_s" do
+  test "#to_s returns an expected string" do
     assert_equal "pie", Measured::Unit.new(:pie).to_s
     assert_equal "pie (1/2 sweet)", Measured::Unit.new(:pie, aliases: ["cake"], value: [Rational(1,2), "sweet"]).to_s
   end
@@ -110,28 +47,29 @@ class Measured::UnitTest < ActiveSupport::TestCase
     assert_equal "#<Measured::Unit: pie (cake, pie) 1/2 sweet>", Measured::Unit.new(:pie, aliases: ["cake"], value: [Rational(1,2), "sweet"]).inspect
   end
 
-  test "is comparable" do
+  test "includes Comparable mixin" do
     assert Measured::Unit.ancestors.include?(Comparable)
   end
 
-  test "#<=> delegates down to name for non Unit comparisons" do
-    assert_equal 1, @unit <=> "anything"
+  test "#<=> compares non-Unit classes against name" do
+    assert_equal 1, @unit <=> "Pap"
+    assert_equal -1, @unit <=> "Pop"
   end
 
-  test "#<=> is equal for same values" do
-    assert_equal 0, @unit <=> Measured::Unit.new(:pie, value: "10 cake")
-    assert_equal 0, @unit <=> Measured::Unit.new("pie", value: "10 cake")
-    assert_equal 0, @unit <=> Measured::Unit.new("pie", value: [10, :cake])
+  test "#<=> is 0 for Unit instances that should be equivalent" do
+    assert_equal 0, @unit <=> Measured::Unit.new(:Pie, value: "10 cake")
+    assert_equal 0, @unit <=> Measured::Unit.new("Pie", value: "10 cake")
+    assert_equal 0, @unit <=> Measured::Unit.new("Pie", value: [10, :cake])
   end
 
-  test "#<=> is slightly different" do
-    assert_equal 1, @unit <=> Measured::Unit.new(:pies, value: "10 cake")
-    assert_equal 1, @unit <=> Measured::Unit.new("pie", aliases: ["pies"], value: "10 cake")
-    assert_equal 1, @unit <=> Measured::Unit.new(:pie, value: [11, :cake])
+  test "#<=> is 1 for units with names that come after Pie lexicographically" do
+    assert_equal 1, @unit <=> Measured::Unit.new(:Pigs, value: "10 bacon")
+    assert_equal 1, @unit <=> Measured::Unit.new("Pig", aliases: %w(Pigs), value: "10 bacon")
+    assert_equal 1, @unit <=> Measured::Unit.new(:Pig, value: [11, :bacon])
   end
 
   test "#inverse_conversion_amount returns 1/amount for BigDecimal" do
-    assert_equal BigDecimal(1)/BigDecimal(10), @unit.inverse_conversion_amount
+    assert_equal BigDecimal(1) / 10, @unit.inverse_conversion_amount
   end
 
   test "#inverse_conversion_amount swaps the numerator and denominator for Rational" do

data/test/units/length_test.rb

@@ -1,12 +1,19 @@
 require "test_helper"
 
 class Measured::LengthTest < ActiveSupport::TestCase
-  test ".units_with_aliases should be the expected list of valid units" do
-    assert_equal ["centimeter", "centimeters", "centimetre", "centimetres", "cm", "feet", "foot", "ft", "in", "inch", "inches", "m", "meter", "meters", "metre", "metres", "millimeter", "millimeters", "millimetre", "millimetres", "mm", "yard", "yards", "yd"], Measured::Length.units_with_aliases
-  end
-
-  test ".units should be the list of base units" do
-    assert_equal ["cm", "ft", "in", "m", "mm", "yd"], Measured::Length.units
+  test ".unit_names_with_aliases should be the expected list of valid units" do
+    assert_equal(
+      %w(
+        centimeter centimeters centimetre centimetres cm feet foot ft
+        in inch inches m meter meters metre metres millimeter
+        millimeters millimetre millimetres mm yard yards yd
+      ),
+      Measured::Length.unit_names_with_aliases
+    )
+  end
+
+  test ".unit_names should be the list of base unit names" do
+    assert_equal %w(cm ft in m mm yd), Measured::Length.unit_names
   end
 
   test ".name" do

data/test/units/weight_test.rb

@@ -5,12 +5,15 @@ class Measured::WeightTest < ActiveSupport::TestCase
     @weight = Measured::Weight.new(1, "g")
   end
 
-  test ".units_with_aliases should be the expected list of valid units" do
-    assert_equal ["g", "gram", "grams", "kg", "kilogram", "kilograms", "lb", "lbs", "ounce", "ounces", "oz", "pound", "pounds"], Measured::Weight.units_with_aliases
+  test ".unit_names_with_aliases should be the expected list of valid units" do
+    assert_equal(
+      %w(g gram grams kg kilogram kilograms lb lbs ounce ounces oz pound pounds),
+      Measured::Weight.unit_names_with_aliases
+    )
   end
 
-  test ".units should be the list of base units" do
-    assert_equal ["g", "kg", "lb", "oz"], Measured::Weight.units
+  test ".unit_names should be the list of base unit names" do
+    assert_equal %w(g kg lb oz), Measured::Weight.unit_names
   end
 
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: measured
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 2.0.0.pre1
 platform: ruby
 authors:
 - Kevin McPhillips
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-28 00:00:00.000000000 Z
+date: 2017-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -99,24 +99,28 @@ files:
 - lib/measured.rb
 - lib/measured/arithmetic.rb
 - lib/measured/base.rb
-- lib/measured/case_sensitive_measurable.rb
-- lib/measured/conversion.rb
+- lib/measured/case_insensitive_unit.rb
+- lib/measured/case_insensitive_unit_system.rb
 - lib/measured/conversion_table.rb
 - lib/measured/measurable.rb
 - lib/measured/unit.rb
+- lib/measured/unit_system.rb
+- lib/measured/unit_system_builder.rb
 - lib/measured/units/length.rb
 - lib/measured/units/weight.rb
 - lib/measured/version.rb
 - measured.gemspec
 - shipit.rubygems.yml
 - test/arithmetic_test.rb
-- test/case_sensitive_measurable_test.rb
+- test/case_insensitive_unit_system_test.rb
+- test/case_insensitive_unit_test.rb
 - test/conversion_table_test.rb
-- test/conversion_test.rb
 - test/measurable_test.rb
 - test/support/fake_system.rb
 - test/test_helper.rb
 - test/unit_error_test.rb
+- test/unit_system_builder_test.rb
+- test/unit_system_test.rb
 - test/unit_test.rb
 - test/units/length_test.rb
 - test/units/weight_test.rb
@@ -135,9 +139,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.5.1
@@ -146,13 +150,15 @@ specification_version: 4
 summary: Encapsulate measurements with their units in Ruby
 test_files:
 - test/arithmetic_test.rb
-- test/case_sensitive_measurable_test.rb
+- test/case_insensitive_unit_system_test.rb
+- test/case_insensitive_unit_test.rb
 - test/conversion_table_test.rb
-- test/conversion_test.rb
 - test/measurable_test.rb
 - test/support/fake_system.rb
 - test/test_helper.rb
 - test/unit_error_test.rb
+- test/unit_system_builder_test.rb
+- test/unit_system_test.rb
 - test/unit_test.rb
 - test/units/length_test.rb
 - test/units/weight_test.rb

data/lib/measured/case_sensitive_measurable.rb

@@ -1,7 +0,0 @@
-class Measured::CaseSensitiveMeasurable < Measured::Measurable
-  class << self
-    def conversion
-      @conversion ||= Measured::Conversion.new(case_sensitive: true)
-    end
-  end
-end

data/lib/measured/conversion.rb

@@ -1,95 +0,0 @@
-class Measured::Conversion
-  ARBITRARY_CONVERSION_PRECISION = 20
-  def initialize(case_sensitive: false)
-    @base_unit = nil
-    @units = []
-    @case_sensitive = case_sensitive
-  end
-
-  attr_reader :base_unit, :units, :case_sensitive
-
-  def set_base(unit_name, aliases: [])
-    add_new_unit(unit_name, aliases: aliases, base: true)
-  end
-
-  def add(unit_name, aliases: [], value:)
-    add_new_unit(unit_name, aliases: aliases, value: value)
-  end
-
-  def unit_names_with_aliases
-    @units.map{|u| u.names}.flatten.sort
-  end
-
-  def unit_names
-    @units.map{|u| u.name}.sort
-  end
-
-  def unit_or_alias?(name)
-    @units.each{|unit| return true if unit.names_include?(name, case_sensitive: @case_sensitive)}
-    false
-  end
-
-  def unit?(name)
-    @units.each{|unit| return true if unit.name_eql?(name, case_sensitive: @case_sensitive)}
-    false
-  end
-
-  def to_unit_name(name)
-    unit_for(name).name
-  end
-
-  def convert(value, from:, to:)
-    raise Measured::UnitError, "Source unit #{ from } does not exits." unless unit?(from)
-    raise Measured::UnitError, "Converted unit #{ to } does not exits." unless unit?(to)
-
-    from_unit = unit_for(from)
-    to_unit = unit_for(to)
-
-    raise Measured::UnitError, "Cannot find conversion entry from #{ from } to #{ to }" unless conversion = conversion_table[from][to]
-
-    BigDecimal(value.to_r * conversion,ARBITRARY_CONVERSION_PRECISION)
-  end
-
-  def conversion_table
-    @conversion_table ||= Measured::ConversionTable.new(@units).to_h
-  end
-
-  private
-
-  def add_new_unit(unit_name, aliases:, 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
-      raise Measured::UnitError, "A base unit has not yet been set."
-    end
-
-    check_for_duplicate_unit_names([unit_name] + aliases)
-
-    unit = Measured::Unit.new(unit_name, aliases: aliases, value: value)
-    @units << unit
-    @base_unit = unit if base
-
-    clear_conversion_table
-
-    unit
-  end
-
-  def check_for_duplicate_unit_names(names)
-    names.each do |name|
-      raise Measured::UnitError, "Unit #{ name } has already been added." if unit_or_alias?(name)
-    end
-  end
-
-  def unit_for(name)
-    @units.each do |unit|
-      return unit if unit.names_include?(name, case_sensitive: @case_sensitive)
-    end
-
-    raise Measured::UnitError, "Cannot find unit for #{ name }."
-  end
-
-  def clear_conversion_table
-    @conversion_table = nil
-  end
-
-end