git_fame 2.5.1 → 3.0.1

data/lib/git_fame/command.rb

@@ -0,0 +1,171 @@
+# frozen_string_literal: true
+
+require "active_support/core_ext/enumerable"
+require "tty-option"
+require "tty-spinner"
+
+module GitFame
+  class Command
+    include TTY::Option
+    using Extension
+
+    usage do
+      program "git"
+      command "fame"
+      desc "GitFame is a tool to generate a contributor list from git history"
+      example "Include commits made since 2010", "git fame --after 2010-01-01"
+      example "Include commits made before 2015", "git fame --before 2015-01-01"
+      example "Include commits made since 2010 and before 2015", "git fame --after 2010-01-01 --before 2015-01-01"
+      example "Only changes made to the main branch", "git fame --branch main"
+      example "Only ruby and javascript files", "git fame --extensions .rb .js"
+      example "Exclude spec files and the README", "git fame --exclude */**/*_spec.rb README.md"
+      example "Only spec files and markdown files", "git fame --include */**/*_spec.rb */**/*.md"
+      example "A parent directory of the current directory", "git fame ../other/git/repo"
+    end
+
+    option :log_level do
+      permit ["debug", "info", "warn", "error", "fatal"]
+      long "--log-level [LEVEL]"
+      desc "Log level"
+    end
+
+    option :exclude do
+      desc "Exclude files matching the given glob pattern"
+      long "--exclude [GLOB]"
+      arity zero_or_more
+      short "-E [BLOB]"
+      convert :list
+    end
+
+    option :include do
+      desc "Include files matching the given glob pattern"
+      long "--include [GLOB]"
+      arity zero_or_more
+      short "-I [BLOB]"
+      convert :list
+    end
+
+    option :extensions do
+      desc "File extensions to be included starting with a period"
+      arity zero_or_more
+      long "--extensions [EXT]"
+      short "-ex [EXT]"
+      convert :list
+
+      validate -> input do
+        input.match(/\.\w+/)
+      end
+    end
+
+    option :before do
+      desc "Only changes made after this date"
+      long "--before [DATE]"
+      short "-B [DATE]"
+      validate -> input do
+        Types::Params::DateTime.valid?(input)
+      end
+    end
+
+    option :after do
+      desc "Only changes made before this date"
+      long "--after [DATE]"
+      short "-A [DATE]"
+
+      validate -> input do
+        Types::Params::DateTime.valid?(input)
+      end
+    end
+
+    argument :path do
+      desc "Path or sub path to the git repository"
+      default { Dir.pwd }
+      optional
+
+      validate -> path do
+        File.directory?(path)
+      end
+    end
+
+    option :branch do
+      desc "Branch to be used as starting point"
+      long "--branch [NAME]"
+      default "HEAD"
+    end
+
+    flag :version do
+      desc "Current version"
+      long "--version"
+      short "-v"
+    end
+
+    flag :help do
+      desc "Print usage"
+      long "--help"
+      short "-h"
+    end
+
+    def self.call(argv = ARGV)
+      cmd = new
+      cmd.parse(argv, raise_on_parse_error: true)
+      cmd.run
+    rescue TTY::Option::InvalidParameter, TTY::Option::InvalidArgument => e
+      abort e.message
+    end
+
+    def run
+      if params[:help]
+        puts help
+        exit
+      end
+
+      if params[:version]
+        puts "git-fame v#{GitFame::VERSION}"
+        exit
+      end
+
+      thread = spinner.run do
+        Render.new(result: result, **options(:branch))
+      end
+
+      thread.value.call
+    rescue Dry::Struct::Error => e
+      abort e.message
+    rescue Interrupt
+      exit
+    end
+
+    private
+
+    def filter
+      Filter.new(**params.to_h.compact_blank.except(:branch))
+    end
+
+    def spinner
+      @spinner ||= TTY::Spinner.new("[:spinner] git-fame is crunching the numbers, hold on ...", interval: 1)
+    end
+
+    def repo
+      Rugged::Repository.discover(params[:path])
+    end
+
+    def collector
+      Collector.new(filter: filter, diff: diff, **options)
+    end
+
+    def diff
+      Diff.new(commit: commit, **options)
+    end
+
+    def options(*args)
+      params.to_h.only(*args, :log_level).compact_blank
+    end
+
+    def commit
+      repo.rev_parse(params[:branch])
+    end
+
+    def result
+      collector.call
+    end
+  end
+end

data/lib/git_fame/contribution.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module GitFame
+  class Contribution < Base
+    attribute :lines, Types::Integer
+    attribute :commits, Types::Set
+    attribute :files, Types::Set
+    attribute :author, Author
+
+    delegate :name, :email, to: :author
+  end
+end

data/lib/git_fame/diff.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module GitFame
+  class Diff < Base
+    include Enumerable
+
+    attribute :commit, Types::Any
+    delegate :tree, to: :commit
+    delegate :repo, to: :tree
+
+    # @yield [Hash]
+    #
+    # @return [void]
+    def each(&block)
+      tree.walk(:preorder).each do |root, entry|
+        case entry
+        in { type: :blob, name: file, oid: }
+          Rugged::Blame.new(repo, root + file, newest_commit: commit).each(&block)
+        in { type: type, name: file }
+          say("Ignore type [%s] in for %s", type, root + file)
+        end
+      end
+    end
+  end
+end

data/lib/git_fame/error.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module GitFame
+  class Error < StandardError; end
+end

data/lib/git_fame/extension.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module GitFame
+  module Extension
+    refine Hash do
+      # Exclude keys from a Hash
+      #
+      # @param [Array<Symbol>] keys
+      #
+      # @return [Hash]
+      def only(...)
+        dup.extract!(...)
+      end
+    end
+  end
+end

data/lib/git_fame/filter.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module GitFame
+  class Filter < Base
+    OPT = File::FNM_EXTGLOB | File::FNM_DOTMATCH | File::FNM_CASEFOLD | File::FNM_PATHNAME
+
+    attribute? :before, Types::JSON::DateTime
+    attribute? :after, Types::JSON::DateTime
+    attribute? :extensions, Types::Set
+    attribute? :include, Types::Set
+    attribute? :exclude, Types::Set
+
+    schema schema.strict(false)
+
+    # Invokes block if hunk is valid
+    #
+    # @param hunk [Hash]
+    #
+    # @yieldparam lines [Integer]
+    # @yieldparam orig_path [Pathname]
+    # @yieldparam oid [String]
+    # @yieldparam name [String]
+    # @yieldparam email [String]
+    #
+    # @return [void]
+    def call(hunk, &block)
+      case [hunk, attributes]
+      in [{ orig_path: path, final_signature: { time: created_at } }, { after: }] unless created_at > after
+        say("File %s ignored due to [created > after] (%p > %p)", path, created_at, after)
+      in [{ orig_path: path, final_signature: { time: created_at } }, { before: }] unless created_at < before
+        say("File %s ignored due to [created < before] (%p < %p)", path, created_at, before)
+      in [{ orig_path: path}, { exclude: excluded }] if excluded.any? { File.fnmatch?(_1, path, OPT) }
+        say("File %s excluded by [exclude] (%p)", path, excluded)
+      in [{ orig_path: path }, { include: included }] unless included.any? { File.fnmatch?(_1, path, OPT) }
+        say("File %s excluded by [include] (%p)", path, included)
+      in [{ orig_path: path }, { extensions: }] unless extensions.any? { File.extname(path) == _1 }
+        say("File %s excluded by [extensions] (%p)", path, extensions)
+      in [{final_signature: { name:, email:}, final_commit_id: oid, lines_in_hunk: lines, orig_path: path}, Hash]
+        block[lines, path, oid, name, email]
+      end
+    end
+  end
+end

data/lib/git_fame/render/extension.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "active_support/dependencies/autoload"
+require "active_support/number_helper"
+
+module GitFame
+  class Render
+    module Extension
+      refine Integer do
+        def f
+          ActiveSupport::NumberHelper.number_to_delimited(self, delimiter: " ")
+        end
+      end
+
+      refine Contribution do
+        def dist(result)
+          l = lines.to_f / result.lines
+          c = commits.count.to_f / result.commits.count
+          f = files.count.to_f / result.files.count
+
+          "%0.1f%% / %0.1f%% / %0.1f%%" % [l * 100, c * 100, f * 100]
+        end
+      end
+    end
+  end
+end

data/lib/git_fame/render.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require "tty-screen"
+require "tty-table"
+require "tty-box"
+require "erb"
+
+module GitFame
+  class Render < Base
+    FIELDS = [:name, :email, :lines, :commits, :files, :dist].map(&:to_s).freeze
+
+    attribute :branch, Types::String
+    attribute :result, Result
+    delegate_missing_to :result
+
+    using Extension
+
+    # Renders to stdout
+    #
+    # @return [void]
+    def call
+      table = TTY::Table.new(header: FIELDS)
+      width = TTY::Screen.width
+
+      contributions.reverse_each do |c|
+        table << [c.name, c.email, c.lines.f, c.commits.count.f, c.files.count.f, c.dist(self)]
+      end
+
+      print table.render(:unicode, width: width, resize: true, alignment: [:center])
+    end
+
+    private
+
+    def contributions
+      result.contributions.sort_by(&:lines)
+    end
+  end
+end

data/lib/git_fame/result.rb

@@ -1,6 +1,31 @@
+# frozen_string_literal: true
+
 module GitFame
-  class Result < Struct.new(:data, :success)
-    def to_s; data; end
-    def success?; success; end
+  class Result < Base
+    attribute :contributions, Types.Array(Contribution)
+
+    # @return [Array<Author>]
+    def authors
+      contributions.map(&:author)
+    end
+
+    # @return [Array<String>]
+    def commits
+      contributions.flat_map do |c|
+        c.commits.to_a
+      end
+    end
+
+    # @return [Array<String>]
+    def files
+      contributions.flat_map do |c|
+        c.files.to_a
+      end
+    end
+
+    # @return [Integer]
+    def lines
+      contributions.sum(&:lines)
+    end
   end
-end
+end

data/lib/git_fame/types.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "set"
+
+module GitFame
+  module Types
+    include Dry::Types()
+
+    Set = Instance(Set).constructor(&:to_set)
+  end
+end

data/lib/git_fame/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GitFame
-  VERSION = "2.5.1"
+  VERSION = "3.0.1"
 end

data/lib/git_fame.rb

@@ -1,4 +1,17 @@
-$-v = false
+# frozen_string_literal: true
 
-require "git_fame/version"
-require "git_fame/base"
+require "active_support/core_ext/module/delegation"
+require "active_support/isolated_execution_state"
+require "active_support/core_ext/numeric/time"
+require "dry/core/memoizable"
+require "dry/initializer"
+require "dry/struct"
+require "dry/types"
+require "neatjson"
+require "zeitwerk"
+require "pathname"
+require "rugged"
+
+module GitFame
+  Zeitwerk::Loader.for_gem.tap(&:setup)
+end