r4r 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 503aaa9fc4fa100b6bb5e2962146523ebe0141e2
+  data.tar.gz: 5c62f478f3e0b8c8e9974bea14ce0649489298a1
+SHA512:
+  metadata.gz: d3b54ded1917f54d95a5d16519ddf0c60efd41c744dde4587905fe4b3995a5b35ccfdc0b5d5dfedef28532d9b639b42b47bec4aa2e47669169d1fbd43abc9576
+  data.tar.gz: ae5ed5bc6472c53519b1fda0b506476c21e29f8f9b3e8964938d1603a32c191880ccd431fab60568144aaf95693715295f69e9053a72aa1e07c3402838040159

data/.circleci/config.yml

@@ -0,0 +1,110 @@
+version: 2
+
+shared_ghpages: &shared_ghpages
+  working_directory: ~/repo
+  environment:
+    TERM: dump
+
+  steps:
+    - checkout
+    # Download and cache dependencies
+    - restore_cache:
+        keys:
+          - v1-dependencies-{{ .Environment.CIRCLE_STAGE }}-{{ checksum "Gemfile.lock" }}
+          - v1-dependencies-
+
+    - run:
+        name: install dependencies
+        command: |
+          bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+    - save_cache:
+        paths:
+          - ./vendor/bundle
+        key: v1-dependencies-{{ .Environment.CIRCLE_STAGE }}-{{ checksum "Gemfile.lock" }}
+
+    - add-ssh-keys:
+        fingerprints:
+          - "af:38:77:24:f4:c6:33:f2:74:60:e5:cc:76:0e:a7:ad"
+
+    - run:
+        name: publish gh-pages
+        command: |
+          git config --global user.email "ghpages@dmexe.me"
+          git config --global user.name $CIRCLE_USERNAME
+          bin/ghpages
+
+shared_ruby_build: &shared_ruby_build
+  working_directory: ~/repo
+  environment:
+    TERM: dump
+
+  steps:
+    - checkout
+    # Download and cache dependencies
+    - restore_cache:
+        keys:
+          - v1-dependencies-{{ .Environment.CIRCLE_STAGE }}-{{ checksum "Gemfile.lock" }}
+          - v1-dependencies-
+
+    - run:
+        name: install dependencies
+        command: |
+          bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+    - save_cache:
+        paths:
+          - ./vendor/bundle
+        key: v1-dependencies-{{ .Environment.CIRCLE_STAGE }}-{{ checksum "Gemfile.lock" }}
+
+    - run:
+        name: compile
+        command: |
+          bin/rake compile
+
+    - run:
+        name: run tests
+        command: |
+          bin/rake test TESTOPTS="--ci-dir=$CIRCLE_TEST_REPORTS/reports"
+
+    - run:
+        name: run bench
+        command: |
+          bin/rake bench
+
+    - store_test_results:
+        path: /reports
+
+    - store_artifacts:
+        path: /reports
+        destination: test-results
+
+jobs:
+  ruby22:
+    <<: *shared_ruby_build
+    docker:
+      - image: ruby:2.2
+  ruby24:
+    <<: *shared_ruby_build
+    docker:
+      - image: ruby:2.4
+  ghpages:
+    <<: *shared_ghpages
+    docker:
+      - image: ruby:2.4
+
+workflows:
+  version: 2
+  build-test-deploy:
+    jobs:
+      - ruby22
+      - ruby24
+      - ghpages:
+          requires:
+            - ruby22
+            - ruby24
+          filters:
+            branches:
+              only: master
+
+

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.o
+/html/
+/test/reports/
+/docs/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in r4r.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,39 @@
+PATH
+  remote: .
+  specs:
+    r4r (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ansi (1.5.0)
+    builder (3.2.3)
+    minitest (5.10.3)
+    minitest-ci (3.3.0)
+      minitest (>= 5.0.6)
+    minitest-reporters (1.1.19)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    rake (11.3.0)
+    rake-compiler (1.0.4)
+      rake
+    ruby-progressbar (1.9.0)
+    yard (0.9.12)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.15)
+  minitest (~> 5.0)
+  minitest-ci (~> 3.3)
+  minitest-reporters (~> 1.1)
+  r4r!
+  rake (~> 11.0)
+  rake-compiler (~> 1.0)
+  yard (~> 0.9)
+
+BUNDLED WITH
+   1.16.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Dmitry Galinsky
+
+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,15 @@
+# R4r
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'r4r'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install r4r

data/Rakefile

@@ -0,0 +1,38 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+Rake::TestTask.new(:bench) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/benchmark_*.rb"]
+end
+
+task :default => :test
+
+require 'rake/extensiontask'
+spec = Gem::Specification.load('r4r.gemspec')
+
+Dir.glob("ext/r4r/*").each do |dirname|
+  extname = File.basename dirname
+
+  Rake::ExtensionTask.new do |ext|
+    ext.name = extname
+    ext.ext_dir = dirname
+    ext.lib_dir = 'lib/r4r'
+    ext.gem_spec = spec
+  end
+
+end
+
+require 'yard'
+YARD::Rake::YardocTask.new do |t|
+  t.files   = ['lib/**/*.rb', 'ext/**/*.c']
+  t.options = ['-r', 'README.md', '-o', 'docs']
+  t.stats_options = ['--list-undoc']
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "r4r"
+
+# 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/ghpages

@@ -0,0 +1,19 @@
+#!/bin/bash
+
+set -ex
+
+git diff-index --quiet HEAD -- || (
+  echo "Uncommitted changes detected"
+  exit 1
+)
+
+bin/rake yard
+
+git add -f docs
+git commit -m 'add /docs'
+
+git push origin `git subtree split --prefix docs HEAD`:gh-pages --force
+git reset --hard HEAD~1
+
+echo ""
+echo "DONE"

data/bin/rake

@@ -0,0 +1,2 @@
+#!/usr/bin/env bash
+exec bundle exec rake $@

data/bin/setup

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

data/ext/r4r/ring_bits_ext/extconf.rb

@@ -0,0 +1,7 @@
+require "mkmf"
+
+$CFLAGS = "-O2 -Wall -std=c99"
+
+extension_name = 'ring_bits_ext'
+dir_config(extension_name)
+create_makefile "#{extension_name}"

data/ext/r4r/ring_bits_ext/ring_bits_ext.c

@@ -0,0 +1,173 @@
+#include <ruby.h>
+#include <stdint.h>
+#include <stdio.h>
+#include <stdbool.h>
+#include <assert.h>
+
+#define ADDRESS_BITS_PER_WORD 6
+
+struct ring_bits_ext {
+  size_t size; //the size of the ring bit set
+  uint64_t * words;
+};
+
+/**
+ * Free resources allocated for ring_bits_ext.
+ */
+static void
+ring_bits_ext_free(void *p) {
+  struct ring_bits_ext *ptr = p;
+  if (ptr->size > 0) {
+    free(ptr->words);
+  }
+}
+
+/**
+ * Given a bit index, return word index containing it.
+ */
+size_t
+ring_bits_ext_word_index(int bit_index) {
+  return bit_index >> ADDRESS_BITS_PER_WORD;
+}
+
+/**
+ * Allocates resources for a ring_bits_ext.
+ */
+static VALUE
+ring_bits_ext_alloc(VALUE klass) {
+  VALUE obj;
+  struct ring_bits_ext *ptr;
+
+  obj = Data_Make_Struct(klass, struct ring_bits_ext, NULL, ring_bits_ext_free, ptr);
+  ptr->size = 0;
+  ptr->words = NULL;
+
+  return obj;
+}
+
+/**
+ * Inits a new ring_bits_ext object.
+ *
+ * @param [Fixnum] capacity a ring bits buffer size.
+ * @raise [ArgumentError] if capacity is negative
+ */
+static VALUE
+ring_bits_ext_init(VALUE self, VALUE capacity) {
+  struct ring_bits_ext *ptr;
+  int ring_bits_ext_size = NUM2INT(capacity);
+
+  if (0 >= ring_bits_ext_size) {
+    rb_raise(rb_eArgError, "ring bit's size must be positive, got %i", ring_bits_ext_size);
+    return Qnil;
+  }
+
+  size_t count_of_words_required = ring_bits_ext_word_index(ring_bits_ext_size - 1) + 1;
+
+  Data_Get_Struct(self, struct ring_bits_ext, ptr);
+  ptr->size = count_of_words_required << ADDRESS_BITS_PER_WORD;
+  ptr->words = calloc(count_of_words_required, sizeof(uint64_t));
+
+  return self;
+}
+
+/**
+ * Returns an actual ring bits capacity.
+ */
+static VALUE
+ring_bits_ext_get_size(VALUE self) {
+  struct ring_bits_ext *ptr;
+  Data_Get_Struct(self, struct ring_bits_ext, ptr);
+  return SIZET2NUM(ptr->size);
+}
+
+bool
+_ring_bits_ext_set(struct ring_bits_ext *ptr, int bit_index, bool value) {
+  assert(bit_index >= 0);
+
+  size_t word_index = ring_bits_ext_word_index(bit_index);
+
+  uint64_t bit_mask = ((uint64_t) 1) << bit_index;
+  bool previous = (ptr->words[word_index] & bit_mask) != 0;
+
+  //fprintf(stderr, "set: word_index: %lu bit_index: %i bit_mask: %llx \n", word_index, bit_index, bit_mask);
+
+  if (value) {
+    ptr->words[word_index] |= bit_mask;
+  } else {
+    ptr->words[word_index] &= ~bit_mask;
+  }
+
+  return previous;
+}
+
+/**
+ * Sets the bit at the specified index to value.
+ *
+ * @param [Fixnum] bit_index_value a bit index
+ * @return previous state of bit_index that can be true or false
+ * @raise [ArgumentError] if the specified index is negative
+ */
+static VALUE
+ring_bits_ext_set(VALUE self, VALUE bit_index_value, VALUE value) {
+  struct ring_bits_ext *ptr;
+  Data_Get_Struct(self, struct ring_bits_ext, ptr);
+
+  int bit_index = NUM2INT(bit_index_value);
+  if (0 > bit_index) {
+    rb_raise(rb_eArgError, "ring bit's index must be positive, got %i", bit_index);
+  }
+
+  bool previous = _ring_bits_ext_set(ptr, bit_index, value == Qtrue);
+  return previous ? Qtrue : Qfalse;
+}
+
+bool
+_ring_bits_ext_get(struct ring_bits_ext *ptr, int bit_index) {
+  assert(0 <= bit_index);
+
+  size_t word_index = ring_bits_ext_word_index(bit_index);
+  uint64_t bit_mask = ((uint64_t) 1) << bit_index;
+
+  //fprintf(stderr, "get: word_index: %lu bit_index: %i bit_mask: %llx\n", word_index, bit_index, bit_mask);
+
+  return (ptr->words[word_index] & bit_mask) != 0;
+}
+
+/**
+ * Gets the bit at the specified index.
+ *
+ * @param [Fixnum] bit_index_value a bit index
+ * @return state of bit_index that can be true or false
+ * @raise [ArgumentError] if the specified index is negative
+ */
+static VALUE
+ring_bits_ext_get(VALUE self, VALUE bit_index_value) {
+  struct ring_bits_ext *ptr;
+  Data_Get_Struct(self, struct ring_bits_ext, ptr);
+
+  int bit_index = NUM2INT(bit_index_value);
+  if (0 > bit_index) {
+    rb_raise(rb_eArgError, "ring bit's index must be positive, got %i", bit_index);
+  }
+
+  bool value = _ring_bits_ext_get(ptr, bit_index);
+  return value ? Qtrue : Qfalse;
+}
+
+/**
+ * Module entry point.
+ */
+void
+Init_ring_bits_ext() {
+  VALUE mR4r;
+  VALUE cRingBitSet;
+
+  mR4r = rb_define_module("R4r");
+  cRingBitSet = rb_define_class_under(mR4r, "RingBitsExt", rb_cObject);
+
+  rb_define_alloc_func(cRingBitSet, ring_bits_ext_alloc);
+  rb_define_method(cRingBitSet, "initialize", ring_bits_ext_init, 1);
+  rb_define_method(cRingBitSet, "size", ring_bits_ext_get_size, 0);
+  rb_define_method(cRingBitSet, "set", ring_bits_ext_set, 2);
+  rb_define_method(cRingBitSet, "get", ring_bits_ext_get, 1);
+}