jsonnet 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e1eae86ab6c46d74404411fd29d877109116617170f2423738623f067eef21b1
-  data.tar.gz: ec239abefc2eaf068b36736bdfc0ef1cc7202538418575c6c19cbb077c1152d9
+  metadata.gz: 2872d26e221e6ec8bbd30265edd0109eb9f1c68fa19fcfaa888c9921f096f771
+  data.tar.gz: b91f326aa5a64a97f9f088a17b6462e8cf77d8e82679c11231cc68eff2b495e5
 SHA512:
-  metadata.gz: 85538d0bec2ffba85010a2058b2652bb5fc59bacafe25dc2628bab9f2eb379041f8e3271273a76493b2608bd11f60494e8ab4ef0e55c57eed02272d5d024b453
-  data.tar.gz: 6ec195d4487be4c68914081f3c83786f254d64f8da61ee7413a73a642e0e46f2d9943540534136ba1dcda69c23308485666a5fa235813e0e7bed6252f3b6e0fe
+  metadata.gz: dab85234e40a4b05ae60a4fe7423af108df27b9e3d2db119e6d18edb40f9abbb92c20a5cf7c25fb5d20e3a090031fae42ec93fab135ea3c6682adaf3ec006693
+  data.tar.gz: 8aea3bbab4b7661a4ee6d055bd6fdd9b5c0834feae98f266b5d162563b860b932689f4fcd4096a3f2dcdf12fb5e960b2fbb7f7e65ce23d1d177d5f85128dbb56

data/.travis.yml

@@ -1,16 +1,19 @@
 language: ruby
-dist: trusty
+dist: xenial
 script: bundle exec rake test
 
 matrix:
   include:
   - os: linux
-    rvm: 2.3.4
+    rvm: 2.5.8
   - os: osx
-    rvm: 2.3.4
+    rvm: 2.5.8
   - os: linux
-    rvm: 2.4.0
+    rvm: 2.6.6
   - os: osx
-    rvm: 2.4.0
+    rvm: 2.6.6
+  - os: linux
+    rvm: 2.7.2
+  - os: osx
+    rvm: 2.7.2
   fast_finish: true
-

data/README.md

@@ -24,7 +24,7 @@ Or install it yourself as:
 $ gem install jsonnet
 ```
 
-By default this gem will compile and install Jsonnet (v0.10.0) as part of
+By default this gem will compile and install Jsonnet (v0.16.0) as part of
 installation. However you can use the system version of Jsonnet if you prefer.
 This would be the recommended route if you want to use a different version
 of Jsonnet or are having problems installing this.

data/ext/jsonnet/extconf.rb

@@ -13,8 +13,8 @@ unless using_system_libraries?
   require 'mini_portile2'
   message "Using mini_portile version #{MiniPortile::VERSION}\n"
 
-  recipe = MiniPortile.new('jsonnet', 'v0.10.0')
-  recipe.files = ['https://github.com/google/jsonnet/archive/v0.10.0.tar.gz']
+  recipe = MiniPortile.new('jsonnet', 'v0.17.0')
+  recipe.files = ['https://github.com/google/jsonnet/archive/v0.17.0.tar.gz']
   class << recipe
 
     def compile
@@ -39,6 +39,7 @@ unless using_system_libraries?
 
       FileUtils.cp(File.join(work_path, 'libjsonnet.a'), lib_path)
       FileUtils.cp(File.join(work_path, 'include', 'libjsonnet.h'), include_path)
+      FileUtils.cp(File.join(work_path, 'include', 'libjsonnet_fmt.h'), include_path)
     end
   end
 
@@ -57,4 +58,5 @@ end
 
 abort 'libjsonnet.h not found' unless have_header('libjsonnet.h')
 abort 'libjsonnet not found' unless have_library('jsonnet')
+have_header('libjsonnet_fmt.h')
 create_makefile('jsonnet/jsonnet_wrap')

data/ext/jsonnet/vm.c

@@ -1,4 +1,7 @@
 #include <libjsonnet.h>
+#ifdef HAVE_LIBJSONNET_FMT_H
+# include <libjsonnet_fmt.h>
+#endif
 #include <ruby/ruby.h>
 #include <ruby/intern.h>
 
@@ -20,8 +23,10 @@ static VALUE cVM;
  * Raised on evaluation errors in a Jsonnet VM.
  */
 static VALUE eEvaluationError;
+static VALUE eFormatError;
 
 static void raise_eval_error(struct JsonnetVm *vm, char *msg, rb_encoding *enc);
+static void raise_format_error(struct JsonnetVm *vm, char *msg, rb_encoding *enc);
 static VALUE str_new_json(struct JsonnetVm *vm, char *json, rb_encoding *enc);
 static VALUE fileset_new(struct JsonnetVm *vm, char *buf, rb_encoding *enc);
 
@@ -255,6 +260,128 @@ vm_set_max_trace(VALUE self, VALUE val)
     return Qnil;
 }
 
+static VALUE
+vm_set_fmt_indent(VALUE self, VALUE val)
+{
+    struct jsonnet_vm_wrap *vm = rubyjsonnet_obj_to_vm(self);
+    jsonnet_fmt_indent(vm->vm, NUM2INT(val));
+    return val;
+}
+
+static VALUE
+vm_set_fmt_max_blank_lines(VALUE self, VALUE val)
+{
+    struct jsonnet_vm_wrap *vm = rubyjsonnet_obj_to_vm(self);
+    jsonnet_fmt_max_blank_lines(vm->vm, NUM2INT(val));
+    return val;
+}
+
+static VALUE
+vm_set_fmt_string(VALUE self, VALUE str)
+{
+    const char *ptr;
+    struct jsonnet_vm_wrap *vm = rubyjsonnet_obj_to_vm(self);
+    StringValue(str);
+    if (RSTRING_LEN(str) != 1) {
+	rb_raise(rb_eArgError, "fmt_string must have a length of 1");
+    }
+    ptr = RSTRING_PTR(str);
+    switch (*ptr) {
+	case 'd':
+	case 's':
+	case 'l':
+	    jsonnet_fmt_string(vm->vm, *ptr);
+	    return str;
+	default:
+	    rb_raise(rb_eArgError, "fmt_string only accepts 'd', 's', or 'l'");
+    }
+}
+
+static VALUE
+vm_set_fmt_comment(VALUE self, VALUE str)
+{
+    const char *ptr;
+    struct jsonnet_vm_wrap *vm = rubyjsonnet_obj_to_vm(self);
+    StringValue(str);
+    if (RSTRING_LEN(str) != 1) {
+	rb_raise(rb_eArgError, "fmt_comment must have a length of 1");
+    }
+    ptr = RSTRING_PTR(str);
+    switch (*ptr) {
+	case 'h':
+	case 's':
+	case 'l':
+	    jsonnet_fmt_comment(vm->vm, *ptr);
+	    return str;
+	default:
+	    rb_raise(rb_eArgError, "fmt_comment only accepts 'h', 's', or 'l'");
+    }
+}
+
+static VALUE
+vm_set_fmt_pad_arrays(VALUE self, VALUE val)
+{
+    struct jsonnet_vm_wrap *vm = rubyjsonnet_obj_to_vm(self);
+    jsonnet_fmt_pad_objects(vm->vm, RTEST(val) ? 1 : 0);
+    return val;
+}
+
+static VALUE
+vm_set_fmt_pad_objects(VALUE self, VALUE val)
+{
+    struct jsonnet_vm_wrap *vm = rubyjsonnet_obj_to_vm(self);
+    jsonnet_fmt_pad_objects(vm->vm, RTEST(val) ? 1 : 0);
+    return val;
+}
+
+static VALUE
+vm_set_fmt_pretty_field_names(VALUE self, VALUE val)
+{
+    struct jsonnet_vm_wrap *vm = rubyjsonnet_obj_to_vm(self);
+    jsonnet_fmt_pretty_field_names(vm->vm, RTEST(val) ? 1 : 0);
+    return val;
+}
+
+static VALUE
+vm_set_fmt_sort_imports(VALUE self, VALUE val)
+{
+    struct jsonnet_vm_wrap *vm = rubyjsonnet_obj_to_vm(self);
+    jsonnet_fmt_sort_imports(vm->vm, RTEST(val) ? 1 : 0);
+    return val;
+}
+
+static VALUE
+vm_fmt_file(VALUE self, VALUE fname, VALUE encoding)
+{
+    int error;
+    char *result;
+    rb_encoding *const enc = rb_to_encoding(encoding);
+    struct jsonnet_vm_wrap *vm = rubyjsonnet_obj_to_vm(self);
+
+    FilePathValue(fname);
+    result = jsonnet_fmt_file(vm->vm, StringValueCStr(fname), &error);
+    if (error) {
+	raise_format_error(vm->vm, result, rb_enc_get(fname));
+    }
+    return str_new_json(vm->vm, result, enc);
+}
+
+static VALUE
+vm_fmt_snippet(VALUE self, VALUE snippet, VALUE fname)
+{
+    int error;
+    char *result;
+    struct jsonnet_vm_wrap *vm = rubyjsonnet_obj_to_vm(self);
+
+    rb_encoding *enc = rubyjsonnet_assert_asciicompat(StringValue(snippet));
+    FilePathValue(fname);
+    result = jsonnet_fmt_snippet(vm->vm, StringValueCStr(fname), StringValueCStr(snippet), &error);
+    if (error) {
+	raise_format_error(vm->vm, result, rb_enc_get(fname));
+    }
+    return str_new_json(vm->vm, result, enc);
+}
+
 void
 rubyjsonnet_init_vm(VALUE mJsonnet)
 {
@@ -262,6 +389,8 @@ rubyjsonnet_init_vm(VALUE mJsonnet)
     rb_define_singleton_method(cVM, "new", vm_s_new, -1);
     rb_define_private_method(cVM, "eval_file", vm_evaluate_file, 3);
     rb_define_private_method(cVM, "eval_snippet", vm_evaluate, 3);
+    rb_define_private_method(cVM, "fmt_file", vm_fmt_file, 2);
+    rb_define_private_method(cVM, "fmt_snippet", vm_fmt_snippet, 2);
     rb_define_method(cVM, "ext_var", vm_ext_var, 2);
     rb_define_method(cVM, "ext_code", vm_ext_code, 2);
     rb_define_method(cVM, "tla_var", vm_tla_var, 2);
@@ -272,22 +401,30 @@ rubyjsonnet_init_vm(VALUE mJsonnet)
     rb_define_method(cVM, "gc_growth_trigger=", vm_set_gc_growth_trigger, 1);
     rb_define_method(cVM, "string_output=", vm_set_string_output, 1);
     rb_define_method(cVM, "max_trace=", vm_set_max_trace, 1);
+    rb_define_method(cVM, "fmt_indent=", vm_set_fmt_indent, 1);
+    rb_define_method(cVM, "fmt_max_blank_lines=", vm_set_fmt_max_blank_lines, 1);
+    rb_define_method(cVM, "fmt_string=", vm_set_fmt_string, 1);
+    rb_define_method(cVM, "fmt_comment=", vm_set_fmt_comment, 1);
+    rb_define_method(cVM, "fmt_pad_arrays=", vm_set_fmt_pad_arrays, 1);
+    rb_define_method(cVM, "fmt_pad_objects=", vm_set_fmt_pad_objects, 1);
+    rb_define_method(cVM, "fmt_pretty_field_names=", vm_set_fmt_pretty_field_names, 1);
+    rb_define_method(cVM, "fmt_sort_imports=", vm_set_fmt_sort_imports, 1);
+
+    rb_define_const(mJsonnet, "STRING_STYLE_DOUBLE", rb_str_new_cstr("d"));
+    rb_define_const(mJsonnet, "STRING_STYLE_SINGLE", rb_str_new_cstr("s"));
+    rb_define_const(mJsonnet, "STRING_STYLE_LEAVE", rb_str_new_cstr("l"));
+    rb_define_const(mJsonnet, "COMMENT_STYLE_HASH", rb_str_new_cstr("h"));
+    rb_define_const(mJsonnet, "COMMENT_STYLE_SLASH", rb_str_new_cstr("s"));
+    rb_define_const(mJsonnet, "COMMENT_STYLE_LEAVE", rb_str_new_cstr("l"));
 
     rubyjsonnet_init_callbacks(cVM);
 
     eEvaluationError = rb_define_class_under(mJsonnet, "EvaluationError", rb_eRuntimeError);
+    eFormatError = rb_define_class_under(mJsonnet, "FormatError", rb_eRuntimeError);
 }
 
-/**
- * raises an EvaluationError whose message is \c msg.
- * @param[in] vm  a JsonnetVM
- * @param[in] msg must be a NUL-terminated string returned by \c vm.
- * @return never returns
- * @throw EvaluationError
- * @sa rescue_callback
- */
 static void
-raise_eval_error(struct JsonnetVm *vm, char *msg, rb_encoding *enc)
+raise_error(VALUE exception_class, struct JsonnetVm *vm, char *msg, rb_encoding *enc)
 {
     VALUE ex;
     const int state = rubyjsonnet_jump_tag(msg);
@@ -300,11 +437,31 @@ raise_eval_error(struct JsonnetVm *vm, char *msg, rb_encoding *enc)
 	rb_jump_tag(state);
     }
 
-    ex = rb_exc_new3(eEvaluationError, rb_enc_str_new_cstr(msg, enc));
+    ex = rb_exc_new3(exception_class, rb_enc_str_new_cstr(msg, enc));
     jsonnet_realloc(vm, msg, 0);
     rb_exc_raise(ex);
 }
 
+/**
+ * raises an EvaluationError whose message is \c msg.
+ * @param[in] vm  a JsonnetVM
+ * @param[in] msg must be a NUL-terminated string returned by \c vm.
+ * @return never returns
+ * @throw EvaluationError
+ * @sa rescue_callback
+ */
+static void
+raise_eval_error(struct JsonnetVm *vm, char *msg, rb_encoding *enc)
+{
+    raise_error(eEvaluationError, vm, msg, enc);
+}
+
+static void
+raise_format_error(struct JsonnetVm *vm, char *msg, rb_encoding *enc)
+{
+    raise_error(eFormatError, vm, msg, enc);
+}
+
 /**
  * Returns a String whose contents is equal to \c json.
  * It automatically frees \c json just after constructing the return value.

data/jsonnet.gemspec

@@ -21,8 +21,8 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency "mini_portile2", ">= 2.2.0"
 
-  spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "test-unit", "~> 3.1.3"
-  spec.add_development_dependency "rake-compiler", "~> 0.9.5"
+  spec.add_development_dependency "bundler", ">= 1.7"
+  spec.add_development_dependency "rake", ">= 10.0"
+  spec.add_development_dependency "test-unit", ">= 3.1.3"
+  spec.add_development_dependency "rake-compiler", ">= 0.9.5"
 end

data/lib/jsonnet/version.rb

@@ -1,3 +1,3 @@
 module Jsonnet
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/lib/jsonnet/vm.rb

@@ -14,9 +14,9 @@ module Jsonnet
       # @see #evaluate
       def evaluate(snippet, options = {})
         snippet_check = ->(key, value) { key.to_s.match(/^filename|multi$/) }
-        snippet_options = options.select &snippet_check
-        vm_options = options.reject &snippet_check
-        new(vm_options).evaluate(snippet, snippet_options)
+        snippet_options = options.select(&snippet_check)
+        vm_options = options.reject(&snippet_check)
+        new(vm_options).evaluate(snippet, **snippet_options)
       end
 
       ##
@@ -30,9 +30,9 @@ module Jsonnet
       # @see #evaluate_file
       def evaluate_file(filename, options = {})
         file_check = ->(key, value) { key.to_s.match(/^encoding|multi$/) }
-        file_options = options.select &file_check
-        vm_options = options.reject &file_check
-        new(vm_options).evaluate_file(filename, file_options)
+        file_options = options.select(&file_check)
+        vm_options = options.reject(&file_check)
+        new(vm_options).evaluate_file(filename, **file_options)
       end
     end
 
@@ -88,14 +88,39 @@ module Jsonnet
       eval_file(filename, encoding, multi)
     end
 
+    ##
+    # Format Jsonnet file.
+    #
+    # @param [String] filename filename of a Jsonnet source file.
+    # @return [String] a formatted Jsonnet representation
+    # @raise [FormatError] raised when the formatting results an error.
+    def format_file(filename, encoding: Encoding.default_external)
+      fmt_file(filename, encoding)
+    end
+
+    ##
+    # Format Jsonnet snippet.
+    #
+    # @param [String] jsonnet Jsonnet source string. Must be encoded in ASCII-compatible encoding.
+    # @param [String] filename filename of the source. Used in stacktrace.
+    # @return [String] a formatted Jsonnet representation
+    # @raise [FormatError] raised when the formatting results an error.
+    # @raise [UnsupportedEncodingError] raised when the encoding of jsonnt is not ASCII-compatible.
+    def format(jsonnet, filename: "(jsonnet)")
+      fmt_snippet(jsonnet, filename)
+    end
+
     ##
     # Lets the given block handle "import" expression of Jsonnet.
     # @yieldparam  [String] base base path to resolve "rel" from.
     # @yieldparam  [String] rel  a relative or absolute path to the file to be imported
     # @yieldreturn [Array<String>] a pair of the content of the imported file and
     #                              its path.
-    def handle_import
-      self.import_callback = to_method(Proc.new)
+    def handle_import(&block)
+      if block.nil?
+        raise ArgumentError, 'handle_import requires a block'
+      end
+      self.import_callback = to_method(block)
       nil
     end
 
@@ -112,8 +137,11 @@ module Jsonnet
     #   Also all the positional optional parameters of the body are interpreted
     #   as required parameters. And the body cannot have keyword, rest or
     #   keyword rest paramters.
-    def define_function(name, body = nil)
-      body = body ? body.to_proc : Proc.new
+    def define_function(name, body = nil, &block)
+      body = body ? body.to_proc : block
+      if body.nil?
+        raise ArgumentError, 'define_function requires a body argument or a block'
+      end
       params = body.parameters.map.with_index do |(type, name), i|
         raise ArgumentError, "rest or keyword parameters are not allowed: #{type}" \
           unless [:req, :opt].include? type

data/test/test_jsonnet.rb

@@ -38,7 +38,7 @@ class TestJsonnet < Test::Unit::TestCase
   private
 
   def example_jsonnet_file
-    example = Tempfile.open("example.jsonnet") do |f|
+    Tempfile.open("example.jsonnet") do |f|
       f.write %<
         local myvar = 1;
         {

data/test/test_vm.rb

@@ -474,6 +474,96 @@ class TestVM < Test::Unit::TestCase
     end
   end
 
+  test "Jsonnet::VM#format_file formats Jsonnet file" do
+    vm = Jsonnet::VM.new
+    vm.fmt_indent = 4
+    with_example_file(%<
+      local myvar = 1;
+    {
+    "foo": myvar
+    }
+    >) {|fname|
+      result = vm.format_file(fname)
+      assert_equal <<-EOS, result
+local myvar = 1;
+{
+    foo: myvar,
+}
+      EOS
+    }
+  end
+
+  test "Jsonnet::VM#format formats Jsonnet snippet" do
+    vm = Jsonnet::VM.new
+    vm.fmt_string = 'd'
+    result = vm.format(<<-EOS)
+local myvar = 'myvar';
+{
+foo: [myvar,myvar]
+}
+    EOS
+    assert_equal <<-EOS, result
+local myvar = "myvar";
+{
+  foo: [myvar, myvar],
+}
+    EOS
+  end
+
+  test "Jsonnet::VM#fmt_string only accepts 'd', 's', or 'l'" do
+    vm = Jsonnet::VM.new
+    vm.fmt_string = Jsonnet::STRING_STYLE_DOUBLE
+    vm.fmt_string = Jsonnet::STRING_STYLE_SINGLE
+    vm.fmt_string = Jsonnet::STRING_STYLE_LEAVE
+    assert_raise(ArgumentError) do
+      vm.fmt_string = ''
+    end
+    assert_raise(ArgumentError) do
+      vm.fmt_string = 'a'
+    end
+    assert_raise(ArgumentError) do
+      vm.fmt_string = 'ds'
+    end
+    assert_raise(TypeError) do
+      vm.fmt_string = 0
+    end
+  end
+
+  test "Jsonnet::VM#fmt_comment only accepts 'h', 's', or 'l'" do
+    vm = Jsonnet::VM.new
+    vm.fmt_comment = Jsonnet::COMMENT_STYLE_HASH
+    vm.fmt_comment = Jsonnet::COMMENT_STYLE_SLASH
+    vm.fmt_comment = Jsonnet::COMMENT_STYLE_LEAVE
+    assert_raise(ArgumentError) do
+      vm.fmt_comment = ''
+    end
+    assert_raise(ArgumentError) do
+      vm.fmt_comment = 'a'
+    end
+    assert_raise(ArgumentError) do
+      vm.fmt_comment = 'hs'
+    end
+    assert_raise(TypeError) do
+      vm.fmt_comment = 0
+    end
+  end
+
+  test "Jsonnet::VM#fmt_file raises FormatError on error" do
+    vm = Jsonnet::VM.new
+    with_example_file('{foo: }') do |fname|
+      assert_raise(Jsonnet::FormatError) do
+        vm.format_file(fname)
+      end
+    end
+  end
+
+  test "Jsonnet::VM#fmt_snippet raises FormatError on error" do
+    vm = Jsonnet::VM.new
+    assert_raise(Jsonnet::FormatError) do
+      vm.format('{foo: }')
+    end
+  end
+
   private
   def with_example_file(content)
     Tempfile.open("example.jsonnet") {|f|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsonnet
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Yuki Yugui Sonoda
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-05-01 00:00:00.000000000 Z
+date: 2020-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mini_portile2
@@ -28,56 +28,56 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.7'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.1.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.1.3
 - !ruby/object:Gem::Dependency
   name: rake-compiler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.9.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.9.5
 description: Wraps the official C++ implementation of Jsonnet
@@ -114,7 +114,7 @@ homepage: ''
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -129,9 +129,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Jsonnet library
 test_files: