sweet-moon 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46891cd3e8103176f3f909415432df155df1bd33cbed89a80f0042f5d303a2b7
-  data.tar.gz: af7617e43eacc588135285dbd652f644d9bda8b87735c86ff89a7719ce6bfe1a
+  metadata.gz: 880cceae5913b9a748b5b318bfc27c56ccf58d7ae54b7f31f8aeea943c524aac
+  data.tar.gz: ab2abc87ef9ead4ea7be474963a92ad647326ec6d4ad1bfec62ed20d103d4e4c
 SHA512:
-  metadata.gz: 1949e5f83c00dd65cdf78e2e8ebd4f66654dc24df1769add99ad8f01e75cc97bcb090e9d0dc0cf5d10dcdd4d1d338252b4ad78894bd3d4cef40b91ae31aab3d0
-  data.tar.gz: 9a09f1231c7e02250f232e368abd95b7bb1b4d5e366ef2614ce9871248c49201fb480b8b698833df66d769e7688602e8c3415a454366ef5ad3ede02163e1c5a4
+  metadata.gz: 1b613dba97c24527e3e71a8bd7c6d14cd98edcd9a0083a85463a3300f05886a81da33ea5c515108fe523ed43ab012760954edd40dacec4aa38a250e6846b3906
+  data.tar.gz: c8c09f0f1bc7cde58c789975b84491399af843b8d95cb69bd3600dbb4c22a056f232e99eea50d3af969ebea6fa298bd86214a596d7ab67afe5c4a209d8a43fa3

data/README.md

@@ -28,6 +28,7 @@ _Sweet Moon_ is a resilient solution that makes working with [Lua](https://www.l
 - [Fennel](#fennel)
   - [Fennel Usage](#fennel-usage)
   - [Fennel Global vs Local Variables](#fennel-global-vs-local-variables)
+  - [allowedGlobals and options](#allowedglobals-and-options)
   - [Fennel Setup](#fennel-setup)
   - [Integration with fnx](#integration-with-fnx)
   - [Fennel REPL](#fennel-repl)
@@ -74,7 +75,7 @@ gem install sweet-moon
 > **Disclaimer:** It's an early-stage project, and you should expect breaking changes.
 
 ```ruby
-gem 'sweet-moon', '~> 0.0.6'
+gem 'sweet-moon', '~> 0.0.7'
 ```
 
 ```ruby
@@ -445,6 +446,16 @@ second = state.get(:second)
 second.([%w[a b c]]) # => 'b'
 ```
 
+Alternatively, you can send the `outputs` parameter:
+
+```ruby
+require 'sweet-moon'
+
+state = SweetMoon::State.new
+
+state.eval('return "a", "b"', { outputs: 2 }) # => ['a', 'b']
+```
+
 You can call Ruby _Lambdas_ from _Lua_ as well:
 
 ```ruby
@@ -821,6 +832,71 @@ fennel.eval('var-b') # => nil
 fennel.eval('_G.var-b') # => 35
 ```
 
+### allowedGlobals and options
+
+As Lua, Fennel functions may return [multiple results](https://www.lua.org/pil/5.1.html), so `eval` and `load` accept a second parameter to indicate the expected number of outputs:
+
+```fnl
+; source.fnl
+
+(fn multi [] (values "c" "d"))
+
+(multi)
+```
+
+```ruby
+require 'sweet-moon'
+
+fennel = SweetMoon::State.new.fennel
+
+fennel.eval('(values "a" "b")', 2) # => ['a', 'b']
+fennel.load('source.fnl', 2) # => ['c', 'd']
+```
+
+The Fennel API offers [some options](https://fennel-lang.org/api) that `eval` and `load` accept as a third parameter:
+
+```ruby
+require 'sweet-moon'
+
+fennel = SweetMoon::State.new.fennel
+
+fennel.eval('(print (+ 2 3))', 1, { allowedGlobals: ['print'] }) # => 5
+
+fennel.eval('(print (+ 2 3))', 1, { allowedGlobals: [] })
+# Compile error in unknown:1 (SweetMoon::Errors::LuaRuntimeError)
+#   unknown identifier in strict mode: print
+
+# (print (+ 2 3))
+#  ^^^^^
+# * Try looking to see if there's a typo.
+# * Try using the _G table instead, eg. _G.print if you really want a global.
+# * Try moving this code to somewhere that print is in scope.
+# * Try binding print as a local in the scope of this code.
+```
+
+Alternatively, you can use the second parameter for options as well:
+
+```ruby
+require 'sweet-moon'
+
+fennel = SweetMoon::State.new.fennel
+
+fennel.eval('(print (+ 2 3))', { allowedGlobals: ['print'] }) # => 5
+```
+
+You can also specify the expected outputs in the options parameter (it will be removed and not forwarded to Fennel):
+
+```ruby
+require 'sweet-moon'
+
+fennel = SweetMoon::State.new.fennel
+
+fennel.eval(
+  '(values "a" "b")',
+  { allowedGlobals: ['values'], outputs: 2 }
+) # => ['a', 'b']
+```
+
 ### Fennel Setup
 
 To ensure that the Fennel module is available, you can set up the [_LuaRocks_](#integration-withluarocks) integration or manually add the `package_path` for the module.

data/config/tests.sample.yml

@@ -1,6 +1,6 @@
 # Available at https://github.com/gbaptista/sweet-moon-test
 
-fennel-dev: '/home/me/sweet-moon-test/fennel/dev/?.lua'
+fennel-dev: '/home/gbaptista/Fennel/?.lua'
 
 luarocks:
   expected: ['dkjson', 'supernova', 'readline']

data/dsl/fennel.rb

@@ -20,12 +20,16 @@ module DSL
       build_meta
     end
 
-    def eval(input, outputs = 1)
-      @eval.([input], outputs)
+    def eval(input, first = nil, second = nil)
+      options = _build_options(first, second)
+
+      @eval.([input, options[:options]], options[:outputs])
     end
 
-    def load(path, outputs = 1)
-      @dofile.([path], outputs)
+    def load(path, first = nil, second = nil)
+      options = _build_options(first, second)
+
+      @dofile.([path, options[:options]], options[:outputs])
     end
 
     def build_meta

data/dsl/state.rb

@@ -28,11 +28,19 @@ module DSL
     end
 
     def eval(input, outputs = 1)
-      @controller[:eval!].(@api, @interpreter, state, input, outputs)[:output]
+      options = _build_options(outputs, nil)
+
+      @controller[:eval!].(
+        @api, @interpreter, state, input, options[:outputs]
+      )[:output]
     end
 
     def load(path, outputs = 1)
-      @controller[:load!].(@api, @interpreter, state, path, outputs)[:output]
+      options = _build_options(outputs, nil)
+
+      @controller[:load!].(
+        @api, @interpreter, state, path, options[:outputs]
+      )[:output]
     end
 
     def get(variable, key = nil)
@@ -56,6 +64,22 @@ module DSL
       nil
     end
 
+    def _build_options(first, second)
+      options = { outputs: 1 }
+
+      options = options.merge(first) if first.is_a? Hash
+      options = options.merge(second) if second.is_a? Hash
+
+      options[:outputs] = first if first.is_a? Numeric
+      options[:outputs] = second if second.is_a? Numeric
+
+      outputs = options[:outputs] if options[:outputs]
+
+      options.delete(:outputs)
+
+      { options: options, outputs: outputs }
+    end
+
     def _ensure_min_version!(purpose, lua, jit = nil)
       version = lua
       version = jit if meta.interpreter[/jit/] && jit
@@ -113,8 +137,7 @@ module DSL
 
     def state
       unless @state
-        raise SweetMoon::Errors::SweetMoonError,
-              'The state no longer exists.'
+        raise SweetMoon::Errors::SweetMoonError, 'The state no longer exists.'
       end
 
       @state

data/logic/spec.rb

@@ -2,7 +2,7 @@ module Logic
   Spec = {
     name: 'sweet-moon',
     command: 'sweet-moon',
-    version: '0.0.6',
+    version: '0.0.7',
     author: 'gbaptista',
     summary: 'Lua / Fennel from Ruby and vice versa. Support to LuaJIT, Lua 5.0, ' \
              'and 5.1. Lua C API for Lua 5, 4, and 3. LuaRocks and fnx integration.',

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sweet-moon
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - gbaptista
 autorequire:
 bindir: ports/in/shell
 cert_chain: []
-date: 2022-03-27 00:00:00.000000000 Z
+date: 2022-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi