expressir 0.2.5-x64-mingw32 → 0.2.7-x64-mingw32

data/Gemfile

@@ -1,6 +1,4 @@
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in reeper.gemspec
-gemspec
-
-gem "rake-compiler", git: "https://github.com/larskanis/rake-compiler", branch: "fix-native-version"
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in reeper.gemspec
+gemspec

data/README.adoc

@@ -1,147 +1,147 @@
-= 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]
-
-== 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
-----
-
-== 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].
+= 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]
+
+== 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
+----
+
+== 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

@@ -1,17 +1,11 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-require "rake/extensiontask"
-
-RSpec::Core::RakeTask.new(:spec)
-
-task :default => :spec
-
-spec = Gem::Specification.load("expressir.gemspec")
-
-# add your default gem packing task
-Gem::PackageTask.new(spec) do |pkg|
-end
-
-ext = Rake::ExtensionTask.new("express_parser", spec) do |ext|
-  ext.ext_dir = "ext/express-parser"
-end
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "rake/extensiontask"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+GEMSPEC = Gem::Specification.load("expressir.gemspec")
+
+Gem::PackageTask.new(GEMSPEC).define

data/bin/console

@@ -1,12 +1,12 @@
-#!/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
-
+#!/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

@@ -1,29 +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")
+#!/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

@@ -1,8 +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
+#!/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

@@ -1,18 +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
+#!/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

@@ -1,90 +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
+## 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