modl 0.3.26 → 0.3.27

data/lib/modl/parser/modl_keylist.rb

@@ -1,81 +0,0 @@
-# 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
-    # Extracts an index definition from a ParsedPair
-    class KeylistExtractor
-      def self.extract(pair, item)
-        # the item must be an array of arrays
-        pair.key_lists = []
-        last_keylist_len = 0
-        if item.is_a?(Parsed::ParsedValueItem) && item.value.is_a?(Parsed::ParsedValue) && item.value.array
-          item.value.array.abstractArrayItems.each do |avi|
-            key_list = []
-            avi.arrayValueItem.array.abstractArrayItems.each do |key|
-              key_list << key.arrayValueItem.primitive.string.string if key.arrayValueItem.primitive.string
-              key_list << key.arrayValueItem.primitive.number.num if key.arrayValueItem.primitive.number
-            end
-            if key_list.length > last_keylist_len
-              last_keylist_len = key_list.length
-            else
-              raise InterpreterError, 'Error: Key lists in *assign are not in ascending order of list length: ' + key_list.to_s
-            end
-            pair.key_lists << key_list
-          end
-        elsif item.is_a?(Parsed::ParsedArray)
-          item.abstractArrayItems.each do |avi|
-            key_list = []
-            avi.arrayValueItem.array.abstractArrayItems.each do |key|
-              key_list << key.arrayValueItem.primitive.string.string if key.arrayValueItem.primitive.string
-              key_list << key.arrayValueItem.primitive.number.num if key.arrayValueItem.primitive.number
-            end
-            if key_list.length > last_keylist_len
-              last_keylist_len = key_list.length
-            else
-              raise InterpreterError, 'Error: Key lists in *assign are not in ascending order of list length.'
-            end
-            pair.key_lists << key_list
-          end
-        elsif item.is_a?(Parsed::ParsedValueItem) && !item.value.nbArray.nil?
-          item.value.nbArray.arrayItems.each do |avi|
-            key_list = []
-            avi.arrayValueItem.array.abstractArrayItems.each do |key|
-              key_list << key.arrayValueItem.primitive.string.string if key.arrayValueItem.primitive.string
-              key_list << key.arrayValueItem.primitive.number.num if key.arrayValueItem.primitive.number
-            end
-            if key_list.length > last_keylist_len
-              last_keylist_len = key_list.length
-            else
-              raise InterpreterError, 'Error: Key lists in *assign are not in ascending order of list length.'
-            end
-            pair.key_lists << key_list
-          end
-        else
-          raise InterpreterError, 'Array of arrays expected for: ' + pair.key
-        end
-      end
-    end
-  end
-end

data/lib/modl/parser/modl_method.rb

@@ -1,172 +0,0 @@
-# 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 *method defined by a MODL document.
-    class MODLMethod
-      attr_accessor :id
-      attr_accessor :name
-      attr_accessor :transform
-
-      def name_or_id
-        @name.nil? ? @id : @name
-      end
-
-      # There is a user-defined method transform to run on the str
-      def run(str)
-        # Consume the elements of the transform spec until there are none left.
-        transform = @transform
-        while transform && transform.length > 0
-          if transform.start_with?('replace<') || transform.start_with?('r<')
-            close_bracket = transform.index('>')
-            m = Sutil.head(transform, close_bracket + 1).sub!('replace', 'r')
-            str = StandardMethods.run_method(m, str)
-            # Consume the subst clause
-            close_bracket = transform.index('>')
-            transform = Sutil.tail(transform, close_bracket + 2)
-          elsif transform.start_with?('trim') || transform.start_with?('t<')
-            close_bracket = transform.index('>')
-            m = Sutil.head(transform, close_bracket + 1).sub!('trim', 't')
-            str = StandardMethods.run_method(m, str)
-            # Consume the trunc clause
-            close_bracket = transform.index('>')
-            transform = Sutil.tail(transform, close_bracket + 2)
-          elsif transform.start_with?('initcap') || transform.start_with?('i')
-            str = StandardMethods.run_method('i', str)
-            transform = Sutil.after(transform, '.')
-          elsif transform.start_with?('upcase') || transform.start_with?('u')
-            str = StandardMethods.run_method('u', str)
-            transform = Sutil.after(transform, '.')
-          elsif transform.start_with?('downcase') || transform.start_with?('d')
-            str = StandardMethods.run_method('d', str)
-            transform = Sutil.after(transform, '.')
-          elsif transform.start_with?('sentence') || transform.start_with?('s')
-            str = StandardMethods.run_method('s', str)
-            transform = Sutil.after(transform, '.')
-          elsif transform.start_with?('urlencode') || transform.start_with?('e')
-            str = StandardMethods.run_method('e', str)
-            transform = Sutil.after(transform, '.')
-          else
-            raise InterpreterError, 'NOT IMPLEMENTED'
-          end
-        end
-        str
-      end
-
-    end
-
-    # Extracts a method definition from a ParsedPair
-    class MethodExtractor
-      def self.extract(pair, global)
-        return unless pair.type == 'method'
-
-        mthd = MODLMethod.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'
-            mthd.id = item.pair.valueItem.value.primitive.string.string
-          when 'transform'
-            mthd.transform = item.pair.valueItem.value.primitive.string.string
-          when 'name'
-            mthd.name = item.pair.valueItem.value.primitive.string.string
-          else
-            raise InterpreterError, 'Invalid *method - only *id, *name, and *transform fields expected'
-          end
-        end
-
-        raise InterpreterError, 'Missing id for method' if mthd.id.nil?
-        raise InterpreterError, 'Missing name for method' if mthd.name.nil?
-        raise InterpreterError, 'Duplicate method name or id: ' + mthd.name if global.has_user_method?(mthd.name)
-        raise InterpreterError, 'Duplicate method name or id: ' + mthd.id if global.has_user_method?(mthd.id)
-
-        # store the methods by id and name to make them easier to find later
-        global.user_method_id(mthd.id, mthd)
-        global.user_method(mthd.name, mthd)
-      end
-    end
-
-    class StandardMethods
-
-      @@mthd_names = %w(u d i s e r t p upcase downcase initcap sentence urlencode replace trim punydecode)
-
-      def self.run_method(mthd, str)
-        m = mthd.match(/\w*/)[0]
-        case m
-        when 'u', 'upcase'
-          str.upcase
-        when 'd', 'downcase'
-          str.downcase
-        when 'i', 'initcap'
-          str.split.map(&:capitalize) * ' '
-        when 's', 'sentence'
-          split = str.split
-          split[0].capitalize!
-          split.join(' ')
-        when 'e', 'urlencode'
-          CGI.escape(str)
-        when 'r', 'replace'
-          s1, s2 = get_subst_parts(mthd)
-          str.gsub(s1, s2)
-        when 't', 'trim'
-          s1 = extract_params mthd
-          i = str.index(s1)
-          Sutil.head(str, i)
-        when 'p', 'punydecode'
-          Punycode.decode(str)
-        else
-          str.nil? ? '.' + mthd : str.to_s + '.' + mthd
-        end
-      end
-
-      # Extract the method parameters
-      def self.get_subst_parts(s)
-        # should be of the form .r(s1,s2)
-        result = extract_params(s).split(',')
-        result[0] = '' if result.length.zero? || result[0].nil?
-        result[1] = '' if result.length == 1 || result[1].nil?
-        result
-      end
-
-      # Extract the method parameter
-      def self.extract_params(str)
-        # should be of the form .r(s1,s2)
-        Sutil.between(str, '<', '>')
-      end
-
-      def self.valid_method?(mthd)
-        m = mthd
-        if m.include?('<')
-          m = Sutil.until(m, '<')
-        end
-        return @@mthd_names.include?(m)
-      end
-    end
-  end
-end

data/lib/modl/parser/object_cache.rb

@@ -1,88 +0,0 @@
-# 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
-    # Store any files for up to 1 hour by default.
-    class ObjectCache
-      # A cache record to keep track of the time since an object was last cached.
-      class CacheEntry
-        TTL_ONE_HOUR = 3_600 # seconds
-
-        attr_reader :object
-
-        # Initialiase the CacheEntry with an object and an optional ttl in seconds (default 1 hour)
-        def initialize(object, ttl = nil)
-          ttl = TTL_ONE_HOUR if ttl.nil?
-          @object = object
-          @expiry_time = Time.now + ttl
-        end
-
-        # Check whether the CacheEntry is live
-        def expired?
-          @expiry_time < Time.now
-        end
-      end
-
-      # Set up and empty cache.
-      def initialize
-        @cache = {}
-      end
-
-      # Cache an object with the given key and optional ttl in seconds (default 1 hour)
-      def put(key, object, ttl = nil)
-        @cache[key] = CacheEntry.new(object, ttl) unless key.nil? || object.nil?
-      end
-
-      # Evict a cache entry
-      def evict(key)
-        @cache.delete(key) unless key.nil?
-      end
-
-      # Return the object with the given key if one exists and has not expired.
-      def get(key)
-        # Return nothing if not in the cache or it has expired.
-        return if key.nil?
-
-        entry = @cache[key]
-        return unless entry
-        return if entry.expired?
-
-        # Otherwise return the cached object.
-        # We don't delete the cached entry because we might need to force its use if its expired and offline
-        entry.object
-      end
-
-      # If the file is offline this can be used to retrieve the cached version if we have one.
-      def force_get(key)
-        # Return nothing if not in the cache or it has expired.
-        return if key.nil?
-
-        entry = @cache[key]
-        return unless entry
-        entry.object
-      end
-    end
-  end
-end

data/lib/modl/parser/orphan_handler.rb

@@ -1,98 +0,0 @@
-# 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
-    class OrphanHandler
-      #
-      # Return true if all strings start with '_'
-      #
-      def self.all_hidden(str_array)
-        if str_array && str_array.length > 0
-          str_array.each do |s|
-            return false unless s.start_with?('_')
-          end
-        end
-        true
-      end
-
-      #
-      # Look for any orphan pairs at the top level and adopt them into a map
-      # Its an error if there are duplicate keys or mixed types at the top.
-      #
-      def self.adopt(global, structures)
-        #
-        # Separate out any top-level pairs into a separate hash, checking for duplicates on the way.
-        #
-        if structures
-          pairs = Hash.new
-
-          # This will replace the existing structures array
-          new_structures = []
-
-          structures.each do |s|
-            if s.pair
-              # skip hidden pairs and instructions
-              if s.pair.key.start_with?('*') || s.pair.key.start_with?('_') || s.pair.key == '?'
-                new_structures.push(s)
-                next
-              end
-
-              if pairs.has_key?(s.pair.key)
-                raise InterpreterError, 'Duplicate top level keys are not allowed.'
-              else
-                pairs[s.pair.key] = s
-              end
-            else
-              if pairs.length > 0 && !all_hidden(pairs.keys) && !s.top_level_conditional
-                raise InterpreterError, 'Mixed top-level types are not allowed.'
-              else
-                new_structures.push(s)
-              end
-            end
-          end
-
-          if pairs.length > 0
-            #
-            # Create a map for the pairs and insert them into it.
-            #
-            new_map = MODL::Parser::Parsed::ParsedMap.new(global)
-            pairs.values.each do |p|
-              new_map.mapItems.push p unless p.pair.key.start_with?('_')
-            end
-
-            # Add the map to a new structure and insert it at the front of the structures list
-            new_struct = MODL::Parser::Parsed::ParsedStructure.new(global)
-            new_struct.map = new_map
-            new_structures.unshift(new_struct)
-
-            # Replace the existing structures with the new structures.
-            return new_structures
-          end
-        end
-        structures
-      end
-    end
-  end
-end