lutaml-uml 0.4.1 → 1.0.0

data/lib/lutaml/uml/parsers/dsl_preprocessor.rb

@@ -1,59 +0,0 @@
-# frozen_string_literal: true
-
-module Lutaml
-  module Uml
-    module Parsers
-      # Class for preprocessing dsl ascii file special directives:
-      # - include
-      class DslPreprocessor
-        attr_reader :input_file
-
-        def initialize(input_file)
-          @input_file = input_file
-        end
-
-        class << self
-          def call(input_file)
-            new(input_file).call
-          end
-        end
-
-        def call
-          include_root = File.dirname(input_file.path)
-          input_file.read.split("\n").reduce([]) do |res, line|
-            res.push(*process_dsl_line(include_root, line))
-          end.join("\n")
-        end
-
-        private
-
-        def process_dsl_line(include_root, line)
-          process_include_line(include_root, process_comment_line(line))
-        end
-
-        def process_comment_line(line)
-          has_comment = line.match(Regexp.new("//.+"))
-          return line if has_comment.nil?
-
-          line.gsub(Regexp.new("//.+"), "")
-        end
-
-        def process_include_line(include_root, line)
-          include_path_match = line.match(/^\s*include\s+(.+)/)
-          return line if include_path_match.nil? || line =~ /^\s\*\*/
-
-          path_to_file = include_path_match[1].strip
-          path_to_file = if path_to_file.match?(/^\//)
-                           path_to_file
-                         else
-                           File.join(include_root, path_to_file)
-                         end
-          File.read(path_to_file).split("\n")
-        rescue Errno::ENOENT
-          puts("No such file or directory @ rb_sysopen - #{path_to_file}, \
-            include file paths need to be supplied relative to the main document")
-        end
-      end
-    end
-  end
-end

data/lib/lutaml/uml/parsers/dsl_transform.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-require "parslet"
-
-module Lutaml
-  module Uml
-    module Parsers
-      # Class for additional transformations of LutaML syntax:
-      # visibility modifier etc
-      class DslTransform < Parslet::Transform
-        rule(visibility_modifier: simple(:visibility_value)) do
-          case visibility_value
-          when "-"
-            "private"
-          when "#"
-            "protected"
-          when "~"
-            "friendly"
-          else
-            "public"
-          end
-        end
-        rule(simple(:member)) { member.nil? ? member : member.to_s.strip }
-      end
-    end
-  end
-end

data/lib/lutaml/uml/parsers/yaml.rb

@@ -1,46 +0,0 @@
-# frozen_string_literal: true
-
-require "yaml"
-require "lutaml/uml/class"
-require "lutaml/uml/document"
-require "lutaml/uml/serializers/yaml_view"
-
-module Lutaml
-  module Uml
-    module Parsers
-      class Yaml
-        def self.parse(yaml_path, options = {})
-          new.parse(yaml_path, options)
-        end
-
-        def parse(yaml_path, _options = {})
-          yaml_parse(yaml_path)
-        end
-
-        def yaml_parse(yaml_path)
-          yaml_content = YAML.safe_load(File.read(yaml_path))
-          serialized_yaml = Lutaml::Uml::Serializers::YamlView
-            .new(yaml_content)
-          result = Lutaml::Uml::Document.new(serialized_yaml)
-          result.classes = imports_to_classes(yaml_content, yaml_path)
-          result
-        end
-
-        private
-
-        def imports_to_classes(yaml_content, yaml_path)
-          models_path = File.join(File.dirname(yaml_path), "..", "models")
-          yaml_content["imports"].map do |(klass_name, _)|
-            klass_attrs = YAML.safe_load(
-              File.read(
-                File.join(models_path, "#{klass_name}.yml")
-              )
-            )
-            klass_attrs["name"] = klass_name if klass_attrs["name"].nil?
-            Lutaml::Uml::Serializers::Class.new(klass_attrs)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/lutaml/uml/port.rb

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-module Lutaml
-  module Uml
-    class Port < Property
-    end
-  end
-end

data/lib/lutaml/uml/primitive_type.rb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-module Lutaml
-  module Uml
-    class PrimitiveType < DataType
-      attr_reader :keyword
-
-      def initialize(attributes = {})
-        super
-        @keyword = "primitive"
-      end
-    end
-  end
-end

data/lib/lutaml/uml/property.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-module Lutaml
-  module Uml
-    class Property < TopElement
-      attr_accessor :type,
-                    :aggregation,
-                    :association,
-                    :is_derived,
-                    :lowerValue,
-                    :upperValue
-
-      def initialize
-        @name = nil
-        @xmi_id = nil
-        @xmi_uuid = nil
-        @aggregation = nil
-        @association = nil
-        @namespace = nil
-        @is_derived = false
-        @visibility = "public"
-        @lowerValue = "1"
-        @upperValue = "1"
-      end
-    end
-  end
-end

data/lib/lutaml/uml/pseudostate.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-##
-## Behaviour metamodel
-##
-module Lutaml
-  module Uml
-    class Pseudostate < Vertex
-    end
-  end
-end

data/lib/lutaml/uml/realization.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-##
-## Behaviour metamodel
-##
-module Lutaml
-  module Uml
-    class Realization < Abstraction
-    end
-  end
-end

data/lib/lutaml/uml/region.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-##
-## Behaviour metamodel
-##
-
-module Lutaml
-  module Uml
-    class Region < TopElement
-    end
-  end
-end

data/lib/lutaml/uml/serializers/association.rb

@@ -1,58 +0,0 @@
-# frozen_string_literal: true
-
-require "lutaml/uml/serializers/base"
-require "lutaml/uml/serializers/class"
-
-module Lutaml
-  module Uml
-    module Serializers
-      class Association < Base
-        property :member_end, from: :target
-        property :member_end_attribute_name,
-                 from: "relationship",
-                 transform_with: (lambda do |val|
-                   val.dig("target", "attributes")&.keys&.first ||
-                    val.dig("target", "attribute")&.keys&.first
-                 end)
-        property :member_end_cardinality,
-                 from: "relationship",
-                 transform_with: (lambda do |val|
-                   res = val.dig("source", "attributes")&.values&.first ||
-                          val.dig("source", "attribute")&.values&.first
-                   res["cardinality"] if res
-                 end)
-        property :member_end_type,
-                 from: "relationship",
-                 transform_with: (lambda do |val|
-                   val.dig("target", "type")
-                 end)
-        property :owner_end_attribute_name,
-                 from: "relationship",
-                 transform_with: (lambda do |val|
-                   val.dig("source", "attributes")&.keys&.first ||
-                     val.dig("source", "attribute")&.keys&.first
-                 end)
-        property :owner_end_cardinality,
-                 from: "relationship",
-                 transform_with: (lambda do |val|
-                   res = val.dig("source", "attributes")&.values&.first ||
-                           val.dig("source", "attribute")&.values&.first
-                   res["cardinality"] if res
-                 end)
-        property :owner_end_type,
-                 from: "relationship",
-                 transform_with: (lambda do |val|
-                   val.dig("source", "type")
-                 end)
-        property :action,
-                 transform_with: (lambda do |val|
-                   if val["direction"] == "target"
-                     "#{val['verb']} ▶"
-                   else
-                     "◀ #{val['verb']}"
-                   end
-                 end)
-      end
-    end
-  end
-end

data/lib/lutaml/uml/serializers/base.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-require "hashie"
-
-module Lutaml
-  module Uml
-    module Serializers
-      class Base < Hashie::Dash
-        include Hashie::Extensions::Dash::PropertyTranslation
-        include Hashie::Extensions::Dash::IndifferentAccess
-        include Hashie::Extensions::Dash::Coercion
-        include Hashie::Extensions::IgnoreUndeclared
-      end
-    end
-  end
-end

data/lib/lutaml/uml/serializers/class.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-require "lutaml/uml/serializers/base"
-require "lutaml/uml/serializers/top_element_attribute"
-require "lutaml/uml/serializers/association"
-
-module Lutaml
-  module Uml
-    module Serializers
-      class Class < Base
-        property :attributes,
-                 transform_with: (lambda do |entry|
-                   entry
-                    .to_a
-                    .map do |(name, attributes)|
-                      attributes.merge(name: name)
-                    end
-                 end)
-        property :associations,
-                 from: :relations,
-                 coerce: Array[::Lutaml::Uml::Serializers::Association]
-        property :name
-        # property :type, from: :modelType
-        # property :relations,
-        #          coerce: Array[Relation]
-      end
-    end
-  end
-end

data/lib/lutaml/uml/serializers/top_element_attribute.rb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-require "lutaml/uml/serializers/base"
-
-module Lutaml
-  module Uml
-    module Serializers
-      class TopElementAttribute < Base
-        property :cardinality
-        property :type
-      end
-    end
-  end
-end

data/lib/lutaml/uml/serializers/yaml_view.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-require "lutaml/uml/serializers/base"
-require "lutaml/uml/serializers/class"
-
-module Lutaml
-  module Uml
-    module Serializers
-      class YamlView < Base
-        property :name
-        property :title
-        property :caption
-        property :groups
-        property :fidelity
-      end
-    end
-  end
-end

data/lib/lutaml/uml/state.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-##
-## Behaviour metamodel
-##
-module Lutaml
-  module Uml
-    class State < Vertex
-      attr_accessor :exit, :entry, :do_activity
-    end
-  end
-end

data/lib/lutaml/uml/state_machine.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-##
-## Behaviour metamodel
-##
-
-module Lutaml
-  module Uml
-    class StateMachine < Behavior
-    end
-  end
-end

data/lib/lutaml/uml/top_element.rb

@@ -1,58 +0,0 @@
-# frozen_string_literal: true
-
-module Lutaml
-  module Uml
-    class TopElement
-      include HasAttributes
-
-      attr_accessor :name,
-                    :definition,
-                    :xmi_id,
-                    :xmi_uuid,
-                    :namespace,
-                    :keyword,
-                    :stereotype,
-                    :href,
-                    :visibility,
-                    :comments
-
-      # rubocop:disable Rails/ActiveRecordAliases
-      def initialize(attributes = {})
-        @visibility = "public"
-        @name = attributes["name"]
-        update_attributes(attributes)
-      end
-      # rubocop:enable Rails/ActiveRecordAliases
-
-      def full_name
-        if name == nil
-          return nil
-        end
-
-        the_name = name
-        next_namespace = namespace
-
-        while !next_namespace.nil?
-          the_name = if !next_namespace.name.nil?
-                       next_namespace.name + "::" + the_name
-                     else
-                       "::" + the_name
-                     end
-          next_namespace = next_namespace.namespace
-        end
-
-        the_name
-      end
-
-      def definition=(value)
-        @definition = value
-                        .to_s
-                        .gsub(/\\}/, '}')
-                        .gsub(/\\{/, '{')
-                        .split("\n")
-                        .map(&:strip)
-                        .join("\n")
-      end
-    end
-  end
-end

data/lib/lutaml/uml/top_element_attribute.rb

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-module Lutaml
-  module Uml
-    class TopElementAttribute
-      include HasAttributes
-      include HasMembers
-
-      attr_accessor :name,
-                    :visibility,
-                    :type,
-                    :definition,
-                    :contain,
-                    :static,
-                    :cardinality,
-                    :keyword,
-                    :is_derived
-
-      # rubocop:disable Rails/ActiveRecordAliases
-      def initialize(attributes = {})
-        @visibility = "public"
-        update_attributes(attributes)
-      end
-      # rubocop:enable Rails/ActiveRecordAliases
-
-      def definition=(value)
-        @definition = value
-                        .to_s
-                        .gsub(/\\}/, '}')
-                        .gsub(/\\{/, '{')
-                        .split("\n")
-                        .map(&:strip)
-                        .join("\n")
-      end
-    end
-  end
-end

data/lib/lutaml/uml/transition.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-##
-## Behaviour metamodel
-##
-module Lutaml
-  module Uml
-    class Transition < TopElement
-      attr_accessor :source, :target, :guard, :effect
-    end
-  end
-end

data/lib/lutaml/uml/trigger.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-##
-## Behaviour metamodel
-##
-module Lutaml
-  module Uml
-    class Trigger < TopElement
-      attr_accessor :event
-    end
-  end
-end

data/lib/lutaml/uml/value.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-module Lutaml
-  module Uml
-    class Value
-      include HasAttributes
-      include HasMembers
-
-      attr_accessor :definition,
-                    :name,
-                    :type
-
-      # rubocop:disable Rails/ActiveRecordAliases
-      def initialize(attributes = {})
-        update_attributes(attributes)
-      end
-      # rubocop:enable Rails/ActiveRecordAliases
-
-      def definition=(value)
-        @definition = value
-                        .to_s
-                        .gsub(/\\}/, '}')
-                        .gsub(/\\{/, '{')
-                        .split("\n")
-                        .map(&:strip)
-                        .join("\n")
-      end
-    end
-  end
-end

data/lib/lutaml/uml/version.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-module Lutaml
-  module Uml
-    VERSION = "0.4.1"
-  end
-end

data/lib/lutaml/uml/vertex.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-##
-## Behaviour metamodel
-##
-module Lutaml
-  module Uml
-    class Vertex < TopElement
-    end
-  end
-end

data/lib/lutaml/uml.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-require "lutaml/uml/version"
-require "lutaml/uml/parsers/dsl"
-require "lutaml/uml/parsers/yaml"
-require "lutaml/uml/parsers/attribute"
-require "lutaml/uml/formatter"
-
-module Lutaml
-  module Uml
-    class Error < StandardError; end
-  end
-end

data/spec/fixtures/datamodel/models/AddressClassProfile.yml

@@ -1,90 +0,0 @@
-modelType: class
-# TODO
-definition: |
-  An `AddressClassProfile` represents a profile of a `ProfileCompliantAddress`.
-  It corresponds to the concept of an `AddressClass` originally
-  expressed in <<ISO19160-1>> as a referenced codelist.
-
-  It represents additional attributes and restrictions to the
-  `ProfileCompliantAddress` model. It also represents metadata for the use of
-  the profile.
-
-  A single profile can include and support multiple types of
-  address formats, such as a numbered street address and a
-  "`PO Box`" address simultaneously. Each of these address formats
-  is represented as an interchange address class.
-
-  [example]
-  --
-  The US Numbered Thoroughfare Address with this syntax can be
-  represented as an address class profile:
-
-  *{sp}{ Complete Landmark Name or Complete Place Name } +
-  *{sp}{ Complete Address Number * } +
-  *{sp}{ Complete Street Name * } +
-  *{sp}{ Complete Subaddress } +
-  *{sp}{ Complete Place Name * } +
-  *{sp}{ State Name * } +
-  *{sp}{ Zip Code } +
-  *{sp}{ Zip Plus 4 } +
-  *{sp}{ Country Name }
-  --
-attributes:
-  id:
-    definition: Unique identifier of this AddressClassProfile.
-    type: CharacterString
-  type:
-    definition: Intended usage of this profile.
-    type: CharacterString
-  description:
-    definition: Textual description of this profile.
-    type: CharacterString
-  localization:
-    definition: The language and script used within this profile.
-    type: Localization
-  signature:
-    definition: The digital signature to verify the integrity of this profile, and the identity of the publishing authority.
-    type: Signature
-    cardinality:
-      min: 0
-      max: 1
-  areaApplicability:
-    definition: The geographic representation of which this AddressClassProfile applies to. Overlapping geographic areas are allowed across different profiles.
-    type: iso19115MD_SpatialRepresentation
-    cardinality:
-      min: 0
-      max: "*"
-  timeToLive:
-    definition: The maximum time interval between refreshing of this profile via an authoritative source, in seconds.
-    type: Integer
-  validity:
-    definition: The period of date and time that this profile should be considered as valid.
-    type: Validity
-relations:
-  - target: AttributeProfile
-    relationship:
-      source:
-        type: aggregation
-        attribute:
-          addressClassProfile:
-      target:
-        type: direct
-        attribute:
-          attributeProfile:
-            cardinality:
-              min: 0
-              max: '*'
-
-  - target: ProfileCompliantAddress
-    relationship:
-      source:
-        attribute:
-          profile:
-            cardinality:
-              min: 1
-              max: 1
-      target:
-        type: direct
-    action:
-      verb: compliesWith
-      direction: source