git_evolution 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9601a4a1eb15dc6bda2ed6c3229858602d933733
-  data.tar.gz: 98056387ada1c9303ce8f47603a82657df8b5df6
+SHA256:
+  metadata.gz: e0bd6b1c75dbdcdb797f06ede7c13d1d29773e45a5d58d6da9a37d517923bd21
+  data.tar.gz: 46c9a69248d5a54e6c0b64a65ef0b5b2e663bf1820331006b09e6734233c5e0a
 SHA512:
-  metadata.gz: a8ae0797250443a52f297cf840d002fea1ab97598586a43f8cbc25892ab5d8160775806a3535c8aa364e0b90a87aa076331591e96c5773c7fff4c3c9803eb768
-  data.tar.gz: e2ba200cfb1bfe7d0aa87963be0c3e58667f38460b6bd09707a0064529a3f29cc5deada0a36971d45170e64973618a39ca61b25160fe40c0f3087ef908241148
+  metadata.gz: f861946d477729dfd2728da7ca9559c8c87fef3ee6095e4125d36c8b6ba393337e22febb438d51479bc00a49f3d98c86a77b0bb2af63dd7c362334b9b4b113bd
+  data.tar.gz: c3e894fc42ca0e4060fdc7560ffa1a341575ed7a8c52e3281653f41dd5d7cb7dce61f02f622719d667946a5389a57b57d75007c7c6e38438ed9697fb2ea4ad8f

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    git_evolution (0.1.3)
-      bundler (~> 1.0)
+    git_evolution (0.2.0)
+      bundler (~> 2.0)
       chronic (~> 0.10.0)
       rake (~> 10.0)
       rugged (~> 0.21.0)
@@ -10,75 +10,70 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.0.0)
-    astrolabe (1.3.0)
-      parser (>= 2.2.0.pre.3, < 3.0)
-    byebug (3.5.1)
-      columnize (~> 0.8)
-      debugger-linecache (~> 1.2)
-      slop (~> 3.6)
+    ast (2.4.0)
+    byebug (11.0.1)
     chronic (0.10.2)
-    coderay (1.1.0)
-    columnize (0.9.0)
-    coveralls (0.7.10)
-      multi_json (~> 1.10)
-      rest-client (>= 1.6.8, < 2)
-      simplecov (~> 0.9.1)
-      term-ansicolor (~> 1.3)
-      thor (~> 0.19.1)
-    debugger-linecache (1.2.0)
-    diff-lcs (1.2.5)
-    docile (1.1.5)
-    method_source (0.8.2)
-    mime-types (2.4.3)
-    multi_json (1.10.1)
-    netrc (0.10.2)
-    parser (2.2.0.3)
-      ast (>= 1.1, < 3.0)
-    powerpack (0.1.0)
-    pry (0.10.1)
+    coderay (1.1.2)
+    coveralls (0.7.2)
+      multi_json (~> 1.3)
+      rest-client (= 1.6.7)
+      simplecov (>= 0.7)
+      term-ansicolor (= 1.2.2)
+      thor (= 0.18.1)
+    diff-lcs (1.3)
+    docile (1.3.2)
+    jaro_winkler (1.5.4)
+    json (2.2.0)
+    method_source (0.9.2)
+    mime-types (3.3)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2019.1009)
+    multi_json (1.14.1)
+    parallel (1.18.0)
+    parser (2.6.5.0)
+      ast (~> 2.4.0)
+    pry (0.12.2)
       coderay (~> 1.1.0)
-      method_source (~> 0.8.1)
-      slop (~> 3.4)
-    pry-byebug (3.0.1)
-      byebug (~> 3.4)
+      method_source (~> 0.9.0)
+    pry-byebug (3.7.0)
+      byebug (~> 11.0)
       pry (~> 0.10)
-    rainbow (2.0.0)
-    rake (10.4.2)
-    rest-client (1.7.3)
-      mime-types (>= 1.16, < 3.0)
-      netrc (~> 0.7)
-    rspec (3.2.0)
-      rspec-core (~> 3.2.0)
-      rspec-expectations (~> 3.2.0)
-      rspec-mocks (~> 3.2.0)
-    rspec-core (3.2.0)
-      rspec-support (~> 3.2.0)
-    rspec-expectations (3.2.0)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.2.0)
-    rspec-mocks (3.2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.2.0)
-    rspec-support (3.2.1)
-    rubocop (0.29.1)
-      astrolabe (~> 1.3)
-      parser (>= 2.2.0.1, < 3.0)
-      powerpack (~> 0.1)
-      rainbow (>= 1.99.1, < 3.0)
-      ruby-progressbar (~> 1.4)
-    ruby-progressbar (1.7.1)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+    rubocop (0.76.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
     rugged (0.21.4)
-    simplecov (0.9.2)
-      docile (~> 1.1.0)
-      multi_json (~> 1.0)
-      simplecov-html (~> 0.9.0)
-    simplecov-html (0.9.0)
-    slop (3.6.0)
-    term-ansicolor (1.3.0)
-      tins (~> 1.0)
-    thor (0.19.1)
-    tins (1.3.4)
+    simplecov (0.17.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    term-ansicolor (1.2.2)
+      tins (~> 0.8)
+    thor (0.18.1)
+    tins (0.13.2)
+    unicode-display_width (1.6.0)
 
 PLATFORMS
   ruby
@@ -90,3 +85,6 @@ DEPENDENCIES
   rspec
   rubocop
   simplecov
+
+BUNDLED WITH
+   2.0.2

data/README.md

@@ -4,27 +4,134 @@
 [![Coverage Status](https://coveralls.io/repos/kevinjalbert/git_evolution/badge.svg)](https://coveralls.io/r/kevinjalbert/git_evolution)
 [![Code Climate](https://codeclimate.com/github/kevinjalbert/git_evolution/badges/gpa.svg)](https://codeclimate.com/github/kevinjalbert/git_evolution)
 
-TODO: Write a gem description
+Have you ever curious how a specific line or group of lines got to that point? If those lines are captured in a git repository then the history is there. Being able to identify the _evolution_ of said lines to their current state can be tricky and cumbersome. `GitEvolution` aims to solve this problem and provide a quick, and informative approach to understanding the evolution of changes in a git repository.
+
+This is incredibly useful when dealing with source lines in a software project as the commit messages often contain nuggets of information on decisions for change.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+`gem install git_evolution`
+
+## Usage
 
-```ruby
-gem 'git_evolution'
+Command-line interface `--help`
 ```
+$ git_evolution --help
 
-And then execute:
+Usage: git_evolution [options] <file>
+    -r, --range N:N                  The specified range of lines to consider within the file (optional)
+    -s, --since STRING               Consider the commits which are more recent than the specified time (optional)
+```
 
-    $ bundle
+## Example Scenario
 
-Or install it yourself as:
+If we were interesting in the source code evolution that lead to [rails's Array#forty_two](https://github.com/rails/rails/blob/7ba3a48/activesupport/lib/active_support/core_ext/array/access.rb#L70-L75):
 
-    $ gem install git_evolution
+```
+$ git_evolution --range 70:75 ./rails/activesupport/lib/active_support/core_ext/array/access.rb
 
-## Usage
+Commits:
+utenmiki <utenmiki@gmail.com> (Thu Oct 31 23:20:15 2013 +0900) - 3f79d8423078f0671c8aa505ae199608d451663d
+Add Rdoc document for Array#forty_two
+
+Jeremy Kemper <jeremy@bitsweat.net> (Sat Mar 21 03:26:09 2009 -0700) - 83fd1ae122cf1ee4ea2c52e0bd963462163516ca
+Convert array extension modules to class reopens
+
+David Heinemeier Hansson <david@loudthinking.com> (Fri Nov 21 09:06:46 2008 +0100) - e50530ca3ab5db53ebc74314c54b62b91b932389
+Reduced the number of literal aliases to the range that has actually seen personal use. With the massive savings in overhead, I was able to fit Array#forty_two
+
+Pratik Naik <pratiknaik@gmail.com> (Sun Oct 5 22:16:26 2008 +0100) - a2932784bb71e72a78c32819ebd7ed2bed551e3e
+Merge docrails
+
+Pratik Naik <pratiknaik@gmail.com> (Mon Jul 28 12:26:59 2008 +0100) - 6e754551254a8cc64e034163f5d0dc155b450388
+Merge docrails changes
+
+David Heinemeier Hansson <david@loudthinking.com> (Tue Jun 17 13:37:57 2008 -0500) - 22af62cf486721ee2e45bb720c42ac2f4121faf4
+Added Array#second through Array#tenth as aliases for Array#[1] through Array#[9] [DHH]
+
+David Heinemeier Hansson <david@loudthinking.com> (Tue Nov 27 19:42:30 2007 +0000) - 4d177ae0d6d9f60c4000f45fb6f6df27317afbff
+Added Array#from and Array#to that behaves just from String#from and String#to [DHH]
+
+--------------------------------------------------------------------------------
+
+Ownership (Commits):
+David Heinemeier Hansson <david@loudthinking.com> - 3/7 (42.86%)
+Pratik Naik <pratiknaik@gmail.com> - 2/7 (28.57%)
+Jeremy Kemper <jeremy@bitsweat.net> - 1/7 (14.29%)
+utenmiki <utenmiki@gmail.com> - 1/7 (14.29%)
+
+Ownership (Changes):
+David Heinemeier Hansson <david@loudthinking.com> - 53/84 (63.1%)
+Pratik Naik <pratiknaik@gmail.com> - 20/84 (23.81%)
+Jeremy Kemper <jeremy@bitsweat.net> - 9/84 (10.71%)
+utenmiki <utenmiki@gmail.com> - 2/84 (2.38%)
+```
+
+`GitEvolution` provides a succinct output of the commits which contains any changes which lead to the current state. Its quick to see that [e50530ca3ab5db53ebc74314c54b62b91b932389](https://github.com/rails/rails/commit/e50530ca3ab5db53ebc74314c54b62b91b932389) was the introduction point for `Array#forty_two`.
+
+In addition we have some _ownership_ information with respect to commits and changes. The ownership information can be used to identify _who_ to follow up with for additional context. In time new metrics and analysis could be attached to the output (i.e., factoring in time for ownership, types of changes, identifying file modifications such as movement or renames, etc...)
+
+## The Other (Hard) Way
+
+If we were to identify the commit which introduced `Array#forty_two` we have two main options `git blame` and `git log`:
+
+### Using `git blame`
+I highly advise against this approach as it involves a lot of manual work. You essentially use `git blame` to identify the previous commit which effects a line of concern within the area you are looking in.
+
+```
+$ git blame --follow ./activesupport/lib/active_support/core_ext/array/access.rb
+
+...
+83fd1ae1 (Jeremy Kemper            2009-03-21 03:26:09 -0700 70)   # Equal to <tt>self[41]</tt>. Also known as accessing "the reddit".
+3f79d842 (utenmiki                 2013-10-31 23:20:15 +0900 71)   #
+3f79d842 (utenmiki                 2013-10-31 23:20:15 +0900 72)   #   (1..42).to_a.forty_two # => 42
+83fd1ae1 (Jeremy Kemper            2009-03-21 03:26:09 -0700 73)   def forty_two
+83fd1ae1 (Jeremy Kemper            2009-03-21 03:26:09 -0700 74)     self[41]
+4d177ae0 (David Heinemeier Hansson 2007-11-27 19:42:30 +0000 75)   end
+...
+```
+
+You can then use a similar command to blame the parent git revision at that point.
+
+```
+$ git blame --follow 83fd1ae1^ -- ./activesupport/lib/active_support/core_ext/array/access.rb
+
+...
+e50530ca (David Heinemeier Hansson 2008-11-21 09:06:46 +0100 46)         # Equal to <tt>self[41]</tt>. Also known as accessing "the reddit".
+e50530ca (David Heinemeier Hansson 2008-11-21 09:06:46 +0100 47)         def forty_two
+e50530ca (David Heinemeier Hansson 2008-11-21 09:06:46 +0100 48)           self[41]
+22af62cf (David Heinemeier Hansson 2008-06-17 13:37:57 -0500 49)         end
+...
+```
+
+All the while you occasionally want to inspect the commit in more detail using `git show <commit-sha>`. Eventually you will end up where you want to be.
+
+```
+$ git show e50530ca
+
+commit e50530ca3ab5db53ebc74314c54b62b91b932389
+Author: David Heinemeier Hansson <david@loudthinking.com>
+Date:   Fri Nov 21 09:06:46 2008 +0100
+
+    Reduced the number of literal aliases to the range that has actually seen personal use. With the massive savings in overhead, I was able to fit Array#forty_two
+```
+
+### Using `git log`
+The following `git log` command presents the entire file history (26 commits):
+
+```
+$ git log --follow ./activesupport/lib/active_support/core_ext/array/access.rb
+```
+
+This works, but it is a lot more information to sift through.
+
+A better approach (which is what `GitEvolution` uses under the hood) presents the file history for only the concerned portion (7 commits):
+
+```
+$ git log -L70,75:./activesupport/lib/active_support/core_ext/array/access.rb --follow ./activesupport/lib/active_support/core_ext/array/access.rb
+```
 
-TODO: Write usage instructions here
+The output isn't succinct, nor does it have ownership information. The command is also more verbose.
 
 ## Contributing
 

data/git_evolution.gemspec

@@ -18,10 +18,10 @@ Gem::Specification.new do |spec|
   spec.executables   = Dir['bin/*'].map { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'bundler', '~> 1.0'
+  spec.add_dependency 'bundler', '~> 2.0'
   spec.add_dependency 'rake', '~> 10.0'
   spec.add_dependency 'rugged', '~> 0.21.0'
   spec.add_dependency 'chronic', '~> 0.10.0'
 
-  spec.required_ruby_version = '~> 2.0'
+  spec.required_ruby_version = '~> 2.5'
 end

data/lib/git_evolution/version.rb

@@ -1,3 +1,3 @@
 module GitEvolution
-  VERSION = '0.1.3'
+  VERSION = '0.2.0'
 end

data/spec/git_evolution/option_handler_spec.rb

@@ -49,7 +49,7 @@ RSpec.describe GitEvolution::OptionHandler do
       let(:range) { '10.20' }
 
       it 'raises exception' do
-        expect { described_class.parse_range(range) }.to raise_error
+        expect { described_class.parse_range(range) }.to raise_error(GitEvolution::InvalidRangeFormatError)
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: git_evolution
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Kevin Jalbert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-05 00:00:00.000000000 Z
+date: 2019-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -92,8 +92,7 @@ files:
 - lib/git_evolution/report_presenter.rb
 - lib/git_evolution/repository.rb
 - lib/git_evolution/version.rb
-- pkg/git_evolution-0.1.1.gem
-- pkg/git_evolution-0.1.2.gem
+- pkg/git_evolution-0.2.0.gem
 - spec/fixtures/raw_commit.txt
 - spec/fixtures/raw_commit_with_no_body.txt
 - spec/fixtures/raw_commit_with_no_diff.txt
@@ -115,26 +114,25 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - "~>"
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: Gem that provides the ability to determine the evolution of code within a
   git repository
 test_files:
-- spec/fixtures/raw_commit.txt
-- spec/fixtures/raw_commit_with_no_body.txt
-- spec/fixtures/raw_commit_with_no_diff.txt
-- spec/git_evolution/commit_spec.rb
-- spec/git_evolution/option_handler_spec.rb
-- spec/git_evolution/repository_spec.rb
 - spec/spec_helper.rb
 - spec/support/coverage.rb
 - spec/support/repository_helper.rb
+- spec/fixtures/raw_commit.txt
+- spec/fixtures/raw_commit_with_no_diff.txt
+- spec/fixtures/raw_commit_with_no_body.txt
+- spec/git_evolution/repository_spec.rb
+- spec/git_evolution/option_handler_spec.rb
+- spec/git_evolution/commit_spec.rb