listpack 0.0.1.beta

data/ext/listpack/listpack.h

@@ -0,0 +1,61 @@
+/* Listpack -- A lists of strings serialization format
+ *
+ * This file implements the specification you can find at:
+ *
+ *  https://github.com/antirez/listpack
+ *
+ * Copyright (c) 2017, Salvatore Sanfilippo <antirez at gmail dot com>
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ *   * Redistributions of source code must retain the above copyright notice,
+ *     this list of conditions and the following disclaimer.
+ *   * Redistributions in binary form must reproduce the above copyright
+ *     notice, this list of conditions and the following disclaimer in the
+ *     documentation and/or other materials provided with the distribution.
+ *   * Neither the name of Redis nor the names of its contributors may be used
+ *     to endorse or promote products derived from this software without
+ *     specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#ifndef __LISTPACK_H
+#define __LISTPACK_H
+
+#include <stdint.h>
+
+#define LP_INTBUF_SIZE 21 /* 20 digits of -2^63 + 1 null term = 21. */
+
+/* lpInsert() where argument possible values: */
+#define LP_BEFORE 0
+#define LP_AFTER 1
+#define LP_REPLACE 2
+
+unsigned char *lpNew(void);
+void lpFree(unsigned char *lp);
+unsigned char *lpInsert(unsigned char *lp, unsigned char *ele, uint32_t size, unsigned char *p, int where, unsigned char **newp);
+unsigned char *lpAppend(unsigned char *lp, unsigned char *ele, uint32_t size);
+unsigned char *lpDelete(unsigned char *lp, unsigned char *p, unsigned char **newp);
+uint32_t lpLength(unsigned char *lp);
+unsigned char *lpGet(unsigned char *p, int64_t *count, unsigned char *intbuf);
+unsigned char *lpFirst(unsigned char *lp);
+unsigned char *lpLast(unsigned char *lp);
+unsigned char *lpNext(unsigned char *lp, unsigned char *p);
+unsigned char *lpPrev(unsigned char *lp, unsigned char *p);
+uint32_t lpBytes(unsigned char *lp);
+unsigned char *lpSeek(unsigned char *lp, long index);
+
+#endif

data/ext/listpack/listpack_malloc.h

@@ -0,0 +1,45 @@
+/* Listpack -- A lists of strings serialization format
+ * https://github.com/antirez/listpack
+ *
+ * Copyright (c) 2017, Salvatore Sanfilippo <antirez at gmail dot com>
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ *   * Redistributions of source code must retain the above copyright notice,
+ *     this list of conditions and the following disclaimer.
+ *   * Redistributions in binary form must reproduce the above copyright
+ *     notice, this list of conditions and the following disclaimer in the
+ *     documentation and/or other materials provided with the distribution.
+ *   * Neither the name of Redis nor the names of its contributors may be used
+ *     to endorse or promote products derived from this software without
+ *     specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
+
+/* Allocator selection.
+ *
+ * This file is used in order to change the Rax allocator at compile time.
+ * Just define the following defines to what you want to use. Also add
+ * the include of your alternate allocator if needed (not needed in order
+ * to use the default libc allocator). */
+
+#ifndef LISTPACK_ALLOC_H
+#define LISTPACK_ALLOC_H
+//#include "zmalloc.h"
+#define lp_malloc malloc
+#define lp_realloc realloc
+#define lp_free free
+#endif

data/ext/listpack/listpack_rb.c

@@ -0,0 +1,211 @@
+#include <ruby.h>
+#include <stdint.h>
+#include "listpack.h"
+#include "listpack_malloc.h"
+
+static VALUE Listpack;
+
+typedef struct {
+  unsigned char *lp;
+  unsigned char *p;
+} listpack_rb;
+
+// Internal methods
+
+/* Loads a listpack format string into the internal struct */
+VALUE _rb_listpack_load(VALUE self, VALUE rb_str)
+{
+  listpack_rb *list;
+  Data_Get_Struct(self, listpack_rb, list);
+  size_t str_len = RSTRING_LENINT(rb_str);
+
+  if (list->lp != NULL) {
+    lp_free(list->lp);
+  }
+
+  list->lp = lp_malloc(str_len);
+
+  if (list->lp == NULL) {
+    rb_raise(rb_eNoMemError, "no memory for listpack");
+  }
+
+  memcpy(list->lp, RSTRING_PTR(rb_str), str_len);
+
+  return Qtrue;
+}
+
+/* Converts a value from the list to the correct Ruby type */
+VALUE _rb_listpack_getvalue(unsigned char *p)
+{
+  if(!p) {
+    return Qnil;
+  }
+
+  unsigned char * result;
+  int64_t num;
+
+  result = lpGet(p, &num, NULL);
+
+  if(result) {
+    return rb_str_new((char *) result, num);
+  } else {
+    return rb_int_new(num);
+  }
+}
+
+// Public methods
+VALUE rb_listpack_append(VALUE self, VALUE rb_ele)
+{
+  listpack_rb *list;
+  Data_Get_Struct(self, listpack_rb, list);
+
+  list->lp = lpAppend(list->lp, (unsigned char *) RSTRING_PTR(rb_ele), RSTRING_LENINT(rb_ele));
+
+  if (list->lp == NULL) {
+    rb_raise(rb_eNoMemError, "no memory for listpack");
+  }
+
+  return Qtrue;
+}
+
+VALUE rb_listpack_current(VALUE self)
+{
+  listpack_rb *list;
+  Data_Get_Struct(self, listpack_rb, list);
+
+  if (list->p == NULL) {
+    return Qnil;
+  }
+  else {
+    return _rb_listpack_getvalue(list->p);
+  }
+}
+
+VALUE rb_listpack_first(VALUE self)
+{
+  listpack_rb *list;
+  unsigned char *result;
+  Data_Get_Struct(self, listpack_rb, list);
+
+  result = lpFirst(list->lp);
+
+  return _rb_listpack_getvalue(result);
+}
+
+VALUE rb_listpack_initialize(int argc, VALUE* argv, VALUE self)
+{
+  listpack_rb *list;
+  VALUE data;
+  Data_Get_Struct(self, listpack_rb, list);
+  rb_scan_args(argc, argv, "01", &data);
+
+  if (NIL_P(data)) {
+    list->lp = lpNew();
+  }
+  else {
+    _rb_listpack_load(self, data);
+  }
+
+  return Qnil;
+}
+
+VALUE rb_listpack_insert(VALUE self, VALUE rb_ele)
+{
+  listpack_rb *list;
+  Data_Get_Struct(self, listpack_rb, list);
+
+  list->lp = lpInsert(list->lp, (unsigned char *) RSTRING_PTR(rb_ele), RSTRING_LENINT(rb_ele), list->p, LP_AFTER, &list->p);
+
+  if (list->lp == NULL) {
+    rb_raise(rb_eNoMemError, "no memory for listpack");
+  }
+
+  return Qtrue;
+}
+
+VALUE rb_listpack_last(VALUE self)
+{
+  listpack_rb *list;
+  unsigned char *result;
+  Data_Get_Struct(self, listpack_rb, list);
+
+  result = lpLast(list->lp);
+
+  return _rb_listpack_getvalue(result);
+}
+
+VALUE rb_listpack_next(VALUE self)
+{
+  listpack_rb *list;
+  Data_Get_Struct(self, listpack_rb, list);
+
+  if (list->p == NULL) {
+    list->p = lpFirst(list->lp);
+  } else {
+    list->p = lpNext(list->lp, list->p);
+  }
+
+  return _rb_listpack_getvalue(list->p);
+}
+
+VALUE rb_listpack_seek(VALUE self, VALUE rb_idx)
+{
+  listpack_rb *list;
+  Data_Get_Struct(self, listpack_rb, list);
+
+  list->p = lpSeek(list->lp, NUM2UINT(rb_idx));
+
+  return Qnil;
+}
+
+VALUE rb_listpack_size(VALUE self)
+{
+  listpack_rb *list;
+  Data_Get_Struct(self, listpack_rb, list);
+
+  return rb_uint_new(lpLength(list->lp));
+}
+
+VALUE rb_listpack_to_s(VALUE self)
+{
+  listpack_rb *list;
+  Data_Get_Struct(self, listpack_rb, list);
+
+  return rb_str_new((char *) list->lp, lpBytes(list->lp));
+}
+
+static void deallocate(listpack_rb *p_list)
+{
+  lpFree(p_list->lp);
+  xfree(p_list);
+}
+
+static VALUE allocate(VALUE klass)
+{
+  listpack_rb *list;
+
+  if ((list = ALLOC(listpack_rb)) != NULL)
+  {
+    list->lp = NULL;
+    list->p = NULL;
+  }
+
+  return Data_Wrap_Struct(klass, NULL, deallocate, list);
+}
+
+void Init_listpack(void) {
+  Listpack = rb_define_class("Listpack", rb_cObject);
+  rb_define_alloc_func(Listpack, allocate);
+
+  rb_define_method(Listpack, "append", rb_listpack_append, 1);
+  rb_define_method(Listpack, "current", rb_listpack_current, 0);
+  rb_define_method(Listpack, "first", rb_listpack_first, 0);
+  rb_define_method(Listpack, "initialize", rb_listpack_initialize, -1);
+  rb_define_method(Listpack, "insert", rb_listpack_insert, 1);
+  rb_define_method(Listpack, "last", rb_listpack_next, 0);
+  rb_define_method(Listpack, "next", rb_listpack_next, 0);
+  rb_define_method(Listpack, "prev", rb_listpack_first, 0);
+  rb_define_method(Listpack, "seek", rb_listpack_seek, 1);
+  rb_define_method(Listpack, "size", rb_listpack_size, 0);
+  rb_define_method(Listpack, "to_s", rb_listpack_to_s, 0);
+}

data/lib/listpack.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'listpack/version'
+require 'listpack/listpack'

data/lib/listpack/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class Listpack
+  VERSION = '0.0.1.beta'
+end

data/listpack.gemspec

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "listpack/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "listpack"
+  spec.version       = Listpack::VERSION
+  spec.authors       = ["Sebastian Wallin"]
+  spec.email         = ["sebastian.wallin@gmail.com"]
+  spec.extensions    = ["ext/listpack/extconf.rb"]
+
+  spec.summary       = %q{Ruby wrapper for Redis listpack data structure}
+  spec.description   = %q{Ruby wrapper for Redis listpack data structure}
+  spec.homepage      = "https://github.com/wallin/listpack-rb"
+  spec.license       = 'BSD-3-Clause'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rake-compiler"
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: listpack
+version: !ruby/object:Gem::Version
+  version: 0.0.1.beta
+platform: ruby
+authors:
+- Sebastian Wallin
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-05-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby wrapper for Redis listpack data structure
+email:
+- sebastian.wallin@gmail.com
+executables: []
+extensions:
+- ext/listpack/extconf.rb
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ext/listpack/extconf.rb
+- ext/listpack/listpack.c
+- ext/listpack/listpack.h
+- ext/listpack/listpack_malloc.h
+- ext/listpack/listpack_rb.c
+- lib/listpack.rb
+- lib/listpack/version.rb
+- listpack.gemspec
+homepage: https://github.com/wallin/listpack-rb
+licenses:
+- BSD-3-Clause
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for Redis listpack data structure
+test_files: []