sweet-moon 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 79d7b00c236a8ce4b85d6cb4230d7e4e9714b0e537199fa3445254c0577b5bfa
-  data.tar.gz: befd1ae3a4bcec8a274a256b5aab3c690cf876df1167531a896650b956e7dc58
+  metadata.gz: bdfabe100158948ea2c29fadca09e82cd9567d71230627f6bd0e8ba3a04f523d
+  data.tar.gz: 3bb2925b0ef437c3942a837a67bb94261d89c9aaf5a011973dcf4b98db07e6b9
 SHA512:
-  metadata.gz: 05ff924f37bab331deb03a55e21b968384fd7755cc38d8b4780b45ec5a14d21487df64df1dea2122c41ad4dedfb4e8013964e926a826537e713aa253b923be90
-  data.tar.gz: 8d1266390a693ef67f8bf5209eb5b2cf2b997bddb1e9f90ba5e2030fadd9ddf5819f2411099173b7a4528eafdcd09b7157675bcff77e3ca864fe600018085355
+  metadata.gz: 582a792771b05e59a577349070709e78bb2a569ef14cdb955fb2666e826eb401ba4aa4e7b19297c30fd64f98eda244d656caf2e904f9c1af95e971807aed8820
+  data.tar.gz: 38307987e564f998b40b2792fd97a3e107095d6e46992689663d63d67bf248dfc16c3a8838f8461bf7a8765857e7b5c04da4e4ac3c636cd6a419abb85bab2e5b

data/README.md

@@ -21,11 +21,13 @@ _Sweet Moon_ is a resilient solution that makes working with [Lua](https://www.l
     - [Tables, Arrays, and Hashes](#tables-arrays-and-hashes)
     - [Functions](#functions)
     - [Other Types](#other-types)
+    - [Lua Global vs Local Variables](#lua-global-vs-local-variables)
   - [_destroy_ and _clear_](#destroy-and-clear)
 - [Modules, Packages and LuaRocks](#modules-packages-and-luarocks)
   - [Integration with LuaRocks](#integration-with-luarocks)
 - [Fennel](#fennel)
   - [Fennel Usage](#fennel-usage)
+  - [Fennel Global vs Local Variables](#fennel-global-vs-local-variables)
   - [Fennel Setup](#fennel-setup)
   - [Integration with fnx](#integration-with-fnx)
 - [Global vs Isolated](#global-vs-isolated)
@@ -69,7 +71,7 @@ gem install sweet-moon
 > **Disclaimer:** It's an early-stage project, and you should expect breaking changes.
 
 ```ruby
-gem 'sweet-moon', '~> 0.0.3'
+gem 'sweet-moon', '~> 0.0.4'
 ```
 
 ```ruby
@@ -209,6 +211,7 @@ Compared to: [rufus-lua](https://github.com/jmettraux/rufus-lua), [YAML](https:/
   - [Tables, Arrays, and Hashes](#tables-arrays-and-hashes)
   - [Functions](#functions)
   - [Other Types](#other-types)
+  - [Lua Global vs Local Variables](#lua-global-vs-local-variables)
 - [_destroy_ and _clear_](#destroy-and-clear)
 
 ### Setup
@@ -389,6 +392,20 @@ state.eval('lua_value = {a = "text", b = 1.5, c = true}') # => nil
 state.get(:lua_value, :b) # => 1.5
 ```
 
+With `set`, you can use a second parameter to set a field:
+
+```ruby
+require 'sweet-moon'
+
+state = SweetMoon::State.new
+
+state.set(:myTable, {}) # => nil
+
+state.set(:myTable, :a, 3) # => nil
+
+state.eval('return myTable["a"]') # => 3
+```
+
 Caveats:
 
 - Ruby `Symbol` (e.g. `:value`) is converted to Lua `string`.
@@ -512,6 +529,24 @@ fennel_eval = state.get(:fennel_eval)
 fennel_eval.(['(+ 1 1)']) # => 2
 ```
 
+#### Lua Global vs Local Variables
+
+You can't exchange _local_ variables, only [_global_](https://www.lua.org/pil/1.2.html) ones:
+
+```ruby
+require 'sweet-moon'
+
+state = SweetMoon::State.new
+
+state.eval('lua_value = "Lua Text"') # => nil
+
+state.get('lua_value') # => 'Lua Text'
+
+state.eval('local lua_b = "b"') # => nil
+
+state.get('lua_b') # => nil
+```
+
 ## _destroy_ and _clear_
 
 You can destroy a state:
@@ -714,8 +749,8 @@ state = SweetMoon::State.new
 
 state.fennel.eval('(+ 1 2)') # => 3
 
-state.fennel.eval('(global mySum (fn [a b] (+ a b)))')
-state.fennel.eval('(mySum 2 3)') # => 5
+state.fennel.eval('(set _G.mySum (fn [a b] (+ a b)))')
+state.fennel.eval('(_G.mySum 2 3)') # => 5
 
 mySum = state.fennel.get(:mySum)
 
@@ -725,7 +760,7 @@ sum_list = -> (list) { list.sum }
 
 state.set('sumList', sum_list) # => nil
 
-state.fennel.eval('(sumList [2 3 5])') # => 10
+state.fennel.eval('(_G.sumList [2 3 5])') # => 10
 
 state.fennel.load('file.fnl')
 ```
@@ -740,6 +775,49 @@ state = SweetMoon::State.new.fennel
 state.eval('(+ 1 2)') # => 3
 ```
 
+### Fennel Global vs Local Variables
+
+Fennel encourages you to explicitly use the [_`_G`_](https://www.lua.org/manual/5.4/manual.html#pdf-_G) table to access global variables:
+
+```ruby
+require 'sweet-moon'
+
+fennel = SweetMoon::State.new.fennel
+
+fennel.eval('(set _G.a? 2)')
+
+fennel.get('a?') # => 2
+fennel.get('_G', 'a?') # => 2
+
+fennel.set('b', 3)
+
+fennel.eval('(print _G.b)') # => 3
+```
+
+Although older versions have the expression `(global name "value")`, it's deprecated, and you should avoid using that. _Sweet Moon_ has no commitments in supporting this deprecated expression, and you should prefer the `_G` way.
+
+As is [true for Lua](#lua-global-vs-local-variables), you can't exchange _local_ variables, only [_global_](https://www.lua.org/pil/1.2.html) ones:
+
+```ruby
+require 'sweet-moon'
+
+fennel = SweetMoon::State.new.fennel
+
+fennel.eval('(local name "value")')
+
+fennel.get('name') # => nil
+
+fennel.eval('(set _G.name "value")')
+
+fennel.get('name') # => "value"
+
+fennel.set('var-b', 35) # => nil
+
+fennel.eval('var-b') # => nil
+
+fennel.eval('_G.var-b') # => 35
+```
+
 ### 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/components/interpreters/50/interpreter.rb

@@ -38,8 +38,13 @@ module Component
         { state: state, error: Interpreter[:_error].(api, state, result, pull: true) }
       },
 
-      set_table!: ->(api, state, variable, value) {
-        Table[:set!].(api, state, variable, value)
+      set_table!: ->(api, state) {
+        result = api.lua_settable(state[:lua], -3)
+
+        api.lua_settop(state[:lua], -2)
+
+        { state: state,
+          error: Interpreter[:_error].(api, state, result, pull: false) }
       },
 
       push_value!: ->(api, state, value) {
@@ -55,12 +60,19 @@ module Component
       },
 
       get_variable_and_push!: ->(api, state, variable, key = nil) {
+        extra_pop = true
+        if variable == '_G'
+          variable = key
+          key = nil
+          extra_pop = false
+        end
+
         api.lua_pushstring(state[:lua], variable.to_s)
         api.lua_gettable(state[:lua], Logic::V50::Interpreter[:LUA_GLOBALSINDEX])
 
         Table[:read_field_and_push!].(api, state, key, -1) unless key.nil?
 
-        { state: state }
+        { state: state, extra_pop: extra_pop }
       },
 
       call!: ->(api, state, inputs = 0, outputs = 1) {

data/components/interpreters/50/table.rb

@@ -45,7 +45,7 @@ module Component
 
           tuples << [key[:value], value[:value]]
 
-          break if value[:type] == 'no value'
+          break if value[:type] == 'no value' || key[:value].instance_of?(Proc)
         end
 
         { value: Logic::Tables[:to_hash_or_array].(tuples), pop: true }
@@ -78,7 +78,7 @@ module Component
             break
           end
 
-          break if value[:type] == 'no value'
+          break if value[:type] == 'no value' || key[:value].instance_of?(Proc)
         end
 
         api.lua_settop(state[:lua], -2)

data/components/interpreters/51/interpreter.rb

@@ -31,8 +31,13 @@ module Component
         { state: state, error: Interpreter[:_error].(api, state, result, pull: true) }
       },
 
-      set_table!: ->(api, state, variable, value) {
-        Table[:set!].(api, state, variable, value)
+      set_table!: ->(api, state) {
+        result = api.lua_settable(state[:lua], -3)
+
+        api.lua_settop(state[:lua], -2)
+
+        { state: state,
+          error: Interpreter[:_error].(api, state, result, pull: false) }
       },
 
       push_value!: ->(api, state, value) {
@@ -60,7 +65,7 @@ module Component
           end
         end
 
-        { state: state }
+        { state: state, extra_pop: true }
       },
 
       call!: ->(api, state, inputs = 0, outputs = 1) {

data/components/interpreters/51/table.rb

@@ -45,7 +45,7 @@ module Component
 
           tuples << [key[:value], value[:value]]
 
-          break if value[:type] == 'no value'
+          break if value[:type] == 'no value' || key[:value].instance_of?(Proc)
         end
 
         { value: Logic::Tables[:to_hash_or_array].(tuples), pop: true }

data/components/interpreters/54/interpreter.rb

@@ -30,8 +30,13 @@ module Component
         { state: state, error: Interpreter[:_error].(api, state, result, pull: true) }
       },
 
-      set_table!: ->(api, state, variable, value) {
-        Table[:set!].(api, state, variable, value)
+      set_table!: ->(api, state) {
+        result = api.lua_settable(state[:lua], -3)
+
+        api.lua_settop(state[:lua], -2)
+
+        { state: state,
+          error: Interpreter[:_error].(api, state, result, pull: false) }
       },
 
       push_value!: ->(api, state, value) {
@@ -56,7 +61,7 @@ module Component
           end
         end
 
-        { state: state }
+        { state: state, extra_pop: true }
       },
 
       call!: ->(api, state, inputs = 0, outputs = 1) {

data/config/tests.sample.yml

@@ -1,5 +1,7 @@
 # Available at https://github.com/gbaptista/sweet-moon-test
 
+fennel-dev: '/home/me/sweet-moon-test/fennel-dev.lua'
+
 luarocks:
   path:
     - /home/me/.luarocks/share/lua/5.4/?.lua

data/controllers/state.rb

@@ -26,23 +26,48 @@ module Controller
     },
 
     get!: ->(api, interpreter, state, variable, key = nil) {
+      if key.nil?
+        key = variable
+        variable = '_G'
+      end
+
+      State[:_get_key!].(api, interpreter, state, variable, key)
+    },
+
+    _get_key!: ->(api, interpreter, state, variable, key) {
       result = State[:_check!].(
         interpreter[:get_variable_and_push!].(api, state, variable, key)
       )
 
-      result = State[:_check!].(interpreter[:read_and_pop!].(
-                                  api, result[:state], -1, extra_pop: !key.nil?
-                                ))
+      result = State[:_check!].(
+        interpreter[:read_and_pop!].(
+          api, result[:state], -1, extra_pop: result[:extra_pop]
+        )
+      )
 
       { state: result[:state], output: result[:output] }
     },
 
-    set!: ->(api, interpreter, state, variable, value) {
-      result = State[:_check!].(interpreter[:push_value!].(api, state, value))
-
-      result = State[:_check!].(
-        interpreter[:pop_and_set_as!].(api, result[:state], variable.to_s)
-      )
+    set!: ->(api, interpreter, state, variable, key_or_value, value = nil) {
+      if value.nil?
+        result = State[:_check!].(interpreter[:push_value!].(api, state,
+                                                             key_or_value))
+
+        result = State[:_check!].(
+          interpreter[:pop_and_set_as!].(api, result[:state], variable.to_s)
+        )
+      else
+        result = State[:_check!].(
+          interpreter[:get_variable_and_push!].(api, state, variable)
+        )
+
+        result = State[:_check!].(interpreter[:push_value!].(api, result[:state],
+                                                             key_or_value))
+        result = State[:_check!].(interpreter[:push_value!].(api, result[:state],
+                                                             value))
+
+        result = State[:_check!].(interpreter[:set_table!].(api, result[:state]))
+      end
 
       { state: result[:state], output: result[:output] }
     },

data/dsl/fennel.rb

@@ -11,6 +11,9 @@ module DSL
         'table.insert(package.loaders or package.searchers, fennel.searcher)'
       )
 
+      # TODO: Makes sense?
+      # debug.traceback = fennel.traceback
+
       @eval = @state.get(:fennel, :eval)
       @dofile = @state.get(:fennel, :dofile)
       @version = @state.get(:fennel, :version)

data/dsl/state.rb

@@ -34,8 +34,10 @@ module DSL
       @controller[:get!].(@api, @interpreter, state, variable, key)[:output]
     end
 
-    def set(variable, value)
-      @controller[:set!].(@api, @interpreter, state, variable, value)[:output]
+    def set(variable, key_or_value, value = nil)
+      @controller[:set!].(
+        @api, @interpreter, state, variable, key_or_value, value
+      )[:output]
     end
 
     def destroy

data/logic/interpreters/interpreter_50.rb

@@ -6,6 +6,7 @@ module Logic
       LUA_REGISTRYINDEX: -10_000,
       LUA_GLOBALSINDEX: -10_001,
 
+      # lua_isinteger lua_pushinteger lua_tointeger
       requires: %i[
         lua_close lua_gettable lua_gettop lua_insert lua_newtable lua_next lua_open
         lua_pcall lua_pushboolean lua_pushcclosure lua_pushnil lua_pushnumber

data/logic/interpreters/interpreter_54.rb

@@ -12,11 +12,11 @@ module Logic
 
       # lua_isinteger lua_pushinteger lua_tointeger
       requires: %i[
-        lua_close lua_createtable lua_getfield lua_getglobal lua_gettop lua_next
-        lua_pcall lua_pushboolean lua_pushcclosure lua_pushnil lua_pushnumber
-        lua_pushstring lua_rawgeti lua_setglobal lua_settable lua_settop lua_toboolean
-        lua_tonumber lua_topointer lua_tostring lua_type lua_typename luaL_loadfile
-        luaL_loadstring luaL_newstate luaL_openlibs luaL_ref
+        lua_close lua_createtable lua_getfield lua_gettop lua_next lua_pcall
+        lua_pushboolean lua_pushcclosure lua_pushnil lua_pushnumber lua_pushstring
+        lua_rawgeti lua_settable lua_settop lua_toboolean lua_tonumber lua_topointer
+        lua_tostring lua_type lua_typename luaL_loadfile luaL_loadstring luaL_newstate
+        luaL_openlibs luaL_ref lua_getglobal lua_setglobal
       ],
 
       status: {

data/logic/spec.rb

@@ -2,7 +2,7 @@ module Logic
   Spec = {
     name: 'sweet-moon',
     command: 'sweet-moon',
-    version: '0.0.3',
+    version: '0.0.4',
     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.3
+  version: 0.0.4
 platform: ruby
 authors:
 - gbaptista
 autorequire:
 bindir: ports/in/shell
 cert_chain: []
-date: 2022-03-23 00:00:00.000000000 Z
+date: 2022-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi