lutaml-uml 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b99520ee95878d541ac76755c71cfc9ff71a3551c27ba9391a774fd92273f502
-  data.tar.gz: f17e20b2e03e66df0efdcc33937b37657e963e7f2d19655e30ba665020ce7b00
+  metadata.gz: 9390b74fbba2e8c8ee424d8aecd2efd9d507d157e6a63cc64c115b821878ef01
+  data.tar.gz: e8d2466349d6b622ae0a3d46b1eeca87f0f3996d155fbf5bed75e90bc14a3b48
 SHA512:
-  metadata.gz: c6f48df0e2c0055b3bdb0b32c7abb135c72e94509e0fdce555f18df21dfa145a54ca77afd8e762152a17a12e8c835765ef47c85a982ed4e90ba8da9ee3ca714a
-  data.tar.gz: d16ce0f4fd44ead1300aa28d3bfb07b86dbc5db3ca58aa5d2a45898552220118048f6f415eb212c2ad88d3c9826357d0bd74bfb9f159f3a02b992d49426a9b0f
+  metadata.gz: 2d4a974174f13d690205e9d5f887745ec1268e16c8d031a137ca492fca24617a004d4ede0e72ed074b02694895d81b4128f7695811436e4d4a746676bacbb834
+  data.tar.gz: 8dbe1883d2ea7c910e48b4c0f9191559aaa7a6ee02c598b5a0b05a7fb3cd33407edc37101a9fec4297f9110be3fb9243625370b140c5a0fc36adc9d909a6b4ae

data/.github/workflows/macos.yml

@@ -0,0 +1,36 @@
+name: macos
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    paths-ignore:
+      - .github/workflows/ubuntu.yml
+      - .github/workflows/windows.yml
+
+jobs:
+  test-macos:
+    name: Test on Ruby ${{ matrix.ruby }} macOS
+    runs-on: macos-latest
+    continue-on-error: ${{ matrix.experimental }}
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ '2.6', '2.5', '2.4' ]
+        experimental: [false]
+        include:
+          - ruby: '2.7'
+            experimental: true
+    steps:
+      - uses: actions/checkout@master
+      - name: Use Ruby
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: Update gems
+        run: |
+          sudo gem install bundler --force
+          bundle install --jobs 4 --retry 3
+      - name: Run specs
+        run: |
+          bundle exec rake

data/.github/workflows/ubuntu.yml

@@ -0,0 +1,38 @@
+name: ubuntu
+
+on:
+  push:
+    branches: [ master ]
+    tags:
+      - '*'
+  pull_request:
+    paths-ignore:
+      - .github/workflows/macos.yml
+      - .github/workflows/windows.yml
+
+jobs:
+  test-linux:
+    name: Test on Ruby ${{ matrix.ruby }} Ubuntu
+    runs-on: ubuntu-latest
+    continue-on-error: ${{ matrix.experimental }}
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ '2.6', '2.5', '2.4' ]
+        experimental: [false]
+        include:
+          - ruby: '2.7'
+            experimental: true
+    steps:
+      - uses: actions/checkout@master
+      - name: Use Ruby
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: Update gems
+        run: |
+          gem install bundler
+          bundle install --jobs 4 --retry 3
+      - name: Run specs
+        run: |
+          bundle exec rake

data/.github/workflows/windows.yml

@@ -0,0 +1,41 @@
+name: windows
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    paths-ignore:
+      - .github/workflows/macos.yml
+      - .github/workflows/ubuntu.yml
+
+jobs:
+  test-windows:
+    name: Test on Ruby ${{ matrix.ruby }} Windows
+    runs-on: windows-latest
+    continue-on-error: ${{ matrix.experimental }}
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ '2.6', '2.5', '2.4' ]
+        experimental: [false]
+        # Does not supported yet:
+        # Ruby (< 2.7.dev, >= 2.3), which is required by gem 'nokogiri (~> 1.10)', is not
+        #   available in the local ruby installation
+        # include:
+        #   - ruby: '2.7'
+        #     experimental: true
+    steps:
+      - uses: actions/checkout@master
+      - name: Use Ruby
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: Update gems
+        shell: pwsh
+        run: |
+          gem install bundler
+          bundle config --local path vendor/bundle
+          bundle install --jobs 4 --retry 3
+      - name: Run specs
+        run: |
+          bundle exec rake

data/.gitignore

@@ -9,3 +9,4 @@
 
 # rspec failure tracking
 .rspec_status
+Gemfile.lock

data/Gemfile

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 
 # Specify your gem's dependencies in lutaml-uml.gemspec
 gemspec
 
 gem "rake", "~> 12.0"
-gem "rspec", "~> 3.0"

data/LUTAML.adoc

@@ -0,0 +1,314 @@
+= LutaML syntax
+
+== `diagram` syntax
+
+`diagram` is a root element for each diagram.
+
+[source,java]
+----
+diagram MyView {
+  import Relationship, Element
+  render_option typed_as_associations
+  file "my_view.png"
+  fontname "Helvetica"
+}
+----
+
+== DataTypes
+
+Lutaml supports 3 types of data_types: `data_type`, `primitive` and `enum`. Example of data types declaration:
+
+[source,java]
+----
+diagram MyView {
+  enum MyEnum {}
+
+  enum AddressClassProfile {
+    +addressClassProfile: CharacterString
+  }
+
+  data_type "Banking Information" {
+    "art code"
+    "CCT Number"
+  }
+
+  primitive Integer
+
+  enum Profile {
+    imlicistAttributeProfile: CharacterString
+    +attributeProfile: CharacterString
+    -privateAttributeProfile: CharacterString
+    ~friendlyAttributeProfile: CharacterString
+    #protectedAttributeProfile: CharacterString
+  }
+}
+----
+
+== Associations
+
+=== Explicit declaration
+
+Syntax:
+
+[source,java]
+----
+association name {
+  owned_type association|composition|aggregation|generalization|uses
+  member_type association|composition|aggregation|generalization|uses
+  owned association_name[#attribute_name] [{property_string}][cardinality]
+  member association_name[#attribute_name] [{property_string}][cardinality]
+}
+----
+
+where:
+
+* `owned_type` - optional, use to define bidirectional association(association|composition|aggregation|generalization|uses)
+* `member_type` - association type(association|composition|aggregation|generalization|uses)
+* `owned|member` - end of association, use `\#attribute_name` to set a role name
+* `property_string` - property string for attibutes associations
+* `cardinality` - examples: '1..*', '*'
+
+Example:
+
+[source,java]
+----
+class Association {
+  +association:
+}
+class Type {
+  +endType:
+}
+
+association AssociatingTypeAndAssociation {
+  type uses
+  from Association#+association {subsets relationship}[*]
+  to Type#+/endType {readOnly, subsets relatedElement} [1..*]
+}
+----
+
+=== Undirected associations
+
+The simplest way to define relationship between two classes is to use `generalize` keyword:
+
+[source,java]
+----
+class Pet {}
+class Cat {
+  generalize Pet
+}
+----
+
+=== Attribute relationship
+
+Derived attribute `relatedElement` can have 1 to many `Element` associated with it through `union`
+
+[source,java]
+----
+class Relationship {
+   +/relatedElement: Element[1..*] {union}
+}
+class Element {}
+----
+
+== Attributes/entries
+
+=== Definition
+
+Full syntax:
+
+[source,java]
+----
+[visibility][/][attribute] name [:type][multiplicity][=initial value][{property string}]
+----
+
+where:
+
+* `visibility` can be equal to `-` - private, `+` - public, `#` - protected, `~` - friendly
+* `attribute` - attrbute keyword
+* `/` - symbolizes a derived attribute.
+* `multiplicity` -  Multiplicity is in square brackets (e.g. [1..*]).
+* `initial value` - Default value specifies the initial value of the attribute.
+* `property string` - Property string indicates a modifier that applies to the attribute:
+  ** {readonly}: the property can be read but not changed.
+  ** {union}: the property is a union of subsets.
+  ** {subsets <property>}: the property is a subset of <property>.
+  ** {redefines <property>}: the property is a new definition of <property> (overwritten by inheritance).
+
+
+One can use explicit or implicit syntax for attribute definition
+
+explicit syntax:
+
+[source,java]
+----
+class A {
+  attribute my_attribute
+}
+
+enum A {
+  entry my_val2
+}
+----
+
+implicit syntax:
+
+[source,java]
+----
+class A {
+  my_attribute
+}
+
+enum A {
+  my_val2
+}
+----
+
+=== Attribute visibility
+
+Syntax for defining visibility: [+|-|#|~] [attribute] attribute_name. LutaML uses these modificators to define attribute(entry) visbility:
+
++ => public
+- => private
+# => protected
+~ => package
+
+example:
+
+[source,java]
+----
+class Figure {
+  // Public attribute `radius`
+  + radius
+  // private attribute `filled`
+  - filled
+  // protected attribute `length`
+  # length
+}
+----
+
+== Methods
+
+Syntax for defining methods:
+
+[source,java]
+----
+[visbility] method-name (parameter-list): return type {property-modifier}
+----
+
+where:
+- `visibility` can be equal to `-` - private, `+` - public, `#` - protected, `~` - friendly
+- `parameter-list` - parameter list
+- `property-modifier` - can be equal to `redefines`, `query`, `ordered`(`unordered`), `unique`(`nonunique`)
+
+Syntax for a `parameter-list`:
+
+[source,java]
+----
+[direction] name:type [multiplicity] [=default] [{property string}]
+----
+
+where:
+- `direction` - can be equal to `in`, `out`, `inout` or `return`
+
+== import files
+
+Use `include` special word:
+
+[source,java]
+----
+include path/to/file
+----
+
+== Package syntax
+
+Namespaces
+Def.-A named element is an element that can have a name and a defined visibility (public, private, protected, package):
+
+[source,java]
+----
++ => public
+- => private
+# => protected
+~ => package
+----
+
+The name of the element and its visibility are optional.
+
+[source,java]
+----
+package Customers {
+  class Insurance {}
+  - class PrivateInsurance {}
+  # class ProtectedInsurance {}
+}
+----
+
+== Code comments
+
+Use `//` notation for LutaML comments skipped by parser, example:
+
+[source,java]
+----
+// TODO: implement
+abstract class Pet {}
+----
+
+== Comment objects diagram
+
+Use `\**`(one line comment) or `*| |*`(multiline comment) to create comment object for diagram entry.
+If this syntax used inside class/enum/association block it will be created for owner of this block.
+
+[source,java]
+----
+** I am a document comment
+
+*|
+  This is a
+  multiply
+  lines document comment.
+*|
+
+class A
+enum B {
+  ** one line enum comment
+  foo
+  *|
+    This is a
+    multiply
+    lines class comment.
+  *|
+  bar
+}
+----
+
+== Syntax comments
+
+Use `//` to create syntax comment, chars after // will be ignored during processing
+
+[source,java]
+----
+// TODO: attributes
+class A
+enum B {
+  // Write docs
+  foo
+  bar
+}
+----
+
+== Value specification
+
+A value specification indicates one or several values in a model. Examples for value specifications include simple, mathematical expressions, such as 4+2, and expressions with values from the object model, Integer::MAX_INT-1
+
+[source,java]
+----
+class {Class name, if any} {as ref name, optional} {
+  {attribute name} = {attribute value}
+  {attribute name}:{attribute class} = {attribute value}
+}
+
+instance :{Class name, if any} {as ref name, optional} {
+  {attribute name} = {attribute value}
+  {attribute name}:{attribute class} = {attribute value}
+}
+----