js_dependency 0.3.7 → 0.3.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eed9f17f75fff9405d112f14ac2cccffffa9ecce728c718ff9a14eda3396c5ba
-  data.tar.gz: 645a8b5ab4363e2d1c4d7f6b25c79c0908d3f4a8ed78a928590c8d25e841c0e4
+  metadata.gz: 153a609f4227a43182ed6e6a469bcfe466ffe130c5f6d8033771545ca13b4198
+  data.tar.gz: 32cd8dd2ec33e8906b0bad39c8a4a6378e4909285486f52b6c93915891bed8bb
 SHA512:
-  metadata.gz: 2b1160dfd6319369750cf8d10feffd4b703aa72ba1d0199e5e1e9bb341316beda0a07e7982f83675435e9642edd29fd999d5953c32c5f90aa95b2b81322f8ed8
-  data.tar.gz: ff0eb122ee309e0ba743c5c422e6ff21641e04131d5ec3da650781ec2e22f6878cbeaf2e006e03fc68dd170d64b80ca5d91471fa3259d4b4384bb67d9853782a
+  metadata.gz: 63e3437906da40a60ed9e129dc8b2a3157221a61d34982bce433dfb8f8b3c7ee198cba9c85b6f230079db5a3a08fe9bb1c103d38763ce139a5aed81ecf5c9e10
+  data.tar.gz: cf47aa344e700868b2dd76c67ad4323acc2a47e9f0e4d9736d0ae30a981715bb639c52b4d9322b243122879abaf892b314479d39a3c29e4dba56df848cfbe0a0

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-13 03:35:35 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: 9
 # 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.10] - 2022-08-13
+
+- Add file_config options to specify configuration yaml which user like.
+
+## [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.

data/Gemfile.lock

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

data/README.md

@@ -46,6 +46,12 @@ excludes: # Exclude words that you want to skip from export.
   - excludeWord2
 ```
 
+If you want to specify .js_dependency.yml as another path, you can add option path by `-f` option.
+
+```shell
+js_dependency -f path/to/yourfilename.yml
+```
+
 Each parameter is overridden by the command line.
 
 ```
@@ -56,6 +62,7 @@ parent_analyze_level -> -p
 name_level -> -n
 output_path -> -o
 exclude -> -e
+alias_paths -> -a
 ```
 
 #### Export Mermaid Format
@@ -63,31 +70,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 +102,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 +110,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,101 @@ 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."
+    method_option :file_config, type: :string, aliases: "-f", desc: "Configuration file path."
 
     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(path: options[:file_config]).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."
+    method_option :file_config, type: :string, aliases: "-f", desc: "Configuration file path."
 
     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(path: options[:file_config]).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."
+    method_option :file_config, type: :string, aliases: "-f", desc: "Configuration file path."
 
     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(path: options[:file_config]).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."
+    method_option :file_config, type: :string, aliases: "-f", desc: "Configuration file path."
 
     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(path: options[:file_config]).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."
+    method_option :file_config, type: :string, aliases: "-f", desc: "Configuration file path."
 
     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(path: options[:file_config]).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,59 @@
+# frozen_string_literal: true
+
+module JsDependency
+  module CliUtils
+    class Yaml
+      attr_reader :dir_path,
+                  :path
+
+      # @param [String, nil] dir_path
+      # @param [String, nil] path
+      def initialize(dir_path: nil, path: nil)
+        @dir_path = present?(dir_path) ? dir_path : Dir.pwd
+        @path = path
+      end
+
+      # @return [Hash]
+      def args
+        pathname = if present?(@path)
+                     Pathname.new(@path)
+                   else
+                     config_pathname
+                   end
+
+        if pathname.nil?
+          {}
+        else
+          symbolize_keys(YAML.safe_load(pathname.read))
+        end
+      end
+
+      private
+
+      # @param [String] str
+      # @return [TrueClass, FalseClass]
+      def present?(str)
+        return false if str.nil?
+        return false if str.empty?
+
+        true
+      end
+
+      # @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/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JsDependency
-  VERSION = "0.3.7"
+  VERSION = "0.3.10"
 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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: js_dependency
 version: !ruby/object:Gem::Version
-  version: 0.3.7
+  version: 0.3.10
 platform: ruby
 authors:
 - junara
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-11 00:00:00.000000000 Z
+date: 2022-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pathname
@@ -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