data-buffer 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 98569d8254905d930614b2f4f46ebc1292b998539c2f8185e2a1d86bca5c4f61
+  data.tar.gz: 4305e5842428a9d346248fcadd49d962ccd13f579ff15ac74e888031d303b6d0
+SHA512:
+  metadata.gz: 286b60992a8264c16fa5258cb461b1dc98407c0bdd63288a2927ff565590a37a3b1607e357b3487784c2beba77835d10fc04fd97d8bc35ae2ea00003d79e8f9f
+  data.tar.gz: 9491986ca17d2762c148433e1f9accfedd22ce1bc50ba747e5441e5f419991de116a9b9dd5b62725e4d3ea11da48727ab8774b56372d1d0c7464a9eb0e969a13

data/.gitignore

@@ -0,0 +1,58 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*
+/lib/*.bundle
+/lib/*.so

data/.travis.yml

@@ -0,0 +1,25 @@
+---
+language: ruby
+cache: bundler
+rvm: 2.7.1
+matrix:
+  include:
+    - rvm: 2.7.1
+      os: linux
+    - rvm: 2.7.1
+      os: osx
+    - rvm: ruby-head
+  allow_failures:
+    - rvm: ruby-head
+  fast_finish: true
+
+before_install: gem install bundler
+script:
+  - gem list -l
+  - bundle exec rake compile
+  - bundle exec rake
+
+bundler_args: --jobs 1 --retry 3
+
+notifications:
+  email: false

data/.vscode/c_cpp_properties.json

@@ -0,0 +1,20 @@
+{
+    "configurations": [
+        {
+            "name": "Mac",
+            "includePath": [
+                "${workspaceFolder}/**",
+                "/Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/Ruby.framework/Versions/2.6/Headers"
+            ],
+            "defines": [],
+            "macFrameworkPath": [
+                "/Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks"
+            ],
+            "compilerPath": "/usr/bin/clang",
+            "cStandard": "c11",
+            "cppStandard": "c++17",
+            "intelliSenseMode": "clang-x64"
+        }
+    ],
+    "version": 4
+}

data/.vscode/settings.json

@@ -0,0 +1,28 @@
+{
+    "files.associations": {
+        "__functional_03": "cpp",
+        "functional": "cpp",
+        "__hash_table": "cpp",
+        "__split_buffer": "cpp",
+        "array": "cpp",
+        "bitset": "cpp",
+        "initializer_list": "cpp",
+        "iterator": "cpp",
+        "string": "cpp",
+        "string_view": "cpp",
+        "unordered_map": "cpp",
+        "utility": "cpp",
+        "vector": "cpp",
+        "sstream": "cpp",
+        "__functional_base": "cpp",
+        "__functional_base_03": "cpp",
+        "__tuple": "cpp",
+        "algorithm": "cpp",
+        "chrono": "cpp",
+        "type_traits": "cpp",
+        "limits": "cpp",
+        "memory": "cpp",
+        "ratio": "cpp",
+        "tuple": "cpp"
+    }
+}

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in evt.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "minitest", "~> 5.0"

data/Gemfile.lock

@@ -0,0 +1,24 @@
+PATH
+  remote: .
+  specs:
+    data-buffer (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.14.2)
+    rake (12.3.3)
+    rake-compiler (1.1.1)
+      rake
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  data-buffer!
+  minitest (~> 5.0)
+  rake (~> 12.0)
+  rake-compiler (~> 1.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2020, Delton Ding
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. 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.
+
+3. Neither the name of the copyright holder 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 HOLDER 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.

data/README.md

@@ -0,0 +1,34 @@
+# buffer
+The gem to operate low level I/O data buffer
+
+[![Build Status](https://travis-ci.org/dsh0416/buffer.svg?branch=master)](https://travis-ci.org/dsh0416/buffer)
+
+## Example
+
+```
+gem install 'data-buffer'
+```
+
+```ruby
+require 'buffer'
+
+buf = Buffer.new(1024) # Create char* buffer with size of 1024
+buf.clear # memset 0 to buffer size
+buf.size # return buffer size
+buf.to_s # convert to string. WARNING: make sure the string has NUL terminator
+buf.bytes # convert to char byte array
+
+buf.resize(2048) # realloc the buffer to 2048
+
+buf = Buffer.from('Hello World') # Create char* from existing string
+buf = Buffer.from([1, 2, 3, 244]) # Create char* from existing char array
+
+buf.data # Get raw data struct
+
+# struct buffer_data {
+#   size_t buffer_size;
+#   char* buffer;
+# };
+#
+# buffer_data* data = (buffer_data*) ((struct RData *)obj)->data;
+```

data/Rakefile

@@ -0,0 +1,17 @@
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+require 'rake/extensiontask'
+
+spec = Gem::Specification.load('buffer.gemspec')
+Rake::ExtensionTask.new('buffer_ext', spec) do |ext|
+  ext.ext_dir = "ext/buffer"
+end
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/buffer.gemspec

@@ -0,0 +1,28 @@
+
+require_relative 'lib/buffer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "data-buffer"
+  spec.version       = Buffer::VERSION
+  spec.authors       = ["Delton Ding"]
+  spec.email         = ["dsh0416@gmail.com"]
+
+  spec.summary       = "The gem to operate low level I/O data buffer."
+  spec.description   = "The gem to operate low level I/O data buffer."
+  spec.homepage      = "https://github.com/dsh0416/buffer"
+  spec.license       = 'BSD-3-Clause'
+  spec.required_ruby_version = '>= 2.7.1'
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/dsh0416/buffer"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.require_paths = ["lib"]
+  spec.extensions = ['ext/buffer/extconf.rb']
+
+  spec.add_development_dependency 'rake-compiler', '~> 1.0'
+end

data/ext/buffer/buffer.c

@@ -0,0 +1,113 @@
+#include "buffer.h"
+
+void Init_buffer_ext() {
+  kBuffer = rb_define_class("Buffer", rb_cObject);
+  kBufferPayload = rb_define_class_under(kBuffer, "BufferPayload", rb_cObject);
+  rb_define_singleton_method(kBuffer, "from", method_buffer_from, 1);
+  rb_define_method(kBuffer, "initialize", method_buffer_init, 1);
+  rb_define_method(kBuffer, "clear", method_buffer_clear, 0);
+  rb_define_method(kBuffer, "resize", method_buffer_resize, 1);
+  rb_define_method(kBuffer, "to_s", method_buffer_to_s, 0);
+  rb_define_method(kBuffer, "bytes", method_buffer_bytes, 0);
+  rb_define_method(kBuffer, "size", method_buffer_buffer_size, 0);
+}
+
+VALUE method_buffer_from(VALUE klass, VALUE val) {
+  if (TYPE(val) == T_STRING) {
+    char* ptr = StringValueCStr(val);
+    VALUE obj = rb_funcall(kBuffer, rb_intern("new"), 1, SIZET2NUM(strlen(ptr) + 1));
+    VALUE data = rb_iv_get(obj, "@data");
+    char* buf_ptr = internal_buffer_data_get(data)->buffer;
+    memcpy(buf_ptr, ptr, strlen(ptr) + 1);
+    return obj;
+  }
+
+  if (TYPE(val) == T_ARRAY) {
+    long len = RARRAY_LEN(val);
+    VALUE obj = rb_funcall(kBuffer, rb_intern("new"), 1, LONG2NUM(len));
+    VALUE data = rb_iv_get(obj, "@data");
+    char* buf_ptr = internal_buffer_data_get(data)->buffer;
+    for (long i = 0; i < len; i++) {
+      VALUE num = rb_ary_entry(val, i);
+      buf_ptr[i] = NUM2CHR(num);
+    }
+    return obj;
+  }
+
+  return Qnil;
+}
+
+VALUE method_buffer_init(VALUE self, VALUE size) {
+  VALUE data = internal_buffer_data_malloc(NUM2SIZET(size));
+  rb_iv_set(self, "@data", data);
+  return self;
+}
+
+VALUE method_buffer_clear(VALUE self) {
+  VALUE payload = rb_iv_get(self, "@data");
+  struct buffer_data* data = internal_buffer_data_get(payload);
+  memset(data->buffer, 0, data->buffer_size);
+  return self;
+}
+
+VALUE method_buffer_resize(VALUE self, VALUE size) {
+  VALUE data = rb_iv_get(self, "@data");
+  internal_buffer_data_realloc(data, NUM2SIZET(size));
+  return self;
+}
+
+VALUE method_buffer_to_s(VALUE self) {
+  // FIXME: What if a buffer doesn't have a NUL terminator?
+  VALUE data = rb_iv_get(self, "@data");
+
+  return rb_str_buf_new2(internal_buffer_data_get(data)->buffer);
+}
+
+VALUE method_buffer_bytes(VALUE self) {
+  VALUE data = rb_iv_get(self, "@data");
+  struct buffer_data* buffer = internal_buffer_data_get(data);
+  VALUE result = rb_ary_new2(buffer->buffer_size);
+  for (size_t i = 0; i < buffer->buffer_size; i++) {
+    rb_ary_store(result, i, CHR2FIX(buffer->buffer[i])); // # TODO: Why there is no CHR2NUM?
+  }
+  return result;
+}
+
+VALUE method_buffer_buffer_size(VALUE self) {
+  VALUE data = rb_iv_get(self, "@data");
+
+  return SIZET2NUM(internal_buffer_data_get(data)->buffer_size);
+}
+
+// internal methods
+VALUE internal_buffer_data_malloc(size_t size) {
+  struct buffer_data* data = xmalloc(sizeof(struct buffer_data));
+  data->buffer_size = size;
+  data->buffer = xmalloc(sizeof(char) * size);
+  return TypedData_Wrap_Struct(kBufferPayload, &type_buffer_data, data);
+}
+
+VALUE internal_buffer_data_realloc(VALUE wrapped, size_t size) {
+  struct buffer_data* ptr;
+  TypedData_Get_Struct(wrapped, struct buffer_data, &type_buffer_data, ptr);
+  ptr->buffer_size = size;
+  ptr->buffer = xrealloc(ptr->buffer, sizeof(char) * size);
+  return wrapped;
+}
+
+struct buffer_data* internal_buffer_data_get(VALUE wrapped) {
+  struct buffer_data* ptr;
+  TypedData_Get_Struct(wrapped, struct buffer_data, &type_buffer_data, ptr);
+  return ptr;
+}
+
+void internal_buffer_data_free(void* ptr) {
+  struct buffer_data* t = (struct buffer_data*) ptr;
+  xfree(t->buffer);
+  xfree(t);
+}
+
+size_t internal_buffer_data_size(const void* ptr) {
+  struct buffer_data* t = (struct buffer_data*) ptr;
+  return sizeof(struct buffer_data) + t->buffer_size;
+}

data/ext/buffer/buffer.h

@@ -0,0 +1,36 @@
+#include <ruby.h>
+
+VALUE kBuffer = Qnil;
+VALUE kBufferPayload = Qnil;
+
+void Init_buffer_ext();
+VALUE method_buffer_from(VALUE klass, VALUE val);
+VALUE method_buffer_init(VALUE self, VALUE size);
+VALUE method_buffer_clear(VALUE self);
+VALUE method_buffer_resize(VALUE self, VALUE size);
+VALUE method_buffer_to_s(VALUE self);
+VALUE method_buffer_bytes(VALUE self);
+VALUE method_buffer_buffer_size(VALUE self);
+
+// internal methods
+VALUE internal_buffer_data_malloc(size_t size);
+VALUE internal_buffer_data_realloc(VALUE wrapped, size_t size);
+struct buffer_data* internal_buffer_data_get(VALUE wrapped);
+void internal_buffer_data_free(void* ptr);
+size_t internal_buffer_data_size(const void* ptr);
+
+struct buffer_data {
+  size_t buffer_size;
+  char* buffer;
+};
+
+static const rb_data_type_t type_buffer_data = {
+  .wrap_struct_name = "buffer_data",
+  .function = {
+    .dmark = NULL,
+    .dfree = internal_buffer_data_free,
+    .dsize = internal_buffer_data_size,
+  },
+  .data = NULL,
+  .flags = RUBY_TYPED_FREE_IMMEDIATELY,
+};

data/ext/buffer/extconf.rb

@@ -0,0 +1,6 @@
+require 'mkmf'
+extension_name = 'buffer_ext'
+dir_config(extension_name)
+
+create_header
+create_makefile(extension_name)

data/lib/buffer.rb

@@ -0,0 +1,5 @@
+require 'buffer_ext'
+
+class Buffer
+  attr_reader :data
+end

data/lib/buffer/version.rb

@@ -0,0 +1,3 @@
+class Buffer
+  VERSION = '0.0.1'
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: data-buffer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Delton Ding
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-09-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: The gem to operate low level I/O data buffer.
+email:
+- dsh0416@gmail.com
+executables: []
+extensions:
+- ext/buffer/extconf.rb
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- ".vscode/c_cpp_properties.json"
+- ".vscode/settings.json"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- buffer.gemspec
+- ext/buffer/buffer.c
+- ext/buffer/buffer.h
+- ext/buffer/extconf.rb
+- lib/buffer.rb
+- lib/buffer/version.rb
+homepage: https://github.com/dsh0416/buffer
+licenses:
+- BSD-3-Clause
+metadata:
+  homepage_uri: https://github.com/dsh0416/buffer
+  source_code_uri: https://github.com/dsh0416/buffer
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: The gem to operate low level I/O data buffer.
+test_files: []