expressir 0.2.17 → 0.2.25

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4ec7d4c5f988f9f9c3e207eacac5e729fc64bf2b70b5041a7ce00cb91415eb98
-  data.tar.gz: aa73c35c4613556778fa9aba004288eae2b6d36fb991efe9037267fac49d7836
+  metadata.gz: a32b6c4d99c4dd5082bf3bf9d2e7f6a93f86eae043a9dda49e8ffe37e1082479
+  data.tar.gz: 0eef9e070668c5ec37daff443516ea9c8afa1b01ed63d85833bdff0e1b5755cc
 SHA512:
-  metadata.gz: 061b689a64c92fe4bc9bef807cd4b2235b113940cfba75634ec5db19c0150fae0125bae41195e109d774bd9b9fc66c9d45569f9f6ce6fc684095af1f4419de13
-  data.tar.gz: 91374c2fff06437dc65ea5c394596126db47b960fbcccaa9d87c3a48cae7c0792c793c7ab199d9107e4fe03b7cf5160a39f45611131826f5eec7af80fd3c9c56
+  metadata.gz: 89180457dad6e288d406ebb565cf13bc11366205d4bcd9b99a3b5d994fba26c3db6b599cf1da4c084e5ccc2323eedc9df871b1c79f126048da52aa9e38be8a25
+  data.tar.gz: 343ee264593bde6ba7f459eb2170cc37db44a2fdc322814cedcd1b59a009b642d8ca9814cc21db2d6d733db127e7ad3484f46a62c7967a475be21c9869485bd6

data/.github/workflows/rake.yml

@@ -43,3 +43,8 @@ jobs:
       - run: bundle exec rake compile
 
       - run: bundle exec rake
+
+      - uses: actions/upload-artifact@v2
+        with:
+          name: express_parser-${{ matrix.os }}-${{ matrix.ruby }}
+          path: lib/expressir/express_exp/express_parser.so

data/.github/workflows/release.yml

@@ -1,13 +1,38 @@
 name: release
 
 on:
+  workflow_dispatch:
+    inputs:
+      next_version:
+        description: |
+          Next release version. Possible values: x.y.z, major, minor, patch or pre|rc|etc
+        required: true
+        default: 'patch'
   push:
     tags: [ v* ]
-  workflow_dispatch:
 
 jobs:
+  bump:
+    runs-on: ubuntu-18.04
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          submodules: recursive
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '2.6'
+
+      - if: ${{ github.event_name == 'workflow_dispatch' }} # unfortunatelly cannot keep this condition on job level
+        run: |
+          git config user.name github-actions
+          git config user.email github-actions@github.com
+          gem install gem-release
+          gem bump --version ${{ github.event.inputs.next_version }} --tag --push
+
   pack:
     runs-on: ubuntu-18.04
+    needs: bump
     strategy:
       fail-fast: false
       matrix:
@@ -20,9 +45,12 @@ jobs:
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: '2.6'
+          # bundler-cache: true important to not use cache because it leads to "cannot find -lrice"
+          # more info https://github.com/lutaml/expressir/runs/2097658383?check_suite_focus=true#step:7:2126
 
       - run: bundle install --jobs 4 --retry 3
 
+      # build gem WITHOUT pre-built native extension
       - run: gem build expressir.gemspec
 
       - if: matrix.host == 'linux'
@@ -31,6 +59,7 @@ jobs:
           name: pkg-ruby
           path: expressir-*.gem
 
+      # build gem WITH pre-built native extension
       - run: bundle exec rake gem:${{ matrix.host }}
 
       - uses: actions/upload-artifact@v2
@@ -38,8 +67,7 @@ jobs:
           name: pkg-${{ matrix.host }}
           path: pkg/*.gem
 
-
-  release:
+  publish:
     runs-on: ubuntu-18.04
     needs: pack
     steps:

data/README.adoc

@@ -1,8 +1,8 @@
 = Expressir: EXPRESS in Ruby
 
-image:https://github.com/lutaml/expressir/workflows/ubuntu/badge.svg[ubuntu]
-image:https://github.com/lutaml/expressir/workflows/macos/badge.svg[macos]
-image:https://github.com/lutaml/expressir/workflows/windows/badge.svg[windows]
+image:https://img.shields.io/gem/v/expressir.svg["Gem Version", link="https://rubygems.org/gems/expressir"]
+// image:https://codeclimate.com/github/lutaml/expressir/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/lutaml/expressir"]
+image:https://github.com/lutaml/expressir/workflows/rake/badge.svg["Build Status", link="https://github.com/lutaml/expressir/actions?workflow=rake"]
 
 == Purpose
 

data/exe/format

@@ -1,10 +1,12 @@
 #!/usr/bin/env ruby
 
 require "yaml"
+require "tempfile"
 require "expressir/express_exp/parser"
 require "expressir/express_exp/formatter"
 require "expressir/express_exp/schema_head_formatter"
 require "expressir/express_exp/hyperlink_formatter"
+require "expressir/express_exp/cache"
 
 exp_files = [
   # basic test
@@ -22,44 +24,58 @@ exp_files = [
   # '../iso-10303-stepmod/data/resources/iso13584_expressions_schema/iso13584_expressions_schema.exp',
   # annotated-express test (12s)
   # see https://github.com/metanorma/annotated-express/blob/master/data/documents/resources/fundamentals_of_product_description_and_support/sections/04-schemas.adoc
-  # '../iso-10303-stepmod/data/resources/action_schema/action_schema_annotated.exp',
-  # '../iso-10303-stepmod/data/resources/application_context_schema/application_context_schema_annotated.exp',
-  # '../iso-10303-stepmod/data/resources/approval_schema/approval_schema_annotated.exp',
-  # '../iso-10303-stepmod/data/resources/basic_attribute_schema/basic_attribute_schema_annotated.exp',
-  # '../iso-10303-stepmod/data/resources/certification_schema/certification_schema_annotated.exp',
-  # '../iso-10303-stepmod/data/resources/contract_schema/contract_schema_annotated.exp',
-  # '../iso-10303-stepmod/data/resources/date_time_schema/date_time_schema_annotated.exp',
-  # '../iso-10303-stepmod/data/resources/document_schema/document_schema.exp',
-  # '../iso-10303-stepmod/data/resources/effectivity_schema/effectivity_schema_annotated.exp',
-  # '../iso-10303-stepmod/data/resources/experience_schema/experience_schema_annotated.exp',
-  # '../iso-10303-stepmod/data/resources/external_reference_schema/external_reference_schema_annotated.exp',
-  # '../iso-10303-stepmod/data/resources/group_schema/group_schema_annotated.exp',
-  # '../iso-10303-stepmod/data/resources/language_schema/language_schema_annotated.exp',
-  # '../iso-10303-stepmod/data/resources/location_schema/location_schema_annotated.exp',
-  # '../iso-10303-stepmod/data/resources/management_resources_schema/management_resources_schema_annotated.exp',
-  # '../iso-10303-stepmod/data/resources/measure_schema/measure_schema_annotated.exp',
-  # '../iso-10303-stepmod/data/resources/person_organization_schema/person_organization_schema_annotated.exp',
-  # '../iso-10303-stepmod/data/resources/process_property_schema/process_property_schema_annotated.exp',
-  # '../iso-10303-stepmod/data/resources/product_definition_schema/product_definition_schema_annotated.exp',
-  # '../iso-10303-stepmod/data/resources/product_property_definition_schema/product_property_definition_schema_annotated.exp',
-  # '../iso-10303-stepmod/data/resources/product_property_representation_schema/product_property_representation_schema_annotated.exp',
-  # '../iso-10303-stepmod/data/resources/qualifications_schema/qualifications_schema_annotated.exp',
-  # '../iso-10303-stepmod/data/resources/security_classification_schema/security_classification_schema_annotated.exp',
-  # '../iso-10303-stepmod/data/resources/support_resource_schema/support_resource_schema_annotated.exp',
+  '../iso-10303-stepmod/data/resources/action_schema/action_schema_annotated.exp',
+  '../iso-10303-stepmod/data/resources/application_context_schema/application_context_schema_annotated.exp',
+  '../iso-10303-stepmod/data/resources/approval_schema/approval_schema_annotated.exp',
+  '../iso-10303-stepmod/data/resources/basic_attribute_schema/basic_attribute_schema_annotated.exp',
+  '../iso-10303-stepmod/data/resources/certification_schema/certification_schema_annotated.exp',
+  '../iso-10303-stepmod/data/resources/contract_schema/contract_schema_annotated.exp',
+  '../iso-10303-stepmod/data/resources/date_time_schema/date_time_schema_annotated.exp',
+  '../iso-10303-stepmod/data/resources/document_schema/document_schema.exp',
+  '../iso-10303-stepmod/data/resources/effectivity_schema/effectivity_schema_annotated.exp',
+  '../iso-10303-stepmod/data/resources/experience_schema/experience_schema_annotated.exp',
+  '../iso-10303-stepmod/data/resources/external_reference_schema/external_reference_schema_annotated.exp',
+  '../iso-10303-stepmod/data/resources/group_schema/group_schema_annotated.exp',
+  '../iso-10303-stepmod/data/resources/language_schema/language_schema_annotated.exp',
+  '../iso-10303-stepmod/data/resources/location_schema/location_schema_annotated.exp',
+  '../iso-10303-stepmod/data/resources/management_resources_schema/management_resources_schema_annotated.exp',
+  '../iso-10303-stepmod/data/resources/measure_schema/measure_schema_annotated.exp',
+  '../iso-10303-stepmod/data/resources/person_organization_schema/person_organization_schema_annotated.exp',
+  '../iso-10303-stepmod/data/resources/process_property_schema/process_property_schema_annotated.exp',
+  '../iso-10303-stepmod/data/resources/product_definition_schema/product_definition_schema_annotated.exp',
+  '../iso-10303-stepmod/data/resources/product_property_definition_schema/product_property_definition_schema_annotated.exp',
+  '../iso-10303-stepmod/data/resources/product_property_representation_schema/product_property_representation_schema_annotated.exp',
+  '../iso-10303-stepmod/data/resources/qualifications_schema/qualifications_schema_annotated.exp',
+  '../iso-10303-stepmod/data/resources/security_classification_schema/security_classification_schema_annotated.exp',
+  '../iso-10303-stepmod/data/resources/support_resource_schema/support_resource_schema_annotated.exp',
   # full test (6m18s + 8s = 6m26s)
-  *`bundle exec ../stepmod-utils/exe/stepmod-find-express-files ../iso-10303-stepmod`.strip.split("\n").map{|file| File.exists?(file.sub(/\.exp$/, '_annotated.exp')) ? file.sub(/\.exp$/, '_annotated.exp') : file}
+  # *`bundle exec ../stepmod-utils/exe/stepmod-find-express-files ../iso-10303-stepmod`.strip.split("\n").map{|file| File.exists?(file.sub(/\.exp$/, '_annotated.exp')) ? file.sub(/\.exp$/, '_annotated.exp') : file}
 ]
 
 start = Time.now
 repository = Expressir::ExpressExp::Parser.from_files(exp_files)
-puts "Parsing time: #{Time.now - start}"
-start2 = Time.now
+puts "Parser.from_files time:  #{(Time.now - start).round(2)}s"
+
+temp_file = Tempfile.new
+begin
+  start = Time.now
+  Expressir::ExpressExp::Cache.to_file(temp_file, repository)
+  puts "Cache.to_file time:      #{(Time.now - start).round(2)}s"
+
+  start = Time.now
+  repository = Expressir::ExpressExp::Cache.from_file(temp_file)
+  puts "Cache.from_file time:    #{(Time.now - start).round(2)}s"
+ensure
+  temp_file.close
+  temp_file.unlink
+end
+
+start = Time.now
 formatter = Class.new(Expressir::ExpressExp::Formatter) do
   include Expressir::ExpressExp::SchemaHeadFormatter
   include Expressir::ExpressExp::HyperlinkFormatter
 end
 result = repository.to_hash(formatter: formatter, skip_empty: true)
-puts "Formatting & serializing time: #{Time.now - start2}"
-puts "Total time: #{Time.now - start}"
+puts "Repository.to_hash time: #{(Time.now - start).round(2)}s"
 
 # puts YAML.dump(result)

data/ext/express-parser/extconf.rb

@@ -37,6 +37,8 @@ if cross_build
   if RbConfig::CONFIG['target_os'] =~ /mingw32|mswin/
     # workaround for 'w64-mingw32-as: express_parser.o: too many sections'
     $CXXFLAGS << " -O3 -Wa,-mbig-obj"
+    # workaround for LoadError: 127: The specified procedure could not be found.
+    $DLDFLAGS << " -static -static-libgcc -static-libstdc++"
   end
 else
   require 'mkmf-rice'

data/lib/expressir/express_exp/cache.rb

@@ -0,0 +1,48 @@
+require 'yaml'
+require 'zlib'
+require 'expressir/model'
+
+module Expressir
+  module ExpressExp
+    class Cache
+      def self.to_file(file, content, options = {})
+        root_path = options[:root_path]
+        test_overwrite_version = options[:test_overwrite_version] # don't use, only for tests
+
+        version = test_overwrite_version || VERSION
+
+        cache = Model::Cache.new({
+          version: version,
+          content: content
+        })
+
+        hash = cache.to_hash(root_path: root_path, skip_empty: true)
+        yaml = YAML.dump(hash)
+        yaml_compressed = Zlib::Deflate.deflate(yaml)
+
+        File.binwrite(file, yaml_compressed)
+      end
+
+      def self.from_file(file, options = {})
+        root_path = options[:root_path]
+        test_overwrite_version = options[:test_overwrite_version] # don't use, only for tests
+
+        version = test_overwrite_version || VERSION
+
+        yaml_compressed = File.binread(file)
+        yaml = Zlib::Inflate.inflate(yaml_compressed)
+        hash = YAML.load(yaml)
+        cache = Model::ModelElement.from_hash(hash, root_path: root_path)
+
+        if cache.version != version
+          raise CacheLoadError.new("Cache version mismatch, cache version is #{cache.version}, Expressir version is #{version}")
+        end
+
+        cache.content
+      end
+    end
+
+    class CacheLoadError < StandardError
+    end
+  end
+end

data/lib/expressir/express_exp/formatter.rb

@@ -1502,7 +1502,7 @@ module Expressir
             [
               '(*',
               '"',
-              node.path,
+              node.path || node.id,
               '"',
             ].join(''),
             remark,
@@ -1512,7 +1512,7 @@ module Expressir
           [
             '--',
             '"',
-            node.path,
+            node.path || node.id,
             '"',
             ' ',
             remark

data/lib/expressir/express_exp/hyperlink_formatter.rb

@@ -2,25 +2,20 @@ module Expressir
   module ExpressExp
     module HyperlinkFormatter
       def format_expressions_simple_reference(node)
-        return node.id if node.parent.is_a? Model::Expressions::AttributeReference
+        return node.id unless node.base_path
 
-        # skip hyperlink if target node can't be found
-        target_node = if node.parent.is_a? Model::InterfaceItem
-          node.find("#{node.parent.parent.schema.id}.#{node.parent.ref.id}")
-        else
-          node.find(node.id)
+        # find closest node with path
+        current_node = node
+        while !current_node.path
+          current_node = current_node.parent
         end
-        return node.id unless target_node
 
-        # skip hyperlink for implicit scopes
-        return node.id if target_node.is_a? Model::Statements::Alias or target_node.is_a? Model::Statements::Repeat or target_node.is_a? Model::Expressions::QueryExpression
+        # skip if this reference and target node are in the same node with path
+        node_base_path_parts = node.base_path.split(".")
+        current_node_path_parts = current_node.path.split(".")
+        return node.id if node_base_path_parts[0..1] == current_node_path_parts[0..1]
 
-        # skip hyperlink if this node and target node are in the same main item
-        node_path_parts = node.path.split(".")
-        target_node_path_parts = target_node.path.split(".")
-        return node.id if node_path_parts[0..1] == target_node_path_parts[0..1]
-
-        "{{{<<express:#{target_node.path},#{node.id}>>}}}"
+        "{{{<<express:#{node.base_path},#{node.id}>>}}}"
       end
     end
   end

data/lib/expressir/express_exp/model_visitor.rb

@@ -0,0 +1,23 @@
+require "expressir/model"
+
+module Expressir
+  module ExpressExp
+    class ModelVisitor
+      def visit(node)
+        node.class.model_attrs.each do |variable|
+          value = node.send(variable)
+
+          if value.is_a? Array
+            value.each do |value|
+              if value.is_a? Model::ModelElement
+                visit(value)
+              end
+            end
+          elsif value.is_a? Model::ModelElement
+            visit(value)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/expressir/express_exp/parser.rb

@@ -5,6 +5,7 @@ rescue LoadError
   require_relative "express_parser"
 end
 require 'expressir/express_exp/visitor'
+require 'expressir/express_exp/resolve_references_model_visitor'
 
 =begin
 char_stream = Antlr4::Runtime::CharStreams.from_string(input, 'String')
@@ -25,6 +26,8 @@ module Expressir
   module ExpressExp
     class Parser
       def self.from_file(file, options = {})
+        skip_references = options[:skip_references]
+
         input = File.read(file)
 
         parser = ::ExpressParser::Parser.parse(input)
@@ -34,15 +37,24 @@ module Expressir
         visitor = Visitor.new(parser.tokens, options)
         repository = visitor.visit(parse_tree)
 
-        repository.schemas.each{|schema| schema.file = file}
+        repository.schemas.each do |schema|
+          schema.file = file.to_s
+        end
+
+        unless skip_references
+          resolve_references_model_visitor = ResolveReferencesModelVisitor.new
+          resolve_references_model_visitor.visit(repository)
+        end
 
         repository
       end
 
       def self.from_files(files, options = {})
+        skip_references = options[:skip_references]
+
         schemas = files.each_with_index.map do |file, i|
           # start = Time.now
-          repository = self.from_file(file, options)
+          repository = self.from_file(file, options.merge(skip_references: true))
           # STDERR.puts "#{i+1}/#{files.length} #{file} #{Time.now - start}"
           repository.schemas
         end.flatten
@@ -51,7 +63,10 @@ module Expressir
           schemas: schemas
         })
 
-        repository.schemas.each{|schema| schema.parent = repository}
+        unless skip_references
+          resolve_references_model_visitor = ResolveReferencesModelVisitor.new
+          resolve_references_model_visitor.visit(repository)
+        end
 
         repository
       end

data/lib/expressir/express_exp/resolve_references_model_visitor.rb

@@ -0,0 +1,33 @@
+require "expressir/express_exp/model_visitor"
+require "expressir/model"
+
+module Expressir
+  module ExpressExp
+    class ResolveReferencesModelVisitor < ModelVisitor
+      def visit(node)
+        if node.is_a? Model::Expressions::SimpleReference
+          visit_expressions_simple_reference(node)
+        end
+
+        super
+      end
+
+      def visit_expressions_simple_reference(node)
+        return if node.parent.is_a? Model::Expressions::AttributeReference
+
+        if node.parent.is_a? Model::InterfaceItem
+          base_item = node.find("#{node.parent.parent.schema.id}.#{node.parent.ref.id}")
+        else
+          base_item = node.find(node.id)
+        end
+        return unless base_item
+
+        if base_item.is_a? Model::InterfacedItem
+          base_item = base_item.base_item
+        end
+
+        node.base_path = base_item.path
+      end
+    end
+  end
+end

data/lib/expressir/express_exp/visitor.rb

@@ -107,27 +107,28 @@ module Expressir
         target_node = node.find(path)
         return target_node if target_node
 
-        # check if path should create implicit informal proposal
-        # see https://github.com/lutaml/expressir/issues/50
+        # check if path can create implicit remark item
+        # see https://github.com/lutaml/expressir/issues/78
         rest, _, current_path = path.rpartition(".") # get last path part
         _, _, current_path = current_path.rpartition(":") # ignore prefix
+        parent_node = node.find(rest)
+        if parent_node and parent_node.class.method_defined? :remark_items
+          remark_item = Model::RemarkItem.new({
+            id: current_path
+          })
+          remark_item.parent = parent_node
 
-        # match informal proposition id
-        informal_proposition_id = current_path.match(/^IP\d+$/).to_a[0]
-        return unless informal_proposition_id
-
-        # find informal proposition target
-        target_node = node.find(rest)
-        return unless target_node and target_node.class.method_defined? :informal_propositions
-
-        # create implicit informal proposition
-        informal_proposition = Model::InformalProposition.new({
-          id: informal_proposition_id
-        })
-        target_node.informal_propositions << informal_proposition
-        target_node.reset_children_by_id
-        informal_proposition.parent = target_node
-        informal_proposition
+          # check if path can create implicit informal proposition
+          # see https://github.com/lutaml/expressir/issues/50
+          if parent_node.class.method_defined? :informal_propositions and current_path.match(/^IP\d+$/)
+            parent_node.informal_propositions << remark_item
+          else
+            parent_node.remark_items << remark_item
+          end
+          parent_node.reset_children_by_id
+          
+          remark_item
+        end
       end
 
       def attach_remarks(ctx, node)