sylvester 0.0.1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1,2 @@
+--drb
+--color

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+
+# Gem dependencies
+
+# Development dependencies
+group :development do
+  gem "rspec", "~> 2.8.0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.1.0"
+  gem "jeweler", "~> 1.8.4"
+  gem "simplecov", "~> 0.6.4"
+  gem "spork", "~> 0.9.2"
+  gem "pry"
+end

data/Gemfile.lock

@@ -0,0 +1,47 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    coderay (1.0.7)
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.4)
+    method_source (0.8)
+    multi_json (1.3.6)
+    pry (0.9.10)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.3.1)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+    simplecov (0.6.4)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.5.3)
+    simplecov-html (0.5.3)
+    slop (3.3.2)
+    spork (0.9.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.1.0)
+  jeweler (~> 1.8.4)
+  pry
+  rdoc (~> 3.12)
+  rspec (~> 2.8.0)
+  simplecov (~> 0.6.4)
+  spork (~> 0.9.2)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Jeremy Holland
+
+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.rdoc

@@ -0,0 +1,19 @@
+= sylvester
+
+Description goes here.
+
+== Contributing to sylvester
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2012 Jeremy Holland. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,62 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+require 'pry'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "sylvester"
+  gem.homepage = "http://github.com/awebneck/sylvester"
+  gem.license = "MIT"
+  gem.summary = %Q{A ruby library for interacting with, storing, and reading basic ruby objects from System V shared memory}
+  gem.description = %Q{The beginnings of a handy ruby interface for System V shared memory, making it accessible and easy to use directly from ruby. Plans are to simply treat it as a string to begin with, thereafter building more complex data structures that will implement the interfaces (where appropriate) of their stack-based counterparts.}
+  gem.email = "jeremy@jeremypholland.com"
+  gem.authors = ["Jeremy Holland"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "sylvester #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+desc "Compile for testing"
+task :buildext do
+  puts `/usr/bin/env ruby #{File.dirname(__FILE__)}/ext/sylvester/extconf.rb`
+  puts `/usr/bin/make`
+  puts `rm *.o > /dev/null 2>&1`
+  puts `rm mkmf.log > /dev/null 2>&1`
+  puts `rm Makefile > /dev/null 2>&1`
+  puts `mkdir -p #{File.dirname(__FILE__)}/spec/build/sylvester > /dev/null 2>&1`
+  Kernel.exec "mv sylvester.{bundle,so} #{File.dirname(__FILE__)}/lib > /dev/null 2>&1"
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/ext/sylvester/extconf.rb

@@ -0,0 +1,43 @@
+require "mkmf"
+
+HEADER_DIRS = [
+  # First search /opt/local for macports
+  '/opt/local/include',
+  # Then search /usr/local for people that installed from source or homebrew
+  '/usr/local/include',
+  # Finally fall back to /usr
+  '/usr/include',
+]
+
+LIB_DIRS = [
+  # First search /opt/local for macports
+  '/opt/local/lib',
+  # Then search /usr/local for people that installed from source or homebrew
+  '/usr/local/lib',
+  # Finally fall back to /usr
+  '/usr/lib',
+]
+
+headers = [
+  "stdarg.h",
+  "time.h",
+  "sys/types.h",
+  "sys/ipc.h",
+  "sys/shm.h",
+]
+
+libraries = [
+]
+
+puts ">> check require libraries..."
+
+libraries.each{|lib|
+  raise "lib#{lib} not found." unless have_library(lib)
+}
+
+puts ">> check require headers..."
+headers.each{|header|
+  raise "#{header} not found." unless have_header(header)
+}
+
+create_makefile("sylvester/sylvester")

data/ext/sylvester/sylvester.c

@@ -0,0 +1,28 @@
+#include <sylvester.h>
+
+/**
+ * Sylvester system initializer
+ */
+
+/* ================= EXTERNAL VARIABLES ================== */
+
+/**
+ * module Sylvester
+ */
+VALUE mSylvester;
+
+/* ================ RUBY ROOT INITIALIZER ================ */
+
+void Init_sylvester(void) {
+
+  /**
+   * Define namespace modules
+   */
+  mSylvester = rb_define_module("Sylvester");
+
+  /**
+   * Initialize all systems in order of dependency
+   */
+  sylvester_init_errors();
+  sylvester_init_share();
+}

data/ext/sylvester/sylvester.h

@@ -0,0 +1,21 @@
+#ifndef SYLVESTER
+#define SYLVESTER
+
+#include <sys/types.h>
+#include <sys/ipc.h>
+#include <sys/shm.h>
+#include <stdio.h>
+#include <time.h>
+#include <string.h>
+#include <errno.h>
+#include <math.h>
+#include "ruby.h"
+
+#include <sylvester_errors.h>
+#include <sylvester_share.h>
+
+/* ====================== EXTERNALS ====================== */
+
+extern VALUE mSylvester;
+
+#endif

data/ext/sylvester/sylvester_errors.c

@@ -0,0 +1,31 @@
+#include <sylvester_errors.h>
+
+/**
+ * Contains all Sylvester system error classes
+ */
+
+/* ================= EXTERNAL VARIABLES ================== */
+
+/**
+ * Sylvester error classes
+ */
+VALUE cSylvesterAttachmentError;
+VALUE cSylvesterDetachmentError;
+VALUE cSylvesterMetadataError;
+
+/* ================== RUBY INITIALIZER =================== */
+
+void sylvester_init_errors(void) {
+
+  /**
+   * Acquire namespace module
+   */
+  VALUE sylvester = rb_define_module("Sylvester");
+
+  /**
+   * Define error classes
+   */
+  cSylvesterAttachmentError = rb_define_class_under(sylvester, "AttachmentError", rb_eException);
+  cSylvesterDetachmentError = rb_define_class_under(sylvester, "DetachmentError", rb_eException);
+  cSylvesterMetadataError = rb_define_class_under(sylvester, "MetadataError", rb_eException);
+}

data/ext/sylvester/sylvester_errors.h

@@ -0,0 +1,14 @@
+#ifndef SYLVESTER_ERRORS
+#define SYLVESTER_ERRORS
+
+#include <sylvester.h>
+
+/* ====================== EXTERNALS ====================== */
+
+extern VALUE cSylvesterAttachmentError;
+extern VALUE cSylvesterDetachmentError;
+extern VALUE cSylvesterMetadataError;
+
+extern void sylvester_init_errors(void);
+
+#endif

data/ext/sylvester/sylvester_share.c

@@ -0,0 +1,284 @@
+#include <sylvester_share.h>
+#include <sylvester_errors.h>
+
+/**
+ * A Sylvester::Share is an attachment to shared memory
+ */
+
+/* ================= EXTERNAL VARIABLES ================== */
+
+/**
+ * class Sylvester::Share
+ */
+VALUE cSylvesterShare;
+
+/* ================== C-LEVEL FUNCTIONS ================== */
+
+/**
+ * Allocates and returns new Sshare struct
+ */
+static SsharePtr sshare_new_sshare(void) {
+  return (SsharePtr) malloc(sizeof(Sshare));
+}
+
+/**
+ * Checks validity of key
+ */
+static VALUE sshare_validate_key(VALUE key) {
+  if (!rb_obj_is_kind_of(key, rb_cInteger) || FIX2INT(key) < 0)
+    rb_raise(rb_eArgError, "Shared memory key not a positive integer!");
+}
+
+/**
+ * Checks validity of key
+ */
+static VALUE sshare_validate_size(VALUE size) {
+  if (!rb_obj_is_kind_of(size, rb_cInteger) || FIX2INT(size) < 0)
+    rb_raise(rb_eArgError, "Specified size not a positive integer!");
+}
+
+/**
+ * Returns the integer share reference for a given key
+ */
+int sshare_get_share_reference(key_t key, int sz) {
+  int shmid;
+
+  if ((shmid = shmget(key, sz, IPC_CREAT | 0666)) < 0)
+    rb_raise(cSylvesterAttachmentError, "Error acquiring id for shared memory for key %d of size %d: [%d] %s", key, sz, errno, strerror(errno));
+  return shmid;
+}
+
+/**
+ * Attaches a unit of shared memory at the specified
+ * key and of the specified size to the current process,
+ * returning a pointer thereinto for readonly purposes
+ */
+void sshare_attach_share(key_t key, int sz, int shmid, void **shmaddr, int *attached) {
+  if (!*attached) {
+    if ((*shmaddr = shmat(shmid, NULL, 0)) == (int *)-1)
+      rb_raise(cSylvesterAttachmentError, "Error attaching shared memory for key %d of size %d: [%d] %s", key, sz, errno, strerror(errno));
+    *attached = 1;
+  }
+}
+
+/**
+ * Detaches a unit of shared memory at the specified
+ * key and of the specified size from the current process.
+ */
+void sshare_detach_share(key_t key, int sz, void *shmaddr, int *attached) {
+  if (*attached) {
+    if ((shmdt(shmaddr)) == -1)
+      rb_raise(cSylvesterDetachmentError, "Error detaching shared memory for key %d of size %d: [%d] %s", (unsigned int)key, sz, errno, strerror(errno));
+    *attached = 0;
+  }
+}
+
+/**
+ * Destroys a unit of shared memory at the specified
+ * key and of the specified size from the current process.
+ */
+void sshare_destroy_share(key_t key, int sz, int shmid, void *shmaddr, int *attached) {
+  struct shmid_ds *databuf;
+
+  sshare_detach_share(key, sz, shmaddr, attached);
+  databuf = malloc(sizeof(struct shmid_ds));
+  if ((shmctl(shmid, IPC_RMID, databuf)) == -1)
+    rb_raise(cSylvesterMetadataError, "Error destroying shared memory for key %d of size %d: [%d] %s", (unsigned int)key, sz, errno, strerror(errno));
+  free(databuf);
+  //printf("DESTROYED!\n");
+}
+
+/**
+ * Returns the number of currently attached processes
+ */
+int sshare_get_attachment_count(key_t key, int sz, int shmid) {
+  struct shmid_ds *databuf;
+  int count;
+
+  databuf = malloc(sizeof(struct shmid_ds));
+  if ((shmctl(shmid, IPC_STAT, databuf)) == -1)
+    rb_raise(cSylvesterMetadataError, "Error accessing shared memory metadata for key %d of size %d: [%d] %s", (unsigned int)key, sz, errno, strerror(errno));
+  count = databuf->shm_nattch;
+  free(databuf);
+  return count;
+  //printf("DESTROYED!\n");
+}
+
+/* ================ RUBY SYSTEM FUNCTIONS ================ */
+
+/**
+ * Class free function
+ */
+static void free_sshare(SsharePtr sshare) {
+  if (sshare->attached)
+    sshare_detach_share(sshare->key, sshare->sz, sshare->ptr, &sshare->attached);
+  free(sshare);
+}
+
+/**
+ * Class allocation function
+ */
+static VALUE sshare_alloc(VALUE klass) {
+  SsharePtr sshare;
+  VALUE obj;
+
+  sshare = sshare_new_sshare();
+  sshare->attached = 0;
+  sshare->shmid = 0;
+  sshare->key = (key_t)0;
+  sshare->sz = 0;
+  sshare->autoattach = 1;
+  obj = Data_Wrap_Struct(klass, 0, free_sshare, sshare);
+  return obj;
+}
+
+/**
+ * Parse initialization options
+ */
+static void sshare_parse_init_opts(SsharePtr sshare, VALUE opts) {
+  if (opts != Qnil) {
+    if (st_lookup(RHASH(opts)->ntbl, ID2SYM(rb_intern("autoattach")), 0) && RTEST(rb_hash_aref(opts, ID2SYM(rb_intern("autoattach")))) == 0)
+      sshare->autoattach = 0;
+  }
+}
+
+/* ================ RUBY INSTANCE METHODS ================ */
+
+/**
+ * Constructor:
+ *   Takes 1 argument, being the refkey for shared
+ *   memory. Attaches such memory to the process, allowing
+ *   it to be queried
+ */
+static VALUE sshare_init(int argc, VALUE *argv, VALUE self) {
+  VALUE key, shmsz, opts, autoattach;
+  SsharePtr sshare;
+
+  rb_scan_args(argc, argv, "21", &key, &shmsz, &opts);
+  Data_Get_Struct(self, Sshare, sshare);
+
+  sshare_validate_key(key);
+  sshare_validate_size(shmsz);
+
+  sshare->key = (key_t)FIX2INT(key);
+  sshare->sz = FIX2INT(shmsz);
+  sshare->shmid = sshare_get_share_reference((key_t)sshare->key, sshare->sz);
+
+  sshare_parse_init_opts(sshare, opts);
+
+  if (sshare->autoattach) {
+    // printf("ATTACHING: %d\n", sshare->attached);
+    sshare_attach_share(sshare->key, sshare->sz, sshare->shmid, &sshare->ptr, &sshare->attached);
+    // printf("ATTACHED AFTER CALL: %d\n", sshare->attached);
+  }
+
+  return self;
+}
+
+/**
+ * name: :attached?
+ * Returns true if the share is currently attached to the current process, false otherwise
+ */
+static VALUE sshare_attached_qm(VALUE self) {
+  SsharePtr sshare;
+
+  Data_Get_Struct(self, Sshare, sshare);
+  // printf("IS ATTACHED?: %d\n", sshare->attached);
+  return (sshare->attached) ? Qtrue : Qfalse;
+}
+
+/**
+ * name: :attach!
+ * Attaches the share (if it is not already).
+ */
+static VALUE sshare_attach_ep(VALUE self) {
+  SsharePtr sshare;
+
+  Data_Get_Struct(self, Sshare, sshare);
+  sshare_attach_share(sshare->key, sshare->sz, sshare->shmid, &sshare->ptr, &sshare->attached);
+  return Qnil;
+}
+
+/**
+ * name: :detach!
+ * Detaches the share (if it is not already).
+ */
+static VALUE sshare_detach_ep(VALUE self) {
+  SsharePtr sshare;
+
+  Data_Get_Struct(self, Sshare, sshare);
+  sshare_detach_share(sshare->key, sshare->sz, sshare->ptr, &sshare->attached);
+  sshare->ptr = NULL;
+  return Qnil;
+}
+
+/**
+ * name: :destroy!
+ * Detaches the share (if attached) and destroys the reference.
+ */
+static VALUE sshare_destroy_ep(VALUE self) {
+  SsharePtr sshare;
+
+  Data_Get_Struct(self, Sshare, sshare);
+  sshare_destroy_share(sshare->key, sshare->sz, sshare->shmid, sshare->ptr, &sshare->attached);
+  sshare->ptr = NULL;
+  return Qnil;
+}
+
+/**
+ * name: :key
+ * Returns the key for the share.
+ */
+static VALUE sshare_key(VALUE self) {
+  SsharePtr sshare;
+
+  Data_Get_Struct(self, Sshare, sshare);
+  return INT2FIX((unsigned int)sshare->key);
+}
+
+/**
+ * name: :size
+ * Returns the size of the share.
+ */
+static VALUE sshare_size(VALUE self) {
+  SsharePtr sshare;
+
+  Data_Get_Struct(self, Sshare, sshare);
+  return INT2FIX(sshare->sz);
+}
+
+/**
+ * name: :size
+ * Returns the current number of attached processes.
+ */
+static VALUE sshare_attachment_count(VALUE self) {
+  SsharePtr sshare;
+
+  Data_Get_Struct(self, Sshare, sshare);
+  return INT2FIX(sshare_get_attachment_count(sshare->key, sshare->sz, sshare->shmid));
+}
+
+
+/* ================== RUBY INITIALIZER =================== */
+
+void sylvester_init_share(void) {
+
+  /**
+   * Acquire namespace module
+   */
+  VALUE sylvester = rb_define_module("Sylvester");
+
+  /**
+   * Define and describe share class
+   */
+  cSylvesterShare = rb_define_class_under(sylvester, "Share", rb_cObject);
+  rb_define_alloc_func(cSylvesterShare, sshare_alloc);
+  rb_define_method(cSylvesterShare, "initialize", sshare_init, -1);
+  rb_define_method(cSylvesterShare, "attached?", sshare_attached_qm, 0);
+  rb_define_method(cSylvesterShare, "attach!", sshare_attach_ep, 0);
+  rb_define_method(cSylvesterShare, "detach!", sshare_detach_ep, 0);
+  rb_define_method(cSylvesterShare, "destroy!", sshare_destroy_ep, 0);
+  rb_define_method(cSylvesterShare, "key", sshare_key, 0);
+  rb_define_method(cSylvesterShare, "size", sshare_size, 0);
+  rb_define_method(cSylvesterShare, "attachment_count", sshare_attachment_count, 0);
+}

data/ext/sylvester/sylvester_share.h

@@ -0,0 +1,23 @@
+#ifndef SYLVESTER_SHARE
+#define SYLVESTER_SHARE
+
+#include <sylvester.h>
+
+/* ================ STRUCTS AND TYPEDEFS ================= */
+
+struct _sshare {
+  unsigned int attached, shmid, sz, autoattach;
+  key_t key;
+  void *ptr;
+};
+
+typedef struct _sshare Sshare;
+typedef Sshare * SsharePtr;
+
+/* ====================== EXTERNALS ====================== */
+
+extern VALUE cSylvesterShare;
+
+extern void sylvester_init_share(void);
+
+#endif

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+require 'rubygems'
+require 'spork'
+require 'pry'
+
+#uncomment the following line to use spork with the debugger
+#require 'spork/ext/ruby-debug'
+
+Spork.prefork do
+  $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+  $LOAD_PATH.unshift(File.dirname(__FILE__))
+  require 'rspec'
+  require 'sylvester'
+
+  Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+  RSpec.configure do |config|
+  end
+end
+
+Spork.each_run do
+end

data/spec/support/bin/attach

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+require "#{File.dirname(__FILE__)}/../bin_helper"
+
+class Attacher
+  def initialize(key,size)
+    @share = Sylvester::Share.new ARGV[0].to_i, ARGV[1].to_i
+    @running = true
+    run
+  end
+
+  def handle_interrupt
+    Proc.new do
+      @running = false
+      @share.detach!
+    end
+  end
+
+  def run
+    while @running
+      trap("INT", &handle_interrupt)
+      trap("KILL", &handle_interrupt)
+      trap("QUIT", &handle_interrupt)
+      trap("TERM", &handle_interrupt)
+      trap("HUP", &handle_interrupt)
+    end
+  end
+end
+
+@attacher = Attacher.new ARGV[0].to_i, ARGV[1].to_i
+

data/spec/support/bin_commands.rb

@@ -0,0 +1,7 @@
+def execute_binary(command)
+  `#{File.dirname(__FILE__)}/bin/#{command} > /dev/null & echo $!`.to_i
+end
+
+def kill_binary(pid)
+  `kill #{pid}`
+end

data/spec/support/bin_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
+require 'sylvester'

data/spec/support/test_shares.rb

@@ -0,0 +1,4 @@
+TEST_SHARES = [
+  {:key => 9991, :size => 1048576}, # 1Mb
+  {:key => 9992, :size => 1024} # 1Mb
+]

data/spec/sylvester/share_spec.rb

@@ -0,0 +1,161 @@
+require 'spec_helper'
+
+describe Sylvester::Share do
+  let(:share_params) { TEST_SHARES[0] }
+  let(:share_params_2) { TEST_SHARES[1] }
+
+  it "should be a class" do
+    Sylvester::Share.should be_a Class
+  end
+
+  describe "constructor" do
+    it "should return a valid instance of the class when presented with a positive integer key and a positive integer size" do
+      share_params[:key].should be_a Integer
+      share_params[:size].should be_a Integer
+      share = Sylvester::Share.new share_params[:key], share_params[:size]
+      share.should be_a Sylvester::Share
+      share.destroy!
+    end
+
+    it "should throw an argument error when presented with a negative integer key" do
+      lambda {
+        share = Sylvester::Share.new -123, share_params[:size]
+        share.destroy!
+      }.should raise_error ArgumentError, "Shared memory key not a positive integer!"
+    end
+
+    it "should throw an argument error when presented with a noninteger key" do
+      lambda {
+        share = Sylvester::Share.new "test", share_params[:size]
+        share.destroy!
+      }.should raise_error ArgumentError, "Shared memory key not a positive integer!"
+    end
+
+    it "should throw an argument error when presented with a negative integer size" do
+      lambda {
+        share = Sylvester::Share.new share_params[:key], -123
+        share.destroy!
+      }.should raise_error ArgumentError, "Specified size not a positive integer!"
+    end
+
+    it "should be attached if the opts hash is omitted" do
+      share = Sylvester::Share.new share_params[:key], share_params[:size]
+      share.should be_attached
+      share.destroy!
+    end
+
+    it "should be attached if the opts hash key :autoattach is set to anything besides nil or false" do
+      share = Sylvester::Share.new share_params[:key], share_params[:size], :autoattach => true
+      share.should be_attached
+      share.destroy!
+      share = Sylvester::Share.new share_params_2[:key], share_params_2[:size], :autoattach => "hat"
+      share.should be_attached
+      share.destroy!
+    end
+
+    it "should be unattached if the opts hash key :autoattach is set to false or nil" do
+      share = Sylvester::Share.new share_params[:key], share_params[:size], :autoattach => false
+      share.should_not be_attached
+      share.destroy!
+      share = Sylvester::Share.new share_params_2[:key], share_params_2[:size], :autoattach => nil
+      share.should_not be_attached
+      share.destroy!
+    end
+  end
+
+  describe "instance methods" do
+    describe "attached?" do
+      it "should be true if the share is currently attached to the process" do
+        share = Sylvester::Share.new share_params[:key], share_params[:size], :autoattach => false
+        share.should_not be_attached
+        share.attach!
+        share.should be_attached
+        share.destroy!
+      end
+
+      it "should be false if the share is currently not attached to the process" do
+        share = Sylvester::Share.new share_params[:key], share_params[:size]
+        share.should be_attached
+        share.detach!
+        share.should_not be_attached
+        share.destroy!
+      end
+    end
+
+    describe "attach!" do
+      it "should attach the shared memory to the current process if it isn't already" do
+        share = Sylvester::Share.new share_params[:key], share_params[:size], :autoattach => false
+        share.attach!
+        share.should be_attached
+        share.attachment_count.should == 1
+        share.destroy!
+      end
+
+      it "should do nothing if the share is already attached" do
+        share = Sylvester::Share.new share_params[:key], share_params[:size]
+        share.should be_attached
+        share.attachment_count.should == 1
+        share.attach!
+        share.should be_attached
+        share.attachment_count.should == 1
+        share.destroy!
+      end
+    end
+
+    describe "detach!" do
+      it "should detach the shared memory from the current process if it isn't already" do
+        share = Sylvester::Share.new share_params[:key], share_params[:size]
+        share.detach!
+        share.should_not be_attached
+        share.attachment_count.should == 0
+        share.destroy!
+      end
+
+      it "should do nothing if the share is already attached" do
+        share = Sylvester::Share.new share_params[:key], share_params[:size], :autoattach => false
+        share.should_not be_attached
+        share.attachment_count.should == 0
+        share.detach!
+        share.should_not be_attached
+        share.attachment_count.should == 0
+        share.destroy!
+      end
+    end
+
+    describe "destroy!"
+
+    describe "attachment_count" do
+      it "should return the number of current attachments" do
+        share = Sylvester::Share.new share_params[:key], share_params[:size], :autoattach => false
+        share.attachment_count.should == 0
+        share.attach!
+        share.attachment_count.should == 1
+        pid = execute_binary "attach #{share_params[:key]} #{share_params[:size]}"
+        sleep 0.1
+        share.attachment_count.should == 2
+        share.detach!
+        share.attachment_count.should == 1
+        kill_binary pid
+        sleep 0.1
+        share.attachment_count.should == 0
+        share.destroy!
+      end
+    end
+
+    describe "key" do
+      it "should retrieve the share key" do
+        share = Sylvester::Share.new share_params[:key], share_params[:size]
+        share.key.should == share_params[:key]
+        share.destroy!
+      end
+    end
+
+    describe "size" do
+      it "should retrieve the size of the share" do
+        share = Sylvester::Share.new share_params[:key], share_params[:size]
+        share.size.should == share_params[:size]
+        share.destroy!
+      end
+    end
+  end
+end

data/spec/sylvester_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Sylvester do
+  it "should be a module" do
+    Sylvester.should be_a Module
+  end
+end

data/sylvester.gemspec

@@ -0,0 +1,81 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "sylvester"
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jeremy Holland"]
+  s.date = "2012-08-04"
+  s.description = "The beginnings of a handy ruby interface for System V shared memory, making it accessible and easy to use directly from ruby. Plans are to simply treat it as a string to begin with, thereafter building more complex data structures that will implement the interfaces (where appropriate) of their stack-based counterparts."
+  s.email = "jeremy@jeremypholland.com"
+  s.extensions = ["ext/sylvester/extconf.rb"]
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "ext/sylvester/extconf.rb",
+    "ext/sylvester/sylvester.c",
+    "ext/sylvester/sylvester.h",
+    "ext/sylvester/sylvester_errors.c",
+    "ext/sylvester/sylvester_errors.h",
+    "ext/sylvester/sylvester_share.c",
+    "ext/sylvester/sylvester_share.h",
+    "spec/spec_helper.rb",
+    "spec/support/bin/attach",
+    "spec/support/bin_commands.rb",
+    "spec/support/bin_helper.rb",
+    "spec/support/test_shares.rb",
+    "spec/sylvester/share_spec.rb",
+    "spec/sylvester_spec.rb",
+    "sylvester.gemspec"
+  ]
+  s.homepage = "http://github.com/awebneck/sylvester"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.15"
+  s.summary = "A ruby library for interacting with, storing, and reading basic ruby objects from System V shared memory"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.1.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_development_dependency(%q<simplecov>, ["~> 0.6.4"])
+      s.add_development_dependency(%q<spork>, ["~> 0.9.2"])
+      s.add_development_dependency(%q<pry>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.1.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_dependency(%q<simplecov>, ["~> 0.6.4"])
+      s.add_dependency(%q<spork>, ["~> 0.9.2"])
+      s.add_dependency(%q<pry>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.1.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+    s.add_dependency(%q<simplecov>, ["~> 0.6.4"])
+    s.add_dependency(%q<spork>, ["~> 0.9.2"])
+    s.add_dependency(%q<pry>, [">= 0"])
+  end
+end
+

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: sylvester
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jeremy Holland
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &18611940 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: *18611940
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &18633900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: *18633900
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &18630220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :development
+  prerelease: false
+  version_requirements: *18630220
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &18675840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :development
+  prerelease: false
+  version_requirements: *18675840
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &18672080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.4
+  type: :development
+  prerelease: false
+  version_requirements: *18672080
+- !ruby/object:Gem::Dependency
+  name: spork
+  requirement: &18720440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: *18720440
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: &18732660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *18732660
+description: The beginnings of a handy ruby interface for System V shared memory,
+  making it accessible and easy to use directly from ruby. Plans are to simply treat
+  it as a string to begin with, thereafter building more complex data structures that
+  will implement the interfaces (where appropriate) of their stack-based counterparts.
+email: jeremy@jeremypholland.com
+executables: []
+extensions:
+- ext/sylvester/extconf.rb
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- ext/sylvester/extconf.rb
+- ext/sylvester/sylvester.c
+- ext/sylvester/sylvester.h
+- ext/sylvester/sylvester_errors.c
+- ext/sylvester/sylvester_errors.h
+- ext/sylvester/sylvester_share.c
+- ext/sylvester/sylvester_share.h
+- spec/spec_helper.rb
+- spec/support/bin/attach
+- spec/support/bin_commands.rb
+- spec/support/bin_helper.rb
+- spec/support/test_shares.rb
+- spec/sylvester/share_spec.rb
+- spec/sylvester_spec.rb
+- sylvester.gemspec
+homepage: http://github.com/awebneck/sylvester
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1812158138877080485
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: A ruby library for interacting with, storing, and reading basic ruby objects
+  from System V shared memory
+test_files: []