js_dependency 0.2.3.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a59fced735fccc952d4f31d5dc27e41637ef5ee67bc5f5b7eb8038f5458808c
-  data.tar.gz: b4e713344b1a58d6dac1143068a20cf1e43bad0158c50c4ef28c1e8cd0b7ddc8
+  metadata.gz: df7ebbe8ac02b295b1ec9d1f9829e7e94868933af1c935f1f5094f4e74f1e876
+  data.tar.gz: 388b4b017e4b1986b86f221a0bdc19490a9a9c8ca13eaea0847d032e094d6c31
 SHA512:
-  metadata.gz: f2432b1e03352673908567cfc7f0ec5798bae146201db548c48899b1601e6d79680a3bef33daec2b82fa00bc541ff0b099757d65ded91f9801f026dcc5d52a56
-  data.tar.gz: 9f952a5dc433c9e687c12505dbb47136cbf8da671f5981cf008d1f002d282c3195f14976a94a911364c581adc55f36c68cb1e0d0459961328a49fa44b5e8bc4f
+  metadata.gz: 753bccf5874fbe9edd2784d6a999393c13bac53d1da213c861c4d6c4f93fa48d70c6c7bebacaa863aa894e3a38174f2d3a547809c8ee1d6181f793d76d949ab6
+  data.tar.gz: e449209ee8d7eaa9328db4b94cd28ef61352ace72e776d4297572a385d45bc8e2f5267dd05a638797f04b84268efd6cb61784ca6f4df939053d7172f7d7da8b0

data/.rubocop_todo.yml

@@ -1,37 +1,32 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2022-07-20 23:10:21 UTC using RuboCop version 1.31.2.
+# on 2022-07-24 12:55:17 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: 6
+# Offense count: 4
 # Configuration parameters: IgnoredMethods, CountRepeatedAttributes.
 Metrics/AbcSize:
   Max: 37
 
-# Offense count: 6
+# Offense count: 4
 # Configuration parameters: IgnoredMethods.
 Metrics/CyclomaticComplexity:
   Max: 15
 
-# Offense count: 8
+# Offense count: 7
 # Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
 Metrics/MethodLength:
   Max: 26
 
-# Offense count: 1
-# Configuration parameters: CountComments, CountAsOne.
-Metrics/ModuleLength:
-  Max: 114
-
 # Offense count: 3
 # Configuration parameters: CountKeywordArgs, MaxOptionalParameters.
 Metrics/ParameterLists:
   Max: 9
 
-# Offense count: 6
+# Offense count: 4
 # Configuration parameters: IgnoredMethods.
 Metrics/PerceivedComplexity:
   Max: 16
@@ -42,7 +37,12 @@ Style/IfUnlessModifier:
   Exclude:
     - 'lib/js_dependency/index_creator.rb'
 
-# Offense count: 2
+# Offense count: 1
+Style/MultilineBlockChain:
+  Exclude:
+    - 'lib/js_dependency/mermaid/root.rb'
+
+# Offense count: 1
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns, IgnoredPatterns.
 # URISchemes: http, https

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## [Unreleased]
 
+## [0.3.0] - 2022-07-24
+
+- Stable mermaid support.
+- Stable `excludes` option.
+- Refactor JsDependency class method using `JsDependency::TargetPathname`.
+
 ## [0.2.3.1] - 2022-07-21
 
 - Revert for script tag with line brake.

data/Gemfile.lock

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

data/lib/js_dependency/cli.rb

@@ -78,7 +78,7 @@ module JsDependency
         output_path: output_path,
         alias_paths: alias_paths,
         excludes: excludes
-      ).sort.uniq.join("\n")
+      ).join("\n")
 
       puts str
     end
@@ -113,7 +113,7 @@ module JsDependency
         output_path: output_path,
         alias_paths: alias_paths,
         excludes: excludes
-      ).sort.uniq.join("\n")
+      ).join("\n")
 
       puts str
     end

data/lib/js_dependency/index_creator.rb

@@ -12,8 +12,11 @@ module JsDependency
       @alias_paths = alias_paths
     end
 
-    def self.call(src, alias_paths: nil)
-      new(src, alias_paths: alias_paths).call
+    def self.call(src, alias_paths: nil, excludes: nil)
+      index = new(src, alias_paths: alias_paths).call
+      index.transform_values do |value|
+        value.reject { |path| excludes&.any? { |exclude| path.include?(exclude) } }
+      end
     end
 
     def call

data/lib/js_dependency/mermaid/nodes_link.rb

@@ -6,29 +6,26 @@ module JsDependency
       attr_reader :parent, :child
 
       def initialize(parent, child)
-        @parent = parent
-        @child = child
+        @parent = Pathname.new(parent)
+        @child = Pathname.new(child)
       end
 
       def parent_module_name(level = 0)
-        parse(Pathname.new(@parent), level).join("/")
+        mermaid_str(@parent, level)
       end
 
       def child_module_name(level = 0)
-        parse(Pathname.new(@child), level).join("/")
+        mermaid_str(@child, level)
       end
 
       private
 
-      def parse(pathname, level)
-        return [pathname.to_s] unless pathname.exist?
+      def mermaid_str(pathname, level = 0)
+        "#{parse(pathname).join("_")}[\"#{parse(pathname, level).join("/")}\"]"
+      end
 
-        array = [pathname.basename]
-        level.times do
-          array.unshift(pathname.parent.basename.to_s)
-          pathname = pathname.parent
-        end
-        array
+      def parse(pathname, level = -1)
+        pathname.each_filename.with_object([]) { |filename, array| array << filename }.reverse[0..level].reverse
       end
     end
   end

data/lib/js_dependency/mermaid/root.rb

@@ -15,9 +15,20 @@ module JsDependency
         @list << NodesLink.new(parent, child)
       end
 
-      def export(name_level: 1)
+      def export(name_level: 1, src_path: nil)
+        nodes_links = if src_path
+                        src_pathname = Pathname.new(src_path).realpath
+                        @list.map do |nodes_link|
+                          NodesLink.new(nodes_link.parent.exist? ? nodes_link.parent.relative_path_from(src_pathname.to_s) : nodes_link.parent.to_s,
+                                        nodes_link.child.exist? ? nodes_link.child.relative_path_from(src_pathname.to_s) : nodes_link.child.to_s)
+                        end
+                      else
+                        @list
+                      end
         str = "flowchart #{orientation}\n"
-        str + @list.uniq { |link| "#{link.parent}__#{link.child}" }.sort_by { |link| "#{link.parent}__#{link.child}" }.map do |link|
+        str + 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

data/lib/js_dependency/pathname_utility.rb

@@ -13,5 +13,13 @@ module JsDependency
 
       pathname
     end
+
+    def self.to_target_pathname(target_path)
+      if Pathname.new(target_path).relative? && Pathname.new(target_path).exist?
+        Pathname.new(target_path).realpath
+      else
+        Pathname.new(target_path)
+      end
+    end
   end
 end

data/lib/js_dependency/target_pathname.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module JsDependency
+  class TargetPathname
+    # @param [String] target_path
+    def initialize(target_path)
+      @pathname = if Pathname.new(target_path).relative? && Pathname.new(target_path).exist?
+                    Pathname.new(target_path).realpath
+                  else
+                    Pathname.new(target_path)
+                  end
+    end
+
+    # @param [Integer] analyze_level
+    # @param [Hash] index
+    def each_parent_path(analyze_level, index)
+      temp_paths = [@pathname.to_s]
+      analyze_level.times do
+        list = []
+        temp_paths.each do |temp_path|
+          temp_pathname = to_target_pathname(temp_path)
+
+          list += extract_parent_paths(temp_pathname.to_s, index).each do |parent_path|
+            yield parent_path, temp_pathname.to_s
+          end
+        end
+        temp_paths = list
+      end
+    end
+
+    # @param [Integer] analyze_level
+    # @param [Hash] index
+    def each_child_path(analyze_level, index)
+      temp_paths = [@pathname.to_s]
+      analyze_level.times do
+        list = []
+        temp_paths.each do |temp_path|
+          temp_pathname = to_target_pathname(temp_path)
+
+          list += extract_children_paths(temp_pathname.to_s, index).each do |child_path|
+            yield temp_pathname.to_s, child_path
+          end
+        end
+        temp_paths = list
+      end
+    end
+
+    private
+
+    # @param [String] target_path
+    # @param [Hash] index
+    # @return [Array]
+    def extract_parent_paths(target_path, index)
+      index.each_with_object([]) do |(parent, children), list|
+        list << parent if children.any?(target_path)
+      end
+    end
+
+    # @param [String] target_path
+    # @param [Hash] index
+    # @return [Array]
+    def extract_children_paths(target_path, index)
+      index[target_path] || []
+    end
+
+    def to_target_pathname(target_path)
+      if Pathname.new(target_path).relative? && Pathname.new(target_path).exist?
+        Pathname.new(target_path).realpath
+      else
+        Pathname.new(target_path)
+      end
+    end
+  end
+end

data/lib/js_dependency/version.rb

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

data/lib/js_dependency.rb

@@ -4,11 +4,20 @@ require_relative "js_dependency/version"
 require_relative "js_dependency/index_creator"
 require_relative "js_dependency/mermaid/root"
 require_relative "js_dependency/cli"
+require_relative "js_dependency/target_pathname"
 require "pathname"
 
 module JsDependency
   class Error < StandardError; end
 
+  # @param [String] src_path
+  # @param [Hash, nil] alias_paths
+  # @param [Array, nil] excludes
+  # @return [Hash]
+  def self.export_index(src_path, alias_paths: nil, excludes: nil)
+    JsDependency::IndexCreator.call(src_path, alias_paths: alias_paths, excludes: excludes)
+  end
+
   # @param [String] src_path
   # @param [String] target_path
   # @param [String] orientation
@@ -21,146 +30,70 @@ module JsDependency
   # @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)
     output_pathname = Pathname.new(output_path) if output_path
-    index = JsDependency::IndexCreator.call(src_path, alias_paths: alias_paths)
+    index = JsDependency::IndexCreator.call(src_path, alias_paths: alias_paths, excludes: excludes)
 
-    target_pathname = if Pathname.new(target_path).relative? && Pathname.new(target_path).exist?
-                        Pathname.new(target_path).realpath
-                      else
-                        Pathname.new(target_path)
-                      end
+    target_pathname = JsDependency::TargetPathname.new(target_path)
 
-    root = JsDependency::Mermaid::Root.new(orientation)
+    mermaid_root = JsDependency::Mermaid::Root.new(orientation)
 
-    parents_paths(target_pathname, parent_analyze_level, index, excludes: excludes) do |parent_path, child_path|
-      root.add(parent_path, child_path)
+    target_pathname.each_parent_path(parent_analyze_level, index) do |parent_path, child_path|
+      mermaid_root.add(parent_path, child_path)
     end
 
-    children_paths(target_pathname, child_analyze_level, index, excludes: excludes) do |parent_path, child_path|
-      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
 
-    output = root.export(name_level: name_level)
+    output = mermaid_root.export(name_level: name_level, src_path: src_path)
     output_pathname&.write(output)
     output
   end
 
+  # @param [String] src_path
+  # @param [String] target_path
+  # @param [String] orientation
+  # @param [Hash, nil] alias_paths
+  # @param [Integer] parent_analyze_level
+  # @param [String, nil] output_path
+  # @param [Array, nil] excludes
+  # @return [Array<Pathname>]
   def self.parents(src_path, target_path, alias_paths: nil, parent_analyze_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)
+    index = JsDependency::IndexCreator.call(src_path, alias_paths: alias_paths, excludes: excludes)
 
-    target_pathname = if Pathname.new(target_path).relative? && Pathname.new(target_path).exist?
-                        Pathname.new(target_path).realpath
-                      else
-                        Pathname.new(target_path)
-                      end
+    target_pathname = JsDependency::TargetPathname.new(target_path)
     list = []
-    parents_paths(target_pathname, parent_analyze_level, index, excludes: excludes) do |parent_path, _child_path|
+    target_pathname.each_parent_path(parent_analyze_level, index) do |parent_path, _child_path|
       list << parent_path
     end
-    output = list.uniq
+    output = list.uniq.sort.map do |path|
+      Pathname.new(path).relative_path_from(Pathname.new(src_path).realpath.to_s)
+    end
     output_pathname&.write(output.sort.join("\n"))
     output
   end
 
+  # @param [String] src_path
+  # @param [String] target_path
+  # @param [String] orientation
+  # @param [Hash, nil] alias_paths
+  # @param [Integer] child_analyze_level
+  # @param [String, nil] output_path
+  # @param [Array, nil] excludes
+  # @return [Array<Pathname>]
   def self.children(src_path, target_path, alias_paths: nil, child_analyze_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)
+    index = JsDependency::IndexCreator.call(src_path, alias_paths: alias_paths, excludes: excludes)
 
-    target_pathname = if Pathname.new(target_path).relative? && Pathname.new(target_path).exist?
-                        Pathname.new(target_path).realpath
-                      else
-                        Pathname.new(target_path)
-                      end
+    target_pathname = JsDependency::TargetPathname.new(target_path)
     list = []
-    children_paths(target_pathname, child_analyze_level, index, excludes: excludes) do |_parent_path, child_path|
+    target_pathname.each_child_path(child_analyze_level, index) do |_parent_path, child_path|
       list << child_path
     end
-    output = list.uniq
+    output = list.uniq.sort.map do |path|
+      Pathname.new(path).relative_path_from(Pathname.new(src_path).realpath.to_s)
+    end
     output_pathname&.write(output.sort.join("\n"))
     output
   end
-
-  # @param [String] target_path
-  # @param [Hash] index
-  # @return [Array]
-  def self.extract_parent_paths(target_path, index)
-    target_pathname = if Pathname.new(target_path).exist?
-                        Pathname.new(target_path).realpath
-                      else
-                        Pathname.new(target_path)
-                      end
-    index.each_with_object([]) do |(parent, children), list|
-      list << parent if children.any?(target_pathname.to_s)
-    end
-  end
-
-  private_class_method :extract_parent_paths
-
-  # @param [String] target_path
-  # @param [Hash] index
-  # @return [Array]
-  def self.extract_children_paths(target_path, index)
-    target_pathname = if Pathname.new(target_path).exist?
-                        Pathname.new(target_path).realpath
-                      else
-                        Pathname.new(target_path)
-                      end
-    index[target_pathname.to_s] || []
-  end
-
-  private_class_method :extract_children_paths
-
-  # @param [String] src
-  # @param [nil, Hash] alias_paths
-  def self.create_index(src_path, alias_paths: nil)
-    JsDependency::IndexCreator.call(src_path, alias_paths: alias_paths)
-  end
-
-  private_class_method :create_index
-
-  def self.parents_paths(target_pathname, analyze_level, index, excludes: nil)
-    temp_paths = [target_pathname.to_s]
-    analyze_level.times do
-      list = []
-      temp_paths.each do |temp_path|
-        temp_pathname = if Pathname.new(temp_path).relative? && Pathname.new(temp_path).exist?
-                          Pathname.new(temp_path).realpath
-                        else
-                          Pathname.new(temp_path)
-                        end
-
-        list += extract_parent_paths(temp_pathname.to_s, index).each do |parent_path|
-          next if excludes&.any? { |ignore| parent_path.to_s.include?(ignore) || temp_pathname.to_s.include?(ignore) }
-
-          yield parent_path, temp_pathname.to_s
-        end
-      end
-      temp_paths = list
-    end
-  end
-
-  private_class_method :parents_paths
-
-  def self.children_paths(target_pathname, analyze_level, index, excludes: nil)
-    temp_paths = [target_pathname.to_s]
-    analyze_level.times do
-      list = []
-      temp_paths.each do |temp_path|
-        temp_pathname = if Pathname.new(temp_path).relative? && Pathname.new(temp_path).exist?
-                          Pathname.new(temp_path).realpath
-                        else
-                          Pathname.new(temp_path)
-                        end
-
-        list += extract_children_paths(temp_pathname.to_s, index).each do |child_path|
-          next if excludes&.any? { |ignore| child_path.to_s.include?(ignore) || temp_pathname.to_s.include?(ignore) }
-
-          yield temp_pathname.to_s, child_path
-        end
-      end
-      temp_paths = list
-    end
-  end
-
-  private_class_method :children_paths
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: js_dependency
 version: !ruby/object:Gem::Version
-  version: 0.2.3.1
+  version: 0.3.0
 platform: ruby
 authors:
 - junara
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-21 00:00:00.000000000 Z
+date: 2022-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pathname
@@ -166,6 +166,7 @@ files:
 - lib/js_dependency/mermaid/root.rb
 - lib/js_dependency/pathname_utility.rb
 - lib/js_dependency/replace_path_alias.rb
+- lib/js_dependency/target_pathname.rb
 - lib/js_dependency/version.rb
 - sig/js_dependency.rbs
 homepage: https://github.com/junara/js_dependency