sy 2.0.7 → 2.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 672ba8a0946d6df05bb65ff2e23100e0419fdec2
-  data.tar.gz: 19dbf53c658806b0052809bda3e975b8ba7a29df
+  metadata.gz: fbbae1ea1d66b6976a9dbff702b83e891d0a2e71
+  data.tar.gz: 45b1ac5ddb4e8394d96ae22ad4a2e9946e23ec11
 SHA512:
-  metadata.gz: 98ca4cb0b79fc7c73b3ca6a6748415b152ef2e78d291f4775b98832e15c7647e0e613ee9787fde0fa2d7782030be2deeb782debb9280bd0549751453e29bed5f
-  data.tar.gz: c21b90522fe5268c2a9438964dedb51cb07d5813fa237d365fa12869817eb8f51f5a0d8541b73fdbc37f7e66053c22105ea7847c3557f20dafc07e8d5ae72cc5
+  metadata.gz: 61cd30896408251b6611e1d616476e3666fd6d1c006140b4f9472ce15f11dfb29cf47b59a631614b9a8d1c5c74d282562ef70d588abacd3571aba063312ed5bb
+  data.tar.gz: 2c6553261eebeacdf3ab6f9a29094bc855800845d2cf44a3c9d62b19dd86b09c25ce796ad4a50a7de9cc5f070b484c20b2a1a53ec2a6241b7a17ab9f67933d50

data/lib/sy.rb

@@ -66,7 +66,9 @@ module SY
   # of the constant "UNIT" implies, via YSupport's NameMagic mixin, that the
   # name of the object becomes :unit and that it is possible to use syntax
   # such as 42.unit to create magnitudes of SY::Amount.
+  puts "About to construct UNIT." if SY::DEBUG
   UNIT = Unit.standard of: Amount
+  puts "UNIT constructed. SY::Unit instances are #{SY::Unit.instance_names}" if SY::DEBUG
 
   # AVOGADRO_CONSTANT (Nᴀ) is a certain well-known amount of things:
   Nᴀ = AVOGADRO_CONSTANT = 6.02214e23
@@ -75,7 +77,10 @@ module SY
   MoleAmount = Quantity.dimensionless coerces: Amount
 
   # And let SY::MOLE be its standard unit, related to SY::Amount via Nᴀ:
+  puts "About to construct MOLE." if SY::DEBUG
   MOLE = Unit.standard of: MoleAmount, short: "mol", amount: Nᴀ.unit
+  puts SY::Unit.__instances__ if SY::DEBUG
+  puts "MOLE constructed. SY::Unit instances are #{SY::Unit.instance_names}" if SY::DEBUG
 
   # === Basic dimension L (length)
 
@@ -141,18 +146,49 @@ module SY
   CELSIUS = Unit.standard( of: CelsiusTemperature,
                            short: '°C', measure: CELSIUS_MEASURE )
 
-  class << CelsiusTemperature
-    # FIXME: Patch CelsiusTemperature to make it work with SY::Temperature
-    # 1.°C + 1.K #=> 2.°C
-    # 1.°C - 1.°C #=> 0.K (unambiguous)
-    # 1.°C + 1.°C #=> QuantityError (ambiguous)
-    # 1.K +- 1.°C #=> QuantityError (ambiguous)
-    # 1.°C +- 1.K #=> 2.°C
-    # 1.mm.°C⁻¹ #=> 1.mm.K⁻¹ etc.
-    # 1.mm.°C #=> 1.mm.K etc.
-    # 1.mm */ 1.°C #=> QuantityError (ambiguous)
+  module CelsiusMagnitude
+    def + m2
+      puts "CelsiusMagnitude#+ method with #{m2}"   # FIXME: This message doesn't show.
+      return magnitude amount + m2.amount if
+        m2.quantity == SY::Temperature ||
+        m2.quantity.colleague == SY::Temperature
+      raise QuantityError, "Addition of Celsius temepratures is ambiguous!" if
+        m2.quantity == SY::CelsiusTemperature
+      super
+    end
+
+    def - m2
+      puts "CelsiusMagnitude#- method with #{m2}"   # FIXME: This message doesn't show.
+      return magnitude amount - m2.amount if
+        m2.quantity == SY::Temperature ||
+        m2.quantity.colleague == SY::Temperature
+      return super.( SY::Temperature ) if m2.quantity == SY::CelsiusTemperature
+      super
+    end
+
+    # FIXME: #% method etc
   end
 
+  # Making sure that for Celsius temperature, #°C returns absolute magnitude.
+  # 
+  class Numeric
+    def °C
+      SY::CelsiusTemperature.absolute.magnitude self
+    end
+  end
+  # FIXME: Make this more systematic.
+  # FIXME: Make sure that SI prefixes may not be used with Celsius
+  # FIXME: Make sure that highly unusual SI prefixes may not be used
+
+  class << CelsiusTemperature.send( :Magnitude )
+    include SY::CelsiusMagnitude
+  end
+
+  class << CelsiusTemperature.relative.send( :Magnitude )
+    include SY::CelsiusMagnitude
+  end
+
+
   # alias :°C :celsius                 # with U+00B0 DEGREE SIGN
   # alias :˚C :celsius                 # with U+02DA RING ABOVE
   # alias :℃ :celsius                  # U+2103 DEGREE CELSIUS

data/lib/sy/absolute_magnitude.rb

@@ -43,6 +43,8 @@ module SY::AbsoluteMagnitude
   # For absolute magnitudes, #+ method always returns a result framed in
   # corresponding relative quantity.
   # 
+  # TODO: Figure out which module comes on the top in Quantity@Magnitude, whether Magnitude
+  # or SignedMagnitude, and therefore, whether it is necessary to adjust this method.
   def + m2
     return magnitude amount + m2.amount if m2.quantity == quantity.relative
     return quantity.relative.magnitude( amount + m2.amount ) if
@@ -67,6 +69,8 @@ module SY::AbsoluteMagnitude
   # For absolute magnitudes, #- method always returns a result framed in
   # corresponding relative quantity.
   # 
+  # TODO: Figure out which module comes on the top in Quantity@Magnitude, whether Magnitude
+  # or SignedMagnitude, and therefore, whether it is necessary to adjust this method.
   def - m2
     return magnitude amount - m2.amount if m2.quantity == quantity.relative
     return quantity.relative.magnitude( amount - m2.amount ) if

data/lib/sy/expressible_in_units.rb

@@ -68,19 +68,24 @@ module SY::ExpressibleInUnits
       @included_in ||= []
     end
 
+    # Unit namespace.
+    # 
+    def unit_namespace
+      begin
+        SY::Unit
+      rescue NameError # no SY::Unit defined yet
+      end
+    end
+
     # Currently defined unit instances, if any.
     # 
     def known_units
-      unit_namespace = begin
-                         SY::Unit
-                       rescue NameError
-                         return [] # no SY::Unit yet
-                       end
       begin
         unit_namespace.instances
       rescue NoMethodError 
         [] # no #instances method defined yet
       end
+        .tap { |r| puts "Known units are #{r}" if SY::DEBUG }
     end
 
     # All methods defined by this mixin.
@@ -92,7 +97,12 @@ module SY::ExpressibleInUnits
     # Find unit based on name / abbreviation.
     # 
     def find_unit ς
-      known_units.find { |u| u.name.to_s == ς || u.short.to_s == ς }
+      puts "searching for unit #{ς}" if SY::DEBUG
+      known_units.find do |u|
+        u.name.to_s.downcase == ς.downcase &&
+          ( ς == ς.downcase || ς == ς.upcase ) ||
+          u.short.to_s == ς
+      end
     end
 
     # Return prefix method or empty string, if prefix method not necessary.
@@ -121,6 +131,7 @@ module SY::ExpressibleInUnits
         # I'D HAVE TO PERFORM THE COLLISION CHECK HERE
         # IF NO COLLISION, INFORM THE SUBSEQUENT METHOD DEFINED CALL ON
         # SELF.CLASS
+        puts "parsed" if SY::DEBUG
         self.class.instance_variable_set "@no_collision", ß # FIXME: This is too clumsy
         self.class.module_eval write_unit_method( ß, prefixes, units, exps )
         SY::ExpressibleInUnits.method_family << self.class.instance_method( ß )
@@ -155,6 +166,7 @@ module SY::ExpressibleInUnits
   # figures out which SY units it represents, along with prefixes and exponents. 
   # 
   def parse_unit_symbol ß
+    puts "About to parse #{ß} using all prefixes" if SY::DEBUG
     SY::Unit.parse_sps_using_all_prefixes( ß ) # rely on SY::Unit
   end
 
@@ -163,10 +175,12 @@ module SY::ExpressibleInUnits
   # Arrays must be of equal length. (Note: 'ß' is 'symbol', 'ς' is 'string')
   # 
   def write_unit_method ß, prefixes, units, exponents
+    puts "writing unit method #{ß}" if SY::DEBUG
     # Prepare prefix / unit / exponent triples for making factor strings:
     triples = [ prefixes, units, exponents ].transpose
     # A procedure for triple processing before use:
     process_triple = lambda do |pfx, unit_ς, exp|
+      puts "Processing triple #{pfx}, #{unit_ς}, #{exp}." if SY::DEBUG
       [ ::SY::ExpressibleInUnits.find_unit( unit_ς ).name.to_s.upcase, 
         ::SY::ExpressibleInUnits.prefix_method_string( pfx ),
         ::SY::ExpressibleInUnits.exponentiation_string( exp ) ]

data/lib/sy/magnitude.rb

@@ -157,14 +157,16 @@ module SY::Magnitude
 
   # Same magnitudes <em>and</em> same (#eql) quantities.
   # 
-  def eql other
-    raise NotImplementedError
+  def eql? other
+    quantity == other.quantity && amount == other.amount
   end
 
   # Percent operator (remainder after division)
   # 
-  def %
-    raise NotImplementedError
+  def % m2
+    return magnitude amount % m2.amount if quantity == m2.quantity
+    return self % m2.( quantity ) if quantity.coerces? m2.quantity
+    apply_through_coerce :%, m2
   end
 
   # Type coercion for magnitudes.

data/lib/sy/quantity.rb

@@ -261,7 +261,7 @@ class SY::Quantity
     Unit().standard
   end
 
-  # Constructs a new absolute magnitude of this quantity.
+  # Constructs a absolute magnitude of this quantity.
   # 
   def magnitude amount
     puts "Constructing #{self}#magnitude with amount #{amount}." if SY::DEBUG
@@ -436,8 +436,8 @@ class SY::Quantity
                   qnt = self
                   ɴλ = -> { name ? "#{name}@%s" : "#<Quantity:#{object_id}@%s>" }
                   
-                  Class.new Magnitude() do # Unit class.
-                    include SY::Unit
+                  Class.new Magnitude() do puts "Creating @Unit class!" if SY::DEBUG
+                    include SY::Unit; puts "Included SY::Unit" if SY::DEBUG
                     
                     singleton_class.class_exec do
                       define_method :standard do |**nn|      # Customized #standard.
@@ -449,8 +449,12 @@ class SY::Quantity
                         ɴλ.call % "Unit"           # as for @Magnitude applies.)
                       end
                     end
-                  end
-                end )
+                  end.namespace! SY::Unit
+                end ).tap do |u|
+      puts "@Unit constructed, its namespace is #{u.namespace}" if SY::DEBUG
+      puts "its instances are #{u.namespace.instances}" if SY::DEBUG
+      puts "its instance names are #{u.namespace.instance_names}" if SY::DEBUG
+    end
   end
 
   private

data/lib/sy/signed_magnitude.rb

@@ -29,6 +29,8 @@ module SY::SignedMagnitude
 
   # Addition.
   # 
+  # TODO: Figure out which module comes on the top in Quantity@Magnitude, whether Magnitude
+  # or SignedMagnitude, and therefore, whether it is necessary to adjust this method.
   def + m2
     return magnitude( amount + m2.amount ) if quantity == m2.quantity
     return quantity.absolute.magnitude( amount + m2.amount ) if
@@ -38,7 +40,8 @@ module SY::SignedMagnitude
   end
 
   # Subtraction.
-  # 
+  #
+  # TODO: ditto
   def - m2
     return magnitude( amount - m2.amount ) if m2.quantity == quantity.relative
     return quantity.relative.magnitude( amount - m2.amount ) if

data/lib/sy/unit.rb

@@ -6,86 +6,61 @@
 module SY::Unit
   PROTECTED_NAMES = [ "kilogram" ]
 
-  def self.pre_included target
-    class << target
-      # Overriding this method from NameMagic mixin ensures, that all Unit
-      # subclasses use common namespace (Unit), rather than each their own.
-      # 
-      def namespace
-        SY::Unit
-      end
-    end
-  end # def self.pre_included
-
-  # Tweaking instance accessor from NameMagic to make it accept unit
-  # abbreviations and unit names regardless of capitalization
-  # 
-  def self.instance arg
-    puts "SY::Unit module #instance method activated" if SY::DEBUG
-    begin
-      super # let's first try the original method
-        .tap { puts "original #instance method provided by NameMagic succeeded" if SY::DEBUG }
-    rescue NameError               # if we fail...
-      puts "original #instance method provided by NameMagic returned NameError" if SY::DEBUG
-      begin # second in order, let's try whether it's an abbreviation
-        puts "trying whether the argument is an abbreviation" if SY::DEBUG
-        rslt = instances.find { |unit_inst|
-          if unit_inst.abbreviation then
-            if unit_inst.abbreviation.to_s == arg.to_s then
-              puts "For supplied argument #{arg} (#{arg.class}), it seems that " +
-                "unit #{unit_inst} of quantity #{unit_inst.quantity} has abbreviation " +
-                "#{unit_inst.abbreviation} matching it." if SY::DEBUG
-              true
-            else
-              false
-            end
+  class << self
+    # Make Unit#instance ignore capitalization and accept abbreviations.
+    # 
+    def instance arg
+      begin
+        super # let's first try the original method
+      rescue NameError # if we fail...
+        begin # ... let's try the abbreviation
+          super instances.find { |unit_inst|
+            unit_inst.short.to_s == arg.to_s if unit_inst.short
+          }.tap { |rslt| fail NameError if rslt.nil? } # fail if nothing found
+        rescue NameError, TypeError
+          begin # Let's to try upcase if we have all-downcase arg
+            super arg.to_s.upcase
+          rescue NameError # if not, tough luck
+            raise NameError, "Unknown unit symbol: #{arg}"
           end
-          # inst.abbreviation.to_s == arg.to_s if inst.abbreviation
-        }
-        fail NameError if rslt.nil? # if nothing found, super need not be called
-        super rslt
-      rescue NameError, TypeError
-        puts "failed, we'll now try to upcase the argument in case of all-downcase argument" if SY::DEBUG
-        begin # finally, let's try upcase if we have all-downcase arg
-          super arg.to_s.upcase
-        rescue NameError # if not, tough luck
-          raise NameError, "Unknown unit symbol: #{which}"
         end
       end
     end
-  end # def self.instance
-
-  def self.included target
-    target.class_exec do
-      # Let's set up the naming hook for NameMagic:
-      name_set_closure do |name, new_instance, old_name|
-        ɴ = name.to_s
-        up, down = ɴ.upcase, ɴ.downcase
-        # Check case (only all-upper or all-lower is acceptable).
-        unless ɴ == up || ɴ = down
-          raise NameError, "Unit must be either all-upper or all-lower case!"
-        end
-        # Reject the names starting with a full prefix.
-        conflicter = SY::PREFIX_TABLE.full_prefixes
-          .find { |prefix| down.starts_with? prefix unless prefix.empty? }
-        raise NameError, "Name #{ɴ} starts with #{conflicter}- prefix" unless
-          SY::Unit::PROTECTED_NAMES.include? down if conflicter
-        # Warn about the conflicts in modules where the SY::ExpressibleInUnits
-        # mixin is included.
-        if new_instance.warns? then
-          w = ::SY::ExpressibleInUnits::COLLISION_WARNING
-          ::SY::ExpressibleInUnits.included_in.each do |ɱ|
-            im = ɱ.instance_methods
-            # puts ɱ, "class: #{ɱ.class}"
-            # puts im.size
-            # puts down
-            # puts im.include? down
-            warn w  % [down, ɱ] if im.include? down
-            abbrev = new_instance.abbreviation
-            warn w % [abbrev, ɱ] if im.include? abbrev
+
+    def included target
+      target.class_exec do
+        # Let's set up the naming hook for NameMagic:
+        name_set_closure do |name, new_instance, old_name|
+          ɴ = name.to_s
+          up, down = ɴ.upcase, ɴ.downcase
+
+          # Check case (only all-upper or all-lower is acceptable).
+          msg = "Unit must be either all-upper or all-lower case!"
+          fail NameError, msg unless ɴ == up || ɴ = down
+
+          # Reject the names starting with a full prefix.
+          conflicter = SY::PREFIX_TABLE.full_prefixes
+            .find { |prefix| down.starts_with? prefix unless prefix.empty? }
+          fail NameError, "Name #{ɴ} starts with #{conflicter}- prefix!" unless
+            SY::Unit::PROTECTED_NAMES.include? down if conflicter
+
+          # Warn about method name conflicts in the target module(s), where
+          # SY::ExpressibleInUnits mixin is included.
+          if new_instance.warns? then
+            w = ::SY::ExpressibleInUnits::COLLISION_WARNING
+            ::SY::ExpressibleInUnits.included_in.each do |ɱ|
+              im = ɱ.instance_methods
+              # puts ɱ, "class: #{ɱ.class}"
+              # puts im.size
+              # puts down
+              # puts im.include? down
+              warn w % [down, ɱ] if im.include? down
+              abbrev = new_instance.abbreviation
+              warn w % [abbrev, ɱ] if im.include? abbrev
+            end
           end
+          up.to_sym
         end
-        up.to_sym
       end
 
       # name_get_closure { |name| name.to_s.downcase.to_sym }
@@ -108,10 +83,10 @@ module SY::Unit
           end
         end
       end
-    end # module_exec
-  end # def self.included
+    end # def included
+  end # class << self
 
-  include NameMagic
+  include NameMagic # it respects prefiously defined self.included
 
   class << self
     # Constructor of units of a given quantity.
@@ -144,14 +119,13 @@ module SY::Unit
     # Full list of known unit names and unit abbreviations.
     # 
     def known_symbols
-      instance_names + abbreviations.keys
+      instance_names.map( &:downcase ) + abbreviations.keys
     end
 
     # Parses an SPS, curring it with known unit names and abbreviations,
     # and all known full and short prefixes.
     # 
     def parse_sps_using_all_prefixes sps
-      puts "Unit about to sps parse (#{sps})" if SY::DEBUG
       SY::PREFIX_TABLE.parse_sps( sps, known_symbols )
     end
   end # class << self
@@ -178,15 +152,6 @@ module SY::Unit
   def short= unit_abbreviation
     @abbreviation = unit_abbreviation.to_sym
   end
-    
-  # Unit name. While named units are typically introduced as constants in
-  # all-upper case, their names are then presented in all-lower case.
-  # 
-  def name
-    ɴ = super
-    return ɴ ? ɴ.to_s.downcase.to_sym : nil
-  end
-  alias ɴ name
 
   # Constructor of units provides support for one additional named argument:
   # :abbreviation, alias :short. (This is in addition to :name, alias :ɴ named

data/lib/sy/version.rb

@@ -1,5 +1,5 @@
 module SY
-  VERSION = "2.0.7"
+  VERSION = "2.0.9"
   DEBUG = false # debug mode switch - sometimes there are lines like
   # puts "something" if SY::DEBUG
 end

data/test/sy_test.rb

@@ -241,7 +241,7 @@ describe SY::Quantity, SY::Magnitude do
       1.Mt.must_equal 1000.kiloton
       1.mm.quantity.name.must_equal :Length±
       SY::Length.standard_unit.must_equal SY::METRE
-      SY::Length.standard_unit.name.must_equal :metre
+      SY::Length.standard_unit.name.must_equal :METRE
       SY::Length.standard_unit.must_equal SY::METRE
       SY.Quantity( :Length ).object_id.must_equal SY::Length.object_id
       SY::Length.relative.object_id.must_equal SY.Quantity( :Length± ).object_id
@@ -250,7 +250,7 @@ describe SY::Quantity, SY::Magnitude do
       SY.Quantity( :Length± ).colleague.object_id.must_equal SY::Length.object_id
       SY.Quantity( :Length± ).send( :Unit ).object_id
         .must_equal SY::Length.send( :Unit ).object_id
-      1.mm.quantity.standard_unit.name.must_equal :metre
+      1.mm.quantity.standard_unit.name.must_equal :METRE
       1.mm.to_s.must_equal "0.001.m"
       1.mm.inspect.must_equal "#<±Magnitude: 0.001.m >"
       1.µs.inspect.must_equal "#<±Magnitude: 1e-06.s >"
@@ -258,12 +258,12 @@ describe SY::Quantity, SY::Magnitude do
       SY::Area.dimension.must_equal SY.Dimension( :L² )
       SY::Area.composition.must_equal SY::Composition[ SY::Length => 2 ]
       
-      SY::AMPERE.name.must_equal :ampere
+      SY::AMPERE.name.must_equal :AMPERE
       SY::AMPERE.abbreviation.must_equal :A
       SY::AMPERE.dimension.must_equal 1.A.dimension
       SY.Magnitude( of: SY::ElectricCurrent, amount: 1 ).must_equal 1.A.absolute
       1.A.quantity.must_equal SY::ElectricCurrent.relative
-      1.A.quantity.standard_unit.name.must_equal :ampere
+      1.A.quantity.standard_unit.name.must_equal :AMPERE
       1.A.to_s( SY::AMPERE ).must_equal "1.A"
       1.A.to_s.must_equal "1.A"
       1.A.amount.must_equal 1
@@ -313,7 +313,7 @@ describe SY::Quantity, SY::Magnitude do
         rescue
         end
       end.must_include :M
-      SY::Unit.instance_names.must_include :mole
+      SY::Unit.instance_names.must_include :MOLE
       # Avogadro's number is defined directly in SY
       1.mol.quantity.object_id.must_equal SY::Nᴀ.unit.( SY::MoleAmount ).quantity.object_id
       SY::Nᴀ.unit.( SY::MoleAmount ).must_equal 1.mol
@@ -392,6 +392,40 @@ describe SY::Quantity, SY::Magnitude do
       assert_equal 273.15, 0.°C.in( :K )
       assert_equal SY::Unit.instance( :SECOND ), SY::Unit.instance( :second )
       assert_equal SY::TRIPLE_POINT_OF_WATER, 0.°C # coercion behavior
+      assert 2.°C.eql?( 1.°C + 1.K )
+      assert ( 1.°C - 1.°C ).eql?( 0.K )
+      assert_equal :raised, begin
+                              1.°C + 1.°C
+                              :nothing_raised
+                            rescue QuantityError
+                              :raised
+                            end
+      assert_equal :raised, begin
+                              1.K + 1.°C
+                              :nothing_raised
+                            rescue QuantityError
+                              :raised
+                            end
+      assert_equal :raised, begin
+                              1.K - 1.°C
+                              :nothing_raised
+                            rescue QuantityError
+                              :raised
+                            end
+      assert 1.mm.K⁻¹.eql?( 1.mm.°C⁻¹ )
+      assert 1.mm.K.eql?( 1.mm.°C )
+      assert_equal :raised, begin
+                              1.mm / 1.°C
+                              :nothing_raised
+                            rescue QuantityError
+                              :raised
+                            end
+      assert_equal :raised, begin
+                              1.mm * 1.°C
+                              :nothing_raised
+                            rescue QuantityError
+                              :raised
+                            end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sy
 version: !ruby/object:Gem::Version
-  version: 2.0.7
+  version: 2.0.9
 platform: ruby
 authors:
 - boris
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-24 00:00:00.000000000 Z
+date: 2013-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport