sy 2.0.19 → 2.0.20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b523d585e50b7c1180421f3a08847057165daea9
-  data.tar.gz: 930162faffe96f611c8d61281375140e57922d6d
+  metadata.gz: 8188db91a1be774b2ea6858b9b690c5533664748
+  data.tar.gz: aac76cadeb0e3737136ecb6e81887ac8e4388b57
 SHA512:
-  metadata.gz: d521ab97e1f86c694b88071f95f05c9ba3daf1e1148568d87d60d4c707311ab9dd3c7d5a779f679fcb646d69234e4db590af0189cf6fde0da57f784d51e2afe4
-  data.tar.gz: 1235ecdf7122635a711e96e2b3ff0c739fc7417d37af57abed3b358a64c00110bb13b56af5bac4e14fc280cd31260e5671367e9c40f8560e13b83521b93cec55
+  metadata.gz: a89e002696b4d93d231d7733c40d6aa9753dc20f1ff517e06d3c44abddc7cc335ce5a5de5d9a20c3ac53533fea73a86f640282529b7eda205b3a2db593abe45c
+  data.tar.gz: 769545fec641a14f785b81884e2c71fb60fe6e25655796eef2352b63d27ada1eca88f7856c1ccd549a83484359799ee16bf58bb1598f94ef755fbdea2565f76a

data/README.md

@@ -1,50 +1,50 @@
 # SY - The physical units library.
 
-The most prominent feature of SY is, that it extends the Numeric class
-with methods corresponding to units and their abbreviations. At this place,
-let me also make a polite mention of the other good physical units Ruby,
-phys-units by Masahiro Tanaka, which seem to be inspired by GNU units.
+The most prominent feature of `SY` is, that it extends the `Numeric` class with
+methods corresponding to units and their abbreviations. At this place, let me
+also make a polite mention of the other good library of physical units in Ruby,
+[phys-units](https://github.com/masa16/phys-units), inspired by GNU units.
 
 ## Usage
 
-Upon require 'sy', we can say 5.metre, or Rational( 5, 2 ).metre, and the
-computer will understand, that these numbers represent magnitudes of the
-physical quantity SY::Length expressed in the unit SY::METRE. Equally,
-we can use abbreviations (such as 5.m, 2.5.m), prefixes (such as 5.km,
-5.kilometre, 5.km), exponents (such as 5.m² for 5 square metres) and
-chaining (such as 5.m.s⁻¹ to denote speed of 5 metres per second). Please
-read also the code file lib/sy.rb, where you can find the examples of the
-DSL used to define quantities and their units.
+Upon `require 'sy'`, we can say `5.metre`, or `Rational( 5, 2 ).metre`, and
+the computer will understand, that these numbers represent magnitudes of
+the physical quantity `SY::Length` expressed in the unit `SY::METRE`. Equally,
+we can use abbreviations (such as `5.m`, `2.5.m`), prefixes (such as `5.km`,
+`5.kilometre`, `5.km`), exponents (such as `5.m²` for 5 square metres), and
+chaining (such as `5.m.s⁻¹` to denote speed of 5 metres per second). Please
+read also the code file lib/sy.rb for the DSL statements defining default
+quantities and their units.
 
 ## Unicode exponents
 
 You should definitely learn how to type Unicode exponent characters, such
-as ², ³, ⁻¹ etc. It is possible to use alterantive syntax such as 5.m.s(-1)
-instead of 5.m.s⁻¹, but Unicode exponents should be used everywere except
-non-reused code. Unicode exponents make the physical models that you will
-be constructing with SY much more readable. And we know that code is (usually)
-write once, read many times. So it pays off to type an extra keystroke when
-writing, and that way buy more model readability for the many subsequent
+as `²`, `³`, `⁻¹` etc. It is possible to use alterantive syntax, such as
+`5.m.s(-1)` instead of `5.m.s⁻¹`, but Unicode exponents should be used
+everywere except non-reused code. Unicode exponents make the physical models
+that you will be constructing with SY much more readable. And we know that
+code is (typically) write once, read many times. So it pays off to type an
+extra keystroke when writing to increase readability for the many subsequent
 revisions.
 
 ## Method collisions
 
-One more remark here would be, that due to the fact, that many unit names
-and abbreviations are very short and common words, there can be collisions.
-For example ActiveSupport already provides handling for time units (hour,
-minute, second etc.), which would collide with SY methods of the same name.
-Since SY relies on method_missing, if these methods are already defined for
-numerics, SY's method_missing will not activate and ActiveSupport methods
-will be used. In this particular case, SY methods still can be invoked using
-abbreviations (5.s, 5.h, 5.min).
+As a tribute to pragmatism (I like to think), `SY` extends Numeric with unit
+methods and their abbreviations. The downside is, that since many of these are
+short and common words, there can be collisions. For example, `ActiveSupport`
+already provides handling for time units (hour, minute, second etc.), which
+would collide with SY methods of the same name. Since `SY` relies on `method
+_missing`, if these methods are already defined for numerics, `SY`'s
+method_missing will not activate and ActiveSupport methods will be used. In
+this particular case, `SY` methods still can be invoked using abbreviations
+(`5.s`, `5.h`, `5.min`).
 
 ## Contributing
 
-SY has been written emphasizing the object model over plentitude of defined
-units. There is plenty of room for defining units thus far not defined by SY.
-Also, the object model, though advanced, could possibly be refactored, eg.
-with respect to the way that parametrized descendants of Magnitude are
-introduced.
+`SY` has been written emphasizing the object model over plentitude of defined
+units. There is plenty of room for defining units thus far not defined by `SY`.
+Also, the object model, though advanced, could possibly be refactored, eg. with
+respect to the way that parametrized descendants of `Magnitude` are introduced.
 
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)

data/lib/sy/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sy
 version: !ruby/object:Gem::Version
-  version: 2.0.19
+  version: 2.0.20
 platform: ruby
 authors:
 - boris