js_dependency 0.1.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 20217229c2c7f845d05b400f356240d4e2db4d46f9b4d1fc6662868bc1bac372
-  data.tar.gz: d74ccf10be4764621ff17bc2700c56b8947263b5dc35bccaab49101df90eea59
+  metadata.gz: d88ba49b09bf39f743538394281ad7d7956abfd3a3a86e7b34fb88c1ad995f98
+  data.tar.gz: 75928de5c657b2af3599606343798f17bfc2839e4967b46a9c9274eef0819218
 SHA512:
-  metadata.gz: a842902a4bf0331ea00352315682bf4efb8ac6891dfa2fcfedff0d5ecdfada5d8cf1240ebc6e02a5f8b8ac8a6df54d85c47e4140ac581601d43dbb7a16f3fb2d
-  data.tar.gz: 919130f6a767b0dc51533cacee935c810da0a8460ab74e86536704fea8614289fa45025c8b3d9edd62a48782bc463e632256b3c9868f849bcb93cf006859c035
+  metadata.gz: 27bbd73e5ecd0f49ff5c82608abf7f553802fdce21878dd18036e1d675c09f526a92e152c08aab3ec9b9293c4a446d51b27fa8ceb75bd19a074ab097d9e5248d
+  data.tar.gz: 5f328e13c00a1a50352c910902a42323caf558cdd22441218cc03048bebc41da85aea3b767948ce951b373037d7404e57ae293d4e85e12d1f930baef21a2d312

data/.js_dependency.yml.sample

@@ -0,0 +1,11 @@
+src_path: ./src
+target_path: ./src/App.vue
+child_analyze_level: 2
+parent_analyze_level: 2
+name_level: 1
+output_path: ./mermaid.txt
+alias_paths:
+  "@": ./pages
+excludes:
+  - excludedWord1
+  - excludedWord2

data/.rubocop_todo.yml

@@ -1,25 +1,40 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2022-07-18 12:42:10 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
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 3
+# Offense count: 6
 # Configuration parameters: IgnoredMethods, CountRepeatedAttributes.
 Metrics/AbcSize:
-  Max: 20
+  Max: 37
 
-# Offense count: 3
+# Offense count: 5
+# Configuration parameters: IgnoredMethods.
+Metrics/CyclomaticComplexity:
+  Max: 15
+
+# Offense count: 8
 # Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
 Metrics/MethodLength:
-  Max: 17
+  Max: 26
 
 # Offense count: 1
+# Configuration parameters: CountComments, CountAsOne.
+Metrics/ModuleLength:
+  Max: 114
+
+# Offense count: 3
 # Configuration parameters: CountKeywordArgs, MaxOptionalParameters.
 Metrics/ParameterLists:
-  Max: 8
+  Max: 9
+
+# Offense count: 5
+# Configuration parameters: IgnoredMethods.
+Metrics/PerceivedComplexity:
+  Max: 16
 
 # Offense count: 1
 # This cop supports safe autocorrection (--autocorrect).
@@ -27,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,19 @@
 ## [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.
+- Output mermaid with parent and child string sorting.
+
+## [0.2.0] - 2022-07-19
+
+- Add CLI interface.
+
 ## [0.1.1] - 2022-07-19
 
 - Bug fix of double quotation mark.

data/Gemfile.lock

@@ -1,8 +1,10 @@
 PATH
   remote: .
   specs:
-    js_dependency (0.1.1)
+    js_dependency (0.2.2)
       pathname
+      thor
+      yaml
 
 GEM
   remote: https://rubygems.org/
@@ -74,11 +76,13 @@ GEM
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
+    thor (1.2.1)
     trollop (2.9.10)
     unicode-display_width (2.2.0)
     unparser (0.6.5)
       diff-lcs (~> 1.3)
       parser (>= 3.1.0)
+    yaml (0.2.0)
     yarn (0.1.1)
       parslet (>= 1.2)
       rack (>= 1.3)

data/README.md

@@ -1,3 +1,5 @@
+[![codecov](https://codecov.io/gh/junara/js_dependency/branch/main/graph/badge.svg?token=GRdbS1xqUa)](https://codecov.io/gh/junara/js_dependency)
+
 # JsDependency
 
 Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/js_dependency`. To experiment with that code, run `bin/console` for an interactive prompt.
@@ -15,6 +17,56 @@ If bundler is not being used to manage dependencies, install the gem by executin
     $ gem install js_dependency
 
 ## Usage
+### By Command Line
+
+Configuration file is `./.js_dependency.yml`. This file includes parameters for the analysis.
+
+```yaml
+src_path: ./src # Root folder
+target_path: ./src/App.vue # Target file tha you want to analyze
+child_analyze_level: 2 # Output level of child analyze
+parent_analyze_level: 2 # Output level of parent analyze
+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.
+
+```
+src_path -> -s
+target_path -> -t
+child_analyze_level -> -c
+parent_analyze_level -> -p
+name_level -> -n
+output_path -> -o
+exclude -> -e
+```
+
+#### Export Mermaid Format
+
+```shell
+js_dependency -s ./src -t ./src/App.vue -o ./mermaid.txt -c 2 -p 2 -n 1
+```
+
+#### Export parents components list
+
+```shell
+js_dependency parents -s ./src -t ./src/App.vue -o ./parents.txt -p 2
+```
+
+#### Export children components list
+
+```shell
+js_dependency childrent -s ./src -t ./src/App.vue -o ./children.txt -c 2
+```
+
+
+### 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:
 
 ```ruby

data/exe/js_dependency

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "js_dependency"
+
+JsDependency::Cli.start(ARGV)

data/js_dependency.gemspec

@@ -31,7 +31,8 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "pathname"
-
+  spec.add_dependency "thor"
+  spec.add_dependency "yaml"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "rspec-parameterized"
   spec.add_development_dependency "rubocop"

data/lib/js_dependency/cli.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+require "thor"
+require "yaml"
+
+module JsDependency
+  class Cli < Thor
+    default_command :export_mermaid
+
+    desc "export_mermaid", "Output mermaid flowchart string."
+    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 :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 = {}
+      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"] || 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[:exclude]
+                   [options[:exclude]]
+                 elsif args["excludes"]
+                   args["excludes"]
+                 end
+
+      str = JsDependency.export_mermaid(
+        src_path,
+        target_path,
+        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
+      )
+
+      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 :exclude, type: :string, aliases: "-e", desc: "Exclude the word that is included in the 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[: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,
+        excludes: excludes
+      ).sort.uniq.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 :exclude, type: :string, aliases: "-e", desc: "Exclude the word that is included in the 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[: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,
+        excludes: excludes
+      ).sort.uniq.join("\n")
+
+      puts str
+    end
+  end
+end

data/lib/js_dependency/mermaid/root.rb

@@ -17,7 +17,7 @@ module JsDependency
 
       def export(name_level: 1)
         str = "flowchart #{orientation}\n"
-        str + @list.sort_by(&:parent).uniq { |link| "#{link.parent}__#{link.child}" }.map do |link|
+        str + @list.uniq { |link| "#{link.parent}__#{link.child}" }.sort_by { |link| "#{link.parent}__#{link.child}" }.map do |link|
           "#{link.parent_module_name(name_level)} --> #{link.child_module_name(name_level)}"
         end.join("\n")
       end

data/lib/js_dependency/version.rb

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

data/lib/js_dependency.rb

@@ -3,6 +3,7 @@
 require_relative "js_dependency/version"
 require_relative "js_dependency/index_creator"
 require_relative "js_dependency/mermaid/root"
+require_relative "js_dependency/cli"
 require "pathname"
 
 module JsDependency
@@ -16,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)
 
@@ -29,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
 
@@ -42,6 +44,42 @@ module JsDependency
     output
   end
 
+  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)
+
+    target_pathname = if Pathname.new(target_path).relative? && Pathname.new(target_path).exist?
+                        Pathname.new(target_path).realpath
+                      else
+                        Pathname.new(target_path)
+                      end
+    list = []
+    parents_paths(target_pathname, parent_analyze_level, index, excludes: excludes) do |parent_path, _child_path|
+      list << parent_path
+    end
+    output = list.uniq
+    output_pathname&.write(output.sort.join("\n"))
+    output
+  end
+
+  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)
+
+    target_pathname = if Pathname.new(target_path).relative? && Pathname.new(target_path).exist?
+                        Pathname.new(target_path).realpath
+                      else
+                        Pathname.new(target_path)
+                      end
+    list = []
+    children_paths(target_pathname, child_analyze_level, index, excludes: excludes) do |_parent_path, child_path|
+      list << child_path
+    end
+    output = list.uniq
+    output_pathname&.write(output.sort.join("\n"))
+    output
+  end
+
   # @param [String] target_path
   # @param [Hash] index
   # @return [Array]
@@ -55,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
@@ -68,6 +107,7 @@ module JsDependency
                       end
     index[target_pathname.to_s] || []
   end
+
   private_class_method :extract_children_paths
 
   # @param [String] src
@@ -75,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 = []
@@ -89,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 = []
@@ -109,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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: js_dependency
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.2
 platform: ruby
 authors:
 - junara
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-19 00:00:00.000000000 Z
+date: 2022-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pathname
@@ -24,6 +24,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yaml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -111,10 +139,12 @@ dependencies:
 description: Analyze dependency using import for JavaScript.
 email:
 - jun5araki@gmail.com
-executables: []
+executables:
+- js_dependency
 extensions: []
 extra_rdoc_files: []
 files:
+- ".js_dependency.yml.sample"
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
@@ -125,8 +155,10 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- exe/js_dependency
 - js_dependency.gemspec
 - lib/js_dependency.rb
+- lib/js_dependency/cli.rb
 - lib/js_dependency/extract_import_path.rb
 - lib/js_dependency/extract_script_tag.rb
 - lib/js_dependency/index_creator.rb