ruar 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2ad6f68a61d0accd3eb5e970934fcbbf30e299c3caafb1ec69ebfc9f9a3b76bf
+  data.tar.gz: 9a9f620ce167c3c5b0f1ab163b0d40f4261652005b83f8f2757098b600ee5b6a
+SHA512:
+  metadata.gz: d5508e42916f61c9aeb2c47d90a956401139baac154d7a6776b600434da114aecdf156b860621c4117755a8dbf1f6ad45ee2cff5a601254b278b7d9804fe0065
+  data.tar.gz: 790039c7c05c5da8c09a22bc349926c3c10476e7b37090ac2e2c213cd91bbd512aae7c596900ab89e1afcfad98d06cfe89671d0ebf39fe534d9444221f6f9cd0

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,101 @@
+# ruar
+
+Tar-like Archive for RIEN
+
+[![CI Tests](https://github.com/DarkKowalski/ruar/workflows/CI%20Tests/badge.svg)](https://github.com/DarkKowalski/ruar/actions?query=workflow%3A%22CI+Tests%22)
+[![Build](https://github.com/DarkKowalski/ruar/workflows/Build/badge.svg)](https://github.com/DarkKowalski/ruar/actions?query=workflow%3ABuild)
+
+## Usage
+
+```ruby
+require 'ruar'
+require 'tmpdir'
+
+# Serialize it
+# file /tmp/plain.ruar => data
+archive = File.join(Dir.tmpdir, 'plain.ruar')
+Ruar::Serialize.plain('./test/sample', archive)
+
+# Setup
+Ruar.setup(
+  archive: archive
+).activate
+
+# Require from /tmp/plain.ruar
+require 'dir/file'
+
+# require 'your_file', from: [:both, :ruar, :local]
+# require_relative 'your_file', from: [:both, :ruar, :local]
+# load 'your_file', from: [:both, :ruar, :local]
+#
+# Notice: Currently we don't support autoload from ruar
+
+# Here you go
+```
+
+## Format
+
+```
++--------+-------+--------+-----+--------+
+| Header | Index | File 0 | ... | File x |
++--------+-------+--------+-----+--------+
+```
+
+### Header
+
+```
++-------------------------------------------------------------+
+|                            Header                           |
++-------------------------------+-----------------------------+
+| major_version:      uint32_t  | minor_version:     uint32_t |
++-------------------------------+-----------------------------+
+| patch_version:      uint32_t  | platform:          uint32_t |
++-------------------------------+-----------------------------+
+| encryption_flags:   uint32_t  | compression_flags: uint32_t |
++-------------------------------+-----------------------------+
+| index_start(octet): uint32_t  | index_size(octet): unit32_t |
++-------------------------------+-----------------------------+
+| index_checksum:     uint32_t  | header_checksum:   uint32_t |
++-------------------------------+-----------------------------+
+|                            padding:                         |
+|                           24 octets                         |
++-------------------------------+-----------------------------+
+```
+
+### Index
+
+```json
+{
+   "files": {
+      "tmp": {
+         "files": {}
+      },
+      "usr" : {
+         "files": {
+           "bin": {
+             "files": {
+               "ls": {
+                 "offset": "0",
+                 "size": 100,
+                 "executable": true
+               },
+               "cd": {
+                 "offset": "100",
+                 "size": 100,
+                 "executable": true
+               }
+             }
+           }
+         }
+      },
+      "etc": {
+         "files": {
+           "hosts": {
+             "offset": "200",
+             "size": 32
+           }
+         }
+      }
+   }
+}
+```

data/ext/ruar/extconf.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'mkmf'
+$CFLAGS << ' -O3 '
+$CFLAGS << ' -std=c99'
+
+return unless have_library('z') && have_header('zlib.h') && have_func('crc32', 'zlib.h')
+
+create_makefile('ruar/ruar')

data/ext/ruar/ruar.c

@@ -0,0 +1,337 @@
+#include "ruar.h"
+
+#include <ctype.h>
+#include <ruby.h>
+#include <stdint.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <zlib.h>
+
+#define HEADER_SIZE 64 /* Bytes */
+
+/* Notice: O(n) */
+#define INDEX_SIZE(i) ((uint32_t)(strlen((i)) + 1)) /* Bytes */
+
+#define READ_SRC_BUFFER_SIZE 0x8000 /* Bytes */
+
+struct ruar_header
+{
+    uint32_t major_version;
+    uint32_t minor_version;
+    uint32_t patch_version;
+    uint32_t platform;
+    uint32_t encryption_flags;
+    uint32_t compression_flags;
+    uint32_t index_start;
+    uint32_t index_size;
+    uint32_t index_checksum;
+    uint32_t header_checksum;
+    uint8_t pad[24];
+} __attribute__((packed));
+
+/*
+ * If the struct padding isn't correct to pad the key to 64 bytes, 
+ * refuse to compile.
+ */
+#define STATIC_ASSERT(X) STATIC_ASSERT2(X, __LINE__)
+#define STATIC_ASSERT2(X, L) STATIC_ASSERT3(X, L)
+#define STATIC_ASSERT3(X, L) STATIC_ASSERT_MSG(X, at_line_##L)
+#define STATIC_ASSERT_MSG(COND, MSG) typedef char static_assertion_##MSG[(!!(COND)) * 2 - 1]
+STATIC_ASSERT(sizeof(struct ruar_header) == HEADER_SIZE);
+
+/* Constants */
+static const uint32_t current_major_version = 0;
+static const uint32_t current_minor_version = 0;
+static const uint32_t current_patch_version = 1;
+
+/* System info */
+#ifdef __linux__
+static uint32_t current_platform = 1;
+#elif __APPLE__
+static uint32_t current_platform = 2;
+#elif BSD
+static uint32_t current_platform = 3;
+#elif __CYGWIN__
+static uint32_t current_platform = 4;
+#elif __WIN32
+static uint32_t current_platform = 5;
+#else
+static uint32_t current_platform = 0;
+#endif
+
+/* Ruar::Serialize::Native */
+static VALUE rb_mRuar;
+static VALUE rb_mRuar_Serialize;
+static VALUE rb_mRuar_Serialize_Native;
+
+/* Functions exposed as module functions on Ruar::Serialize::Native */
+static VALUE ruar_serialize_rb_plain_header(VALUE self, VALUE dstfile, VALUE index);
+static VALUE ruar_serialize_rb_append_file(VALUE self, VALUE dstfile, VALUE srcfile);
+
+/* Ruar::Access::Native */
+static VALUE rb_kRuar_Access;
+static VALUE rb_mRuar_Access_Native;
+
+/* Functions exposed as instance method on Ruar::Access::Native */
+static VALUE ruar_access_rb_header(VALUE self, VALUE archive);
+static VALUE ruar_access_rb_index(VALUE self, VALUE archive);
+static VALUE ruar_access_rb_file(VALUE self, VALUE archive, VALUE offset, VALUE size);
+
+/* Ruar::Const::Native */
+static VALUE rb_mRuar_Const;
+static VALUE rb_mRuar_Const_Native;
+
+/* Functions exposed as module functions on Ruar::Const::Native */
+static VALUE ruar_const_rb_header_size(VALUE self);
+
+/* Helpers*/
+static uint32_t ruar_crc32_generate(const unsigned char *bytes, const int len);
+static VALUE ruar_rb_header_hash(const struct ruar_header *header);
+
+void Init_ruar(void)
+{
+    rb_mRuar = rb_define_module("Ruar");
+
+    rb_mRuar_Serialize = rb_define_module_under(rb_mRuar, "Serialize");
+    rb_mRuar_Serialize_Native = rb_define_module_under(rb_mRuar_Serialize, "Native");
+    rb_define_module_function(rb_mRuar_Serialize_Native, "plain_header", ruar_serialize_rb_plain_header, 2);
+    rb_define_module_function(rb_mRuar_Serialize_Native, "append_file", ruar_serialize_rb_append_file, 2);
+
+    rb_kRuar_Access = rb_define_class_under(rb_mRuar, "Access", rb_cObject);
+    rb_mRuar_Access_Native = rb_define_module_under(rb_kRuar_Access, "Native");
+    rb_define_module_function(rb_mRuar_Access_Native, "header", ruar_access_rb_header, 1);
+    rb_define_module_function(rb_mRuar_Access_Native, "index", ruar_access_rb_index, 1);
+    rb_define_module_function(rb_mRuar_Access_Native, "file", ruar_access_rb_file, 3);
+
+    rb_mRuar_Const = rb_define_module_under(rb_mRuar, "Const");
+    rb_mRuar_Const_Native = rb_define_module_under(rb_mRuar_Const, "Native");
+    rb_define_module_function(rb_mRuar_Const_Native, "header_size", ruar_const_rb_header_size, 0);
+}
+
+static VALUE ruar_const_rb_header_size(VALUE self)
+{
+    return INT2NUM(HEADER_SIZE);
+}
+
+static uint32_t ruar_crc32_generate(const unsigned char *bytes, const int len)
+{
+    return crc32(0, bytes, len) & 0xffffffff;
+}
+
+static VALUE ruar_rb_header_hash(const struct ruar_header *header)
+{
+    VALUE rb_header = rb_hash_new();
+
+    rb_hash_aset(rb_header, rb_utf8_str_new_cstr("major_version"), INT2NUM(header->major_version));
+    rb_hash_aset(rb_header, rb_utf8_str_new_cstr("minor_version"), INT2NUM(header->minor_version));
+    rb_hash_aset(rb_header, rb_utf8_str_new_cstr("patch_version"), INT2NUM(header->patch_version));
+    rb_hash_aset(rb_header, rb_utf8_str_new_cstr("platform"), INT2NUM(header->platform));
+    rb_hash_aset(rb_header, rb_utf8_str_new_cstr("compression_flags"), INT2NUM(header->compression_flags));
+    rb_hash_aset(rb_header, rb_utf8_str_new_cstr("encrypthon_flags"), INT2NUM(header->encryption_flags));
+    rb_hash_aset(rb_header, rb_utf8_str_new_cstr("index_start"), INT2NUM(header->index_start));
+    rb_hash_aset(rb_header, rb_utf8_str_new_cstr("index_size"), INT2NUM(header->index_size));
+    rb_hash_aset(rb_header, rb_utf8_str_new_cstr("index_checksum"), INT2NUM(header->index_checksum));
+    rb_hash_aset(rb_header, rb_utf8_str_new_cstr("header_checksum"), INT2NUM(header->header_checksum));
+
+    return rb_header;
+}
+
+static VALUE ruar_serialize_rb_plain_header(VALUE self, VALUE dstfile, VALUE index)
+{
+    /* Call into ruby to generate the index */
+    char *index_cstring = rb_string_value_cstr(&index);
+    uint32_t index_size = INDEX_SIZE(index_cstring);
+
+    /* Fill out a header */
+    struct ruar_header header = {
+        .major_version = current_major_version,
+        .minor_version = current_minor_version,
+        .patch_version = current_patch_version,
+        .platform = current_platform,
+        .encryption_flags = 0,
+        .compression_flags = 0,
+        .index_start = HEADER_SIZE,
+        .index_size = index_size,
+        .index_checksum = ruar_crc32_generate((unsigned char *)index_cstring, index_size),
+        .header_checksum = 0};
+    header.header_checksum = ruar_crc32_generate((unsigned char *)&header, HEADER_SIZE);
+
+    /* Write header */
+    char *dstfile_cstring = rb_string_value_cstr(&dstfile);
+    FILE *outfile = fopen(dstfile_cstring, "wb");
+    if (outfile == NULL)
+    {
+        fprintf(stderr, "\nFailed to open file! %s\n", dstfile_cstring);
+        return Qnil;
+    }
+
+    fwrite(&header, HEADER_SIZE, 1, outfile);
+    fwrite(index_cstring, index_size, 1, outfile);
+    fclose(outfile);
+
+    /* Get Ruby Hash */
+    return ruar_rb_header_hash(&header);
+}
+
+/* FIXME: maybe we need an atomic way to do this */
+static VALUE ruar_serialize_rb_append_file(VALUE self, VALUE dstfile, VALUE srcfile)
+{
+    /* Open archive file to write */
+    char *dstfile_cstring = rb_string_value_cstr(&dstfile);
+    FILE *outfile = fopen(dstfile_cstring, "ab");
+    if (outfile == NULL)
+    {
+        fprintf(stderr, "\nFailed to open file! %s\n", dstfile_cstring);
+        return Qnil;
+    }
+
+    /* Open source file to read */
+    char *srcfile_cstring = rb_string_value_cstr(&srcfile);
+    FILE *sourcefile = fopen(srcfile_cstring, "rb");
+    if (sourcefile == NULL)
+    {
+        fprintf(stderr, "\nFailed to open file! %s\n", dstfile_cstring);
+        fclose(outfile);
+        return Qnil;
+    }
+
+    /* Append source to archive */
+    uint8_t buf[READ_SRC_BUFFER_SIZE];
+    size_t size = 0;
+    while ((size = fread(buf, 1, READ_SRC_BUFFER_SIZE, sourcefile)))
+    {
+        // fprintf(stdout, "Write %d bytes, from %s to %s\n", size, srcfile_cstring, dstfile_cstring);
+        fwrite(buf, 1, size, outfile);
+    }
+
+    /* Clean up */
+    fclose(sourcefile);
+    fclose(outfile);
+
+    /* Ruby Hash */
+    return srcfile;
+}
+
+static VALUE ruar_access_rb_header(VALUE self, VALUE archive)
+{
+    char *archive_cstring = rb_string_value_cstr(&archive);
+    FILE *fp = fopen(archive_cstring, "rb");
+    if (fp == NULL)
+    {
+        fprintf(stderr, "\nFailed to open file! %s\n", archive_cstring);
+        return Qnil;
+    }
+    uint8_t buf[HEADER_SIZE];
+    fread(buf, HEADER_SIZE, 1, fp);
+    fclose(fp);
+
+    struct ruar_header *header = (struct ruar_header *)buf;
+
+    /* Validate */
+    uint32_t header_checksum = header->header_checksum;           /* Extract first*/
+    header->header_checksum = 0;                                  /* Clear these bits */
+    uint32_t re_checksum = ruar_crc32_generate(buf, HEADER_SIZE); /* Re-compute it */
+    header->header_checksum = header_checksum;                    /* Put it back */
+    if (re_checksum != header_checksum)
+    {
+        fprintf(stderr, "\nUnmatched checksum, provided: %x, expected: %x \n", re_checksum, header_checksum);
+        return Qnil;
+    }
+
+    /* Ruby Hash */
+    return ruar_rb_header_hash(header);
+}
+
+static VALUE ruar_access_rb_index(VALUE self, VALUE archive)
+{
+    /* Read the header first */
+    char *archive_cstring = rb_string_value_cstr(&archive);
+    FILE *fp = fopen(archive_cstring, "rb");
+    if (fp == NULL)
+    {
+        fprintf(stderr, "\nFailed to open file! %s\n", archive_cstring);
+        return Qnil;
+    }
+
+    uint8_t header_buf[HEADER_SIZE];
+    fread(header_buf, HEADER_SIZE, 1, fp);
+
+    /* Extract index info from the header */
+    struct ruar_header *header = (struct ruar_header *)header_buf;
+    uint32_t index_start = header->index_start;
+    uint32_t index_size = header->index_size;
+    uint32_t index_checksum = header->index_checksum;
+
+    /* Prepare buffer and load the index into memory 
+     * When we serialized the index into archive, the trailing '\0'
+     * has already been added and counted in index_size
+     */
+    uint8_t *index_buf = (uint8_t *)malloc(sizeof(uint8_t) * index_size);
+    if (index_buf == NULL)
+    {
+        fprintf(stderr, "\nFailed to allocate memory for index buffer!\n");
+        fclose(fp);
+        return Qnil;
+    }
+    fseek(fp, index_start, SEEK_SET);
+    fread(index_buf, index_size, 1, fp);
+    fclose(fp);
+
+    /* Validate */
+    uint32_t re_checksum = ruar_crc32_generate(index_buf, index_size);
+    if (re_checksum != index_checksum)
+    {
+        free(index_buf);
+        fprintf(stderr, "\nUnmatched checksum, provided: %x, expected: %x \n", re_checksum, index_checksum);
+        return Qnil;
+    }
+
+    /* Get Ruby String */
+    VALUE index = rb_utf8_str_new_cstr((char *)index_buf);
+    free(index_buf);
+
+    /* Ruby String */
+    return index;
+}
+
+/* Offset here is absolute offset from the beginning of the archive,
+ * and it's calculated in Ruby code
+ */
+static VALUE ruar_access_rb_file(VALUE self, VALUE archive, VALUE offset, VALUE size)
+{
+    char *archive_cstring = rb_string_value_cstr(&archive);
+    FILE *fp = fopen(archive_cstring, "rb");
+    if (fp == NULL)
+    {
+        fprintf(stderr, "\nFailed to open file! %s\n", archive_cstring);
+        return Qnil;
+    }
+
+    size_t size_cint = NUM2SIZET(size);
+
+    
+    /* Ruby C API will convert this C-style String to a Ruby String Object
+     * Thus one extra byte for the trialing '\0' 
+     */
+    uint8_t *file_buf = (uint8_t *)malloc(sizeof(uint8_t) * size_cint + 1);
+    if (file_buf == NULL)
+    {
+        fprintf(stderr, "\nFailed to allocate memory for file buffer!\n");
+        fclose(fp);
+        return Qnil;
+    }
+
+    size_t offset_cint = NUM2SIZET(offset);
+    fseek(fp, offset_cint, SEEK_SET);
+    fread(file_buf, 1, size_cint, fp);
+    fclose(fp);
+
+    /* Trailing '\0' for the C-style string */
+    file_buf[size_cint] = '\0';
+    VALUE file = rb_utf8_str_new_cstr((char *)file_buf);
+    free(file_buf);
+
+    /* Ruby String */
+    return file;
+}

data/ext/ruar/ruar.h

@@ -0,0 +1,4 @@
+#ifndef RUAR_H
+#define RUAR_H
+/* Doesn't expose anything */
+#endif /* RUAR_H */

data/lib/ruar.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'tmpdir'
+require 'pathname'
+require 'binding_of_caller'
+
+require_relative 'ruar/version'
+require_relative 'ruar/ruar'
+require_relative 'ruar/error'
+
+require_relative 'ruar/index'
+require_relative 'ruar/serialize'
+require_relative 'ruar/access'
+require_relative 'ruar/entrypoint'
+
+require_relative 'ruar/setup'
+
+require_relative 'ruar/core_ext/string_colorize'

data/lib/ruar/access.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module Ruar
+  class Access
+    attr_reader :archive, :header, :index
+
+    def self.make_not_exist_error(path)
+      Ruar::Error::FileNotFound.new(path)
+    end
+
+    def self.make_failed_to_eval_error(path)
+      Ruar::Error::FailedToEval.new(path)
+    end
+
+    def self.warn_autoload(name_error)
+      location = name_error.backtrace_locations.first
+      message = <<~MSG
+        #{location}
+        Kernel.autoload and Module.autoload are not supported by ruar,
+        if you are using them, try `require` instead
+      MSG
+      warn message.yellow
+    end
+
+    def initialize(archive)
+      @archive = archive
+      rebuild
+    end
+
+    def lookup(path)
+      paths = Ruar::Access.clean_path(path)
+      filename = paths.pop
+
+      pwd = @index['files']
+
+      begin
+        paths.each { |dir| pwd = pwd[dir]['files'] }
+      rescue StandardError
+        raise Ruar::Access.make_not_exist_error(path)
+      end
+
+      raise Ruar::Access.make_not_exist_error(path) if pwd[filename].nil?
+
+      offset = pwd[filename]['offset'] + @file_start
+      size = pwd[filename]['size']
+      executable = pwd[filename]['executable']
+
+      [offset, size, executable]
+    end
+
+    def read(path)
+      offset, size, _executable = lookup(path)
+      Ruar::Access::Native.file(@archive, offset.to_i, size.to_i)
+    end
+
+    def eval(path, eval_bind = TOPLEVEL_BINDING)
+      pseudo_filename = File.join(Ruar.path_prefix.to_s, Ruar::Access.abs_path(path))
+      pseudo_lineno = 1
+      file = read(path)
+      # FIXME: need to test
+      begin
+        Kernel.eval(file, eval_bind, pseudo_filename, pseudo_lineno)
+      rescue NameError => e # FIXME: to warn autoload pitfall
+        begin
+          Ruar::Access.warn_autoload(e)
+          raise
+        rescue StandardError
+          raise Ruar::Access.make_failed_to_eval_error(path)
+        end
+      end
+    end
+
+    def self.abs_path(path)
+      Pathname.new(path).cleanpath.to_s
+    end
+
+    # Array
+    def self.clean_path(path)
+      cleaned = Ruar::Access.abs_path(path).split(File::SEPARATOR)
+      cleaned.delete('')
+
+      cleaned
+    end
+
+    private
+
+    def rebuild
+      @header = Ruar::Access::Native.header(@archive)
+      @index = JSON.parse(Ruar::Access::Native.index(@archive))
+      @file_start = @header['index_start'] + @header['index_size']
+    end
+  end
+end

data/lib/ruar/core_ext/kernel_require.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+module Ruar
+  class Access
+    module CoreExt
+      def self.make_load_error(path)
+        err = LoadError.new(+"cannot load such file -- #{path}")
+        err.define_singleton_method(:path) { path }
+        err
+      end
+
+      # Generate pseudo $LOADED_FEATURES entry
+      def self.pseudo_lf_entry(path)
+        prefix = Ruar.path_prefix
+        # TODO: support .so here
+        if File.extname(path) == '.rb'
+          File.join(prefix, path)
+        else
+          File.join(prefix, "#{path}.rb")
+        end
+      end
+    end
+  end
+end
+
+module Kernel
+  module_function
+
+  def ruar_eval_wrap(path, eval_bind = TOPLEVEL_BINDING)
+    Ruar.eval(path, eval_bind)
+    yield
+    true
+  rescue Ruar::Error::FileNotFound
+    # Try again with .rb extension
+    begin
+      # For rubocop:
+      Ruar.eval("#{path}.rb", eval_bind) # Ruar.eval(path.rb, eval_bind)
+      yield
+      true
+    rescue Ruar::Error::BaseError
+      raise Ruar::Access::CoreExt.make_load_error(path)
+    end
+  rescue Ruar::Error::BaseError
+    raise Ruar::Access::CoreExt.make_load_error(path)
+  end
+
+  alias require_without_ruar require
+
+  def require_with_ruar(path, eval_bind = TOPLEVEL_BINDING)
+    # puts "path = #{path}, location = #{eval_bind.source_location}"
+    pseudo_entry = Ruar::Access::CoreExt.pseudo_lf_entry(path)
+    return false if $LOADED_FEATURES.include?(pseudo_entry) # Already been required
+
+    ruar_eval_wrap(path, eval_bind) do
+      $LOADED_FEATURES << pseudo_entry
+    end
+  end
+
+  def require(path, from: :both)
+    case from
+    when :both
+      begin
+        require_with_ruar(path)
+      rescue LoadError
+        require_without_ruar(path)
+      end
+    when :ruar
+      require_with_ruar(path)
+    when :local
+      require_without_ruar(path)
+    else
+      raise Ruar::Access::CoreExt.make_load_error(path)
+    end
+  end
+
+  alias require_relative_without_ruar require_relative
+
+  # TODO: need to test
+  def require_relative(path, from: :both)
+    caller_path = caller_locations.first.path.to_s
+    caller_dir = Pathname.new(caller_path).dirname.to_s
+    prefix = Ruar.path_prefix.to_s
+
+    # Ruar Internal File
+    caller_dir = caller_dir.delete_prefix(prefix).prepend(File::SEPARATOR) if caller_dir.start_with?(prefix)
+
+    resolved_path = File.expand_path(path, caller_dir)
+    require(resolved_path, from: from)
+  end
+
+  alias load_without_ruar load
+
+  def load_with_ruar(path, eval_bind = TOPLEVEL_BINDING)
+    ruar_eval_wrap(path, eval_bind) do
+      # Do nothing, just read and eval
+    end
+  end
+
+  def load(path, from: :both)
+    case from
+    when :both
+      begin
+        load_with_ruar(path)
+      rescue LoadError
+        load_without_ruar(path)
+      end
+    when :ruar
+      load_with_ruar(path)
+    when :local
+      load_without_ruar(path)
+    else
+      raise Ruar::Access::CoreExt.make_load_error(path)
+    end
+  end
+
+  # TODO: deliberately test autoload
+  # FIXME: not support autoload
+end

data/lib/ruar/core_ext/string_colorize.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+class String
+  def colorize(color_code)
+    "\e[#{color_code}m#{self}\e[0m"
+  end
+
+  def red
+    colorize(31)
+  end
+
+  def green
+    colorize(32)
+  end
+
+  def yellow
+    colorize(33)
+  end
+
+  def blue
+    colorize(34)
+  end
+end

data/lib/ruar/entrypoint.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Ruar
+  class EntryPoint
+    def initialize(archive: nil, entry: nil)
+      @archive = archive
+      @entry = entry
+    end
+
+    def activate
+      @access = Ruar::Access.new(@archive)
+      # First eval this file if option[:entry] is set
+      @access.eval(@entry) unless @entry.nil?
+    end
+
+    def eval(path, eval_bind = TOPLEVEL_BINDING)
+      @access.eval(path, eval_bind)
+    end
+  end
+end

data/lib/ruar/error.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Ruar
+  module Error
+    class BaseError < RuntimeError
+    end
+
+    class FileNotFound < BaseError
+      attr_reader :path
+
+      def initialize(path)
+        @path = path
+        super(+"file does not exist in ruar -- #{path}")
+      end
+    end
+
+    class FailedToEval < BaseError
+      attr_reader :path
+
+      def initialize(path)
+        @path = path
+        super(+"ruar failed to eval -- #{path}")
+      end
+    end
+  end
+end

data/lib/ruar/index.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Ruar
+  class Index
+    attr_reader :dir, :index, :source_info
+
+    def initialize(dir = '.')
+      @dir = dir
+      generate(dir)
+    end
+
+    def json_index
+      @index.to_json
+    end
+
+    private
+
+    # Generate json format index
+    def generate(dir)
+      @index, @source_info = scan(dir, 0)
+    end
+
+    # FIXME: don't recurse
+    # TODO: support compression and encryption
+    # Recursively scan the directory
+    def scan(dir, offset)
+      Dir.chdir(dir) do
+        index = { 'files' => {} }
+        source_info = [] # { realpath, size, offset }
+        entities = Dir['**']
+        return [index, source_info, offset] if entities.empty?
+
+        files = entities.select { |f| File.file?(f) }
+        files.each do |f|
+          size = File.size(f)
+
+          index['files'][f] = {
+            'size' => size,
+            'offset' => offset,
+            'executable' => File.executable?(f)
+          }
+
+          source_info.push({
+                             'realpath' => File.realpath(f),
+                             'size' => size,
+                             'offset' => offset
+                           })
+
+          offset += size
+        end
+
+        dirs = entities.select { |d| File.directory?(d) }
+        dirs.each do |d|
+          # Notice: need to accumulate offset here
+          sub_index, sub_source_info, offset = scan(d, offset)
+          index['files'][d] = sub_index
+          source_info.concat(sub_source_info)
+        end
+
+        [index, source_info, offset]
+      end
+    end
+  end
+end

data/lib/ruar/serialize.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Ruar
+  module Serialize
+    def self.plain(srcdir, dstfile)
+      index = Ruar::Index.new(srcdir)
+      Ruar::Serialize::Native.plain_header(dstfile, index.json_index)
+      index.source_info.each do |src|
+        Ruar::Serialize::Native.append_file(dstfile, src['realpath'])
+      end
+    end
+  end
+end

data/lib/ruar/setup.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Ruar
+  module Setup
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def setup(archive: nil, entry: nil)
+        @entrypoint ||= Ruar::EntryPoint.new(archive: archive, entry: entry)
+        @path_prefix ||= Pathname.new('/_from/_ruar/_internal')
+
+        self
+      end
+
+      def path_prefix
+        @path_prefix
+      end
+
+      def activate
+        return if @activated
+
+        @activated = true
+
+        require_relative 'core_ext/kernel_require'
+        @entrypoint.activate
+
+        puts 'Ruar Activated!'.green
+      end
+
+      def eval(path, bind = TOPLEVEL_BINDING)
+        @entrypoint.eval(path, bind)
+      end
+    end
+  end
+end
+
+module Ruar
+  include Ruar::Setup
+end

data/lib/ruar/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Ruar
+  VERSION = '0.0.2'
+end

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: ruar
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Kowalski Dark
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-02-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: binding_of_caller
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.14.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.14.3
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.3
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.3
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.9.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.3
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+description: Pack your Ruby code for distribution
+email:
+- darkkowalski2012@gmail.com
+executables: []
+extensions:
+- ext/ruar/extconf.rb
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- ext/ruar/extconf.rb
+- ext/ruar/ruar.c
+- ext/ruar/ruar.h
+- lib/ruar.rb
+- lib/ruar/access.rb
+- lib/ruar/core_ext/kernel_require.rb
+- lib/ruar/core_ext/string_colorize.rb
+- lib/ruar/entrypoint.rb
+- lib/ruar/error.rb
+- lib/ruar/index.rb
+- lib/ruar/ruar.so
+- lib/ruar/serialize.rb
+- lib/ruar/setup.rb
+- lib/ruar/version.rb
+homepage: https://github.com/darkkowalski/ruar
+licenses:
+- Apache-2.0
+metadata:
+  bug_tracker_uri: https://github.com/darkkowalski/ruar/issues
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key: 
+specification_version: 4
+summary: Tar-like Archive for RIEN
+test_files: []