js_dependency 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5bf7cfb1d29636defe8ab5e05990af5d95e80f5dc383ff1e3bb56233f6458cd6
-  data.tar.gz: 426a15952e30fe085bfa93c3ab5fbdb1a1f8e19323c01cddc83d3744a41a9269
+  metadata.gz: d88ba49b09bf39f743538394281ad7d7956abfd3a3a86e7b34fb88c1ad995f98
+  data.tar.gz: 75928de5c657b2af3599606343798f17bfc2839e4967b46a9c9274eef0819218
 SHA512:
-  metadata.gz: ea9dd1783d4c7d6ea1c7a205c49fbb55fd73ba947d474c87e700b4e8ad52e93a2ce0816ddfc0f3df78c9bc689c7b7f3037196e7ddd1d73d701616ff5f4234364
-  data.tar.gz: c2020ea6afcef60232a53b2846f7ba972b15c6600659bc18197f68708187f2d75bd0349011297b3e98201428cbc31f8d617f5999d29010d0293a433fc96a2b47
+  metadata.gz: 27bbd73e5ecd0f49ff5c82608abf7f553802fdce21878dd18036e1d675c09f526a92e152c08aab3ec9b9293c4a446d51b27fa8ceb75bd19a074ab097d9e5248d
+  data.tar.gz: 5f328e13c00a1a50352c910902a42323caf558cdd22441218cc03048bebc41da85aea3b767948ce951b373037d7404e57ae293d4e85e12d1f930baef21a2d312

data/.js_dependency.yml.sample

@@ -6,3 +6,6 @@ name_level: 1
 output_path: ./mermaid.txt
 alias_paths:
   "@": ./pages
+excludes:
+  - excludedWord1
+  - excludedWord2

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2022-07-19 16:03:39 UTC using RuboCop version 1.31.2.
+# on 2022-07-20 14:57: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
@@ -9,32 +9,32 @@
 # Offense count: 6
 # Configuration parameters: IgnoredMethods, CountRepeatedAttributes.
 Metrics/AbcSize:
-  Max: 30
+  Max: 37
 
-# Offense count: 3
+# Offense count: 5
 # Configuration parameters: IgnoredMethods.
 Metrics/CyclomaticComplexity:
-  Max: 13
+  Max: 15
 
 # Offense count: 8
 # Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
 Metrics/MethodLength:
-  Max: 20
+  Max: 26
 
 # Offense count: 1
 # Configuration parameters: CountComments, CountAsOne.
 Metrics/ModuleLength:
-  Max: 112
+  Max: 114
 
-# Offense count: 1
+# Offense count: 3
 # Configuration parameters: CountKeywordArgs, MaxOptionalParameters.
 Metrics/ParameterLists:
-  Max: 8
+  Max: 9
 
-# Offense count: 3
+# Offense count: 5
 # Configuration parameters: IgnoredMethods.
 Metrics/PerceivedComplexity:
-  Max: 13
+  Max: 16
 
 # Offense count: 1
 # This cop supports safe autocorrection (--autocorrect).
@@ -42,9 +42,9 @@ Style/IfUnlessModifier:
   Exclude:
     - 'lib/js_dependency/index_creator.rb'
 
-# Offense count: 1
+# Offense count: 2
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns, IgnoredPatterns.
 # URISchemes: http, https
 Layout/LineLength:
-  Max: 167
+  Max: 182

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## [Unreleased]
 
+## [0.2.2] - 2022-07-21
+
+- Add CLI option parameter "exclude".
+- Add yaml configuration option parameter "excludes" that is array of "exclude".
+
 ## [0.2.1] - 2022-07-20
 
 - Output parents and children cli with line brake and sort.

data/Gemfile.lock

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

data/README.md

@@ -30,6 +30,9 @@ name_level: 1 # Output name level
 output_path: ./mermaid.txt # Output file path
 alias_paths: # Alias path
   "@": ./pages # absolute path or relative path of src_path
+excludes: # Exclude words that you want to skip from export.
+  - excludeWord1
+  - excludeWord2
 ```
 
 Each parameter is overridden by the command line.
@@ -41,6 +44,7 @@ child_analyze_level -> -c
 parent_analyze_level -> -p
 name_level -> -n
 output_path -> -o
+exclude -> -e
 ```
 
 #### Export Mermaid Format

data/lib/js_dependency/cli.rb

@@ -14,6 +14,8 @@ module JsDependency
     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"
     option :name_level, type: :numeric, aliases: "-n", desc: "Output name level"
+    option :exclude, type: :string, aliases: "-e", desc: "Exclude the word that is included in the path"
+
     def export_mermaid
       pathname = Pathname.new(".js_dependency.yml")
       args = {}
@@ -26,6 +28,11 @@ module JsDependency
       output_path = options[:output_path] || args["output_path"] || nil
       alias_paths = args["alias_paths"] || nil
       name_level = options[:name_level] || args["name_level"] || 1
+      excludes = if options[:exclude]
+                   [options[:exclude]]
+                 elsif args["excludes"]
+                   args["excludes"]
+                 end
 
       str = JsDependency.export_mermaid(
         src_path,
@@ -34,7 +41,8 @@ module JsDependency
         parent_analyze_level: parent_analyze_level,
         output_path: output_path,
         alias_paths: alias_paths,
-        name_level: name_level
+        name_level: name_level,
+        excludes: excludes
       )
 
       puts str
@@ -45,6 +53,8 @@ module JsDependency
     option :target_path, type: :string, aliases: "-t", desc: "Target file that you want to analyze."
     option :output_path, type: :string, aliases: "-o", desc: "Output file path"
     option :parent_analyze_level, type: :numeric, aliases: "-p", desc: "Output level of parent dependency"
+    option :exclude, type: :string, aliases: "-e", desc: "Exclude the word that is included in the path"
+
     def parents
       pathname = Pathname.new(".js_dependency.yml")
       args = {}
@@ -55,13 +65,19 @@ module JsDependency
       parent_analyze_level = options[:parent_analyze_level] || args["parent_analyze_level"] || 1
       output_path = options[:output_path] || args["output_path"] || nil
       alias_paths = args["alias_paths"] || nil
+      excludes = if options[:exclude]
+                   [options[:exclude]]
+                 elsif args["excludes"]
+                   args["excludes"]
+                 end
 
       str = JsDependency.parents(
         src_path,
         target_path,
         parent_analyze_level: parent_analyze_level,
         output_path: output_path,
-        alias_paths: alias_paths
+        alias_paths: alias_paths,
+        excludes: excludes
       ).sort.uniq.join("\n")
 
       puts str
@@ -72,6 +88,8 @@ module JsDependency
     option :target_path, type: :string, 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 :exclude, type: :string, aliases: "-e", desc: "Exclude the word that is included in the path"
+
     def children
       pathname = Pathname.new(".js_dependency.yml")
       args = {}
@@ -82,13 +100,19 @@ module JsDependency
       child_analyze_level = options[:child_analyze_level] || args["child_analyze_level"] || 1
       output_path = options[:output_path] || args["output_path"] || nil
       alias_paths = args["alias_paths"] || nil
+      excludes = if options[:exclude]
+                   [options[:exclude]]
+                 elsif args["excludes"]
+                   args["excludes"]
+                 end
 
       str = JsDependency.children(
         src_path,
         target_path,
         child_analyze_level: child_analyze_level,
         output_path: output_path,
-        alias_paths: alias_paths
+        alias_paths: alias_paths,
+        excludes: excludes
       ).sort.uniq.join("\n")
 
       puts str

data/lib/js_dependency/version.rb

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

data/lib/js_dependency.rb

@@ -17,8 +17,9 @@ module JsDependency
   # @param [Integer] parent_analyze_level
   # @param [Integer] name_level
   # @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)
+  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)
 
@@ -30,11 +31,11 @@ module JsDependency
 
     root = JsDependency::Mermaid::Root.new(orientation)
 
-    parents_paths(target_pathname, parent_analyze_level, index) do |parent_path, child_path|
+    parents_paths(target_pathname, parent_analyze_level, index, excludes: excludes) do |parent_path, child_path|
       root.add(parent_path, child_path)
     end
 
-    children_paths(target_pathname, child_analyze_level, index) do |parent_path, child_path|
+    children_paths(target_pathname, child_analyze_level, index, excludes: excludes) do |parent_path, child_path|
       root.add(parent_path, child_path)
     end
 
@@ -43,7 +44,7 @@ module JsDependency
     output
   end
 
-  def self.parents(src_path, target_path, alias_paths: nil, parent_analyze_level: 1, output_path: nil)
+  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)
 
@@ -53,7 +54,7 @@ module JsDependency
                         Pathname.new(target_path)
                       end
     list = []
-    parents_paths(target_pathname, parent_analyze_level, index) do |parent_path, _child_path|
+    parents_paths(target_pathname, parent_analyze_level, index, excludes: excludes) do |parent_path, _child_path|
       list << parent_path
     end
     output = list.uniq
@@ -61,7 +62,7 @@ module JsDependency
     output
   end
 
-  def self.children(src_path, target_path, alias_paths: nil, child_analyze_level: 1, output_path: nil)
+  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)
 
@@ -71,7 +72,7 @@ module JsDependency
                         Pathname.new(target_path)
                       end
     list = []
-    children_paths(target_pathname, child_analyze_level, index) do |_parent_path, child_path|
+    children_paths(target_pathname, child_analyze_level, index, excludes: excludes) do |_parent_path, child_path|
       list << child_path
     end
     output = list.uniq
@@ -92,6 +93,7 @@ module JsDependency
       list << parent if children.any?(target_pathname.to_s)
     end
   end
+
   private_class_method :extract_parent_paths
 
   # @param [String] target_path
@@ -105,6 +107,7 @@ module JsDependency
                       end
     index[target_pathname.to_s] || []
   end
+
   private_class_method :extract_children_paths
 
   # @param [String] src
@@ -112,9 +115,10 @@ module JsDependency
   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)
+  def self.parents_paths(target_pathname, analyze_level, index, excludes: nil)
     temp_paths = [target_pathname.to_s]
     analyze_level.times do
       list = []
@@ -126,15 +130,18 @@ module JsDependency
                         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) }
+
           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)
+  def self.children_paths(target_pathname, analyze_level, index, excludes: nil)
     temp_paths = [target_pathname.to_s]
     analyze_level.times do
       list = []
@@ -146,11 +153,14 @@ module JsDependency
                         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) }
+
           yield temp_pathname.to_s, child_path
         end
       end
       temp_paths = list
     end
   end
+
   private_class_method :children_paths
 end

metadata

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