rufus-lua 1.1.0 → 1.1.1

data/CHANGELOG.txt

@@ -2,6 +2,23 @@
 = rufus-lua CHANGELOG.txt
 
 
+== rufus-lua - 1.1.1    released 2014/07/01
+
+- move from bacon to rspec
+- remove double VERSION (Nathanael Jones - https://github.com/nathanaeljones)
+- load only one Lua lib (Thanks Nathanael)
+- add Rufus::Lua::Lib.path to learn which Lua lib got loaded (idea Nathanael)
+- set `ffi_lib_flags(:lazy, :global)` before loading Lua (thanks Nathanael)
+- fix panic error when creating new Rufus::Lua::State with specific
+  list of lib to load (fix by Matthew Nielsen - https://github.com/xunker)
+- read back Lua strings containing \0 bytes (thanks Nathanael Jones)
+- let Ruby strings containing \0 bytes go to the Lua side freely (thanks NJ)
+- enhanced Rufus::Lua::LuaError by adding filename and lineno - based on
+  a suggestion by Nathanael Jones)
+- enhanced Rufus::Lua::State#eval by adding optional 'filename' and 'lineno'
+  arguments (like Kernel.eval) (hint by Nathanael Jones)
+
+
 == rufus-lua - 1.1.0    released 2009/09/30
 
 - todo      : Ruby symbols are passed to Lua as strings (Scott)

data/CREDITS.txt

@@ -4,11 +4,16 @@
 
 == authors
 
-John Mettraux  http://jmettraux.wordpress.com
+John Mettraux  http://jmettraux.lambda.io
 Alain Hoang  http://blogs.law.harvard.edu/hoanga/
-Scott Persinger  http://github.com/scottpersinger
+Scott Persinger  https://github.com/scottpersinger
 
 
+== contributors
+
+Matthew Nielsen  https://github.com/xunker
+Nathanael Jones  https://github.com/nathanaeljones
+
 == inspiration
 
   http://rubyluabridge.rubyforge.org/

data/LICENSE.txt

@@ -1,5 +1,5 @@
 
-Copyright (c) 2009, John Mettraux, Alain Hoang.
+Copyright (c) 2009-2014, John Mettraux, Alain Hoang.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -0,0 +1,263 @@
+
+# rufus-lua
+
+[![Gem Version](https://badge.fury.io/rb/rufus-lua.png)](http://badge.fury.io/rb/rufus-lua)
+
+Lua embedded in Ruby, via Ruby FFI.
+
+(Lua 5.1.x only, sorry).
+
+
+## Lua
+
+http://www.lua.org/about.html says :
+
+
+> Lua is a powerful, fast, lightweight, embeddable scripting language.
+>
+> Lua combines simple procedural syntax with powerful data description
+> constructs based on associative arrays and extensible semantics. Lua is
+> dynamically typed, runs by interpreting bytecode for a register-based
+> virtual machine, and has automatic memory management with incremental
+> garbage collection, making it ideal for configuration, scripting, and
+> rapid prototyping.
+
+http://www.lua.org/
+
+
+## other Ruby and Lua bridges / connectors
+
+* https://github.com/glejeune/ruby-lua by Gregoire Lejeune
+* http://rubyluabridge.rubyforge.org/ by Evan Wies
+* https://github.com/whitequark/rlua by Peter Zotov
+
+
+## getting Lua on your system
+
+On Debian GNU/Linux, I do
+
+```
+sudo apt-get install liblua5.1-0
+```
+
+If your system's package manager doesn't have some version (5.1.x) of Lua around, jump to [compiling liblua.dylib](#compiling-libluadylib) below.
+
+Rufus-lua will look for library in a [list of know places](https://github.com/jmettraux/rufus-lua/blob/9ddf26cde9f4a73115032504ad7f7eb688849b73/lib/rufus/lua/lib.rb#L38-L50).
+
+If it doesn't find the Lua dynamic library or if it picks the wrong one, it's OK to set the `LUA_LIB` environment variable. For example:
+
+```bash
+LUA_LIB=~/mystuff/lualib.5.1.4.so ruby myluacode.rb
+```
+or
+```bash
+export LUA_LIB=~/mystuff/lualib.5.1.4.so
+# ...
+ruby myluacode.rb
+```
+
+
+
+## using rufus-lua
+
+```
+gem install rufus-lua
+```
+
+or add to your Gemfile:
+
+```ruby
+  gem 'rufus-lua'
+```
+
+then
+
+```ruby
+require 'rufus-lua'
+
+s = Rufus::Lua::State.new
+
+puts s.eval("return table.concat({ 'hello', 'from', 'Lua' }, ' ')")
+  #
+  # => "Hello from Lua"
+
+s.close
+```
+
+
+### binding Ruby code as Lua functions
+
+```ruby
+require 'rufus-lua'
+
+s = Rufus::Lua::State.new
+
+s.function 'key_up' do |table|
+  table.inject({}) do |h, (k, v)|
+    h[k.to_s.upcase] = v
+  end
+end
+
+p s.eval(%{
+  local table = { CoW = 2, pigs = 3, DUCKS = 'none' }
+  return key_up(table) -- calling Ruby from Lua...
+}).to_h
+  # => { 'COW' => 2.0, 'DUCKS => 'none', 'PIGS' => 3.0 }
+
+s.close
+```
+
+
+It's OK to bind a function inside of a table (library):
+
+```ruby
+require 'rufus-lua'
+
+s = Rufus::Lua::State.new
+
+s.eval("rubies = {}")
+s.function 'add' do |x, y|
+  x + y
+end
+
+s.eval("rubies.add(1, 2)")
+  # => 3.0
+
+s.close
+```
+
+
+You can omit the table definition (only 1 level allowed here though):
+
+```ruby
+require 'rufus-lua'
+
+s = Rufus::Lua::State.new
+
+s.function 'rubies.add' do |x, y|
+  x + y
+end
+
+s.eval("rubies.add(1, 2)")
+  # => 3.0
+
+s.close
+```
+
+
+The specs contain more examples:
+
+https://github.com/jmettraux/rufus-lua/tree/master/spec/
+
+
+### eval(code[, binding[, filename[, lineno ]]])
+
+The examples so far have shown `Rufus::Lua::State#eval` being used with a single argument, a piece of code.
+
+But this rufus-lua eval mimics the Ruby `eval` and lets one specify binding, filename and lineno.
+
+(TODO) Binding hasn't yet been implemented. It'll probaby be with `setfenv` but nothing sure yet. Stick a `nil` to it for now.
+
+The string of Lua code may come from wild places, it may help to flag it with arbitrary filename and lineno.
+
+```ruby
+require 'rufus-lua'
+
+lua = Rufus::Lua::State.new
+
+lua.eval('print("hello")', nil, 'myluastuff/hello.lua', 77)
+```
+
+
+## compiling liblua.dylib
+
+original instructions by Adrian Perez at:
+
+http://lua-users.org/lists/lua-l/2006-09/msg00894.html
+
+get the source at:
+
+http://www.lua.org/ftp/lua-5.1.4.tar.gz
+
+then
+
+```
+tar xzvf lua-5.1.4.tar.gz
+cd lua-5.1.4
+```
+
+Modify the file `src/Makefile` as per http://lua-users.org/lists/lua-l/2006-09/msg00894.html
+
+It's mostly about adding that rule to the `src/Makefile`:
+```make
+liblua.dylib: $(CORE_O) $(LIB_O)
+	$(CC) -dynamiclib -o $@ $^ $(LIBS)
+```
+
+Here's how to build the library file and deploy it:
+```
+make
+make macosx # or make linux ...
+make -C src liblua.dylib
+sudo cp src/liblua.dylib /usr/local/lib/
+
+sudo make macosx install
+```
+
+I tend to copy the lib with
+
+```
+sudo cp src/liblua.dylib /usr/local/lib/liblua.5.1.4.dylib
+
+# instead of
+#sudo cp src/liblua.dylib /usr/local/lib/
+```
+
+
+## tested with
+
+ruby 1.8.7p72, ruby 1.9.1p0, jruby 1.2.0
+jruby 1.1.6 has an issue with errors raised inside of Ruby functions (callbacks)
+
+ruby-ffi 0.4.0 and 0.5.0
+
+I run the specs with
+
+```
+bundle install # first time only
+bundle exec rspec
+```
+
+
+## dependencies
+
+the ruby gem 'ffi'
+
+
+## issue tracker
+
+http://github.com/jmettraux/rufus-lua/issues
+
+
+## source
+
+http://github.com/jmettraux/rufus-lua
+
+```
+git clone git://github.com/jmettraux/rufus-lua.git
+```
+
+
+## authors and credits
+
+see [CREDITS.txt](CREDITS.txt)
+
+
+## license
+
+MIT
+
+Lua itself is licensed under the MIT license as well :
+
+http://www.lua.org/license.html
+

data/Rakefile

@@ -0,0 +1,82 @@
+
+$:.unshift('.') # 1.9.2
+
+require 'rake'
+require 'rake/clean'
+require 'rspec/core/rake_task'
+
+
+#
+# clean
+
+CLEAN.include('pkg', 'rdoc')
+
+
+#
+# test / spec
+
+RSpec::Core::RakeTask.new
+
+task :test => :spec
+task :default => :spec
+
+
+#
+# gem
+
+GEMSPEC_FILE = Dir['*.gemspec'].first
+GEMSPEC = eval(File.read(GEMSPEC_FILE))
+GEMSPEC.validate
+
+
+desc %{
+  builds the gem and places it in pkg/
+}
+task :build do
+
+  sh "gem build #{GEMSPEC_FILE}"
+  sh "mkdir pkg" rescue nil
+  sh "mv #{GEMSPEC.name}-#{GEMSPEC.version}.gem pkg/"
+end
+
+desc %{
+  builds the gem and pushes it to rubygems.org
+}
+task :push => :build do
+
+  sh "gem push pkg/#{GEMSPEC.name}-#{GEMSPEC.version}.gem"
+end
+
+
+##
+## rdoc
+##
+## make sure to have rdoc 2.5.x to run that
+#
+#Rake::RDocTask.new do |rd|
+#
+#  rd.main = 'README.txt'
+#  rd.rdoc_dir = "rdoc/#{GEMSPEC.name}"
+#
+#  rd.rdoc_files.include('README.mdown', 'CHANGELOG.txt', 'lib/**/*.rb')
+#
+#  rd.title = "#{GEMSPEC.name} #{GEMSPEC.version}"
+#end
+#
+#
+##
+## upload_rdoc
+#
+#desc %{
+#  upload the rdoc to rubyforge
+#}
+#task :upload_rdoc => [ :clean, :rdoc ] do
+#
+#  account = 'jmettraux@rubyforge.org'
+#  webdir = '/var/www/gforge-projects/rufus'
+#
+#  sh "rsync -azv -e ssh rdoc/#{GEMSPEC.name} #{account}:#{webdir}/"
+#end
+  #
+  # keep that in the fridge for now
+

data/lib/rufus/lua.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2009, John Mettraux, Alain Hoang.
+# Copyright (c) 2009-2014, John Mettraux, Alain Hoang.
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -22,8 +22,11 @@
 # Made in Japan.
 #++
 
+require 'rufus/lua/version'
+
 require 'rufus/lua/lib'
 
+require 'rufus/lua/error'
 require 'rufus/lua/state'
 require 'rufus/lua/utils'
 require 'rufus/lua/objects'

data/lib/rufus/lua/error.rb

@@ -0,0 +1,86 @@
+#--
+# Copyright (c) 2009-2014, John Mettraux, Alain Hoang.
+#
+# 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.
+#
+# Made in Japan.
+#++
+
+
+module Rufus::Lua
+
+  #
+  # An error class for rufus-lua.
+  #
+  class LuaError < RuntimeError
+
+    attr_reader :kind, :errcode, :msg
+    attr_reader :binding, :filename, :lineno
+
+    attr_reader :original_backtrace
+
+    def initialize(kind, errcode, msg, binding, filename, lineno)
+
+      super("#{kind} : '#{msg}' (#{errcode})")
+
+      @kind = kind
+      @errcode = errcode
+      @msg = msg
+
+      @binding = binding
+      @filename = filename
+      @lineno = lineno
+    end
+
+    def filename
+
+      return @filename if @filename
+
+      m = CALLER_REX.match(backtrace.first || '')
+      return m ? m[1] : nil
+    end
+
+    def lineno
+
+      return @lineno if @lineno
+
+      m = CALLER_REX.match(backtrace.first || '')
+      return m ? m[2].to_i : -1
+    end
+
+    def set_backtrace(trace)
+
+      @original_backtrace = trace
+
+      trace =
+        trace.select { |line|
+          m = CALLER_REX.match(line)
+          ( ! m) || File.dirname(m[1]) != DIR
+        }
+
+      trace.insert(0, "#{@filename}:#{@lineno}:") if @filename
+
+      super(trace)
+    end
+
+    CALLER_REX = /^(.+):(\d+):/
+    DIR = File.dirname(__FILE__)
+  end
+end
+