expressir 0.2.7-x86-linux

data/bin/rspec

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/demo.rb

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+require 'expressir'
+require 'expressir/express_exp/parser'
+
+# This file is from:
+# https://github.com/metanorma/annotated-express/blob/master/data/resources/action_schema/action_schema.exp
+file = 'action_schema.exp'
+
+# repo = Expressir::ExpressExp::Parser.from_exp(file)
+# schema = repo.schemas.find{|schema| schema.id == "support_resource_schema"}
+
+repo = Expressir::ExpressExp::Parser.from_exp(file)
+schema = repo.schemas.find{|schema| schema.id == "action_schema"}
+entity = schema.entities.find{|entity| entity.id == "action_directive_relationship"}
+where = entity.where.find{|where| where.id == "WR1"}
+
+puts where.inspect

data/docs/development.md

@@ -0,0 +1,90 @@
+## Development Plan
+
+This document is a draft to understand the basic of the original library, and
+how the whole tool chain is working at the moment. Once, we've an understanding
+then let's look at the potential area of improvement, and plan out a high level
+plan to start the development.
+
+### What is it, expressir?
+
+* Expressir is a ruby tool to harvest iso express data model
+* Express is one of the language to represent data model
+* Expressir tool is used to manipulate iso express data model
+* The input for the expressir is a standard xml document
+* XML Spec: http://stepmod.sourceforge.net/express_model_spec/
+* Expressir does the job of representing express model as ruby class
+* REXML-based parser that reads EXPRESS as XML and creates the dictionary (i.e.
+  instances of the EXPRESS Ruby Classes) and then calls a mapper, that may be
+  specified as an option at runtime
+* Mappers that read the EXPRESS dictionary and perform the conversion to the
+  desired language or format
+* Express to UML2 Mapper - Convert the express model to UML2
+* Express to OWL Structure - Convert the express model to OWL Structure
+* Ruby API generator for express language
+* Current Ruby API is super slow, it takes 2 hours to generate 400 entity
+
+### How does the original version work?
+
+At the core the `expressir.rb` is responsible for everything at moment, it takes
+an Express XML file as an input and then it parses that XML file and build the
+correct ruby interface for further processing.
+
+This `expressir.rb` also expect one mapping file `deafult to mapping.rb`, and it
+also expect the file to specify a custom method `map_from_express` to take the
+`Ruby Express Representation` and convert this ruby representation to the
+desire output format.
+
+The library also provides couple mapping for UM2, OWL and SysML, so anyone can
+export their data to any of those format if necessary, and the use cases for
+those library are as following:
+
+```ruby
+ruby expressir.rb expxml=<schema.xml> map=<mapping_owl.rb>
+```
+
+### What are potential improvement area?
+
+* The interface is not well defined, someone needs to dig deeper to understand
+  just the basic of the library and how to use for their use cases. This is
+  something that could be improved as initial step.
+* At the moment, these are some ruby files, so potentially we could group those
+  together as a CLI tool and group some of the common functionality, and provide
+  a straight forward interface for users.
+* The good part about this library is author had the extensibility in mind from
+  the beginning, so we should keep that functionality as flexible as possible.
+* There are lot of boilerplate code in the library, but it's understandable as
+  it was written quite long time ago, so maybe most of the tool was not even
+  available back then, so this is the another area we could improve.
+* Another improvement we could do in terms of actual codebase, we should be able
+  to refactor this library and cleanup as much as possible.
+
+### What are the initial changes?
+
+Initially, we can start by creating a ruby cli gem, group these functionality
+together. This could be named as `expressir`, and this gem will be shipped with an
+executable called `expressir`.
+
+Second of all, let's add some dedicated interface for the default type, so user
+does not need to know all the details but the name of the interface, for example
+we could expose the transformation as follows:
+
+```sh
+# Convert to owl
+expressir express2owl file=[express_xml_file] [**options]
+
+# Convert to UML
+expressir express2uml file=[express_xml_file] [**options]
+
+# Convert to SysML
+expressir express2sysml file=[express_xml_file] [**options]
+
+# Custom conversion
+expressir express2custom file=[express_xml_file] mapping=[custom_mapping.rb]
+```
+
+Third of all once this library is functional as the original version then we
+will go through each of the existing types, and refactor those as necessary.
+
+### References
+
+* https://martinfowler.com/bliki/MovingToNokogiri.html

data/exe/expressir

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+# resolve bin path, ignoring symlinks
+require "pathname"
+bin_file = Pathname.new(__FILE__).realpath
+
+# add self to libpath
+$:.unshift File.expand_path("../../lib", bin_file)
+
+# Fixes https://github.com/rubygems/rubygems/issues/1420
+require "rubygems/specification"
+
+class Gem::Specification
+  def this; self; end
+end
+
+# start up the CLI
+require "expressir"
+Expressir::Cli.start(ARGV)

data/exe/generate-parser

@@ -0,0 +1,48 @@
+#!/usr/bin/env ruby
+
+require 'fileutils'
+require 'antlr4-native'
+
+grammar_file = ARGV.shift
+
+# ANTLR does weird things if the grammar file isn't in the current working directory
+temp_grammar_file = File.join(FileUtils.pwd(), File.basename(grammar_file))
+FileUtils.cp(grammar_file, temp_grammar_file)
+
+# generate parser
+generator = Antlr4Native::Generator.new(
+  grammar_files: [File.basename(temp_grammar_file)],
+  output_dir: 'ext',
+  parser_root_method: 'syntax'
+)
+generator.generate
+
+# fix issues with generated parser
+parser_source_file = File.join(*%w(ext express-parser express_parser.cpp))
+parser_source_lines = File.read(parser_source_file).split(/\n/)
+
+# - add ParserProxy tokens method, simple compensation for missing exposed BufferedTokenStream
+i = parser_source_lines.index{|x| x == '  Object syntax() {'}
+parser_source_lines[i + 6] += "\n" + <<~CPP.split(/\n/).map{|x| x != "" ? "  " + x : x}.join("\n") + "\n"
+  Array getTokens() {
+    Array a;
+
+    std::vector<Token*> tokens = this -> tokens -> getTokens();
+
+    for (auto &token : tokens) {
+      a.push(token);
+    }
+
+    return a;
+  }
+CPP
+i = parser_source_lines.index{|x| x == '    .define_method("syntax", &ParserProxy::syntax)'}
+parser_source_lines[i] += "\n" + <<~CPP.split(/\n/).map{|x| x != "" ? "    " + x : x}.join("\n")
+  .define_method("tokens", &ParserProxy::getTokens)
+CPP
+
+# write fixed parser file
+File.write(parser_source_file, parser_source_lines.join("\n") + "\n")
+
+# cleanup
+FileUtils.rm(temp_grammar_file)

data/expressir.gemspec

@@ -0,0 +1,43 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "expressir/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "expressir"
+  spec.version       = Expressir::VERSION
+  spec.authors       = ["Ribose Inc."]
+  spec.email         = ["open.source@ribose.com'"]
+
+  spec.summary       = "ISO EXPRESS parser in Ruby, tools for accessing EXPRESS data models."
+  spec.description   = "ISO EXPRESS parser in Ruby, tools for accessing EXPRESS data models."
+  spec.homepage      = "https://github.com/lutaml/expressir"
+  spec.license       = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "https://github.com/lutaml/expressir/releases"
+
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  spec.files         = `git ls-files`.split("\n")\
+    + Dir.glob('ext/express-parser/antlr4-upstream/runtime/Cpp/runtime/**/*')
+
+  spec.test_files    = `git ls-files -- {spec}/*`.split("\n")
+
+  spec.bindir        = "exe"
+  spec.require_paths = ["lib"]
+  spec.executables   = %w[expressir]
+
+  spec.extensions = File.join(*%w(ext express-parser extconf.rb))
+
+  spec.add_runtime_dependency "nokogiri", "~> 1.10"
+  spec.add_runtime_dependency "thor", "~> 1.0"
+  spec.add_runtime_dependency "rice", "~> 2.2.0"
+  spec.add_development_dependency "antlr4-native", "~> 1.1.0"
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "pry", "~> 0.12.2"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake-compiler", "~> 1.1"
+  spec.add_development_dependency "rake-compiler-dock", "~> 1.1"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/expressir/cli/ui.rb

@@ -0,0 +1,36 @@
+require "thor"
+
+module Expressir
+  module Cli
+    class UI < Thor
+      def self.ask(message)
+        new.ask(message)
+      end
+
+      def self.say(message)
+        new.say(message)
+      end
+
+      def self.error(message)
+        if log_types.include?("error")
+          new.error(message)
+        end
+      end
+
+      def self.info(message)
+        if log_types.include?("info")
+          new.say(message)
+        end
+      end
+
+      def self.run(command)
+        require "open3"
+        Open3.capture3(command)
+      end
+
+      def self.log_types
+        Expressir.configuration.logs.map(&:to_s) || []
+      end
+    end
+  end
+end

data/lib/expressir/cli.rb

@@ -0,0 +1,27 @@
+require "thor"
+require "expressir/cli/ui"
+require "expressir/express_parser"
+
+module Expressir
+  module Cli
+    def self.ui
+      Expressir::Cli::UI
+    end
+
+    def self.start(args)
+      Base.start(args)
+    end
+
+    class Base < Thor
+      desc "version", "The Expressir Version"
+      def version
+        Cli.ui.say("Version #{Expressir::VERSION}")
+      end
+
+      desc "express-to-owl FILE", "Express to OWL conversion"
+      def express_to_owl(file)
+        Cli.ui.say(ExpressParser.to_owl(file))
+      end
+    end
+  end
+end

data/lib/expressir/config.rb

@@ -0,0 +1,23 @@
+module Expressir
+  module Config
+    def configure
+      if block_given?
+        yield configuration
+      end
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+  end
+
+  class Configuration
+    attr_accessor :logs
+
+    def initialize
+      @logs ||= %i(error)
+    end
+  end
+
+  extend Config
+end

data/lib/expressir/express/aggregate_dimension.rb

@@ -0,0 +1,38 @@
+module Expressir
+  module Express
+    class AggregateDimension
+      attr_accessor :aggrtype, :lower, :upper, :isUnique, :isOptionalArray
+
+      def initialize(options = {})
+        @aggrtype = "SET"
+        @lower = "0"
+        @upper = "?"
+        @isUnique = false
+        @isOptionalArray = false
+
+        @options = options
+      end
+
+      def parse
+        document = @options.fetch(:document, nil)
+        extract_attributes(document) if document
+
+        self
+      end
+
+      def self.parse(document)
+        new(document: document).parse
+      end
+
+      private
+
+      def extract_attributes(document)
+        @aggrtype = document.attributes["type"]
+        @lower = document.attributes["lower"]
+        @upper = document.attributes["upper"]
+        @isUnique = document.attributes["unique"] == "YES"
+        @isOptionalArray = document.attributes["optional"] == "YES"
+      end
+    end
+  end
+end

data/lib/expressir/express/attribute.rb

@@ -0,0 +1,15 @@
+require "expressir/express/model_element"
+
+module Expressir
+  module Express
+    class Attribute < ModelElement
+      attr_accessor :name, :entity, :domain, :redeclare_entity,
+        :redeclare_oldname
+
+      def initialize
+        @redeclare_entity = nil
+        @redeclare_oldname = nil
+      end
+    end
+  end
+end

data/lib/expressir/express/comment.rb

@@ -0,0 +1,7 @@
+module Expressir
+  module Express
+    class Comment
+      attr_accessor :comment, :ModelElement
+    end
+  end
+end

data/lib/expressir/express/defined_type.rb

@@ -0,0 +1,36 @@
+require "expressir/express/named_type"
+
+module Expressir
+  module Express
+    class DefinedType < NamedType
+      def initialize(options = {})
+        @options = options
+        @schema = options.fetch(:schema)
+      end
+
+      def parse
+        document = @options.fetch(:document)
+        extract_type_attributes(document)
+
+        self
+      end
+
+      def self.parse(document, schema)
+        new(document: document, schema: schema).parse
+      end
+
+      private
+
+      def extract_type_attributes(document)
+        @name = document.attributes["name"].to_s
+        @wheres = extract_where_rules(document)
+      end
+
+      def extract_where_rules(document)
+        document.xpath("where").map do |where|
+          Express::WhereRule.parse(where)
+        end
+      end
+    end
+  end
+end

data/lib/expressir/express/derived.rb

@@ -0,0 +1,65 @@
+module Expressir
+  module Express
+    class Derived < ExplicitOrDerived
+      attr_accessor :expression
+
+      def initialize(options = {})
+        @options = options
+        @entity = options.fetch(:entity, nil)
+      end
+
+      def parse
+        document = @options.fetch(:document, nil)
+        extract_common_attributes(document)
+        extract_type_specific_attributes(document)
+
+        self
+      end
+
+      def self.parse(document, entity)
+        new(document: document, entity: entity).parse
+      end
+
+      private
+
+      def extract_type_specific_attributes(document); end
+
+      def extract_common_attributes(document)
+        @name = document.attributes["name"].to_s
+        @expression = document.attributes["expression"].to_s
+        @domain = extract_domain_name(document.xpath("typename"))
+
+        extract_builtintype_attributes(document)
+        extract_redeclaration_attributes(document)
+      end
+
+      def extract_domain_name(typename)
+        unless typename.empty?
+          typename.first.attributes["name"].to_s
+        end
+      end
+
+      def extract_redeclaration_attributes(document)
+        redeclaration = document.xpath("redeclaration").first
+
+        if redeclaration
+          @redeclare_entity = redeclaration.attributes["entity-ref"].to_s
+          old_name = redeclaration.attributes["old_name"]
+          @redeclare_oldname = old_name.to_s if old_name
+        end
+      end
+
+      def extract_builtintype_attributes(document)
+        builtin_type = document.xpath("builtintype").first
+
+        if builtin_type
+          @isBuiltin = true
+          @domain = builtin_type.attributes["type"].to_s
+          @width = builtin_type.attributes["width"].to_s
+          @fixed = builtin_type.attributes["fixed"] == "YES"
+          @precision = builtin_type.attributes["precision"].to_s
+        end
+      end
+    end
+  end
+end

data/lib/expressir/express/derived_aggregate.rb

@@ -0,0 +1,43 @@
+module Expressir
+  module Express
+    class DerivedAggregate < Derived
+      attr_accessor :rank, :dimensions
+
+      def initialize(options = {})
+        @rank = 0
+        @dimensions = []
+
+        super(options)
+      end
+
+      private
+
+      def extract_type_specific_attributes(document)
+        @dimensions = document.xpath("aggregate").map do |aggregate|
+          Express::AggregateDimension.parse(aggregate)
+        end
+
+        @rank = @dimensions.size
+        extract_inverse_aggregate(document)
+      end
+
+      # @todo: Non existance attributes
+      #
+      # In the codebase, they are trying to add couple of aggregate
+      # dimensions related attributes that was never a part of the
+      # Explict class, but for consistency we are keeping those as
+      # it is for now. let's revist those later and fix it.
+      #
+      def extract_inverse_aggregate(document)
+        aggregates = document.xpath("inverse.aggregate")
+
+        if !aggregates.empty?
+          dimension = Express::AggregateDimension.parse(aggregates.first)
+          @aggrtype = dimension.aggrtype
+          @lower = dimension.lower
+          @upper = dimension.upper
+        end
+      end
+    end
+  end
+end