git_lib 1.2.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c3b82cc9214aa0d0faecd8aa639ae16fee57179d0be17aebc365ebebe52e43f
-  data.tar.gz: 24b88e76619b9ab4138ebe07eca7c849f09377a2eec21afe384545d6e674df61
+  metadata.gz: f83b697a51aa8d99736c92879bb28d0e59f8635e7d32a9e0d9de5c9b6a0a2dc9
+  data.tar.gz: 62649c6cbe804f091acc15cf96e47cbb13521afd44a4cad571e378cbdd051719
 SHA512:
-  metadata.gz: eb5e0a487b3adad39dc3bc3d3f3fe94097a143ea0d7fdbccef27d1f5515a4612e98ecd44251d7926b5c4d51aeffd1a0efd819db024564574089dc7428cb9b6f2
-  data.tar.gz: 75f854dba8e98489dc373fd829c8792ba8fc581624f5b5191bce97978dba6eade70e89b42a4b16a20ef76f784f42f8c08984841eb246b6647e0e49b11471db92
+  metadata.gz: 7a4caae1a2a43f7602ff8b2b0d5d4db07565e2702cc497aabd781e95fff12a845d9568f33ea91db142a0caf8644b6fb7e024fd4cf3bcbf78a1f19a01519f8062
+  data.tar.gz: 3556c067c8d47dcbb0bf641800cf8f095d3fa994830c57169792fa85b6f04dd0720b87a3d8c8bd724d622054dc3c4efb0361ff0384909555109cb38d1abb7ff8

data/.github/workflows/build.yml

@@ -0,0 +1,27 @@
+---
+name: Build
+on: [push]
+jobs:
+  tests:
+    name: Unit Tests
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [2.5, 2.6]
+        gemfile:
+        - Gemfile
+        - gemfiles/rails_4.gemfile
+        - gemfiles/rails_5.gemfile
+        - gemfiles/rails_6.gemfile
+    env:
+      BUNDLE_GEMFILE: ${{ matrix.gemfile }}
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler: 1.17.3
+        bundler-cache: true
+    - name: Unit tests
+      run: bundle exec rspec

data/.github/workflows/gem_release.yml

@@ -23,7 +23,7 @@ jobs:
         uses: mindsers/changelog-reader-action@v1
         with:
           version: ${{ steps.tag_name.outputs.current_version }}
-        path: ./CHANGELOG.md
+          path: ./CHANGELOG.md
       - name: Create Release
         id: create_release
         uses: actions/create-release@v1

data/CHANGELOG.md

@@ -4,6 +4,14 @@ Inspired by [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 Note: this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [2.1.0] - 2021-12-13
+### Changed
+- Changed `commit_diff_refs` to handle the `nil` case for `ancestor_ref`
+
+## [2.0.0] - 2021-08-24
+### Changed
+- Add required `repository:` to `GitCommit`.
+
 ## [1.2.0] - 2020-07-13
 ### Added
 - Add support for Rails 5 and 6.
@@ -20,5 +28,7 @@ Note: this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0
 - Add magic frozen_string_literal: true comment everywhere.
 - Clean up Rakefile.
 
+[2.1.0]: https://github.com/Invoca/git_lib/compare/v2.0.0...v2.1.0
+[2.0.0]: https://github.com/Invoca/git_lib/compare/v1.2.0...v2.0.0
 [1.2.0]: https://github.com/Invoca/git_lib/compare/v1.1.1...v1.2.0
 [1.1.1]: https://github.com/Invoca/git_lib/compare/v1.1.0...v1.1.1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    git_lib (1.2.0)
+    git_lib (2.1.0)
       activesupport (>= 4.2, < 7)
 
 GEM

data/lib/git/git.rb

@@ -150,20 +150,28 @@ module Git
       raw_output.split("\n")
     end
 
+    def sha_list_for_ref_range(ref, ancestor_ref, fetch: false)
+      commit_diff_refs(ref, ancestor_ref, fetch: fetch).map(&:sha)
+    end
+
     def commit_diff_refs(ref, ancestor_ref, fetch: false)
       if fetch
         fetch_all
       end
-      ref_prefix = 'origin/' unless self.class.is_git_sha?(ref)
+
+      ref_prefix          = 'origin/' unless self.class.is_git_sha?(ref)
       ancestor_ref_prefix = 'origin/' unless self.class.is_git_sha?(ancestor_ref)
 
-      raw_output = execute(
-        "log --format=%H\t%an\t%ae\t%aI\t%s " \
-        "--no-color #{ancestor_ref_prefix}#{Shellwords.escape(ancestor_ref)}..#{ref_prefix}#{Shellwords.escape(ref)}"
-      )
+      sha_range = if ancestor_ref
+                    "#{ancestor_ref_prefix}#{Shellwords.escape(ancestor_ref)}..#{ref_prefix}#{Shellwords.escape(ref)}"
+                  else
+                    "#{ref_prefix}#{Shellwords.escape(ref)}"
+                  end
+
+      raw_output = execute("log --format=%H\t%an\t%ae\t%aI\t%s --no-color #{sha_range}")
       raw_output.split("\n").map do |row|
         commit_data = row.split("\t")
-        GitCommit.new(commit_data[0], commit_data[4], DateTime.iso8601(commit_data[3]), commit_data[1], commit_data[2])
+        GitCommit.new(commit_data[0], commit_data[4], DateTime.iso8601(commit_data[3]), commit_data[1], commit_data[2], repository_name: @repository_name)
       end
     end
 

data/lib/git/git_commit.rb

@@ -2,14 +2,15 @@
 
 module Git
   class GitCommit
-    attr_reader :sha, :message, :commit_date, :author_name, :author_email
+    attr_reader :repository_name, :sha, :message, :commit_date, :author_name, :author_email
 
-    def initialize(sha, message, commit_date, author_name, author_email)
+    def initialize(sha, message, commit_date, author_name, author_email, repository_name:)
       @sha = sha
       @message = message
       @commit_date = commit_date
       @author_email = author_email
       @author_name = author_name
+      @repository_name = repository_name
     end
 
     def to_s

data/lib/git/git_test_helpers.rb

@@ -23,12 +23,13 @@ module Git
       GitConflict.new(repository_name, branch_a_name, branch_b_name, file_list)
     end
 
-    def self.create_commit(sha: '1234567890123456789012345678901234567890',
+    def self.create_commit(repository_name: 'repository',
+                           sha: '1234567890123456789012345678901234567890',
                            message: 'Commit message',
                            author_name: 'Author Name',
                            author_email: 'author@email.com',
                            commit_date: Time.current)
-      GitCommit.new(sha, message, commit_date, author_name, author_email)
+      GitCommit.new(sha, message, commit_date, author_name, author_email, repository_name: repository_name)
     end
 
     def self.create_sha

data/lib/git/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Git
-  VERSION = '1.2.0'
+  VERSION = '2.1.0'
 end

data/spec/lib/git/git_branch_spec.rb

@@ -3,7 +3,7 @@
 require 'spec_helper'
 require_relative '../../../lib/git/git_branch.rb'
 
-describe 'Git::GitBranch' do
+RSpec.describe 'Git::GitBranch' do
   it 'can be created' do
     last_modified_date = Time.current
     branch = Git::GitBranch.new('repository_name', 'name', last_modified_date, 'author_name', 'author@email.com')

data/spec/lib/git/git_commit_spec.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require_relative '../../../lib/git/git_commit.rb'
+
+RSpec.describe Git::GitCommit do
+  let(:sha) { 'aabb2345' }
+  let(:message) { 'TECH-1234: update comments' }
+  let(:commit_date) { '2021-08-23 10:03:00 -0700' }
+  let(:author_name) { 'John Doe' }
+  let(:author_email) { 'john@doe.com' }
+  let(:repository_name) { 'repository_name' }
+
+  it 'can be created' do
+    commit = Git::GitCommit.new(sha, message, commit_date, author_name, author_email, repository_name: repository_name)
+
+    expect(commit.sha).to eq(sha)
+    expect(commit.message).to eq(message)
+    expect(commit.commit_date).to eq(commit_date)
+    expect(commit.author_name).to eq(author_name)
+    expect(commit.author_email).to eq(author_email)
+    expect(commit.repository_name).to eq(repository_name)
+  end
+end

data/spec/lib/git/git_conflict_spec.rb

@@ -3,7 +3,7 @@
 require 'spec_helper'
 require_relative '../../../lib/git/git_conflict.rb'
 
-describe 'Git::GitConflict' do
+RSpec.describe 'Git::GitConflict' do
   it 'can be created' do
     conflict = Git::GitConflict.new('repository_name', 'branch_a', 'branch_b', ['file1', 'file2'])
 

data/spec/lib/git/git_error_spec.rb

@@ -3,7 +3,7 @@
 require 'spec_helper'
 require_relative '../../../lib/git/git_error.rb'
 
-describe 'Git::GitError' do
+RSpec.describe 'Git::GitError' do
   it 'can be raised' do
     expect { raise Git::GitError.new('command', 200, 'error_message') }.to \
       raise_exception(Git::GitError, "Git command command failed with exit code 200. Message:\nerror_message")

data/spec/lib/git/git_spec.rb

@@ -4,7 +4,7 @@ require 'spec_helper'
 require_relative '../../../lib/git/git.rb'
 
 # rubocop:disable Metrics/LineLength
-describe 'Git::Git' do
+RSpec.describe 'Git::Git' do
   include FakeFS::SpecHelpers
 
   def create_mock_open_status(status)
@@ -28,15 +28,17 @@ describe 'Git::Git' do
     end
   end
 
+  let(:repository_name) { 'repository_name' }
+
   it 'can be created' do
-    git = Git::Git.new('repository_name')
+    git = Git::Git.new(repository_name)
 
     expect(git.repository_url).to eq('git@github.com:repository_name.git')
     expect(git.repository_path).to eq('/tmp/git/repository_name')
   end
 
   it 'can be created with a different cache path' do
-    git = Git::Git.new('repository_name', git_cache_path: './mycache')
+    git = Git::Git.new(repository_name, git_cache_path: './mycache')
 
     expect(git.repository_url).to eq('git@github.com:repository_name.git')
     expect(git.repository_path).to eq('./mycache/repository_name')
@@ -44,7 +46,7 @@ describe 'Git::Git' do
 
   context 'with a git repository' do
     before do
-      @git = Git::Git.new('repository_name')
+      @git = Git::Git.new(repository_name)
     end
 
     it 'can execute a command' do
@@ -145,21 +147,21 @@ describe 'Git::Git' do
 
         branch_list = []
         branch_list << Git::GitBranch.new(
-          'repository_name',
+          repository_name,
           'test_1',
           DateTime.iso8601('2015-10-19T17:58:24-0700'),
           'Nicholas Ellis',
           'nellis@invoca.com'
         )
         branch_list << Git::GitBranch.new(
-          'repository_name',
+          repository_name,
           'test_build',
           DateTime.iso8601('2015-10-19T15:03:22-0700'),
           'Bob Smith',
           'bob@invoca.com'
         )
         branch_list << Git::GitBranch.new(
-          'repository_name',
+          repository_name,
           'test_build_b',
           DateTime.iso8601('2015-10-19T16:52:40-0700'),
           'Nicholas Ellis',
@@ -186,7 +188,7 @@ describe 'Git::Git' do
         )
 
         conflict = Git::GitConflict.new(
-          'repository_name',
+          repository_name,
           '91/eb/WEB-1723_Ringswitch_DB_Conn_Loss',
           '85/t/trello_adwords_dashboard_tiles_auto_adjust_font_size',
           ['test/workers/adwords_detail_worker_test.rb', 'pegasus/backdraft/pegasus_dashboard/spec/views/call_cost_tile_spec.js']
@@ -215,7 +217,7 @@ describe 'Git::Git' do
         expect(@git).to receive(:reset)
 
         conflict = Git::GitConflict.new(
-          'repository_name',
+          repository_name,
           '91/eb/WEB-1723_Ringswitch_DB_Conn_Loss',
           '85/t/trello_adwords_dashboard_tiles_auto_adjust_font_size',
           [
@@ -377,8 +379,8 @@ describe 'Git::Git' do
       it 'can diff a branch' do
         mocked_output = ["efd778098239838c165ffab2f12ad293f32824c8\tAuthor 1\tauthor1@email.com\t2016-07-14T10:09:45-07:00\tMerge branch 'production'\n",
                          "667f3e5347c48c04663209682642fd8d6d93fde2\tAuthor 2\tauthor2@email.com\t2016-07-14T16:46:35-07:00\tMerge pull request #5584 from Owner/repo/dimension_repair\n"].join
-        expected_array = [Git::GitCommit.new('efd778098239838c165ffab2f12ad293f32824c8', "Merge branch 'production'", nil, 'Author 1', 'author1@email.com'),
-                          Git::GitCommit.new('667f3e5347c48c04663209682642fd8d6d93fde2', 'Merge pull request #5584 from Owner/repo/dimension_repair', nil, 'Author 2', 'author2@email.com')]
+        expected_array = [Git::GitCommit.new('efd778098239838c165ffab2f12ad293f32824c8', "Merge branch 'production'", nil, 'Author 1', 'author1@email.com', repository_name: repository_name),
+                          Git::GitCommit.new('667f3e5347c48c04663209682642fd8d6d93fde2', 'Merge pull request #5584 from Owner/repo/dimension_repair', nil, 'Author 2', 'author2@email.com', repository_name: repository_name)]
         mock_execute(
           mocked_output,
           1,
@@ -424,6 +426,18 @@ describe 'Git::Git' do
         )
         @git.commit_diff_refs('branch`name', 'ancestor`_branch')
       end
+
+      it 'can get a list of shas given start and end refs' do
+        mocked_output = ["efd778098239838c165ffab2f12ad293f32824c8\tAuthor 1\tauthor1@email.com\t2016-07-14T10:09:45-07:00\tMerge branch 'production'\n",
+                         "667f3e5347c48c04663209682642fd8d6d93fde2\tAuthor 2\tauthor2@email.com\t2016-07-14T16:46:35-07:00\tMerge pull request #5584 from Owner/repo/dimension_repair\n"].join
+        expected_array = ["efd778098239838c165ffab2f12ad293f32824c8", "667f3e5347c48c04663209682642fd8d6d93fde2"]
+        mock_execute(
+          mocked_output,
+          1,
+          expected_command: "/usr/bin/git log --format=%H\t%an\t%ae\t%aI\t%s --no-color efd778098239838c165ffab2f12ad293f32824c8..667f3e5347c48c04663209682642fd8d6d93fde2"
+        )
+        expect(@git.sha_list_for_ref_range("667f3e5347c48c04663209682642fd8d6d93fde2", "efd778098239838c165ffab2f12ad293f32824c8")).to eq(expected_array)
+      end
     end
 
     describe 'get_current_branch_name' do

data/spec/spec_helper.rb

@@ -7,14 +7,22 @@ require 'pp'
 require 'fakefs/spec_helpers'
 require 'rspec_junit_formatter'
 require 'climate_control'
+require 'rspec/support/object_formatter'
 
 RSpec.configure do |config|
   config.add_formatter RspecJunitFormatter, ENV['JUNIT_OUTPUT'] || 'spec/reports/rspec.xml'
+  RSpec::Support::ObjectFormatter.default_instance.max_formatted_output_length = 2_000
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.filter_run_when_matching :focus
 
   # Enable flags like --only-failures and --next-failure
   config.example_status_persistence_file_path = "spec/reports/.rspec_status"
 
   config.expect_with :rspec do |expectations|
+    expectations.syntax = :expect
     expectations.include_chain_clauses_in_custom_matcher_descriptions = true
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: git_lib
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Invoca Development
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-13 00:00:00.000000000 Z
+date: 2021-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -30,7 +30,7 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '7'
-description: 
+description:
 email:
 - development@invoca.com
 executables: []
@@ -38,10 +38,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".dependabot/config.yml"
+- ".github/workflows/build.yml"
 - ".github/workflows/gem_release.yml"
 - ".gitignore"
-- ".jenkins/Jenkinsfile"
-- ".jenkins/ruby_build_pod.yml"
 - ".rspec"
 - ".rubocop.yml"
 - ".ruby-version"
@@ -65,6 +64,7 @@ files:
 - lib/git/version.rb
 - lib/git_lib.rb
 - spec/lib/git/git_branch_spec.rb
+- spec/lib/git/git_commit_spec.rb
 - spec/lib/git/git_conflict_spec.rb
 - spec/lib/git/git_error_spec.rb
 - spec/lib/git/git_spec.rb
@@ -73,7 +73,7 @@ homepage: https://github.com/Invoca/git_lib
 licenses: []
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -89,11 +89,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.1
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Git wrapper library.
 test_files:
 - spec/lib/git/git_branch_spec.rb
+- spec/lib/git/git_commit_spec.rb
 - spec/lib/git/git_conflict_spec.rb
 - spec/lib/git/git_error_spec.rb
 - spec/lib/git/git_spec.rb

data/.jenkins/Jenkinsfile

@@ -1,72 +0,0 @@
-#!/usr/bin/groovy
-@Library('jenkins-pipeline@v0.4.5')
-import com.invoca.docker.*;
-
-pipeline {
-  agent {
-    kubernetes {
-      defaultContainer "ruby"
-      yamlFile ".jenkins/ruby_build_pod.yml"
-    }
-  }
-
-  environment {
-    GITHUB_TOKEN = credentials('github_token')
-    BUNDLE_GEM__FURY__IO = credentials('gemfury_deploy_token')
-  }
-
-  stages {
-    stage('Setup') {
-      steps {
-        updateGitHubStatus('clean-build', 'pending', 'Running unit tests...')
-        sh 'bundle install'
-        sh 'bundle exec appraisal install'
-      }
-    }
-
-    stage('Appraisals') {
-      parallel {
-        stage('Current') {
-          environment { JUNIT_OUTPUT = 'spec/reports/current/rspec.xml' }
-          steps       { sh 'bundle exec rspec' }
-          post        { always { junit JUNIT_OUTPUT } }
-        }
-
-        stage('Rails 4') {
-          environment { JUNIT_OUTPUT = 'spec/reports/rails-4/rspec.xml' }
-          steps       { sh 'bundle exec appraisal rails-4 rspec' }
-          post        { always { junit JUNIT_OUTPUT } }
-        }
-
-        stage('Rails 5') {
-          environment { JUNIT_OUTPUT = 'spec/reports/rails-5/rspec.xml' }
-          steps       { sh 'bundle exec appraisal rails-5 rspec' }
-          post        { always { junit JUNIT_OUTPUT } }
-        }
-
-        stage('Rails 6') {
-          environment { JUNIT_OUTPUT = 'spec/reports/rails-6/rspec.xml' }
-          steps       { sh 'bundle exec appraisal rails-6 rspec' }
-          post        { always { junit JUNIT_OUTPUT } }
-        }
-      }
-    }
-  }
-
-  post {
-    success { updateGitHubStatus('clean-build', 'success', 'Unit tests passed') }
-    failure { updateGitHubStatus('clean-build', 'failure', 'Unit tests failed') }
-  }
-}
-
-void updateGitHubStatus(String context, String status, String description) {
-  gitHubStatus([
-    repoSlug:    'Invoca/git_lib',
-    sha:         env.GIT_COMMIT,
-    description: description,
-    context:     context,
-    targetURL:   env.RUN_DISPLAY_URL,
-    token:       env.GITHUB_TOKEN,
-    status:      status
-  ])
-}

data/.jenkins/ruby_build_pod.yml

@@ -1,19 +0,0 @@
----
-apiVersion: v1
-kind: Pod
-metadata:
-  labels:
-  jenkins/git-lib: 'true'
-  namespace: jenkins
-  name: git-lib
-spec:
-  containers:
-  - name: ruby
-    image: ruby:2.6.1
-    tty: true
-    resources:
-    requests:
-      memory: "100Mi"
-    command:
-      - cat
-