gemstone_ruby 0.1.2

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.DS_Store
+coverage
+Gemfile.lock
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 GemTalk Systems, LLC
+
+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,4 @@
+gemstone_ruby
+=============
+
+Ruby FFI for GemStone/S 64 Bit C Library

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test

data/bin/gemstone_ruby

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+require 'gemstone_ruby'

data/gemstone_ruby.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "gemstone_ruby/version"
+
+Gem::Specification.new do |s|
+  s.name          = 'gemstone_ruby'
+  s.version       = GemStone::VERSION
+  s.summary       = "GemStone/S FFI"
+  s.description   = "FFI for GemStone/S 64 Bit 3.1.0.4"
+  s.authors       = ["James Foster"]
+  s.email         = 'github@jgfoster.net'
+  s.homepage      = 'https://github.com/jgfoster/gemstone_ruby'
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  s.license       = 'MIT'
+  s.add_runtime_dependency "ffi", [">= 1.9.0"]
+end

data/lib/gemstone_ruby.rb

@@ -0,0 +1,2 @@
+require 'gemstone_ruby/base.rb'
+require 'gemstone_ruby/version.rb'

data/lib/gemstone_ruby/base.rb

@@ -0,0 +1,134 @@
+
+require 'ffi'    # Foreign Function Interface
+
+module GemStone
+  extend FFI::Library
+  gciVersion = "3.1.0.4"
+  ffi_lib [
+    "gcirpc-#{ gciVersion }-64",       # this must be in LD_LIBRARY_PATH
+    File.expand_path("../../../bin/libgcirpc-#{ gciVersion }-64.so", __FILE__),
+    File.expand_path("../../../bin/libgcirpc-#{ gciVersion }-64.dylib", __FILE__)
+  ]
+  
+  OOP_NIL = 20
+  OOP_CLASS_STRING = 74753
+  
+  typedef :uint64, :OopType
+  typedef :int32, :GciSessionIdType
+  
+  attach_function :GciErr,          [:pointer                             ], :bool
+  attach_function :GciExecuteStr,   [:string, :OopType                    ], :OopType, :blocking => true
+  attach_function :GciFetchChars_,  [:OopType, :uint64, :pointer, :uint64 ], :uint64
+  attach_function :GciFetchClass,   [:OopType                             ], :OopType
+  attach_function :GciFetchObjImpl, [:OopType                             ], :uint8
+  attach_function :GciFetchSize_,   [:OopType                             ], :uint64
+  attach_function :GciGetSessionId, [                                     ], :GciSessionIdType
+  attach_function :GciHardBreak,    [                                     ], :void
+  attach_function :GciInit,         [                                     ], :bool
+  attach_function :GciLogin,        [:string, :string                     ], :bool, :blocking => true
+  attach_function :GciLogout,       [                                     ], :void
+  attach_function :GciOopToBool,    [:OopType                             ], :bool
+  attach_function :GciOopToChar32,  [:OopType                             ], :uint32
+  attach_function :GciOopToFlt,     [:OopType                             ], :double
+  attach_function :GciOopToI64,     [:OopType                             ], :int64
+  attach_function :GciSetNet,       [:string, :string, :string, :string   ], :void
+  attach_function :GciSetSessionId, [:GciSessionIdType                    ], :void
+  attach_function :GciShutdown,     [                                     ], :void
+  attach_function :GciSoftBreak,    [                                     ], :void
+  attach_function :GciVersion,      [                                     ], :string
+  
+  def GemStone.login(options={})
+    options[:stone]    ||= "gs64stone"
+    options[:gemnet]   ||= "!tcp@localhost#netldi:gs64ldi#task!gemnetobject"
+    options[:user]     ||= "DataCurator"
+    options[:password] ||= "swordfish"
+    GemStone.GciSetNet(options[:stone], nil, nil, options[:gemnet])
+    if (!GemStone.GciLogin(options[:user], options[:password]))
+      raise GemStone.gciError()[:message]
+    end
+    return GciGetSessionId()  
+  end
+  
+
+  def GemStone.executeString(string)
+    oopValue = GemStone.GciExecuteStr(string, OOP_NIL)
+    oop = OopType.new(oopValue)
+    if oop.isNil;          return nil;      end
+    if oop.isTrue;         return true;     end
+    if oop.isFalse;        return false;    end
+    if oop.isCharacter;    return oop.to_s; end
+    if oop.isSmallDouble;  return oop.to_f; end
+    if oop.isSmallInteger; return oop.to_i; end
+    if oop.isString;    return oop.to_s;    end
+    return oop
+  end
+  
+  def GemStone.gciError()
+    gciError = GemStone::GciErrSType.new
+    haveErrorFlag = GemStone.GciErr(gciError)
+    return haveErrorFlag ? gciError : nil
+  end
+
+  
+  class GciErrSType < FFI::Struct
+    layout :category,     :OopType,  
+           :context,      :OopType,
+           :exceptionObj, :OopType,
+           :args,        [:OopType, 10],
+           :number,       :uint32,
+           :argCount,     :uint32,
+           :fatal,        :uint8,
+           :message,     [:char, 1025],
+           :reason,      [:char, 1025]
+  end
+  
+  class OopType
+    def initialize(value)
+      @value = value
+    end
+    
+    def isBoolean;      return isFalse | isTrue;                                    end
+    def isBytes;        return GemStone.GciFetchObjImpl(@value) === 1;              end
+    def isCharacter;    return @value & 255 === 28;                                 end  
+    def isFalse;        return @value === 12;                                       end
+    def isIllegal;      return @value === 2;                                        end
+    def isImmediate;    return 0 < @value & 6;                                      end  
+    def isNil;          return @value === 20;                                       end
+    def isSmallDouble;  return @value & 7 === 6;                                    end
+    def isSmallInteger; return @value & 7 === 2;                                    end
+    def isString;       return GemStone.GciFetchClass(@value) === OOP_CLASS_STRING; end
+    def isTrue;         return @value === 268;                                      end
+    
+    def to_f
+      if !isSmallDouble;  return nil;  end
+      return GemStone.GciOopToFlt(@value)
+    end
+    
+    def to_i
+      if !isSmallInteger;  return nil;  end
+      return GemStone.GciOopToI64(@value)
+    end
+    
+    def to_s
+      if isNil;         return "nil";     end
+      if isTrue;        return "true";    end
+      if isFalse;       return "false";   end
+      if isSmallDouble; return to_f.to_s; end
+      if isCharacter
+        return GemStone.GciOopToChar32(@value).chr
+      end
+      if isString
+        expectedSize = GemStone.GciFetchSize_(@value)
+        memory = FFI::MemoryPointer.new(expectedSize + 1)
+        actualSize = GemStone.GciFetchChars_(@value, 1, memory, expectedSize + 1)
+        if (expectedSize != actualSize)
+          raise "expected = #{ expectedSize }; actual = #{ actualSize }"
+        end
+        return memory.get_string(0)
+      end
+      return "OOP(#{ @value.to_s })"
+    end
+  end
+end
+
+GemStone.GciInit

data/lib/gemstone_ruby/version.rb

@@ -0,0 +1,3 @@
+module GemStone
+  VERSION = "0.1.2"
+end

data/test/test_gemstone_ruby.rb

@@ -0,0 +1,69 @@
+
+require "gemstone_ruby"
+require "test/unit"
+
+class TC_GciLibrary < Test::Unit::TestCase
+
+  def test_character
+    assert_equal("a", GemStone.executeString("$a"))
+  end
+  
+  def test_failLogin
+    assert_equal(1, GemStone.GciGetSessionId());
+    assert(!GemStone.GciLogin("badUser", "swordfish"))
+    assert(!GemStone.GciLogin("DataCurator", "badPassword"))
+    GemStone.GciSetSessionId(1)
+  end
+  
+  def test_false
+    assert_equal(false, GemStone.executeString("false"))
+  end
+  
+  def test_hardBreak    # this also tests non-blocking
+    Thread.new do
+      sleep 0.01
+      GemStone.GciHardBreak
+    end
+    object = GemStone.executeString("(Delay forSeconds: 1) wait. true")
+    assert_equal(nil, object)
+    gciError = GemStone.gciError()
+    assert_equal(6004, gciError[:number])
+  end
+  
+  def test_nil
+    assert_equal(nil, GemStone.executeString("nil"))
+  end
+  
+  def test_smallDouble
+    assert_equal(2.5, GemStone.executeString("2.5"))
+  end
+  
+  def test_softBreak    # this also tests non-blocking
+    Thread.new do
+      sleep 0.01
+      GemStone.GciSoftBreak
+    end
+    object = GemStone.executeString("(Delay forSeconds: 1) wait. true")
+    assert_equal(nil, object)
+    gciError = GemStone.gciError()
+    assert_equal(6003, gciError[:number])
+  end
+  
+  def test_smallInteger
+    assert_equal(5, GemStone.executeString("2 + 3"))
+  end
+  
+  def test_string
+    assert_equal("720", GemStone.executeString("6 factorial printString"))
+  end
+  
+  def test_true
+    assert_equal(true, GemStone.executeString("true"))
+  end
+  
+  def test_version
+    assert_equal(String, GemStone.GciVersion().class)
+  end
+end
+
+GemStone.login()

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: gemstone_ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+  prerelease: 
+platform: ruby
+authors:
+- James Foster
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.9.0
+description: FFI for GemStone/S 64 Bit 3.1.0.4
+email: github@jgfoster.net
+executables:
+- gemstone_ruby
+- libgcirpc-3.1.0.4-64.dylib
+- libssl-3.1.0.4-64.dylib
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/gemstone_ruby
+- bin/libgcirpc-3.1.0.4-64.dylib
+- bin/libssl-3.1.0.4-64.dylib
+- gemstone_ruby.gemspec
+- lib/gemstone_ruby.rb
+- lib/gemstone_ruby/base.rb
+- lib/gemstone_ruby/version.rb
+- test/test_gemstone_ruby.rb
+homepage: https://github.com/jgfoster/gemstone_ruby
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: GemStone/S FFI
+test_files:
+- test/test_gemstone_ruby.rb