modl 0.3.15 → 0.3.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 19862a8b989bb41687946af65e7368ee2c9ab88794498d9bc0383dba94bbd1ad
-  data.tar.gz: e1b01ea144720b3b96f7ee412c843154fdb10acf6f84ebd72e24e23a5aef7f25
+  metadata.gz: de1a3cee98476becc60a2c7dab825c65c30b47e5e8b017ae30c23b8505937e41
+  data.tar.gz: 85150763932b4136124d120017881baaf34c528cc989709ecc139eaf563bc868
 SHA512:
-  metadata.gz: eea7c86691b1e027737cbefbb92644731f96d049fbdf2bf894c0ea971679536f9111ff0c670ce2785b6346664df90e813bd5cce2c3f8b6360e1d91e2cbe94446
-  data.tar.gz: e059d05d456ab4f73bc11b5dc62f50e7a291d00158063c4cc43ca7d3a3f5b9b1da09457bf3bf3f44d41d896576e3879efb49398434aa088b3229b64d50a12882
+  metadata.gz: 0276b480cfe85fa983b0deac3ca030f5a79d25e6676c781cf3ca8868162adfb30d837d29af4d26d935e41888819b57b9f83141d41d0311dd2fb8ab634e2799c5
+  data.tar.gz: d2e5547d0fd8225d3739d8d2c3754f40b7b77f0df6f5d415a42201f5dd696beb8f1d25e33c2ee18b635efc15bdc268df20ad97c7188c742825d498234312314f

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+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

data/grammar_tests/base_tests.json

@@ -1667,7 +1667,7 @@
   },
   {
     "id": "176",
-    "input": "_var=2;\n*L=\"http://s3-eu-west-1.amazonaws.com/modltestfiles/testing.txt!\";\nprint=%update_date\n",
+    "input": "_var=2;\n*L=\"http://modl.uk/tests/testing.txt!\";\nprint=%update_date\n",
     "expected_output": "{\n    \"print\": \"20180921 08:20 2\"\n}",
     "tested_features": [
       "object_ref",
@@ -3011,5 +3011,14 @@
       "escape"
     ],
     "minimised_modl": "_letters=abc;key=\"\\%letters\""
+  },
+  {
+    "id": "316",
+    "input": "*array(\n      *id=p;\n      *name=people;\n      *of=person\n  );\n\n  *class(\n    *id=n;\n    *name=name\n  );\n\n  *class(\n    *id=a;\n    *name=age\n  );\n\n  *class(\n    *id=person;\n    *assign=[\n      [n;a]\n    ]\n  );\n\n  data(\n    p[[John;18];[Jane;20]];\n    person=[Fred;21]\n  );\n  p[[Mary;18];[Mungo;19];[Midge;20]];\n  person=[Rod;23]\n",
+    "expected_output": "{\n  \"data\": {\n    \"people\": [\n      {\n        \"name\": \"John\",\n        \"age\": 18\n      },\n      {\n        \"name\": \"Jane\",\n        \"age\": 20\n      }\n    ],\n    \"person\": {\n      \"name\": \"Fred\",\n      \"age\": 21\n    }\n  },\n  \"people\": [\n    {\n      \"name\": \"Mary\",\n      \"age\": 18\n    },\n    {\n      \"name\": \"Mungo\",\n      \"age\": 19\n    },\n    {\n      \"name\": \"Midge\",\n      \"age\": 20\n    }\n  ],\n  \"person\": {\n    \"name\": \"Rod\",\n    \"age\": 23\n  }\n}",
+    "tested_features": [
+      "*arrays"
+    ],
+    "minimised_modl": "*array(*id=p;*name=people;*of=person);*class(*id=n;*name=name);*class(*id=a;*name=age);*class(*id=person;*assign=[[n;a]]);data(p[[John;18];[Jane;20]];person=[Fred;21]);p[[Mary;18];[Mungo;19];[Midge;20]];person=[Rod;23]"
   }
 ]

data/lib/modl/parser/array_processor.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+# The MIT License (MIT)
+#
+# Copyright (c) 2019 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
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+module MODL
+  module Parser
+    # This class handles the conversion of objects that refer to arrays into instances of those arrays.
+    # It works recursively since array usage can be nested.
+    class ArrayProcessor
+      # How deep can the class structure be?
+      MAX_RECURSION_DEPTH = 50
+      # global is a GlobalParseContext and obj is the extracted Array or Hash from MODL::Parser::Parsed.extract_json
+      def self.process(global, obj)
+        # Process each object in the array or just process the object if its a hash.
+        # Any other object is ignored.
+        raise StandardError, 'parameter "global" should be a GlobalParseContext' unless global.is_a?(GlobalParseContext)
+
+        if obj.is_a? Array
+          obj.each do |o|
+            process_obj global, o if o.is_a? Hash
+          end
+        elsif obj.is_a? Hash
+          process_obj global, obj
+        end
+      end
+
+      private
+
+      # Process the contents of the supplied array
+      def self.process_array(global, the_array, k, value)
+
+        return [k, value] if value.length.zero?
+        field_count = value[0].length
+        return [k, value] if field_count.zero?
+
+        # Get the class for the 'of' field of the array.
+        clazz = global.classs the_array.of
+        raise StandardError, 'No class with id or name =' + the_array.of + ' could be found.' if clazz.nil?
+
+        # Get the *assign array from the class and make sure we have an entry of size field_count
+        assignment_list = clazz.keylist_of_length field_count
+        raise StandardError, 'No assignment list of length ' + field_count.to_s + ' for class with id or name =' + the_array.of + ' could be found.' if assignment_list.nil?
+
+        result = []
+
+        value.each do |record|
+          object = {}
+          i = 0
+          assignment_list.each do |field|
+            field_class = global.classs field
+            if field_class
+              object[field_class.name_or_id] = record[i]
+            else
+              object[field] = record[i]
+            end
+            i += 1
+          end
+          result << object
+        end
+
+        return [the_array.name_or_id, result]
+      end
+
+      # Replace the existing object with the new array instance and a new key
+      # We need to keep the same key order, hence this method below
+      def self.replace_value(obj, old_k, new_k, new_v)
+        tmp = obj.dup
+        obj.clear
+        tmp.keys.each do |tmpk|
+          tmpv = tmp[tmpk]
+          if tmpk == old_k
+            obj[new_k] = new_v
+          else
+            obj[tmpk] = tmpv
+          end
+        end
+      end
+
+      def self.process_obj(global, obj)
+        obj.keys.each do |k|
+          value = obj[k]
+          # Does the key refer to an array that we have parsed or loaded?
+          the_array = global.arrays(k)
+          if the_array
+            # Yes so convert this value to an instance of that array
+            new_k, new_v = process_array global, the_array, k, value
+            # Replace the existing object with the new array instance and a new key
+            # We need to keep the same key order, hence this method below
+            replace_value obj, k, new_k, new_v
+          else
+            new_v = value
+          end
+          # Recurse into the value in case it has contents that also refer to arrays.
+          process global, new_v
+        end
+      end
+
+    end
+  end
+end

data/lib/modl/parser/class_processor.rb

@@ -57,7 +57,7 @@ module MODL
             new_k, new_v = process_class global, k, value
             # Replace the existing object with the new class instance and a new key
             # We need to keep the same key order, hence this method below
-            replaceValue(obj, k, new_k, new_v)
+            replace_value(obj, k, new_k, new_v)
           else
             new_v = value
           end
@@ -66,7 +66,7 @@ module MODL
         end
       end
 
-      def self.replaceValue(obj, old_k, new_k, new_v)
+      def self.replace_value(obj, old_k, new_k, new_v)
         tmp = obj.dup
         obj.clear
         tmp.keys.each do |tmpk|
@@ -252,7 +252,7 @@ module MODL
 
             # Replace the value for this key if we've changed anything.
             if new_value[new_k] != new_v
-              replaceValue(new_value, new_k, new_k, new_v)
+              replace_value(new_value, new_k, new_k, new_v)
             end
           end
         elsif new_value.is_a?(Array)

data/lib/modl/parser/file_importer.rb

@@ -49,7 +49,7 @@ module MODL
           force = file_name.end_with?('!')
           file_name = Sutil.head(file_name) if force
           file_name << '.modl' unless file_name.end_with?('.txt', '.modl')
-          file_name, new_val = RefProcessor.deref file_name, global if file_name.include?('%')
+          file_name, _new_val = RefProcessor.deref file_name, global if file_name.include?('%')
           if force
             # Don't use the cache if we're forcing a reload.
             @cache.evict(file_name)

data/lib/modl/parser/global_parse_context.rb

@@ -56,6 +56,9 @@ module MODL
         @syntax_version = 1
         @interpreter_syntax_version = 1
         @loaded_files = []
+        # Arrays
+        @arrays_by_id = {}
+        @arrays_by_name = {}
       end
 
       def loaded_file(str)
@@ -103,6 +106,17 @@ module MODL
         end
       end
 
+      def arrays(key)
+        if key.is_a? String
+          result = @arrays_by_id[key]
+          result = @arrays_by_name[key] if result.nil?
+          result
+        elsif key.is_a? MODLArray
+          @arrays_by_id[key.id] = key if key.id
+          @arrays_by_name[key.name] = key if key.name
+        end
+      end
+
       def merge_pairs(other)
         @pairs.merge!(other.all_pairs)
       end
@@ -125,6 +139,10 @@ module MODL
         @classes_by_id.keys.include?(key) || @classes_by_name.keys.include?(key)
       end
 
+      def has_array?(key)
+        @arrays_by_id.keys.include?(key) || @arrays_by_name.keys.include?(key)
+      end
+
       def has_user_method?(key)
         @methods_hash.keys.include?(key)
       end

data/lib/modl/parser/interpreter.rb

@@ -27,6 +27,7 @@ require 'modl/parser/MODLParserVisitor'
 require 'modl/parser/MODLLexer'
 require 'modl/parser/MODLParser'
 require 'modl/parser/class_processor'
+require 'modl/parser/array_processor'
 require 'modl/parser/orphan_handler'
 require 'modl/parser/parser'
 require 'json'
@@ -68,6 +69,7 @@ module MODL
 
     # Process any class definitions used by the MODL file.
     MODL::Parser::ClassProcessor.process(parsed.global, interpreted)
+    MODL::Parser::ArrayProcessor.process(parsed.global, interpreted)
     MODL::Parser::InstructionProcessor.process(parsed.global, interpreted)
     # If the result is a simple string then just return it.
     interpreted

data/lib/modl/parser/modl_array.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+# The MIT License (MIT)
+#
+# Copyright (c) 2019 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
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+module MODL
+  module Parser
+    # Represents a *array defined, or loaded by, a MODL document.
+    class MODLArray
+      attr_accessor :id
+      attr_accessor :name
+      attr_accessor :of
+
+      def initialize
+        @content = {}
+      end
+
+      def name_or_id
+        @name.nil? ? @id : @name
+      end
+    end
+
+    # Extract an array from a ParsedPair object
+    class ArrayExtractor
+      def self.extract(pair, global)
+        return unless pair.type == 'array'
+
+        the_array = MODLArray.new
+        map = pair.map if pair.map
+        map = pair.valueItem&.value&.map if pair.valueItem&.value&.map
+
+        map.mapItems.each do |item|
+          next unless item&.pair&.type
+
+          case item&.pair&.type
+          when 'id'
+            str_value = item.pair.valueItem.value.primitive.string.string
+            the_array.id = str_value
+          when 'name'
+            str_value = item.pair.valueItem.value.primitive.string.string
+            the_array.name = str_value
+          when 'of'
+            str_value = item.pair.valueItem.value.primitive.string.string
+            the_array.of = str_value
+          else
+            # Ignore
+          end
+        end
+
+        raise InterpreterError, 'Missing id for *array' if the_array.id.nil?
+
+        # Make sure the array name isn't redefining an existing array
+        if !global.has_array?(the_array.id) && !global.has_array?(the_array.name)
+
+          # store the arrays by id and name to make them easier to find later
+          global.arrays(the_array)
+        else
+          id = the_array.id.nil? ? 'undefined' : the_array.id
+          name = the_array.name.nil? ? 'undefined' : the_array.name
+          raise InterpreterError, '*Array name or id already defined - cannot redefine: ' + id + ', ' + name
+        end
+      end
+    end
+  end
+end

data/lib/modl/parser/parsed.rb

@@ -30,6 +30,7 @@ require 'modl/parser/file_importer'
 require 'antlr4/runtime/parse_cancellation_exception'
 require 'modl/parser/sutil'
 require 'modl/parser/modl_class'
+require 'modl/parser/modl_array'
 require 'modl/parser/modl_method'
 require 'modl/parser/modl_index'
 require 'modl/parser/modl_keylist'
@@ -211,6 +212,8 @@ module MODL
           @final = false
           @file_importer = FileImporter.instance
           @loaded = false
+          @array = nil
+          @map = nil
         end
 
         def find_property(key)
@@ -284,6 +287,7 @@ module MODL
           return if @type == 'import'
           return if @type == 'allow'
           return if @type == 'expect'
+          return if @type == 'array'
 
           {@key => @text}
         end
@@ -336,6 +340,8 @@ module MODL
           case @type
           when 'class'
             ClassExtractor.extract(self, @global)
+          when 'array'
+            ArrayExtractor.extract(self, @global)
           when 'id'
             extract_value
           when 'name'
@@ -478,6 +484,8 @@ module MODL
           @type = 'hidden' if @key.start_with? '_'
           @type = 'allow' if @key.downcase == '*allow'
           @type = 'expect' if @key.downcase == '*expect'
+          @type = 'of' if @key.downcase == '*of'
+          @type = 'array' if @key.downcase == '*array'
         end
       end
 

data/lib/modl/parser/ref_processor.rb

@@ -22,7 +22,6 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-require 'modl/parser/parsed'
 require 'punycode'
 require 'modl/parser/sutil'
 

data/lib/modl/parser/version.rb

@@ -24,6 +24,6 @@
 
 module MODL
   module Parser
-    VERSION = "0.3.15"
+    VERSION = "0.3.16"
   end
 end

data/modl.gemspec

@@ -25,6 +25,6 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_runtime_dependency 'antlr4-runtime', '= 0.2.8'
+  spec.add_runtime_dependency 'antlr4-runtime', '= 0.2.9'
   spec.add_runtime_dependency 'punycode4r', '>= 0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: modl
 version: !ruby/object:Gem::Version
-  version: 0.3.15
+  version: 0.3.16
 platform: ruby
 authors:
 - Tony Walmsley
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-05 00:00:00.000000000 Z
+date: 2019-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.2.8
+        version: 0.2.9
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.2.8
+        version: 0.2.9
 - !ruby/object:Gem::Dependency
   name: punycode4r
   requirement: !ruby/object:Gem::Requirement
@@ -113,12 +113,14 @@ files:
 - lib/modl/parser/MODLParserBaseVisitor.rb
 - lib/modl/parser/MODLParserListener.rb
 - lib/modl/parser/MODLParserVisitor.rb
+- lib/modl/parser/array_processor.rb
 - lib/modl/parser/class_processor.rb
 - lib/modl/parser/evaluator.rb
 - lib/modl/parser/file_importer.rb
 - lib/modl/parser/global_parse_context.rb
 - lib/modl/parser/instruction_processor.rb
 - lib/modl/parser/interpreter.rb
+- lib/modl/parser/modl_array.rb
 - lib/modl/parser/modl_class.rb
 - lib/modl/parser/modl_index.rb
 - lib/modl/parser/modl_keylist.rb