yamlscript 0.0.16 → 0.1.34

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2f2590c97f31dc5e9da44345db05a6c5670c50fa9acd075c798c706ad1bfd9d4
-  data.tar.gz: c55d29ddf63979e7cdcbe6a567094c8d777f96b1084b333424eb0288b0b7ce74
+  metadata.gz: 2591c91f2c28552fedf3d3eed747049e3776b835b0761d81078b99bfb3539be1
+  data.tar.gz: f2484037d32174a29ecc9e01be62cbf2f3f2fa1c0485e8d87b5c64dbab9ec15c
 SHA512:
-  metadata.gz: 641d0cf012bf55db5a3b8d87ca73228bd60ad7c1780b72b0e70408b85df6b4456f8257fa0deeaec03d42c291d13471e09f2fd535e6eb452ed4ecad8ce8608eb2
-  data.tar.gz: '020280ad7ca3cd8cc36865b32427208587682ae32152e1fbdc29c151e7b3f06a26a591d21e744a4292f9881e00ac450cd5edfc2f6d0fb7d5384eb29bb344676b'
+  metadata.gz: 7c4d3a6d4da4674749869cc821eb5eeb0c9feca1b31dcd1a419d9ea41538b28232a852254e85b1ae3662c75b2fd748070fa2f74171aeaf4eb0ce13fbfbb3a982
+  data.tar.gz: c99ae20a38f1e3090371dee340331b00bfbd011896b42c08b03be8d26960fd17962e6a9d4e251a842e269a3454349af95faf0c7cf57fcf52817c6c86e4e06a05

data/.gitignore

@@ -4,6 +4,7 @@
 /coverage/
 /doc/
 /pkg/
+/.rake_tasks*
 /spec/reports/
 /tmp/
 /Gemfile.lock

data/Gemfile

@@ -6,3 +6,4 @@ source "https://rubygems.org"
 gemspec
 
 gem "rake", "~> 13.0"
+gem "minitest", "~> 5.20.0"

data/Makefile

@@ -0,0 +1,25 @@
+include ../common/base.mk
+include $(COMMON)/binding.mk
+
+RUBY := $(shell command -v bundle)
+
+RAKE_CMDS := \
+    build \
+    clean \
+    release \
+    test \
+
+#------------------------------------------------------------------------------
+
+ifdef RUBY
+update:
+	bundle install
+
+$(RAKE_CMDS)::
+	bundle exec rake $@
+
+endif
+
+clean::
+	$(RM) Gemfile.lock .rake_tasks*
+	$(RM) -r pkg

data/Rakefile

@@ -1,4 +1,13 @@
 # frozen_string_literal: true
 
 require "bundler/gem_tasks"
-task default: %i[]
+require "minitest/test_task"
+
+Minitest::TestTask.create(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.warning = false
+  t.test_globs = ["test/**/*_test.rb"]
+end
+
+task :default => :test

data/ReadMe.md

@@ -0,0 +1,140 @@
+YAMLScript
+==========
+
+Program in YAML
+
+
+## Synopsis
+
+```yaml
+#!/usr/bin/env ys-0
+
+defn main(name):
+  say: "Hello, $name!"
+```
+
+
+## Description
+
+YAMLScript is a functional programming language with a stylized YAML syntax.
+
+YAMLScript can be used for:
+
+* Writing new programs and applications
+  * Run with `ys file.ys`
+  * Or compile to binary executable with `ys -C file.ys`
+* Enhancing ordinary YAML files with new functional magics
+  * Import parts of other YAML files to any node
+  * String interpolation including function calls
+  * Any other functionality you can dream up!
+* Writing reusable shared libraries
+  * High level code instead of C
+  * Bindable to almost any programming language
+
+YAMLScript should be a drop-in replacement for your YAML loader!
+
+Most existing YAML files are already valid YAMLScript files.
+This means that YAMLScript works as a normal YAML loader, but can also evaluate
+functional expressions if asked to.
+
+Under the hood, YAMLScript code compiles to the Clojure programming language.
+This makes YAMLScript a complete functional programming language right out of
+the box.
+
+Even though YAMLScript compiles to Clojure, and Clojure compiles to Java, there
+is no dependency on Java or the JVM.
+YAMLScript is compiled to a native shared library (`libyamlscript.so`) that can
+be used by any programming language that can load shared libraries.
+
+To see the Clojure code that YAMLScript compiles to, you can use the YAMLScript
+command line utility, `ys`, to run:
+
+```text
+$ ys --compile file.ys
+```
+
+
+## Ruby Usage
+
+File `prog.rb`:
+
+```ruby
+require 'yamlscript'
+input = IO.read('file.ys')
+ys = YAMLScript.new
+data = ys.load(input)
+puts data
+```
+
+File `file.ys`:
+
+```yaml
+!yamlscript/v0
+
+name =: "World"
+
+=>::
+  foo: [1, 2, ! inc(41)]
+  bar:: load("other.yaml")
+  baz:: "Hello, $name!"
+```
+
+File `other.yaml`:
+
+```yaml
+oh: Hello
+```
+
+Run:
+
+```text
+$ ruby prog.rb
+{"foo"=>[1, 2, 42], "bar"=>{"oh"=>"Hello"}, "baz"=>"Hello, World!"}
+```
+
+
+## Installation
+
+You can install this module like any other Ruby module:
+
+```bash
+$ gem install yamlscript
+```
+
+but you will need to have a system install of `libyamlscript.so`.
+
+One simple way to do that is with:
+
+```bash
+$ curl https://yamlscript.org/install | sudo PREFIX=/usr/local bash
+```
+
+> Note: The above command will install the latest version of the YAMLScript
+command line utility, `ys`, and the shared library, `libyamlscript.so`, into
+`/usr/local/bin` and `/usr/local/lib` respectively.
+
+See https://github.com/yaml/yamlscript?#installing-yamlscript for more info.
+
+
+## See Also
+
+* [The YAMLScript Web Site](https://yamlscript.org)
+* [The YAMLScript Blog](https://yamlscript.org/blog)
+* [The YAMLScript Source Code](https://github.com/yaml/yamlscript)
+* [YAML](https://yaml.org)
+* [Clojure](https://clojure.org)
+
+
+## Authors
+
+* [Ingy döt Net](https://github.com/ingydotnet)
+* [Delon R.Newman](https://github.com/delonnewman)
+
+
+## License & Copyright
+
+Copyright 2022-2024 Ingy döt Net <ingy@ingy.net>
+
+This project is licensed under the terms of the `MIT` license.
+See [LICENSE](https://github.com/yaml/yamlscript/blob/main/License) for
+more details.

data/lib/yamlscript/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
-module Yamlscript
-  VERSION = "0.0.16"
+class YAMLScript
+  VERSION = "0.1.34"
 end

data/lib/yamlscript.rb

@@ -1,8 +1,109 @@
 # frozen_string_literal: true
 
-require_relative "yamlscript/version"
+# Copyright 2023-2024 Ingy dot Net
+# This code is licensed under MIT license (See License for details)
 
-module Yamlscript
-  class Error < StandardError; end
-  # Your code goes here...
+require 'fiddle'
+require 'fiddle/import'
+require 'json'
+
+require_relative 'yamlscript/version'
+
+# Ruby binding for the libyamlscript shared library.
+class YAMLScript
+  Error = Class.new(StandardError)
+
+  # TODO: This value is automatically updated by 'make bump'.
+  # The version number is used to find the correct shared library file.
+  # We currently only support binding to an exact version of libyamlscript.
+  YAMLSCRIPT_VERSION = '0.1.34'
+
+  # A low-level interface to the native library
+  module LibYAMLScript
+    extend Fiddle::Importer
+
+    def self.extension
+      case RUBY_PLATFORM
+      when /darwin/
+        'dylib'
+      when /linux/
+        'so'
+      else
+        raise Error, "Unsupported platform #{RUBY_PLATFORM} for yamlscript."
+      end
+    end
+
+    def self.filename
+      "libyamlscript.#{extension}.#{YAMLSCRIPT_VERSION}"
+    end
+
+    # Returns an array of library paths extracted from the LD_LIBRARY_PATH
+    # environment variable.
+    # If the environment variable is not set will return an array with
+    # `/usr/local/lib` only.
+    def self.ld_library_paths
+      env_value = ENV.fetch('LD_LIBRARY_PATH', '')
+      paths = env_value.split(':')
+      paths << '/usr/local/lib'
+    end
+
+    # Find the libyamlscript shared library file path
+    def self.path
+      name = filename
+      path = ld_library_paths.map {
+        |dir| File.join(dir, name) }.detect { |file| File.exist?(file)
+      }
+
+      raise Error, "Shared library file `#{name}` not found" unless path
+
+      path
+    end
+
+    dlload path
+
+    extern \
+      'int graal_create_isolate(void* params, void** isolate, void** thread)'
+    extern 'int graal_tear_down_isolate(void* thread)'
+    extern 'char* load_ys_to_json(void* thread, char* yamlscript)'
+  end
+
+  # Interface with the libyamlscript shared library.
+  #
+  # @example
+  #   require 'yamlscript'
+  #
+  #   YAMLScript.load(IO.read('file.ys'))
+  def self.load(ys_code, **options)
+    new(**options).load(ys_code)
+  end
+
+  attr_reader :options, :error
+
+  def initialize(**options)
+    # config not used yet
+    @options = options
+
+    # Create a new GraalVM isolate for life of the YAMLScript instance
+    @isolate = Fiddle::Pointer.malloc(Fiddle::SIZEOF_VOIDP)
+    @error = nil
+  end
+
+  # Compile and eval a YAMLScript string and return the result
+  def load(ys_code)
+    # Create a new GraalVM isolate thread for each call to load()
+    thread = Fiddle::Pointer.malloc(Fiddle::SIZEOF_VOIDP)
+    LibYAMLScript.graal_create_isolate(nil, @isolate.ref, thread.ref)
+
+    # Call 'load_ys_to_json' function in libyamlscript shared library
+    json_data = LibYAMLScript.load_ys_to_json(thread, ys_code)
+    resp = JSON.parse(json_data.to_s)
+    raise Error, 'Failed to tear down isolate' \
+      unless LibYAMLScript.graal_tear_down_isolate(thread).zero?
+    raise Error, @error['cause'] if (@error = resp['error'])
+    data = resp.fetch('data') do
+      raise Error, 'Unexpected response from libyamlscript'
+    end
+
+    data
+  end
 end

data/yamlscript.gemspec

@@ -4,9 +4,9 @@ require_relative "lib/yamlscript/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "yamlscript"
-  spec.version       = Yamlscript::VERSION
-  spec.authors       = ["Ingy döt Net"]
-  spec.email         = ["ingy@ingy.net"]
+  spec.version       = YAMLScript::VERSION
+  spec.authors       = ["Ingy döt Net", "Delon Newman"]
+  spec.email         = ["ingy@ingy.net", "contact@delonnewman.name"]
 
   spec.summary       = "Program in YAML"
   spec.description   = "Program in YAML"
@@ -15,18 +15,17 @@ Gem::Specification.new do |spec|
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage
-  spec.metadata["changelog_uri"] = "https://github.com/yaml/yamlscript/tree/main/ruby/ChangeLog.md"
+  spec.metadata["changelog_uri"] = \
+    "https://github.com/yaml/yamlscript/tree/main/ruby/ChangeLog.md"
 
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+    `git ls-files -z`.split("\x0").reject {
+      |f| f.match(%r{\A(?:test|spec|features)/})
+    }
   end
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  # Uncomment to register a new dependency of your gem
-  # spec.add_dependency "example-gem", "~> 1.0"
-
-  # For more information and examples about making a new gem, checkout our
-  # guide at: https://bundler.io/guides/creating_gem.html
+  spec.add_dependency "minitest", "~> 5.20.0"
 end

metadata

@@ -1,18 +1,34 @@
 --- !ruby/object:Gem::Specification
 name: yamlscript
 version: !ruby/object:Gem::Version
-  version: 0.0.16
+  version: 0.1.34
 platform: ruby
 authors:
 - Ingy döt Net
+- Delon Newman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-08-01 00:00:00.000000000 Z
-dependencies: []
+date: 2024-01-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.20.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.20.0
 description: Program in YAML
 email:
 - ingy@ingy.net
+- contact@delonnewman.name
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -20,10 +36,9 @@ files:
 - ".gitignore"
 - ChangeLog.md
 - Gemfile
-- README.md
+- Makefile
 - Rakefile
-- bin/console
-- bin/setup
+- ReadMe.md
 - lib/yamlscript.rb
 - lib/yamlscript/version.rb
 - yamlscript.gemspec

data/README.md

@@ -1,35 +0,0 @@
-# Yamlscript
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/yamlscript`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'yamlscript'
-```
-
-And then execute:
-
-    $ bundle install
-
-Or install it yourself as:
-
-    $ gem install yamlscript
-
-## Usage
-
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/yamlscript.

data/bin/console

@@ -1,15 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require "bundler/setup"
-require "yamlscript"
-
-# 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(__FILE__)

data/bin/setup

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