git-branch--stray 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 4c4dd87337d21115aebe331f57a12fdddff6cef940956e63adadda37e465c5ec
-  data.tar.gz: e160bdbfa27758e704935d27df66c03bd2077d633afc1d95b780337d320138e2
+SHA1:
+  metadata.gz: dd358f7d6dcc8b853965067aef2baf5686af5906
+  data.tar.gz: 19775be68826ebd2003cb0f00194bf54865c8fb3
 SHA512:
-  metadata.gz: 1c81e946ca83b3c3cb388c611d644e8e9536beca3ff658788f75b0036c45ea068864485f6cf1cc30e874ecc42f0b83fc950a73bb1cd111ef6a4367ebb967ff3c
-  data.tar.gz: deff72901ca564f32cfc0bd3f4b7aec878ae38ff33d9d6c1792ae5ea8c8b2960df60041de061e393ebaea69c91c24390ed86d7a7c946d406dd59fdc1bfe49052
+  metadata.gz: d201ec5055943cc18b5a6a798b6b9a756dce3be9ef5f0d48d55216d937ac6105f4274433de86c075b5e11295a594e127d756de3af84942fdedca07a14875e84f
+  data.tar.gz: 3bf9f3e8c9b493ab920b9d5e18c5bab35d45f771b1022056768c420d324853383c470ce4287bd8eba8801978061a89a5d86a13cf1c39a62c9734e97a48fbde53

data/.ruby-version

@@ -1 +1 @@
-2.5.1
+2.3.7

data/README.md

@@ -1,31 +1,31 @@
-# Delete "stray" git branches
+# List and delete "stray" git branches
 
-## tl;dr
+## Summary
 
-Run `git branch--delete--stray` to delete local "remote-tracking" branches for which the branch being tracked has been deleted on the remote.
+Run `git branch--delete--stray` to delete local tracking branches for which the remote branch being tracked has been deleted on the remote... use `git branch--list--stray` to just list them; both work best with [regular pruning](#pruning) of remote-tracking references!
 
 ## Background
 
-Git has a default disposition of keeping data unless it's explicitly thrown away; this extends to _(unnecessarily)_ holding onto references to so-called local "remote-tracking" branches where the branch being tracked has long since been deleted on the remote itself.
+Git has a default disposition of keeping data unless it's explicitly thrown away; this extends to _(unnecessarily?)_ holding onto references to so-called local "remote-tracking" branches where the branch being tracked has long since been deleted on the remote itself.
 
-This utility refers to these local branches as "stray" branches, and includes two git extensions: one for listing all "stray" branches, and a second one for _(selectively)_ deleting them.
+This utility refers to these local tracking branches as "stray" branches, and includes two git extensions: one for listing all "stray" branches, and a second one for _(selectively)_ deleting them.
 
-In case of the [GitHub Flow](https://guides.github.com/introduction/flow/) for instance, a local branch would become "stray" after a pull request gets merged and the underlying remote branch gets deleted... after the next `git fetch` it would be possible to identify the "stray" branch with something akin to `git branch --list --merged`.
+In case of the [GitHub Flow](https://guides.github.com/introduction/flow/) for instance, a local branch would become "stray" after a pull request gets merged and the underlying remote branch gets deleted... after the next `git fetch` it would be possible to identify the "stray" branch with something akin to `git branch --list --merged`, and delete them accordingly.
 
-But that's not the only scenario that results in "stray" branches, which is why the various "solutions" you find on Stack Overflow don't typically cover all edge cases, whereas this utility does;  it also prefers git plumbing over git porcelain, and it implements most of its logic in a library, making it very easy indeed to implement even more git extensions for dealing with "stray" branches.
+But that's not the only scenario that results in "stray" branches, which is why the various "solutions" you find on Stack Overflow don't typically cover all edge cases, whereas this utility does; it also prefers git plumbing over git porcelain, and it implements most of its logic in a library, making it very straightforward to implement even more git extensions for dealing with "stray" branches.
 
 ## What's in a name?
 
-In the context of this utility, a branch is considered "stray" if it is what git calls a "remote-tracking" branch but one where the remote branch it was tracking no longer exists _(ie. where the branch it was tracking has been deleted on the remote, e.g. on GitHub or on Bitbucket)_.
+In the context of this utility, a branch is considered "stray" if it is what git calls [a "remote-tracking" branch](https://git-scm.com/book/id/v2/Git-Branching-Remote-Branches#_tracking_branches), but one where the remote branch it was tracking no longer exists _(ie. where the branch it was tracking has been deleted on the remote, e.g. on GitHub or on Bitbucket)_.
 
 The term "stray" was chosen to avoid confusion with existing git terminology like ''merged", "tracked" and even "orpaned".
 
 Also, the names of the two git extensions implemented by this utility:
 
-* `git-branch--list--stray`
-* `git-branch--delete--stray`
+* `git branch--list--stray`
+* `git branch--delete--stray`
 
-... were chosen two mimic some existing `git branch` commands:
+... were chosen two mimic some existing `git branch` options:
 
 * `git branch --list --merged`
 * `git branch --delete`
@@ -34,29 +34,17 @@ respectively.
 
 ## Installation
 
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'git-branch--stray'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install git-branch--stray
+    gem install git-branch--stray
 
 ## Usage
 
-After installing the gem, you will have two new git extensions in your environment: `git-branch--list--stray` will list all stray branches, whereas `git-branch--delete--stray` will iterate over the list and - after prompting for confirmation - delete any stray branches in your git workarea.
+After installing the gem, you will have two new git extensions in your environment: `git-branch--list--stray` will list all stray branches, whereas `git-branch--delete--stray` will iterate over the list and - after prompting for confirmation - delete any stray branches.
 
-Because they will be in your local `$PATH` you can run them as so-called git subcommands as follows:
+Because they will be in your local `$PATH` you can run them as so-called git subcommands, as follows:
 
 ```
 git branch--list--stray
-git branch--delete-stray
+git branch--delete--stray
 ```
 
 Most likely, though, you will want to create some [git aliases](https://git-scm.com/book/en/v2/Git-Basics-Git-Aliases) to make it easier to work with the two utility scripts:
@@ -70,7 +58,23 @@ Alternatively, a similar approach can be used to add either of the scripts to yo
 
 ## Pruning
 
-The two git extensions work best if your git workflow includes regular pruning of remote-tracking references that no longer exist on the remote, either by running `git fetch --prune` when syncing with the remote in question, or else configuring [git's pruning behaviour](https://git-scm.com/docs/git-fetch#_pruning) for your environment.
+The two git extensions work best if your git workflow includes regular pruning of remote-tracking references that no longer exist on the remote, either by running [`git fetch --prune`](https://git-scm.com/docs/git-fetch#git-fetch--p) when syncing with the remote in question, or else configuring [git's pruning behaviour](https://git-scm.com/docs/git-fetch#_pruning) for your environment.
+
+## Extending
+
+Most of the utility is implemented in a Ruby library, making it very easy to use the logic for dealing with "stray" branches in your own Ruby applications or utilities.
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'git-branch--stray'
+```
+
+And then execute:
+
+    $ bundle
+
+The library to require is in the [`lib/git/branch/stray.rb`](lib/git/branch/stray.rb) file.
 
 ## Development
 

data/exe/git-branch--delete--stray

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-lib = File.expand_path('../../lib', __FILE__)
+lib = File.expand_path('../lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'git/branch/stray'
 

data/exe/git-branch--list--stray

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-lib = File.expand_path('../../lib', __FILE__)
+lib = File.expand_path('../lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'git/branch/stray'
 

data/git-branch--stray.gemspec

@@ -1,4 +1,4 @@
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'git/branch/stray/version'
 
@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.description   = 'Delete local tracking branches that have been strayed'
   spec.homepage      = 'https://github.com/pvdb/git-branch--stray'
 
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`
       .split("\x0")
       .reject { |f| f.match(%r{^(test|spec|features)/}) }

data/lib/git/branch/stray/version.rb

@@ -1,7 +1,7 @@
 module Git
   module Branch
     module Stray
-      VERSION = '1.0.0'.freeze
+      VERSION = '1.1.0'.freeze
     end
   end
 end

data/lib/git/branch/stray.rb

@@ -71,6 +71,7 @@ module Git
     stray_branches.each_consented('Delete stray branch "%s"') do |stray|
       system("git branch -d #{stray}")
       next if $CHILD_STATUS.success?
+
       Array(stray).each_consented('Delete unmerged branch "%s"') do |unmerged|
         system("git branch -D #{unmerged}")
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: git-branch--stray
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Peter Vandenberk
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-08 00:00:00.000000000 Z
+date: 2018-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: consenter
@@ -123,7 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.5.2.3
 signing_key: 
 specification_version: 4
 summary: Delete local tracking branches that have been strayed