unwrappr 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 17cf29453a149873809590eabc7cb496b39abe330f47514a24da54ec5f869ef7
-  data.tar.gz: e0e5ce8b470ef58e9a341bf70368c0a3e394c4db8322b52294b2fff773a343b0
+  metadata.gz: 197b63d85c71cc3d7701f8f22cd1a0c305bf07a6eade0c5e7c8ca52ec0538bb3
+  data.tar.gz: 07546ef3c1f66c5a6e9dd632d0f1ac07a5bae6c56897ec6908b9f5ae360dc682
 SHA512:
-  metadata.gz: 392d0cfc8f2f4613616f379765ec8f0ab43ec3aeb5bdb8fbf6fc5ff816337b6a9d9eecdab729caceb2f43fda883a44290821e58f1cfd8e2e5877ed2e2fe384de
-  data.tar.gz: 25a9a43fc432e09eb0aeb2cf019d3e6a6b8fe2ef1e4ccd5ffaeccde386b16330679489085f0e5c0bbdec8327e2495c553e50d75672d8d1ae629adf8389b95320
+  metadata.gz: c0eb4bed6b570378cc213667250f9fbca23e3a25ac84779d8ec2d54ebe4c7fb1cd601c1bac84a92ebff2861a52950f9c048f7c79fb947001c259289ca54272bd
+  data.tar.gz: 2ccbd4e9c68b2d38746b5a88bd37730f1bd211d65d94ceed575b6573e151d733cc7dae0dc4331dd9381d1b8084a05d92d932ad6800d83e726ed456dc4bcce2f1

data/.github/workflows/ci.yml

@@ -0,0 +1,23 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ['2.5', '2.6', '2.7', '3.0']
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - name: Install dependencies
+      run: bundle install
+    - name: Run tests
+      run: bundle exec rake

data/.rubocop.yml

@@ -1,8 +1,9 @@
 ---
 AllCops:
-  TargetRubyVersion: 2.5
   Exclude:
     - 'spike/*.rb'
+  NewCops: enable
+  TargetRubyVersion: 2.5
 
 Gemspec/RequiredRubyVersion:
   Enabled: false

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.0.0

data/CHANGELOG.md

@@ -6,7 +6,40 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-[Unreleased]: https://github.com/envato/unwrappr/compare/v0.4.0...HEAD
+[Unreleased]: https://github.com/envato/unwrappr/compare/v0.6.0...HEAD
+
+## [0.6.0] 2021-05-12
+
+### Add
+- Allow specification of Gemfile lock files to annotate. ([#86])
+
+[0.6.0]: https://github.com/envato/unwrappr/compare/v0.5.0..v0.6.0
+[#86]: https://github.com/envato/unwrappr/pull/86
+
+## [0.5.0] 2021-01-04
+
+### Add
+- Support for Ruby 3. ([#79])
+- Allow specification of base branch, upon which to base the pull-request
+  ([#80], [#84])
+
+### Changed
+- Moved CI to GitHub Actions ([#78])
+- Fixed homepage URL in gemspec ([#77])
+- Default branch is now `main`([#81])
+- Rename private predicate methods in GitCommandRunner to be more descriptive.
+  ([#82])
+- Upgrade Faraday dependency to version 1 ([#85])
+
+[0.5.0]: https://github.com/envato/unwrappr/compare/v0.4.0..v0.5.0
+[#77]: https://github.com/envato/unwrappr/pull/77
+[#78]: https://github.com/envato/unwrappr/pull/78
+[#79]: https://github.com/envato/unwrappr/pull/79
+[#80]: https://github.com/envato/unwrappr/pull/80
+[#81]: https://github.com/envato/unwrappr/pull/81
+[#82]: https://github.com/envato/unwrappr/pull/82
+[#84]: https://github.com/envato/unwrappr/pull/84
+[#85]: https://github.com/envato/unwrappr/pull/85
 
 ## [0.4.0] 2020-04-14
 ### Changed

data/README.md

@@ -16,7 +16,7 @@ to get regular dependency updates into production.
   - Vulnerability advisory information using [bundler-audit](https://github.com/rubysec/bundler-audit)
   - Links to the home page, source code and change log (where available) of each gem
 
-## Development status [![Build Status](https://travis-ci.org/envato/unwrappr.svg?branch=master)](https://travis-ci.org/envato/unwrappr)
+## Development status [![CI Status](https://github.com/envato/unwrappr/workflows/CI/badge.svg)](https://github.com/envato/unwrappr/actions?query=workflow%3ACI)
 
 `unwrappr` is used in many projects around [Envato][envato]
 However, it is still undergoing development and features are likely to change
@@ -85,16 +85,16 @@ See https://github.com/settings/tokens to set up personal access tokens.
  - [Em Esc](https://github.com/emesc)
  - [Chun-wei Kuo](https://github.com/Domon)
 
-## License [![license](https://img.shields.io/github/license/mashape/apistatus.svg?style=flat-square)](https://github.com/envato/unwrappr/blob/master/LICENSE.txt)
+## License [![license](https://img.shields.io/github/license/mashape/apistatus.svg?style=flat-square)](https://github.com/envato/unwrappr/blob/HEAD/LICENSE.txt)
 
 `unwrappr` uses MIT license. See
-[`LICENSE.txt`](https://github.com/envato/unwrappr/blob/master/LICENSE.txt) for
+[`LICENSE.txt`](https://github.com/envato/unwrappr/blob/HEAD/LICENSE.txt) for
 details.
 
 ## Code of Conduct
 
 We welcome contribution from everyone. Read more about it in
-[`CODE_OF_CONDUCT.md`](https://github.com/envato/unwrappr/blob/master/CODE_OF_CONDUCT.md)
+[`CODE_OF_CONDUCT.md`](https://github.com/envato/unwrappr/blob/HEAD/CODE_OF_CONDUCT.md)
 
 ## Contributing [![PRs welcome](https://img.shields.io/badge/PRs-welcome-orange.svg?style=flat-square)](https://github.com/envato/unwrappr/issues)
 

data/lib/unwrappr/cli.rb

@@ -8,6 +8,22 @@ module Unwrappr
   class CLI < Clamp::Command
     self.default_subcommand = 'all'
 
+    option(['-b', '--base'],
+           'BRANCH',
+           <<~DESCRIPTION,
+             the branch upon which to base the pull-request. Omit this option
+             to use the current branch, or repository's default branch
+             (typically 'origin/main') on clone.
+           DESCRIPTION
+           attribute_name: :base_branch)
+
+    option ['-f', '--lock-file'],
+           'LOCK_FILE1 [-f LOCK_FILE2] [-f LOCK_FILE3] [-f ...]',
+           'The Gemfile.lock files to annotate. Useful when working with multiple lock files.',
+           multivalued: true,
+           default: ['Gemfile.lock'],
+           attribute_name: :lock_files
+
     option ['-v', '--version'], :flag, 'Show version' do
       puts "unwrappr v#{Unwrappr::VERSION}"
       exit(0)
@@ -16,7 +32,7 @@ module Unwrappr
     subcommand 'all', 'run bundle update, push to github, '\
                       'create a pr and annotate changes' do
       def execute
-        Unwrappr.run_unwapper_in_pwd
+        Unwrappr.run_unwapper_in_pwd(base_branch: base_branch, lock_files: lock_files)
       end
     end
 
@@ -33,7 +49,8 @@ module Unwrappr
       def execute
         LockFileAnnotator.annotate_github_pull_request(
           repo: repo,
-          pr_number: pr.to_i
+          pr_number: pr.to_i,
+          lock_files: lock_files
         )
       end
     end
@@ -59,24 +76,24 @@ module Unwrappr
             )
           end
 
-          Dir.chdir(repo) { Unwrappr.run_unwapper_in_pwd }
+          Dir.chdir(repo) { Unwrappr.run_unwapper_in_pwd(base_branch: base_branch, lock_files: lock_files) }
         end
       end
     end
   end
 
-  def self.run_unwapper_in_pwd
-    return unless lockfile_present?
+  def self.run_unwapper_in_pwd(base_branch:, lock_files:)
+    return unless any_lockfile_present?(lock_files)
 
     puts "Doing the unwrappr thing in #{Dir.pwd}"
 
-    GitCommandRunner.create_branch!
+    GitCommandRunner.create_branch!(base_branch: base_branch)
     BundlerCommandRunner.bundle_update!
     GitCommandRunner.commit_and_push_changes!
-    GitHub::Client.make_pull_request!
+    GitHub::Client.make_pull_request!(lock_files)
   end
 
-  def self.lockfile_present?
-    GitCommandRunner.file_exist?('Gemfile.lock')
+  def self.any_lockfile_present?(lock_files)
+    lock_files.any? { |lock_file| GitCommandRunner.file_exist?(lock_file) }
   end
 end

data/lib/unwrappr/gem_change.rb

@@ -18,6 +18,7 @@ module Unwrappr
     end
 
     attr_reader :name, :head_version, :base_version, :line_number
+
     def_delegators :@lock_file_diff, :filename, :sha
 
     def added?

data/lib/unwrappr/git_command_runner.rb

@@ -7,15 +7,15 @@ module Unwrappr
   # Runs Git commands
   module GitCommandRunner
     class << self
-      def create_branch!
+      def create_branch!(base_branch:)
         raise 'Not a git working dir' unless git_dir?
-        raise 'failed to create branch' unless branch_created?
+        raise "failed to create branch from '#{base_branch}'" unless checkout_target_branch(base_branch: base_branch)
       end
 
       def commit_and_push_changes!
-        raise 'failed to add git changes' unless git_added_changes?
-        raise 'failed to commit changes' unless git_committed?
-        raise 'failed to push changes' unless git_pushed?
+        raise 'failed to add git changes' unless stage_all_changes
+        raise 'failed to commit changes' unless commit_staged_changes
+        raise 'failed to push changes' unless push_current_branch_to_origin
       end
 
       def reset_client
@@ -50,23 +50,23 @@ module Unwrappr
         git_wrap { !current_branch_name.empty? }
       end
 
-      def branch_created?
+      def checkout_target_branch(base_branch:)
         timestamp = Time.now.strftime('%Y%m%d-%H%M').freeze
         git_wrap do
-          git.checkout('origin/master')
+          git.checkout(base_branch) unless base_branch.nil?
           git.branch("auto_bundle_update_#{timestamp}").checkout
         end
       end
 
-      def git_added_changes?
+      def stage_all_changes
         git_wrap { git.add(all: true) }
       end
 
-      def git_committed?
+      def commit_staged_changes
         git_wrap { git.commit('Automatic Bundle Update') }
       end
 
-      def git_pushed?
+      def push_current_branch_to_origin
         git_wrap { git.push('origin', current_branch_name) }
       end
 
@@ -80,7 +80,7 @@ module Unwrappr
 
       def log_options
         {}.tap do |opt|
-          opt[:log] = Logger.new(STDOUT) if ENV['DEBUG']
+          opt[:log] = Logger.new($stdout) if ENV['DEBUG']
         end
       end
 

data/lib/unwrappr/github/client.rb

@@ -12,8 +12,8 @@ module Unwrappr
           @github_token = nil
         end
 
-        def make_pull_request!
-          create_and_annotate_pull_request
+        def make_pull_request!(lock_files)
+          create_and_annotate_pull_request(lock_files)
         rescue Octokit::ClientError => e
           raise "Failed to create and annotate pull request: #{e}"
         end
@@ -27,15 +27,20 @@ module Unwrappr
           [m[:org], m[:repo]].join('/')
         end
 
-        def create_and_annotate_pull_request
+        def create_and_annotate_pull_request(lock_files)
           pr = git_client.create_pull_request(
             repo_name_and_org,
-            'master',
+            repo_default_branch,
             Unwrappr::GitCommandRunner.current_branch_name,
             'Automated Bundle Update',
             pull_request_body
           )
-          annotate_pull_request(pr.number)
+          annotate_pull_request(pr.number, lock_files)
+        end
+
+        def repo_default_branch
+          git_client.repository(repo_name_and_org)
+                    .default_branch
         end
 
         def pull_request_body
@@ -45,10 +50,11 @@ module Unwrappr
           BODY
         end
 
-        def annotate_pull_request(pr_number)
+        def annotate_pull_request(pr_number, lock_files)
           LockFileAnnotator.annotate_github_pull_request(
             repo: repo_name_and_org,
             pr_number: pr_number,
+            lock_files: lock_files,
             client: git_client
           )
         end
@@ -58,16 +64,16 @@ module Unwrappr
         end
 
         def github_token
-          @github_token ||= ENV.fetch('GITHUB_TOKEN') do
-            raise %(
+          @github_token ||= ENV.fetch('GITHUB_TOKEN')
+        rescue KeyError
+          raise %(
 Missing environment variable GITHUB_TOKEN.
 See https://github.com/settings/tokens to set up personal access tokens.
 Add to the environment:
 
     export GITHUB_TOKEN=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
 
-)
-          end
+            )
         end
       end
     end

data/lib/unwrappr/github/pr_source.rb

@@ -9,9 +9,10 @@ module Unwrappr
     # Implements the `lock_file_diff_source` interface as defined by the
     # LockFileAnnotator.
     class PrSource
-      def initialize(repo, pr_number, client)
+      def initialize(repo, pr_number, lock_files, client)
         @repo = repo
         @pr_number = pr_number
+        @lock_files = lock_files
         @client = client
       end
 
@@ -33,7 +34,7 @@ module Unwrappr
         @lock_file_diffs ||= @client
                              .pull_request_files(@repo, @pr_number)
                              .select do |file|
-                               File.basename(file.filename) == 'Gemfile.lock'
+                               @lock_files.include?(File.basename(file.filename))
                              end
       end
 

data/lib/unwrappr/lock_file_annotator.rb

@@ -18,10 +18,10 @@ module Unwrappr
   class LockFileAnnotator
     # rubocop:disable Metrics/MethodLength
     def self.annotate_github_pull_request(
-      repo:, pr_number:, client: Octokit.client
+      repo:, pr_number:, lock_files:, client: Octokit.client
     )
       new(
-        lock_file_diff_source: Github::PrSource.new(repo, pr_number, client),
+        lock_file_diff_source: Github::PrSource.new(repo, pr_number, lock_files, client),
         annotation_sink: Github::PrSink.new(repo, pr_number, client),
         annotation_writer: Writers::Composite.new(
           Writers::Title,
@@ -54,6 +54,8 @@ module Unwrappr
 
     def annotate
       @lock_file_diff_source.each_file do |lock_file_diff|
+        puts "Annotating #{lock_file_diff.filename}"
+
         lock_file_diff.each_gem_change do |gem_change|
           gem_change_info = @gem_researcher.research(gem_change, {})
           message = @annotation_writer.write(gem_change, gem_change_info)

data/lib/unwrappr/lock_file_comparator.rb

@@ -21,7 +21,9 @@ module Unwrappr
       private
 
       def specs_versions(lock_file)
-        Hash[lock_file.specs.map { |s| [s.name.to_sym, s.version.to_s] }]
+        lock_file.specs.each_with_object({}) do |s, memo|
+          memo[s.name.to_sym] = s.version.to_s
+        end
       end
     end
   end

data/lib/unwrappr/lock_file_diff.rb

@@ -63,7 +63,7 @@ module Unwrappr
       # '+    websocket-driver (0.6.5)'
       # Careful not to match this (note the wider indent):
       # '+      websocket-extensions (>= 0.1.0)'
-      pattern = /^(?<change_type>[\+\-])    (?<gem_name>[\S]+) \(\d/
+      pattern = /^(?<change_type>[+\-])    (?<gem_name>\S+) \(\d/
       match = pattern.match(line)
       return match[:gem_name], match[:change_type] unless match.nil?
     end

data/lib/unwrappr/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Unwrappr
-  VERSION = '0.4.0'
+  VERSION = '0.6.0'
 end

data/unwrappr.gemspec

@@ -12,6 +12,9 @@ AUTHORS = {
   'vladimir.chervanev@envato.com' => 'Vladimir Chervanev'
 }.freeze
 
+GITHUB_URL = 'https://github.com/envato/unwrappr'
+HOMEPAGE_URL = 'https://opensource.envato.com/projects/unwrappr.html'
+
 Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength:
   spec.name = 'unwrappr'
   spec.version = Unwrappr::VERSION
@@ -20,9 +23,9 @@ Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength:
 
   spec.summary = "A tool to unwrap your gems and see what's changed easily"
   spec.description = 'bundle update PRs: Automated. Annotated.'
-  spec.homepage = 'http://www.unwrappr.com.org'
+  spec.homepage = HOMEPAGE_URL
   spec.license = 'MIT'
-  spec.required_ruby_version = '~> 2.5'
+  spec.required_ruby_version = '>= 2.5'
   spec.required_rubygems_version = '>= 2.7'
 
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
@@ -35,7 +38,7 @@ Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength:
   spec.add_dependency 'bundler', '< 3'
   spec.add_dependency 'bundler-audit', '>= 0.6.0'
   spec.add_dependency 'clamp', '~> 1'
-  spec.add_dependency 'faraday', '~> 0'
+  spec.add_dependency 'faraday', '~> 1'
   spec.add_dependency 'git', '~> 1'
   spec.add_dependency 'octokit', '~> 4.0'
   spec.add_dependency 'safe_shell', '~> 1'
@@ -49,10 +52,10 @@ Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength:
   spec.add_development_dependency 'rubocop', '>= 0.49.0'
 
   spec.metadata = {
-    'bug_tracker_uri' => 'https://github.com/envato/unwrappr/issues',
-    'changelog_uri' => 'https://github.com/envato/unwrappr/blob/master/CHANGELOG.md',
-    'documentation_uri' => 'https://github.com/envato/unwrappr/blob/master/README.md',
-    'homepage_uri' => 'https://opensource.envato.com/projects/unwrappr.html',
-    'source_code_uri' => 'https://github.com/envato/unwrappr'
+    'bug_tracker_uri' => "#{GITHUB_URL}/issues",
+    'changelog_uri' => "#{GITHUB_URL}/blob/HEAD/CHANGELOG.md",
+    'documentation_uri' => "#{GITHUB_URL}/blob/HEAD/README.md",
+    'homepage_uri' => HOMEPAGE_URL,
+    'source_code_uri' => GITHUB_URL
   }
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: unwrappr
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Emilyn Escabarte
@@ -9,10 +9,10 @@ authors:
 - Orien Madgwick
 - Pete Johns
 - Vladimir Chervanev
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-04-14 00:00:00.000000000 Z
+date: 2021-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -62,14 +62,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: git
   requirement: !ruby/object:Gem::Requirement
@@ -225,10 +225,11 @@ files:
 - ".buildkite/pipeline.yml"
 - ".buildkite/steps/rspec.sh"
 - ".buildkite/steps/rubocop.sh"
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
+- ".tool-versions"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -267,22 +268,22 @@ files:
 - lib/unwrappr/writers/title.rb
 - lib/unwrappr/writers/version_change.rb
 - unwrappr.gemspec
-homepage: http://www.unwrappr.com.org
+homepage: https://opensource.envato.com/projects/unwrappr.html
 licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/envato/unwrappr/issues
-  changelog_uri: https://github.com/envato/unwrappr/blob/master/CHANGELOG.md
-  documentation_uri: https://github.com/envato/unwrappr/blob/master/README.md
+  changelog_uri: https://github.com/envato/unwrappr/blob/HEAD/CHANGELOG.md
+  documentation_uri: https://github.com/envato/unwrappr/blob/HEAD/README.md
   homepage_uri: https://opensource.envato.com/projects/unwrappr.html
   source_code_uri: https://github.com/envato/unwrappr
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
       version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
@@ -291,8 +292,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '2.7'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.11
+signing_key:
 specification_version: 4
 summary: A tool to unwrap your gems and see what's changed easily
 test_files: []

data/.travis.yml

@@ -1,8 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.5.8
-  - 2.6.6
-  - 2.7.1
-before_install:
-  - gem update --system