structurizr 1.0.0.pre.alpha.2 → 1.0.0.rc.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fe8a005a3c60de0672a5d97461b0ec492efc28cdd47b9ccce953adbb405b032a
-  data.tar.gz: 2c7e7fa0f87ac51bdc9a78adb68be7c640b2f1f04e01b93d28912031a18de16d
+  metadata.gz: ce4c05ff7b71aae943e13eb73189496976b01612790834d08940c3c1102e045e
+  data.tar.gz: c24285334e2609897f641e40ef9429efdc930a085e75eef18f8b185533b17e4c
 SHA512:
-  metadata.gz: 20e3190211889b56a2a8721050c658253bcb6971a8a14ebf1baa7afecea7457437b8f964ed973678eccf84adad97dd8b50683433475056d201a0861b9836144d
-  data.tar.gz: 04dc35d206db7f33cee95cbe3adb8668e8bd4536e1d550f69e4118a1d2575f2d24f362d030c263ae3b6e31d29fb7cdf6b1843e00f6d13ba1654ea1a5c964ff02
+  metadata.gz: 61550f9549122a0b672105f5dd92fa60f201e8fed9dbb9d5944c3f5b0237ea71bf24dbaf4e173790353823c0edfd7c73d13ef0c7083005c30e9b2ddeaabb6637
+  data.tar.gz: a825c405dda69678aec26944c058412ed35b559da8ef3699add383cab98516b6c4d91977e3a3949943f8f9390ce2191e369e8e74878c80db07d1ad9c4b1bccea

data/.github/workflows/ci.yml

@@ -0,0 +1,35 @@
+name: ci
+
+on: push
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby_version: [jruby]
+
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        lfs: true
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby_version }}
+    - name: Download CodeClimate reporter
+      run: |
+        curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+        chmod +x ./cc-test-reporter
+        ./cc-test-reporter before-build
+      env:
+        CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
+    - name: Build and test
+      run: |
+        make bundle
+        make test
+    - name: Report to CodeClimate
+      run: |
+        ./cc-test-reporter after-build --exit-code 0
+      env:
+        CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}

data/.gitignore

@@ -8,3 +8,4 @@
 /tmp/
 
 Gemfile.lock
+.rbnext/

data/.rubocop.yml

@@ -1,6 +1,11 @@
+require:
+  - ruby-next/rubocop
+
 AllCops:
   NewCops: enable
   TargetRubyVersion: 2.5
+  Exclude:
+    - 'lib/.rbnext/**/*'
 
 Style/Documentation:
   Enabled: false

data/Makefile

@@ -1,12 +1,17 @@
-.PHONY: test setup bundle lint console download-jars
+.PHONY: test transpile install setup bundle lint console download-jars build-gem build
 
 test:
 	jruby -Itest -Ilib bin/test
 
-setup:
+transpile:
+	ruby-next nextify ./lib
+
+install:
 	jruby -S gem install bundler
 	jruby -S bundle install
 
+setup: install transpile
+
 bundle:
 	jruby -S bundle
 
@@ -25,3 +30,8 @@ download-jars:
 	mvn dependency:get -Dartifact=com.structurizr:structurizr-core:LATEST -Ddest=./lib/structurizr/metal/jars/
 	mvn dependency:get -Dartifact=com.structurizr:structurizr-graphviz:LATEST -Ddest=./lib/structurizr/metal/jars/
 	mvn dependency:get -Dartifact=com.structurizr:structurizr-client:LATEST -Ddest=./lib/structurizr/metal/jars/
+
+build-gem:
+	gem build
+
+build: transpile build-gem

data/README.md

@@ -3,11 +3,13 @@
 [![Test Coverage](https://api.codeclimate.com/v1/badges/b75e8c130fc8b3bf54b5/test_coverage)](https://codeclimate.com/github/Morozzzko/structurizr-ruby/test_coverage)[![Maintainability](https://api.codeclimate.com/v1/badges/b75e8c130fc8b3bf54b5/maintainability)](https://codeclimate.com/github/Morozzzko/structurizr-ruby/maintainability)
 
 
-`structurizr-ruby` brings the [C4 model](https://c4model.com) to Ruby. It piggybacks on top of [Java's API](https://github.com/structurizr/java) for [Structurizr](https://structurizr.com), which is a powerful tool for incorporating C4 model into your software architecture process. 
+`structurizr-ruby` brings the [C4 model](https://c4model.com) to Ruby. It piggybacks on top of [Java's API](https://github.com/structurizr/java) for [Structurizr](https://structurizr.com), which is a powerful tool for incorporating C4 model into your software architecture process.
 
 The primary goal is to enable better introspection & scripting for workspaces defined by Structurizr DSL.
 
-As a bonus, this library provides a complete integration to build Structurizr workspace from Ruby. However, it doesn't make much sense since there's Structurizr DSL.
+Number 1 feature of this library is actually a runnable `REPL` which allows a flexible introspection. You can run it via `structurizr-repl <workspace.json>`.
+
+As a bonus, this library provides a complete integration to build Structurizr workspace from Ruby. However, it doesn't make much sense since there's [Structurizr DSL](https://structurizr.com/help/dsl). However, it's still a bit useful if you're using [DSL's scripting feature](https://github.com/structurizr/dsl/blob/master/docs/language-reference.md#scripts), you might find this library a bit useful.
 
 If you've met something which doesn't have a nice Ruby DSL, you can always use [`Structurizr::Metal`](/lib/structurizr/metal.rb) to access Java classes and methods. Please don't forget to [submit issue or a pull-request](#Contributing) which describes your use-case and the missing features.
 
@@ -37,6 +39,8 @@ Before you start, you need to `require` the necessary files:
 require 'structurizr'
 ```
 
+If you have a `workspace.json`, you can run an interactive REPL to read values from it: `structurizr-repl workspace.json`
+
 ## Development
 
 After checking out the repo, run `make setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/exe/structurizr-repl

@@ -3,8 +3,9 @@
 
 require 'structurizr'
 require 'structurizr/repl'
+require 'ruby-next/pry'
 
-application = Structurizr::REPL::Application.new
+application = Structurizr::REPL::Application.new(ARGV)
 
 application.parse_workspace_path!
 application.prepare_context!

data/lib/structurizr/location.rb

@@ -4,4 +4,10 @@ require 'structurizr/metal'
 
 module Structurizr
   Location = Metal::Model::Location
+
+  class Location
+    def inspect
+      %(#<Structurizr::Location::#{name}>)
+    end
+  end
 end

data/lib/structurizr/model_item.rb

@@ -12,7 +12,7 @@ module Structurizr
 
     def inspect
       class_name = self.class.name.split('::').last
-      %(<#{class_name}: "#{name}">)
+      %(#<Structurizr::#{class_name}(#{name.inspect})>)
     end
   end
 end

data/lib/structurizr/relationship.rb

@@ -4,4 +4,16 @@ require 'structurizr/metal'
 
 module Structurizr
   Relationship = Metal::Model::Relationship
+
+  class Relationship
+    def inspect
+      parts = [
+        "#{source.name.inspect} -> #{destination.name.inspect}",
+        description.inspect,
+        technology.inspect
+      ].reject(&:empty?).join(" ")
+
+      %(#<#{parts}>)
+    end
+  end
 end

data/lib/structurizr/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Structurizr
-  VERSION = '1.0.0-alpha.2'
+  VERSION = '1.0.0.rc.2'
 end

data/lib/structurizr/workspace.rb

@@ -15,5 +15,9 @@ module Structurizr
     def self.from_json(json)
       Metal::Util::WorkspaceUtils.from_json(json)
     end
+
+    def inspect
+      %(#<Structurizr::Workspace(#{name.inspect})>)
+    end
   end
 end

data/lib/structurizr.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+require 'ruby-next/language/setup'
+RubyNext::Language.setup_gem_load_path
+
 require 'structurizr/version'
 require 'structurizr/model_item'
 require 'structurizr/workspace'

data/structurizr.gemspec

@@ -19,13 +19,14 @@ Gem::Specification.new do |spec|
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|.github)/}) }
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
   spec.add_dependency 'pry'
+  spec.add_dependency 'ruby-next'
   spec.add_development_dependency 'minitest'
   spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'rubocop-minitest'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: structurizr
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.alpha.2
+  version: 1.0.0.rc.2
 platform: ruby
 authors:
 - Igor S. Morozov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-09-04 00:00:00.000000000 Z
+date: 2022-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: ruby-next
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
@@ -89,6 +103,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitattributes"
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".jrubyrc"
 - ".reek.yml"