js_dependency 0.3.6 → 0.3.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 201aa2538971ea1e938c32236410e2b31ada21abbcd9f90141b84b08b132e7bb
-  data.tar.gz: fd6c9eb934ea1f884f885e0bce39c989ab2536a10faa33f900bcc95418f41fa6
+  metadata.gz: e6ac19bdd54aa746f7e5f40bb7cf8c92660eb8384c074347734f8e484d60d878
+  data.tar.gz: a5f4a090fec3d3a4af1c8a8b5747efc830f8f92c4f29dce852e91348c0d867c6
 SHA512:
-  metadata.gz: 0641c8506997b0bf21e4ec9cede06096fbc9b523e8e4e39954bb4a63eb73d551772945efa73c7e1098b0481cf70b0fc87eb291140f57db6b7599901b958a1b78
-  data.tar.gz: c0c38b6e23cb29d54a40009aba2290543d9706366eb45a092cbbd4e47817972e161e0830bbc51081e76bbd85899247d02bf851345030126c715e2e4e6e2d6e8e
+  metadata.gz: '0902a104039ef853937b3d1739ec0f1fe249d17f7428d23457124e66b16003a8f7a3136ceefb14a6f3122c99bfcbeeeec0f77d589066f6e0956d95e11b36b963'
+  data.tar.gz: 746f673194445bf43f180a2ec650bd2530795e9966e8cc6a35f5bb55d37ff8688187ceaff41475117bd166d6a788624a3bbb63555b52901231a5d46dace1f4dd

data/.rubocop_todo.yml

@@ -1,47 +1,42 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2022-08-11 04:37:50 UTC using RuboCop version 1.34.1.
+# on 2022-08-11 15:14:43 UTC using RuboCop version 1.34.1.
 # 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: 5
+# Offense count: 3
 # Configuration parameters: AllowedMethods, AllowedPatterns, IgnoredMethods, CountRepeatedAttributes.
 Metrics/AbcSize:
-  Max: 42
-
-# Offense count: 1
-# Configuration parameters: CountComments, CountAsOne.
-Metrics/ClassLength:
-  Max: 129
+  Max: 33
 
-# Offense count: 5
+# Offense count: 3
 # Configuration parameters: AllowedMethods, AllowedPatterns, IgnoredMethods.
 Metrics/CyclomaticComplexity:
-  Max: 18
+  Max: 19
 
-# Offense count: 9
+# Offense count: 8
 # Configuration parameters: CountComments, CountAsOne, ExcludedMethods, AllowedMethods, AllowedPatterns, IgnoredMethods.
 Metrics/MethodLength:
-  Max: 26
+  Max: 19
 
 # Offense count: 3
 # Configuration parameters: CountKeywordArgs, MaxOptionalParameters.
 Metrics/ParameterLists:
   Max: 9
 
-# Offense count: 5
+# Offense count: 3
 # Configuration parameters: AllowedMethods, AllowedPatterns, IgnoredMethods.
 Metrics/PerceivedComplexity:
-  Max: 19
+  Max: 20
 
 # Offense count: 1
 Style/MultilineBlockChain:
   Exclude:
     - 'lib/js_dependency/mermaid/root.rb'
 
-# Offense count: 4
+# Offense count: 8
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns, IgnoredPatterns.
 # URISchemes: http, https

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 ## [Unreleased]
 
+## [0.3.9] - 2022-08-12
+
+- Add alias_paths options of hash.
+
+## [0.3.8] - 2022-08-11
+
+- `.js_dependecy.yaml` is arrowed for configuration file name.
+- Refactor codes.
+- Add test codes.
+
+## [0.3.7] - 2022-08-11
+
+- If target is index.js, orphan include in analysis.
+
 ## [0.3.6] - 2022-08-11
 
 - Add src path in script tag for create index.

data/Gemfile.lock

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

data/README.md

@@ -56,6 +56,7 @@ parent_analyze_level -> -p
 name_level -> -n
 output_path -> -o
 exclude -> -e
+alias_paths -> -a
 ```
 
 #### Export Mermaid Format
@@ -63,31 +64,31 @@ exclude -> -e
 ##### Single target path
 
 ```shell
-js_dependency -s ./src -t ./src/App.vue -o ./mermaid.txt -c 2 -p 2 -n 1
+js_dependency -s ./src -t ./src/App.vue -o ./mermaid.txt -c 2 -p 2 -n 1 -a @:./pages
 ```
 
 ##### 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
+js_dependency -s ./src -t ./src/App.vue ./src/components/Sub.vue -o ./mermaid.txt -c 2 -p 2 -n 1 -a @:./pages
 ```
 
-##### Exclude path which iclude exclude words `-e` from output
+##### Exclude path which include exclude words `-e` from output
 
 ```shell
-js_dependency -s ./src -t ./src/App.vue -o ./mermaid.txt -c 2 -p 2 -n 1 -e excludeWord1 excludeWord2
+js_dependency -s ./src -t ./src/App.vue -o ./mermaid.txt -c 2 -p 2 -n 1 -e excludeWord1 excludeWord2 -a @:./pages
 ```
 
 #### Export parents components list
 
 ```shell
-js_dependency parents -s ./src -t ./src/App.vue -o ./parents.txt -p 2
+js_dependency parents -s ./src -t ./src/App.vue -o ./parents.txt -p 2 -a @:./pages
 ```
 
 #### Export children components list
 
 ```shell
-js_dependency childrent -s ./src -t ./src/App.vue -o ./children.txt -c 2
+js_dependency childrent -s ./src -t ./src/App.vue -o ./children.txt -c 2 -a @:./pages
 ```
 
 #### Export orphan components list
@@ -95,7 +96,7 @@ js_dependency childrent -s ./src -t ./src/App.vue -o ./children.txt -c 2
 Components that are not used in other components.
 
 ```shell
-js_dependency orphan -s ./src
+js_dependency orphan -s ./src -a @:./pages
 ```
 
 #### Export left components list
@@ -103,7 +104,7 @@ js_dependency orphan -s ./src
 Components that do not import other components.
 
 ```shell
-js_dependency leave -s ./src
+js_dependency leave -s ./src -a @:./pages
 ```
 
 ### By ruby code

data/lib/js_dependency/cli.rb

@@ -8,152 +8,96 @@ module JsDependency
     default_command :export_mermaid
 
     desc "export_mermaid", "Output mermaid flowchart string."
-    option :src_path, type: :string, aliases: "-s", desc: "Root folder."
-    option :target_paths, 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"
-    option :name_level, type: :numeric, aliases: "-n", desc: "Output name level"
-    option :excludes, type: :array, aliases: "-e", desc: "Exclude the word that is included in the path"
+    method_option :src_path, type: :string, aliases: "-s", desc: "Root folder."
+    method_option :target_paths, type: :array, aliases: "-t", desc: "Target file that you want to analyze."
+    method_option :output_path, type: :string, aliases: "-o", desc: "Output file path"
+    method_option :child_analyze_level, type: :numeric, aliases: "-c", desc: "Output level of child dependency"
+    method_option :parent_analyze_level, type: :numeric, aliases: "-p", desc: "Output level of parent dependency"
+    method_option :name_level, type: :numeric, aliases: "-n", desc: "Output name level"
+    method_option :excludes, type: :array, aliases: "-e", desc: "Exclude the word that is included in the path"
+    method_option :alias_paths, type: :hash, aliases: "-a", desc: "Alias paths by hash format."
 
     def export_mermaid
-      pathname = Pathname.new(".js_dependency.yml")
-      args = {}
-      args = YAML.safe_load(pathname.read) if pathname.exist?
-
-      src_path = options[:src_path] || args["src_path"]
-      target_paths = options[:target_paths] || (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
-      alias_paths = args["alias_paths"] || nil
-      name_level = options[:name_level] || args["name_level"] || 1
-      excludes = if options[:excludes]&.length&.positive?
-                   options[:excludes]
-                 elsif args["excludes"]
-                   args["excludes"]
-                 end
-
-      str = JsDependency.export_mermaid(
-        src_path,
-        target_paths,
-        child_analyze_level: child_analyze_level,
-        parent_analyze_level: parent_analyze_level,
-        output_path: output_path,
-        alias_paths: alias_paths,
-        name_level: name_level,
-        excludes: excludes
+      args = JsDependency::CliUtils::Yaml.new.args
+      config = JsDependency::CliUtils::Config.new(options, args)
+      puts JsDependency.export_mermaid(
+        config.src_path,
+        config.target_paths,
+        child_analyze_level: config.child_analyze_level,
+        parent_analyze_level: config.parent_analyze_level,
+        output_path: config.output_path,
+        alias_paths: config.alias_paths,
+        name_level: config.name_level,
+        excludes: config.excludes
       )
-
-      puts str
     end
 
     desc "parents", "export parents list"
-    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 :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 :excludes, type: :array, aliases: "-e", desc: "Exclude the word that is included in the path"
+    method_option :src_path, type: :string, aliases: "-s", desc: "Root folder."
+    method_option :target_path, type: :string, aliases: "-t", desc: "Target file that you want to analyze."
+    method_option :output_path, type: :string, aliases: "-o", desc: "Output file path"
+    method_option :parent_analyze_level, type: :numeric, aliases: "-p", desc: "Output level of parent dependency"
+    method_option :excludes, type: :array, aliases: "-e", desc: "Exclude the word that is included in the path"
+    method_option :alias_paths, type: :hash, aliases: "-a", desc: "Alias paths by hash format."
 
     def parents
-      pathname = Pathname.new(".js_dependency.yml")
-      args = {}
-      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"]
-      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[:excludes]&.length&.positive?
-                   options[:excludes]
-                 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,
-        excludes: excludes
+      args = JsDependency::CliUtils::Yaml.new.args
+      config = JsDependency::CliUtils::Config.new(options, args)
+      puts JsDependency.parents(
+        config.src_path,
+        config.target_path,
+        parent_analyze_level: config.parent_analyze_level,
+        output_path: config.output_path,
+        alias_paths: config.alias_paths,
+        excludes: config.excludes
       ).join("\n")
-
-      puts str
     end
 
     desc "children", "export children list"
-    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 :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 :excludes, type: :array, aliases: "-e", desc: "Exclude the word that is included in the path"
+    method_option :src_path, type: :string, aliases: "-s", desc: "Root folder."
+    method_option :target_path, type: :string, aliases: "-t", desc: "Target file that you want to analyze."
+    method_option :output_path, type: :string, aliases: "-o", desc: "Output file path"
+    method_option :child_analyze_level, type: :numeric, aliases: "-c", desc: "Output level of child dependency"
+    method_option :excludes, type: :array, aliases: "-e", desc: "Exclude the word that is included in the path"
+    method_option :alias_paths, type: :hash, aliases: "-a", desc: "Alias paths by hash format."
 
     def children
-      pathname = Pathname.new(".js_dependency.yml")
-      args = {}
-      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"]
-      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[:excludes]&.length&.positive?
-                   options[:excludes]
-                 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,
-        excludes: excludes
+      args = JsDependency::CliUtils::Yaml.new.args
+      config = JsDependency::CliUtils::Config.new(options, args)
+      puts JsDependency.children(
+        config.src_path,
+        config.target_path,
+        child_analyze_level: config.child_analyze_level,
+        output_path: config.output_path,
+        alias_paths: config.alias_paths,
+        excludes: config.excludes
       ).join("\n")
-
-      puts str
     end
 
     desc "orphan", "export components than is not depended by others"
-    option :src_path, type: :string, aliases: "-s", desc: "Root folder."
+    method_option :src_path, type: :string, aliases: "-s", desc: "Root folder."
+    method_option :alias_paths, type: :hash, aliases: "-a", desc: "Alias paths by hash format."
 
     def orphan
-      pathname = Pathname.new(".js_dependency.yml")
-      args = {}
-      args = YAML.safe_load(pathname.read) if pathname.exist?
-
-      src_path = options[:src_path] || args["src_path"]
-      alias_paths = args["alias_paths"] || nil
-
-      str = JsDependency.orphan(
-        src_path,
-        alias_paths: alias_paths
+      args = JsDependency::CliUtils::Yaml.new.args
+      config = JsDependency::CliUtils::Config.new(options, args)
+      puts JsDependency.orphan(
+        config.src_path,
+        alias_paths: config.alias_paths
       ).join("\n")
-
-      puts str
     end
 
     desc "leave", "export components than is not depended by others"
-    option :src_path, type: :string, aliases: "-s", desc: "Root folder."
+    method_option :src_path, type: :string, aliases: "-s", desc: "Root folder."
+    method_option :alias_paths, type: :hash, aliases: "-a", desc: "Alias paths by hash format."
 
     def leave
-      pathname = Pathname.new(".js_dependency.yml")
-      args = {}
-      args = YAML.safe_load(pathname.read) if pathname.exist?
-
-      src_path = options[:src_path] || args["src_path"]
-      alias_paths = args["alias_paths"] || nil
-
-      str = JsDependency.leave(
-        src_path,
-        alias_paths: alias_paths
+      args = JsDependency::CliUtils::Yaml.new.args
+      config = JsDependency::CliUtils::Config.new(options, args)
+      puts JsDependency.leave(
+        config.src_path,
+        alias_paths: config.alias_paths
       ).join("\n")
-
-      puts str
     end
 
     desc "version", "show version"

data/lib/js_dependency/cli_utils/config.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module JsDependency
+  module CliUtils
+    class Config
+      attr_reader :src_path, :target_paths, :target_path, :child_analyze_level, :parent_analyze_level, :output_path,
+                  :alias_paths, :name_level, :excludes
+
+      # @param [Hash] options
+      # @param [Hash] args
+      def initialize(options, args)
+        @src_path = options[:src_path] || args[:src_path]
+        @target_paths = options[:target_paths] || (args[:target_path].is_a?(String) ? [args[:target_path]] : args[:target_path])
+        @target_path = options[: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
+        @alias_paths = options[:alias_paths] || args[:alias_paths] || {}
+        @name_level = options[:name_level] || args[:name_level] || 1
+        @excludes = if options[:excludes]&.length&.positive?
+                      options[:excludes]
+                    elsif args[:excludes]
+                      args[:excludes]
+                    end
+      end
+    end
+  end
+end

data/lib/js_dependency/cli_utils/yaml.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module JsDependency
+  module CliUtils
+    class Yaml
+      attr_reader :args,
+                  :dir_path
+
+      # @param [String, nil] dir_path
+      def initialize(dir_path: nil)
+        @dir_path = dir_path || Dir.pwd
+        pathname = config_pathname
+        @args = if pathname.nil?
+                  {}
+                else
+                  symbolize_keys(YAML.safe_load(pathname.read))
+                end
+      end
+
+      private
+
+      # @return [Pathname, nil]
+      def config_pathname
+        dir_pathname = Pathname.new(@dir_path)
+        pathname = nil
+        %w[.js_dependency.yml .js_dependency.yaml].each do |path|
+          pathname = (dir_pathname + path) if (dir_pathname + path).exist?
+        end
+        pathname
+      end
+
+      # @param [Hash] hash
+      # @return [Hash]
+      def symbolize_keys(hash)
+        hash.transform_keys(&:to_sym)
+      end
+    end
+  end
+end

data/lib/js_dependency/source_analysis/orphan.rb

@@ -30,11 +30,9 @@ module JsDependency
       # @param [String] target_path
       # @return [TrueClass, FalseClass]
       def orphan?(target_path)
-        target_pathname = JsDependency::TargetPathname.new(target_path)
-        paths = []
-        target_pathname.each_parent_path(1, @index) do |parent_path, _child_path|
-          paths << parent_path
-        end
+        paths = parent_paths(target_path)
+        paths += dir_parent_paths(target_path) if target_path.include?("index.js")
+
         paths.size.zero?
       end
 
@@ -44,6 +42,30 @@ module JsDependency
       def relative_path_or_external_path(path, src_path)
         JsDependency::PathnameUtility.relative_path_or_external_path(path, src_path)
       end
+
+      # Parent paths.
+      # @param [String] target_path
+      # @return [Array<String>]
+      def parent_paths(target_path)
+        target_pathname = JsDependency::TargetPathname.new(target_path)
+        paths = []
+        target_pathname.each_parent_path(1, @index) do |parent_path, _child_path|
+          paths << parent_path
+        end
+        paths
+      end
+
+      # Directory parent paths.
+      # @param [String] target_path
+      # @return [Array<String>]
+      def dir_parent_paths(target_path)
+        paths = []
+        target_pathname_dir = JsDependency::TargetPathname.new(Pathname.new(target_path).dirname.to_s)
+        target_pathname_dir.each_parent_path(1, @index) do |parent_path, _child_path|
+          paths << parent_path
+        end
+        paths
+      end
     end
   end
 end

data/lib/js_dependency/version.rb

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

data/lib/js_dependency.rb

@@ -9,6 +9,8 @@ require_relative "js_dependency/mermaid/target_pathname"
 require_relative "js_dependency/source_analysis/leave"
 require_relative "js_dependency/source_analysis/orphan"
 require_relative "js_dependency/pathname_utility"
+require_relative "js_dependency/cli_utils/yaml"
+require_relative "js_dependency/cli_utils/config"
 require "pathname"
 
 module JsDependency

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: js_dependency
 version: !ruby/object:Gem::Version
-  version: 0.3.6
+  version: 0.3.9
 platform: ruby
 authors:
 - junara
@@ -159,6 +159,8 @@ files:
 - js_dependency.gemspec
 - lib/js_dependency.rb
 - lib/js_dependency/cli.rb
+- lib/js_dependency/cli_utils/config.rb
+- lib/js_dependency/cli_utils/yaml.rb
 - lib/js_dependency/extractor/extract_import_path.rb
 - lib/js_dependency/extractor/extract_script_tag.rb
 - lib/js_dependency/extractor/extract_src_path.rb