rubyapi 1.0.1

data/.gitignore

@@ -0,0 +1,22 @@
+*.dll
+*.so
+*.bundle
+*.o
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/LICENSE

@@ -0,0 +1,21 @@
+Copyright 2012 Kim Burgestrand. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are
+permitted provided that the following conditions are met:
+
+   1. Redistributions of source code must retain the above copyright notice, this list of
+      conditions and the following disclaimer.
+
+   2. Redistributions in binary form must reproduce the above copyright notice, this list
+      of conditions and the following disclaimer in the documentation and/or other materials
+      provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY KIM BURGESTRAND ``AS IS'' AND ANY EXPRESS OR IMPLIED
+WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL KIM BURGESTRAND OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/Makefile

@@ -0,0 +1,213 @@
+
+SHELL = /bin/sh
+
+# V=0 quiet, V=1 verbose.  other values don't work.
+V = 0
+Q1 = $(V:1=)
+Q = $(Q1:0=@)
+n=$(NULLCMD)
+ECHO1 = $(V:1=@$n)
+ECHO = $(ECHO1:0=@echo)
+
+#### Start of system configuration section. ####
+
+srcdir = .
+topdir = /Users/Kim/.rvm/rubies/ruby-1.9.3-p125/include/ruby-1.9.1
+hdrdir = /Users/Kim/.rvm/rubies/ruby-1.9.3-p125/include/ruby-1.9.1
+arch_hdrdir = /Users/Kim/.rvm/rubies/ruby-1.9.3-p125/include/ruby-1.9.1/$(arch)
+VPATH = $(srcdir):$(arch_hdrdir)/ruby:$(hdrdir)/ruby
+prefix = $(DESTDIR)/Users/Kim/.rvm/rubies/ruby-1.9.3-p125
+rubylibprefix = $(libdir)/$(RUBY_BASE_NAME)
+exec_prefix = $(prefix)
+vendorhdrdir = $(rubyhdrdir)/vendor_ruby
+sitehdrdir = $(rubyhdrdir)/site_ruby
+rubyhdrdir = $(includedir)/$(RUBY_BASE_NAME)-$(ruby_version)
+vendordir = $(rubylibprefix)/vendor_ruby
+sitedir = $(rubylibprefix)/site_ruby
+ridir = $(datarootdir)/$(RI_BASE_NAME)
+mandir = $(datarootdir)/man
+localedir = $(datarootdir)/locale
+libdir = $(exec_prefix)/lib
+psdir = $(docdir)
+pdfdir = $(docdir)
+dvidir = $(docdir)
+htmldir = $(docdir)
+infodir = $(datarootdir)/info
+docdir = $(datarootdir)/doc/$(PACKAGE)
+oldincludedir = $(DESTDIR)/usr/include
+includedir = $(prefix)/include
+localstatedir = $(prefix)/var
+sharedstatedir = $(prefix)/com
+sysconfdir = $(prefix)/etc
+datadir = $(datarootdir)
+datarootdir = $(prefix)/share
+libexecdir = $(exec_prefix)/libexec
+sbindir = $(exec_prefix)/sbin
+bindir = $(exec_prefix)/bin
+rubylibdir = $(rubylibprefix)/$(ruby_version)
+archdir = $(rubylibdir)/$(arch)
+sitelibdir = $(sitedir)/$(ruby_version)
+sitearchdir = $(sitelibdir)/$(sitearch)
+vendorlibdir = $(vendordir)/$(ruby_version)
+vendorarchdir = $(vendorlibdir)/$(sitearch)
+
+NULLCMD = :
+
+CC = /usr/bin/gcc-4.2
+CXX = g++-4.2
+LIBRUBY = $(LIBRUBY_SO)
+LIBRUBY_A = lib$(RUBY_SO_NAME)-static.a
+LIBRUBYARG_SHARED = -l$(RUBY_SO_NAME)
+LIBRUBYARG_STATIC = -l$(RUBY_SO_NAME)-static
+OUTFLAG = -o 
+COUTFLAG = -o 
+
+RUBY_EXTCONF_H = 
+cflags   =  $(optflags) $(debugflags) $(warnflags)
+optflags = -O3
+debugflags = -ggdb
+warnflags = -Wextra -Wno-unused-parameter -Wno-parentheses -Wno-long-long -Wno-missing-field-initializers -Wpointer-arith -Wwrite-strings -Wdeclaration-after-statement -Wshorten-64-to-32 -Wimplicit-function-declaration
+CFLAGS   = -fno-common $(cflags)  -fno-common -pipe $(ARCH_FLAG)
+INCFLAGS = -I. -I$(arch_hdrdir) -I$(hdrdir)/ruby/backward -I$(hdrdir) -I$(srcdir)
+DEFS     = 
+CPPFLAGS =  -I/Users/Kim/.rvm/usr/include -D_XOPEN_SOURCE -D_DARWIN_C_SOURCE $(DEFS) $(cppflags)
+CXXFLAGS = $(CFLAGS) $(cxxflags)
+ldflags  = -L. 
+dldflags = -Wl,-undefined,dynamic_lookup -Wl,-multiply_defined,suppress -Wl,-flat_namespace
+ARCH_FLAG = 
+DLDFLAGS = $(ldflags) $(dldflags) $(ARCH_FLAG)
+LDSHARED = $(CC) -dynamic -bundle
+LDSHAREDXX = $(CXX) -dynamic -bundle
+AR = ar
+EXEEXT = 
+
+RUBY_BASE_NAME = ruby
+RUBY_INSTALL_NAME = ruby
+RUBY_SO_NAME = ruby.1.9.1
+arch = x86_64-darwin11.3.0
+sitearch = $(arch)
+ruby_version = 1.9.1
+ruby = /Users/Kim/.rvm/rubies/ruby-1.9.3-p125/bin/ruby
+RUBY = $(ruby)
+RM = rm -f
+RM_RF = $(RUBY) -run -e rm -- -rf
+RMDIRS = rmdir -p
+MAKEDIRS = mkdir -p
+INSTALL = /usr/bin/install -c
+INSTALL_PROG = $(INSTALL) -m 0755
+INSTALL_DATA = $(INSTALL) -m 644
+COPY = cp
+
+#### End of system configuration section. ####
+
+preload = 
+
+libpath = . $(libdir) /Users/Kim/.rvm/usr/lib
+LIBPATH =  -L. -L$(libdir) -L/Users/Kim/.rvm/usr/lib
+DEFFILE = 
+
+CLEANFILES = mkmf.log
+DISTCLEANFILES = 
+DISTCLEANDIRS = 
+
+extout = 
+extout_prefix = 
+target_prefix = 
+LOCAL_LIBS = 
+LIBS = $(LIBRUBYARG_SHARED)  -lpthread -ldl -lobjc 
+SRCS = rubyapi_ext.c
+OBJS = rubyapi_ext.o
+TARGET = rubyapi_ext
+DLLIB = $(TARGET).bundle
+EXTSTATIC = 
+STATIC_LIB = 
+
+BINDIR        = $(bindir)
+RUBYCOMMONDIR = $(sitedir)$(target_prefix)
+RUBYLIBDIR    = $(sitelibdir)$(target_prefix)
+RUBYARCHDIR   = $(sitearchdir)$(target_prefix)
+HDRDIR        = $(rubyhdrdir)/ruby$(target_prefix)
+ARCHHDRDIR    = $(rubyhdrdir)/$(arch)/ruby$(target_prefix)
+
+TARGET_SO     = $(DLLIB)
+CLEANLIBS     = $(TARGET).bundle 
+CLEANOBJS     = *.o  *.bak
+
+all:    $(DLLIB)
+static: $(STATIC_LIB)
+.PHONY: all install static install-so install-rb
+.PHONY: clean clean-so clean-rb
+
+clean-rb-default::
+clean-rb::
+clean-so::
+clean: clean-so clean-rb-default clean-rb
+		@-$(RM) $(CLEANLIBS) $(CLEANOBJS) $(CLEANFILES)
+
+distclean-rb-default::
+distclean-rb::
+distclean-so::
+distclean: clean distclean-so distclean-rb-default distclean-rb
+		@-$(RM) Makefile $(RUBY_EXTCONF_H) conftest.* mkmf.log
+		@-$(RM) core ruby$(EXEEXT) *~ $(DISTCLEANFILES)
+		@-$(RMDIRS) $(DISTCLEANDIRS) 2> /dev/null || true
+
+realclean: distclean
+install: install-so install-rb
+
+install-so: $(RUBYARCHDIR)
+install-so: $(RUBYARCHDIR)/$(DLLIB)
+$(RUBYARCHDIR)/$(DLLIB): $(DLLIB)
+	@-$(MAKEDIRS) $(@D)
+	$(INSTALL_PROG) $(DLLIB) $(@D)
+install-rb: pre-install-rb install-rb-default
+install-rb-default: pre-install-rb-default
+pre-install-rb: Makefile
+pre-install-rb-default: Makefile
+pre-install-rb-default:
+	$(ECHO) installing default rubyapi_ext libraries
+$(RUBYARCHDIR):
+	$(Q) $(MAKEDIRS) $@
+
+site-install: site-install-so site-install-rb
+site-install-so: install-so
+site-install-rb: install-rb
+
+.SUFFIXES: .c .m .cc .mm .cxx .cpp .C .o
+
+.cc.o:
+	$(ECHO) compiling $(<)
+	$(Q) $(CXX) $(INCFLAGS) $(CPPFLAGS) $(CXXFLAGS) $(COUTFLAG)$@ -c $<
+
+.mm.o:
+	$(ECHO) compiling $(<)
+	$(Q) $(CXX) $(INCFLAGS) $(CPPFLAGS) $(CXXFLAGS) $(COUTFLAG)$@ -c $<
+
+.cxx.o:
+	$(ECHO) compiling $(<)
+	$(Q) $(CXX) $(INCFLAGS) $(CPPFLAGS) $(CXXFLAGS) $(COUTFLAG)$@ -c $<
+
+.cpp.o:
+	$(ECHO) compiling $(<)
+	$(Q) $(CXX) $(INCFLAGS) $(CPPFLAGS) $(CXXFLAGS) $(COUTFLAG)$@ -c $<
+
+.C.o:
+	$(ECHO) compiling $(<)
+	$(Q) $(CXX) $(INCFLAGS) $(CPPFLAGS) $(CXXFLAGS) $(COUTFLAG)$@ -c $<
+
+.c.o:
+	$(ECHO) compiling $(<)
+	$(Q) $(CC) $(INCFLAGS) $(CPPFLAGS) $(CFLAGS) $(COUTFLAG)$@ -c $<
+
+.m.o:
+	$(ECHO) compiling $(<)
+	$(Q) $(CC) $(INCFLAGS) $(CPPFLAGS) $(CFLAGS) $(COUTFLAG)$@ -c $<
+
+$(DLLIB): $(OBJS) Makefile
+	$(ECHO) linking shared-object $(DLLIB)
+	@-$(RM) $(@)
+	$(Q) $(LDSHARED) -o $@ $(OBJS) $(LIBPATH) $(DLDFLAGS) $(LOCAL_LIBS) $(LIBS)
+
+
+
+$(OBJS): $(hdrdir)/ruby.h $(hdrdir)/ruby/defines.h $(arch_hdrdir)/ruby/config.h

data/README.md

@@ -0,0 +1,32 @@
+rubyapi
+=======
+
+Access help to the Ruby C library from FFI.
+
+Installation
+------------
+
+    gem install rubyapi
+
+Usage
+-----
+
+```ruby
+
+RubyAPI.attach_function :new_array, :rb_array_new, [], :object
+RubyAPI.attach_function :inspect, :rb_p, [ :object ], :void
+
+RubyAPI.inspect("Hello, world!")
+RubyAPI.inspect(RubyAPI.new_array)
+
+```
+
+WHY?
+----
+
+:trollface:
+
+License
+-------
+
+Simplified (2-clause) BSD license.

data/Rakefile

@@ -0,0 +1,23 @@
+begin
+  require "bundler/gem_tasks"
+rescue LoadError
+end
+
+task :compile do
+  sh 'ruby extconf.rb'
+  sh 'make'
+end
+
+task :console => :compile do
+  exec 'irb -I. -rrubyapi'
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |t|
+  t.libs    = ["."]
+  t.pattern = "*_spec.rb"
+  t.verbose = true
+end
+task :test => :compile
+
+task :default => :test

data/extconf.rb

@@ -0,0 +1,3 @@
+require 'mkmf'
+
+create_makefile 'rubyapi_ext'

data/rubyapi.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |gem|
+  gem.name          = "rubyapi"
+
+  gem.authors       = ["Kim Burgestrand"]
+  gem.email         = ["kim@burgestrand.se"]
+  gem.summary       = %q{Access help to the Ruby C library from FFI}
+  gem.license       = "Simplified BSD License"
+  gem.homepage      = "https://github.com/Burgestrand/rubyapi"
+
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = ["rubyapi_spec.rb"]
+  gem.require_paths = ["."]
+  gem.extensions    = ["extconf.rb"]
+  gem.version       = "1.0.1"
+
+  gem.add_dependency 'ffi'
+end
+

data/rubyapi.rb

@@ -0,0 +1,30 @@
+require 'ffi'
+require 'rubyapi_ext'
+
+module RubyAPI
+  extend FFI::Library
+  ffi_lib FFI::CURRENT_PROCESS
+
+  class VALUE
+    extend FFI::DataConverter
+    native_type FFI::Type::POINTER
+
+    def self.from_native(value, ctx)
+      RubyAPI.from_native(super.address)
+    end
+
+    def self.to_native(value, ctx)
+      FFI::Pointer.new(RubyAPI.to_native(value))
+    end
+  end
+
+  typedef VALUE, :object
+end
+
+class Object
+  # This is a bit of a dangerous hack, as FFI will now accept any
+  # object as a pointer argument anywhere. This renders the FFI type
+  # checking useless for pointers.
+  def to_ptr
+  end
+end

data/rubyapi_ext.c

@@ -0,0 +1,34 @@
+#include <ruby.h>
+
+static VALUE to_native(VALUE self, VALUE value)
+{
+#if SIZEOF_VALUE == SIZEOF_LONG_LONG
+  return LL2NUM(value);
+#elif SIZEOF_VALUE == SIZEOF_LONG
+  return LONG2NUM(value);
+#elif SIZEOF_VALUE == SIZEOF_INT
+  return INT2NUM(value);
+#else
+  rb_raise(rb_eRuntimeError, "size of VALUE is %d", SIZEOF_VALUE);
+#endif
+}
+
+static VALUE from_native(VALUE self, VALUE value)
+{
+#if SIZEOF_VALUE == SIZEOF_LONG_LONG
+  return (VALUE) NUM2LL(value);
+#elif SIZEOF_VALUE == SIZEOF_LONG
+  return (VALUE) NUM2LONG(value);
+#elif SIZEOF_VALUE == SIZEOF_INT
+  return (VALUE) NUM2INT(value);
+#else
+  rb_raise(rb_eRuntimeError, "size of VALUE is %d", SIZEOF_VALUE);
+#endif
+}
+
+void Init_rubyapi_ext()
+{
+  VALUE rb_mCRuby = rb_define_module("RubyAPI");
+  rb_define_singleton_method(rb_mCRuby, "to_native", to_native, 1);
+  rb_define_singleton_method(rb_mCRuby, "from_native", from_native, 1);
+}

data/rubyapi_spec.rb

@@ -0,0 +1,35 @@
+$LOAD_PATH.unshift File.dirname(__FILE__)
+
+require 'rubyapi'
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'stringio'
+
+def capture_stdout
+  old_stdout, $stdout = $stdout, StringIO.new
+  yield
+  $stdout.rewind
+  $stdout.read
+ensure
+  $stdout = old_stdout
+end
+
+describe RubyAPI do
+  it "allows binding ruby C API" do
+    RubyAPI.attach_function :new_array, :rb_ary_new, [], :object
+    RubyAPI.new_array.must_equal []
+  end
+
+  it "runs the example from the README" do
+    RubyAPI.attach_function :new_array, :rb_ary_new, [], :object
+    RubyAPI.attach_function :inspect, :rb_p, [ :object ], :void
+
+    stdout = capture_stdout do
+      RubyAPI.inspect("Hello, world!")
+      RubyAPI.inspect(RubyAPI.new_array)
+    end
+
+    stdout.must_match /Hello, world!/
+    stdout.must_match "[]"
+  end
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: rubyapi
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Kim Burgestrand
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: &70339498764720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70339498764720
+description: 
+email:
+- kim@burgestrand.se
+executables: []
+extensions:
+- extconf.rb
+extra_rdoc_files: []
+files:
+- .gitignore
+- LICENSE
+- Makefile
+- README.md
+- Rakefile
+- extconf.rb
+- rubyapi.gemspec
+- rubyapi.rb
+- rubyapi_ext.c
+- rubyapi_spec.rb
+homepage: https://github.com/Burgestrand/rubyapi
+licenses:
+- Simplified BSD License
+post_install_message: 
+rdoc_options: []
+require_paths:
+- .
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: Access help to the Ruby C library from FFI
+test_files:
+- rubyapi_spec.rb
+has_rdoc: