structurizr 1.0.0.pre.alpha.1 → 1.0.0.pre.alpha.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df83d13062a0819df87ea4dc9a1321f83bb81c54d965f9df2ac28411b614a5b9
-  data.tar.gz: facec0bf9bc67e67da85e10a9ac51fb6fa1817b4b74f7e12e543ff0f64566724
+  metadata.gz: fe8a005a3c60de0672a5d97461b0ec492efc28cdd47b9ccce953adbb405b032a
+  data.tar.gz: 2c7e7fa0f87ac51bdc9a78adb68be7c640b2f1f04e01b93d28912031a18de16d
 SHA512:
-  metadata.gz: b41f7c1f86b695ddb5810dac2b0b378b300653770ef4b3b9b522e08026bf89c310445ee5290663505369242cea4f98b87b21e4b4dbe94dbbe12306192b79c0c8
-  data.tar.gz: 4c02c4a4dc5547bc6b9d82be0417ba98a83f05f554c799cede8b1f2b2227b907005051833725dcb4a57c3a9b833504dd175331263ff667c168da812eb324a744
+  metadata.gz: 20e3190211889b56a2a8721050c658253bcb6971a8a14ebf1baa7afecea7457437b8f964ed973678eccf84adad97dd8b50683433475056d201a0861b9836144d
+  data.tar.gz: 04dc35d206db7f33cee95cbe3adb8668e8bd4536e1d550f69e4118a1d2575f2d24f362d030c263ae3b6e31d29fb7cdf6b1843e00f6d13ba1654ea1a5c964ff02

data/.rubocop.yml

@@ -1,5 +1,6 @@
 AllCops:
   NewCops: enable
+  TargetRubyVersion: 2.5
 
 Style/Documentation:
   Enabled: false

data/Makefile

@@ -1,15 +1,4 @@
-.PHONY: download-jars test console
-
-
-download-jars:
-	rm -f lib/structurizr/metal/jars/*.jar
-	mvn dependency:get -Dartifact=commons-logging:commons-logging:LATEST -Ddest=./lib/structurizr/metal/jars/
-	mvn dependency:get -Dartifact=com.fasterxml.jackson.core:jackson-core:LATEST -Ddest=./lib/structurizr/metal/jars/
-	mvn dependency:get -Dartifact=com.fasterxml.jackson.core:jackson-databind:LATEST -Ddest=./lib/structurizr/metal/jars/
-	mvn dependency:get -Dartifact=com.fasterxml.jackson.core:jackson-annotations:LATEST -Ddest=./lib/structurizr/metal/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/
+.PHONY: test setup bundle lint console download-jars
 
 test:
 	jruby -Itest -Ilib bin/test
@@ -24,8 +13,15 @@ bundle:
 lint:
 	jruby -S bundle exec rubocop
 
-build:
-	jruby -S gem build
-
 console:
 	bin/console
+
+download-jars:
+	rm -f lib/structurizr/metal/jars/*.jar
+	mvn dependency:get -Dartifact=commons-logging:commons-logging:LATEST -Ddest=./lib/structurizr/metal/jars/
+	mvn dependency:get -Dartifact=com.fasterxml.jackson.core:jackson-core:LATEST -Ddest=./lib/structurizr/metal/jars/
+	mvn dependency:get -Dartifact=com.fasterxml.jackson.core:jackson-databind:LATEST -Ddest=./lib/structurizr/metal/jars/
+	mvn dependency:get -Dartifact=com.fasterxml.jackson.core:jackson-annotations:LATEST -Ddest=./lib/structurizr/metal/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/

data/exe/structurizr-repl

@@ -0,0 +1,13 @@
+#!/usr/bin/env jruby
+# frozen_string_literal: true
+
+require 'structurizr'
+require 'structurizr/repl'
+
+application = Structurizr::REPL::Application.new
+
+application.parse_workspace_path!
+application.prepare_context!
+application.setup_pry!
+
+application.start

data/lib/structurizr/repl/commands.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Structurizr
+  module REPL
+    module Commands
+      class Workspace < Pry::ClassCommand
+        match 'workspace'
+        description 'Access current workspace'
+        group 'Structurizr'
+        command_options keep_retval: true
+
+        def process
+          target_self.workspace
+        end
+      end
+
+      class Model < Pry::ClassCommand
+        match 'model'
+        description "Access current workspace's model"
+        group 'Structurizr'
+        command_options keep_retval: true
+
+        def process
+          target_self.workspace.model
+        end
+      end
+
+      module Shortcuts
+        All = Pry::CommandSet.new
+
+        {
+          'Relationships' => 'relationships',
+          'Elements' => 'elements',
+          'People' => 'people',
+          'SoftwareSystems' => 'software_systems'
+        }.each do |class_name, attribute_name|
+          shortcut_class = Class.new(Pry::ClassCommand) do
+            match attribute_name
+            description "Access model's #{attribute_name}"
+            group 'Structurizr'
+            command_options keep_retval: true
+
+            define_method :process do
+              target_self.workspace.model.public_send(attribute_name.to_sym)
+            end
+          end
+
+          const_set(class_name, shortcut_class)
+
+          All.add_command shortcut_class
+        end
+      end
+    end
+  end
+end

data/lib/structurizr/repl.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require 'pry'
+require 'structurizr/repl/commands'
+
+module Structurizr
+  module REPL
+    # Simple module which defines a reader for a nested attribute
+    module Delegation
+      def delegate(*methods, to:)
+        methods.each do |method|
+          define_method method do
+            public_send(to).public_send(method)
+          end
+        end
+      end
+    end
+
+    InvalidWorkspaceFileError = Class.new(StandardError)
+
+    class Context
+      extend Delegation
+
+      attr_reader :workspace
+
+      delegate :model, to: :workspace
+      delegate :relationships, :elements, :software_systems, :people, to: :model
+
+      def initialize(workspace)
+        @workspace = workspace
+      end
+    end
+
+    class Application
+      attr_reader :context, :workspace_path, :argv
+
+      def initialize(argv)
+        @argv = argv
+      end
+
+      def parse_workspace_path!
+        @workspace_path =
+          if (input_path = argv.first) && File.file?(input_path)
+            argv.first
+          else
+            puts 'Usage: structurizr-repl <path/to/structurizr.json>'
+
+            raise InvalidWorkspaceFileError, 'Please specify a valid path'
+          end
+      end
+
+      def prepare_context!
+        @context = Structurizr::REPL::Context.new(
+          Structurizr::Workspace.from_json(
+            File.read(workspace_path)
+          )
+        )
+      end
+
+      def setup_pry!
+        setup_welcome_message
+        register_commands
+      end
+
+      def start
+        Pry.start(context)
+      end
+
+      private
+
+      def register_commands
+        Pry::Commands.add_command Structurizr::REPL::Commands::Workspace
+        Pry::Commands.add_command Structurizr::REPL::Commands::Model
+        Pry::Commands.import Structurizr::REPL::Commands::Shortcuts::All
+      end
+
+      def setup_welcome_message
+        Pry.hooks.add_hook(
+          :before_session,
+          :structurizr_welcome_message
+        ) do |output, _binding, _pry|
+          output.puts <<~ECHO
+            Welcome to Structurizr REPL
+
+            Type `help structurizr` to get a list of commands
+          ECHO
+        end
+      end
+    end
+  end
+end

data/lib/structurizr/version.rb

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

data/structurizr.gemspec

@@ -25,8 +25,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.add_dependency 'pry'
   spec.add_development_dependency 'minitest'
-  spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'rubocop-minitest'
   spec.add_development_dependency 'simplecov', '~> 0.17.1'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: structurizr
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.alpha.1
+  version: 1.0.0.pre.alpha.2
 platform: ruby
 authors:
 - Igor S. Morozov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-10 00:00:00.000000000 Z
+date: 2022-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -16,9 +16,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  name: minitest
+  name: pry
   prerelease: false
-  type: :development
+  type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -30,7 +30,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  name: pry
+  name: minitest
   prerelease: false
   type: :development
   version_requirements: !ruby/object:Gem::Requirement
@@ -83,7 +83,8 @@ dependencies:
 description:
 email:
 - igor@morozov.is
-executables: []
+executables:
+- structurizr-repl
 extensions: []
 extra_rdoc_files: []
 files:
@@ -98,6 +99,7 @@ files:
 - README.md
 - bin/console
 - bin/test
+- exe/structurizr-repl
 - lib/structurizr.rb
 - lib/structurizr/arc42_documentation_template.rb
 - lib/structurizr/automatic_documentation_template.rb
@@ -127,6 +129,8 @@ files:
 - lib/structurizr/paper_size.rb
 - lib/structurizr/person.rb
 - lib/structurizr/relationship.rb
+- lib/structurizr/repl.rb
+- lib/structurizr/repl/commands.rb
 - lib/structurizr/routing.rb
 - lib/structurizr/shape.rb
 - lib/structurizr/software_system.rb