ae_fast_decimal_formatter 0.1.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 59156225262394ee5540585652a72a196b60845ef06bb64d8409c590f62e535d
-  data.tar.gz: 1dc099b29def36a2f513c6a70d3772ce5df6c48c7a0465ca64e39a300a9dbaa7
+  metadata.gz: 25d8e986474fd332d72658a25693cb1147d0ff71f187b5dd39e3b1be69078bb9
+  data.tar.gz: c0faafa4e3be83109a3de7174e7055c226129e31cdfb83c443483c6c2973a86f
 SHA512:
-  metadata.gz: 9d10f701251c18ca9bba7261635a8723370825a4abc5feee17520a7d9fb64d347bd5bf17fcbdd1e0ccd797bc6536895d9e3e7c7df780e41ddca6646d626b7fa4
-  data.tar.gz: 70abf3b82f2e17cf81010fd8538095c041f717e9d3fc4035dffada029c043ca5e106ea716c696a5469df1fbd87cc42a1e27ab771cbaba23c7a7e1a5b958281ff
+  metadata.gz: '0009ff8c75044a9caafee78662242e0de482dedf0dc9aa207b6d808b7d1ee4145fde1c071cd0b2d29b76fc2f4126f8b212c4b55621f2d5ae317a8f96dd1141f3'
+  data.tar.gz: 2cd3523e207af1a6f0cc2946bdfbc82d8d915e2e58eb488d39fb730dd92597935958f3ba628370a3ff6d426efba1d765d36116eda16b7b387f3c54b9f2a6b32e

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2019-2022 AppFolio, Inc
+
+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/ae_fast_decimal_formatter.gemspec

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative 'lib/ae_fast_decimal_formatter/version'
+
+Gem::Specification.new do |spec|
+  spec.name                  = 'ae_fast_decimal_formatter'
+  spec.version               = AeFastDecimalFormatter::VERSION
+  spec.platform              = Gem::Platform::RUBY
+  spec.author                = 'AppFolio'
+  spec.email                 = 'opensource@appfolio.com'
+  spec.description           = 'Efficiently format decimal number.'
+  spec.summary               = spec.description
+  spec.homepage              = 'https://github.com/appfolio/ae_fast_decimal_formatter'
+  spec.license               = 'MIT'
+  spec.files                 = Dir['**/*'].select { |f| f[%r{^(lib/|ext/|LICENSE.txt|.*gemspec)}] }
+  spec.require_paths         = ['lib']
+  spec.extensions            = ['ext/ae_fast_decimal_formatter/extconf.rb']
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.6.3')
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  spec.add_dependency('addressable', ['>= 2.3.6', '< 3'])
+  spec.add_dependency('rack', ['>= 2.2.3', '< 3'])
+end

data/ext/ae_fast_decimal_formatter/ae_fast_decimal_formatter.c

@@ -1,111 +1,59 @@
 #include <ruby.h>
 #include <float.h>
 
-VALUE c_format_decimal(double num, int precision)
-{
-  char numstr[100];
-  char str[DBL_MAX_10_EXP + 2];
-  int numi, numlen, stri, strl;
-  int maxp = 5, i;
-  char formatstr[10];
-  int digits_to_comma;
-  double rounding_factor, rounded_num;
+inline static char * long_to_formatted_string(long value, char *str, unsigned int strlen, unsigned int precision) {
+  char *p;
+  unsigned long v;
 
-  if (precision > maxp) { precision = maxp; }
-  if (precision < 0) { precision = 0; }
+  v = (value < 0) ? -value : value;
+  p = str + strlen - 1;
 
-  snprintf(formatstr, 10, "%%.%df", precision);
-  formatstr[9] = 0;
-
-  if (precision > 0) {
-    rounding_factor = (double) 10.0;
-    for (i = 1; i < precision; i++) { rounding_factor *= (double) 10.0; }
-
-    double multiplied_num = num * (double) 10.0;
-    for (i = 1; i < precision; i++) { multiplied_num *= (double) 10.0; }
-
-    rounded_num = round(multiplied_num) / rounding_factor;
-  } else {
-    rounded_num = round(num);
+  // Copy all the precision digits
+  for (unsigned int i = 0; i < precision; i++) {
+    *p-- = '0' + (v % 10);
+    v /= 10;
   }
 
-  if (precision > 0) { precision++; } // adjust for .
-
-  numlen = snprintf(numstr, 100, formatstr, rounded_num);
-  digits_to_comma = numlen - precision;
-  if (numstr[0] == '-') { digits_to_comma--; }
-
-  strl = numlen + (digits_to_comma / 3);
-  if ((digits_to_comma % 3) == 0) {
-    strl--;
-  }
-
-  if (strncmp(numstr, "-0.00000", strl) == 0) {
-    return rb_str_new("0.00000", 1 + precision);
-  }
-
-  stri = strl;
-  str[stri] = 0;
-  for (i = 1; i <= (precision + 1); i++) {
-    str[stri - i] = numstr[numlen - i];
+  // Add the dot
+  if (precision > 0) {
+    *p-- = '.';
   }
 
-  stri -= (precision + 2);
-  numlen -= (precision + 1);
-  numi = 1;
+  // Copy all the digits, adding a comma every 3rd digit
+  int digits = 0;
+  do {
+    *p-- = '0' + (v % 10);
+    v /= 10;
 
-  while ((numlen - numi) >= 1) {
-    if ((numi % 3) == 0) {
-      str[stri] = ',';
-      stri--;
+    if ((++digits % 3) == 0 && v) {
+      *p-- = ',';
     }
-    str[stri] = numstr[numlen - numi];
-    stri--;
-    numi++;
-  }
-
-  if (numstr[0] == '-') {
-    str[0] = '-';
-  } else {
-    if ((numi % 3) == 0) {
-      str[1] = ',';
-    }
-    str[0] = numstr[0];
-  }
-  return rb_str_new2(str);
-}
+  } while(v);
 
-struct ae_fast_decimal_formatter {
-  double num;
-  int precision;
-};
+  // Finally, add the - if we started with a negative number
+  if (value < 0) *p-- = '-';
 
-static void ae_fast_decimal_formatter_free(void *p) {}
-
-static VALUE ae_fast_decimal_formatter_alloc(VALUE klass) {
-  VALUE obj;
-  struct ae_fast_decimal_formatter *ptr;
-
-  obj = Data_Make_Struct(klass, struct ae_fast_decimal_formatter, NULL, ae_fast_decimal_formatter_free, ptr);
-
-  ptr->num = 0.0;
-  ptr->precision = 0;
-
-  return obj;
-}
+  // And adjust the p to undo the last p--
+  p++;
 
-static VALUE ae_fast_decimal_formatter_init(VALUE self, VALUE number, VALUE precision) {
-  struct ae_fast_decimal_formatter *ptr;
-  Data_Get_Struct(self, struct ae_fast_decimal_formatter, ptr);
-  ptr->num = NUM2DBL(number);
-  ptr->precision = NUM2UINT(precision);
-  return self;
+  return p;
 }
 
-static VALUE ae_fast_decimal_formatter_format(VALUE self) {
-  struct ae_fast_decimal_formatter *ptr;
-  Data_Get_Struct(self, struct ae_fast_decimal_formatter, ptr);
-  return c_format_decimal(ptr->num, ptr->precision);
+// The function takes a value num (assumed to be fixnum) and value precision (assumed to be fixnum
+// between 0 and 5) and returns num as a formatted string.
+//
+// For example, given 100, 2 the function will output "1.00".
+// For example, given 123456, 2 the function will output "1,234.56".
+// For example, given -1234, 0 the function will output "-1,234".
+static VALUE ae_fast_decimal_formatter_format_long(VALUE self, VALUE num, VALUE precision) {
+  // The maximum length is 28 characters: 20 digits (assuming 64bits), 6 commas,
+  // negative sign, and a period. So we will always fit in 32 chars.
+  char buf[32];
+  char *numstr = long_to_formatted_string(NUM2LONG(num), buf, 32, NUM2UINT(precision));
+
+  // The rb_str_new takes a pointer to a string and a length. It does not rely on
+  // null terminated strings.
+  return rb_str_new(numstr, 32 - (int)(numstr - buf));
 }
 
 void Init_ae_fast_decimal_formatter(void) {
@@ -113,7 +61,5 @@ void Init_ae_fast_decimal_formatter(void) {
 
   cFastDecimalFormatter = rb_const_get(rb_cObject, rb_intern("AeFastDecimalFormatter"));
 
-  rb_define_alloc_func(cFastDecimalFormatter, ae_fast_decimal_formatter_alloc);
-  rb_define_method(cFastDecimalFormatter, "initialize", ae_fast_decimal_formatter_init, 2);
-  rb_define_method(cFastDecimalFormatter, "format", ae_fast_decimal_formatter_format, 0);
+  rb_define_singleton_method(cFastDecimalFormatter, "format_long", ae_fast_decimal_formatter_format_long, 2);
 }

data/ext/ae_fast_decimal_formatter/extconf.rb

@@ -1,6 +1,3 @@
 require "mkmf"
 
-abort "missing snprintf()" unless have_func "snprintf"
-abort "missing strncmp()"  unless have_func "strncmp"
-
 create_makefile "ae_fast_decimal_formatter/ae_fast_decimal_formatter"

data/lib/ae_fast_decimal_formatter/version.rb

@@ -0,0 +1,3 @@
+class AeFastDecimalFormatter
+  VERSION = '2.1.0'
+end

data/lib/ae_fast_decimal_formatter.rb

@@ -1,4 +1,23 @@
+require 'bigdecimal'
+
 class AeFastDecimalFormatter
+  def self.format(number, precision)
+    precision = 0 if precision < 0
+    precision = 5 if precision > 5
+
+    # We can call to_f on the input to convert variety of types to floats. This is
+    # faster than inspecting the type of the input and performing different logic.
+    # This is safe as we have a test that verifies we produce the same result for
+    # float as we do for BigDecimals (i.e. format_long((num * 10 ** precision).round, precision)).
+    #
+    # In order to round correct, it looks like we need the two sets of rounds. For example,
+    # (148.855 * 100).round.to_i -> 14885 seems incorrect, so we try,
+    # (148.855.round(2) * 100).to_i -> 14886 but then,
+    # (1234567890.12.round(2) * 100).to_i -> 123456789011 which is definitely not correct.
+    #
+    # Thus the two rounds.
+    format_long((number.to_f.round(precision) * 10 ** precision).round, precision)
+  end
 end
 
 require "ae_fast_decimal_formatter/ae_fast_decimal_formatter"

metadata

@@ -1,27 +1,70 @@
 --- !ruby/object:Gem::Specification
 name: ae_fast_decimal_formatter
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 2.1.0
 platform: ruby
 authors:
-- Appfolio Inc.
+- AppFolio
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-10 00:00:00.000000000 Z
-dependencies: []
-description: Efficiently format decimal number so that reports of millions of decimal
-  cells are fast
-email: dev@appfolio.com
+date: 2022-03-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.6
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.6
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.3
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.3
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+description: Efficiently format decimal number.
+email: opensource@appfolio.com
 executables: []
 extensions:
 - ext/ae_fast_decimal_formatter/extconf.rb
 extra_rdoc_files: []
 files:
+- LICENSE.txt
+- ae_fast_decimal_formatter.gemspec
 - ext/ae_fast_decimal_formatter/ae_fast_decimal_formatter.c
 - ext/ae_fast_decimal_formatter/extconf.rb
 - lib/ae_fast_decimal_formatter.rb
-homepage: https://www.github.com/appfolio/ae_fast_decimal_formatter
+- lib/ae_fast_decimal_formatter/ae_fast_decimal_formatter.bundle
+- lib/ae_fast_decimal_formatter/version.rb
+homepage: https://github.com/appfolio/ae_fast_decimal_formatter
 licenses:
 - MIT
 metadata:
@@ -35,17 +78,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ">="
     - !ruby/object:Gem::Version
       version: 2.6.3
-  - - "<"
-    - !ruby/object:Gem::Version
-      version: '3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.0.9
 signing_key:
 specification_version: 4
-summary: Efficiently format decimal number
+summary: Efficiently format decimal number.
 test_files: []