twitter_cldr_js 1.0.0

data/Gemfile

@@ -0,0 +1,12 @@
+source :rubygems
+
+gemspec
+
+group :test do
+  gem 'rspec', '~> 2.11.0'
+  gem 'rr',    '~> 1.0.4'
+
+  platform :mri_18 do
+    gem 'rcov'
+  end
+end

data/History.txt

@@ -0,0 +1,3 @@
+=== 1.0.0
+
+*  Moved JavaScript compilation files out of twitter-cldr-rb and into their own gem here.

data/LICENSE

@@ -0,0 +1,177 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

data/NOTICE

@@ -0,0 +1,120 @@
+twitter-cldr-rb is a Ruby implementation of the Common Locale Data Repository
+Copyright (C) 2012 Twitter, Inc.
+
+
+Portions of this gem were borrowed from Sven Fuchs' ruby-cldr gem. Here is
+the license that accompanied Mr. Fuchs' code:
+
+Copyright (c) 2009 Sven Fuchs
+
+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.
+
+
+Backporting of String interpolation from Ruby 1.9 to Ruby 1.8 implemented in
+this gem (see file interpolation.rb) was partially copied and heavily based
+on the implementation of i18n and gettext gems. Below are the license agreements
+that accompanied these gems.
+
+License agreement of the i18n gem (https://github.com/svenfuchs/i18n):
+
+Copyright (c) 2008 The Ruby I18n team
+
+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.
+
+License of the gettext gem (https://github.com/mutoh/gettext):
+
+Copyright (C) 2005-2009 Masao Mutoh
+
+You may redistribute it [the code] and/or modify it under the same license
+terms as Ruby or LGPL [http://www.gnu.org/licenses/lgpl-3.0.txt].
+
+Ruby is copyrighted free software by Yukihiro Matsumoto <matz@netlab.jp>.
+You can redistribute it and/or modify it under either the terms of the GPL
+version 2 (see the file GPL), or the conditions below:
+
+  1. You may make and give away verbatim copies of the source form of the
+     software without restriction, provided that you duplicate all of the
+     original copyright notices and associated disclaimers.
+
+  2. You may modify your copy of the software in any way, provided that
+     you do at least ONE of the following:
+
+       a) place your modifications in the Public Domain or otherwise
+          make them Freely Available, such as by posting said
+modifications to Usenet or an equivalent medium, or by allowing
+the author to include your modifications in the software.
+
+       b) use the modified software only within your corporation or
+          organization.
+
+       c) give non-standard binaries non-standard names, with
+          instructions on where to get the original software distribution.
+
+       d) make other distribution arrangements with the author.
+
+  3. You may distribute the software in object code or binary form,
+     provided that you do at least ONE of the following:
+
+       a) distribute the binaries and library files of the software,
+together with instructions (in the manual page or equivalent)
+on where to get the original distribution.
+
+       b) accompany the distribution with the machine-readable source of
+the software.
+
+       c) give non-standard binaries non-standard names, with
+          instructions on where to get the original software distribution.
+
+       d) make other distribution arrangements with the author.
+
+  4. You may modify and include the part of the software into any other
+     software (possibly commercial). But some files in the distribution
+     are not written by the author, so that they are not under these terms.
+
+     For the list of those files and their copying conditions, see the
+     file LEGAL.
+
+  5. The scripts and library files supplied as input to or produced as
+     output from the software do not automatically fall under the
+     copyright of the software, but belong to whomever generated them,
+     and may be sold commercially, and may be aggregated with this
+     software.
+
+  6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
+     IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+     PURPOSE.

data/README.md

@@ -0,0 +1,161 @@
+## twitter-cldr-js  [![Build Status](https://secure.travis-ci.org/twitter/twitter-cldr-js.png?branch=master)](http://travis-ci.org/twitter/twitter-cldr-js)
+
+TwitterCldr uses Unicode's Common Locale Data Repository (CLDR) to format certain types of text into their
+localized equivalents via the Rails asset pipeline.  It is a port of [twitter-cldr-rb](http://github.com/twitter/twitter-cldr-rb), a Ruby gem that uses the same CLDR data.  Originally, this project was not a gem, but a collection of JavaScript files.  It has been turned into a gem to move the JavaScript compiling routines from twitter-cldr-rb and provide support for the asset pipeline.
+
+Currently, twitter-cldr-js supports the following:
+
+1. Date and time formatting
+2. Relative date and time formatting (eg. 1 month ago)
+3. Number formatting (decimal, currency, and percentage)
+4. Plural rules
+
+## Usage in the Rails Asset Pipeline
+
+twitter-cldr-js provides a single `.js` file per locale.  You can include a locale-specific version (eg. Spanish) in your JavaScript manifest (`app/assets/javascripts/application.js`) like this:
+
+```ruby
+//= require twitter_cldr/twitter_cldr_es
+```
+
+This will make the Spanish version of twitter-cldr-js available to the JavaScript in your app.  If your app supports multiple languages however, this single-locale approach won't be much use.  Instead, require the right file with `javascript_include_tag` for example in a view or a layout:
+
+```ruby
+<%= javascript_include_tag "twitter_cldr/twitter_cldr_#{TwitterCldr.convert_locale(I18n.locale)}.js" %>
+```
+
+### Dates and Times
+
+```javascript
+// include twitter_cldr_es.js for the Spanish DateTimeFormatter
+var fmt = new TwitterCldr.DateTimeFormatter();
+
+fmt.format(new Date(), {"type": "full"});                     // "lunes, 12 de diciembre de 2011 21:44:57 UTC -0800"
+fmt.format(new Date(), {"type": "long"});                     // "12 de diciembre de 201121:45:42 -08:00"
+fmt.format(new Date(), {"type": "medium"});                   // "12/12/2011 21:46:09"
+fmt.format(new Date(), {"type": "short"});                    // "12/12/11 21:47"
+
+fmt.format(new Date(), {"format": "date", "type": "full"});   // "lunes, 12 de diciembre de 2011"
+fmt.format(new Date(), {"format": "date", "type": "long"});   // "12 de diciembre de 2011"
+fmt.format(new Date(), {"format": "date", "type": "medium"}); // "12/12/2011"
+fmt.format(new Date(), {"format": "date", "type": "short"});  // "12/12/11"
+
+fmt.format(new Date(), {"format": "time", "type": "full"});   // "21:44:57 UTC -0800"
+fmt.format(new Date(), {"format": "time", "type": "long"});   // "21:45:42 -08:00"
+fmt.format(new Date(), {"format": "time", "type": "medium"}); // "21:46:09"
+fmt.format(new Date(), {"format": "time", "type": "short"});  // "21:47"
+```
+
+The CLDR data set only includes 4 specific date formats, full, long, medium, and short, so you'll have to choose amongst them for the one that best fits your needs.  Yes, it's limiting, but the 4 formats get the job done most of the time :)
+
+### Relative Dates and Times
+
+In addition to formatting full dates and times, TwitterCLDR supports relative time spans.  It tries to guess the best time unit (eg. days, hours, minutes, etc) based on the length of time given.  Indicate past or future by using negative or positive numbers respectively:
+
+```javascript
+// include twitter_cldr_en.js for the English TimespanFormatter
+var fmt = new TwitterCldr.TimespanFormatter();
+var then = Math.round(new Date(2012, 1, 1, 12, 0, 0).getTime() / 1000);
+var now = Math.round(Date.now() / 1000);
+
+fmt.format(then - now);                    // "6 months ago"
+fmt.format(then - now, {unit: "week"});    // "24 weeks ago"
+fmt.format(then - now, {unit: "year"});    // "0 years ago"
+fmt.format(then + now, {unit: "week"});    // "In 24 weeks"
+fmt.format(then + now, {unit: "year"});    // "In 0 years"
+```
+
+The `TimespanFormatter` can also handle time spans without a direction via the `direction: "none"` option.  Directionless timespans can be combined with the `type` option:
+
+```javascript
+fmt.format(180, {direction: "none", type: "short"});                 // "3 mins"
+fmt.format(180, {direction: "none", type: "abbreviated"});           // "3m"
+fmt.format(180, {direction: "none", type: "short", unit: "second"}); // "180 secs"
+```
+
+### Numbers
+
+twitter-cldr-js number formatting supports decimals, currencies, and percentages.
+
+#### Decimals
+
+```javascript
+// include twitter_cldr_es.js for the Spanish NumberFormatter
+var fmt = new TwitterCldr.DecimalFormatter();
+fmt.format(1337);                      // "1.337"
+fmt.format(-1337);                     // "-1.337"
+fmt.format(1337, {precision: 2});      // "1.337,00"
+```
+
+#### Currencies
+
+```javascript
+var fmt = new TwitterCldr.CurrencyFormatter();
+fmt.format(1337, {currency: "EUR"});                 // 1.337,00 €
+fmt.format(1337, {currency: "Peru"});                // 1.337,00 S/.
+fmt.format(1337, {currency: "Peru", precision: 3});  // 1.337,000 S/.
+```
+
+#### Percentages
+
+```javascript
+var fmt = new TwitterCldr.PercentFormatter();
+fmt.format(1337);                      // 1.337%
+fmt.format(1337, {precision: 2});      // 1.337,00%
+```
+
+### Plural Rules
+
+Some languages, like English, have "countable" nouns.  You probably know this concept better as "plural" and "singular", i.e. the difference between "strawberry" and "strawberries".  Other languages, like Russian, have three plural forms: one (numbers ending in 1), few (numbers ending in 2, 3, or 4), and many (everything else).  Still other languages like Japanese don't use countable nouns at all.
+
+TwitterCLDR makes it easy to find the plural rules for any numeric value:
+
+```javascript
+// include twitter_cldr_ru.js for access to Russian Plural rules
+TwitterCldr.PluralRules.rule_for(1);      // "one"
+TwitterCldr.PluralRules.rule_for(2);      // "few"
+TwitterCldr.PluralRules.rule_for(8);      // "many"
+```
+
+Get all the rules for your language:
+
+```javascript
+TwitterCldr.PluralRules.all();            // ["one", "few", "many", "other"]
+```
+
+### Generating the JavaScript
+
+The JavaScript files that make up twitter-cldr-js can be automatically generated for each language via a set of Rake tasks.
+
+* Build js files in the current directory: `bundle exec rake twitter_cldr:compile`
+* Build js files into a given directory: `bundle exec rake twitter_cldr:compile OUTPUT_DIR=/path/to/output/dir`
+* Build only the specified locales: `bundle exec rake twitter_cldr:compile OUTPUT_DIR=/path/to/output/dir LOCALES=ar,he,ko,ja`
+
+* Rebuild the js files internally in the gem: `bundle exec rake twitter_cldr:update`
+
+## Requirements
+
+twitter-cldr-js requires Rails 3.1 or later.  To run the JavaScript test suite, you'll need Node and the jasmine-node NPM package.
+
+## Running Tests
+
+1. Install node (eg. `brew install node`, `sudo apt-get install node`, etc)
+2. Install jasmine-node: `npm install jasmine-node -g`
+2. Run `bundle install`
+3. Run `bundle exec rake`
+
+## Authors
+
+* Cameron C. Dutro: https://github.com/camertron
+* Portions taken from the ruby-cldr gem by Sven Fuchs: https://github.com/svenfuchs/ruby-cldr
+
+## Links
+* twitter-cldr-rb [https://github.com/twitter/twitter-cldr-rb](https://github.com/twitter/twitter-cldr-rb)
+* ruby-cldr gem: [https://github.com/svenfuchs/ruby-cldr](https://github.com/svenfuchs/ruby-cldr)
+* CLDR homepage: [http://cldr.unicode.org/](http://cldr.unicode.org/)
+
+## License
+
+Copyright 2012 Twitter, Inc.
+
+Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0

data/Rakefile

@@ -0,0 +1,66 @@
+# encoding: UTF-8
+
+# Copyright 2012 Twitter, Inc
+# http://www.apache.org/licenses/LICENSE-2.0
+
+require 'rubygems' unless ENV['NO_RUBYGEMS']
+
+require 'bundler'
+require 'digest'
+require 'fileutils'
+require 'rexml/document'
+
+require 'rspec/core/rake_task'
+require 'rubygems/package_task'
+
+require './lib/twitter_cldr/js'
+
+Bundler::GemHelper.install_tasks
+
+task :default => :spec
+
+desc 'Run specs'
+task :spec => ["spec:ruby", "spec:js"]
+
+desc 'Run Ruby specs'
+RSpec::Core::RakeTask.new("spec:ruby") do |t|
+  t.pattern = './spec/**/*_spec.rb'
+end
+
+desc 'Run JavaScript specs'
+task "spec:js" => ["twitter_cldr:update"] do
+  puts "\nJasmine Specs"
+  failures = 0
+
+  if `which jasmine-node`.strip.empty?
+    puts "ERROR: You need to install jasmine-node to run JavaScript tests:"
+    puts "  `npm install jasmine-node -g`"
+    exit 1
+  else
+    puts `jasmine-node #{File.dirname(__FILE__)} --junitreport`
+    doc_files = Dir.glob(File.join(File.dirname(__FILE__), "reports/**"))
+
+    doc_files.each do |doc_file|
+      doc = REXML::Document.new(File.read(doc_file))
+      failures += doc.elements.to_a("testsuites/testsuite").inject(0) do |sum, element|
+        sum += element.attributes["failures"].to_i
+        sum
+      end
+    end
+
+    if failures > 0
+      exit 1
+    end
+  end
+end
+
+if RUBY_VERSION < '1.9.0'
+  desc 'Run all examples with RCov'
+  RSpec::Core::RakeTask.new('spec:rcov') do |t|
+    t.rcov      = true
+    t.pattern   = './spec/**/*_spec.rb'
+    t.rcov_opts = %w(-T --sort coverage --exclude gems/,spec/)
+  end
+end
+
+load "./lib/twitter_cldr/js/tasks/tasks.rake"