modl 0.3.2 → 0.3.3

data/lib/modl/parser/MODLParserBaseListener.rb

@@ -1,7 +1,7 @@
 # Generated from MODLParser.g4 by ANTLR 4.7.2
 require 'antlr4/runtime'
 
-module Modl::Parser
+module MODL::Parser
 
 class MODLParserBaseListener < MODLParserListener
 	 def enterModl(ctx)

data/lib/modl/parser/MODLParserBaseVisitor.rb

@@ -3,7 +3,7 @@
 require 'antlr4/runtime'
 
 
-module Modl::Parser
+module MODL::Parser
 
  class MODLParserBaseVisitor < Antlr4::Runtime::AbstractParseTreeVisitor
 	def visitModl( ctx)

data/lib/modl/parser/MODLParserListener.rb

@@ -1,5 +1,5 @@
 # Generated from MODLParser.g4 by ANTLR 4.7.2
-module Modl::Parser
+module MODL::Parser
 require 'antlr4/runtime'
 
 class MODLParserListener < Antlr4::Runtime::ParseTreeListener

data/lib/modl/parser/MODLParserVisitor.rb

@@ -1,7 +1,7 @@
 # Generated from MODLParser.g4 by ANTLR 4.7.2
 require 'antlr4/runtime'
 
-module Modl::Parser
+module MODL::Parser
 
 class MODLParserVisitor < Antlr4::Runtime::ParseTreeVisitor
 	def visitModl(ctx)

data/lib/modl/parser/class_processor.rb

@@ -1,11 +1,11 @@
-module Modl
+module MODL
   module Parser
     # This class handles the conversion of objects that refer to classes into instances of those classes.
     # It works recursively since class usage can be nested.
     class ClassProcessor
       # How deep can the class structure be?
       MAX_RECURSION_DEPTH = 20
-      # global is a GlobalParseContext and obj is the extracted Array or Hash from Modl::Parser::Parsed.extract_json
+      # 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.

data/lib/modl/parser/evaluator.rb

@@ -1,10 +1,10 @@
-module Modl
+module MODL
   module Parser
     # Evaluate a conditional expression
     class Evaluator
       # Evaluate the given condition
       def self.evaluate(global, condition)
-        return false if global.nil? || !global.is_a?(GlobalParseContext) || !condition.is_a?(Modl::Parser::Parsed::ParsedCondition)
+        return false if global.nil? || !global.is_a?(GlobalParseContext) || !condition.is_a?(MODL::Parser::Parsed::ParsedCondition)
 
         start = 0
         if condition.text
@@ -65,7 +65,7 @@ module Modl
       def self.value(global, k)
         success = false
         if k.is_a?(String) && k.include?('%')
-          value1, _ignore = Modl::Parser::RefProcessor.deref(k, global)
+          value1, _ignore = MODL::Parser::RefProcessor.deref(k, global)
           success = true
         elsif k.is_a?(FalseClass)
           value1 = false
@@ -96,7 +96,7 @@ module Modl
         result = false
         if @key
           if @key.include?('%')
-            value1, _ignore = Modl::Parser::RefProcessor.deref(@key, @global)
+            value1, _ignore = MODL::Parser::RefProcessor.deref(@key, @global)
           else
             key = @key
             ikey = key.to_i
@@ -113,7 +113,7 @@ module Modl
 
           @values.each do |value|
             value2 = value.text
-            value2, _ignore = Modl::Parser::RefProcessor.deref(value2, @global) if value2.is_a?(String) && value2.include?('%')
+            value2, _ignore = MODL::Parser::RefProcessor.deref(value2, @global) if value2.is_a?(String) && value2.include?('%')
             value2 = @global.pair(value.text).text if @global.pair(value.text)
 
             case @operator

data/lib/modl/parser/file_importer.rb

@@ -1,11 +1,15 @@
+require 'singleton'
 require 'modl/parser/object_cache'
 require 'modl/parser/sutil'
 
-module Modl
+module MODL
   module Parser
 
     # This class handled file loading from local or remote file systems.
     class FileImporter
+      include Singleton
+
+      CACHE_DISABLED = true
 
       def initialize
         @cache = ObjectCache.new
@@ -19,10 +23,12 @@ module Modl
 
         file_names.each do |file_name|
           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?('%')
           if force
             # Don't use the cache if we're forcing a reload.
             @cache.evict(file_name)
-            file_name = Sutil.head(file_name)
             parsed = nil
           else
             # Do we have a cached version?
@@ -30,10 +36,8 @@ module Modl
           end
 
           # Did we hit the cache?
-          unless parsed
+          if (parsed.nil? && CACHE_DISABLED) || (CACHE_DISABLED)
             # No.
-            file_name << '.modl' unless file_name.end_with?('.txt', '.modl')
-            file_name, new_val = RefProcessor.deref file_name, global if file_name.include?('%')
 
             begin
               uri = URI(file_name)
@@ -49,9 +53,9 @@ module Modl
             global.loaded_file(file_name)
 
             # Parse the downloaded file ands extract the classes
-            parsed = Modl::Parser::Parser.parse txt, global
+            parsed = MODL::Parser::Parser.parse txt, global
             # Save it for next time
-            @cache.put(file_name, parsed)
+            @cache.put(file_name, parsed) unless CACHE_DISABLED
           end
           # Extract the JSON content and add the classes and pairs to the existing GlobalParseContext hashes.
           parsed.extract_hash

data/lib/modl/parser/global_parse_context.rb

@@ -1,8 +1,8 @@
-module Modl
+module MODL
   module Parser
     # Each time we run the parser on a MODL file we need to keep track of a few things so they can be made available
     # to other areas of the code. This class is the container for that contextual information, which is gathered
-    # as the Modl::Parser:Parsed object processes the parse tree.
+    # as the MODL::Parser:Parsed object processes the parse tree.
     class GlobalParseContext
 
       attr_accessor :syntax_version
@@ -183,7 +183,11 @@ module Modl
       end
 
       def all_pairs
-        @pairs
+        result = {}
+        @pairs.keys.each do |k|
+          result[k] = @pairs[k] unless k.start_with?('*')
+        end
+        result
       end
 
       private

data/lib/modl/parser/instruction_processor.rb

@@ -1,4 +1,4 @@
-module Modl
+module MODL
   module Parser
     # This class handles the conversion of objects that refer to classes into instances of those classes.
     # It works recursively since class usage can be nested.
@@ -51,6 +51,8 @@ module Modl
           return global.transform_list
         when '%*allow'
           return global.allow_list
+        when '%*expect'
+          return global.allow_list
         end
       end
     end

data/lib/modl/parser/interpreter.rb

@@ -6,7 +6,7 @@ require 'modl/parser/class_processor'
 require 'modl/parser/parser'
 require 'json'
 
-module Modl
+module MODL
   # Interpreter-specific errors
   class InterpreterError < StandardError
   end
@@ -15,15 +15,15 @@ module Modl
   # containing the JSON equivalent. The JSON isn't pretty-printed unless pretty is true
   class Interpreter
     def self.interpret(str, pretty = false)
-      # Parse the MODL string into a Modl::Parser::Parsed object.
-      parsed = Modl::Parser::Parser.parse str
+      # Parse the MODL string into a MODL::Parser::Parsed object.
+      parsed = MODL::Parser::Parser.parse str
 
       # Convert the Parsed object into a simpler structure of and Array or Hash
       interpreted = parsed.extract_hash
 
       # Process any class definitions used by the MODL file.
-      Modl::Parser::ClassProcessor.process(parsed.global, interpreted)
-      Modl::Parser::InstructionProcessor.process(parsed.global, interpreted)
+      MODL::Parser::ClassProcessor.process(parsed.global, interpreted)
+      MODL::Parser::InstructionProcessor.process(parsed.global, interpreted)
       # If the result is a simple string then just return it.
       return interpreted if interpreted.is_a? String
 
@@ -35,4 +35,19 @@ module Modl
       end
     end
   end
+
+  # Parse a MODL string and return a hash, array, or String depending on how the MODL is structured.
+  def self.parse(string)
+    # Parse the MODL string into a MODL::Parser::Parsed object.
+    parsed = MODL::Parser::Parser.parse(string)
+
+    # Convert the Parsed object into a simpler structure of and Array or Hash
+    interpreted = parsed.extract_hash
+
+    # Process any class definitions used by the MODL file.
+    MODL::Parser::ClassProcessor.process(parsed.global, interpreted)
+    MODL::Parser::InstructionProcessor.process(parsed.global, interpreted)
+    # If the result is a simple string then just return it.
+    interpreted
+  end
 end

data/lib/modl/parser/modl_class.rb

@@ -1,4 +1,4 @@
-module Modl
+module MODL
   module Parser
     # Represents a *class defined, or loaded by, a MODL document.
     class MODLClass

data/lib/modl/parser/modl_index.rb

@@ -1,4 +1,4 @@
-module Modl
+module MODL
   module Parser
     # Extracts an index definition from a ParsedPair
     class IndexExtractor

data/lib/modl/parser/modl_keylist.rb

@@ -1,4 +1,4 @@
-module Modl
+module MODL
   module Parser
     # Extracts an index definition from a ParsedPair
     class KeylistExtractor

data/lib/modl/parser/modl_method.rb

@@ -1,4 +1,4 @@
-module Modl
+module MODL
   module Parser
     # Represents a *method defined by a MODL document.
     class MODLMethod

data/lib/modl/parser/object_cache.rb

@@ -1,5 +1,5 @@
 
-module Modl
+module MODL
   module Parser
     # Store any files for up to 1 hour by default.
     class ObjectCache

data/lib/modl/parser/parsed.rb

@@ -13,14 +13,14 @@ require 'modl/parser/evaluator'
 require 'cgi'
 require 'net/http'
 
-module Modl
+module MODL
   module Parser
     # This class represents a MODL parse tree for a given MODL object.
     # It tries to process the parse tree as it is generated as much as
     # possible to save revisiting nodes unnecessarily.
     #
     # Many of the method names are generated by ANTLR4 so are not ruby style.
-    class Parsed < Modl::Parser::MODLParserBaseListener
+    class Parsed < MODL::Parser::MODLParserBaseListener
       attr_accessor :structures
       attr_accessor :global
 
@@ -54,7 +54,7 @@ module Modl
       end
 
       # Class to represent a parsed grammar object
-      class ParsedMap < Modl::Parser::MODLParserBaseListener
+      class ParsedMap < MODL::Parser::MODLParserBaseListener
         attr_accessor :mapItems
 
         def initialize(global)
@@ -99,7 +99,7 @@ module Modl
       end
 
       # Class to represent a parsed grammar object
-      class ParsedMapItem < Modl::Parser::MODLParserBaseListener
+      class ParsedMapItem < MODL::Parser::MODLParserBaseListener
         attr_accessor :pair
         attr_accessor :mapConditional
 
@@ -128,7 +128,7 @@ module Modl
       end
 
       # Class to represent a parsed grammar object
-      class ParsedStructure < Modl::Parser::MODLParserBaseListener
+      class ParsedStructure < MODL::Parser::MODLParserBaseListener
         attr_accessor :array
         attr_accessor :pair
         attr_accessor :top_level_conditional
@@ -168,7 +168,7 @@ module Modl
       end
 
       # Class to represent a parsed grammar object
-      class ParsedPair < Modl::Parser::MODLParserBaseListener
+      class ParsedPair < MODL::Parser::MODLParserBaseListener
         attr_accessor :key
         attr_accessor :map
         attr_accessor :array
@@ -182,7 +182,7 @@ module Modl
           @global = global
           @needs_defref = true
           @final = false
-          @file_importer = FileImporter.new
+          @file_importer = FileImporter.instance
         end
 
         def find_property(key)
@@ -259,6 +259,7 @@ module Modl
           return if @type == 'method'
           return if @type == 'import'
           return if @type == 'allow'
+          return if @type == 'expect'
 
           {@key => @text}
         end
@@ -443,11 +444,12 @@ module Modl
           @type = 'index' if @key == '?'
           @type = 'hidden' if @key.start_with? '_'
           @type = 'allow' if @key.downcase == '*allow'
+          @type = 'expect' if @key.downcase == '*expect'
         end
       end
 
       # Class to represent a parsed grammar object
-      class ParsedArrayValueItem < Modl::Parser::MODLParserBaseListener
+      class ParsedArrayValueItem < MODL::Parser::MODLParserBaseListener
         attr_accessor :map
         attr_accessor :array
         attr_accessor :pair
@@ -503,7 +505,7 @@ module Modl
       end
 
       # Class to represent a parsed grammar object
-      class ParsedValueItem < Modl::Parser::MODLParserBaseListener
+      class ParsedValueItem < MODL::Parser::MODLParserBaseListener
         attr_accessor :value
         attr_accessor :valueConditional
 
@@ -535,7 +537,7 @@ module Modl
       end
 
       # Class to represent a parsed grammar object
-      class ParsedValue < Modl::Parser::MODLParserBaseListener
+      class ParsedValue < MODL::Parser::MODLParserBaseListener
         attr_accessor :map
         attr_accessor :array
         attr_accessor :nbArray
@@ -608,7 +610,7 @@ module Modl
       end
 
       # Class to represent a parsed grammar object
-      class ParsedPrimitive < Modl::Parser::MODLParserBaseListener
+      class ParsedPrimitive < MODL::Parser::MODLParserBaseListener
         attr_accessor :quoted
         attr_accessor :number
         attr_accessor :trueVal
@@ -729,7 +731,7 @@ module Modl
       end
 
       # Class to represent a parsed grammar object
-      class ParsedConditionTest < Modl::Parser::MODLParserBaseListener
+      class ParsedConditionTest < MODL::Parser::MODLParserBaseListener
         attr_accessor :subConditionList
 
         def initialize(global)
@@ -806,7 +808,7 @@ module Modl
       end
 
       # Class to represent a parsed grammar object
-      class ParsedConditionGroup < Modl::Parser::MODLParserBaseListener
+      class ParsedConditionGroup < MODL::Parser::MODLParserBaseListener
         attr_accessor :conditionsTestList
 
         def initialize(global)
@@ -845,7 +847,7 @@ module Modl
       end
 
       # Class to represent a parsed grammar object
-      class ParsedCondition < Modl::Parser::MODLParserBaseListener
+      class ParsedCondition < MODL::Parser::MODLParserBaseListener
         attr_accessor :values
         attr_accessor :operator
         attr_accessor :text
@@ -878,7 +880,7 @@ module Modl
       end
 
       # Class to represent a parsed grammar object
-      class ParsedMapConditionalReturn < Modl::Parser::MODLParserBaseListener
+      class ParsedMapConditionalReturn < MODL::Parser::MODLParserBaseListener
         attr_accessor :mapItems
 
         def initialize(global)
@@ -903,7 +905,7 @@ module Modl
       end
 
       # Class to represent a parsed grammar object
-      class ParsedMapConditional < Modl::Parser::MODLParserBaseListener
+      class ParsedMapConditional < MODL::Parser::MODLParserBaseListener
         attr_accessor :conditionTests
         attr_accessor :mapConditionalReturns
 
@@ -917,7 +919,7 @@ module Modl
           result = @conditionTests[0].evaluate
           return @mapConditionalReturns[0].extract_hash if result
 
-          @mapConditionalReturns[1].extract_hash
+          @mapConditionalReturns[1].extract_hash if @mapConditionalReturns.length > 1
         end
 
         def enterModl_map_conditional(ctx)
@@ -946,7 +948,7 @@ module Modl
       end
 
       # Class to represent a parsed grammar object
-      class ParsedTopLevelConditionalReturn < Modl::Parser::MODLParserBaseListener
+      class ParsedTopLevelConditionalReturn < MODL::Parser::MODLParserBaseListener
         attr_accessor :structures
 
         def initialize(global)
@@ -979,7 +981,7 @@ module Modl
       end
 
       # Class to represent a parsed grammar object
-      class ParsedTopLevelConditional < Modl::Parser::MODLParserBaseListener
+      class ParsedTopLevelConditional < MODL::Parser::MODLParserBaseListener
         attr_accessor :conditionTests
         attr_accessor :topLevelConditionalReturns
 
@@ -1038,7 +1040,7 @@ module Modl
       end
 
       # Class to represent a parsed grammar object
-      class ParsedArrayConditionalReturn < Modl::Parser::MODLParserBaseListener
+      class ParsedArrayConditionalReturn < MODL::Parser::MODLParserBaseListener
         attr_accessor :arrayItems
 
         def initialize(global)
@@ -1063,7 +1065,7 @@ module Modl
       end
 
       # Class to represent a parsed grammar object
-      class ParsedArrayConditional < Modl::Parser::MODLParserBaseListener
+      class ParsedArrayConditional < MODL::Parser::MODLParserBaseListener
         attr_accessor :conditionTest
         attr_accessor :arrayConditionalReturns
 
@@ -1109,7 +1111,7 @@ module Modl
       end
 
       # Class to represent a parsed grammar object
-      class ParsedValueConditionalReturn < Modl::Parser::MODLParserBaseListener
+      class ParsedValueConditionalReturn < MODL::Parser::MODLParserBaseListener
         attr_accessor :valueItems
 
         def initialize(global)
@@ -1136,7 +1138,7 @@ module Modl
       end
 
       # Class to represent a parsed grammar object
-      class ParsedValueConditional < Modl::Parser::MODLParserBaseListener
+      class ParsedValueConditional < MODL::Parser::MODLParserBaseListener
         attr_accessor :conditionTests
         attr_accessor :valueConditionalReturns
 
@@ -1187,7 +1189,7 @@ module Modl
       end
 
       # Class to represent a parsed grammar object
-      class ParsedNbArray < Modl::Parser::MODLParserBaseListener
+      class ParsedNbArray < MODL::Parser::MODLParserBaseListener
         attr_accessor :arrayItems
 
         def initialize(global)
@@ -1260,7 +1262,7 @@ module Modl
       end
 
       # Class to represent a parsed grammar object
-      class ParsedArray < Modl::Parser::MODLParserBaseListener
+      class ParsedArray < MODL::Parser::MODLParserBaseListener
         # We now have a list of < array_item | nb_array >
         attr_accessor :abstractArrayItems
 
@@ -1339,7 +1341,7 @@ module Modl
       end
 
       # Class to represent a parsed grammar object
-      class ParsedArrayItem < Modl::Parser::MODLParserBaseListener
+      class ParsedArrayItem < MODL::Parser::MODLParserBaseListener
         attr_accessor :arrayValueItem
         attr_accessor :arrayConditional
 
@@ -1372,17 +1374,17 @@ module Modl
       end
 
       # Singleton class to represent a true value
-      class ParsedTrue < Modl::Parser::MODLParserBaseListener
+      class ParsedTrue < MODL::Parser::MODLParserBaseListener
         include Singleton
       end
 
       # Singleton class to represent a false value
-      class ParsedFalse < Modl::Parser::MODLParserBaseListener
+      class ParsedFalse < MODL::Parser::MODLParserBaseListener
         include Singleton
       end
 
       # Singleton class to represent a null value
-      class ParsedNull < Modl::Parser::MODLParserBaseListener
+      class ParsedNull < MODL::Parser::MODLParserBaseListener
         include Singleton
       end
 

data/lib/modl/parser/parser.rb

@@ -1,20 +1,20 @@
 require 'modl/parser/throwing_error_listener'
 require 'modl/parser/parsed'
 
-module Modl
+module MODL
   module Parser
 
     # This class converts the input string into a Modl:Parser::Parsed object for further processing.
     class Parser
       def self.parse(str, global = nil)
         begin
-          lexer = Modl::Parser::MODLLexer.new(Antlr4::Runtime::CharStreams.from_string(str, 'String'))
+          lexer = MODL::Parser::MODLLexer.new(Antlr4::Runtime::CharStreams.from_string(str, 'String'))
           lexer.remove_error_listeners
           lexer.add_error_listener ThrowingErrorListener.instance
 
           tokens = Antlr4::Runtime::CommonTokenStream.new(lexer)
 
-          parser = Modl::Parser::MODLParser.new(tokens)
+          parser = MODL::Parser::MODLParser.new(tokens)
           parser.remove_error_listeners
           parser.add_error_listener ThrowingErrorListener.instance
 

data/lib/modl/parser/ref_processor.rb

@@ -4,7 +4,7 @@ require 'modl/parser/parsed'
 require 'punycode'
 require 'modl/parser/sutil'
 
-module Modl
+module MODL
   module Parser
     # Convert MODL reference to the replacement value
     class RefProcessor
@@ -59,7 +59,7 @@ module Modl
                     str.sub(ref, nv_text.to_s)
                   end
             new_value = nil
-          elsif new_value.is_a?(Modl::Parser::MODLParserBaseListener)
+          elsif new_value.is_a?(MODL::Parser::MODLParserBaseListener)
             if new_value.text
               str = if ref == str
                       new_value.text
@@ -92,7 +92,7 @@ module Modl
           parts.each do |p|
             if p.include?('%')
               p, _ignore = expand(global, p)
-              if p.is_a?(Modl::Parser::MODLParserBaseListener)
+              if p.is_a?(MODL::Parser::MODLParserBaseListener)
                 p = p.text
               end
             end

data/lib/modl/parser/substitutions.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Modl
+module MODL
   module Parser
     # Escape-sequence replacements for MODL files.
     class Substitutions

data/lib/modl/parser/throwing_error_listener.rb

@@ -1,6 +1,6 @@
 require 'antlr4/runtime/parse_cancellation_exception'
 
-module Modl::Parser
+module MODL::Parser
   class ThrowingErrorListener
     include Singleton
 

data/lib/modl/parser/version.rb

@@ -1,5 +1,5 @@
-module Modl
+module MODL
   module Parser
-    VERSION = "0.3.2"
+    VERSION = "0.3.3"
   end
 end

data/modl.gemspec

@@ -1,32 +1,31 @@
 
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "modl/parser/version"
+require 'modl/parser/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "modl"
-  spec.version       = Modl::Parser::VERSION
-  spec.authors       = ["Tony Walmsley"]
-  spec.email         = ["tony@aosd.co.uk"]
+  spec.name          = 'modl'
+  spec.version       = MODL::Parser::VERSION
+  spec.authors       = ['Tony Walmsley']
+  spec.email         = ['tony@aosd.co.uk']
 
-  spec.summary       = %q{The ANTLR4 Lexer and Parser for MODL generated using the Ruby language target.}
-  spec.description   = %q{Contains the base Lexer, Parser, and supporting classes for a MODL parser.}
-  spec.homepage      = "https://github.com/MODLanguage/ruby-interpreter"
-  spec.license       = "MIT"
+  spec.summary       = 'The ANTLR4 Lexer and Parser for MODL generated using the Ruby language target.'
+  spec.description   = 'Contains the base Lexer, Parser, and supporting classes for a MODL parser.'
+  spec.homepage      = 'https://github.com/MODLanguage/ruby-interpreter'
+  spec.license       = 'MIT'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  #spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency 'antlr4-runtime', '>= 0.0.1'
-  spec.add_runtime_dependency 'antlr4-runtime', '>= 0.2.1'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_runtime_dependency 'antlr4-runtime', '= 0.2.1'
   spec.add_runtime_dependency 'punycode4r', '>= 0.2.0'
 end