@absolutesight/react-gettext 0.0.1

package/lib/buildTextDomain.js

@@ -0,0 +1,24 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _gettext = require("./gettext");
+/**
+ * TODO: We need to add description here
+ * @param {object} translations JSON
+ * @param {any} plural TODO: No idea obout type
+ * @returns {object} JSON
+ */
+function buildTextDomain() {
+  let translations = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+  let plural = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : "n != 1";
+  return {
+    gettext: _gettext.gettext.bind(null, translations),
+    ngettext: _gettext.ngettext.bind(null, translations, plural),
+    xgettext: _gettext.xgettext.bind(null, translations),
+    nxgettext: _gettext.nxgettext.bind(null, translations, plural)
+  };
+}
+var _default = exports.default = buildTextDomain;

package/lib/buildTextdomain.js

@@ -0,0 +1,24 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _gettext = require("./gettext");
+/**
+ * TODO: We need to add description here
+ * @param {object} translations JSON
+ * @param {any} plural TODO: No idea obout type
+ * @returns {object} JSON
+ */
+function buildTextdomain() {
+  let translations = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+  let plural = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : "n != 1";
+  return {
+    gettext: _gettext.gettext.bind(null, translations),
+    ngettext: _gettext.ngettext.bind(null, translations, plural),
+    xgettext: _gettext.xgettext.bind(null, translations),
+    nxgettext: _gettext.nxgettext.bind(null, translations, plural)
+  };
+}
+var _default = exports.default = buildTextdomain;

package/lib/gettext.js

@@ -0,0 +1,113 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+exports.gettext = gettext;
+exports.ngettext = ngettext;
+exports.nxgettext = nxgettext;
+exports.xgettext = xgettext;
+const DELIMITER = "\u0004"; // End of Transmission (EOT)
+
+/**
+ * TODO: We need to add description here
+ * @param {any} catalog string or function
+ * @returns {string} string or string from a function
+ */
+function getTranslations(catalog) {
+  return typeof catalog === "function" ? catalog() : catalog;
+}
+
+/**
+ * TODO: We need to add description here
+ * @param {any} plural string or function
+ * @param {any} n TODO: No idea what will pass in it
+ * @returns {any} 0 if nothing
+ */
+function getPluralForm(plural, n) {
+  // return 0 if n is not integer
+  if (Number.isNaN(parseInt(n, 10))) {
+    return 0;
+  }
+
+  // if pluralForm is function, use it to get plural form index
+  if (typeof plural === "function") {
+    return plural(n);
+  }
+
+  // if pluralForm is string and contains only "n", "0-9", " ", "!=?:%+-/*><&|()"
+  // characters, then we can "eval" it to calculate plural form
+  if (typeof plural === "string" && !plural.match(/[^n0-9 !=?:%+-/*><&|()]/i)) {
+    /* eslint-disable no-new-func */
+    const calcPlural = Function("n", `return ${plural}`);
+    /* eslint-enable no-new-func */
+    return +calcPlural(n);
+  }
+  return 0;
+}
+
+/**
+ * TODO: We need to add description here
+ * @param {string} catalog Catalog
+ * @param {string} message Message
+ * @returns {string} Message
+ */
+function gettext(catalog, message) {
+  const messages = getTranslations(catalog);
+  return Object.prototype.hasOwnProperty.call(messages, message) ? messages[message] : message;
+}
+
+/**
+ * TODO: WE need to add description here
+ * @param {string} catalog Catalog
+ * @param {string} plurality Plurality
+ * @param {string} singular Singular
+ * @param {string} plural Plural
+ * @param {number} n n
+ * @returns {string} Message
+ */
+function ngettext(catalog, plurality, singular, plural, n) {
+  const messages = getTranslations(catalog);
+  const pluralIndex = getPluralForm(plurality, n);
+  const defaultValue = n > 1 ? plural : singular;
+  return Object.prototype.hasOwnProperty.call(messages, singular) && Array.isArray(messages[singular]) && messages[singular].length > pluralIndex && pluralIndex >= 0 ? messages[singular][pluralIndex] : defaultValue;
+}
+
+/**
+ * TODO: We need to add description here
+ * @param {string} catalog Catalog
+ * @param {string} message Message
+ * @param {string} context Context
+ * @returns {string} Message
+ */
+function xgettext(catalog, message, context) {
+  const messages = getTranslations(catalog);
+  const key = context + DELIMITER + message;
+  return Object.prototype.hasOwnProperty.call(messages, key) ? messages[key] : message;
+}
+
+/**
+ * TODO: We need to add description here
+ * @param {string} catalog Catalog
+ * @param {string} plurality Plurality
+ * @param {string} singular Singular
+ * @param {string} plural Plural
+ * @param {number} n n
+ * @param {string} context Context
+ * @returns {string} Message
+ */
+function nxgettext(catalog, plurality, singular, plural, n, context) {
+  const messages = getTranslations(catalog);
+  const pluralIndex = getPluralForm(plurality, n);
+  const defaultValue = n > 1 ? plural : singular;
+  const key = context + DELIMITER + singular;
+  return Object.prototype.hasOwnProperty.call(messages, key) && Array.isArray(messages[key]) && messages[key].length > pluralIndex && pluralIndex >= 0 ? messages[key][pluralIndex] : defaultValue;
+}
+const allDomain = {
+  gettext,
+  ngettext,
+  xgettext,
+  nxgettext
+};
+var _default = exports.default = allDomain;

package/lib/index.js

@@ -0,0 +1,30 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "TextDomain", {
+  enumerable: true,
+  get: function () {
+    return _TextDomain.default;
+  }
+});
+Object.defineProperty(exports, "TextDomainContext", {
+  enumerable: true,
+  get: function () {
+    return _TextDomainContext.default;
+  }
+});
+Object.defineProperty(exports, "buildTextDomain", {
+  enumerable: true,
+  get: function () {
+    return _buildTextDomain.default;
+  }
+});
+exports.default = void 0;
+var _TextDomain = _interopRequireDefault(require("./TextDomain"));
+var _TextDomainContext = _interopRequireDefault(require("./TextDomainContext"));
+var _buildTextDomain = _interopRequireDefault(require("./buildTextDomain"));
+var _withGettext = _interopRequireDefault(require("./withGettext"));
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+var _default = exports.default = _withGettext.default;

package/lib/withGettext.js

@@ -0,0 +1,39 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _react = _interopRequireDefault(require("react"));
+var _TextDomain = _interopRequireDefault(require("./TextDomain"));
+var _hoistNonReactStatics = _interopRequireDefault(require("hoist-non-react-statics"));
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+const withGettext = function () {
+  let translations = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+  let pluralForm = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 'n != 1';
+  let options = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
+  return WrappedComponent => {
+    const args = Object.assign({
+      withRef: false
+    }, options);
+    class WithGettext extends _TextDomain.default {
+      getWrappedComponent() {
+        return this.refs.wrappedComponent;
+      }
+      render() {
+        const newprops = Object.assign({}, this.props);
+        if (args.withRef) {
+          newprops.ref = 'wrappedComponent';
+        }
+        return /*#__PURE__*/_react.default.createElement(WrappedComponent, newprops);
+      }
+    }
+    WithGettext.defaultProps = {
+      translations,
+      plural: pluralForm
+    };
+    WithGettext.displayName = `withGettext(${WrappedComponent.displayName || WrappedComponent.name || 'Component'})`;
+    return (0, _hoistNonReactStatics.default)(WithGettext, WrappedComponent);
+  };
+};
+var _default = exports.default = withGettext;

package/package.json

@@ -0,0 +1,81 @@
+{
+  "name": "@absolutesight/react-gettext",
+  "description": "Gettext implementation for React based project.",
+  "license": "MIT",
+  "author": "Qadeer Ahmad <qadeer@gmail.com>",
+  "homepage": "https://absolutesight.com",
+  "bugs": {
+    "url": "https://absolutesight.com"
+  },
+  "version": "0.0.1",
+  "main": "lib/index.js",
+  "files": [
+    "*.md",
+    "dist",
+    "LICENSE",
+    "lib",
+    "src"
+  ],
+  "keywords": [
+    "react",
+    "gettext",
+    "gettextjs"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git@github.com:eugene-manuilov/react-gettext.git"
+  },
+  "scripts": {
+    "build": "npm run build:commonjs & npm run build:umd & npm run build:umd:min",
+    "build:commonjs": "mkdir -p lib && babel ./src -d lib",
+    "build:umd": "webpack --output-filename=react-gettext.js",
+    "build:umd:min": "NODE_ENV=production webpack --output-filename=react-gettext.min.js",
+    "test": "BABEL_ENV=test jest",
+    "prepublish": "npm run build",
+    "lint": "eslint src --fix --max-warnings=0"
+  },
+  "devDependencies": {
+    "@babel/cli": "^7.23.9",
+    "@babel/core": "^7.23.9",
+    "@babel/plugin-proposal-private-property-in-object": "^7.21.11",
+    "@babel/preset-env": "^7.23.9",
+    "@babel/preset-react": "^7.23.3",
+    "babel-jest": "^29.7.0",
+    "babel-loader": "^9.1.3",
+    "enzyme": "^3.11.0",
+    "eslint": "^8.56.0",
+    "eslint-config-react-app": "^7.0.1",
+    "eslint-plugin-import": "^2.29.1",
+    "eslint-plugin-jsdoc": "^48.0.4",
+    "eslint-plugin-jsx-a11y": "^6.8.0",
+    "eslint-plugin-react": "^7.33.2",
+    "eslint-webpack-plugin": "^4.0.1",
+    "faker": "^6.6.6",
+    "jest": "^29.7.0",
+    "jest-enzyme": "^7.1.2",
+    "lodash": "^4.17.21",
+    "prop-types": "^15.8.1",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
+    "react-test-renderer": "^18.2.0",
+    "webpack": "^5.90.1",
+    "webpack-cli": "^5.1.4"
+  },
+  "dependencies": {
+    "hoist-non-react-statics": "^1.2.0 || ^2.0.0-0 || ^3.0.0-0"
+  },
+  "peerDependencies": {
+    "hoist-non-react-statics": "^1.2.0 || ^2.0.0-0 || ^3.0.0-0",
+    "prop-types": "^15.0.0-0 || ^16.0.0-0",
+    "react": "^15.0.0-0 || ^16.0.0-0 || ^17.0.0-0 || ^18.0.0-0"
+  },
+  "jest": {
+    "setupFilesAfterEnv": [
+      "<rootDir>/__tests__/__setup.js"
+    ],
+    "testMatch": [
+      "<rootDir>/__tests__/**/[^_]*.js"
+    ],
+    "verbose": true
+  }
+}

package/src/TextDomain.js

@@ -0,0 +1,82 @@
+import {gettext,
+  ngettext,
+  nxgettext,
+  xgettext,} from './gettext';
+import { Component } from 'react';
+import PropTypes from 'prop-types';
+
+
+
+class TextDomain extends Component {
+
+  getChildContext() {
+    const self = this;
+
+    return {
+      gettext: self.gettext.bind(self),
+      xgettext: self.xgettext.bind(self),
+      ngettext: self.ngettext.bind(self),
+      nxgettext: self.nxgettext.bind(self),
+    };
+  }
+
+  gettext(message) {
+    const { translations } = this.props;
+    return gettext(translations, message);
+  }
+
+  ngettext(singular, plural, n) {
+    const { translations, plural: plurality } = this.props;
+    return ngettext(translations, plurality, singular, plural, n);
+  }
+
+  xgettext(message, context) {
+    const { translations } = this.props;
+    return xgettext(translations, message, context);
+  }
+
+  nxgettext(singular, plural, n, context) {
+    const { translations, plural: plurality } = this.props;
+    return nxgettext(translations, plurality, singular, plural, n, context);
+  }
+
+  render() {
+    const { children } = this.props;
+    return children;
+  }
+
+}
+
+TextDomain.propTypes = {
+  translations: PropTypes.oneOfType([
+    PropTypes.func,
+    PropTypes.objectOf(PropTypes.oneOfType([
+      PropTypes.string,
+      PropTypes.arrayOf(PropTypes.string),
+    ])),
+  ]),
+  plural: PropTypes.oneOfType([
+    PropTypes.func,
+    PropTypes.string,
+  ]),
+  children: PropTypes.oneOfType([
+    PropTypes.node,
+    PropTypes.arrayOf(PropTypes.node),
+  ]),
+};
+
+TextDomain.defaultProps = {
+  translations: {
+  },
+  plural: 'n != 1',
+  children: [],
+};
+
+TextDomain.childContextTypes = {
+  gettext: PropTypes.func,
+  ngettext: PropTypes.func,
+  xgettext: PropTypes.func,
+  nxgettext: PropTypes.func,
+};
+
+export default TextDomain;

package/src/TextDomainContext.js

@@ -0,0 +1,7 @@
+import React from 'react';
+import buildTextDomain from './buildTextDomain';
+
+const TextDomainContext = React.createContext(buildTextDomain({
+}, 'n != 1'));
+
+export default TextDomainContext;

package/src/buildTextDomain.js

@@ -0,0 +1,19 @@
+import { gettext, ngettext, nxgettext, xgettext } from "./gettext";
+
+/**
+ * TODO: We need to add description here
+ * @param {object} translations JSON
+ * @param {any} plural TODO: No idea obout type
+ * @returns {object} JSON
+ */
+function buildTextDomain(translations = {
+}, plural = "n != 1") {
+  return {
+    gettext: gettext.bind(null, translations),
+    ngettext: ngettext.bind(null, translations, plural),
+    xgettext: xgettext.bind(null, translations),
+    nxgettext: nxgettext.bind(null, translations, plural)
+  };
+}
+
+export default buildTextDomain;

package/src/gettext.js

@@ -0,0 +1,123 @@
+const DELIMITER = "\u0004"; // End of Transmission (EOT)
+
+/**
+ * TODO: We need to add description here
+ * @param {any} catalog string or function
+ * @returns {string} string or string from a function
+ */
+function getTranslations(catalog) {
+  return typeof catalog === "function" ? catalog() : catalog;
+}
+
+/**
+ * TODO: We need to add description here
+ * @param {any} plural string or function
+ * @param {any} n TODO: No idea what will pass in it
+ * @returns {any} 0 if nothing
+ */
+function getPluralForm(plural, n) {
+  // return 0 if n is not integer
+  if (Number.isNaN(parseInt(n, 10))) {
+    return 0;
+  }
+
+  // if pluralForm is function, use it to get plural form index
+  if (typeof plural === "function") {
+    return plural(n);
+  }
+
+  // if pluralForm is string and contains only "n", "0-9", " ", "!=?:%+-/*><&|()"
+  // characters, then we can "eval" it to calculate plural form
+  if (typeof plural === "string" && !plural.match(/[^n0-9 !=?:%+-/*><&|()]/i)) {
+    /* eslint-disable no-new-func */
+    const calcPlural = Function("n", `return ${plural}`);
+    /* eslint-enable no-new-func */
+    return +calcPlural(n);
+  }
+
+  return 0;
+}
+
+/**
+ * TODO: We need to add description here
+ * @param {string} catalog Catalog
+ * @param {string} message Message
+ * @returns {string} Message
+ */
+export function gettext(catalog, message) {
+  const messages = getTranslations(catalog);
+  return Object.prototype.hasOwnProperty.call(messages, message)
+    ? messages[message]
+    : message;
+}
+
+/**
+ * TODO: WE need to add description here
+ * @param {string} catalog Catalog
+ * @param {string} plurality Plurality
+ * @param {string} singular Singular
+ * @param {string} plural Plural
+ * @param {number} n n
+ * @returns {string} Message
+ */
+export function ngettext(catalog, plurality, singular, plural, n) {
+  const messages = getTranslations(catalog);
+  const pluralIndex = getPluralForm(plurality, n);
+  const defaultValue = n > 1 ? plural : singular;
+
+  return Object.prototype.hasOwnProperty.call(messages, singular) &&
+  Array.isArray(messages[singular]) &&
+  messages[singular].length > pluralIndex &&
+  pluralIndex >= 0
+    ? messages[singular][pluralIndex]
+    : defaultValue;
+}
+
+/**
+ * TODO: We need to add description here
+ * @param {string} catalog Catalog
+ * @param {string} message Message
+ * @param {string} context Context
+ * @returns {string} Message
+ */
+export function xgettext(catalog, message, context) {
+  const messages = getTranslations(catalog);
+  const key = context + DELIMITER + message;
+
+  return Object.prototype.hasOwnProperty.call(messages, key)
+    ? messages[key]
+    : message;
+}
+
+/**
+ * TODO: We need to add description here
+ * @param {string} catalog Catalog
+ * @param {string} plurality Plurality
+ * @param {string} singular Singular
+ * @param {string} plural Plural
+ * @param {number} n n
+ * @param {string} context Context
+ * @returns {string} Message
+ */
+export function nxgettext(catalog, plurality, singular, plural, n, context) {
+  const messages = getTranslations(catalog);
+  const pluralIndex = getPluralForm(plurality, n);
+  const defaultValue = n > 1 ? plural : singular;
+  const key = context + DELIMITER + singular;
+
+  return Object.prototype.hasOwnProperty.call(messages, key) &&
+  Array.isArray(messages[key]) &&
+  messages[key].length > pluralIndex &&
+  pluralIndex >= 0
+    ? messages[key][pluralIndex]
+    : defaultValue;
+}
+
+const allDomain = {
+  gettext,
+  ngettext,
+  xgettext,
+  nxgettext
+};
+
+export default allDomain;

package/src/index.js

@@ -0,0 +1,12 @@
+import TextDomain from './TextDomain';
+import TextDomainContext from './TextDomainContext';
+import buildTextDomain from './buildTextDomain';
+import withGettext from './withGettext';
+
+export {
+  TextDomain,
+  TextDomainContext,
+  buildTextDomain,
+};
+
+export default withGettext;

package/src/withGettext.js

@@ -0,0 +1,40 @@
+import React from 'react';
+import TextDomain from './TextDomain';
+import hoistNonReactStatic from 'hoist-non-react-statics';
+
+const withGettext = (translations = {
+}, pluralForm = 'n != 1', options = {
+}) => (WrappedComponent) => {
+  const args = Object.assign({
+    withRef: false 
+  }, options);
+
+  class WithGettext extends TextDomain {
+
+    getWrappedComponent() {
+      return this.refs.wrappedComponent;
+    }
+
+    render() {
+      const newprops = Object.assign({
+      }, this.props);
+      if (args.withRef) {
+        newprops.ref = 'wrappedComponent';
+      }
+
+      return React.createElement(WrappedComponent, newprops);
+    }
+
+  }
+
+  WithGettext.defaultProps = {
+    translations,
+    plural: pluralForm,
+  };
+
+  WithGettext.displayName = `withGettext(${WrappedComponent.displayName || WrappedComponent.name || 'Component'})`;
+
+  return hoistNonReactStatic(WithGettext, WrappedComponent);
+};
+
+export default withGettext;