chelsea 0.0.26 → 0.0.31

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e4509169b4bc0855e2ef590412aac149020c8506e430093285a1edc03f49652
-  data.tar.gz: 894d2636f0966c8b288e31d8f40d265b1bf156c310622fd35c90852d46c1234e
+  metadata.gz: 8f6fed77cd96f3fd715030c654c03c5e480a9a46e40c76c7a4a5ae4d2016c681
+  data.tar.gz: e42fca3e172ce5937e90b09f7961d9a13b44d6fc9c1dd530f5b3f5fe19ec87df
 SHA512:
-  metadata.gz: 35e878b35f6aa92d1ae68bf4d4e18b3eedcb08de41a7fc233b42c842b3ef440c6d89f26020f86990c4af9cd52cff73e83139046eeedff82fb9fadaeac954c944
-  data.tar.gz: 946138b959b3eb119ffde5897b673002c2445549e7f48d1b0edfba50a338a8cecf14b3eb29c16ac166dfdec10a31885712563fd49a8bc01e5227a7975adc0c9b
+  metadata.gz: 1af02ec98ba340900a503b508d7f4cbf15c7cbd8643c27879db3db87608ac8d4cdbe7dad67b034a042f76d75548dbc17f2d546c760b0537e8e32fdfd1ce7bf9d
+  data.tar.gz: 27194d47997fc5bb332820a28d3c16ba58c31de0bae35cd8bad939c5e4efe76317cf3e3ee9a7091013745c26d995c65c50ac8e6825dad8dff38d4a8778a7b78a

data/.circleci/config.yml

@@ -18,7 +18,7 @@ version: 2.1
 jobs: 
   build: 
     docker: 
-      - image: circleci/ruby:2.6.5-stretch
+      - image: circleci/ruby:2.6.6-stretch
         environment: 
           BUNDLE_PATH: vendor/bundle
     steps:
@@ -35,7 +35,9 @@ jobs:
             - chelsea-bundle-v2-
       - run:
           name: Bundle Install
-          command: bundle check --path vendor/bundle || bundle install
+          command: |
+            bundle config set --local path 'vendor/bundle'
+            bundle check || bundle install
       - save_cache:
           key: chelsea-bundle-v2-{{ checksum "Gemfile.lock" }}
           paths:
@@ -46,6 +48,9 @@ jobs:
             bundle exec rspec --format progress \
                             --format RspecJunitFormatter \
                             --out test_results/rspec.xml
+      - run:
+          name: Run linter
+          command: bundle exec rubocop
       - run:
           name: Build gem
           command: gem build chelsea.gemspec
@@ -62,7 +67,7 @@ jobs:
           path: test_results
   release:
     docker:
-      - image: circleci/ruby:2.6.5-stretch
+      - image: circleci/ruby:2.6.6-stretch
     steps:
       - add_ssh_keys:
           fingerprints:
@@ -82,7 +87,7 @@ jobs:
           command: git config --global user.email "$GITHUB_EMAIL"
       - run:
           name: Set git upstream
-          command: git branch -u origin/master
+          command: git branch -u origin/main
       - run:
           name: Bump version
           command: gem bump -v patch --tag --skip-ci --push
@@ -102,4 +107,4 @@ workflows:
           filters:
             branches:
               only: 
-                - master
+                - main

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -23,7 +23,7 @@ If applicable, add screenshots to help explain your problem.
 
 **Desktop (please complete the following information):**
  - OS: [e.g. OS X 1.13.6]
- - Ruby Version: [e.g. 2.6.5]
+ - Ruby Version: [e.g. 2.6.6]
  - Bundler Version: [e.g. 2.1.4]
  - chelsea Version [e.g. 0.0.11]
 

data/.rubocop.yml

@@ -0,0 +1,6 @@
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.6.6
+
+Metrics/BlockLength:
+  IgnoredMethods: ['Slop.parse']

data/Gemfile

@@ -1,6 +1,11 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in chelsea.gemspec
 gemspec
+
+# linter
+gem 'rubocop', require: false

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    chelsea (0.0.17)
+    chelsea (0.0.28)
       bundler (>= 1.2.0, < 3)
       ox (~> 2.13.2)
       pastel (~> 0.7.2)
@@ -16,31 +16,38 @@ GEM
   specs:
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.2)
     byebug (11.1.2)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
     diff-lcs (1.3)
     domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
-    equatable (0.6.1)
+    equatable (0.7.0)
     hashdiff (1.0.1)
     http-cookie (1.0.3)
       domain_name (~> 0.5)
     mime-types (3.3.1)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2020.0512)
-    necromancer (0.6.0)
+    mime-types-data (3.2021.0225)
+    necromancer (0.7.0)
     netrc (0.11.0)
-    ox (2.13.2)
+    ox (2.13.4)
+    parallel (1.20.1)
+    parser (3.0.1.0)
+      ast (~> 2.4.1)
     pastel (0.7.4)
       equatable (~> 0.6)
       tty-color (~> 0.5)
     public_suffix (4.0.3)
+    rainbow (3.0.0)
     rake (12.3.3)
+    regexp_parser (2.1.1)
     rest-client (2.0.2)
       http-cookie (>= 1.0.2, < 2.0)
       mime-types (>= 1.16, < 4.0)
       netrc (~> 0.8)
+    rexml (3.2.5)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
@@ -56,17 +63,29 @@ GEM
     rspec-support (3.9.2)
     rspec_junit_formatter (0.4.1)
       rspec-core (>= 2, < 4, != 2.12.0)
+    rubocop (1.12.1)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.1)
+      parser (>= 2.7.1.5)
+    ruby-progressbar (1.11.0)
     safe_yaml (1.0.5)
-    slop (4.8.1)
+    slop (4.8.2)
     strings (0.1.8)
       strings-ansi (~> 0.1)
       unicode-display_width (~> 1.5)
       unicode_utils (~> 1.4)
     strings-ansi (0.2.0)
-    tty-color (0.5.1)
+    tty-color (0.6.0)
     tty-cursor (0.7.1)
     tty-font (0.5.0)
-    tty-screen (0.8.0)
+    tty-screen (0.8.1)
     tty-spinner (0.9.3)
       tty-cursor (~> 0.7)
     tty-table (0.11.0)
@@ -94,6 +113,7 @@ DEPENDENCIES
   rake (~> 12.3)
   rspec (~> 3.0)
   rspec_junit_formatter (~> 0.4.1)
+  rubocop
   webmock (~> 3.8.3)
 
 BUNDLED WITH

data/README.md

@@ -167,12 +167,279 @@ Run tests:
 bundle exec rspec
 ```
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`. To manually release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+### Release Process
+
+Chelsea is automatically released after a commit to the `master` branch.
+
+To avoid performing a release after a commit to the `master` branch, be sure your commit message includes `[skip ci] `.
 
 ## Why Chelsea?
 
 One of the awesome developers at Sonatype was thinking of names, and came upon the [Chelsea filter](https://en.wikipedia.org/wiki/Chelsea_filter). A Chelsea filter is used to separate gemstones, helping gemologists distinguish between real emeralds, and just regular green glass. We felt this tool helps you do something very similar, looking at your RubyGems, and seeing which are pristine, and which are less than ok at the moment.
 
+## How to Fix Vulnerabilities
+
+So you've found a vulnerability. Now what? The best case is to upgrade the vulnerable component to a newer/non-vulnerable
+version. However, it is likely the vulnerable component is not a direct dependency, but instead is a transitive dependency
+(a dependency of a dependency, of a dependency, wash-rinse-repeat). In such a case, the first step is to figure out which
+direct dependency (and sub-dependencies) depend on the vulnerable component. 
+
+The `gem dependency` command will show a dependency tree for all gems from the current Gemfile with their dependencies.
+The `bundle outdated` command will show a list of all gems which have newer versions. 
+
+As an example, suppose we've learned that component `rexml`, version 3.2.4 is vulnerable (CVE-2021-28965). 
+Use the following command to determine which components depend on `rexml`.
+```shell
+$ gem dependency -R rexml
+Gem rexml-3.1.9
+  bundler (>= 0, development)
+  rake (>= 0, development)
+  Used by
+    rubocop-1.9.0 (rexml (>= 0))
+
+Gem rexml-3.2.4
+  bundler (>= 0, development)
+  rake (>= 0, development)
+  Used by
+    rubocop-1.9.0 (rexml (>= 0))
+```
+
+There are a number of approaches to resolving the vulnerability, but no matter which approach you choose, you should 
+probably make sure all the tests are passing before making any dependency changes.
+```shell
+bundle exec rspec
+...
+Finished in 0.1411 seconds (files took 0.67222 seconds to load)
+22 examples, 0 failures
+```
+
+One approach is to upgrade everything to the latest version available. This solution might make people nervous about
+introducing breaking changes. (You have unit tested everything right? ;) )
+<details>
+  <summary>Click to expand output of command:
+
+```shell
+$ bundle update 
+```
+  </summary>
+
+```shell
+  $ bundle update
+Fetching gem metadata from https://rubygems.org/.........
+Fetching gem metadata from https://rubygems.org/.
+Resolving dependencies...
+Using rake 12.3.3
+Using public_suffix 4.0.6 (was 4.0.3)
+Using addressable 2.7.0
+Using ast 2.4.2
+Using bundler 2.1.4
+Using byebug 11.1.3 (was 11.1.2)
+Using ox 2.13.4
+Using equatable 0.7.0 (was 0.6.1)
+Using tty-color 0.6.0 (was 0.5.2)
+Using pastel 0.7.4
+Using unf_ext 0.0.7.7
+Using unf 0.1.4
+Using domain_name 0.5.20190701
+Using http-cookie 1.0.3
+Using mime-types-data 3.2021.0225 (was 3.2020.0512)
+Using mime-types 3.3.1
+Using netrc 0.11.0
+Using rest-client 2.0.2
+Using slop 4.8.2
+Using tty-font 0.5.0
+Using tty-cursor 0.7.1
+Using tty-spinner 0.9.3
+Using necromancer 0.7.0 (was 0.6.0)
+Using strings-ansi 0.2.0
+Using unicode-display_width 1.7.0
+Using unicode_utils 1.4.0
+Using strings 0.1.8
+Using tty-screen 0.8.1
+Using tty-table 0.11.0
+Using chelsea 0.0.28 (was 0.0.27) from source at `.`
+Using rexml 3.2.5 (was 3.2.4)
+Using crack 0.4.5 (was 0.4.3)
+Using diff-lcs 1.4.4 (was 1.3)
+Using hashdiff 1.0.1
+Using parallel 1.20.1
+Using parser 3.0.1.0 (was 3.0.0.0)
+Using rainbow 3.0.0
+Using regexp_parser 2.1.1 (was 2.0.3)
+Using rspec-support 3.10.2 (was 3.9.2)
+Using rspec-core 3.10.1 (was 3.9.1)
+Using rspec-expectations 3.10.1 (was 3.9.1)
+Using rspec-mocks 3.10.2 (was 3.9.1)
+Using rspec 3.10.0 (was 3.9.0)
+Using rspec_junit_formatter 0.4.1
+Using rubocop-ast 1.4.1
+Using ruby-progressbar 1.11.0
+Using rubocop 1.12.1 (was 1.9.0)
+Using webmock 3.8.3
+Bundle updated!
+Gems in the group production were not updated.
+```
+</details>
+
+Perhaps a more palatable approach would be to upgrade to a newer version of the "Used by" component, meaning you upgrade
+the direct dependency (`rubocop`) to a version that does not depend on a vulnerable version of the transitive dependency
+(`rexml`). This approach will make fewer changes overall.
+
+In some cases, no such upgrade of the direct dependency exists that avoids a dependence on the vulnerable component. 
+In such a case, the next step is to file an issue with the direct dependency project for them to update the vulnerable
+sub-dependencies. Be sure to read and follow any vulnerability reporting instructions published by the project: Look for
+a `SECURITY.md` file, or other instructions on how to report vulnerabilities. Some projects may prefer you not report 
+the vulnerability publicly.
+
+In our example, there is a newer version of the direct dependency available:
+```shell
+  $ bundle outdated | grep rubocop
+  * rubocop (newest 1.12.1, installed 1.9.0) in group "default"
+```
+Now we can update the `rubocop` component as follows:
+<details>
+  <summary>Click to expand output of command:
+
+```shell
+$ bundle update rubocop
+```
+  </summary>
+
+```shell
+$ bundle update rubocop
+Fetching gem metadata from https://rubygems.org/.........
+Fetching gem metadata from https://rubygems.org/.
+Resolving dependencies...
+Using rake 12.3.3
+Fetching public_suffix 4.0.3
+Installing public_suffix 4.0.3
+Using addressable 2.7.0
+Using ast 2.4.2
+Using bundler 2.1.4
+Fetching byebug 11.1.2
+Installing byebug 11.1.2 with native extensions
+Using ox 2.13.4
+Using equatable 0.6.1
+Using tty-color 0.5.2
+Using pastel 0.7.4
+Using unf_ext 0.0.7.7
+Using unf 0.1.4
+Using domain_name 0.5.20190701
+Using http-cookie 1.0.3
+Using mime-types-data 3.2020.0512
+Using mime-types 3.3.1
+Using netrc 0.11.0
+Using rest-client 2.0.2
+Using slop 4.8.2
+Using tty-font 0.5.0
+Using tty-cursor 0.7.1
+Using tty-spinner 0.9.3
+Using necromancer 0.6.0
+Using strings-ansi 0.2.0
+Using unicode-display_width 1.7.0
+Using unicode_utils 1.4.0
+Using strings 0.1.8
+Using tty-screen 0.8.1
+Using tty-table 0.11.0
+Using chelsea 0.0.28 from source at `.`
+Using safe_yaml 1.0.5
+Fetching crack 0.4.3
+Installing crack 0.4.3
+Fetching diff-lcs 1.3
+```
+</details>
+
+Yet another alternative approach is to upgrade the transitive dependency (`rexml` in our example). 
+
+Use the command below to determine if there is a newer version of the vulnerable component.
+```shell
+  $ bundle outdated | grep rexml
+  * rexml (newest 3.2.5, installed 3.2.4)
+```
+Now we can update the `rexml` component as follows:
+<details>
+  <summary>Click to expand output of command:
+
+```shell
+$ bundle update rexml
+```
+  </summary>
+
+```shell
+$ bundle update rexml
+Fetching gem metadata from https://rubygems.org/.........
+Fetching gem metadata from https://rubygems.org/.
+Resolving dependencies...
+Using rake 12.3.3
+Using public_suffix 4.0.3
+Using addressable 2.7.0
+Using ast 2.4.2
+Using bundler 2.1.4
+Using byebug 11.1.2
+Using ox 2.13.4
+Using equatable 0.7.0 (was 0.6.1)
+Using tty-color 0.6.0 (was 0.5.2)
+Using pastel 0.7.4
+Using unf_ext 0.0.7.7
+Using unf 0.1.4
+Using domain_name 0.5.20190701
+Using http-cookie 1.0.3
+Using mime-types-data 3.2021.0225 (was 3.2020.0512)
+Using mime-types 3.3.1
+Using netrc 0.11.0
+Using rest-client 2.0.2
+Using slop 4.8.2
+Using tty-font 0.5.0
+Using tty-cursor 0.7.1
+Using tty-spinner 0.9.3
+Using necromancer 0.7.0 (was 0.6.0)
+Using strings-ansi 0.2.0
+Using unicode-display_width 1.7.0
+Using unicode_utils 1.4.0
+Using strings 0.1.8
+Using tty-screen 0.8.1
+Using tty-table 0.11.0
+Using chelsea 0.0.28 (was 0.0.27) from source at `.`
+Using safe_yaml 1.0.5
+Using crack 0.4.3
+Using diff-lcs 1.3
+Using hashdiff 1.0.1
+Using parallel 1.20.1
+Using parser 3.0.0.0
+Using rainbow 3.0.0
+Using regexp_parser 2.0.3
+Using rexml 3.2.5 (was 3.2.4)
+Using rspec-support 3.9.2
+Using rspec-core 3.9.1
+Using rspec-expectations 3.9.1
+Using rspec-mocks 3.9.1
+Using rspec 3.9.0
+Using rspec_junit_formatter 0.4.1
+Using rubocop-ast 1.4.1
+Using ruby-progressbar 1.11.0
+Using rubocop 1.9.0
+Using webmock 3.8.3
+Bundle updated!
+Gems in the group production were not updated.
+```
+</details>
+
+Regardless of which approach you choose, you should verify the tests pass after you upgrade dependencies.
+```shell
+bundle exec rspec
+...
+Finished in 0.12826 seconds (files took 0.5069 seconds to load)
+22 examples, 0 failures
+```
+Full disclosure, it turns out that after upgrading `rubocop` (via: `bundle update rubocop`),
+a `# rubocop:disable Layout/LineLength` was no longer needed. 
+Happily, the CI test suite failed and pointed quickly to the fix (just needed to remove `# rubocop`
+disable/enable comments).
+
+Victory! Commit the changes, and we're done. (see [PR: #44](https://github.com/sonatype-nexus-community/chelsea/pull/44))
+
 ## Contributing
 
 We care a lot about making the world a safer place, and that's why we created `chelsea`. If you as well want to speed up the pace of software development by working on this project, jump on in! Before you start work, create a new issue, or comment on an existing issue, to let others know you are!