socialcast-i18n-js 4.0.0.rc1

data/app/assets/javascripts/i18n.js

@@ -0,0 +1,661 @@
+//= require underscore
+
+// I18n.js
+// =======
+//
+// This small library provides the Rails I18n API on the Javascript.
+//
+var I18n = {};
+
+;(function(I18n){
+  "use strict";
+
+  I18n.reset = function() {
+    // Set default locale. This locale will be used when fallback is enabled and
+    // the translation doesn't exist in a particular locale.
+    this.defaultLocale = "en";
+
+    // Set the current locale to `en`.
+    this.locale = "en";
+
+    // Set the translation key separator.
+    this.defaultSeparator = ".";
+
+    // Set the placeholder format. Accepts `{{placeholder}}` and `%{placeholder}`.
+    this.placeholder = /(?:\{\{|%\{)(.*?)(?:\}\}?)/gm;
+
+    // Set if engine should fallback to the default locale when a translation
+    // is missing.
+    this.fallbacks = false;
+
+    // Set the default translation object.
+    this.translations = {};
+  };
+
+  // Return a list of all locales that must be tried before returning the
+  // missing translation message. By default, this will consider the inline option,
+  // current locale and fallback locale.
+  //
+  //     I18n.locales.get("de-DE");
+  //     // ["de-DE", "de", "en"]
+  //
+  // You can define custom rules for any locale. Just make sure you return a array
+  // containing all locales.
+  //
+  //     // Default the Wookie locale to English.
+  //     I18n.locales["wk"] = function(locale) {
+  //       return ["en"];
+  //     };
+  //
+  I18n.locales = {};
+
+  // Retrieve locales based on inline locale, current locale or default to
+  // I18n's detection.
+  I18n.locales.get = function(locale) {
+    var result = this[locale] || this[I18n.locale] || this["default"];
+
+    if (_.isFunction(result)) {
+      result = result(locale);
+    }
+
+    if (!_.isArray(result)) {
+      result = [result];
+    }
+
+    return result;
+  };
+
+  // The default locale list.
+  I18n.locales["default"] = function(locale) {
+    var locales = []
+      , list = []
+      , countryCode
+      , count
+    ;
+
+    // Handle the inline locale option that can be provided to
+    // the `I18n.t` options.
+    if (locale) {
+      locales.push(locale);
+    }
+
+    // Add the current locale to the list.
+    if (!locale && I18n.locale) {
+      locales.push(I18n.locale);
+    }
+
+    // Add the default locale if fallback strategy is enabled.
+    if (I18n.fallbacks && I18n.defaultLocale) {
+      locales.push(I18n.defaultLocale);
+    }
+
+    // Compute each locale with its country code.
+    // So this will return an array containing both
+    // `de-DE` and `de` locales.
+    locales.forEach(function(locale){
+      countryCode = locale.split("-")[0];
+
+      if (!_.include(list, locale)) {
+        list.push(locale);
+      }
+
+      if (I18n.fallbacks && countryCode && countryCode !== locale && !_.include(list, countryCode)) {
+        list.push(countryCode);
+      }
+    });
+
+    // No locales set? English it is.
+    if (!locales.length) {
+      locales.push("en");
+    }
+
+    return list;
+  };
+
+  //
+  //
+  I18n.pluralization = {};
+
+  // Return the pluralizer for a specific locale.
+  // If no specify locale is found, then I18n's default will be used.
+  I18n.pluralization.get = function(locale) {
+    return this[locale] || this[I18n.locale] || this["default"];
+  };
+
+  // The default pluralizer rule.
+  // It detects the `zero`, `one`, and `other` scopes.
+  I18n.pluralization["default"] = function(count) {
+    switch (count) {
+      case 0: return ["zero", "other"];
+      case 1: return ["one"];
+      default: return ["other"];
+    }
+  };
+
+  // Reset all default attributes. This is specially useful
+  // while running tests.
+  I18n.reset();
+
+  // Return current locale. If no locale has been set, then
+  // the current locale will be the default locale.
+  I18n.currentLocale = function() {
+    return this.locale || this.defaultLocale;
+  };
+
+  // Check if value is different than undefined and null;
+  I18n.isSet = function(value) {
+    return !_.isUndefined(value) && !_.isNull(value);
+  };
+
+  // Find and process the translation using the provided scope and options.
+  // This is used internally by some functions and should not be used as an
+  // public API.
+  I18n.lookup = function(scope, options) {
+    options = this.prepareOptions(options);
+
+    var locales = this.locales.get(options.locale)
+      , requestedLocale = locales[0]
+      , locale
+      , scopes
+      , translations
+    ;
+
+    while (locales.length) {
+      locale = locales.shift();
+      scopes = scope.split(this.defaultSeparator);
+      translations = this.translations[locale];
+
+      if (_.isUndefined(translations)) {
+        continue;
+      }
+
+      while (scopes.length) {
+        translations = translations[scopes.shift()];
+
+        if (_.isUndefined(translations)) {
+          break;
+        }
+      }
+
+      if (!_.isUndefined(translations)) {
+        return translations;
+      }
+    }
+
+    if (this.isSet(options.defaultValue)) {
+      return options.defaultValue;
+    }
+  };
+
+  // Merge serveral hash options, checking if value is set before
+  // overwriting any value. The precedence is from left to right.
+  //
+  //     I18n.prepareOptions({name: "John Doe"}, {name: "Mary Doe", role: "user"});
+  //     #=> {name: "John Doe", role: "user"}
+  //
+  I18n.prepareOptions = function() {
+    var args = Array.prototype.slice.call(arguments)
+      , options = {}
+    ;
+
+    for (var i = 0, count = args.length; i < count; i++) {
+      var o = args.shift();
+
+      if (!_.isObject(o)) {
+        continue;
+      }
+
+      for (var attr in o) {
+        if (!_.has(o, attr)) {
+          continue;
+        }
+
+        if (this.isSet(options[attr])) {
+          continue;
+        }
+
+        options[attr] = o[attr];
+      }
+    }
+
+    return options;
+  };
+
+  // Translate the given scope with the provided options.
+  I18n.translate = function(scope, options) {
+    options = this.prepareOptions(options);
+    var translation = this.lookup(scope, options);
+
+    if (_.isUndefined(translation)) {
+      return this.missingTranslation(scope);
+    }
+
+    if (_.isString(translation)) {
+      translation = this.interpolate(translation, options);
+    } else if (_.isObject(translation) && this.isSet(options.count)) {
+      translation = this.pluralize(options.count, translation, options);
+    }
+
+    return translation;
+  };
+
+  // This function interpolates the all variables in the given message.
+  I18n.interpolate = function(message, options) {
+    options = this.prepareOptions(options);
+    var matches = message.match(this.placeholder)
+      , placeholder
+      , value
+      , name
+      , regex
+    ;
+
+    if (!matches) {
+      return message;
+    }
+
+    while (matches.length) {
+      placeholder = matches.shift();
+      name = placeholder.replace(this.placeholder, "$1");
+      value = options[name];
+
+      if (!this.isSet(options[name])) {
+        value = "[missing " + placeholder + " value]";
+      }
+
+      regex = new RegExp(placeholder.replace(/\{/gm, "\\{").replace(/\}/gm, "\\}"));
+      message = message.replace(regex, value);
+    }
+
+    return message;
+  };
+
+  // Pluralize the given scope using the `count` value.
+  // The pluralized translation may have other placeholders,
+  // which will be retrieved from `options`.
+  I18n.pluralize = function(count, scope, options) {
+    options = this.prepareOptions(options);
+    var translations, pluralizer, keys, key, message;
+
+    if (_.isObject(scope)) {
+      translations = scope;
+    } else {
+      translations = this.lookup(scope, options);
+    }
+
+    if (_.isUndefined(translations)) {
+      return this.missingTranslation(scope);
+    }
+
+    pluralizer = this.pluralization.get(options.locale);
+    keys = pluralizer(Math.abs(count));
+
+    while (keys.length) {
+      key = keys.shift();
+
+      if (this.isSet(translations[key])) {
+        message = translations[key];
+        break;
+      }
+    }
+
+    options.count = String(count);
+    return this.interpolate(message, options);
+  };
+
+  // Return a missing translation message for the given parameters.
+  I18n.missingTranslation = function(scope) {
+    var message = '[missing "' + this.currentLocale();
+
+    for (var i = 0; i < arguments.length; i++) {
+      message += "." + arguments[i];
+    }
+
+    message += '" translation]';
+
+    return message;
+  };
+
+  // Format number using localization rules.
+  // The options will be retrieved from the `number.format` scope.
+  // If this isn't present, then the following options will be used:
+  //
+  // - `precision`: `3`
+  // - `separator`: `"."`
+  // - `delimiter`: `","`
+  // - `strip_insignificant_zeros`: `false`
+  //
+  // You can also override these options by providing the `options` argument.
+  //
+  I18n.toNumber = function(number, options) {
+    options = this.prepareOptions(
+      options,
+      this.lookup("number.format"),
+      {precision: 3, separator: ".", delimiter: ",", strip_insignificant_zeros: false}
+    );
+
+    var negative = number < 0
+      , string = Math.abs(number).toFixed(options.precision).toString()
+      , parts = string.split(".")
+      , precision
+      , buffer = []
+      , formattedNumber
+    ;
+
+    number = parts[0];
+    precision = parts[1];
+
+    while (number.length > 0) {
+      buffer.unshift(number.substr(Math.max(0, number.length - 3), 3));
+      number = number.substr(0, number.length -3);
+    }
+
+    formattedNumber = buffer.join(options.delimiter);
+
+    if (options.precision > 0) {
+      formattedNumber += options.separator + parts[1];
+    }
+
+    if (negative) {
+      formattedNumber = "-" + formattedNumber;
+    }
+
+    if (options.strip_insignificant_zeros) {
+      var regex = {
+          separator: new RegExp(options.separator.replace(/\./, "\\.") + "$")
+        , zeros: /0+$/
+      };
+
+      formattedNumber = formattedNumber
+        .replace(regex.zeros, "")
+        .replace(regex.separator, "")
+      ;
+    }
+
+    return formattedNumber;
+  };
+
+  // Format currency with localization rules.
+  // The options will be retrieved from the `number.currency.format` and
+  // `number.format` scopes, in that order.
+  //
+  // Any missing option will be retrieved from the `I18n.toNumber` defaults and
+  // the following options:
+  //
+  // - `unit`: `"$"`
+  // - `precision`: `2`
+  // - `format`: `"%u%n"`
+  // - `delimiter`: `","`
+  // - `separator`: `"."`
+  //
+  // You can also override these options by providing the `options` argument.
+  //
+  I18n.toCurrency = function(number, options) {
+    options = this.prepareOptions(
+      options,
+      this.lookup("number.currency.format"),
+      this.lookup("number.format"),
+      {unit: "$", precision: 2, format: "%u%n", delimiter: ",", separator: "."}
+    );
+
+    number = this.toNumber(number, options);
+    number = options.format
+      .replace("%u", options.unit)
+      .replace("%n", number)
+    ;
+
+    return number;
+  };
+
+  // Localize several values.
+  // You can provide the following scopes: `currency`, `number`, or `percentage`.
+  // If you provide a scope that matches the `/^(date|time)/` regular expression
+  // then the `value` will be converted by using the `I18n.toTime` function.
+  //
+  // It will default to the value's `toString` function.
+  //
+  I18n.localize = function(scope, value) {
+    switch (scope) {
+      case "currency":
+        return this.toCurrency(value);
+      case "number":
+        scope = this.lookup("number.format");
+        return this.toNumber(value, scope);
+      case "percentage":
+        return this.toPercentage(value);
+      default:
+        if (scope.match(/^(date|time)/)) {
+          return this.toTime(scope, value);
+        } else {
+          return value.toString();
+        }
+    }
+  };
+
+  // Parse a given `date` string into a JavaScript Date object.
+  // This function is time zone aware.
+  //
+  // The following string formats are recognized:
+  //
+  //    yyyy-mm-dd
+  //    yyyy-mm-dd[ T]hh:mm::ss
+  //    yyyy-mm-dd[ T]hh:mm::ss
+  //    yyyy-mm-dd[ T]hh:mm::ssZ
+  //    yyyy-mm-dd[ T]hh:mm::ss+0000
+  //
+  I18n.parseDate = function(date) {
+    var matches, convertedDate;
+
+    // we have a date, so just return it.
+    if (_.isDate(date)) {
+      return date;
+    };
+
+    matches = date.toString().match(/(\d{4})-(\d{2})-(\d{2})(?:[ T](\d{2}):(\d{2}):(\d{2}))?(Z|\+0000)?/);
+
+    if (matches) {
+      for (var i = 1; i <= 6; i++) {
+        matches[i] = parseInt(matches[i], 10) || 0;
+      }
+
+      // month starts on 0
+      matches[2] -= 1;
+
+      if (matches[7]) {
+        convertedDate = new Date(Date.UTC(matches[1], matches[2], matches[3], matches[4], matches[5], matches[6]));
+      } else {
+        convertedDate = new Date(matches[1], matches[2], matches[3], matches[4], matches[5], matches[6]);
+      }
+    } else if (typeof(date) == "number") {
+      // UNIX timestamp
+      convertedDate = new Date();
+      convertedDate.setTime(date);
+    } else if (date.match(/\d+ \d+:\d+:\d+ [+-]\d+ \d+/)) {
+      // a valid javascript format with timezone info
+      convertedDate = new Date();
+      convertedDate.setTime(Date.parse(date))
+    } else {
+      // an arbitrary javascript string
+      convertedDate = new Date();
+      convertedDate.setTime(Date.parse(date));
+    }
+
+    return convertedDate;
+  };
+
+  // Formats time according to the directives in the given format string.
+  // The directives begins with a percent (%) character. Any text not listed as a
+  // directive will be passed through to the output string.
+  //
+  // The accepted formats are:
+  //
+  //     %a  - The abbreviated weekday name (Sun)
+  //     %A  - The full weekday name (Sunday)
+  //     %b  - The abbreviated month name (Jan)
+  //     %B  - The full month name (January)
+  //     %c  - The preferred local date and time representation
+  //     %d  - Day of the month (01..31)
+  //     %-d - Day of the month (1..31)
+  //     %H  - Hour of the day, 24-hour clock (00..23)
+  //     %-H - Hour of the day, 24-hour clock (0..23)
+  //     %I  - Hour of the day, 12-hour clock (01..12)
+  //     %-I - Hour of the day, 12-hour clock (1..12)
+  //     %m  - Month of the year (01..12)
+  //     %-m - Month of the year (1..12)
+  //     %M  - Minute of the hour (00..59)
+  //     %-M - Minute of the hour (0..59)
+  //     %p  - Meridian indicator (AM  or  PM)
+  //     %S  - Second of the minute (00..60)
+  //     %-S - Second of the minute (0..60)
+  //     %w  - Day of the week (Sunday is 0, 0..6)
+  //     %y  - Year without a century (00..99)
+  //     %-y - Year without a century (0..99)
+  //     %Y  - Year with century
+  //     %z  - Timezone offset (+0545)
+  //
+  I18n.strftime = function(date, format) {
+    var options = this.lookup("date");
+
+    if (!options) {
+      options = {
+          day_names: ["Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday"]
+        , abbr_day_names: ["Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat"]
+        , month_names: [null, "January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", "December"]
+        , abbr_month_names: [null, "Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"]
+      }
+    }
+
+    if (!options.meridian) {
+      options.meridian = ["AM", "PM"];
+    }
+
+    var weekDay = date.getDay()
+      , day = date.getDate()
+      , year = date.getFullYear()
+      , month = date.getMonth() + 1
+      , hour = date.getHours()
+      , hour12 = hour
+      , meridian = hour > 11 ? 1 : 0
+      , secs = date.getSeconds()
+      , mins = date.getMinutes()
+      , offset = date.getTimezoneOffset()
+      , absOffsetHours = Math.floor(Math.abs(offset / 60))
+      , absOffsetMinutes = Math.abs(offset) - (absOffsetHours * 60)
+      , timezoneoffset = (offset > 0 ? "-" : "+") + (absOffsetHours.toString().length < 2 ? "0" + absOffsetHours : absOffsetHours) + (absOffsetMinutes.toString().length < 2 ? "0" + absOffsetMinutes : absOffsetMinutes)
+    ;
+
+    if (hour12 > 12) {
+      hour12 = hour12 - 12;
+    } else if (hour12 === 0) {
+      hour12 = 12;
+    }
+
+    var padding = function(n) {
+      var s = "0" + n.toString();
+      return s.substr(s.length - 2);
+    };
+
+    format = format.replace("%a", options.abbr_day_names[weekDay]);
+    format = format.replace("%A", options.day_names[weekDay]);
+    format = format.replace("%b", options.abbr_month_names[month]);
+    format = format.replace("%B", options.month_names[month]);
+    format = format.replace("%d", padding(day));
+    format = format.replace("%e", day);
+    format = format.replace("%-d", day);
+    format = format.replace("%H", padding(hour));
+    format = format.replace("%-H", hour);
+    format = format.replace("%I", padding(hour12));
+    format = format.replace("%-I", hour12);
+    format = format.replace("%m", padding(month));
+    format = format.replace("%-m", month);
+    format = format.replace("%M", padding(mins));
+    format = format.replace("%-M", mins);
+    format = format.replace("%p", options.meridian[meridian]);
+    format = format.replace("%S", padding(secs));
+    format = format.replace("%-S", secs);
+    format = format.replace("%w", weekDay);
+    format = format.replace("%y", padding(year));
+    format = format.replace("%-y", padding(year).replace(/^0+/, ""));
+    format = format.replace("%Y", year);
+    format = format.replace("%z", timezoneoffset);
+
+    return format;
+  };
+
+  //
+  //
+  I18n.toTime = function(scope, d) {
+    var date = this.parseDate(d)
+      , format = this.lookup(scope)
+    ;
+
+    if (date.toString().match(/invalid/i)) {
+      return date.toString();
+    }
+
+    if (!format) {
+      return date.toString();
+    }
+
+    return this.strftime(date, format);
+  };
+
+  //
+  //
+  I18n.toPercentage = function(number, options) {
+    options = this.prepareOptions(
+      options,
+      this.lookup("number.percentage.format"),
+      this.lookup("number.format"),
+      {precision: 3, separator: ".", delimiter: ""}
+    );
+
+    number = this.toNumber(number, options);
+    return number + "%";
+  };
+
+  //
+  //
+  I18n.toHumanSize = function(number, options) {
+    var kb = 1024
+      , size = number
+      , iterations = 0
+      , unit
+      , precision
+    ;
+
+    while (size >= kb && iterations < 4) {
+      size = size / kb;
+      iterations += 1;
+    }
+
+    if (iterations === 0) {
+      unit = this.t("number.human.storage_units.units.byte", {count: size});
+      precision = 0;
+    } else {
+      unit = this.t("number.human.storage_units.units." + [null, "kb", "mb", "gb", "tb"][iterations]);
+      precision = (size - Math.floor(size) === 0) ? 0 : 1;
+    }
+
+    options = this.prepareOptions(
+      options,
+      {precision: precision, format: "%n%u", delimiter: ""}
+    );
+
+    number = this.toNumber(size, options);
+    number = options.format
+      .replace("%u", unit)
+      .replace("%n", number)
+    ;
+
+    return number;
+  };
+
+  // Set aliases, so we can save some typing.
+  I18n.t = I18n.translate;
+  I18n.l = I18n.localize;
+  I18n.p = I18n.pluralize;
+})(I18n);
+
+if(!_.isUndefined(exports)){
+  module.exports = I18n;
+}

data/config/i18n-js.yml

@@ -0,0 +1,22 @@
+# Split context in several files.
+# By default only one file with all translations is exported and
+# no configuration is required. Your settings for asset pipeline
+# are automatically recognized.
+#
+# If you want to split translations into several files or specify
+# locale contexts that will be exported, just use this file to do
+# so.
+#
+# If you're going to use the Rails 3.1 asset pipeline, change
+# the following configuration to something like this:
+#
+#   translations:
+#     - file: "app/assets/javascripts/i18n/translations.js"
+#
+# If you're running an old version, you can use something
+# like this:
+#
+#   translations:
+#     - file: "public/javascripts/translations.js"
+#       only: "*"
+#

data/i18n-js.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "i18n/js/version"
+
+Gem::Specification.new do |s|
+  s.name        = "socialcast-i18n-js"
+  s.version     = I18n::Js::Version::STRING
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Nando Vieira", "Sean Cashin"]
+  s.email       = ["fnando.vieira@gmail.com", "sean@socialcast.com"]
+  s.homepage    = "http://rubygems.org/gems/socialcast-i18n-js"
+  s.summary     = "It's a small library to provide the Rails I18n translations on the Javascript."
+  s.description = s.summary
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency "i18n"
+  s.add_dependency "activesupport", ">= 3.0.0"
+  s.add_dependency "railties", ">= 3.0.0"
+  s.add_dependency "sprockets", ">= 2.0.0"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "pry"
+  s.add_development_dependency "awesome_print"
+end