rtext 0.8.1 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a2118c8e1de4b2b45d1ce326aba3e9bc67f366fb
-  data.tar.gz: 7a89c7837a7f19bd02b9bdf45788ed93b167d01b
+  metadata.gz: ffae86ba1a7ca648c0b1d81cbe6f35071a1f60ab
+  data.tar.gz: 811cbb7addac61eb840aa6b8ec65290ff2323c88
 SHA512:
-  metadata.gz: 90e517625293d88771632b0497bbd570647f9fc2c62a50457d15aa539853b2ee3d984b6afcbde33bc49461a9a2eab050f06422215aaf29b4638004fbaf1d8efb
-  data.tar.gz: 2b879bfb02ab0c5a251d2662ffbab6b55116fe61ae1b8f21d7224c614d5301edc6c7fac620577a5fa25e248f041c1d56398dbf1741143c7108c6a0297f9af06b
+  metadata.gz: 5051b3111eb4537a900d98fabe77f0970e2ec0af6e7be8f61bfa2e6a2f1b74323579d3159b550ca6e08e9c4fd8b68d95b4b3a0071080474a15d325fa3961b30d
+  data.tar.gz: 7d71c71858cf2a5ffb6a6f43e01e50b03fa4bc3fb05a9ff2cdaea5c295134dc4a0d8b3428ef87451ce737204fbb8a3d5116ff60ff72f2d0f0f1b7a11763553c5

data/CHANGELOG

@@ -1,89 +1,120 @@
-=0.2.0
-
-* First public release
-
-=0.3.0
-
-* Added context sensitive commands
-* Show child role lables in auto completer
-* Show unlabled arguments in auto completer
-* Show only arguments in auto completer which don't have a value yet
-* Fixed auto completion within array values
-* Fixed generation of child role labels in serializer
-* Added :after_load hook to DefaultLoader
-* Added result limit option to DefaultServiceProvider
-* Removed short_class_names option from Language
-
-=0.4.0
-
-* Made instantiator a lot more robust against parse errors
-* Added DefaultLoader option to not reload fragments with errors
-* Added service load progress indication and custom problem severity
-* Fixed serialization of enum literals starting with a digit
-* Fixed used port detection in service
-* Fixed completion option order to match order defined in lanugage
-
-=0.5.0
-
-* Added annotations
-* Added generic value support
-* Added RText frontend support (for Ruby based RText plugins and testing)
-* Changed frontend/backend protocol to JSON over TCP
-* Generally improved completer and context builder, fixed bugs, added tests
-* Added automated frontend/backend tests
-* Added example language (ECore editor)
-* Added configurable backward reference attribute
-* Fixed backward reference resolution in case line ends with name attribute
-* Added more information to unlabled value completion options
-* Added backend service support for lanugage exchange at runtime
-* Extended support for relative reference calculation and resolution
-* Added on_progress hook to default_loader
-* Added explicit handling of encoding
-* Improved backend service progress reporting
-* Fixed backward reference list to not include opposites of forward references
-* Fixed problem with backend service socket connection on some machines
-
-=0.5.1
-
-* Fixed service connection problem when ports are in use by other processes
-
-=0.5.2
-
-* Fixed exception in default service provider when trying to follow a reference on an attribute value
-* Ignore BOM in instantiator
-
-=0.5.3
-
-* Fixed completion of enum values which need to be quoted
-* Added support for BigDecimal
-
-=0.6.0
-
-* Changed service provider interface to allow for more customization
-* Changed Completer into DefaultCompleter to allow for customization
-* Added labeled_containments language parameter
-* Made DefaultLoader robust against missing files
-
-=0.7.0
-
-* Added DefaultResolver and support for custom resolvers for DefaultLoader and DefaultServiceProvider
-* Changed instantiator on_progress proc to take a second argument with the number of progress steps
-* Changed tokenizer to start new tokens immediately after error tokens
-* Fixed line number in instantiator problem report for multiple childs in one-role
-* Fixed unit tests for Ruby 2.0
-* Fixed context builder prefixes for strings
-* Fixed DefaultLoader to let fragments calculate their elements list by themselves
-* Minor performance improvements, mainly for instantiator and when passing large RText messages
-* Improved performance of frontend connector especially for large amounts of data
-
-=0.8.0
-
-* Added line breaks support
-* Fixed problem when there is no whitespace before a curly bracket
-* Fixed problem when loading frontend context extractor in vim
-
-=0.8.1
-
-* Fixed frontend content extraction to support line breaks with backslash
-* Fixed frontend content extraction, joining of broken lines
-
+=0.2.0
+
+* First public release
+
+=0.3.0
+
+* Added context sensitive commands
+* Show child role lables in auto completer
+* Show unlabled arguments in auto completer
+* Show only arguments in auto completer which don't have a value yet
+* Fixed auto completion within array values
+* Fixed generation of child role labels in serializer
+* Added :after_load hook to DefaultLoader
+* Added result limit option to DefaultServiceProvider
+* Removed short_class_names option from Language
+
+=0.4.0
+
+* Made instantiator a lot more robust against parse errors
+* Added DefaultLoader option to not reload fragments with errors
+* Added service load progress indication and custom problem severity
+* Fixed serialization of enum literals starting with a digit
+* Fixed used port detection in service
+* Fixed completion option order to match order defined in lanugage
+
+=0.5.0
+
+* Added annotations
+* Added generic value support
+* Added RText frontend support (for Ruby based RText plugins and testing)
+* Changed frontend/backend protocol to JSON over TCP
+* Generally improved completer and context builder, fixed bugs, added tests
+* Added automated frontend/backend tests
+* Added example language (ECore editor)
+* Added configurable backward reference attribute
+* Fixed backward reference resolution in case line ends with name attribute
+* Added more information to unlabled value completion options
+* Added backend service support for lanugage exchange at runtime
+* Extended support for relative reference calculation and resolution
+* Added on_progress hook to default_loader
+* Added explicit handling of encoding
+* Improved backend service progress reporting
+* Fixed backward reference list to not include opposites of forward references
+* Fixed problem with backend service socket connection on some machines
+
+=0.5.1
+
+* Fixed service connection problem when ports are in use by other processes
+
+=0.5.2
+
+* Fixed exception in default service provider when trying to follow a reference on an attribute value
+* Ignore BOM in instantiator
+
+=0.5.3
+
+* Fixed completion of enum values which need to be quoted
+* Added support for BigDecimal
+
+=0.6.0
+
+* Changed service provider interface to allow for more customization
+* Changed Completer into DefaultCompleter to allow for customization
+* Added labeled_containments language parameter
+* Made DefaultLoader robust against missing files
+
+=0.7.0
+
+* Added DefaultResolver and support for custom resolvers for DefaultLoader and DefaultServiceProvider
+* Changed instantiator on_progress proc to take a second argument with the number of progress steps
+* Changed tokenizer to start new tokens immediately after error tokens
+* Fixed line number in instantiator problem report for multiple childs in one-role
+* Fixed unit tests for Ruby 2.0
+* Fixed context builder prefixes for strings
+* Fixed DefaultLoader to let fragments calculate their elements list by themselves
+* Minor performance improvements, mainly for instantiator and when passing large RText messages
+* Improved performance of frontend connector especially for large amounts of data
+
+=0.8.0
+
+* Added line breaks support
+* Fixed problem when there is no whitespace before a curly bracket
+* Fixed problem when loading frontend context extractor in vim
+
+=0.8.1
+
+* Fixed frontend content extraction to support line breaks with backslash
+* Fixed frontend content extraction, joining of broken lines
+
+=0.8.2
+
+* Fixed serializer negative decimal quotation
+* Added Object attribute test case
+
+=0.9.0
+
+* Added protocol versioning support
+* Added completion options for square brackets and curly braces
+
+=0.9.1
+
+* Fixed backward compatibility issues
+
+=0.9.2
+
+* Fixed frontend connector
+* Fixed frontend tests
+* Automatic conversion of integer and float values to string
+
+=0.9.3
+
+* Added lock file for backend service
+
+=0.9.4
+
+* Fixed issue with unquoted multiline strings
+
+=0.10.0
+
+* Switch to Ruby 2.7

data/Project.yaml

@@ -0,0 +1,15 @@
+name: rtext
+version: 0.10.0
+git: https://github.com/mthiede/rtext.git
+summary: Ruby Textual Modelling
+email: martin dot thiede at gmx de
+homepage: http://ruby-gen.org
+description: RText can be used to derive textual languages from an RGen metamodel with very little effort.
+authors: [Martin Thiede]
+dependencies:
+  http://rubygems.org:
+    - {name: rgen,     version: ['>= 0.9.0', '< 0.10']}
+    - {name: filelock, version: ['>= 1.1.1', '< 1.2']}
+rdoc_options: [--main, README.rdoc, -x, test]
+extra_rdoc_files: [README.rdoc, CHANGELOG, MIT-LICENSE, RText_Users_Guide, RText_Protocol]
+encrypt_sources: false

data/RText_Protocol

@@ -4,6 +4,10 @@ RText frontend and backend pass messages containing JSON objects.
 Normally the frontend invokes a backend command by means of a request message and the 
 backend will eventually reply with a response message. 
 
+== Versioning
+
+RText protocol supports versioning mechanism with a single version natural number.
+The actual version of the protocol is 1.
 
 == Encoding
 
@@ -25,8 +29,8 @@ In addition, the character "%" is escaped in the same way, i.e. "%" will always
 
 Example:
 
-The word "�bung" (german: exercise), encoded in ISO-8859-1 would result in the string:
-"%dcbung" (the "�" Umlaut has a byte value of 0xdc is ISO-8859-1).
+The word "Übung" (german: exercise), encoded in ISO-8859-1 would result in the string:
+"%dcbung" (the "Ü" Umlaut has a byte value of 0xdc is ISO-8859-1).
 
 
 == Request Messages
@@ -34,9 +38,12 @@ The word "
 Each request message contains a field ``command`` and a field ``invocation_id``.
 The command field holds the name of the command to be invoked as a string.
 The invocation id field holds an identifier which will be repeated by the backend's response.
+The "version" field was introduced in version 1. It is optional for protocol version 0 requests,
+but mandatory for newer versions.
 
   {
     "type": "request",
+    "version": <protocol_version [integer]>,
     "command": <command>,
     "invocation_id": <invocation_id>
     ...
@@ -65,6 +72,16 @@ There are a number of error message which may be sent in response to a request m
     "invocation_id": <invocation_id>,
     "command": <unknown command [string]>
   }
+  
+=== Unsupported Protocol Version Error
+
+Introduced in version 1.
+
+  {
+    "type": "unsupported_version",
+    "invocation_id": <invocation_id>,
+    "version": <supported version [integer]>
+  }
 
 == Progress Information
 
@@ -90,6 +107,25 @@ The message field may carry information about the currently ongoing subtask.
 For each command, the layout of the request and response messages will be given below.
 Note that the invocation id field is present in every request and response but is omitted for brevity.
 
+=== Backend version request
+
+Introduced in version 1.
+
+This command requests the backend to disclose its supported protocol version.
+
+  {
+    "type": "request",
+    "command": "version"
+  }
+  
+The backend responds with a version information.
+
+  {
+    "type": "response",
+    "version": <version [integer]>
+  }
+  
+The backend supporting protocool version 0 only responds with an 'Unknown Command Error'.
 
 === Load Model
 
@@ -141,7 +177,14 @@ build the set of context lines in the frontend. Column number start at 1.
   }
 
 The backend replies with a list of completion options. 
-The field ``insert`` holds the text to be inserted if the completion option is chosen.
+The field ``insert`` holds the text to be inserted if the completion option is chosen. This text 
+may contains placeholders for cursor position. An editor may use them to assist a user in 
+filling additional completion fields.
+Each placeholder must start and end with a vertical bar character (``|``) and can contain up to
+three optional parts separated by an additional vertical bar character: ordering number, name and
+description of this cursor position. E.g.: ``||``, ``|1|name|Entity name|``, ``|||New value|``.
+Placeholders with the same name must be considered as the same value repeated in different 
+positions.
 The field ``display`` contains the string which should be displayed to the user in some kind of 
 completion option menu. An optional description field may provide more information about a 
 particular option.
@@ -458,7 +501,7 @@ the parent commands wrapped around it. Any sibling commands can be omitted as we
 any lines containing closing braces and brackets. The order of lines is the same as in the 
 RText file.
 
-Here is an example. Consider the following RText file with the cursor in the line of "Command3" 
+Here is an example. Consider the following RText file with the cursor in the line of "Command5"
 at the time when the auto completion command is issued.
 
   Command1 {

data/lib/rtext/context_builder.rb

@@ -26,7 +26,8 @@ module RText
 #
 module ContextBuilder
 
-  Context = Struct.new(:element, :feature, :prefix, :in_array, :in_block, :after_label, :problem)
+  PositionContext = Struct.new(:in_array, :in_block, :after_label, :after_comma, :before_brace, :before_bracket)
+  Context = Struct.new(:element, :feature, :prefix, :problem, :position, :line_indent, :indent)
 
   class << self
   include RText::Tokenizer
@@ -50,13 +51,37 @@ module ContextBuilder
       else
         feature = nil
       end
-      Context.new(element, feature, context_info.prefix, context_info.in_array, context_info.in_block, after_label, context_info.problem)
+      context_info.position.after_label = after_label
+      Context.new(element, feature, context_info.prefix, context_info.problem, context_info.position,
+                  get_line_indent(context_lines.last), get_indent(context_lines))
     else
-      Context.new(nil, nil, context_info.prefix, context_info.in_array, context_info.in_block, false, context_info.problem)
+      context_info.position.after_label = false
+      Context.new(nil, nil, context_info.prefix, context_info.problem, context_info.position,
+                  get_line_indent(context_lines.last), get_indent(context_lines))
     end
   end
 
   private
+  
+  def get_line_indent(line)
+    return '' unless line
+    match = line.match(/^\s+/)
+    if match.nil?
+      ''
+    else
+      match[0]
+    end
+  end
+  
+  # Compute indent from context lines
+  def get_indent(context_lines)
+    cl = context_lines.dup
+    while true
+      return '  ' if cl.size < 2 # default indentation is 2 spaces
+      indent = get_line_indent(cl.last)[get_line_indent(cl.delete_at(-2)).size..-1]
+      return indent unless indent.nil? || indent.empty?
+    end
+  end
 
   def instantiate_context_element(language, context_info)
     root_elements = []
@@ -72,7 +97,7 @@ module ContextBuilder
   end
 
   def find_leaf_child(element, num_required_children)
-    childs = element.class.ecore.eAllReferences.select{|r| r.containment}.collect{|r|
+    childs = element.class.ecore.eAllReferences.select{|r| r.containment }.collect{|r|
       element.getGenericAsArray(r.name)}.flatten
     if num_required_children == 0
       element
@@ -83,7 +108,7 @@ module ContextBuilder
     end
   end
 
-  ContextInternal = Struct.new(:lines, :num_elements, :role, :prefix, :in_array, :in_block, :problem)
+  ContextInternal = Struct.new(:lines, :num_elements, :role, :prefix, :problem, :position)
 
   # extend +context_lines+ into a set of lines which can be processed by the RText
   def fix_context(language, context_lines, position_in_line)
@@ -95,11 +120,14 @@ module ContextBuilder
     position_in_line ||= context_lines.last.size
     # cut off last line right of cursor
     if position_in_line < 1
-      context_lines.pop
+      tail = context_lines.pop
       context_lines << ""
     else
+      tail = context_lines.last[position_in_line..-1]
       context_lines << context_lines.pop[0..position_in_line-1]
     end
+    before_brace = !tail.nil? && !tail.match(/^\s*\{/).nil?
+    before_bracket = !tail.nil? && !tail.match(/^\s*\[/).nil?
     problem = nil
     line = context_lines.last
     if line =~ /\{\s*$/
@@ -110,7 +138,7 @@ module ContextBuilder
       problem = :after_curly
     end
     
-    num_elements = in_block = in_array = missing_comma = role = prefix = nil
+    num_elements = in_block = in_array = missing_comma = role = prefix = after_comma = nil
     tokens = tokenize(line, language.reference_regexp)
     tokens.pop if tokens.last && tokens.last.kind == :newline
     if tokens.size > 0 && tokens[0].kind == :identifier
@@ -124,6 +152,7 @@ module ContextBuilder
         unlabled_index = 0
         tokens[1..-1].each do |token|
           break if token.kind == :error
+          after_comma = false
           if token.kind == "["
             in_array = true
           elsif token.kind == "]"
@@ -136,6 +165,7 @@ module ContextBuilder
             missing_comma = false
             role = nil unless in_array
             unlabled_index += 1 unless in_array
+            after_comma = true
           end
         end
         if ((tokens.size == 1 && line =~ /\s+$/) || 
@@ -187,6 +217,16 @@ module ContextBuilder
       if context_lines[-2] =~ /^\s*\w+:\s*$/
         context_lines[-1] = context_lines.pop
       end
+    elsif tokens.size == 1 && tokens[0].kind == :label
+      token = tokens[0]
+      role = context_lines.last[token.scol - 1..token.ecol - 2]
+      context_lines << context_lines.pop[0..token.scol - 2]
+      context = fix_context(language, context_lines, context_lines.last.size)
+      context.role = role
+      context.position.in_block = false
+      context.position.before_brace = before_brace
+      context.position.before_bracket = before_bracket
+      return context
     else
       # comment, closing brackets, etc.
       num_elements = 0
@@ -210,7 +250,8 @@ module ContextBuilder
       end
     end
     problem = :missing_comma if !problem && missing_comma
-    ContextInternal.new(context_lines, num_elements, role, prefix, in_array, in_block, problem)
+    ContextInternal.new(context_lines, num_elements, role, prefix, problem,
+                        PositionContext.new(in_array, in_block, false, after_comma, before_brace, before_bracket))
   end
 
   def find_role(context_lines)