yamlscript 0.1.63 → 0.1.66

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3da6f600df76247fb3fcd7602f1fcc163da3e96fc87a1ec64c8c95745134dcb9
-  data.tar.gz: ba628d1011eac23136d83af8b8d1dcd8a3fe456f14302d349ce1d36591a47722
+  metadata.gz: 4898a2bea185c4fa8ae98c0fdcf7feeeea91c364d8f05f53223a91d0e2220154
+  data.tar.gz: e01d3805540211046aa6e7a03a41fdb152e404e33786b8c156a1f863507819ea
 SHA512:
-  metadata.gz: 92f9822e4327d475e6553fdf23a75f41cb1b2bcba4fcdc8e4c5d0036780d8b95ab26ad71071f34318cd47eda019aa9474665d60c8ed1dc48f6eba788149fa263
-  data.tar.gz: 894cce3e9a6be5793ddbf738ab204c58cc1a5630f8f2c4c60986c41cab02a2b86d292b23da113edd53cc4539aac0fbc87a182fe72b706d2e672a3da6c961ac57
+  metadata.gz: 0b0019ed6ceb0d12b9f2944146ed68bec7f4f2cabaff8fc7c51ad0bc764e4254ece1b10d2def1f6880a4852ba4f83e946cee0d63ad4320cbeb0807f1d181d247
+  data.tar.gz: 0e100b1565aa7d0697656c00ee4f56d7a5c97f1a71bf3ef3fca598f833574cfcdc04ceb84326481f0466c210d4faa1f96e02c2f43f8d0c030acf267b8e08fbd2

data/ChangeLog.md

@@ -1,3 +1,15 @@
+## [0.1.66] - 2024-07-11
+
+- libyamlscript 0.1.66
+
+## [0.1.65] - 2024-07-06
+
+- libyamlscript 0.1.65
+
+## [0.1.64] - 2024-07-04
+
+- libyamlscript 0.1.64
+
 ## [0.1.63] - 2024-06-19
 
 - libyamlscript 0.1.63

data/Makefile

@@ -9,8 +9,13 @@ RAKE_CMDS := \
     release \
     test \
 
+
 #------------------------------------------------------------------------------
 
+build:: build-doc
+
+build-doc:: ReadMe.md
+
 ifdef RUBY
 update:
 	bundle install

data/ReadMe.md

@@ -1,37 +1,54 @@
+<!-- DO NOT EDIT — THIS FILE WAS GENERATED -->
+
 YAMLScript
 ==========
 
-Program in YAML
+Add Logic to Your YAML Files
 
 
 ## Synopsis
 
+Load `file.yaml` with YAMLScript:
 ```yaml
-#!/usr/bin/env ys-0
+!yamlscript/v0/
+
+=>:
+  names =: curl(
+    "https://raw.githubusercontent.com/dominictarr/" +
+    "random-name/master/first-names.json")
+    .json/load()
+
+name:: names.rand-nth()
+aka:: names.rand-nth()
+age:: 6 * 7
+color: yellow
+```
 
-defn main(name='world'):
-  say: "Hello, $name!"
+and get:
+```json
+{
+  "name": "Anthea",
+  "aka": "Patrizia",
+  "age": 42,
+  "color": "yellow"
+}
 ```
 
 
 ## Description
 
-YAMLScript is a functional programming language with a stylized YAML syntax.
+[YAMLScript](https://yamlscript.org) is a functional programming language with a
+clean YAML syntax.
 
-YAMLScript can be used for:
+YAMLScript can be used for enhancing ordinary [YAML](https://yaml.org) files
+with functional operations, such as:
 
-* 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
+* Import parts of other YAML files to any node
+* String interpolation including function calls
+* Data transforms including ones defined by you
 
-YAMLScript should be a drop-in replacement for your YAML loader!
+This YAMLScript library should be a drop-in replacement for your current 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
@@ -47,10 +64,18 @@ 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:
+CLI binary, `ys`, to run:
 
 ```text
 $ ys --compile file.ys
+(def names
+  (_-> (curl (+_ "https://raw.githubusercontent.com/dominictarr/"
+                 "random-name/master/first-names.json"))
+       (list json/load)))
+{"age" (*_ 6 7),
+ "aka" (_-> names (list rand-nth)),
+ "color" "yellow",
+ "name" (_-> names (list rand-nth))}
 ```
 
 
@@ -118,15 +143,18 @@ 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)
+* [YAMLScript Web Site](https://yamlscript.org)
+* [YAMLScript Blog](https://yamlscript.org/blog)
+* [YAMLScript Source Code](https://github.com/yaml/yamlscript)
+* [YAMLScript Samples](https://github.com/yaml/yamlscript/tree/main/sample)
+* [YAMLScript Programs](https://rosettacode.org/wiki/Category: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)
 

data/doc/authors.md

@@ -0,0 +1,2 @@
+* [Ingy döt Net](https://github.com/ingydotnet)
+* [Delon R.Newman](https://github.com/delonnewman)

data/doc/readme.md

@@ -0,0 +1,60 @@
+## 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 | bash
+```
+
+> Note: The above command will install the latest version of the YAMLScript
+command line utility, `ys`, and the shared library, `libyamlscript.so`, into
+`~/local/bin` and `~/.local/lib` respectively.
+
+See https://github.com/yaml/yamlscript?#installing-yamlscript for more info.

data/lib/yamlscript/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class YAMLScript
-  VERSION = "0.1.63"
+  VERSION = "0.1.66"
 end

data/lib/yamlscript.rb

@@ -16,7 +16,7 @@ class YAMLScript
   # 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.63'
+  YAMLSCRIPT_VERSION = '0.1.66'
 
   # A low-level interface to the native library
   module LibYAMLScript

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yamlscript
 version: !ruby/object:Gem::Version
-  version: 0.1.63
+  version: 0.1.66
 platform: ruby
 authors:
 - Ingy döt Net
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-06-19 00:00:00.000000000 Z
+date: 2024-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -39,6 +39,8 @@ files:
 - Makefile
 - Rakefile
 - ReadMe.md
+- doc/authors.md
+- doc/readme.md
 - lib/yamlscript.rb
 - lib/yamlscript/version.rb
 - yamlscript.gemspec