Permalink
Browse files

Initial release v1.0.0

  • Loading branch information...
0 parents commit 6240f64fa53b736f685dec46bf60801e1aad0c06 Paul Engel committed Jul 20, 2010
@@ -0,0 +1,5 @@
+= Rich-pluralization CHANGELOG
+
+== Version 1.0.0 (July 20, 2010)
+
+* Initial release (extracted Rich-pluralization from E9s)
@@ -0,0 +1,20 @@
+Copyright (c) 2010 Paul Engel
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
@@ -0,0 +1,143 @@
+
+h1. Rich-pluralization
+
+Enrichments (e9s) module for localized pluralization
+
+h2. Introduction
+
+Rich-pluralization is a module of E9s ("http://github.com/archan937/e9s":http://github.com/archan937/e9s) which provides localized pluralization in combination with i18n. Doing this enables you to only translate words in singular form as the module pluralizes the translation for you.
+
+h2. Installation
+
+h3. Using Rich-pluralization as gem
+
+Install the Rich-pluralization gem:
+
+<pre>
+ sudo gem install rich_pluralization
+</pre>
+
+Add rich_pluralization in environment.rb as a gem dependency:
+
+<pre>
+ config.gem "rich_pluralization"
+</pre>
+
+h3. Using Rich-pluralization as plugin
+
+Install the Rich-pluralization plugin:
+
+<pre>
+ ./script/plugin install git://github.com/archan937/rich_pluralization.git
+</pre>
+
+h2. Usage
+
+Just call the @pl@ method on string or symbols to pluralize.
+
+*Note*: @I18n.locale@ is @:nl@
+
+<pre>
+ >> "brief".pl
+ => "brieven"
+ >> "gebruiker".pl
+ => "gebruikers"
+ >> :museum.pl
+ => "musea"
+ >> "afspraak".pl
+ => "afspraken"
+</pre>
+
+h3. Adding pluralization rules / inflections
+
+Rich-pluralization inflections resembles the inflections of @ActiveSupport::Inflector@. Unfortunately, specifying inflections within @config/initializers/inflections.rb@ influences your Rails application and thus causes great problems.
+
+To specify pluralization rules for different locales. You have to use regular expressions and put them in @config/locales/language.yml@.
+
+*Note*: specified in @config/locales/nl.yml@
+
+<pre>
+---
+nl:
+
+ e9s:
+ singular:
+ - rule: en$
+ replacement: ""
+
+ plural:
+ - rule: ee$
+ replacement: eeën
+
+ - rule: heid$
+ replacement: heden
+
+ - rule: (c|m|n|t)us$
+ replacement: \1i
+
+ - rule: | abc, acme, acne, (a|ë|i|o|u|y)$
+ replacement: \1's
+ exceptions: (ai|eau|ei|li|lieu|ooi|ou|shampoo|spray|vlo)$
+
+ - rule: (blad|kind)$
+ replacement: \1eren
+ exceptions: (aanrecht|advertentie)blad
+
+ - rule: (e|em|el|er|erd|aar|aard|um|eur|foon|oor|ier|en|ie|eau|show|festival|é)$
+ replacement: \1s
+
+ - rule: | (a|e|o|u)\1([^aeiou])$
+ replacement: \1\2en
+
+ - rule: | (aï|alia)(s),
+ ([^aeiou][aeiou])([^aeiou])$
+ replacement: \1\2\2en
+ exceptions: dal, pad, slot, vat, weg,
+ (blad|dag|dak|engel|gat|weg)$
+
+ - rule: f$
+ replacement: ven
+
+ - rule: s$
+ replacement: zen
+
+ - rule: $
+ replacement: en
+
+ irregular:
+ gelid: gelederen
+
+ uncountable:
+ - geld
+ - informatie
+ - rijst
+</pre>
+
+For a complete example, please open "http://github.com/archan937/rich_pluralization/locales/nl.yml":http://github.com/archan937/rich_pluralization/locales/nl.yml which contains Dutch inflections.
+
+h2. Contact me
+
+For support, remarks and requests please mail me at "paul.engel@holder.nl":mailto:paul.engel@holder.nl.
+
+h2. Credit
+
+This Rails gem / plugin depends on:
+
+i18n<br>
+"http://github.com/svenfuchs/i18n":http://github.com/svenfuchs/i18n
+
+h2. ToDo's
+
+* Complete the Dutch inflections
+
+h2. License
+
+Copyright (c) 2010 Paul Engel, released under the MIT license
+
+"http://holder.nl":http://holder.nl - "http://codehero.es":http://codehero.es - "http://gettopup.com":http://gettopup.com - "http://twitter.com/archan937":http://twitter.com/archan937 - "paul.engel@holder.nl":mailto:paul.engel@holder.nl
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
@@ -0,0 +1,41 @@
+require "rake"
+require "rake/testtask"
+require "rake/rdoctask"
+
+begin
+ require "jeweler"
+ Jeweler::Tasks.new do |gemspec|
+ gemspec.name = "rich_pluralization"
+ gemspec.summary = "Enrichments (e9s) module for localized pluralization"
+ gemspec.description = "Rich-pluralization is a module of E9s (http://github.com/archan937/e9s) which provides localized pluralization in combination with i18n. Doing this enables you to only translate words in singular form as the module pluralizes the translation for you."
+ gemspec.email = "paul.engel@holder.nl"
+ gemspec.homepage = "http://github.com/archan937/rich_pluralization"
+ gemspec.author = "Paul Engel"
+
+ gemspec.add_dependency "i18n"
+ end
+ Jeweler::GemcutterTasks.new
+rescue LoadError
+ puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+desc "Default: run unit tests."
+task :default => :test
+
+desc "Test the rich_pluralization plugin."
+Rake::TestTask.new(:test) do |t|
+ t.libs << "lib"
+ t.libs << "test"
+ t.pattern = "test/**/*_test.rb"
+ t.verbose = true
+end
+
+desc "Generate documentation for the rich_pluralization plugin."
+Rake::RDocTask.new(:rdoc) do |rdoc|
+ rdoc.rdoc_dir = "rdoc"
+ rdoc.title = "Rich-pluralization"
+ rdoc.options << "--line-numbers" << "--inline-source"
+ rdoc.rdoc_files.include "README"
+ rdoc.rdoc_files.include "MIT-LICENSE"
+ rdoc.rdoc_files.include "lib/**/*.rb"
+end
@@ -0,0 +1 @@
+1.0.0
@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), "rails", "init")
@@ -0,0 +1 @@
+# Install hook code here
@@ -0,0 +1,9 @@
+
+module Rich
+ module Pluralization
+ extend self
+ end
+end
+
+require "rich/pluralization/core"
+require "rich/pluralization/engine"
@@ -0,0 +1,4 @@
+
+Dir[File.join(File.dirname(__FILE__), "core", "*.rb")].each do |file|
+ require file
+end
@@ -0,0 +1,6 @@
+
+require "rich/pluralization/core/string/inflections"
+
+class String
+ include Rich::Pluralization::Core::String::Inflections
+end
@@ -0,0 +1,16 @@
+
+module Rich
+ module Pluralization
+ module Core
+ module String
+ module Inflections
+
+ def pl(count = nil)
+ Rich::Pluralization::Inflector.pluralize self, count
+ end
+
+ end
+ end
+ end
+ end
+end
@@ -0,0 +1,6 @@
+
+require "rich/pluralization/core/symbol/inflections"
+
+class Symbol
+ include Rich::Pluralization::Core::Symbol::Inflections
+end
@@ -0,0 +1,16 @@
+
+module Rich
+ module Pluralization
+ module Core
+ module Symbol
+ module Inflections
+
+ def pl(count = nil)
+ to_s.pl count
+ end
+
+ end
+ end
+ end
+ end
+end
@@ -0,0 +1,42 @@
+
+module Rich
+ module Pluralization
+ module Engine
+ extend self
+
+ def init(test_class = nil)
+ if test_class
+ test_locale = test_class.name.match(/(Rich\:\:Pluralization\:\:Test\:\:Locales\:\:)(\w+)/).captures[1].downcase.to_sym
+
+ I18n.load_path = [File.join("vendor", "plugins", "rich_pluralization", "locales", "#{test_locale}.yml")]
+ else
+ I18n.load_path += Dir[Rails.root.join("vendor", "plugins", "rich_pluralization", "locales", "*.yml")]
+ end
+
+ I18n.backend.reload!
+ Rich::Pluralization::Inflector.inflections.reset_attrs if test_class
+
+ initial_locale = I18n.locale
+
+ I18n.backend.available_locales.each do |locale|
+ I18n.locale = locale
+
+ Rich::Pluralization::Inflector.inflections locale do |inflections|
+ (I18n.t! "e9s" rescue []).each do |type, entries|
+ entries.each do |inflection|
+ inflections.send *[type, inflection].flatten
+ end
+ end
+ end
+ end
+
+ I18n.locale = initial_locale
+
+ test_locale
+ end
+
+ end
+ end
+end
+
+Rich::Pluralization::Engine.init
@@ -0,0 +1,58 @@
+
+module Rich
+ module Pluralization
+ module Inflector
+ extend self
+
+ def inflections(locale = nil)
+ Inflections.instance.locale = locale
+ if block_given?
+ yield Inflections.instance
+ else
+ Inflections.instance
+ end
+ end
+
+ def singularize(word)
+ inflect :singulars, word
+ end
+
+ def pluralize(word, count = nil)
+ count == 1 ? singularize(word) : inflect(:plurals, word)
+ end
+
+ private
+
+ [:singulars, :plurals, :irregulars, :uncountables].each do |type|
+ define_method type do
+ (Inflections.instance.send(type)[I18n.locale] || (type == :uncountables ? [] : {}))
+ end
+ end
+
+ def inflect(type, word)
+ return word if uncountable?(word) or irregular_counterpart?(type, word)
+
+ if irregular = irregulars[word.downcase]
+ return irregular.cp_case(word)
+ end
+
+ send(type).each do |inflection|
+ if result = inflection.inflect!(word)
+ return result.cp_case(word)
+ end
+ end
+
+ word
+ end
+
+ def uncountable?(word)
+ uncountables.include?(word.downcase)
+ end
+
+ def irregular_counterpart?(type, word)
+ irregulars.send({:singulars => :keys, :plurals => :values}[type]).include?(word.downcase)
+ end
+
+ end
+ end
+end
Oops, something went wrong.

0 comments on commit 6240f64

Please sign in to comment.