gistory 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6f0db94a0ca0b970909c4f8118e5343ecd8bb9dd
+  data.tar.gz: f8d219bce6020ff7c737f3dcc70e0fe2ff08390b
+SHA512:
+  metadata.gz: 01dd9e2a1ddfb4e136f6efbe8360b676ebf5c221c1903b10daf1eb8555a77a7bba97b8b3e6cb65c0131c30e8e9c166a54a3c17763094e980428ad3e50590aed5
+  data.tar.gz: 12b412a19b76a0a8a4d4f0159ccb77ea2bfa25f6df209aee24d91dedb99905ae186b0889f79f36f62c406410ac4ca7be7364911545c54f29ba6bbf0957646732

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+NOTES.txt

data/.rubocop.yml

@@ -0,0 +1,15 @@
+Metrics/LineLength:
+  Max: 120
+
+Documentation:
+  Enabled: false
+
+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
+  Exclude:
+    - 'test/**/*_test.rb' # ignore tests which typically have high B count due to many asserts
+
+Metrics/MethodLength:
+  Max: 15

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.14.3

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'byebug' # debugger
+  gem 'pry' # better console
+  gem 'pry-byebug' # pry integration for byebug
+end
+
+group :test do
+  gem 'flexmock' # mock object
+  gem 'simplecov', require: false # code coverage
+end

data/README.md

@@ -0,0 +1,40 @@
+# Gistory
+
+If you use bundler and git, and want to know when a gem you are using was updated, `gistory` comes to your rescue, simply:
+
+```shell
+gem install gistory
+cd /path/to/repo
+gistory sidekiq
+```
+
+and you'll see something like:
+```
+Gem: sidekiq
+Current version: 4.2.7
+
+Change history:
+4.2.7 on Tue,  7 Feb 2017 16:05 +01:00 (commit c6edf321)
+4.2.6 on Wed, 30 Nov 2016 13:47 +01:00 (commit bf6a0d17)
+4.2.5 on Tue, 22 Nov 2016 14:48 -05:00 (commit 20ff5148)
+4.1.4 on Wed,  9 Nov 2016 14:31 +01:00 (commit 05a3c549)
+```
+
+By default `gistory` only looks at the 100 last changes to Gemfile.lock
+if you want to see farther in the past run:
+
+```shell
+gistory sidekiq -m10000
+```
+
+Note that if the gem was added, then removed, and then added again, `gistory` will
+only show the latest version changes up until it was removed.
+
+## Roadmap
+
+- use red for changes in the major version, blue for changes in the minor version
+- support other VCSs like subversion, mercurial, etc.
+- detect if the gem was added, then removed and then added again
+- use a libgit2 binding instead of the git cli, how much faster it is?
+- remove bundler dep
+- add yard doc

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'gistory'
+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 }
+
+def reload!
+  verbosity = $VERBOSE
+  begin
+    $VERBOSE = nil
+    files = $LOADED_FEATURES.select { |feat| feat =~ %r{/gistory/} }
+    files.each { |file| load(file) }
+  ensure
+    $VERBOSE = verbosity
+  end
+  true
+end
+
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/gistory

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'gistory'
+
+Gistory::Cli::Main.new(repo_path: Dir.getwd, args: ARGV).run

data/gistory.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gistory/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'gistory'
+  spec.version = Gistory::VERSION
+  spec.authors = ['Sergio Medina']
+  spec.email = ['medinasergio@gmail.com']
+
+  spec.summary = 'Gistory: Know exactly when a gem was updated in your Gemfile.lock'
+  spec.description = 'Gistory: Know exactly when a gem was updated in your Gemfile.lock'
+  spec.homepage = 'https://www.github.com/serch/gistory'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'bundler', '~> 1.14' # FIXME: what is the minimum bundler version I need?
+  spec.add_dependency 'colorize'
+
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+end

data/lib/gistory.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+require 'gistory/version'
+
+require 'gistory/cli/main'
+require 'gistory/cli/arg_parser'
+require 'gistory/cli/io'
+require 'gistory/configuration'
+
+require 'gistory/errors'
+require 'gistory/commit'
+require 'gistory/version_change'
+require 'gistory/git_repo'
+require 'gistory/change_log'
+
+module Gistory
+  class << self
+    def config
+      @config ||= Gistory::Configuration.new
+    end
+  end
+end

data/lib/gistory/change_log.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: truew
+require 'bundler'
+
+module Gistory
+  class ChangeLog
+    LOCKFILE = 'Gemfile.lock'.freeze
+
+    def initialize(repo:)
+      @repo = repo
+    end
+
+    def changelog_for_gem(gem_name)
+      version_changes = []
+      previous_version = nil
+      lockfile_changes = @repo.changes_to_file(LOCKFILE)
+
+      lockfile_changes.each do |commit|
+        gem_spec = gem_spec_at_commit_hash(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?
+
+        # 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
+        end
+      end
+
+      version_changes
+    end
+
+    private
+
+    def gem_spec_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
+    end
+  end
+end

data/lib/gistory/cli/arg_parser.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+require 'optparse'
+
+module Gistory
+  module Cli
+    class ArgParser
+      def initialize(args:, io: Gistory::Cli::Io.new)
+        @args = args
+        @config = Gistory.config
+        @parser = create_parser(@config)
+        @io = io
+      end
+
+      def parse
+        @parser.parse!(@args)
+
+        parse_gem_name
+        @io.error("extra parameters ignored: #{@args}") unless @args.count.zero?
+        @config
+      rescue OptionParser::InvalidOption => err
+        raise(Gistory::ParserError, err.message)
+      end
+
+      def to_s
+        @parser.to_s
+      end
+
+      private
+
+      def parse_gem_name
+        gem_name = @args.shift
+        raise(Gistory::ParserError, 'No gem specified') unless gem_name
+        @config.gem_name = gem_name
+      end
+
+      def create_parser(config)
+        parser = OptionParser.new
+        parser.banner = 'Usage: gistory <gem_name> [options]'
+
+        add_specific_options(parser, config)
+        add_common_options(parser)
+
+        parser
+      end
+
+      def add_specific_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:'
+
+        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
+        end
+      end
+
+      def add_help(parser)
+        parser.on_tail('-h', '--help', 'Show this message') do
+          @io.puts parser
+          exit
+        end
+      end
+
+      def add_version(parser)
+        parser.on_tail('--version', 'Show version') do
+          @io.puts "gistory version #{Gistory::VERSION}"
+          exit
+        end
+      end
+    end
+  end
+end

data/lib/gistory/cli/io.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+require 'colorize'
+
+module Gistory
+  module Cli
+    class Io
+      def initialize(out: $stdout, err: $stderr)
+        @out = out
+        @err = err
+      end
+
+      def puts(msg)
+        @out.puts(msg)
+      end
+
+      def error(msg)
+        @err.puts(msg.red)
+      end
+    end
+  end
+end

data/lib/gistory/cli/main.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+module Gistory
+  module Cli
+    class Main
+      def initialize(repo_path:, args:, io: Gistory::Cli::Io.new)
+        @repo_path = repo_path
+        @args = args
+        @io = io
+      end
+
+      def run
+        repo = GitRepo.new(path: @repo_path)
+        parser = Cli::ArgParser.new(args: @args, io: @io)
+        config = parser.parse
+        history(repo, config.gem_name)
+      rescue Gistory::ParserError => error
+        @io.error error.message
+        @io.puts parser
+      rescue Gistory::Error => error
+        @io.error error.message
+      end
+
+      private
+
+      def history(repo, gem_name)
+        changes = ChangeLog.new(repo: repo).changelog_for_gem(gem_name)
+
+        if changes.empty?
+          raise(Gistory::Error, "Gem '#{gem_name}' not found in lock file, maybe a typo?")
+        end
+
+        @io.puts "Gem: #{gem_name}"
+        @io.puts "Current version: #{changes.first.version}"
+        @io.puts ''
+
+        @io.puts 'Change history:'
+        changes.each do |change|
+          @io.puts "#{change.version} on #{change.date.strftime('%a, %e %b %Y %H:%M %Z')} (commit #{change.short_hash})"
+        end
+      end
+    end
+  end
+end

data/lib/gistory/commit.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+require 'date'
+
+module Gistory
+  class Commit
+    attr_reader :short_hash, :date
+
+    def initialize(short_hash:, date:)
+      @short_hash = short_hash
+      @date = DateTime.parse(date.to_s)
+      freeze
+    end
+  end
+end

data/lib/gistory/configuration.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+module Gistory
+  class Configuration
+    attr_accessor :gem_name, :max_lockfile_changes
+
+    def initialize
+      @max_lockfile_changes = 100
+    end
+  end
+end

data/lib/gistory/errors.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+module Gistory
+  class Error < StandardError; end
+
+  class ParserError < Error; end
+end

data/lib/gistory/git_repo.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+require 'english'
+
+module Gistory
+  class GitRepo
+    def initialize(path:)
+      raise(Gistory::Error, 'This is not a valid git repository') unless Dir.exist?(File.join(path, '.git'))
+      raise(Gistory::Error, 'git is not available, please install it') unless git_cli_available?
+    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}")
+      to_commits(hashes_and_dates.split("\n"))
+    end
+
+    def file_content_at_commit(commit_hash, filename)
+      git("show #{commit_hash}:#{filename}")
+    end
+
+    private
+
+    def git_cli_available?
+      system('which git > /dev/null 2>&1')
+    end
+
+    def to_commits(hashes_and_dates)
+      hashes_and_dates.map do |hash_and_date|
+        commit_hash, date = hash_and_date.split('|')
+        Commit.new(short_hash: commit_hash, date: date)
+      end
+    end
+
+    def git(command)
+      out = `git #{command}`
+      raise('Git CLI command failed') unless $CHILD_STATUS.success?
+      out
+    end
+  end
+end

data/lib/gistory/version.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+module Gistory
+  VERSION = '0.1.0'.freeze
+end

data/lib/gistory/version_change.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+require 'forwardable'
+
+module Gistory
+  class VersionChange
+    extend Forwardable
+    def_delegators :@commit, :short_hash, :date
+
+    attr_reader :commit, :version
+
+    def initialize(commit:, version:)
+      @commit = commit
+      @version = version
+      freeze
+    end
+  end
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: gistory
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sergio Medina
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-02-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: 'Gistory: Know exactly when a gem was updated in your Gemfile.lock'
+email:
+- medinasergio@gmail.com
+executables:
+- gistory
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/gistory
+- gistory.gemspec
+- lib/gistory.rb
+- lib/gistory/change_log.rb
+- lib/gistory/cli/arg_parser.rb
+- lib/gistory/cli/io.rb
+- lib/gistory/cli/main.rb
+- lib/gistory/commit.rb
+- lib/gistory/configuration.rb
+- lib/gistory/errors.rb
+- lib/gistory/git_repo.rb
+- lib/gistory/version.rb
+- lib/gistory/version_change.rb
+homepage: https://www.github.com/serch/gistory
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: 'Gistory: Know exactly when a gem was updated in your Gemfile.lock'
+test_files: []