bel_parser 1.0.0.alpha.7 → 1.0.0.alpha.8

data/lib/bel_parser/parsers/ast/node.rb

@@ -13,14 +13,13 @@ module BELParser
 
       # BEL application-specific AST node.
       #
-      # All BEL AST nodes have a basic set of properties. Additional properties
-      # may be specified by subclasses. Each class in the hierarchy describes
-      # its type through the class variable _ast_type_. This is equivalent to
-      # its _type_ instance variable but the former is not used by the AST
-      # library itself.
+      # All BEL AST nodes have a basic set of properties. Additional
+      # properties may be specified by subclasses. Each class in
+      # the hierarchy describes its type through the class variable
+      # _ast_type_. This is equivalent to its _type_ instance variable
+      # but the former is not used by the AST library itself.
       #
-      # @see Node.ast_type
-      # @see Node.initialize
+      # @see Node.ast_type @see Node.initialize
       #
       class Node < ::AST::Node
         # AST node type
@@ -30,17 +29,17 @@ module BELParser
 
         # New BEL AST node.
         #
-        # @param [Symbol] type The node type symbol
-        # @param [Array] children Optional children of node
-        # @param [Hash] properties Optional supported node properties
+        # @param [Symbol] type The node type symbol @param [Array]
+        # children Optional children of node @param [Hash] properties
+        # Optional supported node properties
         #
-        # === Supported properties
-        # - +line_number+ -> {#line_number}
-        # - +character_range+ -> {#character_range}, {#range_start},
+        # === Supported properties - +line_number+ -> {#line_number} -
+        # +character_range+ -> {#character_range}, {#range_start},
         #   {#range_end}
         # - +complete+ -> {#complete?}
         #
-        # @raise ArgumentError If _children_ is not an Array or _properties_
+        # @raise ArgumentError If _children_ is not an Array or
+        # _properties_
         #        is not a Hash
         def initialize(type, children = [], properties = {})
           AST.assert_is_a(Array, children, 'children')
@@ -48,20 +47,19 @@ module BELParser
           super(type, children, properties)
         end
 
-        # Get the class AST node type.
-        # @return [Symbol]
+        # Get the class AST node type.  @return [Symbol]
         class << self; attr_reader :ast_type end
 
-        # Get whether this class AST node has semantics.
-        # @return [boolean]
+        # Get whether this class AST node has semantics.  @return
+        # [boolean]
         class << self; attr_reader :has_semantics end
 
         # Get the line number where this AST node originates.
         attr_reader :line_number
 
-        # Get the character range enclosing this AST node.
-        # It is defined as the close interval containing all the characters
-        # of this AST node.
+        # Get the character range enclosing this AST node.  It is defined
+        # as the close interval containing all the characters of this
+        # AST node.
         attr_reader :character_range
 
         # Get the syntax errors for this AST node.
@@ -112,8 +110,7 @@ module BELParser
         end
 
         def freeze
-          # no freeze...nothing
-          # I want to be able to modify properties!
+          # no freeze...nothing I want to be able to modify properties!
           self
         end
 
@@ -128,7 +125,8 @@ module BELParser
           end
         end
 
-        # Concatenates `array` with `children` and returns the resulting node.
+        # Concatenates `array` with `children` and returns the resulting
+        # node.
         #
         # @return [Node]
         def concat(array)
@@ -209,8 +207,7 @@ module BELParser
 
       # AST node representing the function of a BEL term.
       #
-      # === Special node properties
-      # - _return_type_: {#return_type}
+      # === Special node properties - _return_type_: {#return_type}
       #
       class Function < Node
         # AST node type
@@ -294,13 +291,13 @@ module BELParser
         end
 
         # Determine if this is a URL domain.
-        def has_url?
+        def url?
           children[0] && children[0].is_a?(Url)
         end
 
         # Get the domain's Url.
         def url
-          has_url? ? children[0] : nil
+          url? ? children[0] : nil
         end
       end
 
@@ -409,12 +406,12 @@ module BELParser
         end
 
         # Does the argument have a {Parameter} child?
-        def has_parameter?
+        def parameter?
           children[0].is_a?(Parameter)
         end
 
         # Does the argument have a {Term} child?
-        def has_term?
+        def term?
           children[0].is_a?(Term)
         end
 
@@ -505,12 +502,38 @@ module BELParser
 
         # Get what is being set.
         def name
-          # TODO: access children for content
+          children[0]
         end
 
         # Get the value of what is being set.
         def value
-          # TODO: access children for content
+          children[1]
+        end
+      end
+
+      # AST node representing a document property (e.g. +SET DOCUMENT
+      # ...+).
+      class DocumentProperty < Node
+        # AST node type
+        @ast_type = :document_property
+        # DocumentProperty has semantics (what was set?)
+        @has_semantics = true
+
+        # New DocumentProperty AST node.
+        #
+        # @see Node#initialize Node class for basic properties
+        def initialize(children = [], properties = {})
+          super(DocumentProperty.ast_type, children, properties)
+        end
+
+        # Get what is being set.
+        def name
+          children[0]
+        end
+
+        # Get the value of what is being set.
+        def value
+          children[1]
         end
       end
 
@@ -533,30 +556,30 @@ module BELParser
           children[0]
         end
 
-        def has_relationship?
+        def relationship?
           children[1] && children[1].is_a?(Relationship)
         end
 
         # Get the relationship of the nested statement.
         def relationship
-          has_relationship? ? children[1] : nil
+          relationship? ? children[1] : nil
         end
 
-        def has_object?
+        def object?
           children[2] && children[2].is_a?(Object)
         end
 
         # Get the object of the nested statement.
         def object
-          has_object? ? children[2] : nil
+          object? ? children[2] : nil
         end
 
-        def has_comment?
+        def comment?
           children[-1] && children[-1].is_a?(Comment)
         end
 
         def comment
-          has_comment? ? children[-1] : nil
+          comment? ? children[-1] : nil
         end
       end
 
@@ -574,20 +597,10 @@ module BELParser
           super(NestedStatement.ast_type, children, properties)
         end
 
-        # Get the subject of the statement.
-        def subject
+        # Get the statement.
+        def statement
           children[0]
         end
-
-        # Get the relationship of the nested statement.
-        def relationship
-          children[1]
-        end
-
-        # Get the object of the nested statement.
-        def object
-          children[2]
-        end
       end
 
       # AST node representing a observed term statement.
@@ -604,8 +617,8 @@ module BELParser
           super(ObservedTerm.ast_type, children, properties)
         end
 
-        # Get the subject of the statement.
-        def subject
+        # Get the statement.
+        def statement
           children[0]
         end
       end
@@ -624,20 +637,10 @@ module BELParser
           super(SimpleStatement.ast_type, children, properties)
         end
 
-        # Get the subject of the statement.
-        def subject
+        # Get the statement.
+        def statement
           children[0]
         end
-
-        # Get the relationship of the nested statement.
-        def relationship
-          children[1]
-        end
-
-        # Get the object of the nested statement.
-        def object
-          children[2]
-        end
       end
 
       # AST node representing the subject of a statement.
@@ -675,12 +678,12 @@ module BELParser
         end
 
         # Does the object have a {Term} child?
-        def has_term?
+        def term?
           children[0].is_a?(Term)
         end
 
         # Does the object have a {Statement} child?
-        def has_statement?
+        def statement?
           children[0].is_a?(Statement)
         end
 
@@ -735,16 +738,17 @@ module BELParser
         end
 
         # Get the term's function semantics.
-        def function_semantics
-          @function_semantics
-        end
+        attr_reader :function_semantics
 
         # Sets the term's function semantics.
         def function_semantics=(function_semantics)
-          if function_semantics != nil && !function_semantics.is_a?(BELParser::Language::Signature)
-            raise ArgumentError, "function_semantics: expected nil or BELParser::Language::Signature"
+          if !function_semantics.nil? &&
+             !function_semantics.is_a?(BELParser::Language::Signature)
+            raise(
+              ArgumentError,
+              'function_semantics: expected nil or Signature')
           end
-          assign_properties({function_semantics: function_semantics})
+          assign_properties(function_semantics: function_semantics)
         end
       end
 
@@ -768,10 +772,28 @@ module BELParser
         end
       end
 
+      # AST node representing a name.
+      class Name < Node
+        # AST node type
+        @ast_type = :name
+        # Name has semantics (name of property or annotation).
+        @has_semantics = true
+
+        # New Name AST node.
+        #
+        # @see Node#initialize Node class for basic properties
+        def initialize(children = [], properties = {})
+          super(Name.ast_type, children, properties)
+        end
+
+        def identifier
+          children[0]
+        end
+      end
+
       # AST node representing a value.
       #
-      # === Special node properties
-      # - _encoding_: {#encoding}
+      # === Special node properties - _encoding_: {#encoding}
       #
       class Value < Node
         # AST node type
@@ -790,6 +812,10 @@ module BELParser
         attr_reader :encoding
       end
 
+      # Sexp defines a module that creates {BELParser::Parsers::AST::Node
+      # AST nodes} using S-expression syntax.
+      #
+      # @see https://en.wikipedia.org/wiki/S-expression S-expression
       module Sexp
         def nested_statement(*children)
           NestedStatement.new(children)
@@ -839,6 +865,10 @@ module BELParser
           Prefix.new(children)
         end
 
+        def name(*children)
+          Name.new(children)
+        end
+
         def value(*children)
           Value.new(children)
         end
@@ -871,6 +901,14 @@ module BELParser
           BlankLine.new
         end
 
+        def set(*children)
+          Set.new(children)
+        end
+
+        def document_property(*children)
+          DocumentProperty.new(children)
+        end
+
         def annotation_definition(*children)
           AnnotationDefinition.new(children)
         end

data/lib/bel_parser/parsers/bel_script/set.rl

@@ -35,7 +35,7 @@
   }
 
   set :=
-	  SET_KW %set_keyword
+    SET_KW %set_keyword
     SP+
     IDENT %name
     SP+