jsonnet 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a215d91a36c8af2f5ad4d145f571fbbc070cedb7
-  data.tar.gz: 4e5b93b2fc44a5c33bb1fb27830a33ee810b4e8f
+  metadata.gz: 594f8f8d8e1b7fe224e63b82ac7f66c29e56baee
+  data.tar.gz: c46ca9961aaa22fd42f54623b7a375487f4b541f
 SHA512:
-  metadata.gz: 84a38e5e7e776ac8d11505693adedd2fd05dfe0d01146e5e242241f2a82f9d2b849983d15bb1909cd24fcfe6404aee0eb87647074a34893204ae522fee0c14bc
-  data.tar.gz: 1d44661d345335978fe2f67fec727c06aa3888b08b8418f570b7b27226b57e6c9501d4cc93fb51b312a861cbe2c6ba515793031c34cfec92468f67b319cfa8bb
+  metadata.gz: fd7fbcc1dcdcdff7cc6f7367d8b878ae712326d5bc9f69a010b7bb5a42d98fad132c6ee1145fc21708d73422261e0d0b56e198c4a47e9756594144a84229eba1
+  data.tar.gz: 0f34b0b7b14ac0a290fa9f4f6563d8359f53343bd82f0b958f3f2c423e77eb58c92d3f82bb06bf16b9a46d546bcb288dba9e775cf1d2a91ed7ef2d617c929aad

data/.travis.yml

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

data/README.md

@@ -1,17 +1,11 @@
+[![Build Status](https://travis-ci.org/yugui/ruby-jsonnet.svg?branch=master)](https://travis-ci.org/yugui/ruby-jsonnet)
+
 # Jsonnet
 
-Jsonnet processor library.  Wraps the official C++ implementation with a Ruby extention library.
+[Jsonnet][] processor library.  Wraps the official C++ implementation with a Ruby extension library.
 
 ## Installation
 
-Install libjsonnet:
-
-    $ git clone https://github.com/google/jsonnet.git
-    $ cd jsonnet
-    $ make
-    $ sudo cp libjsonnet.so /usr/local/lib/libjsonnet.so
-    $ sudo cp libjsonnet.h /usr/local/include/libjsonnet.h
-
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -20,20 +14,85 @@ gem 'jsonnet'
 
 And then execute:
 
-    $ bundle
+```shell
+$ bundle install
+```
 
 Or install it yourself as:
 
-    $ gem install jsonnet
+```shell
+$ gem install jsonnet
+```
+
+By default this gem will compile and install Jsonnet (v0.9.4) 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.
+
+To install libjsonnet:
+
+```shell
+$ git clone https://github.com/google/jsonnet.git
+$ cd jsonnet
+$ make libjsonnet.so
+$ sudo cp libjsonnet.so /usr/local/lib/libjsonnet.so
+$ sudo cp include/libjsonnet.h /usr/local/include/libjsonnet.h
+```
+
+Note: /usr/local/lib and /usr/local/include are used as they are library lookup
+locations. You may need to adjust these for your system if you have errors
+running this gem saying it can't open libjsonnet.so - on Ubuntu for instance
+I found /lib worked when /usr/local/lib did not.
+
+To install this gem without jsonnet:
+
+Use `JSONNET_USE_SYSTEM_LIBRARIES` ENV var:
+
+```shell
+$ JSONNET_USE_SYSTEM_LIBRARIES=1 bundle install
+```
+
+or, the `--use-system-libraries` option:
+
+
+```shell
+gem install jsonnet -- --use-system-libraries
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+Load the library with `require "jsonnet"`
+
+You can evaluate a string of Jsonnet using `Jsonnet.parse`
+
+```
+irb(main):002:0> Jsonnet.evaluate('{ foo: "bar" }')
+=> {"foo"=>"bar"}
+```
+Or load a file using `Jsonnet.load`
+
+```
+irb(main):002:0> Jsonnet.load('example.jsonnet')
+=> {"baz"=>1}
+```
+
+To get closer to the C++ interface you can create an instance of `Jsonnet::VM`
+
+```
+irb(main):002:0> vm = Jsonnet::VM.new
+=> #<Jsonnet::VM:0x007fd29aa1e568>
+irb(main):003:0> vm.evaluate('{ foo: "bar" }')
+=> "{\n   \"foo\": \"bar\"\n}\n"
+irb(main):004:0> vm.evaluate_file('example.jsonnet')
+=> "{\n   \"baz\": 1\n}\n"
+```
 
 ## Contributing
 
-1. Fork it ( https://github.com/yugui/jsonnet/fork )
+1. Fork it ( https://github.com/yugui/ruby-jsonnet/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
+
+[Jsonnet]: https://github.com/google/jsonnet

data/ext/jsonnet/extconf.rb

@@ -1,6 +1,61 @@
 require 'mkmf'
+require 'fileutils'
+
+def using_system_libraries?
+  arg_config('--use-system-libraries', !!ENV['JSONNET_USE_SYSTEM_LIBRARIES'])
+end
 
 dir_config('jsonnet')
+
+unless using_system_libraries?
+  message "Building jsonnet using packaged libraries.\n"
+  require 'rubygems'
+  gem 'mini_portile2', '~> 2.2.0'
+  require 'mini_portile2'
+  message "Using mini_portile version #{MiniPortile::VERSION}\n"
+
+  recipe = MiniPortile.new('jsonnet', 'v0.9.4')
+  recipe.files = ['https://github.com/google/jsonnet/archive/v0.9.4.tar.gz']
+  class << recipe
+
+    def compile
+      # We want to create a file a library we can link to. Jsonnet provides us
+      # with the command `make libjsonnet.so` which creates a shared object
+      # however that won't be bundled into the compiled output so instead
+      # we compile the c into .o files and then create an archive that can
+      # be linked to
+      execute('compile', make_cmd)
+      execute('archive', 'ar rcs libjsonnet.a core/desugarer.o core/formatter.o core/lexer.o core/libjsonnet.o core/parser.o core/pass.o core/static_analysis.o core/string_utils.o core/vm.o third_party/md5/md5.o')
+    end
+
+    def configured?
+      true
+    end
+
+    def install
+      lib_path = File.join(port_path, 'lib')
+      include_path = File.join(port_path, 'include')
+
+      FileUtils.mkdir_p([lib_path, include_path])
+
+      FileUtils.cp(File.join(work_path, 'libjsonnet.a'), lib_path)
+      FileUtils.cp(File.join(work_path, 'include', 'libjsonnet.h'), include_path)
+    end
+  end
+
+  recipe.cook
+  # I tried using recipe.activate here but that caused this file to build ok
+  # but the makefile to fail. These commands add the necessary paths to do both
+  $LIBPATH = ["#{recipe.path}/lib"] | $LIBPATH
+  $CPPFLAGS << " -I#{recipe.path}/include"
+
+  # This resolves an issue where you can get improper linkage when compiling
+  # and get an error like "undefined symbol: _ZTVN10__cxxabiv121__vmi_class_type_infoE"
+  # experienced on ubuntu.
+  # See: https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=193950
+  $LIBS << " -lstdc++"
+end
+
 abort 'libjsonnet.h not found' unless have_header('libjsonnet.h')
 abort 'libjsonnet not found' unless have_library('jsonnet')
 create_makefile('jsonnet/jsonnet_wrap')

data/ext/jsonnet/jsonnet.c

@@ -136,12 +136,13 @@ jw_s_version(VALUE mod)
 }
 
 static VALUE
-vm_s_new(VALUE mod)
+vm_s_new(int argc, const VALUE *argv, VALUE klass)
 {
     struct jsonnet_vm_wrap *vm;
     VALUE self = TypedData_Make_Struct(cVM, struct jsonnet_vm_wrap, &jsonnet_vm_type, vm);
     vm->vm = jsonnet_make();
     vm->callback = Qnil;
+    rb_obj_call_init(self, argc, argv);
     return self;
 }
 
@@ -259,7 +260,7 @@ import_callback_thunk(void *ctx, const char *base, const char *rel, char **found
 /**
  * Sets a custom way to resolve "import" expression.
  * @param [#call] callback receives two parameters and returns two values.
- *                The first parameter "base" is a base directory to resolve 
+ *                The first parameter "base" is a base directory to resolve
  *                "rel" from.
  *                The second parameter "rel" is an absolute or a relative
  *                path to the file to import.
@@ -322,7 +323,7 @@ vm_set_gc_growth_trigger(VALUE self, VALUE val)
 }
 
 /*
- * Let #evalutae and #evaluate_file return a raw String instead of JSON-encoded string if val is true
+ * Let #evaluate and #evaluate_file return a raw String instead of JSON-encoded string if val is true
  * @param [Boolean] val
  */
 static VALUE
@@ -343,15 +344,6 @@ vm_set_max_trace(VALUE self, VALUE val)
     return Qnil;
 }
 
-static VALUE
-vm_set_debug_ast(VALUE self, VALUE val)
-{
-    struct jsonnet_vm_wrap *vm;
-    TypedData_Get_Struct(self, struct jsonnet_vm_wrap, &jsonnet_vm_type, vm);
-    jsonnet_debug_ast(vm->vm, RTEST(val));
-    return Qnil;
-}
-
 void
 Init_jsonnet_wrap(void)
 {
@@ -362,7 +354,7 @@ Init_jsonnet_wrap(void)
     rb_define_singleton_method(mJsonnet, "libversion", jw_s_version, 0);
 
     cVM = rb_define_class_under(mJsonnet, "VM", rb_cData);
-    rb_define_singleton_method(cVM, "new", vm_s_new, 0);
+    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_method(cVM, "ext_var", vm_ext_var, 2);
@@ -371,7 +363,6 @@ Init_jsonnet_wrap(void)
     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, "debug_ast=", vm_set_debug_ast, 1);
     rb_define_method(cVM, "import_callback=", vm_set_import_callback, 1);
 
     eEvaluationError = rb_define_class_under(mJsonnet, "EvaluationError", rb_eRuntimeError);

data/jsonnet.gemspec

@@ -19,6 +19,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  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"

data/lib/jsonnet.rb

@@ -1,7 +1,47 @@
 require "jsonnet/version"
-require "jsonnet/jsonnet_wrap"
 require "jsonnet/vm"
+require "json"
 
 module Jsonnet
-  # Your code goes here...
+  module_function
+
+  ##
+  # Evaluates a string of Jsonnet and returns a hash of the resulting JSON
+  #
+  # @param [String]  jsonnet  Jsonnet source string, ideally in UTF-8 encoding
+  # @param [Hash]    jsonnet_options A hash of options to for Jsonnet::VM.
+  #                                  Available options are: filename, multi,
+  #                                  import_callback, gc_growth_triger,
+  #                                  gc_min_objects, max_stack, max_trace
+  # @param [Hash]    json_options Options supported by {JSON.parse}[http://www.rubydoc.info/github/flori/json/JSON#parse-class_method]
+  # @return [Hash] The JSON representation as a hash
+  # @raise [UnsupportedOptionError] Raised when an option passed is unsupported by Jsonnet::VM
+  #
+  # @note This method runs Jsonnet::VM#evaluate and runs the string
+  #       output through {JSON.parse}[http://www.rubydoc.info/github/flori/json/JSON#parse-class_method]
+  #       so those should be looked at for furhter details
+  def evaluate(jsonnet, jsonnet_options: {}, json_options: {})
+    output = VM.evaluate(jsonnet, jsonnet_options)
+    JSON.parse(output, json_options)
+  end
+
+  ##
+  # Loads a Jsonnet file and returns a hash of the resulting JSON
+  #
+  # @param [String]  path path to the jsonnet file
+  # @param [Hash]    jsonnet_options A hash of options to for Jsonnet::VM.
+  #                                  Available options are: encoding, multi,
+  #                                  import_callback, gc_growth_triger,
+  #                                  gc_min_objects, max_stack, max_trace
+  # @param [Hash]    json_options Options supported by {JSON.parse}[http://www.rubydoc.info/github/flori/json/JSON#parse-class_method]
+  # @return [Hash] The JSON representation as a hash
+  # @raise [UnsupportedOptionError] Raised when an option passed is unsupported by Jsonnet::VM
+  #
+  # @note This method runs Jsonnet::VM#evaluate_file and runs the string
+  #       output through {JSON.parse}[http://www.rubydoc.info/github/flori/json/JSON#parse-class_method]
+  #       so those should be looked at for furhter details
+  def load(path, jsonnet_options: {}, json_options: {})
+    output = VM.evaluate_file(path, jsonnet_options)
+    JSON.parse(output, json_options)
+  end
 end

data/lib/jsonnet/version.rb

@@ -1,3 +1,3 @@
 module Jsonnet
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/jsonnet/vm.rb

@@ -1,5 +1,59 @@
+require "jsonnet/jsonnet_wrap"
+
 module Jsonnet
   class VM
+    class << self
+      ##
+      # Convenient method to evaluate a Jsonnet snippet.
+      #
+      # It implicitly instantiates a VM and then evaluate Jsonnet with the VM.
+      #
+      # @param snippet [String]  Jsonnet source string.
+      # @param options [Hash]  options to {.new} or options to {#evaluate}
+      # @return [String]
+      # @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)
+      end
+
+      ##
+      # Convenient method to evaluate a Jsonnet file.
+      #
+      # It implicitly instantiates a VM and then evaluates Jsonnet with the VM.
+      #
+      # @param filename [String]  Jsonnet source file.
+      # @param options [Hash]  options to {.new} or options to {#evaluate_file}
+      # @return [String]
+      # @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)
+      end
+    end
+
+    ##
+    # initializes a new VM with the given configuration.
+    #
+    # @param [Hash] options  a mapping from option names to their values.
+    #    It can have names of writable attributes in VM class as keys.
+    # @return [VM] the VM.
+    def initialize(options = {})
+      options.each do |key, value|
+        method = "#{key}="
+        if respond_to?(method)
+          public_send(method, value)
+        else
+          raise UnsupportedOptionError.new("Jsonnet VM does not support #{key} option")
+        end
+      end
+      self
+    end
+
     ##
     # Evaluates Jsonnet source.
     #
@@ -11,9 +65,9 @@ module Jsonnet
     # @raise [EvaluationError] raised when the evaluation results an error.
     # @raise [UnsupportedEncodingError] raised when the encoding of jsonnet
     #        is not ASCII-compatible.
-    # @note It is recommended to encode the source string in UTF-8 because 
-    #       Jsonnet expects it is ASCII-compatible, the result JSON string 
-    #       shall be UTF-{8,16,32} according to RFC 7159 thus the only 
+    # @note It is recommended to encode the source string in UTF-8 because
+    #       Jsonnet expects it is ASCII-compatible, the result JSON string
+    #       shall be UTF-{8,16,32} according to RFC 7159 thus the only
     #       intersection between the requirements is UTF-8.
     def evaluate(jsonnet, filename: "(jsonnet)", multi: false)
       eval_snippet(jsonnet, filename, multi)
@@ -26,9 +80,9 @@ module Jsonnet
     # @param [Boolean] multi    enables multi-mode
     # @return [String] a JSON representation of the evaluation result
     # @raise [EvaluationError] raised when the evaluation results an error.
-    # @note It is recommended to encode the source file in UTF-8 because 
-    #       Jsonnet expects it is ASCII-compatible, the result JSON string 
-    #       shall be UTF-{8,16,32} according to RFC 7159 thus the only 
+    # @note It is recommended to encode the source file in UTF-8 because
+    #       Jsonnet expects it is ASCII-compatible, the result JSON string
+    #       shall be UTF-{8,16,32} according to RFC 7159 thus the only
     #       intersection between the requirements is UTF-8.
     def evaluate_file(filename, encoding: Encoding.default_external, multi: false)
       eval_file(filename, encoding, multi)
@@ -44,5 +98,7 @@ module Jsonnet
       self.import_callback = Proc.new
       nil
     end
+
+    class UnsupportedOptionError < RuntimeError; end
   end
 end

data/test/test_jsonnet.rb

@@ -1,8 +1,51 @@
 require 'jsonnet'
+
+require 'tempfile'
 require 'test/unit'
 
 class TestJsonnet < Test::Unit::TestCase
   test 'libversion returns a String' do
-    assert_kind_of String, Jsonnet.libversion 
+    assert_kind_of String, Jsonnet.libversion
+  end
+
+  test 'Jsonnet.evaluate returns a JSON parsed result' do
+    result = Jsonnet.evaluate('{ foo: "bar" }')
+    assert_equal result, { "foo" => "bar" }
+  end
+
+  test 'Jsonnet.evaluate can accept options for JSON' do
+    result = Jsonnet.evaluate('{ foo: "bar" }', json_options: { symbolize_names: true })
+    assert_equal result, { foo: "bar" }
+  end
+
+  test 'Jsonnet.evaluate can accept options for Jsonnet VM' do
+    result = Jsonnet.evaluate(
+      'import "imported.jsonnet"',
+      jsonnet_options: {
+        import_callback: ->(_base, _rel) do
+          return ['{ foo: "bar" }', 'imported']
+        end
+      }
+    )
+    assert_equal result, { "foo" => "bar" }
+  end
+
+  test 'Jsonnet.load returns a JSON parsed result' do
+    result = Jsonnet.load(example_jsonnet_file.path)
+    assert_equal result, { "foo1" => 1 }
+  end
+
+  private
+
+  def example_jsonnet_file
+    example = Tempfile.open("example.jsonnet") do |f|
+      f.write %<
+        local myvar = 1;
+        {
+          ["foo" + myvar]: myvar,
+        }
+      >
+      f
+    end
   end
 end

data/test/test_vm.rb

@@ -47,7 +47,7 @@ class TestVM < Test::Unit::TestCase
     vm = Jsonnet::VM.new
     begin
       with_example_file(%q{ ["unterminated string }) {|fname|
-        vm.evaluate_file(fname.encode(Encoding::SJIS)) 
+        vm.evaluate_file(fname.encode(Encoding::SJIS))
       }
     rescue Jsonnet::EvaluationError => e
       assert_equal Encoding::SJIS, e.message.encoding
@@ -104,7 +104,7 @@ class TestVM < Test::Unit::TestCase
   test "Jsonnet::VM#evaluate raises an error in the encoding of filename" do
     vm = Jsonnet::VM.new
     begin
-      vm.evaluate(%Q{ ["unterminated string }, filename: "テスト.json".encode(Encoding::SJIS)) 
+      vm.evaluate(%Q{ ["unterminated string }, filename: "テスト.json".encode(Encoding::SJIS))
     rescue Jsonnet::EvaluationError => e
       assert_equal Encoding::SJIS, e.message.encoding
     end
@@ -211,10 +211,6 @@ class TestVM < Test::Unit::TestCase
     Jsonnet::VM.new.max_trace = 1
   end
 
-  test "Jsonnet::VM responds to debug_ast=" do
-    Jsonnet::VM.new.debug_ast = true
-  end
-
   test "Jsonnet::VM#string_output lets the VM output a raw string" do
     vm = Jsonnet::VM.new
     vm.string_output = true
@@ -229,7 +225,7 @@ class TestVM < Test::Unit::TestCase
       case [base, rel]
       when ['/path/to/base/', 'imported1.jsonnet']
         return <<-EOS, '/path/to/imported1/imported1.jsonnet'
-          import "imported2.jsonnet" {
+          (import "imported2.jsonnet") + {
             b: 2,
           }
         EOS
@@ -242,7 +238,7 @@ class TestVM < Test::Unit::TestCase
       end
     }
     result = vm.evaluate(<<-EOS, filename: "/path/to/base/example.jsonnet")
-      import "imported1.jsonnet" { c: 3 }
+      (import "imported1.jsonnet") + { c: 3 }
     EOS
 
     expected = {"a" => 1, "b" => 2, "c" => 3}
@@ -255,7 +251,7 @@ class TestVM < Test::Unit::TestCase
     vm.import_callback = ->(base, rel) { called = true; raise }
     assert_raise(Jsonnet::EvaluationError) {
       vm.evaluate(<<-EOS)
-        import "a.jsonnet" {}
+        (import "a.jsonnet") + {}
       EOS
     }
     assert_true called

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: jsonnet
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Yuki Yugui Sonoda
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-08 00:00:00.000000000 Z
+date: 2017-07-12 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: mini_portile2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -75,6 +89,7 @@ extensions:
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -108,11 +123,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
 summary: Jsonnet library
 test_files:
 - test/test_jsonnet.rb
 - test/test_vm.rb
-has_rdoc: