git 1.8.0 → 1.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b4267b97da7a2024f34b388707eb119370d7006d6606efb8963c4bfde76f460
-  data.tar.gz: 3383dffa2ff71b075c62bfa40f417e37c082dc78946f2cf4c413d3bdca89a153
+  metadata.gz: 4baf98bc2847ece4cb13a4f558b1654facb3c8add9ce58eebb024a139f880742
+  data.tar.gz: 9c1448896ab666dbe25c38484074fc81814a53fdb6b5e8eac599f58ebdde713b
 SHA512:
-  metadata.gz: 2bd0fdfe6cce4d48a0efe62204350227d4c9eb20f184e6be43cc12811639e3e1ba789a467ab74dd24374ba758d1abd311a1875c13a368fbe28ea42080109b58b
-  data.tar.gz: cdc75148835d1a68b76681941a28a49955b42729f085f8fdac79dc393c293447099c33748701b86f66c4db1c93344df6a6c668eff72c6c3a2899ca88b65444b3
+  metadata.gz: a71409e92d3c79d2c41c2dc693eb031dda63e1d50ddbfcc90c3fea04c30c25341d40a086934f4582f3207fba9a20240c1061ad79a007cdcae19969c9a662c341
+  data.tar.gz: 78c864391d9dcc90f238d78cd616e65c7ccc0fddd2ae7d0a206e31f5d5726d4945ceecdb201680c9630bc7123b88696b744ae8a5f0a9094f743ac0473106c4dc

data/.github/stale.yml

@@ -0,0 +1,25 @@
+# Probot: Stale
+# https://github.com/probot/stale
+
+# Number of days of inactivity before an issue becomes stale
+daysUntilStale: 60
+
+# Number of days of inactivity before a stale issue is closed
+# Set to false to disable. If disabled, issues still need to be closed
+# manually, but will remain marked as stale.
+daysUntilClose: false
+
+# Issues with these labels will never be considered stale
+exemptLabels:
+  - pinned
+  - security
+
+# Label to use when marking an issue as stale
+staleLabel: stale
+
+# Comment to post when marking an issue as stale. Set to `false` to disable
+markComment: >
+  A friendly reminder that this issue had no activity for 60 days.
+
+# Comment to post when closing a stale issue. Set to `false` to disable
+closeComment: false

data/.github/workflows/continuous_integration.yml

@@ -0,0 +1,42 @@
+name: CI
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+jobs:
+  continuous_integration_build:
+    continue-on-error: true
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [2.3, 2.7]
+        operating-system: [ubuntu-latest]
+        include:
+          - ruby: head
+            operating-system: ubuntu-latest
+          - ruby: truffleruby-head
+            operating-system: ubuntu-latest
+          - ruby: 2.7
+            operating-system: windows-latest
+          - ruby: jruby-head
+            operating-system: windows-latest
+
+    name: Ruby ${{ matrix.ruby }} on ${{ matrix.operating-system }}
+
+    runs-on: ${{ matrix.operating-system }}
+
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v2
+
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+
+      - name: Run Build
+        run: bundle exec rake default

data/.gitignore

@@ -0,0 +1,10 @@
+*.gem
+*.kpf
+*.sw?
+.DS_Store
+coverage
+doc
+.yardoc
+pkg
+rdoc
+Gemfile.lock

data/.yardopts

@@ -0,0 +1,11 @@
+--default-return=''
+--hide-void-return
+--markup-provider=redcarpet
+--markup=markdown
+--fail-on-warning
+-
+README.md
+CHANGELOG.md
+CONTRIBUTING.md
+RELEASING.md
+MAINTAINERS.md

data/CHANGELOG.md

@@ -5,6 +5,10 @@
 
 # Change Log
 
+## 1.8.1
+
+See https://github.com/ruby-git/ruby-git/releases/tag/v1.8.1
+
 ## 1.8.0
 
 See https://github.com/ruby-git/ruby-git/releases/tag/v1.8.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gemspec :name => 'git'
+

data/ISSUE_TEMPLATE.md

@@ -0,0 +1,15 @@
+### Subject of the issue
+Describe your issue here.
+
+### Your environment
+* version of git and ruby-git
+* version of ruby
+
+### Steps to reproduce
+Tell us how to reproduce this issue. 
+
+### Expected behaviour
+What did you expect to happen?
+
+### Actual behaviour
+What actually happened?

data/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,9 @@
+### Your checklist for this pull request
+🚨Please review the [guidelines for contributing](https://github.com/ruby-git/ruby-git/blob/master/CONTRIBUTING.md) to this repository.
+
+- [ ] Ensure all commits include DCO sign-off.
+- [ ] Ensure that your contributions pass unit testing.
+- [ ] Ensure that your contributions contain documentation if applicable.
+
+### Description
+Please describe your pull request.

data/RELEASING.md

@@ -0,0 +1,62 @@
+<!--
+# @markup markdown
+# @title Releasing
+-->
+
+# How to release a new git.gem
+
+Releasing a new version of the `git` gem requires these steps:
+  * [Prepare the release](#prepare-the-release)
+  * [Create a GitHub release](#create-a-github-release)
+  * [Build and release the gem](#build-and-release-the-gem)
+
+These instructions use an example where the current release version is `1.5.0`
+and the new release version to be created is `1.6.0.pre1`.
+
+## Prepare the release
+
+From a fork of ruby-git, create a PR containing changes to (1) bump the
+version number, (2) update the CHANGELOG.md, and (3) tag the release.
+
+  * Bump the version number in lib/git/version.rb following [Semantic Versioning](https://semver.org)
+    guidelines
+  * Add a link in CHANGELOG.md to the release tag which will be created later
+    in this guide
+  * Create a new tag using [git-extras](https://github.com/tj/git-extras/blob/master/Commands.md#git-release)
+    `git release` command
+    * For example: `git release v1.6.0.pre1`
+  * These should be the only changes in the PR
+  * An example of these changes for `v1.6.0.pre1` can be found in [PR #435](https://github.com/ruby-git/ruby-git/pull/435)
+  * Get the PR reviewed, approved and merged to master.
+
+## Create a GitHub release
+
+On [the ruby-git releases page](https://github.com/ruby-git/ruby-git/releases),
+select `Draft a new release`
+
+  * Select the tag corresponding to the version being released `v1.6.0.pre1`
+  * The Target should be `master`
+  * For the release description, use the output of [changelog-rs](https://github.com/perlun/changelog-rs)
+    * Since the release has not been created yet, you will need to supply
+      `changeling-rs` with the current release tag and the tag the new release
+      is being created from
+    * For example: `changelog-rs . v1.5.0 v1.6.0.pre1`
+    * Copy the output, omitting the tag header `## v1.6.0.pre1` and paste into
+      the release description
+    * The release description can be edited later if needed
+  * Select the appropriate value for `This is a pre-release`
+    * Since `v1.6.0.pre1` is a pre-release, check `This is a pre-release`
+
+## Build and release the gem
+
+Clone [ruby-git/ruby-git](https://github.com/ruby-git/ruby-git) directly (not a
+fork) and ensure your local working copy is on the master branch
+
+  * Verify that you are not on a fork with the command `git remote -v`
+  * Verify that the version number is correct by running `rake -T` and inspecting
+    the output for the `release[remote]` task
+
+Build the git gem and push it to rubygems.org with the command `rake release`
+
+  * Ensure that your `gem sources list` includes `https://rubygems.org` (in my
+    case, I usually have my work’s internal gem repository listed)

data/Rakefile

@@ -0,0 +1,44 @@
+require 'bundler/gem_tasks'
+
+require "#{File.expand_path(File.dirname(__FILE__))}/lib/git/version"
+
+default_tasks = []
+
+desc 'Run Unit Tests'
+task :test do
+  sh 'git config --global user.email "git@example.com"' if `git config user.email`.empty?
+  sh 'git config --global user.name "GitExample"' if `git config user.name`.empty?
+
+  require File.dirname(__FILE__) + '/tests/all_tests.rb'
+end
+default_tasks << :test
+
+unless RUBY_PLATFORM == 'java'
+  #
+  # YARD documentation for this project can NOT be built with JRuby.
+  # This project uses the redcarpet gem which can not be installed on JRuby.
+  #
+  require 'yard'
+  YARD::Rake::YardocTask.new
+  CLEAN << '.yardoc'
+  CLEAN << 'doc'
+  default_tasks << :yard
+
+  require 'yardstick/rake/verify'
+  Yardstick::Rake::Verify.new(:'yardstick:coverage') do |t|
+    t.threshold = 50
+    t.require_exact_threshold = false
+  end
+  default_tasks << :'yardstick:coverage'
+
+  desc 'Run yardstick to check yard docs'
+  task :yardstick do
+    sh "yardstick 'lib/**/*.rb'"
+  end
+  # Do not include yardstick as a default task for now since there are too many
+  # warnings.  Will work to get the warnings down before re-enabling it.
+  #
+  # default_tasks << :yardstick
+end
+
+task default: default_tasks

data/git.gemspec

@@ -0,0 +1,46 @@
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+require 'git/version'
+
+Gem::Specification.new do |s|
+  s.author = 'Scott Chacon and others'
+  s.email = 'schacon@gmail.com'
+  s.homepage = 'http://github.com/ruby-git/ruby-git'
+  s.license = 'MIT'
+  s.name = 'git'
+  s.summary = 'An API to create, read, and manipulate Git repositories'
+  s.description = <<~DESCRIPTION
+    The Git Gem provides an API that can be used to create, read, and manipulate
+    Git repositories by wrapping system calls to the `git` binary. The API can be
+    used for working with Git in complex interactions including branching and
+    merging, object inspection and manipulation, history, patch generation and
+    more.
+  DESCRIPTION
+  s.version = Git::VERSION
+
+  s.metadata['homepage_uri'] = s.homepage
+  s.metadata['source_code_uri'] = s.homepage
+  s.metadata['changelog_uri'] = 'http://rubydoc.info/gems/git/file.CHANGELOG.html'
+
+  s.require_paths = ['lib']
+  s.required_ruby_version = '>= 2.3'
+  s.required_rubygems_version = Gem::Requirement.new('>= 0') if s.respond_to?(:required_rubygems_version=)
+  s.requirements = ['git 1.6.0.0, or greater']
+
+  s.add_runtime_dependency 'rchardet', '~> 1.8'
+
+  s.add_development_dependency 'minitar', '~> 0.9'
+  s.add_development_dependency 'rake', '~> 13.0'
+  s.add_development_dependency 'test-unit', '~> 3.3'
+
+  unless RUBY_PLATFORM == 'java'
+    s.add_development_dependency 'redcarpet', '~> 3.5'
+    s.add_development_dependency 'yard', '~> 0.9'
+    s.add_development_dependency 'yardstick', '~> 0.9'
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  s.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(tests|spec|features)/}) }
+  end
+end

data/lib/git/version.rb

@@ -1,5 +1,5 @@
 module Git
   # The current gem version
   # @return [String] the current gem version.
-  VERSION='1.8.0'
+  VERSION='1.8.1'
 end

data/lib/git/worktree.rb

@@ -0,0 +1,38 @@
+require 'git/path'
+
+module Git
+
+  class Worktree < Path
+
+    attr_accessor :full, :dir, :gcommit
+
+    def initialize(base, dir, gcommit = nil)
+      @full = dir
+      @full += ' ' + gcommit if !gcommit.nil?
+      @base = base
+      @dir = dir
+      @gcommit = gcommit
+    end
+
+    def gcommit
+      @gcommit ||= @base.gcommit(@full)
+      @gcommit
+    end
+
+    def add
+      @base.lib.worktree_add(@dir, @gcommit)
+    end
+
+    def remove
+      @base.lib.worktree_remove(@dir)
+    end
+
+    def to_a
+      [@full]
+    end
+
+    def to_s
+      @full
+    end
+  end
+end

data/lib/git/worktrees.rb

@@ -0,0 +1,47 @@
+module Git
+  # object that holds all the available worktrees
+  class Worktrees
+
+    include Enumerable
+
+    def initialize(base)
+      @worktrees = {}
+
+      @base = base
+
+      # Array contains [dir, git_hash]
+      @base.lib.worktrees_all.each do |w|
+        @worktrees[w[0]] = Git::Worktree.new(@base, w[0], w[1])
+      end
+    end
+
+    # array like methods
+
+    def size
+      @worktrees.size
+    end
+
+    def each(&block)
+      @worktrees.values.each(&block)
+    end
+
+    def [](worktree_name)
+      @worktrees.values.inject(@worktrees) do |worktrees, worktree|
+        worktrees[worktree.full] ||= worktree
+        worktrees
+      end[worktree_name.to_s]
+    end
+
+    def to_s
+      out = ''
+      @worktrees.each do |k, b|
+        out << b.to_s << "\n"
+      end
+      out
+    end
+
+    def prune
+      @base.lib.worktree_prune
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: git
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.8.1
 platform: ruby
 authors:
 - Scott Chacon and others
@@ -119,11 +119,21 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/stale.yml"
+- ".github/workflows/continuous_integration.yml"
+- ".gitignore"
+- ".yardopts"
 - CHANGELOG.md
 - CONTRIBUTING.md
+- Gemfile
+- ISSUE_TEMPLATE.md
 - LICENSE
 - MAINTAINERS.md
+- PULL_REQUEST_TEMPLATE.md
 - README.md
+- RELEASING.md
+- Rakefile
+- git.gemspec
 - lib/git.rb
 - lib/git/author.rb
 - lib/git/base.rb
@@ -144,6 +154,8 @@ files:
 - lib/git/status.rb
 - lib/git/version.rb
 - lib/git/working_directory.rb
+- lib/git/worktree.rb
+- lib/git/worktrees.rb
 homepage: http://github.com/ruby-git/ruby-git
 licenses:
 - MIT