i18n-inflector 1.0.11 → 2.0.0

data/.yardopts

@@ -4,8 +4,9 @@
 --no-private
 --hide-void-return
 -
+docs/RELATIONS
 docs/HISTORY
 ChangeLog
 docs/COPYING
-docs/LGPL-LICENSE
+docs/LGPL
 docs/TODO

data/ChangeLog

@@ -1,14 +1,149 @@
-commit d8aedac664b622abd120e6b00f4de63b060fa887
+commit e7a6eb41eab2f76881169eeabb03e9540adeeb0e
 Author: Paweł Wilk <siefca@gnu.org>
-Date:   Sat Jan 15 15:01:05 2011 +0100
+Date:   Fri Jan 14 17:33:44 2011 +0100
 
-    Compatibility release 1.0.11
+    Version 2.0.0 ready to be released
 
-commit e5390e53a44e610883d818d8230515157df5e6a8
+commit 9d87da0b8781be172ed7216aafc57e3bde096504
 Author: Paweł Wilk <siefca@gnu.org>
-Date:   Sat Jan 15 14:58:30 2011 +0100
+Date:   Fri Jan 14 17:29:19 2011 +0100
 
-    Fixed doco and Rakefile
+    Added more tests and cleaned up conditional expressions in InflectionData
+
+commit 295f2e3c98a23b1109e8e8355c008e9d59ecd010
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Fri Jan 14 16:26:20 2011 +0100
+
+    Version 2.0.0 tested in Rails 3 environment
+
+commit 62785a25f593460d91294cd87fdde254acb5f2e3
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Fri Jan 14 15:06:14 2011 +0100
+
+    Speed improvements.
+
+commit 1b3ac06a779288f8f9584dd0fc4f50e9f1728a34
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Fri Jan 14 12:54:40 2011 +0100
+
+    Updated version information in README
+
+commit d76bd2a91323c8f612a7328191b69014353a3802
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Fri Jan 14 12:52:13 2011 +0100
+
+    Version 2.0.0
+
+commit 33c2e77ecef865c7f1813c1a7db899e66be98c13
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Fri Jan 14 12:36:36 2011 +0100
+
+    Version 1.2.0
+
+commit c86af221fe2a3d7f0bcba863a2ef9e2a91d4825a
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Fri Jan 14 12:31:47 2011 +0100
+
+    Documentation updates, code cleanups
+
+commit 2fb80a5725325071b9dbad85c8662e263edcfbcc
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Fri Jan 14 02:55:12 2011 +0100
+
+    README.rdoc fixed
+
+commit f39db3b5a29ee34706326d337cc766983a1bfb9b
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Fri Jan 14 02:51:52 2011 +0100
+
+    Added RELATIONS to documentation
+
+commit bf8a9799aa0600eddecbf95a981947cf2ef805ef
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Fri Jan 14 02:51:06 2011 +0100
+
+    Documentation updated
+
+commit 4bf626399b4556ee2a4aaa76a9a7559bd20464a3
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Thu Jan 13 18:47:08 2011 +0100
+
+    Serious refactoring
+    
+    - Interpolating method moved to I18n::Inflector
+    - Loading inflections now creates InflactionData object that feeds I18n::Inflector::Core
+    - Locale management created in I18n::Inflector::Core (pluggable databases)
+    - Added safe_data() and data() methods to Core in order to simplify inflection database calls
+    - Removed send() calls, removed bridge; not needed anymore
+    - InflectionData initializer can now be feeded with locale (it's also stored there)
+    - Removed unneeded I18n::Inflector::Util incusion in I18n::Inflector::Backend
+
+commit 0fc113797bdd9ff7bd3d1e953385c6670064b936
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Thu Jan 13 06:36:19 2011 +0100
+
+    I18n::Inflector is a regular module and inflector is sticked to the backend again
+    
+    New class I18n::Inflector::Core is API to deal with inflection data.
+    Inflector is now @inflector in altered I18n::Backend::Simple and I18n.inflector is a proxy method
+
+commit cf547a804c4c90418e8cfb69de405660a959eba9
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Thu Jan 13 05:25:21 2011 +0100
+
+    Options are now kind of InflectionOptions and are controlled by I18n::Inflector class methods
+
+commit a7cbc568ca90d67a4c7ef2b9c9c08f1c5dbc94f0
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Thu Jan 13 01:56:15 2011 +0100
+
+    Errors moved out if I18n::Inflector::InflectionData, documentation updated a bit
+
+commit 324a647292c9e9d5121b0b2bd18fb83151458afb
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Wed Jan 12 22:13:52 2011 +0100
+
+    Code refactored. Added class InflectionData and keeping all data in its instance
+    
+    Aliases are now keeped along with tokens in one hash, there are also some new API methods
+
+commit faa4ca16bbafb572e7d209e139b8664406040a43
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Wed Jan 12 01:36:26 2011 +0100
+
+    Serious refactoring and namespace changes
+    
+    - Most of inflector-specific API methods are now in I18n::Inflector
+    - Core logic (loading and translations) in I18n::Backend::Inflector
+    - Useful methods used in both modules listed above in I18n::Inflector::Util
+    - Added new method for checking if token exists
+    - Added bridge between I18n::Inflector and I18n::Backend::Inflector (init_frontend)
+    - Started working on feature for is_* methods (additional argument narrows tests to some kind)
+    - Changed method names to more intuitive
+
+commit edc402233f62b6a135882a28fc1c284d5a5fee99
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Tue Jan 11 21:50:28 2011 +0100
+
+    Added support for negative matches in patterns
+
+commit 6cf50a1b31c61a0f0ddb102d8b5f1a68bf769247
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Tue Jan 11 16:04:16 2011 +0100
+
+    Added support for token groups seaprated by commas
+
+commit e399d04ba157e16fe45c55b41ff5cb313ce6da3e
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Tue Jan 11 08:21:32 2011 +0100
+
+    Inflected locale testing is not raising errors when entered locale is invalid
+
+commit a336e2376c3e0e2e50f1404529dd5e726732583b
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Mon Jan 10 05:38:14 2011 +0100
+
+    Fix for apps initializing translations via YAML files
 
 commit dc81afa48b36336b9efde0ce9019637edc0474f8
 Author: Paweł Wilk <siefca@gnu.org>

data/Gemfile

@@ -9,6 +9,7 @@ gem "test_declarative", ">=0.0.4", :group => [:development, :test]
 gem "yard", ">=0.6.4", :group => [:development, :test]
 gem "bundler", ">=1.0.7", :group => [:development, :test]
 gem "hoe-bundler", ">=1.0.0", :group => [:development, :test]
+gem "hoe-yard", ">=0.1.2", :group => [:development, :test]
 gem "hoe", ">=2.8.0", :group => [:development, :test]
 
 # vim: syntax=ruby

data/Manifest.txt

@@ -9,14 +9,18 @@ ci/i18n-inflector.gemspec
 docs/COPYING
 docs/HISTORY
 docs/LEGAL
-docs/LGPL-LICENSE
+docs/LGPL
+docs/RELATIONS
 docs/TODO
 docs/rdoc.css
 lib/i18n-inflector.rb
+lib/i18n-inflector/backend.rb
 lib/i18n-inflector/errors.rb
+lib/i18n-inflector/inflection_data.rb
 lib/i18n-inflector/inflector.rb
 lib/i18n-inflector/long_comments.rb
-lib/i18n-inflector/shortcuts.rb
+lib/i18n-inflector/options.rb
+lib/i18n-inflector/util.rb
 lib/i18n-inflector/version.rb
 test/inflector_test.rb
 test/test_helper.rb

data/README.rdoc

@@ -1,6 +1,6 @@
 = Simple Inflector for I18n
 
-<b>i18n-inflector version <tt>1.0</tt></b> (<b><tt>Aropsaid</tt></b>)
+<b>i18n-inflector version <tt>2.0</tt></b> (<b><tt>Harvester</tt></b>)
 
 
 
@@ -8,23 +8,19 @@
 * https://github.com/siefca/i18n-inflector/tree
 * mailto:pw@gnu.org
 
-This library contains a backend module for I18n that adds some extra
-functionality to standard backend. It overwrites the translate method
-so that it will interpolate additional inflection tokens present in
-translations. These tokens may appear in *patterns* which are contained
-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.
+== Description
+
+This backend module for Ruby's I18n overwrites the Simple backend
+translate method so that it will interpolate additional inflection
+tokens present in translations. These tokens may appear in *patterns*
+which are contained within <tt>@{</tt> and <tt>}</tt>
+symbols.
 
 You can choose different 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
-switches that are controlling the engine.
-
 Example translation data:
 
   en:
@@ -44,17 +40,20 @@ Example translation data:
 == 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
+tranlations are performed by many people, yet there is a need to
 substitute fragments of text depending on user's gender, person or
 other data.
 
 To achieve similar functionality lambdas can be used but including
-proc objects in translations may be considered as unsafe.
+proc objects in translations may be considered as the unsafe idea.
 
 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.
 
+See i18n-inflector-rails[https://rubygems.org/gems/i18n-inflector-rails] if
+you need Rails integration.
+
 == Requirements
 
 * i18n[https://rubygems.org/gems/i18n]
@@ -83,27 +82,30 @@ then you should use this module.
 
 Detailed example:
 
-  I18n.locale = :en
-  I18n.backend.store_translations 'en', :i18n => { :inflections => {
-                                                     :gender => {
-                                                       :f => 'female',
-                                                       :m => 'male',
-                                                       :n => 'neuter',
-                                                       :default => 'n' }}}
+===== YAML:
+  en:
+    i18n:
+      inflections:
+        gender:
+          f:        "female"
+          m:        "male"
+          n:        "neuter"
+          default:  n
    
-   I18n.backend.store_translations 'en', 'welcome' => 'Dear @{f:Lady|m:Sir|n:You|All}'
-  
+    welcome:  "Dear @{f:Lady|m:Sir|n:You|All}"
+
+===== Code:
    I18n.t('welcome')
    # => "Dear You"
    
-   I18n.t('welcome', :gender => :m)
+   I18n.t('welcome', :gender => :male)
    # => "Dear Sir"
    
    I18n.t('welcome', :gender => :unknown)
-   # => "Dear You"
+   # => "Dear All"
    
    I18n.t('welcome', :gender => nil)
-   # => "Dear You"
+   # => "Dear All"
 
 == Tests
 
@@ -116,7 +118,9 @@ You can run tests both with
 
 See {whole documentation}[http://rubydoc.info/gems/i18n-inflector/] for more info about usage.
 
-See {I18n::Backend::Inflector} module documentation for detailed information.
+See {I18n::Inflector} module documentation for information about API and detailed usage.
+
+See {I18n::Backend::Inflector} module documentation for detailed information about internals.
 
 == See also
 
@@ -134,7 +138,7 @@ Copyright (c) 2011 by Paweł Wilk.
 
 i18n-inflector is copyrighted software owned by Paweł Wilk (pw@gnu.org).
 You may redistribute and/or modify this software as long as you
-comply with either the terms of the LGPL (see {file:LGPL-LICENSE}),
+comply with either the terms of the LGPL (see {file:LGPL}),
 or Ruby's license (see {file:COPYING}).
 
 THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS

data/Rakefile

@@ -1,6 +1,6 @@
 # encoding: utf-8
 # -*- ruby -*-
- 
+
 $:.unshift File.join(File.dirname(__FILE__), "lib")
 
 require 'rubygems'
@@ -41,16 +41,13 @@ Hoe.spec 'i18n-inflector' do
   self.rsync_args      << '--chmod=a+rX'
   self.readme_file     = 'README.rdoc'
   self.history_file    = 'docs/HISTORY'
-  
+
   extra_deps          << ['i18n',             '>= 0.4.1']
   extra_dev_deps      << ['test_declarative', '>= 0.0.4'] <<
                          ['yard',             '>= 0.6.4'] <<
                          ['bundler',          '>= 1.0.7'] <<
-                         ['hoe-bundler',      '>= 1.0.0']
-
-  unless extra_dev_deps.flatten.include?('hoe-yard')
-    extra_dev_deps << ['hoe-yard', '>= 0.1.2']
-  end
+                         ['hoe-bundler',      '>= 1.0.0'] <<
+                         ['hoe-yard',         '>= 0.1.2']
 end
 
 task 'Manifest.txt' do

data/ci/i18n-inflector.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |s|
   s.description  = I18n::Inflector::DESCRIPTION
 
   s.files        = Dir.glob("{ci,lib,spec,docs}/**/**") + %w(Gemfile .rspec .yardopts README.rdoc LGPL-LICENSE ChangeLog Manifest.txt)
-  s.extra_rdoc_files = ["README.rdoc", "docs/TODO", "docs/HISTORY", "docs/LGPL-LICENSE", "docs/COPYING"]
+  s.extra_rdoc_files = ["README.rdoc", "docs/TODO", "docs/HISTORY", "docs/LGPL", "docs/COPYING"]
   s.rdoc_options = ["--main", "README.rdoc"]
   s.platform     = Gem::Platform::RUBY
   s.require_path = 'lib'
@@ -22,11 +22,11 @@ Gem::Specification.new do |s|
   s.required_rubygems_version = '>= 1.3.5'
   s.specification_version = 3
 
-  s.add_dependency             'i18n',              '>= 0.5.0'
+  s.add_dependency             'i18n',              '>= 0.4.1'
   s.add_development_dependency 'test_declarative',  '>= 0.0.4'
   s.add_development_dependency 'rspec',             '>= 2.3.0'
   s.add_development_dependency 'yard',              '>= 1.0.7'
   s.add_development_dependency 'hoe-yard',          '>= 0.1.2'
   s.add_development_dependency 'hoe-bundler',       '>= 1.0.0'
-  
+
 end

data/docs/COPYING

@@ -1,4 +1,4 @@
-i18n-inflector is copyrighted free software owned by Paweł Wilk (pw@gnu.org). The Owner of this software permits you to redistribute and/or modify the software under either the terms of the LGPL version 3 (see the file {file:LGPL-LICENSE LGPL-LICENSE}), or the conditions below ("Ruby License").
+i18n-inflector is copyrighted free software owned by Paweł Wilk (pw@gnu.org). The Owner of this software permits you to redistribute and/or modify the software under either the terms of the LGPL version 3 (see the file {file:LGPL LGPL-LICENSE}), or the conditions below ("Ruby License").
 
 == 1.
 

data/docs/HISTORY

@@ -1,3 +1,18 @@
+=== 2.0.0 / 2011-01-14
+
+* major enhancements
+
+  * API changed
+  * Added a class for keeping internal inflection data: I18n::Inflector::InflectionData
+  * Added a class for keeping options: I18n::Inflector::InflectionOptions
+  * Added a class for controlling the inflection: I18n::Inflector::Core
+  * Added a module for utilities: I18n::Inflector::Util
+  * Added token groups support
+  * Added inversed matching of tokens in inflection patterns
+  * Added support for aliases in inflection patterns
+  * Most of the methods from I18n::Backend::Inflector moved to Core submodule
+  * Most methods rewritten
+
 === 1.0.10 / 2011-01-10
 
 * major bugfixes
@@ -47,7 +62,7 @@
 * major enhancements
 
   * YARD documentation updated with metatags
-  
+
 * minor enhancements
 
   * Some changes in accessors for interpolation switches

data/docs/LEGAL

@@ -6,6 +6,6 @@ i18n-inflector is Copyright (C) 2011 by Paweł Wilk.
 i18n-inflector is copyrighted software owned by Paweł Wilk
 (pw@gnu.org). You may redistribute and/or modify this
 software as long as you comply with either the terms of the LGPL
-(see the file {file:LGPL-LICENSE}),
+(see the file {file:LGPL}),
 or Ruby's license (see the file {file:COPYING}).
 

data/docs/RELATIONS

@@ -0,0 +1,25 @@
+== This library contains
+
+* Module {I18n::Inflector} containing everything
+* Class {I18n::Inflector::Core} used to create inflector object attached to I18n backend
+* Class {I18n::Inflector::InflectionData} used by {I18n::Inflector::Core} instances to store
+  inflection data and manipulate them, also is used by {I18n::Backend::Inflector} instances when loading
+  translations to create new database within {I18n::Inflector::Core} instance attachend to backend
+* Class {I18n::Inflector::InflectionOptions} is used inside of {I18n::Inflector::Core} for keeping
+  switches and options 
+* Module {I18n::Backend::Inflector} used to alter methods of {I18n::Backend::Simple}
+
+== Relations
+
+* {I18n.backend} is the currently used backend and the instance of {I18n::Backend::Simple}
+* {I18n.backend.inflector} is the instance of {I18n::Inflector::Core} attached to backend
+* {I18n.inflector} is the proxy module method that calls inflector for currently used backend {I18n.backend.inflector}
+* {I18n.backend.inflector.options} is the instance of {I18n::Inflector::InflectionOptions} and
+  mainly it controls a behavior of interpolation method
+* {I18n::Inflector::Core} has an instance variable defined that contains database of translation data
+* Each entry in the internal database of {I18n::Inflector::Core} is indexed by locale and is kind of 
+  {I18n::Inflector::InflectionData}
+* When initializing translations a method from {I18n::Backend::Simple} (altered by {I18n::Backend::Inflector})
+  takes the loaded data, processes the +i18n.inflections+ part for each locale and creates configuration
+  that is keeped as an instance of {I18n::Inflector::InflectionData}. That data is registered within the
+  inflecor object attached to backend that loaded the translations.