plurality 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f96196fcf6917c3aa0ac866c3977e7b1a639bea8
+  data.tar.gz: ff30f4edc72d331c2132d4bd67da392bc4be13aa
+SHA512:
+  metadata.gz: baafef611b2bae560a2d8f2dd87e6f45c62e85f349bfa57b969aeb26a605c2ba6c25b422f3475d786965bf778b9cbf652299b9615de33a4e8ad34dcf9b259728
+  data.tar.gz: e176d8575525f9d2020e9f88065401a8f2690975df72e6059a0a8477b301e29c10c7ab2ae138adcf546c866acecbeae567e6578b69339c82a800dd130600e029

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in plurality.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Evan Alter
+
+MIT License
+
+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.

data/README.md

@@ -0,0 +1,52 @@
+# Plurality
+
+Plurality lets you define different sentence pluralizations based on the number of nouns passed to it. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'plurality'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install plurality
+
+## Usage
+
+Plurality relies on on I18n's backend for storing the plural forms.  It also follows I18n's own conventions for storing plurals with the added exception of being able to pluralize up to 1000 sentences instead of the the limitation of the current language.
+
+If you are using Simple backend then below is what your `en.yml` would look like.  The tokens are the ordinals representation of where the noun falls in the array.  They are calculated by the gem [`numbers_and_words`](https://github.com/kslazarev/numbers_and_words).  The `additonal` token is a special one that is calculated based on the number of nouns minus the ordinal tokens used. 
+``` yaml
+en:
+  email:
+    subject:
+      one: "%{first} was added"
+      two: "%{first} and %{second} were added"
+      other: "%{first}, %{second} and %{additional} others were added"
+```
+
+Then you simply call `Plurality.t` or `Plurality.translate` with the array of nouns and it'll spit out the rest for you.  
+
+``` ruby
+require 'plurality'
+
+users = %w(Evan Rob Bill Josh)
+
+Plurality.t 'email.subject', nouns: users #=> "Evan, Rob and 3 others were added"
+
+```
+
+You may also pass additional options that'll be passed through to `I18n.translate` assuming they don't conflict with the reserved tokens.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task default: :spec
+task test: :spec

data/lib/plurality.rb

@@ -0,0 +1,58 @@
+require "plurality/version"
+require "numbers_and_words"
+
+module Plurality
+  extend self
+
+  class MissingPluralData < ArgumentError
+  end
+
+  ORDINALS = (1..1000).each_with_object({}) { |i, h| h[i] = i.to_words(ordinal: true) }
+  WORDS = (1..1000).each_with_object({}) { |i, h| h[i] = i.to_words.to_sym }
+
+  TOKENS = /%?%\{([^\}]+)\}/
+
+  def translate(*args)
+    options = args.last.is_a?(Hash) ? args.pop.dup : {}
+    key = args.shift
+    nouns = options.delete(:nouns).to_a
+    translations = I18n.t!(key, scope: options[:scope])
+    numbers = translations.keys
+    other = numbers.delete(:other)
+    count = nouns.count
+    threshold = WORDS.key(numbers.last)
+
+    if other.nil? || count <= threshold
+      number = WORDS[count]
+      string = translations[number]
+    else
+      number = :other
+      string = translations[:other]
+    end
+
+    raise MissingPluralData, "Missing for #{WORDS[count]} nouns" if string.nil?
+
+    options[:scope] = generate_scope key, options[:scope]  
+    options[:additional] = calculate_additonal(count, string)
+    options.merge! ordinalized_nouns(nouns, threshold)
+
+    I18n.t number, options
+  end
+  alias :t :translate
+
+  private
+
+    def calculate_additonal(count, string)
+      tokens = string.scan(TOKENS).flatten.count { |t| ORDINALS.has_value? t }
+      count - tokens
+    end
+
+    def generate_scope(key, scope)
+      I18n.normalize_keys(nil, key, scope)
+    end
+
+    def ordinalized_nouns(nouns, number)
+      Hash[ORDINALS.values.take(number).map(&:to_sym).zip(nouns.take(number))].delete_if { |k, v| v.nil? }
+    end
+
+end

data/lib/plurality/version.rb

@@ -0,0 +1,3 @@
+module Plurality
+  VERSION = "0.0.1"
+end

data/plurality.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'plurality/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "plurality"
+  spec.version       = Plurality::VERSION
+  spec.authors       = ["Evan Alter"]
+  spec.email         = ["evan.alter@gmail.com"]
+  spec.description   = %q{Pluralize sentences based on the number of objects}
+  spec.summary       = %q{Sentence pluralization}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "i18n", "~> 0.6.8"
+  spec.add_dependency "numbers_and_words", "~> 0.10.0"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.14"
+end

data/spec/fixtures/en.yml

@@ -0,0 +1,15 @@
+en:
+  correct:
+    email:
+      subject:
+        one: "%{first} was added"
+        two: "%{first} and %{second} were added"
+        three: "%{first}, %{second} and %{third} were added"
+        four: "%{first} and %{additional} others were added"
+        other: "%{first}, %{second} and %{additional} others were added"
+  missing:
+    email:
+      subject:
+        one: "%{first} was added"
+        three: "%{first}, %{second} and %{third} were added"
+        other: "%{first}, %{second} and %{additional} others were added"

data/spec/lib/plurality_spec.rb

@@ -0,0 +1,87 @@
+require 'spec_helper'
+
+describe Plurality do
+  let(:users) { %w(Evan Rob Bill Josh Noah) }
+
+  describe ".translate" do
+    context "with correct data" do
+      let(:key) { 'correct.email.subject' }
+
+      context "one noun" do
+        let(:nouns) { users.take(1) }
+
+        subject { Plurality.translate key, nouns: nouns }
+
+        it { should eq("Evan was added")}
+      end
+
+      context "two nouns" do
+        let(:nouns) { users.take(2) }
+
+        subject { Plurality.translate key, nouns: nouns }
+
+        it { should eq("Evan and Rob were added")}
+      end
+
+      context "three nouns" do
+        let(:nouns) { users.take(3) }
+
+        subject { Plurality.translate key, nouns: nouns }
+
+        it { should eq("Evan, Rob and Bill were added")}
+      end
+
+      context "four nouns but only using the first user's name" do
+        let(:nouns) { users.take(4) }
+
+        subject { Plurality.translate key, nouns: nouns }
+
+        it { should eq("Evan and 3 others were added")}
+      end
+
+      context "other using the first two users but not the rest" do
+        let(:nouns) { users.take(5) }
+
+        subject { Plurality.translate key, nouns: nouns }
+
+        it { should eq("Evan, Rob and 3 others were added")}
+      end
+    end
+
+    context "with some missing data" do
+      let(:key) { 'missing.email.subject' }
+
+      context "one noun" do
+        let(:nouns) { users.take(1) }
+
+        subject { Plurality.translate key, nouns: nouns }
+
+        it { should eq("Evan was added")}
+      end
+
+      context "missing data for two nouns" do
+        let(:nouns) { users.take(2) }
+
+        subject { Plurality.translate key, nouns: nouns }
+
+        it { raise_error(Plurality::MissingPluralData, "Missing for two nouns") }
+      end
+
+      context "three nouns" do
+        let(:nouns) { users.take(3) }
+
+        subject { Plurality.translate key, nouns: nouns }
+
+        it { should eq("Evan, Rob and Bill were added")}
+      end
+
+      context "other using the first two users but not the third" do
+        let(:nouns) { users.take(5) }
+
+        subject { Plurality.translate key, nouns: nouns }
+
+        it { should eq("Evan, Rob and 3 others were added")}
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'plurality'
+
+I18n.config.enforce_available_locales = true
+I18n.load_path = Dir[File.dirname(__FILE__) + '/fixtures/*.yml']
+I18n.backend.load_translations
+I18n.locale = :en

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: plurality
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Evan Alter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.8
+- !ruby/object:Gem::Dependency
+  name: numbers_and_words
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+description: Pluralize sentences based on the number of objects
+email:
+- evan.alter@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/plurality.rb
+- lib/plurality/version.rb
+- plurality.gemspec
+- spec/fixtures/en.yml
+- spec/lib/plurality_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Sentence pluralization
+test_files:
+- spec/fixtures/en.yml
+- spec/lib/plurality_spec.rb
+- spec/spec_helper.rb
+has_rdoc: