sy 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e78755a352e971c6b349b4caf3e35f67e95876dd
-  data.tar.gz: 43903464572d42927c2a6ac4359c1341c3f71f79
+  metadata.gz: 10add7f2f0bf05cad700558533497d69933635d9
+  data.tar.gz: 3efd7b86cff1d12b78860996f8071b4ac3e657c1
 SHA512:
-  metadata.gz: 6f817d558c1f3be298243a703ade9c6945d22f3a6febada5fb86e7c375986ea1b5b8d78f7f8d5d463086feea69a5010cb33b199a5e27c513d0a94d1582e9aed9
-  data.tar.gz: 2e953fc6121f7d30419d48493e80b45cb18ea6295eeb8fb5c708bc1f0851f7c9410e334adb742b1c09f32029aca246ad35657342fcf63912312d70f80b362dd3
+  metadata.gz: 76cf82027239bdbdbf335adecafd877c9569be862ab6991514632c9eaf19241ab8a2c677acf7f908a7b2aef7a024221868172f8b663bc9c29fad6eaf1662aec0
+  data.tar.gz: 0416c7c76d69039e84976ede34a3714f0c3128eaf07a8a2fb423fbc837fbb65b2733899629670f159364f46160d10e115ac1924ae53272b502ca1c1fc31b2fce

data/lib/sy.rb

@@ -196,7 +196,7 @@ module SY
   Molarity = ( MoleAmount / LitreVolume ).protect!
 
   # Standard unit of SY::Molarity is SY::MOLAR:
-  MOLAR = Unit.standard of: Molarity, abbreviation: "M"
+  MOLAR = Unit.standard of: Molarity, short: "M"
 
   # Let us now note the #protect! directive at the line above defining
   # SY::Molarity. Method #protect! prevents Molarity from understanding itself

data/lib/sy/dimension.rb

@@ -1,4 +1,4 @@
-#encoding: utf-8
+# -*- coding: utf-8 -*-
 
 # This class represents physical dimension of a metrological quantity.
 # 
@@ -46,7 +46,7 @@ class SY::Dimension
     # Base dimension constructor. Base dimension symbol is expeced as argument.
     # 
     def base symbol
-      raise AErr, "Unknown base dimension: #{symbol}" unless
+      raise ArgumentError, "Unknown base dimension: #{symbol}" unless
         SY::BASE_DIMENSIONS.base_symbols.include? symbol
       return new( symbol => 1 )
     end
@@ -76,7 +76,7 @@ class SY::Dimension
   # 
   def [] ß
     return send ß if SY::BASE_DIMENSIONS.letters.include? ß
-    raise AErr, "Unknown basic dimension: #{ß}"
+    raise ArgumentError, "Unknown basic dimension: #{ß}"
   end
 
   #Two dimensions are equal, if their exponents are equal.

data/lib/sy/expressible_in_units.rb

@@ -1,42 +1,35 @@
-#encoding: utf-8
+# -*- coding: utf-8 -*-
 
-# This mixin endows a class with the capacity to respond to method
-# symbols corresponding to metrological units defined in SY.
+# This mixin provides ability to respond to SY unit symbol methods.
 # 
 module SY::ExpressibleInUnits
-  class RecursionError < StandardError; end
+  RecursionError = Class.new StandardError
 
   def method_missing ß, *args, &block
-    # hack #0: working around a bug in a 3rd party library
-    return self if ß.to_s.include?( 'begin' ) || ß.to_s.include?( 'end' )
-    # hack #1: get rid of missing methods 'to_something', esp. #to_ary
-    super if ß == :to_ary || ß.to_s.starts_with?( 'to_' )
-    begin # prevent recurrent method_missing for the same symbol
-      anti_recursion_exec_with_token ß, :@SY_Units_mmiss do
+    return self if ß.to_s =~ /begin|end/ # 3rd party bug workaround
+    super if ß.to_s =~ /to_.+/ # dissmiss :to_..., esp. :to_ary
+    begin # prevent recurrent call of method_missing for the same symbol
+      anti_recursion_exec token: ß, var: :@SY_Units_mmiss do
         puts "Method missing: '#{ß}'" if SY::DEBUG
-        # Parse the unit symbol.
-        prefixes, units, exps = parse_unit_symbol( ß )
-        # Define the unit method.
-        self.class.module_eval write_unit_method( ß, prefixes, units, exps )
+        prefixes, units, exps = parse_unit_symbol ß
+        # Define the unit method on self.class:
+        ç.module_eval write_unit_method( ß, prefixes, units, exps )
       end
-    rescue NameError => m
-      puts "NameError raised: #{m}" if SY::DEBUG
+    rescue NameError => err
+      puts "NameError raised: #{err}" if SY::DEBUG
       super # give up
     rescue SY::ExpressibleInUnits::RecursionError
       super # give up
-    else # invoke the defined method that we just defined
+    else # actually invoke the method that we just defined
       send ß, *args, &block
     end
   end
 
   def respond_to_missing? ß, *args, &block
-    str = ß.to_s
-    return false if str.start_with?( 'to_' ) ||    # speedup hack
-      str == 'begin' || str == 'end' # bugs in 3rd party library
+    # dismiss :to_... methods and /begin|end/ (3rd party bug workaround)
+    return false if ß.to_s =~ /to_.+|begin|end/
     begin
-      anti_recursion_exec_with_token ß, :@SY_Units_rmiss do
-        parse_unit_symbol( ß )
-      end
+      anti_recursion_exec token: ß, var: :@SY_Units_rmiss do parse_unit ß end
     rescue NameError, SY::ExpressibleInUnits::RecursionError
       false
     else
@@ -53,9 +46,9 @@ module SY::ExpressibleInUnits
     SY::Unit.parse_sps_using_all_prefixes( ß ) # rely on SY::Unit
   end
 
-  # Taking method name symbol as the first argument, and three more arguments
-  # representing equal-length arrays of prefixes, unit symbols and exponents,
-  # appropriate method string is written.
+  # Takes method symbol, and three more array arguments, representing prefixes,
+  # unit symbols and exponents. Generates an appropriate unit method as a string.
+  # Arrays must be of equal length. (Note: 'ß' is 'symbol', 'ς' is 'string')
   # 
   def write_unit_method ß, prefixes, units, exponents
     known_units = SY::Unit.instances
@@ -70,16 +63,14 @@ module SY::ExpressibleInUnits
       full_prefix == '' ? '' : ".#{full_prefix}"
     end
     # Return exponentiation string (suffix) or empty ς if not necessary.
-    exponentiation_ς = lambda do |exponent|
-      exponent == 1 ? '' : " ** #{exponent}"
-    end
+    exponentiation_ς = lambda do |exp| exp == 1 ? '' : " ** #{exp}" end
     # 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 |prefix, unit_ς, exponent|
-      [ find_unit.( unit_ς ).name.to_s.upcase,
-        prefix_method_ς.( prefix ),
-        exponentiation_ς.( exponent ) ]
+    process_triple = lambda do |pfx, unit_ς, exp|
+      [ find_unit.( unit_ς ).name.to_s.upcase, 
+        prefix_method_ς.( pfx ),
+        exponentiation_ς.( exp ) ]
     end
     # Method skeleton:
     if triples.size == 1 && triples.first[-1] == 1 then
@@ -99,8 +90,8 @@ module SY::ExpressibleInUnits
                         "end"
       factors = [ "+( ::SY.Unit( :%s )%s )%s * self" %
                   process_triple.( *triples.shift ) ] +
-        triples.map do |ᴛ|
-          "( ::SY.Unit( :%s )%s.relative ) )%s" % process_triple.( *ᴛ )
+        triples.map do |triple|
+          "( ::SY.Unit( :%s )%s.relative ) )%s" % process_triple.( *triple )
         end
       # Multiply the factors toghether:
       method_body = factors.join( " * \n    " )
@@ -114,12 +105,10 @@ module SY::ExpressibleInUnits
   # supplied block, and releases the token. The method guards against double
   # execution for the same token, raising IllegalRecursionError in such case.
   # 
-  def anti_recursion_exec_with_token token, inst_var
-    registry = self.class.instance_variable_get( inst_var ) ||
-      self.class.instance_variable_set( inst_var, [] )
-    if registry.include? token then
-      raise SY::ExpressibleInUnits::RecursionError
-    end
+  def anti_recursion_exec( token: nil, var: :@SY_anti_recursion_exec )
+    registry = self.class.instance_variable_get( var ) ||
+      self.class.instance_variable_set( var, [] )
+    raise RecursionError if registry.include? token
     begin
       registry << token
       yield if block_given?

data/lib/sy/fixed_assets_of_the_module.rb

@@ -1,11 +1,13 @@
-#encoding: utf-8
+# -*- coding: utf-8 -*-
 
 # Here, fixed assets of the main module are set up.
 # 
 module SY
-  # Basic physical dimensions.
-  # 
-  BASE_DIMENSIONS = {
+  QuantityError = Class.new StandardError # mixing incompatible quantities
+  DimensionError = Class.new StandardError # mixing incompatible dimensions
+  MagnitudeError = Class.new StandardError # creating impossible magnitude
+
+  BASE_DIMENSIONS = {                # Basic physical dimensions.
     L: :LENGTH,
     M: :MASS,
     Q: :ELECTRIC_CHARGE,
@@ -20,7 +22,8 @@ module SY
       keys
     end
 
-    # Base dimensions letters with prefixes.
+    # Base dimensions letters with prefixes. (Remark: I forgot what did I mean
+    # those prefixes for. Something important, I just forgot what.)
     # 
     def prefixed_letters
       [] # none for now
@@ -243,18 +246,6 @@ module SY
       '["B", "s"], [1, -1]'
   end
 
-  # Mainly for mixing incompatible quantities.
-  # 
-  class QuantityError < StandardError; end
-
-  # Mainly for mixing incompatible dimensions.
-  # 
-  class DimensionError < StandardError; end
-
-  # Mainly for negative or otherwise impossible physical amounts.
-  # 
-  class MagnitudeError < StandardError; end
-
   # Convenience dimension accessor.
   # 
   def Dimension id=proc{ return ::SY::Dimension }.call

data/lib/sy/magnitude.rb

@@ -458,7 +458,7 @@ module SY::Magnitude
       begin
         quantity == other.quantity
       rescue NoMethodError
-        raise TErr, "#{other} does not have quantity!"
+        raise TypeError, "#{other} does not have quantity!"
       end
     end
   end

data/lib/sy/quantity.rb

@@ -446,10 +446,10 @@ class SY::Quantity
   end
 
   def explain_amount_of_standard_units
-    raise TErr, "The amount of standard units is, by definition, 1. When " +
-      ":amount named parameter fis supplied to the construtor of a " +
-      "standard unit, it has different meaning: It must be given as " +
-      "a magnitude of another quantity of the same dimension, and it " +
-      "establishes relationship between this and the other quantity."
+    raise TypeError, "For standard units, :amount is 1, by definition. When" +
+      ":amount parameter is supplied to a standard unit constructor, its" +
+      "meaning is different: Using a magnitude of the same dimension, but" +
+      "different quantity, it establishes conversion relationship between" +
+      "the two quantities."
   end
 end # class SY::Quantity

data/lib/sy/version.rb

@@ -1,4 +1,5 @@
 module SY
-  VERSION = "1.0.0"
-  DEBUG = false # ignore this; debugging only
+  VERSION = "1.0.1"
+  DEBUG = false # debug mode switch - sometimes there are lines like
+  # puts "something" if SY::DEBUG
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sy
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - boris
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-16 00:00:00.000000000 Z
+date: 2013-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -38,7 +38,6 @@ files:
 - Rakefile
 - lib/sy.rb
 - lib/sy/absolute_magnitude.rb
-- lib/sy/abstract_algebra.rb
 - lib/sy/composition.rb
 - lib/sy/dimension.rb
 - lib/sy/expressible_in_units.rb

data/lib/sy/abstract_algebra.rb

@@ -1,102 +0,0 @@
-#encoding: utf-8
-
-# Adds abstract algebra concepts to Ruby.
-#
-module Algebra
-  # A Monoid requires:
-  #
-  # Closed and associative addition: #add method
-  # Additive identity element: #additive_identity
-  # 
-  module Monoid
-    def + summand; add summand end
-    def zero; additive_identity end
-  end
-
-  # A group is a monoid with additive inverse.
-  #
-  # additive inversion: #additive_inverse
-  # 
-  module Group
-    include Monoid
-    def -@; additive_inverse end
-    def - subtrahend; add subtrahend.additive_inverse end
-  end
-
-  # A group that fulfills the condition of commutativity
-  #
-  # ( a.add b == b.add a ).
-  # 
-  module AbelianGroup
-    include Group
-  end
-
-  # A ring is a commutative group with multiplication.
-  # 
-  # multiplication: #multiply (associative, distributive)
-  # multiplicative identity element: #multiplicative_identity
-  # 
-  module Ring
-    include AbelianGroup
-    def * multiplicand; multiply multiplicand end
-    def one; multiplicative_identity end
-  end
-
-  # A field is a ring that can do division.
-  # 
-  module Field
-    include Ring
-    def inverse; multiplicative_inverse end
-    def / divisor; multiply divisor.multiplicative_inverse end
-  end
-end
-
-# Patching Integer with Algebra::Ring compliance methods.
-# 
-class << Integer
-  def additive_identity; 0 end
-  alias zero additive_identity
-  def add( other ); self + other end
-  def additive_inverse; -self end
-  def multiply( other ); self * other end
-  def multiplicative_identity; 1 end
-end
-
-# Patching Float with Algebra::Field compliance methods.
-# 
-class << Float
-  def additive_identity; 0.0 end
-  alias zero additive_identity
-  def add( other ); self + other end
-  def additive_inverse; -self end
-  def multiply( other ); self * other end
-  def multiplicative_identity; 1.0 end
-  alias one multiplicative_identity
-  def multiplicative_inverse; 1.0 / self end
-end
-
-# Patching Rational with Algebra::Field compliance methods.
-# 
-class << Rational
-  def additive_identity; Rational 0, 1 end
-  alias zero additive_identity
-  def add( other ); self + other end
-  def additive_inverse; -self end
-  def multiply( other ); self * other end
-  def multiplicative_identity; Rational 1, 1 end
-  alias one multiplicative_identity
-  def multiplicative_inverse; Rational( 1, 1 ) / self end
-end
-
-# Patching Complex with #zero method.
-# 
-class << Complex
-  def additive_identity; Complex 0.0, 0.0 end
-  alias zero additive_identity
-  def add( other ); self + other end
-  def additive_inverse; -self end
-  def multiply( other ); self * other end
-  def multiplicative_identity; Complex 1, 0 end
-  alias one multiplicative_identity
-  def multiplicative_inverse; Complex( 1, 0 ) / self end
-end