convenient_service 0.19.0 → 0.20.0

data/lib/convenient_service/service/plugins/has_mermaid_flowchart/entities/flowchart/entities/code/commands/generate_lines.rb

@@ -1,94 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Service
-    module Plugins
-      module HasMermaidFlowchart
-        module Entities
-          class Flowchart
-            module Entities
-              class Code
-                module Commands
-                  class GenerateLines < Support::Command
-                    include Support::Delegate
-
-                    ##
-                    # @api private
-                    #
-                    # @!attribute code [r]
-                    #   @return [ConvenientService::Service::Plugins::HasMermaidFlowchart::Entities::Flowchart::Entities::Code]
-                    #
-                    attr_reader :code
-
-                    ##
-                    # @api private
-                    #
-                    # @return [ConvenientService::Service::Plugins::HasMermaidFlowchart::Entities::Flowchart]
-                    #
-                    delegate :flowchart, to: :code
-
-                    ##
-                    # @api private
-                    #
-                    # @return [ConvenientService::Service]
-                    #
-                    delegate :service, to: :flowchart
-
-                    ##
-                    # @api private
-                    #
-                    # @return [ConvenientService::Service::Plugins::HasMermaidFlowchart::Entities::Flowchart::Entities::Settings]
-                    #
-                    delegate :settings, to: :flowchart
-
-                    ##
-                    # @api private
-                    #
-                    # @param code [ConvenientService::Service::Plugins::HasMermaidFlowchart::Entities::Flowchart::Entities::Code]
-                    # @return [void]
-                    #
-                    def initialize(code:)
-                      @code = code
-                    end
-
-                    ##
-                    # @api private
-                    #
-                    # @return [Array<String>]
-                    #
-                    def call
-                      [first_line, *service_lines]
-                    end
-
-                    private
-
-                    ##
-                    # @return [String]
-                    #
-                    # @internal
-                    #   NOTE: Flowchart docs.
-                    #   - https://mermaid.js.org/syntax/flowchart.html
-                    #
-                    def first_line
-                      <<~MERMAID.chomp
-                        flowchart #{settings.direction}
-                      MERMAID
-                    end
-
-                    ##
-                    # @return [Array<String>]
-                    #
-                    def service_lines
-                      GenerateServiceLines[service: service, ids: [], settings: settings]
-                        .map { |line| "  #{line}" }
-                    end
-                  end
-                end
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/service/plugins/has_mermaid_flowchart/entities/flowchart/entities/code/commands/generate_method_step_lines.rb

@@ -1,115 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Service
-    module Plugins
-      module HasMermaidFlowchart
-        module Entities
-          class Flowchart
-            module Entities
-              class Code
-                module Commands
-                  class GenerateMethodStepLines < Support::Command
-                    ##
-                    # @api private
-                    #
-                    # @!attribute service [r]
-                    #   @return [ConvenientService::Service]
-                    #
-                    attr_reader :service
-
-                    ##
-                    # @api private
-                    #
-                    # @!attribute step [r]
-                    #   @return [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Step]
-                    #
-                    attr_reader :step
-
-                    ##
-                    # @api private
-                    #
-                    # @!attribute ids [r]
-                    #   @return [Array<String>]
-                    #
-                    attr_reader :ids
-
-                    ##
-                    # @api private
-                    #
-                    # @!attribute settings [r]
-                    #   @return [ConvenientService::Service::Plugins::HasMermaidFlowchart::Entities::Flowchart::Entities::Settings]
-                    #
-                    attr_reader :settings
-
-                    ##
-                    # @api private
-                    #
-                    # @param service [ConvenientService::Service]
-                    # @param step [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Step]
-                    # @param ids [Array<String>]
-                    # @param settings [ConvenientService::Service::Plugins::HasMermaidFlowchart::Entities::Flowchart::Entities::Settings]
-                    # @return [void]
-                    #
-                    def initialize(service:, step:, ids:, settings:)
-                      @service = service
-                      @step = step
-                      @ids = ids
-                      @settings = settings
-                    end
-
-                    ##
-                    # @api private
-                    #
-                    # @return [Array<String>]
-                    #
-                    def call
-                      [
-                        <<~MERMAID.chomp
-                          #{service_id}[#{service_name}] --> #{method_step_id}[#{method_step_name}]
-                        MERMAID
-                      ]
-                    end
-
-                    private
-
-                    ##
-                    # @return [String]
-                    #
-                    # @internal
-                    #   TODO: Entities::ID.
-                    #
-                    def service_id
-                      ids.join("-")
-                    end
-
-                    ##
-                    # @return [String]
-                    #
-                    def service_name
-                      Utils::Class.display_name(service)
-                    end
-
-                    ##
-                    # @return [String]
-                    #
-                    def method_step_id
-                      "#{service_id}-#{step.method}"
-                    end
-
-                    ##
-                    # @return [String]
-                    #
-                    def method_step_name
-                      "#{service_name}##{step.method}"
-                    end
-                  end
-                end
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/service/plugins/has_mermaid_flowchart/entities/flowchart/entities/code/commands/generate_result_lines.rb

@@ -1,105 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Service
-    module Plugins
-      module HasMermaidFlowchart
-        module Entities
-          class Flowchart
-            module Entities
-              class Code
-                module Commands
-                  class GenerateResultLines < Support::Command
-                    ##
-                    # @api private
-                    #
-                    # @!attribute service [r]
-                    #   @return [ConvenientService::Service]
-                    #
-                    attr_reader :service
-
-                    ##
-                    # @api private
-                    #
-                    # @!attribute ids [r]
-                    #   @return [Array<String>]
-                    #
-                    attr_reader :ids
-
-                    ##
-                    # @api private
-                    #
-                    # @!attribute settings [r]
-                    #   @return [ConvenientService::Service::Plugins::HasMermaidFlowchart::Entities::Flowchart::Entities::Settings]
-                    #
-                    attr_reader :settings
-
-                    ##
-                    # @api private
-                    #
-                    # @param service [ConvenientService::Service]
-                    # @param ids [Array<String>]
-                    # @param settings [ConvenientService::Service::Plugins::HasMermaidFlowchart::Entities::Flowchart::Entities::Settings]
-                    # @return [void]
-                    #
-                    def initialize(service:, ids:, settings:)
-                      @service = service
-                      @ids = ids
-                      @settings = settings
-                    end
-
-                    ##
-                    # @api private
-                    #
-                    # @return [Array<String>]
-                    #
-                    def call
-                      [
-                        <<~MERMAID.chomp
-                          #{service_id}[#{service_name}] --> #{result_id}[#{result_name}]
-                        MERMAID
-                      ]
-                    end
-
-                    private
-
-                    ##
-                    # @return [String]
-                    #
-                    # @internal
-                    #   TODO: Entities::ID.
-                    #
-                    def service_id
-                      ids.join("-")
-                    end
-
-                    ##
-                    # @return [String]
-                    #
-                    def service_name
-                      Utils::Class.display_name(service)
-                    end
-
-                    ##
-                    # @return [String]
-                    #
-                    def result_id
-                      "#{service_id}-result"
-                    end
-
-                    ##
-                    # @return [String]
-                    #
-                    def result_name
-                      "#{service_name}#result"
-                    end
-                  end
-                end
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/service/plugins/has_mermaid_flowchart/entities/flowchart/entities/code/commands/generate_service_lines.rb

@@ -1,88 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Service
-    module Plugins
-      module HasMermaidFlowchart
-        module Entities
-          class Flowchart
-            module Entities
-              class Code
-                module Commands
-                  class GenerateServiceLines < Support::Command
-                    ##
-                    # @api private
-                    #
-                    # @!attribute service [r]
-                    #   @return [ConvenientService::Service]
-                    #
-                    attr_reader :service
-
-                    ##
-                    # @api private
-                    #
-                    # @!attribute ids [r]
-                    #   @return [Array<String>]
-                    #
-                    attr_reader :ids
-
-                    ##
-                    # @api private
-                    #
-                    # @!attribute settings [r]
-                    #   @return [ConvenientService::Service::Plugins::HasMermaidFlowchart::Entities::Flowchart::Entities::Settings]
-                    #
-                    attr_reader :settings
-
-                    ##
-                    # @api private
-                    #
-                    # @param service [ConvenientService::Service]
-                    # @param ids [Array<String>]
-                    # @param settings [ConvenientService::Service::Plugins::HasMermaidFlowchart::Entities::Flowchart::Entities::Settings]
-                    # @return [void]
-                    #
-                    def initialize(service:, ids:, settings:)
-                      @service = service
-                      @ids = ids
-                      @settings = settings
-                    end
-
-                    ##
-                    # @api private
-                    #
-                    # @return [Array<String>]
-                    #
-                    def call
-                      return Commands::GenerateResultLines[service: service, settings: settings, ids: next_ids] if service.steps.none?
-
-                      service.steps.flat_map do |step|
-                        if step.method_step?
-                          Commands::GenerateMethodStepLines[service: service, settings: settings, step: step, ids: next_ids]
-                        else
-                          Commands::GenerateServiceStepLines[service: service, settings: settings, step: step, ids: next_ids]
-                        end
-                      end
-                    end
-
-                    private
-
-                    ##
-                    # @return [Array<String>]
-                    #
-                    # @internal
-                    #   TODO: Entities::ID.
-                    #
-                    def next_ids
-                      @next_ids ||= ids + [service.object_id]
-                    end
-                  end
-                end
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/service/plugins/has_mermaid_flowchart/entities/flowchart/entities/code/commands/generate_service_step_lines.rb

@@ -1,127 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Service
-    module Plugins
-      module HasMermaidFlowchart
-        module Entities
-          class Flowchart
-            module Entities
-              class Code
-                module Commands
-                  class GenerateServiceStepLines < Support::Command
-                    ##
-                    # @api private
-                    #
-                    # @!attribute service [r]
-                    #   @return [ConvenientService::Service]
-                    #
-                    attr_reader :service
-
-                    ##
-                    # @api private
-                    #
-                    # @!attribute step [r]
-                    #   @return [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Step]
-                    #
-                    attr_reader :step
-
-                    ##
-                    # @api private
-                    #
-                    # @!attribute ids [r]
-                    #   @return [Array<String>]
-                    #
-                    attr_reader :ids
-
-                    ##
-                    # @api private
-                    #
-                    # @!attribute settings [r]
-                    #   @return [ConvenientService::Service::Plugins::HasMermaidFlowchart::Entities::Flowchart::Entities::Settings]
-                    #
-                    attr_reader :settings
-
-                    ##
-                    # @api private
-                    #
-                    # @param service [ConvenientService::Service]
-                    # @param step [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Step]
-                    # @param ids [Array<String>]
-                    # @param settings [ConvenientService::Service::Plugins::HasMermaidFlowchart::Entities::Flowchart::Entities::Settings]
-                    # @return [void]
-                    #
-                    def initialize(service:, step:, ids:, settings:)
-                      @service = service
-                      @step = step
-                      @ids = ids
-                      @settings = settings
-                    end
-
-                    ##
-                    # @api private
-                    #
-                    # @return [String]
-                    #
-                    def call
-                      [step_service_line, *sub_service_lines]
-                    end
-
-                    private
-
-                    ##
-                    # @return [String]
-                    #
-                    def step_service_line
-                      <<~MERMAID.chomp
-                        #{service_id}[#{service_name}] --> #{service_step_id}[#{service_step_name}]
-                      MERMAID
-                    end
-
-                    ##
-                    # @return [String]
-                    #
-                    def sub_service_lines
-                      Commands::GenerateServiceLines[service: step.service.klass, ids: ids, settings: settings]
-                    end
-
-                    ##
-                    # @return [String]
-                    #
-                    # @internal
-                    #   TODO: Entities::ID.
-                    #
-                    def service_id
-                      ids.join("-")
-                    end
-
-                    ##
-                    # @return [String]
-                    #
-                    def service_name
-                      Utils::Class.display_name(service)
-                    end
-
-                    ##
-                    # @return [String]
-                    #
-                    def service_step_id
-                      "#{service_id}-#{step.service.klass.object_id}"
-                    end
-
-                    ##
-                    # @return [String]
-                    #
-                    def service_step_name
-                      Utils::Class.display_name(step.service.klass)
-                    end
-                  end
-                end
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/service/plugins/has_mermaid_flowchart/entities/flowchart/entities/code/commands.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "commands/generate_lines"
-require_relative "commands/generate_method_step_lines"
-require_relative "commands/generate_result_lines"
-require_relative "commands/generate_service_lines"
-require_relative "commands/generate_service_step_lines"

data/lib/convenient_service/service/plugins/has_mermaid_flowchart/entities/flowchart/entities/code.rb

@@ -1,90 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "code/commands"
-
-module ConvenientService
-  module Service
-    module Plugins
-      module HasMermaidFlowchart
-        module Entities
-          class Flowchart
-            module Entities
-              class Code
-                ##
-                # @api private
-                #
-                # @!attribute flowchart [r]
-                #   @return [ConvenientService::Service::Plugins::HasMermaidFlowchart::Entities::Flowchart]
-                #
-                attr_reader :flowchart
-
-                ##
-                # @api private
-                #
-                # @return [void]
-                #
-                def initialize(flowchart:)
-                  @flowchart = flowchart
-                end
-
-                ##
-                # @api private
-                #
-                # @return [String]
-                #
-                # @example Generated code for a service with steps, but without nested steps.
-                #
-                #   flowchart LR
-                #     7900[ConvenientService::Examples::Standard::Gemfile::Services::ReadFileContent] --> 7900-validate_path[ConvenientService::Examples::Standard::Gemfile::Services::ReadFileContent#validate_path]
-                #     7900[ConvenientService::Examples::Standard::Gemfile::Services::ReadFileContent] --> 7900-7920[ConvenientService::Examples::Standard::Gemfile::Services::AssertFileExists]
-                #     7900-7920[ConvenientService::Examples::Standard::Gemfile::Services::AssertFileExists] --> 7900-7920-result[ConvenientService::Examples::Standard::Gemfile::Services::AssertFileExists#result]
-                #     7900[ConvenientService::Examples::Standard::Gemfile::Services::ReadFileContent] --> 7900-7940[ConvenientService::Examples::Standard::Gemfile::Services::AssertFileNotEmpty]
-                #     7900-7940[ConvenientService::Examples::Standard::Gemfile::Services::AssertFileNotEmpty] --> 7900-7940-result[ConvenientService::Examples::Standard::Gemfile::Services::AssertFileNotEmpty#result]
-                #     7900[ConvenientService::Examples::Standard::Gemfile::Services::ReadFileContent] --> 7900-result[ConvenientService::Examples::Standard::Gemfile::Services::ReadFileContent#result]
-                #
-                def generate
-                  lines.join("\n")
-                end
-
-                ##
-                # @api private
-                #
-                # @return [String]
-                #
-                # @example Generated code for a service with steps, but without nested steps.
-                #
-                #   [
-                #     "flowchart LR",
-                #     "  7900[ConvenientService::Examples::Standard::Gemfile::Services::ReadFileContent] --> 7900-validate_path[ConvenientService::Examples::Standard::Gemfile::Services::ReadFileContent#validate_path]",
-                #     "  7900[ConvenientService::Examples::Standard::Gemfile::Services::ReadFileContent] --> 7900-7920[ConvenientService::Examples::Standard::Gemfile::Services::AssertFileExists]",
-                #     "  7900-7920[ConvenientService::Examples::Standard::Gemfile::Services::AssertFileExists] --> 7900-7920-result[ConvenientService::Examples::Standard::Gemfile::Services::AssertFileExists#result]",
-                #     "  7900[ConvenientService::Examples::Standard::Gemfile::Services::ReadFileContent] --> 7900-7940[ConvenientService::Examples::Standard::Gemfile::Services::AssertFileNotEmpty]",
-                #     "  7900-7940[ConvenientService::Examples::Standard::Gemfile::Services::AssertFileNotEmpty] --> 7900-7940-result[ConvenientService::Examples::Standard::Gemfile::Services::AssertFileNotEmpty#result]",
-                #     "  7900[ConvenientService::Examples::Standard::Gemfile::Services::ReadFileContent] --> 7900-result[ConvenientService::Examples::Standard::Gemfile::Services::ReadFileContent#result]"
-                #   ]
-                #
-                def lines
-                  Commands::GenerateLines[code: self]
-                end
-
-                ##
-                # @api private
-                #
-                # @param other [Object]
-                # @return [Boolean, nil]
-                #
-                def ==(other)
-                  return unless other.instance_of?(self.class)
-
-                  return false if flowchart != other.flowchart
-
-                  true
-                end
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end