filedictrb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 74171da9cf75b57d441faad6754c05e718a170fdada7618cd593ddcc8f8b982a
+  data.tar.gz: 6a88336c3e3cb8e1a18d50bc14bd49794f0ba10e614667c0a086dfb9cd35d11c
+SHA512:
+  metadata.gz: 9dde01e9a2f1af933ec22e7648797fbbd393362bd9abdfc7ff351104aa0184f02222edcc8c59de98770172f4e1e9c7285d61e9d2b89d575a06aebacb080d86d3
+  data.tar.gz: d569f379a3787a42dcd691a28b57e68ba1dd5579c4afb8741aad66d6ff13d58d2dba5e949772684c41cbec4ecccc9b55de9e1b9506353c447a37d7fd04d14e65

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.4
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in filedictrb.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rake-compiler"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.7"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Nigel Baillie
+
+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,51 @@
+# Filedictrb
+
+Ruby wrapper for [filedict](https://github.com/Resonious/filedict).
+
+The idea is the provide an interface that behaves exactly like a `Hash<Set<String>>`, but the data is bound to a file. The file is memory-mapped, and so it is shared across processes, and updates are flushed automatically by the operating system.
+
+As of writing, this gem is still brand new, not production-ready. I'm pretty sure you'll get a segfault if you use non-string keys or values.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'filedictrb'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install filedictrb
+
+## Usage
+
+You can use `Filedict::Hash` almost just like a regular `Hash`.
+
+```ruby
+dict = Filedict::Hash.new('path/to/data/file')
+dict['key'].add 'value'
+
+dict['key'] # should equal Filedict::Set['value']
+
+# if another process comes along and appends 'value 2', then ...
+dict['key'] # should equal Filedict::Set['value', 'value 2']
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/filedictrb.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+require "rake/extensiontask"
+
+task build: :compile
+
+Rake::ExtensionTask.new("filedictrb") do |ext|
+  ext.lib_dir = "lib/filedictrb"
+end
+
+task default: %i[clobber compile spec rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "filedict"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/ext/filedictrb/extconf.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require "mkmf"
+
+create_makefile("filedictrb/filedictrb")

data/ext/filedictrb/filedictrb.c

@@ -0,0 +1,11 @@
+#include "filedictrb.h"
+#include "hash.h"
+
+VALUE mFiledict;
+
+void
+Init_filedictrb(void)
+{
+    mFiledict = rb_define_module("Filedict");
+    fdrb_init_hash();
+}

data/ext/filedictrb/filedictrb.h

@@ -0,0 +1,10 @@
+#ifndef FILEDICTRB_H
+#define FILEDICTRB_H 1
+
+#include "ruby.h"
+
+#define FILEDICT_IMPL 1
+#include "../filedict/filedict.h"
+#undef FILEDICT_IMPL
+
+#endif /* FILEDICTRB_H */

data/ext/filedictrb/hash.c

@@ -0,0 +1,151 @@
+#include "hash.h"
+#include "../filedict/filedict.h"
+
+extern VALUE mFiledict;
+VALUE cHash;
+VALUE mSetExt;
+VALUE cSet;
+
+ID id_add;
+ID id_remove;
+ID id_freeze;
+ID id_fd_hash;
+ID id_fd_key;
+
+/*
+ * ==============================
+ * Custom allocation / GC support
+ * ==============================
+ *
+ * Used as a reference:
+ * https://github.com/ruby-prof/ruby-prof/blob/master/ext/ruby_prof/rp_profile.c
+ *
+ * This stuff is necessary in order for GC to work properly when we hold
+ * references to Ruby objects in C code.
+ */
+
+static void fd_hash_mark(void *data) {
+    /* TODO: do we need to hold ruby objects? */
+    /* fd_hash_t *fd_hash = (fd_hash_t*)data; */
+}
+
+static void fd_hash_free(void *data) {
+    fd_hash_t *fd_hash = (fd_hash_t*)data;
+
+    filedict_deinit(&fd_hash->filedict);
+
+    xfree(fd_hash);
+}
+
+size_t fd_hash_size(const void* _data) {
+    return sizeof(fd_hash_t);
+}
+
+static const rb_data_type_t fd_hash_type =
+{
+    .wrap_struct_name = "Filedict::Hash",
+    .function =
+    {
+        .dmark = fd_hash_mark,
+        .dfree = fd_hash_free,
+        .dsize = fd_hash_size,
+    },
+    .data = NULL,
+    .flags = RUBY_TYPED_FREE_IMMEDIATELY
+};
+
+static VALUE fd_hash_allocate(VALUE klass) {
+    VALUE result;
+    fd_hash_t* fd_hash;
+
+    result = TypedData_Make_Struct(klass, fd_hash_t, &fd_hash_type, fd_hash);
+    filedict_init(&fd_hash->filedict);
+
+    return result;
+}
+
+
+/*
+ * ==============================
+ * Ruby method definitions
+ * ==============================
+ *
+ */
+
+static VALUE fd_hash_initialize(VALUE self, VALUE filename) {
+    fd_hash_t *fd_hash = RTYPEDDATA_DATA(self);
+
+    const char *filename_cstr = StringValuePtr(filename);
+    filedict_open(&fd_hash->filedict, filename_cstr);
+
+    if (fd_hash->filedict.error) {
+        rb_raise(rb_eArgError, "Filedict error: %s", fd_hash->filedict.error);
+    }
+
+    return self;
+}
+
+static VALUE fd_set_add(int argc, VALUE *argv, VALUE self) {
+    VALUE fd_hash_ruby_object = rb_ivar_get(self, id_fd_hash);
+
+    if (fd_hash_ruby_object == Qnil) {
+        return self;
+    }
+
+    fd_hash_t *fd_hash = RTYPEDDATA_DATA(fd_hash_ruby_object);
+    int i;
+
+    VALUE key = rb_ivar_get(self, id_fd_key);
+    const char *key_cstr = StringValuePtr(key);
+    const char *value_cstr;
+
+    for (i = 0; i < argc; ++i) {
+        value_cstr = StringValuePtr(argv[i]);
+        filedict_insert_unique(&fd_hash->filedict, key_cstr, value_cstr);
+    }
+
+    return rb_call_super(argc, argv);
+}
+
+static VALUE fd_hash_access(VALUE self, VALUE key) {
+    fd_hash_t *fd_hash = RTYPEDDATA_DATA(self);
+
+    VALUE result = rb_class_new_instance(0, NULL, cSet);
+    const char *key_cstr = StringValuePtr(key);
+
+    filedict_read_t read = filedict_get(&fd_hash->filedict, key_cstr);
+
+    int success = 1;
+    while (success && read.value) {
+        rb_funcall(result, id_add, 1, rb_str_new_cstr(read.value));
+        success = filedict_get_next(&read);
+    }
+
+    rb_ivar_set(result, id_fd_hash, self);
+    rb_ivar_set(result, id_fd_key, key);
+
+    rb_extend_object(result, mSetExt);
+
+    return result;
+}
+
+void fdrb_init_hash() {
+    cHash = rb_define_class_under(mFiledict, "Hash", rb_cObject);
+    rb_define_alloc_func(cHash, fd_hash_allocate);
+
+    rb_define_method(cHash, "initialize", fd_hash_initialize, 1);
+    rb_define_method(cHash, "at", fd_hash_access, 1);
+    rb_define_method(cHash, "[]", fd_hash_access, 1);
+
+    VALUE rb_cSet = rb_define_class("Set", rb_cObject);
+    cSet = rb_define_class_under(mFiledict, "Set", rb_cSet);
+    mSetExt = rb_define_module_under(mFiledict, "SetExt");
+
+    rb_define_method(mSetExt, "add", fd_set_add, -1);
+
+    id_add = rb_intern("add");
+    id_remove = rb_intern("remove");
+    id_freeze = rb_intern("freeze");
+    id_fd_hash = rb_intern_const("__fd_hash__");
+    id_fd_key = rb_intern_const("__fd_hash_key__");
+}

data/ext/filedictrb/hash.h

@@ -0,0 +1,12 @@
+#ifndef HASH_H
+#define HASH_H 1
+
+#include "filedictrb.h"
+
+typedef struct fd_hash_t {
+    filedict_t filedict;
+} fd_hash_t;
+
+void fdrb_init_hash(void);
+
+#endif /* HASH_H */

data/filedictrb.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative "lib/filedict/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "filedictrb"
+  spec.version       = Filedict::VERSION
+  spec.authors       = ["Nigel Baillie"]
+  spec.email         = ["metreckk@gmail.com"]
+
+  spec.summary       = "Uses filedict to emulate a file-backed Hash<Set<String>>"
+  spec.homepage      = "https://github.com/Resonious/filedictrb"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 2.4.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+
+  # 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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.extensions    = ["ext/filedictrb/extconf.rb"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/filedict/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Filedict
+  VERSION = "0.1.0"
+end

data/lib/filedict.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'set'
+require_relative 'filedict/version'
+require_relative 'filedictrb/filedictrb'
+
+module Filedict
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/lib/filedictrb.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative 'filedict'

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: filedictrb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nigel Baillie
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-03-30 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- metreckk@gmail.com
+executables: []
+extensions:
+- ext/filedictrb/extconf.rb
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ext/filedictrb/extconf.rb
+- ext/filedictrb/filedictrb.c
+- ext/filedictrb/filedictrb.h
+- ext/filedictrb/hash.c
+- ext/filedictrb/hash.h
+- filedictrb.gemspec
+- lib/filedict.rb
+- lib/filedict/version.rb
+- lib/filedictrb.rb
+homepage: https://github.com/Resonious/filedictrb
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/Resonious/filedictrb
+  source_code_uri: https://github.com/Resonious/filedictrb
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.3
+signing_key:
+specification_version: 4
+summary: Uses filedict to emulate a file-backed Hash<Set<String>>
+test_files: []