package-audit 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c2f009e294663828a3055ac8b8facb3106251875a240f9abf74754747102cef
-  data.tar.gz: 0a11812a839205caa7793c5b34baf31006438b020e9f535ffe1fd5b3ee0333ab
+  metadata.gz: 3987dbcffb0bef510d5897ad47ec79aa5ba65572c62d1a78003496a44264ca7e
+  data.tar.gz: f2608608cee05dde5a409e9dc6a4c885b208ee7d52cc7d6e745e0d3ccf37d7b7
 SHA512:
-  metadata.gz: 7e7a294008ddcb510e8335193ac013447c38b27a71f440325ae2221f5bd0dea29bf714a88e6089b451d50c64f24964da04215c5e54c74c0729fa37a3f277d44b
-  data.tar.gz: 29bb2f4dbef1bb9a6c38eb7d4b17c9aa299f943916765d05a02b14b8f48a0e8ce212bc834e4657285b99d9ba0eb33c80df479e907b673f13fa6834c098e8649e
+  metadata.gz: baa304f965258c639f7e4bee858da18ddd74bfb83926a66d95ce43367ac5bfcf363e4847dd56c98ed649cda9d7143cbb44bb2015d1c7dc263b73f8942538011e
+  data.tar.gz: a5adfb16e863dacea34dc1d1ca8e4962e76ab984f766d86073f2a5bcfceea9923d2c048ae11487e8a0644d9420025a6dba61f57dede9b6faaf74cd82954f5f52

data/lib/package/audit/cli.rb

@@ -15,9 +15,9 @@ module Package
       class_option Enum::Option::CONFIG,
                    aliases: '-c', banner: 'FILE',
                    desc: "Path to a custom configuration file, default: #{Const::File::CONFIG})"
-      class_option Enum::Option::ENVIRONMENT,
-                   aliases: '-e', repeatable: true,
-                   desc: 'Environment to be audited (repeat this flag for each environment)'
+      class_option Enum::Option::GROUP,
+                   aliases: '-g', repeatable: true,
+                   desc: 'Group to be audited (repeat this flag for each group)'
       class_option Enum::Option::TECHNOLOGY,
                    aliases: '-t', repeatable: true,
                    desc: 'Technology to be audited (repeat this flag for each technology)'

data/lib/package/audit/enum/{environment.rb → group.rb}

@@ -1,7 +1,7 @@
 module Package
   module Audit
     module Enum
-      module Environment
+      module Group
         DEV = 'development'
         TEST = 'test'
         STAGING = 'staging'
@@ -9,7 +9,7 @@ module Package
         DEFAULT = 'default'
 
         def self.all
-          constants.map { |key| Enum::Environment.const_get(key) }.sort
+          constants.map { |key| Enum::Group.const_get(key) }.sort
         end
       end
     end

data/lib/package/audit/enum/option.rb

@@ -5,7 +5,7 @@ module Package
         CONFIG = 'config'
         CSV = 'csv'
         CSV_EXCLUDE_HEADERS = 'exclude-headers'
-        ENVIRONMENT = 'environment'
+        GROUP = 'group'
         INCLUDE_IGNORED = 'include-ignored'
         TECHNOLOGY = 'technology'
       end

data/lib/package/audit/models/package.rb

@@ -1,4 +1,4 @@
-require_relative '../enum/environment'
+require_relative '../enum/group'
 require_relative '../enum/risk_explanation'
 require_relative '../enum/risk_type'
 require_relative '../services/risk_calculator'

data/lib/package/audit/npm/yarn_lock_parser.rb

@@ -1,4 +1,4 @@
-require_relative '../enum/environment'
+require_relative '../enum/group'
 
 module Package
   module Audit
@@ -16,9 +16,9 @@ module Package
             version = fetch_package_version(dep_name, pkg_block)
             pks = Package.new(dep_name.to_s, version, 'node')
             pks.update groups: if dev_deps.key?(dep_name)
-                                 [Enum::Environment::DEV]
+                                 [Enum::Group::DEV]
                                else
-                                 [Enum::Environment::DEFAULT, Enum::Environment::DEV]
+                                 [Enum::Group::DEFAULT, Enum::Group::DEV]
                                end
             pkgs << pks
           end

data/lib/package/audit/services/command_parser.rb

@@ -19,7 +19,7 @@ module Package
         @options = options
         @report = report
         @config = parse_config_file
-        @environments = parse_environments
+        @groups = @options[Enum::Option::GROUP]
         @technologies = parse_technologies
         @spinner = Util::Spinner.new('Evaluating packages and their dependencies...')
       end
@@ -32,7 +32,7 @@ module Package
         @spinner.start
         threads = @technologies.map.with_index do |technology, technology_index|
           Thread.new do
-            all_pkgs, ignored_pkgs = PackageFinder.new(@config, @dir, @report, @environments).run(technology)
+            all_pkgs, ignored_pkgs = PackageFinder.new(@config, @dir, @report, @groups).run(technology)
             ignored_pkgs = [] if @options[Enum::Option::INCLUDE_IGNORED]
             cumulative_pkgs += all_pkgs || []
             sleep 0.1 while technology_index != thread_index # print each technology in order
@@ -101,17 +101,6 @@ module Package
         end
       end
 
-      def parse_environments
-        unsupported_technologies = (@options[Enum::Option::ENVIRONMENT] || []) - Enum::Environment.all
-
-        if unsupported_technologies.any?
-          raise ArgumentError, "#{unsupported_technologies} is not valid list of environments, " \
-                               "use one of #{Enum::Environment.all}"
-        end
-
-        (@options[Enum::Option::ENVIRONMENT] || Enum::Environment.all) | [Enum::Environment::DEFAULT]
-      end
-
       def parse_technologies
         technology_validator = Technology::Validator.new(@dir)
         @options[Enum::Option::TECHNOLOGY]&.each { |technology| technology_validator.validate! technology }

data/lib/package/audit/services/package_finder.rb

@@ -11,17 +11,17 @@ require 'yaml'
 module Package
   module Audit
     class PackageFinder
-      def initialize(config, dir, report, environments)
+      def initialize(config, dir, report, groups)
         @config = config
         @dir = dir
         @report = report
-        @environments = environments
+        @groups = groups
       end
 
       def run(technology)
         all_pkgs = find_by_technology(technology)
-        ignored_by_environment_pkgs = filter_pkgs_based_on_environment(all_pkgs)
-        active_pkgs = all_pkgs - ignored_by_environment_pkgs
+        ignored_by_group_pkgs = filter_pkgs_based_on_group(all_pkgs)
+        active_pkgs = all_pkgs - ignored_by_group_pkgs
         ignored_by_config_pkgs = filter_pkgs_based_on_config(active_pkgs)
         [active_pkgs, ignored_by_config_pkgs]
       end
@@ -57,12 +57,15 @@ module Package
         ignored_pkgs
       end
 
-      def filter_pkgs_based_on_environment(pkgs)
+      def filter_pkgs_based_on_group(pkgs)
         ignored_pkgs = []
 
-        pkgs.each do |pkg|
-          ignored_pkgs << pkg unless (pkg.groups & @environments).any?
+        unless @groups.nil?
+          pkgs.each do |pkg|
+            ignored_pkgs << pkg unless (pkg.groups & (@groups | [Enum::Group::DEFAULT])).any?
+          end
         end
+
         ignored_pkgs
       end
     end

data/lib/package/audit/services/risk_calculator.rb

@@ -76,8 +76,8 @@ module Package
       end
 
       def production_dependency?
-        @pkg.groups.none? || (@pkg.groups & [Enum::Environment::DEFAULT,
-                                             Enum::Environment::PRODUCTION]).any?
+        @pkg.groups.none? || (@pkg.groups & [Enum::Group::DEFAULT,
+                                             Enum::Group::PRODUCTION]).any?
       end
     end
   end

data/lib/package/audit/util/summary_printer.rb

@@ -84,7 +84,7 @@ module Package
           puts
 
           puts Util::BashColor.blue('5. Check whether the package is used in production or not.')
-          puts '   If a package is limited to a non-production environment:'
+          puts '   If a package is limited to a non-production group:'
           puts "      - cap risk severity to\t -> #{Util::BashColor.yellow('low')} risk"
         end
       end

data/lib/package/audit/version.rb

@@ -1,5 +1,5 @@
 module Package
   module Audit
-    VERSION = '0.5.0'
+    VERSION = '0.5.1'
   end
 end

data/sig/package/audit/enum/{environment.rbs → group.rbs}

@@ -1,7 +1,7 @@
 module Package
   module Audit
     module Enum
-      module Environment
+      module Group
         DEFAULT: String
         DEV: String
         PRODUCTION: String

data/sig/package/audit/enum/option.rbs

@@ -5,7 +5,7 @@ module Package
         CONFIG: String
         CSV: String
         CSV_EXCLUDE_HEADERS: String
-        ENVIRONMENT: String
+        GROUP: String
         INCLUDE_IGNORED: String
         TECHNOLOGY: String
       end

data/sig/package/audit/services/command_parser.rbs

@@ -3,7 +3,7 @@ module Package
     class CommandParser
       @config: Hash[String, untyped]?
       @dir: String
-      @environments: Array[String]
+      @groups: Array[String]
       @spinner: Util::Spinner
       @options: Hash[String, untyped]
       @report: Symbol
@@ -19,8 +19,6 @@ module Package
 
       def parse_config_file: -> Hash[String, untyped]?
 
-      def parse_environments: -> Array[String]
-
       def parse_technologies: -> Array[String]
 
       def print_disclaimer: (String) -> void

data/sig/package/audit/services/package_finder.rbs

@@ -4,7 +4,7 @@ module Package
       @config: Hash[String, untyped]?
       @dir: String
       @report: Symbol
-      @environments: Array[String]
+      @groups: Array[String]
 
       def initialize: (Hash[String, untyped]?, String, Symbol, Array[String]) -> void
 
@@ -14,7 +14,7 @@ module Package
 
       def filter_pkgs_based_on_config: (Array[Package]) -> Array[Package]
 
-      def filter_pkgs_based_on_environment: (Array[Package]) -> Array[Package]
+      def filter_pkgs_based_on_group: (Array[Package]) -> Array[Package]
 
       def find_by_technology: (String) -> Array[Package]
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: package-audit
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Tactica Communications Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-11-16 00:00:00.000000000 Z
+date: 2023-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler-audit
@@ -54,7 +54,7 @@ files:
 - lib/package/audit/const/file.rb
 - lib/package/audit/const/time.rb
 - lib/package/audit/const/yaml.rb
-- lib/package/audit/enum/environment.rb
+- lib/package/audit/enum/group.rb
 - lib/package/audit/enum/option.rb
 - lib/package/audit/enum/report.rb
 - lib/package/audit/enum/risk_explanation.rb
@@ -94,7 +94,7 @@ files:
 - sig/package/audit/const/file.rbs
 - sig/package/audit/const/time.rbs
 - sig/package/audit/const/yaml.rbs
-- sig/package/audit/enum/environment.rbs
+- sig/package/audit/enum/group.rbs
 - sig/package/audit/enum/option.rbs
 - sig/package/audit/enum/report.rbs
 - sig/package/audit/enum/risk_explanation.rbs
@@ -150,7 +150,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.22
+rubygems_version: 3.4.21
 signing_key:
 specification_version: 4
 summary: A helper tool to find outdated, deprecated and vulnerable dependencies.