js_dependency 0.3.3 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d117ec8b831e67223b243ed652261885f1bbffc4734f93ed2d386166d16d31e2
-  data.tar.gz: '008fe6a337a677fa62348ca4d76766f02d72affc2b851126f7f22cba45c32c4f'
+  metadata.gz: aad89bc5047522fc38815da19020c395e7cd92ec262da2dce9dad5f7ddf40526
+  data.tar.gz: dde5992cb4ecf9c27a2e645b064584296809c5dcd26d8d46625d88dbb393b9cb
 SHA512:
-  metadata.gz: 891fdc5a595134a7724a4f9bdf061ac6290025e3e624d1f33d362ba74ef22d696a1dd3355f6befdd8a11661a07b531eef7877ff9271b4f4bb1ca01dd83f3c31e
-  data.tar.gz: 574b0b04401c6b3d4b7a510cb0dbbe972a0539d8e052bed48395cc4c7c1f3ec656bf314f57229e6ac79a2524fbacadf89825d8b30fc410e8e6acb3efd50b438e
+  metadata.gz: 6fc657950c57fe7e6960fae9f4c1f1754ca42f223c2989e664ab686212978dd5cd8eb2ca19f610dc73c3492b6a2a17d5eabf6cca6a47bd7dc4c2e81850e04cb9
+  data.tar.gz: 51f72bb8a23cd36ed25bc3aa9640d244b1c1534347d94d36cda812a7167046aba9c6d68bef5fbe544e9b2f2810fdd21af74ea0c8be0abf79272142b4b458a635

data/.rubocop_todo.yml

@@ -1,20 +1,25 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2022-07-26 00:36:01 UTC using RuboCop version 1.31.2.
+# on 2022-07-26 23:22:56 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: 7
+# Offense count: 5
 # Configuration parameters: IgnoredMethods, CountRepeatedAttributes.
 Metrics/AbcSize:
-  Max: 41
+  Max: 42
+
+# Offense count: 1
+# Configuration parameters: CountComments, CountAsOne.
+Metrics/ClassLength:
+  Max: 129
 
 # Offense count: 5
 # Configuration parameters: IgnoredMethods.
 Metrics/CyclomaticComplexity:
-  Max: 16
+  Max: 18
 
 # Offense count: 9
 # Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
@@ -29,14 +34,14 @@ Metrics/ParameterLists:
 # Offense count: 5
 # Configuration parameters: IgnoredMethods.
 Metrics/PerceivedComplexity:
-  Max: 17
+  Max: 19
 
 # Offense count: 1
 Style/MultilineBlockChain:
   Exclude:
     - 'lib/js_dependency/mermaid/root.rb'
 
-# Offense count: 6
+# Offense count: 4
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns, IgnoredPatterns.
 # URISchemes: http, https

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 ## [Unreleased]
 
+## [0.3.5] - 2022-07-27
+
+- Export orphan components list.
+- Export left components list.
+
+## [0.3.4] - 2022-07-26
+
+- Add version CLI command
+- Bug fix excludes option in parents and children commands.
+
 ## [0.3.3] - 2022-07-26
 
 - Add special style to target_paths in mermaid output CLI.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    js_dependency (0.3.3)
+    js_dependency (0.3.5)
       pathname
       thor
       yaml
@@ -50,14 +50,14 @@ GEM
       rspec (>= 2.13, < 4)
       unparser
     rspec-support (3.11.0)
-    rubocop (1.31.2)
+    rubocop (1.32.0)
       json (~> 2.3)
       parallel (~> 1.10)
       parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.18.0, < 2.0)
+      rubocop-ast (>= 1.19.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
     rubocop-ast (1.19.1)

data/README.md

@@ -19,6 +19,15 @@ If bundler is not being used to manage dependencies, install the gem by executin
 ## Usage
 ### By Command Line
 
+#### Show version
+
+```shell
+js_dependency version
+# => "X.X.X"
+```
+
+#### yaml configuration file
+
 Configuration file is `./.js_dependency.yml`. This file includes parameters for the analysis.
 
 ```yaml
@@ -79,6 +88,21 @@ js_dependency parents -s ./src -t ./src/App.vue -o ./parents.txt -p 2
 js_dependency childrent -s ./src -t ./src/App.vue -o ./children.txt -c 2
 ```
 
+#### Export orphan components list
+
+Components that are not used in other components.
+
+```shell
+js_dependency orphan -s ./src
+```
+
+#### Export left components list
+
+Components that do not import other components.
+
+```shell
+js_dependency leave -s ./src
+```
 
 ### By ruby code
 If your javascript code is in `./src` and `./src/App.vue` is in the directory, you can analyze `./src/App.vue` dependency like this:

data/lib/js_dependency/cli.rb

@@ -28,7 +28,7 @@ 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[:excludes].length.positive?
+      excludes = if options[:excludes]&.length&.positive?
                    options[:excludes]
                  elsif args["excludes"]
                    args["excludes"]
@@ -65,7 +65,7 @@ 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[:excludes].length.positive?
+      excludes = if options[:excludes]&.length&.positive?
                    options[:excludes]
                  elsif args["excludes"]
                    args["excludes"]
@@ -100,7 +100,7 @@ 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[:excludes].length.positive?
+      excludes = if options[:excludes]&.length&.positive?
                    options[:excludes]
                  elsif args["excludes"]
                    args["excludes"]
@@ -117,5 +117,48 @@ module JsDependency
 
       puts str
     end
+
+    desc "orphan", "export components than is not depended by others"
+    option :src_path, type: :string, aliases: "-s", desc: "Root folder."
+
+    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
+      ).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."
+
+    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
+      ).join("\n")
+
+      puts str
+    end
+
+    desc "version", "show version"
+    def version
+      puts JsDependency::VERSION
+    end
   end
 end

data/lib/js_dependency/mermaid/target_pathname.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require_relative "../pathname_utility"
+module JsDependency
+  module Mermaid
+    class TargetPathname
+      attr_accessor :color_css, :font_size_css
+
+      # @param [String] target_path
+      def initialize(target_path)
+        @pathname = to_target_pathname(target_path)
+        @color_css = "#f9f"
+        @font_size_css = "4px"
+      end
+
+      # @param [String] src_path
+      # @return [String]
+      def mermaid_style(src_path)
+        src_pathname = Pathname.new(src_path).realpath
+        export_style(parse(@pathname.exist? ? @pathname.relative_path_from(src_pathname) : @pathname).join("_"))
+      end
+
+      private
+
+      # @param [String] path
+      # @return [String]
+      def export_style(path)
+        "style #{path} stroke:#{@color_css},stroke-width:#{@font_size_css}"
+      end
+
+      # @param [Pathname] pathname
+      # @param [Integer] level
+      def parse(pathname, level = -1)
+        JsDependency::PathnameUtility.parse(pathname, level)
+      end
+
+      # @param [String] target_path
+      # @return [Pathname]
+      def to_target_pathname(target_path)
+        JsDependency::PathnameUtility.to_target_pathname(target_path)
+      end
+    end
+  end
+end

data/lib/js_dependency/pathname_utility.rb

@@ -28,8 +28,23 @@ module JsDependency
 
     # @param [Pathname] pathname
     # @param [Integer] level
+    # @return [Array]
     def self.parse(pathname, level = -1)
       pathname.each_filename.with_object([]) { |filename, array| array << filename }.reverse[0..level].reverse
     end
+
+    # @param [String] path
+    # @param [String] src_path
+    # @return [String]
+    def self.relative_path_or_external_path(path, src_path)
+      pathname = Pathname.new(path)
+      src_pathname = Pathname.new(src_path)
+
+      if pathname.exist?
+        pathname.realpath.relative_path_from(src_pathname.realpath.to_s).to_s
+      else
+        pathname.to_s
+      end
+    end
   end
 end

data/lib/js_dependency/source_analysis/leave.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative "../pathname_utility"
+module JsDependency
+  module SourceAnalysis
+    # Components have no dependencies.
+    class Leave
+      # @param [Hash] index
+      # @param [String] src_path
+      def initialize(index, src_path)
+        @index = index
+        @src_path = src_path
+      end
+
+      # @return [Array<String>]
+      def call
+        left_index = @index.filter do |_target_path, child_paths|
+          blank?(child_paths)
+        end
+
+        left_index = left_index.transform_keys do |target_path|
+          relative_path_or_external_path(target_path, @src_path)
+        end
+        left_index.keys.uniq.sort
+      end
+
+      private
+
+      # @param [Array<String>] paths
+      # @return [TrueClass, FalseClass]
+      def blank?(paths)
+        paths.nil? || paths.empty?
+      end
+
+      # @param [String] path
+      # @param [String] src_path
+      # @return [String]
+      def relative_path_or_external_path(path, src_path)
+        JsDependency::PathnameUtility.relative_path_or_external_path(path, src_path)
+      end
+    end
+  end
+end

data/lib/js_dependency/source_analysis/orphan.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require_relative "../pathname_utility"
+
+module JsDependency
+  module SourceAnalysis
+    # Components is not depended on.
+    class Orphan
+      # @param [Hash] index
+      # @param [String] src_path
+      def initialize(index, src_path)
+        @index = index
+        @src_path = src_path
+      end
+
+      # @return [Array<String>]
+      def call
+        orphan_index = @index.filter do |target_path, _child_paths|
+          orphan?(target_path)
+        end
+
+        orphan_index = orphan_index.transform_keys do |target_path|
+          relative_path_or_external_path(target_path, @src_path)
+        end
+        orphan_index.keys.uniq.sort
+      end
+
+      private
+
+      # @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.size.zero?
+      end
+
+      # @param [String] path
+      # @param [String] src_path
+      # @return [String]
+      def relative_path_or_external_path(path, src_path)
+        JsDependency::PathnameUtility.relative_path_or_external_path(path, src_path)
+      end
+    end
+  end
+end

data/lib/js_dependency/target_pathname.rb

@@ -7,13 +7,7 @@ module JsDependency
 
     # @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
-      @color_css = "#f9f"
-      @font_size_css = "4px"
+      @pathname = to_target_pathname(target_path)
     end
 
     # @param [Integer] analyze_level
@@ -50,19 +44,8 @@ module JsDependency
       end
     end
 
-    def mermaid_style(src_path)
-      src_pathname = Pathname.new(src_path).realpath
-      export_style(parse(@pathname.exist? ? @pathname.relative_path_from(src_pathname) : @pathname).join("_"))
-    end
-
     private
 
-    # @param [String] path
-    # @return [String]
-    def export_style(path)
-      "style #{path} stroke:#{@color_css},stroke-width:#{@font_size_css}"
-    end
-
     # @param [String] target_path
     # @param [Hash] index
     # @return [Array]
@@ -84,11 +67,5 @@ module JsDependency
     def to_target_pathname(target_path)
       JsDependency::PathnameUtility.to_target_pathname(target_path)
     end
-
-    # @param [Pathname] pathname
-    # @param [Integer] level
-    def parse(pathname, level = -1)
-      JsDependency::PathnameUtility.parse(pathname, level)
-    end
   end
 end

data/lib/js_dependency/version.rb

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

data/lib/js_dependency.rb

@@ -5,6 +5,10 @@ require_relative "js_dependency/index_creator"
 require_relative "js_dependency/mermaid/root"
 require_relative "js_dependency/cli"
 require_relative "js_dependency/target_pathname"
+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 "pathname"
 
 module JsDependency
@@ -18,6 +22,22 @@ module JsDependency
     JsDependency::IndexCreator.call(src_path, alias_paths: alias_paths, excludes: excludes)
   end
 
+  # @param [String] src_path
+  # @param [Hash, nil] alias_paths
+  # @return [Array<String>]
+  def self.leave(src_path, alias_paths: nil)
+    index = JsDependency::IndexCreator.call(src_path, alias_paths: alias_paths)
+    JsDependency::SourceAnalysis::Leave.new(index, src_path).call
+  end
+
+  # @param [String] src_path
+  # @param [Hash, nil] alias_paths
+  # @return [Array<String>]
+  def self.orphan(src_path, alias_paths: nil)
+    index = JsDependency::IndexCreator.call(src_path, alias_paths: alias_paths)
+    JsDependency::SourceAnalysis::Orphan.new(index, src_path).call
+  end
+
   # @param [String] src_path
   # @param [Array<String>] target_paths
   # @param [String] orientation
@@ -35,10 +55,10 @@ module JsDependency
     nodes = []
     styles = []
     target_paths.each do |target_path|
-      target_pathname = JsDependency::TargetPathname.new(target_path)
-      styles += [target_pathname.mermaid_style(src_path)]
+      styles += [JsDependency::Mermaid::TargetPathname.new(target_path).mermaid_style(src_path)]
       mermaid_root = JsDependency::Mermaid::Root.new(orientation)
 
+      target_pathname = JsDependency::TargetPathname.new(target_path)
       target_pathname.each_parent_path(parent_analyze_level, index) do |parent_path, child_path|
         mermaid_root.add(parent_path, child_path)
       end
@@ -72,7 +92,7 @@ module JsDependency
       paths << parent_path
     end
     output = paths.uniq.sort.map do |path|
-      Pathname.new(path).exist? ? Pathname.new(path).relative_path_from(Pathname.new(src_path).realpath.to_s).to_s : Pathname.new(path).to_s
+      JsDependency::PathnameUtility.relative_path_or_external_path(path, src_path)
     end
     output_pathname&.write(output.sort.join("\n"))
     output
@@ -96,7 +116,7 @@ module JsDependency
       paths << child_path
     end
     output = paths.uniq.sort.map do |path|
-      Pathname.new(path).exist? ? Pathname.new(path).relative_path_from(Pathname.new(src_path).realpath.to_s).to_s : Pathname.new(path).to_s
+      JsDependency::PathnameUtility.relative_path_or_external_path(path, src_path)
     end
     output_pathname&.write(output.sort.join("\n"))
     output

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: js_dependency
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.5
 platform: ruby
 authors:
 - junara
@@ -164,8 +164,11 @@ files:
 - lib/js_dependency/index_creator.rb
 - lib/js_dependency/mermaid/nodes_link.rb
 - lib/js_dependency/mermaid/root.rb
+- lib/js_dependency/mermaid/target_pathname.rb
 - lib/js_dependency/pathname_utility.rb
 - lib/js_dependency/replace_path_alias.rb
+- lib/js_dependency/source_analysis/leave.rb
+- lib/js_dependency/source_analysis/orphan.rb
 - lib/js_dependency/target_pathname.rb
 - lib/js_dependency/version.rb
 - sig/js_dependency.rbs