js_dependency 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df7ebbe8ac02b295b1ec9d1f9829e7e94868933af1c935f1f5094f4e74f1e876
-  data.tar.gz: 388b4b017e4b1986b86f221a0bdc19490a9a9c8ca13eaea0847d032e094d6c31
+  metadata.gz: 105b4f97bf9e521b3665eaa4b1b3ffb28210cc9a3c5937eacf9e37720df78d09
+  data.tar.gz: 020eca2f41c6e7f63ac8f1bd91e7b0191e2496d5e28b62edabca74e58aa85251
 SHA512:
-  metadata.gz: 753bccf5874fbe9edd2784d6a999393c13bac53d1da213c861c4d6c4f93fa48d70c6c7bebacaa863aa894e3a38174f2d3a547809c8ee1d6181f793d76d949ab6
-  data.tar.gz: e449209ee8d7eaa9328db4b94cd28ef61352ace72e776d4297572a385d45bc8e2f5267dd05a638797f04b84268efd6cb61784ca6f4df939053d7172f7d7da8b0
+  metadata.gz: 4274c3354a8ddc358036c5a7246e5fa905947b4760417350ed28c57a02dd10a9fd4e77535c0fe2fdbe91ac4237d5f9a35d7acfc6f23257cb2201078f4608342f
+  data.tar.gz: 135352e118f7d89dd0c024be73ed3671ec075272d4d51f8138fe5a954d5f3e115782b559dcd3be67ebec380af3dbc95d2cf073fc3ede700e0fca4c3bee6d2cf2

data/.rubocop_todo.yml

@@ -1,22 +1,22 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2022-07-24 12:55:17 UTC using RuboCop version 1.31.2.
+# on 2022-07-24 23:16:43 UTC using RuboCop version 1.31.2.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 4
+# Offense count: 7
 # Configuration parameters: IgnoredMethods, CountRepeatedAttributes.
 Metrics/AbcSize:
-  Max: 37
+  Max: 40
 
-# Offense count: 4
+# Offense count: 5
 # Configuration parameters: IgnoredMethods.
 Metrics/CyclomaticComplexity:
-  Max: 15
+  Max: 16
 
-# Offense count: 7
+# Offense count: 9
 # Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
 Metrics/MethodLength:
   Max: 26
@@ -26,10 +26,10 @@ Metrics/MethodLength:
 Metrics/ParameterLists:
   Max: 9
 
-# Offense count: 4
+# Offense count: 5
 # Configuration parameters: IgnoredMethods.
 Metrics/PerceivedComplexity:
-  Max: 16
+  Max: 17
 
 # Offense count: 1
 # This cop supports safe autocorrection (--autocorrect).
@@ -42,9 +42,9 @@ Style/MultilineBlockChain:
   Exclude:
     - 'lib/js_dependency/mermaid/root.rb'
 
-# Offense count: 1
+# Offense count: 6
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns, IgnoredPatterns.
 # URISchemes: http, https
 Layout/LineLength:
-  Max: 182
+  Max: 183

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+## [0.3.1] - 2022-07-25
+
+- Multiple target paths for JsDependency.export and export_mermaid CLI.
+
 ## [0.3.0] - 2022-07-24
 
 - Stable mermaid support.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    js_dependency (0.3.0)
+    js_dependency (0.3.1)
       pathname
       thor
       yaml

data/README.md

@@ -49,10 +49,18 @@ exclude -> -e
 
 #### Export Mermaid Format
 
+##### Single target path
+
 ```shell
 js_dependency -s ./src -t ./src/App.vue -o ./mermaid.txt -c 2 -p 2 -n 1
 ```
 
+##### Multiple target paths
+
+```shell
+js_dependency -s ./src -t ./src/App.vue ./src/components/Sub.vue -o ./mermaid.txt -c 2 -p 2 -n 1
+```
+
 #### Export parents components list
 
 ```shell

data/lib/js_dependency/cli.rb

@@ -9,7 +9,7 @@ module JsDependency
 
     desc "export_mermaid", "Output mermaid flowchart string."
     option :src_path, type: :string, aliases: "-s", desc: "Root folder."
-    option :target_path, type: :string, aliases: "-t", desc: "Target file that you want to analyze."
+    option :target_path, type: :array, aliases: "-t", desc: "Target file that you want to analyze."
     option :output_path, type: :string, aliases: "-o", desc: "Output file path"
     option :child_analyze_level, type: :numeric, aliases: "-c", desc: "Output level of child dependency"
     option :parent_analyze_level, type: :numeric, aliases: "-p", desc: "Output level of parent dependency"
@@ -22,7 +22,7 @@ module JsDependency
       args = YAML.safe_load(pathname.read) if pathname.exist?
 
       src_path = options[:src_path] || args["src_path"]
-      target_path = options[:target_path] || args["target_path"]
+      target_paths = options[:target_path] || (args["target_path"].is_a?(String) ? [args["target_path"]] : args["target_path"])
       child_analyze_level = options[:child_analyze_level] || args["child_analyze_level"] || 2
       parent_analyze_level = options[:parent_analyze_level] || args["parent_analyze_level"] || 2
       output_path = options[:output_path] || args["output_path"] || nil
@@ -36,7 +36,7 @@ module JsDependency
 
       str = JsDependency.export_mermaid(
         src_path,
-        target_path,
+        target_paths,
         child_analyze_level: child_analyze_level,
         parent_analyze_level: parent_analyze_level,
         output_path: output_path,

data/lib/js_dependency/extract_script_tag.rb

@@ -17,6 +17,8 @@ module JsDependency
       scripts.uniq.sort.join("\n")
     end
 
+    # @param [String] str
+    # @return [String]
     def self.call(str)
       new(str).call
     end

data/lib/js_dependency/index_creator.rb

@@ -7,11 +7,16 @@ require_relative "pathname_utility"
 
 module JsDependency
   class IndexCreator
+    # @param [String] src
+    # @param [Array<String>] alias_paths
     def initialize(src, alias_paths: nil)
       @src = src
       @alias_paths = alias_paths
     end
 
+    # @param [String] src
+    # @param [Array<String>] alias_paths
+    # @param [Array<String>] excludes
     def self.call(src, alias_paths: nil, excludes: nil)
       index = new(src, alias_paths: alias_paths).call
       index.transform_values do |value|
@@ -19,6 +24,7 @@ module JsDependency
       end
     end
 
+    # @return [Hash]
     def call
       src_pathname = Pathname.new(@src).relative? ? Pathname.new(@src).realpath : Pathname.new(@src)
       raise Error, "#{@src} is not directory." unless src_pathname.directory?
@@ -31,6 +37,9 @@ module JsDependency
 
     private
 
+    # @param [Pathname] src_pathname
+    # @param [Array<String>] alias_paths
+    # @return [Hash]
     def index_from(src_pathname, alias_paths)
       pattern = %w[**/*.vue **/*.js **/*.jsx]
 
@@ -44,6 +53,9 @@ module JsDependency
       end
     end
 
+    # @param [Pathname] component_pathname
+    # @param [Array<String>] alias_paths
+    # @return [Array<Pathname>]
     def import_pathnames_from(component_pathname, alias_paths)
       component_dirname = component_pathname.dirname
       script_str = extract_script_string(component_pathname)
@@ -52,6 +64,10 @@ module JsDependency
       end
     end
 
+    # @param [String] import_path
+    # @param [Array<String>] alias_paths
+    # @param [Pathname] component_dirname
+    # @return [Pathname]
     def standardize_path(import_path, alias_paths, component_dirname)
       import_pathname = Pathname.new(replace_path_alias(import_path, alias_paths))
 
@@ -67,6 +83,8 @@ module JsDependency
       import_pathname.cleanpath
     end
 
+    # @param [Pathname] pathname
+    # @return [String]
     def extract_script_string(pathname)
       str = pathname.read
       extname = pathname.extname
@@ -75,6 +93,9 @@ module JsDependency
       JsDependency::ExtractScriptTag.call(str)
     end
 
+    # @param [String] path
+    # @param [Array<String>] alias_paths
+    # @return [String]
     def replace_path_alias(path, alias_paths)
       JsDependency::ReplacePathAlias.call(path, alias_paths)
     end

data/lib/js_dependency/mermaid/nodes_link.rb

@@ -5,25 +5,35 @@ module JsDependency
     class NodesLink
       attr_reader :parent, :child
 
+      # @param [String] parent
+      # @param [String] child
       def initialize(parent, child)
         @parent = Pathname.new(parent)
         @child = Pathname.new(child)
       end
 
+      # @param [Integer] level
+      # @return [String]
       def parent_module_name(level = 0)
         mermaid_str(@parent, level)
       end
 
+      # @param [Integer] level
+      # @return [String]
       def child_module_name(level = 0)
         mermaid_str(@child, level)
       end
 
       private
 
+      # @param [Pathname] pathname
+      # @param [Integer] level
       def mermaid_str(pathname, level = 0)
         "#{parse(pathname).join("_")}[\"#{parse(pathname, level).join("/")}\"]"
       end
 
+      # @param [Pathname] pathname
+      # @param [Integer] level
       def parse(pathname, level = -1)
         pathname.each_filename.with_object([]) { |filename, array| array << filename }.reverse[0..level].reverse
       end

data/lib/js_dependency/mermaid/root.rb

@@ -6,16 +6,34 @@ module JsDependency
     class Root
       attr_accessor :orientation
 
+      # @param [String] orientation
       def initialize(orientation = "LR")
         @orientation = orientation
         @list = []
       end
 
+      # @param [String] parent
+      # @param [String] child
       def add(parent, child)
         @list << NodesLink.new(parent, child)
       end
 
+      # @param [Integer] name_level
+      # @param [nil, String] src_path
+      # @return [String]
       def export(name_level: 1, src_path: nil)
+        ([export_header] + export_nodes(name_level: name_level, src_path: src_path)).join("\n")
+      end
+
+      # @return [String]
+      def export_header
+        "flowchart #{orientation}"
+      end
+
+      # @param [Integer] name_level
+      # @param [nil, String] src_path
+      # @return [Array]
+      def export_nodes(name_level: 1, src_path: nil)
         nodes_links = if src_path
                         src_pathname = Pathname.new(src_path).realpath
                         @list.map do |nodes_link|
@@ -25,12 +43,11 @@ module JsDependency
                       else
                         @list
                       end
-        str = "flowchart #{orientation}\n"
-        str + nodes_links.uniq do |link|
+        nodes_links.uniq do |link|
           "#{link.parent}__#{link.child}"
         end.sort_by { |link| "#{link.parent}__#{link.child}" }.map do |link|
           "#{link.parent_module_name(name_level)} --> #{link.child_module_name(name_level)}"
-        end.join("\n")
+        end
       end
     end
   end

data/lib/js_dependency/pathname_utility.rb

@@ -2,6 +2,8 @@
 
 module JsDependency
   module PathnameUtility
+    # @param [Pathname] pathname
+    # @return [Pathname]
     def self.complement_extname(pathname)
       return pathname if pathname.exist? || pathname.extname != ""
 
@@ -14,6 +16,8 @@ module JsDependency
       pathname
     end
 
+    # @param [String] target_path
+    # @return [Pathname]
     def self.to_target_pathname(target_path)
       if Pathname.new(target_path).relative? && Pathname.new(target_path).exist?
         Pathname.new(target_path).realpath

data/lib/js_dependency/replace_path_alias.rb

@@ -36,6 +36,7 @@ module JsDependency
       str
     end
 
+    # @return [Array<String>]
     def safe_list
       ["@rails/ujs"]
     end

data/lib/js_dependency/target_pathname.rb

@@ -63,6 +63,8 @@ module JsDependency
       index[target_path] || []
     end
 
+    # @param [String] target_path
+    # @return [Pathname]
     def to_target_pathname(target_path)
       if Pathname.new(target_path).relative? && Pathname.new(target_path).exist?
         Pathname.new(target_path).realpath

data/lib/js_dependency/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JsDependency
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

data/lib/js_dependency.rb

@@ -19,7 +19,7 @@ module JsDependency
   end
 
   # @param [String] src_path
-  # @param [String] target_path
+  # @param [Array<String>] target_paths
   # @param [String] orientation
   # @param [Hash, nil] alias_paths
   # @param [Integer] child_analyze_level
@@ -28,23 +28,27 @@ module JsDependency
   # @param [String, nil] output_path
   # @param [Array, nil] excludes
   # @return [String]
-  def self.export_mermaid(src_path, target_path, orientation: "LR", alias_paths: nil, child_analyze_level: 1, parent_analyze_level: 1, name_level: 1, output_path: nil, excludes: nil)
+  def self.export_mermaid(src_path, target_paths, orientation: "LR", alias_paths: nil, child_analyze_level: 1, parent_analyze_level: 1, name_level: 1, output_path: nil, excludes: nil)
     output_pathname = Pathname.new(output_path) if output_path
     index = JsDependency::IndexCreator.call(src_path, alias_paths: alias_paths, excludes: excludes)
 
-    target_pathname = JsDependency::TargetPathname.new(target_path)
+    nodes = []
+    target_paths.each do |target_path|
+      target_pathname = JsDependency::TargetPathname.new(target_path)
 
-    mermaid_root = JsDependency::Mermaid::Root.new(orientation)
+      mermaid_root = JsDependency::Mermaid::Root.new(orientation)
 
-    target_pathname.each_parent_path(parent_analyze_level, index) do |parent_path, child_path|
-      mermaid_root.add(parent_path, child_path)
-    end
+      target_pathname.each_parent_path(parent_analyze_level, index) do |parent_path, child_path|
+        mermaid_root.add(parent_path, child_path)
+      end
 
-    target_pathname.each_child_path(child_analyze_level, index) do |parent_path, child_path|
-      mermaid_root.add(parent_path, child_path)
+      target_pathname.each_child_path(child_analyze_level, index) do |parent_path, child_path|
+        mermaid_root.add(parent_path, child_path)
+      end
+      nodes += mermaid_root.export_nodes(name_level: name_level, src_path: src_path)
     end
 
-    output = mermaid_root.export(name_level: name_level, src_path: src_path)
+    output = (["flowchart LR"] + nodes.uniq).join("\n")
     output_pathname&.write(output)
     output
   end
@@ -62,12 +66,12 @@ module JsDependency
     index = JsDependency::IndexCreator.call(src_path, alias_paths: alias_paths, excludes: excludes)
 
     target_pathname = JsDependency::TargetPathname.new(target_path)
-    list = []
+    paths = []
     target_pathname.each_parent_path(parent_analyze_level, index) do |parent_path, _child_path|
-      list << parent_path
+      paths << parent_path
     end
-    output = list.uniq.sort.map do |path|
-      Pathname.new(path).relative_path_from(Pathname.new(src_path).realpath.to_s)
+    output = paths.uniq.sort.map do |path|
+      Pathname.new(path).exist? ? Pathname.new(path).relative_path_from(Pathname.new(src_path).realpath.to_s).to_s : Pathname.new(path).to_s
     end
     output_pathname&.write(output.sort.join("\n"))
     output
@@ -86,12 +90,12 @@ module JsDependency
     index = JsDependency::IndexCreator.call(src_path, alias_paths: alias_paths, excludes: excludes)
 
     target_pathname = JsDependency::TargetPathname.new(target_path)
-    list = []
+    paths = []
     target_pathname.each_child_path(child_analyze_level, index) do |_parent_path, child_path|
-      list << child_path
+      paths << child_path
     end
-    output = list.uniq.sort.map do |path|
-      Pathname.new(path).relative_path_from(Pathname.new(src_path).realpath.to_s)
+    output = paths.uniq.sort.map do |path|
+      Pathname.new(path).exist? ? Pathname.new(path).relative_path_from(Pathname.new(src_path).realpath.to_s).to_s : Pathname.new(path).to_s
     end
     output_pathname&.write(output.sort.join("\n"))
     output

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: js_dependency
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - junara