hash_unnest 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c988aea31df14ef50afcaf73818f844a0ab61aca55fcf0614425a95441a6e810
+  data.tar.gz: 0f47f4110f2ee9a2ba2bd1133d8d55ec0c7c44135b569abc3efae44f6a18790f
+SHA512:
+  metadata.gz: d75dfe4e4d93a2ba794d0b0d4cfac7120aca446372063af6e012dee0ffcfcfd6a8ece663394359d4b273dac3ef74f7f039ac0a4b28d80767fa0c1264047b3bac
+  data.tar.gz: 98252c49b5744768268406c302441eb3654daf8c120cfb9d8ad605df97d22176591a20000616ec46afca8b933517a17bbcf565f15c90cdc5719a16af35438dc6

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 HouseTrip Ltd.
+
+MIT License
+
+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,26 @@
+# hash-unnest 
+
+Un-nests hashes, ie transforms:
+
+    { a: { b: 1 }, c: 2 }
+
+into
+
+    { a.b: 1, c: 2 }
+    
+Keys in the output hash will be sorted in lexicographical order.
+
+## Installation
+
+    gem install hash_unnest
+
+## Usage
+
+```ruby
+require 'hash_unnest'
+Hash.include(HashUnnest)
+
+h = { a: { b: 1 }, c: 2 }
+h.unnest
+# => { a.b: 1, c: 2 }
+```

data/ext/hash_unnest/extconf.rb

@@ -0,0 +1,12 @@
+require 'mkmf'
+
+PLATFORM = `uname`.strip.upcase
+SHARED_FLAGS = "--std=c99 -Wall -Wextra -Werror"
+
+# production
+$CFLAGS += " #{SHARED_FLAGS} -Os"
+
+# development
+# $CFLAGS += " #{SHARED_FLAGS} -O0 -g -DDEBUG"
+
+create_makefile('hash_unnest/hash_unnest')

data/ext/hash_unnest/hash_unnest.c

@@ -0,0 +1,167 @@
+#include <ruby.h>
+#include <assert.h>
+#include "hash_unnest.h"
+
+// forward declarataions of closures
+static int hash_unnest_size_closure(VALUE key, VALUE val, VALUE in);
+static int hash_unnest_closure(VALUE key, VALUE val, VALUE in);
+
+static VALUE eHashUnnestModule = Qnil;
+
+// a (sortable) key-value entry
+typedef struct {
+  VALUE key;
+  VALUE value;
+} hn_record_t;
+
+/******************************************************************************/
+
+// Unnesting callback:
+// 
+// - When `val` is anything but a hash, just add it to the `in[1]` buffer,
+//   using the prefix in `in[0]`.
+//   
+//   Note that in[1] is a pointer to the current buffer pointer;
+//   so it sets the buffer cell, thenmoves the pointer to the next cell.
+//
+// - When `val` is a hash, call ourselves recursively, appending the
+//   current key to the prefix.
+//
+static int hash_unnest_closure(VALUE key, VALUE val, VALUE in)
+{
+  VALUE prefix = rb_ary_entry(in, 0);
+  hn_record_t** output = (hn_record_t**) rb_ary_entry(in, 1);
+
+#ifdef DEBUG
+  VALUE _str_key = rb_funcall(key,    rb_intern("inspect"), 0);
+  VALUE _str_val = rb_funcall(val,    rb_intern("inspect"), 0);
+  LOG("*** hash_unnest_closure (%s,%s,'%s')\n", StringValueCStr(_str_key), StringValueCStr(_str_val), StringValueCStr(prefix));
+#endif
+
+  switch(TYPE(val)) {
+    case T_HASH:
+      {
+        VALUE new_prefix;
+        VALUE new_in;
+
+        new_prefix = rb_str_dup(prefix);
+        rb_str_append(new_prefix, key);
+        rb_str_cat2(new_prefix, ".");
+
+        new_in = rb_ary_new2(2);
+        rb_ary_store(new_in, 0, new_prefix);
+        rb_ary_store(new_in, 1, (VALUE) output);
+
+        rb_hash_foreach(val, hash_unnest_closure, new_in);
+        break;
+      }
+    default:
+      {
+        VALUE new_key = rb_str_dup(prefix);
+
+        rb_str_append(new_key, key);
+        (*output)->key   = new_key;
+        (*output)->value = val;
+        *output = *output + 1;
+      }
+  }
+  return ST_CONTINUE;
+}
+
+/******************************************************************************/
+
+// Recursively counts the number of leaves ("size") of a nested hash.
+static int hash_unnest_size_closure(VALUE key, VALUE val, VALUE in)
+{
+  switch(TYPE(val)) {
+    case T_HASH:
+      {
+        rb_hash_foreach(val, hash_unnest_size_closure, in);
+        break;
+      }
+    default:
+      {
+        int* size = (int*) in;
+        *size = *size + 1;
+      }
+  }
+  return ST_CONTINUE;
+}
+
+/******************************************************************************/
+
+// Compares the `key`s in `hn_record_t`s, for sorting purposes.
+int hn_record_compare(const void* a, const void* b) {
+  hn_record_t* record_a = (hn_record_t*) a;
+  hn_record_t* record_b = (hn_record_t*) b;
+
+  LOG("compare '%s' to '%s'\n", StringValueCStr(record_a->key), StringValueCStr(record_b->key));
+
+  // NOTE: use StringValue + memcmp if slow
+  return strcmp(
+    StringValueCStr(record_a->key),
+    StringValueCStr(record_b->key)
+  );
+}
+
+/******************************************************************************/
+
+static VALUE hash_unnest_unnest(VALUE self)
+{
+  VALUE result, in, prefix;
+  hn_record_t* buf;
+  hn_record_t* buf_ptr;
+  int size = 0;
+
+#ifdef DEBUG
+  {
+    VALUE _str_self   = rb_funcall(self,   rb_intern("to_s"), 0);
+    LOG("*** hash_unnest_unnest (%s)\n", StringValueCStr(_str_self));
+  }
+#endif
+
+  rb_hash_foreach(self, hash_unnest_size_closure, (VALUE) &size);
+#ifdef DEBUG
+  {
+    VALUE _str_self   = rb_funcall(self,   rb_intern("to_s"), 0);
+    LOG("*** size(%s): %d\n", StringValueCStr(_str_self), size);
+  }
+#endif
+
+  buf = (hn_record_t*) malloc(size * sizeof(hn_record_t));
+  buf_ptr = buf;
+
+  prefix = rb_str_new("", 0);
+
+  in = rb_ary_new2(2);
+  rb_ary_store(in, 0, prefix);
+  rb_ary_store(in, 1, (VALUE) &buf_ptr);
+    
+  rb_hash_foreach(self, hash_unnest_closure, in);
+
+  qsort((void*) buf, size, sizeof(hn_record_t), hn_record_compare);
+
+  result = rb_hash_new();
+  for (int k = 0; k < size; ++k) {
+    hn_record_t entry = buf[k];
+
+    rb_hash_aset(result, entry.key, entry.value);
+  }
+
+  free(buf);
+
+  return result;
+}
+
+/******************************************************************************/
+
+void Init_hash_unnest(void) {
+  LOG("*** Init_hash_unnest\n");
+
+  /* assume we haven't yet defined hash_unnest */
+  eHashUnnestModule = rb_define_module("HashUnnest");
+  assert(eHashUnnestModule != Qnil);
+
+  rb_define_method(eHashUnnestModule, "unnest_c", hash_unnest_unnest, 0);
+  return;
+}

data/ext/hash_unnest/hash_unnest.h

@@ -0,0 +1,18 @@
+/*
+
+  hash_unnest.h --
+
+  Helper macros
+
+*/
+
+#ifndef __HASH_UNNEST_H__
+#define __HASH_UNNEST_H__ 1
+
+#ifdef DEBUG
+  #define LOG(...) fprintf(stderr, __VA_ARGS__)
+#else
+  #define LOG(...)
+#endif
+
+#endif

data/lib/hash_unnest.rb

@@ -0,0 +1,7 @@
+require 'hash_unnest/hash_unnest'
+
+module HashUnnest
+  def unnest
+    unnest_c
+  end
+end

data/lib/hash_unnest/version.rb

@@ -0,0 +1,4 @@
+module HashUnnest
+  VERSION = '1.0.0'.freeze
+end
+

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: hash_unnest
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Julien Letessier
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-04-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Fast hash unnesting
+email:
+- julien.letessier@gmail.com
+executables: []
+extensions:
+- ext/hash_unnest/extconf.rb
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- ext/hash_unnest/extconf.rb
+- ext/hash_unnest/hash_unnest.c
+- ext/hash_unnest/hash_unnest.h
+- lib/hash_unnest.rb
+- lib/hash_unnest/version.rb
+homepage: http://github.com/mezis/hash_unnest
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Fast hash unnesting
+test_files: []