expressir 1.3.3-x86_64-linux-musl

data/.github/workflows/release.yml

@@ -0,0 +1,189 @@
+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* ]
+
+concurrency:
+  group: '${{ github.workflow }}-${{ github.job }}-${{ github.head_ref || github.ref_name }}'
+  cancel-in-progress: true
+
+env:
+  BUNDLER_VER: 2.4.22
+
+jobs:
+  bump:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: recursive
+
+      - uses: ruby/setup-ruby@master
+        with:
+          ruby-version: '3.1'
+          bundler: ${{ env.BUNDLER_VER }}
+
+      - if: ${{ github.event_name == 'workflow_dispatch' }} # unfortunatelly cannot keep this condition on job level
+        run: |
+          git config --global user.name github-actions
+          git config --global user.email github-actions@github.com
+          gem install gem-release
+          gem bump --version ${{ github.event.inputs.next_version }} --tag --push
+
+  pack:
+    runs-on: ubuntu-latest
+    needs: bump
+    strategy:
+      fail-fast: false
+      matrix:
+        platform: [ linux-gnu, linux-musl, windows, darwin ]
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: recursive
+          ref: main # https://github.com/actions/checkout/issues/439#issuecomment-830862188
+
+      - uses: ruby/setup-ruby@master
+        with:
+          ruby-version: '3.1'
+          # 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
+
+      - name: Build gem and save version
+        if: matrix.platform == 'linux-gnu'
+        run: |
+          gem build expressir.gemspec | grep -o 'Version: .*' | awk '{print $2}' > version
+
+      - if: matrix.platform == 'linux-gnu'
+        uses: actions/upload-artifact@v4
+        with:
+          name: pkg-ruby
+          path: expressir-*.gem
+
+      - if: matrix.platform == 'linux-gnu'
+        uses: actions/upload-artifact@v4
+        with:
+          name: version
+          path: version
+
+      - name: Enable swap
+        run: |
+          sudo fallocate -l 15g /compile.swap
+          sudo chmod 600 /compile.swap
+          sudo mkswap /compile.swap
+          sudo swapon /compile.swap
+          sudo swapon --all --verbose
+
+      # build gem WITH pre-built native extension
+      - run: bundle exec rake gem:${{ matrix.platform }}
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: pkg-${{ matrix.platform }}
+          path: pkg/*.gem
+
+  publish:
+    runs-on: ubuntu-latest
+    needs: pack
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: pkg-ruby
+          path: pkg
+
+      - uses: actions/download-artifact@v4
+        with:
+          name: pkg-linux-gnu
+          path: pkg
+
+      - uses: actions/download-artifact@v4
+        with:
+          name: pkg-linux-musl
+          path: pkg
+
+      - uses: actions/download-artifact@v4
+        with:
+          name: pkg-windows
+          path: pkg
+
+      - uses: actions/download-artifact@v4
+        with:
+          name: pkg-darwin
+          path: pkg
+
+      - uses: ruby/setup-ruby@master
+        with:
+          ruby-version: '3.1'
+
+      - name: Publish to rubygems.org
+        env:
+          RUBYGEMS_API_KEY: ${{ secrets.LUTAML_CI_RUBYGEMS_API_KEY }}
+        run: |
+          ls -l pkg/
+          mkdir -p ~/.gem
+          cat > ~/.gem/credentials << EOF
+          ---
+          :rubygems_api_key: ${RUBYGEMS_API_KEY}
+          EOF
+          chmod 0600 ~/.gem/credentials
+          gem signin
+          for gem in pkg/*.gem; do gem push $gem -V; done
+          sleep 15
+
+  verify:
+    name: Verify published gem on ${{ matrix.os }}
+    needs: publish
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ ubuntu-latest, windows-latest, macos-latest ]
+    steps:
+      - name: Install Ruby
+        uses: ruby/setup-ruby@master
+        with:
+          ruby-version: 3.1
+          bundler-cache: true
+          bundler: ${{ env.BUNDLER_VER }}
+
+      - name: Download version
+        uses: actions/download-artifact@v4
+        with:
+         name: version
+
+      - name: Install gem
+        run: gem install expressir -v $(cat version)
+
+      - name: Verify
+        run: expressir version
+
+  verify-alpine:
+    name: Verify published gem on alpine
+    needs: publish
+    runs-on: ubuntu-latest
+    container:
+      image: alpine:3.17
+    steps:
+      - name: Install packages
+        run: apk --no-cache add bash build-base git ruby-dev gcc g++ automake
+
+      - name: Download version
+        uses: actions/download-artifact@v4
+        with:
+         name: version
+
+      - name: Install gem
+        run: gem install expressir -v $(cat version)
+
+      - name: Verify
+        run: expressir version

data/.github/workflows/stress.yml

@@ -0,0 +1,53 @@
+name: stress
+
+on:
+  workflow_dispatch:
+
+concurrency:
+  group: '${{ github.workflow }}-${{ github.job }}-${{ github.head_ref || github.ref_name }}'
+  cancel-in-progress: true
+
+env:
+  BUNDLER_VER: 2.4.22
+  GC_STRESS: true
+
+jobs:
+  rake:
+    name: test on ruby-${{ matrix.ruby }} ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ '3.2', '3.1', '3.0', '2.7' ]
+        os: [ ubuntu-latest, windows-latest, macos-latest ]
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          submodules: recursive
+
+      - name: Setup packages
+        if: startsWith(matrix.os, 'macos')
+        run: brew install autoconf automake libtool
+
+      - name: Install Ruby
+        uses: ruby/setup-ruby@master
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler: ${{ env.BUNDLER_VER }}
+          # Rice gem has issues with bundler cache
+          # more info https://github.com/lutaml/expressir/runs/2097658383?check_suite_focus=true#step:7:2126
+          # but it is not the only issue
+          bundler-cache: false
+
+      - name: Bundle
+        run: bundle install --jobs 4 --retry 3
+
+      - name: Build native extension
+        run: bundle exec rake compile
+
+      - name: Run tests
+        run: |
+          bundle exec rake
+          cat .rspec_status

data/.gitignore

@@ -0,0 +1,23 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/Gemfile.lock
+/.idea
+/.vscode
+/lib/expressir/express/express_parser.bundle
+/lib/expressir/express/express_parser.so
+/lib/expressir/express/*/express_parser.bundle
+/lib/expressir/express/*/express_parser.so
+/spec/syntax/*-pretty.exp
+/ext/express_parser/rice-embed
+
+# rspec failure tracking
+.rspec_status
+
+# rubocop guide
+.rubocop-https---*

data/.gitmodules

@@ -0,0 +1,6 @@
+[submodule "ext/express_parser/antlr4-upstream"]
+	path = ext/express_parser/antlr4-upstream
+	url = https://github.com/antlr/antlr4
+[submodule "ext/express-grammar"]
+	path = ext/express-grammar
+	url = https://github.com/lutaml/express-grammar

data/.hound.yml

@@ -0,0 +1,3 @@
+ruby:
+  enabled: true
+  config_file: .rubocop.yml

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,18 @@
+inherit_from:
+  - https://raw.githubusercontent.com/riboseinc/oss-guides/master/ci/rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 2.7
+  NewCops: enable
+  SuggestExtensions: false
+  Exclude:
+    - 'vendor/**/*'
+    - 'expressir.gemspec'
+    - 'tmp/**/*'
+    - 'pkg/**/*'
+    - 'exe/format-test'
+    - 'lib/expressir/express/**/*'
+    - 'lib/expressir/model/**/*'
+
+Layout/LineLength:
+  Max: 160

data/.yardopts

@@ -0,0 +1,11 @@
+# macro must be defined first, see https://stackoverflow.com/a/10344776/1823988
+lib/expressir/model/model_element.rb
+lib/expressir/model/data_type.rb
+lib/expressir/model/declaration.rb
+lib/expressir/model/expression.rb
+lib/expressir/model/literal.rb
+lib/expressir/model/reference.rb
+lib/expressir/model/statement.rb
+lib/expressir/model/supertype_expression.rb
+
+lib/**/*.rb

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in reeper.gemspec
+gemspec

data/README.adoc

@@ -0,0 +1,155 @@
+= Expressir: EXPRESS in Ruby
+
+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
+
+Expressir ("`EXPRESS in Ruby`") is a Ruby parser for EXPRESS and
+a set of Ruby tools for accessing ISO EXPRESS data models.
+
+== Architecture
+
+Expressir consists of 3 parts:
+
+. Parsers. A parser allows Expressir to read EXPRESS files, including:
+
+** EXPRESS data modelling language (ISO 10303-11:2007)
+** EXPRESS data modelling language in XML (STEPmod)
+** EXPRESS XML (ISO 10303-28:2007)
+"`Industrial automation systems and integration — Product data representation and exchange — Part 28: Implementation methods: XML representations of EXPRESS schemas and data, using XML schemas`")
+
+. Data model. The data model (`lib/expressir/express`) is the Ruby data model that fully represents an EXPRESS data model.
+
+. Converters. A converter transforms the EXPRESS Ruby data model into an interoperable export format, including:
+** EXPRESS data modelling language (ISO 10303-11:2007)
+** W3C OWL
+** OMG SysML (XMI 2.1, XMI 2.5)
+** OMG UML 2 (XMI 2.1)
+** OMG UML 2 for Eclipse (XMI 2.1)
+
+
+== Usage
+
+This gem ships with a CLI tool. To check what's available you can simply run
+the script directly from `exe/expressir`, by default it will display some usage
+instructions.
+
+[source, sh]
+----
+./exe/expressir
+
+Commands:
+  expressir help [COMMAND]  # Describe available commands or one specific command
+  expressir version         # The Expressir Version
+----
+
+== Development
+
+We are following Sandi Metz's Rules for this gem, you can read
+the http://robots.thoughtbot.com/post/50655960596/sandi-metz-rules-for-developers[description of the rules here] All new code should follow these rules.
+If you make changes in a pre-existing file that violates these rules you should
+fix the violations as part of your contribution.
+
+=== Setup
+
+Clone the repository.
+
+[source, sh]
+----
+git clone https://github.com/metanorma/expressir
+----
+
+Setup your environment.
+
+[source, sh]
+----
+bin/setup
+----
+
+Run the test suite
+
+[source, sh]
+----
+bin/rspec
+----
+
+=== Grammar updates
+EXPRESS grammar is lined as git submodule to ext/express-grammar
+Shoudl you update it, run ```rake generate```. This command will generate source code for updated native extension using antlr4-native gem.
+Please note that we create several classes on top of antlr4-native output so using embedded rake task is a real requirement.
+
+When new extension is gnerated and tested plase check in updated C++ files to git (```rake generate``` is NOT a CI step, 
+extension source files are pulled from the repo).
+
+== Installation
+
+Add this line to your application's `Gemfile`:
+
+[source, sh]
+----
+gem "expressir"
+----
+
+And then execute:
+
+[source, sh]
+----
+$ bundle install
+----
+
+Or install it yourself as:
+
+[source, sh]
+----
+$ gem install expressir
+----
+
+
+== Contributing
+
+First, thank you for contributing! We love pull requests from everyone. By
+participating in this project, you hereby grant
+https://www.ribose.com[Ribose Inc.] the right to grant or transfer an unlimited
+number of non exclusive licenses or sub-licenses to third parties, under the
+copyright covering the contribution to use the contribution by all means.
+
+Here are a few technical guidelines to follow:
+
+* Open an https://github.com/lutaml/expressir/issues[issues] to discuss a new
+  feature.
+* Write tests to support your new feature.
+* Make sure the entire test suite passes locally and on CI.
+* Open a Pull Request.
+* https://github.com/thoughtbot/guides/tree/master/protocol/git#write-a-feature[Squash your commits] after receiving feedback.
+* Party!
+
+
+== License
+
+Expressir is distributed under the BSD 2-clause license.
+
+Expressir is built on code originally from the NIST Reeper project.
+
+The https://www.nist.gov/services-resources/software/reeper[NIST Reeper license]
+is reproduced below:
+
+[quote]
+____
+This software was funded by NIST and developed by EuroSTEP.
+Pursuant to title 17 Section 105 of the United States Code this
+software is not subject to copyright protection and is in the public
+domain.
+
+We would appreciate acknowledgment if the software is used. Links to
+non-Federal Government Web sites do not imply NIST endorsement of any
+particular product, service, organization, company, information
+provider, or content.
+____
+
+
+== Credits
+
+Expressir is created using the structure and examples provided by
+the NIST Reeper software on https://sourceforge.net/p/reeper/[Sourceforge].

data/Rakefile

@@ -0,0 +1,17 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "rake/extensiontask"
+require "rubocop/rake_task"
+require "yard"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+
+GEMSPEC = Gem::Specification.load("expressir.gemspec")
+
+RuboCop::RakeTask.new
+
+Gem::PackageTask.new(GEMSPEC).define
+
+YARD::Rake::YardocTask.new

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "reeper"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require "pry"
+Pry.start

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", __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300).include?("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/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,22 @@
+#!/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"
+
+module Gem
+  class Specification
+    def this; self; end
+  end
+end
+
+# start up the CLI
+require "expressir"
+Expressir::Cli.start(ARGV)

data/exe/format

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+require "yaml"
+require "expressir/express/parser"
+require "expressir/express/formatter"
+require "expressir/express/schema_head_formatter"
+require "expressir/express/hyperlink_formatter"
+
+exp_files = ARGV
+
+repository = Expressir::Express::Parser.from_files(exp_files)
+formatter = Class.new(Expressir::Express::Formatter) do
+  include Expressir::Express::SchemaHeadFormatter
+  include Expressir::Express::HyperlinkFormatter
+end
+result = repository.to_hash(formatter: formatter, skip_empty: true)
+
+puts YAML.dump(result)