ae_fast_decimal_formatter 1.0.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 45ca777593c0bfaf6e4cac01b3681d91935a91a0b005defec7436f9fd9b44c39
-  data.tar.gz: be583138932ff4fe697f296bb57f691898f299fe6a1af7f2ed7be85f5d7cfffc
+  metadata.gz: fac5f36669896fd67ffb43a022635899c7143a6cd6204064260051a6fde5a180
+  data.tar.gz: f5d41ebc1983a010473c7763915b3ca04c5c845581bfaafdcc55d9ac1e918061
 SHA512:
-  metadata.gz: 36437067c9f6a566b9894cb2f377a337a2d8aec466b46f856804027debc2ab583974cf325b45b71ef9e33f88235a9f2b3a2042dd2546119414f4931a3a0b0525
-  data.tar.gz: 00cf30e71c1fe476701dd362e97383ed9d89b7f5eeb24c83459d45dcae5ad3d2ba9a49737bc1263463191bd63640ff3f3b273b91384bcd2826228cecbb4c96db
+  metadata.gz: b884e0704195a3d19cf5b346f09eeb1e1ac8ad5186582060c932ac127d6b1a30cccb1cf223fd65608f38930e6551f57826653428fdd4528ebf53f20ae55686f1
+  data.tar.gz: 0f9d967ff0a792e6c29d5d3123280fbf2e52d5502b5de6e3b10df93aaedf476ba7a917827a2b498d10991cb310a57ffc858511b9db97840843aed7df669151dc

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,5 @@
 require "mkmf"
 
-abort "missing snprintf()" unless have_func "snprintf"
-abort "missing strncmp()"  unless have_func "strncmp"
+append_cflags("-std=c99")
 
 create_makefile "ae_fast_decimal_formatter/ae_fast_decimal_formatter"

data/lib/ae_fast_decimal_formatter/version.rb

@@ -1,3 +1,3 @@
 class AeFastDecimalFormatter
-  VERSION = '1.0.0'
+  VERSION = '2.1.1'
 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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ae_fast_decimal_formatter
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.1.1
 platform: ruby
 authors:
 - AppFolio
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-23 00:00:00.000000000 Z
+date: 2022-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable