sy 2.0.18 → 2.0.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d8f9f7390d20ebd9be2e00dea57e39a1c36de4df
-  data.tar.gz: 91e9d5e9b85fc8789742ec150c2e7760f79f1f8d
+  metadata.gz: b523d585e50b7c1180421f3a08847057165daea9
+  data.tar.gz: 930162faffe96f611c8d61281375140e57922d6d
 SHA512:
-  metadata.gz: 92a5a1360619fe9473357eb3a350baa2839b6c8084c4011ccda4152f975249e60c7f7d7f02d71a3dfcbb53e9e799ba24cef8a92be9273a877fc4f6472c361f53
-  data.tar.gz: bf86c5bbeac6c81f5f6c32552e17532c1761cb8dbeee256dcd532d1dbbe57472ad079f7bd324feb098217bfa9c7a26625107cd2dd7e9fe4c5f338834930050b4
+  metadata.gz: d521ab97e1f86c694b88071f95f05c9ba3daf1e1148568d87d60d4c707311ab9dd3c7d5a779f679fcb646d69234e4db590af0189cf6fde0da57f784d51e2afe4
+  data.tar.gz: 1235ecdf7122635a711e96e2b3ff0c739fc7417d37af57abed3b358a64c00110bb13b56af5bac4e14fc280cd31260e5671367e9c40f8560e13b83521b93cec55

data/README.md

@@ -1,29 +1,53 @@
-# Sy
+# SY - The physical units library.
 
-TODO: Write a gem description
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-    gem 'sy'
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install sy
+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.
 
 ## Usage
 
-TODO: Write usage instructions here
+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.
+
+## 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
+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).
 
 ## 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.
+
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Added some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+5. Create new Pull Request

data/lib/sy/version.rb

@@ -1,5 +1,5 @@
 module SY
-  VERSION = "2.0.18"
+  VERSION = "2.0.19"
   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: 2.0.18
+  version: 2.0.19
 platform: ruby
 authors:
 - boris
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-15 00:00:00.000000000 Z
+date: 2013-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport