id_pack 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e8731fab4947eaab425af39652bdb53123f64b66
+  data.tar.gz: 7f571ff94f358063908bf0c8f0d763431c2c5a87
+SHA512:
+  metadata.gz: a9de58d8ce76c8f4aedcee05a7e0b2b7dac0838da532c8b7f90b23c347d16b3c9bc442a20110b7ec6635a7e117a0ae253c0339b045ace3a17188b2c201f2dac7
+  data.tar.gz: 7f81c9eef199e29ec689e0a632ade5b8fe536a2cfd11f9dfd02ca942b7ab10c562df01bd46249e8556467dc15d5bf313dc129d72e61a8827015eb12d7e172719

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.15.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at ronald.tse@ribose.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    id_pack (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.15)
+  id_pack!
+  rake (~> 10.0)
+  rspec (~> 3.6)
+
+BUNDLED WITH
+   1.16.0

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Ribose
+
+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,39 @@
+# IdPack
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/id_pack`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'id_pack'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install id_pack
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/riboseinc/id_pack. This project is intended to be a safe,
+welcoming space for collaboration, and contributors are expected to adhere to
+the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+

data/Rakefile

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

data/app/assets/javascripts/lib/id-packer.js

@@ -0,0 +1,296 @@
+/** vim: et:ts=2:sw=2:sts=2
+ * @license (c) 2017 Ribose Inc.
+ *
+ * IdPacker is a library provides encoding support for Number collections (Arrays or Objects).
+ *
+ *
+ * Usage:
+ *
+ * The encoding algorithm encodes a Number collection (in form of Array or Object) into another String.
+ *
+ * @param collection - Number collection (in form of Array or Object)
+ * @param windowSize - Maximunm length of the binary encodedString in binary form (default: 10)
+ * @param isExcludeNull - Exclude the object keys with null value (default: true)
+ * @param outputCharset - Control how the output look like. CANNOT CONTAIN DUPLICATED characters (default: "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-")
+ *
+ * IdPacker.encodeHashKeys(collection, windowSize, isExcludeNull, outputCharset);
+ *
+ *
+ * Examples:
+ *
+ * // encrypt the items in an Array
+ * var collection = [5, 6, 21, 23, 25];
+ * IdPacker.encodeHashKeys(collection);
+ * => "_E~C_O.V"
+ *
+ * // encrypt the keys of an Object
+ * var collection = {
+ *   5: "a",
+ *   6: "b",
+ *   21: "c",
+ *   23: "d",
+ *   25: "e"
+ * };
+ * IdPacker.encodeHashKeys(collection);
+ * => "_E~C_O.V"
+ *
+ *
+ * The encoding algorithm:
+ *
+ * The algorithm first sorts the collection in ascending order. Then, it decomposes
+ * the sorted collection into multiple parts starting from 1. Finally, each part is
+ * encoded into one of the following three encodedString forms:
+ *
+ * 1) Spaces encodedString
+ * A encoded text with prefix '_', represents continuous space.
+ *
+ * 2) Range encodedString
+ * A encoded text with prefix '~', represents continuous number.
+ *
+ * 3) Binary encodedString
+ * A encoded text with prefix '.', represents arbitrary distributed numbers.
+ *
+ * In each part, the encodedString after the prefix is a value from a base-X number system, where
+ * X is the length of IdPacker.outputCharset (overridable).
+ *
+ * Take the encoded text "_E~C_O.V" (original collection: [5, 6, 21, 23, 25]) as an example.
+ * It consists of 4 parts：
+ *
+ * 1）_E
+ * 4 continuous space (0-4)
+ *
+ * 2) ~C
+ * 2 continuous number (5,6)
+ *
+ * 3) _O
+ * 14 continuous space (7-20)
+ *
+ * 4) .V
+ * Convert 'V' from the base-X number system to base-10 number system gives '21',
+ * convert '21' from the base-10 number system to base-2 (binary) number system gives '101'.
+ * '1' and '0' represent 'number' and 'space', respectively. Therefore, '101' denotes 21, 23, 25.
+ */
+(function (factory) {
+  'use strict';
+
+  /* AMD. Register as an anonymous module. */
+  if (typeof define === 'function' && define.amd) {
+    define(factory);
+  }
+
+  /* Node/CommonJS */
+  else if (typeof exports === 'object') {
+    module.exports = factory();
+  }
+
+  /* Browser globals */
+  else {
+    factory();
+  }
+
+}(function() {
+  'use strict';
+
+  return {
+    spacesEncodedStringPrefix: '_',
+    binaryEncodedStringPrefix: '.',
+    rangeEncodedStringPrefix:  '~',
+    windowSize:                10,
+    isExcludeNull:             true,
+    outputCharset:             "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-",
+
+    /**
+     * [1,2,3,6,7,8]
+     * => [IdPack.range(start: 1 length: 3), IdPack.range(start: 6 length: 3)]
+     */
+    convertNumbersToRanges: function (numbers) {
+      var ranges = [];
+      if (numbers.length > 0) {
+        var range = new IdPack.range(numbers[0], 1);
+        for (var i = 1; i < numbers.length; i++) {
+          if (numbers[i] == numbers[i-1]+1) {
+            range.length = range.length + 1;
+          } else {
+            ranges.push(range);
+            range = new IdPack.range(numbers[i], 1);
+          }
+        }
+        ranges.push(range);
+      }
+      return ranges;
+    },
+
+    /**
+     * [IdPack.range(start: 1 length: 3), IdPack.range(start: 6 length: 3)]
+     * => "11100111"
+     */
+    convertRangesToBinaryNumber: function (ranges) {
+      var binaryNumber = '';
+      var i, j;
+      for (i = 0; i < ranges.length; i++) {
+        if (i > 0) {
+          for (j = ranges[i].start; j > ranges[i-1].end() + 1; j--) {
+            binaryNumber += '0';
+          }
+        }
+        for (j = 0; j < ranges[i].length; j++) {
+          binaryNumber += '1';
+        }
+      }
+      return binaryNumber;
+    },
+
+    /**
+     * [5, 6, 21, 23, 25]
+     * => "_E~C_O.V"
+     */
+    encodeHashKeys: function(hash, windowSize, isExcludeNull, outputCharset) {
+      // set default values
+      windowSize    = typeof  windowSize   === "number"  ? windowSize    : this.windowSize;
+      isExcludeNull = typeof isExcludeNull === "boolean" ? isExcludeNull : this.isExcludeNull;
+      outputCharset = typeof outputCharset === "string"  ? outputCharset : this.outputCharset;
+
+      var encodedHashKeys = '';
+      var hashKeys = hash instanceof Array ? hash : [];
+
+      // convert keys in Object into array if collection is an Object
+      if (! (hash instanceof Array)) {
+        var hashKey;
+        for (hashKey in hash) {
+          if (!isExcludeNull || isExcludeNull && hash[hashKey]) {
+            hashKeys.push(parseInt(hashKey, 10));
+          }
+        }
+
+        if (! hashKeys.length) {
+          return '';
+        }
+      }
+
+      // sort the collection in ascending order
+      hashKeys.sort(function(a,b) {
+        return a - b;
+      });
+
+      var ranges        = this.convertNumbersToRanges(hashKeys);
+      var prevEnd       = 0;
+      var currStart     = 1;
+      var spaces        = 0;
+      var groupWithPrev = false;
+      var rangesToGroup = [];
+      var binaryNumber  = '';
+      var decimalNumber = 0;
+      var encodedString = '';
+
+      for (var i = 0; i < ranges.length; i++) {
+
+        spaces = ranges[i].start - prevEnd;
+
+        if (groupWithPrev) {
+
+          if (ranges[i].end() - currStart + 1 == windowSize) {
+            rangesToGroup.push(ranges[i]);
+            binaryNumber     = this.convertRangesToBinaryNumber(rangesToGroup);
+            decimalNumber    = this.convertBinaryNumberToDecimalNumber(binaryNumber);
+            encodedString    = this.binaryPrefix + this.encodeDecimalNumber(decimalNumber, outputCharset);
+            encodedHashKeys += encodedString;
+            rangesToGroup    = [];
+            groupWithPrev    = false;
+          } else if (ranges[i].end() - currStart + 1 >= windowSize) {
+
+            if (rangesToGroup.length == 1) {
+              encodedString    = this.rangePrefix + this.encodeDecimalNumber(rangesToGroup[0].length, outputCharset);
+              encodedHashKeys += encodedString;
+            } else {
+              binaryNumber     = this.convertRangesToBinaryNumber(rangesToGroup);
+              decimalNumber    = this.convertBinaryNumberToDecimalNumber(binaryNumber);
+              encodedString    = this.binaryPrefix + this.encodeDecimalNumber(decimalNumber, outputCharset);
+              encodedHashKeys += encodedString;
+            }
+
+            rangesToGroup    = [];
+            encodedString    = this.spacesPrefix + this.encodeDecimalNumber(spaces, outputCharset);
+            encodedHashKeys += encodedString;
+
+            if (ranges[i].length >= windowSize) {
+              encodedString    = this.rangePrefix + this.encodeDecimalNumber(ranges[i].length, outputCharset);
+              encodedHashKeys += encodedString;
+              groupWithPrev    = false;
+            } else {
+              rangesToGroup.push(ranges[i]);
+              currStart     = ranges[i].start;
+              groupWithPrev = true;
+            }
+          } else {
+            rangesToGroup.push(ranges[i]);
+          }
+        } else {
+          if (spaces >= 0) {
+            encodedString    = this.spacesPrefix + this.encodeDecimalNumber(spaces, outputCharset);
+            encodedHashKeys += encodedString;
+          }
+          if (ranges[i].length >= windowSize) {
+            encodedString    = this.rangePrefix + this.encodeDecimalNumber(ranges[i].length, outputCharset);
+            encodedHashKeys += encodedString;
+          } else {
+            rangesToGroup.push(ranges[i]);
+            currStart     = ranges[i].start;
+            groupWithPrev = true;
+          }
+        }
+        prevEnd = ranges[i].end();
+      }
+
+      if (rangesToGroup.length == 1) {
+        encodedString    = this.rangePrefix + this.encodeDecimalNumber(rangesToGroup[0].length, outputCharset);
+        encodedHashKeys += encodedString;
+      } else if (rangesToGroup.length > 0) {
+        binaryNumber     = this.convertRangesToBinaryNumber(rangesToGroup);
+        decimalNumber    = this.convertBinaryNumberToDecimalNumber(binaryNumber);
+        encodedString    = this.binaryPrefix + this.encodeDecimalNumber(decimalNumber, outputCharset);
+        encodedHashKeys += encodedString;
+      }
+      return encodedHashKeys;
+    },
+
+    encodeInteger: function (n) {
+      return this.encodeDecimalNumber(n);
+    },
+
+    /**
+     * "10101"
+     * => 21
+     */
+    convertBinaryNumberToDecimalNumber: function(binaryNumber) {
+      var decimalNumber = 0;
+      for (var i = 0; i < binaryNumber.length; i++) {
+        decimalNumber = decimalNumber + Math.pow(2, binaryNumber.length - i - 1) * parseInt(binaryNumber.charAt(i), 10);
+      }
+      return decimalNumber;
+    },
+
+    /**
+     * 5
+     * => F"
+     */
+    encodeDecimalNumber: function(decimalNumber, outputCharset) {
+      if (typeof outputCharset == 'undefined' || outputCharset == null) {
+        outputCharset = this.outputCharset;
+      }
+      var encodedNumber = "";
+      var base          = outputCharset.length;
+      var quotient      = decimalNumber;
+      var remainder;
+      while (true) {
+        remainder = quotient % base;
+        encodedNumber = outputCharset.charAt(remainder) + encodedNumber;
+        quotient = (quotient - remainder) / base;
+        if (quotient == 0) {
+          break;
+        }
+      }
+      return encodedNumber;
+    }
+  };
+
+}));