modl 0.3.26 → 0.3.27

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: edaf87097f3f827795fdeff49c22f3acb3e25ec92acf2bf177ab1af9f881ae9e
-  data.tar.gz: da67d0d410dbad33b336daf1bbf424912e6cbca52d5ef939b42908af445d1fad
+  metadata.gz: 19413632838d38b40c5079a2b4c4551681ba94fc67c03a9b5aba98ef3bab522b
+  data.tar.gz: 74648b6833fdd3a9562bfde9ce8ddbaeea71439b751d19cd4487d5c586f918e1
 SHA512:
-  metadata.gz: dd2e39df266e049f744a927ef12ffe63dbc2e1aa3af60e82b3c964104c6c85cc1c7822318ef855b7c7cd494d1eea1d04fa628111b2d3506cf5590d906e1f14e2
-  data.tar.gz: 7f1c74734687b3d9ab94b9e6757d4fcf435721366b1267d2b2ae4857f8a1636f6f4f9b7e8333aedb46614691a5f8c50a1871470795fba670a366f7d6c0c186fc
+  metadata.gz: a2e31d1efa2d9668c94f503f1b0d5cdc19c9ea484dd85314e6697a6647ef44bed2213515ad3031839e38bf459a7e68497434b195f2f9cf5e54ce81203bfd03e0
+  data.tar.gz: c9dec885b8ea5acc8799c405379f3848dbac48f5dc919ae27f34d2d2d2bc8dda1fdee18620477f3867e747e00ba0baf2b940b1f62d29c7fa71055bb857cedc5f

data/CHANGELOG.md

@@ -1,151 +1,3 @@
-0.3.26
-===
-- Remove `*expect`
-- Fix problem with references in classes.
-
-0.3.25
-===
-- Update Rake due to security advisory.
-
-0.3.24
-===
-- Use base_tests from the grammar repo.
-- Updated grammar to support minified MODL.
-- Bug fixes for handling minified MODL.
-
-0.3.23
-===
-- Add support for 5- and 6-digit unicode escape sequences.
-
-0.3.22
-===
-- Two bug fixes - quoted strings, and incomplete strings for certain output situations.
-
-0.3.21
-===
-- Bugfix for `*assign` processing.
-
-0.3.20
-===
-- Support escaping unicode escape sequences so they are not replaced by unicode characters.
-
-0.3.19
-===
-- Fix bug with `*assign` when there is only 1 item in the array.
-
-0.3.18
-===
-- Fix problems with `*assign`.
-
-0.3.17
-===
-- Remove support for `*array`.
-- Add support for unicode escape sequences including `~unnnn` and `\unnnn`
-- Update `*assign` processing to support a more compact form
-
-0.3.16
-===
-- Use latest ruby runtime.
-- Add support for `*array` keyword.
-
-0.3.15
-===
-- Interpreter Error: undefined method `text' for nil:NilClass. GitHub issue #23
-- Fixed some NOT IMPLEMENTED sections for *method interpretation. GitHub issue #25
-- Standardise the error messages to match the Java interpreter.
-
-0.3.14
-===
-- MODL Syntax Versioning errors update. GitHub issue #11
-- Support for escaped % characters - GitHub issue #43
-
-0.3.13
-===
-- Added missing exceptions for Orphan Pairs
-
-0.3.12
-===
-- Use file cache on load error - GitHub issue #20
-- Error converting value to number - GitHub issue #21
-- Problem with punycode - GitHub issue #22
-- Handle orphan pairs - adopt then into a map
-
-0.3.11
-===
-- Support conditional file loading.
-- Updated to latest grammar.
-
-0.3.10
-===
-- Fix GitHub issue #19 - Checking value of object reference in conditional
-
-0.3.9
-===
-- Fix GitHub Issue #18 - Quoted strings not handled correctly in references
-
-0.3.8
-===
-- Add MIT license to all non-auto-generated Ruby files.
-- Use latest ANTLR4 Ruby runtime - previous version didn't build on AWS.
-
-0.3.7
-===
-- Update to latest antlr4-ruby-runtime for performance improvements
-- Fixed some failing base_tests
-- Fixed processing of superclass type conversions.
-- Fixed file caching issue - GitHub issue#1
-- Fixed GitHub issue#15 unicode problem.
-- Fixed GitHub issue#9 *LOAD problem
-- Fixed bug in error tests handling
-- Fixed stack too deep error for rafs such as `%ref%`
-- Fixed GitHub issue#13 No output from objects in loaded file.
-- Fixed GitHub issue#14 method chaining problem.
-- Correct handling of invalid pair keys.
-- Fix file encoding problem for error_tests.json on MS Windows.
-
-0.3.6
-===
-- Use latest ANTLR4 Ruby.stg updated by Cameron Dutro.
-- Use antrl4-runtime v0.2.2 which fixes some issues around Array2DHashSet
-- Fixed a failing error test due to incorrect value type for a `*class` with supertype `num`.
-- Corrected the ordering of fields within a class.
-- Return `null` for empty output rather than `""`
-- Fixed GitHub issue#4 - improved error reporting.
-
-0.3.5
-===
-- Fixed another bug with class handling to expand classes properly.
-
-0.3.4
-===
-- Fixed a bug with class handling to expand classes properly.
-- Add `*expect` to the output for the `%*class` instruction.
-
-0.3.3
-===
-- Change module name to MODL from Modl.
-- Support simpler usage, i.e. `x = MODL.parse(str)`. README.md updated accordingly.
-- Ignore *allow and *expect for now, except when used as `x=%*allow` or `x=%*expect`. Proper implementation will follow later.
-- Fixed a NilClass exception.
-- Disabled file caching due to garbage collection and other issues. See issue#1.
-- Grammar update to catch errors from unparsed MODL input.
-
-0.3.2
-===
-- Update to latest ANTLR4 Runtime
-
-0.3.1
-===
-- Update to latest ANTLR4 Runtime
-
-0.3.0
-===
-- First working MODL interpreter for Ruby
-
-0.2.0
-===
-- Hello world.
-
-0.1.0
+0.0.1
 ===
 - Initial release

data/Gemfile

@@ -1,9 +1,11 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in modl.gemspec
 group :development, :test do
-  gem 'ruby-debug-ide'
   gem 'debase'
+  gem 'ruby-debug-ide'
 end
 
 gemspec

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2019 NUM Technology Ltd
+Copyright (c) 2022 NUM Technology Ltd
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,6 +1,7 @@
-# MODL::Parser
+# MODL::Interpreter
+
+This Ruby gem is a MODL interpreter and requires Ruby 2.6.0.
 
-This Ruby gem can be used as the base for a MODL interpreter. It contains the Lexer, Parser, and other supporting classes generated by the ANTLR4 Ruby language target.
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -21,30 +22,37 @@ Or clone the repository and build and install it yourself as:
     
     $ sudo rake install
 
-You will also need to install the antlr4-ruby-runtime gem that this depends on. See https://github.com/MODLanguage/antlr4-ruby-runtime
 ## Usage
 
+In `irb`:
+
+```ruby
+2.6.0 :001 > require 'modl'
+ => true
+2.6.0 :002 > MODL.parse 'a=b'
+ => {"a"=>"b"}
+2.6.0 :003 >
+```
+In a Ruby file:
+
 ```ruby
 require 'modl'
 
 str='s=MODL data'
-
-result = MODL.parse(str)
-jsonStr = JSON.pretty_generate(result)
-puts jsonStr
+pretty = true
+result = MODL.parse str
+puts result
 
 ```
 where `str` is the modl to be interpreted. 
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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 tags, 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/MODLanguage/ruby-interpreter. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/MODLanguage/ruby-modl. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
@@ -52,4 +60,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the MODL::Parser project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/modl-parser/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the MODL::Interpreter project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/modl-parser/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -1,6 +1,8 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/lib/modl/interpreter.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'json'
+
+# The MODL namespace
+module MODL
+  # Interpreter-specific errors
+  class ParserError < StandardError
+  end
+
+  # This is the main Ruby Interpreter entry point. Supply a String containing
+  # MODL text and it will return a String  containing the JSON equivalent.
+  # The JSON isn't pretty-printed unless pretty is true
+  module Interpreter
+    def self.interpret_to_json_string(str, pretty = false)
+      json_obj = interpret_to_object str
+      pretty ? JSON.pretty_generate(json_obj) : JSON.generate(json_obj)
+    end
+
+    def self.interpret_to_object(str)
+      interpret(str).to_j
+    end
+
+    def self.interpret(str)
+      MODL::Parser.parse_modl str
+    end
+  end
+
+  # MODL String to Ruby Hash/Array/primitive
+  def self.parse(str)
+    MODL::Interpreter.interpret_to_object str
+  end
+
+  # Ruby Hash/Array/primitive to MODL
+  def self.generate(obj)
+    MODL::Model::Modl.new(MODL::Model.to_modl(obj)).to_m
+  end
+end

data/lib/modl/model/model.rb

@@ -0,0 +1,264 @@
+# frozen_string_literal: true
+
+module MODL
+  # A Model module for MODL
+  module Model
+    # The root of a MODL object
+    class Modl
+      attr_reader :value
+
+      def initialize(value)
+        @value = value
+      end
+
+      def to_s
+        if @value.instance_of? Array
+          @value.map(&:to_s)
+        else
+          "Modl: #{@value}"
+        end
+      end
+
+      def to_j
+        @value.nil? ? 'null' : @value.to_j
+      end
+
+      def to_m
+        if @value.instance_of?(ModlMap)
+          @value.items.map(&:to_m).join(';')
+        else
+          @value.to_m
+        end
+      end
+    end
+
+    # A MODL Array
+    class ModlArray
+      attr_reader :items
+
+      def initialize(items)
+        @items = items
+      end
+
+      def to_s
+        items = @items.map(&:to_s)
+        "ModlArray: #{items}"
+      end
+
+      def to_j
+        @items.map(&:to_j)
+      end
+
+      def to_m
+        list = @items.map(&:to_m).join ';'
+        "[#{list}]"
+      end
+    end
+
+    # A MODL Map
+    class ModlMap
+      attr_reader :items
+
+      def initialize(items)
+        @items = items
+      end
+
+      def to_s
+        items = @items.map(&:to_s)
+        "ModlMap: #{items}"
+      end
+
+      def to_j
+        result = @items.map { |p| [p.key, p.value.to_j] }
+        result.to_h
+      end
+
+      def to_m
+        modl = @items.map(&:to_m).join ';'
+        "(#{modl})"
+      end
+    end
+
+    # A MODL Primitive
+    class ModlPrimitive
+      attr_reader :value
+
+      def initialize(value)
+        @value = value
+      end
+
+      def to_s
+        "ModlPrimitive: #{@value}"
+      end
+
+      def to_m
+        @value.to_s
+      end
+    end
+
+    # A MODL PAir
+    class ModlPair
+      attr_reader :key, :value
+
+      def initialize(key, value)
+        @key = key
+        @value = value
+      end
+
+      def to_s
+        "ModlPair: #{key}=#{@value}"
+      end
+
+      def to_j
+        { @key => @value.to_j }
+      end
+
+      def to_m
+        key = UTIL.non_string_primitive?(@key) ? "\"#{@key}\"" : @key
+        if @value.instance_of?(ModlPair)
+          "#{key}(#{@value.to_m})"
+        elsif @value.instance_of?(ModlMap) || @value.instance_of?(ModlArray)
+          "#{key}#{@value.to_m}"
+        else
+          "#{key}=#{@value.to_m}"
+        end
+      end
+    end
+
+    # A MODL FLOAT
+    class ModlFloat
+      attr_reader :value
+
+      def initialize(value)
+        @value = value
+      end
+
+      def to_s
+        "ModlFloat: #{@value}"
+      end
+
+      def to_j
+        @value
+      end
+
+      def to_m
+        format('%.16G', @value).sub('E+', 'E')
+      end
+    end
+
+    # A MODL Integer
+    class ModlInteger
+      attr_reader :value
+
+      def initialize(value)
+        @value = value
+      end
+
+      def to_s
+        "ModlInteger: #{@value}"
+      end
+
+      def to_j
+        @value
+      end
+
+      def to_m
+        @value.to_s
+      end
+    end
+
+    # A MODL String
+    class ModlString
+      attr_reader :value
+
+      def initialize(value)
+        @value = value
+      end
+
+      def to_s
+        "ModlString: #{@value}"
+      end
+
+      def to_j
+        @value
+      end
+
+      def to_m
+        UTIL.escape_and_quote @value
+      end
+    end
+
+    # A MODL Quoted String
+    class ModlQuoted
+      attr_reader :value
+
+      def initialize(value)
+        @value = value
+      end
+
+      def to_s
+        "ModlQuoted: #{@value}"
+      end
+
+      def to_j
+        @value
+      end
+
+      def to_m
+        UTIL.escape_and_quote @value
+      end
+    end
+
+    # A MODL Boolean or NULL
+    class ModlBoolNull
+      def initialize(value)
+        @value = value
+      end
+
+      MODL_NULL = ModlBoolNull.new nil
+      MODL_TRUE = ModlBoolNull.new true
+      MODL_FALSE = ModlBoolNull.new false
+
+      def to_s
+        "ModlBoolNull: #{@value}"
+      end
+
+      def to_j
+        @value
+      end
+
+      def to_m
+        @value.nil? ? 'null' : @value
+      end
+    end
+
+    # Convert a Ruby Hash/Array/Primitive to a Modl object.
+    def self.to_modl(obj)
+      if obj.instance_of? Float
+        ModlFloat.new obj
+      elsif obj.instance_of? Integer
+        ModlInteger.new obj
+      elsif obj.instance_of? String
+        ModlString.new obj
+      elsif obj.instance_of? Hash
+        if obj.keys.length == 1
+          key = obj.keys[0]
+          ModlPair.new key, to_modl(obj[key])
+        else
+          ModlMap.new(obj.keys.map { |k| ModlPair.new k, to_modl(obj[k]) })
+        end
+      elsif obj.instance_of? Array
+        ModlArray.new(obj.map { |i| to_modl i })
+      elsif obj.instance_of? TrueClass
+        ModlBoolNull::MODL_TRUE
+      elsif obj.instance_of? FalseClass
+        ModlBoolNull::MODL_FALSE
+      elsif obj.instance_of? NilClass
+        ModlBoolNull::MODL_NULL
+      else
+        puts "Cannot handle #{obj}"
+        exit
+      end
+    end
+  end
+end