js_dependency 0.3.9 → 0.3.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e6ac19bdd54aa746f7e5f40bb7cf8c92660eb8384c074347734f8e484d60d878
-  data.tar.gz: a5f4a090fec3d3a4af1c8a8b5747efc830f8f92c4f29dce852e91348c0d867c6
+  metadata.gz: 8a4e8c31528eb944e9acf98aaf37710cffb27728f6e5c9b7337f85dcf5a3ca13
+  data.tar.gz: fb428fe8a8eca603ebef72f19771d8b8d94235d782ccb301e2de7bb11da0a004
 SHA512:
-  metadata.gz: '0902a104039ef853937b3d1739ec0f1fe249d17f7428d23457124e66b16003a8f7a3136ceefb14a6f3122c99bfcbeeeec0f77d589066f6e0956d95e11b36b963'
-  data.tar.gz: 746f673194445bf43f180a2ec650bd2530795e9966e8cc6a35f5bb55d37ff8688187ceaff41475117bd166d6a788624a3bbb63555b52901231a5d46dace1f4dd
+  metadata.gz: 7531ac4e27d5ec92a7efeea5e13051baed6471d7b059c622bd2aa21885a9d09bfcf9767c99bc59812adf1de6b333e60374518a888a7f3ef704d64a0d827ac812
+  data.tar.gz: 818a5e4210088a3f3d240a18d437909842c46619636e0c38cac1ffd3444659812e2b3a13dfe10b98f39bc4561fb8f52594696374159215f8d4bd29214f436cd1

data/.js_dependency.yml.sample

@@ -1,5 +1,8 @@
 src_path: ./src
 target_path: ./src/App.vue
+target_paths:
+  - ./src/App1.vue
+  - ./src/App2.vue
 child_analyze_level: 2
 parent_analyze_level: 2
 name_level: 1

data/.rubocop_todo.yml

@@ -1,22 +1,27 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2022-08-11 15:14:43 UTC using RuboCop version 1.34.1.
+# on 2022-08-13 15:05:03 UTC using RuboCop version 1.35.0.
 # 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: 3
+# Offense count: 2
+Lint/UselessAssignment:
+  Exclude:
+    - 'spec/js_dependency_spec.rb'
+
+# Offense count: 2
 # Configuration parameters: AllowedMethods, AllowedPatterns, IgnoredMethods, CountRepeatedAttributes.
 Metrics/AbcSize:
-  Max: 33
+  Max: 29
 
-# Offense count: 3
+# Offense count: 2
 # Configuration parameters: AllowedMethods, AllowedPatterns, IgnoredMethods.
 Metrics/CyclomaticComplexity:
-  Max: 19
+  Max: 15
 
-# Offense count: 8
+# Offense count: 7
 # Configuration parameters: CountComments, CountAsOne, ExcludedMethods, AllowedMethods, AllowedPatterns, IgnoredMethods.
 Metrics/MethodLength:
   Max: 19
@@ -26,19 +31,14 @@ Metrics/MethodLength:
 Metrics/ParameterLists:
   Max: 9
 
-# Offense count: 3
+# Offense count: 2
 # Configuration parameters: AllowedMethods, AllowedPatterns, IgnoredMethods.
 Metrics/PerceivedComplexity:
-  Max: 20
-
-# Offense count: 1
-Style/MultilineBlockChain:
-  Exclude:
-    - 'lib/js_dependency/mermaid/root.rb'
+  Max: 15
 
-# Offense count: 8
+# Offense count: 18
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns, IgnoredPatterns.
 # URISchemes: http, https
 Layout/LineLength:
-  Max: 183
+  Max: 187

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 ## [Unreleased]
 
+## [0.3.12] - 2022-08-14
+
+- Add rspec test.
+- Fix script tag contents extraction if script tag has `src` like `<script src="">` .
+
+## [0.3.11] - 2022-08-13
+
+- Add target_paths options in configuration file to use array.
+
+## [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.

data/Gemfile

@@ -10,6 +10,7 @@ gem "rake", "~> 13.0"
 gem "rspec", "~> 3.0"
 
 gem "codecov", require: false, group: "test"
+gem "debug", ">= 1.0.0"
 gem "rubocop", "~> 1.21"
 gem "simplecov", require: false, group: :test
 gem "yarn"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    js_dependency (0.3.9)
+    js_dependency (0.3.12)
       pathname
       thor
       yaml
@@ -14,8 +14,14 @@ GEM
     codecov (0.6.0)
       simplecov (>= 0.15, < 0.22)
     coderay (1.1.3)
+    debug (1.5.0)
+      irb (>= 1.3.6)
+      reline (>= 0.2.7)
     diff-lcs (1.5.0)
     docile (1.4.0)
+    io-console (0.5.11)
+    irb (1.4.1)
+      reline (>= 0.3.0)
     json (2.6.2)
     parallel (1.22.1)
     parser (3.1.2.1)
@@ -30,6 +36,8 @@ GEM
     rainbow (3.1.1)
     rake (13.0.6)
     regexp_parser (2.5.0)
+    reline (0.3.1)
+      io-console (~> 0.5)
     rexml (3.2.5)
     rspec (3.11.0)
       rspec-core (~> 3.11.0)
@@ -94,6 +102,7 @@ PLATFORMS
 
 DEPENDENCIES
   codecov
+  debug (>= 1.0.0)
   js_dependency!
   rake (~> 13.0)
   rspec (~> 3.0)

data/README.md

@@ -35,6 +35,9 @@ Configuration file is `./.js_dependency.yml`. This file includes parameters for
 ```yaml
 src_path: ./src # Root folder
 target_path: ./src/App.vue # Target file tha you want to analyze
+target_paths: # Target files tha you want to analyze
+  - ./src/App1.vue
+  - ./src/App2.vue
 child_analyze_level: 2 # Output level of child analyze
 parent_analyze_level: 2 # Output level of parent analyze
 name_level: 1 # Output name level
@@ -46,6 +49,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.
 
 ```

data/lib/js_dependency/cli.rb

@@ -16,9 +16,10 @@ module JsDependency
     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
-      args = JsDependency::CliUtils::Yaml.new.args
+      args = JsDependency::CliUtils::Yaml.new(path: options[:file_config]).args
       config = JsDependency::CliUtils::Config.new(options, args)
       puts JsDependency.export_mermaid(
         config.src_path,
@@ -39,9 +40,10 @@ module JsDependency
     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
-      args = JsDependency::CliUtils::Yaml.new.args
+      args = JsDependency::CliUtils::Yaml.new(path: options[:file_config]).args
       config = JsDependency::CliUtils::Config.new(options, args)
       puts JsDependency.parents(
         config.src_path,
@@ -60,9 +62,10 @@ module JsDependency
     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
-      args = JsDependency::CliUtils::Yaml.new.args
+      args = JsDependency::CliUtils::Yaml.new(path: options[:file_config]).args
       config = JsDependency::CliUtils::Config.new(options, args)
       puts JsDependency.children(
         config.src_path,
@@ -77,9 +80,10 @@ module JsDependency
     desc "orphan", "export components than is not depended by others"
     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
-      args = JsDependency::CliUtils::Yaml.new.args
+      args = JsDependency::CliUtils::Yaml.new(path: options[:file_config]).args
       config = JsDependency::CliUtils::Config.new(options, args)
       puts JsDependency.orphan(
         config.src_path,
@@ -90,9 +94,10 @@ module JsDependency
     desc "leave", "export components than is not depended by others"
     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
-      args = JsDependency::CliUtils::Yaml.new.args
+      args = JsDependency::CliUtils::Yaml.new(path: options[:file_config]).args
       config = JsDependency::CliUtils::Config.new(options, args)
       puts JsDependency.leave(
         config.src_path,

data/lib/js_dependency/cli_utils/config.rb

@@ -10,18 +10,82 @@ module JsDependency
       # @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]
+        @target_paths = calc_target_paths(options[:target_path], options[:target_paths], args[:target_path],
+                                          args[:target_paths])
+        @target_path = calc_target_path(options[:target_path], options[:target_paths], args[:target_path],
+                                        args[:target_paths])
         @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
+        @excludes = calc_excludes(options[:excludes], args[:excludes])
+      end
+
+      private
+
+      # @param [String, Array, nil] option_target_path
+      # @param [String, Array, nil] option_target_paths
+      # @param [String, Array, nil] args_target_path
+      # @param [String, Array, nil] args_target_paths
+      # @return [nil, Array]
+      def calc_target_paths(option_target_path, option_target_paths, args_target_path, args_target_paths)
+        [option_target_paths, option_target_path, args_target_paths, args_target_path].each do |obj|
+          return as_array(obj) if present?(obj)
+        end
+
+        nil
+      end
+
+      # @param [String, Array, nil] option_target_path
+      # @param [String, Array, nil] option_target_paths
+      # @param [String, Array, nil] args_target_path
+      # @param [String, Array, nil] args_target_paths
+      # @return [nil, String]
+      def calc_target_path(option_target_path, option_target_paths, args_target_path, args_target_paths)
+        [option_target_path, option_target_paths, args_target_path, args_target_paths].each do |obj|
+          return as_string_or_first(obj) if present?(obj)
+        end
+
+        nil
+      end
+
+      # @param [Object] option_excludes
+      # @param [Object] args_excludes
+      # @return [nil, Array]
+      def calc_excludes(option_excludes, args_excludes)
+        [option_excludes, args_excludes].each do |obj|
+          return as_array(obj) if present?(obj)
+        end
+
+        nil
+      end
+
+      # @param [Array, String, nil] obj
+      # @return [TrueClass, FalseClass]
+      def present?(obj)
+        return false if obj.nil?
+        return false if obj.empty?
+
+        true
+      end
+
+      # @param [Array, String, nil] obj
+      # @return [Array, nil]
+      def as_array(obj)
+        return nil if obj.nil?
+        return obj if obj.is_a?(Array)
+
+        [obj]
+      end
+
+      # @param [Array, String, nil] obj
+      # @return [String, nil]
+      def as_string_or_first(obj)
+        return nil if obj.nil?
+        return obj if obj.is_a?(String)
+
+        return obj.first if obj.is_a?(Array)
       end
     end
   end

data/lib/js_dependency/cli_utils/yaml.rb

@@ -3,22 +3,42 @@
 module JsDependency
   module CliUtils
     class Yaml
-      attr_reader :args,
-                  :dir_path
+      attr_reader :dir_path,
+                  :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
+      # @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)

data/lib/js_dependency/extractor/extract_script_tag.rb

@@ -15,6 +15,10 @@ module JsDependency
           list << Regexp.last_match(1)
         end
 
+        scripts += str.gsub(%r{<script.+src=".+">(.+)</script>}m).with_object([]) do |_, list|
+          list << Regexp.last_match(1)
+        end
+
         scripts.uniq.sort.join("\n")
       end
 

data/lib/js_dependency/mermaid/nodes_link.rb

@@ -26,10 +26,32 @@ module JsDependency
         mermaid_str(@child, level)
       end
 
+      # @param [String] src_path
+      # @return [JsDependency::Mermaid::NodesLink]
+      def relative_path_from(src_path)
+        NodesLink.new(
+          relative_parent_path(src_path),
+          relative_child_path(src_path)
+        )
+      end
+
       private
 
+      # @param [String] src_path
+      # @return [String]
+      def relative_parent_path(src_path)
+        parent.exist? ? parent.realpath.relative_path_from(Pathname.new(src_path).realpath.to_s).to_s : parent.to_s
+      end
+
+      # @param [String] src_path
+      # @return [String]
+      def relative_child_path(src_path)
+        child.exist? ? child.realpath.relative_path_from(Pathname.new(src_path).realpath.to_s).to_s : child.to_s
+      end
+
       # @param [Pathname] pathname
       # @param [Integer] level
+      # @return [String]
       def mermaid_str(pathname, level = 0)
         "#{parse(pathname).join("_")}[\"#{parse(pathname, level).join("/")}\"]"
       end

data/lib/js_dependency/mermaid/root.rb

@@ -5,6 +5,7 @@ module JsDependency
   module Mermaid
     class Root
       attr_accessor :orientation
+      attr_reader :list
 
       # @param [String] orientation
       def initialize(orientation = "LR")
@@ -35,18 +36,14 @@ module JsDependency
       # @return [Array<String>]
       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|
-                          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
+                        @list.map { |nodes_link| nodes_link.relative_path_from(src_path) }
                       else
                         @list
                       end
-        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)}"
+        nodes_links = nodes_links.uniq { |nodes_link| "#{nodes_link.parent}__#{nodes_link.child}" }
+        nodes_links = nodes_links.sort_by { |nodes_link| "#{nodes_link.parent}__#{nodes_link.child}" }
+        nodes_links.map do |nodes_link|
+          "#{nodes_link.parent_module_name(name_level)} --> #{nodes_link.child_module_name(name_level)}"
         end
       end
     end

data/lib/js_dependency/version.rb

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

data/lib/js_dependency.rb

@@ -71,7 +71,7 @@ module JsDependency
       nodes += mermaid_root.export_nodes(name_level: name_level, src_path: src_path)
     end
 
-    output = (["flowchart LR"] + nodes.uniq + styles.uniq).join("\n")
+    output = "#{(["flowchart LR"] + nodes.uniq + styles.uniq).join("\n")}\n"
     output_pathname&.write(output)
     output
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: js_dependency
 version: !ruby/object:Gem::Version
-  version: 0.3.9
+  version: 0.3.12
 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