i18n-inflector 2.1.0 → 2.2.0

data/ChangeLog

@@ -1,3 +1,415 @@
+commit a60370126b5981255aff1b6de47c98ea3e740c04
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Wed Feb 9 18:49:52 2011 +0100
+
+    Release 2.2.0
+
+commit 38416442533f9c4b44f51ee13f676460ad23fbbc
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Wed Feb 9 18:47:22 2011 +0100
+
+    Tested with Ruby 1.8, Ruby 1.9, i18n-inflector-rails, full-stacked Rails app, I18n v0.4.1 & v0.5.0
+
+commit 732260142ca0ce727b9690c0374c7e5043e95130
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Wed Feb 9 18:17:32 2011 +0100
+
+    README updated
+
+commit ffe39ffe0a4cc26b76c720507c5a46eb7d10b57e
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Wed Feb 9 18:17:10 2011 +0100
+
+    Documentation updated
+
+commit c81ed66f010b350f6db6d21d6194ceb0ba0d8167
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Wed Feb 9 18:16:22 2011 +0100
+
+    EXAMPLES updated
+
+commit 4c09e2c3c5f549eca7a2024cea0e2bb5f3bc5078
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Wed Feb 9 03:45:10 2011 +0100
+
+    Documentation fixes, error messages fixes
+
+commit 3917807f00ff9ec0d641557c29eee15878914b67
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Wed Feb 9 01:21:15 2011 +0100
+
+    Documentation updated
+
+commit 924f84f57d19ff8d1f8a9c18764f40a2f9ccea49
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Tue Feb 8 23:57:57 2011 +0100
+
+    README updated
+
+commit cec22a1422f6b8e4213d8ce435ed0c3fa5390cad
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Tue Feb 8 23:57:36 2011 +0100
+
+    Fixed pattern escaping when locale is not inflected
+
+commit 9649c6b292c169a8d4f7aaa9daa929c61388b9d5
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Tue Feb 8 18:00:58 2011 +0100
+
+    Removed magic symbols from code and fixed regular expression generators to be Ruby 1.8 compliant
+
+commit a41dd59db76910c5a1eb0baa2bc8c818224187bc
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Tue Feb 8 17:59:45 2011 +0100
+
+    Added key-based inflection and multiple patterns support and some tests
+
+commit 3c7f5ae5acf8f0061944fab46dc020b46fa7dd32
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Mon Feb 7 17:16:22 2011 +0100
+
+    Documentation updated
+
+commit aa278841eb957a6ccc858ec6cb86832f59677587
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Mon Feb 7 00:46:41 2011 +0100
+
+    Documentation fix.
+
+commit 90b55fd784818b0456aec01416195b5267fba3ff
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Mon Feb 7 00:46:20 2011 +0100
+
+    Added some old constants in case someone uses them.
+
+commit b083527e545701a1c5fbe39d010618e148db6904
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Mon Feb 7 00:24:11 2011 +0100
+
+    Added config.rb to Manifest.txt
+
+commit 2f917d62b456abe8b54f2e82a2441b35d6b25821
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Mon Feb 7 00:22:41 2011 +0100
+
+    Updated TODO and HISTORY
+
+commit 10e98a1c7fc7d426f437ed0b25ff0c969ff1b2f9
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Mon Feb 7 00:22:06 2011 +0100
+
+    Tests fixed according to strict specification keeping while paring inflection options
+
+commit be4f1f6cb53949166894529ec2a8433098909f43
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Mon Feb 7 00:21:00 2011 +0100
+
+    Documentation updated to reflect the changes
+
+commit 1ea80871cbb114939d8e645b33a91272e72fab78
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Mon Feb 7 00:20:24 2011 +0100
+
+    Interpolation method refactored; cleaned options parsing code
+
+commit 7e4bf4e2bbb21958971c354615c2077e44e66dd9
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Mon Feb 7 00:17:46 2011 +0100
+
+    Removed 'sudo' from installation instruction
+
+commit 47e3b4ee161985f0457b19e9d475f17aa87c8c1e
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Sat Feb 5 17:46:56 2011 +0100
+
+    Tests updated
+
+commit f32e334d04c66a9e7e24e5d9bce3c637ab312c62
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Sat Feb 5 17:46:39 2011 +0100
+
+    Added validations to interpolation and tokens loading routines
+
+commit 83020be4362c615b8191632fc8c7a4f9d03690f5
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Sat Feb 5 17:44:29 2011 +0100
+
+    Known options generation and keeping moved to attr_accessor and class-level instance variable
+
+commit bb09d160ec99b41d26bb6ddcd97f667fc28c21f2
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Sat Feb 5 17:43:03 2011 +0100
+
+    Added new error classes: I18n::InvalidInflectionOption and I18n::InvalidInflectionKind
+
+commit dd702ebff0a0204affd5623bce3df86a1a0f171b
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Sat Feb 5 17:41:58 2011 +0100
+
+    I18n::Inflector::Config updated
+
+commit 7855e234e01be5a4e44a539a01c5730919b5f87d
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Sat Feb 5 17:40:48 2011 +0100
+
+    Added config proxy to API
+
+commit e4500dbfa83371052f4f1fdeaebbb7574bb343b9
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Sat Feb 5 17:40:10 2011 +0100
+
+    Backend module loading moved after config module loading
+
+commit c63d0b50f5492387eafdf6b83fb169f9c9c9feea
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Thu Feb 3 19:56:55 2011 +0100
+
+    I18n::Inflector::Config optimized
+
+commit 39826057121142674a8e366d487f4f1509f03cfb
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Thu Feb 3 19:56:25 2011 +0100
+
+    Documentation updated
+
+commit c2954fb3480b43953ba044ff3826b0ca909ba187
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Thu Feb 3 03:06:30 2011 +0100
+
+    Refactored configuration constants handling and started working on validation routines
+
+commit aefb526f9251c48e0270615d8ae8e8eb31a7b946
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Wed Feb 2 03:48:50 2011 +0100
+
+    Kind validation and I18n::BadInflectionKind implemented in Backend#prepare_inflection_tokens
+
+commit 72699c8d3b075515c7bb005ae284798044880a21
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Wed Feb 2 03:47:39 2011 +0100
+
+    Interpolation routine for complex kinds simplified
+
+commit dbaf3062790c3290fbd738ba2c2176decf7f4c4f
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Wed Feb 2 03:47:15 2011 +0100
+
+    I18n::BadInflectionKind documented
+
+commit 5d287872bea57aaf8ef42f82b3a00bebefebab42
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Wed Feb 2 03:46:53 2011 +0100
+
+    Added I18n::BadInflectionKind exception class
+
+commit 5e887376c1de71b5100d12bac9aac3d3f56836ae
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Wed Feb 2 00:52:19 2011 +0100
+
+    Added some tests for complex patterns
+
+commit d7b371087665ba02b248aa259169877aea33b9df
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Wed Feb 2 00:52:00 2011 +0100
+
+    Documentation updated
+
+commit 584986b39d77fa212cafcce6c7473205f4ede6c1
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Wed Feb 2 00:51:39 2011 +0100
+
+    Complex pattern interpolation simplified a lot.
+
+commit bdbeea5e539f6e690d03f4de253fbaa72f23fa32
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Mon Jan 31 04:55:31 2011 +0100
+
+    Workarounds in complex pattern processing method for Ruby 1.8 (symbols, erronous enumerators)
+
+commit ff0379e4eea9cafe1d4da9cb8b5df1284b710bf0
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Mon Jan 31 02:21:43 2011 +0100
+
+    Interpolation method fixed and improved (now it sends all subpatterns at once)
+
+commit fc4ece4637a00003156e1cdf3742c6b9649bc211
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Mon Jan 31 02:20:21 2011 +0100
+
+    Key reporting in error reporting methods fixed and improved
+
+commit 74194159094b59e87899d3b6f231181912a2f6b0
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Mon Jan 31 02:19:36 2011 +0100
+
+    Reserved keys updated
+
+commit aa374a3e84a45ac69e7c79e8d12596932a44604e
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Mon Jan 31 02:19:05 2011 +0100
+
+    Documentation updated, removed debugging switch from backend method
+
+commit c133c73b5260d44bcbc2a765c5b46a82a14151e9
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Mon Jan 31 02:18:27 2011 +0100
+
+    Documentation fixed
+
+commit 3eca748793ac7e1ac4adb5501ffad69d96485e2c
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Sun Jan 30 23:49:06 2011 +0100
+
+    Added :inflector_cache_aware switch that causes inflector to pass all options to translate call
+
+commit 0a9efaedff51caecd1741dfe39152c9a0dbc387f
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Sun Jan 30 22:58:11 2011 +0100
+
+    Reading of known kinds improved a bit; one intermediate array on each call
+
+commit 09d5358f6f829cea2eb42543270c2a0097fe9472
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Sun Jan 30 20:38:08 2011 +0100
+
+    Updated HISTORY and TODO
+
+commit ac2331d4f72b7cbe9a0c2b1c1860a374210800f6
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Sun Jan 30 20:37:42 2011 +0100
+
+    Removed cache-related stuff. A cache should be other backend for I18n, not a class for Inflector
+
+commit a8c48bf13f8856d48195ca40b4e4110339de2d82
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Sun Jan 30 20:36:18 2011 +0100
+
+    Options preparing methods moved to I18n::Inflector::InflectionOptions, @known is now a lazy hash
+
+commit 9cce55b6dfedf0a1720dd8fd7dbe821f7a666d32
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Sun Jan 30 20:32:52 2011 +0100
+
+    All inflection related exceptions are now aware of translation key
+
+commit abee72cce5f552aa0a217a2ef4ed977d7f251cd5
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Sun Jan 30 17:43:53 2011 +0100
+
+    Added some test for complex patterns mixed with aliased patterns and loud tokens
+
+commit d38d9fdb5e4cea7cd2add52d94a1262d3d54cd9a
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Sun Jan 30 17:40:55 2011 +0100
+
+    Documentation updated
+
+commit 67edeef3557064af60de255f2a0778aa9df5d3e6
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Sun Jan 30 17:40:44 2011 +0100
+
+    Typo removed
+
+commit 0fbcc31ab7ada438dc209d49569daf5d44267b02
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Sun Jan 30 17:40:34 2011 +0100
+
+    Complex patterns now support loud tokens
+
+commit d2cd5d76a457f4865c330b7d22d32e27ae903fc7
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Sun Jan 30 06:09:19 2011 +0100
+
+    Updated TODO, ChangeLog and HISTORY
+
+commit 0c77a0c49f32b3a20d1ad6fd6c16ff441e12d8d3
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Sun Jan 30 05:56:50 2011 +0100
+
+    Added complex patterns support
+
+commit 67c0fc2acfe950d96752094fb42d87e9154d562c
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Sun Jan 30 05:55:24 2011 +0100
+
+    Added lazy enumerators for arrays
+
+commit 6e1db292b9f49570780558b1b1d5a3e9aa833e3f
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Sun Jan 30 04:14:52 2011 +0100
+
+    Options reading refactored: more efficient way of gathering global & local options in API methods
+
+commit b99e4a5b02a685ec0f3c210e00428a337c99082a
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Sun Jan 30 04:09:42 2011 +0100
+
+    Error messages handling refactored: exceptions are more hierarchical and more DRY
+
+commit b9c35db66702d137f21a3ef8cc64caba59b20202
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Sat Jan 29 23:38:01 2011 +0100
+
+    Added some constants for future features
+
+commit d29026e54e5f0fea1f43fd5eb89b37808ed12e09
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Sat Jan 29 23:37:26 2011 +0100
+
+    Added abstract error reporting classes:
+    
+    - I18n::InflectionException,
+    - I18n::InflectionPatternException,
+    - I18n::InclectionConfigurationException.
+
+commit e88c43fccf877dd69ae25c2793f0da4e3103b31c
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Fri Jan 28 03:50:17 2011 +0100
+
+    Bugfix: filtering reserved option names enabled :>
+
+commit 67f6a0c12cbbe4a7e6980b0b3d2f68e39b665dbf
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Fri Jan 28 01:50:24 2011 +0100
+
+    Manifest.txt updated
+
+commit e624ff5e8102ad5bdd0279a428debaded911df8f
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Fri Jan 28 01:49:37 2011 +0100
+
+    Interpolation method moved to I18n::Inflector::Interpolate, loud tokens documented, escaping fixed
+
+commit 25d9c41cf12c4cbfec237abe9dec7b1991df004a
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Thu Jan 27 18:01:20 2011 +0100
+
+    Lists of escape strings are now kind of HSet
+
+commit 290ee7fb55aaca4dfe788f34fffb914660829cae
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Thu Jan 27 17:33:01 2011 +0100
+
+    Added support for loud tokens
+
+commit 7da2fcd563bdc6c9b8bc0475c4163e16860c27e4
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Thu Jan 27 02:46:44 2011 +0100
+
+    Documentation fixes
+
+commit ceb547f1cc32690ff9ee1e6d5225dfe18119164f
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Thu Jan 27 02:46:30 2011 +0100
+
+    Intermediate array removed when dumping hash from LazyHashEnumerator
+
+commit 50eff6c3ce7def1dddd2f840590f17c8a38c5b61
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Thu Jan 27 02:26:30 2011 +0100
+
+    Fixed typo in README
+
 commit abe5a4570b80924c323dde65e30ba30be50446ce
 Author: Paweł Wilk <siefca@gnu.org>
 Date:   Thu Jan 27 01:30:54 2011 +0100

data/Manifest.txt

@@ -19,10 +19,13 @@ lib/i18n-inflector.rb
 lib/i18n-inflector/api.rb
 lib/i18n-inflector/api_strict.rb
 lib/i18n-inflector/backend.rb
+lib/i18n-inflector/config.rb
 lib/i18n-inflector/errors.rb
+lib/i18n-inflector/hset.rb
 lib/i18n-inflector/inflection_data.rb
 lib/i18n-inflector/inflection_data_strict.rb
 lib/i18n-inflector/inflector.rb
+lib/i18n-inflector/interpolate.rb
 lib/i18n-inflector/lazy_enum.rb
 lib/i18n-inflector/long_comments.rb
 lib/i18n-inflector/options.rb

data/README.rdoc

@@ -1,6 +1,6 @@
 = Simple Inflector for I18n
 
-<b>i18n-inflector version <tt>2.1</tt></b> (<b><tt>Anand</tt></b>)
+<b>i18n-inflector version <tt>2.2</tt></b> (<b><tt>Dea</tt></b>)
 
 
 
@@ -8,6 +8,17 @@
 * https://github.com/siefca/i18n-inflector/tree
 * mailto:pw@gnu.org
 
+
+== Features
+
+* Inline inflection using patterns.
+* Key-based inflection using inflection keys.
+* Definable inflection kinds and tokens.
+* Easy to use public API for inflection data.
+* Configurable using special scope of translation data.
+* Complex patterns support; inflection by more than one kind at a time.
+* Negative matching, aliases, default tokens, token groups and more…
+
 == Description
 
 This library contains a backend module for I18n that adds some extra
@@ -18,13 +29,13 @@ within <tt>@{</tt> and <tt>}</tt> symbols. Configuration is stored
 also in translation data, in a scope <tt><locale>.i18n.inflections</tt>,
 where <tt>locale</tt> is a locale subtree.
 
-You can choose different kinds (gender, title, person, time, author, etc.)
+You can create your own inflection kinds (gender, title, person, time, author, etc.)
 of tokens to group them in a meaningful, semantical sets. That means you can
 apply Inflector to do simple inflection by a gender or a person, when some
 language requires it.
 
 It adds the +inflector+ object to the default backend so you can use many
-methods for accessing loaded inflection data at runtime, or set up global
+methods for accessing loaded inflection data at runtime, or to set up global
 switches that are controlling the engine.
 
 Example translation data:
@@ -41,27 +52,42 @@ Example translation data:
           default:  neuter          
         
       
-    welcome:  "Dear @{f:Lady|m:Sir|n:You|All}"
-
-From version 2.1.0 Inflector supports so called named patterns,
+    welcome:  "Dear @{f:Lady|m:Sir|n:You|All}!"
+    
+    @same_but_as_key:
+      f:        "Lady"
+      m:        "Sir"
+      n:        "You"
+      @prefix:  "Dear "
+      @suffix:  "!"
+      @free:    "All"
+
+From version 2.1.0 the Inflector supports so called named patterns,
 which can be used if there is a need to be strict and/or to
 use the same token names but assigned to different kinds. Example:
 
    welcome:  "Dear @gender{f:Lady|m:Sir|n:You|All}"
 
+From version 2.2.0 the Inflector supports complex patterns,
+which can be used to inflect some sentence or a word by more
+than a one kind. That might be very helpful for highly inflected
+languages. An example pattern:
+
+  welcome:  "Dear @gender+number{f+s:Lady|f+p:Ladies|m+s:Sir|m+p:Gentlemen|All}"
+
 == Why?
 
 It's intended to be used in a web projects or other projects where
 translations are performed by many people, yet there is a need to
-substitute fragments of text depending on user's gender, person or
-other data.
+inflect sentences with some external variables.
 
 To achieve similar functionality lambdas can be used but including
-proc objects in translations may be considered as unsafe.
+Proc objects in translations might be considered unsafe or memory
+consuming.
 
 If you have a troop of happy translators that shouldn't have the
 ability to execute any code yet you need some simple inflection
-then you should use this module.
+then this module might help you.
 
 See i18n-inflector-rails[https://rubygems.org/gems/i18n-inflector-rails] if
 you need Rails integration.
@@ -85,7 +111,7 @@ you need Rails integration.
 
 == Installation
 
-* <tt>sudo gem install i18n-inflector</tt>
+* <tt>gem install i18n-inflector</tt>
 
 == Synopsis
 
@@ -131,8 +157,8 @@ Detailed example:
 == More information
 
 * See {I18n::Inflector} module documentation for detailed information about the usage.
+* See {I18n::Inflector::API} class documentation for detailed information about the API.
 * See {I18n::Backend::Inflector} module documentation for detailed information about the internals.
-* See {I18n::Backend::Inflector::API} class documentation for detailed information about the API.
 * See {whole documentation}[http://rubydoc.info/gems/i18n-inflector/] to browse all documents.
 
 == Tests
@@ -142,11 +168,6 @@ You can run tests both with
 * <tt>rake test</tt> or just <tt>rake</tt>
 * run a test file directly, e.g. <tt>ruby -Ilib -Itest test/inflector_test.rb</tt>
 
-== See also
-
-See {i18n-inflector-rails}[https://rubygems.org/gems/i18n-inflector-rails/] if you need
-the Rails plug-in that integrates this module with ActionController.
-
 == Credits
 
 {Heise Media Polska}[http://www.heise-online.pl/] supports Free Software and has