matlab_ruby 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NDhiYTg2NGZjYWVjOGZkZTdkMmVlM2NjNGRmNjMwNzE4MjhmYzFmMQ==
+  data.tar.gz: !binary |-
+    NGI4Nzg0OTZjMzcyNmZmMTZhZDJjYzA2OGE5ZTBjODQxMTlkZTY2NQ==
+SHA512:
+  metadata.gz: !binary |-
+    N2EzZmMxYjNmODkxYzJlMzA1ZDM4NDBlNzQ5NTYyMWRmNWNmOGM1NTgxOGFi
+    Mzk5MTllNWI5MDBiYTBiMDc2ZDUyMWMyYWQ1NmViYmNlMzIyZGM0NTZiYTZl
+    NWY4NWYwODZjMTVjODU2NTE5MzIwZjRmNTg4YjYyYmFkOWE0MmM=
+  data.tar.gz: !binary |-
+    NjRlYzA2NzE4ZjNkNDZlYjYyNTI2OTliNDc2NmJkODQ0YTcxNmM4ZGUwM2I3
+    YWVmNmEzODFlZjJkYzcyOWU2ZjA5MDdlMWE1ZjY4NjVmOTJmMjA1OGMyY2U5
+    NWFjYTdhYTlmZTA5MWZjOTE2YjFjOWY4OGUxYWE4YzQ0ZjA1MTM=

data/.env.test

@@ -0,0 +1 @@
+MATLAB_RUBY_LIBS_PATH=/usr/local/MATLAB/R2014a/bin/glnxa64

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.idea
+examples.txt

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.ruby-gemset

@@ -0,0 +1 @@
+matlab_ruby

data/.ruby-version

@@ -0,0 +1 @@
+ruby-1.9.3-p547

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in matlab_ruby.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Panayotis Matsinopoulos
+
+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,77 @@
+# MatlabRuby #
+
+This is a Ruby interface to the [MATLAB Engine API](http://www.mathworks.com/help/matlab/calling-matlab-engine-from-c-c-and-fortran-programs.html)
+and to the [C/C++ Matrix Library API](http://www.mathworks.com/help/matlab/cc-mx-matrix-library.html).
+
+MATLAB needs to be installed and you need to know where the dynamically loaded library files are located. For example, in my installation (Ubuntu 14.04)
+MATLAB dlls are installed here: `/usr/local/MATLAB/R2014a/bin/glnxa64`
+
+## Installation ##
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'matlab_ruby'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install matlab_ruby
+
+## Usage ##
+
+Open the file `lib/matlab_ruby.rb` to see which functions of the APIs are interfaced via this gem. Not all functions are ready.
+
+### Initialize ###
+
+First you need to initialize the interface to the API implementations. 
+Call `.initialize` and give the path to the MATLAB libs directory:
+
+```
+MatlabRuby.initialize('/usr/local/MATLAB/R2014a/bin/glnxa64')
+```
+
+### Start Engine ###
+
+Then you need to start the MATLAB engine. 
+
+```
+matlab_engine = MatlabRuby.startEngine
+```
+
+### Call API Functions ###
+
+And now you are ready to call API functions.
+
+Example:
+```
+MatlabRuby.engEvalString matlab_engine, "x = 5;"
+
+x_var   = MatlabRuby.engGetVariable matlab_engine, "x"
+
+x_value = MatlabRuby.mxGetScalar(x_var)
+
+MatlabRuby.engEvalString(matlab_engine, "clearvars x;")
+
+puts "Value of 'x' is #{x_value}" # this should print out 5.0
+```
+
+## Tests ##
+
+In order to run the tests of this gem, you need to have the MATLAB engine installed and you need to have
+MATLAB_RUBY_LIBS_PATH environment variable set to the correct path to the MATLAB libs. You can do that inside the ".env.test" file
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/matlab_ruby. This project is intended to be a safe, welcoming space for collaboration, 
+and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+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
+
+task :default => :test

data/bin/console

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

data/bin/setup

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

data/lib/matlab_ruby.rb

@@ -0,0 +1,39 @@
+require "matlab_ruby/version"
+require "ffi"
+
+module MatlabRuby
+  extend FFI::Library
+
+  # This initializes with the directory of the matlab dynamically linked libraries
+  # E.g. /usr/local/MATLAB/R2014a/bin/glnxa64
+  #
+  def self.initialize(matlab_dll_dir = ENV['MATLAB_RUBY_LIBS_PATH'])
+    ffi_lib "#{matlab_dll_dir}/libeng.so"
+    attach_function :engOpen,         [:string], :pointer
+    attach_function :engClose,        [:pointer], :int
+    attach_function :engPutVariable,  [:pointer, :string, :pointer ], :int
+    attach_function :engGetVariable,  [:pointer, :string], :pointer
+    attach_function :engEvalString,   [:pointer, :string ], :int
+
+    ffi_lib "#{matlab_dll_dir}/libmx.so"
+    attach_function :mxGetNumberOfFields,  [:pointer], :int
+
+    attach_function :mxGetScalar, [:pointer], :double
+
+    attach_function :mxCreateDoubleMatrix, [:int, :int, :int], :pointer
+    attach_function :mxDestroyArray,       [:pointer], :void
+    attach_function :mxGetClassName,       [:pointer], :string
+
+    ffi_lib FFI::Library::LIBC
+    attach_function :malloc, [:size_t], :pointer
+    attach_function :free,   [:pointer], :void
+  end
+
+  def self.start_engine
+    engOpen "matlab -nosplash -nodisplay -nojvm"
+  end
+
+  def self.stop_engine(engine_ref)
+    engClose engine_ref
+  end
+end

data/lib/matlab_ruby/version.rb

@@ -0,0 +1,3 @@
+module MatlabRuby
+  VERSION = "0.1.0"
+end

data/matlab_ruby.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'matlab_ruby/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "matlab_ruby"
+  spec.version       = MatlabRuby::VERSION
+  spec.authors       = ["Panayotis Matsinopoulos"]
+  spec.email         = ["panayotis@matsinopoulos.gr"]
+
+  spec.summary       = "A Ruby interface to MATLAB Engine API."
+  spec.description   =<<-SHORT_DESCRIPTION
+This gem allows you to build a MATLAB Engine Application, a.k.a. a Ruby application that embeds a MATLAB Engine. This is all done by interfacing the MATLAB Engine API.
+You can read more about the MATLAB Engine API here: http://www.mathworks.com/help/matlab/calling-matlab-engine-from-c-c-and-fortran-programs.html.
+  SHORT_DESCRIPTION
+  spec.homepage      = "https://github.com/pmatsinopoulos"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "ffi", "1.9.10"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "dotenv", "2.0.2"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: matlab_ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Panayotis Matsinopoulos
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-08-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.9.10
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.9.10
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! 'This gem allows you to build a MATLAB Engine Application, a.k.a. a
+  Ruby application that embeds a MATLAB Engine. This is all done by interfacing the
+  MATLAB Engine API.
+
+  You can read more about the MATLAB Engine API here: http://www.mathworks.com/help/matlab/calling-matlab-engine-from-c-c-and-fortran-programs.html.
+
+'
+email:
+- panayotis@matsinopoulos.gr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .env.test
+- .gitignore
+- .rspec
+- .ruby-gemset
+- .ruby-version
+- .travis.yml
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/matlab_ruby.rb
+- lib/matlab_ruby/version.rb
+- matlab_ruby.gemspec
+homepage: https://github.com/pmatsinopoulos
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A Ruby interface to MATLAB Engine API.
+test_files: []