Class: LicenseAuto::Npm

Inherits:
PackageManager show all
Defined in:
lib/license_auto/package_manager/npm.rb

Constant Summary collapse

LANGUAGE = 
'NodeJS'

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from PackageManager

#check_cli, #dependency_file_path_names

Constructor Details

#initialize(path) ⇒ Npm

Returns a new instance of Npm.



11
12
13
 
# File 'lib/license_auto/package_manager/npm.rb', line 11

def initialize(path)
  super(path)
end

Class Method Details

.check_cli ⇒ Object

TODO: move



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/license_auto/package_manager/npm.rb', line 90

def self.check_cli
  bash_cmd = "node -v"
  LicenseAuto.logger.debug(bash_cmd)
  stdout_str, stderr_str, status = Open3.capture3(bash_cmd)
  node_version = /v5\.\d+\.\d+/
  if not stderr_str.empty?
    LicenseAuto.logger.error(stderr_str)
    return false
  elsif not stdout_str =~ node_version
    error = "NodeJS version: #{stdout_str} not satisfied: #{node_version}"
    LicenseAuto.logger.error(error)
    return false
  end

  bash_cmd = "node -e \"const semver = require('semver');\" -r semver"
  LicenseAuto.logger.debug(bash_cmd)
  stdout_str, stderr_str, status = Open3.capture3(bash_cmd)
  unless stderr_str.empty?
    LicenseAuto.logger.error(stderr_str)
    LicenseAuto.logger.info(
        "\nInstall npm packages first using:\n
          $ npm install\n")
    return false
  end

  return true
end

.is_valid_semver?(semver) ⇒ Boolean

semver: String

Returns:

  • (Boolean) 


76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/license_auto/package_manager/npm.rb', line 76

def self.is_valid_semver?(semver)
  node_cmd = "node -e \"var semver = require('semver'); var valid = semver.validRange('#{semver}'); console.log(valid)\""
  # LicenseAuto.logger.debug(node_cmd)
  stdout_str, _stderr_str, _status = Open3.capture3(node_cmd)
  is_invalid = stdout_str.gsub(/\n/, '') == 'null'
  # if is_invalid
  #   LicenseAuto.logger.error("semver: #{semver} is not a valid sem-version")
  # else
  #   LicenseAuto.logger.debug("semver: #{semver} is valid")
  # end
  not is_invalid
end

Instance Method Details

#dependency_file_pattern ⇒ Object 



15
16
17
 
# File 'lib/license_auto/package_manager/npm.rb', line 15

def dependency_file_pattern
  /#{@path}\/(src\/|source\/)?package\.json$/
end

#parse_dependencies ⇒ Object 



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/license_auto/package_manager/npm.rb', line 19

def parse_dependencies

  package_json_files = dependency_file_path_names
  if package_json_files.empty?
    LicenseAuto.logger.info("#{LANGUAGE}: #{dependency_file_pattern} file not exist")
    return []
  else
    package_json_files.map {|dep_file|
      LicenseAuto.logger.debug(dep_file)
      npm_definition = Hashie::Mash.new(JSON.parse(File.read(dep_file)))

      {
        dep_file: dep_file,
        deps: [npm_definition.dependencies, npm_definition.devDependencies].compact.map {|hash|
            hash.map {|pack_name, semver|
              available_version, remote =
                  if semver =~ /^file:/
                    # DOC: https://docs.npmjs.com/files/package.json#local-paths
                    ['local-path', semver]
                  elsif LicenseAuto::Npm.is_valid_semver?(semver)
                    pack = Hashie::Mash.new(
                        "language": "NodeJS",
                        "name": pack_name,
                        "group": "",
                        "version": semver,
                        "server": "registry.npmjs.org"
                    )
                    npm_registry = LicenseAuto::NpmRegistry.new(pack)
                    version = npm_registry.chose_latest_available_version(semver)
                    [version, npm_registry.registry]
                  else
                    # DOC: https://docs.npmjs.com/files/package.json#git-urls-as-dependencies
                    git_url = semver.gsub(/^git\+/, '')
                    matcher = LicenseAuto::Matcher::SourceURL.new(git_url)
                    github_matched = matcher.match_github_resource
                    if github_matched
                      # TODO: ref=github_matched[:ref]
                      github = GithubCom.new({}, github_matched[:owner], github_matched[:repo])
                      version = github.list_tags.first.name
                      LicenseAuto.logger.debug(version)
                      [version, git_url]
                    end
                  end
              {
                  name: pack_name,
                  version: available_version,
                  remote: remote
              }
            }
        }.flatten
      }
    }
  end
  # LicenseAuto.logger.debug(JSON.pretty_generate(dep_files))
end