lutaml 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd52cb5d4a4e29687299339e3cd9af05720f81348d5a307ae1d07bf2514bd022
-  data.tar.gz: 373158747e92e76c14efd7bbfc6d42a9ecebe164ebb5d14f035840a85666ce5d
+  metadata.gz: 84bb179e752bc157f0de4a59ea8cf88e9bd1fe4430726dcefcf63269d12c86fb
+  data.tar.gz: a5f8917e80a33814b9cc6a9e3556b335da72fe05fd73e4d54dc294d1c4b6a27f
 SHA512:
-  metadata.gz: ad0a113798e024375f25c0f580c09b8e17f1b8d8ea60ab1edc67dbfb5250ae9cb6151b44a4f6cd090159d177d08c40361c7b536a1832053f01a5784d580f91da
-  data.tar.gz: 6f0e0043a0c0a240763c95d0041ff6ccb462fb81773ecc1f4c5d4dc376942fdebe39f6c9fc5c30df96e8a95a061147cfa2b139dda968aabd6161abeb216f7a66
+  metadata.gz: 64b11704d20aff55c53cb6b1d857d346a6e9016b84b091581372c38b100a3d21d499685550e8d5a8b132e4cc7de5e8da37c3efd14ae325d119a207a76fc0feea
+  data.tar.gz: f9800bc7e40536370807a3e4a3429d60dfa1f2fd728054adf6c9a8e73ba813b20bad80e22c85323309089eb41e1455806381513c139de1a99cc804ebb37378f2

data/.github/workflows/macos.yml

@@ -0,0 +1,41 @@
+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' ]
+        experimental: [false]
+        include:
+          - ruby: '2.7'
+            experimental: true
+    steps:
+      - uses: actions/checkout@master
+      - name: Install build tools
+        run: |
+          brew install automake libtool
+      - name: Use Ruby
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: Install Grpahviz macOS
+        run: brew install graphviz
+      - 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,40 @@
+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' ]
+        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: Install Grpahviz Ubuntu
+        run: sudo apt-get install graphviz
+      - 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,48 @@
+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' ]
+        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: Install graphviz
+        uses: nick-invision/retry@v1
+        with:
+          polling_interval_seconds: 5
+          timeout_minutes: 5
+          max_attempts: 3
+          command: choco install --no-progress graphviz --version 2.38.0.20190211
+      - 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/Gemfile

@@ -2,6 +2,3 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in lutaml.gemspec
 gemspec
-
-gem "rake", "~> 12.0"
-gem "rspec", "~> 3.0"

data/README.adoc

@@ -0,0 +1,72 @@
+= Lutaml
+
+== Functionality
+
+Entry point for lutaml extensions.
+
+=== Installation
+
+With bundler:
+
+[source,ruby]
+----
+# Gemfile
+gem "lutaml"
+----
+
+Then in console:
+
+[source,console]
+----
+$ bundle
+----
+
+With RubyGems:
+
+[source,console]
+----
+$ gem install lutaml
+----
+
+=== Usage
+
+== From ruby
+
+In order to parse files supported by lutaml extensions, use Lutaml::Parser.parse method.
+
+[source,ruby]
+----
+# example.exp is an EXPRESS repository file
+Lutaml::Parser.parse(File.new("example.exp")) # will produce Lutaml::LutamlPath::DocumentWrapper object with serialized express repository
+----
+
+== With cli tool
+
+There is a cli tool available for parsing lutaml/exp files(also yaml datastruct files are supported).
+
+[source,bash]
+----
+# Will generate `test.dot` file in the current directory
+$: lutaml -o . test.lutaml
+
+# Will generate `test.png` file in the `assets` directory
+$: lutaml -o assets -t png test.lutaml
+----
+
+For additional info refer to `lutaml --help output`
+
+
+== Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/lutaml. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/lutaml/blob/master/CODE_OF_CONDUCT.md).
+
+
+== Code of Conduct
+
+Everyone interacting in the Lutaml::Uml project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/lutaml/blob/master/CODE_OF_CONDUCT.md).

data/exe/lutaml

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+# frozen_string_literal: true
+
+# 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
+
+require "lutaml"
+require "lutaml/command_line"
+
+Lutaml::CommandLine.run(ARGV.dup, STDOUT)

data/lib/lutaml.rb

@@ -1,7 +1,5 @@
 require "lutaml/version"
-require "lutaml/lutaml_path/document_wrapper"
+require "lutaml/parser"
 
 module Lutaml
-  class Error < StandardError; end
-  # Your code goes here...
 end

data/lib/lutaml/command_line.rb

@@ -0,0 +1,261 @@
+require "optparse"
+require "pathname"
+require "lutaml/formatter"
+require "lutaml/uml/has_attributes"
+require "lutaml/uml/parsers/attribute"
+require "lutaml/uml/parsers/dsl"
+require "lutaml/uml/parsers/yaml"
+
+module Lutaml
+  class CommandLine
+    class Error < StandardError; end
+    class FileError < Error; end
+    class NotSupportedInputFormat < Error; end
+
+    include ::Lutaml::Uml::HasAttributes
+
+    SUPPORTED_FORMATS = %w[yaml lutaml exp].freeze
+    DEFAULT_INPUT_FORMAT = "lutaml".freeze
+
+    def self.run(args, out_object, attributes = {})
+      new(attributes, out_object).run(args)
+    end
+
+    def initialize(attributes = {}, out_object = STDOUT)
+      @formatter = ::Lutaml::Formatter::Graphviz.new
+      @verbose = false
+      @option_parser = OptionParser.new
+      @out_object = out_object
+
+      setup_parser_options
+
+      # rubocop:disable Rails/ActiveRecordAliases
+      update_attributes(attributes)
+      # rubocop:enable Rails/ActiveRecordAliases
+    end
+
+    def output_path=(value)
+      @output_path = determine_output_path_value(value)
+    end
+
+    def determine_output_path_value(value)
+      unless value.nil? || @output_path = value.is_a?(Pathname)
+        return Pathname.new(value.to_s)
+      end
+
+      value
+    end
+
+    def paths=(values)
+      @paths = values.to_a.map { |path| Pathname.new(path) }
+    end
+
+    def formatter=(value)
+      value = value.to_s.strip.downcase.to_sym
+      value = Lutaml::Uml::Formatter.find_by(name: value)
+      raise Error, "Formatter not found: #{value}" if value.nil?
+
+      @formatter = value
+    end
+
+    def input_format=(value)
+      if value.nil?
+        @input_format = DEFAULT_INPUT_FORMAT
+        return
+      end
+
+      @input_format = SUPPORTED_FORMATS.detect { |n| n == value }
+      raise(NotSupportedInputFormat, value) if @input_format.nil?
+    end
+
+    def run(original_args)
+      args = original_args.dup
+      @option_parser.parse!(args) rescue nil
+      @paths = args
+      @formatter.type = @type
+
+      if @output_path&.file? && @paths.length > 1
+        raise Error,
+              'Output path must be a directory \
+              if multiple input files are given'
+      end
+
+      @paths.each do |input_path_string|
+        input_path = Pathname.new(input_path_string)
+        unless input_path.exist?
+          raise FileError, "File does not exist: #{input_path}"
+        end
+
+        document = Lutaml::Parser
+          .parse_into_document(File.new(input_path), @input_format)
+        result = @formatter.format(document)
+
+        if @output_path
+          output_path = @output_path
+          if output_path.directory?
+            output_path = output_path.join(input_path
+                                            .basename(".*").to_s +
+                                          ".#{@formatter.type}")
+          end
+
+          output_path.open("w+") { |file| file.write(result) }
+        else
+          @out_object.puts(result)
+        end
+      end
+    end
+
+    protected
+
+    def text_bold(body = nil)
+      text_effect(1, body)
+    end
+
+    def text_italic(body = nil)
+      text_effect(3, body)
+    end
+
+    def text_bold_italic(body = nil)
+      text_bold(text_italic(body))
+    end
+
+    def text_underline(body = nil)
+      text_effect(4, body)
+    end
+
+    def text_effect(num, body = nil)
+      result = "\e[#{num}m"
+      result << "#{body}#{text_reset}" unless body.nil?
+
+      result
+    end
+
+    def text_reset
+      "\e[0m"
+    end
+
+    def setup_parser_options
+      @option_parser.banner = ""
+      format_desc = "The output formatter (Default: '#{@formatter.name}')"
+      @option_parser
+        .on("-f",
+            "--formatter VALUE",
+            format_desc) do |value|
+        @formatter = value
+      end
+      @option_parser
+        .on("-t", "--type VALUE", "The output format type") do |value|
+          @type = value
+        end
+      @option_parser
+        .on("-o", "--output VALUE", "The output path") do |value|
+          @output_path = Pathname.new(value)
+        end
+      @option_parser
+        .on("-i", "--input-format VALUE", "The input format") do |value|
+          @input_format = value
+        end
+      @option_parser
+        .on("-h", "--help", "Prints this help") do
+        print_help
+        exit
+      end
+      @option_parser.on("-g", "--graph VALUE") do |value|
+        Parsers::Attribute.parse(value).each do |key, attr_value|
+          @formatter.graph[key] = attr_value
+        end
+      end
+
+      @option_parser.on("-e", "--edge VALUE") do |value|
+        Parsers::Attribute.parse(value).each do |key, attr_value|
+          @formatter.edge[key] = attr_value
+        end
+      end
+
+      @option_parser.on("-n", "--node VALUE") do |value|
+        Parsers::Attribute.parse(value).each do |key, attr_value|
+          @formatter.node[key] = attr_value
+        end
+      end
+
+      @option_parser.on("-a", "--all VALUE") do |value|
+        Parsers::Attribute.parse(value).each do |key, attr_value|
+          @formatter.graph[key] = attr_value
+          @formatter.edge[key] = attr_value
+          @formatter.node[key] = attr_value
+        end
+      end
+    end
+
+    def print_help
+      @out_object.puts <<~HELP
+        #{text_bold('Usage:')} lutaml [options] PATHS
+
+        #{text_bold('Overview:')} Generate output from Supplied language files if supported
+
+        #{text_bold('Options:')}
+        #{@option_parser}
+        #{text_bold('Paths:')}
+
+            LUTAML can accept multiple paths for parsing for easier batch processing.
+
+            The location of the output by default is standard output.
+
+            The output can be directed to a path with #{text_bold_italic('--output')}, which can be a file or a directory.
+            If the output path is a directory, then the filename will be the same as the input filename,
+              with it's file extension substituted with the #{text_bold_italic('--type')}.
+
+            #{text_underline('Examples')}
+
+                `lutaml project.lutaml`
+
+                    Produces DOT notation, sent to standard output
+
+                `lutaml -o . project.lutaml`
+
+                    Produces DOT notation, written to #{text_italic('./project.dot')}
+
+                `lutaml -o ./diagram.dot project.lutaml`
+
+                    Produces DOT notation, written to #{text_italic('./diagram.dot')}
+
+                `lutaml -o ./diagram.png project.lutaml`
+
+                    Produces PNG image, written to #{text_italic('./diagram.png')}
+
+                `lutaml -t png -o . project.lutaml`
+
+                    Produces PNG image, written to #{text_italic('./project.png')}
+
+                `lutaml -t png -o . project.lutaml core_ext.lutaml`
+
+                    Produces PNG images, written to #{text_italic('./project.png')} and #{text_italic('./core_ext.png')}
+
+        #{text_bold('Inputs:')}
+
+            #{text_underline('Lutaml')}
+
+              Lutaml dsl syntax files, supports diagram generation(image or dot files) with Graphviz
+
+        #{text_bold('Formatters:')}
+
+            #{text_underline('Graphviz')}
+
+              Generates DOT notation and can use the DOT notation to generate any format Graphviz can produce.
+
+              The output format is based on #{text_bold_italic('--type')}, which by default is "dot".
+              If #{text_bold_italic('--type')} is not given and #{text_bold_italic('--output')} is, the file extension of the #{text_bold_italic('--output')} path will be used.
+
+              Valid types/extensions are: #{Lutaml::Formatter::Graphviz::VALID_TYPES.join(', ')}
+
+              #{text_bold('Options:')}
+
+                  -g, --graph VALUE                The graph attributes
+                  -e, --edge VALUE                 The edge attributes
+                  -n, --node VALUE                 The node attributes
+                  -a, --all VALUE                  Set attributes for graph, edge, and node
+
+      HELP
+    end
+  end
+end