diver_down 0.0.1.alpha12 → 0.0.1.alpha14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 28056e77fa2f4be6b881359cb07fc3caf23eac9e2bcf170358b69b7408613934
-  data.tar.gz: b62338d4b24f306caee8bda3d463854fdd0bba2b1b35461d242a4cf71ad97e22
+  metadata.gz: 12f54ddda5108f877d6e1510710b5a397dfc92db94c21f6521739b5032e4351f
+  data.tar.gz: 4c3c4b1063fd4da506077a8f9908a9f621336ffed58e0f5fc8b4c9c5b54cbd15
 SHA512:
-  metadata.gz: 2cce0b916067444b615b22c4f57daadbfc885c1e2d098e68ad2277c4fcd322c4d1de3d13aa057db7c6458838381ed2adbd8a833ffe74592e325b4c0d44ae4dec
-  data.tar.gz: c3ab57af9bf2e873c032b9200b3b8ac8c8f7b206d7ca1792e59f69111dc6ff9e4a9e7a4d543389ddb70016d7ea29db7a375275d8c0f7e9d109079b0c84b696c1
+  metadata.gz: 476bee3370a190cb94adb215abe7c58deb8c0dac475fca258c9e673d09471c477f5ba7826ba2575524c0f80c1f5454236bb71fd244c8306d02d75ad7766e85b9
+  data.tar.gz: 2e155be624f952d2b0e69d8d9a5ec549053e7f2ddfa469c2ce998777421cab30a73a423a2ecba5264f1fe7e603c4186413a801dfcbe49e82ca39d8bad7ec4531

data/README.md

@@ -25,7 +25,7 @@ Or install it yourself as:
 
 ## Usage
 
-`divert_down` is mainly divided into the `DiverDown::Trace` for dynamic analysing ruby code, and the `DiverDown::Web` for viewing the result on the browser.
+`diver_down` is mainly divided into the `DiverDown::Trace` for dynamic analysing ruby code, and the `DiverDown::Web` for viewing the result on the browser.
 
 ### `DiverDown::Trace`
 
@@ -121,10 +121,10 @@ View the analysis results in a browser.
 This gem is specifically designed to analyze large applications with a modular monolithic architecture. It allows users to categorize each analyzed file into specified modules directly through the web interface.
 
 - `--definition-dir` Specifies the directory where the analysis results are stored.
-- `--module-store-path` Designates a path to save the results that include details on which module each file belongs to. If this option is not specified, the results will be temporarily stored in a default temporary file.
+- `--metadata` Designates a path to save the results that include details on which module each file belongs to. If this option is not specified, the results will be temporarily stored in a default temporary file.
 
 ```sh
-bundle exec diver_down_web --definition-dir tmp/diver_down --module-store-path tmp/module_store.yml
+bundle exec diver_down_web --definition-dir tmp/diver_down --metadata tmp/metadata.yml
 open http://localhost:8080
 ```
 
@@ -151,7 +151,7 @@ $ pnpm run dev
 
 # Start server for backend
 $ bundle install
-$ DIVER_DOWN_DIR=/path/to/definitions_dir DIVER_DOWN_MODULE_STORE=/path/to/module_store.yml bundle exec puma
+$ DIVER_DOWN_DIR=/path/to/definitions_dir DIVER_DOWN_METADATA=/path/to/metadata.yml bundle exec puma
 ```
 
 ## Contributing

data/exe/diver_down_web

@@ -14,7 +14,7 @@ option_parser = OptionParser.new do |opts|
     Usage: diver_down_web [options]
 
     Example:
-      diver_down_web --definition-dir /path/to/definitions --module-store /path/to/module_store.yml
+      diver_down_web --definition-dir /path/to/definitions --metadata /path/to/metadata.yml
 
     Options:
   BANNER
@@ -23,8 +23,8 @@ option_parser = OptionParser.new do |opts|
     options[:definition_dir] = path
   end
 
-  opts.on('--module-store PATH', 'Path to the module store') do |path|
-    options[:module_store] = path
+  opts.on('--metadata PATH', 'Path to the metadata.yml') do |path|
+    options[:metadata] = path
   end
 end
 option_parser.parse!(ARGV)
@@ -39,7 +39,7 @@ end
 app = Rack::JSONBodyParser.new(
   DiverDown::Web.new(
     definition_dir: options.fetch(:definition_dir),
-    module_store: DiverDown::Web::ModuleStore.new(options[:module_store] || Tempfile.new(['module_store', '.yaml']))
+    metadata: DiverDown::Web::Metadata.new(options[:metadata] || Tempfile.new(['metadata', '.yaml']).path)
   )
 )
 

data/lib/diver_down/definition/dependency.rb

@@ -102,6 +102,16 @@ module DiverDown
       def inspect
         %(#<#{self.class} source_name="#{source_name}" method_ids=#{method_ids}>")
       end
+
+      # @return [void]
+      def freeze
+        super
+        @method_id_map.transform_values do
+          _1.transform_values(&:freeze)
+          _1.freeze
+        end
+        @method_id_map.freeze
+      end
     end
   end
 end

data/lib/diver_down/definition/method_id.rb

@@ -78,6 +78,12 @@ module DiverDown
       def inspect
         %(#<#{self.class} #{human_method_name} paths=#{paths.inspect}>")
       end
+
+      # @return [void]
+      def freeze
+        super
+        @paths.freeze
+      end
     end
   end
 end

data/lib/diver_down/definition/source.rb

@@ -52,6 +52,12 @@ module DiverDown
         @dependency_map[dependency_source_name]
       end
 
+      # @param dependency_source_name [String]
+      # @return [void]
+      def delete_dependency(dependency_source_name)
+        @dependency_map.delete(dependency_source_name)
+      end
+
       # @return [Array<DiverDown::Definition::Dependency>]
       def dependencies
         @dependency_map.values.sort
@@ -85,6 +91,13 @@ module DiverDown
       def hash
         [self.class, source_name, dependencies].hash
       end
+
+      # @return [void]
+      def freeze
+        super
+        @dependency_map.transform_values(&:freeze)
+        @dependency_map.freeze
+      end
     end
   end
 end

data/lib/diver_down/definition.rb

@@ -103,5 +103,13 @@ module DiverDown
         [self.class, definition_group, title, sources].hash
       end
     end
+
+    # @return [void]
+    def freeze
+      super
+
+      @source_map.transform_values(&:freeze)
+      @source_map.freeze
+    end
   end
 end

data/lib/diver_down/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DiverDown
-  VERSION = '0.0.1.alpha12'
+  VERSION = '0.0.1.alpha14'
 end

data/lib/diver_down/web/action.rb

@@ -13,14 +13,50 @@ module DiverDown
       )
 
       # @param store [DiverDown::Definition::Store]
-      # @param module_store [DiverDown::Web::ModuleStore]
+      # @param metadata [DiverDown::Web::Metadata]
       # @param request [Rack::Request]
-      def initialize(store:, module_store:, request:)
+      def initialize(store:, metadata:, request:)
         @store = store
-        @module_store = module_store
+        @metadata = metadata
+        @source_alias_resolver = DiverDown::Web::SourceAliasResolver.new(@metadata.source_alias)
         @request = request
       end
 
+      # GET /api/source_aliases.json
+      def source_aliases
+        source_aliases = @metadata.source_alias.to_h.map do |alias_name, source_names|
+          {
+            alias_name:,
+            source_names:,
+          }
+        end
+
+        json(
+          source_aliases:
+        )
+      end
+
+      # POST /api/source_aliases.json
+      # @param alias_name [String]
+      # @param old_alias_name [String]
+      # @param source_names [Array<String>]
+      def update_source_alias(alias_name, old_alias_name, source_names)
+        @metadata.source_alias.transaction do
+          unless old_alias_name.to_s.empty?
+            # Delete old alias
+            @metadata.source_alias.update_alias(old_alias_name, [])
+          end
+
+          @metadata.source_alias.update_alias(alias_name, source_names)
+        end
+
+        @metadata.flush
+
+        json({})
+      rescue DiverDown::Web::Metadata::SourceAlias::ConflictError => e
+        json_error(e.message)
+      end
+
       # GET /api/sources.json
       def sources
         source_names = Set.new
@@ -33,14 +69,17 @@ module DiverDown
         end
         # rubocop:enable Style/HashEachMethods
 
-        classified_sources_count = source_names.count { @module_store.classified?(_1) }
+        classified_sources_count = source_names.count { @metadata.source(_1).modules? }
 
         json(
           sources: source_names.sort.map do |source_name|
+            source_metadata = @metadata.source(source_name)
+
             {
               source_name:,
-              memo: @module_store.get_memo(source_name),
-              modules: @module_store.get_modules(source_name).map do |module_name|
+              resolved_alias: @metadata.source_alias.resolve_alias(source_name),
+              memo: source_metadata.memo,
+              modules: source_metadata.modules.map do |module_name|
                 { module_name: }
               end,
             }
@@ -57,7 +96,7 @@ module DiverDown
         # rubocop:disable Style/HashEachMethods
         @store.each do |_, definition|
           definition.sources.each do |source|
-            modules = @module_store.get_modules(source.source_name)
+            modules = @metadata.source(source.source_name).modules
             module_set.add(modules) unless modules.empty?
           end
         end
@@ -84,7 +123,7 @@ module DiverDown
         # rubocop:disable Style/HashEachMethods
         @store.each do |_, definition|
           definition.sources.each do |source|
-            source_module_names = @module_store.get_modules(source.source_name)
+            source_module_names = @metadata.source(source.source_name).modules
 
             next unless source_module_names[0..module_names.size - 1] == module_names
 
@@ -109,7 +148,7 @@ module DiverDown
           sources: source_names.sort.map do |source_name|
             {
               source_name:,
-              memo: @module_store.get_memo(source_name),
+              memo: @metadata.source(source_name).memo,
             }
           end,
           related_definitions: related_definitions.map do |definition|
@@ -139,7 +178,7 @@ module DiverDown
               definition_group: definition.definition_group,
               title: definition.title,
               sources_count: definition.sources.size,
-              unclassified_sources_count: definition.sources.reject { @module_store.classified?(_1.source_name) }.size,
+              unclassified_sources_count: definition.sources.reject { @metadata.source(_1.source_name).modules? }.size,
             }
           end,
           pagination: pagination.to_h
@@ -161,6 +200,32 @@ module DiverDown
         )
       end
 
+      # GET /api/module_definition/:module_names.json
+      #
+      # @param bit_id [Integer]
+      # @param compound [Boolean]
+      # @param concentrate [Boolean]
+      # @param only_module [Boolean]
+      # @param modules [Array<String>]
+      def module_definition(compound, concentrate, only_module, modules)
+        definition = @store.combined_definition
+
+        # Filter all sources and dependencies by modules if match_modules is given
+        resolved_definition = DiverDown::Web::ModuleSourcesFilter.new(@metadata).filter(definition, modules:)
+
+        # Resolve source aliases
+        resolved_definition = @source_alias_resolver.resolve(resolved_definition)
+
+        render_combined_definition(
+          (1..@store.size).to_a,
+          resolved_definition,
+          modules,
+          compound:,
+          concentrate:,
+          only_module:
+        )
+      end
+
       # GET /api/definitions/:bit_id.json
       #
       # @param bit_id [Integer]
@@ -187,22 +252,16 @@ module DiverDown
                              end
 
         if definition
-          definition_to_dot = DiverDown::Web::DefinitionToDot.new(definition, @module_store, compound:, concentrate:, only_module:)
-
-          json(
-            titles:,
-            bit_id: DiverDown::Web::BitId.ids_to_bit_id(valid_ids).to_s,
-            dot: definition_to_dot.to_s,
-            dot_metadata: definition_to_dot.metadata,
-            sources: definition.sources.map do
-              {
-                source_name: _1.source_name,
-                memo: @module_store.get_memo(_1.source_name),
-                modules: @module_store.get_modules(_1.source_name).map do |module_name|
-                  { module_name: }
-                end,
-              }
-            end
+          # Resolve source aliases
+          resolved_definition = @source_alias_resolver.resolve(definition)
+
+          render_combined_definition(
+            valid_ids,
+            resolved_definition,
+            titles,
+            compound:,
+            concentrate:,
+            only_module:
           )
         else
           not_found
@@ -249,12 +308,13 @@ module DiverDown
                          []
                        else
                          source = DiverDown::Definition::Source.combine(*found_sources)
-                         @module_store.get_modules(source.source_name)
+                         @metadata.source(source.source_name).modules
                        end
 
         json(
           source_name:,
-          memo: @module_store.get_memo(source_name),
+          resolved_alias: @metadata.source_alias.resolve_alias(source_name),
+          memo: @metadata.source(source_name).memo,
           modules: module_names.map do
             { module_name: _1 }
           end,
@@ -291,8 +351,8 @@ module DiverDown
         end
 
         if found_source
-          @module_store.set_modules(source_name, modules)
-          @module_store.flush
+          @metadata.source(source_name).modules = modules
+          @metadata.flush
 
           json({})
         else
@@ -312,8 +372,8 @@ module DiverDown
         end
 
         if found_source
-          @module_store.set_memo(source_name, memo)
-          @module_store.flush
+          @metadata.source(source_name).memo = memo
+          @metadata.flush
 
           json({})
         else
@@ -370,8 +430,33 @@ module DiverDown
         end
       end
 
-      def json(data)
-        [200, { 'content-type' => 'application/json' }, [data.to_json]]
+      def json(data, status = 200)
+        [status, { 'content-type' => 'application/json' }, [data.to_json]]
+      end
+
+      def json_error(message, status = 422)
+        json({ message: }, status)
+      end
+
+      def render_combined_definition(ids, definition, titles, compound:, concentrate:, only_module:)
+        definition_to_dot = DiverDown::Web::DefinitionToDot.new(definition, @metadata, compound:, concentrate:, only_module:)
+
+        json(
+          titles:,
+          bit_id: DiverDown::Web::BitId.ids_to_bit_id(ids).to_s,
+          dot: definition_to_dot.to_s,
+          dot_metadata: definition_to_dot.dot_metadata,
+          sources: definition.sources.map do
+            {
+              source_name: _1.source_name,
+              resolved_alias: @metadata.source_alias.resolve_alias(_1.source_name),
+              memo: @metadata.source(_1.source_name).memo,
+              modules: @metadata.source(_1.source_name).modules.map do |module_name|
+                { module_name: }
+              end,
+            }
+          end
+        )
       end
     end
   end

data/lib/diver_down/web/definition_store.rb

@@ -5,12 +5,11 @@ module DiverDown
     class DefinitionStore
       include Enumerable
 
-      attr_reader :bit_id
-
       def initialize
         # Hash{ Integer(unique bit flag) => DiverDown::Definition }
         @definitions = []
         @definition_group_store = Hash.new { |h, k| h[k] = [] }
+        @combined_definition = nil
       end
 
       # @param id [Integer]
@@ -31,14 +30,33 @@ module DiverDown
           raise(ArgumentError, 'definition already set') if _1.store_id
 
           _1.store_id = @definitions.size + 1
+          _1.freeze
 
           @definitions.push(_1)
           @definition_group_store[_1.definition_group] << _1
 
+          # Reset combined_definition
+          @combined_definition = nil
+
           _1.store_id
         end
       end
 
+      # @return [DiverDown::Definition]
+      def combined_definition
+        if @combined_definition.nil?
+          @combined_definition = DiverDown::Definition.combine(
+            definition_group: nil,
+            title: 'All Definitions',
+            definitions: @definitions
+          )
+
+          @combined_definition.freeze
+        end
+
+        @combined_definition
+      end
+
       # @return [Array<String, nil>]
       def definition_groups
         keys = @definition_group_store.keys