sweet-moon 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e1ed99acf5622e7a68168e97a5543a952da6cbd057b29d35dcac167cdd7ed3e
-  data.tar.gz: 30ffaf5cd2c96429114950db5e44c39c328cdefeb711df44eba1d5b288d34a1e
+  metadata.gz: 7bc6ba34912c2d5c9e26b95b385e4a992b186b6adbe81e40e0e6068cc363a948
+  data.tar.gz: 751f266193c94b533cf8f0b38f99745870688a2efd01e5277bb25d0aafe4b314
 SHA512:
-  metadata.gz: 375db63fb25932d6d1e0d1fda599c996a62efd2f51691528785e34b2bba37078dcb98db1f05f669375759852671cf0792aed27110fea91e8d351406ba219823f
-  data.tar.gz: bd4732726abfb6f8ce2dcf0b4bc81d858bb03d9cde60610f0e02372e29c2951cf47f2b2d6cebd3f2eb5d25b23daa29ec6097f8603e578d4dfcd572486b3c1eee
+  metadata.gz: 1fac3cd35cc1afd5cf1918f98326237203f9e12c631ccde66946a6496d24d90e69cf06a43413b1f58527c486f81f50098d7d866547389936becac5b6ba8eda84
+  data.tar.gz: e14b5c3eecbdeefa68747f4b2cf8377c0b99289783bfd5dd3eec5c295368bea65eca70be594f4272777cbd811ecdb6a3fef36ce73103349831072d44851a51bb

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2022 Guilherme Baptista
+
+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

@@ -1,4 +1,5 @@
 # Sweet Moon
+[![Gem Version](https://badge.fury.io/rb/sweet-moon.svg)](https://badge.fury.io/rb/sweet-moon)
 
 _Sweet Moon_ is a resilient solution that makes working with [Lua](https://www.lua.org) / [Fennel](https://fennel-lang.org) from [Ruby](https://www.ruby-lang.org) and vice versa a delightful experience.
 
@@ -26,6 +27,7 @@ _Sweet Moon_ is a resilient solution that makes working with [Lua](https://www.l
 - [Fennel](#fennel)
   - [Fennel Usage](#fennel-usage)
   - [Fennel Setup](#fennel-setup)
+  - [Integration with fnx](#integration-with-fnx)
 - [Global vs Isolated](#global-vs-isolated)
 - [Error Handling](#error-handling)
 - [Where can I find .so files?](#where-can-i-find-so-files)
@@ -38,6 +40,9 @@ _Sweet Moon_ is a resilient solution that makes working with [Lua](https://www.l
     - [Lua 5.4](#lua-54)
     - [Lua 4.0](#lua-40)
 - [Development](#development)
+  - [Tests Setup](#tests-setup)
+  - [Running](#running)
+  - [Supporting New Versions](#supporting-new-versions)
 
 ## Supported Versions
 
@@ -64,7 +69,7 @@ gem install sweet-moon
 > **Disclaimer:** It's an early-stage project, and you should expect breaking changes.
 
 ```ruby
-gem 'sweet-moon', '~> 0.0.1'
+gem 'sweet-moon', '~> 0.0.2'
 ```
 
 ```ruby
@@ -552,8 +557,8 @@ require 'sweet-moon'
 
 state = SweetMoon::State.new
 
-state.eval('package.path = package.path .. ";/my-modules/?.lua"')
-state.eval('package.cpath = package.cpath .. ";/my-modules/?.so"')
+state.eval('package.path = "/my-modules/?.lua;" .. package.path')
+state.eval('package.cpath = "/my-modules/?.so;" .. package.cpath')
 
 state.eval('some_package = require("my_module")')
 ```
@@ -682,7 +687,7 @@ For global:
 ```ruby
 require 'sweet-moon'
 
-SweetMoon.global.config.new(
+SweetMoon.global.config(
   package_path: [
     '/home/me/.luarocks/share/lua/5.4/?.lua',
     '/home/me/.luarocks/share/lua/5.4/?/init.lua'
@@ -783,6 +788,28 @@ SweetMoon.global.config(package_path: '/folder/fennel.lua')
 SweetMoon.global.state.fennel.eval('(+ 1 1)') # => 2
 ```
 
+### Integration with fnx
+
+[fnx](https://github.com/gbaptista/fnx) is a package manager for the Fennel language.
+
+After installing `fnx` and configuring it for [_Embedding_](https://github.com/gbaptista/fnx#embedding), you can:
+
+```ruby
+require 'sweet-moon'
+
+fennel = SweetMoon::State.new.fennel
+
+fennel.eval('(let [fnx (require :fnx)] (fnx.bootstrap!))')
+```
+
+Done. It will automatically inject all your dependencies according to your `.fnx.fnl` file, similar to using the `fnx` command.
+
+To enforce the path for the `.fnx.fnl` file:
+
+```ruby
+fennel.eval('(let [fnx (require :fnx)] (fnx.bootstrap! "/project/.fnx.fnl"))')
+```
+
 ## Global vs Isolated
 
 You can use the **global** helper that provides an _API_ and a _State_ for quick-and-dirty coding. It uses internally a Ruby [_Singleton_](https://docs.ruby-lang.org/en/3.1/Singleton.html):
@@ -821,8 +848,8 @@ You may want to use an isolated API for scenarios like interacting with two Lua
 ```ruby
 require 'sweet-moon'
 
-api_5 = SweetMoon.global.config(shared_object: '/usr/lib/liblua5.s')
-api_3 = SweetMoon.global.config(shared_object: '/usr/lib/liblua3.so')
+api_5 = SweetMoon::API.new(shared_object: '/usr/lib/liblua5.s')
+api_3 = SweetMoon::API.new(shared_object: '/usr/lib/liblua3.so')
 
 api_5.luaL_newstate
 
@@ -882,7 +909,7 @@ require 'sweet-moon'
 
 begin
   SweetMoon.global.state.eval('return 1 + true')
-rescue SweetMoon::Errors::LuaSyntaxError => error
+rescue SweetMoon::Errors::LuaRuntimeError => error
   puts error.message
   # => [string "return 1 + true"]:1: attempt to perform arithmetic on a boolean value
 end
@@ -896,7 +923,7 @@ require 'sweet-moon/errors'
 
 begin
   SweetMoon.global.state.eval('return 1 + true')
-rescue LuaSyntaxError => error
+rescue LuaRuntimeError => error
   puts error.message
   # => [string "return 1 + true"]:1: attempt to perform arithmetic on a boolean value
 end
@@ -904,9 +931,9 @@ end
 
 ## Where can I find .so files?
 
-Due to the Lua's popularity, you likely have it already on your system, and _Sweet Moon_ will be able to find the files on its own.
+Due to the Lua's popularity, you likely have it already on your system, and _Sweet Moon_ will be able to find the files by itself.
 
-Either way, you can download it from this page:
+Either way, you can download it from:
 - [Lua Binaries](http://luabinaries.sourceforge.net)
 - [LuaJIT releases](http://luajit.org/download.html)
 
@@ -1138,6 +1165,26 @@ rubocop -a
 rspec
 ```
 
+### Tests Setup
+
+To setup tests:
+
+```
+cp config/tests.sample.yml config/tests.yml
+```
+
+Clone the [sweet-moon-test](https://github.com/gbaptista/sweet-moon-test) repo somewhere:
+
+```sh
+git clone git@github.com:gbaptista/sweet-moon-test.git
+```
+
+Update the [`config/tests.yml`](https://github.com/gbaptista/sweet-moon/blob/main/config/tests.sample.yml) accordingly.
+
+Alternatively: Find or build the _Shared Objects_ for your Operating System on your own.
+
+### Running
+
 ```sh
 ./ports/in/shell/sweet-moon version
 
@@ -1147,3 +1194,21 @@ bundle exec sweet-moon signatures /lua/lib/542 542.rb
 
 bundle exec ruby some/file.rb
 ```
+
+### Supporting New Versions
+
+Download both the source code and the libraries.
+
+Example: For [Lua 5.4.2](https://sourceforge.net/projects/luabinaries/files/5.4.2/), you would download _"Linux Libraries"_ and _"Docs and Sources."_
+
+Extract everything to a folder, e.g., `lua-542-source-libs`.
+
+Run the command to extract the signatures:
+
+```shell
+bundle exec sweet-moon signatures /home/me/lua-542-source-libs 542.rb
+```
+
+Check the `542.rb` file for the output and then start coding.
+
+You can use the [`logic/signatures`](https://github.com/gbaptista/sweet-moon/tree/main/logic/signatures) folder as a reference starting point.

data/config/tests.sample.yml

@@ -1,15 +1,54 @@
+# Available at https://github.com/gbaptista/sweet-moon-test
+
 luarocks:
   - /home/me/.luarocks/share/lua/5.4/?.lua
   - /home/me/.luarocks/share/lua/5.4/?/init.lua
   - /home/me/.luarocks/lib/lua/5.4/?.so
 
+jit:2.0.5:
+  description: 'Lua Jit 2.0.5 + Fennel 1.0.0'
+  shared_object: /home/me/sweet-moon-test/libluajit.so.2.0.5
+  fennel: /home/me/sweet-moon-test/fennel-100.lua
+
 5.4.4:
   description: 'Lua 5.4.4 + Fennel 1.0.0'
-  shared_object: /resources/liblua.so.5.4.4
-  fennel: /resources/fennel.lua
+  shared_object: /home/me/sweet-moon-test/liblua.so.5.4.4
+  fennel: /home/me/sweet-moon-test/fennel-100.lua
+
+5.4.2:
+  description: 'Lua 5.4.2 + Fennel 1.0.0'
+  shared_object: /home/me/sweet-moon-test/liblua.so.5.4.2
+  fennel: /home/me/sweet-moon-test/fennel-100.lua
+
+5.3.3:
+  description: 'Lua 5.3.3'
+  shared_object: /home/me/sweet-moon-test/liblua.so.5.3.3
+  fennel: /home/me/sweet-moon-test/fennel-100.lua
+
+5.2.4:
+  description: 'Lua 5.2.4'
+  shared_object: /home/me/sweet-moon-test/liblua.so.5.2.4
+  fennel: /home/me/sweet-moon-test/fennel-100.lua
+
+5.1.5:
+  description: 'Lua 5.1.5'
+  shared_object: /home/me/sweet-moon-test/liblua.so.5.1.5
+  fennel: /home/me/sweet-moon-test/fennel-100.lua
+
+5.0.3:
+  description: 'Lua 5.0.3'
+  shared_object: /home/me/sweet-moon-test/liblua.so.5.0.3
 
 4.0.1:
   description: 'Lua 4.0.1'
   shared_objects:
-    - /resources/liblua.so.4.0.1
-    - /resources/liblualib.so.4.0.1
+    - /home/me/sweet-moon-test/liblua.so.4.0.1
+    - /home/me/sweet-moon-test/liblualib.so.4.0.1
+
+3.2.2:
+  description: 'Lua 3.2.2'
+  shared_object: /home/me/sweet-moon-test/liblua.so.3.2.2
+
+'?':
+  description: 'Lua ?'
+  shared_object: /home/me/sweet-moon-test/liblua.so

data/dsl/concerns/packages.rb

@@ -9,7 +9,7 @@ module DSL
         paths = path
         paths = [path] unless paths.is_a? Array
 
-        self.eval("#{target} = #{target} .. \";#{paths.join(';')}\"")
+        self.eval("#{target} = \"#{paths.join(';')};\" .. #{target}")
       end
 
       def package_path(target = 'package.path')

data/logic/spec.rb

@@ -2,11 +2,14 @@ module Logic
   Spec = {
     name: 'sweet-moon',
     command: 'sweet-moon',
-    version: '0.0.1',
+    version: '0.0.2',
     author: 'gbaptista',
-    summary: 'Lua / Fennel from Ruby and vice versa.',
+    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.',
     description: 'A resilient solution that makes working with Lua / Fennel from ' \
-                 'Ruby and vice versa a delightful experience.',
+                 "Ruby and vice versa a delightful experience.\n\n" \
+                 'Support to LuaJIT, Lua 5.0, and 5.1. Lua C API for Lua 5, 4, ' \
+                 'and 3. LuaRocks and fnx integration.',
     github: 'https://github.com/gbaptista/sweet-moon',
     license: 'MIT'
   }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sweet-moon
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - gbaptista
 autorequire:
 bindir: ports/in/shell
 cert_chain: []
-date: 2022-03-20 00:00:00.000000000 Z
+date: 2022-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -30,8 +30,10 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.15.5
-description: A resilient solution that makes working with Lua / Fennel from Ruby and
-  vice versa a delightful experience.
+description: |-
+  A resilient solution that makes working with Lua / Fennel from Ruby and vice versa a delightful experience.
+
+  Support to LuaJIT, Lua 5.0, and 5.1. Lua C API for Lua 5, 4, and 3. LuaRocks and fnx integration.
 email:
 executables:
 - sweet-moon
@@ -43,6 +45,7 @@ files:
 - ".rubocop.yml"
 - Gemfile
 - Gemfile.lock
+- LICENSE
 - README.md
 - components/api.rb
 - components/injections.rb
@@ -133,5 +136,6 @@ requirements: []
 rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
-summary: Lua / Fennel from Ruby and vice versa.
+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.
 test_files: []