y_support 2.0.38 → 2.0.39

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 162144f60bcef05c8ffbedaf26734b109de7baf9
-  data.tar.gz: 06d085bb97dd3ff85ff814b375b08b9cf24aa8f8
+  metadata.gz: ed2dababbc49adf84a88b8412d7d8a52d2106c5c
+  data.tar.gz: afbdb0ab6c8a7dada0c501a4757b01b850afeba6
 SHA512:
-  metadata.gz: 5371cd77eccef072a5fb9e49d3964fb7f71aa2e0c4ad515f8d884bcdd475a156ea7f908f111b9b02eaf4aad5a47b171360f0543f414f1f374905ce20153bef2a
-  data.tar.gz: 905f4e5b783484bc41dcc21b220a6e3a3a0692f5712b9e8d4d701f1556b042d647a8473e5d2d2b9d145b2b94c204b2c61a75b37dd62a74e297fb68ac8d2fcf5a
+  metadata.gz: 52cc87bbe3e00e2ba464787745f4f2ea246423c7f0e530666c05aa88397c1cefb2dddfcb6d61dc4ed0e810f32b97053bad2cc7ea2cfa9715e4592f8627dbaccb
+  data.tar.gz: 25f0078f9df59bbec95f830f5fb3702ad7e6e2b046e5f420bd64ae73437ae2bc3a8fc876ea529d9c2d978efcf7b8f6f6699ee4013240dcc3b7e3465e0f20b6c0

data/README.md

@@ -1,24 +1,57 @@
 # YSupport
 
-Common support library for Y* gems.
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-    gem 'y_support'
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install y_support
-
-## Usage
-
-Require 'y_support/all', or require 'y_support/something', and use it.
+`YSupport` is a common support library for Y* gems (`y_petri`, `yzz`,
+`y_nelson`, `sy`...). At the moment, it is a collection of all and sundry
+helpful methods, which can be divided as follows
+
+  * `NameMagic` (`lib/name_magic.rb`) -- its main feature is that it allows
+    constant magic known from classes to work with any objects.
+  * Miscellaneous helpful methods (`lib/misc.rb`)
+  * Typing (runtime assertions, `lib/typing.rb`)
+  * Other smaller components:
+    - `unicode.rb` -- shortcut letter for class (ç), singleton class (ⓒ) etc.
+    - `null_object.rb`
+    - `try.rb` -- a different kind of `#try` method
+    - several other small fry components
+
+## NameMagic
+
+Try for example:
+```ruby
+  require 'y_support/name_magic'
+
+  class Animal
+    include NameMagic
+    def sound; "squeak" end
+    def speak; 2.times { puts sound.capitalize << ?! } end
+  end
+
+  class Dog < Animal; def sound; "bark" end end
+  class Cat < Animal; def sound; "meow" end end
+
+  Pochi = Dog.new
+  unnamed_kitten = Cat.new
+```
+Mixin `NameMagic` makes class `Animal` keep registry of its instances:
+```ruby
+  Animal.instances.names
+  #=> [:Pochi, nil]
+  Tama = unnamed_kitten
+  Animal.instances.names
+  #=> [:Pochi, :Tama]
+  Cheburashka = Animal.new
+  Animal.instances.names
+  #=> [:Pochi, :Tama, :Cheburashka]
+  Dog.instances.names
+  #=> [:Pochi]
+  Animal.instances.each &:speak
+  Dog.instances.each &:speak
+  Cat.instances.each &:speak
+```
+
+## Other components
+
+Read the documentation of the individual methods.
 
 ## Contributing
 

data/lib/y_support/version.rb

@@ -1,4 +1,4 @@
 module YSupport
-  VERSION = "2.0.38"
+  VERSION = "2.0.39"
   DEBUG = false
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: y_support
 version: !ruby/object:Gem::Version
-  version: 2.0.38
+  version: 2.0.39
 platform: ruby
 authors:
 - boris