gistory 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 3c869b6ccd9aeb5d0a9ad7b080aa35f326d62863
-  data.tar.gz: a8b2d0930813f9d6c62503562ff68c2ceac79f30
+SHA256:
+  metadata.gz: '09f3c9251a676aa3fe78d5487e7cb60ee6c8348de21ae7ad4d91ee7a16623f69'
+  data.tar.gz: bb6b913eb6a330dea5db7e8f8bdd4e1db87324ff72abdeb48c835c00c87ab0a3
 SHA512:
-  metadata.gz: 3ce6ad22492538a40df7e828931c2ec67fa423d9716db58deeefa4624244c0228427be12d9a763779e2c7c9f450efca0364beb56134915db0878c751b3429f55
-  data.tar.gz: 385aef234e3efe8b297792c7c880d0f3a41881d8fa58cf12bc7b8ac35b4196ca675dbe00446e5ca32c236df5d624f249044d8f3859ff6f457764cc97606cf3bc
+  metadata.gz: 5f0931cb9e7673d6e7d88e1eb80e892ae3f482b1c3c8e4feae59b1b28f20b45a37bb6c08d51e4d15ec0d7115b780c0cc2f4dc4c530739197c4e9c48975ef19db
+  data.tar.gz: 137c0bb24fa19cea60221ab8a57994bc7a4e46c99aa4666c6b3d35b133aeb0559541b26090c9d3f92f71d87daacc471b5fe283e0824433d98d1b8af30c3b3223

data/.codeclimate.yml

@@ -13,4 +13,4 @@ ratings:
   paths:
   - "**.rb"
 exclude_paths:
-- test/
+- spec/

data/.gitignore

@@ -8,4 +8,7 @@
 /spec/reports/
 /tmp/
 
+# rspec failure tracking
+.rspec_status
+
 NOTES.txt

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -1,18 +1,84 @@
-Metrics/LineLength:
-  Max: 120
-
-Documentation:
-  Enabled: false
+require: rubocop-rspec
 
 Metrics/AbcSize:
-  # The ABC size is a calculated magnitude, so this number can be a Fixnum or a Float.
-  # http://c2.com/cgi/wiki?AbcMetric
-  Max: 20
+  Max: 25
+  Exclude:
+    - 'spec/**/*_spec.rb'
+
+Metrics/BlockLength:
   Exclude:
-    - 'test/**/*_test.rb' # ignore tests which typically have high B count due to many asserts
+    - 'spec/**/*_spec.rb'
 
 Metrics/MethodLength:
-  Max: 15
+  Max: 20
+
+Layout/EmptyLineAfterGuardClause:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 120
+
+Style/BlockDelimiters:
+  Exclude:
+    - 'spec/**/*_spec.rb'
+
+Style/Documentation:
+  Enabled: false
+
+Style/IfUnlessModifier:
+  Enabled: false
 
 Style/FrozenStringLiteralComment:
   EnforcedStyle: always
+
+# rubocop-rspec
+
+RSpec/MultipleExpectations:
+  Max: 15
+
+RSpec/ExampleLength:
+  Max: 15
+
+# starting rubocop 0.80 newly added cops need to be explicitly enabled:
+
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+
+Lint/MixedRegexpCaptureTypes:
+  Enabled: true
+
+Lint/RaiseException:
+  Enabled: true
+
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
+
+Style/ExponentialNotation:
+  Enabled: true
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+Style/RedundantFetchBlock:
+  Enabled: true
+
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+
+Style/RedundantRegexpEscape:
+  Enabled: true
+
+Style/SlicingWithRange:
+  Enabled: true

data/.travis.yml

@@ -1,8 +1,9 @@
 sudo: false
 language: ruby
+script:
+  - bundle exec rspec
 rvm:
-  - 2.4.0
-  - 2.3.3
-  - 2.2.6
-  - 2.1.10
-before_install: gem install bundler -v 1.14.3
+  - 2.6.6
+  - 2.5.8
+  - 2.4.10
+before_install: gem install bundler -v 1.17.3

data/Gemfile

@@ -12,7 +12,6 @@ end
 
 group :test do
   gem 'coveralls', require: false
-  gem 'flexmock' # mock library
   gem 'simplecov', require: false # code coverage
 end
 

data/README.md

@@ -5,7 +5,7 @@
 [![Build Status](https://travis-ci.org/serch/gistory.svg?branch=master)](https://travis-ci.org/serch/gistory)
 [![Coverage Status](https://coveralls.io/repos/github/serch/gistory/badge.svg?branch=master)](https://coveralls.io/github/serch/gistory?branch=master)
 
-If you use bundler and git, and want to know when a gem you are using was updated, `gistory` comes to your rescue, simply:
+If you use bundler and git and you want to know when a gem was updated, `gistory` comes to the rescue, simply:
 
 ```shell
 gem install gistory
@@ -14,6 +14,7 @@ gistory sidekiq
 ```
 
 and you'll see something like:
+
 ```
 Gem: sidekiq
 Current version: 4.2.7
@@ -25,11 +26,17 @@ Change history:
 4.1.4 on Wed,  9 Nov 2016 14:31 +01:00 (commit 05a3c549)
 ```
 
-By default `gistory` only looks at the last 100 changes to Gemfile.lock
-if you want to see farther in the past run:
+By default `gistory` only looks at the last 100 commits made to the current branch.
+If you want to see farther back in the past run:
+
+```shell
+gistory sidekiq -m1000
+```
+
+If you want to look at all changes to Gemfile.lock in all branches, use the `-a` switch:
 
 ```shell
-gistory sidekiq -m10000
+gistory sidekiq -a
 ```
 
 Note that if the gem was added, then removed, and then added again, `gistory` will
@@ -43,3 +50,4 @@ only show the latest version changes up until it was removed.
 - use a libgit2 binding instead of the git cli, how much faster it is?
 - remove bundler dep
 - add yard doc
+- do not print the warning text if there were no more changes in the lock file

data/Rakefile

@@ -1,12 +1,8 @@
 # frozen_string_literal: true
 
 require 'bundler/gem_tasks'
-require 'rake/testtask'
+require 'rspec/core/rake_task'
 
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'test'
-  t.libs << 'lib'
-  t.test_files = FileList['test/**/*_test.rb']
-end
+RSpec::Core::RakeTask.new(:spec)
 
-task default: :test
+task default: :spec

data/bin/console

@@ -8,7 +8,7 @@ require 'pry'
 root_path = "#{File.dirname(__FILE__)}/.."
 
 # require all files in lib for quick access to them in the console
-Dir["#{root_path}/lib/**/*.rb"].each { |file| require file }
+Dir["#{root_path}/lib/**/*.rb"].sort.each { |file| require file }
 
 def reload!
   verbosity = $VERBOSE

data/exe/gistory

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-lib = File.expand_path('../../lib', __FILE__)
+lib = File.expand_path('../lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 require 'gistory'

data/gistory.gemspec

@@ -1,7 +1,6 @@
-# coding: utf-8
 # frozen_string_literal: true
 
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'gistory/version'
 
@@ -9,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.name = 'gistory'
   spec.version = Gistory::VERSION
   spec.platform = Gem::Platform::RUBY
-  spec.required_ruby_version = '>= 2.1'
+  spec.required_ruby_version = '>= 2.4'
   spec.authors = ['Sergio Medina']
   spec.email = ['medinasergio@gmail.com']
 
@@ -28,6 +27,10 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'bundler', '~> 1.0'
   spec.add_dependency 'colorize'
 
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.9'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-rspec'
 end

data/lib/gistory.rb

@@ -11,6 +11,7 @@ require 'gistory/errors'
 require 'gistory/commit'
 require 'gistory/version_change'
 require 'gistory/git_repo'
+require 'gistory/lockfile_parser'
 require 'gistory/change_log'
 
 module Gistory

data/lib/gistory/change_log.rb

@@ -1,10 +1,8 @@
 # frozen_string_literal: true
 
-require 'bundler'
-
 module Gistory
   class ChangeLog
-    LOCKFILE = 'Gemfile.lock'.freeze
+    LOCKFILE = 'Gemfile.lock'
 
     def initialize(repo:)
       @repo = repo
@@ -12,33 +10,41 @@ module Gistory
 
     def changelog_for_gem(gem_name)
       version_changes = []
-      previous_version = nil
-      lockfile_changes = @repo.changes_to_file(LOCKFILE)
+      commits_with_changes = @repo.changes_to_file(LOCKFILE)
+
+      # no lockfile found or no changes to the lockfile found
+      return [] if commits_with_changes.empty?
+
+      previous_commit = commits_with_changes.shift
+      previous_gem_spec = gem_version_at_commit_hash(previous_commit.short_hash, gem_name)
+      # only one change to the lockfile was found and the gem was not there
+      return [] if previous_gem_spec.nil?
 
-      lockfile_changes.each do |commit|
-        gem_spec = gem_spec_at_commit_hash(commit.short_hash, gem_name)
+      commits_with_changes.each do |current_commit|
+        current_gem_spec = gem_version_at_commit_hash(current_commit.short_hash, gem_name)
 
         # we reached the end, the gem didn't exist back then
         # TODO: what if it was added then removed and then added again?
-        break if gem_spec.nil?
+        break if current_gem_spec.nil?
 
-        # only store version changes of this gem
-        unless gem_spec.version.to_s == previous_version
-          version_changes << VersionChange.new(commit: commit, version: gem_spec.version)
-          previous_version = gem_spec.version.to_s
+        if current_gem_spec != previous_gem_spec
+          version_changes << VersionChange.new(commit: previous_commit, version: previous_gem_spec)
         end
+
+        previous_gem_spec = current_gem_spec
+        previous_commit = current_commit
       end
 
+      version_changes << VersionChange.new(commit: previous_commit, version: previous_gem_spec)
+
       version_changes
     end
 
     private
 
-    def gem_spec_at_commit_hash(commit_hash, gem_name)
+    def gem_version_at_commit_hash(commit_hash, gem_name)
       lockfile_content = @repo.file_content_at_commit(commit_hash, LOCKFILE)
-      lockfile = Bundler::LockfileParser.new(lockfile_content)
-      gem_spec = lockfile.specs.find { |spec| spec.name == gem_name }
-      gem_spec
+      LockfileParser.new(lockfile_content: lockfile_content).gem_version(gem_name)
     end
   end
 end

data/lib/gistory/cli/arg_parser.rb

@@ -18,8 +18,8 @@ module Gistory
         parse_gem_name
         @io.error("extra parameters ignored: #{@args}") unless @args.count.zero?
         @config
-      rescue OptionParser::InvalidOption => err
-        raise(Gistory::ParserError, err.message)
+      rescue OptionParser::InvalidOption => e
+        raise(Gistory::ParserError, e.message)
       end
 
       def to_s
@@ -38,33 +38,35 @@ module Gistory
         parser = OptionParser.new
         parser.banner = 'Usage: gistory <gem_name> [options]'
 
-        add_specific_options(parser, config)
-        add_common_options(parser)
+        add_options(parser, config)
 
         parser
       end
 
-      def add_specific_options(parser, config)
+      def add_options(parser, config)
         parser.separator ''
-        parser.separator 'Specific options:'
-
-        add_max_lockfile_changes(parser, config)
-      end
-
-      def add_common_options(parser)
-        parser.separator ''
-        parser.separator 'Common options:'
+        parser.separator 'Options:'
 
+        add_max_fetched_commits(parser, config)
+        add_use_commits_from_all_branches(parser, config)
         add_help(parser)
         add_version(parser)
       end
 
-      def add_max_lockfile_changes(parser, config)
-        default = config.max_lockfile_changes
-        description = "max number of changes to the lock file (default #{default})"
-        parser.on('-m', '--max-lockfile-changes [INTEGER]', Integer, description) do |m|
-          raise(Gistory::ParserError, 'argument --max-lockfile-changes must be an integer') if m.nil?
-          config.max_lockfile_changes = m
+      def add_max_fetched_commits(parser, config)
+        default = config.max_fetched_commits
+        description = "max number of commits to be fetched (default #{default})"
+        parser.on('-m', '--max-fetched-commits [Integer]', Integer, description) do |m|
+          raise(Gistory::ParserError, 'argument --max-fetched-commits must be an integer') if m.nil?
+          config.max_fetched_commits = m
+        end
+      end
+
+      def add_use_commits_from_all_branches(parser, config)
+        description = 'use commits from all branches ' \
+                      '(by default it uses only commits made to the current branch)'
+        parser.on('-a', '--all-branches', description) do |a|
+          config.all_branches = a
         end
       end
 

data/lib/gistory/cli/main.rb

@@ -14,11 +14,11 @@ module Gistory
         parser = Cli::ArgParser.new(args: @args, io: @io)
         config = parser.parse
         history(repo, config.gem_name)
-      rescue Gistory::ParserError => error
-        @io.error error.message
+      rescue Gistory::ParserError => e
+        @io.error e.message
         @io.puts parser
-      rescue Gistory::Error => error
-        @io.error error.message
+      rescue Gistory::Error => e
+        @io.error e.message
       end
 
       private
@@ -34,11 +34,33 @@ module Gistory
         @io.puts "Current version: #{changes.first.version}"
         @io.puts ''
 
+        print_change_history(changes)
+
+        @io.puts ''
+
+        print_configuration_info
+      end
+
+      def print_change_history(changes)
         @io.puts 'Change history:'
+        max_length = changes.map { |c| c.version.length }.max
+
         changes.each do |change|
-          @io.puts "#{change.version} on #{change.date.strftime('%a, %e %b %Y %H:%M %Z')} (commit #{change.short_hash})"
+          @io.puts "#{change.version.ljust(max_length)} on #{change.date.strftime('%a, %e %b %Y %H:%M %Z')} " \
+                   "(commit #{change.short_hash})"
         end
       end
+
+      def print_configuration_info
+        max = Gistory.config.max_fetched_commits
+        if Gistory.config.all_branches?
+          @io.puts "The last #{max} changes to the lock file were fetched."
+        else
+          @io.puts "The last #{max} commits made to the current branch were fetched."
+        end
+
+        @io.puts 'To see farther in the past use the -m switch'
+      end
     end
   end
 end

data/lib/gistory/commit.rb

@@ -11,5 +11,9 @@ module Gistory
       @date = DateTime.parse(date.to_s)
       freeze
     end
+
+    def to_s
+      "Commit #{short_hash} on #{date}"
+    end
   end
 end

data/lib/gistory/configuration.rb

@@ -2,10 +2,16 @@
 
 module Gistory
   class Configuration
-    attr_accessor :gem_name, :max_lockfile_changes
+    attr_accessor :gem_name, :max_fetched_commits
+    attr_writer :all_branches
 
     def initialize
-      @max_lockfile_changes = 100
+      @max_fetched_commits = 100
+      @all_branches = false
+    end
+
+    def all_branches?
+      @all_branches
     end
   end
 end

data/lib/gistory/git_repo.rb

@@ -10,8 +10,9 @@ module Gistory
     end
 
     def changes_to_file(filename)
-      max_count = Gistory.config.max_lockfile_changes
-      hashes_and_dates = git("log --pretty=format:'%h|%cD' --max-count=#{max_count} --follow #{filename}")
+      max_count = Gistory.config.max_fetched_commits
+      strategy = git_log_strategy(filename)
+      hashes_and_dates = git("log --pretty=format:'%h|%cD' --max-count=#{max_count} #{strategy}")
       to_commits(hashes_and_dates.split("\n"))
     end
 
@@ -21,6 +22,15 @@ module Gistory
 
     private
 
+    def git_log_strategy(filename)
+      if Gistory.config.all_branches?
+        "--follow #{filename}"
+      else
+        # TODO: filter out commits that did not introduce changes to the lock file
+        '--first-parent'
+      end
+    end
+
     def git_cli_available?
       system('which git > /dev/null 2>&1')
     end
@@ -34,7 +44,7 @@ module Gistory
 
     def git(command)
       out = `git #{command}`
-      raise('Git CLI command failed') unless $CHILD_STATUS.success?
+      raise 'Git CLI command failed' unless $CHILD_STATUS.success?
       out
     end
   end

data/lib/gistory/lockfile_parser.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'bundler'
+
+module Gistory
+  class LockfileParser
+    def initialize(lockfile_content:)
+      @lockfile_content = lockfile_content
+    end
+
+    def gem_version(gem_name)
+      lockfile = Bundler::LockfileParser.new(@lockfile_content)
+      gem_spec = lockfile.specs.find { |spec| spec.name == gem_name }
+      gem_spec ? gem_spec.version.to_s : nil
+    rescue Bundler::LockfileError => _e
+      # bundler could not parse the lockfile
+      # f.i. it could have been committed with merge conflicts
+      # try to parse it with a regex
+      # gem version looks like "    byebug (9.0.6)"
+      # TODO: what if the gem was in the merge conflict?
+      regexp = /\n\s{4}#{gem_name} \((?<version>.+)\)\n/
+      matches = @lockfile_content.match(regexp)
+      matches ? matches[:version] : nil
+    end
+  end
+end

data/lib/gistory/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Gistory
-  VERSION = '0.1.4'.freeze
+  VERSION = '0.2.0'
 end

data/lib/gistory/version_change.rb

@@ -14,5 +14,9 @@ module Gistory
       @version = version
       freeze
     end
+
+    def to_s
+      "Version #{version} (on #{date} by #{short_hash})"
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gistory
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - Sergio Medina
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2017-05-26 00:00:00.000000000 Z
+date: 2020-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,34 +38,90 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 'Gistory: Know exactly when a gem was updated in your Gemfile.lock'
 email:
 - medinasergio@gmail.com
@@ -77,6 +133,7 @@ files:
 - ".codeclimate.yml"
 - ".coveralls.yml"
 - ".gitignore"
+- ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
@@ -96,13 +153,14 @@ files:
 - lib/gistory/configuration.rb
 - lib/gistory/errors.rb
 - lib/gistory/git_repo.rb
+- lib/gistory/lockfile_parser.rb
 - lib/gistory/version.rb
 - lib/gistory/version_change.rb
 homepage: https://www.github.com/serch/gistory
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -110,16 +168,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.1'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.12
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: 'Gistory: Know exactly when a gem was updated in your Gemfile.lock'
 test_files: []