js_dependency 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68994e61c025f75290a28d6d14e1004c54c09ad32d54f3c93fc5626d9621fcd2
-  data.tar.gz: f8dcb17dc254e873d217ecce20ec2e739d1c53c9935cbc6e163941d53a033f2a
+  metadata.gz: 5bf7cfb1d29636defe8ab5e05990af5d95e80f5dc383ff1e3bb56233f6458cd6
+  data.tar.gz: 426a15952e30fe085bfa93c3ab5fbdb1a1f8e19323c01cddc83d3744a41a9269
 SHA512:
-  metadata.gz: 46891feebfed8de0c5fe551b3e176e48d38f17359c6322fd68893c6a0b101394981b5e97385079069c20b93df198c5e8abbb211a3d482609101ad5db06a81197
-  data.tar.gz: ab70ef7054409bc108c68ed0b376feaa110c59543769c91f232940b75cfe81917ca2ca4a7c2c3881b89dd3247fa49d8f03c27bf4b70f7bc14b14e14a8f31b7d1
+  metadata.gz: ea9dd1783d4c7d6ea1c7a205c49fbb55fd73ba947d474c87e700b4e8ad52e93a2ce0816ddfc0f3df78c9bc689c7b7f3037196e7ddd1d73d701616ff5f4234364
+  data.tar.gz: c2020ea6afcef60232a53b2846f7ba972b15c6600659bc18197f68708187f2d75bd0349011297b3e98201428cbc31f8d617f5999d29010d0293a433fc96a2b47

data/.js_dependency.yml.sample

@@ -0,0 +1,8 @@
+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

data/.rubocop_todo.yml

@@ -1,26 +1,41 @@
 # 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-19 16:03:39 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: 30
 
 # Offense count: 3
+# Configuration parameters: IgnoredMethods.
+Metrics/CyclomaticComplexity:
+  Max: 13
+
+# Offense count: 8
 # Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
 Metrics/MethodLength:
-  Max: 17
+  Max: 20
+
+# Offense count: 1
+# Configuration parameters: CountComments, CountAsOne.
+Metrics/ModuleLength:
+  Max: 112
 
 # Offense count: 1
 # Configuration parameters: CountKeywordArgs, MaxOptionalParameters.
 Metrics/ParameterLists:
   Max: 8
 
+# Offense count: 3
+# Configuration parameters: IgnoredMethods.
+Metrics/PerceivedComplexity:
+  Max: 13
+
 # Offense count: 1
 # This cop supports safe autocorrection (--autocorrect).
 Style/IfUnlessModifier:

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 ## [Unreleased]
 
+## [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.
+
 ## [0.1.0] - 2022-07-16
 
 - Initial release

data/Gemfile.lock

@@ -1,8 +1,10 @@
 PATH
   remote: .
   specs:
-    js_dependency (0.1.0)
+    js_dependency (0.2.1)
       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,8 +1,10 @@
+[![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.
 
-TODO: Delete this and the text above, and describe your gem
+Analyze import dependency of JavaScript code and export mermaid format.
 
 ## Installation
 
@@ -15,8 +17,76 @@ 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
+```
+
+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
+```
+
+#### 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
+require 'js_dependency'
+
+
+src_path = './src' # Root folder.
+target_path = './src/App.vue' # Target file that you want to analyze.
+child_analyze_level = 2 # Output level of child dependency.
+parent_analyze_level = 2 # Output level of parent dependency.
+output_path = './mermaid.txt' # Optional. Output file path
+alias_paths = {'@' => '/src' } # Optional. Alias path.
+
+# mermaid出力実行
+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)
+```
 
-TODO: Write usage instructions here
+See `./mermaid.txt` of `output_path` for the result.
 
 ## Development
 
@@ -26,7 +96,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/js_dependency. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/js_dependency/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/junara/js_dependency. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/js_dependency/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 

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,97 @@
+# 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"
+    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
+
+      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
+      )
+
+      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"
+    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
+
+      str = JsDependency.parents(
+        src_path,
+        target_path,
+        parent_analyze_level: parent_analyze_level,
+        output_path: output_path,
+        alias_paths: alias_paths
+      ).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"
+    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
+
+      str = JsDependency.children(
+        src_path,
+        target_path,
+        child_analyze_level: child_analyze_level,
+        output_path: output_path,
+        alias_paths: alias_paths
+      ).sort.uniq.join("\n")
+
+      puts str
+    end
+  end
+end

data/lib/js_dependency/extract_import_path.rb

@@ -12,11 +12,11 @@ module JsDependency
     def call
       str = @str
       # import defaultExport from 'module-name';
-      paths = str.gsub(/import\s+\S+\s+from\s+"([^']+)"/).with_object([]) { |_, list| list << Regexp.last_match(1) }
+      paths = str.gsub(/import\s+\S+\s+from\s+"([^"]+)"/).with_object([]) { |_, list| list << Regexp.last_match(1) }
       paths += str.gsub(/import\s+\S+\s+from\s+'([^']+)'/).with_object([]) { |_, list| list << Regexp.last_match(1) }
 
       # import * as name from \"module-name\";
-      paths += str.gsub(/import\s+\S+\s+as\s+\S+\s+from\s+"([^']+)"/).with_object([]) do |_, list|
+      paths += str.gsub(/import\s+\S+\s+as\s+\S+\s+from\s+"([^"]+)"/).with_object([]) do |_, list|
         list << Regexp.last_match(1)
       end
       paths += str.gsub(/import\s+\S+\s+as\s+\S+\s+from\s+'([^']+)'/).with_object([]) do |_, list|
@@ -28,7 +28,7 @@ module JsDependency
       # import { export1 , export2 } from "module-name";
       # import { foo , bar } from "module-name/path/to/specific/un-exported/file";
       # import { export1 , export2 as alias2 , [...] } from "module-name";
-      paths += str.gsub(/import\s+\{\s+.+\s+\}\s+from\s+"([^']+)"/).with_object([]) do |_, list|
+      paths += str.gsub(/import\s+\{\s+.+\s+\}\s+from\s+"([^"]+)"/).with_object([]) do |_, list|
         list << Regexp.last_match(1)
       end
       paths += str.gsub(/import\s+\{\s+.+\s+\}\s+from\s+'([^']+)'/).with_object([]) do |_, list|
@@ -36,7 +36,7 @@ module JsDependency
       end
 
       # import defaultExport, { export1 [ , [...] ] } from "module-name";
-      paths += str.gsub(/import\s+\S+,\s+\{\s+.+\s+\}\s+from\s+"([^']+)"/).with_object([]) do |_, list|
+      paths += str.gsub(/import\s+\S+,\s+\{\s+.+\s+\}\s+from\s+"([^"]+)"/).with_object([]) do |_, list|
         list << Regexp.last_match(1)
       end
       paths += str.gsub(/import\s+\S+,\s+\{\s+.+\s+\}\s+from\s+'([^']+)'/).with_object([]) do |_, list|
@@ -44,7 +44,7 @@ module JsDependency
       end
 
       # import defaultExport, * as name from "module-name";
-      paths += str.gsub(/import\s+\S+,\s+.+\s+as\s+\S+\s+from\s+"([^']+)"/).with_object([]) do |_, list|
+      paths += str.gsub(/import\s+\S+,\s+.+\s+as\s+\S+\s+from\s+"([^"]+)"/).with_object([]) do |_, list|
         list << Regexp.last_match(1)
       end
       paths += str.gsub(/import\s+\S+,\s+.+\s+as\s+\S+\s+from\s+'([^']+)'/).with_object([]) do |_, list|
@@ -52,7 +52,7 @@ module JsDependency
       end
 
       # import "module-name";
-      paths += str.gsub(/import\s+"([^']+)"/).with_object([]) do |_, list|
+      paths += str.gsub(/import\s+"([^"]+)"/).with_object([]) do |_, list|
         list << Regexp.last_match(1)
       end
       paths += str.gsub(/import\s+'([^']+)'/).with_object([]) do |_, list|
@@ -60,7 +60,7 @@ module JsDependency
       end
 
       # var promise = import("module-name");
-      paths += str.gsub(/import\("([^']+)"\)/).with_object([]) do |_, list|
+      paths += str.gsub(/import\("([^"]+)"\)/).with_object([]) do |_, list|
         list << Regexp.last_match(1)
       end
       paths += str.gsub(/import\('([^']+)'\)/).with_object([]) do |_, list|

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.0"
+  VERSION = "0.2.1"
 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
@@ -42,6 +43,42 @@ module JsDependency
     output
   end
 
+  def self.parents(src_path, target_path, alias_paths: nil, parent_analyze_level: 1, output_path: 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) 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)
+    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) 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]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: js_dependency
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - junara
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-18 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